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