1//! Vim support for Zed.
2
3#[cfg(test)]
4mod test;
5
6mod change_list;
7mod command;
8mod editor_events;
9mod insert;
10mod mode_indicator;
11mod motion;
12mod normal;
13mod object;
14mod replace;
15mod state;
16mod surrounds;
17mod visual;
18
19use anyhow::Result;
20use change_list::push_to_change_list;
21use collections::HashMap;
22use command_palette_hooks::{CommandPaletteFilter, CommandPaletteInterceptor};
23use editor::{
24 movement::{self, FindRange},
25 Anchor, Bias, Editor, EditorEvent, EditorMode, ToPoint,
26};
27use gpui::{
28 actions, impl_actions, Action, AppContext, EntityId, FocusableView, Global, KeystrokeEvent,
29 Subscription, UpdateGlobal, View, ViewContext, WeakView, WindowContext,
30};
31use language::{CursorShape, Point, SelectionGoal, TransactionId};
32pub use mode_indicator::ModeIndicator;
33use motion::Motion;
34use normal::{
35 mark::create_visual_marks,
36 normal_replace,
37 repeat::{observe_action, observe_insertion, record_register, replay_register},
38};
39use replace::multi_replace;
40use schemars::JsonSchema;
41use serde::Deserialize;
42use serde_derive::Serialize;
43use settings::{update_settings_file, Settings, SettingsSources, SettingsStore};
44use state::{EditorState, Mode, Operator, RecordedSelection, Register, WorkspaceState};
45use std::{ops::Range, sync::Arc};
46use surrounds::{add_surrounds, change_surrounds, delete_surrounds, SurroundsType};
47use ui::BorrowAppContext;
48use visual::{visual_block_motion, visual_replace};
49use workspace::{self, Workspace};
50
51use crate::state::ReplayableAction;
52
53/// Whether or not to enable Vim mode (work in progress).
54///
55/// Default: false
56pub struct VimModeSetting(pub bool);
57
58/// An Action to Switch between modes
59#[derive(Clone, Deserialize, PartialEq)]
60pub struct SwitchMode(pub Mode);
61
62/// PushOperator is used to put vim into a "minor" mode,
63/// where it's waiting for a specific next set of keystrokes.
64/// For example 'd' needs a motion to complete.
65#[derive(Clone, Deserialize, PartialEq)]
66pub struct PushOperator(pub Operator);
67
68/// Number is used to manage vim's count. Pushing a digit
69/// multiplis the current value by 10 and adds the digit.
70#[derive(Clone, Deserialize, PartialEq)]
71struct Number(usize);
72
73#[derive(Clone, Deserialize, PartialEq)]
74struct SelectRegister(String);
75
76actions!(
77 vim,
78 [
79 ClearOperators,
80 Tab,
81 Enter,
82 Object,
83 InnerObject,
84 FindForward,
85 FindBackward,
86 OpenDefaultKeymap
87 ]
88);
89
90// in the workspace namespace so it's not filtered out when vim is disabled.
91actions!(workspace, [ToggleVimMode]);
92
93impl_actions!(vim, [SwitchMode, PushOperator, Number, SelectRegister]);
94
95/// Initializes the `vim` crate.
96pub fn init(cx: &mut AppContext) {
97 cx.set_global(Vim::default());
98 VimModeSetting::register(cx);
99 VimSettings::register(cx);
100
101 cx.observe_keystrokes(observe_keystrokes).detach();
102 editor_events::init(cx);
103
104 cx.observe_new_views(|workspace: &mut Workspace, cx| register(workspace, cx))
105 .detach();
106
107 // Any time settings change, update vim mode to match. The Vim struct
108 // will be initialized as disabled by default, so we filter its commands
109 // out when starting up.
110 CommandPaletteFilter::update_global(cx, |filter, _| {
111 filter.hide_namespace(Vim::NAMESPACE);
112 });
113 Vim::update_global(cx, |vim, cx| {
114 vim.set_enabled(VimModeSetting::get_global(cx).0, cx)
115 });
116 cx.observe_global::<SettingsStore>(|cx| {
117 Vim::update_global(cx, |vim, cx| {
118 vim.set_enabled(VimModeSetting::get_global(cx).0, cx)
119 });
120 })
121 .detach();
122}
123
124fn register(workspace: &mut Workspace, cx: &mut ViewContext<Workspace>) {
125 workspace.register_action(|_: &mut Workspace, &SwitchMode(mode): &SwitchMode, cx| {
126 Vim::update(cx, |vim, cx| vim.switch_mode(mode, false, cx))
127 });
128 workspace.register_action(
129 |_: &mut Workspace, PushOperator(operator): &PushOperator, cx| {
130 Vim::update(cx, |vim, cx| vim.push_operator(operator.clone(), cx))
131 },
132 );
133 workspace.register_action(|_: &mut Workspace, _: &ClearOperators, cx| {
134 Vim::update(cx, |vim, cx| vim.clear_operator(cx))
135 });
136 workspace.register_action(|_: &mut Workspace, n: &Number, cx: _| {
137 Vim::update(cx, |vim, cx| vim.push_count_digit(n.0, cx));
138 });
139 workspace.register_action(|_: &mut Workspace, _: &Tab, cx| {
140 Vim::active_editor_input_ignored(" ".into(), cx)
141 });
142
143 workspace.register_action(|_: &mut Workspace, _: &Enter, cx| {
144 Vim::active_editor_input_ignored("\n".into(), cx)
145 });
146
147 workspace.register_action(|workspace: &mut Workspace, _: &ToggleVimMode, cx| {
148 let fs = workspace.app_state().fs.clone();
149 let currently_enabled = VimModeSetting::get_global(cx).0;
150 update_settings_file::<VimModeSetting>(fs, cx, move |setting| {
151 *setting = Some(!currently_enabled)
152 })
153 });
154
155 workspace.register_action(|_: &mut Workspace, _: &OpenDefaultKeymap, cx| {
156 cx.emit(workspace::Event::OpenBundledFile {
157 text: settings::vim_keymap(),
158 title: "Default Vim Bindings",
159 language: "JSON",
160 });
161 });
162
163 normal::register(workspace, cx);
164 insert::register(workspace, cx);
165 motion::register(workspace, cx);
166 command::register(workspace, cx);
167 replace::register(workspace, cx);
168 object::register(workspace, cx);
169 visual::register(workspace, cx);
170 change_list::register(workspace, cx);
171}
172
173/// Called whenever an keystroke is typed so vim can observe all actions
174/// and keystrokes accordingly.
175fn observe_keystrokes(keystroke_event: &KeystrokeEvent, cx: &mut WindowContext) {
176 if let Some(action) = keystroke_event
177 .action
178 .as_ref()
179 .map(|action| action.boxed_clone())
180 {
181 observe_action(action.boxed_clone(), cx);
182
183 // Keystroke is handled by the vim system, so continue forward
184 if action.name().starts_with("vim::") {
185 return;
186 }
187 } else if cx.has_pending_keystrokes() || keystroke_event.keystroke.is_ime_in_progress() {
188 return;
189 }
190
191 Vim::update(cx, |vim, cx| match vim.active_operator() {
192 Some(
193 Operator::FindForward { .. }
194 | Operator::FindBackward { .. }
195 | Operator::Replace
196 | Operator::AddSurrounds { .. }
197 | Operator::ChangeSurrounds { .. }
198 | Operator::DeleteSurrounds
199 | Operator::Mark
200 | Operator::Jump { .. }
201 | Operator::Register
202 | Operator::RecordRegister
203 | Operator::ReplayRegister,
204 ) => {}
205 Some(_) => {
206 vim.clear_operator(cx);
207 }
208 _ => {}
209 });
210}
211
212/// The state pertaining to Vim mode.
213#[derive(Default)]
214struct Vim {
215 active_editor: Option<WeakView<Editor>>,
216 editor_subscription: Option<Subscription>,
217 enabled: bool,
218 editor_states: HashMap<EntityId, EditorState>,
219 workspace_state: WorkspaceState,
220 default_state: EditorState,
221}
222
223impl Global for Vim {}
224
225impl Vim {
226 /// The namespace for Vim actions.
227 const NAMESPACE: &'static str = "vim";
228
229 fn read(cx: &mut AppContext) -> &Self {
230 cx.global::<Self>()
231 }
232
233 fn update<F, S>(cx: &mut WindowContext, update: F) -> S
234 where
235 F: FnOnce(&mut Self, &mut WindowContext) -> S,
236 {
237 cx.update_global(update)
238 }
239
240 fn activate_editor(&mut self, editor: View<Editor>, cx: &mut WindowContext) {
241 if !editor.read(cx).use_modal_editing() {
242 return;
243 }
244
245 self.active_editor = Some(editor.clone().downgrade());
246 self.editor_subscription = Some(cx.subscribe(&editor, |editor, event, cx| match event {
247 EditorEvent::SelectionsChanged { local: true } => {
248 if editor.read(cx).leader_peer_id().is_none() {
249 Vim::update(cx, |vim, cx| {
250 vim.local_selections_changed(editor, cx);
251 })
252 }
253 }
254 EditorEvent::InputIgnored { text } => {
255 Vim::active_editor_input_ignored(text.clone(), cx);
256 observe_insertion(text, None, cx)
257 }
258 EditorEvent::InputHandled {
259 text,
260 utf16_range_to_replace: range_to_replace,
261 } => observe_insertion(text, range_to_replace.clone(), cx),
262 EditorEvent::TransactionBegun { transaction_id } => Vim::update(cx, |vim, cx| {
263 vim.transaction_begun(*transaction_id, cx);
264 }),
265 EditorEvent::TransactionUndone { transaction_id } => Vim::update(cx, |vim, cx| {
266 vim.transaction_undone(transaction_id, cx);
267 }),
268 EditorEvent::Edited { .. } => {
269 Vim::update(cx, |vim, cx| vim.transaction_ended(editor, cx))
270 }
271 EditorEvent::FocusedIn => Vim::update(cx, |vim, cx| vim.sync_vim_settings(cx)),
272 _ => {}
273 }));
274
275 let editor = editor.read(cx);
276 let editor_mode = editor.mode();
277 let newest_selection_empty = editor.selections.newest::<usize>(cx).is_empty();
278
279 if editor_mode == EditorMode::Full
280 && !newest_selection_empty
281 && self.state().mode == Mode::Normal
282 // When following someone, don't switch vim mode.
283 && editor.leader_peer_id().is_none()
284 {
285 self.switch_mode(Mode::Visual, true, cx);
286 }
287
288 self.sync_vim_settings(cx);
289 }
290
291 fn update_active_editor<S>(
292 &mut self,
293 cx: &mut WindowContext,
294 update: impl FnOnce(&mut Vim, &mut Editor, &mut ViewContext<Editor>) -> S,
295 ) -> Option<S> {
296 let editor = self.active_editor.clone()?.upgrade()?;
297 Some(editor.update(cx, |editor, cx| update(self, editor, cx)))
298 }
299
300 fn editor_selections(&mut self, cx: &mut WindowContext) -> Vec<Range<Anchor>> {
301 self.update_active_editor(cx, |_, editor, _| {
302 editor
303 .selections
304 .disjoint_anchors()
305 .iter()
306 .map(|selection| selection.tail()..selection.head())
307 .collect()
308 })
309 .unwrap_or_default()
310 }
311
312 /// When doing an action that modifies the buffer, we start recording so that `.`
313 /// will replay the action.
314 pub fn start_recording(&mut self, cx: &mut WindowContext) {
315 if !self.workspace_state.dot_replaying {
316 self.workspace_state.dot_recording = true;
317 self.workspace_state.recorded_actions = Default::default();
318 self.workspace_state.recorded_count = None;
319
320 let selections = self
321 .active_editor
322 .as_ref()
323 .and_then(|editor| editor.upgrade())
324 .map(|editor| {
325 let editor = editor.read(cx);
326 (
327 editor.selections.oldest::<Point>(cx),
328 editor.selections.newest::<Point>(cx),
329 )
330 });
331
332 if let Some((oldest, newest)) = selections {
333 self.workspace_state.recorded_selection = match self.state().mode {
334 Mode::Visual if newest.end.row == newest.start.row => {
335 RecordedSelection::SingleLine {
336 cols: newest.end.column - newest.start.column,
337 }
338 }
339 Mode::Visual => RecordedSelection::Visual {
340 rows: newest.end.row - newest.start.row,
341 cols: newest.end.column,
342 },
343 Mode::VisualLine => RecordedSelection::VisualLine {
344 rows: newest.end.row - newest.start.row,
345 },
346 Mode::VisualBlock => RecordedSelection::VisualBlock {
347 rows: newest.end.row.abs_diff(oldest.start.row),
348 cols: newest.end.column.abs_diff(oldest.start.column),
349 },
350 _ => RecordedSelection::None,
351 }
352 } else {
353 self.workspace_state.recorded_selection = RecordedSelection::None;
354 }
355 }
356 }
357
358 pub fn stop_replaying(&mut self, _: &mut WindowContext) {
359 self.workspace_state.dot_replaying = false;
360 if let Some(replayer) = self.workspace_state.replayer.take() {
361 replayer.stop();
362 }
363 }
364
365 /// When finishing an action that modifies the buffer, stop recording.
366 /// as you usually call this within a keystroke handler we also ensure that
367 /// the current action is recorded.
368 pub fn stop_recording(&mut self) {
369 if self.workspace_state.dot_recording {
370 self.workspace_state.stop_recording_after_next_action = true;
371 }
372 }
373
374 /// Stops recording actions immediately rather than waiting until after the
375 /// next action to stop recording.
376 ///
377 /// This doesn't include the current action.
378 pub fn stop_recording_immediately(&mut self, action: Box<dyn Action>) {
379 if self.workspace_state.dot_recording {
380 self.workspace_state
381 .recorded_actions
382 .push(ReplayableAction::Action(action.boxed_clone()));
383 self.workspace_state.dot_recording = false;
384 self.workspace_state.stop_recording_after_next_action = false;
385 }
386 }
387
388 /// Explicitly record one action (equivalents to start_recording and stop_recording)
389 pub fn record_current_action(&mut self, cx: &mut WindowContext) {
390 self.start_recording(cx);
391 self.stop_recording();
392 }
393
394 fn switch_mode(&mut self, mode: Mode, leave_selections: bool, cx: &mut WindowContext) {
395 let state = self.state();
396 let last_mode = state.mode;
397 let prior_mode = state.last_mode;
398 let prior_tx = state.current_tx;
399 self.update_state(|state| {
400 state.last_mode = last_mode;
401 state.mode = mode;
402 state.operator_stack.clear();
403 if mode == Mode::Normal || mode != last_mode {
404 state.current_tx.take();
405 state.current_anchor.take();
406 }
407 });
408 if mode != Mode::Insert && mode != Mode::Replace {
409 self.take_count(cx);
410 }
411
412 // Sync editor settings like clip mode
413 self.sync_vim_settings(cx);
414
415 if !mode.is_visual() && last_mode.is_visual() {
416 create_visual_marks(self, last_mode, cx);
417 }
418
419 if leave_selections {
420 return;
421 }
422
423 // Adjust selections
424 self.update_active_editor(cx, |_, editor, cx| {
425 if last_mode != Mode::VisualBlock && last_mode.is_visual() && mode == Mode::VisualBlock
426 {
427 visual_block_motion(true, editor, cx, |_, point, goal| Some((point, goal)))
428 }
429 if last_mode == Mode::Insert || last_mode == Mode::Replace {
430 if let Some(prior_tx) = prior_tx {
431 editor.group_until_transaction(prior_tx, cx)
432 }
433 }
434
435 editor.change_selections(None, cx, |s| {
436 // we cheat with visual block mode and use multiple cursors.
437 // the cost of this cheat is we need to convert back to a single
438 // cursor whenever vim would.
439 if last_mode == Mode::VisualBlock
440 && (mode != Mode::VisualBlock && mode != Mode::Insert)
441 {
442 let tail = s.oldest_anchor().tail();
443 let head = s.newest_anchor().head();
444 s.select_anchor_ranges(vec![tail..head]);
445 } else if last_mode == Mode::Insert
446 && prior_mode == Mode::VisualBlock
447 && mode != Mode::VisualBlock
448 {
449 let pos = s.first_anchor().head();
450 s.select_anchor_ranges(vec![pos..pos])
451 }
452
453 let snapshot = s.display_map();
454 if let Some(pending) = s.pending.as_mut() {
455 if pending.selection.reversed && mode.is_visual() && !last_mode.is_visual() {
456 let mut end = pending.selection.end.to_point(&snapshot.buffer_snapshot);
457 end = snapshot
458 .buffer_snapshot
459 .clip_point(end + Point::new(0, 1), Bias::Right);
460 pending.selection.end = snapshot.buffer_snapshot.anchor_before(end);
461 }
462 }
463
464 s.move_with(|map, selection| {
465 if last_mode.is_visual() && !mode.is_visual() {
466 let mut point = selection.head();
467 if !selection.reversed && !selection.is_empty() {
468 point = movement::left(map, selection.head());
469 }
470 selection.collapse_to(point, selection.goal)
471 } else if !last_mode.is_visual() && mode.is_visual() {
472 if selection.is_empty() {
473 selection.end = movement::right(map, selection.start);
474 }
475 }
476 });
477 })
478 });
479 }
480
481 fn push_count_digit(&mut self, number: usize, cx: &mut WindowContext) {
482 if self.active_operator().is_some() {
483 self.update_state(|state| {
484 state.post_count = Some(state.post_count.unwrap_or(0) * 10 + number)
485 })
486 } else {
487 self.update_state(|state| {
488 state.pre_count = Some(state.pre_count.unwrap_or(0) * 10 + number)
489 })
490 }
491 // update the keymap so that 0 works
492 self.sync_vim_settings(cx)
493 }
494
495 fn take_count(&mut self, cx: &mut WindowContext) -> Option<usize> {
496 if self.workspace_state.dot_replaying {
497 return self.workspace_state.recorded_count;
498 }
499
500 let count = if self.state().post_count == None && self.state().pre_count == None {
501 return None;
502 } else {
503 Some(self.update_state(|state| {
504 state.post_count.take().unwrap_or(1) * state.pre_count.take().unwrap_or(1)
505 }))
506 };
507 if self.workspace_state.dot_recording {
508 self.workspace_state.recorded_count = count;
509 }
510 self.sync_vim_settings(cx);
511 count
512 }
513
514 fn select_register(&mut self, register: Arc<str>, cx: &mut WindowContext) {
515 self.update_state(|state| {
516 if register.chars().count() == 1 {
517 state
518 .selected_register
519 .replace(register.chars().next().unwrap());
520 }
521 state.operator_stack.clear();
522 });
523 self.sync_vim_settings(cx);
524 }
525
526 fn write_registers(
527 &mut self,
528 content: Register,
529 register: Option<char>,
530 is_yank: bool,
531 linewise: bool,
532 cx: &mut ViewContext<Editor>,
533 ) {
534 if let Some(register) = register {
535 let lower = register.to_lowercase().next().unwrap_or(register);
536 if lower != register {
537 let current = self.workspace_state.registers.entry(lower).or_default();
538 current.text = (current.text.to_string() + &content.text).into();
539 // not clear how to support appending to registers with multiple cursors
540 current.clipboard_selections.take();
541 let yanked = current.clone();
542 self.workspace_state.registers.insert('"', yanked);
543 } else {
544 self.workspace_state.registers.insert('"', content.clone());
545 match lower {
546 '_' | ':' | '.' | '%' | '#' | '=' | '/' => {}
547 '+' => {
548 cx.write_to_clipboard(content.into());
549 }
550 '*' => {
551 #[cfg(target_os = "linux")]
552 cx.write_to_primary(content.into());
553 #[cfg(not(target_os = "linux"))]
554 cx.write_to_clipboard(content.into());
555 }
556 '"' => {
557 self.workspace_state.registers.insert('0', content.clone());
558 self.workspace_state.registers.insert('"', content);
559 }
560 _ => {
561 self.workspace_state.registers.insert(lower, content);
562 }
563 }
564 }
565 } else {
566 let setting = VimSettings::get_global(cx).use_system_clipboard;
567 if setting == UseSystemClipboard::Always
568 || setting == UseSystemClipboard::OnYank && is_yank
569 {
570 self.workspace_state.last_yank.replace(content.text.clone());
571 cx.write_to_clipboard(content.clone().into());
572 } else {
573 self.workspace_state.last_yank = cx
574 .read_from_clipboard()
575 .map(|item| item.text().to_owned().into());
576 }
577
578 self.workspace_state.registers.insert('"', content.clone());
579 if is_yank {
580 self.workspace_state.registers.insert('0', content);
581 } else {
582 let contains_newline = content.text.contains('\n');
583 if !contains_newline {
584 self.workspace_state.registers.insert('-', content.clone());
585 }
586 if linewise || contains_newline {
587 let mut content = content;
588 for i in '1'..'8' {
589 if let Some(moved) = self.workspace_state.registers.insert(i, content) {
590 content = moved;
591 } else {
592 break;
593 }
594 }
595 }
596 }
597 }
598 }
599
600 fn read_register(
601 &mut self,
602 register: Option<char>,
603 editor: Option<&mut Editor>,
604 cx: &mut WindowContext,
605 ) -> Option<Register> {
606 let Some(register) = register.filter(|reg| *reg != '"') else {
607 let setting = VimSettings::get_global(cx).use_system_clipboard;
608 return match setting {
609 UseSystemClipboard::Always => cx.read_from_clipboard().map(|item| item.into()),
610 UseSystemClipboard::OnYank if self.system_clipboard_is_newer(cx) => {
611 cx.read_from_clipboard().map(|item| item.into())
612 }
613 _ => self.workspace_state.registers.get(&'"').cloned(),
614 };
615 };
616 let lower = register.to_lowercase().next().unwrap_or(register);
617 match lower {
618 '_' | ':' | '.' | '#' | '=' => None,
619 '+' => cx.read_from_clipboard().map(|item| item.into()),
620 '*' => {
621 #[cfg(target_os = "linux")]
622 {
623 cx.read_from_primary().map(|item| item.into())
624 }
625 #[cfg(not(target_os = "linux"))]
626 {
627 cx.read_from_clipboard().map(|item| item.into())
628 }
629 }
630 '%' => editor.and_then(|editor| {
631 let selection = editor.selections.newest::<Point>(cx);
632 if let Some((_, buffer, _)) = editor
633 .buffer()
634 .read(cx)
635 .excerpt_containing(selection.head(), cx)
636 {
637 buffer
638 .read(cx)
639 .file()
640 .map(|file| file.path().to_string_lossy().to_string().into())
641 } else {
642 None
643 }
644 }),
645 _ => self.workspace_state.registers.get(&lower).cloned(),
646 }
647 }
648
649 fn system_clipboard_is_newer(&self, cx: &mut AppContext) -> bool {
650 cx.read_from_clipboard().is_some_and(|item| {
651 if let Some(last_state) = &self.workspace_state.last_yank {
652 last_state != item.text()
653 } else {
654 true
655 }
656 })
657 }
658
659 fn push_operator(&mut self, operator: Operator, cx: &mut WindowContext) {
660 if matches!(
661 operator,
662 Operator::Change
663 | Operator::Delete
664 | Operator::Replace
665 | Operator::Indent
666 | Operator::Outdent
667 | Operator::Lowercase
668 | Operator::Uppercase
669 | Operator::OppositeCase
670 ) {
671 self.start_recording(cx)
672 };
673 // Since these operations can only be entered with pre-operators,
674 // we need to clear the previous operators when pushing,
675 // so that the current stack is the most correct
676 if matches!(
677 operator,
678 Operator::AddSurrounds { .. }
679 | Operator::ChangeSurrounds { .. }
680 | Operator::DeleteSurrounds
681 ) {
682 self.update_state(|state| state.operator_stack.clear());
683 };
684 self.update_state(|state| state.operator_stack.push(operator));
685 self.sync_vim_settings(cx);
686 }
687
688 fn maybe_pop_operator(&mut self) -> Option<Operator> {
689 self.update_state(|state| state.operator_stack.pop())
690 }
691
692 fn pop_operator(&mut self, cx: &mut WindowContext) -> Operator {
693 let popped_operator = self.update_state(|state| state.operator_stack.pop())
694 .expect("Operator popped when no operator was on the stack. This likely means there is an invalid keymap config");
695 self.sync_vim_settings(cx);
696 popped_operator
697 }
698
699 fn clear_operator(&mut self, cx: &mut WindowContext) {
700 self.take_count(cx);
701 self.update_state(|state| {
702 state.selected_register.take();
703 state.operator_stack.clear()
704 });
705 self.sync_vim_settings(cx);
706 }
707
708 fn active_operator(&self) -> Option<Operator> {
709 self.state().operator_stack.last().cloned()
710 }
711
712 fn transaction_begun(&mut self, transaction_id: TransactionId, _: &mut WindowContext) {
713 self.update_state(|state| {
714 let mode = if (state.mode == Mode::Insert
715 || state.mode == Mode::Replace
716 || state.mode == Mode::Normal)
717 && state.current_tx.is_none()
718 {
719 state.current_tx = Some(transaction_id);
720 state.last_mode
721 } else {
722 state.mode
723 };
724 if mode == Mode::VisualLine || mode == Mode::VisualBlock {
725 state.undo_modes.insert(transaction_id, mode);
726 }
727 });
728 }
729
730 fn transaction_undone(&mut self, transaction_id: &TransactionId, cx: &mut WindowContext) {
731 match self.state().mode {
732 Mode::VisualLine | Mode::VisualBlock | Mode::Visual => {
733 self.update_active_editor(cx, |vim, editor, cx| {
734 let original_mode = vim.state().undo_modes.get(transaction_id);
735 editor.change_selections(None, cx, |s| match original_mode {
736 Some(Mode::VisualLine) => {
737 s.move_with(|map, selection| {
738 selection.collapse_to(
739 map.prev_line_boundary(selection.start.to_point(map)).1,
740 SelectionGoal::None,
741 )
742 });
743 }
744 Some(Mode::VisualBlock) => {
745 let mut first = s.first_anchor();
746 first.collapse_to(first.start, first.goal);
747 s.select_anchors(vec![first]);
748 }
749 _ => {
750 s.move_with(|map, selection| {
751 selection.collapse_to(
752 map.clip_at_line_end(selection.start),
753 selection.goal,
754 );
755 });
756 }
757 });
758 });
759 self.switch_mode(Mode::Normal, true, cx)
760 }
761 Mode::Normal => {
762 self.update_active_editor(cx, |_, editor, cx| {
763 editor.change_selections(None, cx, |s| {
764 s.move_with(|map, selection| {
765 selection
766 .collapse_to(map.clip_at_line_end(selection.end), selection.goal)
767 })
768 })
769 });
770 }
771 Mode::Insert | Mode::Replace => {}
772 }
773 }
774
775 fn transaction_ended(&mut self, editor: View<Editor>, cx: &mut WindowContext) {
776 push_to_change_list(self, editor, cx)
777 }
778
779 fn local_selections_changed(&mut self, editor: View<Editor>, cx: &mut WindowContext) {
780 let newest = editor.read(cx).selections.newest_anchor().clone();
781 let is_multicursor = editor.read(cx).selections.count() > 1;
782
783 let state = self.state();
784 if state.mode == Mode::Insert && state.current_tx.is_some() {
785 if state.current_anchor.is_none() {
786 self.update_state(|state| state.current_anchor = Some(newest));
787 } else if state.current_anchor.as_ref().unwrap() != &newest {
788 if let Some(tx_id) = self.update_state(|state| state.current_tx.take()) {
789 self.update_active_editor(cx, |_, editor, cx| {
790 editor.group_until_transaction(tx_id, cx)
791 });
792 }
793 }
794 } else if state.mode == Mode::Normal && newest.start != newest.end {
795 if matches!(newest.goal, SelectionGoal::HorizontalRange { .. }) {
796 self.switch_mode(Mode::VisualBlock, false, cx);
797 } else {
798 self.switch_mode(Mode::Visual, false, cx)
799 }
800 } else if newest.start == newest.end
801 && !is_multicursor
802 && [Mode::Visual, Mode::VisualLine, Mode::VisualBlock].contains(&state.mode)
803 {
804 self.switch_mode(Mode::Normal, true, cx);
805 }
806 }
807
808 fn active_editor_input_ignored(text: Arc<str>, cx: &mut WindowContext) {
809 if text.is_empty() {
810 return;
811 }
812
813 match Vim::read(cx).active_operator() {
814 Some(Operator::FindForward { before }) => {
815 let find = Motion::FindForward {
816 before,
817 char: text.chars().next().unwrap(),
818 mode: if VimSettings::get_global(cx).use_multiline_find {
819 FindRange::MultiLine
820 } else {
821 FindRange::SingleLine
822 },
823 smartcase: VimSettings::get_global(cx).use_smartcase_find,
824 };
825 Vim::update(cx, |vim, _| {
826 vim.workspace_state.last_find = Some(find.clone())
827 });
828 motion::motion(find, cx)
829 }
830 Some(Operator::FindBackward { after }) => {
831 let find = Motion::FindBackward {
832 after,
833 char: text.chars().next().unwrap(),
834 mode: if VimSettings::get_global(cx).use_multiline_find {
835 FindRange::MultiLine
836 } else {
837 FindRange::SingleLine
838 },
839 smartcase: VimSettings::get_global(cx).use_smartcase_find,
840 };
841 Vim::update(cx, |vim, _| {
842 vim.workspace_state.last_find = Some(find.clone())
843 });
844 motion::motion(find, cx)
845 }
846 Some(Operator::Replace) => match Vim::read(cx).state().mode {
847 Mode::Normal => normal_replace(text, cx),
848 Mode::Visual | Mode::VisualLine | Mode::VisualBlock => visual_replace(text, cx),
849 _ => Vim::update(cx, |vim, cx| vim.clear_operator(cx)),
850 },
851 Some(Operator::AddSurrounds { target }) => match Vim::read(cx).state().mode {
852 Mode::Normal => {
853 if let Some(target) = target {
854 add_surrounds(text, target, cx);
855 Vim::update(cx, |vim, cx| vim.clear_operator(cx));
856 }
857 }
858 Mode::Visual | Mode::VisualLine | Mode::VisualBlock => {
859 add_surrounds(text, SurroundsType::Selection, cx);
860 Vim::update(cx, |vim, cx| vim.clear_operator(cx));
861 }
862 _ => Vim::update(cx, |vim, cx| vim.clear_operator(cx)),
863 },
864 Some(Operator::ChangeSurrounds { target }) => match Vim::read(cx).state().mode {
865 Mode::Normal => {
866 if let Some(target) = target {
867 change_surrounds(text, target, cx);
868 Vim::update(cx, |vim, cx| vim.clear_operator(cx));
869 }
870 }
871 _ => Vim::update(cx, |vim, cx| vim.clear_operator(cx)),
872 },
873 Some(Operator::DeleteSurrounds) => match Vim::read(cx).state().mode {
874 Mode::Normal => {
875 delete_surrounds(text, cx);
876 Vim::update(cx, |vim, cx| vim.clear_operator(cx));
877 }
878 _ => Vim::update(cx, |vim, cx| vim.clear_operator(cx)),
879 },
880 Some(Operator::Mark) => Vim::update(cx, |vim, cx| {
881 normal::mark::create_mark(vim, text, false, cx)
882 }),
883 Some(Operator::RecordRegister) => record_register(text.chars().next().unwrap(), cx),
884 Some(Operator::ReplayRegister) => replay_register(text.chars().next().unwrap(), cx),
885 Some(Operator::Register) => Vim::update(cx, |vim, cx| match vim.state().mode {
886 Mode::Insert => {
887 vim.update_active_editor(cx, |vim, editor, cx| {
888 if let Some(register) =
889 vim.read_register(text.chars().next(), Some(editor), cx)
890 {
891 editor.do_paste(
892 ®ister.text.to_string(),
893 register.clipboard_selections.clone(),
894 false,
895 cx,
896 )
897 }
898 });
899 vim.clear_operator(cx);
900 }
901 _ => {
902 vim.select_register(text, cx);
903 }
904 }),
905 Some(Operator::Jump { line }) => normal::mark::jump(text, line, cx),
906 _ => match Vim::read(cx).state().mode {
907 Mode::Replace => multi_replace(text, cx),
908 _ => {}
909 },
910 }
911 }
912
913 fn set_enabled(&mut self, enabled: bool, cx: &mut AppContext) {
914 if self.enabled == enabled {
915 return;
916 }
917 if !enabled {
918 CommandPaletteInterceptor::update_global(cx, |interceptor, _| {
919 interceptor.clear();
920 });
921 CommandPaletteFilter::update_global(cx, |filter, _| {
922 filter.hide_namespace(Self::NAMESPACE);
923 });
924 *self = Default::default();
925 return;
926 }
927
928 self.enabled = true;
929 CommandPaletteFilter::update_global(cx, |filter, _| {
930 filter.show_namespace(Self::NAMESPACE);
931 });
932 CommandPaletteInterceptor::update_global(cx, |interceptor, _| {
933 interceptor.set(Box::new(command::command_interceptor));
934 });
935
936 if let Some(active_window) = cx
937 .active_window()
938 .and_then(|window| window.downcast::<Workspace>())
939 {
940 active_window
941 .update(cx, |workspace, cx| {
942 let active_editor = workspace.active_item_as::<Editor>(cx);
943 if let Some(active_editor) = active_editor {
944 self.activate_editor(active_editor, cx);
945 self.switch_mode(Mode::Normal, false, cx);
946 }
947 })
948 .ok();
949 }
950 }
951
952 /// Returns the state of the active editor.
953 pub fn state(&self) -> &EditorState {
954 if let Some(active_editor) = self.active_editor.as_ref() {
955 if let Some(state) = self.editor_states.get(&active_editor.entity_id()) {
956 return state;
957 }
958 }
959
960 &self.default_state
961 }
962
963 /// Updates the state of the active editor.
964 pub fn update_state<T>(&mut self, func: impl FnOnce(&mut EditorState) -> T) -> T {
965 let mut state = self.state().clone();
966 let ret = func(&mut state);
967
968 if let Some(active_editor) = self.active_editor.as_ref() {
969 self.editor_states.insert(active_editor.entity_id(), state);
970 }
971
972 ret
973 }
974
975 fn sync_vim_settings(&mut self, cx: &mut WindowContext) {
976 self.update_active_editor(cx, |vim, editor, cx| {
977 let state = vim.state();
978 editor.set_cursor_shape(state.cursor_shape(), cx);
979 editor.set_clip_at_line_ends(state.clip_at_line_ends(), cx);
980 editor.set_collapse_matches(true);
981 editor.set_input_enabled(state.editor_input_enabled());
982 editor.set_autoindent(state.should_autoindent());
983 editor.selections.line_mode = matches!(state.mode, Mode::VisualLine);
984 if editor.is_focused(cx) || editor.mouse_menu_is_focused(cx) {
985 editor.set_keymap_context_layer::<Self>(state.keymap_context_layer(), cx);
986 // disable vim mode if a sub-editor (inline assist, rename, etc.) is focused
987 } else if editor.focus_handle(cx).contains_focused(cx) {
988 editor.remove_keymap_context_layer::<Self>(cx);
989 }
990 });
991 }
992
993 fn unhook_vim_settings(editor: &mut Editor, cx: &mut ViewContext<Editor>) {
994 if editor.mode() == EditorMode::Full {
995 editor.set_cursor_shape(CursorShape::Bar, cx);
996 editor.set_clip_at_line_ends(false, cx);
997 editor.set_collapse_matches(false);
998 editor.set_input_enabled(true);
999 editor.set_autoindent(true);
1000 editor.selections.line_mode = false;
1001 }
1002 editor.remove_keymap_context_layer::<Self>(cx)
1003 }
1004}
1005
1006impl Settings for VimModeSetting {
1007 const KEY: Option<&'static str> = Some("vim_mode");
1008
1009 type FileContent = Option<bool>;
1010
1011 fn load(sources: SettingsSources<Self::FileContent>, _: &mut AppContext) -> Result<Self> {
1012 Ok(Self(sources.user.copied().flatten().unwrap_or(
1013 sources.default.ok_or_else(Self::missing_default)?,
1014 )))
1015 }
1016}
1017
1018/// Controls when to use system clipboard.
1019#[derive(Copy, Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
1020#[serde(rename_all = "snake_case")]
1021pub enum UseSystemClipboard {
1022 /// Don't use system clipboard.
1023 Never,
1024 /// Use system clipboard.
1025 Always,
1026 /// Use system clipboard for yank operations.
1027 OnYank,
1028}
1029
1030#[derive(Deserialize)]
1031struct VimSettings {
1032 // all vim uses vim clipboard
1033 // vim always uses system cliupbaord
1034 // some magic where yy is system and dd is not.
1035 pub use_system_clipboard: UseSystemClipboard,
1036 pub use_multiline_find: bool,
1037 pub use_smartcase_find: bool,
1038}
1039
1040#[derive(Clone, Default, Serialize, Deserialize, JsonSchema)]
1041struct VimSettingsContent {
1042 pub use_system_clipboard: Option<UseSystemClipboard>,
1043 pub use_multiline_find: Option<bool>,
1044 pub use_smartcase_find: Option<bool>,
1045}
1046
1047impl Settings for VimSettings {
1048 const KEY: Option<&'static str> = Some("vim");
1049
1050 type FileContent = VimSettingsContent;
1051
1052 fn load(sources: SettingsSources<Self::FileContent>, _: &mut AppContext) -> Result<Self> {
1053 sources.json_merge()
1054 }
1055}