Skip to main content

tess/
keys.rs

1//! Custom keybindings loaded from `~/.config/tess/keys.toml`.
2//!
3//! Schema:
4//! ```toml
5//! [bindings]
6//! "j" = "scroll-down"
7//! "f1" = "!git status"
8//! ```
9
10use std::collections::HashMap;
11
12use crossterm::event::{KeyCode, KeyEvent, KeyModifiers};
13use serde::Deserialize;
14
15use crate::input::Command;
16
17#[derive(Debug, Clone)]
18pub enum BindingTarget {
19    Command(Command),
20    Shell(String),
21}
22
23#[derive(Debug, Clone)]
24pub struct KeyMap {
25    map: HashMap<KeyEvent, BindingTarget>,
26}
27
28impl KeyMap {
29    pub fn empty() -> Self {
30        Self { map: HashMap::new() }
31    }
32
33    /// Load keys from the global config dir (`/etc/tess/` or
34    /// `$TESS_GLOBAL_CONFIG_DIR`) and from `~/.config/tess/keys.toml`,
35    /// merging per individual binding key with local winning.
36    ///
37    /// Global parse errors warn on stderr and the global layer is treated as
38    /// empty; local parse errors fail startup.
39    pub fn load_layered() -> Result<Self, String> {
40        let mut bindings: HashMap<String, String> = HashMap::new();
41
42        // Global layer.
43        if let Some(dir) = crate::config_path::global_config_dir() {
44            let path = dir.join("keys.toml");
45            if path.exists() {
46                match std::fs::read_to_string(&path) {
47                    Ok(text) => {
48                        match toml::from_str::<KeysConfig>(&text) {
49                            Ok(cfg) => {
50                                for (k, v) in cfg.bindings {
51                                    bindings.insert(k, v);
52                                }
53                            }
54                            Err(e) => eprintln!(
55                                "tess: warning: keys.toml: {}: {e}; ignoring global config",
56                                path.display()
57                            ),
58                        }
59                    }
60                    Err(e) => eprintln!(
61                        "tess: warning: keys.toml: {}: {e}; ignoring global config",
62                        path.display()
63                    ),
64                }
65            }
66        }
67
68        // Local layer.
69        if let Some(dir) = crate::config_path::user_config_dir() {
70            let path = dir.join("keys.toml");
71            if path.exists() {
72                let text = std::fs::read_to_string(&path)
73                    .map_err(|e| format!("keys.toml: reading {}: {e}", path.display()))?;
74                let cfg: KeysConfig = toml::from_str(&text)
75                    .map_err(|e| format!("keys.toml: parsing {}: {e}", path.display()))?;
76                for (k, v) in cfg.bindings {
77                    bindings.insert(k, v);
78                }
79            }
80        }
81
82        // Build the final KeyMap from the merged bindings table.
83        let mut map = HashMap::with_capacity(bindings.len());
84        for (key_spec, action) in bindings {
85            let key = parse_key_spec(&key_spec)
86                .map_err(|e| format!("keys.toml: '{key_spec}': {e}"))?;
87            reject_forbidden_key(&key, &key_spec)
88                .map_err(|e| format!("keys.toml: {e}"))?;
89            let target = parse_action(&action)
90                .map_err(|e| format!("keys.toml: '{key_spec}': {e}"))?;
91            map.insert(key, target);
92        }
93        Ok(Self { map })
94    }
95
96    pub fn load_from_str(toml_text: &str) -> Result<Self, String> {
97        let cfg: KeysConfig = toml::from_str(toml_text)
98            .map_err(|e| format!("parsing: {e}"))?;
99        let mut map = HashMap::with_capacity(cfg.bindings.len());
100        for (key_spec, action) in cfg.bindings {
101            let key = parse_key_spec(&key_spec)
102                .map_err(|e| format!("'{key_spec}': {e}"))?;
103            reject_forbidden_key(&key, &key_spec)?;
104            let target = parse_action(&action)
105                .map_err(|e| format!("'{key_spec}': {e}"))?;
106            map.insert(key, target);
107        }
108        Ok(Self { map })
109    }
110
111    pub fn lookup(&self, key: &KeyEvent) -> Option<&BindingTarget> {
112        self.map.get(key)
113    }
114
115    pub fn is_empty(&self) -> bool {
116        self.map.is_empty()
117    }
118
119    /// Group user bindings by the kebab-case command name they target.
120    /// Shell-target bindings are excluded. Used by the help overlay to
121    /// replace default key displays with the user's chosen keys.
122    pub fn user_keys_by_command_name(&self) -> std::collections::HashMap<String, Vec<String>> {
123        let mut out: std::collections::HashMap<String, Vec<String>> =
124            std::collections::HashMap::new();
125        for (key, target) in &self.map {
126            let BindingTarget::Command(cmd) = target else { continue };
127            let Some(name) = command_to_kebab(cmd) else { continue };
128            out.entry(name.to_string())
129                .or_default()
130                .push(format_key_event(*key));
131        }
132        out
133    }
134}
135
136#[derive(Debug, Deserialize, Default)]
137struct KeysConfig {
138    #[serde(default)]
139    bindings: HashMap<String, String>,
140}
141
142/// Parse a key spec string into a `KeyEvent`.
143fn parse_key_spec(spec: &str) -> Result<KeyEvent, String> {
144    let lower = spec.to_lowercase();
145    let mut parts: Vec<&str> = lower.split('-').collect();
146    if parts.is_empty() {
147        return Err("empty key spec".to_string());
148    }
149    let key_part = parts.pop().unwrap();
150    let mut modifiers = KeyModifiers::NONE;
151    for m in &parts {
152        if m.is_empty() {
153            // Handle "ctrl--" (ctrl + dash). The trailing "-" became "".
154            continue;
155        }
156        match *m {
157            "ctrl" => modifiers |= KeyModifiers::CONTROL,
158            "alt" => modifiers |= KeyModifiers::ALT,
159            "shift" => modifiers |= KeyModifiers::SHIFT,
160            other => return Err(format!("unknown modifier '{other}'")),
161        }
162    }
163    let code = match key_part {
164        "esc" => KeyCode::Esc,
165        "enter" => KeyCode::Enter,
166        "tab" => KeyCode::Tab,
167        "backspace" => KeyCode::Backspace,
168        "space" => KeyCode::Char(' '),
169        "up" => KeyCode::Up,
170        "down" => KeyCode::Down,
171        "left" => KeyCode::Left,
172        "right" => KeyCode::Right,
173        "pgup" => KeyCode::PageUp,
174        "pgdn" => KeyCode::PageDown,
175        "home" => KeyCode::Home,
176        "end" => KeyCode::End,
177        "" => {
178            // The trailing piece was empty, meaning the key is literal "-"
179            // and the modifiers consumed everything else (e.g. "ctrl--").
180            KeyCode::Char('-')
181        }
182        s if s.starts_with('f') && s.len() > 1 => {
183            let n: u8 = s[1..].parse()
184                .map_err(|_| format!("unknown key '{s}'"))?;
185            KeyCode::F(n)
186        }
187        s if s.chars().count() == 1 => {
188            // For a BARE letter with no modifiers, an uppercase letter
189            // promotes to shift-prefix semantics ("J" == "shift-j").
190            // When modifiers are already present (e.g. "ctrl-J"), the
191            // user's intent is the literal letter — don't add SHIFT.
192            let original_char = spec.chars().last().unwrap();
193            if original_char.is_ascii_uppercase() && modifiers == KeyModifiers::NONE {
194                modifiers |= KeyModifiers::SHIFT;
195                KeyCode::Char(original_char.to_ascii_lowercase())
196            } else {
197                // Either lowercase letter, or uppercase with an explicit
198                // modifier — lowercase the char either way for consistency.
199                KeyCode::Char(original_char.to_ascii_lowercase())
200            }
201        }
202        other => return Err(format!("unknown key '{other}'")),
203    };
204    Ok(KeyEvent::new(code, modifiers))
205}
206
207fn reject_forbidden_key(key: &KeyEvent, original_spec: &str) -> Result<(), String> {
208    let forbidden = match (&key.code, key.modifiers) {
209        (KeyCode::Char('m'), KeyModifiers::NONE) => true,
210        (KeyCode::Char('\''), KeyModifiers::NONE) => true,
211        (KeyCode::Char('-'), KeyModifiers::NONE) => true,
212        (KeyCode::Char('x'), KeyModifiers::CONTROL) => true,
213        (KeyCode::Char(c), KeyModifiers::NONE) if c.is_ascii_digit() => true,
214        _ => false,
215    };
216    if forbidden {
217        return Err(format!(
218            "'{original_spec}' is part of a multi-key sequence and cannot be rebound"
219        ));
220    }
221    Ok(())
222}
223
224fn parse_action(action: &str) -> Result<BindingTarget, String> {
225    if let Some(shell_cmd) = action.strip_prefix('!') {
226        if shell_cmd.is_empty() {
227            return Err("shell binding requires a command after '!'".to_string());
228        }
229        return Ok(BindingTarget::Shell(shell_cmd.to_string()));
230    }
231    let cmd = command_from_kebab(action)
232        .ok_or_else(|| format!("unknown command '{action}'"))?;
233    Ok(BindingTarget::Command(cmd))
234}
235
236/// Map a kebab-case command name to the corresponding `Command` enum variant.
237fn command_from_kebab(name: &str) -> Option<Command> {
238    match name {
239        "scroll-down" => Some(Command::ScrollLines(1)),
240        "scroll-up" => Some(Command::ScrollLines(-1)),
241        "scroll-logical-down" => Some(Command::ScrollLogicalLines(1)),
242        "scroll-logical-up" => Some(Command::ScrollLogicalLines(-1)),
243        "page-down" => Some(Command::PageDown),
244        "page-up" => Some(Command::PageUp),
245        "half-page-down" => Some(Command::HalfPageDown),
246        "half-page-up" => Some(Command::HalfPageUp),
247        "quit" => Some(Command::Quit),
248        "refresh" => Some(Command::Refresh),
249        "reload" => Some(Command::Reload),
250        "toggle-line-numbers" => Some(Command::ToggleLineNumbers),
251        "toggle-chop" => Some(Command::ToggleChop),
252        "toggle-follow" => Some(Command::ToggleFollow),
253        "toggle-prettify" => Some(Command::TogglePrettify),
254        "search-forward" => Some(Command::SearchForward),
255        "search-backward" => Some(Command::SearchBackward),
256        "next-match" => Some(Command::NextMatch),
257        "previous-match" => Some(Command::PreviousMatch),
258        "option-prefix" => Some(Command::OptionPrefix),
259        "goto-line" => Some(Command::GotoLine),
260        "goto-record" => Some(Command::GotoRecord),
261        "goto-percent" => Some(Command::GotoPercent),
262        "mark-set" => Some(Command::MarkSet),
263        "mark-jump" => Some(Command::MarkJump),
264        "ctrl-x-prefix" => Some(Command::CtrlXPrefix),
265        "jump-previous" => Some(Command::JumpPrevious),
266        "shell-escape" => Some(Command::ShellEscape),
267        "cancel" => Some(Command::Cancel),
268        "hscroll-left" => Some(Command::HScrollLeft),
269        "hscroll-right" => Some(Command::HScrollRight),
270        "hscroll-left-step" => Some(Command::HScrollLeftStep),
271        "hscroll-right-step" => Some(Command::HScrollRightStep),
272        "clipboard-yank-line" => Some(Command::YankLine),
273        _ => None,
274    }
275}
276
277/// Inverse of `command_from_kebab` — covers the same command set.
278fn command_to_kebab(cmd: &Command) -> Option<&'static str> {
279    match cmd {
280        Command::ScrollLines(1) => Some("scroll-down"),
281        Command::ScrollLines(-1) => Some("scroll-up"),
282        Command::ScrollLogicalLines(1) => Some("scroll-logical-down"),
283        Command::ScrollLogicalLines(-1) => Some("scroll-logical-up"),
284        Command::PageDown => Some("page-down"),
285        Command::PageUp => Some("page-up"),
286        Command::HalfPageDown => Some("half-page-down"),
287        Command::HalfPageUp => Some("half-page-up"),
288        Command::Quit => Some("quit"),
289        Command::Refresh => Some("refresh"),
290        Command::Reload => Some("reload"),
291        Command::ToggleLineNumbers => Some("toggle-line-numbers"),
292        Command::ToggleChop => Some("toggle-chop"),
293        Command::ToggleFollow => Some("toggle-follow"),
294        Command::TogglePrettify => Some("toggle-prettify"),
295        Command::SearchForward => Some("search-forward"),
296        Command::SearchBackward => Some("search-backward"),
297        Command::NextMatch => Some("next-match"),
298        Command::PreviousMatch => Some("previous-match"),
299        Command::OptionPrefix => Some("option-prefix"),
300        Command::GotoLine => Some("goto-line"),
301        Command::GotoRecord => Some("goto-record"),
302        Command::GotoPercent => Some("goto-percent"),
303        Command::MarkSet => Some("mark-set"),
304        Command::MarkJump => Some("mark-jump"),
305        Command::CtrlXPrefix => Some("ctrl-x-prefix"),
306        Command::JumpPrevious => Some("jump-previous"),
307        Command::ShellEscape => Some("shell-escape"),
308        Command::Cancel => Some("cancel"),
309        Command::HScrollLeft => Some("hscroll-left"),
310        Command::HScrollRight => Some("hscroll-right"),
311        Command::HScrollLeftStep => Some("hscroll-left-step"),
312        Command::HScrollRightStep => Some("hscroll-right-step"),
313        Command::YankLine => Some("clipboard-yank-line"),
314        _ => None,
315    }
316}
317
318fn format_key_event(ke: KeyEvent) -> String {
319    let ctrl  = ke.modifiers.contains(KeyModifiers::CONTROL);
320    let alt   = ke.modifiers.contains(KeyModifiers::ALT);
321    let shift = ke.modifiers.contains(KeyModifiers::SHIFT);
322
323    // Convention: SHIFT-alone on an ASCII letter displays as the uppercase
324    // letter with no "Shift-" prefix (matches KEY_REGISTRY's `"J"` form).
325    if shift && !ctrl && !alt {
326        if let KeyCode::Char(c) = ke.code {
327            if c.is_ascii_alphabetic() {
328                return c.to_ascii_uppercase().to_string();
329            }
330        }
331    }
332
333    let mut parts: Vec<&'static str> = Vec::new();
334    if ctrl  { parts.push("Ctrl"); }
335    if alt   { parts.push("Alt"); }
336    if shift { parts.push("Shift"); }
337
338    let key = match ke.code {
339        KeyCode::Char(' ') => "Space".to_string(),
340        KeyCode::Char(c)   => c.to_string(),
341        KeyCode::F(n)      => format!("F{n}"),
342        KeyCode::Esc       => "Esc".into(),
343        KeyCode::Enter     => "Enter".into(),
344        KeyCode::Tab       => "Tab".into(),
345        KeyCode::Backspace => "Backspace".into(),
346        KeyCode::Up        => "\u{2191}".into(),
347        KeyCode::Down      => "\u{2193}".into(),
348        KeyCode::Left      => "\u{2190}".into(),
349        KeyCode::Right     => "\u{2192}".into(),
350        KeyCode::Home      => "Home".into(),
351        KeyCode::End       => "End".into(),
352        KeyCode::PageUp    => "PgUp".into(),
353        KeyCode::PageDown  => "PgDn".into(),
354        other              => format!("{other:?}"),
355    };
356    if parts.is_empty() { key } else { format!("{}-{}", parts.join("-"), key) }
357}
358
359#[cfg(test)]
360mod tests {
361    use super::*;
362    use std::sync::Mutex;
363
364    static HOME_LOCK: Mutex<()> = Mutex::new(());
365
366    #[test]
367    fn parse_empty_file_returns_empty_map() {
368        let m = KeyMap::load_from_str("").unwrap();
369        assert!(m.is_empty());
370    }
371
372    #[test]
373    fn parse_single_binding() {
374        let toml = r#"
375[bindings]
376"j" = "scroll-down"
377"#;
378        let m = KeyMap::load_from_str(toml).unwrap();
379        let key = KeyEvent::new(KeyCode::Char('j'), KeyModifiers::NONE);
380        assert!(matches!(m.lookup(&key), Some(BindingTarget::Command(Command::ScrollLines(1)))));
381    }
382
383    #[test]
384    fn parse_named_special_key() {
385        let toml = r#"
386[bindings]
387"f1" = "toggle-line-numbers"
388"esc" = "cancel"
389"#;
390        let m = KeyMap::load_from_str(toml).unwrap();
391        let f1 = KeyEvent::new(KeyCode::F(1), KeyModifiers::NONE);
392        let esc = KeyEvent::new(KeyCode::Esc, KeyModifiers::NONE);
393        assert!(matches!(m.lookup(&f1), Some(BindingTarget::Command(Command::ToggleLineNumbers))));
394        assert!(matches!(m.lookup(&esc), Some(BindingTarget::Command(Command::Cancel))));
395    }
396
397    #[test]
398    fn parse_modifier_combinations() {
399        let toml = r#"
400[bindings]
401"ctrl-r" = "reload"
402"shift-tab" = "scroll-logical-up"
403"#;
404        let m = KeyMap::load_from_str(toml).unwrap();
405        let ctrl_r = KeyEvent::new(KeyCode::Char('r'), KeyModifiers::CONTROL);
406        let shift_tab = KeyEvent::new(KeyCode::Tab, KeyModifiers::SHIFT);
407        assert!(matches!(m.lookup(&ctrl_r), Some(BindingTarget::Command(Command::Reload))));
408        assert!(matches!(m.lookup(&shift_tab), Some(BindingTarget::Command(Command::ScrollLogicalLines(-1)))));
409    }
410
411    #[test]
412    fn case_letter_resolves_to_shift_prefix() {
413        let toml = r#"
414[bindings]
415"J" = "scroll-logical-down"
416"#;
417        let m = KeyMap::load_from_str(toml).unwrap();
418        let shift_j = KeyEvent::new(KeyCode::Char('j'), KeyModifiers::SHIFT);
419        assert!(matches!(m.lookup(&shift_j), Some(BindingTarget::Command(Command::ScrollLogicalLines(1)))));
420    }
421
422    #[test]
423    fn forbidden_keys_error_at_parse() {
424        for key in &["m", "'", "-", "ctrl-x", "0", "5", "9"] {
425            let toml = format!(r#"
426[bindings]
427"{key}" = "quit"
428"#);
429            let err = KeyMap::load_from_str(&toml).unwrap_err();
430            assert!(err.contains("multi-key sequence"),
431                    "key '{key}' should be forbidden: {err}");
432        }
433    }
434
435    #[test]
436    fn unknown_command_name_errors() {
437        let toml = r#"
438[bindings]
439"j" = "definitely-not-a-real-command"
440"#;
441        let err = KeyMap::load_from_str(toml).unwrap_err();
442        assert!(err.contains("unknown command"));
443    }
444
445    #[test]
446    fn empty_shell_binding_errors() {
447        let toml = r#"
448[bindings]
449"f1" = "!"
450"#;
451        let err = KeyMap::load_from_str(toml).unwrap_err();
452        assert!(err.contains("requires a command"));
453    }
454
455    #[test]
456    fn parse_inline_shell_binding() {
457        let toml = r#"
458[bindings]
459"f2" = "!git status"
460"#;
461        let m = KeyMap::load_from_str(toml).unwrap();
462        let f2 = KeyEvent::new(KeyCode::F(2), KeyModifiers::NONE);
463        match m.lookup(&f2) {
464            Some(BindingTarget::Shell(cmd)) => assert_eq!(cmd, "git status"),
465            other => panic!("expected Shell, got {:?}", other),
466        }
467    }
468
469    #[test]
470    fn lookup_returns_none_for_unbound_key() {
471        let toml = r#"
472[bindings]
473"j" = "scroll-down"
474"#;
475        let m = KeyMap::load_from_str(toml).unwrap();
476        let other = KeyEvent::new(KeyCode::Char('k'), KeyModifiers::NONE);
477        assert!(m.lookup(&other).is_none());
478    }
479
480    #[test]
481    fn ctrl_uppercase_letter_does_not_add_shift() {
482        // "ctrl-J" should be Ctrl + 'j', NOT Ctrl + Shift + 'j'.
483        let toml = r#"
484[bindings]
485"ctrl-J" = "reload"
486"#;
487        let m = KeyMap::load_from_str(toml).unwrap();
488        let ctrl_j = KeyEvent::new(KeyCode::Char('j'), KeyModifiers::CONTROL);
489        assert!(matches!(m.lookup(&ctrl_j), Some(BindingTarget::Command(Command::Reload))),
490                "ctrl-J should resolve to Ctrl+j without Shift");
491        let ctrl_shift_j = KeyEvent::new(KeyCode::Char('j'), KeyModifiers::CONTROL | KeyModifiers::SHIFT);
492        assert!(m.lookup(&ctrl_shift_j).is_none(),
493                "ctrl-J should NOT also match Ctrl+Shift+j");
494    }
495
496    #[test]
497    fn user_remaps_by_command_name_groups_keys() {
498        let toml = r#"
499[bindings]
500"f3" = "scroll-down"
501"f4" = "scroll-down"
502"f5" = "quit"
503"#;
504        let m = KeyMap::load_from_str(toml).unwrap();
505        let groups = m.user_keys_by_command_name();
506        let mut down = groups.get("scroll-down").cloned().unwrap_or_default();
507        down.sort();
508        assert_eq!(down, vec!["F3".to_string(), "F4".to_string()]);
509        assert_eq!(groups.get("quit").cloned().unwrap_or_default(), vec!["F5".to_string()]);
510    }
511
512    #[test]
513    fn dash_with_modifier_is_a_real_key() {
514        // "ctrl--" should resolve to Ctrl + '-' (a valid bind).
515        // (Bare "-" is forbidden by reject_forbidden_key, but Ctrl-- isn't.)
516        let toml = r#"
517[bindings]
518"ctrl--" = "refresh"
519"#;
520        let m = KeyMap::load_from_str(toml).unwrap();
521        let ctrl_dash = KeyEvent::new(KeyCode::Char('-'), KeyModifiers::CONTROL);
522        assert!(matches!(m.lookup(&ctrl_dash), Some(BindingTarget::Command(Command::Refresh))));
523    }
524
525    #[test]
526    fn format_key_event_renders_modifier_combos() {
527        // Ctrl alone
528        assert_eq!(
529            format_key_event(KeyEvent::new(KeyCode::Char('r'), KeyModifiers::CONTROL)),
530            "Ctrl-r",
531        );
532        // Shift alone on a letter → uppercase, no prefix
533        assert_eq!(
534            format_key_event(KeyEvent::new(KeyCode::Char('j'), KeyModifiers::SHIFT)),
535            "J",
536        );
537        // Shift alone on a non-letter (e.g. Tab) → "Shift-Tab"
538        assert_eq!(
539            format_key_event(KeyEvent::new(KeyCode::Tab, KeyModifiers::SHIFT)),
540            "Shift-Tab",
541        );
542        // Plain lowercase letter → "j" (no uppercasing)
543        assert_eq!(
544            format_key_event(KeyEvent::new(KeyCode::Char('j'), KeyModifiers::NONE)),
545            "j",
546        );
547        // Function key
548        assert_eq!(
549            format_key_event(KeyEvent::new(KeyCode::F(3), KeyModifiers::NONE)),
550            "F3",
551        );
552        // Ctrl+Shift+letter — composed prefix, lowercase stored char
553        assert_eq!(
554            format_key_event(KeyEvent::new(KeyCode::Char('x'), KeyModifiers::CONTROL | KeyModifiers::SHIFT)),
555            "Ctrl-Shift-x",
556        );
557    }
558
559    #[test]
560    fn hscroll_names_resolve_to_commands() {
561        let toml = r#"
562[bindings]
563"f6" = "hscroll-right"
564"#;
565        let m = KeyMap::load_from_str(toml).unwrap();
566        let f6 = KeyEvent::new(KeyCode::F(6), KeyModifiers::NONE);
567        assert!(matches!(m.lookup(&f6), Some(BindingTarget::Command(Command::HScrollRight))));
568
569        assert!(matches!(command_from_kebab("hscroll-left"), Some(Command::HScrollLeft)));
570        assert!(matches!(command_from_kebab("hscroll-left-step"), Some(Command::HScrollLeftStep)));
571        assert!(matches!(command_from_kebab("hscroll-right-step"), Some(Command::HScrollRightStep)));
572    }
573
574    #[test]
575    fn command_kebab_round_trip() {
576        // Every name in command_from_kebab must round-trip through command_to_kebab.
577        let names = [
578            "scroll-down", "scroll-up", "scroll-logical-down", "scroll-logical-up",
579            "page-down", "page-up", "half-page-down", "half-page-up",
580            "quit", "refresh", "reload",
581            "toggle-line-numbers", "toggle-chop", "toggle-follow", "toggle-prettify",
582            "search-forward", "search-backward", "next-match", "previous-match",
583            "option-prefix", "goto-line", "goto-record", "goto-percent",
584            "mark-set", "mark-jump", "ctrl-x-prefix", "jump-previous",
585            "shell-escape", "cancel",
586            "hscroll-left", "hscroll-right", "hscroll-left-step", "hscroll-right-step",
587            "clipboard-yank-line",
588        ];
589        for name in &names {
590            let cmd = command_from_kebab(name).expect(&format!("from_kebab failed for {name}"));
591            let back = command_to_kebab(&cmd).expect(&format!("to_kebab failed for {name}"));
592            assert_eq!(back, *name, "round-trip mismatch for {name}");
593        }
594    }
595
596    #[test]
597    fn shell_bindings_are_excluded_from_user_keys() {
598        let toml = r#"
599[bindings]
600"f2" = "!git status"
601"f3" = "scroll-down"
602"#;
603        let m = KeyMap::load_from_str(toml).unwrap();
604        let groups = m.user_keys_by_command_name();
605        assert!(!groups.values().any(|v| v.contains(&"F2".to_string())),
606                "shell-bound F2 should not appear: {groups:?}");
607        assert_eq!(groups.get("scroll-down").cloned().unwrap_or_default(), vec!["F3".to_string()]);
608    }
609
610    #[test]
611    fn layered_keys_local_overrides_global_per_binding() {
612        let _guard = HOME_LOCK.lock().unwrap();
613        let prev_home = std::env::var_os("HOME");
614        let prev_global = std::env::var_os("TESS_GLOBAL_CONFIG_DIR");
615
616        let home = tempfile::tempdir().unwrap();
617        let global = tempfile::tempdir().unwrap();
618
619        std::env::set_var("HOME", home.path());
620        std::env::set_var("TESS_GLOBAL_CONFIG_DIR", global.path());
621
622        std::fs::write(
623            global.path().join("keys.toml"),
624            r#"
625[bindings]
626"j" = "scroll-down"
627"k" = "scroll-up"
628"#,
629        )
630        .unwrap();
631
632        let cfg_dir = home.path().join(".config").join("tess");
633        std::fs::create_dir_all(&cfg_dir).unwrap();
634        std::fs::write(
635            cfg_dir.join("keys.toml"),
636            r#"
637[bindings]
638"j" = "page-down"
639"#,
640        )
641        .unwrap();
642
643        let km = KeyMap::load_layered().unwrap();
644
645        // j: local wins (page-down)
646        let j = crossterm::event::KeyEvent::new(
647            crossterm::event::KeyCode::Char('j'),
648            crossterm::event::KeyModifiers::NONE,
649        );
650        match km.lookup(&j) {
651            Some(BindingTarget::Command(cmd)) => {
652                let dbg = format!("{cmd:?}");
653                assert!(dbg.to_lowercase().contains("page"), "got: {dbg}");
654            }
655            other => panic!("expected Command(PageDown), got {other:?}"),
656        }
657
658        // k: global survives (scroll-up)
659        let k = crossterm::event::KeyEvent::new(
660            crossterm::event::KeyCode::Char('k'),
661            crossterm::event::KeyModifiers::NONE,
662        );
663        match km.lookup(&k) {
664            Some(BindingTarget::Command(cmd)) => {
665                assert!(matches!(cmd, Command::ScrollLines(n) if *n < 0), "got: {cmd:?}");
666            }
667            other => panic!("expected Command(ScrollLines(-1)), got {other:?}"),
668        }
669
670        match prev_home {
671            Some(v) => std::env::set_var("HOME", v),
672            None => std::env::remove_var("HOME"),
673        }
674        match prev_global {
675            Some(v) => std::env::set_var("TESS_GLOBAL_CONFIG_DIR", v),
676            None => std::env::remove_var("TESS_GLOBAL_CONFIG_DIR"),
677        }
678    }
679
680    #[test]
681    fn layered_keys_warns_on_bad_global() {
682        let _guard = HOME_LOCK.lock().unwrap();
683        let prev_home = std::env::var_os("HOME");
684        let prev_global = std::env::var_os("TESS_GLOBAL_CONFIG_DIR");
685
686        let home = tempfile::tempdir().unwrap();
687        let global = tempfile::tempdir().unwrap();
688
689        std::env::set_var("HOME", home.path());
690        std::env::set_var("TESS_GLOBAL_CONFIG_DIR", global.path());
691
692        std::fs::write(
693            global.path().join("keys.toml"),
694            "= = not valid",
695        )
696        .unwrap();
697
698        // Local missing — should still succeed.
699        let km = KeyMap::load_layered().unwrap();
700        assert!(km.is_empty());
701
702        match prev_home {
703            Some(v) => std::env::set_var("HOME", v),
704            None => std::env::remove_var("HOME"),
705        }
706        match prev_global {
707            Some(v) => std::env::set_var("TESS_GLOBAL_CONFIG_DIR", v),
708            None => std::env::remove_var("TESS_GLOBAL_CONFIG_DIR"),
709        }
710    }
711}