path: root/build.zig

const std = @import("std");

pub const Platform = enum { tty, gui, web };
pub const TreeSitterGrammars = enum { disabled, minimal, full };
const GhosttyArtifact = enum { ghostty, lib };

pub fn build(b: *std.Build) void {
    const target = b.standardTargetOptions(.{});
    const requested_optimize = b.standardOptimizeOption(.{});
    const platform = b.option(Platform, "platform", "which shell to build (tty, gui, web)") orelse .tty;
    const static = b.option(bool, "static", "statically link") orelse false;
    const dump_path = b.option([]const u8, "dump", "dump .zon embedded into the web shell (-Dplatform=web)");
    const emcc_path = b.option([]const u8, "emcc", "emcc for the web shell's final link") orelse "/usr/lib/emscripten/emcc";
    const is_emscripten = target.result.os.tag == .emscripten;
    // wasm: size is the budget
    const optimize = if (is_emscripten) .ReleaseSmall else requested_optimize;
    const default_grammars: TreeSitterGrammars = if (is_emscripten) .minimal else .full;
    const tree_sitter_grammars = b.option(TreeSitterGrammars, "tree-sitter", "tree-sitter grammar set: disabled, minimal, full") orelse default_grammars;

    // the browser shell: zig object + emcc link + html, installed to zig-out/web
    const web_step = b.step("web", "build the browser shell into zig-out/web (-Dplatform=web -Dtarget=wasm32-emscripten -Ddump=<dump.zon>)");

    const emscripten_sysroot = if (is_emscripten) detectEmscriptenSysroot(b) else null;
    if (platform == .web and !is_emscripten) return failBuild(b, web_step, "-Dplatform=web requires -Dtarget=wasm32-emscripten");
    if (platform != .web and is_emscripten) return failBuild(b, web_step, "-Dtarget=wasm32-emscripten requires -Dplatform=web");
    if (platform == .web and dump_path == null) return failBuild(b, web_step, "-Dplatform=web requires -Ddump=<dump.zon> (the browser has no ptys; state replays from an embedded dump)");
    if (platform == .web and emscripten_sysroot == null) return failBuild(b, web_step, "no emscripten sysroot found; pass --sysroot <emscripten-cache>/sysroot or set EM_CACHE/EMSDK");

    // emscripten "libc": point zig at the sysroot headers/crt via a libc.txt
    // (the prototype's WriteFiles trick) — applied to EVERY compile step.
    const libc_file: ?std.Build.LazyPath = if (emscripten_sysroot) |sysroot| blk: {
        const files = b.addWriteFiles();
        break :blk files.add("emscripten-libc.txt", b.fmt(
            \\include_dir={s}/include
            \\sys_include_dir={s}/include
            \\crt_dir={s}/lib/wasm32-emscripten
            \\msvc_lib_dir=
            \\kernel32_lib_dir=
            \\gcc_dir=
            \\
        , .{ sysroot, sysroot, sysroot }));
    } else null;
    const emscripten_include: ?std.Build.LazyPath = if (emscripten_sysroot) |sysroot|
        .{ .cwd_relative = b.pathJoin(&.{ sysroot, "include" }) }
    else
        null;

    // build-time IO, only used to slurp the grammars' highlights.scm queries
    var threaded: std.Io.Threaded = .init(b.allocator, .{});
    defer threaded.deinit();
    const io = threaded.io();

    const root_mod = b.createModule(.{
        .target = target,
        .optimize = optimize,
        .root_source_file = b.path("src/main.zig"),
        .link_libc = true,
    });
    // static archives the emcc link needs beyond the zig object (grammars, SDL)
    var wasm_libs: std.ArrayList(std.Build.LazyPath) = .empty;

    const opts = b.addOptions();
    opts.addOption(Platform, "platform", platform);
    opts.addOption(bool, "syntax_highlighting", tree_sitter_grammars != .disabled);
    opts.addOption(bool, "syntax_minimal_grammars", tree_sitter_grammars != .disabled);
    opts.addOption(bool, "syntax_full_grammars", tree_sitter_grammars == .full);
    root_mod.addOptions("pardes_config", opts);

    // tree-sitter: the zig bindings + C runtime, one static lib per grammar,
    // and each grammar's highlights.scm slurped at build time into the
    // ts_queries options module (codegen consumed by comptime in syntax.zig).
    if (tree_sitter_grammars != .disabled) {
        const tree_sitter_mod = b.dependency("tree_sitter", .{ .target = target, .optimize = optimize }).module("tree_sitter");
        // the C runtime rides the module as a static lib; give it the wasm
        // libc and hand its archive to the emcc link
        if (is_emscripten) {
            for (tree_sitter_mod.link_objects.items) |link_object| switch (link_object) {
                .other_step => |lib| {
                    lib.setLibCFile(libc_file.?);
                    wasm_libs.append(b.allocator, lib.getEmittedBin()) catch @panic("OOM");
                },
                else => {},
            };
        }
        root_mod.addImport("tree-sitter", tree_sitter_mod);

        const Grammar = struct {
            name: []const u8,
            dep: []const u8,
            src: []const u8 = "src",
            scanner: bool = false,
            query: []const u8 = "queries/highlights.scm",
            minimal: bool = false,
        };
        const grammars = [_]Grammar{
            .{ .name = "ada", .dep = "ts_ada" },
            .{ .name = "bash", .dep = "ts_bash", .scanner = true },
            .{ .name = "c", .dep = "ts_c", .minimal = true },
            .{ .name = "c_sharp", .dep = "ts_c_sharp", .scanner = true },
            .{ .name = "clojure", .dep = "ts_clojure" },
            .{ .name = "cpp", .dep = "ts_cpp", .scanner = true, .minimal = true },
            .{ .name = "css", .dep = "ts_css", .scanner = true },
            .{ .name = "elixir", .dep = "ts_elixir", .scanner = true },
            .{ .name = "erlang", .dep = "ts_erlang", .scanner = true },
            .{ .name = "fortran", .dep = "ts_fortran", .scanner = true },
            .{ .name = "go", .dep = "ts_go" },
            .{ .name = "haskell", .dep = "ts_haskell", .scanner = true },
            .{ .name = "html", .dep = "ts_html", .scanner = true },
            .{ .name = "java", .dep = "ts_java" },
            .{ .name = "javascript", .dep = "ts_javascript", .scanner = true },
            .{ .name = "json", .dep = "ts_json" },
            .{ .name = "kotlin", .dep = "ts_kotlin", .scanner = true },
            .{ .name = "ocaml", .dep = "ts_ocaml", .src = "grammars/ocaml/src", .scanner = true },
            .{ .name = "pascal", .dep = "ts_pascal" },
            .{ .name = "php", .dep = "ts_php", .src = "php/src", .scanner = true },
            .{ .name = "powershell", .dep = "ts_powershell", .scanner = true },
            .{ .name = "python", .dep = "ts_python", .scanner = true },
            .{ .name = "ruby", .dep = "ts_ruby", .scanner = true },
            .{ .name = "rust", .dep = "ts_rust", .scanner = true },
            .{ .name = "scala", .dep = "ts_scala", .scanner = true },
            .{ .name = "zig", .dep = "ts_zig", .minimal = true },
        };
        const ts_queries = b.addOptions();
        inline for (grammars) |g| {
            if (tree_sitter_grammars == .full or g.minimal) {
                const dep = b.dependency(g.dep, .{});
                const query_path = dep.path(g.query);
                const query = std.Io.Dir.cwd().readFileAlloc(io, query_path.getPath(b), b.allocator, .limited(0x100000)) catch @panic("read " ++ g.name ++ " highlights");
                ts_queries.addOption([]const u8, g.name ++ "_highlights", query);

                const lib = b.addLibrary(.{
                    .name = "tree-sitter-" ++ g.name,
                    .root_module = b.createModule(.{ .target = target, .optimize = optimize, .link_libc = true }),
                    .linkage = .static,
                });
                if (libc_file) |f| lib.setLibCFile(f);
                lib.root_module.addCSourceFile(.{ .file = dep.path(g.src ++ "/parser.c") });
                if (g.scanner) lib.root_module.addCSourceFile(.{ .file = dep.path(g.src ++ "/scanner.c") });
                lib.root_module.addIncludePath(dep.path(g.src));
                root_mod.linkLibrary(lib);
                if (is_emscripten) wasm_libs.append(b.allocator, lib.getEmittedBin()) catch @panic("OOM");
            }
        }
        root_mod.addOptions("ts_queries", ts_queries);
    }

    // zstbi (C stb_image): image pane decode. zigimg crashes the 0.16 compiler.
    const zstbi_dep = b.dependency("zstbi", .{ .target = target, .optimize = optimize });
    root_mod.addImport("zstbi", zstbi_dep.module("root"));

    // ghostty-vt and vaxis both depend on uucode, but Zig forbids one source
    // file in two modules — build a single uucode (our config, unpacked tables)
    // and hand it to both. Same trick as the prototype; see uucode_config.zig.
    const uucode_config = b.path("uucode_config.zig");
    const uucode_tables = b.dependency("uucode", .{
        .target = target,
        .optimize = optimize,
        .build_config_path = uucode_config,
    }).namedLazyPath("tables.zig");
    const uucode_mod = b.dependency("uucode", .{
        .target = target,
        .optimize = optimize,
        .build_config_path = uucode_config,
        .tables_path = uucode_tables,
    }).module("uucode");

    const vaxis_mod = b.dependency("vaxis", .{
        .target = target,
        .optimize = optimize,
        .external_uucode = true,
    }).module("vaxis");

    var ghostty_vt_for_snap: ?*std.Build.Module = null;
    if (b.lazyDependency("ghostty", .{ .simd = target.result.os.tag != .emscripten })) |dep| {
        const ghostty_vt = dep.module("ghostty-vt");
        ghostty_vt_for_snap = ghostty_vt;
        ghostty_vt.addImport("uucode", uucode_mod);
        // emscripten: hand ghostty-vt the terminal_options module its build()
        // would otherwise provide (copied verbatim from the prototype build)
        if (is_emscripten) {
            const term_opts = b.addOptions();
            term_opts.addOption(GhosttyArtifact, "artifact", .lib);
            term_opts.addOption(bool, "c_abi", false);
            term_opts.addOption(bool, "oniguruma", false);
            term_opts.addOption(bool, "simd", false);
            term_opts.addOption(bool, "slow_runtime_safety", false);
            term_opts.addOption(bool, "kitty_graphics", false);
            term_opts.addOption(bool, "tmux_control_mode", false);
            term_opts.addOption([]const u8, "version_string", "0.0.0");
            term_opts.addOption(usize, "version_major", 0);
            term_opts.addOption(usize, "version_minor", 0);
            term_opts.addOption(usize, "version_patch", 0);
            term_opts.addOption(?[]const u8, "version_pre", null);
            term_opts.addOption(?[]const u8, "version_build", null);
            ghostty_vt.addOptions("terminal_options", term_opts);
        }
        root_mod.addImport("ghostty-vt", ghostty_vt);
    }
    // override uucode on vaxis LAST so it wins over ghostty's build() wiring.
    vaxis_mod.addImport("uucode", uucode_mod);
    root_mod.addImport("vaxis", vaxis_mod);
    root_mod.addImport("uucode", uucode_mod);

    // SDL3 shell wiring (-Dplatform=gui and web). The sdl package builds SDL3
    // from source as a static lib + emits the SDL3/ headers; gui.zig @cImports
    // those, plus a small stb_truetype C shim for the glyph atlas, and embeds
    // the SPIR-V compiled at build time from shaders/*.glsl — or, on web, the
    // GL ES shader sources compiled at runtime by WebGL.
    if (platform == .gui or platform == .web) {
        const sdl_dep = if (emscripten_include) |include|
            b.lazyDependency("sdl", .{ .target = target, .optimize = optimize, .system_include_path = include })
        else
            b.lazyDependency("sdl", .{ .target = target, .optimize = optimize });
        if (sdl_dep) |dep| {
            const sdl_lib = dep.artifact("SDL3");
            if (libc_file) |f| sdl_lib.setLibCFile(f);
            root_mod.linkLibrary(sdl_lib);
            root_mod.addIncludePath(dep.path("include"));
            if (emscripten_include) |include| root_mod.addSystemIncludePath(include);
            if (is_emscripten) wasm_libs.append(b.allocator, sdl_lib.getEmittedBin()) catch @panic("OOM");
        }
        root_mod.addIncludePath(b.path("vendor/stb"));
        root_mod.addCSourceFile(.{ .file = b.path("vendor/stb/stb_truetype_impl.c") });
        root_mod.addCSourceFile(.{ .file = b.path("vendor/stb/font.c") });
        // the embedded UI font: provided as a build import since assets/ lives
        // outside the src/ module root (@embedFile can't escape it)
        root_mod.addAnonymousImport("AdwaitaMono-Regular.ttf", .{
            .root_source_file = b.path("assets/AdwaitaMono-Regular.ttf"),
        });
        if (platform == .web) {
            root_mod.addAnonymousImport("ui.vert.es.glsl", .{ .root_source_file = b.path("shaders/ui.vert.es.glsl") });
            root_mod.addAnonymousImport("ui.frag.es.glsl", .{ .root_source_file = b.path("shaders/ui.frag.es.glsl") });
            root_mod.addAnonymousImport("overlay.vert.es.glsl", .{ .root_source_file = b.path("shaders/overlay.vert.es.glsl") });
            root_mod.addAnonymousImport("overlay.frag.es.glsl", .{ .root_source_file = b.path("shaders/overlay.frag.es.glsl") });
            const dp = dump_path.?;
            root_mod.addAnonymousImport("embedded.dump.zon", .{
                .root_source_file = if (std.fs.path.isAbsolute(dp)) .{ .cwd_relative = dp } else b.path(dp),
            });
        } else {
            root_mod.addAnonymousImport("ui.vert.spv", .{
                .root_source_file = compileGlsl(b, "shaders/ui.vert.glsl", "vertex", "ui.vert.spv"),
            });
            root_mod.addAnonymousImport("ui.frag.spv", .{
                .root_source_file = compileGlsl(b, "shaders/ui.frag.glsl", "fragment", "ui.frag.spv"),
            });
            root_mod.addAnonymousImport("overlay.vert.spv", .{
                .root_source_file = compileGlsl(b, "shaders/overlay.vert.glsl", "vertex", "overlay.vert.spv"),
            });
            root_mod.addAnonymousImport("overlay.frag.spv", .{
                .root_source_file = compileGlsl(b, "shaders/overlay.frag.glsl", "fragment", "overlay.frag.spv"),
            });
        }
    }

    if (platform == .web) {
        // zig emits an object; emcc does the final link (wasm + js glue),
        // compiling the C shims itself and pulling in every static archive.
        const obj = b.addObject(.{ .name = "pardes", .root_module = root_mod });
        obj.setLibCFile(libc_file.?);

        const emcc = b.addSystemCommand(&.{emcc_path});
        emcc.addFileArg(obj.getEmittedBinDirectory().path(b, "pardes_zcu.o"));
        emcc.addFileArg(obj.getEmittedBin());
        emcc.addFileArg(b.path("vendor/stb/stb_truetype_impl.c"));
        emcc.addFileArg(b.path("vendor/stb/font.c"));
        emcc.addFileArg(zstbi_dep.path("src/zstbi.c"));
        for (wasm_libs.items) |lib| emcc.addFileArg(lib);
        emcc.addPrefixedDirectoryArg("-I", b.path("vendor/stb"));
        emcc.addPrefixedDirectoryArg("-I", zstbi_dep.path("libs/stbi"));
        emcc.addArgs(&.{
            "-std=c99",
            "-fno-sanitize=undefined",
            "-Oz",
            "-sINITIAL_MEMORY=1073741824", // the 512 MiB web heap + code/stack
            "-sEXIT_RUNTIME=0", // run() returns; the rAF loop keeps living
            "-sFULL_ES3=1",
            "-sMIN_WEBGL_VERSION=2",
            "-sMAX_WEBGL_VERSION=2",
            "-sINCOMING_MODULE_JS_API=canvas",
            "-o",
        });
        const js = emcc.addOutputFileArg("pardes.js");
        web_step.dependOn(&b.addInstallFileWithDir(js, .{ .custom = "web" }, "pardes.js").step);
        web_step.dependOn(&b.addInstallFileWithDir(js.dirname().path(b, "pardes.wasm"), .{ .custom = "web" }, "pardes.wasm").step);
        const html = b.addWriteFiles().add("index.html", html_shell);
        web_step.dependOn(&b.addInstallFileWithDir(html, .{ .custom = "web" }, "index.html").step);
        b.getInstallStep().dependOn(web_step);
    } else {
        const exe = b.addExecutable(.{
            .name = "pardes",
            .linkage = if (static) .static else null,
            .root_module = root_mod,
        });
        b.installArtifact(exe);
        const run = b.addRunArtifact(exe);
        b.step("run", "descend to the pardes").dependOn(&run.step);
        web_step.dependOn(&b.addFail("web needs -Dplatform=web -Dtarget=wasm32-emscripten -Ddump=<dump.zon>").step);

        // snapshot parity suite: scripted input traces in a pty, captured grids
        // diffed against the goldens in snapshots/ — the frozen record of parity
        // with the prototype this program replaced. `-- --update` regenerates.
        const snap = b.addExecutable(.{
            .name = "pardes-snap",
            .root_module = b.createModule(.{
                .target = target,
                .optimize = optimize,
                .root_source_file = b.path("test/snapshot.zig"),
                .link_libc = true,
            }),
        });
        if (ghostty_vt_for_snap) |vt| snap.root_module.addImport("ghostty-vt", vt);
        b.installArtifact(snap);
        const run_snap = b.addRunArtifact(snap);
        run_snap.addArtifactArg(exe);
        if (b.args) |args| run_snap.addArgs(args);
        b.step("snap", "run the snapshot parity suite (-- --update regenerates goldens)").dependOn(&run_snap.step);
    }
}

