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