From 2a99c8506089646745a9a8d3a41ddc13e59d0384 Mon Sep 17 00:00:00 2001 From: Stephen Gutekanst Date: Mon, 3 Jul 2023 21:18:53 -0700 Subject: [PATCH] glfw: remove system_sdk dependency; add xcode-frameworks Signed-off-by: Stephen Gutekanst --- .gitmodules | 3 + libs/glfw/.gitmodules | 7 +- libs/glfw/build.zig | 238 +----------------------------- libs/glfw/libs/xcode-frameworks | 1 + libs/glfw/sdk.zig | 251 ++++++++++++++++++++++++++++++++ libs/gpu-dawn/build.zig | 2 +- 6 files changed, 266 insertions(+), 236 deletions(-) create mode 160000 libs/glfw/libs/xcode-frameworks create mode 100644 libs/glfw/sdk.zig diff --git a/.gitmodules b/.gitmodules index c08e7932..3564301c 100644 --- a/.gitmodules +++ b/.gitmodules @@ -21,3 +21,6 @@ [submodule "libs/gpu-dawn/libs/xcode-frameworks"] path = libs/gpu-dawn/libs/xcode-frameworks url = https://github.com/hexops/xcode-frameworks +[submodule "libs/glfw/libs/xcode-frameworks"] + path = libs/glfw/libs/xcode-frameworks + url = https://github.com/hexops/xcode-frameworks diff --git a/libs/glfw/.gitmodules b/libs/glfw/.gitmodules index 2fb5ef12..47084e86 100644 --- a/libs/glfw/.gitmodules +++ b/libs/glfw/.gitmodules @@ -1,4 +1,3 @@ -[submodule "upstream"] - path = upstream - url = https://github.com/hexops-graveyard/glfw - +[submodule "libs/xcode-frameworks"] + path = libs/xcode-frameworks + url = https://github.com/hexops/xcode-frameworks diff --git a/libs/glfw/build.zig b/libs/glfw/build.zig index e077c365..e54bf987 100644 --- a/libs/glfw/build.zig +++ b/libs/glfw/build.zig @@ -1,241 +1,17 @@ const builtin = @import("builtin"); const std = @import("std"); const Build = std.Build; - -const system_sdk = @import("system_sdk.zig"); +const glfw = @import("sdk.zig").Sdk(.{ + // TODO(build-system): This cannot be imported with the Zig package manager + // error: TarUnsupportedFileType + .xcode_frameworks = @import("libs/xcode-frameworks/build.zig"), +}); pub fn build(b: *Build) !void { const optimize = b.standardOptimizeOption(.{}); const target = b.standardTargetOptions(.{}); const test_step = b.step("test", "Run library tests"); - test_step.dependOn(&(try testStep(b, optimize, target)).step); - test_step.dependOn(&(try testStepShared(b, optimize, target)).step); -} - -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, - }); - - try link(b, main_tests, .{}); - b.installArtifact(main_tests); - return b.addRunArtifact(main_tests); -} - -fn testStepShared(b: *Build, optimize: std.builtin.OptimizeMode, target: std.zig.CrossTarget) !*std.build.RunStep { - const main_tests = b.addTest(.{ - .name = "glfw-tests-shared", - .root_source_file = .{ .path = sdkPath("/src/main.zig") }, - .target = target, - .optimize = optimize, - }); - - try link(b, main_tests, .{ .shared = true }); - b.installArtifact(main_tests); - return b.addRunArtifact(main_tests); -} - -pub const Options = struct { - /// Not supported on macOS. - vulkan: bool = true, - - /// Only respected on macOS. - metal: bool = true, - - /// Deprecated on macOS. - opengl: bool = false, - - /// Not supported on macOS. GLES v3.2 only, currently. - gles: bool = false, - - /// Only respected on Linux. - x11: bool = true, - - /// Only respected on Linux. - wayland: bool = true, - - /// System SDK options. - system_sdk: system_sdk.Options = .{}, - - /// Build and link GLFW as a shared library. - shared: bool = false, - - install_libs: bool = false, -}; - -var _module: ?*std.build.Module = null; - -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.?; -} - -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) system_sdk.include(b, step, options.system_sdk); -} - -fn buildLibrary(b: *Build, optimize: std.builtin.OptimizeMode, target: std.zig.CrossTarget, options: Options) !*std.build.CompileStep { - // TODO(build-system): https://github.com/hexops/mach/issues/229#issuecomment-1100958939 - ensureDependencySubmodule(b.allocator, "upstream") catch return error.CannotEnsureDependency; - - const lib = if (options.shared) - b.addSharedLibrary(.{ .name = "glfw", .target = target, .optimize = optimize }) - else - b.addStaticLibrary(.{ .name = "glfw", .target = target, .optimize = optimize }); - - if (options.shared) - lib.defineCMacro("_GLFW_BUILD_DLL", null); - - addGLFWIncludes(lib); - try addGLFWSources(b, lib, options); - linkGLFWDependencies(b, lib, options); - - if (options.install_libs) - b.installArtifact(lib); - - return lib; -} - -fn addGLFWIncludes(step: *std.build.CompileStep) void { - step.addIncludePath(sdkPath("/upstream/glfw/include")); - step.addIncludePath(sdkPath("/src")); -} - -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) { - .windows => lib.addCSourceFiles(&.{ - sdkPath("/src/sources_all.c"), - sdkPath("/src/sources_windows.c"), - }, &.{ "-D_GLFW_WIN32", include_glfw_src }), - .macos => lib.addCSourceFiles(&.{ - sdkPath("/src/sources_all.c"), - sdkPath("/src/sources_macos.m"), - sdkPath("/src/sources_macos.c"), - }, &.{ "-D_GLFW_COCOA", include_glfw_src }), - else => { - // TODO(future): for now, Linux can't be built with musl: - // - // ``` - // 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) { - 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) system_sdk.include(b, step, options.system_sdk); - 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 { - 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: { - const root_dir = std.fs.path.dirname(@src().file) orelse "."; - break :blk root_dir ++ suffix; - }; + test_step.dependOn(&(try glfw.testStep(b, optimize, target)).step); + test_step.dependOn(&(try glfw.testStepShared(b, optimize, target)).step); } diff --git a/libs/glfw/libs/xcode-frameworks b/libs/glfw/libs/xcode-frameworks new file mode 160000 index 00000000..ed8cfb52 --- /dev/null +++ b/libs/glfw/libs/xcode-frameworks @@ -0,0 +1 @@ +Subproject commit ed8cfb5270876725e78874d281df32e0919c4d1f diff --git a/libs/glfw/sdk.zig b/libs/glfw/sdk.zig new file mode 100644 index 00000000..88e40319 --- /dev/null +++ b/libs/glfw/sdk.zig @@ -0,0 +1,251 @@ +const builtin = @import("builtin"); +const std = @import("std"); +const Build = std.Build; + +pub fn Sdk(comptime deps: anytype) type { + return struct { + 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, + }); + + try link(b, main_tests, .{}); + b.installArtifact(main_tests); + return b.addRunArtifact(main_tests); + } + + pub fn testStepShared(b: *Build, optimize: std.builtin.OptimizeMode, target: std.zig.CrossTarget) !*std.build.RunStep { + const main_tests = b.addTest(.{ + .name = "glfw-tests-shared", + .root_source_file = .{ .path = sdkPath("/src/main.zig") }, + .target = target, + .optimize = optimize, + }); + + try link(b, main_tests, .{ .shared = true }); + b.installArtifact(main_tests); + return b.addRunArtifact(main_tests); + } + + pub const Options = struct { + /// Not supported on macOS. + vulkan: bool = true, + + /// Only respected on macOS. + metal: bool = true, + + /// Deprecated on macOS. + opengl: bool = false, + + /// Not supported on macOS. GLES v3.2 only, currently. + gles: bool = false, + + /// Only respected on Linux. + x11: bool = true, + + /// Only respected on Linux. + wayland: bool = true, + + /// Build and link GLFW as a shared library. + shared: bool = false, + + install_libs: bool = false, + }; + + var _module: ?*std.build.Module = null; + + 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.?; + } + + 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); + deps.xcode_frameworks.addPaths(step); + } + } + + fn buildLibrary(b: *Build, optimize: std.builtin.OptimizeMode, target: std.zig.CrossTarget, options: Options) !*std.build.CompileStep { + // TODO(build-system): https://github.com/hexops/mach/issues/229#issuecomment-1100958939 + ensureDependencySubmodule(b.allocator, "upstream") catch return error.CannotEnsureDependency; + + const lib = if (options.shared) + b.addSharedLibrary(.{ .name = "glfw", .target = target, .optimize = optimize }) + else + b.addStaticLibrary(.{ .name = "glfw", .target = target, .optimize = optimize }); + + if (options.shared) + lib.defineCMacro("_GLFW_BUILD_DLL", null); + + addGLFWIncludes(lib); + try addGLFWSources(b, lib, options); + linkGLFWDependencies(b, lib, options); + + if (options.install_libs) + b.installArtifact(lib); + + return lib; + } + + fn addGLFWIncludes(step: *std.build.CompileStep) void { + step.addIncludePath(sdkPath("/upstream/glfw/include")); + step.addIncludePath(sdkPath("/src")); + } + + 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) { + .windows => lib.addCSourceFiles(&.{ + sdkPath("/src/sources_all.c"), + sdkPath("/src/sources_windows.c"), + }, &.{ "-D_GLFW_WIN32", include_glfw_src }), + .macos => lib.addCSourceFiles(&.{ + sdkPath("/src/sources_all.c"), + sdkPath("/src/sources_macos.m"), + sdkPath("/src/sources_macos.c"), + }, &.{ "-D_GLFW_COCOA", include_glfw_src }), + else => { + // TODO(future): for now, Linux can't be built with musl: + // + // ``` + // 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) { + 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); + 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 { + 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: { + const root_dir = std.fs.path.dirname(@src().file) orelse "."; + break :blk root_dir ++ suffix; + }; + } + }; +} diff --git a/libs/gpu-dawn/build.zig b/libs/gpu-dawn/build.zig index 0a3c8d47..2e153897 100644 --- a/libs/gpu-dawn/build.zig +++ b/libs/gpu-dawn/build.zig @@ -26,7 +26,7 @@ pub fn build(b: *Build) !void { .optimize = optimize, }); try gpu_dawn.link(b, example, options); - try glfw.link(b, example, .{ .system_sdk = .{ .set_sysroot = false } }); + try glfw.link(b, example, .{}); example.addModule("glfw", glfw.module(b)); b.installArtifact(example); }