···11+const std = @import("std");
22+33+// Although this function looks imperative, it does not perform the build
44+// directly and instead it mutates the build graph (`b`) that will be then
55+// executed by an external runner. The functions in `std.Build` implement a DSL
66+// for defining build steps and express dependencies between them, allowing the
77+// build runner to parallelize the build automatically (and the cache system to
88+// know when a step doesn't need to be re-run).
99+pub fn build(b: *std.Build) void {
1010+ // Standard target options allow the person running `zig build` to choose
1111+ // what target to build for. Here we do not override the defaults, which
1212+ // means any target is allowed, and the default is native. Other options
1313+ // for restricting supported target set are available.
1414+ const target = b.standardTargetOptions(.{});
1515+ // Standard optimization options allow the person running `zig build` to select
1616+ // between Debug, ReleaseSafe, ReleaseFast, and ReleaseSmall. Here we do not
1717+ // set a preferred release mode, allowing the user to decide how to optimize.
1818+ const optimize = b.standardOptimizeOption(.{});
1919+ // It's also possible to define more custom flags to toggle optional features
2020+ // of this build script using `b.option()`. All defined flags (including
2121+ // target and optimize options) will be listed when running `zig build --help`
2222+ // in this directory.
2323+2424+ // This creates a module, which represents a collection of source files alongside
2525+ // some compilation options, such as optimization mode and linked system libraries.
2626+ // Zig modules are the preferred way of making Zig code available to consumers.
2727+ // addModule defines a module that we intend to make available for importing
2828+ // to our consumers. We must give it a name because a Zig package can expose
2929+ // multiple modules and consumers will need to be able to specify which
3030+ // module they want to access.
3131+3232+ // Here we define an executable. An executable needs to have a root module
3333+ // which needs to expose a `main` function. While we could add a main function
3434+ // to the module defined above, it's sometimes preferable to split business
3535+ // logic and the CLI into two separate modules.
3636+ //
3737+ // If your goal is to create a Zig library for others to use, consider if
3838+ // it might benefit from also exposing a CLI tool. A parser library for a
3939+ // data serialization format could also bundle a CLI syntax checker, for example.
4040+ //
4141+ // If instead your goal is to create an executable, consider if users might
4242+ // be interested in also being able to embed the core functionality of your
4343+ // program in their own executable in order to avoid the overhead involved in
4444+ // subprocessing your CLI tool.
4545+ //
4646+ // If neither case applies to you, feel free to delete the declaration you
4747+ // don't need and to put everything under a single module.
4848+ const exe = b.addExecutable(.{
4949+ .name = "zig",
5050+ .root_module = b.createModule(.{
5151+ // b.createModule defines a new module just like b.addModule but,
5252+ // unlike b.addModule, it does not expose the module to consumers of
5353+ // this package, which is why in this case we don't have to give it a name.
5454+ .root_source_file = b.path("src/main.zig"),
5555+ // Target and optimization levels must be explicitly wired in when
5656+ // defining an executable or library (in the root module), and you
5757+ // can also hardcode a specific target for an executable or library
5858+ // definition if desireable (e.g. firmware for embedded devices).
5959+ .target = target,
6060+ .optimize = optimize,
6161+ // List of modules available for import in source files part of the
6262+ // root module.
6363+ }),
6464+ });
6565+6666+ // This declares intent for the executable to be installed into the
6767+ // install prefix when running `zig build` (i.e. when executing the default
6868+ // step). By default the install prefix is `zig-out/` but can be overridden
6969+ // by passing `--prefix` or `-p`.
7070+ b.installArtifact(exe);
7171+7272+ // This creates a top level step. Top level steps have a name and can be
7373+ // invoked by name when running `zig build` (e.g. `zig build run`).
7474+ // This will evaluate the `run` step rather than the default step.
7575+ // For a top level step to actually do something, it must depend on other
7676+ // steps (e.g. a Run step, as we will see in a moment).
7777+ const run_step = b.step("run", "Run the app");
7878+7979+ // This creates a RunArtifact step in the build graph. A RunArtifact step
8080+ // invokes an executable compiled by Zig. Steps will only be executed by the
8181+ // runner if invoked directly by the user (in the case of top level steps)
8282+ // or if another step depends on it, so it's up to you to define when and
8383+ // how this Run step will be executed. In our case we want to run it when
8484+ // the user runs `zig build run`, so we create a dependency link.
8585+ const run_cmd = b.addRunArtifact(exe);
8686+ run_step.dependOn(&run_cmd.step);
8787+8888+ // By making the run step depend on the default step, it will be run from the
8989+ // installation directory rather than directly from within the cache directory.
9090+ run_cmd.step.dependOn(b.getInstallStep());
9191+9292+ // This allows the user to pass arguments to the application in the build
9393+ // command itself, like this: `zig build run -- arg1 arg2 etc`
9494+ if (b.args) |args| {
9595+ run_cmd.addArgs(args);
9696+ }
9797+9898+ // Creates an executable that will run `test` blocks from the executable's
9999+ // root module. Note that test executables only test one module at a time,
100100+ // hence why we have to create two separate ones.
101101+ const exe_tests = b.addTest(.{
102102+ .root_module = exe.root_module,
103103+ });
104104+105105+ // A run step that will run the second test executable.
106106+ const run_exe_tests = b.addRunArtifact(exe_tests);
107107+108108+ // A top level step for running all tests. dependOn can be called multiple
109109+ // times and since the two run steps do not depend on one another, this will
110110+ // make the two of them run in parallel.
111111+ const test_step = b.step("test", "Run tests");
112112+ test_step.dependOn(&run_exe_tests.step);
113113+114114+ // Just like flags, top level steps are also listed in the `--help` menu.
115115+ //
116116+ // The Zig build system is entirely implemented in userland, which means
117117+ // that it cannot hook into private compiler APIs. All compilation work
118118+ // orchestrated by the build system will result in other Zig compiler
119119+ // subcommands being invoked with the right flags defined. You can observe
120120+ // these invocations when one fails (or you pass a flag to increase
121121+ // verbosity) to validate assumptions and diagnose problems.
122122+ //
123123+ // Lastly, the Zig build system is relatively simple and self-contained,
124124+ // and reading its source code will allow you to master it.
125125+}