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