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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
|
use crate::{Event, KeyCode, KeyEvent, KeyModifiers};
/// Represents a mapping between an input event and an action.
#[derive(Debug)]
#[non_exhaustive]
pub struct KeyBindings<CustomKeybinding: crate::CustomKeybinding, CustomEvent: crate::CustomEvent> {
/// Key bindings for redoing a change.
pub redo: Vec<Event<CustomEvent>>,
/// Key bindings for undoing a change.
pub undo: Vec<Event<CustomEvent>>,
/// Key bindings for scrolling down.
pub scroll_down: Vec<Event<CustomEvent>>,
/// Key bindings for scrolling to the end.
pub scroll_end: Vec<Event<CustomEvent>>,
/// Key bindings for scrolling to the start.
pub scroll_home: Vec<Event<CustomEvent>>,
/// Key bindings for scrolling to the left.
pub scroll_left: Vec<Event<CustomEvent>>,
/// Key bindings for scrolling to the right.
pub scroll_right: Vec<Event<CustomEvent>>,
/// Key bindings for scrolling up.
pub scroll_up: Vec<Event<CustomEvent>>,
/// Key bindings for scrolling down a step.
pub scroll_step_down: Vec<Event<CustomEvent>>,
/// Key bindings for scrolling up a step.
pub scroll_step_up: Vec<Event<CustomEvent>>,
/// Key bindings for help.
pub help: Vec<Event<CustomEvent>>,
/// Key bindings for starting search.
pub search_start: Vec<Event<CustomEvent>>,
/// Key bindings for next search match.
pub search_next: Vec<Event<CustomEvent>>,
/// Key bindings for previous search match.
pub search_previous: Vec<Event<CustomEvent>>,
/// Custom keybindings
pub custom: CustomKeybinding,
}
/// Map a keybinding to a list of events.
#[must_use]
#[inline]
#[allow(clippy::string_slice, clippy::missing_panics_doc)]
pub fn map_keybindings<CustomEvent: crate::CustomEvent>(bindings: &[String]) -> Vec<Event<CustomEvent>> {
bindings
.iter()
.map(|b| {
let mut key = String::from(b);
let mut modifiers = KeyModifiers::empty();
if key.contains("Control") {
key = key.replace("Control", "");
modifiers.insert(KeyModifiers::CONTROL);
}
if key.contains("Alt") {
key = key.replace("Alt", "");
modifiers.insert(KeyModifiers::ALT);
}
if key.contains("Shift") {
key = key.replace("Shift", "");
modifiers.insert(KeyModifiers::SHIFT);
}
let code = match key.as_str() {
"Backspace" => KeyCode::Backspace,
"BackTab" => KeyCode::BackTab,
"Delete" => KeyCode::Delete,
"Down" => KeyCode::Down,
"End" => KeyCode::End,
"Enter" => KeyCode::Enter,
"Esc" => KeyCode::Esc,
"Home" => KeyCode::Home,
"Insert" => KeyCode::Insert,
"Left" => KeyCode::Left,
"PageDown" => KeyCode::PageDown,
"PageUp" => KeyCode::PageUp,
"Right" => KeyCode::Right,
"Tab" => KeyCode::Tab,
"Up" => KeyCode::Up,
// assume that this is an F key
k if k.len() > 1 => {
let key_number = k[1..].parse::<u8>().unwrap_or(1);
KeyCode::F(key_number)
},
k => {
// printable characters cannot use shift
KeyCode::Char(k.chars().next().expect("Expected only one character from Char KeyCode"))
},
};
Event::Key(KeyEvent::new(code, modifiers))
})
.collect()
}
impl<CustomKeybinding: crate::CustomKeybinding, CustomEvent: crate::CustomEvent>
KeyBindings<CustomKeybinding, CustomEvent>
{
/// Create a new instance from the configuration keybindings.
#[inline]
#[must_use]
pub fn new(key_bindings: &config::KeyBindings) -> Self {
Self {
redo: map_keybindings(&key_bindings.redo),
undo: map_keybindings(&key_bindings.undo),
scroll_down: map_keybindings(&key_bindings.scroll_down),
scroll_end: map_keybindings(&key_bindings.scroll_end),
scroll_home: map_keybindings(&key_bindings.scroll_home),
scroll_left: map_keybindings(&key_bindings.scroll_left),
scroll_right: map_keybindings(&key_bindings.scroll_right),
scroll_up: map_keybindings(&key_bindings.scroll_up),
scroll_step_down: map_keybindings(&key_bindings.scroll_step_down),
scroll_step_up: map_keybindings(&key_bindings.scroll_step_up),
help: map_keybindings(&key_bindings.help),
search_start: map_keybindings(&key_bindings.search_start),
search_next: map_keybindings(&key_bindings.search_next),
search_previous: map_keybindings(&key_bindings.search_previous),
custom: CustomKeybinding::new(key_bindings),
}
}
}
#[cfg(test)]
mod tests {
use rstest::rstest;
use super::*;
use crate::testutil::local::{TestEvent, TestKeybinding};
#[test]
fn new() {
let _key_bindings = KeyBindings::<TestKeybinding, TestEvent>::new(&config::KeyBindings::new());
}
#[test]
fn map_keybindings_with_modifiers() {
assert_eq!(
map_keybindings::<TestEvent>(&[String::from("ControlAltShiftUp")]),
vec![Event::Key(KeyEvent::new(
KeyCode::Up,
KeyModifiers::CONTROL | KeyModifiers::ALT | KeyModifiers::SHIFT
))]
);
}
#[rstest]
#[case::backspace("Backspace", KeyCode::Backspace)]
#[case::back_tab("BackTab", KeyCode::BackTab)]
#[case::delete("Delete", KeyCode::Delete)]
#[case::down("Down", KeyCode::Down)]
#[case::end("End", KeyCode::End)]
#[case::enter("Enter", KeyCode::Enter)]
#[case::esc("Esc", KeyCode::Esc)]
#[case::home("Home", KeyCode::Home)]
#[case::insert("Insert", KeyCode::Insert)]
#[case::left("Left", KeyCode::Left)]
#[case::page_down("PageDown", KeyCode::PageDown)]
#[case::page_up("PageUp", KeyCode::PageUp)]
#[case::right("Right", KeyCode::Right)]
#[case::tab("Tab", KeyCode::Tab)]
#[case::up("Up", KeyCode::Up)]
#[case::function_in_range("F10", KeyCode::F(10))]
#[case::function_out_of_range("F10000", KeyCode::F(1))]
#[case::char("a", KeyCode::Char('a'))]
fn map_keybindings_key_code(#[case] binding: &str, #[case] key_code: KeyCode) {
assert_eq!(map_keybindings::<TestEvent>(&[String::from(binding)]), vec![
Event::from(key_code)
]);
}
#[test]
fn map_keybindings_key_code_char_remove_shift() {
assert_eq!(map_keybindings::<TestEvent>(&[String::from("ShiftA")]), vec![
Event::from(KeyCode::Char('A'))
]);
}
}
|
