build: options to enable/disable terminfo & termcap install (take 2) (#5340)

Fixes #5253

Add -Demit-terminfo and -Demit-termcap build options to enable/disable
installation of source terminfo and termcap files.

Replacement for #5311
This commit is contained in:
Mitchell Hashimoto
2025-01-24 13:28:48 -08:00
committed by GitHub
3 changed files with 56 additions and 20 deletions

View File

@ -55,6 +55,8 @@ emit_helpgen: bool = false,
emit_docs: bool = false, emit_docs: bool = false,
emit_webdata: bool = false, emit_webdata: bool = false,
emit_xcframework: bool = false, emit_xcframework: bool = false,
emit_terminfo: bool = false,
emit_termcap: bool = false,
/// Environmental properties /// Environmental properties
env: std.process.EnvMap, env: std.process.EnvMap,
@ -306,6 +308,27 @@ pub fn init(b: *std.Build) !Config {
break :emit_docs path != null; break :emit_docs path != null;
}; };
config.emit_terminfo = b.option(
bool,
"emit-terminfo",
"Install Ghostty terminfo source file",
) orelse switch (target.result.os.tag) {
.windows => true,
else => switch (optimize) {
.Debug => true,
.ReleaseSafe, .ReleaseFast, .ReleaseSmall => false,
},
};
config.emit_termcap = b.option(
bool,
"emit-termcap",
"Install Ghostty termcap file",
) orelse switch (optimize) {
.Debug => true,
.ReleaseSafe, .ReleaseFast, .ReleaseSmall => false,
};
config.emit_webdata = b.option( config.emit_webdata = b.option(
bool, bool,
"emit-webdata", "emit-webdata",

View File

@ -23,9 +23,12 @@ pub fn init(b: *std.Build, cfg: *const Config) !GhosttyResources {
// Write it // Write it
var wf = b.addWriteFiles(); var wf = b.addWriteFiles();
const src_source = wf.add("share/terminfo/ghostty.terminfo", str.items); const source = wf.add("ghostty.terminfo", str.items);
const src_install = b.addInstallFile(src_source, "share/terminfo/ghostty.terminfo");
try steps.append(&src_install.step); if (cfg.emit_terminfo) {
const source_install = b.addInstallFile(source, "share/terminfo/ghostty.terminfo");
try steps.append(&source_install.step);
}
// Windows doesn't have the binaries below. // Windows doesn't have the binaries below.
if (cfg.target.result.os.tag == .windows) break :terminfo; if (cfg.target.result.os.tag == .windows) break :terminfo;
@ -33,10 +36,10 @@ pub fn init(b: *std.Build, cfg: *const Config) !GhosttyResources {
// Convert to termcap source format if thats helpful to people and // Convert to termcap source format if thats helpful to people and
// install it. The resulting value here is the termcap source in case // install it. The resulting value here is the termcap source in case
// that is used for other commands. // that is used for other commands.
{ if (cfg.emit_termcap) {
const run_step = RunStep.create(b, "infotocap"); const run_step = RunStep.create(b, "infotocap");
run_step.addArg("infotocap"); run_step.addArg("infotocap");
run_step.addFileArg(src_source); run_step.addFileArg(source);
const out_source = run_step.captureStdOut(); const out_source = run_step.captureStdOut();
_ = run_step.captureStdErr(); // so we don't see stderr _ = run_step.captureStdErr(); // so we don't see stderr
@ -49,14 +52,20 @@ pub fn init(b: *std.Build, cfg: *const Config) !GhosttyResources {
const run_step = RunStep.create(b, "tic"); const run_step = RunStep.create(b, "tic");
run_step.addArgs(&.{ "tic", "-x", "-o" }); run_step.addArgs(&.{ "tic", "-x", "-o" });
const path = run_step.addOutputFileArg("terminfo"); const path = run_step.addOutputFileArg("terminfo");
run_step.addFileArg(src_source); run_step.addFileArg(source);
_ = run_step.captureStdErr(); // so we don't see stderr _ = run_step.captureStdErr(); // so we don't see stderr
// Depend on the terminfo source install step so that Zig build // Ensure that `share/terminfo` is a directory, otherwise the `cp
// creates the "share" directory for us. // -R` will create a file named `share/terminfo`
run_step.step.dependOn(&src_install.step); const mkdir_step = RunStep.create(b, "make share/terminfo directory");
switch (cfg.target.result.os.tag) {
// windows mkdir shouldn't need "-p"
.windows => mkdir_step.addArgs(&.{"mkdir"}),
else => mkdir_step.addArgs(&.{ "mkdir", "-p" }),
}
mkdir_step.addArg(b.fmt("{s}/share/terminfo", .{b.install_path}));
try steps.append(&mkdir_step.step);
{
// Use cp -R instead of Step.InstallDir because we need to preserve // Use cp -R instead of Step.InstallDir because we need to preserve
// symlinks in the terminfo database. Zig's InstallDir step doesn't // symlinks in the terminfo database. Zig's InstallDir step doesn't
// handle symlinks correctly yet. // handle symlinks correctly yet.
@ -64,10 +73,10 @@ pub fn init(b: *std.Build, cfg: *const Config) !GhosttyResources {
copy_step.addArgs(&.{ "cp", "-R" }); copy_step.addArgs(&.{ "cp", "-R" });
copy_step.addFileArg(path); copy_step.addFileArg(path);
copy_step.addArg(b.fmt("{s}/share", .{b.install_path})); copy_step.addArg(b.fmt("{s}/share", .{b.install_path}));
copy_step.step.dependOn(&mkdir_step.step);
try steps.append(&copy_step.step); try steps.append(&copy_step.step);
} }
} }
}
// Shell-integration // Shell-integration
{ {

View File

@ -21,7 +21,11 @@ pub fn resourcesDir(alloc: std.mem.Allocator) !?[]const u8 {
// This is the sentinel value we look for in the path to know // This is the sentinel value we look for in the path to know
// we've found the resources directory. // we've found the resources directory.
const sentinel = "terminfo/ghostty.termcap"; const sentinel = switch (comptime builtin.target.os.tag) {
.windows => "terminfo/ghostty.terminfo",
.macos => "terminfo/78/xterm-ghostty",
else => "terminfo/x/xterm-ghostty",
};
// Get the path to our running binary // Get the path to our running binary
var exe_buf: [std.fs.max_path_bytes]u8 = undefined; var exe_buf: [std.fs.max_path_bytes]u8 = undefined;