refactor(config): parse config values from raw bytes like Zig
Zig parses config values (cli/args.zig, Config.zig field parsers, config/string.zig) from raw byte slices, and each field type decides whether it requires UTF-8 (InvalidValue otherwise) or stores bytes. The port escape-encoded raw bytes into Strings at the line reader and let fields parse the escaped text, so fields could observe encoding artifacts; successive audits kept finding such leaks (RV5-RV8). Field parsers now receive the original bytes: text fields validate UTF-8 where Zig does, byte/path fields store bytes (EncodedOs/OsString). This resolves all 9 RV8 findings (docs/rewrite/notes/review-rv8-codex.md), each with a regression test: Windows path conversion fails with BadPathName instead of substituting U+FFFD; Windows process launch uses strict UTF-8 like Zig's Command; the WTF-8 decoder accepts paired- surrogate encodings like Zig; literal U+FDD0 Unicode key triggers; selection-word-chars and clipboard-codepoint-map reject invalid UTF-8; font style / codepoint-map family names use original bytes; C title actions forward bytes; D-Bus new-window/Flatpak conversions match Zig. Design, sweep and validation: docs/rewrite/notes/final-bytes-refactor.md. Also moves the bundled iTerm2-Color-Schemes license out of resources/themes/ so +list-themes no longer lists it as a theme (output is now byte-identical to Ghostty 1.3.1). Done by Codex (gpt-6-astra), reviewed and verified by the orchestrator. Test Plan: - cargo test --workspace --no-fail-fast (3428 passed, exit 0) - just check-macos (both), just check-windows, just check-wasm - +show-config --default --docs, +list-keybinds, +list-actions --docs, +list-themes --plain compared with /usr/bin/ghostty
This commit is contained in:
1 parent
37a1646611
commit
672e8a4ae1
100 files changed
+2310
-1054
No files matched your search
@@ -62,11 +62,21 @@ impl ThemeListElement {
|
||||
/// TODO: use Unicode-aware comparison (as in Zig).
|
||||
#[must_use]
|
||||
pub fn order(&self, other: &ThemeListElement) -> Ordering {
|
||||
let a = self.theme.bytes().map(|c| c.to_ascii_lowercase());
|
||||
let b = other.theme.bytes().map(|c| c.to_ascii_lowercase());
|
||||
let a = config_str_to_bytes(&self.theme)
|
||||
.into_iter()
|
||||
.map(|c| c.to_ascii_lowercase());
|
||||
let b = config_str_to_bytes(&other.theme)
|
||||
.into_iter()
|
||||
.map(|c| c.to_ascii_lowercase());
|
||||
a.cmp(b)
|
||||
}
|
||||
|
||||
/// Plain text for TUI display/search, separate from byte-preserving export.
|
||||
#[must_use]
|
||||
pub fn display_name(&self) -> String {
|
||||
ghostty_os::osbytes::config_str_to_text(&self.theme)
|
||||
}
|
||||
|
||||
/// `file://` URI of the theme file (Zig: `toUri`).
|
||||
#[must_use]
|
||||
pub fn to_uri(&self) -> String {
|
||||
@@ -122,11 +132,11 @@ pub fn collect_themes(resources_dir: Option<&EncodedOs>) -> Vec<ThemeListElement
|
||||
let mut themes = vec![];
|
||||
let mut it = LocationIterator::new(resources_dir);
|
||||
while let Some((location, dir)) = it.next_location() {
|
||||
let rd = match std::fs::read_dir(dir.to_path()) {
|
||||
let rd = match dir.to_path().and_then(std::fs::read_dir) {
|
||||
Ok(rd) => rd,
|
||||
Err(e) if e.kind() == std::io::ErrorKind::NotFound => continue,
|
||||
Err(e) => {
|
||||
eprintln!("error trying to open {}: {e}", dir.as_encoded());
|
||||
eprintln!("error trying to open {}: {e}", dir.to_text_lossy());
|
||||
continue;
|
||||
}
|
||||
};
|
||||
@@ -145,7 +155,7 @@ pub fn collect_themes(resources_dir: Option<&EncodedOs>) -> Vec<ThemeListElement
|
||||
continue;
|
||||
}
|
||||
themes.push(ThemeListElement {
|
||||
path: EncodedOs::from_path(&dir.to_path().join(&raw_name)),
|
||||
path: dir.join(&EncodedOs::from_os(&raw_name)),
|
||||
location,
|
||||
theme: name,
|
||||
rank: None,
|
||||
@@ -170,7 +180,9 @@ pub fn should_include_theme(theme_filter: ColorScheme, theme_config: &Config) ->
|
||||
|
||||
/// Make `path` absolute (`Config::load_file` requires absolute paths).
|
||||
pub(crate) fn absolute_path(path: &EncodedOs) -> EncodedOs {
|
||||
std::path::absolute(path.to_path()).map_or_else(|_| path.clone(), |p| EncodedOs::from_path(&p))
|
||||
path.to_path()
|
||||
.and_then(std::path::absolute)
|
||||
.map_or_else(|_| path.clone(), |p| EncodedOs::from_path(&p))
|
||||
}
|
||||
|
||||
fn resources_dir() -> Option<EncodedOs> {
|
||||
@@ -216,7 +228,7 @@ fn resources_dir() -> Option<EncodedOs> {
|
||||
///
|
||||
/// * `--color`: Specify the color scheme of the themes included in the list.
|
||||
/// This can be `dark`, `light`, or `all`. The default is `all`.
|
||||
pub fn run(args: &[String]) -> Result<u8, Error> {
|
||||
pub fn run(args: &[impl AsRef<[u8]>]) -> Result<u8, Error> {
|
||||
let mut opts = Options::default();
|
||||
crate::parse_options(&mut opts, args)?;
|
||||
|
||||
@@ -316,12 +328,26 @@ mod tests {
|
||||
assert_eq!(1, themes.len());
|
||||
assert_eq!(config_str_to_bytes(&themes[0].theme), b"th\xffeme".to_vec());
|
||||
// The path points at the real file and the listing loads it.
|
||||
assert_eq!(themes[0].path.to_path(), dir.join(raw));
|
||||
assert_eq!(themes[0].path.to_path().unwrap(), dir.join(raw));
|
||||
let mut out = Vec::new();
|
||||
write_plain(&mut out, &themes, &Options::default()).unwrap();
|
||||
assert_eq!(out, b"th\xffeme (resources)\n");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn theme_display_and_sort_use_original_names() {
|
||||
let theme = |name: EncodedOs| ThemeListElement {
|
||||
theme: name.into_encoded(),
|
||||
path: EncodedOs::new(),
|
||||
location: Location::Resources,
|
||||
rank: None,
|
||||
};
|
||||
let literal = theme(EncodedOs::from_plain_text("\u{fdd0}é"));
|
||||
let invalid = theme(EncodedOs::from_bytes(b"\xff"));
|
||||
assert_eq!(literal.display_name(), "\u{fdd0}é");
|
||||
assert_eq!(literal.order(&invalid), Ordering::Less);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn collect_sort_and_filter() {
|
||||
let tmp = theme_dir(&[
|
||||
@@ -407,13 +433,9 @@ mod tests {
|
||||
#[test]
|
||||
fn options_color() {
|
||||
let mut opts = Options::default();
|
||||
crate::parse_options(
|
||||
&mut opts,
|
||||
&["g".into(), "--color=dark".into(), "--path".into()],
|
||||
)
|
||||
.unwrap();
|
||||
crate::parse_options(&mut opts, &["g", "--color=dark", "--path"]).unwrap();
|
||||
assert_eq!(ColorScheme::Dark, opts.color);
|
||||
assert!(opts.path);
|
||||
assert!(crate::parse_options(&mut opts, &["g".into(), "--color=blue".into()]).is_err());
|
||||
assert!(crate::parse_options(&mut opts, &["g", "--color=blue"]).is_err());
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user