refactor: type escaped OS strings and fix the final audit findings

Escaped config strings (ghostty_os::osbytes) kept reaching OS
boundaries undecoded, and decoding was occasionally applied to plain
text. The root cause was that both were plain `String`s. Now:
- `EncodedOs` is a newtype (no Display/AsRef<Path>) that decodes only
  via to_os/to_path/to_bytes/to_wide; plain text enters via
  from_plain_text. OS helpers (env, home, xdg, passwd, resources dir,
  path expansion), config::Path, WorkingDirectory, theme/file_load/edit
  paths, terminal pwd, OpenUrl/Pwd actions and termio cwd use it, so the
  compiler forces decoding at every boundary. os::open takes &OsStr.
  Config output is unchanged.

Fixes all rows of docs/rewrite/notes/review-rv5-codex.md (final-Z7.md):
screen-file copy; regex/OSC 8 URLs no longer decoded (regression);
lossless Windows WTF-8/WTF-16 for args, env and CreateProcessW; Windows
resources dir/TERMINFO; color OSC request lists and X11 color lookup no
longer allocate globally (C zero-allocation test extended); macOS Mach
handler resumes all threads before KERN_FAILURE (hang regression) and
SIGABRT minidumps go through the exception thread; plus open-config,
background images, crash dir, ssh cache, exe dir/PATH, fontconfig
filenames, file links, kitty TMPDIR, .hushlogin and benchmark paths.
The typing also surfaced and fixed gtk-custom-css, bell audio, bash
HISTFILE, OSC 52 writes and the C config getters.

Test Plan:
- cargo test --workspace (3376 passed)
- just check-macos (both), just check-windows, just check-wasm
- diff <(ghostty-rs +show-config --default --docs) \
  <(ghostty +show-config --default --docs)
This commit is contained in:
ddidderr committed 2026-10-12 10:06:07 +02:00
1 parent 0f898d3e41
commit 8f3e206d9f
92 files changed
+2967 -992

No files matched your search

+16 -12
View File
@@ -40,12 +40,12 @@ fn warn(what: &str, e: &dyn std::fmt::Display) -> BenchmarkFailed {
/// Shared data-file handling: opened in setup, closed in teardown.
struct Data {
path: Option<String>,
path: Option<std::path::PathBuf>,
f: Option<Box<dyn Read>>,
}
impl Data {
fn new(path: Option<String>) -> Data {
fn new(path: Option<std::path::PathBuf>) -> Data {
Data { path, f: None }
}
@@ -103,7 +103,7 @@ impl TerminalStream {
pub fn create(args: &mut Args) -> std::result::Result<Self, String> {
let rows = args.take("terminal-rows", 80u16)?;
let cols = args.take("terminal-cols", 120u16)?;
let data = args.take_opt_string("data")?;
let data = args.take_opt_path("data")?;
let full = match args.take_opt_string("handler")?.as_deref() {
None | Some("print") => false,
Some("full") => true,
@@ -160,7 +160,7 @@ pub struct TerminalParser {
impl TerminalParser {
pub fn create(args: &mut Args) -> std::result::Result<Self, String> {
Ok(TerminalParser {
data: Data::new(args.take_opt_string("data")?),
data: Data::new(args.take_opt_path("data")?),
})
}
}
@@ -196,7 +196,7 @@ pub struct OscParser {
impl OscParser {
pub fn create(args: &mut Args) -> std::result::Result<Self, String> {
Ok(OscParser {
data: Data::new(args.take_opt_string("data")?),
data: Data::new(args.take_opt_path("data")?),
parser: osc::Parser::init(true),
})
}
@@ -267,7 +267,7 @@ impl CodepointWidth {
Some(m) => return Err(format!("invalid value for --mode: {m}")),
};
Ok(CodepointWidth {
data: Data::new(args.take_opt_string("data")?),
data: Data::new(args.take_opt_path("data")?),
mode,
})
}
@@ -390,7 +390,7 @@ impl GraphemeBreak {
Some(m) => return Err(format!("invalid value for --mode: {m}")),
};
Ok(GraphemeBreak {
data: Data::new(args.take_opt_string("data")?),
data: Data::new(args.take_opt_path("data")?),
noop,
})
}
@@ -479,7 +479,7 @@ impl IsSymbol {
Some(m) => return Err(format!("invalid value for --mode: {m}")),
};
Ok(IsSymbol {
data: Data::new(args.take_opt_string("data")?),
data: Data::new(args.take_opt_path("data")?),
mode,
})
}
@@ -544,7 +544,7 @@ impl ScreenClone {
};
let rows = args.take("terminal-rows", 80u16)?;
let cols = args.take("terminal-cols", 120u16)?;
let data = args.take_opt_string("data")?;
let data = args.take_opt_path("data")?;
let terminal = Terminal::new(TermOptions::new(cols, rows)).map_err(|e| format!("{e:?}"))?;
Ok(ScreenClone {
data: Data::new(data),
@@ -674,9 +674,13 @@ mod tests {
fn run(action: &str, mode: &str, data: &std::path::Path) -> Result {
let mut args = Args::parse([
format!("+{action}"),
format!("--mode={mode}"),
format!("--data={}", data.display()),
std::ffi::OsString::from(format!("+{action}")),
std::ffi::OsString::from(format!("--mode={mode}")),
{
let mut a = std::ffi::OsString::from("--data=");
a.push(data);
a
},
])
.unwrap();
match action {