summaryrefslogtreecommitdiff
path: root/pkg/apple-sdk/build.zig
blob: c573c391087a0676362fe671fae9230bfcc5b14d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
const std = @import("std");

pub fn build(b: *std.Build) !void {
    const target = b.standardTargetOptions(.{});
    const optimize = b.standardOptimizeOption(.{});
    _ = target;
    _ = optimize;
}

/// Setup the step to point to the proper Apple SDK for libc and
/// frameworks. This expects and relies on the native SDK being
/// installed on the system. Ghostty doesn't support cross-compilation
/// for Apple platforms.
pub fn addPaths(
    b: *std.Build,
    step: *std.Build.Step.Compile,
) !void {
    // The cache. This always uses b.allocator and never frees memory
    // (which is idiomatic for a Zig build exe). We cache the libc txt
    // file we create because it is expensive to generate (subprocesses).
    const Cache = struct {
        const Key = struct {
            arch: std.Target.Cpu.Arch,
            os: std.Target.Os.Tag,
            abi: std.Target.Abi,
        };

        var map: std.AutoHashMapUnmanaged(Key, ?struct {
            libc: std.Build.LazyPath,
            framework: []const u8,
            system_include: []const u8,
            library: []const u8,
        }) = .{};
    };

    const target = step.rootModuleTarget();
    const gop = try Cache.map.getOrPut(b.allocator, .{
        .arch = target.cpu.arch,
        .os = target.os.tag,
        .abi = target.abi,
    });

    if (!gop.found_existing) {
        // Detect our SDK using the "findNative" Zig stdlib function.
        // This is really important because it forces using `xcrun` to
        // find the SDK path.
        const libc = try std.zig.LibCInstallation.findNative(.{
            .allocator = b.allocator,
            .target = &step.rootModuleTarget(),
            .verbose = false,
        });

        // Render the file compatible with the `--libc` Zig flag.
        var stream: std.io.Writer.Allocating = .init(b.allocator);
        defer stream.deinit();
        try libc.render(&stream.writer);

        // Create a temporary file to store the libc path because
        // `--libc` expects a file path.
        const wf = b.addWriteFiles();
        const path = wf.add("libc.txt", stream.written());

        // Determine our framework path. Zig has a bug where it doesn't
        // parse this from the libc txt file for `-framework` flags:
        // https://github.com/ziglang/zig/issues/24024
        const framework_path = framework: {
            const down1 = std.fs.path.dirname(libc.sys_include_dir.?).?;
            const down2 = std.fs.path.dirname(down1).?;
            break :framework try std.fs.path.join(b.allocator, &.{
                down2,
                "System",
                "Library",
                "Frameworks",
            });
        };

        const library_path = library: {
            const down1 = std.fs.path.dirname(libc.sys_include_dir.?).?;
            break :library try std.fs.path.join(b.allocator, &.{
                down1,
                "lib",
            });
        };

        gop.value_ptr.* = .{
            .libc = path,
            .framework = framework_path,
            .system_include = libc.sys_include_dir.?,
            .library = library_path,
        };
    }

    const value = gop.value_ptr.* orelse return switch (target.os.tag) {
        // Return a more descriptive error. Before we just returned the
        // generic error but this was confusing a lot of community members.
        // It costs us nothing in the build script to return something better.
        .macos => error.XcodeMacOSSDKNotFound,
        .ios => error.XcodeiOSSDKNotFound,
        .tvos => error.XcodeTVOSSDKNotFound,
        .watchos => error.XcodeWatchOSSDKNotFound,
        else => error.XcodeAppleSDKNotFound,
    };

    step.setLibCFile(value.libc);

    // This is only necessary until this bug is fixed:
    // https://github.com/ziglang/zig/issues/24024
    step.root_module.addSystemFrameworkPath(.{ .cwd_relative = value.framework });
    step.root_module.addSystemIncludePath(.{ .cwd_relative = value.system_include });
    step.root_module.addLibraryPath(.{ .cwd_relative = value.library });
}