| author |  Ryan Liptak <squeek502@hotmail.com> 2024-05-02 18:57:34-07:00 |
| committer |  Andrew Kelley <andrew@ziglang.org> 2024-05-02 22:08:00-07:00 |
| log | ea9d817a905ae19dcf27db4f380270485f9e26d2 |
| tree | e8edc32b14154ca7f0e833953a8d18a787bf194d |
| parent | 8ea4283d83a23b2956a1894eeb64793335de82b9 |
Build system: Allow specifying Win32 resource include paths using LazyPath
Adds an `include_paths` field to RcSourceFile that takes a slice of LazyPaths. The paths are resolved and subsequently appended to the -rcflags as `/I <resolved path>`.
This fixes an accidental regression from https://github.com/ziglang/zig/pull/19174. Before that PR, all Win32 resource compilation would inherit the CC flags (via `addCCArgs`), which included things like include directories. After that PR, though, that is no longer the case.
However, this commit intentionally does not restore the previous behavior (inheriting the C include paths). Instead, each .rc file will need to have its include paths specified directly and the include paths only apply to one particular resource script. This allows more fine-grained control and has less potentially surprising behavior (at the cost of some convenience).
Closes #196054 files changed, 29 insertions(+), 5 deletions(-)
lib- std
- Build
lib/std/Build/Module.zig+10
| ... | ... | @@ -110,11 +110,18 @@ pub const RcSourceFile = struct { |
| 110 | 110 | /// /x (ignore the INCLUDE environment variable) |
| 111 | 111 | /// /D_DEBUG or /DNDEBUG depending on the optimization mode |
| 112 | 112 | flags: []const []const u8 = &.{}, |
| 113 | /// Include paths that may or may not exist yet and therefore need to be | |
| 114 | /// specified as a LazyPath. Each path will be appended to the flags | |
| 115 | /// as `/I <resolved path>`. | |
| 116 | include_paths: []const LazyPath = &.{}, | |
| 113 | 117 | |
| 114 | 118 | pub fn dupe(self: RcSourceFile, b: *std.Build) RcSourceFile { |
| 119 | const include_paths = b.allocator.alloc(LazyPath, self.include_paths.len) catch @panic("OOM"); | |
| 120 | for (include_paths, self.include_paths) |*dest, lazy_path| dest.* = lazy_path.dupe(b); | |
| 115 | 121 | return .{ |
| 116 | 122 | .file = self.file.dupe(b), |
| 117 | 123 | .flags = b.dupeStrings(self.flags), |
| 124 | .include_paths = include_paths, | |
| 118 | 125 | }; |
| 119 | 126 | } |
| 120 | 127 | }; |
| ... | ... | @@ -503,6 +510,9 @@ pub fn addWin32ResourceFile(m: *Module, source: RcSourceFile) void { |
| 503 | 510 | rc_source_file.* = source.dupe(b); |
| 504 | 511 | m.link_objects.append(allocator, .{ .win32_resource_file = rc_source_file }) catch @panic("OOM"); |
| 505 | 512 | addLazyPathDependenciesOnly(m, source.file); |
| 513 | for (source.include_paths) |include_path| { | |
| 514 | addLazyPathDependenciesOnly(m, include_path); | |
| 515 | } | |
| 506 | 516 | } |
| 507 | 517 | |
| 508 | 518 | pub fn addAssemblyFile(m: *Module, source: LazyPath) void { |
lib/std/Build/Step/Compile.zig+5-1
| ... | ... | @@ -1281,7 +1281,7 @@ fn make(step: *Step, prog_node: *std.Progress.Node) !void { |
| 1281 | 1281 | .win32_resource_file => |rc_source_file| l: { |
| 1282 | 1282 | if (!my_responsibility) break :l; |
| 1283 | 1283 | |
| 1284 | if (rc_source_file.flags.len == 0) { | |
| 1284 | if (rc_source_file.flags.len == 0 and rc_source_file.include_paths.len == 0) { | |
| 1285 | 1285 | if (prev_has_rcflags) { |
| 1286 | 1286 | try zig_args.append("-rcflags"); |
| 1287 | 1287 | try zig_args.append("--"); |
| ... | ... | @@ -1292,6 +1292,10 @@ fn make(step: *Step, prog_node: *std.Progress.Node) !void { |
| 1292 | 1292 | for (rc_source_file.flags) |arg| { |
| 1293 | 1293 | try zig_args.append(arg); |
| 1294 | 1294 | } |
| 1295 | for (rc_source_file.include_paths) |include_path| { | |
| 1296 | try zig_args.append("/I"); | |
| 1297 | try zig_args.append(include_path.getPath2(module.owner, step)); | |
| 1298 | } | |
| 1295 | 1299 | try zig_args.append("--"); |
| 1296 | 1300 | prev_has_rcflags = true; |
| 1297 | 1301 | } |
test/standalone/windows_resources/build.zig+10-4
| ... | ... | @@ -10,11 +10,13 @@ pub fn build(b: *std.Build) void { |
| 10 | 10 | .abi = .gnu, |
| 11 | 11 | }); |
| 12 | 12 | |
| 13 | add(b, b.host, .any, test_step); | |
| 14 | add(b, target, .any, test_step); | |
| 13 | const generated_h_step = b.addWriteFile("generated.h", "#define GENERATED_DEFINE \"foo\""); | |
| 15 | 14 | |
| 16 | add(b, b.host, .gnu, test_step); | |
| 17 | add(b, target, .gnu, test_step); | |
| 15 | add(b, b.host, .any, test_step, generated_h_step); | |
| 16 | add(b, target, .any, test_step, generated_h_step); | |
| 17 | ||
| 18 | add(b, b.host, .gnu, test_step, generated_h_step); | |
| 19 | add(b, target, .gnu, test_step, generated_h_step); | |
| 18 | 20 | } |
| 19 | 21 | |
| 20 | 22 | fn add( |
| ... | ... | @@ -22,6 +24,7 @@ fn add( |
| 22 | 24 | target: std.Build.ResolvedTarget, |
| 23 | 25 | rc_includes: enum { any, gnu }, |
| 24 | 26 | test_step: *std.Build.Step, |
| 27 | generated_h_step: *std.Build.Step.WriteFile, | |
| 25 | 28 | ) void { |
| 26 | 29 | const exe = b.addExecutable(.{ |
| 27 | 30 | .name = "zig_resource_test", |
| ... | ... | @@ -32,6 +35,9 @@ fn add( |
| 32 | 35 | exe.addWin32ResourceFile(.{ |
| 33 | 36 | .file = b.path("res/zig.rc"), |
| 34 | 37 | .flags = &.{"/c65001"}, // UTF-8 code page |
| 38 | .include_paths = &.{ | |
| 39 | .{ .generated = &generated_h_step.generated_directory }, | |
| 40 | }, | |
| 35 | 41 | }); |
| 36 | 42 | exe.rc_includes = switch (rc_includes) { |
| 37 | 43 | .any => .any, |
test/standalone/windows_resources/res/zig.rc+4
| ... | ... | @@ -1,3 +1,7 @@ |
| 1 | // This include file is generated via build.zig, and it #defines GENERATED_DEFINE | |
| 2 | #include "generated.h" | |
| 3 | FOO RCDATA { GENERATED_DEFINE } | |
| 4 | ||
| 1 | 5 | #define ICO_ID 1 |
| 2 | 6 | |
| 3 | 7 | // Nothing from windows.h is used in this .rc file, |