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