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