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