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 discarded(&self, _project: Model<Project>, cx: &mut ViewContext<Self>) {
684 for buffer in self.buffer().clone().read(cx).all_buffers() {
685 buffer.update(cx, |buffer, cx| buffer.discarded(cx))
686 }
687 }
688
689 fn deactivated(&mut self, cx: &mut ViewContext<Self>) {
690 let selection = self.selections.newest_anchor();
691 self.push_to_nav_history(selection.head(), None, cx);
692 }
693
694 fn workspace_deactivated(&mut self, cx: &mut ViewContext<Self>) {
695 self.hide_hovered_link(cx);
696 }
697
698 fn is_dirty(&self, cx: &AppContext) -> bool {
699 self.buffer().read(cx).read(cx).is_dirty()
700 }
701
702 fn has_conflict(&self, cx: &AppContext) -> bool {
703 self.buffer().read(cx).read(cx).has_conflict()
704 }
705
706 fn can_save(&self, cx: &AppContext) -> bool {
707 let buffer = &self.buffer().read(cx);
708 if let Some(buffer) = buffer.as_singleton() {
709 buffer.read(cx).project_path(cx).is_some()
710 } else {
711 true
712 }
713 }
714
715 fn save(
716 &mut self,
717 format: bool,
718 project: Model<Project>,
719 cx: &mut ViewContext<Self>,
720 ) -> Task<Result<()>> {
721 self.report_editor_event("save", None, cx);
722 let buffers = self.buffer().clone().read(cx).all_buffers();
723 cx.spawn(|this, mut cx| async move {
724 if format {
725 this.update(&mut cx, |editor, cx| {
726 editor.perform_format(project.clone(), FormatTrigger::Save, cx)
727 })?
728 .await?;
729 }
730
731 if buffers.len() == 1 {
732 // Apply full save routine for singleton buffers, to allow to `touch` the file via the editor.
733 project
734 .update(&mut cx, |project, cx| project.save_buffers(buffers, cx))?
735 .await?;
736 } else {
737 // For multi-buffers, only format and save the buffers with changes.
738 // For clean buffers, we simulate saving by calling `Buffer::did_save`,
739 // so that language servers or other downstream listeners of save events get notified.
740 let (dirty_buffers, clean_buffers) = buffers.into_iter().partition(|buffer| {
741 buffer
742 .update(&mut cx, |buffer, _| {
743 buffer.is_dirty() || buffer.has_conflict()
744 })
745 .unwrap_or(false)
746 });
747
748 project
749 .update(&mut cx, |project, cx| {
750 project.save_buffers(dirty_buffers, cx)
751 })?
752 .await?;
753 for buffer in clean_buffers {
754 buffer
755 .update(&mut cx, |buffer, cx| {
756 let version = buffer.saved_version().clone();
757 let mtime = buffer.saved_mtime();
758 buffer.did_save(version, mtime, cx);
759 })
760 .ok();
761 }
762 }
763
764 Ok(())
765 })
766 }
767
768 fn save_as(
769 &mut self,
770 project: Model<Project>,
771 path: ProjectPath,
772 cx: &mut ViewContext<Self>,
773 ) -> Task<Result<()>> {
774 let buffer = self
775 .buffer()
776 .read(cx)
777 .as_singleton()
778 .expect("cannot call save_as on an excerpt list");
779
780 let file_extension = path
781 .path
782 .extension()
783 .map(|a| a.to_string_lossy().to_string());
784 self.report_editor_event("save", file_extension, cx);
785
786 project.update(cx, |project, cx| project.save_buffer_as(buffer, path, cx))
787 }
788
789 fn reload(&mut self, project: Model<Project>, cx: &mut ViewContext<Self>) -> Task<Result<()>> {
790 let buffer = self.buffer().clone();
791 let buffers = self.buffer.read(cx).all_buffers();
792 let reload_buffers =
793 project.update(cx, |project, cx| project.reload_buffers(buffers, true, cx));
794 cx.spawn(|this, mut cx| async move {
795 let transaction = reload_buffers.log_err().await;
796 this.update(&mut cx, |editor, cx| {
797 editor.request_autoscroll(Autoscroll::fit(), cx)
798 })?;
799 buffer
800 .update(&mut cx, |buffer, cx| {
801 if let Some(transaction) = transaction {
802 if !buffer.is_singleton() {
803 buffer.push_transaction(&transaction.0, cx);
804 }
805 }
806 })
807 .ok();
808 Ok(())
809 })
810 }
811
812 fn as_searchable(&self, handle: &View<Self>) -> Option<Box<dyn SearchableItemHandle>> {
813 Some(Box::new(handle.clone()))
814 }
815
816 fn pixel_position_of_cursor(&self, _: &AppContext) -> Option<gpui::Point<Pixels>> {
817 self.pixel_position_of_newest_cursor
818 }
819
820 fn breadcrumb_location(&self) -> ToolbarItemLocation {
821 if self.show_breadcrumbs {
822 ToolbarItemLocation::PrimaryLeft
823 } else {
824 ToolbarItemLocation::Hidden
825 }
826 }
827
828 fn breadcrumbs(&self, variant: &Theme, cx: &AppContext) -> Option<Vec<BreadcrumbText>> {
829 let cursor = self.selections.newest_anchor().head();
830 let multibuffer = &self.buffer().read(cx);
831 let (buffer_id, symbols) =
832 multibuffer.symbols_containing(cursor, Some(&variant.syntax()), cx)?;
833 let buffer = multibuffer.buffer(buffer_id)?;
834
835 let buffer = buffer.read(cx);
836 let text = self.breadcrumb_header.clone().unwrap_or_else(|| {
837 buffer
838 .snapshot()
839 .resolve_file_path(
840 cx,
841 self.project
842 .as_ref()
843 .map(|project| project.read(cx).visible_worktrees(cx).count() > 1)
844 .unwrap_or_default(),
845 )
846 .map(|path| path.to_string_lossy().to_string())
847 .unwrap_or_else(|| "untitled".to_string())
848 });
849
850 let settings = ThemeSettings::get_global(cx);
851
852 let mut breadcrumbs = vec![BreadcrumbText {
853 text,
854 highlights: None,
855 font: Some(settings.buffer_font.clone()),
856 }];
857
858 breadcrumbs.extend(symbols.into_iter().map(|symbol| BreadcrumbText {
859 text: symbol.text,
860 highlights: Some(symbol.highlight_ranges),
861 font: Some(settings.buffer_font.clone()),
862 }));
863 Some(breadcrumbs)
864 }
865
866 fn added_to_workspace(&mut self, workspace: &mut Workspace, _: &mut ViewContext<Self>) {
867 self.workspace = Some((workspace.weak_handle(), workspace.database_id()));
868 }
869
870 fn to_item_events(event: &EditorEvent, mut f: impl FnMut(ItemEvent)) {
871 match event {
872 EditorEvent::Closed => f(ItemEvent::CloseItem),
873
874 EditorEvent::Saved | EditorEvent::TitleChanged => {
875 f(ItemEvent::UpdateTab);
876 f(ItemEvent::UpdateBreadcrumbs);
877 }
878
879 EditorEvent::Reparsed(_) => {
880 f(ItemEvent::UpdateBreadcrumbs);
881 }
882
883 EditorEvent::SelectionsChanged { local } if *local => {
884 f(ItemEvent::UpdateBreadcrumbs);
885 }
886
887 EditorEvent::DirtyChanged => {
888 f(ItemEvent::UpdateTab);
889 }
890
891 EditorEvent::BufferEdited => {
892 f(ItemEvent::Edit);
893 f(ItemEvent::UpdateBreadcrumbs);
894 }
895
896 EditorEvent::ExcerptsAdded { .. } | EditorEvent::ExcerptsRemoved { .. } => {
897 f(ItemEvent::Edit);
898 }
899
900 _ => {}
901 }
902 }
903
904 fn preserve_preview(&self, cx: &AppContext) -> bool {
905 self.buffer.read(cx).preserve_preview(cx)
906 }
907}
908
909impl SerializableItem for Editor {
910 fn serialized_item_kind() -> &'static str {
911 "Editor"
912 }
913
914 fn cleanup(
915 workspace_id: WorkspaceId,
916 alive_items: Vec<ItemId>,
917 cx: &mut WindowContext,
918 ) -> Task<Result<()>> {
919 cx.spawn(|_| DB.delete_unloaded_items(workspace_id, alive_items))
920 }
921
922 fn deserialize(
923 project: Model<Project>,
924 _workspace: WeakView<Workspace>,
925 workspace_id: workspace::WorkspaceId,
926 item_id: ItemId,
927 cx: &mut ViewContext<Pane>,
928 ) -> Task<Result<View<Self>>> {
929 let serialized_editor = match DB
930 .get_serialized_editor(item_id, workspace_id)
931 .context("Failed to query editor state")
932 {
933 Ok(Some(serialized_editor)) => {
934 if ProjectSettings::get_global(cx)
935 .session
936 .restore_unsaved_buffers
937 {
938 serialized_editor
939 } else {
940 SerializedEditor {
941 path: serialized_editor.path,
942 contents: None,
943 language: None,
944 mtime: None,
945 }
946 }
947 }
948 Ok(None) => {
949 return Task::ready(Err(anyhow!("No path or contents found for buffer")));
950 }
951 Err(error) => {
952 return Task::ready(Err(error));
953 }
954 };
955
956 let buffer_task = match serialized_editor {
957 SerializedEditor {
958 path: None,
959 contents: Some(contents),
960 language,
961 ..
962 } => cx.spawn(|_, mut cx| {
963 let project = project.clone();
964 async move {
965 let language = if let Some(language_name) = language {
966 let language_registry =
967 project.update(&mut cx, |project, _| project.languages().clone())?;
968
969 // We don't fail here, because we'd rather not set the language if the name changed
970 // than fail to restore the buffer.
971 language_registry
972 .language_for_name(&language_name)
973 .await
974 .ok()
975 } else {
976 None
977 };
978
979 // First create the empty buffer
980 let buffer = project.update(&mut cx, |project, cx| {
981 project.create_local_buffer("", language, cx)
982 })?;
983
984 // Then set the text so that the dirty bit is set correctly
985 buffer.update(&mut cx, |buffer, cx| {
986 buffer.set_text(contents, cx);
987 })?;
988
989 anyhow::Ok(buffer)
990 }
991 }),
992 SerializedEditor {
993 path: Some(path),
994 contents,
995 mtime,
996 ..
997 } => {
998 let project_item = project.update(cx, |project, cx| {
999 let (worktree, path) = project
1000 .find_worktree(&path, cx)
1001 .with_context(|| format!("No worktree for path: {path:?}"))?;
1002 let project_path = ProjectPath {
1003 worktree_id: worktree.read(cx).id(),
1004 path: path.into(),
1005 };
1006
1007 Ok(project.open_path(project_path, cx))
1008 });
1009
1010 project_item
1011 .map(|project_item| {
1012 cx.spawn(|_, mut cx| async move {
1013 let (_, project_item) = project_item.await?;
1014 let buffer = project_item.downcast::<Buffer>().map_err(|_| {
1015 anyhow!("Project item at stored path was not a buffer")
1016 })?;
1017
1018 // This is a bit wasteful: we're loading the whole buffer from
1019 // disk and then overwrite the content.
1020 // But for now, it keeps the implementation of the content serialization
1021 // simple, because we don't have to persist all of the metadata that we get
1022 // by loading the file (git diff base, ...).
1023 if let Some(buffer_text) = contents {
1024 buffer.update(&mut cx, |buffer, cx| {
1025 // If we did restore an mtime, we want to store it on the buffer
1026 // so that the next edit will mark the buffer as dirty/conflicted.
1027 if mtime.is_some() {
1028 buffer.did_reload(
1029 buffer.version(),
1030 buffer.line_ending(),
1031 mtime,
1032 cx,
1033 );
1034 }
1035 buffer.set_text(buffer_text, cx);
1036 })?;
1037 }
1038
1039 Ok(buffer)
1040 })
1041 })
1042 .unwrap_or_else(|error| Task::ready(Err(error)))
1043 }
1044 _ => return Task::ready(Err(anyhow!("No path or contents found for buffer"))),
1045 };
1046
1047 cx.spawn(|pane, mut cx| async move {
1048 let buffer = buffer_task.await?;
1049
1050 pane.update(&mut cx, |_, cx| {
1051 cx.new_view(|cx| {
1052 let mut editor = Editor::for_buffer(buffer, Some(project), cx);
1053
1054 editor.read_scroll_position_from_db(item_id, workspace_id, cx);
1055 editor
1056 })
1057 })
1058 })
1059 }
1060
1061 fn serialize(
1062 &mut self,
1063 workspace: &mut Workspace,
1064 item_id: ItemId,
1065 closing: bool,
1066 cx: &mut ViewContext<Self>,
1067 ) -> Option<Task<Result<()>>> {
1068 let mut serialize_dirty_buffers = self.serialize_dirty_buffers;
1069
1070 let project = self.project.clone()?;
1071 if project.read(cx).visible_worktrees(cx).next().is_none() {
1072 // If we don't have a worktree, we don't serialize, because
1073 // projects without worktrees aren't deserialized.
1074 serialize_dirty_buffers = false;
1075 }
1076
1077 if closing && !serialize_dirty_buffers {
1078 return None;
1079 }
1080
1081 let workspace_id = workspace.database_id()?;
1082
1083 let buffer = self.buffer().read(cx).as_singleton()?;
1084
1085 let is_dirty = buffer.read(cx).is_dirty();
1086 let local_file = buffer.read(cx).file().and_then(|file| file.as_local());
1087 let path = local_file.map(|file| file.abs_path(cx));
1088 let mtime = buffer.read(cx).saved_mtime();
1089
1090 let snapshot = buffer.read(cx).snapshot();
1091
1092 Some(cx.spawn(|_this, cx| async move {
1093 cx.background_executor()
1094 .spawn(async move {
1095 let (contents, language) = if serialize_dirty_buffers && is_dirty {
1096 let contents = snapshot.text();
1097 let language = snapshot.language().map(|lang| lang.name().to_string());
1098 (Some(contents), language)
1099 } else {
1100 (None, None)
1101 };
1102
1103 let editor = SerializedEditor {
1104 path,
1105 contents,
1106 language,
1107 mtime,
1108 };
1109
1110 DB.save_serialized_editor(item_id, workspace_id, editor)
1111 .await
1112 .context("failed to save serialized editor")
1113 })
1114 .await
1115 .context("failed to save contents of buffer")?;
1116
1117 Ok(())
1118 }))
1119 }
1120
1121 fn should_serialize(&self, event: &Self::Event) -> bool {
1122 matches!(
1123 event,
1124 EditorEvent::Saved | EditorEvent::DirtyChanged | EditorEvent::BufferEdited
1125 )
1126 }
1127}
1128
1129impl ProjectItem for Editor {
1130 type Item = Buffer;
1131
1132 fn for_project_item(
1133 project: Model<Project>,
1134 buffer: Model<Buffer>,
1135 cx: &mut ViewContext<Self>,
1136 ) -> Self {
1137 Self::for_buffer(buffer, Some(project), cx)
1138 }
1139}
1140
1141impl EventEmitter<SearchEvent> for Editor {}
1142
1143pub(crate) enum BufferSearchHighlights {}
1144impl SearchableItem for Editor {
1145 type Match = Range<Anchor>;
1146
1147 fn clear_matches(&mut self, cx: &mut ViewContext<Self>) {
1148 self.clear_background_highlights::<BufferSearchHighlights>(cx);
1149 }
1150
1151 fn update_matches(&mut self, matches: &[Range<Anchor>], cx: &mut ViewContext<Self>) {
1152 self.highlight_background::<BufferSearchHighlights>(
1153 matches,
1154 |theme| theme.search_match_background,
1155 cx,
1156 );
1157 }
1158
1159 fn has_filtered_search_ranges(&mut self) -> bool {
1160 self.has_background_highlights::<SearchWithinRange>()
1161 }
1162
1163 fn toggle_filtered_search_ranges(&mut self, enabled: bool, cx: &mut ViewContext<Self>) {
1164 if self.has_filtered_search_ranges() {
1165 self.previous_search_ranges = self
1166 .clear_background_highlights::<SearchWithinRange>(cx)
1167 .map(|(_, ranges)| ranges)
1168 }
1169
1170 if !enabled {
1171 return;
1172 }
1173
1174 let ranges = self.selections.disjoint_anchor_ranges();
1175 if ranges.iter().any(|range| range.start != range.end) {
1176 self.set_search_within_ranges(&ranges, cx);
1177 } else if let Some(previous_search_ranges) = self.previous_search_ranges.take() {
1178 self.set_search_within_ranges(&previous_search_ranges, cx)
1179 }
1180 }
1181
1182 fn query_suggestion(&mut self, cx: &mut ViewContext<Self>) -> String {
1183 let setting = EditorSettings::get_global(cx).seed_search_query_from_cursor;
1184 let snapshot = &self.snapshot(cx).buffer_snapshot;
1185 let selection = self.selections.newest::<usize>(cx);
1186
1187 match setting {
1188 SeedQuerySetting::Never => String::new(),
1189 SeedQuerySetting::Selection | SeedQuerySetting::Always if !selection.is_empty() => {
1190 let text: String = snapshot
1191 .text_for_range(selection.start..selection.end)
1192 .collect();
1193 if text.contains('\n') {
1194 String::new()
1195 } else {
1196 text
1197 }
1198 }
1199 SeedQuerySetting::Selection => String::new(),
1200 SeedQuerySetting::Always => {
1201 let (range, kind) = snapshot.surrounding_word(selection.start);
1202 if kind == Some(CharKind::Word) {
1203 let text: String = snapshot.text_for_range(range).collect();
1204 if !text.trim().is_empty() {
1205 return text;
1206 }
1207 }
1208 String::new()
1209 }
1210 }
1211 }
1212
1213 fn activate_match(
1214 &mut self,
1215 index: usize,
1216 matches: &[Range<Anchor>],
1217 cx: &mut ViewContext<Self>,
1218 ) {
1219 self.unfold_ranges([matches[index].clone()], false, true, cx);
1220 let range = self.range_for_match(&matches[index]);
1221 self.change_selections(Some(Autoscroll::fit()), cx, |s| {
1222 s.select_ranges([range]);
1223 })
1224 }
1225
1226 fn select_matches(&mut self, matches: &[Self::Match], cx: &mut ViewContext<Self>) {
1227 self.unfold_ranges(matches.to_vec(), false, false, cx);
1228 let mut ranges = Vec::new();
1229 for m in matches {
1230 ranges.push(self.range_for_match(&m))
1231 }
1232 self.change_selections(None, cx, |s| s.select_ranges(ranges));
1233 }
1234 fn replace(
1235 &mut self,
1236 identifier: &Self::Match,
1237 query: &SearchQuery,
1238 cx: &mut ViewContext<Self>,
1239 ) {
1240 let text = self.buffer.read(cx);
1241 let text = text.snapshot(cx);
1242 let text = text.text_for_range(identifier.clone()).collect::<Vec<_>>();
1243 let text: Cow<_> = if text.len() == 1 {
1244 text.first().cloned().unwrap().into()
1245 } else {
1246 let joined_chunks = text.join("");
1247 joined_chunks.into()
1248 };
1249
1250 if let Some(replacement) = query.replacement_for(&text) {
1251 self.transact(cx, |this, cx| {
1252 this.edit([(identifier.clone(), Arc::from(&*replacement))], cx);
1253 });
1254 }
1255 }
1256 fn replace_all(
1257 &mut self,
1258 matches: &mut dyn Iterator<Item = &Self::Match>,
1259 query: &SearchQuery,
1260 cx: &mut ViewContext<Self>,
1261 ) {
1262 let text = self.buffer.read(cx);
1263 let text = text.snapshot(cx);
1264 let mut edits = vec![];
1265 for m in matches {
1266 let text = text.text_for_range(m.clone()).collect::<Vec<_>>();
1267 let text: Cow<_> = if text.len() == 1 {
1268 text.first().cloned().unwrap().into()
1269 } else {
1270 let joined_chunks = text.join("");
1271 joined_chunks.into()
1272 };
1273
1274 if let Some(replacement) = query.replacement_for(&text) {
1275 edits.push((m.clone(), Arc::from(&*replacement)));
1276 }
1277 }
1278
1279 if !edits.is_empty() {
1280 self.transact(cx, |this, cx| {
1281 this.edit(edits, cx);
1282 });
1283 }
1284 }
1285 fn match_index_for_direction(
1286 &mut self,
1287 matches: &[Range<Anchor>],
1288 current_index: usize,
1289 direction: Direction,
1290 count: usize,
1291 cx: &mut ViewContext<Self>,
1292 ) -> usize {
1293 let buffer = self.buffer().read(cx).snapshot(cx);
1294 let current_index_position = if self.selections.disjoint_anchors().len() == 1 {
1295 self.selections.newest_anchor().head()
1296 } else {
1297 matches[current_index].start
1298 };
1299
1300 let mut count = count % matches.len();
1301 if count == 0 {
1302 return current_index;
1303 }
1304 match direction {
1305 Direction::Next => {
1306 if matches[current_index]
1307 .start
1308 .cmp(¤t_index_position, &buffer)
1309 .is_gt()
1310 {
1311 count = count - 1
1312 }
1313
1314 (current_index + count) % matches.len()
1315 }
1316 Direction::Prev => {
1317 if matches[current_index]
1318 .end
1319 .cmp(¤t_index_position, &buffer)
1320 .is_lt()
1321 {
1322 count = count - 1;
1323 }
1324
1325 if current_index >= count {
1326 current_index - count
1327 } else {
1328 matches.len() - (count - current_index)
1329 }
1330 }
1331 }
1332 }
1333
1334 fn find_matches(
1335 &mut self,
1336 query: Arc<project::search::SearchQuery>,
1337 cx: &mut ViewContext<Self>,
1338 ) -> Task<Vec<Range<Anchor>>> {
1339 let buffer = self.buffer().read(cx).snapshot(cx);
1340 let search_within_ranges = self
1341 .background_highlights
1342 .get(&TypeId::of::<SearchWithinRange>())
1343 .map_or(vec![], |(_color, ranges)| {
1344 ranges.iter().map(|range| range.clone()).collect::<Vec<_>>()
1345 });
1346
1347 cx.background_executor().spawn(async move {
1348 let mut ranges = Vec::new();
1349
1350 if let Some((_, _, excerpt_buffer)) = buffer.as_singleton() {
1351 let search_within_ranges = if search_within_ranges.is_empty() {
1352 vec![None]
1353 } else {
1354 search_within_ranges
1355 .into_iter()
1356 .map(|range| Some(range.to_offset(&buffer)))
1357 .collect::<Vec<_>>()
1358 };
1359
1360 for range in search_within_ranges {
1361 let buffer = &buffer;
1362 ranges.extend(
1363 query
1364 .search(excerpt_buffer, range.clone())
1365 .await
1366 .into_iter()
1367 .map(|matched_range| {
1368 let offset = range.clone().map(|r| r.start).unwrap_or(0);
1369 buffer.anchor_after(matched_range.start + offset)
1370 ..buffer.anchor_before(matched_range.end + offset)
1371 }),
1372 );
1373 }
1374 } else {
1375 let search_within_ranges = if search_within_ranges.is_empty() {
1376 vec![buffer.anchor_before(0)..buffer.anchor_after(buffer.len())]
1377 } else {
1378 search_within_ranges
1379 };
1380
1381 for (excerpt_id, search_buffer, search_range) in
1382 buffer.excerpts_in_ranges(search_within_ranges)
1383 {
1384 if !search_range.is_empty() {
1385 ranges.extend(
1386 query
1387 .search(&search_buffer, Some(search_range.clone()))
1388 .await
1389 .into_iter()
1390 .map(|match_range| {
1391 let start = search_buffer
1392 .anchor_after(search_range.start + match_range.start);
1393 let end = search_buffer
1394 .anchor_before(search_range.start + match_range.end);
1395 buffer.anchor_in_excerpt(excerpt_id, start).unwrap()
1396 ..buffer.anchor_in_excerpt(excerpt_id, end).unwrap()
1397 }),
1398 );
1399 }
1400 }
1401 };
1402
1403 ranges
1404 })
1405 }
1406
1407 fn active_match_index(
1408 &mut self,
1409 matches: &[Range<Anchor>],
1410 cx: &mut ViewContext<Self>,
1411 ) -> Option<usize> {
1412 active_match_index(
1413 matches,
1414 &self.selections.newest_anchor().head(),
1415 &self.buffer().read(cx).snapshot(cx),
1416 )
1417 }
1418
1419 fn search_bar_visibility_changed(&mut self, _visible: bool, _cx: &mut ViewContext<Self>) {
1420 self.expect_bounds_change = self.last_bounds;
1421 }
1422}
1423
1424pub fn active_match_index(
1425 ranges: &[Range<Anchor>],
1426 cursor: &Anchor,
1427 buffer: &MultiBufferSnapshot,
1428) -> Option<usize> {
1429 if ranges.is_empty() {
1430 None
1431 } else {
1432 match ranges.binary_search_by(|probe| {
1433 if probe.end.cmp(cursor, buffer).is_lt() {
1434 Ordering::Less
1435 } else if probe.start.cmp(cursor, buffer).is_gt() {
1436 Ordering::Greater
1437 } else {
1438 Ordering::Equal
1439 }
1440 }) {
1441 Ok(i) | Err(i) => Some(cmp::min(i, ranges.len() - 1)),
1442 }
1443 }
1444}
1445
1446pub fn entry_label_color(selected: bool) -> Color {
1447 if selected {
1448 Color::Default
1449 } else {
1450 Color::Muted
1451 }
1452}
1453
1454pub fn entry_git_aware_label_color(
1455 git_status: Option<GitFileStatus>,
1456 ignored: bool,
1457 selected: bool,
1458) -> Color {
1459 if ignored {
1460 Color::Ignored
1461 } else {
1462 match git_status {
1463 Some(GitFileStatus::Added) => Color::Created,
1464 Some(GitFileStatus::Modified) => Color::Modified,
1465 Some(GitFileStatus::Conflict) => Color::Conflict,
1466 None => entry_label_color(selected),
1467 }
1468 }
1469}
1470
1471fn path_for_buffer<'a>(
1472 buffer: &Model<MultiBuffer>,
1473 height: usize,
1474 include_filename: bool,
1475 cx: &'a AppContext,
1476) -> Option<Cow<'a, Path>> {
1477 let file = buffer.read(cx).as_singleton()?.read(cx).file()?;
1478 path_for_file(file.as_ref(), height, include_filename, cx)
1479}
1480
1481fn path_for_file<'a>(
1482 file: &'a dyn language::File,
1483 mut height: usize,
1484 include_filename: bool,
1485 cx: &'a AppContext,
1486) -> Option<Cow<'a, Path>> {
1487 // Ensure we always render at least the filename.
1488 height += 1;
1489
1490 let mut prefix = file.path().as_ref();
1491 while height > 0 {
1492 if let Some(parent) = prefix.parent() {
1493 prefix = parent;
1494 height -= 1;
1495 } else {
1496 break;
1497 }
1498 }
1499
1500 // Here we could have just always used `full_path`, but that is very
1501 // allocation-heavy and so we try to use a `Cow<Path>` if we haven't
1502 // traversed all the way up to the worktree's root.
1503 if height > 0 {
1504 let full_path = file.full_path(cx);
1505 if include_filename {
1506 Some(full_path.into())
1507 } else {
1508 Some(full_path.parent()?.to_path_buf().into())
1509 }
1510 } else {
1511 let mut path = file.path().strip_prefix(prefix).ok()?;
1512 if !include_filename {
1513 path = path.parent()?;
1514 }
1515 Some(path.into())
1516 }
1517}
1518
1519#[cfg(test)]
1520mod tests {
1521 use crate::editor_tests::init_test;
1522
1523 use super::*;
1524 use gpui::{AppContext, VisualTestContext};
1525 use language::{LanguageMatcher, TestFile};
1526 use project::FakeFs;
1527 use std::{
1528 path::{Path, PathBuf},
1529 time::SystemTime,
1530 };
1531
1532 #[gpui::test]
1533 fn test_path_for_file(cx: &mut AppContext) {
1534 let file = TestFile {
1535 path: Path::new("").into(),
1536 root_name: String::new(),
1537 };
1538 assert_eq!(path_for_file(&file, 0, false, cx), None);
1539 }
1540
1541 async fn deserialize_editor(
1542 item_id: ItemId,
1543 workspace_id: WorkspaceId,
1544 workspace: View<Workspace>,
1545 project: Model<Project>,
1546 cx: &mut VisualTestContext,
1547 ) -> View<Editor> {
1548 workspace
1549 .update(cx, |workspace, cx| {
1550 let pane = workspace.active_pane();
1551 pane.update(cx, |_, cx| {
1552 Editor::deserialize(
1553 project.clone(),
1554 workspace.weak_handle(),
1555 workspace_id,
1556 item_id,
1557 cx,
1558 )
1559 })
1560 })
1561 .await
1562 .unwrap()
1563 }
1564
1565 fn rust_language() -> Arc<language::Language> {
1566 Arc::new(language::Language::new(
1567 language::LanguageConfig {
1568 name: "Rust".into(),
1569 matcher: LanguageMatcher {
1570 path_suffixes: vec!["rs".to_string()],
1571 ..Default::default()
1572 },
1573 ..Default::default()
1574 },
1575 Some(tree_sitter_rust::language()),
1576 ))
1577 }
1578
1579 #[gpui::test]
1580 async fn test_deserialize(cx: &mut gpui::TestAppContext) {
1581 init_test(cx, |_| {});
1582
1583 let now = SystemTime::now();
1584 let fs = FakeFs::new(cx.executor());
1585 fs.set_next_mtime(now);
1586 fs.insert_file("/file.rs", Default::default()).await;
1587
1588 // Test case 1: Deserialize with path and contents
1589 {
1590 let project = Project::test(fs.clone(), ["/file.rs".as_ref()], cx).await;
1591 let (workspace, cx) = cx.add_window_view(|cx| Workspace::test_new(project.clone(), cx));
1592 let workspace_id = workspace::WORKSPACE_DB.next_id().await.unwrap();
1593 let item_id = 1234 as ItemId;
1594
1595 let serialized_editor = SerializedEditor {
1596 path: Some(PathBuf::from("/file.rs")),
1597 contents: Some("fn main() {}".to_string()),
1598 language: Some("Rust".to_string()),
1599 mtime: Some(now),
1600 };
1601
1602 DB.save_serialized_editor(item_id, workspace_id, serialized_editor.clone())
1603 .await
1604 .unwrap();
1605
1606 let deserialized =
1607 deserialize_editor(item_id, workspace_id, workspace, project, cx).await;
1608
1609 deserialized.update(cx, |editor, cx| {
1610 assert_eq!(editor.text(cx), "fn main() {}");
1611 assert!(editor.is_dirty(cx));
1612 assert!(!editor.has_conflict(cx));
1613 let buffer = editor.buffer().read(cx).as_singleton().unwrap().read(cx);
1614 assert!(buffer.file().is_some());
1615 });
1616 }
1617
1618 // Test case 2: Deserialize with only path
1619 {
1620 let project = Project::test(fs.clone(), ["/file.rs".as_ref()], cx).await;
1621 let (workspace, cx) = cx.add_window_view(|cx| Workspace::test_new(project.clone(), cx));
1622
1623 let workspace_id = workspace::WORKSPACE_DB.next_id().await.unwrap();
1624
1625 let item_id = 5678 as ItemId;
1626 let serialized_editor = SerializedEditor {
1627 path: Some(PathBuf::from("/file.rs")),
1628 contents: None,
1629 language: None,
1630 mtime: None,
1631 };
1632
1633 DB.save_serialized_editor(item_id, workspace_id, serialized_editor)
1634 .await
1635 .unwrap();
1636
1637 let deserialized =
1638 deserialize_editor(item_id, workspace_id, workspace, project, cx).await;
1639
1640 deserialized.update(cx, |editor, cx| {
1641 assert_eq!(editor.text(cx), ""); // The file should be empty as per our initial setup
1642 assert!(!editor.is_dirty(cx));
1643 assert!(!editor.has_conflict(cx));
1644
1645 let buffer = editor.buffer().read(cx).as_singleton().unwrap().read(cx);
1646 assert!(buffer.file().is_some());
1647 });
1648 }
1649
1650 // Test case 3: Deserialize with no path (untitled buffer, with content and language)
1651 {
1652 let project = Project::test(fs.clone(), ["/file.rs".as_ref()], cx).await;
1653 // Add Rust to the language, so that we can restore the language of the buffer
1654 project.update(cx, |project, _| project.languages().add(rust_language()));
1655
1656 let (workspace, cx) = cx.add_window_view(|cx| Workspace::test_new(project.clone(), cx));
1657
1658 let workspace_id = workspace::WORKSPACE_DB.next_id().await.unwrap();
1659
1660 let item_id = 9012 as ItemId;
1661 let serialized_editor = SerializedEditor {
1662 path: None,
1663 contents: Some("hello".to_string()),
1664 language: Some("Rust".to_string()),
1665 mtime: None,
1666 };
1667
1668 DB.save_serialized_editor(item_id, workspace_id, serialized_editor)
1669 .await
1670 .unwrap();
1671
1672 let deserialized =
1673 deserialize_editor(item_id, workspace_id, workspace, project, cx).await;
1674
1675 deserialized.update(cx, |editor, cx| {
1676 assert_eq!(editor.text(cx), "hello");
1677 assert!(editor.is_dirty(cx)); // The editor should be dirty for an untitled buffer
1678
1679 let buffer = editor.buffer().read(cx).as_singleton().unwrap().read(cx);
1680 assert_eq!(
1681 buffer.language().map(|lang| lang.name()).as_deref(),
1682 Some("Rust")
1683 ); // Language should be set to Rust
1684 assert!(buffer.file().is_none()); // The buffer should not have an associated file
1685 });
1686 }
1687
1688 // Test case 4: Deserialize with path, content, and old mtime
1689 {
1690 let project = Project::test(fs.clone(), ["/file.rs".as_ref()], cx).await;
1691 let (workspace, cx) = cx.add_window_view(|cx| Workspace::test_new(project.clone(), cx));
1692
1693 let workspace_id = workspace::WORKSPACE_DB.next_id().await.unwrap();
1694
1695 let item_id = 9345 as ItemId;
1696 let old_mtime = now
1697 .checked_sub(std::time::Duration::from_secs(60 * 60 * 24))
1698 .unwrap();
1699 let serialized_editor = SerializedEditor {
1700 path: Some(PathBuf::from("/file.rs")),
1701 contents: Some("fn main() {}".to_string()),
1702 language: Some("Rust".to_string()),
1703 mtime: Some(old_mtime),
1704 };
1705
1706 DB.save_serialized_editor(item_id, workspace_id, serialized_editor)
1707 .await
1708 .unwrap();
1709
1710 let deserialized =
1711 deserialize_editor(item_id, workspace_id, workspace, project, cx).await;
1712
1713 deserialized.update(cx, |editor, cx| {
1714 assert_eq!(editor.text(cx), "fn main() {}");
1715 assert!(editor.has_conflict(cx)); // The editor should have a conflict
1716 });
1717 }
1718 }
1719}