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