1use crate::command::command_interceptor;
2use crate::motion::MotionKind;
3use crate::normal::repeat::Replayer;
4use crate::surrounds::SurroundsType;
5use crate::{ToggleMarksView, ToggleRegistersView, UseSystemClipboard, Vim, VimAddon, VimSettings};
6use crate::{motion::Motion, object::Object};
7use anyhow::Result;
8use collections::HashMap;
9use command_palette_hooks::{CommandPaletteFilter, CommandPaletteInterceptor};
10use db::{
11 sqlez::{domain::Domain, thread_safe_connection::ThreadSafeConnection},
12 sqlez_macros::sql,
13};
14use editor::display_map::{is_invisible, replacement};
15use editor::{Anchor, ClipboardSelection, Editor, MultiBuffer, ToPoint as EditorToPoint};
16use gpui::{
17 Action, App, AppContext, BorrowAppContext, ClipboardEntry, ClipboardItem, DismissEvent, Entity,
18 EntityId, Global, HighlightStyle, StyledText, Subscription, Task, TextStyle, WeakEntity,
19};
20use language::{Buffer, BufferEvent, BufferId, Chunk, Point};
21use multi_buffer::MultiBufferRow;
22use picker::{Picker, PickerDelegate};
23use project::{Project, ProjectItem, ProjectPath};
24use serde::{Deserialize, Serialize};
25use settings::{Settings, SettingsStore};
26use std::borrow::BorrowMut;
27use std::collections::HashSet;
28use std::path::Path;
29use std::{fmt::Display, ops::Range, sync::Arc};
30use text::{Bias, ToPoint};
31use theme::ThemeSettings;
32use ui::{
33 ActiveTheme, Context, Div, FluentBuilder, KeyBinding, ParentElement, SharedString, Styled,
34 StyledTypography, Window, h_flex, rems,
35};
36use util::ResultExt;
37use util::rel_path::RelPath;
38use workspace::searchable::Direction;
39use workspace::{Workspace, WorkspaceDb, WorkspaceId};
40
41#[derive(Clone, Copy, Debug, PartialEq, Serialize, Deserialize)]
42pub enum Mode {
43 Normal,
44 Insert,
45 Replace,
46 Visual,
47 VisualLine,
48 VisualBlock,
49 HelixNormal,
50 HelixSelect,
51}
52
53impl Display for Mode {
54 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
55 match self {
56 Mode::Normal => write!(f, "NORMAL"),
57 Mode::Insert => write!(f, "INSERT"),
58 Mode::Replace => write!(f, "REPLACE"),
59 Mode::Visual => write!(f, "VISUAL"),
60 Mode::VisualLine => write!(f, "VISUAL LINE"),
61 Mode::VisualBlock => write!(f, "VISUAL BLOCK"),
62 Mode::HelixNormal => write!(f, "NORMAL"),
63 Mode::HelixSelect => write!(f, "SELECT"),
64 }
65 }
66}
67
68impl Mode {
69 pub fn is_visual(&self) -> bool {
70 match self {
71 Self::Visual | Self::VisualLine | Self::VisualBlock | Self::HelixSelect => true,
72 Self::Normal | Self::Insert | Self::Replace | Self::HelixNormal => false,
73 }
74 }
75}
76
77impl Default for Mode {
78 fn default() -> Self {
79 Self::Normal
80 }
81}
82
83#[derive(Clone, Debug, PartialEq)]
84pub enum Operator {
85 Change,
86 Delete,
87 Yank,
88 Replace,
89 Object {
90 around: bool,
91 },
92 FindForward {
93 before: bool,
94 multiline: bool,
95 },
96 FindBackward {
97 after: bool,
98 multiline: bool,
99 },
100 Sneak {
101 first_char: Option<char>,
102 },
103 SneakBackward {
104 first_char: Option<char>,
105 },
106 AddSurrounds {
107 // Typically no need to configure this as `SendKeystrokes` can be used - see #23088.
108 target: Option<SurroundsType>,
109 },
110 ChangeSurrounds {
111 target: Option<Object>,
112 /// Represents whether the opening bracket was used for the target
113 /// object.
114 opening: bool,
115 },
116 DeleteSurrounds,
117 Mark,
118 Jump {
119 line: bool,
120 },
121 Indent,
122 Outdent,
123 AutoIndent,
124 Rewrap,
125 ShellCommand,
126 Lowercase,
127 Uppercase,
128 OppositeCase,
129 Rot13,
130 Rot47,
131 Digraph {
132 first_char: Option<char>,
133 },
134 Literal {
135 prefix: Option<String>,
136 },
137 Register,
138 RecordRegister,
139 ReplayRegister,
140 ToggleComments,
141 ReplaceWithRegister,
142 Exchange,
143 HelixMatch,
144 HelixNext {
145 around: bool,
146 },
147 HelixPrevious {
148 around: bool,
149 },
150}
151
152#[derive(Default, Clone, Debug)]
153pub enum RecordedSelection {
154 #[default]
155 None,
156 Visual {
157 rows: u32,
158 cols: u32,
159 },
160 SingleLine {
161 cols: u32,
162 },
163 VisualBlock {
164 rows: u32,
165 cols: u32,
166 },
167 VisualLine {
168 rows: u32,
169 },
170}
171
172#[derive(Default, Clone, Debug)]
173pub struct Register {
174 pub(crate) text: SharedString,
175 pub(crate) clipboard_selections: Option<Vec<ClipboardSelection>>,
176}
177
178impl From<Register> for ClipboardItem {
179 fn from(register: Register) -> Self {
180 if let Some(clipboard_selections) = register.clipboard_selections {
181 ClipboardItem::new_string_with_json_metadata(register.text.into(), clipboard_selections)
182 } else {
183 ClipboardItem::new_string(register.text.into())
184 }
185 }
186}
187
188impl From<ClipboardItem> for Register {
189 fn from(item: ClipboardItem) -> Self {
190 // For now, we don't store metadata for multiple entries.
191 match item.entries().first() {
192 Some(ClipboardEntry::String(value)) if item.entries().len() == 1 => Register {
193 text: value.text().to_owned().into(),
194 clipboard_selections: value.metadata_json::<Vec<ClipboardSelection>>(),
195 },
196 // For now, registers can't store images. This could change in the future.
197 _ => Register::default(),
198 }
199 }
200}
201
202impl From<String> for Register {
203 fn from(text: String) -> Self {
204 Register {
205 text: text.into(),
206 clipboard_selections: None,
207 }
208 }
209}
210
211#[derive(Default)]
212pub struct VimGlobals {
213 pub last_find: Option<Motion>,
214
215 pub dot_recording: bool,
216 pub dot_replaying: bool,
217
218 /// pre_count is the number before an operator is specified (3 in 3d2d)
219 pub pre_count: Option<usize>,
220 /// post_count is the number after an operator is specified (2 in 3d2d)
221 pub post_count: Option<usize>,
222 pub forced_motion: bool,
223 pub stop_recording_after_next_action: bool,
224 pub ignore_current_insertion: bool,
225 pub recorded_count: Option<usize>,
226 pub recording_actions: Vec<ReplayableAction>,
227 pub recorded_actions: Vec<ReplayableAction>,
228 pub recorded_selection: RecordedSelection,
229
230 pub recording_register: Option<char>,
231 pub last_recorded_register: Option<char>,
232 pub last_replayed_register: Option<char>,
233 pub replayer: Option<Replayer>,
234
235 pub last_yank: Option<SharedString>,
236 pub registers: HashMap<char, Register>,
237 pub recordings: HashMap<char, Vec<ReplayableAction>>,
238
239 pub focused_vim: Option<WeakEntity<Vim>>,
240
241 pub marks: HashMap<EntityId, Entity<MarksState>>,
242}
243
244pub struct MarksState {
245 workspace: WeakEntity<Workspace>,
246
247 multibuffer_marks: HashMap<EntityId, HashMap<String, Vec<Anchor>>>,
248 buffer_marks: HashMap<BufferId, HashMap<String, Vec<text::Anchor>>>,
249 watched_buffers: HashMap<BufferId, (MarkLocation, Subscription, Subscription)>,
250
251 serialized_marks: HashMap<Arc<Path>, HashMap<String, Vec<Point>>>,
252 global_marks: HashMap<String, MarkLocation>,
253
254 _subscription: Subscription,
255}
256
257#[derive(Debug, PartialEq, Eq, Clone)]
258pub enum MarkLocation {
259 Buffer(EntityId),
260 Path(Arc<Path>),
261}
262
263pub enum Mark {
264 Local(Vec<Anchor>),
265 Buffer(EntityId, Vec<Anchor>),
266 Path(Arc<Path>, Vec<Point>),
267}
268
269impl MarksState {
270 pub fn new(workspace: &Workspace, cx: &mut App) -> Entity<MarksState> {
271 cx.new(|cx| {
272 let buffer_store = workspace.project().read(cx).buffer_store().clone();
273 let subscription = cx.subscribe(&buffer_store, move |this: &mut Self, _, event, cx| {
274 if let project::buffer_store::BufferStoreEvent::BufferAdded(buffer) = event {
275 this.on_buffer_loaded(buffer, cx);
276 }
277 });
278
279 let mut this = Self {
280 workspace: workspace.weak_handle(),
281 multibuffer_marks: HashMap::default(),
282 buffer_marks: HashMap::default(),
283 watched_buffers: HashMap::default(),
284 serialized_marks: HashMap::default(),
285 global_marks: HashMap::default(),
286 _subscription: subscription,
287 };
288
289 this.load(cx);
290 this
291 })
292 }
293
294 fn workspace_id(&self, cx: &App) -> Option<WorkspaceId> {
295 self.workspace
296 .read_with(cx, |workspace, _| workspace.database_id())
297 .ok()
298 .flatten()
299 }
300
301 fn project(&self, cx: &App) -> Option<Entity<Project>> {
302 self.workspace
303 .read_with(cx, |workspace, _| workspace.project().clone())
304 .ok()
305 }
306
307 fn load(&mut self, cx: &mut Context<Self>) {
308 cx.spawn(async move |this, cx| {
309 let Some(workspace_id) = this.update(cx, |this, cx| this.workspace_id(cx))? else {
310 return Ok(());
311 };
312 let (marks, paths) = cx
313 .background_spawn(async move {
314 let marks = DB.get_marks(workspace_id)?;
315 let paths = DB.get_global_marks_paths(workspace_id)?;
316 anyhow::Ok((marks, paths))
317 })
318 .await?;
319 this.update(cx, |this, cx| this.loaded(marks, paths, cx))
320 })
321 .detach_and_log_err(cx);
322 }
323
324 fn loaded(
325 &mut self,
326 marks: Vec<SerializedMark>,
327 global_mark_paths: Vec<(String, Arc<Path>)>,
328 cx: &mut Context<Self>,
329 ) {
330 let Some(project) = self.project(cx) else {
331 return;
332 };
333
334 for mark in marks {
335 self.serialized_marks
336 .entry(mark.path)
337 .or_default()
338 .insert(mark.name, mark.points);
339 }
340
341 for (name, path) in global_mark_paths {
342 self.global_marks
343 .insert(name, MarkLocation::Path(path.clone()));
344
345 let project_path = project
346 .read(cx)
347 .worktrees(cx)
348 .filter_map(|worktree| {
349 let relative = path.strip_prefix(worktree.read(cx).abs_path()).ok()?;
350 let path = RelPath::new(relative, worktree.read(cx).path_style()).log_err()?;
351 Some(ProjectPath {
352 worktree_id: worktree.read(cx).id(),
353 path: path.into_arc(),
354 })
355 })
356 .next();
357 if let Some(buffer) = project_path
358 .and_then(|project_path| project.read(cx).get_open_buffer(&project_path, cx))
359 {
360 self.on_buffer_loaded(&buffer, cx)
361 }
362 }
363 }
364
365 pub fn on_buffer_loaded(&mut self, buffer_handle: &Entity<Buffer>, cx: &mut Context<Self>) {
366 let Some(project) = self.project(cx) else {
367 return;
368 };
369 let Some(project_path) = buffer_handle.read(cx).project_path(cx) else {
370 return;
371 };
372 let Some(abs_path) = project.read(cx).absolute_path(&project_path, cx) else {
373 return;
374 };
375 let abs_path: Arc<Path> = abs_path.into();
376
377 let Some(serialized_marks) = self.serialized_marks.get(&abs_path) else {
378 return;
379 };
380
381 let mut loaded_marks = HashMap::default();
382 let buffer = buffer_handle.read(cx);
383 for (name, points) in serialized_marks.iter() {
384 loaded_marks.insert(
385 name.clone(),
386 points
387 .iter()
388 .map(|point| buffer.anchor_before(buffer.clip_point(*point, Bias::Left)))
389 .collect(),
390 );
391 }
392 self.buffer_marks.insert(buffer.remote_id(), loaded_marks);
393 self.watch_buffer(MarkLocation::Path(abs_path), buffer_handle, cx)
394 }
395
396 fn serialize_buffer_marks(
397 &mut self,
398 path: Arc<Path>,
399 buffer: &Entity<Buffer>,
400 cx: &mut Context<Self>,
401 ) {
402 let new_points: HashMap<String, Vec<Point>> =
403 if let Some(anchors) = self.buffer_marks.get(&buffer.read(cx).remote_id()) {
404 anchors
405 .iter()
406 .map(|(name, anchors)| {
407 (
408 name.clone(),
409 buffer
410 .read(cx)
411 .summaries_for_anchors::<Point, _>(anchors)
412 .collect(),
413 )
414 })
415 .collect()
416 } else {
417 HashMap::default()
418 };
419 let old_points = self.serialized_marks.get(&path);
420 if old_points == Some(&new_points) {
421 return;
422 }
423 let mut to_write = HashMap::default();
424
425 for (key, value) in &new_points {
426 if self.is_global_mark(key)
427 && self.global_marks.get(key) != Some(&MarkLocation::Path(path.clone()))
428 {
429 if let Some(workspace_id) = self.workspace_id(cx) {
430 let path = path.clone();
431 let key = key.clone();
432 cx.background_spawn(async move {
433 DB.set_global_mark_path(workspace_id, key, path).await
434 })
435 .detach_and_log_err(cx);
436 }
437
438 self.global_marks
439 .insert(key.clone(), MarkLocation::Path(path.clone()));
440 }
441 if old_points.and_then(|o| o.get(key)) != Some(value) {
442 to_write.insert(key.clone(), value.clone());
443 }
444 }
445
446 self.serialized_marks.insert(path.clone(), new_points);
447
448 if let Some(workspace_id) = self.workspace_id(cx) {
449 cx.background_spawn(async move {
450 DB.set_marks(workspace_id, path.clone(), to_write).await?;
451 anyhow::Ok(())
452 })
453 .detach_and_log_err(cx);
454 }
455 }
456
457 fn is_global_mark(&self, key: &str) -> bool {
458 key.chars()
459 .next()
460 .is_some_and(|c| c.is_uppercase() || c.is_digit(10))
461 }
462
463 fn rename_buffer(
464 &mut self,
465 old_path: MarkLocation,
466 new_path: Arc<Path>,
467 buffer: &Entity<Buffer>,
468 cx: &mut Context<Self>,
469 ) {
470 if let MarkLocation::Buffer(entity_id) = old_path
471 && let Some(old_marks) = self.multibuffer_marks.remove(&entity_id)
472 {
473 let buffer_marks = old_marks
474 .into_iter()
475 .map(|(k, v)| (k, v.into_iter().map(|anchor| anchor.text_anchor).collect()))
476 .collect();
477 self.buffer_marks
478 .insert(buffer.read(cx).remote_id(), buffer_marks);
479 }
480 self.watch_buffer(MarkLocation::Path(new_path.clone()), buffer, cx);
481 self.serialize_buffer_marks(new_path, buffer, cx);
482 }
483
484 fn path_for_buffer(&self, buffer: &Entity<Buffer>, cx: &App) -> Option<Arc<Path>> {
485 let project_path = buffer.read(cx).project_path(cx)?;
486 let project = self.project(cx)?;
487 let abs_path = project.read(cx).absolute_path(&project_path, cx)?;
488 Some(abs_path.into())
489 }
490
491 fn points_at(
492 &self,
493 location: &MarkLocation,
494 multi_buffer: &Entity<MultiBuffer>,
495 cx: &App,
496 ) -> bool {
497 match location {
498 MarkLocation::Buffer(entity_id) => entity_id == &multi_buffer.entity_id(),
499 MarkLocation::Path(path) => {
500 let Some(singleton) = multi_buffer.read(cx).as_singleton() else {
501 return false;
502 };
503 self.path_for_buffer(&singleton, cx).as_ref() == Some(path)
504 }
505 }
506 }
507
508 pub fn watch_buffer(
509 &mut self,
510 mark_location: MarkLocation,
511 buffer_handle: &Entity<Buffer>,
512 cx: &mut Context<Self>,
513 ) {
514 let on_change = cx.subscribe(buffer_handle, move |this, buffer, event, cx| match event {
515 BufferEvent::Edited => {
516 if let Some(path) = this.path_for_buffer(&buffer, cx) {
517 this.serialize_buffer_marks(path, &buffer, cx);
518 }
519 }
520 BufferEvent::FileHandleChanged => {
521 let buffer_id = buffer.read(cx).remote_id();
522 if let Some(old_path) = this
523 .watched_buffers
524 .get(&buffer_id.clone())
525 .map(|(path, _, _)| path.clone())
526 && let Some(new_path) = this.path_for_buffer(&buffer, cx)
527 {
528 this.rename_buffer(old_path, new_path, &buffer, cx)
529 }
530 }
531 _ => {}
532 });
533
534 let on_release = cx.observe_release(buffer_handle, |this, buffer, _| {
535 this.watched_buffers.remove(&buffer.remote_id());
536 this.buffer_marks.remove(&buffer.remote_id());
537 });
538
539 self.watched_buffers.insert(
540 buffer_handle.read(cx).remote_id(),
541 (mark_location, on_change, on_release),
542 );
543 }
544
545 pub fn set_mark(
546 &mut self,
547 name: String,
548 multibuffer: &Entity<MultiBuffer>,
549 anchors: Vec<Anchor>,
550 cx: &mut Context<Self>,
551 ) {
552 let buffer = multibuffer.read(cx).as_singleton();
553 let abs_path = buffer.as_ref().and_then(|b| self.path_for_buffer(b, cx));
554
555 let Some(abs_path) = abs_path else {
556 self.multibuffer_marks
557 .entry(multibuffer.entity_id())
558 .or_default()
559 .insert(name.clone(), anchors);
560 if self.is_global_mark(&name) {
561 self.global_marks
562 .insert(name, MarkLocation::Buffer(multibuffer.entity_id()));
563 }
564 if let Some(buffer) = buffer {
565 let buffer_id = buffer.read(cx).remote_id();
566 if !self.watched_buffers.contains_key(&buffer_id) {
567 self.watch_buffer(MarkLocation::Buffer(multibuffer.entity_id()), &buffer, cx)
568 }
569 }
570 return;
571 };
572 let Some(buffer) = buffer else {
573 return;
574 };
575
576 let buffer_id = buffer.read(cx).remote_id();
577 self.buffer_marks.entry(buffer_id).or_default().insert(
578 name,
579 anchors
580 .into_iter()
581 .map(|anchor| anchor.text_anchor)
582 .collect(),
583 );
584 if !self.watched_buffers.contains_key(&buffer_id) {
585 self.watch_buffer(MarkLocation::Path(abs_path.clone()), &buffer, cx)
586 }
587 self.serialize_buffer_marks(abs_path, &buffer, cx)
588 }
589
590 pub fn get_mark(
591 &self,
592 name: &str,
593 multi_buffer: &Entity<MultiBuffer>,
594 cx: &App,
595 ) -> Option<Mark> {
596 let target = self.global_marks.get(name);
597
598 if !self.is_global_mark(name) || target.is_some_and(|t| self.points_at(t, multi_buffer, cx))
599 {
600 if let Some(anchors) = self.multibuffer_marks.get(&multi_buffer.entity_id()) {
601 return Some(Mark::Local(anchors.get(name)?.clone()));
602 }
603
604 let singleton = multi_buffer.read(cx).as_singleton()?;
605 let excerpt_id = *multi_buffer.read(cx).excerpt_ids().first()?;
606 let buffer_id = singleton.read(cx).remote_id();
607 if let Some(anchors) = self.buffer_marks.get(&buffer_id) {
608 let text_anchors = anchors.get(name)?;
609 let anchors = text_anchors
610 .iter()
611 .map(|anchor| Anchor::in_buffer(excerpt_id, buffer_id, *anchor))
612 .collect();
613 return Some(Mark::Local(anchors));
614 }
615 }
616
617 match target? {
618 MarkLocation::Buffer(entity_id) => {
619 let anchors = self.multibuffer_marks.get(entity_id)?;
620 Some(Mark::Buffer(*entity_id, anchors.get(name)?.clone()))
621 }
622 MarkLocation::Path(path) => {
623 let points = self.serialized_marks.get(path)?;
624 Some(Mark::Path(path.clone(), points.get(name)?.clone()))
625 }
626 }
627 }
628 pub fn delete_mark(
629 &mut self,
630 mark_name: String,
631 multi_buffer: &Entity<MultiBuffer>,
632 cx: &mut Context<Self>,
633 ) {
634 let path = if let Some(target) = self.global_marks.get(&mark_name.clone()) {
635 let name = mark_name.clone();
636 if let Some(workspace_id) = self.workspace_id(cx) {
637 cx.background_spawn(async move {
638 DB.delete_global_marks_path(workspace_id, name).await
639 })
640 .detach_and_log_err(cx);
641 }
642 self.buffer_marks.iter_mut().for_each(|(_, m)| {
643 m.remove(&mark_name.clone());
644 });
645
646 match target {
647 MarkLocation::Buffer(entity_id) => {
648 self.multibuffer_marks
649 .get_mut(entity_id)
650 .map(|m| m.remove(&mark_name.clone()));
651 return;
652 }
653 MarkLocation::Path(path) => path.clone(),
654 }
655 } else {
656 self.multibuffer_marks
657 .get_mut(&multi_buffer.entity_id())
658 .map(|m| m.remove(&mark_name.clone()));
659
660 if let Some(singleton) = multi_buffer.read(cx).as_singleton() {
661 let buffer_id = singleton.read(cx).remote_id();
662 self.buffer_marks
663 .get_mut(&buffer_id)
664 .map(|m| m.remove(&mark_name.clone()));
665 let Some(path) = self.path_for_buffer(&singleton, cx) else {
666 return;
667 };
668 path
669 } else {
670 return;
671 }
672 };
673 self.global_marks.remove(&mark_name);
674 self.serialized_marks
675 .get_mut(&path)
676 .map(|m| m.remove(&mark_name.clone()));
677 if let Some(workspace_id) = self.workspace_id(cx) {
678 cx.background_spawn(async move { DB.delete_mark(workspace_id, path, mark_name).await })
679 .detach_and_log_err(cx);
680 }
681 }
682}
683
684impl Global for VimGlobals {}
685
686impl VimGlobals {
687 pub(crate) fn register(cx: &mut App) {
688 cx.set_global(VimGlobals::default());
689
690 cx.observe_keystrokes(|event, _, cx| {
691 let Some(action) = event.action.as_ref().map(|action| action.boxed_clone()) else {
692 return;
693 };
694 Vim::globals(cx).observe_action(action.boxed_clone())
695 })
696 .detach();
697
698 cx.observe_new(|workspace: &mut Workspace, window, _| {
699 RegistersView::register(workspace, window);
700 })
701 .detach();
702
703 cx.observe_new(move |workspace: &mut Workspace, window, _| {
704 MarksView::register(workspace, window);
705 })
706 .detach();
707
708 let mut was_enabled = None;
709
710 cx.observe_global::<SettingsStore>(move |cx| {
711 let is_enabled = Vim::enabled(cx);
712 if was_enabled == Some(is_enabled) {
713 return;
714 }
715 was_enabled = Some(is_enabled);
716 if is_enabled {
717 KeyBinding::set_vim_mode(cx, true);
718 CommandPaletteFilter::update_global(cx, |filter, _| {
719 filter.show_namespace(Vim::NAMESPACE);
720 });
721 CommandPaletteInterceptor::update_global(cx, |interceptor, _| {
722 interceptor.set(Box::new(command_interceptor));
723 });
724 for window in cx.windows() {
725 if let Some(workspace) = window.downcast::<Workspace>() {
726 workspace
727 .update(cx, |workspace, _, cx| {
728 Vim::update_globals(cx, |globals, cx| {
729 globals.register_workspace(workspace, cx)
730 });
731 })
732 .ok();
733 }
734 }
735 } else {
736 KeyBinding::set_vim_mode(cx, false);
737 *Vim::globals(cx) = VimGlobals::default();
738 CommandPaletteInterceptor::update_global(cx, |interceptor, _| {
739 interceptor.clear();
740 });
741 CommandPaletteFilter::update_global(cx, |filter, _| {
742 filter.hide_namespace(Vim::NAMESPACE);
743 });
744 }
745 })
746 .detach();
747 cx.observe_new(|workspace: &mut Workspace, _, cx| {
748 Vim::update_globals(cx, |globals, cx| globals.register_workspace(workspace, cx));
749 })
750 .detach()
751 }
752
753 fn register_workspace(&mut self, workspace: &Workspace, cx: &mut Context<Workspace>) {
754 let entity_id = cx.entity_id();
755 self.marks.insert(entity_id, MarksState::new(workspace, cx));
756 cx.observe_release(&cx.entity(), move |_, _, cx| {
757 Vim::update_globals(cx, |globals, _| {
758 globals.marks.remove(&entity_id);
759 })
760 })
761 .detach();
762 }
763
764 pub(crate) fn write_registers(
765 &mut self,
766 content: Register,
767 register: Option<char>,
768 is_yank: bool,
769 kind: MotionKind,
770 cx: &mut Context<Editor>,
771 ) {
772 if let Some(register) = register {
773 let lower = register.to_lowercase().next().unwrap_or(register);
774 if lower != register {
775 let current = self.registers.entry(lower).or_default();
776 current.text = (current.text.to_string() + &content.text).into();
777 // not clear how to support appending to registers with multiple cursors
778 current.clipboard_selections.take();
779 let yanked = current.clone();
780 self.registers.insert('"', yanked);
781 } else {
782 match lower {
783 '_' | ':' | '.' | '%' | '#' | '=' | '/' => {}
784 '+' => {
785 self.registers.insert('"', content.clone());
786 cx.write_to_clipboard(content.into());
787 }
788 '*' => {
789 self.registers.insert('"', content.clone());
790 #[cfg(any(target_os = "linux", target_os = "freebsd"))]
791 cx.write_to_primary(content.into());
792 #[cfg(not(any(target_os = "linux", target_os = "freebsd")))]
793 cx.write_to_clipboard(content.into());
794 }
795 '"' => {
796 self.registers.insert('"', content.clone());
797 self.registers.insert('0', content);
798 }
799 _ => {
800 self.registers.insert('"', content.clone());
801 self.registers.insert(lower, content);
802 }
803 }
804 }
805 } else {
806 let setting = VimSettings::get_global(cx).use_system_clipboard;
807 if setting == UseSystemClipboard::Always
808 || setting == UseSystemClipboard::OnYank && is_yank
809 {
810 self.last_yank.replace(content.text.clone());
811 cx.write_to_clipboard(content.clone().into());
812 } else {
813 if let Some(text) = cx.read_from_clipboard().and_then(|i| i.text()) {
814 self.last_yank.replace(text.into());
815 }
816 }
817 self.registers.insert('"', content.clone());
818 if is_yank {
819 self.registers.insert('0', content);
820 } else {
821 let contains_newline = content.text.contains('\n');
822 if !contains_newline {
823 self.registers.insert('-', content.clone());
824 }
825 if kind.linewise() || contains_newline {
826 let mut content = content;
827 for i in '1'..='9' {
828 if let Some(moved) = self.registers.insert(i, content) {
829 content = moved;
830 } else {
831 break;
832 }
833 }
834 }
835 }
836 }
837 }
838
839 pub(crate) fn read_register(
840 &self,
841 register: Option<char>,
842 editor: Option<&mut Editor>,
843 cx: &mut App,
844 ) -> Option<Register> {
845 let Some(register) = register.filter(|reg| *reg != '"') else {
846 let setting = VimSettings::get_global(cx).use_system_clipboard;
847 return match setting {
848 UseSystemClipboard::Always => cx.read_from_clipboard().map(|item| item.into()),
849 UseSystemClipboard::OnYank if self.system_clipboard_is_newer(cx) => {
850 cx.read_from_clipboard().map(|item| item.into())
851 }
852 _ => self.registers.get(&'"').cloned(),
853 };
854 };
855 let lower = register.to_lowercase().next().unwrap_or(register);
856 match lower {
857 '_' | ':' | '.' | '#' | '=' => None,
858 '+' => cx.read_from_clipboard().map(|item| item.into()),
859 '*' => {
860 #[cfg(any(target_os = "linux", target_os = "freebsd"))]
861 {
862 cx.read_from_primary().map(|item| item.into())
863 }
864 #[cfg(not(any(target_os = "linux", target_os = "freebsd")))]
865 {
866 cx.read_from_clipboard().map(|item| item.into())
867 }
868 }
869 '%' => editor.and_then(|editor| {
870 let selection = editor.selections.newest::<Point>(cx);
871 if let Some((_, buffer, _)) = editor
872 .buffer()
873 .read(cx)
874 .excerpt_containing(selection.head(), cx)
875 {
876 buffer
877 .read(cx)
878 .file()
879 .map(|file| file.path().display(file.path_style(cx)).into_owned().into())
880 } else {
881 None
882 }
883 }),
884 _ => self.registers.get(&lower).cloned(),
885 }
886 }
887
888 fn system_clipboard_is_newer(&self, cx: &App) -> bool {
889 cx.read_from_clipboard().is_some_and(|item| {
890 match (item.text().as_deref(), &self.last_yank) {
891 (Some(new), Some(last)) => last.as_ref() != new,
892 (Some(_), None) => true,
893 (None, _) => false,
894 }
895 })
896 }
897
898 pub fn observe_action(&mut self, action: Box<dyn Action>) {
899 if self.dot_recording {
900 self.recording_actions
901 .push(ReplayableAction::Action(action.boxed_clone()));
902
903 if self.stop_recording_after_next_action {
904 self.dot_recording = false;
905 self.recorded_actions = std::mem::take(&mut self.recording_actions);
906 self.stop_recording_after_next_action = false;
907 }
908 }
909 if self.replayer.is_none()
910 && let Some(recording_register) = self.recording_register
911 {
912 self.recordings
913 .entry(recording_register)
914 .or_default()
915 .push(ReplayableAction::Action(action));
916 }
917 }
918
919 pub fn observe_insertion(&mut self, text: &Arc<str>, range_to_replace: Option<Range<isize>>) {
920 if self.ignore_current_insertion {
921 self.ignore_current_insertion = false;
922 return;
923 }
924 if self.dot_recording {
925 self.recording_actions.push(ReplayableAction::Insertion {
926 text: text.clone(),
927 utf16_range_to_replace: range_to_replace.clone(),
928 });
929 if self.stop_recording_after_next_action {
930 self.dot_recording = false;
931 self.recorded_actions = std::mem::take(&mut self.recording_actions);
932 self.stop_recording_after_next_action = false;
933 }
934 }
935 if let Some(recording_register) = self.recording_register {
936 self.recordings.entry(recording_register).or_default().push(
937 ReplayableAction::Insertion {
938 text: text.clone(),
939 utf16_range_to_replace: range_to_replace,
940 },
941 );
942 }
943 }
944
945 pub fn focused_vim(&self) -> Option<Entity<Vim>> {
946 self.focused_vim.as_ref().and_then(|vim| vim.upgrade())
947 }
948}
949
950impl Vim {
951 pub fn globals(cx: &mut App) -> &mut VimGlobals {
952 cx.global_mut::<VimGlobals>()
953 }
954
955 pub fn update_globals<C, R>(cx: &mut C, f: impl FnOnce(&mut VimGlobals, &mut C) -> R) -> R
956 where
957 C: BorrowMut<App>,
958 {
959 cx.update_global(f)
960 }
961}
962
963#[derive(Debug)]
964pub enum ReplayableAction {
965 Action(Box<dyn Action>),
966 Insertion {
967 text: Arc<str>,
968 utf16_range_to_replace: Option<Range<isize>>,
969 },
970}
971
972impl Clone for ReplayableAction {
973 fn clone(&self) -> Self {
974 match self {
975 Self::Action(action) => Self::Action(action.boxed_clone()),
976 Self::Insertion {
977 text,
978 utf16_range_to_replace,
979 } => Self::Insertion {
980 text: text.clone(),
981 utf16_range_to_replace: utf16_range_to_replace.clone(),
982 },
983 }
984 }
985}
986
987#[derive(Clone, Default, Debug)]
988pub struct SearchState {
989 pub direction: Direction,
990 pub count: usize,
991
992 pub prior_selections: Vec<Range<Anchor>>,
993 pub prior_operator: Option<Operator>,
994 pub prior_mode: Mode,
995 pub helix_select: bool,
996}
997
998impl Operator {
999 pub fn id(&self) -> &'static str {
1000 match self {
1001 Operator::Object { around: false } => "i",
1002 Operator::Object { around: true } => "a",
1003 Operator::Change => "c",
1004 Operator::Delete => "d",
1005 Operator::Yank => "y",
1006 Operator::Replace => "r",
1007 Operator::Digraph { .. } => "^K",
1008 Operator::Literal { .. } => "^V",
1009 Operator::FindForward { before: false, .. } => "f",
1010 Operator::FindForward { before: true, .. } => "t",
1011 Operator::Sneak { .. } => "s",
1012 Operator::SneakBackward { .. } => "S",
1013 Operator::FindBackward { after: false, .. } => "F",
1014 Operator::FindBackward { after: true, .. } => "T",
1015 Operator::AddSurrounds { .. } => "ys",
1016 Operator::ChangeSurrounds { .. } => "cs",
1017 Operator::DeleteSurrounds => "ds",
1018 Operator::Mark => "m",
1019 Operator::Jump { line: true } => "'",
1020 Operator::Jump { line: false } => "`",
1021 Operator::Indent => ">",
1022 Operator::AutoIndent => "eq",
1023 Operator::ShellCommand => "sh",
1024 Operator::Rewrap => "gq",
1025 Operator::ReplaceWithRegister => "gR",
1026 Operator::Exchange => "cx",
1027 Operator::Outdent => "<",
1028 Operator::Uppercase => "gU",
1029 Operator::Lowercase => "gu",
1030 Operator::OppositeCase => "g~",
1031 Operator::Rot13 => "g?",
1032 Operator::Rot47 => "g?",
1033 Operator::Register => "\"",
1034 Operator::RecordRegister => "q",
1035 Operator::ReplayRegister => "@",
1036 Operator::ToggleComments => "gc",
1037 Operator::HelixMatch => "helix_m",
1038 Operator::HelixNext { .. } => "helix_next",
1039 Operator::HelixPrevious { .. } => "helix_previous",
1040 }
1041 }
1042
1043 pub fn status(&self) -> String {
1044 fn make_visible(c: &str) -> &str {
1045 match c {
1046 "\n" => "enter",
1047 "\t" => "tab",
1048 " " => "space",
1049 c => c,
1050 }
1051 }
1052 match self {
1053 Operator::Digraph {
1054 first_char: Some(first_char),
1055 } => format!("^K{}", make_visible(&first_char.to_string())),
1056 Operator::Literal {
1057 prefix: Some(prefix),
1058 } => format!("^V{}", make_visible(prefix)),
1059 Operator::AutoIndent => "=".to_string(),
1060 Operator::ShellCommand => "=".to_string(),
1061 Operator::HelixMatch => "m".to_string(),
1062 Operator::HelixNext { .. } => "]".to_string(),
1063 Operator::HelixPrevious { .. } => "[".to_string(),
1064 _ => self.id().to_string(),
1065 }
1066 }
1067
1068 pub fn is_waiting(&self, mode: Mode) -> bool {
1069 match self {
1070 Operator::AddSurrounds { target } => target.is_some() || mode.is_visual(),
1071 Operator::FindForward { .. }
1072 | Operator::Mark
1073 | Operator::Jump { .. }
1074 | Operator::FindBackward { .. }
1075 | Operator::Sneak { .. }
1076 | Operator::SneakBackward { .. }
1077 | Operator::Register
1078 | Operator::RecordRegister
1079 | Operator::ReplayRegister
1080 | Operator::Replace
1081 | Operator::Digraph { .. }
1082 | Operator::Literal { .. }
1083 | Operator::ChangeSurrounds {
1084 target: Some(_), ..
1085 }
1086 | Operator::DeleteSurrounds => true,
1087 Operator::Change
1088 | Operator::Delete
1089 | Operator::Yank
1090 | Operator::Rewrap
1091 | Operator::Indent
1092 | Operator::Outdent
1093 | Operator::AutoIndent
1094 | Operator::ShellCommand
1095 | Operator::Lowercase
1096 | Operator::Uppercase
1097 | Operator::Rot13
1098 | Operator::Rot47
1099 | Operator::ReplaceWithRegister
1100 | Operator::Exchange
1101 | Operator::Object { .. }
1102 | Operator::ChangeSurrounds { target: None, .. }
1103 | Operator::OppositeCase
1104 | Operator::ToggleComments
1105 | Operator::HelixMatch
1106 | Operator::HelixNext { .. }
1107 | Operator::HelixPrevious { .. } => false,
1108 }
1109 }
1110
1111 pub fn starts_dot_recording(&self) -> bool {
1112 match self {
1113 Operator::Change
1114 | Operator::Delete
1115 | Operator::Replace
1116 | Operator::Indent
1117 | Operator::Outdent
1118 | Operator::AutoIndent
1119 | Operator::Lowercase
1120 | Operator::Uppercase
1121 | Operator::OppositeCase
1122 | Operator::Rot13
1123 | Operator::Rot47
1124 | Operator::ToggleComments
1125 | Operator::ReplaceWithRegister
1126 | Operator::Rewrap
1127 | Operator::ShellCommand
1128 | Operator::AddSurrounds { target: None }
1129 | Operator::ChangeSurrounds { target: None, .. }
1130 | Operator::DeleteSurrounds
1131 | Operator::Exchange
1132 | Operator::HelixNext { .. }
1133 | Operator::HelixPrevious { .. } => true,
1134 Operator::Yank
1135 | Operator::Object { .. }
1136 | Operator::FindForward { .. }
1137 | Operator::FindBackward { .. }
1138 | Operator::Sneak { .. }
1139 | Operator::SneakBackward { .. }
1140 | Operator::Mark
1141 | Operator::Digraph { .. }
1142 | Operator::Literal { .. }
1143 | Operator::AddSurrounds { .. }
1144 | Operator::ChangeSurrounds { .. }
1145 | Operator::Jump { .. }
1146 | Operator::Register
1147 | Operator::RecordRegister
1148 | Operator::ReplayRegister
1149 | Operator::HelixMatch => false,
1150 }
1151 }
1152}
1153
1154struct RegisterMatch {
1155 name: char,
1156 contents: SharedString,
1157}
1158
1159pub struct RegistersViewDelegate {
1160 selected_index: usize,
1161 matches: Vec<RegisterMatch>,
1162}
1163
1164impl PickerDelegate for RegistersViewDelegate {
1165 type ListItem = Div;
1166
1167 fn match_count(&self) -> usize {
1168 self.matches.len()
1169 }
1170
1171 fn selected_index(&self) -> usize {
1172 self.selected_index
1173 }
1174
1175 fn set_selected_index(&mut self, ix: usize, _: &mut Window, cx: &mut Context<Picker<Self>>) {
1176 self.selected_index = ix;
1177 cx.notify();
1178 }
1179
1180 fn placeholder_text(&self, _window: &mut Window, _cx: &mut App) -> Arc<str> {
1181 Arc::default()
1182 }
1183
1184 fn update_matches(
1185 &mut self,
1186 _: String,
1187 _: &mut Window,
1188 _: &mut Context<Picker<Self>>,
1189 ) -> gpui::Task<()> {
1190 Task::ready(())
1191 }
1192
1193 fn confirm(&mut self, _: bool, _: &mut Window, _: &mut Context<Picker<Self>>) {}
1194
1195 fn dismissed(&mut self, _: &mut Window, _: &mut Context<Picker<Self>>) {}
1196
1197 fn render_match(
1198 &self,
1199 ix: usize,
1200 selected: bool,
1201 _: &mut Window,
1202 cx: &mut Context<Picker<Self>>,
1203 ) -> Option<Self::ListItem> {
1204 let register_match = self.matches.get(ix)?;
1205
1206 let mut output = String::new();
1207 let mut runs = Vec::new();
1208 output.push('"');
1209 output.push(register_match.name);
1210 runs.push((
1211 0..output.len(),
1212 HighlightStyle::color(cx.theme().colors().text_accent),
1213 ));
1214 output.push(' ');
1215 output.push(' ');
1216 let mut base = output.len();
1217 for (ix, c) in register_match.contents.char_indices() {
1218 if ix > 100 {
1219 break;
1220 }
1221 let replace = match c {
1222 '\t' => Some("\\t".to_string()),
1223 '\n' => Some("\\n".to_string()),
1224 '\r' => Some("\\r".to_string()),
1225 c if is_invisible(c) => {
1226 if c <= '\x1f' {
1227 replacement(c).map(|s| s.to_string())
1228 } else {
1229 Some(format!("\\u{:04X}", c as u32))
1230 }
1231 }
1232 _ => None,
1233 };
1234 let Some(replace) = replace else {
1235 output.push(c);
1236 continue;
1237 };
1238 output.push_str(&replace);
1239 runs.push((
1240 base + ix..base + ix + replace.len(),
1241 HighlightStyle::color(cx.theme().colors().text_muted),
1242 ));
1243 base += replace.len() - c.len_utf8();
1244 }
1245
1246 let theme = ThemeSettings::get_global(cx);
1247 let text_style = TextStyle {
1248 color: cx.theme().colors().editor_foreground,
1249 font_family: theme.buffer_font.family.clone(),
1250 font_features: theme.buffer_font.features.clone(),
1251 font_fallbacks: theme.buffer_font.fallbacks.clone(),
1252 font_size: theme.buffer_font_size(cx).into(),
1253 line_height: (theme.line_height() * theme.buffer_font_size(cx)).into(),
1254 font_weight: theme.buffer_font.weight,
1255 font_style: theme.buffer_font.style,
1256 ..Default::default()
1257 };
1258
1259 Some(
1260 h_flex()
1261 .when(selected, |el| el.bg(cx.theme().colors().element_selected))
1262 .font_buffer(cx)
1263 .text_buffer(cx)
1264 .h(theme.buffer_font_size(cx) * theme.line_height())
1265 .px_2()
1266 .gap_1()
1267 .child(StyledText::new(output).with_default_highlights(&text_style, runs)),
1268 )
1269 }
1270}
1271
1272pub struct RegistersView {}
1273
1274impl RegistersView {
1275 fn register(workspace: &mut Workspace, _window: Option<&mut Window>) {
1276 workspace.register_action(|workspace, _: &ToggleRegistersView, window, cx| {
1277 Self::toggle(workspace, window, cx);
1278 });
1279 }
1280
1281 pub fn toggle(workspace: &mut Workspace, window: &mut Window, cx: &mut Context<Workspace>) {
1282 let editor = workspace
1283 .active_item(cx)
1284 .and_then(|item| item.act_as::<Editor>(cx));
1285 workspace.toggle_modal(window, cx, move |window, cx| {
1286 RegistersView::new(editor, window, cx)
1287 });
1288 }
1289
1290 fn new(
1291 editor: Option<Entity<Editor>>,
1292 window: &mut Window,
1293 cx: &mut Context<Picker<RegistersViewDelegate>>,
1294 ) -> Picker<RegistersViewDelegate> {
1295 let mut matches = Vec::default();
1296 cx.update_global(|globals: &mut VimGlobals, cx| {
1297 for name in ['"', '+', '*'] {
1298 if let Some(register) = globals.read_register(Some(name), None, cx) {
1299 matches.push(RegisterMatch {
1300 name,
1301 contents: register.text.clone(),
1302 })
1303 }
1304 }
1305 if let Some(editor) = editor {
1306 let register = editor.update(cx, |editor, cx| {
1307 globals.read_register(Some('%'), Some(editor), cx)
1308 });
1309 if let Some(register) = register {
1310 matches.push(RegisterMatch {
1311 name: '%',
1312 contents: register.text,
1313 })
1314 }
1315 }
1316 for (name, register) in globals.registers.iter() {
1317 if ['"', '+', '*', '%'].contains(name) {
1318 continue;
1319 };
1320 matches.push(RegisterMatch {
1321 name: *name,
1322 contents: register.text.clone(),
1323 })
1324 }
1325 });
1326 matches.sort_by(|a, b| a.name.cmp(&b.name));
1327 let delegate = RegistersViewDelegate {
1328 selected_index: 0,
1329 matches,
1330 };
1331
1332 Picker::nonsearchable_uniform_list(delegate, window, cx)
1333 .width(rems(36.))
1334 .modal(true)
1335 }
1336}
1337
1338enum MarksMatchInfo {
1339 Path(Arc<Path>),
1340 Title(String),
1341 Content {
1342 line: String,
1343 highlights: Vec<(Range<usize>, HighlightStyle)>,
1344 },
1345}
1346
1347impl MarksMatchInfo {
1348 fn from_chunks<'a>(chunks: impl Iterator<Item = Chunk<'a>>, cx: &App) -> Self {
1349 let mut line = String::new();
1350 let mut highlights = Vec::new();
1351 let mut offset = 0;
1352 for chunk in chunks {
1353 line.push_str(chunk.text);
1354 if let Some(highlight_style) = chunk.syntax_highlight_id
1355 && let Some(highlight) = highlight_style.style(cx.theme().syntax())
1356 {
1357 highlights.push((offset..offset + chunk.text.len(), highlight))
1358 }
1359 offset += chunk.text.len();
1360 }
1361 MarksMatchInfo::Content { line, highlights }
1362 }
1363}
1364
1365struct MarksMatch {
1366 name: String,
1367 position: Point,
1368 info: MarksMatchInfo,
1369}
1370
1371pub struct MarksViewDelegate {
1372 selected_index: usize,
1373 matches: Vec<MarksMatch>,
1374 point_column_width: usize,
1375 workspace: WeakEntity<Workspace>,
1376}
1377
1378impl PickerDelegate for MarksViewDelegate {
1379 type ListItem = Div;
1380
1381 fn match_count(&self) -> usize {
1382 self.matches.len()
1383 }
1384
1385 fn selected_index(&self) -> usize {
1386 self.selected_index
1387 }
1388
1389 fn set_selected_index(&mut self, ix: usize, _: &mut Window, cx: &mut Context<Picker<Self>>) {
1390 self.selected_index = ix;
1391 cx.notify();
1392 }
1393
1394 fn placeholder_text(&self, _window: &mut Window, _cx: &mut App) -> Arc<str> {
1395 Arc::default()
1396 }
1397
1398 fn update_matches(
1399 &mut self,
1400 _: String,
1401 _: &mut Window,
1402 cx: &mut Context<Picker<Self>>,
1403 ) -> gpui::Task<()> {
1404 let Some(workspace) = self.workspace.upgrade() else {
1405 return Task::ready(());
1406 };
1407 cx.spawn(async move |picker, cx| {
1408 let mut matches = Vec::new();
1409 let _ = workspace.update(cx, |workspace, cx| {
1410 let entity_id = cx.entity_id();
1411 let Some(editor) = workspace
1412 .active_item(cx)
1413 .and_then(|item| item.act_as::<Editor>(cx))
1414 else {
1415 return;
1416 };
1417 let editor = editor.read(cx);
1418 let mut has_seen = HashSet::new();
1419 let Some(marks_state) = cx.global::<VimGlobals>().marks.get(&entity_id) else {
1420 return;
1421 };
1422 let marks_state = marks_state.read(cx);
1423
1424 if let Some(map) = marks_state
1425 .multibuffer_marks
1426 .get(&editor.buffer().entity_id())
1427 {
1428 for (name, anchors) in map {
1429 if has_seen.contains(name) {
1430 continue;
1431 }
1432 has_seen.insert(name.clone());
1433 let Some(anchor) = anchors.first() else {
1434 continue;
1435 };
1436
1437 let snapshot = editor.buffer().read(cx).snapshot(cx);
1438 let position = anchor.to_point(&snapshot);
1439
1440 let chunks = snapshot.chunks(
1441 Point::new(position.row, 0)
1442 ..Point::new(
1443 position.row,
1444 snapshot.line_len(MultiBufferRow(position.row)),
1445 ),
1446 true,
1447 );
1448 matches.push(MarksMatch {
1449 name: name.clone(),
1450 position,
1451 info: MarksMatchInfo::from_chunks(chunks, cx),
1452 })
1453 }
1454 }
1455
1456 if let Some(buffer) = editor.buffer().read(cx).as_singleton() {
1457 let buffer = buffer.read(cx);
1458 if let Some(map) = marks_state.buffer_marks.get(&buffer.remote_id()) {
1459 for (name, anchors) in map {
1460 if has_seen.contains(name) {
1461 continue;
1462 }
1463 has_seen.insert(name.clone());
1464 let Some(anchor) = anchors.first() else {
1465 continue;
1466 };
1467 let snapshot = buffer.snapshot();
1468 let position = anchor.to_point(&snapshot);
1469 let chunks = snapshot.chunks(
1470 Point::new(position.row, 0)
1471 ..Point::new(position.row, snapshot.line_len(position.row)),
1472 true,
1473 );
1474
1475 matches.push(MarksMatch {
1476 name: name.clone(),
1477 position,
1478 info: MarksMatchInfo::from_chunks(chunks, cx),
1479 })
1480 }
1481 }
1482 }
1483
1484 for (name, mark_location) in marks_state.global_marks.iter() {
1485 if has_seen.contains(name) {
1486 continue;
1487 }
1488 has_seen.insert(name.clone());
1489
1490 match mark_location {
1491 MarkLocation::Buffer(entity_id) => {
1492 if let Some(&anchor) = marks_state
1493 .multibuffer_marks
1494 .get(entity_id)
1495 .and_then(|map| map.get(name))
1496 .and_then(|anchors| anchors.first())
1497 {
1498 let Some((info, snapshot)) = workspace
1499 .items(cx)
1500 .filter_map(|item| item.act_as::<Editor>(cx))
1501 .map(|entity| entity.read(cx).buffer())
1502 .find(|buffer| buffer.entity_id().eq(entity_id))
1503 .map(|buffer| {
1504 (
1505 MarksMatchInfo::Title(
1506 buffer.read(cx).title(cx).to_string(),
1507 ),
1508 buffer.read(cx).snapshot(cx),
1509 )
1510 })
1511 else {
1512 continue;
1513 };
1514 matches.push(MarksMatch {
1515 name: name.clone(),
1516 position: anchor.to_point(&snapshot),
1517 info,
1518 });
1519 }
1520 }
1521 MarkLocation::Path(path) => {
1522 if let Some(&position) = marks_state
1523 .serialized_marks
1524 .get(path.as_ref())
1525 .and_then(|map| map.get(name))
1526 .and_then(|points| points.first())
1527 {
1528 let info = MarksMatchInfo::Path(path.clone());
1529 matches.push(MarksMatch {
1530 name: name.clone(),
1531 position,
1532 info,
1533 });
1534 }
1535 }
1536 }
1537 }
1538 });
1539 let _ = picker.update(cx, |picker, cx| {
1540 matches.sort_by_key(|a| {
1541 (
1542 a.name.chars().next().map(|c| c.is_ascii_uppercase()),
1543 a.name.clone(),
1544 )
1545 });
1546 let digits = matches
1547 .iter()
1548 .map(|m| (m.position.row + 1).ilog10() + (m.position.column + 1).ilog10())
1549 .max()
1550 .unwrap_or_default();
1551 picker.delegate.matches = matches;
1552 picker.delegate.point_column_width = (digits + 4) as usize;
1553 cx.notify();
1554 });
1555 })
1556 }
1557
1558 fn confirm(&mut self, _: bool, window: &mut Window, cx: &mut Context<Picker<Self>>) {
1559 let Some(vim) = self
1560 .workspace
1561 .upgrade()
1562 .map(|w| w.read(cx))
1563 .and_then(|w| w.focused_pane(window, cx).read(cx).active_item())
1564 .and_then(|item| item.act_as::<Editor>(cx))
1565 .and_then(|editor| editor.read(cx).addon::<VimAddon>().cloned())
1566 .map(|addon| addon.entity)
1567 else {
1568 return;
1569 };
1570 let Some(text): Option<Arc<str>> = self
1571 .matches
1572 .get(self.selected_index)
1573 .map(|m| Arc::from(m.name.to_string().into_boxed_str()))
1574 else {
1575 return;
1576 };
1577 vim.update(cx, |vim, cx| {
1578 vim.jump(text, false, false, window, cx);
1579 });
1580
1581 cx.emit(DismissEvent);
1582 }
1583
1584 fn dismissed(&mut self, _: &mut Window, _: &mut Context<Picker<Self>>) {}
1585
1586 fn render_match(
1587 &self,
1588 ix: usize,
1589 selected: bool,
1590 _: &mut Window,
1591 cx: &mut Context<Picker<Self>>,
1592 ) -> Option<Self::ListItem> {
1593 let mark_match = self.matches.get(ix)?;
1594
1595 let mut left_output = String::new();
1596 let mut left_runs = Vec::new();
1597 left_output.push('`');
1598 left_output.push_str(&mark_match.name);
1599 left_runs.push((
1600 0..left_output.len(),
1601 HighlightStyle::color(cx.theme().colors().text_accent),
1602 ));
1603 left_output.push(' ');
1604 left_output.push(' ');
1605 let point_column = format!(
1606 "{},{}",
1607 mark_match.position.row + 1,
1608 mark_match.position.column + 1
1609 );
1610 left_output.push_str(&point_column);
1611 if let Some(padding) = self.point_column_width.checked_sub(point_column.len()) {
1612 left_output.push_str(&" ".repeat(padding));
1613 }
1614
1615 let (right_output, right_runs): (String, Vec<_>) = match &mark_match.info {
1616 MarksMatchInfo::Path(path) => {
1617 let s = path.to_string_lossy().into_owned();
1618 (
1619 s.clone(),
1620 vec![(0..s.len(), HighlightStyle::color(cx.theme().colors().text))],
1621 )
1622 }
1623 MarksMatchInfo::Title(title) => (
1624 title.clone(),
1625 vec![(
1626 0..title.len(),
1627 HighlightStyle::color(cx.theme().colors().text),
1628 )],
1629 ),
1630 MarksMatchInfo::Content { line, highlights } => (line.clone(), highlights.clone()),
1631 };
1632
1633 let theme = ThemeSettings::get_global(cx);
1634 let text_style = TextStyle {
1635 color: cx.theme().colors().editor_foreground,
1636 font_family: theme.buffer_font.family.clone(),
1637 font_features: theme.buffer_font.features.clone(),
1638 font_fallbacks: theme.buffer_font.fallbacks.clone(),
1639 font_size: theme.buffer_font_size(cx).into(),
1640 line_height: (theme.line_height() * theme.buffer_font_size(cx)).into(),
1641 font_weight: theme.buffer_font.weight,
1642 font_style: theme.buffer_font.style,
1643 ..Default::default()
1644 };
1645
1646 Some(
1647 h_flex()
1648 .when(selected, |el| el.bg(cx.theme().colors().element_selected))
1649 .font_buffer(cx)
1650 .text_buffer(cx)
1651 .h(theme.buffer_font_size(cx) * theme.line_height())
1652 .px_2()
1653 .child(StyledText::new(left_output).with_default_highlights(&text_style, left_runs))
1654 .child(
1655 StyledText::new(right_output).with_default_highlights(&text_style, right_runs),
1656 ),
1657 )
1658 }
1659}
1660
1661pub struct MarksView {}
1662
1663impl MarksView {
1664 fn register(workspace: &mut Workspace, _window: Option<&mut Window>) {
1665 workspace.register_action(|workspace, _: &ToggleMarksView, window, cx| {
1666 Self::toggle(workspace, window, cx);
1667 });
1668 }
1669
1670 pub fn toggle(workspace: &mut Workspace, window: &mut Window, cx: &mut Context<Workspace>) {
1671 let handle = cx.weak_entity();
1672 workspace.toggle_modal(window, cx, move |window, cx| {
1673 MarksView::new(handle, window, cx)
1674 });
1675 }
1676
1677 fn new(
1678 workspace: WeakEntity<Workspace>,
1679 window: &mut Window,
1680 cx: &mut Context<Picker<MarksViewDelegate>>,
1681 ) -> Picker<MarksViewDelegate> {
1682 let matches = Vec::default();
1683 let delegate = MarksViewDelegate {
1684 selected_index: 0,
1685 point_column_width: 0,
1686 matches,
1687 workspace,
1688 };
1689 Picker::nonsearchable_uniform_list(delegate, window, cx)
1690 .width(rems(36.))
1691 .modal(true)
1692 }
1693}
1694
1695pub struct VimDb(ThreadSafeConnection);
1696
1697impl Domain for VimDb {
1698 const NAME: &str = stringify!(VimDb);
1699
1700 const MIGRATIONS: &[&str] = &[
1701 sql! (
1702 CREATE TABLE vim_marks (
1703 workspace_id INTEGER,
1704 mark_name TEXT,
1705 path BLOB,
1706 value TEXT
1707 );
1708 CREATE UNIQUE INDEX idx_vim_marks ON vim_marks (workspace_id, mark_name, path);
1709 ),
1710 sql! (
1711 CREATE TABLE vim_global_marks_paths(
1712 workspace_id INTEGER,
1713 mark_name TEXT,
1714 path BLOB
1715 );
1716 CREATE UNIQUE INDEX idx_vim_global_marks_paths
1717 ON vim_global_marks_paths(workspace_id, mark_name);
1718 ),
1719 ];
1720}
1721
1722db::static_connection!(DB, VimDb, [WorkspaceDb]);
1723
1724struct SerializedMark {
1725 path: Arc<Path>,
1726 name: String,
1727 points: Vec<Point>,
1728}
1729
1730impl VimDb {
1731 pub(crate) async fn set_marks(
1732 &self,
1733 workspace_id: WorkspaceId,
1734 path: Arc<Path>,
1735 marks: HashMap<String, Vec<Point>>,
1736 ) -> Result<()> {
1737 log::debug!("Setting path {path:?} for {} marks", marks.len());
1738
1739 self.write(move |conn| {
1740 let mut query = conn.exec_bound(sql!(
1741 INSERT OR REPLACE INTO vim_marks
1742 (workspace_id, mark_name, path, value)
1743 VALUES
1744 (?, ?, ?, ?)
1745 ))?;
1746 for (mark_name, value) in marks {
1747 let pairs: Vec<(u32, u32)> = value
1748 .into_iter()
1749 .map(|point| (point.row, point.column))
1750 .collect();
1751 let serialized = serde_json::to_string(&pairs)?;
1752 query((workspace_id, mark_name, path.clone(), serialized))?;
1753 }
1754 Ok(())
1755 })
1756 .await
1757 }
1758
1759 fn get_marks(&self, workspace_id: WorkspaceId) -> Result<Vec<SerializedMark>> {
1760 let result: Vec<(Arc<Path>, String, String)> = self.select_bound(sql!(
1761 SELECT path, mark_name, value FROM vim_marks
1762 WHERE workspace_id = ?
1763 ))?(workspace_id)?;
1764
1765 Ok(result
1766 .into_iter()
1767 .filter_map(|(path, name, value)| {
1768 let pairs: Vec<(u32, u32)> = serde_json::from_str(&value).log_err()?;
1769 Some(SerializedMark {
1770 path,
1771 name,
1772 points: pairs
1773 .into_iter()
1774 .map(|(row, column)| Point { row, column })
1775 .collect(),
1776 })
1777 })
1778 .collect())
1779 }
1780
1781 pub(crate) async fn delete_mark(
1782 &self,
1783 workspace_id: WorkspaceId,
1784 path: Arc<Path>,
1785 mark_name: String,
1786 ) -> Result<()> {
1787 self.write(move |conn| {
1788 conn.exec_bound(sql!(
1789 DELETE FROM vim_marks
1790 WHERE workspace_id = ? AND mark_name = ? AND path = ?
1791 ))?((workspace_id, mark_name, path))
1792 })
1793 .await
1794 }
1795
1796 pub(crate) async fn set_global_mark_path(
1797 &self,
1798 workspace_id: WorkspaceId,
1799 mark_name: String,
1800 path: Arc<Path>,
1801 ) -> Result<()> {
1802 log::debug!("Setting global mark path {path:?} for {mark_name}");
1803 self.write(move |conn| {
1804 conn.exec_bound(sql!(
1805 INSERT OR REPLACE INTO vim_global_marks_paths
1806 (workspace_id, mark_name, path)
1807 VALUES
1808 (?, ?, ?)
1809 ))?((workspace_id, mark_name, path))
1810 })
1811 .await
1812 }
1813
1814 pub fn get_global_marks_paths(
1815 &self,
1816 workspace_id: WorkspaceId,
1817 ) -> Result<Vec<(String, Arc<Path>)>> {
1818 self.select_bound(sql!(
1819 SELECT mark_name, path FROM vim_global_marks_paths
1820 WHERE workspace_id = ?
1821 ))?(workspace_id)
1822 }
1823
1824 pub(crate) async fn delete_global_marks_path(
1825 &self,
1826 workspace_id: WorkspaceId,
1827 mark_name: String,
1828 ) -> Result<()> {
1829 self.write(move |conn| {
1830 conn.exec_bound(sql!(
1831 DELETE FROM vim_global_marks_paths
1832 WHERE workspace_id = ? AND mark_name = ?
1833 ))?((workspace_id, mark_name))
1834 })
1835 .await
1836 }
1837}