semtext 0.1.0

Terminal UI Library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

// action.rs
//
// Copyright (c) 2020-2021  Douglas P Lau
//
use crate::input::{KeyPress, ModKeys, NavKey};
use crate::layout::Dim;
use std::collections::HashMap;

/// Screen actions
#[non_exhaustive]
#[derive(Clone, Copy, Debug, PartialEq)]
pub enum Action {
    /// Terminal resized
    Resize(Dim),

    /// Redraw required
    Redraw(),

    /// Quit application
    Quit(),
}

/// Key / Action mapping
///
/// A mapping of [KeyPress] events to [Action]s, used for [Screen] hotkeys.
///
/// [Action]: enum.Action.html
/// [KeyPress]: enum.KeyPress.html
/// [Screen]: ../struct.Screen.html#method.set_keymap
pub struct KeyMap {
    /// Mapping of key presses to actions
    map: HashMap<(KeyPress, ModKeys), Action>,
}

impl Default for KeyMap {
    fn default() -> Self {
        let mut map = HashMap::new();
        let key = (KeyPress::Navigation(NavKey::Esc), ModKeys::Empty);
        map.insert(key, Action::Quit());
        Self { map }
    }
}

impl KeyMap {
    /// Lookup an [Action] from a key event
    pub fn lookup(&self, key: KeyPress, mods: ModKeys) -> Option<Action> {
        self.map.get(&(key, mods)).cloned()
    }
}