ratada 0.5.0

A ratatui widget toolkit: driver, modals, forms, pickers, theming
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
50
51
52
53
54
55
56
57
58
59
60
61
62
63

//! Reading user key overrides out of a config table.
//!
//! The deserializable [`KeyBinding`] shape plus the lookup that turns a table
//! of action names onto chords into the bindings a [`super::Keymap`] uses,
//! warning about names no action answers to.

use std::collections::BTreeMap;

use serde::{Deserialize, Serialize};

use super::Action;

/// A key binding as written in config: one key, or a list of them.
///
/// `#[serde(untagged)]`, so `key = "ctrl+s"` and `key = ["ctrl+s", "f2"]` both
/// deserialize.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum KeyBinding {
    /// A single chord.
    One(String),
    /// Several chords, all triggering the action.
    Many(Vec<String>),
}

impl KeyBinding {
    /// The chords as a list, whichever form was written.
    #[must_use]
    pub fn into_keys(self) -> Vec<String> {
        match self {
            KeyBinding::One(key) => vec![key],
            KeyBinding::Many(keys) => keys,
        }
    }
}

/// Logs every `[keys]` entry that names no action, so a typo in config is not
/// silently ignored.
pub fn warn_unknown<A: Action>(overrides: &BTreeMap<String, Vec<String>>) {
    for name in overrides.keys() {
        if A::from_config_name(name).is_none() {
            log::warn!("unknown key action '{name}' in config, ignoring");
        }
    }
}

/// The keys to use for `action`: the override if config names it, else its
/// defaults.
pub(super) fn override_keys<A: Action>(
    overrides: &BTreeMap<String, Vec<String>>,
    action: A,
) -> Vec<String> {
    overrides
        .get(action.config_name())
        .cloned()
        .unwrap_or_else(|| {
            action
                .default_keys()
                .iter()
                .map(|key| (*key).to_string())
                .collect()
        })
}