about summary refs log tree commit diff
path: root/build.zig
blob: 780c0e22d361609001e04b2ca5cff9e85601d044 (plain) (blame)
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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
const std = @import("std");

// Although this function looks imperative, note that its job is to
// declaratively construct a build graph that will be executed by an external
// runner.
pub fn build(b: *std.Build) !void {
    // Standard target options allows the person running `zig build` to choose
    // what target to build for. Here we do not override the defaults, which
    // means any target is allowed, and the default is native. Other options
    // for restricting supported target set are available.
    const target = b.standardTargetOptions(.{});

    // Standard optimization options allow the person running `zig build` to select
    // between Debug, ReleaseSafe, ReleaseFast, and ReleaseSmall. Here we do not
    // set a preferred release mode, allowing the user to decide how to optimize.
    const optimize = b.standardOptimizeOption(.{});

    // We will also create a module for our other entry point, 'main.zig'.
    const exe_mod = b.createModule(.{
        // `root_source_file` is the Zig "entry point" of the module. If a module
        // only contains e.g. external object files, you can make this `null`.
        // In this case the main source file is merely a path, however, in more
        // complicated build scripts, this could be a generated file.
        .root_source_file = b.path("src/main.zig"),
        .target = target,
        .optimize = optimize,
    });

    switch (target.result.os.tag) {
        .macos => {
            exe_mod.addLibraryPath(.{
                .cwd_relative = "/opt/homebrew/opt/llvm/lib",
            });
            exe_mod.addIncludePath(.{ .cwd_relative = "/opt/homebrew/opt/llvm/include" });
            exe_mod.linkSystemLibrary("LLVM", .{
                .use_pkg_config = .no,
            });
        },
        .windows => {
            exe_mod.addLibraryPath(.{ .cwd_relative = "C:\\Program Files\\LLVM\\lib" });
            exe_mod.addIncludePath(.{ .cwd_relative = "C:\\Program Files\\LLVM\\include" });
            exe_mod.linkSystemLibrary("LLVM-C", .{
                .use_pkg_config = .no,
            });
        },
        else => exe_mod.linkSystemLibrary("LLVM", .{
            .use_pkg_config = .no,
        }),
    }

    exe_mod.link_libc = true;

    // This creates another `std.Build.Step.Compile`, but this one builds an executable
    // rather than a static library.
    const exe = b.addExecutable(.{
        .name = "interpreter",
        .root_module = exe_mod,
    });

    // This declares intent for the executable to be installed into the
    // standard location when the user invokes the "install" step (the default
    // step when running `zig build`).
    b.installArtifact(exe);

    // This is needed for better lsp errors
    const exe_check = b.addExecutable(.{
        .name = "interpreter-lsp",
        .root_source_file = b.path("src/main.zig"),
        .root_module = exe_mod,
        .optimize = optimize,
    });

    const check = b.step("check", "Check if foo compiles");
    check.dependOn(&exe_check.step);

    // This *creates* a Run step in the build graph, to be executed when another
    // step is evaluated that depends on it. The next line below will establish
    // such a dependency.
    const run_cmd = b.addRunArtifact(exe);

    // By making the run step depend on the install step, it will be run from the
    // installation directory rather than directly from within the cache directory.
    // This is not necessary, however, if the application depends on other installed
    // files, this ensures they will be present and in the expected location.
    run_cmd.step.dependOn(b.getInstallStep());

    // This allows the user to pass arguments to the application in the build
    // command itself, like this: `zig build run -- arg1 arg2 etc`
    if (b.args) |args| {
        run_cmd.addArgs(args);
    }

    // This creates a build step. It will be visible in the `zig build --help` menu,
    // and can be selected like this: `zig build run`
    // This will evaluate the `run` step rather than the default, which is "install".
    const run_step = b.step("run", "Run the app");
    run_step.dependOn(&run_cmd.step);

    const exe_unit_tests = b.addTest(.{
        .root_module = exe_mod,
    });

    const run_exe_unit_tests = b.addRunArtifact(exe_unit_tests);

    // Similar to creating the run step earlier, this exposes a `test` step to
    // the `zig build --help` menu, providing a way for the user to request
    // running the unit tests.
    const test_step = b.step("test", "Run unit tests");
    test_step.dependOn(&run_exe_unit_tests.step);

    // Example step - used for testing againt all the example programs
    const examples_step = b.step("examples", "Run examples");
    examples_step.dependOn(&exe.step);

    const examples_dir = "examples";
    var dir = std.fs.cwd().openDir(examples_dir, .{ .iterate = true }) catch |err| {
        std.debug.print("Failed to open examples directory: {}\n", .{err});
        return;
    };
    defer dir.close();

    var iter = dir.iterate();
    while (try iter.next()) |entry| {
        if (entry.kind == .file) {
            const example_path = b.fmt("{s}/{s}", .{ examples_dir, entry.name });
            const run_example = b.addSystemCommand(&.{ "zig", "build", "run", "--", example_path });
            run_example.setName(b.fmt("{s}", .{example_path}));
            run_example.expectExitCode(0);
            run_example.has_side_effects = true;
            examples_step.dependOn(&run_example.step);
        }
    }
}