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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
|
use crate::input::{map_keybindings, Event};
/// Represents a mapping between an input event and an action.
#[derive(Debug)]
#[non_exhaustive]
pub(crate) struct KeyBindings {
/// Key bindings for redoing a change.
pub(crate) redo: Vec<Event>,
/// Key bindings for undoing a change.
pub(crate) undo: Vec<Event>,
/// Key bindings for scrolling down.
pub(crate) scroll_down: Vec<Event>,
/// Key bindings for scrolling to the end.
pub(crate) scroll_end: Vec<Event>,
/// Key bindings for scrolling to the start.
pub(crate) scroll_home: Vec<Event>,
/// Key bindings for scrolling to the left.
pub(crate) scroll_left: Vec<Event>,
/// Key bindings for scrolling to the right.
pub(crate) scroll_right: Vec<Event>,
/// Key bindings for scrolling up.
pub(crate) scroll_up: Vec<Event>,
/// Key bindings for scrolling down a step.
pub(crate) scroll_step_down: Vec<Event>,
/// Key bindings for scrolling up a step.
pub(crate) scroll_step_up: Vec<Event>,
/// Key bindings for help.
pub(crate) help: Vec<Event>,
/// Key bindings for starting search.
pub(crate) search_start: Vec<Event>,
/// Key bindings for next search match.
pub(crate) search_next: Vec<Event>,
/// Key bindings for previous search match.
pub(crate) search_previous: Vec<Event>,
/// Key bindings for aborting.
pub(crate) abort: Vec<Event>,
/// Key bindings for the break action.
pub(crate) action_break: Vec<Event>,
/// Key bindings for the drop action.
pub(crate) action_drop: Vec<Event>,
/// Key bindings for the edit action.
pub(crate) action_edit: Vec<Event>,
/// Key bindings for the fixup action.
pub(crate) action_fixup: Vec<Event>,
/// Key bindings for the pick action.
pub(crate) action_pick: Vec<Event>,
/// Key bindings for the reword action.
pub(crate) action_reword: Vec<Event>,
/// Key bindings for the squash action.
pub(crate) action_squash: Vec<Event>,
/// Key bindings for positive confirmation.
pub(crate) confirm_yes: Vec<Event>,
/// Key bindings for editing.
pub(crate) edit: Vec<Event>,
/// Key bindings for forcing an abort.
pub(crate) force_abort: Vec<Event>,
/// Key bindings for forcing a rebase.
pub(crate) force_rebase: Vec<Event>,
/// Key bindings for inserting a line.
pub(crate) insert_line: Vec<Event>,
/// Key bindings for moving down.
pub(crate) move_down: Vec<Event>,
/// Key bindings for moving down a step.
pub(crate) move_down_step: Vec<Event>,
/// Key bindings for moving to the end.
pub(crate) move_end: Vec<Event>,
/// Key bindings for moving to the start.
pub(crate) move_home: Vec<Event>,
/// Key bindings for moving to the left.
pub(crate) move_left: Vec<Event>,
/// Key bindings for moving to the right.
pub(crate) move_right: Vec<Event>,
/// Key bindings for moving the selection down.
pub(crate) move_selection_down: Vec<Event>,
/// Key bindings for moving the selection up.
pub(crate) move_selection_up: Vec<Event>,
/// Key bindings for moving up.
pub(crate) move_up: Vec<Event>,
/// Key bindings for moving up a step.
pub(crate) move_up_step: Vec<Event>,
/// Key bindings for opening the external editor.
pub(crate) open_in_external_editor: Vec<Event>,
/// Key bindings for rebasing.
pub(crate) rebase: Vec<Event>,
/// Key bindings for removing a line.
pub(crate) remove_line: Vec<Event>,
/// Key bindings for showing a commit.
pub(crate) show_commit: Vec<Event>,
/// Key bindings for showing a diff.
pub(crate) show_diff: Vec<Event>,
/// Key bindings for toggling visual mode.
pub(crate) toggle_visual_mode: Vec<Event>,
/// Key bindings for the fixup specific action to toggle the c option.
pub(crate) fixup_keep_message: Vec<Event>,
/// Key biding for the fixup specific action to toggle the C option.
pub(crate) fixup_keep_message_with_editor: Vec<Event>,
}
impl KeyBindings {
/// Create a new instance from the configuration keybindings.
#[must_use]
pub(crate) fn new(key_bindings: &crate::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),
abort: map_keybindings(&key_bindings.abort),
action_break: map_keybindings(&key_bindings.action_break),
action_drop: map_keybindings(&key_bindings.action_drop),
action_edit: map_keybindings(&key_bindings.action_edit),
action_fixup: map_keybindings(&key_bindings.action_fixup),
action_pick: map_keybindings(&key_bindings.action_pick),
action_reword: map_keybindings(&key_bindings.action_reword),
action_squash: map_keybindings(&key_bindings.action_squash),
edit: map_keybindings(&key_bindings.edit),
force_abort: map_keybindings(&key_bindings.force_abort),
force_rebase: map_keybindings(&key_bindings.force_rebase),
insert_line: map_keybindings(&key_bindings.insert_line),
move_down: map_keybindings(&key_bindings.move_down),
move_down_step: map_keybindings(&key_bindings.move_down_step),
move_end: map_keybindings(&key_bindings.move_end),
move_home: map_keybindings(&key_bindings.move_home),
move_left: map_keybindings(&key_bindings.move_left),
move_right: map_keybindings(&key_bindings.move_right),
move_selection_down: map_keybindings(&key_bindings.move_selection_down),
move_selection_up: map_keybindings(&key_bindings.move_selection_up),
move_up: map_keybindings(&key_bindings.move_up),
move_up_step: map_keybindings(&key_bindings.move_up_step),
open_in_external_editor: map_keybindings(&key_bindings.open_in_external_editor),
rebase: map_keybindings(&key_bindings.rebase),
remove_line: map_keybindings(&key_bindings.remove_line),
show_commit: map_keybindings(&key_bindings.show_commit),
show_diff: map_keybindings(&key_bindings.show_diff),
toggle_visual_mode: map_keybindings(&key_bindings.toggle_visual_mode),
confirm_yes: map_keybindings(&key_bindings.confirm_yes),
fixup_keep_message: map_keybindings(&key_bindings.fixup_keep_message),
fixup_keep_message_with_editor: map_keybindings(&key_bindings.fixup_keep_message_with_editor),
}
}
}
#[cfg(test)]
mod tests {
use crossterm::event::{KeyCode, KeyModifiers};
use rstest::rstest;
use super::*;
use crate::input::KeyEvent;
#[test]
fn new() {
let _key_bindings = KeyBindings::new(&crate::config::KeyBindings::new());
}
#[test]
fn map_keybindings_with_modifiers() {
assert_eq!(map_keybindings(&[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(&[String::from(binding)]), vec![Event::from(key_code)]);
}
}
|
