From d57a6d3b6dbfd0584f0f060920e1faae0b018669 Mon Sep 17 00:00:00 2001 From: Stephen Gutekanst Date: Thu, 6 Jul 2023 23:24:57 -0700 Subject: [PATCH] sysaudio: remove xcode_frameworks submodule Signed-off-by: Stephen Gutekanst --- .gitmodules | 3 - build.zig | 6 +- libs/sysaudio/.gitmodules | 3 - libs/sysaudio/build.zig | 120 ++++++++++++++++++++++++++-- libs/sysaudio/libs/xcode-frameworks | 1 - 5 files changed, 114 insertions(+), 19 deletions(-) delete mode 100644 libs/sysaudio/.gitmodules delete mode 160000 libs/sysaudio/libs/xcode-frameworks diff --git a/.gitmodules b/.gitmodules index 3564301c..95e478b8 100644 --- a/.gitmodules +++ b/.gitmodules @@ -15,9 +15,6 @@ [submodule "glfw/upstream"] path = libs/glfw/upstream url = https://github.com/hexops-graveyard/glfw -[submodule "libs/sysaudio/libs/xcode-frameworks"] - path = libs/sysaudio/libs/xcode-frameworks - url = https://github.com/hexops/xcode-frameworks [submodule "libs/gpu-dawn/libs/xcode-frameworks"] path = libs/gpu-dawn/libs/xcode-frameworks url = https://github.com/hexops/xcode-frameworks diff --git a/build.zig b/build.zig index 138c4a64..3a7a6c65 100644 --- a/build.zig +++ b/build.zig @@ -6,11 +6,7 @@ const glfw = @import("libs/glfw/build.zig").Sdk(.{ // error: TarUnsupportedFileType .xcode_frameworks = @import("libs/gpu-dawn/libs/xcode-frameworks/build.zig"), }); -const sysaudio = @import("libs/sysaudio/build.zig").Sdk(.{ - // TODO(build-system): This cannot be imported with the Zig package manager - // error: TarUnsupportedFileType - .xcode_frameworks = @import("libs/gpu-dawn/libs/xcode-frameworks/build.zig"), -}); +const sysaudio = @import("mach_sysaudio").Sdk(); pub const gpu_dawn = @import("libs/gpu-dawn/build.zig").Sdk(.{ // TODO(build-system): This cannot be imported with the Zig package manager // error: TarUnsupportedFileType diff --git a/libs/sysaudio/.gitmodules b/libs/sysaudio/.gitmodules deleted file mode 100644 index 47084e86..00000000 --- a/libs/sysaudio/.gitmodules +++ /dev/null @@ -1,3 +0,0 @@ -[submodule "libs/xcode-frameworks"] - path = libs/xcode-frameworks - url = https://github.com/hexops/xcode-frameworks diff --git a/libs/sysaudio/build.zig b/libs/sysaudio/build.zig index 62dbb444..5617d9bc 100644 --- a/libs/sysaudio/build.zig +++ b/libs/sysaudio/build.zig @@ -3,11 +3,7 @@ const std = @import("std"); pub fn build(b: *std.Build) void { const optimize = b.standardOptimizeOption(.{}); const target = b.standardTargetOptions(.{}); - const sysaudio = Sdk(.{ - // TODO(build-system): This cannot be imported with the Zig package manager - // error: TarUnsupportedFileType - .xcode_frameworks = @import("libs/xcode-frameworks/build.zig"), - }); + const sysaudio = Sdk(); const test_step = b.step("test", "Run library tests"); test_step.dependOn(&sysaudio.testStep(b, optimize, target).step); @@ -39,7 +35,7 @@ pub fn build(b: *std.Build) void { } } -pub fn Sdk(comptime deps: anytype) type { +pub fn Sdk() type { return struct { pub const Options = struct { install_libs: bool = false, @@ -92,7 +88,7 @@ pub fn Sdk(comptime deps: anytype) type { // .optimize = step.optimize, // }).artifact("xcode-frameworks")); // @import("xcode_frameworks").addPaths(step); - deps.xcode_frameworks.addPaths(step); + xcode_frameworks.addPaths(b, step); step.linkFramework("AudioToolbox"); step.linkFramework("CoreFoundation"); @@ -133,3 +129,113 @@ pub fn Sdk(comptime deps: anytype) type { } }; } + +// 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; + } + } +}; diff --git a/libs/sysaudio/libs/xcode-frameworks b/libs/sysaudio/libs/xcode-frameworks deleted file mode 160000 index 723aa55e..00000000 --- a/libs/sysaudio/libs/xcode-frameworks +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 723aa55e9752c8c6c25d3413722b5fe13d72ac4f