revue 2.71.1

A Vue-style TUI framework for Rust with CSS styling
Documentation
//! Key definitions and keymaps

/// Key code
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum Key {
    /// Character key
    Char(char),
    /// Enter/Return
    Enter,
    /// Escape
    Escape,
    /// Tab
    Tab,
    /// Shift+Tab (back tab)
    BackTab,
    /// Backspace
    Backspace,
    /// Delete
    Delete,
    /// Arrow up
    Up,
    /// Arrow down
    Down,
    /// Arrow left
    Left,
    /// Arrow right
    Right,
    /// Home
    Home,
    /// End
    End,
    /// Page up
    PageUp,
    /// Page down
    PageDown,
    /// Function key (F1-F12)
    F(u8),
    /// Insert
    Insert,
    /// Null (no key)
    Null,
    /// Unknown key (not recognized)
    Unknown,
}

impl Key {
    /// Create a Ctrl+key binding
    pub fn ctrl(ch: char) -> KeyBinding {
        KeyBinding {
            key: Key::Char(ch),
            ctrl: true,
            alt: false,
            shift: false,
        }
    }

    /// Create an Alt+key binding
    pub fn alt(ch: char) -> KeyBinding {
        KeyBinding {
            key: Key::Char(ch),
            ctrl: false,
            alt: true,
            shift: false,
        }
    }
}

/// A key binding with modifiers
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct KeyBinding {
    /// The key code
    pub key: Key,
    /// Ctrl modifier
    pub ctrl: bool,
    /// Alt modifier
    pub alt: bool,
    /// Shift modifier
    pub shift: bool,
}

/// Keymap for mapping keys to actions
pub struct KeyMap<A> {
    bindings: std::collections::HashMap<KeyBinding, A>,
}

impl<A: Clone> KeyMap<A> {
    /// Create a new empty keymap
    pub fn new() -> Self {
        Self {
            bindings: std::collections::HashMap::new(),
        }
    }

    /// Bind a key to an action
    pub fn bind(&mut self, binding: KeyBinding, action: A) {
        self.bindings.insert(binding, action);
    }

    /// Get the action for a key binding
    pub fn get(&self, binding: &KeyBinding) -> Option<&A> {
        self.bindings.get(binding)
    }
}

impl<A: Clone> Default for KeyMap<A> {
    fn default() -> Self {
        Self::new()
    }
}

// Tests moved to tests/event_tests.rs