1use crate::{
2 Anchor, Autoscroll, BufferSerialization, Capability, Editor, EditorEvent, EditorSettings,
3 ExcerptId, ExcerptRange, FormatTarget, MultiBuffer, MultiBufferSnapshot, NavigationData,
4 ReportEditorEvent, SelectionEffects, ToPoint as _,
5 display_map::HighlightKey,
6 editor_settings::SeedQuerySetting,
7 persistence::{DB, SerializedEditor},
8 scroll::{ScrollAnchor, ScrollOffset},
9};
10use anyhow::{Context as _, Result, anyhow};
11use collections::{HashMap, HashSet};
12use file_icons::FileIcons;
13use fs::MTime;
14use futures::future::try_join_all;
15use git::status::GitSummary;
16use gpui::{
17 AnyElement, App, AsyncWindowContext, Context, Entity, EntityId, EventEmitter, IntoElement,
18 ParentElement, Pixels, SharedString, Styled, Task, WeakEntity, Window, point,
19};
20use language::{
21 Bias, Buffer, BufferRow, CharKind, CharScopeContext, LocalFile, Point, SelectionGoal,
22 proto::serialize_anchor as serialize_text_anchor,
23};
24use lsp::DiagnosticSeverity;
25use multi_buffer::MultiBufferOffset;
26use project::{
27 File, Project, ProjectItem as _, ProjectPath, lsp_store::FormatTrigger,
28 project_settings::ProjectSettings, search::SearchQuery,
29};
30use rpc::proto::{self, update_view};
31use settings::Settings;
32use std::{
33 any::{Any, TypeId},
34 borrow::Cow,
35 cmp::{self, Ordering},
36 iter,
37 ops::Range,
38 path::{Path, PathBuf},
39 sync::Arc,
40};
41use text::{BufferId, BufferSnapshot, Selection};
42use ui::{IconDecorationKind, prelude::*};
43use util::{ResultExt, TryFutureExt, paths::PathExt};
44use workspace::{
45 CollaboratorId, ItemId, ItemNavHistory, ToolbarItemLocation, ViewId, Workspace, WorkspaceId,
46 invalid_item_view::InvalidItemView,
47 item::{FollowableItem, Item, ItemBufferKind, ItemEvent, ProjectItem, SaveOptions},
48 searchable::{
49 Direction, FilteredSearchRange, SearchEvent, SearchToken, SearchableItem,
50 SearchableItemHandle,
51 },
52};
53use workspace::{
54 OpenOptions,
55 item::{Dedup, ItemSettings, SerializableItem, TabContentParams},
56};
57use workspace::{
58 OpenVisible, Pane, WorkspaceSettings,
59 item::{BreadcrumbText, FollowEvent, ProjectItemKind},
60 searchable::SearchOptions,
61};
62use zed_actions::preview::{
63 markdown::OpenPreview as OpenMarkdownPreview, svg::OpenPreview as OpenSvgPreview,
64};
65
66pub const MAX_TAB_TITLE_LEN: usize = 24;
67
68impl FollowableItem for Editor {
69 fn remote_id(&self) -> Option<ViewId> {
70 self.remote_id
71 }
72
73 fn from_state_proto(
74 workspace: Entity<Workspace>,
75 remote_id: ViewId,
76 state: &mut Option<proto::view::Variant>,
77 window: &mut Window,
78 cx: &mut App,
79 ) -> Option<Task<Result<Entity<Self>>>> {
80 let project = workspace.read(cx).project().to_owned();
81 let Some(proto::view::Variant::Editor(_)) = state else {
82 return None;
83 };
84 let Some(proto::view::Variant::Editor(state)) = state.take() else {
85 unreachable!()
86 };
87
88 let buffer_ids = state
89 .excerpts
90 .iter()
91 .map(|excerpt| excerpt.buffer_id)
92 .collect::<HashSet<_>>();
93 let buffers = project.update(cx, |project, cx| {
94 buffer_ids
95 .iter()
96 .map(|id| BufferId::new(*id).map(|id| project.open_buffer_by_id(id, cx)))
97 .collect::<Result<Vec<_>>>()
98 });
99
100 Some(window.spawn(cx, async move |cx| {
101 let mut buffers = futures::future::try_join_all(buffers?)
102 .await
103 .debug_assert_ok("leaders don't share views for unshared buffers")?;
104
105 let editor = cx.update(|window, cx| {
106 let multibuffer = cx.new(|cx| {
107 let mut multibuffer;
108 if state.singleton && buffers.len() == 1 {
109 multibuffer = MultiBuffer::singleton(buffers.pop().unwrap(), cx)
110 } else {
111 multibuffer = MultiBuffer::new(project.read(cx).capability());
112 let mut sorted_excerpts = state.excerpts.clone();
113 sorted_excerpts.sort_by_key(|e| e.id);
114 let sorted_excerpts = sorted_excerpts.into_iter().peekable();
115
116 for excerpt in sorted_excerpts {
117 let Ok(buffer_id) = BufferId::new(excerpt.buffer_id) else {
118 continue;
119 };
120
121 let mut insert_position = ExcerptId::min();
122 for e in &state.excerpts {
123 if e.id == excerpt.id {
124 break;
125 }
126 if e.id < excerpt.id {
127 insert_position = ExcerptId::from_proto(e.id);
128 }
129 }
130
131 let buffer =
132 buffers.iter().find(|b| b.read(cx).remote_id() == buffer_id);
133
134 let Some(excerpt) = deserialize_excerpt_range(excerpt) else {
135 continue;
136 };
137
138 let Some(buffer) = buffer else { continue };
139
140 multibuffer.insert_excerpts_with_ids_after(
141 insert_position,
142 buffer.clone(),
143 [excerpt],
144 cx,
145 );
146 }
147 };
148
149 if let Some(title) = &state.title {
150 multibuffer = multibuffer.with_title(title.clone())
151 }
152
153 multibuffer
154 });
155
156 cx.new(|cx| {
157 let mut editor =
158 Editor::for_multibuffer(multibuffer, Some(project.clone()), window, cx);
159 editor.remote_id = Some(remote_id);
160 editor
161 })
162 })?;
163
164 update_editor_from_message(
165 editor.downgrade(),
166 project,
167 proto::update_view::Editor {
168 selections: state.selections,
169 pending_selection: state.pending_selection,
170 scroll_top_anchor: state.scroll_top_anchor,
171 scroll_x: state.scroll_x,
172 scroll_y: state.scroll_y,
173 ..Default::default()
174 },
175 cx,
176 )
177 .await?;
178
179 Ok(editor)
180 }))
181 }
182
183 fn set_leader_id(
184 &mut self,
185 leader_id: Option<CollaboratorId>,
186 window: &mut Window,
187 cx: &mut Context<Self>,
188 ) {
189 self.leader_id = leader_id;
190 if self.leader_id.is_some() {
191 self.buffer.update(cx, |buffer, cx| {
192 buffer.remove_active_selections(cx);
193 });
194 } else if self.focus_handle.is_focused(window) {
195 self.buffer.update(cx, |buffer, cx| {
196 buffer.set_active_selections(
197 &self.selections.disjoint_anchors_arc(),
198 self.selections.line_mode(),
199 self.cursor_shape,
200 cx,
201 );
202 });
203 }
204 cx.notify();
205 }
206
207 fn to_state_proto(&self, _: &mut Window, cx: &mut App) -> Option<proto::view::Variant> {
208 let is_private = self
209 .buffer
210 .read(cx)
211 .as_singleton()
212 .and_then(|buffer| buffer.read(cx).file())
213 .is_some_and(|file| file.is_private());
214 if is_private {
215 return None;
216 }
217
218 let display_snapshot = self.display_map.update(cx, |map, cx| map.snapshot(cx));
219 let scroll_anchor = self.scroll_manager.native_anchor(&display_snapshot, cx);
220 let buffer = self.buffer.read(cx);
221 let excerpts = buffer
222 .read(cx)
223 .excerpts()
224 .map(|(id, buffer, range)| proto::Excerpt {
225 id: id.to_proto(),
226 buffer_id: buffer.remote_id().into(),
227 context_start: Some(serialize_text_anchor(&range.context.start)),
228 context_end: Some(serialize_text_anchor(&range.context.end)),
229 primary_start: Some(serialize_text_anchor(&range.primary.start)),
230 primary_end: Some(serialize_text_anchor(&range.primary.end)),
231 })
232 .collect();
233 let snapshot = buffer.snapshot(cx);
234
235 Some(proto::view::Variant::Editor(proto::view::Editor {
236 singleton: buffer.is_singleton(),
237 title: buffer.explicit_title().map(ToOwned::to_owned),
238 excerpts,
239 scroll_top_anchor: Some(serialize_anchor(&scroll_anchor.anchor, &snapshot)),
240 scroll_x: scroll_anchor.offset.x,
241 scroll_y: scroll_anchor.offset.y,
242 selections: self
243 .selections
244 .disjoint_anchors_arc()
245 .iter()
246 .map(|s| serialize_selection(s, &snapshot))
247 .collect(),
248 pending_selection: self
249 .selections
250 .pending_anchor()
251 .as_ref()
252 .map(|s| serialize_selection(s, &snapshot)),
253 }))
254 }
255
256 fn to_follow_event(event: &EditorEvent) -> Option<workspace::item::FollowEvent> {
257 match event {
258 EditorEvent::Edited { .. } => Some(FollowEvent::Unfollow),
259 EditorEvent::SelectionsChanged { local }
260 | EditorEvent::ScrollPositionChanged { local, .. } => {
261 if *local {
262 Some(FollowEvent::Unfollow)
263 } else {
264 None
265 }
266 }
267 _ => None,
268 }
269 }
270
271 fn add_event_to_update_proto(
272 &self,
273 event: &EditorEvent,
274 update: &mut Option<proto::update_view::Variant>,
275 _: &mut Window,
276 cx: &mut App,
277 ) -> bool {
278 let update =
279 update.get_or_insert_with(|| proto::update_view::Variant::Editor(Default::default()));
280
281 match update {
282 proto::update_view::Variant::Editor(update) => match event {
283 EditorEvent::ExcerptsAdded {
284 buffer,
285 predecessor,
286 excerpts,
287 } => {
288 let buffer_id = buffer.read(cx).remote_id();
289 let mut excerpts = excerpts.iter();
290 if let Some((id, range)) = excerpts.next() {
291 update.inserted_excerpts.push(proto::ExcerptInsertion {
292 previous_excerpt_id: Some(predecessor.to_proto()),
293 excerpt: serialize_excerpt(buffer_id, id, range),
294 });
295 update.inserted_excerpts.extend(excerpts.map(|(id, range)| {
296 proto::ExcerptInsertion {
297 previous_excerpt_id: None,
298 excerpt: serialize_excerpt(buffer_id, id, range),
299 }
300 }))
301 }
302 true
303 }
304 EditorEvent::ExcerptsRemoved { ids, .. } => {
305 update
306 .deleted_excerpts
307 .extend(ids.iter().copied().map(ExcerptId::to_proto));
308 true
309 }
310 EditorEvent::ScrollPositionChanged { autoscroll, .. } if !autoscroll => {
311 let display_snapshot = self.display_map.update(cx, |map, cx| map.snapshot(cx));
312 let snapshot = self.buffer.read(cx).snapshot(cx);
313 let scroll_anchor = self.scroll_manager.native_anchor(&display_snapshot, cx);
314 update.scroll_top_anchor =
315 Some(serialize_anchor(&scroll_anchor.anchor, &snapshot));
316 update.scroll_x = scroll_anchor.offset.x;
317 update.scroll_y = scroll_anchor.offset.y;
318 true
319 }
320 EditorEvent::SelectionsChanged { .. } => {
321 let snapshot = self.buffer.read(cx).snapshot(cx);
322 update.selections = self
323 .selections
324 .disjoint_anchors_arc()
325 .iter()
326 .map(|s| serialize_selection(s, &snapshot))
327 .collect();
328 update.pending_selection = self
329 .selections
330 .pending_anchor()
331 .as_ref()
332 .map(|s| serialize_selection(s, &snapshot));
333 true
334 }
335 _ => false,
336 },
337 }
338 }
339
340 fn apply_update_proto(
341 &mut self,
342 project: &Entity<Project>,
343 message: update_view::Variant,
344 window: &mut Window,
345 cx: &mut Context<Self>,
346 ) -> Task<Result<()>> {
347 let update_view::Variant::Editor(message) = message;
348 let project = project.clone();
349 cx.spawn_in(window, async move |this, cx| {
350 update_editor_from_message(this, project, message, cx).await
351 })
352 }
353
354 fn is_project_item(&self, _window: &Window, _cx: &App) -> bool {
355 true
356 }
357
358 fn dedup(&self, existing: &Self, _: &Window, cx: &App) -> Option<Dedup> {
359 let self_singleton = self.buffer.read(cx).as_singleton()?;
360 let other_singleton = existing.buffer.read(cx).as_singleton()?;
361 if self_singleton == other_singleton {
362 Some(Dedup::KeepExisting)
363 } else {
364 None
365 }
366 }
367
368 fn update_agent_location(
369 &mut self,
370 location: language::Anchor,
371 window: &mut Window,
372 cx: &mut Context<Self>,
373 ) {
374 let buffer = self.buffer.read(cx);
375 let buffer = buffer.read(cx);
376 let Some(position) = buffer.as_singleton_anchor(location) else {
377 return;
378 };
379 let selection = Selection {
380 id: 0,
381 reversed: false,
382 start: position,
383 end: position,
384 goal: SelectionGoal::None,
385 };
386 drop(buffer);
387 self.set_selections_from_remote(vec![selection], None, window, cx);
388 self.request_autoscroll_remotely(Autoscroll::fit(), cx);
389 }
390}
391
392async fn update_editor_from_message(
393 this: WeakEntity<Editor>,
394 project: Entity<Project>,
395 message: proto::update_view::Editor,
396 cx: &mut AsyncWindowContext,
397) -> Result<()> {
398 // Open all of the buffers of which excerpts were added to the editor.
399 let inserted_excerpt_buffer_ids = message
400 .inserted_excerpts
401 .iter()
402 .filter_map(|insertion| Some(insertion.excerpt.as_ref()?.buffer_id))
403 .collect::<HashSet<_>>();
404 let inserted_excerpt_buffers = project.update(cx, |project, cx| {
405 inserted_excerpt_buffer_ids
406 .into_iter()
407 .map(|id| BufferId::new(id).map(|id| project.open_buffer_by_id(id, cx)))
408 .collect::<Result<Vec<_>>>()
409 })?;
410 let _inserted_excerpt_buffers = try_join_all(inserted_excerpt_buffers).await?;
411
412 // Update the editor's excerpts.
413 this.update(cx, |editor, cx| {
414 editor.buffer.update(cx, |multibuffer, cx| {
415 let mut removed_excerpt_ids = message
416 .deleted_excerpts
417 .into_iter()
418 .map(ExcerptId::from_proto)
419 .collect::<Vec<_>>();
420 removed_excerpt_ids.sort_by({
421 let multibuffer = multibuffer.read(cx);
422 move |a, b| a.cmp(b, &multibuffer)
423 });
424
425 let mut insertions = message.inserted_excerpts.into_iter().peekable();
426 while let Some(insertion) = insertions.next() {
427 let Some(excerpt) = insertion.excerpt else {
428 continue;
429 };
430 let Some(previous_excerpt_id) = insertion.previous_excerpt_id else {
431 continue;
432 };
433 let buffer_id = BufferId::new(excerpt.buffer_id)?;
434 let Some(buffer) = project.read(cx).buffer_for_id(buffer_id, cx) else {
435 continue;
436 };
437
438 let adjacent_excerpts = iter::from_fn(|| {
439 let insertion = insertions.peek()?;
440 if insertion.previous_excerpt_id.is_none()
441 && insertion.excerpt.as_ref()?.buffer_id == u64::from(buffer_id)
442 {
443 insertions.next()?.excerpt
444 } else {
445 None
446 }
447 });
448
449 multibuffer.insert_excerpts_with_ids_after(
450 ExcerptId::from_proto(previous_excerpt_id),
451 buffer,
452 [excerpt]
453 .into_iter()
454 .chain(adjacent_excerpts)
455 .filter_map(deserialize_excerpt_range),
456 cx,
457 );
458 }
459
460 multibuffer.remove_excerpts(removed_excerpt_ids, cx);
461 anyhow::Ok(())
462 })
463 })??;
464
465 // Deserialize the editor state.
466 let selections = message
467 .selections
468 .into_iter()
469 .filter_map(deserialize_selection)
470 .collect::<Vec<_>>();
471 let pending_selection = message.pending_selection.and_then(deserialize_selection);
472 let scroll_top_anchor = message.scroll_top_anchor.and_then(deserialize_anchor);
473
474 // Wait until the buffer has received all of the operations referenced by
475 // the editor's new state.
476 this.update(cx, |editor, cx| {
477 editor.buffer.update(cx, |buffer, cx| {
478 buffer.wait_for_anchors(
479 selections
480 .iter()
481 .chain(pending_selection.as_ref())
482 .flat_map(|selection| [selection.start, selection.end])
483 .chain(scroll_top_anchor),
484 cx,
485 )
486 })
487 })?
488 .await?;
489
490 // Update the editor's state.
491 this.update_in(cx, |editor, window, cx| {
492 if !selections.is_empty() || pending_selection.is_some() {
493 editor.set_selections_from_remote(selections, pending_selection, window, cx);
494 editor.request_autoscroll_remotely(Autoscroll::newest(), cx);
495 } else if let Some(scroll_top_anchor) = scroll_top_anchor {
496 editor.set_scroll_anchor_remote(
497 ScrollAnchor {
498 anchor: scroll_top_anchor,
499 offset: point(message.scroll_x, message.scroll_y),
500 },
501 window,
502 cx,
503 );
504 }
505 })?;
506 Ok(())
507}
508
509fn serialize_excerpt(
510 buffer_id: BufferId,
511 id: &ExcerptId,
512 range: &ExcerptRange<language::Anchor>,
513) -> Option<proto::Excerpt> {
514 Some(proto::Excerpt {
515 id: id.to_proto(),
516 buffer_id: buffer_id.into(),
517 context_start: Some(serialize_text_anchor(&range.context.start)),
518 context_end: Some(serialize_text_anchor(&range.context.end)),
519 primary_start: Some(serialize_text_anchor(&range.primary.start)),
520 primary_end: Some(serialize_text_anchor(&range.primary.end)),
521 })
522}
523
524fn serialize_selection(
525 selection: &Selection<Anchor>,
526 buffer: &MultiBufferSnapshot,
527) -> proto::Selection {
528 proto::Selection {
529 id: selection.id as u64,
530 start: Some(serialize_anchor(&selection.start, buffer)),
531 end: Some(serialize_anchor(&selection.end, buffer)),
532 reversed: selection.reversed,
533 }
534}
535
536fn serialize_anchor(anchor: &Anchor, buffer: &MultiBufferSnapshot) -> proto::EditorAnchor {
537 proto::EditorAnchor {
538 excerpt_id: buffer.latest_excerpt_id(anchor.excerpt_id).to_proto(),
539 anchor: Some(serialize_text_anchor(&anchor.text_anchor)),
540 }
541}
542
543fn deserialize_excerpt_range(
544 excerpt: proto::Excerpt,
545) -> Option<(ExcerptId, ExcerptRange<language::Anchor>)> {
546 let context = {
547 let start = language::proto::deserialize_anchor(excerpt.context_start?)?;
548 let end = language::proto::deserialize_anchor(excerpt.context_end?)?;
549 start..end
550 };
551 let primary = excerpt
552 .primary_start
553 .zip(excerpt.primary_end)
554 .and_then(|(start, end)| {
555 let start = language::proto::deserialize_anchor(start)?;
556 let end = language::proto::deserialize_anchor(end)?;
557 Some(start..end)
558 })
559 .unwrap_or_else(|| context.clone());
560 Some((
561 ExcerptId::from_proto(excerpt.id),
562 ExcerptRange { context, primary },
563 ))
564}
565
566fn deserialize_selection(selection: proto::Selection) -> Option<Selection<Anchor>> {
567 Some(Selection {
568 id: selection.id as usize,
569 start: deserialize_anchor(selection.start?)?,
570 end: deserialize_anchor(selection.end?)?,
571 reversed: selection.reversed,
572 goal: SelectionGoal::None,
573 })
574}
575
576fn deserialize_anchor(anchor: proto::EditorAnchor) -> Option<Anchor> {
577 let excerpt_id = ExcerptId::from_proto(anchor.excerpt_id);
578 Some(Anchor::in_buffer(
579 excerpt_id,
580 language::proto::deserialize_anchor(anchor.anchor?)?,
581 ))
582}
583
584impl Item for Editor {
585 type Event = EditorEvent;
586
587 fn act_as_type<'a>(
588 &'a self,
589 type_id: TypeId,
590 self_handle: &'a Entity<Self>,
591 cx: &'a App,
592 ) -> Option<gpui::AnyEntity> {
593 if TypeId::of::<Self>() == type_id {
594 Some(self_handle.clone().into())
595 } else if TypeId::of::<MultiBuffer>() == type_id {
596 Some(self_handle.read(cx).buffer.clone().into())
597 } else {
598 None
599 }
600 }
601
602 fn navigate(
603 &mut self,
604 data: Arc<dyn Any + Send>,
605 window: &mut Window,
606 cx: &mut Context<Self>,
607 ) -> bool {
608 if let Some(data) = data.downcast_ref::<NavigationData>() {
609 let newest_selection = self.selections.newest::<Point>(&self.display_snapshot(cx));
610 let buffer = self.buffer.read(cx).read(cx);
611 let offset = if buffer.can_resolve(&data.cursor_anchor) {
612 data.cursor_anchor.to_point(&buffer)
613 } else {
614 buffer.clip_point(data.cursor_position, Bias::Left)
615 };
616
617 let mut scroll_anchor = data.scroll_anchor;
618 if !buffer.can_resolve(&scroll_anchor.anchor) {
619 scroll_anchor.anchor = buffer.anchor_before(
620 buffer.clip_point(Point::new(data.scroll_top_row, 0), Bias::Left),
621 );
622 }
623
624 drop(buffer);
625
626 if newest_selection.head() == offset {
627 false
628 } else {
629 self.set_scroll_anchor(scroll_anchor, window, cx);
630 self.change_selections(
631 SelectionEffects::default().nav_history(false),
632 window,
633 cx,
634 |s| s.select_ranges([offset..offset]),
635 );
636 true
637 }
638 } else {
639 false
640 }
641 }
642
643 fn tab_tooltip_text(&self, cx: &App) -> Option<SharedString> {
644 self.buffer()
645 .read(cx)
646 .as_singleton()
647 .and_then(|buffer| buffer.read(cx).file())
648 .and_then(|file| File::from_dyn(Some(file)))
649 .map(|file| {
650 file.worktree
651 .read(cx)
652 .absolutize(&file.path)
653 .compact()
654 .to_string_lossy()
655 .into_owned()
656 .into()
657 })
658 }
659
660 fn telemetry_event_text(&self) -> Option<&'static str> {
661 None
662 }
663
664 fn tab_content_text(&self, detail: usize, cx: &App) -> SharedString {
665 if let Some(path) = path_for_buffer(&self.buffer, detail, true, cx) {
666 path.to_string().into()
667 } else {
668 // Use the same logic as the displayed title for consistency
669 self.buffer.read(cx).title(cx).to_string().into()
670 }
671 }
672
673 fn suggested_filename(&self, cx: &App) -> SharedString {
674 self.buffer.read(cx).title(cx).to_string().into()
675 }
676
677 fn tab_icon(&self, _: &Window, cx: &App) -> Option<Icon> {
678 ItemSettings::get_global(cx)
679 .file_icons
680 .then(|| {
681 path_for_buffer(&self.buffer, 0, true, cx)
682 .and_then(|path| FileIcons::get_icon(Path::new(&*path), cx))
683 })
684 .flatten()
685 .map(Icon::from_path)
686 }
687
688 fn tab_content(&self, params: TabContentParams, _: &Window, cx: &App) -> AnyElement {
689 let label_color = if ItemSettings::get_global(cx).git_status {
690 self.buffer()
691 .read(cx)
692 .as_singleton()
693 .and_then(|buffer| {
694 let buffer = buffer.read(cx);
695 let path = buffer.project_path(cx)?;
696 let buffer_id = buffer.remote_id();
697 let project = self.project()?.read(cx);
698 let entry = project.entry_for_path(&path, cx)?;
699 let (repo, repo_path) = project
700 .git_store()
701 .read(cx)
702 .repository_and_path_for_buffer_id(buffer_id, cx)?;
703 let status = repo.read(cx).status_for_path(&repo_path)?.status;
704
705 Some(entry_git_aware_label_color(
706 status.summary(),
707 entry.is_ignored,
708 params.selected,
709 ))
710 })
711 .unwrap_or_else(|| entry_label_color(params.selected))
712 } else {
713 entry_label_color(params.selected)
714 };
715
716 let description = params.detail.and_then(|detail| {
717 let path = path_for_buffer(&self.buffer, detail, false, cx)?;
718 let description = path.trim();
719
720 if description.is_empty() {
721 return None;
722 }
723
724 Some(util::truncate_and_trailoff(description, MAX_TAB_TITLE_LEN))
725 });
726
727 // Whether the file was saved in the past but is now deleted.
728 let was_deleted: bool = self
729 .buffer()
730 .read(cx)
731 .as_singleton()
732 .and_then(|buffer| buffer.read(cx).file())
733 .is_some_and(|file| file.disk_state().is_deleted());
734
735 h_flex()
736 .gap_2()
737 .child(
738 Label::new(self.title(cx).to_string())
739 .color(label_color)
740 .when(params.preview, |this| this.italic())
741 .when(was_deleted, |this| this.strikethrough()),
742 )
743 .when_some(description, |this, description| {
744 this.child(
745 Label::new(description)
746 .size(LabelSize::XSmall)
747 .color(Color::Muted),
748 )
749 })
750 .into_any_element()
751 }
752
753 fn for_each_project_item(
754 &self,
755 cx: &App,
756 f: &mut dyn FnMut(EntityId, &dyn project::ProjectItem),
757 ) {
758 self.buffer
759 .read(cx)
760 .for_each_buffer(&mut |buffer| f(buffer.entity_id(), buffer.read(cx)));
761 }
762
763 fn buffer_kind(&self, cx: &App) -> ItemBufferKind {
764 match self.buffer.read(cx).is_singleton() {
765 true => ItemBufferKind::Singleton,
766 false => ItemBufferKind::Multibuffer,
767 }
768 }
769
770 fn can_save_as(&self, cx: &App) -> bool {
771 self.buffer.read(cx).is_singleton()
772 }
773
774 fn can_split(&self) -> bool {
775 true
776 }
777
778 fn clone_on_split(
779 &self,
780 _workspace_id: Option<WorkspaceId>,
781 window: &mut Window,
782 cx: &mut Context<Self>,
783 ) -> Task<Option<Entity<Editor>>>
784 where
785 Self: Sized,
786 {
787 Task::ready(Some(cx.new(|cx| self.clone(window, cx))))
788 }
789
790 fn set_nav_history(
791 &mut self,
792 history: ItemNavHistory,
793 _window: &mut Window,
794 _: &mut Context<Self>,
795 ) {
796 self.nav_history = Some(history);
797 }
798
799 fn on_removed(&self, cx: &mut Context<Self>) {
800 self.report_editor_event(ReportEditorEvent::Closed, None, cx);
801 }
802
803 fn deactivated(&mut self, _: &mut Window, cx: &mut Context<Self>) {
804 let selection = self.selections.newest_anchor();
805 self.push_to_nav_history(selection.head(), None, true, false, cx);
806 }
807
808 fn workspace_deactivated(&mut self, _: &mut Window, cx: &mut Context<Self>) {
809 self.hide_hovered_link(cx);
810 }
811
812 fn is_dirty(&self, cx: &App) -> bool {
813 self.buffer().read(cx).read(cx).is_dirty()
814 }
815
816 fn capability(&self, cx: &App) -> Capability {
817 self.capability(cx)
818 }
819
820 // Note: this mirrors the logic in `Editor::toggle_read_only`, but is reachable
821 // without relying on focus-based action dispatch.
822 fn toggle_read_only(&mut self, window: &mut Window, cx: &mut Context<Self>) {
823 if let Some(buffer) = self.buffer.read(cx).as_singleton() {
824 buffer.update(cx, |buffer, cx| {
825 buffer.set_capability(
826 match buffer.capability() {
827 Capability::ReadWrite => Capability::Read,
828 Capability::Read => Capability::ReadWrite,
829 Capability::ReadOnly => Capability::ReadOnly,
830 },
831 cx,
832 );
833 });
834 }
835 cx.notify();
836 window.refresh();
837 }
838
839 fn has_deleted_file(&self, cx: &App) -> bool {
840 self.buffer().read(cx).read(cx).has_deleted_file()
841 }
842
843 fn has_conflict(&self, cx: &App) -> bool {
844 self.buffer().read(cx).read(cx).has_conflict()
845 }
846
847 fn can_save(&self, cx: &App) -> bool {
848 let buffer = &self.buffer().read(cx);
849 if let Some(buffer) = buffer.as_singleton() {
850 buffer.read(cx).project_path(cx).is_some()
851 } else {
852 true
853 }
854 }
855
856 fn save(
857 &mut self,
858 options: SaveOptions,
859 project: Entity<Project>,
860 window: &mut Window,
861 cx: &mut Context<Self>,
862 ) -> Task<Result<()>> {
863 // Add meta data tracking # of auto saves
864 if options.autosave {
865 self.report_editor_event(ReportEditorEvent::Saved { auto_saved: true }, None, cx);
866 } else {
867 self.report_editor_event(ReportEditorEvent::Saved { auto_saved: false }, None, cx);
868 }
869
870 let buffers = self.buffer().clone().read(cx).all_buffers();
871 let buffers = buffers
872 .into_iter()
873 .map(|handle| handle.read(cx).base_buffer().unwrap_or(handle.clone()))
874 .collect::<HashSet<_>>();
875
876 let buffers_to_save = if self.buffer.read(cx).is_singleton() && !options.autosave {
877 buffers
878 } else {
879 buffers
880 .into_iter()
881 .filter(|buffer| buffer.read(cx).is_dirty())
882 .collect()
883 };
884
885 cx.spawn_in(window, async move |this, cx| {
886 if options.format {
887 this.update_in(cx, |editor, window, cx| {
888 editor.perform_format(
889 project.clone(),
890 FormatTrigger::Save,
891 FormatTarget::Buffers(buffers_to_save.clone()),
892 window,
893 cx,
894 )
895 })?
896 .await?;
897 }
898
899 if !buffers_to_save.is_empty() {
900 project
901 .update(cx, |project, cx| {
902 project.save_buffers(buffers_to_save.clone(), cx)
903 })
904 .await?;
905 }
906
907 Ok(())
908 })
909 }
910
911 fn save_as(
912 &mut self,
913 project: Entity<Project>,
914 path: ProjectPath,
915 _: &mut Window,
916 cx: &mut Context<Self>,
917 ) -> Task<Result<()>> {
918 let buffer = self
919 .buffer()
920 .read(cx)
921 .as_singleton()
922 .expect("cannot call save_as on an excerpt list");
923
924 let file_extension = path.path.extension().map(|a| a.to_string());
925 self.report_editor_event(
926 ReportEditorEvent::Saved { auto_saved: false },
927 file_extension,
928 cx,
929 );
930
931 project.update(cx, |project, cx| project.save_buffer_as(buffer, path, cx))
932 }
933
934 fn reload(
935 &mut self,
936 project: Entity<Project>,
937 window: &mut Window,
938 cx: &mut Context<Self>,
939 ) -> Task<Result<()>> {
940 let buffer = self.buffer().clone();
941 let buffers = self.buffer.read(cx).all_buffers();
942 let reload_buffers =
943 project.update(cx, |project, cx| project.reload_buffers(buffers, true, cx));
944 cx.spawn_in(window, async move |this, cx| {
945 let transaction = reload_buffers.log_err().await;
946 this.update(cx, |editor, cx| {
947 editor.request_autoscroll(Autoscroll::fit(), cx)
948 })?;
949 buffer.update(cx, |buffer, cx| {
950 if let Some(transaction) = transaction
951 && !buffer.is_singleton()
952 {
953 buffer.push_transaction(&transaction.0, cx);
954 }
955 });
956 Ok(())
957 })
958 }
959
960 fn as_searchable(
961 &self,
962 handle: &Entity<Self>,
963 _: &App,
964 ) -> Option<Box<dyn SearchableItemHandle>> {
965 Some(Box::new(handle.clone()))
966 }
967
968 fn pixel_position_of_cursor(&self, _: &App) -> Option<gpui::Point<Pixels>> {
969 self.pixel_position_of_newest_cursor
970 }
971
972 fn breadcrumb_location(&self, cx: &App) -> ToolbarItemLocation {
973 if self.show_breadcrumbs && self.buffer().read(cx).is_singleton() {
974 ToolbarItemLocation::PrimaryLeft
975 } else {
976 ToolbarItemLocation::Hidden
977 }
978 }
979
980 // In a non-singleton case, the breadcrumbs are actually shown on sticky file headers of the multibuffer.
981 fn breadcrumbs(&self, cx: &App) -> Option<Vec<BreadcrumbText>> {
982 if self.buffer.read(cx).is_singleton() {
983 self.breadcrumbs_inner(cx)
984 } else {
985 None
986 }
987 }
988
989 fn added_to_workspace(
990 &mut self,
991 workspace: &mut Workspace,
992 window: &mut Window,
993 cx: &mut Context<Self>,
994 ) {
995 self.workspace = Some((workspace.weak_handle(), workspace.database_id()));
996 if let Some(workspace_entity) = &workspace.weak_handle().upgrade() {
997 cx.subscribe(
998 workspace_entity,
999 |editor, _, event: &workspace::Event, _cx| {
1000 if let workspace::Event::ModalOpened = event {
1001 editor.mouse_context_menu.take();
1002 editor.inline_blame_popover.take();
1003 }
1004 },
1005 )
1006 .detach();
1007 }
1008
1009 // Load persisted folds if this editor doesn't already have folds.
1010 // This handles manually-opened files (not workspace restoration).
1011 let display_snapshot = self
1012 .display_map
1013 .update(cx, |display_map, cx| display_map.snapshot(cx));
1014 let has_folds = display_snapshot
1015 .folds_in_range(MultiBufferOffset(0)..display_snapshot.buffer_snapshot().len())
1016 .next()
1017 .is_some();
1018
1019 if !has_folds {
1020 if let Some(workspace_id) = workspace.database_id()
1021 && let Some(file_path) = self.buffer().read(cx).as_singleton().and_then(|buffer| {
1022 project::File::from_dyn(buffer.read(cx).file()).map(|file| file.abs_path(cx))
1023 })
1024 {
1025 self.load_folds_from_db(workspace_id, file_path, window, cx);
1026 }
1027 }
1028 }
1029
1030 fn to_item_events(event: &EditorEvent, f: &mut dyn FnMut(ItemEvent)) {
1031 match event {
1032 EditorEvent::Saved | EditorEvent::TitleChanged => {
1033 f(ItemEvent::UpdateTab);
1034 f(ItemEvent::UpdateBreadcrumbs);
1035 }
1036
1037 EditorEvent::Reparsed(_) => {
1038 f(ItemEvent::UpdateBreadcrumbs);
1039 }
1040
1041 EditorEvent::SelectionsChanged { local } if *local => {
1042 f(ItemEvent::UpdateBreadcrumbs);
1043 }
1044
1045 EditorEvent::BreadcrumbsChanged => {
1046 f(ItemEvent::UpdateBreadcrumbs);
1047 }
1048
1049 EditorEvent::DirtyChanged => {
1050 f(ItemEvent::UpdateTab);
1051 }
1052
1053 EditorEvent::BufferEdited => {
1054 f(ItemEvent::Edit);
1055 f(ItemEvent::UpdateBreadcrumbs);
1056 }
1057
1058 EditorEvent::ExcerptsAdded { .. } | EditorEvent::ExcerptsRemoved { .. } => {
1059 f(ItemEvent::Edit);
1060 }
1061
1062 _ => {}
1063 }
1064 }
1065
1066 fn tab_extra_context_menu_actions(
1067 &self,
1068 _window: &mut Window,
1069 cx: &mut Context<Self>,
1070 ) -> Vec<(SharedString, Box<dyn gpui::Action>)> {
1071 let mut actions = Vec::new();
1072
1073 let is_markdown = self
1074 .buffer()
1075 .read(cx)
1076 .as_singleton()
1077 .and_then(|buffer| buffer.read(cx).language())
1078 .is_some_and(|language| language.name().as_ref() == "Markdown");
1079
1080 let is_svg = self
1081 .buffer()
1082 .read(cx)
1083 .as_singleton()
1084 .and_then(|buffer| buffer.read(cx).file())
1085 .is_some_and(|file| {
1086 std::path::Path::new(file.file_name(cx))
1087 .extension()
1088 .is_some_and(|ext| ext.eq_ignore_ascii_case("svg"))
1089 });
1090
1091 if is_markdown {
1092 actions.push((
1093 "Open Markdown Preview".into(),
1094 Box::new(OpenMarkdownPreview) as Box<dyn gpui::Action>,
1095 ));
1096 }
1097
1098 if is_svg {
1099 actions.push((
1100 "Open SVG Preview".into(),
1101 Box::new(OpenSvgPreview) as Box<dyn gpui::Action>,
1102 ));
1103 }
1104
1105 actions
1106 }
1107
1108 fn preserve_preview(&self, cx: &App) -> bool {
1109 self.buffer.read(cx).preserve_preview(cx)
1110 }
1111}
1112
1113impl SerializableItem for Editor {
1114 fn serialized_item_kind() -> &'static str {
1115 "Editor"
1116 }
1117
1118 fn cleanup(
1119 workspace_id: WorkspaceId,
1120 alive_items: Vec<ItemId>,
1121 _window: &mut Window,
1122 cx: &mut App,
1123 ) -> Task<Result<()>> {
1124 workspace::delete_unloaded_items(alive_items, workspace_id, "editors", &DB, cx)
1125 }
1126
1127 fn deserialize(
1128 project: Entity<Project>,
1129 workspace: WeakEntity<Workspace>,
1130 workspace_id: workspace::WorkspaceId,
1131 item_id: ItemId,
1132 window: &mut Window,
1133 cx: &mut App,
1134 ) -> Task<Result<Entity<Self>>> {
1135 let serialized_editor = match DB
1136 .get_serialized_editor(item_id, workspace_id)
1137 .context("Failed to query editor state")
1138 {
1139 Ok(Some(serialized_editor)) => {
1140 if ProjectSettings::get_global(cx)
1141 .session
1142 .restore_unsaved_buffers
1143 {
1144 serialized_editor
1145 } else {
1146 SerializedEditor {
1147 abs_path: serialized_editor.abs_path,
1148 contents: None,
1149 language: None,
1150 mtime: None,
1151 }
1152 }
1153 }
1154 Ok(None) => {
1155 return Task::ready(Err(anyhow!(
1156 "Unable to deserialize editor: No entry in database for item_id: {item_id} and workspace_id {workspace_id:?}"
1157 )));
1158 }
1159 Err(error) => {
1160 return Task::ready(Err(error));
1161 }
1162 };
1163 log::debug!(
1164 "Deserialized editor {item_id:?} in workspace {workspace_id:?}, {serialized_editor:?}"
1165 );
1166
1167 match serialized_editor {
1168 SerializedEditor {
1169 abs_path: None,
1170 contents: Some(contents),
1171 language,
1172 ..
1173 } => window.spawn(cx, {
1174 let project = project.clone();
1175 async move |cx| {
1176 let language_registry =
1177 project.read_with(cx, |project, _| project.languages().clone());
1178
1179 let language = if let Some(language_name) = language {
1180 // We don't fail here, because we'd rather not set the language if the name changed
1181 // than fail to restore the buffer.
1182 language_registry
1183 .language_for_name(&language_name)
1184 .await
1185 .ok()
1186 } else {
1187 None
1188 };
1189
1190 // First create the empty buffer
1191 let buffer = project
1192 .update(cx, |project, cx| project.create_buffer(language, true, cx))
1193 .await
1194 .context("Failed to create buffer while deserializing editor")?;
1195
1196 // Then set the text so that the dirty bit is set correctly
1197 buffer.update(cx, |buffer, cx| {
1198 buffer.set_language_registry(language_registry);
1199 buffer.set_text(contents, cx);
1200 if let Some(entry) = buffer.peek_undo_stack() {
1201 buffer.forget_transaction(entry.transaction_id());
1202 }
1203 });
1204
1205 cx.update(|window, cx| {
1206 cx.new(|cx| {
1207 let mut editor = Editor::for_buffer(buffer, Some(project), window, cx);
1208
1209 editor.read_metadata_from_db(item_id, workspace_id, window, cx);
1210 editor
1211 })
1212 })
1213 }
1214 }),
1215 SerializedEditor {
1216 abs_path: Some(abs_path),
1217 contents,
1218 mtime,
1219 ..
1220 } => {
1221 let opened_buffer = project.update(cx, |project, cx| {
1222 let (worktree, path) = project.find_worktree(&abs_path, cx)?;
1223 let project_path = ProjectPath {
1224 worktree_id: worktree.read(cx).id(),
1225 path: path,
1226 };
1227 Some(project.open_path(project_path, cx))
1228 });
1229
1230 match opened_buffer {
1231 Some(opened_buffer) => window.spawn(cx, async move |cx| {
1232 let (_, buffer) = opened_buffer
1233 .await
1234 .context("Failed to open path in project")?;
1235
1236 if let Some(contents) = contents {
1237 buffer.update(cx, |buffer, cx| {
1238 restore_serialized_buffer_contents(buffer, contents, mtime, cx);
1239 });
1240 }
1241
1242 cx.update(|window, cx| {
1243 cx.new(|cx| {
1244 let mut editor =
1245 Editor::for_buffer(buffer, Some(project), window, cx);
1246
1247 editor.read_metadata_from_db(item_id, workspace_id, window, cx);
1248 editor
1249 })
1250 })
1251 }),
1252 None => {
1253 // File is not in any worktree (e.g., opened as a standalone file)
1254 // We need to open it via workspace and then restore dirty contents
1255 window.spawn(cx, async move |cx| {
1256 let open_by_abs_path =
1257 workspace.update_in(cx, |workspace, window, cx| {
1258 workspace.open_abs_path(
1259 abs_path.clone(),
1260 OpenOptions {
1261 visible: Some(OpenVisible::None),
1262 ..Default::default()
1263 },
1264 window,
1265 cx,
1266 )
1267 })?;
1268 let editor =
1269 open_by_abs_path.await?.downcast::<Editor>().with_context(
1270 || format!("path {abs_path:?} cannot be opened as an Editor"),
1271 )?;
1272
1273 if let Some(contents) = contents {
1274 editor.update_in(cx, |editor, _window, cx| {
1275 if let Some(buffer) = editor.buffer().read(cx).as_singleton() {
1276 buffer.update(cx, |buffer, cx| {
1277 restore_serialized_buffer_contents(
1278 buffer, contents, mtime, cx,
1279 );
1280 });
1281 }
1282 })?;
1283 }
1284
1285 editor.update_in(cx, |editor, window, cx| {
1286 editor.read_metadata_from_db(item_id, workspace_id, window, cx);
1287 })?;
1288 Ok(editor)
1289 })
1290 }
1291 }
1292 }
1293 SerializedEditor {
1294 abs_path: None,
1295 contents: None,
1296 ..
1297 } => window.spawn(cx, async move |cx| {
1298 let buffer = project
1299 .update(cx, |project, cx| project.create_buffer(None, true, cx))
1300 .await
1301 .context("Failed to create buffer")?;
1302
1303 cx.update(|window, cx| {
1304 cx.new(|cx| {
1305 let mut editor = Editor::for_buffer(buffer, Some(project), window, cx);
1306
1307 editor.read_metadata_from_db(item_id, workspace_id, window, cx);
1308 editor
1309 })
1310 })
1311 }),
1312 }
1313 }
1314
1315 fn serialize(
1316 &mut self,
1317 workspace: &mut Workspace,
1318 item_id: ItemId,
1319 closing: bool,
1320 window: &mut Window,
1321 cx: &mut Context<Self>,
1322 ) -> Option<Task<Result<()>>> {
1323 let buffer_serialization = self.buffer_serialization?;
1324 let project = self.project.clone()?;
1325
1326 let serialize_dirty_buffers = match buffer_serialization {
1327 // Always serialize dirty buffers, including for worktree-less windows.
1328 // This enables hot-exit functionality for empty windows and single files.
1329 BufferSerialization::All => true,
1330 BufferSerialization::NonDirtyBuffers => false,
1331 };
1332
1333 if closing && !serialize_dirty_buffers {
1334 return None;
1335 }
1336
1337 let workspace_id = workspace.database_id()?;
1338
1339 let buffer = self.buffer().read(cx).as_singleton()?;
1340
1341 let abs_path = buffer.read(cx).file().and_then(|file| {
1342 let worktree_id = file.worktree_id(cx);
1343 project
1344 .read(cx)
1345 .worktree_for_id(worktree_id, cx)
1346 .map(|worktree| worktree.read(cx).absolutize(file.path()))
1347 .or_else(|| {
1348 let full_path = file.full_path(cx);
1349 let project_path = project.read(cx).find_project_path(&full_path, cx)?;
1350 project.read(cx).absolute_path(&project_path, cx)
1351 })
1352 });
1353
1354 let is_dirty = buffer.read(cx).is_dirty();
1355 let mtime = buffer.read(cx).saved_mtime();
1356
1357 let snapshot = buffer.read(cx).snapshot();
1358
1359 Some(cx.spawn_in(window, async move |_this, cx| {
1360 cx.background_spawn(async move {
1361 let (contents, language) = if serialize_dirty_buffers && is_dirty {
1362 let contents = snapshot.text();
1363 let language = snapshot.language().map(|lang| lang.name().to_string());
1364 (Some(contents), language)
1365 } else {
1366 (None, None)
1367 };
1368
1369 let editor = SerializedEditor {
1370 abs_path,
1371 contents,
1372 language,
1373 mtime,
1374 };
1375 log::debug!("Serializing editor {item_id:?} in workspace {workspace_id:?}");
1376 DB.save_serialized_editor(item_id, workspace_id, editor)
1377 .await
1378 .context("failed to save serialized editor")
1379 })
1380 .await
1381 .context("failed to save contents of buffer")?;
1382
1383 Ok(())
1384 }))
1385 }
1386
1387 fn should_serialize(&self, event: &Self::Event) -> bool {
1388 self.should_serialize_buffer()
1389 && matches!(
1390 event,
1391 EditorEvent::Saved | EditorEvent::DirtyChanged | EditorEvent::BufferEdited
1392 )
1393 }
1394}
1395
1396#[derive(Debug, Default)]
1397struct EditorRestorationData {
1398 entries: HashMap<PathBuf, RestorationData>,
1399}
1400
1401#[derive(Default, Debug)]
1402pub struct RestorationData {
1403 pub scroll_position: (BufferRow, gpui::Point<ScrollOffset>),
1404 pub folds: Vec<Range<Point>>,
1405 pub selections: Vec<Range<Point>>,
1406}
1407
1408impl ProjectItem for Editor {
1409 type Item = Buffer;
1410
1411 fn project_item_kind() -> Option<ProjectItemKind> {
1412 Some(ProjectItemKind("Editor"))
1413 }
1414
1415 fn for_project_item(
1416 project: Entity<Project>,
1417 pane: Option<&Pane>,
1418 buffer: Entity<Buffer>,
1419 window: &mut Window,
1420 cx: &mut Context<Self>,
1421 ) -> Self {
1422 let mut editor = Self::for_buffer(buffer.clone(), Some(project), window, cx);
1423
1424 if let Some((excerpt_id, _, snapshot)) =
1425 editor.buffer().read(cx).snapshot(cx).as_singleton()
1426 && WorkspaceSettings::get(None, cx).restore_on_file_reopen
1427 && let Some(restoration_data) = Self::project_item_kind()
1428 .and_then(|kind| pane.as_ref()?.project_item_restoration_data.get(&kind))
1429 .and_then(|data| data.downcast_ref::<EditorRestorationData>())
1430 .and_then(|data| {
1431 let file = project::File::from_dyn(buffer.read(cx).file())?;
1432 data.entries.get(&file.abs_path(cx))
1433 })
1434 {
1435 if !restoration_data.folds.is_empty() {
1436 editor.fold_ranges(
1437 clip_ranges(&restoration_data.folds, snapshot),
1438 false,
1439 window,
1440 cx,
1441 );
1442 }
1443 if !restoration_data.selections.is_empty() {
1444 editor.change_selections(SelectionEffects::no_scroll(), window, cx, |s| {
1445 s.select_ranges(clip_ranges(&restoration_data.selections, snapshot));
1446 });
1447 }
1448 let (top_row, offset) = restoration_data.scroll_position;
1449 let anchor =
1450 Anchor::in_buffer(excerpt_id, snapshot.anchor_before(Point::new(top_row, 0)));
1451 editor.set_scroll_anchor(ScrollAnchor { anchor, offset }, window, cx);
1452 }
1453
1454 editor
1455 }
1456
1457 fn for_broken_project_item(
1458 abs_path: &Path,
1459 is_local: bool,
1460 e: &anyhow::Error,
1461 window: &mut Window,
1462 cx: &mut App,
1463 ) -> Option<InvalidItemView> {
1464 Some(InvalidItemView::new(abs_path, is_local, e, window, cx))
1465 }
1466}
1467
1468fn clip_ranges<'a>(
1469 original: impl IntoIterator<Item = &'a Range<Point>> + 'a,
1470 snapshot: &'a BufferSnapshot,
1471) -> Vec<Range<Point>> {
1472 original
1473 .into_iter()
1474 .map(|range| {
1475 snapshot.clip_point(range.start, Bias::Left)
1476 ..snapshot.clip_point(range.end, Bias::Right)
1477 })
1478 .collect()
1479}
1480
1481impl EventEmitter<SearchEvent> for Editor {}
1482
1483impl Editor {
1484 pub fn update_restoration_data(
1485 &self,
1486 cx: &mut Context<Self>,
1487 write: impl for<'a> FnOnce(&'a mut RestorationData) + 'static,
1488 ) {
1489 if self.mode.is_minimap() || !WorkspaceSettings::get(None, cx).restore_on_file_reopen {
1490 return;
1491 }
1492
1493 let editor = cx.entity();
1494 cx.defer(move |cx| {
1495 editor.update(cx, |editor, cx| {
1496 let kind = Editor::project_item_kind()?;
1497 let pane = editor.workspace()?.read(cx).pane_for(&cx.entity())?;
1498 let buffer = editor.buffer().read(cx).as_singleton()?;
1499 let file_abs_path = project::File::from_dyn(buffer.read(cx).file())?.abs_path(cx);
1500 pane.update(cx, |pane, _| {
1501 let data = pane
1502 .project_item_restoration_data
1503 .entry(kind)
1504 .or_insert_with(|| Box::new(EditorRestorationData::default()) as Box<_>);
1505 let data = match data.downcast_mut::<EditorRestorationData>() {
1506 Some(data) => data,
1507 None => {
1508 *data = Box::new(EditorRestorationData::default());
1509 data.downcast_mut::<EditorRestorationData>()
1510 .expect("just written the type downcasted to")
1511 }
1512 };
1513
1514 let data = data.entries.entry(file_abs_path).or_default();
1515 write(data);
1516 Some(())
1517 })
1518 });
1519 });
1520 }
1521}
1522
1523impl SearchableItem for Editor {
1524 type Match = Range<Anchor>;
1525
1526 fn get_matches(&self, _window: &mut Window, _: &mut App) -> (Vec<Range<Anchor>>, SearchToken) {
1527 (
1528 self.background_highlights
1529 .get(&HighlightKey::BufferSearchHighlights)
1530 .map_or(Vec::new(), |(_color, ranges)| {
1531 ranges.iter().cloned().collect()
1532 }),
1533 SearchToken::default(),
1534 )
1535 }
1536
1537 fn clear_matches(&mut self, _: &mut Window, cx: &mut Context<Self>) {
1538 if self
1539 .clear_background_highlights(HighlightKey::BufferSearchHighlights, cx)
1540 .is_some()
1541 {
1542 cx.emit(SearchEvent::MatchesInvalidated);
1543 }
1544 }
1545
1546 fn update_matches(
1547 &mut self,
1548 matches: &[Range<Anchor>],
1549 active_match_index: Option<usize>,
1550 _token: SearchToken,
1551 _: &mut Window,
1552 cx: &mut Context<Self>,
1553 ) {
1554 let existing_range = self
1555 .background_highlights
1556 .get(&HighlightKey::BufferSearchHighlights)
1557 .map(|(_, range)| range.as_ref());
1558 let updated = existing_range != Some(matches);
1559 self.highlight_background(
1560 HighlightKey::BufferSearchHighlights,
1561 matches,
1562 move |index, theme| {
1563 if active_match_index == Some(*index) {
1564 theme.colors().search_active_match_background
1565 } else {
1566 theme.colors().search_match_background
1567 }
1568 },
1569 cx,
1570 );
1571 if updated {
1572 cx.emit(SearchEvent::MatchesInvalidated);
1573 }
1574 }
1575
1576 fn has_filtered_search_ranges(&mut self) -> bool {
1577 self.has_background_highlights(HighlightKey::SearchWithinRange)
1578 }
1579
1580 fn toggle_filtered_search_ranges(
1581 &mut self,
1582 enabled: Option<FilteredSearchRange>,
1583 _: &mut Window,
1584 cx: &mut Context<Self>,
1585 ) {
1586 if self.has_filtered_search_ranges() {
1587 self.previous_search_ranges = self
1588 .clear_background_highlights(HighlightKey::SearchWithinRange, cx)
1589 .map(|(_, ranges)| ranges)
1590 }
1591
1592 if let Some(range) = enabled {
1593 let ranges = self.selections.disjoint_anchor_ranges().collect::<Vec<_>>();
1594
1595 if ranges.iter().any(|s| s.start != s.end) {
1596 self.set_search_within_ranges(&ranges, cx);
1597 } else if let Some(previous_search_ranges) = self.previous_search_ranges.take()
1598 && range != FilteredSearchRange::Selection
1599 {
1600 self.set_search_within_ranges(&previous_search_ranges, cx);
1601 }
1602 }
1603 }
1604
1605 fn supported_options(&self) -> SearchOptions {
1606 if self.in_project_search {
1607 SearchOptions {
1608 case: true,
1609 word: true,
1610 regex: true,
1611 replacement: false,
1612 selection: false,
1613 find_in_results: true,
1614 }
1615 } else {
1616 SearchOptions {
1617 case: true,
1618 word: true,
1619 regex: true,
1620 replacement: true,
1621 selection: true,
1622 find_in_results: false,
1623 }
1624 }
1625 }
1626
1627 fn query_suggestion(&mut self, window: &mut Window, cx: &mut Context<Self>) -> String {
1628 let setting = EditorSettings::get_global(cx).seed_search_query_from_cursor;
1629 let snapshot = self.snapshot(window, cx);
1630 let selection = self.selections.newest_adjusted(&snapshot.display_snapshot);
1631 let buffer_snapshot = snapshot.buffer_snapshot();
1632
1633 match setting {
1634 SeedQuerySetting::Never => String::new(),
1635 SeedQuerySetting::Selection | SeedQuerySetting::Always if !selection.is_empty() => {
1636 let text: String = buffer_snapshot
1637 .text_for_range(selection.start..selection.end)
1638 .collect();
1639 if text.contains('\n') {
1640 String::new()
1641 } else {
1642 text
1643 }
1644 }
1645 SeedQuerySetting::Selection => String::new(),
1646 SeedQuerySetting::Always => {
1647 let (range, kind) = buffer_snapshot
1648 .surrounding_word(selection.start, Some(CharScopeContext::Completion));
1649 if kind == Some(CharKind::Word) {
1650 let text: String = buffer_snapshot.text_for_range(range).collect();
1651 if !text.trim().is_empty() {
1652 return text;
1653 }
1654 }
1655 String::new()
1656 }
1657 }
1658 }
1659
1660 fn activate_match(
1661 &mut self,
1662 index: usize,
1663 matches: &[Range<Anchor>],
1664 _token: SearchToken,
1665 window: &mut Window,
1666 cx: &mut Context<Self>,
1667 ) {
1668 self.unfold_ranges(&[matches[index].clone()], false, true, cx);
1669 let range = self.range_for_match(&matches[index]);
1670 let autoscroll = if EditorSettings::get_global(cx).search.center_on_match {
1671 Autoscroll::center()
1672 } else {
1673 Autoscroll::fit()
1674 };
1675 self.change_selections(SelectionEffects::scroll(autoscroll), window, cx, |s| {
1676 s.select_ranges([range]);
1677 })
1678 }
1679
1680 fn select_matches(
1681 &mut self,
1682 matches: &[Self::Match],
1683 _token: SearchToken,
1684 window: &mut Window,
1685 cx: &mut Context<Self>,
1686 ) {
1687 self.unfold_ranges(matches, false, false, cx);
1688 self.change_selections(SelectionEffects::no_scroll(), window, cx, |s| {
1689 s.select_ranges(matches.iter().cloned())
1690 });
1691 }
1692 fn replace(
1693 &mut self,
1694 identifier: &Self::Match,
1695 query: &SearchQuery,
1696 _token: SearchToken,
1697 window: &mut Window,
1698 cx: &mut Context<Self>,
1699 ) {
1700 let text = self.buffer.read(cx);
1701 let text = text.snapshot(cx);
1702 let text = text.text_for_range(identifier.clone()).collect::<Vec<_>>();
1703 let text: Cow<_> = if text.len() == 1 {
1704 text.first().cloned().unwrap().into()
1705 } else {
1706 let joined_chunks = text.join("");
1707 joined_chunks.into()
1708 };
1709
1710 if let Some(replacement) = query.replacement_for(&text) {
1711 self.transact(window, cx, |this, _, cx| {
1712 this.edit([(identifier.clone(), Arc::from(&*replacement))], cx);
1713 });
1714 }
1715 }
1716 fn replace_all(
1717 &mut self,
1718 matches: &mut dyn Iterator<Item = &Self::Match>,
1719 query: &SearchQuery,
1720 _token: SearchToken,
1721 window: &mut Window,
1722 cx: &mut Context<Self>,
1723 ) {
1724 let text = self.buffer.read(cx);
1725 let text = text.snapshot(cx);
1726 let mut edits = vec![];
1727
1728 // A regex might have replacement variables so we cannot apply
1729 // the same replacement to all matches
1730 if query.is_regex() {
1731 edits = matches
1732 .filter_map(|m| {
1733 let text = text.text_for_range(m.clone()).collect::<Vec<_>>();
1734
1735 let text: Cow<_> = if text.len() == 1 {
1736 text.first().cloned().unwrap().into()
1737 } else {
1738 let joined_chunks = text.join("");
1739 joined_chunks.into()
1740 };
1741
1742 query
1743 .replacement_for(&text)
1744 .map(|replacement| (m.clone(), Arc::from(&*replacement)))
1745 })
1746 .collect();
1747 } else if let Some(replacement) = query.replacement().map(Arc::<str>::from) {
1748 edits = matches.map(|m| (m.clone(), replacement.clone())).collect();
1749 }
1750
1751 if !edits.is_empty() {
1752 self.transact(window, cx, |this, _, cx| {
1753 this.edit(edits, cx);
1754 });
1755 }
1756 }
1757 fn match_index_for_direction(
1758 &mut self,
1759 matches: &[Range<Anchor>],
1760 current_index: usize,
1761 direction: Direction,
1762 count: usize,
1763 _token: SearchToken,
1764 _: &mut Window,
1765 cx: &mut Context<Self>,
1766 ) -> usize {
1767 let buffer = self.buffer().read(cx).snapshot(cx);
1768 let current_index_position = if self.selections.disjoint_anchors_arc().len() == 1 {
1769 self.selections.newest_anchor().head()
1770 } else {
1771 matches[current_index].start
1772 };
1773
1774 let mut count = count % matches.len();
1775 if count == 0 {
1776 return current_index;
1777 }
1778 match direction {
1779 Direction::Next => {
1780 if matches[current_index]
1781 .start
1782 .cmp(¤t_index_position, &buffer)
1783 .is_gt()
1784 {
1785 count -= 1
1786 }
1787
1788 (current_index + count) % matches.len()
1789 }
1790 Direction::Prev => {
1791 if matches[current_index]
1792 .end
1793 .cmp(¤t_index_position, &buffer)
1794 .is_lt()
1795 {
1796 count -= 1;
1797 }
1798
1799 if current_index >= count {
1800 current_index - count
1801 } else {
1802 matches.len() - (count - current_index)
1803 }
1804 }
1805 }
1806 }
1807
1808 fn find_matches(
1809 &mut self,
1810 query: Arc<project::search::SearchQuery>,
1811 _: &mut Window,
1812 cx: &mut Context<Self>,
1813 ) -> Task<Vec<Range<Anchor>>> {
1814 let buffer = self.buffer().read(cx).snapshot(cx);
1815 let search_within_ranges = self
1816 .background_highlights
1817 .get(&HighlightKey::SearchWithinRange)
1818 .map_or(vec![], |(_color, ranges)| {
1819 ranges.iter().cloned().collect::<Vec<_>>()
1820 });
1821
1822 cx.background_spawn(async move {
1823 let mut ranges = Vec::new();
1824
1825 let search_within_ranges = if search_within_ranges.is_empty() {
1826 vec![buffer.anchor_before(MultiBufferOffset(0))..buffer.anchor_after(buffer.len())]
1827 } else {
1828 search_within_ranges
1829 };
1830
1831 for range in search_within_ranges {
1832 for (search_buffer, search_range, excerpt_id, deleted_hunk_anchor) in
1833 buffer.range_to_buffer_ranges_with_deleted_hunks(range)
1834 {
1835 ranges.extend(
1836 query
1837 .search(
1838 search_buffer,
1839 Some(search_range.start.0..search_range.end.0),
1840 )
1841 .await
1842 .into_iter()
1843 .map(|match_range| {
1844 if let Some(deleted_hunk_anchor) = deleted_hunk_anchor {
1845 let start = search_buffer
1846 .anchor_after(search_range.start + match_range.start);
1847 let end = search_buffer
1848 .anchor_before(search_range.start + match_range.end);
1849 deleted_hunk_anchor.with_diff_base_anchor(start)
1850 ..deleted_hunk_anchor.with_diff_base_anchor(end)
1851 } else {
1852 let start = search_buffer
1853 .anchor_after(search_range.start + match_range.start);
1854 let end = search_buffer
1855 .anchor_before(search_range.start + match_range.end);
1856 Anchor::range_in_buffer(excerpt_id, start..end)
1857 }
1858 }),
1859 );
1860 }
1861 }
1862
1863 ranges
1864 })
1865 }
1866
1867 fn active_match_index(
1868 &mut self,
1869 direction: Direction,
1870 matches: &[Range<Anchor>],
1871 _token: SearchToken,
1872 _: &mut Window,
1873 cx: &mut Context<Self>,
1874 ) -> Option<usize> {
1875 active_match_index(
1876 direction,
1877 matches,
1878 &self.selections.newest_anchor().head(),
1879 &self.buffer().read(cx).snapshot(cx),
1880 )
1881 }
1882
1883 fn search_bar_visibility_changed(&mut self, _: bool, _: &mut Window, _: &mut Context<Self>) {
1884 self.expect_bounds_change = self.last_bounds;
1885 }
1886
1887 fn set_search_is_case_sensitive(
1888 &mut self,
1889 case_sensitive: Option<bool>,
1890 _cx: &mut Context<Self>,
1891 ) {
1892 self.select_next_is_case_sensitive = case_sensitive;
1893 }
1894}
1895
1896pub fn active_match_index(
1897 direction: Direction,
1898 ranges: &[Range<Anchor>],
1899 cursor: &Anchor,
1900 buffer: &MultiBufferSnapshot,
1901) -> Option<usize> {
1902 if ranges.is_empty() {
1903 None
1904 } else {
1905 let r = ranges.binary_search_by(|probe| {
1906 if probe.end.cmp(cursor, buffer).is_lt() {
1907 Ordering::Less
1908 } else if probe.start.cmp(cursor, buffer).is_gt() {
1909 Ordering::Greater
1910 } else {
1911 Ordering::Equal
1912 }
1913 });
1914 match direction {
1915 Direction::Prev => match r {
1916 Ok(i) => Some(i),
1917 Err(i) => Some(i.saturating_sub(1)),
1918 },
1919 Direction::Next => match r {
1920 Ok(i) | Err(i) => Some(cmp::min(i, ranges.len() - 1)),
1921 },
1922 }
1923 }
1924}
1925
1926pub fn entry_label_color(selected: bool) -> Color {
1927 if selected {
1928 Color::Default
1929 } else {
1930 Color::Muted
1931 }
1932}
1933
1934pub fn entry_diagnostic_aware_icon_name_and_color(
1935 diagnostic_severity: Option<DiagnosticSeverity>,
1936) -> Option<(IconName, Color)> {
1937 match diagnostic_severity {
1938 Some(DiagnosticSeverity::ERROR) => Some((IconName::Close, Color::Error)),
1939 Some(DiagnosticSeverity::WARNING) => Some((IconName::Triangle, Color::Warning)),
1940 _ => None,
1941 }
1942}
1943
1944pub fn entry_diagnostic_aware_icon_decoration_and_color(
1945 diagnostic_severity: Option<DiagnosticSeverity>,
1946) -> Option<(IconDecorationKind, Color)> {
1947 match diagnostic_severity {
1948 Some(DiagnosticSeverity::ERROR) => Some((IconDecorationKind::X, Color::Error)),
1949 Some(DiagnosticSeverity::WARNING) => Some((IconDecorationKind::Triangle, Color::Warning)),
1950 _ => None,
1951 }
1952}
1953
1954pub fn entry_git_aware_label_color(git_status: GitSummary, ignored: bool, selected: bool) -> Color {
1955 let tracked = git_status.index + git_status.worktree;
1956 if git_status.conflict > 0 {
1957 Color::Conflict
1958 } else if tracked.modified > 0 {
1959 Color::Modified
1960 } else if tracked.added > 0 || git_status.untracked > 0 {
1961 Color::Created
1962 } else if ignored {
1963 Color::Ignored
1964 } else {
1965 entry_label_color(selected)
1966 }
1967}
1968
1969fn path_for_buffer<'a>(
1970 buffer: &Entity<MultiBuffer>,
1971 height: usize,
1972 include_filename: bool,
1973 cx: &'a App,
1974) -> Option<Cow<'a, str>> {
1975 let file = buffer.read(cx).as_singleton()?.read(cx).file()?;
1976 path_for_file(file, height, include_filename, cx)
1977}
1978
1979fn path_for_file<'a>(
1980 file: &'a Arc<dyn language::File>,
1981 mut height: usize,
1982 include_filename: bool,
1983 cx: &'a App,
1984) -> Option<Cow<'a, str>> {
1985 if project::File::from_dyn(Some(file)).is_none() {
1986 return None;
1987 }
1988
1989 let file = file.as_ref();
1990 // Ensure we always render at least the filename.
1991 height += 1;
1992
1993 let mut prefix = file.path().as_ref();
1994 while height > 0 {
1995 if let Some(parent) = prefix.parent() {
1996 prefix = parent;
1997 height -= 1;
1998 } else {
1999 break;
2000 }
2001 }
2002
2003 // The full_path method allocates, so avoid calling it if height is zero.
2004 if height > 0 {
2005 let mut full_path = file.full_path(cx);
2006 if !include_filename {
2007 if !full_path.pop() {
2008 return None;
2009 }
2010 }
2011 Some(full_path.to_string_lossy().into_owned().into())
2012 } else {
2013 let mut path = file.path().strip_prefix(prefix).ok()?;
2014 if !include_filename {
2015 path = path.parent()?;
2016 }
2017 Some(path.display(file.path_style(cx)))
2018 }
2019}
2020
2021/// Restores serialized buffer contents by overwriting the buffer with saved text.
2022/// This is somewhat wasteful since we load the whole buffer from disk then overwrite it,
2023/// but keeps implementation simple as we don't need to persist all metadata from loading
2024/// (git diff base, etc.).
2025fn restore_serialized_buffer_contents(
2026 buffer: &mut Buffer,
2027 contents: String,
2028 mtime: Option<MTime>,
2029 cx: &mut Context<Buffer>,
2030) {
2031 // If we did restore an mtime, store it on the buffer so that
2032 // the next edit will mark the buffer as dirty/conflicted.
2033 if mtime.is_some() {
2034 buffer.did_reload(buffer.version(), buffer.line_ending(), mtime, cx);
2035 }
2036 buffer.set_text(contents, cx);
2037 if let Some(entry) = buffer.peek_undo_stack() {
2038 buffer.forget_transaction(entry.transaction_id());
2039 }
2040}
2041
2042#[cfg(test)]
2043mod tests {
2044 use crate::editor_tests::init_test;
2045 use fs::Fs;
2046 use workspace::MultiWorkspace;
2047
2048 use super::*;
2049 use fs::MTime;
2050 use gpui::{App, VisualTestContext};
2051 use language::TestFile;
2052 use project::FakeFs;
2053 use std::path::{Path, PathBuf};
2054 use util::{path, rel_path::RelPath};
2055
2056 #[gpui::test]
2057 fn test_path_for_file(cx: &mut App) {
2058 let file: Arc<dyn language::File> = Arc::new(TestFile {
2059 path: RelPath::empty().into(),
2060 root_name: String::new(),
2061 local_root: None,
2062 });
2063 assert_eq!(path_for_file(&file, 0, false, cx), None);
2064 }
2065
2066 async fn deserialize_editor(
2067 item_id: ItemId,
2068 workspace_id: WorkspaceId,
2069 workspace: Entity<Workspace>,
2070 project: Entity<Project>,
2071 cx: &mut VisualTestContext,
2072 ) -> Entity<Editor> {
2073 workspace
2074 .update_in(cx, |workspace, window, cx| {
2075 let pane = workspace.active_pane();
2076 pane.update(cx, |_, cx| {
2077 Editor::deserialize(
2078 project.clone(),
2079 workspace.weak_handle(),
2080 workspace_id,
2081 item_id,
2082 window,
2083 cx,
2084 )
2085 })
2086 })
2087 .await
2088 .unwrap()
2089 }
2090
2091 #[gpui::test]
2092 async fn test_deserialize(cx: &mut gpui::TestAppContext) {
2093 init_test(cx, |_| {});
2094
2095 let fs = FakeFs::new(cx.executor());
2096 fs.insert_file(path!("/file.rs"), Default::default()).await;
2097
2098 // Test case 1: Deserialize with path and contents
2099 {
2100 let project = Project::test(fs.clone(), [path!("/file.rs").as_ref()], cx).await;
2101 let (multi_workspace, cx) = cx.add_window_view(|window, cx| {
2102 MultiWorkspace::test_new(project.clone(), window, cx)
2103 });
2104 let workspace = multi_workspace.read_with(cx, |mw, _| mw.workspace().clone());
2105 let workspace_id = workspace::WORKSPACE_DB.next_id().await.unwrap();
2106 let item_id = 1234 as ItemId;
2107 let mtime = fs
2108 .metadata(Path::new(path!("/file.rs")))
2109 .await
2110 .unwrap()
2111 .unwrap()
2112 .mtime;
2113
2114 let serialized_editor = SerializedEditor {
2115 abs_path: Some(PathBuf::from(path!("/file.rs"))),
2116 contents: Some("fn main() {}".to_string()),
2117 language: Some("Rust".to_string()),
2118 mtime: Some(mtime),
2119 };
2120
2121 DB.save_serialized_editor(item_id, workspace_id, serialized_editor.clone())
2122 .await
2123 .unwrap();
2124
2125 let deserialized =
2126 deserialize_editor(item_id, workspace_id, workspace, project, cx).await;
2127
2128 deserialized.update(cx, |editor, cx| {
2129 assert_eq!(editor.text(cx), "fn main() {}");
2130 assert!(editor.is_dirty(cx));
2131 assert!(!editor.has_conflict(cx));
2132 let buffer = editor.buffer().read(cx).as_singleton().unwrap().read(cx);
2133 assert!(buffer.file().is_some());
2134 });
2135 }
2136
2137 // Test case 2: Deserialize with only path
2138 {
2139 let project = Project::test(fs.clone(), [path!("/file.rs").as_ref()], cx).await;
2140 let (multi_workspace, cx) = cx.add_window_view(|window, cx| {
2141 MultiWorkspace::test_new(project.clone(), window, cx)
2142 });
2143 let workspace = multi_workspace.read_with(cx, |mw, _| mw.workspace().clone());
2144
2145 let workspace_id = workspace::WORKSPACE_DB.next_id().await.unwrap();
2146
2147 let item_id = 5678 as ItemId;
2148 let serialized_editor = SerializedEditor {
2149 abs_path: Some(PathBuf::from(path!("/file.rs"))),
2150 contents: None,
2151 language: None,
2152 mtime: None,
2153 };
2154
2155 DB.save_serialized_editor(item_id, workspace_id, serialized_editor)
2156 .await
2157 .unwrap();
2158
2159 let deserialized =
2160 deserialize_editor(item_id, workspace_id, workspace, project, cx).await;
2161
2162 deserialized.update(cx, |editor, cx| {
2163 assert_eq!(editor.text(cx), ""); // The file should be empty as per our initial setup
2164 assert!(!editor.is_dirty(cx));
2165 assert!(!editor.has_conflict(cx));
2166
2167 let buffer = editor.buffer().read(cx).as_singleton().unwrap().read(cx);
2168 assert!(buffer.file().is_some());
2169 });
2170 }
2171
2172 // Test case 3: Deserialize with no path (untitled buffer, with content and language)
2173 {
2174 let project = Project::test(fs.clone(), [path!("/file.rs").as_ref()], cx).await;
2175 // Add Rust to the language, so that we can restore the language of the buffer
2176 project.read_with(cx, |project, _| {
2177 project.languages().add(languages::rust_lang())
2178 });
2179
2180 let (multi_workspace, cx) = cx.add_window_view(|window, cx| {
2181 MultiWorkspace::test_new(project.clone(), window, cx)
2182 });
2183 let workspace = multi_workspace.read_with(cx, |mw, _| mw.workspace().clone());
2184
2185 let workspace_id = workspace::WORKSPACE_DB.next_id().await.unwrap();
2186
2187 let item_id = 9012 as ItemId;
2188 let serialized_editor = SerializedEditor {
2189 abs_path: None,
2190 contents: Some("hello".to_string()),
2191 language: Some("Rust".to_string()),
2192 mtime: None,
2193 };
2194
2195 DB.save_serialized_editor(item_id, workspace_id, serialized_editor)
2196 .await
2197 .unwrap();
2198
2199 let deserialized =
2200 deserialize_editor(item_id, workspace_id, workspace, project, cx).await;
2201
2202 deserialized.update(cx, |editor, cx| {
2203 assert_eq!(editor.text(cx), "hello");
2204 assert!(editor.is_dirty(cx)); // The editor should be dirty for an untitled buffer
2205
2206 let buffer = editor.buffer().read(cx).as_singleton().unwrap().read(cx);
2207 assert_eq!(
2208 buffer.language().map(|lang| lang.name()),
2209 Some("Rust".into())
2210 ); // Language should be set to Rust
2211 assert!(buffer.file().is_none()); // The buffer should not have an associated file
2212 });
2213 }
2214
2215 // Test case 4: Deserialize with path, content, and old mtime
2216 {
2217 let project = Project::test(fs.clone(), [path!("/file.rs").as_ref()], cx).await;
2218 let (multi_workspace, cx) = cx.add_window_view(|window, cx| {
2219 MultiWorkspace::test_new(project.clone(), window, cx)
2220 });
2221 let workspace = multi_workspace.read_with(cx, |mw, _| mw.workspace().clone());
2222
2223 let workspace_id = workspace::WORKSPACE_DB.next_id().await.unwrap();
2224
2225 let item_id = 9345 as ItemId;
2226 let old_mtime = MTime::from_seconds_and_nanos(0, 50);
2227 let serialized_editor = SerializedEditor {
2228 abs_path: Some(PathBuf::from(path!("/file.rs"))),
2229 contents: Some("fn main() {}".to_string()),
2230 language: Some("Rust".to_string()),
2231 mtime: Some(old_mtime),
2232 };
2233
2234 DB.save_serialized_editor(item_id, workspace_id, serialized_editor)
2235 .await
2236 .unwrap();
2237
2238 let deserialized =
2239 deserialize_editor(item_id, workspace_id, workspace, project, cx).await;
2240
2241 deserialized.update(cx, |editor, cx| {
2242 assert_eq!(editor.text(cx), "fn main() {}");
2243 assert!(editor.has_conflict(cx)); // The editor should have a conflict
2244 });
2245 }
2246
2247 // Test case 5: Deserialize with no path, no content, no language, and no old mtime (new, empty, unsaved buffer)
2248 {
2249 let project = Project::test(fs.clone(), [path!("/file.rs").as_ref()], cx).await;
2250 let (multi_workspace, cx) = cx.add_window_view(|window, cx| {
2251 MultiWorkspace::test_new(project.clone(), window, cx)
2252 });
2253 let workspace = multi_workspace.read_with(cx, |mw, _| mw.workspace().clone());
2254
2255 let workspace_id = workspace::WORKSPACE_DB.next_id().await.unwrap();
2256
2257 let item_id = 10000 as ItemId;
2258 let serialized_editor = SerializedEditor {
2259 abs_path: None,
2260 contents: None,
2261 language: None,
2262 mtime: None,
2263 };
2264
2265 DB.save_serialized_editor(item_id, workspace_id, serialized_editor)
2266 .await
2267 .unwrap();
2268
2269 let deserialized =
2270 deserialize_editor(item_id, workspace_id, workspace, project, cx).await;
2271
2272 deserialized.update(cx, |editor, cx| {
2273 assert_eq!(editor.text(cx), "");
2274 assert!(!editor.is_dirty(cx));
2275 assert!(!editor.has_conflict(cx));
2276
2277 let buffer = editor.buffer().read(cx).as_singleton().unwrap().read(cx);
2278 assert!(buffer.file().is_none());
2279 });
2280 }
2281
2282 // Test case 6: Deserialize with path and contents in an empty workspace (no worktree)
2283 // This tests the hot-exit scenario where a file is opened in an empty workspace
2284 // and has unsaved changes that should be restored.
2285 {
2286 let fs = FakeFs::new(cx.executor());
2287 fs.insert_file(path!("/standalone.rs"), "original content".into())
2288 .await;
2289
2290 // Create an empty project with no worktrees
2291 let project = Project::test(fs.clone(), [], cx).await;
2292 let (multi_workspace, cx) = cx.add_window_view(|window, cx| {
2293 MultiWorkspace::test_new(project.clone(), window, cx)
2294 });
2295 let workspace = multi_workspace.read_with(cx, |mw, _| mw.workspace().clone());
2296
2297 let workspace_id = workspace::WORKSPACE_DB.next_id().await.unwrap();
2298 let item_id = 11000 as ItemId;
2299
2300 let mtime = fs
2301 .metadata(Path::new(path!("/standalone.rs")))
2302 .await
2303 .unwrap()
2304 .unwrap()
2305 .mtime;
2306
2307 // Simulate serialized state: file with unsaved changes
2308 let serialized_editor = SerializedEditor {
2309 abs_path: Some(PathBuf::from(path!("/standalone.rs"))),
2310 contents: Some("modified content".to_string()),
2311 language: Some("Rust".to_string()),
2312 mtime: Some(mtime),
2313 };
2314
2315 DB.save_serialized_editor(item_id, workspace_id, serialized_editor)
2316 .await
2317 .unwrap();
2318
2319 let deserialized =
2320 deserialize_editor(item_id, workspace_id, workspace, project, cx).await;
2321
2322 deserialized.update(cx, |editor, cx| {
2323 // The editor should have the serialized contents, not the disk contents
2324 assert_eq!(editor.text(cx), "modified content");
2325 assert!(editor.is_dirty(cx));
2326 assert!(!editor.has_conflict(cx));
2327
2328 let buffer = editor.buffer().read(cx).as_singleton().unwrap().read(cx);
2329 assert!(buffer.file().is_some());
2330 });
2331 }
2332 }
2333}