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    FORMAT_TIMEOUT,
   6};
   7use anyhow::{anyhow, Context, Result};
   8use collections::HashSet;
   9use futures::future::try_join_all;
  10use futures::FutureExt;
  11use gpui::{
  12    elements::*, geometry::vector::vec2f, AppContext, Entity, ModelHandle, MutableAppContext,
  13    RenderContext, Subscription, Task, View, ViewContext, ViewHandle, WeakViewHandle,
  14};
  15use language::{
  16    proto::serialize_anchor as serialize_text_anchor, Bias, Buffer, OffsetRangeExt, Point,
  17    SelectionGoal,
  18};
  19use project::{FormatTrigger, Item as _, Project, ProjectPath};
  20use rpc::proto::{self, update_view};
  21use settings::Settings;
  22use std::{
  23    borrow::Cow,
  24    cmp::{self, Ordering},
  25    fmt::Write,
  26    iter,
  27    ops::Range,
  28    path::{Path, PathBuf},
  29};
  30use text::Selection;
  31use util::{ResultExt, TryFutureExt};
  32use workspace::item::FollowableItemHandle;
  33use workspace::{
  34    item::{FollowableItem, Item, ItemEvent, ItemHandle, ProjectItem},
  35    searchable::{Direction, SearchEvent, SearchableItem, SearchableItemHandle},
  36    ItemId, ItemNavHistory, Pane, StatusItemView, ToolbarItemLocation, ViewId, Workspace,
  37    WorkspaceId,
  38};
  39
  40pub const MAX_TAB_TITLE_LEN: usize = 24;
  41
  42impl FollowableItem for Editor {
  43    fn remote_id(&self) -> Option<ViewId> {
  44        self.remote_id
  45    }
  46
  47    fn from_state_proto(
  48        pane: ViewHandle<workspace::Pane>,
  49        project: ModelHandle<Project>,
  50        remote_id: ViewId,
  51        state: &mut Option<proto::view::Variant>,
  52        cx: &mut MutableAppContext,
  53    ) -> Option<Task<Result<ViewHandle<Self>>>> {
  54        let Some(proto::view::Variant::Editor(_)) = state else { return None };
  55        let Some(proto::view::Variant::Editor(state)) = state.take() else { unreachable!() };
  56
  57        let client = project.read(cx).client();
  58        let replica_id = project.read(cx).replica_id();
  59        let buffer_ids = state
  60            .excerpts
  61            .iter()
  62            .map(|excerpt| excerpt.buffer_id)
  63            .collect::<HashSet<_>>();
  64        let buffers = project.update(cx, |project, cx| {
  65            buffer_ids
  66                .iter()
  67                .map(|id| project.open_buffer_by_id(*id, cx))
  68                .collect::<Vec<_>>()
  69        });
  70
  71        Some(cx.spawn(|mut cx| async move {
  72            let mut buffers = futures::future::try_join_all(buffers).await?;
  73            let editor = pane.read_with(&cx, |pane, cx| {
  74                let mut editors = pane.items_of_type::<Self>();
  75                editors.find(|editor| {
  76                    editor.remote_id(&client, cx) == Some(remote_id)
  77                        || state.singleton
  78                            && buffers.len() == 1
  79                            && editor.read(cx).buffer.read(cx).as_singleton().as_ref()
  80                                == Some(&buffers[0])
  81                })
  82            });
  83
  84            let editor = editor.unwrap_or_else(|| {
  85                pane.update(&mut cx, |_, cx| {
  86                    let multibuffer = cx.add_model(|cx| {
  87                        let mut multibuffer;
  88                        if state.singleton && buffers.len() == 1 {
  89                            multibuffer = MultiBuffer::singleton(buffers.pop().unwrap(), cx)
  90                        } else {
  91                            multibuffer = MultiBuffer::new(replica_id);
  92                            let mut excerpts = state.excerpts.into_iter().peekable();
  93                            while let Some(excerpt) = excerpts.peek() {
  94                                let buffer_id = excerpt.buffer_id;
  95                                let buffer_excerpts = iter::from_fn(|| {
  96                                    let excerpt = excerpts.peek()?;
  97                                    (excerpt.buffer_id == buffer_id)
  98                                        .then(|| excerpts.next().unwrap())
  99                                });
 100                                let buffer =
 101                                    buffers.iter().find(|b| b.read(cx).remote_id() == buffer_id);
 102                                if let Some(buffer) = buffer {
 103                                    multibuffer.push_excerpts(
 104                                        buffer.clone(),
 105                                        buffer_excerpts.filter_map(deserialize_excerpt_range),
 106                                        cx,
 107                                    );
 108                                }
 109                            }
 110                        };
 111
 112                        if let Some(title) = &state.title {
 113                            multibuffer = multibuffer.with_title(title.clone())
 114                        }
 115
 116                        multibuffer
 117                    });
 118
 119                    cx.add_view(|cx| Editor::for_multibuffer(multibuffer, Some(project), cx))
 120                })
 121            });
 122
 123            editor.update(&mut cx, |editor, cx| {
 124                editor.remote_id = Some(remote_id);
 125                let buffer = editor.buffer.read(cx).read(cx);
 126                let selections = state
 127                    .selections
 128                    .into_iter()
 129                    .map(|selection| {
 130                        deserialize_selection(&buffer, selection)
 131                            .ok_or_else(|| anyhow!("invalid selection"))
 132                    })
 133                    .collect::<Result<Vec<_>>>()?;
 134                let pending_selection = state
 135                    .pending_selection
 136                    .map(|selection| deserialize_selection(&buffer, selection))
 137                    .flatten();
 138                let scroll_top_anchor = state
 139                    .scroll_top_anchor
 140                    .and_then(|anchor| deserialize_anchor(&buffer, anchor));
 141                drop(buffer);
 142
 143                if !selections.is_empty() || pending_selection.is_some() {
 144                    editor.set_selections_from_remote(selections, pending_selection, cx);
 145                }
 146
 147                if let Some(scroll_top_anchor) = scroll_top_anchor {
 148                    editor.set_scroll_anchor_remote(
 149                        ScrollAnchor {
 150                            top_anchor: scroll_top_anchor,
 151                            offset: vec2f(state.scroll_x, state.scroll_y),
 152                        },
 153                        cx,
 154                    );
 155                }
 156
 157                anyhow::Ok(())
 158            })?;
 159
 160            Ok(editor)
 161        }))
 162    }
 163
 164    fn set_leader_replica_id(
 165        &mut self,
 166        leader_replica_id: Option<u16>,
 167        cx: &mut ViewContext<Self>,
 168    ) {
 169        self.leader_replica_id = leader_replica_id;
 170        if self.leader_replica_id.is_some() {
 171            self.buffer.update(cx, |buffer, cx| {
 172                buffer.remove_active_selections(cx);
 173            });
 174        } else {
 175            self.buffer.update(cx, |buffer, cx| {
 176                if self.focused {
 177                    buffer.set_active_selections(
 178                        &self.selections.disjoint_anchors(),
 179                        self.selections.line_mode,
 180                        self.cursor_shape,
 181                        cx,
 182                    );
 183                }
 184            });
 185        }
 186        cx.notify();
 187    }
 188
 189    fn to_state_proto(&self, cx: &AppContext) -> Option<proto::view::Variant> {
 190        let buffer = self.buffer.read(cx);
 191        let scroll_anchor = self.scroll_manager.anchor();
 192        let excerpts = buffer
 193            .read(cx)
 194            .excerpts()
 195            .map(|(id, buffer, range)| proto::Excerpt {
 196                id: id.to_proto(),
 197                buffer_id: buffer.remote_id(),
 198                context_start: Some(serialize_text_anchor(&range.context.start)),
 199                context_end: Some(serialize_text_anchor(&range.context.end)),
 200                primary_start: range
 201                    .primary
 202                    .as_ref()
 203                    .map(|range| serialize_text_anchor(&range.start)),
 204                primary_end: range
 205                    .primary
 206                    .as_ref()
 207                    .map(|range| serialize_text_anchor(&range.end)),
 208            })
 209            .collect();
 210
 211        Some(proto::view::Variant::Editor(proto::view::Editor {
 212            singleton: buffer.is_singleton(),
 213            title: (!buffer.is_singleton()).then(|| buffer.title(cx).into()),
 214            excerpts,
 215            scroll_top_anchor: Some(serialize_anchor(&scroll_anchor.top_anchor)),
 216            scroll_x: scroll_anchor.offset.x(),
 217            scroll_y: scroll_anchor.offset.y(),
 218            selections: self
 219                .selections
 220                .disjoint_anchors()
 221                .iter()
 222                .map(serialize_selection)
 223                .collect(),
 224            pending_selection: self
 225                .selections
 226                .pending_anchor()
 227                .as_ref()
 228                .map(serialize_selection),
 229        }))
 230    }
 231
 232    fn add_event_to_update_proto(
 233        &self,
 234        event: &Self::Event,
 235        update: &mut Option<proto::update_view::Variant>,
 236        cx: &AppContext,
 237    ) -> bool {
 238        let update =
 239            update.get_or_insert_with(|| proto::update_view::Variant::Editor(Default::default()));
 240
 241        match update {
 242            proto::update_view::Variant::Editor(update) => match event {
 243                Event::ExcerptsAdded {
 244                    buffer,
 245                    predecessor,
 246                    excerpts,
 247                } => {
 248                    let buffer_id = buffer.read(cx).remote_id();
 249                    let mut excerpts = excerpts.iter();
 250                    if let Some((id, range)) = excerpts.next() {
 251                        update.inserted_excerpts.push(proto::ExcerptInsertion {
 252                            previous_excerpt_id: Some(predecessor.to_proto()),
 253                            excerpt: serialize_excerpt(buffer_id, id, range),
 254                        });
 255                        update.inserted_excerpts.extend(excerpts.map(|(id, range)| {
 256                            proto::ExcerptInsertion {
 257                                previous_excerpt_id: None,
 258                                excerpt: serialize_excerpt(buffer_id, id, range),
 259                            }
 260                        }))
 261                    }
 262                    true
 263                }
 264                Event::ExcerptsRemoved { ids } => {
 265                    update
 266                        .deleted_excerpts
 267                        .extend(ids.iter().map(ExcerptId::to_proto));
 268                    true
 269                }
 270                Event::ScrollPositionChanged { .. } => {
 271                    let scroll_anchor = self.scroll_manager.anchor();
 272                    update.scroll_top_anchor = Some(serialize_anchor(&scroll_anchor.top_anchor));
 273                    update.scroll_x = scroll_anchor.offset.x();
 274                    update.scroll_y = scroll_anchor.offset.y();
 275                    true
 276                }
 277                Event::SelectionsChanged { .. } => {
 278                    update.selections = self
 279                        .selections
 280                        .disjoint_anchors()
 281                        .iter()
 282                        .map(serialize_selection)
 283                        .collect();
 284                    update.pending_selection = self
 285                        .selections
 286                        .pending_anchor()
 287                        .as_ref()
 288                        .map(serialize_selection);
 289                    true
 290                }
 291                _ => false,
 292            },
 293        }
 294    }
 295
 296    fn apply_update_proto(
 297        &mut self,
 298        project: &ModelHandle<Project>,
 299        message: update_view::Variant,
 300        cx: &mut ViewContext<Self>,
 301    ) -> Task<Result<()>> {
 302        let update_view::Variant::Editor(message) = message;
 303        let multibuffer = self.buffer.read(cx);
 304        let multibuffer = multibuffer.read(cx);
 305
 306        let buffer_ids = message
 307            .inserted_excerpts
 308            .iter()
 309            .filter_map(|insertion| Some(insertion.excerpt.as_ref()?.buffer_id))
 310            .collect::<HashSet<_>>();
 311
 312        let mut removals = message
 313            .deleted_excerpts
 314            .into_iter()
 315            .map(ExcerptId::from_proto)
 316            .collect::<Vec<_>>();
 317        removals.sort_by(|a, b| a.cmp(&b, &multibuffer));
 318
 319        let selections = message
 320            .selections
 321            .into_iter()
 322            .filter_map(|selection| deserialize_selection(&multibuffer, selection))
 323            .collect::<Vec<_>>();
 324        let pending_selection = message
 325            .pending_selection
 326            .and_then(|selection| deserialize_selection(&multibuffer, selection));
 327
 328        let scroll_top_anchor = message
 329            .scroll_top_anchor
 330            .and_then(|anchor| deserialize_anchor(&multibuffer, anchor));
 331        drop(multibuffer);
 332
 333        let buffers = project.update(cx, |project, cx| {
 334            buffer_ids
 335                .into_iter()
 336                .map(|id| project.open_buffer_by_id(id, cx))
 337                .collect::<Vec<_>>()
 338        });
 339
 340        let project = project.clone();
 341        cx.spawn(|this, mut cx| async move {
 342            let _buffers = try_join_all(buffers).await?;
 343            this.update(&mut cx, |this, cx| {
 344                this.buffer.update(cx, |multibuffer, cx| {
 345                    let mut insertions = message.inserted_excerpts.into_iter().peekable();
 346                    while let Some(insertion) = insertions.next() {
 347                        let Some(excerpt) = insertion.excerpt else { continue };
 348                        let Some(previous_excerpt_id) = insertion.previous_excerpt_id else { continue };
 349                        let buffer_id = excerpt.buffer_id;
 350                        let Some(buffer) = project.read(cx).buffer_for_id(buffer_id, cx) else { continue };
 351
 352                        let adjacent_excerpts = iter::from_fn(|| {
 353                            let insertion = insertions.peek()?;
 354                            if insertion.previous_excerpt_id.is_none()
 355                                && insertion.excerpt.as_ref()?.buffer_id == buffer_id
 356                            {
 357                                insertions.next()?.excerpt
 358                            } else {
 359                                None
 360                            }
 361                        });
 362
 363                        multibuffer.insert_excerpts_with_ids_after(
 364                            ExcerptId::from_proto(previous_excerpt_id),
 365                            buffer,
 366                            [excerpt]
 367                                .into_iter()
 368                                .chain(adjacent_excerpts)
 369                                .filter_map(|excerpt| {
 370                                    Some((
 371                                        ExcerptId::from_proto(excerpt.id),
 372                                        deserialize_excerpt_range(excerpt)?,
 373                                    ))
 374                                }),
 375                            cx,
 376                        );
 377                    }
 378
 379                    multibuffer.remove_excerpts(removals, cx);
 380                });
 381
 382                if !selections.is_empty() || pending_selection.is_some() {
 383                    this.set_selections_from_remote(selections, pending_selection, cx);
 384                    this.request_autoscroll_remotely(Autoscroll::newest(), cx);
 385                } else if let Some(anchor) = scroll_top_anchor {
 386                    this.set_scroll_anchor_remote(ScrollAnchor {
 387                        top_anchor: anchor,
 388                        offset: vec2f(message.scroll_x, message.scroll_y)
 389                    }, cx);
 390                }
 391            });
 392            Ok(())
 393        })
 394    }
 395
 396    fn should_unfollow_on_event(event: &Self::Event, _: &AppContext) -> bool {
 397        match event {
 398            Event::Edited => true,
 399            Event::SelectionsChanged { local } => *local,
 400            Event::ScrollPositionChanged { local } => *local,
 401            _ => false,
 402        }
 403    }
 404}
 405
 406fn serialize_excerpt(
 407    buffer_id: u64,
 408    id: &ExcerptId,
 409    range: &ExcerptRange<language::Anchor>,
 410) -> Option<proto::Excerpt> {
 411    Some(proto::Excerpt {
 412        id: id.to_proto(),
 413        buffer_id,
 414        context_start: Some(serialize_text_anchor(&range.context.start)),
 415        context_end: Some(serialize_text_anchor(&range.context.end)),
 416        primary_start: range
 417            .primary
 418            .as_ref()
 419            .map(|r| serialize_text_anchor(&r.start)),
 420        primary_end: range
 421            .primary
 422            .as_ref()
 423            .map(|r| serialize_text_anchor(&r.end)),
 424    })
 425}
 426
 427fn serialize_selection(selection: &Selection<Anchor>) -> proto::Selection {
 428    proto::Selection {
 429        id: selection.id as u64,
 430        start: Some(serialize_anchor(&selection.start)),
 431        end: Some(serialize_anchor(&selection.end)),
 432        reversed: selection.reversed,
 433    }
 434}
 435
 436fn serialize_anchor(anchor: &Anchor) -> proto::EditorAnchor {
 437    proto::EditorAnchor {
 438        excerpt_id: anchor.excerpt_id.to_proto(),
 439        anchor: Some(serialize_text_anchor(&anchor.text_anchor)),
 440    }
 441}
 442
 443fn deserialize_excerpt_range(excerpt: proto::Excerpt) -> Option<ExcerptRange<language::Anchor>> {
 444    let context = {
 445        let start = language::proto::deserialize_anchor(excerpt.context_start?)?;
 446        let end = language::proto::deserialize_anchor(excerpt.context_end?)?;
 447        start..end
 448    };
 449    let primary = excerpt
 450        .primary_start
 451        .zip(excerpt.primary_end)
 452        .and_then(|(start, end)| {
 453            let start = language::proto::deserialize_anchor(start)?;
 454            let end = language::proto::deserialize_anchor(end)?;
 455            Some(start..end)
 456        });
 457    Some(ExcerptRange { context, primary })
 458}
 459
 460fn deserialize_selection(
 461    buffer: &MultiBufferSnapshot,
 462    selection: proto::Selection,
 463) -> Option<Selection<Anchor>> {
 464    Some(Selection {
 465        id: selection.id as usize,
 466        start: deserialize_anchor(buffer, selection.start?)?,
 467        end: deserialize_anchor(buffer, selection.end?)?,
 468        reversed: selection.reversed,
 469        goal: SelectionGoal::None,
 470    })
 471}
 472
 473fn deserialize_anchor(buffer: &MultiBufferSnapshot, anchor: proto::EditorAnchor) -> Option<Anchor> {
 474    let excerpt_id = ExcerptId::from_proto(anchor.excerpt_id);
 475    Some(Anchor {
 476        excerpt_id,
 477        text_anchor: language::proto::deserialize_anchor(anchor.anchor?)?,
 478        buffer_id: buffer.buffer_id_for_excerpt(excerpt_id),
 479    })
 480}
 481
 482impl Item for Editor {
 483    fn navigate(&mut self, data: Box<dyn std::any::Any>, cx: &mut ViewContext<Self>) -> bool {
 484        if let Ok(data) = data.downcast::<NavigationData>() {
 485            let newest_selection = self.selections.newest::<Point>(cx);
 486            let buffer = self.buffer.read(cx).read(cx);
 487            let offset = if buffer.can_resolve(&data.cursor_anchor) {
 488                data.cursor_anchor.to_point(&buffer)
 489            } else {
 490                buffer.clip_point(data.cursor_position, Bias::Left)
 491            };
 492
 493            let mut scroll_anchor = data.scroll_anchor;
 494            if !buffer.can_resolve(&scroll_anchor.top_anchor) {
 495                scroll_anchor.top_anchor = buffer.anchor_before(
 496                    buffer.clip_point(Point::new(data.scroll_top_row, 0), Bias::Left),
 497                );
 498            }
 499
 500            drop(buffer);
 501
 502            if newest_selection.head() == offset {
 503                false
 504            } else {
 505                let nav_history = self.nav_history.take();
 506                self.set_scroll_anchor(scroll_anchor, cx);
 507                self.change_selections(Some(Autoscroll::fit()), cx, |s| {
 508                    s.select_ranges([offset..offset])
 509                });
 510                self.nav_history = nav_history;
 511                true
 512            }
 513        } else {
 514            false
 515        }
 516    }
 517
 518    fn tab_description<'a>(&'a self, detail: usize, cx: &'a AppContext) -> Option<Cow<'a, str>> {
 519        match path_for_buffer(&self.buffer, detail, true, cx)? {
 520            Cow::Borrowed(path) => Some(path.to_string_lossy()),
 521            Cow::Owned(path) => Some(path.to_string_lossy().to_string().into()),
 522        }
 523    }
 524
 525    fn tab_content(
 526        &self,
 527        detail: Option<usize>,
 528        style: &theme::Tab,
 529        cx: &AppContext,
 530    ) -> ElementBox {
 531        Flex::row()
 532            .with_child(
 533                Label::new(self.title(cx).into(), style.label.clone())
 534                    .aligned()
 535                    .boxed(),
 536            )
 537            .with_children(detail.and_then(|detail| {
 538                let path = path_for_buffer(&self.buffer, detail, false, cx)?;
 539                let description = path.to_string_lossy();
 540                Some(
 541                    Label::new(
 542                        if description.len() > MAX_TAB_TITLE_LEN {
 543                            description[..MAX_TAB_TITLE_LEN].to_string() + "…"
 544                        } else {
 545                            description.into()
 546                        },
 547                        style.description.text.clone(),
 548                    )
 549                    .contained()
 550                    .with_style(style.description.container)
 551                    .aligned()
 552                    .boxed(),
 553                )
 554            }))
 555            .boxed()
 556    }
 557
 558    fn for_each_project_item(&self, cx: &AppContext, f: &mut dyn FnMut(usize, &dyn project::Item)) {
 559        self.buffer
 560            .read(cx)
 561            .for_each_buffer(|buffer| f(buffer.id(), buffer.read(cx)));
 562    }
 563
 564    fn is_singleton(&self, cx: &AppContext) -> bool {
 565        self.buffer.read(cx).is_singleton()
 566    }
 567
 568    fn clone_on_split(&self, _workspace_id: WorkspaceId, cx: &mut ViewContext<Self>) -> Option<Self>
 569    where
 570        Self: Sized,
 571    {
 572        Some(self.clone(cx))
 573    }
 574
 575    fn set_nav_history(&mut self, history: ItemNavHistory, _: &mut ViewContext<Self>) {
 576        self.nav_history = Some(history);
 577    }
 578
 579    fn deactivated(&mut self, cx: &mut ViewContext<Self>) {
 580        let selection = self.selections.newest_anchor();
 581        self.push_to_nav_history(selection.head(), None, cx);
 582    }
 583
 584    fn workspace_deactivated(&mut self, cx: &mut ViewContext<Self>) {
 585        hide_link_definition(self, cx);
 586        self.link_go_to_definition_state.last_mouse_location = None;
 587    }
 588
 589    fn is_dirty(&self, cx: &AppContext) -> bool {
 590        self.buffer().read(cx).read(cx).is_dirty()
 591    }
 592
 593    fn has_conflict(&self, cx: &AppContext) -> bool {
 594        self.buffer().read(cx).read(cx).has_conflict()
 595    }
 596
 597    fn can_save(&self, cx: &AppContext) -> bool {
 598        let buffer = &self.buffer().read(cx);
 599        if let Some(buffer) = buffer.as_singleton() {
 600            buffer.read(cx).project_path(cx).is_some()
 601        } else {
 602            true
 603        }
 604    }
 605
 606    fn save(
 607        &mut self,
 608        project: ModelHandle<Project>,
 609        cx: &mut ViewContext<Self>,
 610    ) -> Task<Result<()>> {
 611        self.report_event("save editor", cx);
 612
 613        let buffer = self.buffer().clone();
 614        let buffers = buffer.read(cx).all_buffers();
 615        let mut timeout = cx.background().timer(FORMAT_TIMEOUT).fuse();
 616        let format = project.update(cx, |project, cx| {
 617            project.format(buffers, true, FormatTrigger::Save, cx)
 618        });
 619        cx.spawn(|_, mut cx| async move {
 620            let transaction = futures::select_biased! {
 621                _ = timeout => {
 622                    log::warn!("timed out waiting for formatting");
 623                    None
 624                }
 625                transaction = format.log_err().fuse() => transaction,
 626            };
 627
 628            buffer
 629                .update(&mut cx, |buffer, cx| {
 630                    if let Some(transaction) = transaction {
 631                        if !buffer.is_singleton() {
 632                            buffer.push_transaction(&transaction.0);
 633                        }
 634                    }
 635
 636                    buffer.save(cx)
 637                })
 638                .await?;
 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) -> Vec<ItemEvent> {
 697        let mut result = Vec::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, 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 language::RopeFingerprint;
1162    use std::{
1163        path::{Path, PathBuf},
1164        sync::Arc,
1165        time::SystemTime,
1166    };
1167
1168    #[gpui::test]
1169    fn test_path_for_file(cx: &mut MutableAppContext) {
1170        let file = TestFile {
1171            path: Path::new("").into(),
1172            full_path: PathBuf::from(""),
1173        };
1174        assert_eq!(path_for_file(&file, 0, false, cx), None);
1175    }
1176
1177    struct TestFile {
1178        path: Arc<Path>,
1179        full_path: PathBuf,
1180    }
1181
1182    impl language::File for TestFile {
1183        fn path(&self) -> &Arc<Path> {
1184            &self.path
1185        }
1186
1187        fn full_path(&self, _: &gpui::AppContext) -> PathBuf {
1188            self.full_path.clone()
1189        }
1190
1191        fn as_local(&self) -> Option<&dyn language::LocalFile> {
1192            todo!()
1193        }
1194
1195        fn mtime(&self) -> SystemTime {
1196            todo!()
1197        }
1198
1199        fn file_name<'a>(&'a self, _: &'a gpui::AppContext) -> &'a std::ffi::OsStr {
1200            todo!()
1201        }
1202
1203        fn is_deleted(&self) -> bool {
1204            todo!()
1205        }
1206
1207        fn save(
1208            &self,
1209            _: u64,
1210            _: language::Rope,
1211            _: clock::Global,
1212            _: project::LineEnding,
1213            _: &mut MutableAppContext,
1214        ) -> gpui::Task<anyhow::Result<(clock::Global, RopeFingerprint, SystemTime)>> {
1215            todo!()
1216        }
1217
1218        fn as_any(&self) -> &dyn std::any::Any {
1219            todo!()
1220        }
1221
1222        fn to_proto(&self) -> rpc::proto::File {
1223            todo!()
1224        }
1225    }
1226}