* all: build: fix sdkPath for relative @src.file
Prior to this commit, the build system heavily assumed that the result
`@src.file` would always be absolute, but this is no longer
guaranteed, likely due to there being no such thing as an "absolute
path" in WASI.
It appears that for normal invocations of `zig build`, it is safe to
assume that `@src.file` is absolute. However, when ZLS uses a custom
`build_runner.zig` to collect build configuration, `@src.file` is
actually relative to the current working directory, at least on my
system. For a while, this led to ZLS completions breaking entirely,
but presently it actually causes ZLS to crash!
The solution is not as simple as using relative `sdkPath` results
as-is, because the build system may attempt to resolve these paths
relative to build root, when the paths are actually relative to the
current working directory.
This leads to a sticky situation: the current working directory is a
runtime concept, but `@src.file` is resolved at compile time. However,
it appears that the build runner does not change current working
directory in between compilation and execution, so it is probably safe
to calculate `sdkPath` using runtime current working directory.
Still, this requires major changes with how `sdkPath` works, since
runtime computation and allocations are required. So pretty much
anything that relied on `sdkPath` being comptime-known has been
refactored in this commit.
The most severe result of this is that, for example, `gpu.pkg` can no
longer be a comptime-known constant: it has to be a runtime function
that takes a `*Builder` and returns a `Pkg`.
This commit deals with usages of `*.pkg` and `sdkPath` within Mach
itself, but projects that depend on Mach such as `mach-examples` will
almost certainly require changes as well.
* all: update README to reflect change in pkg usage
For details on updating your code to use this version, see: 88b1106953
Signed-off-by: Stephen Gutekanst <stephen@hexops.com>
Co-authored-by: Stephen Gutekanst <stephen@hexops.com>
74 lines
2.7 KiB
Zig
74 lines
2.7 KiB
Zig
const std = @import("std");
|
|
const Builder = std.build.Builder;
|
|
|
|
pub fn Sdk(comptime deps: anytype) type {
|
|
return struct {
|
|
pub fn testStep(b: *Builder, mode: std.builtin.Mode, target: std.zig.CrossTarget, options: Options) !*std.build.RunStep {
|
|
const main_tests = b.addTestExe("gpu-tests", sdkPath(b, "/src/main.zig"));
|
|
main_tests.setBuildMode(mode);
|
|
main_tests.setTarget(target);
|
|
try link(b, main_tests, options);
|
|
main_tests.install();
|
|
return main_tests.run();
|
|
}
|
|
|
|
pub const Options = struct {
|
|
glfw_options: deps.glfw.Options = .{},
|
|
gpu_dawn_options: deps.gpu_dawn.Options = .{},
|
|
};
|
|
|
|
var cached_pkg: ?std.build.Pkg = null;
|
|
|
|
pub fn pkg(b: *Builder) std.build.Pkg {
|
|
if (cached_pkg == null) {
|
|
const dependencies = b.allocator.create([1]std.build.Pkg) catch unreachable;
|
|
dependencies.* = .{
|
|
deps.glfw.pkg(b),
|
|
};
|
|
|
|
cached_pkg = .{
|
|
.name = "gpu",
|
|
.source = .{ .path = sdkPath(b, "/src/main.zig") },
|
|
.dependencies = dependencies,
|
|
};
|
|
}
|
|
|
|
return cached_pkg.?;
|
|
}
|
|
|
|
pub fn link(b: *std.build.Builder, step: *std.build.LibExeObjStep, options: Options) !void {
|
|
if (step.target.toTarget().cpu.arch != .wasm32) {
|
|
try deps.glfw.link(b, step, options.glfw_options);
|
|
try deps.gpu_dawn.link(b, step, options.gpu_dawn_options);
|
|
step.addCSourceFile(sdkPath(b, "/src/mach_dawn.cpp"), &.{"-std=c++17"});
|
|
step.addIncludePath(sdkPath(b, "/src"));
|
|
}
|
|
}
|
|
|
|
var this_dir: ?[]const u8 = null;
|
|
|
|
fn thisDir(allocator: std.mem.Allocator) []const u8 {
|
|
if (this_dir == null) {
|
|
const unresolved_dir = comptime std.fs.path.dirname(@src().file) orelse ".";
|
|
|
|
if (comptime unresolved_dir[0] == '/') {
|
|
this_dir = unresolved_dir;
|
|
} else {
|
|
this_dir = std.fs.cwd().realpathAlloc(allocator, unresolved_dir) catch unreachable;
|
|
}
|
|
}
|
|
|
|
return this_dir.?;
|
|
}
|
|
|
|
fn sdkPath(b: *Builder, comptime suffix: []const u8) []const u8 {
|
|
return sdkPathAllocator(b.allocator, suffix);
|
|
}
|
|
|
|
fn sdkPathAllocator(allocator: std.mem.Allocator, comptime suffix: []const u8) []const u8 {
|
|
if (suffix[0] != '/') @compileError("suffix must be an absolute path");
|
|
|
|
return std.fs.path.resolve(allocator, &.{ thisDir(allocator), suffix[1..] }) catch unreachable;
|
|
}
|
|
};
|
|
}
|