Commit 7abf9b3a83b3d37bbeeac7dc2df238c3b94aa148 | zig

author	Krzysztof Wolicki <der.teufel.mail@gmail.com> 2023-10-10 20:29:26+02:00
committer	GitHub <noreply@github.com> 2023-10-10 14:29:26-04:00
log	7abf9b3a83b3d37bbeeac7dc2df238c3b94aa148
tree	d48ec6e73ae9b09b08b737f4deecf6deed68773e
parent	2ca7cc46c41dc5fe91fe385df4f3330634bd88f3
signature	Signed by PGP key 4AEE18F83AFDEB23

Step.Compile: add options struct for `addCSourceFiles` (#17420)

Closes #17410

7 files changed, 43 insertions(+), 16 deletions(-)

build.zig
lib
- std
  - Build
    Step
    Compile.zig
test
- link
  - common_symbols
    build.zig
  - common_symbols_alignment
    build.zig
  - macho
    unwind_info
    build.zig
- standalone
  - issue_11595
    build.zig
  - issue_12706
    build.zig

build.zig+4-1

 @@ -693,7 +693,10 @@ fn addStaticLlvmOptionsToExe(exe: *std.Build.Step.Compile) !void {
     // in a dependency on llvm::cfg::Update<llvm::BasicBlock*>::dump() which is
     // unavailable when LLVM is compiled in Release mode.
     const zig_cpp_cflags = exe_cflags ++ [_][]const u8{"-DNDEBUG=1"};
-    exe.addCSourceFiles(&zig_cpp_sources, &zig_cpp_cflags);
+    exe.addCSourceFiles(.{
+        .files = &zig_cpp_sources,
+        .flags = &zig_cpp_cflags,
+    });
     for (clang_libs) |lib_name| {
         exe.linkSystemLibrary(lib_name);

lib/std/Build/Step/Compile.zig+22-6

 @@ -216,7 +216,9 @@ generated_llvm_ir: ?*GeneratedFile,
 generated_h: ?*GeneratedFile,
 pub const CSourceFiles = struct {
-    /// Relative to the build root.
+    dependency: ?*std.Build.Dependency,
+    /// If `dependency` is not null relative to it,
+    /// else relative to the build root.
     files: []const []const u8,
     flags: []const []const u8,
 };
 @@ -924,15 +926,23 @@ pub fn linkSystemLibrary2(
     }) catch @panic("OOM");
 }
+pub const AddCSourceFilesOptions = struct {
+    /// When provided, `files` are relative to `dependency` rather than the package that owns the `Compile` step.
+    dependency: ?*std.Build.Dependency = null,
+    files: []const []const u8,
+    flags: []const []const u8 = &.{},
+};
 /// Handy when you have many C/C++ source files and want them all to have the same flags.
-pub fn addCSourceFiles(self: *Compile, files: []const []const u8, flags: []const []const u8) void {
+pub fn addCSourceFiles(self: *Compile, options: AddCSourceFilesOptions) void {
     const b = self.step.owner;
     const c_source_files = b.allocator.create(CSourceFiles) catch @panic("OOM");
-    const files_copy = b.dupeStrings(files);
+    const files_copy = b.dupeStrings(options.files);
-    const flags_copy = b.dupeStrings(flags);
+    const flags_copy = b.dupeStrings(options.flags);
     c_source_files.* = .{
+        .dependency = options.dependency,
         .files = files_copy,
         .flags = flags_copy,
     };
 @@ -1552,8 +1562,14 @@ fn make(step: *Step, prog_node: *std.Progress.Node) !void {
                     try zig_args.append("--");
                     prev_has_cflags = true;
                 }
-                for (c_source_files.files) |file| {
+                if (c_source_files.dependency) |dep| {
-                    try zig_args.append(b.pathFromRoot(file));
+                    for (c_source_files.files) |file| {
+                        try zig_args.append(dep.builder.pathFromRoot(file));
+                    }
+                } else {
+                    for (c_source_files.files) |file| {
+                        try zig_args.append(b.pathFromRoot(file));
+                    }
                 }
             },

test/link/common_symbols/build.zig+4-1

 @@ -16,7 +16,10 @@ fn add(b: *std.Build, test_step: *std.Build.Step, optimize: std.builtin.Optimize
         .optimize = optimize,
         .target = .{},
     });
-    lib_a.addCSourceFiles(&.{ "c.c", "a.c", "b.c" }, &.{"-fcommon"});
+    lib_a.addCSourceFiles(.{
+        .files = &.{ "c.c", "a.c", "b.c" },
+        .flags = &.{"-fcommon"},
+    });
     const test_exe = b.addTest(.{
         .root_source_file = .{ .path = "main.zig" },

test/link/common_symbols_alignment/build.zig+4-1

 @@ -16,7 +16,10 @@ fn add(b: *std.Build, test_step: *std.Build.Step, optimize: std.builtin.Optimize
         .optimize = optimize,
         .target = .{},
     });
-    lib_a.addCSourceFiles(&.{"a.c"}, &.{"-fcommon"});
+    lib_a.addCSourceFiles(.{
+        .files = &.{"a.c"},
+        .flags = &.{"-fcommon"},
+    });
     const test_exe = b.addTest(.{
         .root_source_file = .{ .path = "main.zig" },

test/link/macho/unwind_info/build.zig+7-5

 @@ -76,11 +76,13 @@ fn createScenario(
     });
     b.default_step.dependOn(&exe.step);
     exe.addIncludePath(.{ .path = "." });
-    exe.addCSourceFiles(&[_][]const u8{
+    exe.addCSourceFiles(.{
-        "main.cpp",
+        .files = &[_][]const u8{
-        "simple_string.cpp",
+            "main.cpp",
-        "simple_string_owner.cpp",
+            "simple_string.cpp",
-    }, &[0][]const u8{});
+            "simple_string_owner.cpp",
+        },
+    });
     exe.linkLibCpp();
     return exe;
 }

test/standalone/issue_11595/build.zig+1-1

...	@@ -25,7 +25,7 @@ pub fn build(b: *std.Build) void {	...	@@ -25,7 +25,7 @@ pub fn build(b: *std.Build) void {
25	"test.c",	25	"test.c",
26	};	26	};
27		27
28	exe.addCSourceFiles(&c_sources, &.{});	28	exe.addCSourceFiles(.{ .files = &c_sources });
29	exe.linkLibC();	29	exe.linkLibC();
30		30
31	var i: i32 = 0;	31	var i: i32 = 0;

test/standalone/issue_12706/build.zig+1-1

...	@@ -19,7 +19,7 @@ pub fn build(b: *std.Build) void {	...	@@ -19,7 +19,7 @@ pub fn build(b: *std.Build) void {
19	const c_sources = [_][]const u8{	19	const c_sources = [_][]const u8{
20	"test.c",	20	"test.c",
21	};	21	};
22	exe.addCSourceFiles(&c_sources, &.{});	22	exe.addCSourceFiles(.{ .files = &c_sources });
23	exe.linkLibC();	23	exe.linkLibC();
24		24
25	const run_cmd = b.addRunArtifact(exe);	25	const run_cmd = b.addRunArtifact(exe);