diff options
| author | Gabriel Schneider <[email protected]> | 2026-11-06 22:36:07 -0300 |
|---|---|---|
| committer | Gabriel Schneider <[email protected]> | 2026-11-06 23:38:31 -0300 |
| commit | 227111c84a2945087abb4395daf63c7b23ba5bab (patch) | |
| tree | fbd17789bdb0feb9cc7739b0bcc443315c5c7336 /build.zig | |
| parent | 8facd769003b970e7a2c933f1887e09bffb4bd08 (diff) | |
| download | pardes-227111c84a2945087abb4395daf63c7b23ba5bab.tar.gz pardes-227111c84a2945087abb4395daf63c7b23ba5bab.zip | |
kinds #47, MuPDF and FreeType lazy: Zig 0.17's configure is handed the -D options and never the steps asked for (the configurer's argv, and the configure cache keyed on it), so no step can fetch for itself; the guard is `-Dpdf`, on by itself once MuPDF is fetched (std.Build.package_map's `available`) and off Linux, which asks `b.lazyDependency` for MuPDF, and FreeType (with the zlib and libpng it brings) is lazy too and asked by it or a window: a fresh checkout's `zig build -Dplatform=tui` fetches none of them, and without `-Dpdf` the pdf, addons, static, mupdf-check, pdf-harness and bench steps say to add it; building.typ, install.typ and shared-libs.md say so
Co-Authored-By: Claude Fable 5.1 <[email protected]>
Claude-Session: https://claude.ai/code/session_016Y9MNAtZenFv4weoMD3cge
Diffstat (limited to 'build.zig')
| -rw-r--r-- | build.zig | 62 |
1 files changed, 39 insertions, 23 deletions
@@ -455,19 +455,25 @@ pub fn build(b: *std.Build) void { .root_source_file = b.path("src/c_heap.zig"), }); + // MuPDF, and the FreeType and zlib it is built against, are lazy: a + // build asks for them only when it builds the pdf addon (or a window, + // FreeType). Zig 0.17's configure is told the -D options and never the + // steps asked for, so "the pdf step's" is an option, on once MuPDF is + // fetched (and off Linux, where the addons are compiled in): a fresh + // checkout's plain build fetches none of the three, and -Dpdf fetches + // MuPDF once. + const pdf = b.option(bool, "pdf", "build the pdf addon over MuPDF (default: on once MuPDF is fetched, as -Dpdf does)") orelse + (std.Build.package_map.get(zon.dependencies.mupdf.hash).?.available or target.result.os.tag != .linux); + const mupdf_dep = if (pdf) b.lazyDependency("mupdf", .{}) else null; // One FreeType in a binary: the gui's glyph atlas links it and MuPDF is // built against it (see mupdf.zig). At c_optimize with the rest of the // vendored C, since MuPDF rasterizes a PDF's text through it. - const freetype_dep = b.dependency("freetype", .{ + const freetype_dep = if (pdf or also_gui or platform == .gui) b.lazyDependency("freetype", .{ .target = target, .optimize = c_optimize, .@"enable-libpng" = false, - }); - const freetype = freetype_dep.artifact("freetype"); - // ...and one zlib, the one FreeType links for its gzip module. Asked of - // FreeType's build with the options it asks with, the dependency cache - // hands back that same artifact rather than a second copy. - const zlib = freetype_dep.builder.dependency("zlib", .{ .target = target, .optimize = c_optimize }).artifact("z"); + }) else null; + const freetype = if (freetype_dep) |d| d.artifact("freetype") else null; // The kinds' C ABI (src/kinds/pardes_addon.h), translated once: the core's // records are the header's, never a mirror of it. @@ -476,21 +482,24 @@ pub fn build(b: *std.Build) void { const addon_mod = b.createModule(.{ .root_source_file = b.path("src/kinds/addon.zig"), .target = target, .optimize = optimize, .imports = &.{.{ .name = "pardes_addon", .module = kind_mod }} }); // The PDF addon (addons/pdf/pdf.zig over MuPDF through pdf_bridge.c), built // and installed as the image addon is: compiled only for a step that - // needs it (`pdf`, the tests), though fetched at the first configure, - // which Zig runs alike for every step. MuPDF is compiled against the - // build's FreeType and zlib and links them into the library, which holds - // its own copy of each beside a window's FreeType (docs/shared-libs.md); - // so all three are position-independent, and the library exports its + // needs it (`pdf`, the tests). MuPDF is compiled against the build's + // FreeType and zlib and links them into the library, which holds its + // own copy of each beside a window's FreeType (docs/shared-libs.md); so + // all three are position-independent, and the library exports its // `pardes_addon` alone. var pdf_addon: ?*std.Build.Step.Compile = null; - if (b.lazyDependency("mupdf", .{})) |mupdf_dep| { - freetype.root_module.pic = true; + if (mupdf_dep) |md| if (freetype_dep) |fd| { + // ...and one zlib, the one FreeType links for its gzip module. Asked + // of FreeType's build with the options it asks with, the dependency + // cache hands back that same artifact rather than a second copy. + const zlib = fd.builder.dependency("zlib", .{ .target = target, .optimize = c_optimize }).artifact("z"); + freetype.?.root_module.pic = true; zlib.root_module.pic = true; - const mupdf = mupdf_build.add(b, io, mupdf_dep, .{ + const mupdf = mupdf_build.add(b, io, md, .{ .target = target, .optimize = c_optimize, .jpx = enable_jpx, - .freetype = freetype, + .freetype = freetype.?, .zlib = zlib, .pic = true, }); @@ -529,7 +538,10 @@ pub fn build(b: *std.Build) void { run.setCwd(b.path(".")); bench.step.dependOn(&run.step); } - } + }; + // Without it, what needs it says how to have it. + const no_pdf: ?*std.Build.Step = if (pdf_addon == null) &b.addFail("this step needs the pdf addon, over MuPDF: add -Dpdf (it is fetched once, and on from then)").step else null; + if (no_pdf) |s| for ([_]*std.Build.Step{ mupdf_check, pdf_pointer_bench_step, pdf_scroll_bench_step }) |step| step.dependOn(s); const uucode_config = b.path("uucode_config.zig"); const uucode_tables = b.dependency("uucode", .{ @@ -918,7 +930,8 @@ pub fn build(b: *std.Build) void { gui_c.addIncludePath(b.path("src/gui")); gm.addImport("gui_c", gui_c.createModule()); } - gm.linkLibrary(freetype); + const ft = freetype orelse continue; + gm.linkLibrary(ft); // HarfBuzz from source, like FreeType: its FreeType integration // (HAVE_FREETYPE, hb-ft) links the freetype artifact above, so the two // share one FreeType. The flags are the ones Ghostty builds it with, @@ -935,7 +948,7 @@ pub fn build(b: *std.Build) void { .link_libcpp = true, }), }); - harfbuzz.root_module.linkLibrary(freetype); + harfbuzz.root_module.linkLibrary(ft); harfbuzz.root_module.addIncludePath(upstream.path("src")); harfbuzz.root_module.addCSourceFile(.{ .file = upstream.path("src/harfbuzz.cc"), @@ -1151,7 +1164,10 @@ pub fn build(b: *std.Build) void { for ([_]?*std.Build.Step.Compile{ image_addon, pdf_addon }, [_][]const u8{ "image", "pdf" }) |lib, name| { const step = b.step(name, b.fmt("install the {s} addon, <prefix>/lib/pardes/addons/{s}.so", .{ name, name })); addons_step.dependOn(step); - const l = lib orelse continue; + const l = lib orelse { + step.dependOn(no_pdf.?); + continue; + }; step.dependOn(&b.addInstallFileWithDir(l.getEmittedBin(), .lib, b.fmt("pardes/addons/{s}.so", .{name})).step); if (home_bin) |dir| { const copy = b.addSystemCommand(&.{ "install", "-Dm755" }); @@ -1176,7 +1192,7 @@ pub fn build(b: *std.Build) void { // also how a build for macOS, whose loader has no memfd, could have // image and PDF panes. const static_step = b.step("static", "a pardes with the image and pdf addons in it: the terminal's static (-Dplatform=tui -Dtarget=x86_64-linux-musl), the gui's dynamic (-Dplatform=gui)"); - if (static_mod) |m| + if (no_pdf) |s| static_step.dependOn(s) else if (static_mod) |m| static_step.dependOn(&b.addInstallArtifact(b.addExecutable(.{ .name = exe_name, .linkage = if (platform == .gui) null else static_linkage, .root_module = m }), .{}).step) else static_step.dependOn(&b.addFail("static is the terminal's on musl (-Dplatform=tui -Dtarget=x86_64-linux-musl) or the gui's (-Dplatform=gui)").step); @@ -1194,7 +1210,7 @@ pub fn build(b: *std.Build) void { iso_step.dependOn(&run_iso.step); } - const addons: []const *std.Build.Step.Compile = if (pdf_addon) |pdf| b.allocator.dupe(*std.Build.Step.Compile, &.{ image_addon, pdf }) catch @panic("OOM") else &.{image_addon}; + const addons: []const *std.Build.Step.Compile = if (pdf_addon) |l| b.allocator.dupe(*std.Build.Step.Compile, &.{ image_addon, l }) catch @panic("OOM") else &.{image_addon}; snap_build.addTty(b, .{ .exe = exe, .addons = addons, @@ -1261,7 +1277,7 @@ pub fn build(b: *std.Build) void { b.step("kitty-harness", "kitty graphics through a terminal pane end to end (a client inside, a kitty terminal or the GPU capture outside)").dependOn(&run_kitty_harness.step); const pdf_harness_step = b.step("pdf-harness", "exercise continuous PDF rendering, search, and sections navigation end to end"); - if (pdf_addon != null) { + if (no_pdf) |s| pdf_harness_step.dependOn(s) else { const run_pdf_harness = b.addRunArtifact(image_harness); run_pdf_harness.addArtifactArg(exe); run_pdf_harness.addArtifactArg(image_addon); |
