1use crate::{
2 Anchor, Autoscroll, Editor, EditorEvent, EditorSettings, ExcerptId, ExcerptRange, FormatTarget,
3 MultiBuffer, MultiBufferSnapshot, NavigationData, SearchWithinRange, ToPoint as _,
4 editor_settings::SeedQuerySetting,
5 persistence::{DB, SerializedEditor},
6 scroll::ScrollAnchor,
7};
8use anyhow::{Context as _, Result, anyhow};
9use collections::{HashMap, HashSet};
10use file_icons::FileIcons;
11use futures::future::try_join_all;
12use git::status::GitSummary;
13use gpui::{
14 AnyElement, App, AsyncWindowContext, Context, Entity, EntityId, EventEmitter, IntoElement,
15 ParentElement, Pixels, SharedString, Styled, Task, WeakEntity, Window, point,
16};
17use language::{
18 Bias, Buffer, BufferRow, CharKind, DiskState, LocalFile, Point, SelectionGoal,
19 proto::serialize_anchor as serialize_text_anchor,
20};
21use lsp::DiagnosticSeverity;
22use project::{
23 Project, ProjectItem as _, ProjectPath, lsp_store::FormatTrigger,
24 project_settings::ProjectSettings, search::SearchQuery,
25};
26use rpc::proto::{self, PeerId, update_view};
27use settings::Settings;
28use std::{
29 any::TypeId,
30 borrow::Cow,
31 cmp::{self, Ordering},
32 iter,
33 ops::Range,
34 path::{Path, PathBuf},
35 sync::Arc,
36};
37use text::{BufferId, BufferSnapshot, Selection};
38use theme::{Theme, ThemeSettings};
39use ui::{IconDecorationKind, prelude::*};
40use util::{ResultExt, TryFutureExt, paths::PathExt};
41use workspace::{
42 ItemId, ItemNavHistory, ToolbarItemLocation, ViewId, Workspace, WorkspaceId,
43 item::{FollowableItem, Item, ItemEvent, ProjectItem},
44 searchable::{Direction, SearchEvent, SearchableItem, SearchableItemHandle},
45};
46use workspace::{
47 OpenOptions,
48 item::{Dedup, ItemSettings, SerializableItem, TabContentParams},
49};
50use workspace::{
51 OpenVisible, Pane, WorkspaceSettings,
52 item::{BreadcrumbText, FollowEvent, ProjectItemKind},
53 searchable::SearchOptions,
54};
55
56pub const MAX_TAB_TITLE_LEN: usize = 24;
57
58impl FollowableItem for Editor {
59 fn remote_id(&self) -> Option<ViewId> {
60 self.remote_id
61 }
62
63 fn from_state_proto(
64 workspace: Entity<Workspace>,
65 remote_id: ViewId,
66 state: &mut Option<proto::view::Variant>,
67 window: &mut Window,
68 cx: &mut App,
69 ) -> Option<Task<Result<Entity<Self>>>> {
70 let project = workspace.read(cx).project().to_owned();
71 let Some(proto::view::Variant::Editor(_)) = state else {
72 return None;
73 };
74 let Some(proto::view::Variant::Editor(state)) = state.take() else {
75 unreachable!()
76 };
77
78 let buffer_ids = state
79 .excerpts
80 .iter()
81 .map(|excerpt| excerpt.buffer_id)
82 .collect::<HashSet<_>>();
83 let buffers = project.update(cx, |project, cx| {
84 buffer_ids
85 .iter()
86 .map(|id| BufferId::new(*id).map(|id| project.open_buffer_by_id(id, cx)))
87 .collect::<Result<Vec<_>>>()
88 });
89
90 Some(window.spawn(cx, async move |cx| {
91 let mut buffers = futures::future::try_join_all(buffers?)
92 .await
93 .debug_assert_ok("leaders don't share views for unshared buffers")?;
94
95 let editor = cx.update(|window, cx| {
96 let multibuffer = cx.new(|cx| {
97 let mut multibuffer;
98 if state.singleton && buffers.len() == 1 {
99 multibuffer = MultiBuffer::singleton(buffers.pop().unwrap(), cx)
100 } else {
101 multibuffer = MultiBuffer::new(project.read(cx).capability());
102 let mut sorted_excerpts = state.excerpts.clone();
103 sorted_excerpts.sort_by_key(|e| e.id);
104 let mut sorted_excerpts = sorted_excerpts.into_iter().peekable();
105
106 while let Some(excerpt) = sorted_excerpts.next() {
107 let Ok(buffer_id) = BufferId::new(excerpt.buffer_id) else {
108 continue;
109 };
110
111 let mut insert_position = ExcerptId::min();
112 for e in &state.excerpts {
113 if e.id == excerpt.id {
114 break;
115 }
116 if e.id < excerpt.id {
117 insert_position = ExcerptId::from_proto(e.id);
118 }
119 }
120
121 let buffer =
122 buffers.iter().find(|b| b.read(cx).remote_id() == buffer_id);
123
124 let Some(excerpt) = deserialize_excerpt_range(excerpt) else {
125 continue;
126 };
127
128 let Some(buffer) = buffer else { continue };
129
130 multibuffer.insert_excerpts_with_ids_after(
131 insert_position,
132 buffer.clone(),
133 [excerpt],
134 cx,
135 );
136 }
137 };
138
139 if let Some(title) = &state.title {
140 multibuffer = multibuffer.with_title(title.clone())
141 }
142
143 multibuffer
144 });
145
146 cx.new(|cx| {
147 let mut editor =
148 Editor::for_multibuffer(multibuffer, Some(project.clone()), window, cx);
149 editor.remote_id = Some(remote_id);
150 editor
151 })
152 })?;
153
154 update_editor_from_message(
155 editor.downgrade(),
156 project,
157 proto::update_view::Editor {
158 selections: state.selections,
159 pending_selection: state.pending_selection,
160 scroll_top_anchor: state.scroll_top_anchor,
161 scroll_x: state.scroll_x,
162 scroll_y: state.scroll_y,
163 ..Default::default()
164 },
165 cx,
166 )
167 .await?;
168
169 Ok(editor)
170 }))
171 }
172
173 fn set_leader_peer_id(
174 &mut self,
175 leader_peer_id: Option<PeerId>,
176 window: &mut Window,
177 cx: &mut Context<Self>,
178 ) {
179 self.leader_peer_id = leader_peer_id;
180 if self.leader_peer_id.is_some() {
181 self.buffer.update(cx, |buffer, cx| {
182 buffer.remove_active_selections(cx);
183 });
184 } else if self.focus_handle.is_focused(window) {
185 self.buffer.update(cx, |buffer, cx| {
186 buffer.set_active_selections(
187 &self.selections.disjoint_anchors(),
188 self.selections.line_mode,
189 self.cursor_shape,
190 cx,
191 );
192 });
193 }
194 cx.notify();
195 }
196
197 fn to_state_proto(&self, _: &Window, cx: &App) -> Option<proto::view::Variant> {
198 let buffer = self.buffer.read(cx);
199 if buffer
200 .as_singleton()
201 .and_then(|buffer| buffer.read(cx).file())
202 .map_or(false, |file| file.is_private())
203 {
204 return None;
205 }
206
207 let scroll_anchor = self.scroll_manager.anchor();
208 let excerpts = buffer
209 .read(cx)
210 .excerpts()
211 .map(|(id, buffer, range)| proto::Excerpt {
212 id: id.to_proto(),
213 buffer_id: buffer.remote_id().into(),
214 context_start: Some(serialize_text_anchor(&range.context.start)),
215 context_end: Some(serialize_text_anchor(&range.context.end)),
216 primary_start: Some(serialize_text_anchor(&range.primary.start)),
217 primary_end: Some(serialize_text_anchor(&range.primary.end)),
218 })
219 .collect();
220 let snapshot = buffer.snapshot(cx);
221
222 Some(proto::view::Variant::Editor(proto::view::Editor {
223 singleton: buffer.is_singleton(),
224 title: (!buffer.is_singleton()).then(|| buffer.title(cx).into()),
225 excerpts,
226 scroll_top_anchor: Some(serialize_anchor(&scroll_anchor.anchor, &snapshot)),
227 scroll_x: scroll_anchor.offset.x,
228 scroll_y: scroll_anchor.offset.y,
229 selections: self
230 .selections
231 .disjoint_anchors()
232 .iter()
233 .map(|s| serialize_selection(s, &snapshot))
234 .collect(),
235 pending_selection: self
236 .selections
237 .pending_anchor()
238 .as_ref()
239 .map(|s| serialize_selection(s, &snapshot)),
240 }))
241 }
242
243 fn to_follow_event(event: &EditorEvent) -> Option<workspace::item::FollowEvent> {
244 match event {
245 EditorEvent::Edited { .. } => Some(FollowEvent::Unfollow),
246 EditorEvent::SelectionsChanged { local }
247 | EditorEvent::ScrollPositionChanged { local, .. } => {
248 if *local {
249 Some(FollowEvent::Unfollow)
250 } else {
251 None
252 }
253 }
254 _ => None,
255 }
256 }
257
258 fn add_event_to_update_proto(
259 &self,
260 event: &EditorEvent,
261 update: &mut Option<proto::update_view::Variant>,
262 _: &Window,
263 cx: &App,
264 ) -> bool {
265 let update =
266 update.get_or_insert_with(|| proto::update_view::Variant::Editor(Default::default()));
267
268 match update {
269 proto::update_view::Variant::Editor(update) => match event {
270 EditorEvent::ExcerptsAdded {
271 buffer,
272 predecessor,
273 excerpts,
274 } => {
275 let buffer_id = buffer.read(cx).remote_id();
276 let mut excerpts = excerpts.iter();
277 if let Some((id, range)) = excerpts.next() {
278 update.inserted_excerpts.push(proto::ExcerptInsertion {
279 previous_excerpt_id: Some(predecessor.to_proto()),
280 excerpt: serialize_excerpt(buffer_id, id, range),
281 });
282 update.inserted_excerpts.extend(excerpts.map(|(id, range)| {
283 proto::ExcerptInsertion {
284 previous_excerpt_id: None,
285 excerpt: serialize_excerpt(buffer_id, id, range),
286 }
287 }))
288 }
289 true
290 }
291 EditorEvent::ExcerptsRemoved { ids, .. } => {
292 update
293 .deleted_excerpts
294 .extend(ids.iter().map(ExcerptId::to_proto));
295 true
296 }
297 EditorEvent::ScrollPositionChanged { autoscroll, .. } if !autoscroll => {
298 let snapshot = self.buffer.read(cx).snapshot(cx);
299 let scroll_anchor = self.scroll_manager.anchor();
300 update.scroll_top_anchor =
301 Some(serialize_anchor(&scroll_anchor.anchor, &snapshot));
302 update.scroll_x = scroll_anchor.offset.x;
303 update.scroll_y = scroll_anchor.offset.y;
304 true
305 }
306 EditorEvent::SelectionsChanged { .. } => {
307 let snapshot = self.buffer.read(cx).snapshot(cx);
308 update.selections = self
309 .selections
310 .disjoint_anchors()
311 .iter()
312 .map(|s| serialize_selection(s, &snapshot))
313 .collect();
314 update.pending_selection = self
315 .selections
316 .pending_anchor()
317 .as_ref()
318 .map(|s| serialize_selection(s, &snapshot));
319 true
320 }
321 _ => false,
322 },
323 }
324 }
325
326 fn apply_update_proto(
327 &mut self,
328 project: &Entity<Project>,
329 message: update_view::Variant,
330 window: &mut Window,
331 cx: &mut Context<Self>,
332 ) -> Task<Result<()>> {
333 let update_view::Variant::Editor(message) = message;
334 let project = project.clone();
335 cx.spawn_in(window, async move |this, cx| {
336 update_editor_from_message(this, project, message, cx).await
337 })
338 }
339
340 fn is_project_item(&self, _window: &Window, _cx: &App) -> bool {
341 true
342 }
343
344 fn dedup(&self, existing: &Self, _: &Window, cx: &App) -> Option<Dedup> {
345 let self_singleton = self.buffer.read(cx).as_singleton()?;
346 let other_singleton = existing.buffer.read(cx).as_singleton()?;
347 if self_singleton == other_singleton {
348 Some(Dedup::KeepExisting)
349 } else {
350 None
351 }
352 }
353}
354
355async fn update_editor_from_message(
356 this: WeakEntity<Editor>,
357 project: Entity<Project>,
358 message: proto::update_view::Editor,
359 cx: &mut AsyncWindowContext,
360) -> Result<()> {
361 // Open all of the buffers of which excerpts were added to the editor.
362 let inserted_excerpt_buffer_ids = message
363 .inserted_excerpts
364 .iter()
365 .filter_map(|insertion| Some(insertion.excerpt.as_ref()?.buffer_id))
366 .collect::<HashSet<_>>();
367 let inserted_excerpt_buffers = project.update(cx, |project, cx| {
368 inserted_excerpt_buffer_ids
369 .into_iter()
370 .map(|id| BufferId::new(id).map(|id| project.open_buffer_by_id(id, cx)))
371 .collect::<Result<Vec<_>>>()
372 })??;
373 let _inserted_excerpt_buffers = try_join_all(inserted_excerpt_buffers).await?;
374
375 // Update the editor's excerpts.
376 this.update(cx, |editor, cx| {
377 editor.buffer.update(cx, |multibuffer, cx| {
378 let mut removed_excerpt_ids = message
379 .deleted_excerpts
380 .into_iter()
381 .map(ExcerptId::from_proto)
382 .collect::<Vec<_>>();
383 removed_excerpt_ids.sort_by({
384 let multibuffer = multibuffer.read(cx);
385 move |a, b| a.cmp(b, &multibuffer)
386 });
387
388 let mut insertions = message.inserted_excerpts.into_iter().peekable();
389 while let Some(insertion) = insertions.next() {
390 let Some(excerpt) = insertion.excerpt else {
391 continue;
392 };
393 let Some(previous_excerpt_id) = insertion.previous_excerpt_id else {
394 continue;
395 };
396 let buffer_id = BufferId::new(excerpt.buffer_id)?;
397 let Some(buffer) = project.read(cx).buffer_for_id(buffer_id, cx) else {
398 continue;
399 };
400
401 let adjacent_excerpts = iter::from_fn(|| {
402 let insertion = insertions.peek()?;
403 if insertion.previous_excerpt_id.is_none()
404 && insertion.excerpt.as_ref()?.buffer_id == u64::from(buffer_id)
405 {
406 insertions.next()?.excerpt
407 } else {
408 None
409 }
410 });
411
412 multibuffer.insert_excerpts_with_ids_after(
413 ExcerptId::from_proto(previous_excerpt_id),
414 buffer,
415 [excerpt]
416 .into_iter()
417 .chain(adjacent_excerpts)
418 .filter_map(deserialize_excerpt_range),
419 cx,
420 );
421 }
422
423 multibuffer.remove_excerpts(removed_excerpt_ids, cx);
424 Result::<(), anyhow::Error>::Ok(())
425 })
426 })??;
427
428 // Deserialize the editor state.
429 let (selections, pending_selection, scroll_top_anchor) = this.update(cx, |editor, cx| {
430 let buffer = editor.buffer.read(cx).read(cx);
431 let selections = message
432 .selections
433 .into_iter()
434 .filter_map(|selection| deserialize_selection(&buffer, selection))
435 .collect::<Vec<_>>();
436 let pending_selection = message
437 .pending_selection
438 .and_then(|selection| deserialize_selection(&buffer, selection));
439 let scroll_top_anchor = message
440 .scroll_top_anchor
441 .and_then(|anchor| deserialize_anchor(&buffer, anchor));
442 anyhow::Ok((selections, pending_selection, scroll_top_anchor))
443 })??;
444
445 // Wait until the buffer has received all of the operations referenced by
446 // the editor's new state.
447 this.update(cx, |editor, cx| {
448 editor.buffer.update(cx, |buffer, cx| {
449 buffer.wait_for_anchors(
450 selections
451 .iter()
452 .chain(pending_selection.as_ref())
453 .flat_map(|selection| [selection.start, selection.end])
454 .chain(scroll_top_anchor),
455 cx,
456 )
457 })
458 })?
459 .await?;
460
461 // Update the editor's state.
462 this.update_in(cx, |editor, window, cx| {
463 if !selections.is_empty() || pending_selection.is_some() {
464 editor.set_selections_from_remote(selections, pending_selection, window, cx);
465 editor.request_autoscroll_remotely(Autoscroll::newest(), cx);
466 } else if let Some(scroll_top_anchor) = scroll_top_anchor {
467 editor.set_scroll_anchor_remote(
468 ScrollAnchor {
469 anchor: scroll_top_anchor,
470 offset: point(message.scroll_x, message.scroll_y),
471 },
472 window,
473 cx,
474 );
475 }
476 })?;
477 Ok(())
478}
479
480fn serialize_excerpt(
481 buffer_id: BufferId,
482 id: &ExcerptId,
483 range: &ExcerptRange<language::Anchor>,
484) -> Option<proto::Excerpt> {
485 Some(proto::Excerpt {
486 id: id.to_proto(),
487 buffer_id: buffer_id.into(),
488 context_start: Some(serialize_text_anchor(&range.context.start)),
489 context_end: Some(serialize_text_anchor(&range.context.end)),
490 primary_start: Some(serialize_text_anchor(&range.primary.start)),
491 primary_end: Some(serialize_text_anchor(&range.primary.end)),
492 })
493}
494
495fn serialize_selection(
496 selection: &Selection<Anchor>,
497 buffer: &MultiBufferSnapshot,
498) -> proto::Selection {
499 proto::Selection {
500 id: selection.id as u64,
501 start: Some(serialize_anchor(&selection.start, &buffer)),
502 end: Some(serialize_anchor(&selection.end, &buffer)),
503 reversed: selection.reversed,
504 }
505}
506
507fn serialize_anchor(anchor: &Anchor, buffer: &MultiBufferSnapshot) -> proto::EditorAnchor {
508 proto::EditorAnchor {
509 excerpt_id: buffer.latest_excerpt_id(anchor.excerpt_id).to_proto(),
510 anchor: Some(serialize_text_anchor(&anchor.text_anchor)),
511 }
512}
513
514fn deserialize_excerpt_range(
515 excerpt: proto::Excerpt,
516) -> Option<(ExcerptId, ExcerptRange<language::Anchor>)> {
517 let context = {
518 let start = language::proto::deserialize_anchor(excerpt.context_start?)?;
519 let end = language::proto::deserialize_anchor(excerpt.context_end?)?;
520 start..end
521 };
522 let primary = excerpt
523 .primary_start
524 .zip(excerpt.primary_end)
525 .and_then(|(start, end)| {
526 let start = language::proto::deserialize_anchor(start)?;
527 let end = language::proto::deserialize_anchor(end)?;
528 Some(start..end)
529 })
530 .unwrap_or_else(|| context.clone());
531 Some((
532 ExcerptId::from_proto(excerpt.id),
533 ExcerptRange { context, primary },
534 ))
535}
536
537fn deserialize_selection(
538 buffer: &MultiBufferSnapshot,
539 selection: proto::Selection,
540) -> Option<Selection<Anchor>> {
541 Some(Selection {
542 id: selection.id as usize,
543 start: deserialize_anchor(buffer, selection.start?)?,
544 end: deserialize_anchor(buffer, selection.end?)?,
545 reversed: selection.reversed,
546 goal: SelectionGoal::None,
547 })
548}
549
550fn deserialize_anchor(buffer: &MultiBufferSnapshot, anchor: proto::EditorAnchor) -> Option<Anchor> {
551 let excerpt_id = ExcerptId::from_proto(anchor.excerpt_id);
552 Some(Anchor {
553 excerpt_id,
554 text_anchor: language::proto::deserialize_anchor(anchor.anchor?)?,
555 buffer_id: buffer.buffer_id_for_excerpt(excerpt_id),
556 diff_base_anchor: None,
557 })
558}
559
560impl Item for Editor {
561 type Event = EditorEvent;
562
563 fn navigate(
564 &mut self,
565 data: Box<dyn std::any::Any>,
566 window: &mut Window,
567 cx: &mut Context<Self>,
568 ) -> bool {
569 if let Ok(data) = data.downcast::<NavigationData>() {
570 let newest_selection = self.selections.newest::<Point>(cx);
571 let buffer = self.buffer.read(cx).read(cx);
572 let offset = if buffer.can_resolve(&data.cursor_anchor) {
573 data.cursor_anchor.to_point(&buffer)
574 } else {
575 buffer.clip_point(data.cursor_position, Bias::Left)
576 };
577
578 let mut scroll_anchor = data.scroll_anchor;
579 if !buffer.can_resolve(&scroll_anchor.anchor) {
580 scroll_anchor.anchor = buffer.anchor_before(
581 buffer.clip_point(Point::new(data.scroll_top_row, 0), Bias::Left),
582 );
583 }
584
585 drop(buffer);
586
587 if newest_selection.head() == offset {
588 false
589 } else {
590 let nav_history = self.nav_history.take();
591 self.set_scroll_anchor(scroll_anchor, window, cx);
592 self.change_selections(Some(Autoscroll::fit()), window, cx, |s| {
593 s.select_ranges([offset..offset])
594 });
595 self.nav_history = nav_history;
596 true
597 }
598 } else {
599 false
600 }
601 }
602
603 fn tab_tooltip_text(&self, cx: &App) -> Option<SharedString> {
604 let file_path = self
605 .buffer()
606 .read(cx)
607 .as_singleton()?
608 .read(cx)
609 .file()
610 .and_then(|f| f.as_local())?
611 .abs_path(cx);
612
613 let file_path = file_path.compact().to_string_lossy().to_string();
614
615 Some(file_path.into())
616 }
617
618 fn telemetry_event_text(&self) -> Option<&'static str> {
619 None
620 }
621
622 fn tab_content_text(&self, detail: usize, cx: &App) -> SharedString {
623 if let Some(path) = path_for_buffer(&self.buffer, detail, true, cx) {
624 path.to_string_lossy().to_string().into()
625 } else {
626 "untitled".into()
627 }
628 }
629
630 fn tab_icon(&self, _: &Window, cx: &App) -> Option<Icon> {
631 ItemSettings::get_global(cx)
632 .file_icons
633 .then(|| {
634 path_for_buffer(&self.buffer, 0, true, cx)
635 .and_then(|path| FileIcons::get_icon(path.as_ref(), cx))
636 })
637 .flatten()
638 .map(Icon::from_path)
639 }
640
641 fn tab_content(&self, params: TabContentParams, _: &Window, cx: &App) -> AnyElement {
642 let label_color = if ItemSettings::get_global(cx).git_status {
643 self.buffer()
644 .read(cx)
645 .as_singleton()
646 .and_then(|buffer| {
647 let buffer = buffer.read(cx);
648 let path = buffer.project_path(cx)?;
649 let buffer_id = buffer.remote_id();
650 let project = self.project.as_ref()?.read(cx);
651 let entry = project.entry_for_path(&path, cx)?;
652 let (repo, repo_path) = project
653 .git_store()
654 .read(cx)
655 .repository_and_path_for_buffer_id(buffer_id, cx)?;
656 let status = repo.read(cx).status_for_path(&repo_path)?.status;
657
658 Some(entry_git_aware_label_color(
659 status.summary(),
660 entry.is_ignored,
661 params.selected,
662 ))
663 })
664 .unwrap_or_else(|| entry_label_color(params.selected))
665 } else {
666 entry_label_color(params.selected)
667 };
668
669 let description = params.detail.and_then(|detail| {
670 let path = path_for_buffer(&self.buffer, detail, false, cx)?;
671 let description = path.to_string_lossy();
672 let description = description.trim();
673
674 if description.is_empty() {
675 return None;
676 }
677
678 Some(util::truncate_and_trailoff(description, MAX_TAB_TITLE_LEN))
679 });
680
681 // Whether the file was saved in the past but is now deleted.
682 let was_deleted: bool = self
683 .buffer()
684 .read(cx)
685 .as_singleton()
686 .and_then(|buffer| buffer.read(cx).file())
687 .map_or(false, |file| file.disk_state() == DiskState::Deleted);
688
689 h_flex()
690 .gap_2()
691 .child(
692 Label::new(self.title(cx).to_string())
693 .color(label_color)
694 .when(params.preview, |this| this.italic())
695 .when(was_deleted, |this| this.strikethrough()),
696 )
697 .when_some(description, |this, description| {
698 this.child(
699 Label::new(description)
700 .size(LabelSize::XSmall)
701 .color(Color::Muted),
702 )
703 })
704 .into_any_element()
705 }
706
707 fn for_each_project_item(
708 &self,
709 cx: &App,
710 f: &mut dyn FnMut(EntityId, &dyn project::ProjectItem),
711 ) {
712 self.buffer
713 .read(cx)
714 .for_each_buffer(|buffer| f(buffer.entity_id(), buffer.read(cx)));
715 }
716
717 fn is_singleton(&self, cx: &App) -> bool {
718 self.buffer.read(cx).is_singleton()
719 }
720
721 fn can_save_as(&self, cx: &App) -> bool {
722 self.buffer.read(cx).is_singleton()
723 }
724
725 fn clone_on_split(
726 &self,
727 _workspace_id: Option<WorkspaceId>,
728 window: &mut Window,
729 cx: &mut Context<Self>,
730 ) -> Option<Entity<Editor>>
731 where
732 Self: Sized,
733 {
734 Some(cx.new(|cx| self.clone(window, cx)))
735 }
736
737 fn set_nav_history(
738 &mut self,
739 history: ItemNavHistory,
740 _window: &mut Window,
741 _: &mut Context<Self>,
742 ) {
743 self.nav_history = Some(history);
744 }
745
746 fn discarded(&self, _project: Entity<Project>, _: &mut Window, cx: &mut Context<Self>) {
747 for buffer in self.buffer().clone().read(cx).all_buffers() {
748 buffer.update(cx, |buffer, cx| buffer.discarded(cx))
749 }
750 }
751
752 fn deactivated(&mut self, _: &mut Window, cx: &mut Context<Self>) {
753 let selection = self.selections.newest_anchor();
754 self.push_to_nav_history(selection.head(), None, true, cx);
755 }
756
757 fn workspace_deactivated(&mut self, _: &mut Window, cx: &mut Context<Self>) {
758 self.hide_hovered_link(cx);
759 }
760
761 fn is_dirty(&self, cx: &App) -> bool {
762 self.buffer().read(cx).read(cx).is_dirty()
763 }
764
765 fn has_deleted_file(&self, cx: &App) -> bool {
766 self.buffer().read(cx).read(cx).has_deleted_file()
767 }
768
769 fn has_conflict(&self, cx: &App) -> bool {
770 self.buffer().read(cx).read(cx).has_conflict()
771 }
772
773 fn can_save(&self, cx: &App) -> bool {
774 let buffer = &self.buffer().read(cx);
775 if let Some(buffer) = buffer.as_singleton() {
776 buffer.read(cx).project_path(cx).is_some()
777 } else {
778 true
779 }
780 }
781
782 fn save(
783 &mut self,
784 format: bool,
785 project: Entity<Project>,
786 window: &mut Window,
787 cx: &mut Context<Self>,
788 ) -> Task<Result<()>> {
789 self.report_editor_event("Editor Saved", None, cx);
790 let buffers = self.buffer().clone().read(cx).all_buffers();
791 let buffers = buffers
792 .into_iter()
793 .map(|handle| handle.read(cx).base_buffer().unwrap_or(handle.clone()))
794 .collect::<HashSet<_>>();
795 cx.spawn_in(window, async move |this, cx| {
796 if format {
797 this.update_in(cx, |editor, window, cx| {
798 editor.perform_format(
799 project.clone(),
800 FormatTrigger::Save,
801 FormatTarget::Buffers,
802 window,
803 cx,
804 )
805 })?
806 .await?;
807 }
808
809 if buffers.len() == 1 {
810 // Apply full save routine for singleton buffers, to allow to `touch` the file via the editor.
811 project
812 .update(cx, |project, cx| project.save_buffers(buffers, cx))?
813 .await?;
814 } else {
815 // For multi-buffers, only format and save the buffers with changes.
816 // For clean buffers, we simulate saving by calling `Buffer::did_save`,
817 // so that language servers or other downstream listeners of save events get notified.
818 let (dirty_buffers, clean_buffers) = buffers.into_iter().partition(|buffer| {
819 buffer
820 .update(cx, |buffer, _| buffer.is_dirty() || buffer.has_conflict())
821 .unwrap_or(false)
822 });
823
824 project
825 .update(cx, |project, cx| project.save_buffers(dirty_buffers, cx))?
826 .await?;
827 for buffer in clean_buffers {
828 buffer
829 .update(cx, |buffer, cx| {
830 let version = buffer.saved_version().clone();
831 let mtime = buffer.saved_mtime();
832 buffer.did_save(version, mtime, cx);
833 })
834 .ok();
835 }
836 }
837
838 Ok(())
839 })
840 }
841
842 fn save_as(
843 &mut self,
844 project: Entity<Project>,
845 path: ProjectPath,
846 _: &mut Window,
847 cx: &mut Context<Self>,
848 ) -> Task<Result<()>> {
849 let buffer = self
850 .buffer()
851 .read(cx)
852 .as_singleton()
853 .expect("cannot call save_as on an excerpt list");
854
855 let file_extension = path
856 .path
857 .extension()
858 .map(|a| a.to_string_lossy().to_string());
859 self.report_editor_event("Editor Saved", file_extension, cx);
860
861 project.update(cx, |project, cx| project.save_buffer_as(buffer, path, cx))
862 }
863
864 fn reload(
865 &mut self,
866 project: Entity<Project>,
867 window: &mut Window,
868 cx: &mut Context<Self>,
869 ) -> Task<Result<()>> {
870 let buffer = self.buffer().clone();
871 let buffers = self.buffer.read(cx).all_buffers();
872 let reload_buffers =
873 project.update(cx, |project, cx| project.reload_buffers(buffers, true, cx));
874 cx.spawn_in(window, async move |this, cx| {
875 let transaction = reload_buffers.log_err().await;
876 this.update(cx, |editor, cx| {
877 editor.request_autoscroll(Autoscroll::fit(), cx)
878 })?;
879 buffer
880 .update(cx, |buffer, cx| {
881 if let Some(transaction) = transaction {
882 if !buffer.is_singleton() {
883 buffer.push_transaction(&transaction.0, cx);
884 }
885 }
886 })
887 .ok();
888 Ok(())
889 })
890 }
891
892 fn as_searchable(&self, handle: &Entity<Self>) -> Option<Box<dyn SearchableItemHandle>> {
893 Some(Box::new(handle.clone()))
894 }
895
896 fn pixel_position_of_cursor(&self, _: &App) -> Option<gpui::Point<Pixels>> {
897 self.pixel_position_of_newest_cursor
898 }
899
900 fn breadcrumb_location(&self, _: &App) -> ToolbarItemLocation {
901 if self.show_breadcrumbs {
902 ToolbarItemLocation::PrimaryLeft
903 } else {
904 ToolbarItemLocation::Hidden
905 }
906 }
907
908 fn breadcrumbs(&self, variant: &Theme, cx: &App) -> Option<Vec<BreadcrumbText>> {
909 let cursor = self.selections.newest_anchor().head();
910 let multibuffer = &self.buffer().read(cx);
911 let (buffer_id, symbols) =
912 multibuffer.symbols_containing(cursor, Some(variant.syntax()), cx)?;
913 let buffer = multibuffer.buffer(buffer_id)?;
914
915 let buffer = buffer.read(cx);
916 let text = self.breadcrumb_header.clone().unwrap_or_else(|| {
917 buffer
918 .snapshot()
919 .resolve_file_path(
920 cx,
921 self.project
922 .as_ref()
923 .map(|project| project.read(cx).visible_worktrees(cx).count() > 1)
924 .unwrap_or_default(),
925 )
926 .map(|path| path.to_string_lossy().to_string())
927 .unwrap_or_else(|| {
928 if multibuffer.is_singleton() {
929 multibuffer.title(cx).to_string()
930 } else {
931 "untitled".to_string()
932 }
933 })
934 });
935
936 let settings = ThemeSettings::get_global(cx);
937
938 let mut breadcrumbs = vec![BreadcrumbText {
939 text,
940 highlights: None,
941 font: Some(settings.buffer_font.clone()),
942 }];
943
944 breadcrumbs.extend(symbols.into_iter().map(|symbol| BreadcrumbText {
945 text: symbol.text,
946 highlights: Some(symbol.highlight_ranges),
947 font: Some(settings.buffer_font.clone()),
948 }));
949 Some(breadcrumbs)
950 }
951
952 fn added_to_workspace(
953 &mut self,
954 workspace: &mut Workspace,
955 _window: &mut Window,
956 cx: &mut Context<Self>,
957 ) {
958 self.workspace = Some((workspace.weak_handle(), workspace.database_id()));
959 if let Some(workspace) = &workspace.weak_handle().upgrade() {
960 cx.subscribe(&workspace, |editor, _, event: &workspace::Event, _cx| {
961 if matches!(event, workspace::Event::ModalOpened) {
962 editor.mouse_context_menu.take();
963 editor.inline_blame_popover.take();
964 }
965 })
966 .detach();
967 }
968 }
969
970 fn to_item_events(event: &EditorEvent, mut f: impl FnMut(ItemEvent)) {
971 match event {
972 EditorEvent::Closed => f(ItemEvent::CloseItem),
973
974 EditorEvent::Saved | EditorEvent::TitleChanged => {
975 f(ItemEvent::UpdateTab);
976 f(ItemEvent::UpdateBreadcrumbs);
977 }
978
979 EditorEvent::Reparsed(_) => {
980 f(ItemEvent::UpdateBreadcrumbs);
981 }
982
983 EditorEvent::SelectionsChanged { local } if *local => {
984 f(ItemEvent::UpdateBreadcrumbs);
985 }
986
987 EditorEvent::DirtyChanged => {
988 f(ItemEvent::UpdateTab);
989 }
990
991 EditorEvent::BufferEdited => {
992 f(ItemEvent::Edit);
993 f(ItemEvent::UpdateBreadcrumbs);
994 }
995
996 EditorEvent::ExcerptsAdded { .. } | EditorEvent::ExcerptsRemoved { .. } => {
997 f(ItemEvent::Edit);
998 }
999
1000 _ => {}
1001 }
1002 }
1003
1004 fn preserve_preview(&self, cx: &App) -> bool {
1005 self.buffer.read(cx).preserve_preview(cx)
1006 }
1007}
1008
1009impl SerializableItem for Editor {
1010 fn serialized_item_kind() -> &'static str {
1011 "Editor"
1012 }
1013
1014 fn cleanup(
1015 workspace_id: WorkspaceId,
1016 alive_items: Vec<ItemId>,
1017 window: &mut Window,
1018 cx: &mut App,
1019 ) -> Task<Result<()>> {
1020 window.spawn(cx, async move |_| {
1021 DB.delete_unloaded_items(workspace_id, alive_items).await
1022 })
1023 }
1024
1025 fn deserialize(
1026 project: Entity<Project>,
1027 workspace: WeakEntity<Workspace>,
1028 workspace_id: workspace::WorkspaceId,
1029 item_id: ItemId,
1030 window: &mut Window,
1031 cx: &mut App,
1032 ) -> Task<Result<Entity<Self>>> {
1033 let serialized_editor = match DB
1034 .get_serialized_editor(item_id, workspace_id)
1035 .context("Failed to query editor state")
1036 {
1037 Ok(Some(serialized_editor)) => {
1038 if ProjectSettings::get_global(cx)
1039 .session
1040 .restore_unsaved_buffers
1041 {
1042 serialized_editor
1043 } else {
1044 SerializedEditor {
1045 abs_path: serialized_editor.abs_path,
1046 contents: None,
1047 language: None,
1048 mtime: None,
1049 }
1050 }
1051 }
1052 Ok(None) => {
1053 return Task::ready(Err(anyhow!("No path or contents found for buffer")));
1054 }
1055 Err(error) => {
1056 return Task::ready(Err(error));
1057 }
1058 };
1059
1060 match serialized_editor {
1061 SerializedEditor {
1062 abs_path: None,
1063 contents: Some(contents),
1064 language,
1065 ..
1066 } => window.spawn(cx, {
1067 let project = project.clone();
1068 async move |cx| {
1069 let language_registry =
1070 project.update(cx, |project, _| project.languages().clone())?;
1071
1072 let language = if let Some(language_name) = language {
1073 // We don't fail here, because we'd rather not set the language if the name changed
1074 // than fail to restore the buffer.
1075 language_registry
1076 .language_for_name(&language_name)
1077 .await
1078 .ok()
1079 } else {
1080 None
1081 };
1082
1083 // First create the empty buffer
1084 let buffer = project
1085 .update(cx, |project, cx| project.create_buffer(cx))?
1086 .await?;
1087
1088 // Then set the text so that the dirty bit is set correctly
1089 buffer.update(cx, |buffer, cx| {
1090 buffer.set_language_registry(language_registry);
1091 if let Some(language) = language {
1092 buffer.set_language(Some(language), cx);
1093 }
1094 buffer.set_text(contents, cx);
1095 if let Some(entry) = buffer.peek_undo_stack() {
1096 buffer.forget_transaction(entry.transaction_id());
1097 }
1098 })?;
1099
1100 cx.update(|window, cx| {
1101 cx.new(|cx| {
1102 let mut editor = Editor::for_buffer(buffer, Some(project), window, cx);
1103
1104 editor.read_metadata_from_db(item_id, workspace_id, window, cx);
1105 editor
1106 })
1107 })
1108 }
1109 }),
1110 SerializedEditor {
1111 abs_path: Some(abs_path),
1112 contents,
1113 mtime,
1114 ..
1115 } => {
1116 let project_item = project.update(cx, |project, cx| {
1117 let (worktree, path) = project.find_worktree(&abs_path, cx)?;
1118 let project_path = ProjectPath {
1119 worktree_id: worktree.read(cx).id(),
1120 path: path.into(),
1121 };
1122 Some(project.open_path(project_path, cx))
1123 });
1124
1125 match project_item {
1126 Some(project_item) => {
1127 window.spawn(cx, async move |cx| {
1128 let (_, project_item) = project_item.await?;
1129 let buffer = project_item.downcast::<Buffer>().map_err(|_| {
1130 anyhow!("Project item at stored path was not a buffer")
1131 })?;
1132
1133 // This is a bit wasteful: we're loading the whole buffer from
1134 // disk and then overwrite the content.
1135 // But for now, it keeps the implementation of the content serialization
1136 // simple, because we don't have to persist all of the metadata that we get
1137 // by loading the file (git diff base, ...).
1138 if let Some(buffer_text) = contents {
1139 buffer.update(cx, |buffer, cx| {
1140 // If we did restore an mtime, we want to store it on the buffer
1141 // so that the next edit will mark the buffer as dirty/conflicted.
1142 if mtime.is_some() {
1143 buffer.did_reload(
1144 buffer.version(),
1145 buffer.line_ending(),
1146 mtime,
1147 cx,
1148 );
1149 }
1150 buffer.set_text(buffer_text, cx);
1151 if let Some(entry) = buffer.peek_undo_stack() {
1152 buffer.forget_transaction(entry.transaction_id());
1153 }
1154 })?;
1155 }
1156
1157 cx.update(|window, cx| {
1158 cx.new(|cx| {
1159 let mut editor =
1160 Editor::for_buffer(buffer, Some(project), window, cx);
1161
1162 editor.read_metadata_from_db(item_id, workspace_id, window, cx);
1163 editor
1164 })
1165 })
1166 })
1167 }
1168 None => {
1169 let open_by_abs_path = workspace.update(cx, |workspace, cx| {
1170 workspace.open_abs_path(
1171 abs_path.clone(),
1172 OpenOptions {
1173 visible: Some(OpenVisible::None),
1174 ..Default::default()
1175 },
1176 window,
1177 cx,
1178 )
1179 });
1180 window.spawn(cx, async move |cx| {
1181 let editor = open_by_abs_path?.await?.downcast::<Editor>().with_context(|| format!("Failed to downcast to Editor after opening abs path {abs_path:?}"))?;
1182 editor.update_in(cx, |editor, window, cx| {
1183 editor.read_metadata_from_db(item_id, workspace_id, window, cx);
1184 })?;
1185 Ok(editor)
1186 })
1187 }
1188 }
1189 }
1190 SerializedEditor {
1191 abs_path: None,
1192 contents: None,
1193 ..
1194 } => Task::ready(Err(anyhow!("No path or contents found for buffer"))),
1195 }
1196 }
1197
1198 fn serialize(
1199 &mut self,
1200 workspace: &mut Workspace,
1201 item_id: ItemId,
1202 closing: bool,
1203 window: &mut Window,
1204 cx: &mut Context<Self>,
1205 ) -> Option<Task<Result<()>>> {
1206 let mut serialize_dirty_buffers = self.serialize_dirty_buffers;
1207
1208 let project = self.project.clone()?;
1209 if project.read(cx).visible_worktrees(cx).next().is_none() {
1210 // If we don't have a worktree, we don't serialize, because
1211 // projects without worktrees aren't deserialized.
1212 serialize_dirty_buffers = false;
1213 }
1214
1215 if closing && !serialize_dirty_buffers {
1216 return None;
1217 }
1218
1219 let workspace_id = workspace.database_id()?;
1220
1221 let buffer = self.buffer().read(cx).as_singleton()?;
1222
1223 let abs_path = buffer.read(cx).file().and_then(|file| {
1224 let worktree_id = file.worktree_id(cx);
1225 project
1226 .read(cx)
1227 .worktree_for_id(worktree_id, cx)
1228 .and_then(|worktree| worktree.read(cx).absolutize(&file.path()).ok())
1229 .or_else(|| {
1230 let full_path = file.full_path(cx);
1231 let project_path = project.read(cx).find_project_path(&full_path, cx)?;
1232 project.read(cx).absolute_path(&project_path, cx)
1233 })
1234 });
1235
1236 let is_dirty = buffer.read(cx).is_dirty();
1237 let mtime = buffer.read(cx).saved_mtime();
1238
1239 let snapshot = buffer.read(cx).snapshot();
1240
1241 Some(cx.spawn_in(window, async move |_this, cx| {
1242 cx.background_spawn(async move {
1243 let (contents, language) = if serialize_dirty_buffers && is_dirty {
1244 let contents = snapshot.text();
1245 let language = snapshot.language().map(|lang| lang.name().to_string());
1246 (Some(contents), language)
1247 } else {
1248 (None, None)
1249 };
1250
1251 let editor = SerializedEditor {
1252 abs_path,
1253 contents,
1254 language,
1255 mtime,
1256 };
1257 log::debug!("Serializing editor {item_id:?} in workspace {workspace_id:?}");
1258 DB.save_serialized_editor(item_id, workspace_id, editor)
1259 .await
1260 .context("failed to save serialized editor")
1261 })
1262 .await
1263 .context("failed to save contents of buffer")?;
1264
1265 Ok(())
1266 }))
1267 }
1268
1269 fn should_serialize(&self, event: &Self::Event) -> bool {
1270 matches!(
1271 event,
1272 EditorEvent::Saved | EditorEvent::DirtyChanged | EditorEvent::BufferEdited
1273 )
1274 }
1275}
1276
1277#[derive(Debug, Default)]
1278struct EditorRestorationData {
1279 entries: HashMap<PathBuf, RestorationData>,
1280}
1281
1282#[derive(Default, Debug)]
1283pub struct RestorationData {
1284 pub scroll_position: (BufferRow, gpui::Point<f32>),
1285 pub folds: Vec<Range<Point>>,
1286 pub selections: Vec<Range<Point>>,
1287}
1288
1289impl ProjectItem for Editor {
1290 type Item = Buffer;
1291
1292 fn project_item_kind() -> Option<ProjectItemKind> {
1293 Some(ProjectItemKind("Editor"))
1294 }
1295
1296 fn for_project_item(
1297 project: Entity<Project>,
1298 pane: &Pane,
1299 buffer: Entity<Buffer>,
1300 window: &mut Window,
1301 cx: &mut Context<Self>,
1302 ) -> Self {
1303 let mut editor = Self::for_buffer(buffer.clone(), Some(project), window, cx);
1304 if let Some((excerpt_id, buffer_id, snapshot)) =
1305 editor.buffer().read(cx).snapshot(cx).as_singleton()
1306 {
1307 if WorkspaceSettings::get(None, cx).restore_on_file_reopen {
1308 if let Some(restoration_data) = Self::project_item_kind()
1309 .and_then(|kind| pane.project_item_restoration_data.get(&kind))
1310 .and_then(|data| data.downcast_ref::<EditorRestorationData>())
1311 .and_then(|data| {
1312 let file = project::File::from_dyn(buffer.read(cx).file())?;
1313 data.entries.get(&file.abs_path(cx))
1314 })
1315 {
1316 editor.fold_ranges(
1317 clip_ranges(&restoration_data.folds, &snapshot),
1318 false,
1319 window,
1320 cx,
1321 );
1322 if !restoration_data.selections.is_empty() {
1323 editor.change_selections(None, window, cx, |s| {
1324 s.select_ranges(clip_ranges(&restoration_data.selections, &snapshot));
1325 });
1326 }
1327 let (top_row, offset) = restoration_data.scroll_position;
1328 let anchor = Anchor::in_buffer(
1329 *excerpt_id,
1330 buffer_id,
1331 snapshot.anchor_before(Point::new(top_row, 0)),
1332 );
1333 editor.set_scroll_anchor(ScrollAnchor { anchor, offset }, window, cx);
1334 }
1335 }
1336 }
1337
1338 editor
1339 }
1340}
1341
1342fn clip_ranges<'a>(
1343 original: impl IntoIterator<Item = &'a Range<Point>> + 'a,
1344 snapshot: &'a BufferSnapshot,
1345) -> Vec<Range<Point>> {
1346 original
1347 .into_iter()
1348 .map(|range| {
1349 snapshot.clip_point(range.start, Bias::Left)
1350 ..snapshot.clip_point(range.end, Bias::Right)
1351 })
1352 .collect()
1353}
1354
1355impl EventEmitter<SearchEvent> for Editor {}
1356
1357impl Editor {
1358 pub fn update_restoration_data(
1359 &self,
1360 cx: &mut Context<Self>,
1361 write: impl for<'a> FnOnce(&'a mut RestorationData) + 'static,
1362 ) {
1363 if !WorkspaceSettings::get(None, cx).restore_on_file_reopen {
1364 return;
1365 }
1366
1367 let editor = cx.entity();
1368 cx.defer(move |cx| {
1369 editor.update(cx, |editor, cx| {
1370 let kind = Editor::project_item_kind()?;
1371 let pane = editor.workspace()?.read(cx).pane_for(&cx.entity())?;
1372 let buffer = editor.buffer().read(cx).as_singleton()?;
1373 let file_abs_path = project::File::from_dyn(buffer.read(cx).file())?.abs_path(cx);
1374 pane.update(cx, |pane, _| {
1375 let data = pane
1376 .project_item_restoration_data
1377 .entry(kind)
1378 .or_insert_with(|| Box::new(EditorRestorationData::default()) as Box<_>);
1379 let data = match data.downcast_mut::<EditorRestorationData>() {
1380 Some(data) => data,
1381 None => {
1382 *data = Box::new(EditorRestorationData::default());
1383 data.downcast_mut::<EditorRestorationData>()
1384 .expect("just written the type downcasted to")
1385 }
1386 };
1387
1388 let data = data.entries.entry(file_abs_path).or_default();
1389 write(data);
1390 Some(())
1391 })
1392 });
1393 });
1394 }
1395}
1396
1397pub(crate) enum BufferSearchHighlights {}
1398impl SearchableItem for Editor {
1399 type Match = Range<Anchor>;
1400
1401 fn get_matches(&self, _window: &mut Window, _: &mut App) -> Vec<Range<Anchor>> {
1402 self.background_highlights
1403 .get(&TypeId::of::<BufferSearchHighlights>())
1404 .map_or(Vec::new(), |(_color, ranges)| {
1405 ranges.iter().cloned().collect()
1406 })
1407 }
1408
1409 fn clear_matches(&mut self, _: &mut Window, cx: &mut Context<Self>) {
1410 if self
1411 .clear_background_highlights::<BufferSearchHighlights>(cx)
1412 .is_some()
1413 {
1414 cx.emit(SearchEvent::MatchesInvalidated);
1415 }
1416 }
1417
1418 fn update_matches(
1419 &mut self,
1420 matches: &[Range<Anchor>],
1421 _: &mut Window,
1422 cx: &mut Context<Self>,
1423 ) {
1424 let existing_range = self
1425 .background_highlights
1426 .get(&TypeId::of::<BufferSearchHighlights>())
1427 .map(|(_, range)| range.as_ref());
1428 let updated = existing_range != Some(matches);
1429 self.highlight_background::<BufferSearchHighlights>(
1430 matches,
1431 |theme| theme.search_match_background,
1432 cx,
1433 );
1434 if updated {
1435 cx.emit(SearchEvent::MatchesInvalidated);
1436 }
1437 }
1438
1439 fn has_filtered_search_ranges(&mut self) -> bool {
1440 self.has_background_highlights::<SearchWithinRange>()
1441 }
1442
1443 fn toggle_filtered_search_ranges(
1444 &mut self,
1445 enabled: bool,
1446 _: &mut Window,
1447 cx: &mut Context<Self>,
1448 ) {
1449 if self.has_filtered_search_ranges() {
1450 self.previous_search_ranges = self
1451 .clear_background_highlights::<SearchWithinRange>(cx)
1452 .map(|(_, ranges)| ranges)
1453 }
1454
1455 if !enabled {
1456 return;
1457 }
1458
1459 let ranges = self.selections.disjoint_anchor_ranges().collect::<Vec<_>>();
1460 if ranges.iter().any(|s| s.start != s.end) {
1461 self.set_search_within_ranges(&ranges, cx);
1462 } else if let Some(previous_search_ranges) = self.previous_search_ranges.take() {
1463 self.set_search_within_ranges(&previous_search_ranges, cx)
1464 }
1465 }
1466
1467 fn supported_options(&self) -> SearchOptions {
1468 if self.in_project_search {
1469 SearchOptions {
1470 case: true,
1471 word: true,
1472 regex: true,
1473 replacement: false,
1474 selection: false,
1475 find_in_results: true,
1476 }
1477 } else {
1478 SearchOptions {
1479 case: true,
1480 word: true,
1481 regex: true,
1482 replacement: true,
1483 selection: true,
1484 find_in_results: false,
1485 }
1486 }
1487 }
1488
1489 fn query_suggestion(&mut self, window: &mut Window, cx: &mut Context<Self>) -> String {
1490 let setting = EditorSettings::get_global(cx).seed_search_query_from_cursor;
1491 let snapshot = &self.snapshot(window, cx).buffer_snapshot;
1492 let selection = self.selections.newest::<usize>(cx);
1493
1494 match setting {
1495 SeedQuerySetting::Never => String::new(),
1496 SeedQuerySetting::Selection | SeedQuerySetting::Always if !selection.is_empty() => {
1497 let text: String = snapshot
1498 .text_for_range(selection.start..selection.end)
1499 .collect();
1500 if text.contains('\n') {
1501 String::new()
1502 } else {
1503 text
1504 }
1505 }
1506 SeedQuerySetting::Selection => String::new(),
1507 SeedQuerySetting::Always => {
1508 let (range, kind) = snapshot.surrounding_word(selection.start, true);
1509 if kind == Some(CharKind::Word) {
1510 let text: String = snapshot.text_for_range(range).collect();
1511 if !text.trim().is_empty() {
1512 return text;
1513 }
1514 }
1515 String::new()
1516 }
1517 }
1518 }
1519
1520 fn activate_match(
1521 &mut self,
1522 index: usize,
1523 matches: &[Range<Anchor>],
1524 window: &mut Window,
1525 cx: &mut Context<Self>,
1526 ) {
1527 self.unfold_ranges(&[matches[index].clone()], false, true, cx);
1528 let range = self.range_for_match(&matches[index]);
1529 self.change_selections(Some(Autoscroll::fit()), window, cx, |s| {
1530 s.select_ranges([range]);
1531 })
1532 }
1533
1534 fn select_matches(
1535 &mut self,
1536 matches: &[Self::Match],
1537 window: &mut Window,
1538 cx: &mut Context<Self>,
1539 ) {
1540 self.unfold_ranges(matches, false, false, cx);
1541 self.change_selections(None, window, cx, |s| {
1542 s.select_ranges(matches.iter().cloned())
1543 });
1544 }
1545 fn replace(
1546 &mut self,
1547 identifier: &Self::Match,
1548 query: &SearchQuery,
1549 window: &mut Window,
1550 cx: &mut Context<Self>,
1551 ) {
1552 let text = self.buffer.read(cx);
1553 let text = text.snapshot(cx);
1554 let text = text.text_for_range(identifier.clone()).collect::<Vec<_>>();
1555 let text: Cow<_> = if text.len() == 1 {
1556 text.first().cloned().unwrap().into()
1557 } else {
1558 let joined_chunks = text.join("");
1559 joined_chunks.into()
1560 };
1561
1562 if let Some(replacement) = query.replacement_for(&text) {
1563 self.transact(window, cx, |this, _, cx| {
1564 this.edit([(identifier.clone(), Arc::from(&*replacement))], cx);
1565 });
1566 }
1567 }
1568 fn replace_all(
1569 &mut self,
1570 matches: &mut dyn Iterator<Item = &Self::Match>,
1571 query: &SearchQuery,
1572 window: &mut Window,
1573 cx: &mut Context<Self>,
1574 ) {
1575 let text = self.buffer.read(cx);
1576 let text = text.snapshot(cx);
1577 let mut edits = vec![];
1578 let mut last_point: Option<Point> = None;
1579
1580 for m in matches {
1581 let point = m.start.to_point(&text);
1582 let text = text.text_for_range(m.clone()).collect::<Vec<_>>();
1583
1584 // Check if the row for the current match is different from the last
1585 // match. If that's not the case and we're still replacing matches
1586 // in the same row/line, skip this match if the `one_match_per_line`
1587 // option is enabled.
1588 if last_point.is_none() {
1589 last_point = Some(point);
1590 } else if last_point.is_some() && point.row != last_point.unwrap().row {
1591 last_point = Some(point);
1592 } else if query.one_match_per_line().is_some_and(|enabled| enabled) {
1593 continue;
1594 }
1595
1596 let text: Cow<_> = if text.len() == 1 {
1597 text.first().cloned().unwrap().into()
1598 } else {
1599 let joined_chunks = text.join("");
1600 joined_chunks.into()
1601 };
1602
1603 if let Some(replacement) = query.replacement_for(&text) {
1604 edits.push((m.clone(), Arc::from(&*replacement)));
1605 }
1606 }
1607
1608 if !edits.is_empty() {
1609 self.transact(window, cx, |this, _, cx| {
1610 this.edit(edits, cx);
1611 });
1612 }
1613 }
1614 fn match_index_for_direction(
1615 &mut self,
1616 matches: &[Range<Anchor>],
1617 current_index: usize,
1618 direction: Direction,
1619 count: usize,
1620 _: &mut Window,
1621 cx: &mut Context<Self>,
1622 ) -> usize {
1623 let buffer = self.buffer().read(cx).snapshot(cx);
1624 let current_index_position = if self.selections.disjoint_anchors().len() == 1 {
1625 self.selections.newest_anchor().head()
1626 } else {
1627 matches[current_index].start
1628 };
1629
1630 let mut count = count % matches.len();
1631 if count == 0 {
1632 return current_index;
1633 }
1634 match direction {
1635 Direction::Next => {
1636 if matches[current_index]
1637 .start
1638 .cmp(¤t_index_position, &buffer)
1639 .is_gt()
1640 {
1641 count -= 1
1642 }
1643
1644 (current_index + count) % matches.len()
1645 }
1646 Direction::Prev => {
1647 if matches[current_index]
1648 .end
1649 .cmp(¤t_index_position, &buffer)
1650 .is_lt()
1651 {
1652 count -= 1;
1653 }
1654
1655 if current_index >= count {
1656 current_index - count
1657 } else {
1658 matches.len() - (count - current_index)
1659 }
1660 }
1661 }
1662 }
1663
1664 fn find_matches(
1665 &mut self,
1666 query: Arc<project::search::SearchQuery>,
1667 _: &mut Window,
1668 cx: &mut Context<Self>,
1669 ) -> Task<Vec<Range<Anchor>>> {
1670 let buffer = self.buffer().read(cx).snapshot(cx);
1671 let search_within_ranges = self
1672 .background_highlights
1673 .get(&TypeId::of::<SearchWithinRange>())
1674 .map_or(vec![], |(_color, ranges)| {
1675 ranges.iter().cloned().collect::<Vec<_>>()
1676 });
1677
1678 cx.background_spawn(async move {
1679 let mut ranges = Vec::new();
1680
1681 let search_within_ranges = if search_within_ranges.is_empty() {
1682 vec![buffer.anchor_before(0)..buffer.anchor_after(buffer.len())]
1683 } else {
1684 search_within_ranges
1685 };
1686
1687 for range in search_within_ranges {
1688 for (search_buffer, search_range, excerpt_id, deleted_hunk_anchor) in
1689 buffer.range_to_buffer_ranges_with_deleted_hunks(range)
1690 {
1691 ranges.extend(
1692 query
1693 .search(search_buffer, Some(search_range.clone()))
1694 .await
1695 .into_iter()
1696 .map(|match_range| {
1697 if let Some(deleted_hunk_anchor) = deleted_hunk_anchor {
1698 let start = search_buffer
1699 .anchor_after(search_range.start + match_range.start);
1700 let end = search_buffer
1701 .anchor_before(search_range.start + match_range.end);
1702 Anchor {
1703 diff_base_anchor: Some(start),
1704 ..deleted_hunk_anchor
1705 }..Anchor {
1706 diff_base_anchor: Some(end),
1707 ..deleted_hunk_anchor
1708 }
1709 } else {
1710 let start = search_buffer
1711 .anchor_after(search_range.start + match_range.start);
1712 let end = search_buffer
1713 .anchor_before(search_range.start + match_range.end);
1714 Anchor::range_in_buffer(
1715 excerpt_id,
1716 search_buffer.remote_id(),
1717 start..end,
1718 )
1719 }
1720 }),
1721 );
1722 }
1723 }
1724
1725 ranges
1726 })
1727 }
1728
1729 fn active_match_index(
1730 &mut self,
1731 direction: Direction,
1732 matches: &[Range<Anchor>],
1733 _: &mut Window,
1734 cx: &mut Context<Self>,
1735 ) -> Option<usize> {
1736 active_match_index(
1737 direction,
1738 matches,
1739 &self.selections.newest_anchor().head(),
1740 &self.buffer().read(cx).snapshot(cx),
1741 )
1742 }
1743
1744 fn search_bar_visibility_changed(&mut self, _: bool, _: &mut Window, _: &mut Context<Self>) {
1745 self.expect_bounds_change = self.last_bounds;
1746 }
1747}
1748
1749pub fn active_match_index(
1750 direction: Direction,
1751 ranges: &[Range<Anchor>],
1752 cursor: &Anchor,
1753 buffer: &MultiBufferSnapshot,
1754) -> Option<usize> {
1755 if ranges.is_empty() {
1756 None
1757 } else {
1758 let r = ranges.binary_search_by(|probe| {
1759 if probe.end.cmp(cursor, buffer).is_lt() {
1760 Ordering::Less
1761 } else if probe.start.cmp(cursor, buffer).is_gt() {
1762 Ordering::Greater
1763 } else {
1764 Ordering::Equal
1765 }
1766 });
1767 match direction {
1768 Direction::Prev => match r {
1769 Ok(i) => Some(i),
1770 Err(i) => Some(i.saturating_sub(1)),
1771 },
1772 Direction::Next => match r {
1773 Ok(i) | Err(i) => Some(cmp::min(i, ranges.len() - 1)),
1774 },
1775 }
1776 }
1777}
1778
1779pub fn entry_label_color(selected: bool) -> Color {
1780 if selected {
1781 Color::Default
1782 } else {
1783 Color::Muted
1784 }
1785}
1786
1787pub fn entry_diagnostic_aware_icon_name_and_color(
1788 diagnostic_severity: Option<DiagnosticSeverity>,
1789) -> Option<(IconName, Color)> {
1790 match diagnostic_severity {
1791 Some(DiagnosticSeverity::ERROR) => Some((IconName::X, Color::Error)),
1792 Some(DiagnosticSeverity::WARNING) => Some((IconName::Triangle, Color::Warning)),
1793 _ => None,
1794 }
1795}
1796
1797pub fn entry_diagnostic_aware_icon_decoration_and_color(
1798 diagnostic_severity: Option<DiagnosticSeverity>,
1799) -> Option<(IconDecorationKind, Color)> {
1800 match diagnostic_severity {
1801 Some(DiagnosticSeverity::ERROR) => Some((IconDecorationKind::X, Color::Error)),
1802 Some(DiagnosticSeverity::WARNING) => Some((IconDecorationKind::Triangle, Color::Warning)),
1803 _ => None,
1804 }
1805}
1806
1807pub fn entry_git_aware_label_color(git_status: GitSummary, ignored: bool, selected: bool) -> Color {
1808 let tracked = git_status.index + git_status.worktree;
1809 if ignored {
1810 Color::Ignored
1811 } else if git_status.conflict > 0 {
1812 Color::Conflict
1813 } else if tracked.modified > 0 {
1814 Color::Modified
1815 } else if tracked.added > 0 || git_status.untracked > 0 {
1816 Color::Created
1817 } else {
1818 entry_label_color(selected)
1819 }
1820}
1821
1822fn path_for_buffer<'a>(
1823 buffer: &Entity<MultiBuffer>,
1824 height: usize,
1825 include_filename: bool,
1826 cx: &'a App,
1827) -> Option<Cow<'a, Path>> {
1828 let file = buffer.read(cx).as_singleton()?.read(cx).file()?;
1829 path_for_file(file.as_ref(), height, include_filename, cx)
1830}
1831
1832fn path_for_file<'a>(
1833 file: &'a dyn language::File,
1834 mut height: usize,
1835 include_filename: bool,
1836 cx: &'a App,
1837) -> Option<Cow<'a, Path>> {
1838 // Ensure we always render at least the filename.
1839 height += 1;
1840
1841 let mut prefix = file.path().as_ref();
1842 while height > 0 {
1843 if let Some(parent) = prefix.parent() {
1844 prefix = parent;
1845 height -= 1;
1846 } else {
1847 break;
1848 }
1849 }
1850
1851 // Here we could have just always used `full_path`, but that is very
1852 // allocation-heavy and so we try to use a `Cow<Path>` if we haven't
1853 // traversed all the way up to the worktree's root.
1854 if height > 0 {
1855 let full_path = file.full_path(cx);
1856 if include_filename {
1857 Some(full_path.into())
1858 } else {
1859 Some(full_path.parent()?.to_path_buf().into())
1860 }
1861 } else {
1862 let mut path = file.path().strip_prefix(prefix).ok()?;
1863 if !include_filename {
1864 path = path.parent()?;
1865 }
1866 Some(path.into())
1867 }
1868}
1869
1870#[cfg(test)]
1871mod tests {
1872 use crate::editor_tests::init_test;
1873 use fs::Fs;
1874
1875 use super::*;
1876 use fs::MTime;
1877 use gpui::{App, VisualTestContext};
1878 use language::{LanguageMatcher, TestFile};
1879 use project::FakeFs;
1880 use std::path::{Path, PathBuf};
1881 use util::path;
1882
1883 #[gpui::test]
1884 fn test_path_for_file(cx: &mut App) {
1885 let file = TestFile {
1886 path: Path::new("").into(),
1887 root_name: String::new(),
1888 local_root: None,
1889 };
1890 assert_eq!(path_for_file(&file, 0, false, cx), None);
1891 }
1892
1893 async fn deserialize_editor(
1894 item_id: ItemId,
1895 workspace_id: WorkspaceId,
1896 workspace: Entity<Workspace>,
1897 project: Entity<Project>,
1898 cx: &mut VisualTestContext,
1899 ) -> Entity<Editor> {
1900 workspace
1901 .update_in(cx, |workspace, window, cx| {
1902 let pane = workspace.active_pane();
1903 pane.update(cx, |_, cx| {
1904 Editor::deserialize(
1905 project.clone(),
1906 workspace.weak_handle(),
1907 workspace_id,
1908 item_id,
1909 window,
1910 cx,
1911 )
1912 })
1913 })
1914 .await
1915 .unwrap()
1916 }
1917
1918 fn rust_language() -> Arc<language::Language> {
1919 Arc::new(language::Language::new(
1920 language::LanguageConfig {
1921 name: "Rust".into(),
1922 matcher: LanguageMatcher {
1923 path_suffixes: vec!["rs".to_string()],
1924 ..Default::default()
1925 },
1926 ..Default::default()
1927 },
1928 Some(tree_sitter_rust::LANGUAGE.into()),
1929 ))
1930 }
1931
1932 #[gpui::test]
1933 async fn test_deserialize(cx: &mut gpui::TestAppContext) {
1934 init_test(cx, |_| {});
1935
1936 let fs = FakeFs::new(cx.executor());
1937 fs.insert_file(path!("/file.rs"), Default::default()).await;
1938
1939 // Test case 1: Deserialize with path and contents
1940 {
1941 let project = Project::test(fs.clone(), [path!("/file.rs").as_ref()], cx).await;
1942 let (workspace, cx) =
1943 cx.add_window_view(|window, cx| Workspace::test_new(project.clone(), window, cx));
1944 let workspace_id = workspace::WORKSPACE_DB.next_id().await.unwrap();
1945 let item_id = 1234 as ItemId;
1946 let mtime = fs
1947 .metadata(Path::new(path!("/file.rs")))
1948 .await
1949 .unwrap()
1950 .unwrap()
1951 .mtime;
1952
1953 let serialized_editor = SerializedEditor {
1954 abs_path: Some(PathBuf::from(path!("/file.rs"))),
1955 contents: Some("fn main() {}".to_string()),
1956 language: Some("Rust".to_string()),
1957 mtime: Some(mtime),
1958 };
1959
1960 DB.save_serialized_editor(item_id, workspace_id, serialized_editor.clone())
1961 .await
1962 .unwrap();
1963
1964 let deserialized =
1965 deserialize_editor(item_id, workspace_id, workspace, project, cx).await;
1966
1967 deserialized.update(cx, |editor, cx| {
1968 assert_eq!(editor.text(cx), "fn main() {}");
1969 assert!(editor.is_dirty(cx));
1970 assert!(!editor.has_conflict(cx));
1971 let buffer = editor.buffer().read(cx).as_singleton().unwrap().read(cx);
1972 assert!(buffer.file().is_some());
1973 });
1974 }
1975
1976 // Test case 2: Deserialize with only path
1977 {
1978 let project = Project::test(fs.clone(), [path!("/file.rs").as_ref()], cx).await;
1979 let (workspace, cx) =
1980 cx.add_window_view(|window, cx| Workspace::test_new(project.clone(), window, cx));
1981
1982 let workspace_id = workspace::WORKSPACE_DB.next_id().await.unwrap();
1983
1984 let item_id = 5678 as ItemId;
1985 let serialized_editor = SerializedEditor {
1986 abs_path: Some(PathBuf::from(path!("/file.rs"))),
1987 contents: None,
1988 language: None,
1989 mtime: None,
1990 };
1991
1992 DB.save_serialized_editor(item_id, workspace_id, serialized_editor)
1993 .await
1994 .unwrap();
1995
1996 let deserialized =
1997 deserialize_editor(item_id, workspace_id, workspace, project, cx).await;
1998
1999 deserialized.update(cx, |editor, cx| {
2000 assert_eq!(editor.text(cx), ""); // The file should be empty as per our initial setup
2001 assert!(!editor.is_dirty(cx));
2002 assert!(!editor.has_conflict(cx));
2003
2004 let buffer = editor.buffer().read(cx).as_singleton().unwrap().read(cx);
2005 assert!(buffer.file().is_some());
2006 });
2007 }
2008
2009 // Test case 3: Deserialize with no path (untitled buffer, with content and language)
2010 {
2011 let project = Project::test(fs.clone(), [path!("/file.rs").as_ref()], cx).await;
2012 // Add Rust to the language, so that we can restore the language of the buffer
2013 project.update(cx, |project, _| project.languages().add(rust_language()));
2014
2015 let (workspace, cx) =
2016 cx.add_window_view(|window, cx| Workspace::test_new(project.clone(), window, cx));
2017
2018 let workspace_id = workspace::WORKSPACE_DB.next_id().await.unwrap();
2019
2020 let item_id = 9012 as ItemId;
2021 let serialized_editor = SerializedEditor {
2022 abs_path: None,
2023 contents: Some("hello".to_string()),
2024 language: Some("Rust".to_string()),
2025 mtime: None,
2026 };
2027
2028 DB.save_serialized_editor(item_id, workspace_id, serialized_editor)
2029 .await
2030 .unwrap();
2031
2032 let deserialized =
2033 deserialize_editor(item_id, workspace_id, workspace, project, cx).await;
2034
2035 deserialized.update(cx, |editor, cx| {
2036 assert_eq!(editor.text(cx), "hello");
2037 assert!(editor.is_dirty(cx)); // The editor should be dirty for an untitled buffer
2038
2039 let buffer = editor.buffer().read(cx).as_singleton().unwrap().read(cx);
2040 assert_eq!(
2041 buffer.language().map(|lang| lang.name()),
2042 Some("Rust".into())
2043 ); // Language should be set to Rust
2044 assert!(buffer.file().is_none()); // The buffer should not have an associated file
2045 });
2046 }
2047
2048 // Test case 4: Deserialize with path, content, and old mtime
2049 {
2050 let project = Project::test(fs.clone(), [path!("/file.rs").as_ref()], cx).await;
2051 let (workspace, cx) =
2052 cx.add_window_view(|window, cx| Workspace::test_new(project.clone(), window, cx));
2053
2054 let workspace_id = workspace::WORKSPACE_DB.next_id().await.unwrap();
2055
2056 let item_id = 9345 as ItemId;
2057 let old_mtime = MTime::from_seconds_and_nanos(0, 50);
2058 let serialized_editor = SerializedEditor {
2059 abs_path: Some(PathBuf::from(path!("/file.rs"))),
2060 contents: Some("fn main() {}".to_string()),
2061 language: Some("Rust".to_string()),
2062 mtime: Some(old_mtime),
2063 };
2064
2065 DB.save_serialized_editor(item_id, workspace_id, serialized_editor)
2066 .await
2067 .unwrap();
2068
2069 let deserialized =
2070 deserialize_editor(item_id, workspace_id, workspace, project, cx).await;
2071
2072 deserialized.update(cx, |editor, cx| {
2073 assert_eq!(editor.text(cx), "fn main() {}");
2074 assert!(editor.has_conflict(cx)); // The editor should have a conflict
2075 });
2076 }
2077 }
2078}