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::{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).into(), 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                        if description.len() > MAX_TAB_TITLE_LEN {
 542                            description[..MAX_TAB_TITLE_LEN].to_string() + "…"
 543                        } else {
 544                            description.into()
 545                        },
 546                        style.description.text.clone(),
 547                    )
 548                    .contained()
 549                    .with_style(style.description.container)
 550                    .aligned()
 551                    .boxed(),
 552                )
 553            }))
 554            .boxed()
 555    }
 556
 557    fn for_each_project_item(&self, cx: &AppContext, f: &mut dyn FnMut(usize, &dyn project::Item)) {
 558        self.buffer
 559            .read(cx)
 560            .for_each_buffer(|buffer| f(buffer.id(), buffer.read(cx)));
 561    }
 562
 563    fn is_singleton(&self, cx: &AppContext) -> bool {
 564        self.buffer.read(cx).is_singleton()
 565    }
 566
 567    fn clone_on_split(&self, _workspace_id: WorkspaceId, cx: &mut ViewContext<Self>) -> Option<Self>
 568    where
 569        Self: Sized,
 570    {
 571        Some(self.clone(cx))
 572    }
 573
 574    fn set_nav_history(&mut self, history: ItemNavHistory, _: &mut ViewContext<Self>) {
 575        self.nav_history = Some(history);
 576    }
 577
 578    fn deactivated(&mut self, cx: &mut ViewContext<Self>) {
 579        let selection = self.selections.newest_anchor();
 580        self.push_to_nav_history(selection.head(), None, cx);
 581    }
 582
 583    fn workspace_deactivated(&mut self, cx: &mut ViewContext<Self>) {
 584        hide_link_definition(self, cx);
 585        self.link_go_to_definition_state.last_mouse_location = None;
 586    }
 587
 588    fn is_dirty(&self, cx: &AppContext) -> bool {
 589        self.buffer().read(cx).read(cx).is_dirty()
 590    }
 591
 592    fn has_conflict(&self, cx: &AppContext) -> bool {
 593        self.buffer().read(cx).read(cx).has_conflict()
 594    }
 595
 596    fn can_save(&self, cx: &AppContext) -> bool {
 597        let buffer = &self.buffer().read(cx);
 598        if let Some(buffer) = buffer.as_singleton() {
 599            buffer.read(cx).project_path(cx).is_some()
 600        } else {
 601            true
 602        }
 603    }
 604
 605    fn save(
 606        &mut self,
 607        project: ModelHandle<Project>,
 608        cx: &mut ViewContext<Self>,
 609    ) -> Task<Result<()>> {
 610        self.report_event("save editor", cx);
 611        let format = self.perform_format(project.clone(), cx);
 612        let buffers = self.buffer().clone().read(cx).all_buffers();
 613        cx.spawn(|_, mut cx| async move {
 614            format.await?;
 615            cx.update(|cx| Project::save_buffers(buffers, cx)).await?;
 616            Ok(())
 617        })
 618    }
 619
 620    fn save_as(
 621        &mut self,
 622        project: ModelHandle<Project>,
 623        abs_path: PathBuf,
 624        cx: &mut ViewContext<Self>,
 625    ) -> Task<Result<()>> {
 626        let buffer = self
 627            .buffer()
 628            .read(cx)
 629            .as_singleton()
 630            .expect("cannot call save_as on an excerpt list");
 631
 632        project.update(cx, |project, cx| {
 633            project.save_buffer_as(buffer, abs_path, cx)
 634        })
 635    }
 636
 637    fn reload(
 638        &mut self,
 639        project: ModelHandle<Project>,
 640        cx: &mut ViewContext<Self>,
 641    ) -> Task<Result<()>> {
 642        let buffer = self.buffer().clone();
 643        let buffers = self.buffer.read(cx).all_buffers();
 644        let reload_buffers =
 645            project.update(cx, |project, cx| project.reload_buffers(buffers, true, cx));
 646        cx.spawn(|this, mut cx| async move {
 647            let transaction = reload_buffers.log_err().await;
 648            this.update(&mut cx, |editor, cx| {
 649                editor.request_autoscroll(Autoscroll::fit(), cx)
 650            });
 651            buffer.update(&mut cx, |buffer, _| {
 652                if let Some(transaction) = transaction {
 653                    if !buffer.is_singleton() {
 654                        buffer.push_transaction(&transaction.0);
 655                    }
 656                }
 657            });
 658            Ok(())
 659        })
 660    }
 661
 662    fn git_diff_recalc(
 663        &mut self,
 664        _project: ModelHandle<Project>,
 665        cx: &mut ViewContext<Self>,
 666    ) -> Task<Result<()>> {
 667        self.buffer().update(cx, |multibuffer, cx| {
 668            multibuffer.git_diff_recalc(cx);
 669        });
 670        Task::ready(Ok(()))
 671    }
 672
 673    fn to_item_events(event: &Self::Event) -> SmallVec<[ItemEvent; 2]> {
 674        let mut result = SmallVec::new();
 675        match event {
 676            Event::Closed => result.push(ItemEvent::CloseItem),
 677            Event::Saved | Event::TitleChanged => {
 678                result.push(ItemEvent::UpdateTab);
 679                result.push(ItemEvent::UpdateBreadcrumbs);
 680            }
 681            Event::Reparsed => {
 682                result.push(ItemEvent::UpdateBreadcrumbs);
 683            }
 684            Event::SelectionsChanged { local } if *local => {
 685                result.push(ItemEvent::UpdateBreadcrumbs);
 686            }
 687            Event::DirtyChanged => {
 688                result.push(ItemEvent::UpdateTab);
 689            }
 690            Event::BufferEdited => {
 691                result.push(ItemEvent::Edit);
 692                result.push(ItemEvent::UpdateBreadcrumbs);
 693            }
 694            _ => {}
 695        }
 696        result
 697    }
 698
 699    fn as_searchable(&self, handle: &ViewHandle<Self>) -> Option<Box<dyn SearchableItemHandle>> {
 700        Some(Box::new(handle.clone()))
 701    }
 702
 703    fn breadcrumb_location(&self) -> ToolbarItemLocation {
 704        ToolbarItemLocation::PrimaryLeft { flex: None }
 705    }
 706
 707    fn breadcrumbs(&self, theme: &theme::Theme, cx: &AppContext) -> Option<Vec<ElementBox>> {
 708        let cursor = self.selections.newest_anchor().head();
 709        let multibuffer = &self.buffer().read(cx);
 710        let (buffer_id, symbols) =
 711            multibuffer.symbols_containing(cursor, Some(&theme.editor.syntax), cx)?;
 712        let buffer = multibuffer.buffer(buffer_id)?;
 713
 714        let buffer = buffer.read(cx);
 715        let filename = buffer
 716            .snapshot()
 717            .resolve_file_path(
 718                cx,
 719                self.project
 720                    .as_ref()
 721                    .map(|project| project.read(cx).visible_worktrees(cx).count() > 1)
 722                    .unwrap_or_default(),
 723            )
 724            .map(|path| path.to_string_lossy().to_string())
 725            .unwrap_or_else(|| "untitled".to_string());
 726
 727        let mut breadcrumbs = vec![Label::new(filename, theme.breadcrumbs.text.clone()).boxed()];
 728        breadcrumbs.extend(symbols.into_iter().map(|symbol| {
 729            Text::new(symbol.text, theme.breadcrumbs.text.clone())
 730                .with_highlights(symbol.highlight_ranges)
 731                .boxed()
 732        }));
 733        Some(breadcrumbs)
 734    }
 735
 736    fn added_to_workspace(&mut self, workspace: &mut Workspace, cx: &mut ViewContext<Self>) {
 737        let workspace_id = workspace.database_id();
 738        let item_id = cx.view_id();
 739        self.workspace_id = Some(workspace_id);
 740
 741        fn serialize(
 742            buffer: ModelHandle<Buffer>,
 743            workspace_id: WorkspaceId,
 744            item_id: ItemId,
 745            cx: &mut MutableAppContext,
 746        ) {
 747            if let Some(file) = buffer.read(cx).file().and_then(|file| file.as_local()) {
 748                let path = file.abs_path(cx);
 749
 750                cx.background()
 751                    .spawn(async move {
 752                        DB.save_path(item_id, workspace_id, path.clone())
 753                            .await
 754                            .log_err()
 755                    })
 756                    .detach();
 757            }
 758        }
 759
 760        if let Some(buffer) = self.buffer().read(cx).as_singleton() {
 761            serialize(buffer.clone(), workspace_id, item_id, cx);
 762
 763            cx.subscribe(&buffer, |this, buffer, event, cx| {
 764                if let Some(workspace_id) = this.workspace_id {
 765                    if let language::Event::FileHandleChanged = event {
 766                        serialize(buffer, workspace_id, cx.view_id(), cx);
 767                    }
 768                }
 769            })
 770            .detach();
 771        }
 772    }
 773
 774    fn serialized_item_kind() -> Option<&'static str> {
 775        Some("Editor")
 776    }
 777
 778    fn deserialize(
 779        project: ModelHandle<Project>,
 780        _workspace: WeakViewHandle<Workspace>,
 781        workspace_id: workspace::WorkspaceId,
 782        item_id: ItemId,
 783        cx: &mut ViewContext<Pane>,
 784    ) -> Task<Result<ViewHandle<Self>>> {
 785        let project_item: Result<_> = project.update(cx, |project, cx| {
 786            // Look up the path with this key associated, create a self with that path
 787            let path = DB
 788                .get_path(item_id, workspace_id)?
 789                .context("No path stored for this editor")?;
 790
 791            let (worktree, path) = project
 792                .find_local_worktree(&path, cx)
 793                .with_context(|| format!("No worktree for path: {path:?}"))?;
 794            let project_path = ProjectPath {
 795                worktree_id: worktree.read(cx).id(),
 796                path: path.into(),
 797            };
 798
 799            Ok(project.open_path(project_path, cx))
 800        });
 801
 802        project_item
 803            .map(|project_item| {
 804                cx.spawn(|pane, mut cx| async move {
 805                    let (_, project_item) = project_item.await?;
 806                    let buffer = project_item
 807                        .downcast::<Buffer>()
 808                        .context("Project item at stored path was not a buffer")?;
 809
 810                    Ok(cx.update(|cx| {
 811                        cx.add_view(pane, |cx| {
 812                            let mut editor = Editor::for_buffer(buffer, Some(project), cx);
 813                            editor.read_scroll_position_from_db(item_id, workspace_id, cx);
 814                            editor
 815                        })
 816                    }))
 817                })
 818            })
 819            .unwrap_or_else(|error| Task::ready(Err(error)))
 820    }
 821}
 822
 823impl ProjectItem for Editor {
 824    type Item = Buffer;
 825
 826    fn for_project_item(
 827        project: ModelHandle<Project>,
 828        buffer: ModelHandle<Buffer>,
 829        cx: &mut ViewContext<Self>,
 830    ) -> Self {
 831        Self::for_buffer(buffer, Some(project), cx)
 832    }
 833}
 834
 835enum BufferSearchHighlights {}
 836impl SearchableItem for Editor {
 837    type Match = Range<Anchor>;
 838
 839    fn to_search_event(event: &Self::Event) -> Option<SearchEvent> {
 840        match event {
 841            Event::BufferEdited => Some(SearchEvent::MatchesInvalidated),
 842            Event::SelectionsChanged { .. } => Some(SearchEvent::ActiveMatchChanged),
 843            _ => None,
 844        }
 845    }
 846
 847    fn clear_matches(&mut self, cx: &mut ViewContext<Self>) {
 848        self.clear_background_highlights::<BufferSearchHighlights>(cx);
 849    }
 850
 851    fn update_matches(&mut self, matches: Vec<Range<Anchor>>, cx: &mut ViewContext<Self>) {
 852        self.highlight_background::<BufferSearchHighlights>(
 853            matches,
 854            |theme| theme.search.match_background,
 855            cx,
 856        );
 857    }
 858
 859    fn query_suggestion(&mut self, cx: &mut ViewContext<Self>) -> String {
 860        let display_map = self.snapshot(cx).display_snapshot;
 861        let selection = self.selections.newest::<usize>(cx);
 862        if selection.start == selection.end {
 863            let point = selection.start.to_display_point(&display_map);
 864            let range = surrounding_word(&display_map, point);
 865            let range = range.start.to_offset(&display_map, Bias::Left)
 866                ..range.end.to_offset(&display_map, Bias::Right);
 867            let text: String = display_map.buffer_snapshot.text_for_range(range).collect();
 868            if text.trim().is_empty() {
 869                String::new()
 870            } else {
 871                text
 872            }
 873        } else {
 874            display_map
 875                .buffer_snapshot
 876                .text_for_range(selection.start..selection.end)
 877                .collect()
 878        }
 879    }
 880
 881    fn activate_match(
 882        &mut self,
 883        index: usize,
 884        matches: Vec<Range<Anchor>>,
 885        cx: &mut ViewContext<Self>,
 886    ) {
 887        self.unfold_ranges([matches[index].clone()], false, cx);
 888        self.change_selections(Some(Autoscroll::fit()), cx, |s| {
 889            s.select_ranges([matches[index].clone()])
 890        });
 891    }
 892
 893    fn match_index_for_direction(
 894        &mut self,
 895        matches: &Vec<Range<Anchor>>,
 896        mut current_index: usize,
 897        direction: Direction,
 898        cx: &mut ViewContext<Self>,
 899    ) -> usize {
 900        let buffer = self.buffer().read(cx).snapshot(cx);
 901        let cursor = self.selections.newest_anchor().head();
 902        if matches[current_index].start.cmp(&cursor, &buffer).is_gt() {
 903            if direction == Direction::Prev {
 904                if current_index == 0 {
 905                    current_index = matches.len() - 1;
 906                } else {
 907                    current_index -= 1;
 908                }
 909            }
 910        } else if matches[current_index].end.cmp(&cursor, &buffer).is_lt() {
 911            if direction == Direction::Next {
 912                current_index = 0;
 913            }
 914        } else if direction == Direction::Prev {
 915            if current_index == 0 {
 916                current_index = matches.len() - 1;
 917            } else {
 918                current_index -= 1;
 919            }
 920        } else if direction == Direction::Next {
 921            if current_index == matches.len() - 1 {
 922                current_index = 0
 923            } else {
 924                current_index += 1;
 925            }
 926        };
 927        current_index
 928    }
 929
 930    fn find_matches(
 931        &mut self,
 932        query: project::search::SearchQuery,
 933        cx: &mut ViewContext<Self>,
 934    ) -> Task<Vec<Range<Anchor>>> {
 935        let buffer = self.buffer().read(cx).snapshot(cx);
 936        cx.background().spawn(async move {
 937            let mut ranges = Vec::new();
 938            if let Some((_, _, excerpt_buffer)) = buffer.as_singleton() {
 939                ranges.extend(
 940                    query
 941                        .search(excerpt_buffer.as_rope())
 942                        .await
 943                        .into_iter()
 944                        .map(|range| {
 945                            buffer.anchor_after(range.start)..buffer.anchor_before(range.end)
 946                        }),
 947                );
 948            } else {
 949                for excerpt in buffer.excerpt_boundaries_in_range(0..buffer.len()) {
 950                    let excerpt_range = excerpt.range.context.to_offset(&excerpt.buffer);
 951                    let rope = excerpt.buffer.as_rope().slice(excerpt_range.clone());
 952                    ranges.extend(query.search(&rope).await.into_iter().map(|range| {
 953                        let start = excerpt
 954                            .buffer
 955                            .anchor_after(excerpt_range.start + range.start);
 956                        let end = excerpt
 957                            .buffer
 958                            .anchor_before(excerpt_range.start + range.end);
 959                        buffer.anchor_in_excerpt(excerpt.id.clone(), start)
 960                            ..buffer.anchor_in_excerpt(excerpt.id.clone(), end)
 961                    }));
 962                }
 963            }
 964            ranges
 965        })
 966    }
 967
 968    fn active_match_index(
 969        &mut self,
 970        matches: Vec<Range<Anchor>>,
 971        cx: &mut ViewContext<Self>,
 972    ) -> Option<usize> {
 973        active_match_index(
 974            &matches,
 975            &self.selections.newest_anchor().head(),
 976            &self.buffer().read(cx).snapshot(cx),
 977        )
 978    }
 979}
 980
 981pub fn active_match_index(
 982    ranges: &[Range<Anchor>],
 983    cursor: &Anchor,
 984    buffer: &MultiBufferSnapshot,
 985) -> Option<usize> {
 986    if ranges.is_empty() {
 987        None
 988    } else {
 989        match ranges.binary_search_by(|probe| {
 990            if probe.end.cmp(cursor, &*buffer).is_lt() {
 991                Ordering::Less
 992            } else if probe.start.cmp(cursor, &*buffer).is_gt() {
 993                Ordering::Greater
 994            } else {
 995                Ordering::Equal
 996            }
 997        }) {
 998            Ok(i) | Err(i) => Some(cmp::min(i, ranges.len() - 1)),
 999        }
1000    }
1001}
1002
1003pub struct CursorPosition {
1004    position: Option<Point>,
1005    selected_count: usize,
1006    _observe_active_editor: Option<Subscription>,
1007}
1008
1009impl Default for CursorPosition {
1010    fn default() -> Self {
1011        Self::new()
1012    }
1013}
1014
1015impl CursorPosition {
1016    pub fn new() -> Self {
1017        Self {
1018            position: None,
1019            selected_count: 0,
1020            _observe_active_editor: None,
1021        }
1022    }
1023
1024    fn update_position(&mut self, editor: ViewHandle<Editor>, cx: &mut ViewContext<Self>) {
1025        let editor = editor.read(cx);
1026        let buffer = editor.buffer().read(cx).snapshot(cx);
1027
1028        self.selected_count = 0;
1029        let mut last_selection: Option<Selection<usize>> = None;
1030        for selection in editor.selections.all::<usize>(cx) {
1031            self.selected_count += selection.end - selection.start;
1032            if last_selection
1033                .as_ref()
1034                .map_or(true, |last_selection| selection.id > last_selection.id)
1035            {
1036                last_selection = Some(selection);
1037            }
1038        }
1039        self.position = last_selection.map(|s| s.head().to_point(&buffer));
1040
1041        cx.notify();
1042    }
1043}
1044
1045impl Entity for CursorPosition {
1046    type Event = ();
1047}
1048
1049impl View for CursorPosition {
1050    fn ui_name() -> &'static str {
1051        "CursorPosition"
1052    }
1053
1054    fn render(&mut self, cx: &mut RenderContext<Self>) -> ElementBox {
1055        if let Some(position) = self.position {
1056            let theme = &cx.global::<Settings>().theme.workspace.status_bar;
1057            let mut text = format!("{},{}", position.row + 1, position.column + 1);
1058            if self.selected_count > 0 {
1059                write!(text, " ({} selected)", self.selected_count).unwrap();
1060            }
1061            Label::new(text, theme.cursor_position.clone()).boxed()
1062        } else {
1063            Empty::new().boxed()
1064        }
1065    }
1066}
1067
1068impl StatusItemView for CursorPosition {
1069    fn set_active_pane_item(
1070        &mut self,
1071        active_pane_item: Option<&dyn ItemHandle>,
1072        cx: &mut ViewContext<Self>,
1073    ) {
1074        if let Some(editor) = active_pane_item.and_then(|item| item.act_as::<Editor>(cx)) {
1075            self._observe_active_editor = Some(cx.observe(&editor, Self::update_position));
1076            self.update_position(editor, cx);
1077        } else {
1078            self.position = None;
1079            self._observe_active_editor = None;
1080        }
1081
1082        cx.notify();
1083    }
1084}
1085
1086fn path_for_buffer<'a>(
1087    buffer: &ModelHandle<MultiBuffer>,
1088    height: usize,
1089    include_filename: bool,
1090    cx: &'a AppContext,
1091) -> Option<Cow<'a, Path>> {
1092    let file = buffer.read(cx).as_singleton()?.read(cx).file()?;
1093    path_for_file(file.as_ref(), height, include_filename, cx)
1094}
1095
1096fn path_for_file<'a>(
1097    file: &'a dyn language::File,
1098    mut height: usize,
1099    include_filename: bool,
1100    cx: &'a AppContext,
1101) -> Option<Cow<'a, Path>> {
1102    // Ensure we always render at least the filename.
1103    height += 1;
1104
1105    let mut prefix = file.path().as_ref();
1106    while height > 0 {
1107        if let Some(parent) = prefix.parent() {
1108            prefix = parent;
1109            height -= 1;
1110        } else {
1111            break;
1112        }
1113    }
1114
1115    // Here we could have just always used `full_path`, but that is very
1116    // allocation-heavy and so we try to use a `Cow<Path>` if we haven't
1117    // traversed all the way up to the worktree's root.
1118    if height > 0 {
1119        let full_path = file.full_path(cx);
1120        if include_filename {
1121            Some(full_path.into())
1122        } else {
1123            Some(full_path.parent()?.to_path_buf().into())
1124        }
1125    } else {
1126        let mut path = file.path().strip_prefix(prefix).ok()?;
1127        if !include_filename {
1128            path = path.parent()?;
1129        }
1130        Some(path.into())
1131    }
1132}
1133
1134#[cfg(test)]
1135mod tests {
1136    use super::*;
1137    use gpui::MutableAppContext;
1138    use std::{
1139        path::{Path, PathBuf},
1140        sync::Arc,
1141        time::SystemTime,
1142    };
1143
1144    #[gpui::test]
1145    fn test_path_for_file(cx: &mut MutableAppContext) {
1146        let file = TestFile {
1147            path: Path::new("").into(),
1148            full_path: PathBuf::from(""),
1149        };
1150        assert_eq!(path_for_file(&file, 0, false, cx), None);
1151    }
1152
1153    struct TestFile {
1154        path: Arc<Path>,
1155        full_path: PathBuf,
1156    }
1157
1158    impl language::File for TestFile {
1159        fn path(&self) -> &Arc<Path> {
1160            &self.path
1161        }
1162
1163        fn full_path(&self, _: &gpui::AppContext) -> PathBuf {
1164            self.full_path.clone()
1165        }
1166
1167        fn as_local(&self) -> Option<&dyn language::LocalFile> {
1168            todo!()
1169        }
1170
1171        fn mtime(&self) -> SystemTime {
1172            todo!()
1173        }
1174
1175        fn file_name<'a>(&'a self, _: &'a gpui::AppContext) -> &'a std::ffi::OsStr {
1176            todo!()
1177        }
1178
1179        fn is_deleted(&self) -> bool {
1180            todo!()
1181        }
1182
1183        fn as_any(&self) -> &dyn std::any::Any {
1184            todo!()
1185        }
1186
1187        fn to_proto(&self) -> rpc::proto::File {
1188            todo!()
1189        }
1190    }
1191}