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