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