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