Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Build system: Allow specifying Win32 resource include paths using LazyPath #19843

Merged
merged 1 commit into from
May 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions lib/std/Build/Module.zig
Original file line number Diff line number Diff line change
Expand Up @@ -110,11 +110,18 @@ pub const RcSourceFile = struct {
/// /x (ignore the INCLUDE environment variable)
/// /D_DEBUG or /DNDEBUG depending on the optimization mode
flags: []const []const u8 = &.{},
/// Include paths that may or may not exist yet and therefore need to be
/// specified as a LazyPath. Each path will be appended to the flags
/// as `/I <resolved path>`.
include_paths: []const LazyPath = &.{},

pub fn dupe(self: RcSourceFile, b: *std.Build) RcSourceFile {
const include_paths = b.allocator.alloc(LazyPath, self.include_paths.len) catch @panic("OOM");
for (include_paths, self.include_paths) |*dest, lazy_path| dest.* = lazy_path.dupe(b);
return .{
.file = self.file.dupe(b),
.flags = b.dupeStrings(self.flags),
.include_paths = include_paths,
};
}
};
Expand Down Expand Up @@ -503,6 +510,9 @@ pub fn addWin32ResourceFile(m: *Module, source: RcSourceFile) void {
rc_source_file.* = source.dupe(b);
m.link_objects.append(allocator, .{ .win32_resource_file = rc_source_file }) catch @panic("OOM");
addLazyPathDependenciesOnly(m, source.file);
for (source.include_paths) |include_path| {
addLazyPathDependenciesOnly(m, include_path);
}
}

pub fn addAssemblyFile(m: *Module, source: LazyPath) void {
Expand Down
6 changes: 5 additions & 1 deletion lib/std/Build/Step/Compile.zig
Original file line number Diff line number Diff line change
Expand Up @@ -1281,7 +1281,7 @@ fn make(step: *Step, prog_node: *std.Progress.Node) !void {
.win32_resource_file => |rc_source_file| l: {
if (!my_responsibility) break :l;

if (rc_source_file.flags.len == 0) {
if (rc_source_file.flags.len == 0 and rc_source_file.include_paths.len == 0) {
if (prev_has_rcflags) {
try zig_args.append("-rcflags");
try zig_args.append("--");
Expand All @@ -1292,6 +1292,10 @@ fn make(step: *Step, prog_node: *std.Progress.Node) !void {
for (rc_source_file.flags) |arg| {
try zig_args.append(arg);
}
for (rc_source_file.include_paths) |include_path| {
try zig_args.append("/I");
try zig_args.append(include_path.getPath2(module.owner, step));
}
try zig_args.append("--");
prev_has_rcflags = true;
}
Expand Down
14 changes: 10 additions & 4 deletions test/standalone/windows_resources/build.zig
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,21 @@ pub fn build(b: *std.Build) void {
.abi = .gnu,
});

add(b, b.host, .any, test_step);
add(b, target, .any, test_step);
const generated_h_step = b.addWriteFile("generated.h", "#define GENERATED_DEFINE \"foo\"");

add(b, b.host, .gnu, test_step);
add(b, target, .gnu, test_step);
add(b, b.host, .any, test_step, generated_h_step);
add(b, target, .any, test_step, generated_h_step);

add(b, b.host, .gnu, test_step, generated_h_step);
add(b, target, .gnu, test_step, generated_h_step);
}

fn add(
b: *std.Build,
target: std.Build.ResolvedTarget,
rc_includes: enum { any, gnu },
test_step: *std.Build.Step,
generated_h_step: *std.Build.Step.WriteFile,
) void {
const exe = b.addExecutable(.{
.name = "zig_resource_test",
Expand All @@ -32,6 +35,9 @@ fn add(
exe.addWin32ResourceFile(.{
.file = b.path("res/zig.rc"),
.flags = &.{"/c65001"}, // UTF-8 code page
.include_paths = &.{
.{ .generated = &generated_h_step.generated_directory },
},
});
exe.rc_includes = switch (rc_includes) {
.any => .any,
Expand Down
4 changes: 4 additions & 0 deletions test/standalone/windows_resources/res/zig.rc
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
// This include file is generated via build.zig, and it #defines GENERATED_DEFINE
#include "generated.h"
FOO RCDATA { GENERATED_DEFINE }

#define ICO_ID 1

// Nothing from windows.h is used in this .rc file,
Expand Down