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