build.zig (3967B)
1 const std = @import("std"); 2 3 // Although this function looks imperative, note that its job is to 4 // declaratively construct a build graph that will be executed by an external 5 // runner. 6 pub fn build(b: *std.Build) void { 7 // Standard target options allows the person running `zig build` to choose 8 // what target to build for. Here we do not override the defaults, which 9 // means any target is allowed, and the default is native. Other options 10 // for restricting supported target set are available. 11 const target = b.standardTargetOptions(.{}); 12 13 // Standard optimization options allow the person running `zig build` to select 14 // between Debug, ReleaseSafe, ReleaseFast, and ReleaseSmall. Here we do not 15 // set a preferred release mode, allowing the user to decide how to optimize. 16 const optimize = b.standardOptimizeOption(.{}); 17 18 const lib = b.addStaticLibrary(.{ 19 .name = "zahl", 20 // In this case the main source file is merely a path, however, in more 21 // complicated build scripts, this could be a generated file. 22 .root_source_file = b.path("src/root.zig"), 23 .target = target, 24 .optimize = optimize, 25 }); 26 27 // This declares intent for the library to be installed into the standard 28 // location when the user invokes the "install" step (the default step when 29 // running `zig build`). 30 b.installArtifact(lib); 31 32 const exe = b.addExecutable(.{ 33 .name = "zahl", 34 .root_source_file = b.path("src/main.zig"), 35 .target = target, 36 .optimize = optimize, 37 }); 38 exe.addCSourceFile(.{ .file = b.path("src/crossline.c"), .flags = &.{} }); 39 exe.addIncludePath(b.path("src")); 40 exe.linkLibC(); 41 42 // This declares intent for the executable to be installed into the 43 // standard location when the user invokes the "install" step (the default 44 // step when running `zig build`). 45 b.installArtifact(exe); 46 47 // This *creates* a Run step in the build graph, to be executed when another 48 // step is evaluated that depends on it. The next line below will establish 49 // such a dependency. 50 const run_cmd = b.addRunArtifact(exe); 51 52 // By making the run step depend on the install step, it will be run from the 53 // installation directory rather than directly from within the cache directory. 54 // This is not necessary, however, if the application depends on other installed 55 // files, this ensures they will be present and in the expected location. 56 run_cmd.step.dependOn(b.getInstallStep()); 57 58 // This allows the user to pass arguments to the application in the build 59 // command itself, like this: `zig build run -- arg1 arg2 etc` 60 if (b.args) |args| { 61 run_cmd.addArgs(args); 62 } 63 64 // This creates a build step. It will be visible in the `zig build --help` menu, 65 // and can be selected like this: `zig build run` 66 // This will evaluate the `run` step rather than the default, which is "install". 67 const run_step = b.step("run", "Run the app"); 68 run_step.dependOn(&run_cmd.step); 69 70 // Creates a step for unit testing. This only builds the test executable 71 // but does not run it. 72 const lib_unit_tests = b.addTest(.{ 73 .root_source_file = b.path("src/root.zig"), 74 .target = target, 75 .optimize = optimize, 76 }); 77 78 const run_lib_unit_tests = b.addRunArtifact(lib_unit_tests); 79 80 const exe_unit_tests = b.addTest(.{ 81 .root_source_file = b.path("src/main.zig"), 82 .target = target, 83 .optimize = optimize, 84 }); 85 86 const run_exe_unit_tests = b.addRunArtifact(exe_unit_tests); 87 88 // Similar to creating the run step earlier, this exposes a `test` step to 89 // the `zig build --help` menu, providing a way for the user to request 90 // running the unit tests. 91 const test_step = b.step("test", "Run unit tests"); 92 test_step.dependOn(&run_lib_unit_tests.step); 93 test_step.dependOn(&run_exe_unit_tests.step); 94 }