1use crate::{
2 editor_settings::SeedQuerySetting, persistence::DB, scroll::ScrollAnchor, Anchor, Autoscroll,
3 Editor, EditorEvent, EditorSettings, ExcerptId, ExcerptRange, MultiBuffer, MultiBufferSnapshot,
4 NavigationData, ToPoint as _,
5};
6use anyhow::{anyhow, Context as _, Result};
7use collections::HashSet;
8use futures::future::try_join_all;
9use gpui::{
10 point, AnyElement, AppContext, AsyncWindowContext, Context, Entity, EntityId, EventEmitter,
11 IntoElement, Model, ParentElement, Pixels, SharedString, Styled, Task, View, ViewContext,
12 VisualContext, WeakView, WindowContext,
13};
14use language::{
15 proto::serialize_anchor as serialize_text_anchor, Bias, Buffer, CharKind, OffsetRangeExt,
16 Point, SelectionGoal,
17};
18use project::repository::GitFileStatus;
19use project::{search::SearchQuery, FormatTrigger, Item as _, Project, ProjectPath};
20use rpc::proto::{self, update_view, PeerId};
21use settings::Settings;
22use workspace::item::ItemSettings;
23
24use std::{
25 borrow::Cow,
26 cmp::{self, Ordering},
27 iter,
28 ops::Range,
29 path::{Path, PathBuf},
30 sync::Arc,
31};
32use text::{BufferId, Selection};
33use theme::Theme;
34use ui::{h_flex, prelude::*, Label};
35use util::{paths::PathExt, ResultExt, TryFutureExt};
36use workspace::item::{BreadcrumbText, FollowEvent, FollowableItemHandle};
37use workspace::{
38 item::{FollowableItem, Item, ItemEvent, ItemHandle, ProjectItem},
39 searchable::{Direction, SearchEvent, SearchableItem, SearchableItemHandle},
40 ItemId, ItemNavHistory, Pane, ToolbarItemLocation, ViewId, Workspace, WorkspaceId,
41};
42
43pub const MAX_TAB_TITLE_LEN: usize = 24;
44
45impl FollowableItem for Editor {
46 fn remote_id(&self) -> Option<ViewId> {
47 self.remote_id
48 }
49
50 fn from_state_proto(
51 pane: View<workspace::Pane>,
52 workspace: View<Workspace>,
53 remote_id: ViewId,
54 state: &mut Option<proto::view::Variant>,
55 cx: &mut WindowContext,
56 ) -> Option<Task<Result<View<Self>>>> {
57 let project = workspace.read(cx).project().to_owned();
58 let Some(proto::view::Variant::Editor(_)) = state else {
59 return None;
60 };
61 let Some(proto::view::Variant::Editor(state)) = state.take() else {
62 unreachable!()
63 };
64
65 let client = project.read(cx).client();
66 let replica_id = project.read(cx).replica_id();
67 let buffer_ids = state
68 .excerpts
69 .iter()
70 .map(|excerpt| excerpt.buffer_id)
71 .collect::<HashSet<_>>();
72 let buffers = project.update(cx, |project, cx| {
73 buffer_ids
74 .iter()
75 .map(|id| BufferId::new(*id).map(|id| project.open_buffer_by_id(id, cx)))
76 .collect::<Result<Vec<_>>>()
77 });
78
79 let pane = pane.downgrade();
80 Some(cx.spawn(|mut cx| async move {
81 let mut buffers = futures::future::try_join_all(buffers?)
82 .await
83 .debug_assert_ok("leaders don't share views for unshared buffers")?;
84 let editor = pane.update(&mut cx, |pane, cx| {
85 let mut editors = pane.items_of_type::<Self>();
86 editors.find(|editor| {
87 let ids_match = editor.remote_id(&client, cx) == Some(remote_id);
88 let singleton_buffer_matches = state.singleton
89 && buffers.first()
90 == editor.read(cx).buffer.read(cx).as_singleton().as_ref();
91 ids_match || singleton_buffer_matches
92 })
93 })?;
94
95 let editor = if let Some(editor) = editor {
96 editor
97 } else {
98 pane.update(&mut cx, |_, cx| {
99 let multibuffer = cx.new_model(|cx| {
100 let mut multibuffer;
101 if state.singleton && buffers.len() == 1 {
102 multibuffer = MultiBuffer::singleton(buffers.pop().unwrap(), cx)
103 } else {
104 multibuffer =
105 MultiBuffer::new(replica_id, project.read(cx).capability());
106 let mut excerpts = state.excerpts.into_iter().peekable();
107 while let Some(excerpt) = excerpts.peek() {
108 let Ok(buffer_id) = BufferId::new(excerpt.buffer_id) else {
109 continue;
110 };
111 let buffer_excerpts = iter::from_fn(|| {
112 let excerpt = excerpts.peek()?;
113 (excerpt.buffer_id == u64::from(buffer_id))
114 .then(|| excerpts.next().unwrap())
115 });
116 let buffer =
117 buffers.iter().find(|b| b.read(cx).remote_id() == buffer_id);
118 if let Some(buffer) = buffer {
119 multibuffer.push_excerpts(
120 buffer.clone(),
121 buffer_excerpts.filter_map(deserialize_excerpt_range),
122 cx,
123 );
124 }
125 }
126 };
127
128 if let Some(title) = &state.title {
129 multibuffer = multibuffer.with_title(title.clone())
130 }
131
132 multibuffer
133 });
134
135 cx.new_view(|cx| {
136 let mut editor =
137 Editor::for_multibuffer(multibuffer, Some(project.clone()), cx);
138 editor.remote_id = Some(remote_id);
139 editor
140 })
141 })?
142 };
143
144 update_editor_from_message(
145 editor.downgrade(),
146 project,
147 proto::update_view::Editor {
148 selections: state.selections,
149 pending_selection: state.pending_selection,
150 scroll_top_anchor: state.scroll_top_anchor,
151 scroll_x: state.scroll_x,
152 scroll_y: state.scroll_y,
153 ..Default::default()
154 },
155 &mut cx,
156 )
157 .await?;
158
159 Ok(editor)
160 }))
161 }
162
163 fn set_leader_peer_id(&mut self, leader_peer_id: Option<PeerId>, cx: &mut ViewContext<Self>) {
164 self.leader_peer_id = leader_peer_id;
165 if self.leader_peer_id.is_some() {
166 self.buffer.update(cx, |buffer, cx| {
167 buffer.remove_active_selections(cx);
168 });
169 } else if self.focus_handle.is_focused(cx) {
170 self.buffer.update(cx, |buffer, cx| {
171 buffer.set_active_selections(
172 &self.selections.disjoint_anchors(),
173 self.selections.line_mode,
174 self.cursor_shape,
175 cx,
176 );
177 });
178 }
179 cx.notify();
180 }
181
182 fn to_state_proto(&self, cx: &WindowContext) -> Option<proto::view::Variant> {
183 let buffer = self.buffer.read(cx);
184 if buffer
185 .as_singleton()
186 .and_then(|buffer| buffer.read(cx).file())
187 .map_or(false, |file| file.is_private())
188 {
189 return None;
190 }
191
192 let scroll_anchor = self.scroll_manager.anchor();
193 let excerpts = buffer
194 .read(cx)
195 .excerpts()
196 .map(|(id, buffer, range)| proto::Excerpt {
197 id: id.to_proto(),
198 buffer_id: buffer.remote_id().into(),
199 context_start: Some(serialize_text_anchor(&range.context.start)),
200 context_end: Some(serialize_text_anchor(&range.context.end)),
201 primary_start: range
202 .primary
203 .as_ref()
204 .map(|range| serialize_text_anchor(&range.start)),
205 primary_end: range
206 .primary
207 .as_ref()
208 .map(|range| serialize_text_anchor(&range.end)),
209 })
210 .collect();
211
212 Some(proto::view::Variant::Editor(proto::view::Editor {
213 singleton: buffer.is_singleton(),
214 title: (!buffer.is_singleton()).then(|| buffer.title(cx).into()),
215 excerpts,
216 scroll_top_anchor: Some(serialize_anchor(&scroll_anchor.anchor)),
217 scroll_x: scroll_anchor.offset.x,
218 scroll_y: scroll_anchor.offset.y,
219 selections: self
220 .selections
221 .disjoint_anchors()
222 .iter()
223 .map(serialize_selection)
224 .collect(),
225 pending_selection: self
226 .selections
227 .pending_anchor()
228 .as_ref()
229 .map(serialize_selection),
230 }))
231 }
232
233 fn to_follow_event(event: &EditorEvent) -> Option<workspace::item::FollowEvent> {
234 match event {
235 EditorEvent::Edited => Some(FollowEvent::Unfollow),
236 EditorEvent::SelectionsChanged { local }
237 | EditorEvent::ScrollPositionChanged { local, .. } => {
238 if *local {
239 Some(FollowEvent::Unfollow)
240 } else {
241 None
242 }
243 }
244 _ => None,
245 }
246 }
247
248 fn add_event_to_update_proto(
249 &self,
250 event: &EditorEvent,
251 update: &mut Option<proto::update_view::Variant>,
252 cx: &WindowContext,
253 ) -> bool {
254 let update =
255 update.get_or_insert_with(|| proto::update_view::Variant::Editor(Default::default()));
256
257 match update {
258 proto::update_view::Variant::Editor(update) => match event {
259 EditorEvent::ExcerptsAdded {
260 buffer,
261 predecessor,
262 excerpts,
263 } => {
264 let buffer_id = buffer.read(cx).remote_id();
265 let mut excerpts = excerpts.iter();
266 if let Some((id, range)) = excerpts.next() {
267 update.inserted_excerpts.push(proto::ExcerptInsertion {
268 previous_excerpt_id: Some(predecessor.to_proto()),
269 excerpt: serialize_excerpt(buffer_id, id, range),
270 });
271 update.inserted_excerpts.extend(excerpts.map(|(id, range)| {
272 proto::ExcerptInsertion {
273 previous_excerpt_id: None,
274 excerpt: serialize_excerpt(buffer_id, id, range),
275 }
276 }))
277 }
278 true
279 }
280 EditorEvent::ExcerptsRemoved { ids } => {
281 update
282 .deleted_excerpts
283 .extend(ids.iter().map(ExcerptId::to_proto));
284 true
285 }
286 EditorEvent::ScrollPositionChanged { autoscroll, .. } if !autoscroll => {
287 let scroll_anchor = self.scroll_manager.anchor();
288 update.scroll_top_anchor = Some(serialize_anchor(&scroll_anchor.anchor));
289 update.scroll_x = scroll_anchor.offset.x;
290 update.scroll_y = scroll_anchor.offset.y;
291 true
292 }
293 EditorEvent::SelectionsChanged { .. } => {
294 update.selections = self
295 .selections
296 .disjoint_anchors()
297 .iter()
298 .map(serialize_selection)
299 .collect();
300 update.pending_selection = self
301 .selections
302 .pending_anchor()
303 .as_ref()
304 .map(serialize_selection);
305 true
306 }
307 _ => false,
308 },
309 }
310 }
311
312 fn apply_update_proto(
313 &mut self,
314 project: &Model<Project>,
315 message: update_view::Variant,
316 cx: &mut ViewContext<Self>,
317 ) -> Task<Result<()>> {
318 let update_view::Variant::Editor(message) = message;
319 let project = project.clone();
320 cx.spawn(|this, mut cx| async move {
321 update_editor_from_message(this, project, message, &mut cx).await
322 })
323 }
324
325 fn is_project_item(&self, _cx: &WindowContext) -> bool {
326 true
327 }
328}
329
330async fn update_editor_from_message(
331 this: WeakView<Editor>,
332 project: Model<Project>,
333 message: proto::update_view::Editor,
334 cx: &mut AsyncWindowContext,
335) -> Result<()> {
336 // Open all of the buffers of which excerpts were added to the editor.
337 let inserted_excerpt_buffer_ids = message
338 .inserted_excerpts
339 .iter()
340 .filter_map(|insertion| Some(insertion.excerpt.as_ref()?.buffer_id))
341 .collect::<HashSet<_>>();
342 let inserted_excerpt_buffers = project.update(cx, |project, cx| {
343 inserted_excerpt_buffer_ids
344 .into_iter()
345 .map(|id| BufferId::new(id).map(|id| project.open_buffer_by_id(id, cx)))
346 .collect::<Result<Vec<_>>>()
347 })??;
348 let _inserted_excerpt_buffers = try_join_all(inserted_excerpt_buffers).await?;
349
350 // Update the editor's excerpts.
351 this.update(cx, |editor, cx| {
352 editor.buffer.update(cx, |multibuffer, cx| {
353 let mut removed_excerpt_ids = message
354 .deleted_excerpts
355 .into_iter()
356 .map(ExcerptId::from_proto)
357 .collect::<Vec<_>>();
358 removed_excerpt_ids.sort_by({
359 let multibuffer = multibuffer.read(cx);
360 move |a, b| a.cmp(&b, &multibuffer)
361 });
362
363 let mut insertions = message.inserted_excerpts.into_iter().peekable();
364 while let Some(insertion) = insertions.next() {
365 let Some(excerpt) = insertion.excerpt else {
366 continue;
367 };
368 let Some(previous_excerpt_id) = insertion.previous_excerpt_id else {
369 continue;
370 };
371 let buffer_id = BufferId::new(excerpt.buffer_id)?;
372 let Some(buffer) = project.read(cx).buffer_for_id(buffer_id) else {
373 continue;
374 };
375
376 let adjacent_excerpts = iter::from_fn(|| {
377 let insertion = insertions.peek()?;
378 if insertion.previous_excerpt_id.is_none()
379 && insertion.excerpt.as_ref()?.buffer_id == u64::from(buffer_id)
380 {
381 insertions.next()?.excerpt
382 } else {
383 None
384 }
385 });
386
387 multibuffer.insert_excerpts_with_ids_after(
388 ExcerptId::from_proto(previous_excerpt_id),
389 buffer,
390 [excerpt]
391 .into_iter()
392 .chain(adjacent_excerpts)
393 .filter_map(|excerpt| {
394 Some((
395 ExcerptId::from_proto(excerpt.id),
396 deserialize_excerpt_range(excerpt)?,
397 ))
398 }),
399 cx,
400 );
401 }
402
403 multibuffer.remove_excerpts(removed_excerpt_ids, cx);
404 Result::<(), anyhow::Error>::Ok(())
405 })
406 })??;
407
408 // Deserialize the editor state.
409 let (selections, pending_selection, scroll_top_anchor) = this.update(cx, |editor, cx| {
410 let buffer = editor.buffer.read(cx).read(cx);
411 let selections = message
412 .selections
413 .into_iter()
414 .filter_map(|selection| deserialize_selection(&buffer, selection))
415 .collect::<Vec<_>>();
416 let pending_selection = message
417 .pending_selection
418 .and_then(|selection| deserialize_selection(&buffer, selection));
419 let scroll_top_anchor = message
420 .scroll_top_anchor
421 .and_then(|anchor| deserialize_anchor(&buffer, anchor));
422 anyhow::Ok((selections, pending_selection, scroll_top_anchor))
423 })??;
424
425 // Wait until the buffer has received all of the operations referenced by
426 // the editor's new state.
427 this.update(cx, |editor, cx| {
428 editor.buffer.update(cx, |buffer, cx| {
429 buffer.wait_for_anchors(
430 selections
431 .iter()
432 .chain(pending_selection.as_ref())
433 .flat_map(|selection| [selection.start, selection.end])
434 .chain(scroll_top_anchor),
435 cx,
436 )
437 })
438 })?
439 .await?;
440
441 // Update the editor's state.
442 this.update(cx, |editor, cx| {
443 if !selections.is_empty() || pending_selection.is_some() {
444 editor.set_selections_from_remote(selections, pending_selection, cx);
445 editor.request_autoscroll_remotely(Autoscroll::newest(), cx);
446 } else if let Some(scroll_top_anchor) = scroll_top_anchor {
447 editor.set_scroll_anchor_remote(
448 ScrollAnchor {
449 anchor: scroll_top_anchor,
450 offset: point(message.scroll_x, message.scroll_y),
451 },
452 cx,
453 );
454 }
455 })?;
456 Ok(())
457}
458
459fn serialize_excerpt(
460 buffer_id: BufferId,
461 id: &ExcerptId,
462 range: &ExcerptRange<language::Anchor>,
463) -> Option<proto::Excerpt> {
464 Some(proto::Excerpt {
465 id: id.to_proto(),
466 buffer_id: buffer_id.into(),
467 context_start: Some(serialize_text_anchor(&range.context.start)),
468 context_end: Some(serialize_text_anchor(&range.context.end)),
469 primary_start: range
470 .primary
471 .as_ref()
472 .map(|r| serialize_text_anchor(&r.start)),
473 primary_end: range
474 .primary
475 .as_ref()
476 .map(|r| serialize_text_anchor(&r.end)),
477 })
478}
479
480fn serialize_selection(selection: &Selection<Anchor>) -> proto::Selection {
481 proto::Selection {
482 id: selection.id as u64,
483 start: Some(serialize_anchor(&selection.start)),
484 end: Some(serialize_anchor(&selection.end)),
485 reversed: selection.reversed,
486 }
487}
488
489fn serialize_anchor(anchor: &Anchor) -> proto::EditorAnchor {
490 proto::EditorAnchor {
491 excerpt_id: anchor.excerpt_id.to_proto(),
492 anchor: Some(serialize_text_anchor(&anchor.text_anchor)),
493 }
494}
495
496fn deserialize_excerpt_range(excerpt: proto::Excerpt) -> Option<ExcerptRange<language::Anchor>> {
497 let context = {
498 let start = language::proto::deserialize_anchor(excerpt.context_start?)?;
499 let end = language::proto::deserialize_anchor(excerpt.context_end?)?;
500 start..end
501 };
502 let primary = excerpt
503 .primary_start
504 .zip(excerpt.primary_end)
505 .and_then(|(start, end)| {
506 let start = language::proto::deserialize_anchor(start)?;
507 let end = language::proto::deserialize_anchor(end)?;
508 Some(start..end)
509 });
510 Some(ExcerptRange { context, primary })
511}
512
513fn deserialize_selection(
514 buffer: &MultiBufferSnapshot,
515 selection: proto::Selection,
516) -> Option<Selection<Anchor>> {
517 Some(Selection {
518 id: selection.id as usize,
519 start: deserialize_anchor(buffer, selection.start?)?,
520 end: deserialize_anchor(buffer, selection.end?)?,
521 reversed: selection.reversed,
522 goal: SelectionGoal::None,
523 })
524}
525
526fn deserialize_anchor(buffer: &MultiBufferSnapshot, anchor: proto::EditorAnchor) -> Option<Anchor> {
527 let excerpt_id = ExcerptId::from_proto(anchor.excerpt_id);
528 Some(Anchor {
529 excerpt_id,
530 text_anchor: language::proto::deserialize_anchor(anchor.anchor?)?,
531 buffer_id: buffer.buffer_id_for_excerpt(excerpt_id),
532 })
533}
534
535impl Item for Editor {
536 type Event = EditorEvent;
537
538 fn navigate(&mut self, data: Box<dyn std::any::Any>, cx: &mut ViewContext<Self>) -> bool {
539 if let Ok(data) = data.downcast::<NavigationData>() {
540 let newest_selection = self.selections.newest::<Point>(cx);
541 let buffer = self.buffer.read(cx).read(cx);
542 let offset = if buffer.can_resolve(&data.cursor_anchor) {
543 data.cursor_anchor.to_point(&buffer)
544 } else {
545 buffer.clip_point(data.cursor_position, Bias::Left)
546 };
547
548 let mut scroll_anchor = data.scroll_anchor;
549 if !buffer.can_resolve(&scroll_anchor.anchor) {
550 scroll_anchor.anchor = buffer.anchor_before(
551 buffer.clip_point(Point::new(data.scroll_top_row, 0), Bias::Left),
552 );
553 }
554
555 drop(buffer);
556
557 if newest_selection.head() == offset {
558 false
559 } else {
560 let nav_history = self.nav_history.take();
561 self.set_scroll_anchor(scroll_anchor, cx);
562 self.change_selections(Some(Autoscroll::fit()), cx, |s| {
563 s.select_ranges([offset..offset])
564 });
565 self.nav_history = nav_history;
566 true
567 }
568 } else {
569 false
570 }
571 }
572
573 fn tab_tooltip_text(&self, cx: &AppContext) -> Option<SharedString> {
574 let file_path = self
575 .buffer()
576 .read(cx)
577 .as_singleton()?
578 .read(cx)
579 .file()
580 .and_then(|f| f.as_local())?
581 .abs_path(cx);
582
583 let file_path = file_path.compact().to_string_lossy().to_string();
584
585 Some(file_path.into())
586 }
587
588 fn telemetry_event_text(&self) -> Option<&'static str> {
589 None
590 }
591
592 fn tab_description(&self, detail: usize, cx: &AppContext) -> Option<SharedString> {
593 let path = path_for_buffer(&self.buffer, detail, true, cx)?;
594 Some(path.to_string_lossy().to_string().into())
595 }
596
597 fn tab_content(&self, detail: Option<usize>, selected: bool, cx: &WindowContext) -> AnyElement {
598 let label_color = if ItemSettings::get_global(cx).git_status {
599 self.buffer()
600 .read(cx)
601 .as_singleton()
602 .and_then(|buffer| buffer.read(cx).project_path(cx))
603 .and_then(|path| self.project.as_ref()?.read(cx).entry_for_path(&path, cx))
604 .map(|entry| {
605 entry_git_aware_label_color(entry.git_status, entry.is_ignored, selected)
606 })
607 .unwrap_or_else(|| entry_label_color(selected))
608 } else {
609 entry_label_color(selected)
610 };
611
612 let description = detail.and_then(|detail| {
613 let path = path_for_buffer(&self.buffer, detail, false, cx)?;
614 let description = path.to_string_lossy();
615 let description = description.trim();
616
617 if description.is_empty() {
618 return None;
619 }
620
621 Some(util::truncate_and_trailoff(&description, MAX_TAB_TITLE_LEN))
622 });
623
624 h_flex()
625 .gap_2()
626 .child(Label::new(self.title(cx).to_string()).color(label_color))
627 .when_some(description, |this, description| {
628 this.child(
629 Label::new(description)
630 .size(LabelSize::XSmall)
631 .color(Color::Muted),
632 )
633 })
634 .into_any_element()
635 }
636
637 fn for_each_project_item(
638 &self,
639 cx: &AppContext,
640 f: &mut dyn FnMut(EntityId, &dyn project::Item),
641 ) {
642 self.buffer
643 .read(cx)
644 .for_each_buffer(|buffer| f(buffer.entity_id(), buffer.read(cx)));
645 }
646
647 fn is_singleton(&self, cx: &AppContext) -> bool {
648 self.buffer.read(cx).is_singleton()
649 }
650
651 fn clone_on_split(
652 &self,
653 _workspace_id: WorkspaceId,
654 cx: &mut ViewContext<Self>,
655 ) -> Option<View<Editor>>
656 where
657 Self: Sized,
658 {
659 Some(cx.new_view(|cx| self.clone(cx)))
660 }
661
662 fn set_nav_history(&mut self, history: ItemNavHistory, _: &mut ViewContext<Self>) {
663 self.nav_history = Some(history);
664 }
665
666 fn deactivated(&mut self, cx: &mut ViewContext<Self>) {
667 let selection = self.selections.newest_anchor();
668 self.push_to_nav_history(selection.head(), None, cx);
669 }
670
671 fn workspace_deactivated(&mut self, cx: &mut ViewContext<Self>) {
672 self.hide_hovered_link(cx);
673 }
674
675 fn is_dirty(&self, cx: &AppContext) -> bool {
676 self.buffer().read(cx).read(cx).is_dirty()
677 }
678
679 fn has_conflict(&self, cx: &AppContext) -> bool {
680 self.buffer().read(cx).read(cx).has_conflict()
681 }
682
683 fn can_save(&self, cx: &AppContext) -> bool {
684 let buffer = &self.buffer().read(cx);
685 if let Some(buffer) = buffer.as_singleton() {
686 buffer.read(cx).project_path(cx).is_some()
687 } else {
688 true
689 }
690 }
691
692 fn save(
693 &mut self,
694 format: bool,
695 project: Model<Project>,
696 cx: &mut ViewContext<Self>,
697 ) -> Task<Result<()>> {
698 self.report_editor_event("save", None, cx);
699 let buffers = self.buffer().clone().read(cx).all_buffers();
700 cx.spawn(|this, mut cx| async move {
701 if format {
702 this.update(&mut cx, |editor, cx| {
703 editor.perform_format(project.clone(), FormatTrigger::Save, cx)
704 })?
705 .await?;
706 }
707
708 if buffers.len() == 1 {
709 // Apply full save routine for singleton buffers, to allow to `touch` the file via the editor.
710 project
711 .update(&mut cx, |project, cx| project.save_buffers(buffers, cx))?
712 .await?;
713 } else {
714 // For multi-buffers, only format and save the buffers with changes.
715 // For clean buffers, we simulate saving by calling `Buffer::did_save`,
716 // so that language servers or other downstream listeners of save events get notified.
717 let (dirty_buffers, clean_buffers) = buffers.into_iter().partition(|buffer| {
718 buffer
719 .update(&mut cx, |buffer, _| {
720 buffer.is_dirty() || buffer.has_conflict()
721 })
722 .unwrap_or(false)
723 });
724
725 project
726 .update(&mut cx, |project, cx| {
727 project.save_buffers(dirty_buffers, cx)
728 })?
729 .await?;
730 for buffer in clean_buffers {
731 buffer
732 .update(&mut cx, |buffer, cx| {
733 let version = buffer.saved_version().clone();
734 let fingerprint = buffer.saved_version_fingerprint();
735 let mtime = buffer.saved_mtime();
736 buffer.did_save(version, fingerprint, mtime, cx);
737 })
738 .ok();
739 }
740 }
741
742 Ok(())
743 })
744 }
745
746 fn save_as(
747 &mut self,
748 project: Model<Project>,
749 abs_path: PathBuf,
750 cx: &mut ViewContext<Self>,
751 ) -> Task<Result<()>> {
752 let buffer = self
753 .buffer()
754 .read(cx)
755 .as_singleton()
756 .expect("cannot call save_as on an excerpt list");
757
758 let file_extension = abs_path
759 .extension()
760 .map(|a| a.to_string_lossy().to_string());
761 self.report_editor_event("save", file_extension, cx);
762
763 project.update(cx, |project, cx| {
764 project.save_buffer_as(buffer, abs_path, cx)
765 })
766 }
767
768 fn reload(&mut self, project: Model<Project>, cx: &mut ViewContext<Self>) -> Task<Result<()>> {
769 let buffer = self.buffer().clone();
770 let buffers = self.buffer.read(cx).all_buffers();
771 let reload_buffers =
772 project.update(cx, |project, cx| project.reload_buffers(buffers, true, cx));
773 cx.spawn(|this, mut cx| async move {
774 let transaction = reload_buffers.log_err().await;
775 this.update(&mut cx, |editor, cx| {
776 editor.request_autoscroll(Autoscroll::fit(), cx)
777 })?;
778 buffer
779 .update(&mut cx, |buffer, cx| {
780 if let Some(transaction) = transaction {
781 if !buffer.is_singleton() {
782 buffer.push_transaction(&transaction.0, cx);
783 }
784 }
785 })
786 .ok();
787 Ok(())
788 })
789 }
790
791 fn as_searchable(&self, handle: &View<Self>) -> Option<Box<dyn SearchableItemHandle>> {
792 Some(Box::new(handle.clone()))
793 }
794
795 fn pixel_position_of_cursor(&self, _: &AppContext) -> Option<gpui::Point<Pixels>> {
796 self.pixel_position_of_newest_cursor
797 }
798
799 fn breadcrumb_location(&self) -> ToolbarItemLocation {
800 if self.show_breadcrumbs {
801 ToolbarItemLocation::PrimaryLeft
802 } else {
803 ToolbarItemLocation::Hidden
804 }
805 }
806
807 fn breadcrumbs(&self, variant: &Theme, cx: &AppContext) -> Option<Vec<BreadcrumbText>> {
808 let cursor = self.selections.newest_anchor().head();
809 let multibuffer = &self.buffer().read(cx);
810 let (buffer_id, symbols) =
811 multibuffer.symbols_containing(cursor, Some(&variant.syntax()), cx)?;
812 let buffer = multibuffer.buffer(buffer_id)?;
813
814 let buffer = buffer.read(cx);
815 let filename = buffer
816 .snapshot()
817 .resolve_file_path(
818 cx,
819 self.project
820 .as_ref()
821 .map(|project| project.read(cx).visible_worktrees(cx).count() > 1)
822 .unwrap_or_default(),
823 )
824 .map(|path| path.to_string_lossy().to_string())
825 .unwrap_or_else(|| "untitled".to_string());
826
827 let mut breadcrumbs = vec![BreadcrumbText {
828 text: filename,
829 highlights: None,
830 }];
831 breadcrumbs.extend(symbols.into_iter().map(|symbol| BreadcrumbText {
832 text: symbol.text,
833 highlights: Some(symbol.highlight_ranges),
834 }));
835 Some(breadcrumbs)
836 }
837
838 fn added_to_workspace(&mut self, workspace: &mut Workspace, cx: &mut ViewContext<Self>) {
839 let workspace_id = workspace.database_id();
840 let item_id = cx.view().item_id().as_u64() as ItemId;
841 self.workspace = Some((workspace.weak_handle(), workspace.database_id()));
842
843 fn serialize(
844 buffer: Model<Buffer>,
845 workspace_id: WorkspaceId,
846 item_id: ItemId,
847 cx: &mut AppContext,
848 ) {
849 if let Some(file) = buffer.read(cx).file().and_then(|file| file.as_local()) {
850 let path = file.abs_path(cx);
851
852 cx.background_executor()
853 .spawn(async move {
854 DB.save_path(item_id, workspace_id, path.clone())
855 .await
856 .log_err()
857 })
858 .detach();
859 }
860 }
861
862 if let Some(buffer) = self.buffer().read(cx).as_singleton() {
863 serialize(buffer.clone(), workspace_id, item_id, cx);
864
865 cx.subscribe(&buffer, |this, buffer, event, cx| {
866 if let Some((_, workspace_id)) = this.workspace.as_ref() {
867 if let language::Event::FileHandleChanged = event {
868 serialize(
869 buffer,
870 *workspace_id,
871 cx.view().item_id().as_u64() as ItemId,
872 cx,
873 );
874 }
875 }
876 })
877 .detach();
878 }
879 }
880
881 fn serialized_item_kind() -> Option<&'static str> {
882 Some("Editor")
883 }
884
885 fn to_item_events(event: &EditorEvent, mut f: impl FnMut(ItemEvent)) {
886 match event {
887 EditorEvent::Closed => f(ItemEvent::CloseItem),
888
889 EditorEvent::Saved | EditorEvent::TitleChanged => {
890 f(ItemEvent::UpdateTab);
891 f(ItemEvent::UpdateBreadcrumbs);
892 }
893
894 EditorEvent::Reparsed => {
895 f(ItemEvent::UpdateBreadcrumbs);
896 }
897
898 EditorEvent::SelectionsChanged { local } if *local => {
899 f(ItemEvent::UpdateBreadcrumbs);
900 }
901
902 EditorEvent::DirtyChanged => {
903 f(ItemEvent::UpdateTab);
904 }
905
906 EditorEvent::BufferEdited => {
907 f(ItemEvent::Edit);
908 f(ItemEvent::UpdateBreadcrumbs);
909 }
910
911 EditorEvent::ExcerptsAdded { .. } | EditorEvent::ExcerptsRemoved { .. } => {
912 f(ItemEvent::Edit);
913 }
914
915 _ => {}
916 }
917 }
918
919 fn deserialize(
920 project: Model<Project>,
921 _workspace: WeakView<Workspace>,
922 workspace_id: workspace::WorkspaceId,
923 item_id: ItemId,
924 cx: &mut ViewContext<Pane>,
925 ) -> Task<Result<View<Self>>> {
926 let project_item: Result<_> = project.update(cx, |project, cx| {
927 // Look up the path with this key associated, create a self with that path
928 let path = DB
929 .get_path(item_id, workspace_id)?
930 .context("No path stored for this editor")?;
931
932 let (worktree, path) = project
933 .find_local_worktree(&path, cx)
934 .with_context(|| format!("No worktree for path: {path:?}"))?;
935 let project_path = ProjectPath {
936 worktree_id: worktree.read(cx).id(),
937 path: path.into(),
938 };
939
940 Ok(project.open_path(project_path, cx))
941 });
942
943 project_item
944 .map(|project_item| {
945 cx.spawn(|pane, mut cx| async move {
946 let (_, project_item) = project_item.await?;
947 let buffer = project_item
948 .downcast::<Buffer>()
949 .map_err(|_| anyhow!("Project item at stored path was not a buffer"))?;
950 pane.update(&mut cx, |_, cx| {
951 cx.new_view(|cx| {
952 let mut editor = Editor::for_buffer(buffer, Some(project), cx);
953
954 editor.read_scroll_position_from_db(item_id, workspace_id, cx);
955 editor
956 })
957 })
958 })
959 })
960 .unwrap_or_else(|error| Task::ready(Err(error)))
961 }
962}
963
964impl ProjectItem for Editor {
965 type Item = Buffer;
966
967 fn for_project_item(
968 project: Model<Project>,
969 buffer: Model<Buffer>,
970 cx: &mut ViewContext<Self>,
971 ) -> Self {
972 Self::for_buffer(buffer, Some(project), cx)
973 }
974}
975
976impl EventEmitter<SearchEvent> for Editor {}
977
978pub(crate) enum BufferSearchHighlights {}
979impl SearchableItem for Editor {
980 type Match = Range<Anchor>;
981
982 fn clear_matches(&mut self, cx: &mut ViewContext<Self>) {
983 self.clear_background_highlights::<BufferSearchHighlights>(cx);
984 }
985
986 fn update_matches(&mut self, matches: &[Range<Anchor>], cx: &mut ViewContext<Self>) {
987 self.highlight_background::<BufferSearchHighlights>(
988 matches,
989 |theme| theme.search_match_background,
990 cx,
991 );
992 }
993
994 fn query_suggestion(&mut self, cx: &mut ViewContext<Self>) -> String {
995 let setting = EditorSettings::get_global(cx).seed_search_query_from_cursor;
996 let snapshot = &self.snapshot(cx).buffer_snapshot;
997 let selection = self.selections.newest::<usize>(cx);
998
999 match setting {
1000 SeedQuerySetting::Never => String::new(),
1001 SeedQuerySetting::Selection | SeedQuerySetting::Always if !selection.is_empty() => {
1002 snapshot
1003 .text_for_range(selection.start..selection.end)
1004 .collect()
1005 }
1006 SeedQuerySetting::Selection => String::new(),
1007 SeedQuerySetting::Always => {
1008 let (range, kind) = snapshot.surrounding_word(selection.start);
1009 if kind == Some(CharKind::Word) {
1010 let text: String = snapshot.text_for_range(range).collect();
1011 if !text.trim().is_empty() {
1012 return text;
1013 }
1014 }
1015 String::new()
1016 }
1017 }
1018 }
1019
1020 fn activate_match(
1021 &mut self,
1022 index: usize,
1023 matches: &[Range<Anchor>],
1024 cx: &mut ViewContext<Self>,
1025 ) {
1026 self.unfold_ranges([matches[index].clone()], false, true, cx);
1027 let range = self.range_for_match(&matches[index]);
1028 self.change_selections(Some(Autoscroll::fit()), cx, |s| {
1029 s.select_ranges([range]);
1030 })
1031 }
1032
1033 fn select_matches(&mut self, matches: &[Self::Match], cx: &mut ViewContext<Self>) {
1034 self.unfold_ranges(matches.to_vec(), false, false, cx);
1035 let mut ranges = Vec::new();
1036 for m in matches {
1037 ranges.push(self.range_for_match(&m))
1038 }
1039 self.change_selections(None, cx, |s| s.select_ranges(ranges));
1040 }
1041 fn replace(
1042 &mut self,
1043 identifier: &Self::Match,
1044 query: &SearchQuery,
1045 cx: &mut ViewContext<Self>,
1046 ) {
1047 let text = self.buffer.read(cx);
1048 let text = text.snapshot(cx);
1049 let text = text.text_for_range(identifier.clone()).collect::<Vec<_>>();
1050 let text: Cow<_> = if text.len() == 1 {
1051 text.first().cloned().unwrap().into()
1052 } else {
1053 let joined_chunks = text.join("");
1054 joined_chunks.into()
1055 };
1056
1057 if let Some(replacement) = query.replacement_for(&text) {
1058 self.transact(cx, |this, cx| {
1059 this.edit([(identifier.clone(), Arc::from(&*replacement))], cx);
1060 });
1061 }
1062 }
1063 fn match_index_for_direction(
1064 &mut self,
1065 matches: &[Range<Anchor>],
1066 current_index: usize,
1067 direction: Direction,
1068 count: usize,
1069 cx: &mut ViewContext<Self>,
1070 ) -> usize {
1071 let buffer = self.buffer().read(cx).snapshot(cx);
1072 let current_index_position = if self.selections.disjoint_anchors().len() == 1 {
1073 self.selections.newest_anchor().head()
1074 } else {
1075 matches[current_index].start
1076 };
1077
1078 let mut count = count % matches.len();
1079 if count == 0 {
1080 return current_index;
1081 }
1082 match direction {
1083 Direction::Next => {
1084 if matches[current_index]
1085 .start
1086 .cmp(¤t_index_position, &buffer)
1087 .is_gt()
1088 {
1089 count = count - 1
1090 }
1091
1092 (current_index + count) % matches.len()
1093 }
1094 Direction::Prev => {
1095 if matches[current_index]
1096 .end
1097 .cmp(¤t_index_position, &buffer)
1098 .is_lt()
1099 {
1100 count = count - 1;
1101 }
1102
1103 if current_index >= count {
1104 current_index - count
1105 } else {
1106 matches.len() - (count - current_index)
1107 }
1108 }
1109 }
1110 }
1111
1112 fn find_matches(
1113 &mut self,
1114 query: Arc<project::search::SearchQuery>,
1115 cx: &mut ViewContext<Self>,
1116 ) -> Task<Vec<Range<Anchor>>> {
1117 let buffer = self.buffer().read(cx).snapshot(cx);
1118 cx.background_executor().spawn(async move {
1119 let mut ranges = Vec::new();
1120 if let Some((_, _, excerpt_buffer)) = buffer.as_singleton() {
1121 ranges.extend(
1122 query
1123 .search(excerpt_buffer, None)
1124 .await
1125 .into_iter()
1126 .map(|range| {
1127 buffer.anchor_after(range.start)..buffer.anchor_before(range.end)
1128 }),
1129 );
1130 } else {
1131 for excerpt in buffer.excerpt_boundaries_in_range(0..buffer.len()) {
1132 let excerpt_range = excerpt.range.context.to_offset(&excerpt.buffer);
1133 ranges.extend(
1134 query
1135 .search(&excerpt.buffer, Some(excerpt_range.clone()))
1136 .await
1137 .into_iter()
1138 .map(|range| {
1139 let start = excerpt
1140 .buffer
1141 .anchor_after(excerpt_range.start + range.start);
1142 let end = excerpt
1143 .buffer
1144 .anchor_before(excerpt_range.start + range.end);
1145 buffer.anchor_in_excerpt(excerpt.id, start).unwrap()
1146 ..buffer.anchor_in_excerpt(excerpt.id, end).unwrap()
1147 }),
1148 );
1149 }
1150 }
1151 ranges
1152 })
1153 }
1154
1155 fn active_match_index(
1156 &mut self,
1157 matches: &[Range<Anchor>],
1158 cx: &mut ViewContext<Self>,
1159 ) -> Option<usize> {
1160 active_match_index(
1161 matches,
1162 &self.selections.newest_anchor().head(),
1163 &self.buffer().read(cx).snapshot(cx),
1164 )
1165 }
1166}
1167
1168pub fn active_match_index(
1169 ranges: &[Range<Anchor>],
1170 cursor: &Anchor,
1171 buffer: &MultiBufferSnapshot,
1172) -> Option<usize> {
1173 if ranges.is_empty() {
1174 None
1175 } else {
1176 match ranges.binary_search_by(|probe| {
1177 if probe.end.cmp(cursor, buffer).is_lt() {
1178 Ordering::Less
1179 } else if probe.start.cmp(cursor, buffer).is_gt() {
1180 Ordering::Greater
1181 } else {
1182 Ordering::Equal
1183 }
1184 }) {
1185 Ok(i) | Err(i) => Some(cmp::min(i, ranges.len() - 1)),
1186 }
1187 }
1188}
1189
1190pub fn entry_label_color(selected: bool) -> Color {
1191 if selected {
1192 Color::Default
1193 } else {
1194 Color::Muted
1195 }
1196}
1197
1198pub fn entry_git_aware_label_color(
1199 git_status: Option<GitFileStatus>,
1200 ignored: bool,
1201 selected: bool,
1202) -> Color {
1203 if ignored {
1204 Color::Ignored
1205 } else {
1206 match git_status {
1207 Some(GitFileStatus::Added) => Color::Created,
1208 Some(GitFileStatus::Modified) => Color::Modified,
1209 Some(GitFileStatus::Conflict) => Color::Conflict,
1210 None => entry_label_color(selected),
1211 }
1212 }
1213}
1214
1215fn path_for_buffer<'a>(
1216 buffer: &Model<MultiBuffer>,
1217 height: usize,
1218 include_filename: bool,
1219 cx: &'a AppContext,
1220) -> Option<Cow<'a, Path>> {
1221 let file = buffer.read(cx).as_singleton()?.read(cx).file()?;
1222 path_for_file(file.as_ref(), height, include_filename, cx)
1223}
1224
1225fn path_for_file<'a>(
1226 file: &'a dyn language::File,
1227 mut height: usize,
1228 include_filename: bool,
1229 cx: &'a AppContext,
1230) -> Option<Cow<'a, Path>> {
1231 // Ensure we always render at least the filename.
1232 height += 1;
1233
1234 let mut prefix = file.path().as_ref();
1235 while height > 0 {
1236 if let Some(parent) = prefix.parent() {
1237 prefix = parent;
1238 height -= 1;
1239 } else {
1240 break;
1241 }
1242 }
1243
1244 // Here we could have just always used `full_path`, but that is very
1245 // allocation-heavy and so we try to use a `Cow<Path>` if we haven't
1246 // traversed all the way up to the worktree's root.
1247 if height > 0 {
1248 let full_path = file.full_path(cx);
1249 if include_filename {
1250 Some(full_path.into())
1251 } else {
1252 Some(full_path.parent()?.to_path_buf().into())
1253 }
1254 } else {
1255 let mut path = file.path().strip_prefix(prefix).ok()?;
1256 if !include_filename {
1257 path = path.parent()?;
1258 }
1259 Some(path.into())
1260 }
1261}
1262
1263#[cfg(test)]
1264mod tests {
1265 use super::*;
1266 use gpui::AppContext;
1267 use language::TestFile;
1268 use std::path::Path;
1269
1270 #[gpui::test]
1271 fn test_path_for_file(cx: &mut AppContext) {
1272 let file = TestFile {
1273 path: Path::new("").into(),
1274 root_name: String::new(),
1275 };
1276 assert_eq!(path_for_file(&file, 0, false, cx), None);
1277 }
1278}