items.rs

   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        todo!();
 533        // if let Ok(data) = data.downcast::<NavigationData>() {
 534        //     let newest_selection = self.selections.newest::<Point>(cx);
 535        //     let buffer = self.buffer.read(cx).read(cx);
 536        //     let offset = if buffer.can_resolve(&data.cursor_anchor) {
 537        //         data.cursor_anchor.to_point(&buffer)
 538        //     } else {
 539        //         buffer.clip_point(data.cursor_position, Bias::Left)
 540        //     };
 541
 542        //     let mut scroll_anchor = data.scroll_anchor;
 543        //     if !buffer.can_resolve(&scroll_anchor.anchor) {
 544        //         scroll_anchor.anchor = buffer.anchor_before(
 545        //             buffer.clip_point(Point::new(data.scroll_top_row, 0), Bias::Left),
 546        //         );
 547        //     }
 548
 549        //     drop(buffer);
 550
 551        //     if newest_selection.head() == offset {
 552        //         false
 553        //     } else {
 554        //         let nav_history = self.nav_history.take();
 555        //         self.set_scroll_anchor(scroll_anchor, cx);
 556        //         self.change_selections(Some(Autoscroll::fit()), cx, |s| {
 557        //             s.select_ranges([offset..offset])
 558        //         });
 559        //         self.nav_history = nav_history;
 560        //         true
 561        //     }
 562        // } else {
 563        //     false
 564        // }
 565    }
 566
 567    fn tab_tooltip_text(&self, cx: &AppContext) -> Option<SharedString> {
 568        let file_path = self
 569            .buffer()
 570            .read(cx)
 571            .as_singleton()?
 572            .read(cx)
 573            .file()
 574            .and_then(|f| f.as_local())?
 575            .abs_path(cx);
 576
 577        let file_path = file_path.compact().to_string_lossy().to_string();
 578
 579        Some(file_path.into())
 580    }
 581
 582    fn tab_description<'a>(&self, detail: usize, cx: &'a AppContext) -> Option<SharedString> {
 583        let path = path_for_buffer(&self.buffer, detail, true, cx)?;
 584        Some(path.to_string_lossy().to_string().into())
 585    }
 586
 587    fn tab_content(&self, detail: Option<usize>, cx: &WindowContext) -> AnyElement {
 588        let theme = cx.theme();
 589
 590        AnyElement::new(
 591            div()
 592                .flex()
 593                .flex_row()
 594                .items_center()
 595                .gap_2()
 596                .child(Label::new(self.title(cx).to_string()))
 597                .children(detail.and_then(|detail| {
 598                    let path = path_for_buffer(&self.buffer, detail, false, cx)?;
 599                    let description = path.to_string_lossy();
 600
 601                    Some(
 602                        div().child(
 603                            Label::new(util::truncate_and_trailoff(
 604                                &description,
 605                                MAX_TAB_TITLE_LEN,
 606                            ))
 607                            .color(Color::Muted),
 608                        ),
 609                    )
 610                })),
 611        )
 612    }
 613
 614    fn for_each_project_item(
 615        &self,
 616        cx: &AppContext,
 617        f: &mut dyn FnMut(EntityId, &dyn project::Item),
 618    ) {
 619        self.buffer
 620            .read(cx)
 621            .for_each_buffer(|buffer| f(buffer.entity_id(), buffer.read(cx)));
 622    }
 623
 624    fn is_singleton(&self, cx: &AppContext) -> bool {
 625        self.buffer.read(cx).is_singleton()
 626    }
 627
 628    fn clone_on_split(
 629        &self,
 630        _workspace_id: WorkspaceId,
 631        cx: &mut ViewContext<Self>,
 632    ) -> Option<View<Editor>>
 633    where
 634        Self: Sized,
 635    {
 636        Some(cx.build_view(|cx| self.clone(cx)))
 637    }
 638
 639    fn set_nav_history(&mut self, history: ItemNavHistory, _: &mut ViewContext<Self>) {
 640        self.nav_history = Some(history);
 641    }
 642
 643    fn deactivated(&mut self, cx: &mut ViewContext<Self>) {
 644        let selection = self.selections.newest_anchor();
 645        self.push_to_nav_history(selection.head(), None, cx);
 646    }
 647
 648    fn workspace_deactivated(&mut self, cx: &mut ViewContext<Self>) {
 649        hide_link_definition(self, cx);
 650        self.link_go_to_definition_state.last_trigger_point = None;
 651    }
 652
 653    fn is_dirty(&self, cx: &AppContext) -> bool {
 654        self.buffer().read(cx).read(cx).is_dirty()
 655    }
 656
 657    fn has_conflict(&self, cx: &AppContext) -> bool {
 658        self.buffer().read(cx).read(cx).has_conflict()
 659    }
 660
 661    fn can_save(&self, cx: &AppContext) -> bool {
 662        let buffer = &self.buffer().read(cx);
 663        if let Some(buffer) = buffer.as_singleton() {
 664            buffer.read(cx).project_path(cx).is_some()
 665        } else {
 666            true
 667        }
 668    }
 669
 670    fn save(&mut self, project: Model<Project>, cx: &mut ViewContext<Self>) -> Task<Result<()>> {
 671        self.report_editor_event("save", None, cx);
 672        let format = self.perform_format(project.clone(), FormatTrigger::Save, cx);
 673        let buffers = self.buffer().clone().read(cx).all_buffers();
 674        cx.spawn(|_, mut cx| async move {
 675            format.await?;
 676
 677            if buffers.len() == 1 {
 678                project
 679                    .update(&mut cx, |project, cx| project.save_buffers(buffers, cx))?
 680                    .await?;
 681            } else {
 682                // For multi-buffers, only save those ones that contain changes. For clean buffers
 683                // we simulate saving by calling `Buffer::did_save`, so that language servers or
 684                // other downstream listeners of save events get notified.
 685                let (dirty_buffers, clean_buffers) = buffers.into_iter().partition(|buffer| {
 686                    buffer
 687                        .update(&mut cx, |buffer, _| {
 688                            buffer.is_dirty() || buffer.has_conflict()
 689                        })
 690                        .unwrap_or(false)
 691                });
 692
 693                project
 694                    .update(&mut cx, |project, cx| {
 695                        project.save_buffers(dirty_buffers, cx)
 696                    })?
 697                    .await?;
 698                for buffer in clean_buffers {
 699                    buffer.update(&mut cx, |buffer, cx| {
 700                        let version = buffer.saved_version().clone();
 701                        let fingerprint = buffer.saved_version_fingerprint();
 702                        let mtime = buffer.saved_mtime();
 703                        buffer.did_save(version, fingerprint, mtime, cx);
 704                    });
 705                }
 706            }
 707
 708            Ok(())
 709        })
 710    }
 711
 712    fn save_as(
 713        &mut self,
 714        project: Model<Project>,
 715        abs_path: PathBuf,
 716        cx: &mut ViewContext<Self>,
 717    ) -> Task<Result<()>> {
 718        let buffer = self
 719            .buffer()
 720            .read(cx)
 721            .as_singleton()
 722            .expect("cannot call save_as on an excerpt list");
 723
 724        let file_extension = abs_path
 725            .extension()
 726            .map(|a| a.to_string_lossy().to_string());
 727        self.report_editor_event("save", file_extension, cx);
 728
 729        project.update(cx, |project, cx| {
 730            project.save_buffer_as(buffer, abs_path, cx)
 731        })
 732    }
 733
 734    fn reload(&mut self, project: Model<Project>, cx: &mut ViewContext<Self>) -> Task<Result<()>> {
 735        let buffer = self.buffer().clone();
 736        let buffers = self.buffer.read(cx).all_buffers();
 737        let reload_buffers =
 738            project.update(cx, |project, cx| project.reload_buffers(buffers, true, cx));
 739        cx.spawn(|this, mut cx| async move {
 740            let transaction = reload_buffers.log_err().await;
 741            this.update(&mut cx, |editor, cx| {
 742                editor.request_autoscroll(Autoscroll::fit(), cx)
 743            })?;
 744            buffer.update(&mut cx, |buffer, cx| {
 745                if let Some(transaction) = transaction {
 746                    if !buffer.is_singleton() {
 747                        buffer.push_transaction(&transaction.0, cx);
 748                    }
 749                }
 750            });
 751            Ok(())
 752        })
 753    }
 754
 755    fn as_searchable(&self, handle: &View<Self>) -> Option<Box<dyn SearchableItemHandle>> {
 756        Some(Box::new(handle.clone()))
 757    }
 758
 759    fn pixel_position_of_cursor(&self, _: &AppContext) -> Option<gpui::Point<Pixels>> {
 760        self.pixel_position_of_newest_cursor
 761    }
 762
 763    fn breadcrumb_location(&self) -> ToolbarItemLocation {
 764        ToolbarItemLocation::PrimaryLeft
 765    }
 766
 767    fn breadcrumbs(&self, variant: &Theme, cx: &AppContext) -> Option<Vec<BreadcrumbText>> {
 768        todo!();
 769        // let cursor = self.selections.newest_anchor().head();
 770        // let multibuffer = &self.buffer().read(cx);
 771        // let (buffer_id, symbols) =
 772        //     multibuffer.symbols_containing(cursor, Some(&theme.editor.syntax), cx)?;
 773        // let buffer = multibuffer.buffer(buffer_id)?;
 774
 775        // let buffer = buffer.read(cx);
 776        // let filename = buffer
 777        //     .snapshot()
 778        //     .resolve_file_path(
 779        //         cx,
 780        //         self.project
 781        //             .as_ref()
 782        //             .map(|project| project.read(cx).visible_worktrees(cx).count() > 1)
 783        //             .unwrap_or_default(),
 784        //     )
 785        //     .map(|path| path.to_string_lossy().to_string())
 786        //     .unwrap_or_else(|| "untitled".to_string());
 787
 788        // let mut breadcrumbs = vec![BreadcrumbText {
 789        //     text: filename,
 790        //     highlights: None,
 791        // }];
 792        // breadcrumbs.extend(symbols.into_iter().map(|symbol| BreadcrumbText {
 793        //     text: symbol.text,
 794        //     highlights: Some(symbol.highlight_ranges),
 795        // }));
 796        // Some(breadcrumbs)
 797    }
 798
 799    fn added_to_workspace(&mut self, workspace: &mut Workspace, cx: &mut ViewContext<Self>) {
 800        let workspace_id = workspace.database_id();
 801        let item_id = cx.view().item_id().as_u64() as ItemId;
 802        self.workspace = Some((workspace.weak_handle(), workspace.database_id()));
 803
 804        fn serialize(
 805            buffer: Model<Buffer>,
 806            workspace_id: WorkspaceId,
 807            item_id: ItemId,
 808            cx: &mut AppContext,
 809        ) {
 810            if let Some(file) = buffer.read(cx).file().and_then(|file| file.as_local()) {
 811                let path = file.abs_path(cx);
 812
 813                cx.background_executor()
 814                    .spawn(async move {
 815                        DB.save_path(item_id, workspace_id, path.clone())
 816                            .await
 817                            .log_err()
 818                    })
 819                    .detach();
 820            }
 821        }
 822
 823        if let Some(buffer) = self.buffer().read(cx).as_singleton() {
 824            serialize(buffer.clone(), workspace_id, item_id, cx);
 825
 826            cx.subscribe(&buffer, |this, buffer, event, cx| {
 827                if let Some((_, workspace_id)) = this.workspace.as_ref() {
 828                    if let language::Event::FileHandleChanged = event {
 829                        serialize(
 830                            buffer,
 831                            *workspace_id,
 832                            cx.view().item_id().as_u64() as ItemId,
 833                            cx,
 834                        );
 835                    }
 836                }
 837            })
 838            .detach();
 839        }
 840    }
 841
 842    fn serialized_item_kind() -> Option<&'static str> {
 843        Some("Editor")
 844    }
 845
 846    fn deserialize(
 847        project: Model<Project>,
 848        _workspace: WeakView<Workspace>,
 849        workspace_id: workspace::WorkspaceId,
 850        item_id: ItemId,
 851        cx: &mut ViewContext<Pane>,
 852    ) -> Task<Result<View<Self>>> {
 853        let project_item: Result<_> = project.update(cx, |project, cx| {
 854            // Look up the path with this key associated, create a self with that path
 855            let path = DB
 856                .get_path(item_id, workspace_id)?
 857                .context("No path stored for this editor")?;
 858
 859            let (worktree, path) = project
 860                .find_local_worktree(&path, cx)
 861                .with_context(|| format!("No worktree for path: {path:?}"))?;
 862            let project_path = ProjectPath {
 863                worktree_id: worktree.read(cx).id(),
 864                path: path.into(),
 865            };
 866
 867            Ok(project.open_path(project_path, cx))
 868        });
 869
 870        project_item
 871            .map(|project_item| {
 872                cx.spawn(|pane, mut cx| async move {
 873                    let (_, project_item) = project_item.await?;
 874                    let buffer = project_item
 875                        .downcast::<Buffer>()
 876                        .map_err(|_| anyhow!("Project item at stored path was not a buffer"))?;
 877                    Ok(pane.update(&mut cx, |_, cx| {
 878                        cx.build_view(|cx| {
 879                            let mut editor = Editor::for_buffer(buffer, Some(project), cx);
 880
 881                            editor.read_scroll_position_from_db(item_id, workspace_id, cx);
 882                            editor
 883                        })
 884                    })?)
 885                })
 886            })
 887            .unwrap_or_else(|error| Task::ready(Err(error)))
 888    }
 889}
 890
 891impl ProjectItem for Editor {
 892    type Item = Buffer;
 893
 894    fn for_project_item(
 895        project: Model<Project>,
 896        buffer: Model<Buffer>,
 897        cx: &mut ViewContext<Self>,
 898    ) -> Self {
 899        Self::for_buffer(buffer, Some(project), cx)
 900    }
 901}
 902
 903impl EventEmitter<SearchEvent> for Editor {}
 904
 905pub(crate) enum BufferSearchHighlights {}
 906impl SearchableItem for Editor {
 907    type Match = Range<Anchor>;
 908
 909    fn clear_matches(&mut self, cx: &mut ViewContext<Self>) {
 910        self.clear_background_highlights::<BufferSearchHighlights>(cx);
 911    }
 912
 913    fn update_matches(&mut self, matches: Vec<Range<Anchor>>, cx: &mut ViewContext<Self>) {
 914        self.highlight_background::<BufferSearchHighlights>(
 915            matches,
 916            |theme| theme.title_bar_background, // todo: update theme
 917            cx,
 918        );
 919    }
 920
 921    fn query_suggestion(&mut self, cx: &mut ViewContext<Self>) -> String {
 922        let setting = EditorSettings::get_global(cx).seed_search_query_from_cursor;
 923        let snapshot = &self.snapshot(cx).buffer_snapshot;
 924        let selection = self.selections.newest::<usize>(cx);
 925
 926        match setting {
 927            SeedQuerySetting::Never => String::new(),
 928            SeedQuerySetting::Selection | SeedQuerySetting::Always if !selection.is_empty() => {
 929                snapshot
 930                    .text_for_range(selection.start..selection.end)
 931                    .collect()
 932            }
 933            SeedQuerySetting::Selection => String::new(),
 934            SeedQuerySetting::Always => {
 935                let (range, kind) = snapshot.surrounding_word(selection.start);
 936                if kind == Some(CharKind::Word) {
 937                    let text: String = snapshot.text_for_range(range).collect();
 938                    if !text.trim().is_empty() {
 939                        return text;
 940                    }
 941                }
 942                String::new()
 943            }
 944        }
 945    }
 946
 947    fn activate_match(
 948        &mut self,
 949        index: usize,
 950        matches: Vec<Range<Anchor>>,
 951        cx: &mut ViewContext<Self>,
 952    ) {
 953        self.unfold_ranges([matches[index].clone()], false, true, cx);
 954        let range = self.range_for_match(&matches[index]);
 955        self.change_selections(Some(Autoscroll::fit()), cx, |s| {
 956            s.select_ranges([range]);
 957        })
 958    }
 959
 960    fn select_matches(&mut self, matches: Vec<Self::Match>, cx: &mut ViewContext<Self>) {
 961        self.unfold_ranges(matches.clone(), false, false, cx);
 962        let mut ranges = Vec::new();
 963        for m in &matches {
 964            ranges.push(self.range_for_match(&m))
 965        }
 966        self.change_selections(None, cx, |s| s.select_ranges(ranges));
 967    }
 968    fn replace(
 969        &mut self,
 970        identifier: &Self::Match,
 971        query: &SearchQuery,
 972        cx: &mut ViewContext<Self>,
 973    ) {
 974        let text = self.buffer.read(cx);
 975        let text = text.snapshot(cx);
 976        let text = text.text_for_range(identifier.clone()).collect::<Vec<_>>();
 977        let text: Cow<_> = if text.len() == 1 {
 978            text.first().cloned().unwrap().into()
 979        } else {
 980            let joined_chunks = text.join("");
 981            joined_chunks.into()
 982        };
 983
 984        if let Some(replacement) = query.replacement_for(&text) {
 985            self.transact(cx, |this, cx| {
 986                this.edit([(identifier.clone(), Arc::from(&*replacement))], cx);
 987            });
 988        }
 989    }
 990    fn match_index_for_direction(
 991        &mut self,
 992        matches: &Vec<Range<Anchor>>,
 993        current_index: usize,
 994        direction: Direction,
 995        count: usize,
 996        cx: &mut ViewContext<Self>,
 997    ) -> usize {
 998        let buffer = self.buffer().read(cx).snapshot(cx);
 999        let current_index_position = if self.selections.disjoint_anchors().len() == 1 {
1000            self.selections.newest_anchor().head()
1001        } else {
1002            matches[current_index].start
1003        };
1004
1005        let mut count = count % matches.len();
1006        if count == 0 {
1007            return current_index;
1008        }
1009        match direction {
1010            Direction::Next => {
1011                if matches[current_index]
1012                    .start
1013                    .cmp(&current_index_position, &buffer)
1014                    .is_gt()
1015                {
1016                    count = count - 1
1017                }
1018
1019                (current_index + count) % matches.len()
1020            }
1021            Direction::Prev => {
1022                if matches[current_index]
1023                    .end
1024                    .cmp(&current_index_position, &buffer)
1025                    .is_lt()
1026                {
1027                    count = count - 1;
1028                }
1029
1030                if current_index >= count {
1031                    current_index - count
1032                } else {
1033                    matches.len() - (count - current_index)
1034                }
1035            }
1036        }
1037    }
1038
1039    fn find_matches(
1040        &mut self,
1041        query: Arc<project::search::SearchQuery>,
1042        cx: &mut ViewContext<Self>,
1043    ) -> Task<Vec<Range<Anchor>>> {
1044        let buffer = self.buffer().read(cx).snapshot(cx);
1045        cx.background_executor().spawn(async move {
1046            let mut ranges = Vec::new();
1047            if let Some((_, _, excerpt_buffer)) = buffer.as_singleton() {
1048                ranges.extend(
1049                    query
1050                        .search(excerpt_buffer, None)
1051                        .await
1052                        .into_iter()
1053                        .map(|range| {
1054                            buffer.anchor_after(range.start)..buffer.anchor_before(range.end)
1055                        }),
1056                );
1057            } else {
1058                for excerpt in buffer.excerpt_boundaries_in_range(0..buffer.len()) {
1059                    let excerpt_range = excerpt.range.context.to_offset(&excerpt.buffer);
1060                    ranges.extend(
1061                        query
1062                            .search(&excerpt.buffer, Some(excerpt_range.clone()))
1063                            .await
1064                            .into_iter()
1065                            .map(|range| {
1066                                let start = excerpt
1067                                    .buffer
1068                                    .anchor_after(excerpt_range.start + range.start);
1069                                let end = excerpt
1070                                    .buffer
1071                                    .anchor_before(excerpt_range.start + range.end);
1072                                buffer.anchor_in_excerpt(excerpt.id.clone(), start)
1073                                    ..buffer.anchor_in_excerpt(excerpt.id.clone(), end)
1074                            }),
1075                    );
1076                }
1077            }
1078            ranges
1079        })
1080    }
1081
1082    fn active_match_index(
1083        &mut self,
1084        matches: Vec<Range<Anchor>>,
1085        cx: &mut ViewContext<Self>,
1086    ) -> Option<usize> {
1087        active_match_index(
1088            &matches,
1089            &self.selections.newest_anchor().head(),
1090            &self.buffer().read(cx).snapshot(cx),
1091        )
1092    }
1093}
1094
1095pub fn active_match_index(
1096    ranges: &[Range<Anchor>],
1097    cursor: &Anchor,
1098    buffer: &MultiBufferSnapshot,
1099) -> Option<usize> {
1100    if ranges.is_empty() {
1101        None
1102    } else {
1103        match ranges.binary_search_by(|probe| {
1104            if probe.end.cmp(cursor, &*buffer).is_lt() {
1105                Ordering::Less
1106            } else if probe.start.cmp(cursor, &*buffer).is_gt() {
1107                Ordering::Greater
1108            } else {
1109                Ordering::Equal
1110            }
1111        }) {
1112            Ok(i) | Err(i) => Some(cmp::min(i, ranges.len() - 1)),
1113        }
1114    }
1115}
1116
1117pub struct CursorPosition {
1118    position: Option<Point>,
1119    selected_count: usize,
1120    _observe_active_editor: Option<Subscription>,
1121}
1122
1123// impl Default for CursorPosition {
1124//     fn default() -> Self {
1125//         Self::new()
1126//     }
1127// }
1128
1129// impl CursorPosition {
1130//     pub fn new() -> Self {
1131//         Self {
1132//             position: None,
1133//             selected_count: 0,
1134//             _observe_active_editor: None,
1135//         }
1136//     }
1137
1138//     fn update_position(&mut self, editor: View<Editor>, cx: &mut ViewContext<Self>) {
1139//         let editor = editor.read(cx);
1140//         let buffer = editor.buffer().read(cx).snapshot(cx);
1141
1142//         self.selected_count = 0;
1143//         let mut last_selection: Option<Selection<usize>> = None;
1144//         for selection in editor.selections.all::<usize>(cx) {
1145//             self.selected_count += selection.end - selection.start;
1146//             if last_selection
1147//                 .as_ref()
1148//                 .map_or(true, |last_selection| selection.id > last_selection.id)
1149//             {
1150//                 last_selection = Some(selection);
1151//             }
1152//         }
1153//         self.position = last_selection.map(|s| s.head().to_point(&buffer));
1154
1155//         cx.notify();
1156//     }
1157// }
1158
1159// impl Entity for CursorPosition {
1160//     type Event = ();
1161// }
1162
1163// impl View for CursorPosition {
1164//     fn ui_name() -> &'static str {
1165//         "CursorPosition"
1166//     }
1167
1168//     fn render(&mut self, cx: &mut ViewContext<Self>) -> AnyElement<Self> {
1169//         if let Some(position) = self.position {
1170//             let theme = &theme::current(cx).workspace.status_bar;
1171//             let mut text = format!(
1172//                 "{}{FILE_ROW_COLUMN_DELIMITER}{}",
1173//                 position.row + 1,
1174//                 position.column + 1
1175//             );
1176//             if self.selected_count > 0 {
1177//                 write!(text, " ({} selected)", self.selected_count).unwrap();
1178//             }
1179//             Label::new(text, theme.cursor_position.clone()).into_any()
1180//         } else {
1181//             Empty::new().into_any()
1182//         }
1183//     }
1184// }
1185
1186// impl StatusItemView for CursorPosition {
1187//     fn set_active_pane_item(
1188//         &mut self,
1189//         active_pane_item: Option<&dyn ItemHandle>,
1190//         cx: &mut ViewContext<Self>,
1191//     ) {
1192//         if let Some(editor) = active_pane_item.and_then(|item| item.act_as::<Editor>(cx)) {
1193//             self._observe_active_editor = Some(cx.observe(&editor, Self::update_position));
1194//             self.update_position(editor, cx);
1195//         } else {
1196//             self.position = None;
1197//             self._observe_active_editor = None;
1198//         }
1199
1200//         cx.notify();
1201//     }
1202// }
1203
1204fn path_for_buffer<'a>(
1205    buffer: &Model<MultiBuffer>,
1206    height: usize,
1207    include_filename: bool,
1208    cx: &'a AppContext,
1209) -> Option<Cow<'a, Path>> {
1210    let file = buffer.read(cx).as_singleton()?.read(cx).file()?;
1211    path_for_file(file.as_ref(), height, include_filename, cx)
1212}
1213
1214fn path_for_file<'a>(
1215    file: &'a dyn language::File,
1216    mut height: usize,
1217    include_filename: bool,
1218    cx: &'a AppContext,
1219) -> Option<Cow<'a, Path>> {
1220    // Ensure we always render at least the filename.
1221    height += 1;
1222
1223    let mut prefix = file.path().as_ref();
1224    while height > 0 {
1225        if let Some(parent) = prefix.parent() {
1226            prefix = parent;
1227            height -= 1;
1228        } else {
1229            break;
1230        }
1231    }
1232
1233    // Here we could have just always used `full_path`, but that is very
1234    // allocation-heavy and so we try to use a `Cow<Path>` if we haven't
1235    // traversed all the way up to the worktree's root.
1236    if height > 0 {
1237        let full_path = file.full_path(cx);
1238        if include_filename {
1239            Some(full_path.into())
1240        } else {
1241            Some(full_path.parent()?.to_path_buf().into())
1242        }
1243    } else {
1244        let mut path = file.path().strip_prefix(prefix).ok()?;
1245        if !include_filename {
1246            path = path.parent()?;
1247        }
1248        Some(path.into())
1249    }
1250}
1251
1252#[cfg(test)]
1253mod tests {
1254    use super::*;
1255    use gpui::AppContext;
1256    use std::{
1257        path::{Path, PathBuf},
1258        sync::Arc,
1259        time::SystemTime,
1260    };
1261
1262    #[gpui::test]
1263    fn test_path_for_file(cx: &mut AppContext) {
1264        let file = TestFile {
1265            path: Path::new("").into(),
1266            full_path: PathBuf::from(""),
1267        };
1268        assert_eq!(path_for_file(&file, 0, false, cx), None);
1269    }
1270
1271    struct TestFile {
1272        path: Arc<Path>,
1273        full_path: PathBuf,
1274    }
1275
1276    impl language::File for TestFile {
1277        fn path(&self) -> &Arc<Path> {
1278            &self.path
1279        }
1280
1281        fn full_path(&self, _: &gpui::AppContext) -> PathBuf {
1282            self.full_path.clone()
1283        }
1284
1285        fn as_local(&self) -> Option<&dyn language::LocalFile> {
1286            unimplemented!()
1287        }
1288
1289        fn mtime(&self) -> SystemTime {
1290            unimplemented!()
1291        }
1292
1293        fn file_name<'a>(&'a self, _: &'a gpui::AppContext) -> &'a std::ffi::OsStr {
1294            unimplemented!()
1295        }
1296
1297        fn worktree_id(&self) -> usize {
1298            0
1299        }
1300
1301        fn is_deleted(&self) -> bool {
1302            unimplemented!()
1303        }
1304
1305        fn as_any(&self) -> &dyn std::any::Any {
1306            unimplemented!()
1307        }
1308
1309        fn to_proto(&self) -> rpc::proto::File {
1310            unimplemented!()
1311        }
1312    }
1313}