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