use xcode-frameworks via package manager

Works around hexops/mach#903

Signed-off-by: Stephen Gutekanst <stephen@hexops.com>

build.zig

@@ -25,15 +25,7 @@ pub fn build(b: *Build) !void {
         .optimize = lib.optimize,
     }).artifact("vulkan-headers"));
     if (lib.target_info.target.os.tag == .macos) {
-        // TODO(build-system): This cannot be imported with the Zig package manager
+        @import("xcode_frameworks").addPaths(b, lib);
-        // error: TarUnsupportedFileType
-        //
-        // lib.linkLibrary(b.dependency("xcode_frameworks", .{
-        //     .target = lib.target,
-        //     .optimize = lib.optimize,
-        // }).artifact("xcode-frameworks"));
-        // @import("xcode_frameworks").addPaths(lib);
-        xcode_frameworks.addPaths(b, lib);
     }
     b.installArtifact(lib);
 
@@ -58,15 +50,7 @@ pub fn build(b: *Build) !void {
             .optimize = main_tests.optimize,
         }).artifact("vulkan-headers"));
         if (main_tests.target_info.target.os.tag == .macos) {
-            // TODO(build-system): This cannot be imported with the Zig package manager
+            @import("xcode_frameworks").addPaths(b, lib);
-            // error: TarUnsupportedFileType
-            //
-            // main_tests.linkLibrary(b.dependency("xcode_frameworks", .{
-            //     .target = main_tests.target,
-            //     .optimize = main_tests.optimize,
-            // }).artifact("xcode-frameworks"));
-            // @import("xcode_frameworks").addPaths(main_tests);
-            xcode_frameworks.addPaths(b, main_tests);
         }
     }
 
@@ -74,113 +58,3 @@ pub fn build(b: *Build) !void {
 
     test_step.dependOn(&b.addRunArtifact(main_tests).step);
 }
-
-// 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
-        xEnsureGitRepoCloned(b.allocator, "https://github.com/hexops/xcode-frameworks", "723aa55e9752c8c6c25d3413722b5fe13d72ac4f", xSdkPath("/zig-cache/xcode_frameworks")) catch |err| @panic(@errorName(err));
-
-        step.addFrameworkPath(.{ .path = xSdkPath("/zig-cache/xcode_frameworks/Frameworks") });
-        step.addSystemIncludePath(.{ .path = xSdkPath("/zig-cache/xcode_frameworks/include") });
-        step.addLibraryPath(.{ .path = xSdkPath("/zig-cache/xcode_frameworks/lib") });
-    }
-
-    fn xEnsureGitRepoCloned(allocator: std.mem.Allocator, clone_url: []const u8, revision: []const u8, dir: []const u8) !void {
-        if (xIsEnvVarTruthy(allocator, "NO_ENSURE_SUBMODULES") or xIsEnvVarTruthy(allocator, "NO_ENSURE_GIT")) {
-            return;
-        }
-
-        xEnsureGit(allocator);
-
-        if (std.fs.openDirAbsolute(dir, .{})) |_| {
-            const current_revision = try xGetCurrentGitRevision(allocator, dir);
-            if (!std.mem.eql(u8, current_revision, revision)) {
-                // Reset to the desired revision
-                xExec(allocator, &[_][]const u8{ "git", "fetch" }, dir) catch |err| std.debug.print("warning: failed to 'git fetch' in {s}: {s}\n", .{ dir, @errorName(err) });
-                try xExec(allocator, &[_][]const u8{ "git", "checkout", "--quiet", "--force", revision }, dir);
-                try xExec(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, dir });
-
-                try xExec(allocator, &[_][]const u8{ "git", "clone", "-c", "core.longpaths=true", clone_url, dir }, ".");
-                try xExec(allocator, &[_][]const u8{ "git", "checkout", "--quiet", "--force", revision }, dir);
-                try xExec(allocator, &[_][]const u8{ "git", "submodule", "update", "--init", "--recursive" }, dir);
-                return;
-            },
-            else => err,
-        };
-    }
-
-    fn xExec(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 xGetCurrentGitRevision(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 xEnsureGit(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 xIsEnvVarTruthy(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;
-        }
-    }
-
-    fn xSdkPath(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;
-        };
-    }
-};

build.zig.zon

@@ -2,6 +2,10 @@
     .name = "mach-glfw",
     .version = "0.2.0",
     .dependencies = .{
+        .xcode_frameworks = .{
+            .url = "https://github.com/hexops/xcode-frameworks-pkg/archive/d486474a6af7fafd89e8314e0bf7eca4709f811b.tar.gz",
+            .hash = "1220293eae4bf67a7c27a18a8133621337cde91a97bc6859a9431b3b2d4217dfb5fb",
+        },
         .glfw = .{
             .url = "https://pkg.machengine.org/glfw/9cdc810bae1bd89fa7273000f21f7fd17c886a9d.tar.gz",
             .hash = "1220c3ecdec5413142a7ee7ec07ca0d86e4455550145ccf398835fa8bcf8be3df169",