1//! Vim support for Zed.
2
3#[cfg(test)]
4mod test;
5
6mod change_list;
7mod command;
8mod digraph;
9mod helix;
10mod indent;
11mod insert;
12mod mode_indicator;
13mod motion;
14mod normal;
15mod object;
16mod replace;
17mod rewrap;
18mod state;
19mod surrounds;
20mod visual;
21
22use collections::HashMap;
23use editor::{
24 Anchor, Bias, Editor, EditorEvent, EditorSettings, HideMouseCursorOrigin, SelectionEffects,
25 ToPoint,
26 actions::Paste,
27 movement::{self, FindRange},
28};
29use gpui::{
30 Action, App, AppContext, Axis, Context, Entity, EventEmitter, KeyContext, KeystrokeEvent,
31 Render, Subscription, Task, WeakEntity, Window, actions,
32};
33use insert::{NormalBefore, TemporaryNormal};
34use language::{
35 CharKind, CharScopeContext, CursorShape, Point, Selection, SelectionGoal, TransactionId,
36};
37pub use mode_indicator::ModeIndicator;
38use motion::Motion;
39use normal::search::SearchSubmit;
40use object::Object;
41use schemars::JsonSchema;
42use serde::Deserialize;
43use settings::RegisterSetting;
44pub use settings::{
45 ModeContent, Settings, SettingsStore, UseSystemClipboard, update_settings_file,
46};
47use state::{Mode, Operator, RecordedSelection, SearchState, VimGlobals};
48use std::{mem, ops::Range, sync::Arc};
49use surrounds::SurroundsType;
50use theme::ThemeSettings;
51use ui::{IntoElement, SharedString, px};
52use vim_mode_setting::HelixModeSetting;
53use vim_mode_setting::VimModeSetting;
54use workspace::{self, Pane, Workspace};
55
56use crate::{
57 normal::{GoToPreviousTab, GoToTab},
58 state::ReplayableAction,
59};
60
61/// Number is used to manage vim's count. Pushing a digit
62/// multiplies the current value by 10 and adds the digit.
63#[derive(Clone, Deserialize, JsonSchema, PartialEq, Action)]
64#[action(namespace = vim)]
65struct Number(usize);
66
67#[derive(Clone, Deserialize, JsonSchema, PartialEq, Action)]
68#[action(namespace = vim)]
69struct SelectRegister(String);
70
71#[derive(Clone, Deserialize, JsonSchema, PartialEq, Action)]
72#[action(namespace = vim)]
73#[serde(deny_unknown_fields)]
74struct PushObject {
75 around: bool,
76}
77
78#[derive(Clone, Deserialize, JsonSchema, PartialEq, Action)]
79#[action(namespace = vim)]
80#[serde(deny_unknown_fields)]
81struct PushFindForward {
82 before: bool,
83 multiline: bool,
84}
85
86#[derive(Clone, Deserialize, JsonSchema, PartialEq, Action)]
87#[action(namespace = vim)]
88#[serde(deny_unknown_fields)]
89struct PushFindBackward {
90 after: bool,
91 multiline: bool,
92}
93
94#[derive(Clone, Deserialize, JsonSchema, PartialEq, Action)]
95#[action(namespace = vim)]
96#[serde(deny_unknown_fields)]
97/// Selects the next object.
98struct PushHelixNext {
99 around: bool,
100}
101
102#[derive(Clone, Deserialize, JsonSchema, PartialEq, Action)]
103#[action(namespace = vim)]
104#[serde(deny_unknown_fields)]
105/// Selects the previous object.
106struct PushHelixPrevious {
107 around: bool,
108}
109
110#[derive(Clone, Deserialize, JsonSchema, PartialEq, Action)]
111#[action(namespace = vim)]
112#[serde(deny_unknown_fields)]
113struct PushSneak {
114 first_char: Option<char>,
115}
116
117#[derive(Clone, Deserialize, JsonSchema, PartialEq, Action)]
118#[action(namespace = vim)]
119#[serde(deny_unknown_fields)]
120struct PushSneakBackward {
121 first_char: Option<char>,
122}
123
124#[derive(Clone, Deserialize, JsonSchema, PartialEq, Action)]
125#[action(namespace = vim)]
126#[serde(deny_unknown_fields)]
127struct PushAddSurrounds;
128
129#[derive(Clone, Deserialize, JsonSchema, PartialEq, Action)]
130#[action(namespace = vim)]
131#[serde(deny_unknown_fields)]
132struct PushChangeSurrounds {
133 target: Option<Object>,
134}
135
136#[derive(Clone, Deserialize, JsonSchema, PartialEq, Action)]
137#[action(namespace = vim)]
138#[serde(deny_unknown_fields)]
139struct PushJump {
140 line: bool,
141}
142
143#[derive(Clone, Deserialize, JsonSchema, PartialEq, Action)]
144#[action(namespace = vim)]
145#[serde(deny_unknown_fields)]
146struct PushDigraph {
147 first_char: Option<char>,
148}
149
150#[derive(Clone, Deserialize, JsonSchema, PartialEq, Action)]
151#[action(namespace = vim)]
152#[serde(deny_unknown_fields)]
153struct PushLiteral {
154 prefix: Option<String>,
155}
156
157actions!(
158 vim,
159 [
160 /// Switches to normal mode.
161 SwitchToNormalMode,
162 /// Switches to insert mode.
163 SwitchToInsertMode,
164 /// Switches to replace mode.
165 SwitchToReplaceMode,
166 /// Switches to visual mode.
167 SwitchToVisualMode,
168 /// Switches to visual line mode.
169 SwitchToVisualLineMode,
170 /// Switches to visual block mode.
171 SwitchToVisualBlockMode,
172 /// Switches to Helix-style normal mode.
173 SwitchToHelixNormalMode,
174 /// Clears any pending operators.
175 ClearOperators,
176 /// Clears the exchange register.
177 ClearExchange,
178 /// Inserts a tab character.
179 Tab,
180 /// Inserts a newline.
181 Enter,
182 /// Selects inner text object.
183 InnerObject,
184 /// Maximizes the current pane.
185 MaximizePane,
186 /// Opens the default keymap file.
187 OpenDefaultKeymap,
188 /// Resets all pane sizes to default.
189 ResetPaneSizes,
190 /// Resizes the pane to the right.
191 ResizePaneRight,
192 /// Resizes the pane to the left.
193 ResizePaneLeft,
194 /// Resizes the pane upward.
195 ResizePaneUp,
196 /// Resizes the pane downward.
197 ResizePaneDown,
198 /// Starts a change operation.
199 PushChange,
200 /// Starts a delete operation.
201 PushDelete,
202 /// Exchanges text regions.
203 Exchange,
204 /// Starts a yank operation.
205 PushYank,
206 /// Starts a replace operation.
207 PushReplace,
208 /// Deletes surrounding characters.
209 PushDeleteSurrounds,
210 /// Sets a mark at the current position.
211 PushMark,
212 /// Toggles the marks view.
213 ToggleMarksView,
214 /// Starts a forced motion.
215 PushForcedMotion,
216 /// Starts an indent operation.
217 PushIndent,
218 /// Starts an outdent operation.
219 PushOutdent,
220 /// Starts an auto-indent operation.
221 PushAutoIndent,
222 /// Starts a rewrap operation.
223 PushRewrap,
224 /// Starts a shell command operation.
225 PushShellCommand,
226 /// Converts to lowercase.
227 PushLowercase,
228 /// Converts to uppercase.
229 PushUppercase,
230 /// Toggles case.
231 PushOppositeCase,
232 /// Applies ROT13 encoding.
233 PushRot13,
234 /// Applies ROT47 encoding.
235 PushRot47,
236 /// Toggles the registers view.
237 ToggleRegistersView,
238 /// Selects a register.
239 PushRegister,
240 /// Starts recording to a register.
241 PushRecordRegister,
242 /// Replays a register.
243 PushReplayRegister,
244 /// Replaces with register contents.
245 PushReplaceWithRegister,
246 /// Toggles comments.
247 PushToggleComments,
248 /// Selects (count) next menu item
249 MenuSelectNext,
250 /// Selects (count) previous menu item
251 MenuSelectPrevious,
252 /// Clears count or toggles project panel focus
253 ToggleProjectPanelFocus,
254 /// Starts a match operation.
255 PushHelixMatch,
256 ]
257);
258
259// in the workspace namespace so it's not filtered out when vim is disabled.
260actions!(
261 workspace,
262 [
263 /// Toggles Vim mode on or off.
264 ToggleVimMode,
265 /// Toggles Helix mode on or off.
266 ToggleHelixMode,
267 ]
268);
269
270/// Initializes the `vim` crate.
271pub fn init(cx: &mut App) {
272 VimGlobals::register(cx);
273
274 cx.observe_new(Vim::register).detach();
275
276 cx.observe_new(|workspace: &mut Workspace, _, _| {
277 workspace.register_action(|workspace, _: &ToggleVimMode, _, cx| {
278 let fs = workspace.app_state().fs.clone();
279 let currently_enabled = VimModeSetting::get_global(cx).0;
280 update_settings_file(fs, cx, move |setting, _| {
281 setting.vim_mode = Some(!currently_enabled);
282 if let Some(helix_mode) = &mut setting.helix_mode {
283 *helix_mode = false;
284 }
285 })
286 });
287
288 workspace.register_action(|workspace, _: &ToggleHelixMode, _, cx| {
289 let fs = workspace.app_state().fs.clone();
290 let currently_enabled = HelixModeSetting::get_global(cx).0;
291 update_settings_file(fs, cx, move |setting, _| {
292 setting.helix_mode = Some(!currently_enabled);
293 if let Some(vim_mode) = &mut setting.vim_mode {
294 *vim_mode = false;
295 }
296 })
297 });
298
299 workspace.register_action(|_, _: &MenuSelectNext, window, cx| {
300 let count = Vim::take_count(cx).unwrap_or(1);
301
302 for _ in 0..count {
303 window.dispatch_action(menu::SelectNext.boxed_clone(), cx);
304 }
305 });
306
307 workspace.register_action(|_, _: &MenuSelectPrevious, window, cx| {
308 let count = Vim::take_count(cx).unwrap_or(1);
309
310 for _ in 0..count {
311 window.dispatch_action(menu::SelectPrevious.boxed_clone(), cx);
312 }
313 });
314
315 workspace.register_action(|_, _: &ToggleProjectPanelFocus, window, cx| {
316 if Vim::take_count(cx).is_none() {
317 window.dispatch_action(project_panel::ToggleFocus.boxed_clone(), cx);
318 }
319 });
320
321 workspace.register_action(|workspace, n: &Number, window, cx| {
322 let vim = workspace
323 .focused_pane(window, cx)
324 .read(cx)
325 .active_item()
326 .and_then(|item| item.act_as::<Editor>(cx))
327 .and_then(|editor| editor.read(cx).addon::<VimAddon>().cloned());
328 if let Some(vim) = vim {
329 let digit = n.0;
330 vim.entity.update(cx, |_, cx| {
331 cx.defer_in(window, move |vim, window, cx| {
332 vim.push_count_digit(digit, window, cx)
333 })
334 });
335 } else {
336 let count = Vim::globals(cx).pre_count.unwrap_or(0);
337 Vim::globals(cx).pre_count = Some(
338 count
339 .checked_mul(10)
340 .and_then(|c| c.checked_add(n.0))
341 .unwrap_or(count),
342 );
343 };
344 });
345
346 workspace.register_action(|_, _: &OpenDefaultKeymap, _, cx| {
347 cx.emit(workspace::Event::OpenBundledFile {
348 text: settings::vim_keymap(),
349 title: "Default Vim Bindings",
350 language: "JSON",
351 });
352 });
353
354 workspace.register_action(|workspace, _: &ResetPaneSizes, _, cx| {
355 workspace.reset_pane_sizes(cx);
356 });
357
358 workspace.register_action(|workspace, _: &MaximizePane, window, cx| {
359 let pane = workspace.active_pane();
360 let Some(size) = workspace.bounding_box_for_pane(pane) else {
361 return;
362 };
363
364 let theme = ThemeSettings::get_global(cx);
365 let height = theme.buffer_font_size(cx) * theme.buffer_line_height.value();
366
367 let desired_size = if let Some(count) = Vim::take_count(cx) {
368 height * count
369 } else {
370 px(10000.)
371 };
372 workspace.resize_pane(Axis::Vertical, desired_size - size.size.height, window, cx)
373 });
374
375 workspace.register_action(|workspace, _: &ResizePaneRight, window, cx| {
376 let count = Vim::take_count(cx).unwrap_or(1) as f32;
377 Vim::take_forced_motion(cx);
378 let theme = ThemeSettings::get_global(cx);
379 let font_id = window.text_system().resolve_font(&theme.buffer_font);
380 let Ok(width) = window
381 .text_system()
382 .advance(font_id, theme.buffer_font_size(cx), 'm')
383 else {
384 return;
385 };
386 workspace.resize_pane(Axis::Horizontal, width.width * count, window, cx);
387 });
388
389 workspace.register_action(|workspace, _: &ResizePaneLeft, window, cx| {
390 let count = Vim::take_count(cx).unwrap_or(1) as f32;
391 Vim::take_forced_motion(cx);
392 let theme = ThemeSettings::get_global(cx);
393 let font_id = window.text_system().resolve_font(&theme.buffer_font);
394 let Ok(width) = window
395 .text_system()
396 .advance(font_id, theme.buffer_font_size(cx), 'm')
397 else {
398 return;
399 };
400 workspace.resize_pane(Axis::Horizontal, -width.width * count, window, cx);
401 });
402
403 workspace.register_action(|workspace, _: &ResizePaneUp, window, cx| {
404 let count = Vim::take_count(cx).unwrap_or(1) as f32;
405 Vim::take_forced_motion(cx);
406 let theme = ThemeSettings::get_global(cx);
407 let height = theme.buffer_font_size(cx) * theme.buffer_line_height.value();
408 workspace.resize_pane(Axis::Vertical, height * count, window, cx);
409 });
410
411 workspace.register_action(|workspace, _: &ResizePaneDown, window, cx| {
412 let count = Vim::take_count(cx).unwrap_or(1) as f32;
413 Vim::take_forced_motion(cx);
414 let theme = ThemeSettings::get_global(cx);
415 let height = theme.buffer_font_size(cx) * theme.buffer_line_height.value();
416 workspace.resize_pane(Axis::Vertical, -height * count, window, cx);
417 });
418
419 workspace.register_action(|workspace, _: &SearchSubmit, window, cx| {
420 let vim = workspace
421 .focused_pane(window, cx)
422 .read(cx)
423 .active_item()
424 .and_then(|item| item.act_as::<Editor>(cx))
425 .and_then(|editor| editor.read(cx).addon::<VimAddon>().cloned());
426 let Some(vim) = vim else { return };
427 vim.entity.update(cx, |_, cx| {
428 cx.defer_in(window, |vim, window, cx| vim.search_submit(window, cx))
429 })
430 });
431 workspace.register_action(|_, _: &GoToTab, window, cx| {
432 let count = Vim::take_count(cx);
433 Vim::take_forced_motion(cx);
434
435 if let Some(tab_index) = count {
436 // <count>gt goes to tab <count> (1-based).
437 let zero_based_index = tab_index.saturating_sub(1);
438 window.dispatch_action(
439 workspace::pane::ActivateItem(zero_based_index).boxed_clone(),
440 cx,
441 );
442 } else {
443 // If no count is provided, go to the next tab.
444 window.dispatch_action(workspace::pane::ActivateNextItem.boxed_clone(), cx);
445 }
446 });
447
448 workspace.register_action(|workspace, _: &GoToPreviousTab, window, cx| {
449 let count = Vim::take_count(cx);
450 Vim::take_forced_motion(cx);
451
452 if let Some(count) = count {
453 // gT with count goes back that many tabs with wraparound (not the same as gt!).
454 let pane = workspace.active_pane().read(cx);
455 let item_count = pane.items().count();
456 if item_count > 0 {
457 let current_index = pane.active_item_index();
458 let target_index = (current_index as isize - count as isize)
459 .rem_euclid(item_count as isize)
460 as usize;
461 window.dispatch_action(
462 workspace::pane::ActivateItem(target_index).boxed_clone(),
463 cx,
464 );
465 }
466 } else {
467 // No count provided, go to the previous tab.
468 window.dispatch_action(workspace::pane::ActivatePreviousItem.boxed_clone(), cx);
469 }
470 });
471 })
472 .detach();
473}
474
475#[derive(Clone)]
476pub(crate) struct VimAddon {
477 pub(crate) entity: Entity<Vim>,
478}
479
480impl editor::Addon for VimAddon {
481 fn extend_key_context(&self, key_context: &mut KeyContext, cx: &App) {
482 self.entity.read(cx).extend_key_context(key_context, cx)
483 }
484
485 fn to_any(&self) -> &dyn std::any::Any {
486 self
487 }
488}
489
490/// The state pertaining to Vim mode.
491pub(crate) struct Vim {
492 pub(crate) mode: Mode,
493 pub last_mode: Mode,
494 pub temp_mode: bool,
495 pub status_label: Option<SharedString>,
496 pub exit_temporary_mode: bool,
497
498 operator_stack: Vec<Operator>,
499 pub(crate) replacements: Vec<(Range<editor::Anchor>, String)>,
500
501 pub(crate) stored_visual_mode: Option<(Mode, Vec<bool>)>,
502
503 pub(crate) current_tx: Option<TransactionId>,
504 pub(crate) current_anchor: Option<Selection<Anchor>>,
505 pub(crate) undo_modes: HashMap<TransactionId, Mode>,
506 pub(crate) undo_last_line_tx: Option<TransactionId>,
507
508 selected_register: Option<char>,
509 pub search: SearchState,
510
511 editor: WeakEntity<Editor>,
512
513 last_command: Option<String>,
514 running_command: Option<Task<()>>,
515 _subscriptions: Vec<Subscription>,
516}
517
518// Hack: Vim intercepts events dispatched to a window and updates the view in response.
519// This means it needs a VisualContext. The easiest way to satisfy that constraint is
520// to make Vim a "View" that is just never actually rendered.
521impl Render for Vim {
522 fn render(&mut self, _window: &mut Window, _cx: &mut Context<Self>) -> impl IntoElement {
523 gpui::Empty
524 }
525}
526
527enum VimEvent {
528 Focused,
529}
530impl EventEmitter<VimEvent> for Vim {}
531
532impl Vim {
533 /// The namespace for Vim actions.
534 const NAMESPACE: &'static str = "vim";
535
536 pub fn new(window: &mut Window, cx: &mut Context<Editor>) -> Entity<Self> {
537 let editor = cx.entity();
538
539 let initial_vim_mode = VimSettings::get_global(cx).default_mode;
540 let (mode, last_mode) = if HelixModeSetting::get_global(cx).0 {
541 let initial_helix_mode = match initial_vim_mode {
542 Mode::Normal => Mode::HelixNormal,
543 Mode::Insert => Mode::Insert,
544 // Otherwise, we panic with a note that we should never get there due to the
545 // possible values of VimSettings::get_global(cx).default_mode being either Mode::Normal or Mode::Insert.
546 _ => unreachable!("Invalid default mode"),
547 };
548 (initial_helix_mode, Mode::HelixNormal)
549 } else {
550 (initial_vim_mode, Mode::Normal)
551 };
552
553 cx.new(|cx| Vim {
554 mode,
555 last_mode,
556 temp_mode: false,
557 exit_temporary_mode: false,
558 operator_stack: Vec::new(),
559 replacements: Vec::new(),
560
561 stored_visual_mode: None,
562 current_tx: None,
563 undo_last_line_tx: None,
564 current_anchor: None,
565 undo_modes: HashMap::default(),
566
567 status_label: None,
568 selected_register: None,
569 search: SearchState::default(),
570
571 last_command: None,
572 running_command: None,
573
574 editor: editor.downgrade(),
575 _subscriptions: vec![
576 cx.observe_keystrokes(Self::observe_keystrokes),
577 cx.subscribe_in(&editor, window, |this, _, event, window, cx| {
578 this.handle_editor_event(event, window, cx)
579 }),
580 ],
581 })
582 }
583
584 fn register(editor: &mut Editor, window: Option<&mut Window>, cx: &mut Context<Editor>) {
585 let Some(window) = window else {
586 return;
587 };
588
589 if !editor.use_modal_editing() {
590 return;
591 }
592
593 let mut was_enabled = Vim::enabled(cx);
594 let mut was_toggle = VimSettings::get_global(cx).toggle_relative_line_numbers;
595 cx.observe_global_in::<SettingsStore>(window, move |editor, window, cx| {
596 let enabled = Vim::enabled(cx);
597 let toggle = VimSettings::get_global(cx).toggle_relative_line_numbers;
598 if enabled && was_enabled && (toggle != was_toggle) {
599 if toggle {
600 let is_relative = editor
601 .addon::<VimAddon>()
602 .map(|vim| vim.entity.read(cx).mode != Mode::Insert);
603 editor.set_relative_line_number(is_relative, cx)
604 } else {
605 editor.set_relative_line_number(None, cx)
606 }
607 }
608 was_toggle = VimSettings::get_global(cx).toggle_relative_line_numbers;
609 if was_enabled == enabled {
610 return;
611 }
612 was_enabled = enabled;
613 if enabled {
614 Self::activate(editor, window, cx)
615 } else {
616 Self::deactivate(editor, cx)
617 }
618 })
619 .detach();
620 if was_enabled {
621 Self::activate(editor, window, cx)
622 }
623 }
624
625 fn activate(editor: &mut Editor, window: &mut Window, cx: &mut Context<Editor>) {
626 let vim = Vim::new(window, cx);
627
628 if !editor.mode().is_full() {
629 vim.update(cx, |vim, _| {
630 vim.mode = Mode::Insert;
631 });
632 }
633
634 editor.register_addon(VimAddon {
635 entity: vim.clone(),
636 });
637
638 vim.update(cx, |_, cx| {
639 Vim::action(editor, cx, |vim, _: &SwitchToNormalMode, window, cx| {
640 vim.switch_mode(Mode::Normal, false, window, cx)
641 });
642
643 Vim::action(editor, cx, |vim, _: &SwitchToInsertMode, window, cx| {
644 vim.switch_mode(Mode::Insert, false, window, cx)
645 });
646
647 Vim::action(editor, cx, |vim, _: &SwitchToReplaceMode, window, cx| {
648 vim.switch_mode(Mode::Replace, false, window, cx)
649 });
650
651 Vim::action(editor, cx, |vim, _: &SwitchToVisualMode, window, cx| {
652 vim.switch_mode(Mode::Visual, false, window, cx)
653 });
654
655 Vim::action(editor, cx, |vim, _: &SwitchToVisualLineMode, window, cx| {
656 vim.switch_mode(Mode::VisualLine, false, window, cx)
657 });
658
659 Vim::action(
660 editor,
661 cx,
662 |vim, _: &SwitchToVisualBlockMode, window, cx| {
663 vim.switch_mode(Mode::VisualBlock, false, window, cx)
664 },
665 );
666
667 Vim::action(
668 editor,
669 cx,
670 |vim, _: &SwitchToHelixNormalMode, window, cx| {
671 vim.switch_mode(Mode::HelixNormal, false, window, cx)
672 },
673 );
674 Vim::action(editor, cx, |_, _: &PushForcedMotion, _, cx| {
675 Vim::globals(cx).forced_motion = true;
676 });
677 Vim::action(editor, cx, |vim, action: &PushObject, window, cx| {
678 vim.push_operator(
679 Operator::Object {
680 around: action.around,
681 },
682 window,
683 cx,
684 )
685 });
686
687 Vim::action(editor, cx, |vim, action: &PushFindForward, window, cx| {
688 vim.push_operator(
689 Operator::FindForward {
690 before: action.before,
691 multiline: action.multiline,
692 },
693 window,
694 cx,
695 )
696 });
697
698 Vim::action(editor, cx, |vim, action: &PushFindBackward, window, cx| {
699 vim.push_operator(
700 Operator::FindBackward {
701 after: action.after,
702 multiline: action.multiline,
703 },
704 window,
705 cx,
706 )
707 });
708
709 Vim::action(editor, cx, |vim, action: &PushSneak, window, cx| {
710 vim.push_operator(
711 Operator::Sneak {
712 first_char: action.first_char,
713 },
714 window,
715 cx,
716 )
717 });
718
719 Vim::action(editor, cx, |vim, action: &PushSneakBackward, window, cx| {
720 vim.push_operator(
721 Operator::SneakBackward {
722 first_char: action.first_char,
723 },
724 window,
725 cx,
726 )
727 });
728
729 Vim::action(editor, cx, |vim, _: &PushAddSurrounds, window, cx| {
730 vim.push_operator(Operator::AddSurrounds { target: None }, window, cx)
731 });
732
733 Vim::action(
734 editor,
735 cx,
736 |vim, action: &PushChangeSurrounds, window, cx| {
737 vim.push_operator(
738 Operator::ChangeSurrounds {
739 target: action.target,
740 opening: false,
741 },
742 window,
743 cx,
744 )
745 },
746 );
747
748 Vim::action(editor, cx, |vim, action: &PushJump, window, cx| {
749 vim.push_operator(Operator::Jump { line: action.line }, window, cx)
750 });
751
752 Vim::action(editor, cx, |vim, action: &PushDigraph, window, cx| {
753 vim.push_operator(
754 Operator::Digraph {
755 first_char: action.first_char,
756 },
757 window,
758 cx,
759 )
760 });
761
762 Vim::action(editor, cx, |vim, action: &PushLiteral, window, cx| {
763 vim.push_operator(
764 Operator::Literal {
765 prefix: action.prefix.clone(),
766 },
767 window,
768 cx,
769 )
770 });
771
772 Vim::action(editor, cx, |vim, _: &PushChange, window, cx| {
773 vim.push_operator(Operator::Change, window, cx)
774 });
775
776 Vim::action(editor, cx, |vim, _: &PushDelete, window, cx| {
777 vim.push_operator(Operator::Delete, window, cx)
778 });
779
780 Vim::action(editor, cx, |vim, _: &PushYank, window, cx| {
781 vim.push_operator(Operator::Yank, window, cx)
782 });
783
784 Vim::action(editor, cx, |vim, _: &PushReplace, window, cx| {
785 vim.push_operator(Operator::Replace, window, cx)
786 });
787
788 Vim::action(editor, cx, |vim, _: &PushDeleteSurrounds, window, cx| {
789 vim.push_operator(Operator::DeleteSurrounds, window, cx)
790 });
791
792 Vim::action(editor, cx, |vim, _: &PushMark, window, cx| {
793 vim.push_operator(Operator::Mark, window, cx)
794 });
795
796 Vim::action(editor, cx, |vim, _: &PushIndent, window, cx| {
797 vim.push_operator(Operator::Indent, window, cx)
798 });
799
800 Vim::action(editor, cx, |vim, _: &PushOutdent, window, cx| {
801 vim.push_operator(Operator::Outdent, window, cx)
802 });
803
804 Vim::action(editor, cx, |vim, _: &PushAutoIndent, window, cx| {
805 vim.push_operator(Operator::AutoIndent, window, cx)
806 });
807
808 Vim::action(editor, cx, |vim, _: &PushRewrap, window, cx| {
809 vim.push_operator(Operator::Rewrap, window, cx)
810 });
811
812 Vim::action(editor, cx, |vim, _: &PushShellCommand, window, cx| {
813 vim.push_operator(Operator::ShellCommand, window, cx)
814 });
815
816 Vim::action(editor, cx, |vim, _: &PushLowercase, window, cx| {
817 vim.push_operator(Operator::Lowercase, window, cx)
818 });
819
820 Vim::action(editor, cx, |vim, _: &PushUppercase, window, cx| {
821 vim.push_operator(Operator::Uppercase, window, cx)
822 });
823
824 Vim::action(editor, cx, |vim, _: &PushOppositeCase, window, cx| {
825 vim.push_operator(Operator::OppositeCase, window, cx)
826 });
827
828 Vim::action(editor, cx, |vim, _: &PushRot13, window, cx| {
829 vim.push_operator(Operator::Rot13, window, cx)
830 });
831
832 Vim::action(editor, cx, |vim, _: &PushRot47, window, cx| {
833 vim.push_operator(Operator::Rot47, window, cx)
834 });
835
836 Vim::action(editor, cx, |vim, _: &PushRegister, window, cx| {
837 vim.push_operator(Operator::Register, window, cx)
838 });
839
840 Vim::action(editor, cx, |vim, _: &PushRecordRegister, window, cx| {
841 vim.push_operator(Operator::RecordRegister, window, cx)
842 });
843
844 Vim::action(editor, cx, |vim, _: &PushReplayRegister, window, cx| {
845 vim.push_operator(Operator::ReplayRegister, window, cx)
846 });
847
848 Vim::action(
849 editor,
850 cx,
851 |vim, _: &PushReplaceWithRegister, window, cx| {
852 vim.push_operator(Operator::ReplaceWithRegister, window, cx)
853 },
854 );
855
856 Vim::action(editor, cx, |vim, _: &Exchange, window, cx| {
857 if vim.mode.is_visual() {
858 vim.exchange_visual(window, cx)
859 } else {
860 vim.push_operator(Operator::Exchange, window, cx)
861 }
862 });
863
864 Vim::action(editor, cx, |vim, _: &ClearExchange, window, cx| {
865 vim.clear_exchange(window, cx)
866 });
867
868 Vim::action(editor, cx, |vim, _: &PushToggleComments, window, cx| {
869 vim.push_operator(Operator::ToggleComments, window, cx)
870 });
871
872 Vim::action(editor, cx, |vim, _: &ClearOperators, window, cx| {
873 vim.clear_operator(window, cx)
874 });
875 Vim::action(editor, cx, |vim, n: &Number, window, cx| {
876 vim.push_count_digit(n.0, window, cx);
877 });
878 Vim::action(editor, cx, |vim, _: &Tab, window, cx| {
879 vim.input_ignored(" ".into(), window, cx)
880 });
881 Vim::action(
882 editor,
883 cx,
884 |vim, action: &editor::actions::AcceptEditPrediction, window, cx| {
885 vim.update_editor(cx, |_, editor, cx| {
886 editor.accept_edit_prediction(action, window, cx);
887 });
888 // In non-insertion modes, predictions will be hidden and instead a jump will be
889 // displayed (and performed by `accept_edit_prediction`). This switches to
890 // insert mode so that the prediction is displayed after the jump.
891 match vim.mode {
892 Mode::Replace => {}
893 _ => vim.switch_mode(Mode::Insert, true, window, cx),
894 };
895 },
896 );
897 Vim::action(editor, cx, |vim, _: &Enter, window, cx| {
898 vim.input_ignored("\n".into(), window, cx)
899 });
900 Vim::action(editor, cx, |vim, _: &PushHelixMatch, window, cx| {
901 vim.push_operator(Operator::HelixMatch, window, cx)
902 });
903 Vim::action(editor, cx, |vim, action: &PushHelixNext, window, cx| {
904 vim.push_operator(
905 Operator::HelixNext {
906 around: action.around,
907 },
908 window,
909 cx,
910 );
911 });
912 Vim::action(editor, cx, |vim, action: &PushHelixPrevious, window, cx| {
913 vim.push_operator(
914 Operator::HelixPrevious {
915 around: action.around,
916 },
917 window,
918 cx,
919 );
920 });
921
922 Vim::action(
923 editor,
924 cx,
925 |vim, _: &editor::actions::Paste, window, cx| match vim.mode {
926 Mode::Replace => vim.paste_replace(window, cx),
927 _ => {
928 vim.update_editor(cx, |_, editor, cx| editor.paste(&Paste, window, cx));
929 }
930 },
931 );
932
933 normal::register(editor, cx);
934 insert::register(editor, cx);
935 helix::register(editor, cx);
936 motion::register(editor, cx);
937 command::register(editor, cx);
938 replace::register(editor, cx);
939 indent::register(editor, cx);
940 rewrap::register(editor, cx);
941 object::register(editor, cx);
942 visual::register(editor, cx);
943 change_list::register(editor, cx);
944 digraph::register(editor, cx);
945
946 if editor.is_focused(window) {
947 cx.defer_in(window, |vim, window, cx| {
948 vim.focused(false, window, cx);
949 })
950 }
951 })
952 }
953
954 fn deactivate(editor: &mut Editor, cx: &mut Context<Editor>) {
955 editor.set_cursor_shape(CursorShape::Bar, cx);
956 editor.set_clip_at_line_ends(false, cx);
957 editor.set_collapse_matches(false);
958 editor.set_input_enabled(true);
959 editor.set_autoindent(true);
960 editor.selections.set_line_mode(false);
961 editor.unregister_addon::<VimAddon>();
962 editor.set_relative_line_number(None, cx);
963 if let Some(vim) = Vim::globals(cx).focused_vim()
964 && vim.entity_id() == cx.entity().entity_id()
965 {
966 Vim::globals(cx).focused_vim = None;
967 }
968 }
969
970 /// Register an action on the editor.
971 pub fn action<A: Action>(
972 editor: &mut Editor,
973 cx: &mut Context<Vim>,
974 f: impl Fn(&mut Vim, &A, &mut Window, &mut Context<Vim>) + 'static,
975 ) {
976 let subscription = editor.register_action(cx.listener(f));
977 cx.on_release(|_, _| drop(subscription)).detach();
978 }
979
980 pub fn editor(&self) -> Option<Entity<Editor>> {
981 self.editor.upgrade()
982 }
983
984 pub fn workspace(&self, window: &mut Window) -> Option<Entity<Workspace>> {
985 window.root::<Workspace>().flatten()
986 }
987
988 pub fn pane(&self, window: &mut Window, cx: &mut Context<Self>) -> Option<Entity<Pane>> {
989 self.workspace(window)
990 .map(|workspace| workspace.read(cx).focused_pane(window, cx))
991 }
992
993 pub fn enabled(cx: &mut App) -> bool {
994 VimModeSetting::get_global(cx).0 || HelixModeSetting::get_global(cx).0
995 }
996
997 /// Called whenever an keystroke is typed so vim can observe all actions
998 /// and keystrokes accordingly.
999 fn observe_keystrokes(
1000 &mut self,
1001 keystroke_event: &KeystrokeEvent,
1002 window: &mut Window,
1003 cx: &mut Context<Self>,
1004 ) {
1005 if self.exit_temporary_mode {
1006 self.exit_temporary_mode = false;
1007 // Don't switch to insert mode if the action is temporary_normal.
1008 if let Some(action) = keystroke_event.action.as_ref()
1009 && action.as_any().downcast_ref::<TemporaryNormal>().is_some()
1010 {
1011 return;
1012 }
1013 self.switch_mode(Mode::Insert, false, window, cx)
1014 }
1015 if let Some(action) = keystroke_event.action.as_ref() {
1016 // Keystroke is handled by the vim system, so continue forward
1017 if action.name().starts_with("vim::") {
1018 self.update_editor(cx, |_, editor, cx| {
1019 editor.hide_mouse_cursor(HideMouseCursorOrigin::MovementAction, cx)
1020 });
1021
1022 return;
1023 }
1024 } else if window.has_pending_keystrokes() || keystroke_event.keystroke.is_ime_in_progress()
1025 {
1026 return;
1027 }
1028
1029 if let Some(operator) = self.active_operator() {
1030 match operator {
1031 Operator::Literal { prefix } => {
1032 self.handle_literal_keystroke(
1033 keystroke_event,
1034 prefix.unwrap_or_default(),
1035 window,
1036 cx,
1037 );
1038 }
1039 _ if !operator.is_waiting(self.mode) => {
1040 self.clear_operator(window, cx);
1041 self.stop_recording_immediately(Box::new(ClearOperators), cx)
1042 }
1043 _ => {}
1044 }
1045 }
1046 }
1047
1048 fn handle_editor_event(
1049 &mut self,
1050 event: &EditorEvent,
1051 window: &mut Window,
1052 cx: &mut Context<Self>,
1053 ) {
1054 match event {
1055 EditorEvent::Focused => self.focused(true, window, cx),
1056 EditorEvent::Blurred => self.blurred(window, cx),
1057 EditorEvent::SelectionsChanged { local: true } => {
1058 self.local_selections_changed(window, cx);
1059 }
1060 EditorEvent::InputIgnored { text } => {
1061 self.input_ignored(text.clone(), window, cx);
1062 Vim::globals(cx).observe_insertion(text, None)
1063 }
1064 EditorEvent::InputHandled {
1065 text,
1066 utf16_range_to_replace: range_to_replace,
1067 } => Vim::globals(cx).observe_insertion(text, range_to_replace.clone()),
1068 EditorEvent::TransactionBegun { transaction_id } => {
1069 self.transaction_begun(*transaction_id, window, cx)
1070 }
1071 EditorEvent::TransactionUndone { transaction_id } => {
1072 self.transaction_undone(transaction_id, window, cx)
1073 }
1074 EditorEvent::Edited { .. } => self.push_to_change_list(window, cx),
1075 EditorEvent::FocusedIn => self.sync_vim_settings(window, cx),
1076 EditorEvent::CursorShapeChanged => self.cursor_shape_changed(window, cx),
1077 EditorEvent::PushedToNavHistory {
1078 anchor,
1079 is_deactivate,
1080 } => {
1081 self.update_editor(cx, |vim, editor, cx| {
1082 let mark = if *is_deactivate {
1083 "\"".to_string()
1084 } else {
1085 "'".to_string()
1086 };
1087 vim.set_mark(mark, vec![*anchor], editor.buffer(), window, cx);
1088 });
1089 }
1090 _ => {}
1091 }
1092 }
1093
1094 fn push_operator(&mut self, operator: Operator, window: &mut Window, cx: &mut Context<Self>) {
1095 if operator.starts_dot_recording() {
1096 self.start_recording(cx);
1097 }
1098 // Since these operations can only be entered with pre-operators,
1099 // we need to clear the previous operators when pushing,
1100 // so that the current stack is the most correct
1101 if matches!(
1102 operator,
1103 Operator::AddSurrounds { .. }
1104 | Operator::ChangeSurrounds { .. }
1105 | Operator::DeleteSurrounds
1106 | Operator::Exchange
1107 ) {
1108 self.operator_stack.clear();
1109 };
1110 self.operator_stack.push(operator);
1111 self.sync_vim_settings(window, cx);
1112 }
1113
1114 pub fn switch_mode(
1115 &mut self,
1116 mode: Mode,
1117 leave_selections: bool,
1118 window: &mut Window,
1119 cx: &mut Context<Self>,
1120 ) {
1121 if self.temp_mode && mode == Mode::Normal {
1122 self.temp_mode = false;
1123 self.switch_mode(Mode::Normal, leave_selections, window, cx);
1124 self.switch_mode(Mode::Insert, false, window, cx);
1125 return;
1126 } else if self.temp_mode
1127 && !matches!(mode, Mode::Visual | Mode::VisualLine | Mode::VisualBlock)
1128 {
1129 self.temp_mode = false;
1130 }
1131
1132 let last_mode = self.mode;
1133 let prior_mode = self.last_mode;
1134 let prior_tx = self.current_tx;
1135 self.status_label.take();
1136 self.last_mode = last_mode;
1137 self.mode = mode;
1138 self.operator_stack.clear();
1139 self.selected_register.take();
1140 self.cancel_running_command(window, cx);
1141 if mode == Mode::Normal || mode != last_mode {
1142 self.current_tx.take();
1143 self.current_anchor.take();
1144 self.update_editor(cx, |_, editor, _| {
1145 editor.clear_selection_drag_state();
1146 });
1147 }
1148 Vim::take_forced_motion(cx);
1149 if mode != Mode::Insert && mode != Mode::Replace {
1150 Vim::take_count(cx);
1151 }
1152
1153 // Sync editor settings like clip mode
1154 self.sync_vim_settings(window, cx);
1155
1156 if VimSettings::get_global(cx).toggle_relative_line_numbers
1157 && self.mode != self.last_mode
1158 && (self.mode == Mode::Insert || self.last_mode == Mode::Insert)
1159 {
1160 self.update_editor(cx, |vim, editor, cx| {
1161 let is_relative = vim.mode != Mode::Insert;
1162 editor.set_relative_line_number(Some(is_relative), cx)
1163 });
1164 }
1165 if HelixModeSetting::get_global(cx).0 {
1166 if self.mode == Mode::Normal {
1167 self.mode = Mode::HelixNormal
1168 } else if self.mode == Mode::Visual {
1169 self.mode = Mode::HelixSelect
1170 }
1171 }
1172
1173 if leave_selections {
1174 return;
1175 }
1176
1177 if !mode.is_visual() && last_mode.is_visual() {
1178 self.create_visual_marks(last_mode, window, cx);
1179 }
1180
1181 // Adjust selections
1182 self.update_editor(cx, |vim, editor, cx| {
1183 if last_mode != Mode::VisualBlock && last_mode.is_visual() && mode == Mode::VisualBlock
1184 {
1185 vim.visual_block_motion(true, editor, window, cx, |_, point, goal| {
1186 Some((point, goal))
1187 })
1188 }
1189 if (last_mode == Mode::Insert || last_mode == Mode::Replace)
1190 && let Some(prior_tx) = prior_tx
1191 {
1192 editor.group_until_transaction(prior_tx, cx)
1193 }
1194
1195 editor.change_selections(SelectionEffects::no_scroll(), window, cx, |s| {
1196 // we cheat with visual block mode and use multiple cursors.
1197 // the cost of this cheat is we need to convert back to a single
1198 // cursor whenever vim would.
1199 if last_mode == Mode::VisualBlock
1200 && (mode != Mode::VisualBlock && mode != Mode::Insert)
1201 {
1202 let tail = s.oldest_anchor().tail();
1203 let head = s.newest_anchor().head();
1204 s.select_anchor_ranges(vec![tail..head]);
1205 } else if last_mode == Mode::Insert
1206 && prior_mode == Mode::VisualBlock
1207 && mode != Mode::VisualBlock
1208 {
1209 let pos = s.first_anchor().head();
1210 s.select_anchor_ranges(vec![pos..pos])
1211 }
1212
1213 let snapshot = s.display_snapshot();
1214 if let Some(pending) = s.pending_anchor_mut()
1215 && pending.reversed
1216 && mode.is_visual()
1217 && !last_mode.is_visual()
1218 {
1219 let mut end = pending.end.to_point(&snapshot.buffer_snapshot());
1220 end = snapshot
1221 .buffer_snapshot()
1222 .clip_point(end + Point::new(0, 1), Bias::Right);
1223 pending.end = snapshot.buffer_snapshot().anchor_before(end);
1224 }
1225
1226 s.move_with(|map, selection| {
1227 if last_mode.is_visual() && !mode.is_visual() {
1228 let mut point = selection.head();
1229 if !selection.reversed && !selection.is_empty() {
1230 point = movement::left(map, selection.head());
1231 } else if selection.is_empty() {
1232 point = map.clip_point(point, Bias::Left);
1233 }
1234 selection.collapse_to(point, selection.goal)
1235 } else if !last_mode.is_visual() && mode.is_visual() && selection.is_empty() {
1236 selection.end = movement::right(map, selection.start);
1237 }
1238 });
1239 })
1240 });
1241 }
1242
1243 pub fn take_count(cx: &mut App) -> Option<usize> {
1244 let global_state = cx.global_mut::<VimGlobals>();
1245 if global_state.dot_replaying {
1246 return global_state.recorded_count;
1247 }
1248
1249 let count = if global_state.post_count.is_none() && global_state.pre_count.is_none() {
1250 return None;
1251 } else {
1252 Some(
1253 global_state.post_count.take().unwrap_or(1)
1254 * global_state.pre_count.take().unwrap_or(1),
1255 )
1256 };
1257
1258 if global_state.dot_recording {
1259 global_state.recorded_count = count;
1260 }
1261 count
1262 }
1263
1264 pub fn take_forced_motion(cx: &mut App) -> bool {
1265 let global_state = cx.global_mut::<VimGlobals>();
1266 let forced_motion = global_state.forced_motion;
1267 global_state.forced_motion = false;
1268 forced_motion
1269 }
1270
1271 pub fn cursor_shape(&self, cx: &mut App) -> CursorShape {
1272 let cursor_shape = VimSettings::get_global(cx).cursor_shape;
1273 match self.mode {
1274 Mode::Normal => {
1275 if let Some(operator) = self.operator_stack.last() {
1276 match operator {
1277 // Navigation operators -> Block cursor
1278 Operator::FindForward { .. }
1279 | Operator::FindBackward { .. }
1280 | Operator::Mark
1281 | Operator::Jump { .. }
1282 | Operator::Register
1283 | Operator::RecordRegister
1284 | Operator::ReplayRegister => CursorShape::Block,
1285
1286 // All other operators -> Underline cursor
1287 _ => CursorShape::Underline,
1288 }
1289 } else {
1290 cursor_shape.normal.unwrap_or(CursorShape::Block)
1291 }
1292 }
1293 Mode::HelixNormal => cursor_shape.normal.unwrap_or(CursorShape::Block),
1294 Mode::Replace => cursor_shape.replace.unwrap_or(CursorShape::Underline),
1295 Mode::Visual | Mode::VisualLine | Mode::VisualBlock | Mode::HelixSelect => {
1296 cursor_shape.visual.unwrap_or(CursorShape::Block)
1297 }
1298 Mode::Insert => cursor_shape.insert.unwrap_or({
1299 let editor_settings = EditorSettings::get_global(cx);
1300 editor_settings.cursor_shape.unwrap_or_default()
1301 }),
1302 }
1303 }
1304
1305 pub fn editor_input_enabled(&self) -> bool {
1306 match self.mode {
1307 Mode::Insert => {
1308 if let Some(operator) = self.operator_stack.last() {
1309 !operator.is_waiting(self.mode)
1310 } else {
1311 true
1312 }
1313 }
1314 Mode::Normal
1315 | Mode::HelixNormal
1316 | Mode::Replace
1317 | Mode::Visual
1318 | Mode::VisualLine
1319 | Mode::VisualBlock
1320 | Mode::HelixSelect => false,
1321 }
1322 }
1323
1324 pub fn should_autoindent(&self) -> bool {
1325 !(self.mode == Mode::Insert && self.last_mode == Mode::VisualBlock)
1326 }
1327
1328 pub fn clip_at_line_ends(&self) -> bool {
1329 match self.mode {
1330 Mode::Insert
1331 | Mode::Visual
1332 | Mode::VisualLine
1333 | Mode::VisualBlock
1334 | Mode::Replace
1335 | Mode::HelixNormal
1336 | Mode::HelixSelect => false,
1337 Mode::Normal => true,
1338 }
1339 }
1340
1341 pub fn extend_key_context(&self, context: &mut KeyContext, cx: &App) {
1342 let mut mode = match self.mode {
1343 Mode::Normal => "normal",
1344 Mode::Visual | Mode::VisualLine | Mode::VisualBlock => "visual",
1345 Mode::Insert => "insert",
1346 Mode::Replace => "replace",
1347 Mode::HelixNormal => "helix_normal",
1348 Mode::HelixSelect => "helix_select",
1349 }
1350 .to_string();
1351
1352 let mut operator_id = "none";
1353
1354 let active_operator = self.active_operator();
1355 if active_operator.is_none() && cx.global::<VimGlobals>().pre_count.is_some()
1356 || active_operator.is_some() && cx.global::<VimGlobals>().post_count.is_some()
1357 {
1358 context.add("VimCount");
1359 }
1360
1361 if let Some(active_operator) = active_operator {
1362 if active_operator.is_waiting(self.mode) {
1363 if matches!(active_operator, Operator::Literal { .. }) {
1364 mode = "literal".to_string();
1365 } else {
1366 mode = "waiting".to_string();
1367 }
1368 } else {
1369 operator_id = active_operator.id();
1370 mode = "operator".to_string();
1371 }
1372 }
1373
1374 if mode == "normal"
1375 || mode == "visual"
1376 || mode == "operator"
1377 || mode == "helix_normal"
1378 || mode == "helix_select"
1379 {
1380 context.add("VimControl");
1381 }
1382 context.set("vim_mode", mode);
1383 context.set("vim_operator", operator_id);
1384 }
1385
1386 fn focused(&mut self, preserve_selection: bool, window: &mut Window, cx: &mut Context<Self>) {
1387 let Some(editor) = self.editor() else {
1388 return;
1389 };
1390 let newest_selection_empty = editor.update(cx, |editor, cx| {
1391 editor
1392 .selections
1393 .newest::<usize>(&editor.display_snapshot(cx))
1394 .is_empty()
1395 });
1396 let editor = editor.read(cx);
1397 let editor_mode = editor.mode();
1398
1399 if editor_mode.is_full()
1400 && !newest_selection_empty
1401 && self.mode == Mode::Normal
1402 // When following someone, don't switch vim mode.
1403 && editor.leader_id().is_none()
1404 {
1405 if preserve_selection {
1406 self.switch_mode(Mode::Visual, true, window, cx);
1407 } else {
1408 self.update_editor(cx, |_, editor, cx| {
1409 editor.set_clip_at_line_ends(false, cx);
1410 editor.change_selections(SelectionEffects::no_scroll(), window, cx, |s| {
1411 s.move_with(|_, selection| {
1412 selection.collapse_to(selection.start, selection.goal)
1413 })
1414 });
1415 });
1416 }
1417 }
1418
1419 cx.emit(VimEvent::Focused);
1420 self.sync_vim_settings(window, cx);
1421
1422 if VimSettings::get_global(cx).toggle_relative_line_numbers {
1423 if let Some(old_vim) = Vim::globals(cx).focused_vim() {
1424 if old_vim.entity_id() != cx.entity().entity_id() {
1425 old_vim.update(cx, |vim, cx| {
1426 vim.update_editor(cx, |_, editor, cx| {
1427 editor.set_relative_line_number(None, cx)
1428 });
1429 });
1430
1431 self.update_editor(cx, |vim, editor, cx| {
1432 let is_relative = vim.mode != Mode::Insert;
1433 editor.set_relative_line_number(Some(is_relative), cx)
1434 });
1435 }
1436 } else {
1437 self.update_editor(cx, |vim, editor, cx| {
1438 let is_relative = vim.mode != Mode::Insert;
1439 editor.set_relative_line_number(Some(is_relative), cx)
1440 });
1441 }
1442 }
1443 Vim::globals(cx).focused_vim = Some(cx.entity().downgrade());
1444 }
1445
1446 fn blurred(&mut self, window: &mut Window, cx: &mut Context<Self>) {
1447 self.stop_recording_immediately(NormalBefore.boxed_clone(), cx);
1448 self.store_visual_marks(window, cx);
1449 self.clear_operator(window, cx);
1450 self.update_editor(cx, |vim, editor, cx| {
1451 if vim.cursor_shape(cx) == CursorShape::Block {
1452 editor.set_cursor_shape(CursorShape::Hollow, cx);
1453 }
1454 });
1455 }
1456
1457 fn cursor_shape_changed(&mut self, _: &mut Window, cx: &mut Context<Self>) {
1458 self.update_editor(cx, |vim, editor, cx| {
1459 editor.set_cursor_shape(vim.cursor_shape(cx), cx);
1460 });
1461 }
1462
1463 fn update_editor<S>(
1464 &mut self,
1465 cx: &mut Context<Self>,
1466 update: impl FnOnce(&mut Self, &mut Editor, &mut Context<Editor>) -> S,
1467 ) -> Option<S> {
1468 let editor = self.editor.upgrade()?;
1469 Some(editor.update(cx, |editor, cx| update(self, editor, cx)))
1470 }
1471
1472 fn editor_selections(&mut self, _: &mut Window, cx: &mut Context<Self>) -> Vec<Range<Anchor>> {
1473 self.update_editor(cx, |_, editor, _| {
1474 editor
1475 .selections
1476 .disjoint_anchors_arc()
1477 .iter()
1478 .map(|selection| selection.tail()..selection.head())
1479 .collect()
1480 })
1481 .unwrap_or_default()
1482 }
1483
1484 fn editor_cursor_word(
1485 &mut self,
1486 window: &mut Window,
1487 cx: &mut Context<Self>,
1488 ) -> Option<String> {
1489 self.update_editor(cx, |_, editor, cx| {
1490 let snapshot = &editor.snapshot(window, cx);
1491 let selection = editor
1492 .selections
1493 .newest::<usize>(&snapshot.display_snapshot);
1494
1495 let snapshot = snapshot.buffer_snapshot();
1496 let (range, kind) =
1497 snapshot.surrounding_word(selection.start, Some(CharScopeContext::Completion));
1498 if kind == Some(CharKind::Word) {
1499 let text: String = snapshot.text_for_range(range).collect();
1500 if !text.trim().is_empty() {
1501 return Some(text);
1502 }
1503 }
1504
1505 None
1506 })
1507 .unwrap_or_default()
1508 }
1509
1510 /// When doing an action that modifies the buffer, we start recording so that `.`
1511 /// will replay the action.
1512 pub fn start_recording(&mut self, cx: &mut Context<Self>) {
1513 Vim::update_globals(cx, |globals, cx| {
1514 if !globals.dot_replaying {
1515 globals.dot_recording = true;
1516 globals.recording_actions = Default::default();
1517 globals.recorded_count = None;
1518
1519 let selections = self.editor().map(|editor| {
1520 editor.update(cx, |editor, cx| {
1521 let snapshot = editor.display_snapshot(cx);
1522
1523 (
1524 editor.selections.oldest::<Point>(&snapshot),
1525 editor.selections.newest::<Point>(&snapshot),
1526 )
1527 })
1528 });
1529
1530 if let Some((oldest, newest)) = selections {
1531 globals.recorded_selection = match self.mode {
1532 Mode::Visual if newest.end.row == newest.start.row => {
1533 RecordedSelection::SingleLine {
1534 cols: newest.end.column - newest.start.column,
1535 }
1536 }
1537 Mode::Visual => RecordedSelection::Visual {
1538 rows: newest.end.row - newest.start.row,
1539 cols: newest.end.column,
1540 },
1541 Mode::VisualLine => RecordedSelection::VisualLine {
1542 rows: newest.end.row - newest.start.row,
1543 },
1544 Mode::VisualBlock => RecordedSelection::VisualBlock {
1545 rows: newest.end.row.abs_diff(oldest.start.row),
1546 cols: newest.end.column.abs_diff(oldest.start.column),
1547 },
1548 _ => RecordedSelection::None,
1549 }
1550 } else {
1551 globals.recorded_selection = RecordedSelection::None;
1552 }
1553 }
1554 })
1555 }
1556
1557 pub fn stop_replaying(&mut self, cx: &mut Context<Self>) {
1558 let globals = Vim::globals(cx);
1559 globals.dot_replaying = false;
1560 if let Some(replayer) = globals.replayer.take() {
1561 replayer.stop();
1562 }
1563 }
1564
1565 /// When finishing an action that modifies the buffer, stop recording.
1566 /// as you usually call this within a keystroke handler we also ensure that
1567 /// the current action is recorded.
1568 pub fn stop_recording(&mut self, cx: &mut Context<Self>) {
1569 let globals = Vim::globals(cx);
1570 if globals.dot_recording {
1571 globals.stop_recording_after_next_action = true;
1572 }
1573 self.exit_temporary_mode = self.temp_mode;
1574 }
1575
1576 /// Stops recording actions immediately rather than waiting until after the
1577 /// next action to stop recording.
1578 ///
1579 /// This doesn't include the current action.
1580 pub fn stop_recording_immediately(&mut self, action: Box<dyn Action>, cx: &mut Context<Self>) {
1581 let globals = Vim::globals(cx);
1582 if globals.dot_recording {
1583 globals
1584 .recording_actions
1585 .push(ReplayableAction::Action(action.boxed_clone()));
1586 globals.recorded_actions = mem::take(&mut globals.recording_actions);
1587 globals.dot_recording = false;
1588 globals.stop_recording_after_next_action = false;
1589 }
1590 self.exit_temporary_mode = self.temp_mode;
1591 }
1592
1593 /// Explicitly record one action (equivalents to start_recording and stop_recording)
1594 pub fn record_current_action(&mut self, cx: &mut Context<Self>) {
1595 self.start_recording(cx);
1596 self.stop_recording(cx);
1597 }
1598
1599 fn push_count_digit(&mut self, number: usize, window: &mut Window, cx: &mut Context<Self>) {
1600 if self.active_operator().is_some() {
1601 let post_count = Vim::globals(cx).post_count.unwrap_or(0);
1602
1603 Vim::globals(cx).post_count = Some(
1604 post_count
1605 .checked_mul(10)
1606 .and_then(|post_count| post_count.checked_add(number))
1607 .filter(|post_count| *post_count < isize::MAX as usize)
1608 .unwrap_or(post_count),
1609 )
1610 } else {
1611 let pre_count = Vim::globals(cx).pre_count.unwrap_or(0);
1612
1613 Vim::globals(cx).pre_count = Some(
1614 pre_count
1615 .checked_mul(10)
1616 .and_then(|pre_count| pre_count.checked_add(number))
1617 .filter(|pre_count| *pre_count < isize::MAX as usize)
1618 .unwrap_or(pre_count),
1619 )
1620 }
1621 // update the keymap so that 0 works
1622 self.sync_vim_settings(window, cx)
1623 }
1624
1625 fn select_register(&mut self, register: Arc<str>, window: &mut Window, cx: &mut Context<Self>) {
1626 if register.chars().count() == 1 {
1627 self.selected_register
1628 .replace(register.chars().next().unwrap());
1629 }
1630 self.operator_stack.clear();
1631 self.sync_vim_settings(window, cx);
1632 }
1633
1634 fn maybe_pop_operator(&mut self) -> Option<Operator> {
1635 self.operator_stack.pop()
1636 }
1637
1638 fn pop_operator(&mut self, window: &mut Window, cx: &mut Context<Self>) -> Operator {
1639 let popped_operator = self.operator_stack.pop()
1640 .expect("Operator popped when no operator was on the stack. This likely means there is an invalid keymap config");
1641 self.sync_vim_settings(window, cx);
1642 popped_operator
1643 }
1644
1645 fn clear_operator(&mut self, window: &mut Window, cx: &mut Context<Self>) {
1646 Vim::take_count(cx);
1647 Vim::take_forced_motion(cx);
1648 self.selected_register.take();
1649 self.operator_stack.clear();
1650 self.sync_vim_settings(window, cx);
1651 }
1652
1653 fn active_operator(&self) -> Option<Operator> {
1654 self.operator_stack.last().cloned()
1655 }
1656
1657 fn transaction_begun(
1658 &mut self,
1659 transaction_id: TransactionId,
1660 _window: &mut Window,
1661 _: &mut Context<Self>,
1662 ) {
1663 let mode = if (self.mode == Mode::Insert
1664 || self.mode == Mode::Replace
1665 || self.mode == Mode::Normal)
1666 && self.current_tx.is_none()
1667 {
1668 self.current_tx = Some(transaction_id);
1669 self.last_mode
1670 } else {
1671 self.mode
1672 };
1673 if mode == Mode::VisualLine || mode == Mode::VisualBlock {
1674 self.undo_modes.insert(transaction_id, mode);
1675 }
1676 }
1677
1678 fn transaction_undone(
1679 &mut self,
1680 transaction_id: &TransactionId,
1681 window: &mut Window,
1682 cx: &mut Context<Self>,
1683 ) {
1684 match self.mode {
1685 Mode::VisualLine | Mode::VisualBlock | Mode::Visual | Mode::HelixSelect => {
1686 self.update_editor(cx, |vim, editor, cx| {
1687 let original_mode = vim.undo_modes.get(transaction_id);
1688 editor.change_selections(SelectionEffects::no_scroll(), window, cx, |s| {
1689 match original_mode {
1690 Some(Mode::VisualLine) => {
1691 s.move_with(|map, selection| {
1692 selection.collapse_to(
1693 map.prev_line_boundary(selection.start.to_point(map)).1,
1694 SelectionGoal::None,
1695 )
1696 });
1697 }
1698 Some(Mode::VisualBlock) => {
1699 let mut first = s.first_anchor();
1700 first.collapse_to(first.start, first.goal);
1701 s.select_anchors(vec![first]);
1702 }
1703 _ => {
1704 s.move_with(|map, selection| {
1705 selection.collapse_to(
1706 map.clip_at_line_end(selection.start),
1707 selection.goal,
1708 );
1709 });
1710 }
1711 }
1712 });
1713 });
1714 self.switch_mode(Mode::Normal, true, window, cx)
1715 }
1716 Mode::Normal => {
1717 self.update_editor(cx, |_, editor, cx| {
1718 editor.change_selections(SelectionEffects::no_scroll(), window, cx, |s| {
1719 s.move_with(|map, selection| {
1720 selection
1721 .collapse_to(map.clip_at_line_end(selection.end), selection.goal)
1722 })
1723 })
1724 });
1725 }
1726 Mode::Insert | Mode::Replace | Mode::HelixNormal => {}
1727 }
1728 }
1729
1730 fn local_selections_changed(&mut self, window: &mut Window, cx: &mut Context<Self>) {
1731 let Some(editor) = self.editor() else { return };
1732
1733 if editor.read(cx).leader_id().is_some() {
1734 return;
1735 }
1736
1737 let newest = editor.read(cx).selections.newest_anchor().clone();
1738 let is_multicursor = editor.read(cx).selections.count() > 1;
1739 if self.mode == Mode::Insert && self.current_tx.is_some() {
1740 if self.current_anchor.is_none() {
1741 self.current_anchor = Some(newest);
1742 } else if self.current_anchor.as_ref().unwrap() != &newest
1743 && let Some(tx_id) = self.current_tx.take()
1744 {
1745 self.update_editor(cx, |_, editor, cx| {
1746 editor.group_until_transaction(tx_id, cx)
1747 });
1748 }
1749 } else if self.mode == Mode::Normal && newest.start != newest.end {
1750 if matches!(newest.goal, SelectionGoal::HorizontalRange { .. }) {
1751 self.switch_mode(Mode::VisualBlock, false, window, cx);
1752 } else {
1753 self.switch_mode(Mode::Visual, false, window, cx)
1754 }
1755 } else if newest.start == newest.end
1756 && !is_multicursor
1757 && [Mode::Visual, Mode::VisualLine, Mode::VisualBlock].contains(&self.mode)
1758 {
1759 self.switch_mode(Mode::Normal, false, window, cx);
1760 }
1761 }
1762
1763 fn input_ignored(&mut self, text: Arc<str>, window: &mut Window, cx: &mut Context<Self>) {
1764 if text.is_empty() {
1765 return;
1766 }
1767
1768 match self.active_operator() {
1769 Some(Operator::FindForward { before, multiline }) => {
1770 let find = Motion::FindForward {
1771 before,
1772 char: text.chars().next().unwrap(),
1773 mode: if multiline {
1774 FindRange::MultiLine
1775 } else {
1776 FindRange::SingleLine
1777 },
1778 smartcase: VimSettings::get_global(cx).use_smartcase_find,
1779 };
1780 Vim::globals(cx).last_find = Some(find.clone());
1781 self.motion(find, window, cx)
1782 }
1783 Some(Operator::FindBackward { after, multiline }) => {
1784 let find = Motion::FindBackward {
1785 after,
1786 char: text.chars().next().unwrap(),
1787 mode: if multiline {
1788 FindRange::MultiLine
1789 } else {
1790 FindRange::SingleLine
1791 },
1792 smartcase: VimSettings::get_global(cx).use_smartcase_find,
1793 };
1794 Vim::globals(cx).last_find = Some(find.clone());
1795 self.motion(find, window, cx)
1796 }
1797 Some(Operator::Sneak { first_char }) => {
1798 if let Some(first_char) = first_char {
1799 if let Some(second_char) = text.chars().next() {
1800 let sneak = Motion::Sneak {
1801 first_char,
1802 second_char,
1803 smartcase: VimSettings::get_global(cx).use_smartcase_find,
1804 };
1805 Vim::globals(cx).last_find = Some(sneak.clone());
1806 self.motion(sneak, window, cx)
1807 }
1808 } else {
1809 let first_char = text.chars().next();
1810 self.pop_operator(window, cx);
1811 self.push_operator(Operator::Sneak { first_char }, window, cx);
1812 }
1813 }
1814 Some(Operator::SneakBackward { first_char }) => {
1815 if let Some(first_char) = first_char {
1816 if let Some(second_char) = text.chars().next() {
1817 let sneak = Motion::SneakBackward {
1818 first_char,
1819 second_char,
1820 smartcase: VimSettings::get_global(cx).use_smartcase_find,
1821 };
1822 Vim::globals(cx).last_find = Some(sneak.clone());
1823 self.motion(sneak, window, cx)
1824 }
1825 } else {
1826 let first_char = text.chars().next();
1827 self.pop_operator(window, cx);
1828 self.push_operator(Operator::SneakBackward { first_char }, window, cx);
1829 }
1830 }
1831 Some(Operator::Replace) => match self.mode {
1832 Mode::Normal => self.normal_replace(text, window, cx),
1833 Mode::Visual | Mode::VisualLine | Mode::VisualBlock => {
1834 self.visual_replace(text, window, cx)
1835 }
1836 Mode::HelixNormal => self.helix_replace(&text, window, cx),
1837 _ => self.clear_operator(window, cx),
1838 },
1839 Some(Operator::Digraph { first_char }) => {
1840 if let Some(first_char) = first_char {
1841 if let Some(second_char) = text.chars().next() {
1842 self.insert_digraph(first_char, second_char, window, cx);
1843 }
1844 } else {
1845 let first_char = text.chars().next();
1846 self.pop_operator(window, cx);
1847 self.push_operator(Operator::Digraph { first_char }, window, cx);
1848 }
1849 }
1850 Some(Operator::Literal { prefix }) => {
1851 self.handle_literal_input(prefix.unwrap_or_default(), &text, window, cx)
1852 }
1853 Some(Operator::AddSurrounds { target }) => match self.mode {
1854 Mode::Normal => {
1855 if let Some(target) = target {
1856 self.add_surrounds(text, target, window, cx);
1857 self.clear_operator(window, cx);
1858 }
1859 }
1860 Mode::Visual | Mode::VisualLine | Mode::VisualBlock => {
1861 self.add_surrounds(text, SurroundsType::Selection, window, cx);
1862 self.clear_operator(window, cx);
1863 }
1864 _ => self.clear_operator(window, cx),
1865 },
1866 Some(Operator::ChangeSurrounds { target, opening }) => match self.mode {
1867 Mode::Normal => {
1868 if let Some(target) = target {
1869 self.change_surrounds(text, target, opening, window, cx);
1870 self.clear_operator(window, cx);
1871 }
1872 }
1873 _ => self.clear_operator(window, cx),
1874 },
1875 Some(Operator::DeleteSurrounds) => match self.mode {
1876 Mode::Normal => {
1877 self.delete_surrounds(text, window, cx);
1878 self.clear_operator(window, cx);
1879 }
1880 _ => self.clear_operator(window, cx),
1881 },
1882 Some(Operator::Mark) => self.create_mark(text, window, cx),
1883 Some(Operator::RecordRegister) => {
1884 self.record_register(text.chars().next().unwrap(), window, cx)
1885 }
1886 Some(Operator::ReplayRegister) => {
1887 self.replay_register(text.chars().next().unwrap(), window, cx)
1888 }
1889 Some(Operator::Register) => match self.mode {
1890 Mode::Insert => {
1891 self.update_editor(cx, |_, editor, cx| {
1892 if let Some(register) = Vim::update_globals(cx, |globals, cx| {
1893 globals.read_register(text.chars().next(), Some(editor), cx)
1894 }) {
1895 editor.do_paste(
1896 ®ister.text.to_string(),
1897 register.clipboard_selections,
1898 false,
1899 window,
1900 cx,
1901 )
1902 }
1903 });
1904 self.clear_operator(window, cx);
1905 }
1906 _ => {
1907 self.select_register(text, window, cx);
1908 }
1909 },
1910 Some(Operator::Jump { line }) => self.jump(text, line, true, window, cx),
1911 _ => {
1912 if self.mode == Mode::Replace {
1913 self.multi_replace(text, window, cx)
1914 }
1915
1916 if self.mode == Mode::Normal {
1917 self.update_editor(cx, |_, editor, cx| {
1918 editor.accept_edit_prediction(
1919 &editor::actions::AcceptEditPrediction {},
1920 window,
1921 cx,
1922 );
1923 });
1924 }
1925 }
1926 }
1927 }
1928
1929 fn sync_vim_settings(&mut self, window: &mut Window, cx: &mut Context<Self>) {
1930 self.update_editor(cx, |vim, editor, cx| {
1931 editor.set_cursor_shape(vim.cursor_shape(cx), cx);
1932 editor.set_clip_at_line_ends(vim.clip_at_line_ends(), cx);
1933 editor.set_collapse_matches(true);
1934 editor.set_input_enabled(vim.editor_input_enabled());
1935 editor.set_autoindent(vim.should_autoindent());
1936 editor
1937 .selections
1938 .set_line_mode(matches!(vim.mode, Mode::VisualLine));
1939
1940 let hide_edit_predictions = !matches!(vim.mode, Mode::Insert | Mode::Replace);
1941 editor.set_edit_predictions_hidden_for_vim_mode(hide_edit_predictions, window, cx);
1942 });
1943 cx.notify()
1944 }
1945}
1946
1947#[derive(RegisterSetting)]
1948struct VimSettings {
1949 pub default_mode: Mode,
1950 pub toggle_relative_line_numbers: bool,
1951 pub use_system_clipboard: settings::UseSystemClipboard,
1952 pub use_smartcase_find: bool,
1953 pub custom_digraphs: HashMap<String, Arc<str>>,
1954 pub highlight_on_yank_duration: u64,
1955 pub cursor_shape: CursorShapeSettings,
1956}
1957
1958/// The settings for cursor shape.
1959#[derive(Copy, Clone, Debug, PartialEq, Eq)]
1960pub struct CursorShapeSettings {
1961 /// Cursor shape for the normal mode.
1962 ///
1963 /// Default: block
1964 pub normal: Option<CursorShape>,
1965 /// Cursor shape for the replace mode.
1966 ///
1967 /// Default: underline
1968 pub replace: Option<CursorShape>,
1969 /// Cursor shape for the visual mode.
1970 ///
1971 /// Default: block
1972 pub visual: Option<CursorShape>,
1973 /// Cursor shape for the insert mode.
1974 ///
1975 /// The default value follows the primary cursor_shape.
1976 pub insert: Option<CursorShape>,
1977}
1978
1979impl From<settings::CursorShapeSettings> for CursorShapeSettings {
1980 fn from(settings: settings::CursorShapeSettings) -> Self {
1981 Self {
1982 normal: settings.normal.map(Into::into),
1983 replace: settings.replace.map(Into::into),
1984 visual: settings.visual.map(Into::into),
1985 insert: settings.insert.map(Into::into),
1986 }
1987 }
1988}
1989
1990impl From<settings::ModeContent> for Mode {
1991 fn from(mode: ModeContent) -> Self {
1992 match mode {
1993 ModeContent::Normal => Self::Normal,
1994 ModeContent::Insert => Self::Insert,
1995 }
1996 }
1997}
1998
1999impl Settings for VimSettings {
2000 fn from_settings(content: &settings::SettingsContent) -> Self {
2001 let vim = content.vim.clone().unwrap();
2002 Self {
2003 default_mode: vim.default_mode.unwrap().into(),
2004 toggle_relative_line_numbers: vim.toggle_relative_line_numbers.unwrap(),
2005 use_system_clipboard: vim.use_system_clipboard.unwrap(),
2006 use_smartcase_find: vim.use_smartcase_find.unwrap(),
2007 custom_digraphs: vim.custom_digraphs.unwrap(),
2008 highlight_on_yank_duration: vim.highlight_on_yank_duration.unwrap(),
2009 cursor_shape: vim.cursor_shape.unwrap().into(),
2010 }
2011 }
2012}