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