// the html shell: a full-viewport canvas wired into Module (from the prototype)
const html_shell =
    \\<!doctype html>
    \\<html>
    \\<head>
    \\  <meta charset="utf-8">
    \\  <meta name="viewport" content="width=device-width, initial-scale=1">
    \\  <title>pardes</title>
    \\  <style>
    \\    html, body { margin: 0; width: 100%; height: 100%; background: #121212; }
    \\    body { overflow: hidden; }
    \\    canvas { display: block; width: 100vw; height: 100vh; outline: none;
    \\      image-rendering: crisp-edges; image-rendering: pixelated;
    \\      -ms-interpolation-mode: nearest-neighbor;
    \\      transform: translateZ(0); backface-visibility: hidden;
    \\      touch-action: none; }
    \\  </style>
    \\</head>
    \\<body>
    \\  <canvas id="canvas" tabindex="0"></canvas>
    \\  <script>
    \\    const canvas = document.getElementById('canvas');
    \\    canvas.addEventListener('contextmenu', (event) => event.preventDefault());
    \\    canvas.addEventListener('pointerdown', (event) => {
    \\      canvas.focus({ preventScroll: true });
    \\      canvas.setPointerCapture?.(event.pointerId);
    \\    });
    \\    const releasePointer = (event) => {
    \\      if (canvas.hasPointerCapture?.(event.pointerId)) canvas.releasePointerCapture(event.pointerId);
    \\    };
    \\    canvas.addEventListener('pointerup', releasePointer);
    \\    canvas.addEventListener('pointercancel', releasePointer);
    \\    window.Module = { canvas };
    \\  </script>
    \\  <script src="pardes.js"></script>
    \\</body>
    \\</html>
;

// a bad -D combination: fail both `zig build` and `zig build web` with the why
fn failBuild(b: *std.Build, web_step: *std.Build.Step, msg: []const u8) void {
    const fail = &b.addFail(msg).step;
    web_step.dependOn(fail);
    b.getInstallStep().dependOn(fail);
}

// glslc <src> -fshader-stage=<stage> -o <out> -> .spv, returned as a LazyPath
// for @embedFile. Only used by the SDL3 GPU shell (-Dplatform=gui).
fn compileGlsl(b: *std.Build, src: []const u8, stage: []const u8, out: []const u8) std.Build.LazyPath {
    const cmd = b.addSystemCommand(&.{ "glslc", b.fmt("-fshader-stage={s}", .{stage}) });
    cmd.addFileArg(b.path(src));
    cmd.addArg("-o");
    return cmd.addOutputFileArg(out);
}

fn detectEmscriptenSysroot(b: *std.Build) ?[]const u8 {
    if (b.option([]const u8, "emscripten-sysroot", "path to the Emscripten sysroot")) |path| return path;
    if (b.sysroot) |path| return path;
    if (envPath(b, "EMSCRIPTEN_SYSROOT")) |path| return path;
    if (envPath(b, "EM_CACHE")) |cache| return b.pathJoin(&.{ cache, "sysroot" });
    if (envPath(b, "EMSDK")) |emsdk| return b.pathJoin(&.{ emsdk, "upstream", "emscripten", "cache", "sysroot" });
    if (envPath(b, "HOME")) |home| return b.pathJoin(&.{ home, ".cache", "emscripten", "sysroot" });
    return null;
}

fn envPath(b: *std.Build, name: []const u8) ?[]const u8 {
    return b.graph.environ_map.get(name);
}