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