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    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 smallvec::SmallVec;
  20use std::{
  21    borrow::Cow,
  22    cmp::{self, Ordering},
  23    fmt::Write,
  24    iter,
  25    ops::Range,
  26    path::{Path, PathBuf},
  27};
  28use text::Selection;
  29use util::{paths::FILE_ROW_COLUMN_DELIMITER, ResultExt, TryFutureExt};
  30use workspace::item::{BreadcrumbText, FollowableItemHandle};
  31use workspace::{
  32    item::{FollowableItem, Item, ItemEvent, ItemHandle, ProjectItem},
  33    searchable::{Direction, SearchEvent, SearchableItem, SearchableItemHandle},
  34    ItemId, ItemNavHistory, Pane, StatusItemView, ToolbarItemLocation, ViewId, Workspace,
  35    WorkspaceId,
  36};
  37
  38pub const MAX_TAB_TITLE_LEN: usize = 24;
  39
  40impl FollowableItem for Editor {
  41    fn remote_id(&self) -> Option<ViewId> {
  42        self.remote_id
  43    }
  44
  45    fn from_state_proto(
  46        pane: ViewHandle<workspace::Pane>,
  47        project: ModelHandle<Project>,
  48        remote_id: ViewId,
  49        state: &mut Option<proto::view::Variant>,
  50        cx: &mut AppContext,
  51    ) -> Option<Task<Result<ViewHandle<Self>>>> {
  52        let Some(proto::view::Variant::Editor(_)) = state else { return None };
  53        let Some(proto::view::Variant::Editor(state)) = state.take() else { unreachable!() };
  54
  55        let client = project.read(cx).client();
  56        let replica_id = project.read(cx).replica_id();
  57        let buffer_ids = state
  58            .excerpts
  59            .iter()
  60            .map(|excerpt| excerpt.buffer_id)
  61            .collect::<HashSet<_>>();
  62        let buffers = project.update(cx, |project, cx| {
  63            buffer_ids
  64                .iter()
  65                .map(|id| project.open_buffer_by_id(*id, cx))
  66                .collect::<Vec<_>>()
  67        });
  68
  69        let pane = pane.downgrade();
  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 = if let Some(editor) = editor {
  84                editor
  85            } else {
  86                pane.update(&mut cx, |_, cx| {
  87                    let multibuffer = cx.add_model(|cx| {
  88                        let mut multibuffer;
  89                        if state.singleton && buffers.len() == 1 {
  90                            multibuffer = MultiBuffer::singleton(buffers.pop().unwrap(), cx)
  91                        } else {
  92                            multibuffer = MultiBuffer::new(replica_id);
  93                            let mut excerpts = state.excerpts.into_iter().peekable();
  94                            while let Some(excerpt) = excerpts.peek() {
  95                                let buffer_id = excerpt.buffer_id;
  96                                let buffer_excerpts = iter::from_fn(|| {
  97                                    let excerpt = excerpts.peek()?;
  98                                    (excerpt.buffer_id == buffer_id)
  99                                        .then(|| excerpts.next().unwrap())
 100                                });
 101                                let buffer =
 102                                    buffers.iter().find(|b| b.read(cx).remote_id() == buffer_id);
 103                                if let Some(buffer) = buffer {
 104                                    multibuffer.push_excerpts(
 105                                        buffer.clone(),
 106                                        buffer_excerpts.filter_map(deserialize_excerpt_range),
 107                                        cx,
 108                                    );
 109                                }
 110                            }
 111                        };
 112
 113                        if let Some(title) = &state.title {
 114                            multibuffer = multibuffer.with_title(title.clone())
 115                        }
 116
 117                        multibuffer
 118                    });
 119
 120                    cx.add_view(|cx| {
 121                        let mut editor =
 122                            Editor::for_multibuffer(multibuffer, Some(project.clone()), cx);
 123                        editor.remote_id = Some(remote_id);
 124                        editor
 125                    })
 126                })?
 127            };
 128
 129            update_editor_from_message(
 130                editor.downgrade(),
 131                project,
 132                proto::update_view::Editor {
 133                    selections: state.selections,
 134                    pending_selection: state.pending_selection,
 135                    scroll_top_anchor: state.scroll_top_anchor,
 136                    scroll_x: state.scroll_x,
 137                    scroll_y: state.scroll_y,
 138                    ..Default::default()
 139                },
 140                &mut cx,
 141            )
 142            .await?;
 143
 144            Ok(editor)
 145        }))
 146    }
 147
 148    fn set_leader_replica_id(
 149        &mut self,
 150        leader_replica_id: Option<u16>,
 151        cx: &mut ViewContext<Self>,
 152    ) {
 153        self.leader_replica_id = leader_replica_id;
 154        if self.leader_replica_id.is_some() {
 155            self.buffer.update(cx, |buffer, cx| {
 156                buffer.remove_active_selections(cx);
 157            });
 158        } else {
 159            self.buffer.update(cx, |buffer, cx| {
 160                if self.focused {
 161                    buffer.set_active_selections(
 162                        &self.selections.disjoint_anchors(),
 163                        self.selections.line_mode,
 164                        self.cursor_shape,
 165                        cx,
 166                    );
 167                }
 168            });
 169        }
 170        cx.notify();
 171    }
 172
 173    fn to_state_proto(&self, cx: &AppContext) -> Option<proto::view::Variant> {
 174        let buffer = self.buffer.read(cx);
 175        let scroll_anchor = self.scroll_manager.anchor();
 176        let excerpts = buffer
 177            .read(cx)
 178            .excerpts()
 179            .map(|(id, buffer, range)| proto::Excerpt {
 180                id: id.to_proto(),
 181                buffer_id: buffer.remote_id(),
 182                context_start: Some(serialize_text_anchor(&range.context.start)),
 183                context_end: Some(serialize_text_anchor(&range.context.end)),
 184                primary_start: range
 185                    .primary
 186                    .as_ref()
 187                    .map(|range| serialize_text_anchor(&range.start)),
 188                primary_end: range
 189                    .primary
 190                    .as_ref()
 191                    .map(|range| serialize_text_anchor(&range.end)),
 192            })
 193            .collect();
 194
 195        Some(proto::view::Variant::Editor(proto::view::Editor {
 196            singleton: buffer.is_singleton(),
 197            title: (!buffer.is_singleton()).then(|| buffer.title(cx).into()),
 198            excerpts,
 199            scroll_top_anchor: Some(serialize_anchor(&scroll_anchor.top_anchor)),
 200            scroll_x: scroll_anchor.offset.x(),
 201            scroll_y: scroll_anchor.offset.y(),
 202            selections: self
 203                .selections
 204                .disjoint_anchors()
 205                .iter()
 206                .map(serialize_selection)
 207                .collect(),
 208            pending_selection: self
 209                .selections
 210                .pending_anchor()
 211                .as_ref()
 212                .map(serialize_selection),
 213        }))
 214    }
 215
 216    fn add_event_to_update_proto(
 217        &self,
 218        event: &Self::Event,
 219        update: &mut Option<proto::update_view::Variant>,
 220        cx: &AppContext,
 221    ) -> bool {
 222        let update =
 223            update.get_or_insert_with(|| proto::update_view::Variant::Editor(Default::default()));
 224
 225        match update {
 226            proto::update_view::Variant::Editor(update) => match event {
 227                Event::ExcerptsAdded {
 228                    buffer,
 229                    predecessor,
 230                    excerpts,
 231                } => {
 232                    let buffer_id = buffer.read(cx).remote_id();
 233                    let mut excerpts = excerpts.iter();
 234                    if let Some((id, range)) = excerpts.next() {
 235                        update.inserted_excerpts.push(proto::ExcerptInsertion {
 236                            previous_excerpt_id: Some(predecessor.to_proto()),
 237                            excerpt: serialize_excerpt(buffer_id, id, range),
 238                        });
 239                        update.inserted_excerpts.extend(excerpts.map(|(id, range)| {
 240                            proto::ExcerptInsertion {
 241                                previous_excerpt_id: None,
 242                                excerpt: serialize_excerpt(buffer_id, id, range),
 243                            }
 244                        }))
 245                    }
 246                    true
 247                }
 248                Event::ExcerptsRemoved { ids } => {
 249                    update
 250                        .deleted_excerpts
 251                        .extend(ids.iter().map(ExcerptId::to_proto));
 252                    true
 253                }
 254                Event::ScrollPositionChanged { .. } => {
 255                    let scroll_anchor = self.scroll_manager.anchor();
 256                    update.scroll_top_anchor = Some(serialize_anchor(&scroll_anchor.top_anchor));
 257                    update.scroll_x = scroll_anchor.offset.x();
 258                    update.scroll_y = scroll_anchor.offset.y();
 259                    true
 260                }
 261                Event::SelectionsChanged { .. } => {
 262                    update.selections = self
 263                        .selections
 264                        .disjoint_anchors()
 265                        .iter()
 266                        .map(serialize_selection)
 267                        .collect();
 268                    update.pending_selection = self
 269                        .selections
 270                        .pending_anchor()
 271                        .as_ref()
 272                        .map(serialize_selection);
 273                    true
 274                }
 275                _ => false,
 276            },
 277        }
 278    }
 279
 280    fn apply_update_proto(
 281        &mut self,
 282        project: &ModelHandle<Project>,
 283        message: update_view::Variant,
 284        cx: &mut ViewContext<Self>,
 285    ) -> Task<Result<()>> {
 286        let update_view::Variant::Editor(message) = message;
 287        let project = project.clone();
 288        cx.spawn(|this, mut cx| async move {
 289            update_editor_from_message(this, project, message, &mut cx).await
 290        })
 291    }
 292
 293    fn should_unfollow_on_event(event: &Self::Event, _: &AppContext) -> bool {
 294        match event {
 295            Event::Edited => true,
 296            Event::SelectionsChanged { local } => *local,
 297            Event::ScrollPositionChanged { local } => *local,
 298            _ => false,
 299        }
 300    }
 301}
 302
 303async fn update_editor_from_message(
 304    this: WeakViewHandle<Editor>,
 305    project: ModelHandle<Project>,
 306    message: proto::update_view::Editor,
 307    cx: &mut AsyncAppContext,
 308) -> Result<()> {
 309    // Open all of the buffers of which excerpts were added to the editor.
 310    let inserted_excerpt_buffer_ids = message
 311        .inserted_excerpts
 312        .iter()
 313        .filter_map(|insertion| Some(insertion.excerpt.as_ref()?.buffer_id))
 314        .collect::<HashSet<_>>();
 315    let inserted_excerpt_buffers = project.update(cx, |project, cx| {
 316        inserted_excerpt_buffer_ids
 317            .into_iter()
 318            .map(|id| project.open_buffer_by_id(id, cx))
 319            .collect::<Vec<_>>()
 320    });
 321    let _inserted_excerpt_buffers = try_join_all(inserted_excerpt_buffers).await?;
 322
 323    // Update the editor's excerpts.
 324    this.update(cx, |editor, cx| {
 325        editor.buffer.update(cx, |multibuffer, cx| {
 326            let mut removed_excerpt_ids = message
 327                .deleted_excerpts
 328                .into_iter()
 329                .map(ExcerptId::from_proto)
 330                .collect::<Vec<_>>();
 331            removed_excerpt_ids.sort_by({
 332                let multibuffer = multibuffer.read(cx);
 333                move |a, b| a.cmp(&b, &multibuffer)
 334            });
 335
 336            let mut insertions = message.inserted_excerpts.into_iter().peekable();
 337            while let Some(insertion) = insertions.next() {
 338                let Some(excerpt) = insertion.excerpt else { continue };
 339                let Some(previous_excerpt_id) = insertion.previous_excerpt_id else { continue };
 340                let buffer_id = excerpt.buffer_id;
 341                let Some(buffer) = project.read(cx).buffer_for_id(buffer_id, cx) else { continue };
 342
 343                let adjacent_excerpts = iter::from_fn(|| {
 344                    let insertion = insertions.peek()?;
 345                    if insertion.previous_excerpt_id.is_none()
 346                        && insertion.excerpt.as_ref()?.buffer_id == buffer_id
 347                    {
 348                        insertions.next()?.excerpt
 349                    } else {
 350                        None
 351                    }
 352                });
 353
 354                multibuffer.insert_excerpts_with_ids_after(
 355                    ExcerptId::from_proto(previous_excerpt_id),
 356                    buffer,
 357                    [excerpt]
 358                        .into_iter()
 359                        .chain(adjacent_excerpts)
 360                        .filter_map(|excerpt| {
 361                            Some((
 362                                ExcerptId::from_proto(excerpt.id),
 363                                deserialize_excerpt_range(excerpt)?,
 364                            ))
 365                        }),
 366                    cx,
 367                );
 368            }
 369
 370            multibuffer.remove_excerpts(removed_excerpt_ids, cx);
 371        });
 372    })?;
 373
 374    // Deserialize the editor state.
 375    let (selections, pending_selection, scroll_top_anchor) = this.update(cx, |editor, cx| {
 376        let buffer = editor.buffer.read(cx).read(cx);
 377        let selections = message
 378            .selections
 379            .into_iter()
 380            .filter_map(|selection| deserialize_selection(&buffer, selection))
 381            .collect::<Vec<_>>();
 382        let pending_selection = message
 383            .pending_selection
 384            .and_then(|selection| deserialize_selection(&buffer, selection));
 385        let scroll_top_anchor = message
 386            .scroll_top_anchor
 387            .and_then(|anchor| deserialize_anchor(&buffer, anchor));
 388        anyhow::Ok((selections, pending_selection, scroll_top_anchor))
 389    })??;
 390
 391    // Wait until the buffer has received all of the operations referenced by
 392    // the editor's new state.
 393    this.update(cx, |editor, cx| {
 394        editor.buffer.update(cx, |buffer, cx| {
 395            buffer.wait_for_anchors(
 396                selections
 397                    .iter()
 398                    .chain(pending_selection.as_ref())
 399                    .flat_map(|selection| [selection.start, selection.end])
 400                    .chain(scroll_top_anchor),
 401                cx,
 402            )
 403        })
 404    })?
 405    .await?;
 406
 407    // Update the editor's state.
 408    this.update(cx, |editor, cx| {
 409        if !selections.is_empty() || pending_selection.is_some() {
 410            editor.set_selections_from_remote(selections, pending_selection, cx);
 411            editor.request_autoscroll_remotely(Autoscroll::newest(), cx);
 412        } else if let Some(scroll_top_anchor) = scroll_top_anchor {
 413            editor.set_scroll_anchor_remote(
 414                ScrollAnchor {
 415                    top_anchor: scroll_top_anchor,
 416                    offset: vec2f(message.scroll_x, message.scroll_y),
 417                },
 418                cx,
 419            );
 420        }
 421    })?;
 422    Ok(())
 423}
 424
 425fn serialize_excerpt(
 426    buffer_id: u64,
 427    id: &ExcerptId,
 428    range: &ExcerptRange<language::Anchor>,
 429) -> Option<proto::Excerpt> {
 430    Some(proto::Excerpt {
 431        id: id.to_proto(),
 432        buffer_id,
 433        context_start: Some(serialize_text_anchor(&range.context.start)),
 434        context_end: Some(serialize_text_anchor(&range.context.end)),
 435        primary_start: range
 436            .primary
 437            .as_ref()
 438            .map(|r| serialize_text_anchor(&r.start)),
 439        primary_end: range
 440            .primary
 441            .as_ref()
 442            .map(|r| serialize_text_anchor(&r.end)),
 443    })
 444}
 445
 446fn serialize_selection(selection: &Selection<Anchor>) -> proto::Selection {
 447    proto::Selection {
 448        id: selection.id as u64,
 449        start: Some(serialize_anchor(&selection.start)),
 450        end: Some(serialize_anchor(&selection.end)),
 451        reversed: selection.reversed,
 452    }
 453}
 454
 455fn serialize_anchor(anchor: &Anchor) -> proto::EditorAnchor {
 456    proto::EditorAnchor {
 457        excerpt_id: anchor.excerpt_id.to_proto(),
 458        anchor: Some(serialize_text_anchor(&anchor.text_anchor)),
 459    }
 460}
 461
 462fn deserialize_excerpt_range(excerpt: proto::Excerpt) -> Option<ExcerptRange<language::Anchor>> {
 463    let context = {
 464        let start = language::proto::deserialize_anchor(excerpt.context_start?)?;
 465        let end = language::proto::deserialize_anchor(excerpt.context_end?)?;
 466        start..end
 467    };
 468    let primary = excerpt
 469        .primary_start
 470        .zip(excerpt.primary_end)
 471        .and_then(|(start, end)| {
 472            let start = language::proto::deserialize_anchor(start)?;
 473            let end = language::proto::deserialize_anchor(end)?;
 474            Some(start..end)
 475        });
 476    Some(ExcerptRange { context, primary })
 477}
 478
 479fn deserialize_selection(
 480    buffer: &MultiBufferSnapshot,
 481    selection: proto::Selection,
 482) -> Option<Selection<Anchor>> {
 483    Some(Selection {
 484        id: selection.id as usize,
 485        start: deserialize_anchor(buffer, selection.start?)?,
 486        end: deserialize_anchor(buffer, selection.end?)?,
 487        reversed: selection.reversed,
 488        goal: SelectionGoal::None,
 489    })
 490}
 491
 492fn deserialize_anchor(buffer: &MultiBufferSnapshot, anchor: proto::EditorAnchor) -> Option<Anchor> {
 493    let excerpt_id = ExcerptId::from_proto(anchor.excerpt_id);
 494    Some(Anchor {
 495        excerpt_id,
 496        text_anchor: language::proto::deserialize_anchor(anchor.anchor?)?,
 497        buffer_id: buffer.buffer_id_for_excerpt(excerpt_id),
 498    })
 499}
 500
 501impl Item for Editor {
 502    fn navigate(&mut self, data: Box<dyn std::any::Any>, cx: &mut ViewContext<Self>) -> bool {
 503        if let Ok(data) = data.downcast::<NavigationData>() {
 504            let newest_selection = self.selections.newest::<Point>(cx);
 505            let buffer = self.buffer.read(cx).read(cx);
 506            let offset = if buffer.can_resolve(&data.cursor_anchor) {
 507                data.cursor_anchor.to_point(&buffer)
 508            } else {
 509                buffer.clip_point(data.cursor_position, Bias::Left)
 510            };
 511
 512            let mut scroll_anchor = data.scroll_anchor;
 513            if !buffer.can_resolve(&scroll_anchor.top_anchor) {
 514                scroll_anchor.top_anchor = buffer.anchor_before(
 515                    buffer.clip_point(Point::new(data.scroll_top_row, 0), Bias::Left),
 516                );
 517            }
 518
 519            drop(buffer);
 520
 521            if newest_selection.head() == offset {
 522                false
 523            } else {
 524                let nav_history = self.nav_history.take();
 525                self.set_scroll_anchor(scroll_anchor, cx);
 526                self.change_selections(Some(Autoscroll::fit()), cx, |s| {
 527                    s.select_ranges([offset..offset])
 528                });
 529                self.nav_history = nav_history;
 530                true
 531            }
 532        } else {
 533            false
 534        }
 535    }
 536
 537    fn tab_tooltip_text(&self, cx: &AppContext) -> Option<Cow<str>> {
 538        let file_path = self
 539            .buffer()
 540            .read(cx)
 541            .as_singleton()?
 542            .read(cx)
 543            .file()
 544            .and_then(|f| f.as_local())?
 545            .abs_path(cx);
 546
 547        let file_path = util::paths::compact(&file_path)
 548            .to_string_lossy()
 549            .to_string();
 550
 551        Some(file_path.into())
 552    }
 553
 554    fn tab_description<'a>(&'a self, detail: usize, cx: &'a AppContext) -> Option<Cow<str>> {
 555        match path_for_buffer(&self.buffer, detail, true, cx)? {
 556            Cow::Borrowed(path) => Some(path.to_string_lossy()),
 557            Cow::Owned(path) => Some(path.to_string_lossy().to_string().into()),
 558        }
 559    }
 560
 561    fn tab_content<T: View>(
 562        &self,
 563        detail: Option<usize>,
 564        style: &theme::Tab,
 565        cx: &AppContext,
 566    ) -> AnyElement<T> {
 567        Flex::row()
 568            .with_child(Label::new(self.title(cx).to_string(), style.label.clone()).into_any())
 569            .with_children(detail.and_then(|detail| {
 570                let path = path_for_buffer(&self.buffer, detail, false, cx)?;
 571                let description = path.to_string_lossy();
 572                Some(
 573                    Label::new(
 574                        util::truncate_and_trailoff(&description, MAX_TAB_TITLE_LEN),
 575                        style.description.text.clone(),
 576                    )
 577                    .contained()
 578                    .with_style(style.description.container)
 579                    .aligned(),
 580                )
 581            }))
 582            .align_children_center()
 583            .into_any()
 584    }
 585
 586    fn for_each_project_item(&self, cx: &AppContext, f: &mut dyn FnMut(usize, &dyn project::Item)) {
 587        self.buffer
 588            .read(cx)
 589            .for_each_buffer(|buffer| f(buffer.id(), buffer.read(cx)));
 590    }
 591
 592    fn is_singleton(&self, cx: &AppContext) -> bool {
 593        self.buffer.read(cx).is_singleton()
 594    }
 595
 596    fn clone_on_split(&self, _workspace_id: WorkspaceId, cx: &mut ViewContext<Self>) -> Option<Self>
 597    where
 598        Self: Sized,
 599    {
 600        Some(self.clone(cx))
 601    }
 602
 603    fn set_nav_history(&mut self, history: ItemNavHistory, _: &mut ViewContext<Self>) {
 604        self.nav_history = Some(history);
 605    }
 606
 607    fn deactivated(&mut self, cx: &mut ViewContext<Self>) {
 608        let selection = self.selections.newest_anchor();
 609        self.push_to_nav_history(selection.head(), None, cx);
 610    }
 611
 612    fn workspace_deactivated(&mut self, cx: &mut ViewContext<Self>) {
 613        hide_link_definition(self, cx);
 614        self.link_go_to_definition_state.last_mouse_location = None;
 615    }
 616
 617    fn is_dirty(&self, cx: &AppContext) -> bool {
 618        self.buffer().read(cx).read(cx).is_dirty()
 619    }
 620
 621    fn has_conflict(&self, cx: &AppContext) -> bool {
 622        self.buffer().read(cx).read(cx).has_conflict()
 623    }
 624
 625    fn can_save(&self, cx: &AppContext) -> bool {
 626        let buffer = &self.buffer().read(cx);
 627        if let Some(buffer) = buffer.as_singleton() {
 628            buffer.read(cx).project_path(cx).is_some()
 629        } else {
 630            true
 631        }
 632    }
 633
 634    fn save(
 635        &mut self,
 636        project: ModelHandle<Project>,
 637        cx: &mut ViewContext<Self>,
 638    ) -> Task<Result<()>> {
 639        self.report_editor_event("save", None, cx);
 640        let format = self.perform_format(project.clone(), FormatTrigger::Save, cx);
 641        let buffers = self.buffer().clone().read(cx).all_buffers();
 642        cx.spawn(|_, mut cx| async move {
 643            format.await?;
 644
 645            if buffers.len() == 1 {
 646                project
 647                    .update(&mut cx, |project, cx| project.save_buffers(buffers, cx))
 648                    .await?;
 649            } else {
 650                // For multi-buffers, only save those ones that contain changes. For clean buffers
 651                // we simulate saving by calling `Buffer::did_save`, so that language servers or
 652                // other downstream listeners of save events get notified.
 653                let (dirty_buffers, clean_buffers) = buffers.into_iter().partition(|buffer| {
 654                    buffer.read_with(&cx, |buffer, _| buffer.is_dirty() || buffer.has_conflict())
 655                });
 656
 657                project
 658                    .update(&mut cx, |project, cx| {
 659                        project.save_buffers(dirty_buffers, cx)
 660                    })
 661                    .await?;
 662                for buffer in clean_buffers {
 663                    buffer.update(&mut cx, |buffer, cx| {
 664                        let version = buffer.saved_version().clone();
 665                        let fingerprint = buffer.saved_version_fingerprint();
 666                        let mtime = buffer.saved_mtime();
 667                        buffer.did_save(version, fingerprint, mtime, cx);
 668                    });
 669                }
 670            }
 671
 672            Ok(())
 673        })
 674    }
 675
 676    fn save_as(
 677        &mut self,
 678        project: ModelHandle<Project>,
 679        abs_path: PathBuf,
 680        cx: &mut ViewContext<Self>,
 681    ) -> Task<Result<()>> {
 682        let buffer = self
 683            .buffer()
 684            .read(cx)
 685            .as_singleton()
 686            .expect("cannot call save_as on an excerpt list");
 687
 688        let file_extension = abs_path
 689            .extension()
 690            .map(|a| a.to_string_lossy().to_string());
 691        self.report_editor_event("save", file_extension, cx);
 692
 693        project.update(cx, |project, cx| {
 694            project.save_buffer_as(buffer, abs_path, cx)
 695        })
 696    }
 697
 698    fn reload(
 699        &mut self,
 700        project: ModelHandle<Project>,
 701        cx: &mut ViewContext<Self>,
 702    ) -> Task<Result<()>> {
 703        let buffer = self.buffer().clone();
 704        let buffers = self.buffer.read(cx).all_buffers();
 705        let reload_buffers =
 706            project.update(cx, |project, cx| project.reload_buffers(buffers, true, cx));
 707        cx.spawn(|this, mut cx| async move {
 708            let transaction = reload_buffers.log_err().await;
 709            this.update(&mut cx, |editor, cx| {
 710                editor.request_autoscroll(Autoscroll::fit(), cx)
 711            })?;
 712            buffer.update(&mut cx, |buffer, cx| {
 713                if let Some(transaction) = transaction {
 714                    if !buffer.is_singleton() {
 715                        buffer.push_transaction(&transaction.0, cx);
 716                    }
 717                }
 718            });
 719            Ok(())
 720        })
 721    }
 722
 723    fn git_diff_recalc(
 724        &mut self,
 725        _project: ModelHandle<Project>,
 726        cx: &mut ViewContext<Self>,
 727    ) -> Task<Result<()>> {
 728        self.buffer().update(cx, |multibuffer, cx| {
 729            multibuffer.git_diff_recalc(cx);
 730        });
 731        Task::ready(Ok(()))
 732    }
 733
 734    fn to_item_events(event: &Self::Event) -> SmallVec<[ItemEvent; 2]> {
 735        let mut result = SmallVec::new();
 736        match event {
 737            Event::Closed => result.push(ItemEvent::CloseItem),
 738            Event::Saved | Event::TitleChanged => {
 739                result.push(ItemEvent::UpdateTab);
 740                result.push(ItemEvent::UpdateBreadcrumbs);
 741            }
 742            Event::Reparsed => {
 743                result.push(ItemEvent::UpdateBreadcrumbs);
 744            }
 745            Event::SelectionsChanged { local } if *local => {
 746                result.push(ItemEvent::UpdateBreadcrumbs);
 747            }
 748            Event::DirtyChanged => {
 749                result.push(ItemEvent::UpdateTab);
 750            }
 751            Event::BufferEdited => {
 752                result.push(ItemEvent::Edit);
 753                result.push(ItemEvent::UpdateBreadcrumbs);
 754            }
 755            _ => {}
 756        }
 757        result
 758    }
 759
 760    fn as_searchable(&self, handle: &ViewHandle<Self>) -> Option<Box<dyn SearchableItemHandle>> {
 761        Some(Box::new(handle.clone()))
 762    }
 763
 764    fn breadcrumb_location(&self) -> ToolbarItemLocation {
 765        ToolbarItemLocation::PrimaryLeft { flex: None }
 766    }
 767
 768    fn breadcrumbs(&self, theme: &theme::Theme, cx: &AppContext) -> Option<Vec<BreadcrumbText>> {
 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_id();
 802        self.workspace = Some((workspace.weak_handle(), workspace.database_id()));
 803
 804        fn serialize(
 805            buffer: ModelHandle<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()
 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(buffer, *workspace_id, cx.view_id(), cx);
 830                    }
 831                }
 832            })
 833            .detach();
 834        }
 835    }
 836
 837    fn serialized_item_kind() -> Option<&'static str> {
 838        Some("Editor")
 839    }
 840
 841    fn deserialize(
 842        project: ModelHandle<Project>,
 843        _workspace: WeakViewHandle<Workspace>,
 844        workspace_id: workspace::WorkspaceId,
 845        item_id: ItemId,
 846        cx: &mut ViewContext<Pane>,
 847    ) -> Task<Result<ViewHandle<Self>>> {
 848        let project_item: Result<_> = project.update(cx, |project, cx| {
 849            // Look up the path with this key associated, create a self with that path
 850            let path = DB
 851                .get_path(item_id, workspace_id)?
 852                .context("No path stored for this editor")?;
 853
 854            let (worktree, path) = project
 855                .find_local_worktree(&path, cx)
 856                .with_context(|| format!("No worktree for path: {path:?}"))?;
 857            let project_path = ProjectPath {
 858                worktree_id: worktree.read(cx).id(),
 859                path: path.into(),
 860            };
 861
 862            Ok(project.open_path(project_path, cx))
 863        });
 864
 865        project_item
 866            .map(|project_item| {
 867                cx.spawn(|pane, mut cx| async move {
 868                    let (_, project_item) = project_item.await?;
 869                    let buffer = project_item
 870                        .downcast::<Buffer>()
 871                        .context("Project item at stored path was not a buffer")?;
 872                    Ok(pane.update(&mut cx, |_, cx| {
 873                        cx.add_view(|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 ViewContext<Self>) -> AnyElement<Self> {
1117        if let Some(position) = self.position {
1118            let theme = &theme::current(cx).workspace.status_bar;
1119            let mut text = format!(
1120                "{}{FILE_ROW_COLUMN_DELIMITER}{}",
1121                position.row + 1,
1122                position.column + 1
1123            );
1124            if self.selected_count > 0 {
1125                write!(text, " ({} selected)", self.selected_count).unwrap();
1126            }
1127            Label::new(text, theme.cursor_position.clone()).into_any()
1128        } else {
1129            Empty::new().into_any()
1130        }
1131    }
1132}
1133
1134impl StatusItemView for CursorPosition {
1135    fn set_active_pane_item(
1136        &mut self,
1137        active_pane_item: Option<&dyn ItemHandle>,
1138        cx: &mut ViewContext<Self>,
1139    ) {
1140        if let Some(editor) = active_pane_item.and_then(|item| item.act_as::<Editor>(cx)) {
1141            self._observe_active_editor = Some(cx.observe(&editor, Self::update_position));
1142            self.update_position(editor, cx);
1143        } else {
1144            self.position = None;
1145            self._observe_active_editor = None;
1146        }
1147
1148        cx.notify();
1149    }
1150}
1151
1152fn path_for_buffer<'a>(
1153    buffer: &ModelHandle<MultiBuffer>,
1154    height: usize,
1155    include_filename: bool,
1156    cx: &'a AppContext,
1157) -> Option<Cow<'a, Path>> {
1158    let file = buffer.read(cx).as_singleton()?.read(cx).file()?;
1159    path_for_file(file.as_ref(), height, include_filename, cx)
1160}
1161
1162fn path_for_file<'a>(
1163    file: &'a dyn language::File,
1164    mut height: usize,
1165    include_filename: bool,
1166    cx: &'a AppContext,
1167) -> Option<Cow<'a, Path>> {
1168    // Ensure we always render at least the filename.
1169    height += 1;
1170
1171    let mut prefix = file.path().as_ref();
1172    while height > 0 {
1173        if let Some(parent) = prefix.parent() {
1174            prefix = parent;
1175            height -= 1;
1176        } else {
1177            break;
1178        }
1179    }
1180
1181    // Here we could have just always used `full_path`, but that is very
1182    // allocation-heavy and so we try to use a `Cow<Path>` if we haven't
1183    // traversed all the way up to the worktree's root.
1184    if height > 0 {
1185        let full_path = file.full_path(cx);
1186        if include_filename {
1187            Some(full_path.into())
1188        } else {
1189            Some(full_path.parent()?.to_path_buf().into())
1190        }
1191    } else {
1192        let mut path = file.path().strip_prefix(prefix).ok()?;
1193        if !include_filename {
1194            path = path.parent()?;
1195        }
1196        Some(path.into())
1197    }
1198}
1199
1200#[cfg(test)]
1201mod tests {
1202    use super::*;
1203    use gpui::AppContext;
1204    use std::{
1205        path::{Path, PathBuf},
1206        sync::Arc,
1207        time::SystemTime,
1208    };
1209
1210    #[gpui::test]
1211    fn test_path_for_file(cx: &mut AppContext) {
1212        let file = TestFile {
1213            path: Path::new("").into(),
1214            full_path: PathBuf::from(""),
1215        };
1216        assert_eq!(path_for_file(&file, 0, false, cx), None);
1217    }
1218
1219    struct TestFile {
1220        path: Arc<Path>,
1221        full_path: PathBuf,
1222    }
1223
1224    impl language::File for TestFile {
1225        fn path(&self) -> &Arc<Path> {
1226            &self.path
1227        }
1228
1229        fn full_path(&self, _: &gpui::AppContext) -> PathBuf {
1230            self.full_path.clone()
1231        }
1232
1233        fn as_local(&self) -> Option<&dyn language::LocalFile> {
1234            todo!()
1235        }
1236
1237        fn mtime(&self) -> SystemTime {
1238            todo!()
1239        }
1240
1241        fn file_name<'a>(&'a self, _: &'a gpui::AppContext) -> &'a std::ffi::OsStr {
1242            todo!()
1243        }
1244
1245        fn is_deleted(&self) -> bool {
1246            todo!()
1247        }
1248
1249        fn as_any(&self) -> &dyn std::any::Any {
1250            todo!()
1251        }
1252
1253        fn to_proto(&self) -> rpc::proto::File {
1254            todo!()
1255        }
1256    }
1257}