1#[cfg(test)]
2mod test;
3
4mod editor_events;
5mod insert;
6mod motion;
7mod normal;
8mod object;
9mod state;
10mod utils;
11mod visual;
12
13use collections::HashMap;
14use command_palette::CommandPaletteFilter;
15use editor::{Bias, Cancel, Editor};
16use gpui::{impl_actions, MutableAppContext, Subscription, ViewContext, WeakViewHandle};
17use language::CursorShape;
18use serde::Deserialize;
19
20use settings::Settings;
21use state::{Mode, Operator, VimState};
22use workspace::{self, Workspace};
23
24#[derive(Clone, Deserialize, PartialEq)]
25pub struct SwitchMode(pub Mode);
26
27#[derive(Clone, Deserialize, PartialEq)]
28pub struct PushOperator(pub Operator);
29
30#[derive(Clone, Deserialize, PartialEq)]
31struct Number(u8);
32
33impl_actions!(vim, [Number, SwitchMode, PushOperator]);
34
35pub fn init(cx: &mut MutableAppContext) {
36 editor_events::init(cx);
37 normal::init(cx);
38 visual::init(cx);
39 insert::init(cx);
40 object::init(cx);
41 motion::init(cx);
42
43 // Vim Actions
44 cx.add_action(|_: &mut Workspace, &SwitchMode(mode): &SwitchMode, cx| {
45 Vim::update(cx, |vim, cx| vim.switch_mode(mode, false, cx))
46 });
47 cx.add_action(
48 |_: &mut Workspace, &PushOperator(operator): &PushOperator, cx| {
49 Vim::update(cx, |vim, cx| vim.push_operator(operator, cx))
50 },
51 );
52 cx.add_action(|_: &mut Workspace, n: &Number, cx: _| {
53 Vim::update(cx, |vim, cx| vim.push_number(n, cx));
54 });
55
56 // Editor Actions
57 cx.add_action(|_: &mut Editor, _: &Cancel, cx| {
58 // If we are in a non normal mode or have an active operator, swap to normal mode
59 // Otherwise forward cancel on to the editor
60 let vim = Vim::read(cx);
61 if vim.state.mode != Mode::Normal || vim.active_operator().is_some() {
62 MutableAppContext::defer(cx, |cx| {
63 Vim::update(cx, |state, cx| {
64 state.switch_mode(Mode::Normal, false, cx);
65 });
66 });
67 } else {
68 cx.propagate_action();
69 }
70 });
71
72 // Sync initial settings with the rest of the app
73 Vim::update(cx, |state, cx| state.sync_vim_settings(cx));
74
75 // Any time settings change, update vim mode to match
76 cx.observe_global::<Settings, _>(|cx| {
77 Vim::update(cx, |state, cx| {
78 state.set_enabled(cx.global::<Settings>().vim_mode, cx)
79 })
80 })
81 .detach();
82}
83
84#[derive(Default)]
85pub struct Vim {
86 editors: HashMap<usize, WeakViewHandle<Editor>>,
87 active_editor: Option<WeakViewHandle<Editor>>,
88 selection_subscription: Option<Subscription>,
89
90 enabled: bool,
91 state: VimState,
92}
93
94impl Vim {
95 fn read(cx: &mut MutableAppContext) -> &Self {
96 cx.default_global()
97 }
98
99 fn update<F, S>(cx: &mut MutableAppContext, update: F) -> S
100 where
101 F: FnOnce(&mut Self, &mut MutableAppContext) -> S,
102 {
103 cx.update_default_global(update)
104 }
105
106 fn update_active_editor<S>(
107 &self,
108 cx: &mut MutableAppContext,
109 update: impl FnOnce(&mut Editor, &mut ViewContext<Editor>) -> S,
110 ) -> Option<S> {
111 self.active_editor
112 .clone()
113 .and_then(|ae| ae.upgrade(cx))
114 .map(|ae| ae.update(cx, update))
115 }
116
117 fn switch_mode(&mut self, mode: Mode, leave_selections: bool, cx: &mut MutableAppContext) {
118 self.state.mode = mode;
119 self.state.operator_stack.clear();
120
121 // Sync editor settings like clip mode
122 self.sync_vim_settings(cx);
123
124 if leave_selections {
125 return;
126 }
127
128 // Adjust selections
129 for editor in self.editors.values() {
130 if let Some(editor) = editor.upgrade(cx) {
131 editor.update(cx, |editor, cx| {
132 editor.change_selections(None, cx, |s| {
133 s.move_with(|map, selection| {
134 if self.state.empty_selections_only() {
135 let new_head = map.clip_point(selection.head(), Bias::Left);
136 selection.collapse_to(new_head, selection.goal)
137 } else {
138 selection.set_head(
139 map.clip_point(selection.head(), Bias::Left),
140 selection.goal,
141 );
142 }
143 });
144 })
145 })
146 }
147 }
148 }
149
150 fn push_operator(&mut self, operator: Operator, cx: &mut MutableAppContext) {
151 self.state.operator_stack.push(operator);
152 self.sync_vim_settings(cx);
153 }
154
155 fn push_number(&mut self, Number(number): &Number, cx: &mut MutableAppContext) {
156 if let Some(Operator::Number(current_number)) = self.active_operator() {
157 self.pop_operator(cx);
158 self.push_operator(Operator::Number(current_number * 10 + *number as usize), cx);
159 } else {
160 self.push_operator(Operator::Number(*number as usize), cx);
161 }
162 }
163
164 fn pop_operator(&mut self, cx: &mut MutableAppContext) -> Operator {
165 let popped_operator = self.state.operator_stack.pop()
166 .expect("Operator popped when no operator was on the stack. This likely means there is an invalid keymap config");
167 self.sync_vim_settings(cx);
168 popped_operator
169 }
170
171 fn pop_number_operator(&mut self, cx: &mut MutableAppContext) -> usize {
172 let mut times = 1;
173 if let Some(Operator::Number(number)) = self.active_operator() {
174 times = number;
175 self.pop_operator(cx);
176 }
177 times
178 }
179
180 fn clear_operator(&mut self, cx: &mut MutableAppContext) {
181 self.state.operator_stack.clear();
182 self.sync_vim_settings(cx);
183 }
184
185 fn active_operator(&self) -> Option<Operator> {
186 self.state.operator_stack.last().copied()
187 }
188
189 fn set_enabled(&mut self, enabled: bool, cx: &mut MutableAppContext) {
190 if self.enabled != enabled {
191 self.enabled = enabled;
192 self.state = Default::default();
193 if enabled {
194 self.switch_mode(Mode::Normal, false, cx);
195 }
196 self.sync_vim_settings(cx);
197 }
198 }
199
200 fn sync_vim_settings(&self, cx: &mut MutableAppContext) {
201 let state = &self.state;
202 let cursor_shape = state.cursor_shape();
203
204 cx.update_default_global::<CommandPaletteFilter, _, _>(|filter, _| {
205 if self.enabled {
206 filter.filtered_namespaces.remove("vim");
207 } else {
208 filter.filtered_namespaces.insert("vim");
209 }
210 });
211
212 for editor in self.editors.values() {
213 if let Some(editor) = editor.upgrade(cx) {
214 editor.update(cx, |editor, cx| {
215 if self.enabled {
216 editor.set_cursor_shape(cursor_shape, cx);
217 editor.set_clip_at_line_ends(state.clip_at_line_end(), cx);
218 editor.set_input_enabled(!state.vim_controlled());
219 editor.selections.line_mode =
220 matches!(state.mode, Mode::Visual { line: true });
221 let context_layer = state.keymap_context_layer();
222 editor.set_keymap_context_layer::<Self>(context_layer);
223 } else {
224 editor.set_cursor_shape(CursorShape::Bar, cx);
225 editor.set_clip_at_line_ends(false, cx);
226 editor.set_input_enabled(true);
227 editor.selections.line_mode = false;
228 editor.remove_keymap_context_layer::<Self>();
229 }
230 });
231 }
232 }
233 }
234}