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