falsepattern/zig-glfw
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

glfw: remove xcode_frameworks submodule; Sdk type

Browse source 
Signed-off-by: Stephen Gutekanst <stephen@hexops.com>
This commit is contained in:
Stephen Gutekanst 2023-07-06 23:45:18 -07:00
parent 3ef11aec02
commit 98418ac4dc
2 changed files with 325 additions and 229 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -54,11 +54,7 @@ Then in your `build.zig` add:
```zig ```zig
... ...
const glfw = @import("libs/mach-glfw/build.zig").Sdk(.{ const glfw = @import("libs/mach-glfw/build.zig");
// TODO(build-system): This cannot be imported with the Zig package manager
// error: TarUnsupportedFileType
.xcode_frameworks = @import("libs/mach-glfw/libs/xcode-frameworks/build.zig"),
});
pub fn build(b: *Build) !void { pub fn build(b: *Build) !void {
... ...

548
build.zig
View file

@ -6,261 +6,361 @@ pub fn build(b: *Build) !void {
const optimize = b.standardOptimizeOption(.{}); const optimize = b.standardOptimizeOption(.{});
const target = b.standardTargetOptions(.{}); const target = b.standardTargetOptions(.{});
const glfw = Sdk(.{ const test_step = b.step("test", "Run library tests");
// TODO(build-system): This cannot be imported with the Zig package manager test_step.dependOn(&(try testStep(b, optimize, target)).step);
// error: TarUnsupportedFileType test_step.dependOn(&(try testStepShared(b, optimize, target)).step);
.xcode_frameworks = @import("libs/xcode-frameworks/build.zig"), }
pub fn testStep(b: *Build, optimize: std.builtin.OptimizeMode, target: std.zig.CrossTarget) !*std.build.RunStep {
const main_tests = b.addTest(.{
.name = "glfw-tests",
.root_source_file = .{ .path = sdkPath("/src/main.zig") },
.target = target,
.optimize = optimize,
}); });
const test_step = b.step("test", "Run library tests"); try link(b, main_tests, .{});
test_step.dependOn(&(try glfw.testStep(b, optimize, target)).step); b.installArtifact(main_tests);
test_step.dependOn(&(try glfw.testStepShared(b, optimize, target)).step); return b.addRunArtifact(main_tests);
} }
pub fn Sdk(comptime deps: anytype) type { pub fn testStepShared(b: *Build, optimize: std.builtin.OptimizeMode, target: std.zig.CrossTarget) !*std.build.RunStep {
return struct { const main_tests = b.addTest(.{
pub fn testStep(b: *Build, optimize: std.builtin.OptimizeMode, target: std.zig.CrossTarget) !*std.build.RunStep { .name = "glfw-tests-shared",
const main_tests = b.addTest(.{ .root_source_file = .{ .path = sdkPath("/src/main.zig") },
.name = "glfw-tests", .target = target,
.root_source_file = .{ .path = sdkPath("/src/main.zig") }, .optimize = optimize,
.target = target, });
.optimize = optimize,
});
try link(b, main_tests, .{}); try link(b, main_tests, .{ .shared = true });
b.installArtifact(main_tests); b.installArtifact(main_tests);
return b.addRunArtifact(main_tests); return b.addRunArtifact(main_tests);
} }
pub fn testStepShared(b: *Build, optimize: std.builtin.OptimizeMode, target: std.zig.CrossTarget) !*std.build.RunStep { pub const Options = struct {
const main_tests = b.addTest(.{ /// Not supported on macOS.
.name = "glfw-tests-shared", vulkan: bool = true,
.root_source_file = .{ .path = sdkPath("/src/main.zig") },
.target = target,
.optimize = optimize,
});
try link(b, main_tests, .{ .shared = true }); /// Only respected on macOS.
b.installArtifact(main_tests); metal: bool = true,
return b.addRunArtifact(main_tests);
}
pub const Options = struct { /// Deprecated on macOS.
/// Not supported on macOS. opengl: bool = false,
vulkan: bool = true,
/// Only respected on macOS. /// Not supported on macOS. GLES v3.2 only, currently.
metal: bool = true, gles: bool = false,
/// Deprecated on macOS. /// Only respected on Linux.
opengl: bool = false, x11: bool = true,
/// Not supported on macOS. GLES v3.2 only, currently. /// Only respected on Linux.
gles: bool = false, wayland: bool = true,
/// Only respected on Linux. /// Build and link GLFW as a shared library.
x11: bool = true, shared: bool = false,
/// Only respected on Linux. install_libs: bool = false,
wayland: bool = true, };
/// Build and link GLFW as a shared library. var _module: ?*std.build.Module = null;
shared: bool = false,
install_libs: bool = false, pub fn module(b: *std.Build) *std.build.Module {
}; if (_module) |m| return m;
_module = b.createModule(.{
.source_file = .{ .path = sdkPath("/src/main.zig") },
});
return _module.?;
}
var _module: ?*std.build.Module = null; pub fn link(b: *Build, step: *std.build.CompileStep, options: Options) !void {
if (options.shared) step.defineCMacro("GLFW_DLL", null);
const lib = try buildLibrary(b, step.optimize, step.target, options);
step.linkLibrary(lib);
addGLFWIncludes(step);
linkGLFWDependencies(b, step, options);
if (step.target_info.target.os.tag == .macos) {
// TODO(build-system): This cannot be imported with the Zig package manager
// error: TarUnsupportedFileType
//
// step.linkLibrary(b.dependency("xcode_frameworks", .{
// .target = step.target,
// .optimize = step.optimize,
// }).artifact("xcode-frameworks"));
// @import("xcode_frameworks").addPaths(step);
xcode_frameworks.addPaths(b, step);
}
}
pub fn module(b: *std.Build) *std.build.Module { fn buildLibrary(b: *Build, optimize: std.builtin.OptimizeMode, target: std.zig.CrossTarget, options: Options) !*std.build.CompileStep {
if (_module) |m| return m; // TODO(build-system): https://github.com/hexops/mach/issues/229#issuecomment-1100958939
_module = b.createModule(.{ ensureDependencySubmodule(b.allocator, "upstream") catch return error.CannotEnsureDependency;
.source_file = .{ .path = sdkPath("/src/main.zig") },
});
return _module.?;
}
pub fn link(b: *Build, step: *std.build.CompileStep, options: Options) !void { const lib = if (options.shared)
if (options.shared) step.defineCMacro("GLFW_DLL", null); b.addSharedLibrary(.{ .name = "glfw", .target = target, .optimize = optimize })
const lib = try buildLibrary(b, step.optimize, step.target, options); else
step.linkLibrary(lib); b.addStaticLibrary(.{ .name = "glfw", .target = target, .optimize = optimize });
addGLFWIncludes(step);
linkGLFWDependencies(b, step, options);
if (step.target_info.target.os.tag == .macos) {
// TODO(build-system): This cannot be imported with the Zig package manager
// error: TarUnsupportedFileType
//
// step.linkLibrary(b.dependency("xcode_frameworks", .{
// .target = step.target,
// .optimize = step.optimize,
// }).artifact("xcode-frameworks"));
// @import("xcode_frameworks").addPaths(step);
deps.xcode_frameworks.addPaths(step);
}
}
fn buildLibrary(b: *Build, optimize: std.builtin.OptimizeMode, target: std.zig.CrossTarget, options: Options) !*std.build.CompileStep { if (options.shared)
// TODO(build-system): https://github.com/hexops/mach/issues/229#issuecomment-1100958939 lib.defineCMacro("_GLFW_BUILD_DLL", null);
ensureDependencySubmodule(b.allocator, "upstream") catch return error.CannotEnsureDependency;
const lib = if (options.shared) addGLFWIncludes(lib);
b.addSharedLibrary(.{ .name = "glfw", .target = target, .optimize = optimize }) try addGLFWSources(b, lib, options);
else linkGLFWDependencies(b, lib, options);
b.addStaticLibrary(.{ .name = "glfw", .target = target, .optimize = optimize });
if (options.shared) if (options.install_libs)
lib.defineCMacro("_GLFW_BUILD_DLL", null); b.installArtifact(lib);
addGLFWIncludes(lib); return lib;
try addGLFWSources(b, lib, options); }
linkGLFWDependencies(b, lib, options);
if (options.install_libs) fn addGLFWIncludes(step: *std.build.CompileStep) void {
b.installArtifact(lib); step.addIncludePath(sdkPath("/upstream/glfw/include"));
step.addIncludePath(sdkPath("/src"));
}
return lib; fn addGLFWSources(b: *Build, lib: *std.build.CompileStep, options: Options) std.mem.Allocator.Error!void {
} const include_glfw_src = comptime "-I" ++ sdkPath("/upstream/glfw/src");
switch (lib.target_info.target.os.tag) {
fn addGLFWIncludes(step: *std.build.CompileStep) void { .windows => lib.addCSourceFiles(&.{
step.addIncludePath(sdkPath("/upstream/glfw/include")); sdkPath("/src/sources_all.c"),
step.addIncludePath(sdkPath("/src")); sdkPath("/src/sources_windows.c"),
} }, &.{ "-D_GLFW_WIN32", include_glfw_src }),
.macos => lib.addCSourceFiles(&.{
fn addGLFWSources(b: *Build, lib: *std.build.CompileStep, options: Options) std.mem.Allocator.Error!void { sdkPath("/src/sources_all.c"),
const include_glfw_src = comptime "-I" ++ sdkPath("/upstream/glfw/src"); sdkPath("/src/sources_macos.m"),
switch (lib.target_info.target.os.tag) { sdkPath("/src/sources_macos.c"),
.windows => lib.addCSourceFiles(&.{ }, &.{ "-D_GLFW_COCOA", include_glfw_src }),
sdkPath("/src/sources_all.c"), else => {
sdkPath("/src/sources_windows.c"), // TODO(future): for now, Linux can't be built with musl:
}, &.{ "-D_GLFW_WIN32", include_glfw_src }), //
.macos => lib.addCSourceFiles(&.{ // ```
sdkPath("/src/sources_all.c"), // ld.lld: error: cannot create a copy relocation for symbol stderr
sdkPath("/src/sources_macos.m"), // thread 2004762 panic: attempt to unwrap error: LLDReportedFailure
sdkPath("/src/sources_macos.c"), // ```
}, &.{ "-D_GLFW_COCOA", include_glfw_src }), var sources = std.ArrayList([]const u8).init(b.allocator);
else => { var flags = std.ArrayList([]const u8).init(b.allocator);
// TODO(future): for now, Linux can't be built with musl: try sources.append(sdkPath("/src/sources_all.c"));
// try sources.append(sdkPath("/src/sources_linux.c"));
// ```
// ld.lld: error: cannot create a copy relocation for symbol stderr
// thread 2004762 panic: attempt to unwrap error: LLDReportedFailure
// ```
var sources = std.ArrayList([]const u8).init(b.allocator);
var flags = std.ArrayList([]const u8).init(b.allocator);
try sources.append(sdkPath("/src/sources_all.c"));
try sources.append(sdkPath("/src/sources_linux.c"));
if (options.x11) {
try sources.append(sdkPath("/src/sources_linux_x11.c"));
try flags.append("-D_GLFW_X11");
}
if (options.wayland) {
try sources.append(sdkPath("/src/sources_linux_wayland.c"));
try flags.append("-D_GLFW_WAYLAND");
}
try flags.append(comptime "-I" ++ sdkPath("/upstream/glfw/src"));
// TODO(upstream): glfw can't compile on clang15 without this flag
try flags.append("-Wno-implicit-function-declaration");
lib.addCSourceFiles(sources.items, flags.items);
},
}
}
fn linkGLFWDependencies(b: *Build, step: *std.build.CompileStep, options: Options) void {
if (step.target_info.target.os.tag == .windows) {
step.linkLibrary(b.dependency("direct3d_headers", .{
.target = step.target,
.optimize = step.optimize,
}).artifact("direct3d-headers"));
}
if (options.x11) { if (options.x11) {
step.linkLibrary(b.dependency("x11_headers", .{ try sources.append(sdkPath("/src/sources_linux_x11.c"));
.target = step.target, try flags.append("-D_GLFW_X11");
.optimize = step.optimize,
}).artifact("x11-headers"));
}
if (options.vulkan) {
step.linkLibrary(b.dependency("vulkan_headers", .{
.target = step.target,
.optimize = step.optimize,
}).artifact("vulkan-headers"));
} }
if (options.wayland) {
try sources.append(sdkPath("/src/sources_linux_wayland.c"));
try flags.append("-D_GLFW_WAYLAND");
}
try flags.append(comptime "-I" ++ sdkPath("/upstream/glfw/src"));
// TODO(upstream): glfw can't compile on clang15 without this flag
try flags.append("-Wno-implicit-function-declaration");
lib.addCSourceFiles(sources.items, flags.items);
},
}
}
fn linkGLFWDependencies(b: *Build, step: *std.build.CompileStep, options: Options) void {
if (step.target_info.target.os.tag == .windows) {
step.linkLibrary(b.dependency("direct3d_headers", .{
.target = step.target,
.optimize = step.optimize,
}).artifact("direct3d-headers"));
}
if (options.x11) {
step.linkLibrary(b.dependency("x11_headers", .{
.target = step.target,
.optimize = step.optimize,
}).artifact("x11-headers"));
}
if (options.vulkan) {
step.linkLibrary(b.dependency("vulkan_headers", .{
.target = step.target,
.optimize = step.optimize,
}).artifact("vulkan-headers"));
}
if (options.wayland) {
step.defineCMacro("WL_MARSHAL_FLAG_DESTROY", null);
step.linkLibrary(b.dependency("wayland_headers", .{
.target = step.target,
.optimize = step.optimize,
}).artifact("wayland-headers"));
}
if (step.target_info.target.os.tag == .windows) @import("direct3d_headers").addLibraryPath(step);
step.linkLibC();
if (step.target_info.target.os.tag == .macos) {
// TODO(build-system): This cannot be imported with the Zig package manager
// error: TarUnsupportedFileType
//
// step.linkLibrary(b.dependency("xcode_frameworks", .{
// .target = step.target,
// .optimize = step.optimize,
// }).artifact("xcode-frameworks"));
// @import("xcode_frameworks").addPaths(step);
xcode_frameworks.addPaths(b, step);
}
switch (step.target_info.target.os.tag) {
.windows => {
step.linkSystemLibraryName("gdi32");
step.linkSystemLibraryName("user32");
step.linkSystemLibraryName("shell32");
if (options.opengl) {
step.linkSystemLibraryName("opengl32");
}
if (options.gles) {
step.linkSystemLibraryName("GLESv3");
}
},
.macos => {
step.linkFramework("IOKit");
step.linkFramework("CoreFoundation");
if (options.metal) {
step.linkFramework("Metal");
}
if (options.opengl) {
step.linkFramework("OpenGL");
}
step.linkSystemLibraryName("objc");
step.linkFramework("AppKit");
step.linkFramework("CoreServices");
step.linkFramework("CoreGraphics");
step.linkFramework("Foundation");
},
else => {
// Assume Linux-like
if (options.wayland) { if (options.wayland) {
step.defineCMacro("WL_MARSHAL_FLAG_DESTROY", null); step.defineCMacro("WL_MARSHAL_FLAG_DESTROY", null);
step.linkLibrary(b.dependency("wayland_headers", .{
.target = step.target,
.optimize = step.optimize,
}).artifact("wayland-headers"));
} }
if (step.target_info.target.os.tag == .windows) @import("direct3d_headers").addLibraryPath(step); },
}
}
step.linkLibC(); fn ensureDependencySubmodule(allocator: std.mem.Allocator, path: []const u8) !void {
if (step.target_info.target.os.tag == .macos) { if (std.process.getEnvVarOwned(allocator, "NO_ENSURE_SUBMODULES")) |no_ensure_submodules| {
// TODO(build-system): This cannot be imported with the Zig package manager defer allocator.free(no_ensure_submodules);
// error: TarUnsupportedFileType if (std.mem.eql(u8, no_ensure_submodules, "true")) return;
// } else |_| {}
// step.linkLibrary(b.dependency("xcode_frameworks", .{ var child = std.ChildProcess.init(&.{ "git", "submodule", "update", "--init", path }, allocator);
// .target = step.target, child.cwd = sdkPath("/");
// .optimize = step.optimize, child.stderr = std.io.getStdErr();
// }).artifact("xcode-frameworks")); child.stdout = std.io.getStdOut();
// @import("xcode_frameworks").addPaths(step);
deps.xcode_frameworks.addPaths(step);
}
switch (step.target_info.target.os.tag) {
.windows => {
step.linkSystemLibraryName("gdi32");
step.linkSystemLibraryName("user32");
step.linkSystemLibraryName("shell32");
if (options.opengl) {
step.linkSystemLibraryName("opengl32");
}
if (options.gles) {
step.linkSystemLibraryName("GLESv3");
}
},
.macos => {
step.linkFramework("IOKit");
step.linkFramework("CoreFoundation");
if (options.metal) {
step.linkFramework("Metal");
}
if (options.opengl) {
step.linkFramework("OpenGL");
}
step.linkSystemLibraryName("objc");
step.linkFramework("AppKit");
step.linkFramework("CoreServices");
step.linkFramework("CoreGraphics");
step.linkFramework("Foundation");
},
else => {
// Assume Linux-like
if (options.wayland) {
step.defineCMacro("WL_MARSHAL_FLAG_DESTROY", null);
}
},
}
}
fn ensureDependencySubmodule(allocator: std.mem.Allocator, path: []const u8) !void { _ = try child.spawnAndWait();
if (std.process.getEnvVarOwned(allocator, "NO_ENSURE_SUBMODULES")) |no_ensure_submodules| { }
defer allocator.free(no_ensure_submodules);
if (std.mem.eql(u8, no_ensure_submodules, "true")) return;
} else |_| {}
var child = std.ChildProcess.init(&.{ "git", "submodule", "update", "--init", path }, allocator);
child.cwd = sdkPath("/");
child.stderr = std.io.getStdErr();
child.stdout = std.io.getStdOut();
_ = try child.spawnAndWait(); fn sdkPath(comptime suffix: []const u8) []const u8 {
} if (suffix[0] != '/') @compileError("suffix must be an absolute path");
return comptime blk: {
fn sdkPath(comptime suffix: []const u8) []const u8 { const root_dir = std.fs.path.dirname(@src().file) orelse ".";
if (suffix[0] != '/') @compileError("suffix must be an absolute path"); break :blk root_dir ++ suffix;
return comptime blk: {
const root_dir = std.fs.path.dirname(@src().file) orelse ".";
break :blk root_dir ++ suffix;
};
}
}; };
} }
// TODO(build-system): This is a workaround that we copy anywhere xcode_frameworks needs to be used.
// With the Zig package manager, it should be possible to remove this entirely and instead just
// write:
//
// ```
// step.linkLibrary(b.dependency("xcode_frameworks", .{
// .target = step.target,
// .optimize = step.optimize,
// }).artifact("xcode-frameworks"));
// @import("xcode_frameworks").addPaths(step);
// ```
//
// However, today this package cannot be imported with the Zig package manager due to `error: TarUnsupportedFileType`
// which would be fixed by https://github.com/ziglang/zig/pull/15382 - so instead for now you must
// copy+paste this struct into your `build.zig` and write:
//
// ```
// try xcode_frameworks.addPaths(b, step);
// ```
const xcode_frameworks = struct {
pub fn addPaths(b: *std.Build, step: *std.build.CompileStep) void {
// branch: mach
ensureGitRepoCloned(b.allocator, "https://github.com/hexops/xcode-frameworks", "723aa55e9752c8c6c25d3413722b5fe13d72ac4f", "zig-cache/xcode_frameworks") catch |err| @panic(@errorName(err));
step.addFrameworkPath("zig-cache/xcode_frameworks/Frameworks");
step.addSystemIncludePath("zig-cache/xcode_frameworks/include");
step.addLibraryPath("zig-cache/xcode_frameworks/lib");
}
fn xcodeSdkPath(comptime suffix: []const u8) []const u8 {
if (suffix[0] != '/') @compileError("suffix must be an absolute path");
return comptime blk: {
const root_dir = std.fs.path.dirname(@src().file) orelse ".";
break :blk root_dir ++ suffix;
};
}
fn ensureGitRepoCloned(allocator: std.mem.Allocator, clone_url: []const u8, revision: []const u8, rel_dir: []const u8) !void {
if (isEnvVarTruthy(allocator, "NO_ENSURE_SUBMODULES") or isEnvVarTruthy(allocator, "NO_ENSURE_GIT")) {
return;
}
ensureGit(allocator);
if (std.fs.cwd().realpathAlloc(allocator, rel_dir)) |dir| {
const current_revision = try getCurrentGitRevision(allocator, dir);
if (!std.mem.eql(u8, current_revision, revision)) {
// Reset to the desired revision
exec(allocator, &[_][]const u8{ "git", "fetch" }, dir) catch |err| std.debug.print("warning: failed to 'git fetch' in {s}: {s}\n", .{ dir, @errorName(err) });
try exec(allocator, &[_][]const u8{ "git", "checkout", "--quiet", "--force", revision }, dir);
try exec(allocator, &[_][]const u8{ "git", "submodule", "update", "--init", "--recursive" }, dir);
}
return;
} else |err| return switch (err) {
error.FileNotFound => {
std.log.info("cloning required dependency..\ngit clone {s} {s}..\n", .{ clone_url, rel_dir });
try exec(allocator, &[_][]const u8{ "git", "clone", "-c", "core.longpaths=true", clone_url, rel_dir }, xcodeSdkPath("/"));
try exec(allocator, &[_][]const u8{ "git", "checkout", "--quiet", "--force", revision }, rel_dir);
try exec(allocator, &[_][]const u8{ "git", "submodule", "update", "--init", "--recursive" }, rel_dir);
return;
},
else => err,
};
}
fn exec(allocator: std.mem.Allocator, argv: []const []const u8, cwd: []const u8) !void {
var child = std.ChildProcess.init(argv, allocator);
child.cwd = cwd;
_ = try child.spawnAndWait();
}
fn getCurrentGitRevision(allocator: std.mem.Allocator, cwd: []const u8) ![]const u8 {
const result = try std.ChildProcess.exec(.{ .allocator = allocator, .argv = &.{ "git", "rev-parse", "HEAD" }, .cwd = cwd });
allocator.free(result.stderr);
if (result.stdout.len > 0) return result.stdout[0 .. result.stdout.len - 1]; // trim newline
return result.stdout;
}
fn ensureGit(allocator: std.mem.Allocator) void {
const argv = &[_][]const u8{ "git", "--version" };
const result = std.ChildProcess.exec(.{
.allocator = allocator,
.argv = argv,
.cwd = ".",
}) catch { // e.g. FileNotFound
std.log.err("mach: error: 'git --version' failed. Is git not installed?", .{});
std.process.exit(1);
};
defer {
allocator.free(result.stderr);
allocator.free(result.stdout);
}
if (result.term.Exited != 0) {
std.log.err("mach: error: 'git --version' failed. Is git not installed?", .{});
std.process.exit(1);
}
}
fn isEnvVarTruthy(allocator: std.mem.Allocator, name: []const u8) bool {
if (std.process.getEnvVarOwned(allocator, name)) |truthy| {
defer allocator.free(truthy);
if (std.mem.eql(u8, truthy, "true")) return true;
return false;
} else |_| {
return false;
}
}
};