Crokey

Crokey helps incorporate configurable keybindings in crossterm based terminal applications by providing functions - parsing key combinations from strings - describing key combinations in strings - parsing key combinations at compile time

Parsing a string

Those strings are usually provided by a configuration file.

rust use crossterm::event::{KeyCode, KeyEvent, KeyModifiers}; assert_eq!( crokey::parse("alt-enter").unwrap(), KeyEvent::new(KeyCode::Enter, KeyModifiers::ALT), ); assert_eq!( crokey::parse("shift-F6").unwrap(), KeyEvent::new(KeyCode::F(6), KeyModifiers::SHIFT), );

Use key event "literals" thanks to procedural macros

Those key events are parsed at compile time and have zero runtime cost.

They're efficient and convenient for matching events or defining hardcoded keybindings.

rust match key_event { key!(ctrl-c) => { println!("Arg! You savagely killed me with a {}", fmt.to_string(key_event).red()); break; } key!(ctrl-q) => { println!("You typed {} which gracefully quits", fmt.to_string(key_event).green()); break; } _ => { println!("You typed {}", fmt.to_string(key_event).blue()); } } Complete example in /examples/print_key:

Displaying a string with a configurable format

```rust use crokey::*; use crossterm::event::{KeyCode, KeyEvent, KeyModifiers};

// The default format let format = KeyEventFormat::default(); asserteq!(format.tostring(key!(shift-a)), "Shift-a"); asserteq!(format.tostring(key!(ctrl-c)), "Ctrl-c");

// A more compact format let format = KeyEventFormat::default() .withimplicitshift() .withcontrol("^"); asserteq!(format.tostring(key!(shift-a)), "A"); asserteq!(format.to_string(key!(ctrl-c)), "^c"); ```

Crokey is used in broot and SafeCloset.