368 lines
14 KiB
Rust
368 lines
14 KiB
Rust
//! Mapping of inputs to sequences of actions.
|
|
use std::collections::HashMap;
|
|
|
|
use super::actions::{Action, Direction};
|
|
|
|
use serde::Deserialize;
|
|
use strum::IntoEnumIterator;
|
|
use zellij_tile::data::*;
|
|
|
|
#[derive(Clone, Debug, PartialEq)]
|
|
pub struct Keybinds(HashMap<InputMode, ModeKeybinds>);
|
|
#[derive(Clone, Debug, Default, PartialEq)]
|
|
pub struct ModeKeybinds(HashMap<Key, Vec<Action>>);
|
|
|
|
/// Intermediate struct used for deserialisation
|
|
#[derive(Clone, Debug, PartialEq, Deserialize)]
|
|
pub struct KeybindsFromYaml(HashMap<InputMode, Vec<KeyActionFromYaml>>);
|
|
|
|
/// Intermediate struct used for deserialisation
|
|
#[derive(Clone, Debug, PartialEq, Deserialize)]
|
|
pub struct KeyActionFromYaml {
|
|
action: Vec<Action>,
|
|
key: Vec<Key>,
|
|
}
|
|
|
|
impl Default for Keybinds {
|
|
fn default() -> Keybinds {
|
|
let mut defaults = Keybinds::new();
|
|
|
|
for mode in InputMode::iter() {
|
|
defaults
|
|
.0
|
|
.insert(mode, Keybinds::get_defaults_for_mode(&mode));
|
|
}
|
|
defaults
|
|
}
|
|
}
|
|
|
|
impl Keybinds {
|
|
pub fn new() -> Keybinds {
|
|
Keybinds(HashMap::<InputMode, ModeKeybinds>::new())
|
|
}
|
|
|
|
pub fn get_default_keybinds_with_config(keybinds: Option<KeybindsFromYaml>) -> Keybinds {
|
|
let default_keybinds = Keybinds::default();
|
|
if let Some(keybinds) = keybinds {
|
|
default_keybinds.merge_keybinds(Keybinds::from(keybinds))
|
|
} else {
|
|
default_keybinds
|
|
}
|
|
}
|
|
|
|
/// Merges two Keybinds structs into one Keybinds struct
|
|
/// `other` overrides the ModeKeybinds of `self`.
|
|
fn merge_keybinds(&self, other: Keybinds) -> Keybinds {
|
|
let mut keybinds = Keybinds::new();
|
|
|
|
for mode in InputMode::iter() {
|
|
let mut mode_keybinds = ModeKeybinds::new();
|
|
if let Some(keybind) = self.0.get(&mode) {
|
|
mode_keybinds.0.extend(keybind.0.clone());
|
|
};
|
|
if let Some(keybind) = other.0.get(&mode) {
|
|
mode_keybinds.0.extend(keybind.0.clone());
|
|
}
|
|
if !mode_keybinds.0.is_empty() {
|
|
keybinds.0.insert(mode, mode_keybinds);
|
|
}
|
|
}
|
|
keybinds
|
|
}
|
|
|
|
/// Returns the default keybinds for a given [`InputMode`].
|
|
fn get_defaults_for_mode(mode: &InputMode) -> ModeKeybinds {
|
|
let mut defaults = HashMap::new();
|
|
|
|
match *mode {
|
|
InputMode::Normal => {
|
|
defaults.insert(
|
|
Key::Ctrl('g'),
|
|
vec![Action::SwitchToMode(InputMode::Locked)],
|
|
);
|
|
defaults.insert(Key::Ctrl('p'), vec![Action::SwitchToMode(InputMode::Pane)]);
|
|
defaults.insert(
|
|
Key::Ctrl('r'),
|
|
vec![Action::SwitchToMode(InputMode::Resize)],
|
|
);
|
|
defaults.insert(Key::Ctrl('t'), vec![Action::SwitchToMode(InputMode::Tab)]);
|
|
defaults.insert(
|
|
Key::Ctrl('s'),
|
|
vec![Action::SwitchToMode(InputMode::Scroll)],
|
|
);
|
|
defaults.insert(Key::Ctrl('q'), vec![Action::Quit]);
|
|
}
|
|
InputMode::Locked => {
|
|
defaults.insert(
|
|
Key::Ctrl('g'),
|
|
vec![Action::SwitchToMode(InputMode::Normal)],
|
|
);
|
|
}
|
|
InputMode::Resize => {
|
|
defaults.insert(
|
|
Key::Ctrl('g'),
|
|
vec![Action::SwitchToMode(InputMode::Locked)],
|
|
);
|
|
defaults.insert(Key::Ctrl('p'), vec![Action::SwitchToMode(InputMode::Pane)]);
|
|
defaults.insert(
|
|
Key::Ctrl('r'),
|
|
vec![Action::SwitchToMode(InputMode::Normal)],
|
|
);
|
|
defaults.insert(Key::Ctrl('t'), vec![Action::SwitchToMode(InputMode::Tab)]);
|
|
defaults.insert(
|
|
Key::Ctrl('s'),
|
|
vec![Action::SwitchToMode(InputMode::Scroll)],
|
|
);
|
|
defaults.insert(Key::Ctrl('q'), vec![Action::Quit]);
|
|
defaults.insert(Key::Esc, vec![Action::SwitchToMode(InputMode::Normal)]);
|
|
defaults.insert(
|
|
Key::Char('\n'),
|
|
vec![Action::SwitchToMode(InputMode::Normal)],
|
|
);
|
|
defaults.insert(
|
|
Key::Char(' '),
|
|
vec![Action::SwitchToMode(InputMode::Normal)],
|
|
);
|
|
|
|
defaults.insert(Key::Char('h'), vec![Action::Resize(Direction::Left)]);
|
|
defaults.insert(Key::Char('j'), vec![Action::Resize(Direction::Down)]);
|
|
defaults.insert(Key::Char('k'), vec![Action::Resize(Direction::Up)]);
|
|
defaults.insert(Key::Char('l'), vec![Action::Resize(Direction::Right)]);
|
|
|
|
defaults.insert(Key::Left, vec![Action::Resize(Direction::Left)]);
|
|
defaults.insert(Key::Down, vec![Action::Resize(Direction::Down)]);
|
|
defaults.insert(Key::Up, vec![Action::Resize(Direction::Up)]);
|
|
defaults.insert(Key::Right, vec![Action::Resize(Direction::Right)]);
|
|
}
|
|
InputMode::Pane => {
|
|
defaults.insert(
|
|
Key::Ctrl('g'),
|
|
vec![Action::SwitchToMode(InputMode::Locked)],
|
|
);
|
|
defaults.insert(
|
|
Key::Ctrl('p'),
|
|
vec![Action::SwitchToMode(InputMode::Normal)],
|
|
);
|
|
defaults.insert(
|
|
Key::Ctrl('r'),
|
|
vec![Action::SwitchToMode(InputMode::Resize)],
|
|
);
|
|
defaults.insert(Key::Ctrl('t'), vec![Action::SwitchToMode(InputMode::Tab)]);
|
|
defaults.insert(
|
|
Key::Ctrl('s'),
|
|
vec![Action::SwitchToMode(InputMode::Scroll)],
|
|
);
|
|
defaults.insert(Key::Ctrl('q'), vec![Action::Quit]);
|
|
defaults.insert(Key::Esc, vec![Action::SwitchToMode(InputMode::Normal)]);
|
|
defaults.insert(
|
|
Key::Char('\n'),
|
|
vec![Action::SwitchToMode(InputMode::Normal)],
|
|
);
|
|
defaults.insert(
|
|
Key::Char(' '),
|
|
vec![Action::SwitchToMode(InputMode::Normal)],
|
|
);
|
|
|
|
defaults.insert(Key::Char('h'), vec![Action::MoveFocus(Direction::Left)]);
|
|
defaults.insert(Key::Char('j'), vec![Action::MoveFocus(Direction::Down)]);
|
|
defaults.insert(Key::Char('k'), vec![Action::MoveFocus(Direction::Up)]);
|
|
defaults.insert(Key::Char('l'), vec![Action::MoveFocus(Direction::Right)]);
|
|
|
|
defaults.insert(Key::Left, vec![Action::MoveFocus(Direction::Left)]);
|
|
defaults.insert(Key::Down, vec![Action::MoveFocus(Direction::Down)]);
|
|
defaults.insert(Key::Up, vec![Action::MoveFocus(Direction::Up)]);
|
|
defaults.insert(Key::Right, vec![Action::MoveFocus(Direction::Right)]);
|
|
|
|
defaults.insert(Key::Char('p'), vec![Action::SwitchFocus(Direction::Right)]);
|
|
defaults.insert(Key::Char('n'), vec![Action::NewPane(None)]);
|
|
defaults.insert(Key::Char('d'), vec![Action::NewPane(Some(Direction::Down))]);
|
|
defaults.insert(
|
|
Key::Char('r'),
|
|
vec![Action::NewPane(Some(Direction::Right))],
|
|
);
|
|
defaults.insert(Key::Char('x'), vec![Action::CloseFocus]);
|
|
defaults.insert(Key::Char('f'), vec![Action::ToggleFocusFullscreen]);
|
|
}
|
|
InputMode::Tab => {
|
|
defaults.insert(
|
|
Key::Ctrl('g'),
|
|
vec![Action::SwitchToMode(InputMode::Locked)],
|
|
);
|
|
defaults.insert(Key::Ctrl('p'), vec![Action::SwitchToMode(InputMode::Pane)]);
|
|
defaults.insert(
|
|
Key::Ctrl('r'),
|
|
vec![Action::SwitchToMode(InputMode::Resize)],
|
|
);
|
|
defaults.insert(
|
|
Key::Ctrl('t'),
|
|
vec![Action::SwitchToMode(InputMode::Normal)],
|
|
);
|
|
defaults.insert(
|
|
Key::Ctrl('s'),
|
|
vec![Action::SwitchToMode(InputMode::Scroll)],
|
|
);
|
|
defaults.insert(Key::Ctrl('q'), vec![Action::Quit]);
|
|
defaults.insert(Key::Esc, vec![Action::SwitchToMode(InputMode::Normal)]);
|
|
defaults.insert(
|
|
Key::Char('\n'),
|
|
vec![Action::SwitchToMode(InputMode::Normal)],
|
|
);
|
|
defaults.insert(
|
|
Key::Char(' '),
|
|
vec![Action::SwitchToMode(InputMode::Normal)],
|
|
);
|
|
|
|
defaults.insert(Key::Char('h'), vec![Action::GoToPreviousTab]);
|
|
defaults.insert(Key::Char('j'), vec![Action::GoToNextTab]);
|
|
defaults.insert(Key::Char('k'), vec![Action::GoToPreviousTab]);
|
|
defaults.insert(Key::Char('l'), vec![Action::GoToNextTab]);
|
|
|
|
defaults.insert(Key::Left, vec![Action::GoToPreviousTab]);
|
|
defaults.insert(Key::Down, vec![Action::GoToNextTab]);
|
|
defaults.insert(Key::Up, vec![Action::GoToPreviousTab]);
|
|
defaults.insert(Key::Right, vec![Action::GoToNextTab]);
|
|
|
|
defaults.insert(Key::Char('n'), vec![Action::NewTab]);
|
|
defaults.insert(Key::Char('x'), vec![Action::CloseTab]);
|
|
|
|
defaults.insert(
|
|
Key::Char('r'),
|
|
vec![
|
|
Action::SwitchToMode(InputMode::RenameTab),
|
|
Action::TabNameInput(vec![0]),
|
|
],
|
|
);
|
|
defaults.insert(Key::Char('q'), vec![Action::Quit]);
|
|
defaults.insert(
|
|
Key::Ctrl('g'),
|
|
vec![Action::SwitchToMode(InputMode::Normal)],
|
|
);
|
|
for i in '1'..='9' {
|
|
defaults.insert(Key::Char(i), vec![Action::GoToTab(i.to_digit(10).unwrap())]);
|
|
}
|
|
}
|
|
InputMode::Scroll => {
|
|
defaults.insert(
|
|
Key::Ctrl('g'),
|
|
vec![Action::SwitchToMode(InputMode::Locked)],
|
|
);
|
|
defaults.insert(Key::Ctrl('p'), vec![Action::SwitchToMode(InputMode::Pane)]);
|
|
defaults.insert(
|
|
Key::Ctrl('r'),
|
|
vec![Action::SwitchToMode(InputMode::Resize)],
|
|
);
|
|
defaults.insert(Key::Ctrl('t'), vec![Action::SwitchToMode(InputMode::Tab)]);
|
|
defaults.insert(
|
|
Key::Ctrl('s'),
|
|
vec![Action::SwitchToMode(InputMode::Normal)],
|
|
);
|
|
defaults.insert(Key::Ctrl('q'), vec![Action::Quit]);
|
|
defaults.insert(Key::Esc, vec![Action::SwitchToMode(InputMode::Normal)]);
|
|
defaults.insert(
|
|
Key::Char('\n'),
|
|
vec![Action::SwitchToMode(InputMode::Normal)],
|
|
);
|
|
defaults.insert(
|
|
Key::Char(' '),
|
|
vec![Action::SwitchToMode(InputMode::Normal)],
|
|
);
|
|
|
|
defaults.insert(Key::Char('j'), vec![Action::ScrollDown]);
|
|
defaults.insert(Key::Char('k'), vec![Action::ScrollUp]);
|
|
|
|
defaults.insert(Key::Down, vec![Action::ScrollDown]);
|
|
defaults.insert(Key::Up, vec![Action::ScrollUp]);
|
|
}
|
|
InputMode::RenameTab => {
|
|
defaults.insert(Key::Char('\n'), vec![Action::SwitchToMode(InputMode::Tab)]);
|
|
defaults.insert(
|
|
Key::Ctrl('g'),
|
|
vec![Action::SwitchToMode(InputMode::Normal)],
|
|
);
|
|
defaults.insert(
|
|
Key::Esc,
|
|
vec![
|
|
Action::TabNameInput(vec![0x1b]),
|
|
Action::SwitchToMode(InputMode::Tab),
|
|
],
|
|
);
|
|
}
|
|
}
|
|
ModeKeybinds(defaults)
|
|
}
|
|
|
|
/// Converts a [`Key`] terminal event to a sequence of [`Action`]s according to the current
|
|
/// [`InputMode`] and [`Keybinds`].
|
|
pub fn key_to_actions(
|
|
key: &Key,
|
|
input: Vec<u8>,
|
|
mode: &InputMode,
|
|
keybinds: &Keybinds,
|
|
) -> Vec<Action> {
|
|
let mode_keybind_or_action = |action: Action| {
|
|
keybinds
|
|
.0
|
|
.get(mode)
|
|
.unwrap_or_else(|| unreachable!("Unrecognized mode: {:?}", mode))
|
|
.0
|
|
.get(key)
|
|
.cloned()
|
|
.unwrap_or_else(|| vec![action])
|
|
};
|
|
match *mode {
|
|
InputMode::Normal | InputMode::Locked => mode_keybind_or_action(Action::Write(input)),
|
|
InputMode::RenameTab => mode_keybind_or_action(Action::TabNameInput(input)),
|
|
_ => mode_keybind_or_action(Action::NoOp),
|
|
}
|
|
}
|
|
}
|
|
|
|
impl ModeKeybinds {
|
|
fn new() -> ModeKeybinds {
|
|
ModeKeybinds(HashMap::<Key, Vec<Action>>::new())
|
|
}
|
|
|
|
/// Merges `self` with `other`, if keys are the same, `other` overwrites.
|
|
fn merge(self, other: ModeKeybinds) -> ModeKeybinds {
|
|
let mut merged = self;
|
|
merged.0.extend(other.0);
|
|
merged
|
|
}
|
|
}
|
|
|
|
impl From<KeybindsFromYaml> for Keybinds {
|
|
fn from(keybinds_from_yaml: KeybindsFromYaml) -> Keybinds {
|
|
let mut keybinds = Keybinds::new();
|
|
|
|
for mode in InputMode::iter() {
|
|
let mut mode_keybinds = ModeKeybinds::new();
|
|
for key_action in keybinds_from_yaml.0.get(&mode).iter() {
|
|
for keybind in key_action.iter() {
|
|
mode_keybinds = mode_keybinds.merge(ModeKeybinds::from(keybind.clone()));
|
|
}
|
|
}
|
|
keybinds.0.insert(mode, mode_keybinds);
|
|
}
|
|
keybinds
|
|
}
|
|
}
|
|
|
|
/// For each `Key` assigned to `Action`s,
|
|
/// map the `Action`s to the key
|
|
impl From<KeyActionFromYaml> for ModeKeybinds {
|
|
fn from(key_action: KeyActionFromYaml) -> ModeKeybinds {
|
|
let keys = key_action.key;
|
|
let actions = key_action.action;
|
|
|
|
ModeKeybinds(
|
|
keys.into_iter()
|
|
.map(|k| (k, actions.clone()))
|
|
.collect::<HashMap<Key, Vec<Action>>>(),
|
|
)
|
|
}
|
|
}
|
|
|
|
// The unit test location.
|
|
#[cfg(test)]
|
|
#[path = "./unit/keybinds_test.rs"]
|
|
mod keybinds_test;
|