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