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