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