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 has_deleted_file(&self, cx: &App) -> bool {
809 self.buffer().read(cx).read(cx).has_deleted_file()
810 }
811
812 fn has_conflict(&self, cx: &App) -> bool {
813 self.buffer().read(cx).read(cx).has_conflict()
814 }
815
816 fn can_save(&self, cx: &App) -> bool {
817 let buffer = &self.buffer().read(cx);
818 if let Some(buffer) = buffer.as_singleton() {
819 buffer.read(cx).project_path(cx).is_some()
820 } else {
821 true
822 }
823 }
824
825 fn save(
826 &mut self,
827 options: SaveOptions,
828 project: Entity<Project>,
829 window: &mut Window,
830 cx: &mut Context<Self>,
831 ) -> Task<Result<()>> {
832 // Add meta data tracking # of auto saves
833 if options.autosave {
834 self.report_editor_event(ReportEditorEvent::Saved { auto_saved: true }, None, cx);
835 } else {
836 self.report_editor_event(ReportEditorEvent::Saved { auto_saved: false }, None, cx);
837 }
838
839 let buffers = self.buffer().clone().read(cx).all_buffers();
840 let buffers = buffers
841 .into_iter()
842 .map(|handle| handle.read(cx).base_buffer().unwrap_or(handle.clone()))
843 .collect::<HashSet<_>>();
844
845 // let mut buffers_to_save =
846 let buffers_to_save = if self.buffer.read(cx).is_singleton() && !options.autosave {
847 buffers
848 } else {
849 buffers
850 .into_iter()
851 .filter(|buffer| buffer.read(cx).is_dirty())
852 .collect()
853 };
854
855 cx.spawn_in(window, async move |this, cx| {
856 if options.format {
857 this.update_in(cx, |editor, window, cx| {
858 editor.perform_format(
859 project.clone(),
860 FormatTrigger::Save,
861 FormatTarget::Buffers(buffers_to_save.clone()),
862 window,
863 cx,
864 )
865 })?
866 .await?;
867 }
868
869 if !buffers_to_save.is_empty() {
870 project
871 .update(cx, |project, cx| {
872 project.save_buffers(buffers_to_save.clone(), cx)
873 })?
874 .await?;
875 }
876
877 Ok(())
878 })
879 }
880
881 fn save_as(
882 &mut self,
883 project: Entity<Project>,
884 path: ProjectPath,
885 _: &mut Window,
886 cx: &mut Context<Self>,
887 ) -> Task<Result<()>> {
888 let buffer = self
889 .buffer()
890 .read(cx)
891 .as_singleton()
892 .expect("cannot call save_as on an excerpt list");
893
894 let file_extension = path.path.extension().map(|a| a.to_string());
895 self.report_editor_event(
896 ReportEditorEvent::Saved { auto_saved: false },
897 file_extension,
898 cx,
899 );
900
901 project.update(cx, |project, cx| project.save_buffer_as(buffer, path, cx))
902 }
903
904 fn reload(
905 &mut self,
906 project: Entity<Project>,
907 window: &mut Window,
908 cx: &mut Context<Self>,
909 ) -> Task<Result<()>> {
910 let buffer = self.buffer().clone();
911 let buffers = self.buffer.read(cx).all_buffers();
912 let reload_buffers =
913 project.update(cx, |project, cx| project.reload_buffers(buffers, true, cx));
914 cx.spawn_in(window, async move |this, cx| {
915 let transaction = reload_buffers.log_err().await;
916 this.update(cx, |editor, cx| {
917 editor.request_autoscroll(Autoscroll::fit(), cx)
918 })?;
919 buffer
920 .update(cx, |buffer, cx| {
921 if let Some(transaction) = transaction
922 && !buffer.is_singleton()
923 {
924 buffer.push_transaction(&transaction.0, cx);
925 }
926 })
927 .ok();
928 Ok(())
929 })
930 }
931
932 fn as_searchable(
933 &self,
934 handle: &Entity<Self>,
935 _: &App,
936 ) -> Option<Box<dyn SearchableItemHandle>> {
937 Some(Box::new(handle.clone()))
938 }
939
940 fn pixel_position_of_cursor(&self, _: &App) -> Option<gpui::Point<Pixels>> {
941 self.pixel_position_of_newest_cursor
942 }
943
944 fn breadcrumb_location(&self, _: &App) -> ToolbarItemLocation {
945 if self.show_breadcrumbs {
946 ToolbarItemLocation::PrimaryLeft
947 } else {
948 ToolbarItemLocation::Hidden
949 }
950 }
951
952 fn breadcrumbs(&self, variant: &Theme, cx: &App) -> Option<Vec<BreadcrumbText>> {
953 let cursor = self.selections.newest_anchor().head();
954 let multibuffer = self.buffer().read(cx);
955 let (buffer_id, symbols) = multibuffer
956 .read(cx)
957 .symbols_containing(cursor, Some(variant.syntax()))?;
958 let buffer = multibuffer.buffer(buffer_id)?;
959
960 let buffer = buffer.read(cx);
961 let text = self.breadcrumb_header.clone().unwrap_or_else(|| {
962 buffer
963 .snapshot()
964 .resolve_file_path(
965 self.project
966 .as_ref()
967 .map(|project| project.read(cx).visible_worktrees(cx).count() > 1)
968 .unwrap_or_default(),
969 cx,
970 )
971 .unwrap_or_else(|| {
972 if multibuffer.is_singleton() {
973 multibuffer.title(cx).to_string()
974 } else {
975 "untitled".to_string()
976 }
977 })
978 });
979
980 let settings = ThemeSettings::get_global(cx);
981
982 let mut breadcrumbs = vec![BreadcrumbText {
983 text,
984 highlights: None,
985 font: Some(settings.buffer_font.clone()),
986 }];
987
988 breadcrumbs.extend(symbols.into_iter().map(|symbol| BreadcrumbText {
989 text: symbol.text,
990 highlights: Some(symbol.highlight_ranges),
991 font: Some(settings.buffer_font.clone()),
992 }));
993 Some(breadcrumbs)
994 }
995
996 fn added_to_workspace(
997 &mut self,
998 workspace: &mut Workspace,
999 _window: &mut Window,
1000 cx: &mut Context<Self>,
1001 ) {
1002 self.workspace = Some((workspace.weak_handle(), workspace.database_id()));
1003 if let Some(workspace) = &workspace.weak_handle().upgrade() {
1004 cx.subscribe(workspace, |editor, _, event: &workspace::Event, _cx| {
1005 if let workspace::Event::ModalOpened = event {
1006 editor.mouse_context_menu.take();
1007 editor.inline_blame_popover.take();
1008 }
1009 })
1010 .detach();
1011 }
1012 }
1013
1014 fn to_item_events(event: &EditorEvent, mut f: impl FnMut(ItemEvent)) {
1015 match event {
1016 EditorEvent::Saved | EditorEvent::TitleChanged => {
1017 f(ItemEvent::UpdateTab);
1018 f(ItemEvent::UpdateBreadcrumbs);
1019 }
1020
1021 EditorEvent::Reparsed(_) => {
1022 f(ItemEvent::UpdateBreadcrumbs);
1023 }
1024
1025 EditorEvent::SelectionsChanged { local } if *local => {
1026 f(ItemEvent::UpdateBreadcrumbs);
1027 }
1028
1029 EditorEvent::BreadcrumbsChanged => {
1030 f(ItemEvent::UpdateBreadcrumbs);
1031 }
1032
1033 EditorEvent::DirtyChanged => {
1034 f(ItemEvent::UpdateTab);
1035 }
1036
1037 EditorEvent::BufferEdited => {
1038 f(ItemEvent::Edit);
1039 f(ItemEvent::UpdateBreadcrumbs);
1040 }
1041
1042 EditorEvent::ExcerptsAdded { .. } | EditorEvent::ExcerptsRemoved { .. } => {
1043 f(ItemEvent::Edit);
1044 }
1045
1046 _ => {}
1047 }
1048 }
1049
1050 fn preserve_preview(&self, cx: &App) -> bool {
1051 self.buffer.read(cx).preserve_preview(cx)
1052 }
1053}
1054
1055impl SerializableItem for Editor {
1056 fn serialized_item_kind() -> &'static str {
1057 "Editor"
1058 }
1059
1060 fn cleanup(
1061 workspace_id: WorkspaceId,
1062 alive_items: Vec<ItemId>,
1063 _window: &mut Window,
1064 cx: &mut App,
1065 ) -> Task<Result<()>> {
1066 workspace::delete_unloaded_items(alive_items, workspace_id, "editors", &DB, cx)
1067 }
1068
1069 fn deserialize(
1070 project: Entity<Project>,
1071 workspace: WeakEntity<Workspace>,
1072 workspace_id: workspace::WorkspaceId,
1073 item_id: ItemId,
1074 window: &mut Window,
1075 cx: &mut App,
1076 ) -> Task<Result<Entity<Self>>> {
1077 let serialized_editor = match DB
1078 .get_serialized_editor(item_id, workspace_id)
1079 .context("Failed to query editor state")
1080 {
1081 Ok(Some(serialized_editor)) => {
1082 if ProjectSettings::get_global(cx)
1083 .session
1084 .restore_unsaved_buffers
1085 {
1086 serialized_editor
1087 } else {
1088 SerializedEditor {
1089 abs_path: serialized_editor.abs_path,
1090 contents: None,
1091 language: None,
1092 mtime: None,
1093 }
1094 }
1095 }
1096 Ok(None) => {
1097 return Task::ready(Err(anyhow!(
1098 "Unable to deserialize editor: No entry in database for item_id: {item_id} and workspace_id {workspace_id:?}"
1099 )));
1100 }
1101 Err(error) => {
1102 return Task::ready(Err(error));
1103 }
1104 };
1105 log::debug!(
1106 "Deserialized editor {item_id:?} in workspace {workspace_id:?}, {serialized_editor:?}"
1107 );
1108
1109 match serialized_editor {
1110 SerializedEditor {
1111 abs_path: None,
1112 contents: Some(contents),
1113 language,
1114 ..
1115 } => window.spawn(cx, {
1116 let project = project.clone();
1117 async move |cx| {
1118 let language_registry =
1119 project.read_with(cx, |project, _| project.languages().clone())?;
1120
1121 let language = if let Some(language_name) = language {
1122 // We don't fail here, because we'd rather not set the language if the name changed
1123 // than fail to restore the buffer.
1124 language_registry
1125 .language_for_name(&language_name)
1126 .await
1127 .ok()
1128 } else {
1129 None
1130 };
1131
1132 // First create the empty buffer
1133 let buffer = project
1134 .update(cx, |project, cx| project.create_buffer(true, cx))?
1135 .await
1136 .context("Failed to create buffer while deserializing editor")?;
1137
1138 // Then set the text so that the dirty bit is set correctly
1139 buffer.update(cx, |buffer, cx| {
1140 buffer.set_language_registry(language_registry);
1141 if let Some(language) = language {
1142 buffer.set_language(Some(language), cx);
1143 }
1144 buffer.set_text(contents, cx);
1145 if let Some(entry) = buffer.peek_undo_stack() {
1146 buffer.forget_transaction(entry.transaction_id());
1147 }
1148 })?;
1149
1150 cx.update(|window, cx| {
1151 cx.new(|cx| {
1152 let mut editor = Editor::for_buffer(buffer, Some(project), window, cx);
1153
1154 editor.read_metadata_from_db(item_id, workspace_id, window, cx);
1155 editor
1156 })
1157 })
1158 }
1159 }),
1160 SerializedEditor {
1161 abs_path: Some(abs_path),
1162 contents,
1163 mtime,
1164 ..
1165 } => {
1166 let opened_buffer = project.update(cx, |project, cx| {
1167 let (worktree, path) = project.find_worktree(&abs_path, cx)?;
1168 let project_path = ProjectPath {
1169 worktree_id: worktree.read(cx).id(),
1170 path: path,
1171 };
1172 Some(project.open_path(project_path, cx))
1173 });
1174
1175 match opened_buffer {
1176 Some(opened_buffer) => {
1177 window.spawn(cx, async move |cx| {
1178 let (_, buffer) = opened_buffer
1179 .await
1180 .context("Failed to open path in project")?;
1181
1182 // This is a bit wasteful: we're loading the whole buffer from
1183 // disk and then overwrite the content.
1184 // But for now, it keeps the implementation of the content serialization
1185 // simple, because we don't have to persist all of the metadata that we get
1186 // by loading the file (git diff base, ...).
1187 if let Some(buffer_text) = contents {
1188 buffer.update(cx, |buffer, cx| {
1189 // If we did restore an mtime, we want to store it on the buffer
1190 // so that the next edit will mark the buffer as dirty/conflicted.
1191 if mtime.is_some() {
1192 buffer.did_reload(
1193 buffer.version(),
1194 buffer.line_ending(),
1195 mtime,
1196 cx,
1197 );
1198 }
1199 buffer.set_text(buffer_text, cx);
1200 if let Some(entry) = buffer.peek_undo_stack() {
1201 buffer.forget_transaction(entry.transaction_id());
1202 }
1203 })?;
1204 }
1205
1206 cx.update(|window, cx| {
1207 cx.new(|cx| {
1208 let mut editor =
1209 Editor::for_buffer(buffer, Some(project), window, cx);
1210
1211 editor.read_metadata_from_db(item_id, workspace_id, window, cx);
1212 editor
1213 })
1214 })
1215 })
1216 }
1217 None => {
1218 let open_by_abs_path = workspace.update(cx, |workspace, cx| {
1219 workspace.open_abs_path(
1220 abs_path.clone(),
1221 OpenOptions {
1222 visible: Some(OpenVisible::None),
1223 ..Default::default()
1224 },
1225 window,
1226 cx,
1227 )
1228 });
1229 window.spawn(cx, async move |cx| {
1230 let editor = open_by_abs_path?.await?.downcast::<Editor>().with_context(|| format!("Failed to downcast to Editor after opening abs path {abs_path:?}"))?;
1231 editor.update_in(cx, |editor, window, cx| {
1232 editor.read_metadata_from_db(item_id, workspace_id, window, cx);
1233 })?;
1234 Ok(editor)
1235 })
1236 }
1237 }
1238 }
1239 SerializedEditor {
1240 abs_path: None,
1241 contents: None,
1242 ..
1243 } => window.spawn(cx, async move |cx| {
1244 let buffer = project
1245 .update(cx, |project, cx| project.create_buffer(true, cx))?
1246 .await
1247 .context("Failed to create buffer")?;
1248
1249 cx.update(|window, cx| {
1250 cx.new(|cx| {
1251 let mut editor = Editor::for_buffer(buffer, Some(project), window, cx);
1252
1253 editor.read_metadata_from_db(item_id, workspace_id, window, cx);
1254 editor
1255 })
1256 })
1257 }),
1258 }
1259 }
1260
1261 fn serialize(
1262 &mut self,
1263 workspace: &mut Workspace,
1264 item_id: ItemId,
1265 closing: bool,
1266 window: &mut Window,
1267 cx: &mut Context<Self>,
1268 ) -> Option<Task<Result<()>>> {
1269 let buffer_serialization = self.buffer_serialization?;
1270 let project = self.project.clone()?;
1271
1272 let serialize_dirty_buffers = match buffer_serialization {
1273 // If we don't have a worktree, we don't serialize, because
1274 // projects without worktrees aren't deserialized.
1275 BufferSerialization::All => project.read(cx).visible_worktrees(cx).next().is_some(),
1276 BufferSerialization::NonDirtyBuffers => false,
1277 };
1278
1279 if closing && !serialize_dirty_buffers {
1280 return None;
1281 }
1282
1283 let workspace_id = workspace.database_id()?;
1284
1285 let buffer = self.buffer().read(cx).as_singleton()?;
1286
1287 let abs_path = buffer.read(cx).file().and_then(|file| {
1288 let worktree_id = file.worktree_id(cx);
1289 project
1290 .read(cx)
1291 .worktree_for_id(worktree_id, cx)
1292 .map(|worktree| worktree.read(cx).absolutize(file.path()))
1293 .or_else(|| {
1294 let full_path = file.full_path(cx);
1295 let project_path = project.read(cx).find_project_path(&full_path, cx)?;
1296 project.read(cx).absolute_path(&project_path, cx)
1297 })
1298 });
1299
1300 let is_dirty = buffer.read(cx).is_dirty();
1301 let mtime = buffer.read(cx).saved_mtime();
1302
1303 let snapshot = buffer.read(cx).snapshot();
1304
1305 Some(cx.spawn_in(window, async move |_this, cx| {
1306 cx.background_spawn(async move {
1307 let (contents, language) = if serialize_dirty_buffers && is_dirty {
1308 let contents = snapshot.text();
1309 let language = snapshot.language().map(|lang| lang.name().to_string());
1310 (Some(contents), language)
1311 } else {
1312 (None, None)
1313 };
1314
1315 let editor = SerializedEditor {
1316 abs_path,
1317 contents,
1318 language,
1319 mtime,
1320 };
1321 log::debug!("Serializing editor {item_id:?} in workspace {workspace_id:?}");
1322 DB.save_serialized_editor(item_id, workspace_id, editor)
1323 .await
1324 .context("failed to save serialized editor")
1325 })
1326 .await
1327 .context("failed to save contents of buffer")?;
1328
1329 Ok(())
1330 }))
1331 }
1332
1333 fn should_serialize(&self, event: &Self::Event) -> bool {
1334 self.should_serialize_buffer()
1335 && matches!(
1336 event,
1337 EditorEvent::Saved | EditorEvent::DirtyChanged | EditorEvent::BufferEdited
1338 )
1339 }
1340}
1341
1342#[derive(Debug, Default)]
1343struct EditorRestorationData {
1344 entries: HashMap<PathBuf, RestorationData>,
1345}
1346
1347#[derive(Default, Debug)]
1348pub struct RestorationData {
1349 pub scroll_position: (BufferRow, gpui::Point<ScrollOffset>),
1350 pub folds: Vec<Range<Point>>,
1351 pub selections: Vec<Range<Point>>,
1352}
1353
1354impl ProjectItem for Editor {
1355 type Item = Buffer;
1356
1357 fn project_item_kind() -> Option<ProjectItemKind> {
1358 Some(ProjectItemKind("Editor"))
1359 }
1360
1361 fn for_project_item(
1362 project: Entity<Project>,
1363 pane: Option<&Pane>,
1364 buffer: Entity<Buffer>,
1365 window: &mut Window,
1366 cx: &mut Context<Self>,
1367 ) -> Self {
1368 let mut editor = Self::for_buffer(buffer.clone(), Some(project), window, cx);
1369 if let Some((excerpt_id, _, snapshot)) =
1370 editor.buffer().read(cx).snapshot(cx).as_singleton()
1371 && WorkspaceSettings::get(None, cx).restore_on_file_reopen
1372 && let Some(restoration_data) = Self::project_item_kind()
1373 .and_then(|kind| pane.as_ref()?.project_item_restoration_data.get(&kind))
1374 .and_then(|data| data.downcast_ref::<EditorRestorationData>())
1375 .and_then(|data| {
1376 let file = project::File::from_dyn(buffer.read(cx).file())?;
1377 data.entries.get(&file.abs_path(cx))
1378 })
1379 {
1380 editor.fold_ranges(
1381 clip_ranges(&restoration_data.folds, snapshot),
1382 false,
1383 window,
1384 cx,
1385 );
1386 if !restoration_data.selections.is_empty() {
1387 editor.change_selections(SelectionEffects::no_scroll(), window, cx, |s| {
1388 s.select_ranges(clip_ranges(&restoration_data.selections, snapshot));
1389 });
1390 }
1391 let (top_row, offset) = restoration_data.scroll_position;
1392 let anchor =
1393 Anchor::in_buffer(*excerpt_id, snapshot.anchor_before(Point::new(top_row, 0)));
1394 editor.set_scroll_anchor(ScrollAnchor { anchor, offset }, window, cx);
1395 }
1396
1397 editor
1398 }
1399
1400 fn for_broken_project_item(
1401 abs_path: &Path,
1402 is_local: bool,
1403 e: &anyhow::Error,
1404 window: &mut Window,
1405 cx: &mut App,
1406 ) -> Option<InvalidItemView> {
1407 Some(InvalidItemView::new(abs_path, is_local, e, window, cx))
1408 }
1409}
1410
1411fn clip_ranges<'a>(
1412 original: impl IntoIterator<Item = &'a Range<Point>> + 'a,
1413 snapshot: &'a BufferSnapshot,
1414) -> Vec<Range<Point>> {
1415 original
1416 .into_iter()
1417 .map(|range| {
1418 snapshot.clip_point(range.start, Bias::Left)
1419 ..snapshot.clip_point(range.end, Bias::Right)
1420 })
1421 .collect()
1422}
1423
1424impl EventEmitter<SearchEvent> for Editor {}
1425
1426impl Editor {
1427 pub fn update_restoration_data(
1428 &self,
1429 cx: &mut Context<Self>,
1430 write: impl for<'a> FnOnce(&'a mut RestorationData) + 'static,
1431 ) {
1432 if self.mode.is_minimap() || !WorkspaceSettings::get(None, cx).restore_on_file_reopen {
1433 return;
1434 }
1435
1436 let editor = cx.entity();
1437 cx.defer(move |cx| {
1438 editor.update(cx, |editor, cx| {
1439 let kind = Editor::project_item_kind()?;
1440 let pane = editor.workspace()?.read(cx).pane_for(&cx.entity())?;
1441 let buffer = editor.buffer().read(cx).as_singleton()?;
1442 let file_abs_path = project::File::from_dyn(buffer.read(cx).file())?.abs_path(cx);
1443 pane.update(cx, |pane, _| {
1444 let data = pane
1445 .project_item_restoration_data
1446 .entry(kind)
1447 .or_insert_with(|| Box::new(EditorRestorationData::default()) as Box<_>);
1448 let data = match data.downcast_mut::<EditorRestorationData>() {
1449 Some(data) => data,
1450 None => {
1451 *data = Box::new(EditorRestorationData::default());
1452 data.downcast_mut::<EditorRestorationData>()
1453 .expect("just written the type downcasted to")
1454 }
1455 };
1456
1457 let data = data.entries.entry(file_abs_path).or_default();
1458 write(data);
1459 Some(())
1460 })
1461 });
1462 });
1463 }
1464}
1465
1466pub(crate) enum BufferSearchHighlights {}
1467impl SearchableItem for Editor {
1468 type Match = Range<Anchor>;
1469
1470 fn get_matches(&self, _window: &mut Window, _: &mut App) -> Vec<Range<Anchor>> {
1471 self.background_highlights
1472 .get(&HighlightKey::Type(TypeId::of::<BufferSearchHighlights>()))
1473 .map_or(Vec::new(), |(_color, ranges)| {
1474 ranges.iter().cloned().collect()
1475 })
1476 }
1477
1478 fn clear_matches(&mut self, _: &mut Window, cx: &mut Context<Self>) {
1479 if self
1480 .clear_background_highlights::<BufferSearchHighlights>(cx)
1481 .is_some()
1482 {
1483 cx.emit(SearchEvent::MatchesInvalidated);
1484 }
1485 }
1486
1487 fn update_matches(
1488 &mut self,
1489 matches: &[Range<Anchor>],
1490 _: &mut Window,
1491 cx: &mut Context<Self>,
1492 ) {
1493 let existing_range = self
1494 .background_highlights
1495 .get(&HighlightKey::Type(TypeId::of::<BufferSearchHighlights>()))
1496 .map(|(_, range)| range.as_ref());
1497 let updated = existing_range != Some(matches);
1498 self.highlight_background::<BufferSearchHighlights>(
1499 matches,
1500 |theme| theme.colors().search_match_background,
1501 cx,
1502 );
1503 if updated {
1504 cx.emit(SearchEvent::MatchesInvalidated);
1505 }
1506 }
1507
1508 fn has_filtered_search_ranges(&mut self) -> bool {
1509 self.has_background_highlights::<SearchWithinRange>()
1510 }
1511
1512 fn toggle_filtered_search_ranges(
1513 &mut self,
1514 enabled: Option<FilteredSearchRange>,
1515 _: &mut Window,
1516 cx: &mut Context<Self>,
1517 ) {
1518 if self.has_filtered_search_ranges() {
1519 self.previous_search_ranges = self
1520 .clear_background_highlights::<SearchWithinRange>(cx)
1521 .map(|(_, ranges)| ranges)
1522 }
1523
1524 if let Some(range) = enabled {
1525 let ranges = self.selections.disjoint_anchor_ranges().collect::<Vec<_>>();
1526
1527 if ranges.iter().any(|s| s.start != s.end) {
1528 self.set_search_within_ranges(&ranges, cx);
1529 } else if let Some(previous_search_ranges) = self.previous_search_ranges.take()
1530 && range != FilteredSearchRange::Selection
1531 {
1532 self.set_search_within_ranges(&previous_search_ranges, cx);
1533 }
1534 }
1535 }
1536
1537 fn supported_options(&self) -> SearchOptions {
1538 if self.in_project_search {
1539 SearchOptions {
1540 case: true,
1541 word: true,
1542 regex: true,
1543 replacement: false,
1544 selection: false,
1545 find_in_results: true,
1546 }
1547 } else {
1548 SearchOptions {
1549 case: true,
1550 word: true,
1551 regex: true,
1552 replacement: true,
1553 selection: true,
1554 find_in_results: false,
1555 }
1556 }
1557 }
1558
1559 fn query_suggestion(&mut self, window: &mut Window, cx: &mut Context<Self>) -> String {
1560 let setting = EditorSettings::get_global(cx).seed_search_query_from_cursor;
1561 let snapshot = self.snapshot(window, cx);
1562 let selection = self.selections.newest_adjusted(&snapshot.display_snapshot);
1563 let buffer_snapshot = snapshot.buffer_snapshot();
1564
1565 match setting {
1566 SeedQuerySetting::Never => String::new(),
1567 SeedQuerySetting::Selection | SeedQuerySetting::Always if !selection.is_empty() => {
1568 let text: String = buffer_snapshot
1569 .text_for_range(selection.start..selection.end)
1570 .collect();
1571 if text.contains('\n') {
1572 String::new()
1573 } else {
1574 text
1575 }
1576 }
1577 SeedQuerySetting::Selection => String::new(),
1578 SeedQuerySetting::Always => {
1579 let (range, kind) = buffer_snapshot
1580 .surrounding_word(selection.start, Some(CharScopeContext::Completion));
1581 if kind == Some(CharKind::Word) {
1582 let text: String = buffer_snapshot.text_for_range(range).collect();
1583 if !text.trim().is_empty() {
1584 return text;
1585 }
1586 }
1587 String::new()
1588 }
1589 }
1590 }
1591
1592 fn activate_match(
1593 &mut self,
1594 index: usize,
1595 matches: &[Range<Anchor>],
1596 window: &mut Window,
1597 cx: &mut Context<Self>,
1598 ) {
1599 self.unfold_ranges(&[matches[index].clone()], false, true, cx);
1600 let range = self.range_for_match(&matches[index]);
1601 let autoscroll = if EditorSettings::get_global(cx).search.center_on_match {
1602 Autoscroll::center()
1603 } else {
1604 Autoscroll::fit()
1605 };
1606 self.change_selections(SelectionEffects::scroll(autoscroll), window, cx, |s| {
1607 s.select_ranges([range]);
1608 })
1609 }
1610
1611 fn select_matches(
1612 &mut self,
1613 matches: &[Self::Match],
1614 window: &mut Window,
1615 cx: &mut Context<Self>,
1616 ) {
1617 self.unfold_ranges(matches, false, false, cx);
1618 self.change_selections(SelectionEffects::no_scroll(), window, cx, |s| {
1619 s.select_ranges(matches.iter().cloned())
1620 });
1621 }
1622 fn replace(
1623 &mut self,
1624 identifier: &Self::Match,
1625 query: &SearchQuery,
1626 window: &mut Window,
1627 cx: &mut Context<Self>,
1628 ) {
1629 let text = self.buffer.read(cx);
1630 let text = text.snapshot(cx);
1631 let text = text.text_for_range(identifier.clone()).collect::<Vec<_>>();
1632 let text: Cow<_> = if text.len() == 1 {
1633 text.first().cloned().unwrap().into()
1634 } else {
1635 let joined_chunks = text.join("");
1636 joined_chunks.into()
1637 };
1638
1639 if let Some(replacement) = query.replacement_for(&text) {
1640 self.transact(window, cx, |this, _, cx| {
1641 this.edit([(identifier.clone(), Arc::from(&*replacement))], cx);
1642 });
1643 }
1644 }
1645 fn replace_all(
1646 &mut self,
1647 matches: &mut dyn Iterator<Item = &Self::Match>,
1648 query: &SearchQuery,
1649 window: &mut Window,
1650 cx: &mut Context<Self>,
1651 ) {
1652 let text = self.buffer.read(cx);
1653 let text = text.snapshot(cx);
1654 let mut edits = vec![];
1655
1656 for m in matches {
1657 let text = text.text_for_range(m.clone()).collect::<Vec<_>>();
1658
1659 let text: Cow<_> = if text.len() == 1 {
1660 text.first().cloned().unwrap().into()
1661 } else {
1662 let joined_chunks = text.join("");
1663 joined_chunks.into()
1664 };
1665
1666 if let Some(replacement) = query.replacement_for(&text) {
1667 edits.push((m.clone(), Arc::from(&*replacement)));
1668 }
1669 }
1670
1671 if !edits.is_empty() {
1672 self.transact(window, cx, |this, _, cx| {
1673 this.edit(edits, cx);
1674 });
1675 }
1676 }
1677 fn match_index_for_direction(
1678 &mut self,
1679 matches: &[Range<Anchor>],
1680 current_index: usize,
1681 direction: Direction,
1682 count: usize,
1683 _: &mut Window,
1684 cx: &mut Context<Self>,
1685 ) -> usize {
1686 let buffer = self.buffer().read(cx).snapshot(cx);
1687 let current_index_position = if self.selections.disjoint_anchors_arc().len() == 1 {
1688 self.selections.newest_anchor().head()
1689 } else {
1690 matches[current_index].start
1691 };
1692
1693 let mut count = count % matches.len();
1694 if count == 0 {
1695 return current_index;
1696 }
1697 match direction {
1698 Direction::Next => {
1699 if matches[current_index]
1700 .start
1701 .cmp(¤t_index_position, &buffer)
1702 .is_gt()
1703 {
1704 count -= 1
1705 }
1706
1707 (current_index + count) % matches.len()
1708 }
1709 Direction::Prev => {
1710 if matches[current_index]
1711 .end
1712 .cmp(¤t_index_position, &buffer)
1713 .is_lt()
1714 {
1715 count -= 1;
1716 }
1717
1718 if current_index >= count {
1719 current_index - count
1720 } else {
1721 matches.len() - (count - current_index)
1722 }
1723 }
1724 }
1725 }
1726
1727 fn find_matches(
1728 &mut self,
1729 query: Arc<project::search::SearchQuery>,
1730 _: &mut Window,
1731 cx: &mut Context<Self>,
1732 ) -> Task<Vec<Range<Anchor>>> {
1733 let buffer = self.buffer().read(cx).snapshot(cx);
1734 let search_within_ranges = self
1735 .background_highlights
1736 .get(&HighlightKey::Type(TypeId::of::<SearchWithinRange>()))
1737 .map_or(vec![], |(_color, ranges)| {
1738 ranges.iter().cloned().collect::<Vec<_>>()
1739 });
1740
1741 cx.background_spawn(async move {
1742 let mut ranges = Vec::new();
1743
1744 let search_within_ranges = if search_within_ranges.is_empty() {
1745 vec![buffer.anchor_before(MultiBufferOffset(0))..buffer.anchor_after(buffer.len())]
1746 } else {
1747 search_within_ranges
1748 };
1749
1750 for range in search_within_ranges {
1751 for (search_buffer, search_range, excerpt_id, deleted_hunk_anchor) in
1752 buffer.range_to_buffer_ranges_with_deleted_hunks(range)
1753 {
1754 ranges.extend(
1755 query
1756 .search(
1757 search_buffer,
1758 Some(search_range.start.0..search_range.end.0),
1759 )
1760 .await
1761 .into_iter()
1762 .map(|match_range| {
1763 if let Some(deleted_hunk_anchor) = deleted_hunk_anchor {
1764 let start = search_buffer
1765 .anchor_after(search_range.start + match_range.start);
1766 let end = search_buffer
1767 .anchor_before(search_range.start + match_range.end);
1768 deleted_hunk_anchor.with_diff_base_anchor(start)
1769 ..deleted_hunk_anchor.with_diff_base_anchor(end)
1770 } else {
1771 let start = search_buffer
1772 .anchor_after(search_range.start + match_range.start);
1773 let end = search_buffer
1774 .anchor_before(search_range.start + match_range.end);
1775 Anchor::range_in_buffer(excerpt_id, start..end)
1776 }
1777 }),
1778 );
1779 }
1780 }
1781
1782 ranges
1783 })
1784 }
1785
1786 fn active_match_index(
1787 &mut self,
1788 direction: Direction,
1789 matches: &[Range<Anchor>],
1790 _: &mut Window,
1791 cx: &mut Context<Self>,
1792 ) -> Option<usize> {
1793 active_match_index(
1794 direction,
1795 matches,
1796 &self.selections.newest_anchor().head(),
1797 &self.buffer().read(cx).snapshot(cx),
1798 )
1799 }
1800
1801 fn search_bar_visibility_changed(&mut self, _: bool, _: &mut Window, _: &mut Context<Self>) {
1802 self.expect_bounds_change = self.last_bounds;
1803 }
1804
1805 fn set_search_is_case_sensitive(
1806 &mut self,
1807 case_sensitive: Option<bool>,
1808 _cx: &mut Context<Self>,
1809 ) {
1810 self.select_next_is_case_sensitive = case_sensitive;
1811 }
1812}
1813
1814pub fn active_match_index(
1815 direction: Direction,
1816 ranges: &[Range<Anchor>],
1817 cursor: &Anchor,
1818 buffer: &MultiBufferSnapshot,
1819) -> Option<usize> {
1820 if ranges.is_empty() {
1821 None
1822 } else {
1823 let r = ranges.binary_search_by(|probe| {
1824 if probe.end.cmp(cursor, buffer).is_lt() {
1825 Ordering::Less
1826 } else if probe.start.cmp(cursor, buffer).is_gt() {
1827 Ordering::Greater
1828 } else {
1829 Ordering::Equal
1830 }
1831 });
1832 match direction {
1833 Direction::Prev => match r {
1834 Ok(i) => Some(i),
1835 Err(i) => Some(i.saturating_sub(1)),
1836 },
1837 Direction::Next => match r {
1838 Ok(i) | Err(i) => Some(cmp::min(i, ranges.len() - 1)),
1839 },
1840 }
1841 }
1842}
1843
1844pub fn entry_label_color(selected: bool) -> Color {
1845 if selected {
1846 Color::Default
1847 } else {
1848 Color::Muted
1849 }
1850}
1851
1852pub fn entry_diagnostic_aware_icon_name_and_color(
1853 diagnostic_severity: Option<DiagnosticSeverity>,
1854) -> Option<(IconName, Color)> {
1855 match diagnostic_severity {
1856 Some(DiagnosticSeverity::ERROR) => Some((IconName::Close, Color::Error)),
1857 Some(DiagnosticSeverity::WARNING) => Some((IconName::Triangle, Color::Warning)),
1858 _ => None,
1859 }
1860}
1861
1862pub fn entry_diagnostic_aware_icon_decoration_and_color(
1863 diagnostic_severity: Option<DiagnosticSeverity>,
1864) -> Option<(IconDecorationKind, Color)> {
1865 match diagnostic_severity {
1866 Some(DiagnosticSeverity::ERROR) => Some((IconDecorationKind::X, Color::Error)),
1867 Some(DiagnosticSeverity::WARNING) => Some((IconDecorationKind::Triangle, Color::Warning)),
1868 _ => None,
1869 }
1870}
1871
1872pub fn entry_git_aware_label_color(git_status: GitSummary, ignored: bool, selected: bool) -> Color {
1873 let tracked = git_status.index + git_status.worktree;
1874 if ignored {
1875 Color::Ignored
1876 } else if git_status.conflict > 0 {
1877 Color::Conflict
1878 } else if tracked.modified > 0 {
1879 Color::Modified
1880 } else if tracked.added > 0 || git_status.untracked > 0 {
1881 Color::Created
1882 } else {
1883 entry_label_color(selected)
1884 }
1885}
1886
1887fn path_for_buffer<'a>(
1888 buffer: &Entity<MultiBuffer>,
1889 height: usize,
1890 include_filename: bool,
1891 cx: &'a App,
1892) -> Option<Cow<'a, str>> {
1893 let file = buffer.read(cx).as_singleton()?.read(cx).file()?;
1894 path_for_file(file.as_ref(), height, include_filename, cx)
1895}
1896
1897fn path_for_file<'a>(
1898 file: &'a dyn language::File,
1899 mut height: usize,
1900 include_filename: bool,
1901 cx: &'a App,
1902) -> Option<Cow<'a, str>> {
1903 // Ensure we always render at least the filename.
1904 height += 1;
1905
1906 let mut prefix = file.path().as_ref();
1907 while height > 0 {
1908 if let Some(parent) = prefix.parent() {
1909 prefix = parent;
1910 height -= 1;
1911 } else {
1912 break;
1913 }
1914 }
1915
1916 // The full_path method allocates, so avoid calling it if height is zero.
1917 if height > 0 {
1918 let mut full_path = file.full_path(cx);
1919 if !include_filename {
1920 if !full_path.pop() {
1921 return None;
1922 }
1923 }
1924 Some(full_path.to_string_lossy().into_owned().into())
1925 } else {
1926 let mut path = file.path().strip_prefix(prefix).ok()?;
1927 if !include_filename {
1928 path = path.parent()?;
1929 }
1930 Some(path.display(file.path_style(cx)))
1931 }
1932}
1933
1934#[cfg(test)]
1935mod tests {
1936 use crate::editor_tests::init_test;
1937 use fs::Fs;
1938
1939 use super::*;
1940 use fs::MTime;
1941 use gpui::{App, VisualTestContext};
1942 use language::{LanguageMatcher, TestFile};
1943 use project::FakeFs;
1944 use std::path::{Path, PathBuf};
1945 use util::{path, rel_path::RelPath};
1946
1947 #[gpui::test]
1948 fn test_path_for_file(cx: &mut App) {
1949 let file = TestFile {
1950 path: RelPath::empty().into(),
1951 root_name: String::new(),
1952 local_root: None,
1953 };
1954 assert_eq!(path_for_file(&file, 0, false, cx), None);
1955 }
1956
1957 async fn deserialize_editor(
1958 item_id: ItemId,
1959 workspace_id: WorkspaceId,
1960 workspace: Entity<Workspace>,
1961 project: Entity<Project>,
1962 cx: &mut VisualTestContext,
1963 ) -> Entity<Editor> {
1964 workspace
1965 .update_in(cx, |workspace, window, cx| {
1966 let pane = workspace.active_pane();
1967 pane.update(cx, |_, cx| {
1968 Editor::deserialize(
1969 project.clone(),
1970 workspace.weak_handle(),
1971 workspace_id,
1972 item_id,
1973 window,
1974 cx,
1975 )
1976 })
1977 })
1978 .await
1979 .unwrap()
1980 }
1981
1982 fn rust_language() -> Arc<language::Language> {
1983 Arc::new(language::Language::new(
1984 language::LanguageConfig {
1985 name: "Rust".into(),
1986 matcher: LanguageMatcher {
1987 path_suffixes: vec!["rs".to_string()],
1988 ..Default::default()
1989 },
1990 ..Default::default()
1991 },
1992 Some(tree_sitter_rust::LANGUAGE.into()),
1993 ))
1994 }
1995
1996 #[gpui::test]
1997 async fn test_deserialize(cx: &mut gpui::TestAppContext) {
1998 init_test(cx, |_| {});
1999
2000 let fs = FakeFs::new(cx.executor());
2001 fs.insert_file(path!("/file.rs"), Default::default()).await;
2002
2003 // Test case 1: Deserialize with path and contents
2004 {
2005 let project = Project::test(fs.clone(), [path!("/file.rs").as_ref()], cx).await;
2006 let (workspace, cx) =
2007 cx.add_window_view(|window, cx| Workspace::test_new(project.clone(), window, cx));
2008 let workspace_id = workspace::WORKSPACE_DB.next_id().await.unwrap();
2009 let item_id = 1234 as ItemId;
2010 let mtime = fs
2011 .metadata(Path::new(path!("/file.rs")))
2012 .await
2013 .unwrap()
2014 .unwrap()
2015 .mtime;
2016
2017 let serialized_editor = SerializedEditor {
2018 abs_path: Some(PathBuf::from(path!("/file.rs"))),
2019 contents: Some("fn main() {}".to_string()),
2020 language: Some("Rust".to_string()),
2021 mtime: Some(mtime),
2022 };
2023
2024 DB.save_serialized_editor(item_id, workspace_id, serialized_editor.clone())
2025 .await
2026 .unwrap();
2027
2028 let deserialized =
2029 deserialize_editor(item_id, workspace_id, workspace, project, cx).await;
2030
2031 deserialized.update(cx, |editor, cx| {
2032 assert_eq!(editor.text(cx), "fn main() {}");
2033 assert!(editor.is_dirty(cx));
2034 assert!(!editor.has_conflict(cx));
2035 let buffer = editor.buffer().read(cx).as_singleton().unwrap().read(cx);
2036 assert!(buffer.file().is_some());
2037 });
2038 }
2039
2040 // Test case 2: Deserialize with only path
2041 {
2042 let project = Project::test(fs.clone(), [path!("/file.rs").as_ref()], cx).await;
2043 let (workspace, cx) =
2044 cx.add_window_view(|window, cx| Workspace::test_new(project.clone(), window, cx));
2045
2046 let workspace_id = workspace::WORKSPACE_DB.next_id().await.unwrap();
2047
2048 let item_id = 5678 as ItemId;
2049 let serialized_editor = SerializedEditor {
2050 abs_path: Some(PathBuf::from(path!("/file.rs"))),
2051 contents: None,
2052 language: None,
2053 mtime: None,
2054 };
2055
2056 DB.save_serialized_editor(item_id, workspace_id, serialized_editor)
2057 .await
2058 .unwrap();
2059
2060 let deserialized =
2061 deserialize_editor(item_id, workspace_id, workspace, project, cx).await;
2062
2063 deserialized.update(cx, |editor, cx| {
2064 assert_eq!(editor.text(cx), ""); // The file should be empty as per our initial setup
2065 assert!(!editor.is_dirty(cx));
2066 assert!(!editor.has_conflict(cx));
2067
2068 let buffer = editor.buffer().read(cx).as_singleton().unwrap().read(cx);
2069 assert!(buffer.file().is_some());
2070 });
2071 }
2072
2073 // Test case 3: Deserialize with no path (untitled buffer, with content and language)
2074 {
2075 let project = Project::test(fs.clone(), [path!("/file.rs").as_ref()], cx).await;
2076 // Add Rust to the language, so that we can restore the language of the buffer
2077 project.read_with(cx, |project, _| project.languages().add(rust_language()));
2078
2079 let (workspace, cx) =
2080 cx.add_window_view(|window, cx| Workspace::test_new(project.clone(), window, cx));
2081
2082 let workspace_id = workspace::WORKSPACE_DB.next_id().await.unwrap();
2083
2084 let item_id = 9012 as ItemId;
2085 let serialized_editor = SerializedEditor {
2086 abs_path: None,
2087 contents: Some("hello".to_string()),
2088 language: Some("Rust".to_string()),
2089 mtime: None,
2090 };
2091
2092 DB.save_serialized_editor(item_id, workspace_id, serialized_editor)
2093 .await
2094 .unwrap();
2095
2096 let deserialized =
2097 deserialize_editor(item_id, workspace_id, workspace, project, cx).await;
2098
2099 deserialized.update(cx, |editor, cx| {
2100 assert_eq!(editor.text(cx), "hello");
2101 assert!(editor.is_dirty(cx)); // The editor should be dirty for an untitled buffer
2102
2103 let buffer = editor.buffer().read(cx).as_singleton().unwrap().read(cx);
2104 assert_eq!(
2105 buffer.language().map(|lang| lang.name()),
2106 Some("Rust".into())
2107 ); // Language should be set to Rust
2108 assert!(buffer.file().is_none()); // The buffer should not have an associated file
2109 });
2110 }
2111
2112 // Test case 4: Deserialize with path, content, and old mtime
2113 {
2114 let project = Project::test(fs.clone(), [path!("/file.rs").as_ref()], cx).await;
2115 let (workspace, cx) =
2116 cx.add_window_view(|window, cx| Workspace::test_new(project.clone(), window, cx));
2117
2118 let workspace_id = workspace::WORKSPACE_DB.next_id().await.unwrap();
2119
2120 let item_id = 9345 as ItemId;
2121 let old_mtime = MTime::from_seconds_and_nanos(0, 50);
2122 let serialized_editor = SerializedEditor {
2123 abs_path: Some(PathBuf::from(path!("/file.rs"))),
2124 contents: Some("fn main() {}".to_string()),
2125 language: Some("Rust".to_string()),
2126 mtime: Some(old_mtime),
2127 };
2128
2129 DB.save_serialized_editor(item_id, workspace_id, serialized_editor)
2130 .await
2131 .unwrap();
2132
2133 let deserialized =
2134 deserialize_editor(item_id, workspace_id, workspace, project, cx).await;
2135
2136 deserialized.update(cx, |editor, cx| {
2137 assert_eq!(editor.text(cx), "fn main() {}");
2138 assert!(editor.has_conflict(cx)); // The editor should have a conflict
2139 });
2140 }
2141
2142 // Test case 5: Deserialize with no path, no content, no language, and no old mtime (new, empty, unsaved buffer)
2143 {
2144 let project = Project::test(fs.clone(), [path!("/file.rs").as_ref()], cx).await;
2145 let (workspace, cx) =
2146 cx.add_window_view(|window, cx| Workspace::test_new(project.clone(), window, cx));
2147
2148 let workspace_id = workspace::WORKSPACE_DB.next_id().await.unwrap();
2149
2150 let item_id = 10000 as ItemId;
2151 let serialized_editor = SerializedEditor {
2152 abs_path: None,
2153 contents: None,
2154 language: None,
2155 mtime: None,
2156 };
2157
2158 DB.save_serialized_editor(item_id, workspace_id, serialized_editor)
2159 .await
2160 .unwrap();
2161
2162 let deserialized =
2163 deserialize_editor(item_id, workspace_id, workspace, project, cx).await;
2164
2165 deserialized.update(cx, |editor, cx| {
2166 assert_eq!(editor.text(cx), "");
2167 assert!(!editor.is_dirty(cx));
2168 assert!(!editor.has_conflict(cx));
2169
2170 let buffer = editor.buffer().read(cx).as_singleton().unwrap().read(cx);
2171 assert!(buffer.file().is_none());
2172 });
2173 }
2174 }
2175}