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