1use crate::{
   2    Anchor, Autoscroll, Editor, EditorEvent, EditorSettings, ExcerptId, ExcerptRange, FormatTarget,
   3    MultiBuffer, MultiBufferSnapshot, NavigationData, SearchWithinRange, ToPoint as _,
   4    editor_settings::SeedQuerySetting,
   5    persistence::{DB, SerializedEditor},
   6    scroll::ScrollAnchor,
   7};
   8use anyhow::{Context as _, Result, anyhow};
   9use collections::{HashMap, HashSet};
  10use file_icons::FileIcons;
  11use futures::future::try_join_all;
  12use git::status::GitSummary;
  13use gpui::{
  14    AnyElement, App, AsyncWindowContext, Context, Entity, EntityId, EventEmitter, IntoElement,
  15    ParentElement, Pixels, SharedString, Styled, Task, WeakEntity, Window, point,
  16};
  17use language::{
  18    Bias, Buffer, BufferRow, CharKind, DiskState, LocalFile, Point, SelectionGoal,
  19    proto::serialize_anchor as serialize_text_anchor,
  20};
  21use lsp::DiagnosticSeverity;
  22use project::{
  23    Project, ProjectItem as _, ProjectPath, lsp_store::FormatTrigger,
  24    project_settings::ProjectSettings, search::SearchQuery,
  25};
  26use rpc::proto::{self, PeerId, update_view};
  27use settings::Settings;
  28use std::{
  29    any::TypeId,
  30    borrow::Cow,
  31    cmp::{self, Ordering},
  32    iter,
  33    ops::Range,
  34    path::{Path, PathBuf},
  35    sync::Arc,
  36};
  37use text::{BufferId, BufferSnapshot, Selection};
  38use theme::{Theme, ThemeSettings};
  39use ui::{IconDecorationKind, prelude::*};
  40use util::{ResultExt, TryFutureExt, paths::PathExt};
  41use workspace::{
  42    ItemId, ItemNavHistory, ToolbarItemLocation, ViewId, Workspace, WorkspaceId,
  43    item::{FollowableItem, Item, ItemEvent, ProjectItem},
  44    searchable::{Direction, SearchEvent, SearchableItem, SearchableItemHandle},
  45};
  46use workspace::{
  47    OpenOptions,
  48    item::{Dedup, ItemSettings, SerializableItem, TabContentParams},
  49};
  50use workspace::{
  51    OpenVisible, Pane, WorkspaceSettings,
  52    item::{BreadcrumbText, FollowEvent, ProjectItemKind},
  53    searchable::SearchOptions,
  54};
  55
  56pub const MAX_TAB_TITLE_LEN: usize = 24;
  57
  58impl FollowableItem for Editor {
  59    fn remote_id(&self) -> Option<ViewId> {
  60        self.remote_id
  61    }
  62
  63    fn from_state_proto(
  64        workspace: Entity<Workspace>,
  65        remote_id: ViewId,
  66        state: &mut Option<proto::view::Variant>,
  67        window: &mut Window,
  68        cx: &mut App,
  69    ) -> Option<Task<Result<Entity<Self>>>> {
  70        let project = workspace.read(cx).project().to_owned();
  71        let Some(proto::view::Variant::Editor(_)) = state else {
  72            return None;
  73        };
  74        let Some(proto::view::Variant::Editor(state)) = state.take() else {
  75            unreachable!()
  76        };
  77
  78        let buffer_ids = state
  79            .excerpts
  80            .iter()
  81            .map(|excerpt| excerpt.buffer_id)
  82            .collect::<HashSet<_>>();
  83        let buffers = project.update(cx, |project, cx| {
  84            buffer_ids
  85                .iter()
  86                .map(|id| BufferId::new(*id).map(|id| project.open_buffer_by_id(id, cx)))
  87                .collect::<Result<Vec<_>>>()
  88        });
  89
  90        Some(window.spawn(cx, async move |cx| {
  91            let mut buffers = futures::future::try_join_all(buffers?)
  92                .await
  93                .debug_assert_ok("leaders don't share views for unshared buffers")?;
  94
  95            let editor = cx.update(|window, cx| {
  96                let multibuffer = cx.new(|cx| {
  97                    let mut multibuffer;
  98                    if state.singleton && buffers.len() == 1 {
  99                        multibuffer = MultiBuffer::singleton(buffers.pop().unwrap(), cx)
 100                    } else {
 101                        multibuffer = MultiBuffer::new(project.read(cx).capability());
 102                        let mut sorted_excerpts = state.excerpts.clone();
 103                        sorted_excerpts.sort_by_key(|e| e.id);
 104                        let mut sorted_excerpts = sorted_excerpts.into_iter().peekable();
 105
 106                        while let Some(excerpt) = sorted_excerpts.next() {
 107                            let Ok(buffer_id) = BufferId::new(excerpt.buffer_id) else {
 108                                continue;
 109                            };
 110
 111                            let mut insert_position = ExcerptId::min();
 112                            for e in &state.excerpts {
 113                                if e.id == excerpt.id {
 114                                    break;
 115                                }
 116                                if e.id < excerpt.id {
 117                                    insert_position = ExcerptId::from_proto(e.id);
 118                                }
 119                            }
 120
 121                            let buffer =
 122                                buffers.iter().find(|b| b.read(cx).remote_id() == buffer_id);
 123
 124                            let Some(excerpt) = deserialize_excerpt_range(excerpt) else {
 125                                continue;
 126                            };
 127
 128                            let Some(buffer) = buffer else { continue };
 129
 130                            multibuffer.insert_excerpts_with_ids_after(
 131                                insert_position,
 132                                buffer.clone(),
 133                                [excerpt],
 134                                cx,
 135                            );
 136                        }
 137                    };
 138
 139                    if let Some(title) = &state.title {
 140                        multibuffer = multibuffer.with_title(title.clone())
 141                    }
 142
 143                    multibuffer
 144                });
 145
 146                cx.new(|cx| {
 147                    let mut editor =
 148                        Editor::for_multibuffer(multibuffer, Some(project.clone()), window, cx);
 149                    editor.remote_id = Some(remote_id);
 150                    editor
 151                })
 152            })?;
 153
 154            update_editor_from_message(
 155                editor.downgrade(),
 156                project,
 157                proto::update_view::Editor {
 158                    selections: state.selections,
 159                    pending_selection: state.pending_selection,
 160                    scroll_top_anchor: state.scroll_top_anchor,
 161                    scroll_x: state.scroll_x,
 162                    scroll_y: state.scroll_y,
 163                    ..Default::default()
 164                },
 165                cx,
 166            )
 167            .await?;
 168
 169            Ok(editor)
 170        }))
 171    }
 172
 173    fn set_leader_peer_id(
 174        &mut self,
 175        leader_peer_id: Option<PeerId>,
 176        window: &mut Window,
 177        cx: &mut Context<Self>,
 178    ) {
 179        self.leader_peer_id = leader_peer_id;
 180        if self.leader_peer_id.is_some() {
 181            self.buffer.update(cx, |buffer, cx| {
 182                buffer.remove_active_selections(cx);
 183            });
 184        } else if self.focus_handle.is_focused(window) {
 185            self.buffer.update(cx, |buffer, cx| {
 186                buffer.set_active_selections(
 187                    &self.selections.disjoint_anchors(),
 188                    self.selections.line_mode,
 189                    self.cursor_shape,
 190                    cx,
 191                );
 192            });
 193        }
 194        cx.notify();
 195    }
 196
 197    fn to_state_proto(&self, _: &Window, cx: &App) -> Option<proto::view::Variant> {
 198        let buffer = self.buffer.read(cx);
 199        if buffer
 200            .as_singleton()
 201            .and_then(|buffer| buffer.read(cx).file())
 202            .map_or(false, |file| file.is_private())
 203        {
 204            return None;
 205        }
 206
 207        let scroll_anchor = self.scroll_manager.anchor();
 208        let excerpts = buffer
 209            .read(cx)
 210            .excerpts()
 211            .map(|(id, buffer, range)| proto::Excerpt {
 212                id: id.to_proto(),
 213                buffer_id: buffer.remote_id().into(),
 214                context_start: Some(serialize_text_anchor(&range.context.start)),
 215                context_end: Some(serialize_text_anchor(&range.context.end)),
 216                primary_start: Some(serialize_text_anchor(&range.primary.start)),
 217                primary_end: Some(serialize_text_anchor(&range.primary.end)),
 218            })
 219            .collect();
 220        let snapshot = buffer.snapshot(cx);
 221
 222        Some(proto::view::Variant::Editor(proto::view::Editor {
 223            singleton: buffer.is_singleton(),
 224            title: (!buffer.is_singleton()).then(|| buffer.title(cx).into()),
 225            excerpts,
 226            scroll_top_anchor: Some(serialize_anchor(&scroll_anchor.anchor, &snapshot)),
 227            scroll_x: scroll_anchor.offset.x,
 228            scroll_y: scroll_anchor.offset.y,
 229            selections: self
 230                .selections
 231                .disjoint_anchors()
 232                .iter()
 233                .map(|s| serialize_selection(s, &snapshot))
 234                .collect(),
 235            pending_selection: self
 236                .selections
 237                .pending_anchor()
 238                .as_ref()
 239                .map(|s| serialize_selection(s, &snapshot)),
 240        }))
 241    }
 242
 243    fn to_follow_event(event: &EditorEvent) -> Option<workspace::item::FollowEvent> {
 244        match event {
 245            EditorEvent::Edited { .. } => Some(FollowEvent::Unfollow),
 246            EditorEvent::SelectionsChanged { local }
 247            | EditorEvent::ScrollPositionChanged { local, .. } => {
 248                if *local {
 249                    Some(FollowEvent::Unfollow)
 250                } else {
 251                    None
 252                }
 253            }
 254            _ => None,
 255        }
 256    }
 257
 258    fn add_event_to_update_proto(
 259        &self,
 260        event: &EditorEvent,
 261        update: &mut Option<proto::update_view::Variant>,
 262        _: &Window,
 263        cx: &App,
 264    ) -> bool {
 265        let update =
 266            update.get_or_insert_with(|| proto::update_view::Variant::Editor(Default::default()));
 267
 268        match update {
 269            proto::update_view::Variant::Editor(update) => match event {
 270                EditorEvent::ExcerptsAdded {
 271                    buffer,
 272                    predecessor,
 273                    excerpts,
 274                } => {
 275                    let buffer_id = buffer.read(cx).remote_id();
 276                    let mut excerpts = excerpts.iter();
 277                    if let Some((id, range)) = excerpts.next() {
 278                        update.inserted_excerpts.push(proto::ExcerptInsertion {
 279                            previous_excerpt_id: Some(predecessor.to_proto()),
 280                            excerpt: serialize_excerpt(buffer_id, id, range),
 281                        });
 282                        update.inserted_excerpts.extend(excerpts.map(|(id, range)| {
 283                            proto::ExcerptInsertion {
 284                                previous_excerpt_id: None,
 285                                excerpt: serialize_excerpt(buffer_id, id, range),
 286                            }
 287                        }))
 288                    }
 289                    true
 290                }
 291                EditorEvent::ExcerptsRemoved { ids } => {
 292                    update
 293                        .deleted_excerpts
 294                        .extend(ids.iter().map(ExcerptId::to_proto));
 295                    true
 296                }
 297                EditorEvent::ScrollPositionChanged { autoscroll, .. } if !autoscroll => {
 298                    let snapshot = self.buffer.read(cx).snapshot(cx);
 299                    let scroll_anchor = self.scroll_manager.anchor();
 300                    update.scroll_top_anchor =
 301                        Some(serialize_anchor(&scroll_anchor.anchor, &snapshot));
 302                    update.scroll_x = scroll_anchor.offset.x;
 303                    update.scroll_y = scroll_anchor.offset.y;
 304                    true
 305                }
 306                EditorEvent::SelectionsChanged { .. } => {
 307                    let snapshot = self.buffer.read(cx).snapshot(cx);
 308                    update.selections = self
 309                        .selections
 310                        .disjoint_anchors()
 311                        .iter()
 312                        .map(|s| serialize_selection(s, &snapshot))
 313                        .collect();
 314                    update.pending_selection = self
 315                        .selections
 316                        .pending_anchor()
 317                        .as_ref()
 318                        .map(|s| serialize_selection(s, &snapshot));
 319                    true
 320                }
 321                _ => false,
 322            },
 323        }
 324    }
 325
 326    fn apply_update_proto(
 327        &mut self,
 328        project: &Entity<Project>,
 329        message: update_view::Variant,
 330        window: &mut Window,
 331        cx: &mut Context<Self>,
 332    ) -> Task<Result<()>> {
 333        let update_view::Variant::Editor(message) = message;
 334        let project = project.clone();
 335        cx.spawn_in(window, async move |this, cx| {
 336            update_editor_from_message(this, project, message, cx).await
 337        })
 338    }
 339
 340    fn is_project_item(&self, _window: &Window, _cx: &App) -> bool {
 341        true
 342    }
 343
 344    fn dedup(&self, existing: &Self, _: &Window, cx: &App) -> Option<Dedup> {
 345        let self_singleton = self.buffer.read(cx).as_singleton()?;
 346        let other_singleton = existing.buffer.read(cx).as_singleton()?;
 347        if self_singleton == other_singleton {
 348            Some(Dedup::KeepExisting)
 349        } else {
 350            None
 351        }
 352    }
 353}
 354
 355async fn update_editor_from_message(
 356    this: WeakEntity<Editor>,
 357    project: Entity<Project>,
 358    message: proto::update_view::Editor,
 359    cx: &mut AsyncWindowContext,
 360) -> Result<()> {
 361    // Open all of the buffers of which excerpts were added to the editor.
 362    let inserted_excerpt_buffer_ids = message
 363        .inserted_excerpts
 364        .iter()
 365        .filter_map(|insertion| Some(insertion.excerpt.as_ref()?.buffer_id))
 366        .collect::<HashSet<_>>();
 367    let inserted_excerpt_buffers = project.update(cx, |project, cx| {
 368        inserted_excerpt_buffer_ids
 369            .into_iter()
 370            .map(|id| BufferId::new(id).map(|id| project.open_buffer_by_id(id, cx)))
 371            .collect::<Result<Vec<_>>>()
 372    })??;
 373    let _inserted_excerpt_buffers = try_join_all(inserted_excerpt_buffers).await?;
 374
 375    // Update the editor's excerpts.
 376    this.update(cx, |editor, cx| {
 377        editor.buffer.update(cx, |multibuffer, cx| {
 378            let mut removed_excerpt_ids = message
 379                .deleted_excerpts
 380                .into_iter()
 381                .map(ExcerptId::from_proto)
 382                .collect::<Vec<_>>();
 383            removed_excerpt_ids.sort_by({
 384                let multibuffer = multibuffer.read(cx);
 385                move |a, b| a.cmp(b, &multibuffer)
 386            });
 387
 388            let mut insertions = message.inserted_excerpts.into_iter().peekable();
 389            while let Some(insertion) = insertions.next() {
 390                let Some(excerpt) = insertion.excerpt else {
 391                    continue;
 392                };
 393                let Some(previous_excerpt_id) = insertion.previous_excerpt_id else {
 394                    continue;
 395                };
 396                let buffer_id = BufferId::new(excerpt.buffer_id)?;
 397                let Some(buffer) = project.read(cx).buffer_for_id(buffer_id, cx) else {
 398                    continue;
 399                };
 400
 401                let adjacent_excerpts = iter::from_fn(|| {
 402                    let insertion = insertions.peek()?;
 403                    if insertion.previous_excerpt_id.is_none()
 404                        && insertion.excerpt.as_ref()?.buffer_id == u64::from(buffer_id)
 405                    {
 406                        insertions.next()?.excerpt
 407                    } else {
 408                        None
 409                    }
 410                });
 411
 412                multibuffer.insert_excerpts_with_ids_after(
 413                    ExcerptId::from_proto(previous_excerpt_id),
 414                    buffer,
 415                    [excerpt]
 416                        .into_iter()
 417                        .chain(adjacent_excerpts)
 418                        .filter_map(deserialize_excerpt_range),
 419                    cx,
 420                );
 421            }
 422
 423            multibuffer.remove_excerpts(removed_excerpt_ids, cx);
 424            Result::<(), anyhow::Error>::Ok(())
 425        })
 426    })??;
 427
 428    // Deserialize the editor state.
 429    let (selections, pending_selection, scroll_top_anchor) = this.update(cx, |editor, cx| {
 430        let buffer = editor.buffer.read(cx).read(cx);
 431        let selections = message
 432            .selections
 433            .into_iter()
 434            .filter_map(|selection| deserialize_selection(&buffer, selection))
 435            .collect::<Vec<_>>();
 436        let pending_selection = message
 437            .pending_selection
 438            .and_then(|selection| deserialize_selection(&buffer, selection));
 439        let scroll_top_anchor = message
 440            .scroll_top_anchor
 441            .and_then(|anchor| deserialize_anchor(&buffer, anchor));
 442        anyhow::Ok((selections, pending_selection, scroll_top_anchor))
 443    })??;
 444
 445    // Wait until the buffer has received all of the operations referenced by
 446    // the editor's new state.
 447    this.update(cx, |editor, cx| {
 448        editor.buffer.update(cx, |buffer, cx| {
 449            buffer.wait_for_anchors(
 450                selections
 451                    .iter()
 452                    .chain(pending_selection.as_ref())
 453                    .flat_map(|selection| [selection.start, selection.end])
 454                    .chain(scroll_top_anchor),
 455                cx,
 456            )
 457        })
 458    })?
 459    .await?;
 460
 461    // Update the editor's state.
 462    this.update_in(cx, |editor, window, cx| {
 463        if !selections.is_empty() || pending_selection.is_some() {
 464            editor.set_selections_from_remote(selections, pending_selection, window, cx);
 465            editor.request_autoscroll_remotely(Autoscroll::newest(), cx);
 466        } else if let Some(scroll_top_anchor) = scroll_top_anchor {
 467            editor.set_scroll_anchor_remote(
 468                ScrollAnchor {
 469                    anchor: scroll_top_anchor,
 470                    offset: point(message.scroll_x, message.scroll_y),
 471                },
 472                window,
 473                cx,
 474            );
 475        }
 476    })?;
 477    Ok(())
 478}
 479
 480fn serialize_excerpt(
 481    buffer_id: BufferId,
 482    id: &ExcerptId,
 483    range: &ExcerptRange<language::Anchor>,
 484) -> Option<proto::Excerpt> {
 485    Some(proto::Excerpt {
 486        id: id.to_proto(),
 487        buffer_id: buffer_id.into(),
 488        context_start: Some(serialize_text_anchor(&range.context.start)),
 489        context_end: Some(serialize_text_anchor(&range.context.end)),
 490        primary_start: Some(serialize_text_anchor(&range.primary.start)),
 491        primary_end: Some(serialize_text_anchor(&range.primary.end)),
 492    })
 493}
 494
 495fn serialize_selection(
 496    selection: &Selection<Anchor>,
 497    buffer: &MultiBufferSnapshot,
 498) -> proto::Selection {
 499    proto::Selection {
 500        id: selection.id as u64,
 501        start: Some(serialize_anchor(&selection.start, &buffer)),
 502        end: Some(serialize_anchor(&selection.end, &buffer)),
 503        reversed: selection.reversed,
 504    }
 505}
 506
 507fn serialize_anchor(anchor: &Anchor, buffer: &MultiBufferSnapshot) -> proto::EditorAnchor {
 508    proto::EditorAnchor {
 509        excerpt_id: buffer.latest_excerpt_id(anchor.excerpt_id).to_proto(),
 510        anchor: Some(serialize_text_anchor(&anchor.text_anchor)),
 511    }
 512}
 513
 514fn deserialize_excerpt_range(
 515    excerpt: proto::Excerpt,
 516) -> Option<(ExcerptId, ExcerptRange<language::Anchor>)> {
 517    let context = {
 518        let start = language::proto::deserialize_anchor(excerpt.context_start?)?;
 519        let end = language::proto::deserialize_anchor(excerpt.context_end?)?;
 520        start..end
 521    };
 522    let primary = excerpt
 523        .primary_start
 524        .zip(excerpt.primary_end)
 525        .and_then(|(start, end)| {
 526            let start = language::proto::deserialize_anchor(start)?;
 527            let end = language::proto::deserialize_anchor(end)?;
 528            Some(start..end)
 529        })
 530        .unwrap_or_else(|| context.clone());
 531    Some((
 532        ExcerptId::from_proto(excerpt.id),
 533        ExcerptRange { context, primary },
 534    ))
 535}
 536
 537fn deserialize_selection(
 538    buffer: &MultiBufferSnapshot,
 539    selection: proto::Selection,
 540) -> Option<Selection<Anchor>> {
 541    Some(Selection {
 542        id: selection.id as usize,
 543        start: deserialize_anchor(buffer, selection.start?)?,
 544        end: deserialize_anchor(buffer, selection.end?)?,
 545        reversed: selection.reversed,
 546        goal: SelectionGoal::None,
 547    })
 548}
 549
 550fn deserialize_anchor(buffer: &MultiBufferSnapshot, anchor: proto::EditorAnchor) -> Option<Anchor> {
 551    let excerpt_id = ExcerptId::from_proto(anchor.excerpt_id);
 552    Some(Anchor {
 553        excerpt_id,
 554        text_anchor: language::proto::deserialize_anchor(anchor.anchor?)?,
 555        buffer_id: buffer.buffer_id_for_excerpt(excerpt_id),
 556        diff_base_anchor: None,
 557    })
 558}
 559
 560impl Item for Editor {
 561    type Event = EditorEvent;
 562
 563    fn navigate(
 564        &mut self,
 565        data: Box<dyn std::any::Any>,
 566        window: &mut Window,
 567        cx: &mut Context<Self>,
 568    ) -> bool {
 569        if let Ok(data) = data.downcast::<NavigationData>() {
 570            let newest_selection = self.selections.newest::<Point>(cx);
 571            let buffer = self.buffer.read(cx).read(cx);
 572            let offset = if buffer.can_resolve(&data.cursor_anchor) {
 573                data.cursor_anchor.to_point(&buffer)
 574            } else {
 575                buffer.clip_point(data.cursor_position, Bias::Left)
 576            };
 577
 578            let mut scroll_anchor = data.scroll_anchor;
 579            if !buffer.can_resolve(&scroll_anchor.anchor) {
 580                scroll_anchor.anchor = buffer.anchor_before(
 581                    buffer.clip_point(Point::new(data.scroll_top_row, 0), Bias::Left),
 582                );
 583            }
 584
 585            drop(buffer);
 586
 587            if newest_selection.head() == offset {
 588                false
 589            } else {
 590                let nav_history = self.nav_history.take();
 591                self.set_scroll_anchor(scroll_anchor, window, cx);
 592                self.change_selections(Some(Autoscroll::fit()), window, cx, |s| {
 593                    s.select_ranges([offset..offset])
 594                });
 595                self.nav_history = nav_history;
 596                true
 597            }
 598        } else {
 599            false
 600        }
 601    }
 602
 603    fn tab_tooltip_text(&self, cx: &App) -> Option<SharedString> {
 604        let file_path = self
 605            .buffer()
 606            .read(cx)
 607            .as_singleton()?
 608            .read(cx)
 609            .file()
 610            .and_then(|f| f.as_local())?
 611            .abs_path(cx);
 612
 613        let file_path = file_path.compact().to_string_lossy().to_string();
 614
 615        Some(file_path.into())
 616    }
 617
 618    fn telemetry_event_text(&self) -> Option<&'static str> {
 619        None
 620    }
 621
 622    fn tab_description(&self, detail: usize, cx: &App) -> Option<SharedString> {
 623        let path = path_for_buffer(&self.buffer, detail, true, cx)?;
 624        Some(path.to_string_lossy().to_string().into())
 625    }
 626
 627    fn tab_icon(&self, _: &Window, cx: &App) -> Option<Icon> {
 628        ItemSettings::get_global(cx)
 629            .file_icons
 630            .then(|| {
 631                path_for_buffer(&self.buffer, 0, true, cx)
 632                    .and_then(|path| FileIcons::get_icon(path.as_ref(), cx))
 633            })
 634            .flatten()
 635            .map(Icon::from_path)
 636    }
 637
 638    fn tab_content(&self, params: TabContentParams, _: &Window, cx: &App) -> AnyElement {
 639        let label_color = if ItemSettings::get_global(cx).git_status {
 640            self.buffer()
 641                .read(cx)
 642                .as_singleton()
 643                .and_then(|buffer| {
 644                    let buffer = buffer.read(cx);
 645                    let path = buffer.project_path(cx)?;
 646                    let buffer_id = buffer.remote_id();
 647                    let project = self.project.as_ref()?.read(cx);
 648                    let entry = project.entry_for_path(&path, cx)?;
 649                    let (repo, repo_path) = project
 650                        .git_store()
 651                        .read(cx)
 652                        .repository_and_path_for_buffer_id(buffer_id, cx)?;
 653                    let status = repo.read(cx).status_for_path(&repo_path)?.status;
 654
 655                    Some(entry_git_aware_label_color(
 656                        status.summary(),
 657                        entry.is_ignored,
 658                        params.selected,
 659                    ))
 660                })
 661                .unwrap_or_else(|| entry_label_color(params.selected))
 662        } else {
 663            entry_label_color(params.selected)
 664        };
 665
 666        let description = params.detail.and_then(|detail| {
 667            let path = path_for_buffer(&self.buffer, detail, false, cx)?;
 668            let description = path.to_string_lossy();
 669            let description = description.trim();
 670
 671            if description.is_empty() {
 672                return None;
 673            }
 674
 675            Some(util::truncate_and_trailoff(description, MAX_TAB_TITLE_LEN))
 676        });
 677
 678        // Whether the file was saved in the past but is now deleted.
 679        let was_deleted: bool = self
 680            .buffer()
 681            .read(cx)
 682            .as_singleton()
 683            .and_then(|buffer| buffer.read(cx).file())
 684            .map_or(false, |file| file.disk_state() == DiskState::Deleted);
 685
 686        h_flex()
 687            .gap_2()
 688            .child(
 689                Label::new(self.title(cx).to_string())
 690                    .color(label_color)
 691                    .when(params.preview, |this| this.italic())
 692                    .when(was_deleted, |this| this.strikethrough()),
 693            )
 694            .when_some(description, |this, description| {
 695                this.child(
 696                    Label::new(description)
 697                        .size(LabelSize::XSmall)
 698                        .color(Color::Muted),
 699                )
 700            })
 701            .into_any_element()
 702    }
 703
 704    fn for_each_project_item(
 705        &self,
 706        cx: &App,
 707        f: &mut dyn FnMut(EntityId, &dyn project::ProjectItem),
 708    ) {
 709        self.buffer
 710            .read(cx)
 711            .for_each_buffer(|buffer| f(buffer.entity_id(), buffer.read(cx)));
 712    }
 713
 714    fn is_singleton(&self, cx: &App) -> bool {
 715        self.buffer.read(cx).is_singleton()
 716    }
 717
 718    fn can_save_as(&self, cx: &App) -> bool {
 719        self.buffer.read(cx).is_singleton()
 720    }
 721
 722    fn clone_on_split(
 723        &self,
 724        _workspace_id: Option<WorkspaceId>,
 725        window: &mut Window,
 726        cx: &mut Context<Self>,
 727    ) -> Option<Entity<Editor>>
 728    where
 729        Self: Sized,
 730    {
 731        Some(cx.new(|cx| self.clone(window, cx)))
 732    }
 733
 734    fn set_nav_history(
 735        &mut self,
 736        history: ItemNavHistory,
 737        _window: &mut Window,
 738        _: &mut Context<Self>,
 739    ) {
 740        self.nav_history = Some(history);
 741    }
 742
 743    fn discarded(&self, _project: Entity<Project>, _: &mut Window, cx: &mut Context<Self>) {
 744        for buffer in self.buffer().clone().read(cx).all_buffers() {
 745            buffer.update(cx, |buffer, cx| buffer.discarded(cx))
 746        }
 747    }
 748
 749    fn deactivated(&mut self, _: &mut Window, cx: &mut Context<Self>) {
 750        let selection = self.selections.newest_anchor();
 751        self.push_to_nav_history(selection.head(), None, true, cx);
 752    }
 753
 754    fn workspace_deactivated(&mut self, _: &mut Window, cx: &mut Context<Self>) {
 755        self.hide_hovered_link(cx);
 756    }
 757
 758    fn is_dirty(&self, cx: &App) -> bool {
 759        self.buffer().read(cx).read(cx).is_dirty()
 760    }
 761
 762    fn has_deleted_file(&self, cx: &App) -> bool {
 763        self.buffer().read(cx).read(cx).has_deleted_file()
 764    }
 765
 766    fn has_conflict(&self, cx: &App) -> bool {
 767        self.buffer().read(cx).read(cx).has_conflict()
 768    }
 769
 770    fn can_save(&self, cx: &App) -> bool {
 771        let buffer = &self.buffer().read(cx);
 772        if let Some(buffer) = buffer.as_singleton() {
 773            buffer.read(cx).project_path(cx).is_some()
 774        } else {
 775            true
 776        }
 777    }
 778
 779    fn save(
 780        &mut self,
 781        format: bool,
 782        project: Entity<Project>,
 783        window: &mut Window,
 784        cx: &mut Context<Self>,
 785    ) -> Task<Result<()>> {
 786        self.report_editor_event("Editor Saved", None, cx);
 787        let buffers = self.buffer().clone().read(cx).all_buffers();
 788        let buffers = buffers
 789            .into_iter()
 790            .map(|handle| handle.read(cx).base_buffer().unwrap_or(handle.clone()))
 791            .collect::<HashSet<_>>();
 792        cx.spawn_in(window, async move |this, cx| {
 793            if format {
 794                this.update_in(cx, |editor, window, cx| {
 795                    editor.perform_format(
 796                        project.clone(),
 797                        FormatTrigger::Save,
 798                        FormatTarget::Buffers,
 799                        window,
 800                        cx,
 801                    )
 802                })?
 803                .await?;
 804            }
 805
 806            if buffers.len() == 1 {
 807                // Apply full save routine for singleton buffers, to allow to `touch` the file via the editor.
 808                project
 809                    .update(cx, |project, cx| project.save_buffers(buffers, cx))?
 810                    .await?;
 811            } else {
 812                // For multi-buffers, only format and save the buffers with changes.
 813                // For clean buffers, we simulate saving by calling `Buffer::did_save`,
 814                // so that language servers or other downstream listeners of save events get notified.
 815                let (dirty_buffers, clean_buffers) = buffers.into_iter().partition(|buffer| {
 816                    buffer
 817                        .update(cx, |buffer, _| buffer.is_dirty() || buffer.has_conflict())
 818                        .unwrap_or(false)
 819                });
 820
 821                project
 822                    .update(cx, |project, cx| project.save_buffers(dirty_buffers, cx))?
 823                    .await?;
 824                for buffer in clean_buffers {
 825                    buffer
 826                        .update(cx, |buffer, cx| {
 827                            let version = buffer.saved_version().clone();
 828                            let mtime = buffer.saved_mtime();
 829                            buffer.did_save(version, mtime, cx);
 830                        })
 831                        .ok();
 832                }
 833            }
 834
 835            Ok(())
 836        })
 837    }
 838
 839    fn save_as(
 840        &mut self,
 841        project: Entity<Project>,
 842        path: ProjectPath,
 843        _: &mut Window,
 844        cx: &mut Context<Self>,
 845    ) -> Task<Result<()>> {
 846        let buffer = self
 847            .buffer()
 848            .read(cx)
 849            .as_singleton()
 850            .expect("cannot call save_as on an excerpt list");
 851
 852        let file_extension = path
 853            .path
 854            .extension()
 855            .map(|a| a.to_string_lossy().to_string());
 856        self.report_editor_event("Editor Saved", file_extension, cx);
 857
 858        project.update(cx, |project, cx| project.save_buffer_as(buffer, path, cx))
 859    }
 860
 861    fn reload(
 862        &mut self,
 863        project: Entity<Project>,
 864        window: &mut Window,
 865        cx: &mut Context<Self>,
 866    ) -> Task<Result<()>> {
 867        let buffer = self.buffer().clone();
 868        let buffers = self.buffer.read(cx).all_buffers();
 869        let reload_buffers =
 870            project.update(cx, |project, cx| project.reload_buffers(buffers, true, cx));
 871        cx.spawn_in(window, async move |this, cx| {
 872            let transaction = reload_buffers.log_err().await;
 873            this.update(cx, |editor, cx| {
 874                editor.request_autoscroll(Autoscroll::fit(), cx)
 875            })?;
 876            buffer
 877                .update(cx, |buffer, cx| {
 878                    if let Some(transaction) = transaction {
 879                        if !buffer.is_singleton() {
 880                            buffer.push_transaction(&transaction.0, cx);
 881                        }
 882                    }
 883                })
 884                .ok();
 885            Ok(())
 886        })
 887    }
 888
 889    fn as_searchable(&self, handle: &Entity<Self>) -> Option<Box<dyn SearchableItemHandle>> {
 890        Some(Box::new(handle.clone()))
 891    }
 892
 893    fn pixel_position_of_cursor(&self, _: &App) -> Option<gpui::Point<Pixels>> {
 894        self.pixel_position_of_newest_cursor
 895    }
 896
 897    fn breadcrumb_location(&self, _: &App) -> ToolbarItemLocation {
 898        if self.show_breadcrumbs {
 899            ToolbarItemLocation::PrimaryLeft
 900        } else {
 901            ToolbarItemLocation::Hidden
 902        }
 903    }
 904
 905    fn breadcrumbs(&self, variant: &Theme, cx: &App) -> Option<Vec<BreadcrumbText>> {
 906        let cursor = self.selections.newest_anchor().head();
 907        let multibuffer = &self.buffer().read(cx);
 908        let (buffer_id, symbols) =
 909            multibuffer.symbols_containing(cursor, Some(variant.syntax()), cx)?;
 910        let buffer = multibuffer.buffer(buffer_id)?;
 911
 912        let buffer = buffer.read(cx);
 913        let text = self.breadcrumb_header.clone().unwrap_or_else(|| {
 914            buffer
 915                .snapshot()
 916                .resolve_file_path(
 917                    cx,
 918                    self.project
 919                        .as_ref()
 920                        .map(|project| project.read(cx).visible_worktrees(cx).count() > 1)
 921                        .unwrap_or_default(),
 922                )
 923                .map(|path| path.to_string_lossy().to_string())
 924                .unwrap_or_else(|| {
 925                    if multibuffer.is_singleton() {
 926                        multibuffer.title(cx).to_string()
 927                    } else {
 928                        "untitled".to_string()
 929                    }
 930                })
 931        });
 932
 933        let settings = ThemeSettings::get_global(cx);
 934
 935        let mut breadcrumbs = vec![BreadcrumbText {
 936            text,
 937            highlights: None,
 938            font: Some(settings.buffer_font.clone()),
 939        }];
 940
 941        breadcrumbs.extend(symbols.into_iter().map(|symbol| BreadcrumbText {
 942            text: symbol.text,
 943            highlights: Some(symbol.highlight_ranges),
 944            font: Some(settings.buffer_font.clone()),
 945        }));
 946        Some(breadcrumbs)
 947    }
 948
 949    fn added_to_workspace(
 950        &mut self,
 951        workspace: &mut Workspace,
 952        _window: &mut Window,
 953        _: &mut Context<Self>,
 954    ) {
 955        self.workspace = Some((workspace.weak_handle(), workspace.database_id()));
 956    }
 957
 958    fn to_item_events(event: &EditorEvent, mut f: impl FnMut(ItemEvent)) {
 959        match event {
 960            EditorEvent::Closed => f(ItemEvent::CloseItem),
 961
 962            EditorEvent::Saved | EditorEvent::TitleChanged => {
 963                f(ItemEvent::UpdateTab);
 964                f(ItemEvent::UpdateBreadcrumbs);
 965            }
 966
 967            EditorEvent::Reparsed(_) => {
 968                f(ItemEvent::UpdateBreadcrumbs);
 969            }
 970
 971            EditorEvent::SelectionsChanged { local } if *local => {
 972                f(ItemEvent::UpdateBreadcrumbs);
 973            }
 974
 975            EditorEvent::DirtyChanged => {
 976                f(ItemEvent::UpdateTab);
 977            }
 978
 979            EditorEvent::BufferEdited => {
 980                f(ItemEvent::Edit);
 981                f(ItemEvent::UpdateBreadcrumbs);
 982            }
 983
 984            EditorEvent::ExcerptsAdded { .. } | EditorEvent::ExcerptsRemoved { .. } => {
 985                f(ItemEvent::Edit);
 986            }
 987
 988            _ => {}
 989        }
 990    }
 991
 992    fn preserve_preview(&self, cx: &App) -> bool {
 993        self.buffer.read(cx).preserve_preview(cx)
 994    }
 995}
 996
 997impl SerializableItem for Editor {
 998    fn serialized_item_kind() -> &'static str {
 999        "Editor"
1000    }
1001
1002    fn cleanup(
1003        workspace_id: WorkspaceId,
1004        alive_items: Vec<ItemId>,
1005        window: &mut Window,
1006        cx: &mut App,
1007    ) -> Task<Result<()>> {
1008        window.spawn(cx, async move |_| {
1009            DB.delete_unloaded_items(workspace_id, alive_items).await
1010        })
1011    }
1012
1013    fn deserialize(
1014        project: Entity<Project>,
1015        workspace: WeakEntity<Workspace>,
1016        workspace_id: workspace::WorkspaceId,
1017        item_id: ItemId,
1018        window: &mut Window,
1019        cx: &mut App,
1020    ) -> Task<Result<Entity<Self>>> {
1021        let serialized_editor = match DB
1022            .get_serialized_editor(item_id, workspace_id)
1023            .context("Failed to query editor state")
1024        {
1025            Ok(Some(serialized_editor)) => {
1026                if ProjectSettings::get_global(cx)
1027                    .session
1028                    .restore_unsaved_buffers
1029                {
1030                    serialized_editor
1031                } else {
1032                    SerializedEditor {
1033                        abs_path: serialized_editor.abs_path,
1034                        contents: None,
1035                        language: None,
1036                        mtime: None,
1037                    }
1038                }
1039            }
1040            Ok(None) => {
1041                return Task::ready(Err(anyhow!("No path or contents found for buffer")));
1042            }
1043            Err(error) => {
1044                return Task::ready(Err(error));
1045            }
1046        };
1047
1048        match serialized_editor {
1049            SerializedEditor {
1050                abs_path: None,
1051                contents: Some(contents),
1052                language,
1053                ..
1054            } => window.spawn(cx, {
1055                let project = project.clone();
1056                async move |cx| {
1057                    let language_registry =
1058                        project.update(cx, |project, _| project.languages().clone())?;
1059
1060                    let language = if let Some(language_name) = language {
1061                        // We don't fail here, because we'd rather not set the language if the name changed
1062                        // than fail to restore the buffer.
1063                        language_registry
1064                            .language_for_name(&language_name)
1065                            .await
1066                            .ok()
1067                    } else {
1068                        None
1069                    };
1070
1071                    // First create the empty buffer
1072                    let buffer = project
1073                        .update(cx, |project, cx| project.create_buffer(cx))?
1074                        .await?;
1075
1076                    // Then set the text so that the dirty bit is set correctly
1077                    buffer.update(cx, |buffer, cx| {
1078                        buffer.set_language_registry(language_registry);
1079                        if let Some(language) = language {
1080                            buffer.set_language(Some(language), cx);
1081                        }
1082                        buffer.set_text(contents, cx);
1083                        if let Some(entry) = buffer.peek_undo_stack() {
1084                            buffer.forget_transaction(entry.transaction_id());
1085                        }
1086                    })?;
1087
1088                    cx.update(|window, cx| {
1089                        cx.new(|cx| {
1090                            let mut editor = Editor::for_buffer(buffer, Some(project), window, cx);
1091
1092                            editor.read_metadata_from_db(item_id, workspace_id, window, cx);
1093                            editor
1094                        })
1095                    })
1096                }
1097            }),
1098            SerializedEditor {
1099                abs_path: Some(abs_path),
1100                contents,
1101                mtime,
1102                ..
1103            } => {
1104                let project_item = project.update(cx, |project, cx| {
1105                    let (worktree, path) = project.find_worktree(&abs_path, cx)?;
1106                    let project_path = ProjectPath {
1107                        worktree_id: worktree.read(cx).id(),
1108                        path: path.into(),
1109                    };
1110                    Some(project.open_path(project_path, cx))
1111                });
1112
1113                match project_item {
1114                    Some(project_item) => {
1115                        window.spawn(cx, async move |cx| {
1116                            let (_, project_item) = project_item.await?;
1117                            let buffer = project_item.downcast::<Buffer>().map_err(|_| {
1118                                anyhow!("Project item at stored path was not a buffer")
1119                            })?;
1120
1121                            // This is a bit wasteful: we're loading the whole buffer from
1122                            // disk and then overwrite the content.
1123                            // But for now, it keeps the implementation of the content serialization
1124                            // simple, because we don't have to persist all of the metadata that we get
1125                            // by loading the file (git diff base, ...).
1126                            if let Some(buffer_text) = contents {
1127                                buffer.update(cx, |buffer, cx| {
1128                                    // If we did restore an mtime, we want to store it on the buffer
1129                                    // so that the next edit will mark the buffer as dirty/conflicted.
1130                                    if mtime.is_some() {
1131                                        buffer.did_reload(
1132                                            buffer.version(),
1133                                            buffer.line_ending(),
1134                                            mtime,
1135                                            cx,
1136                                        );
1137                                    }
1138                                    buffer.set_text(buffer_text, cx);
1139                                    if let Some(entry) = buffer.peek_undo_stack() {
1140                                        buffer.forget_transaction(entry.transaction_id());
1141                                    }
1142                                })?;
1143                            }
1144
1145                            cx.update(|window, cx| {
1146                                cx.new(|cx| {
1147                                    let mut editor =
1148                                        Editor::for_buffer(buffer, Some(project), window, cx);
1149
1150                                    editor.read_metadata_from_db(item_id, workspace_id, window, cx);
1151                                    editor
1152                                })
1153                            })
1154                        })
1155                    }
1156                    None => {
1157                        let open_by_abs_path = workspace.update(cx, |workspace, cx| {
1158                            workspace.open_abs_path(
1159                                abs_path.clone(),
1160                                OpenOptions {
1161                                    visible: Some(OpenVisible::None),
1162                                    ..Default::default()
1163                                },
1164                                window,
1165                                cx,
1166                            )
1167                        });
1168                        window.spawn(cx, async move |cx| {
1169                            let editor = open_by_abs_path?.await?.downcast::<Editor>().with_context(|| format!("Failed to downcast to Editor after opening abs path {abs_path:?}"))?;
1170                            editor.update_in(cx, |editor, window, cx| {
1171                                editor.read_metadata_from_db(item_id, workspace_id, window, cx);
1172                            })?;
1173                            Ok(editor)
1174                        })
1175                    }
1176                }
1177            }
1178            SerializedEditor {
1179                abs_path: None,
1180                contents: None,
1181                ..
1182            } => Task::ready(Err(anyhow!("No path or contents found for buffer"))),
1183        }
1184    }
1185
1186    fn serialize(
1187        &mut self,
1188        workspace: &mut Workspace,
1189        item_id: ItemId,
1190        closing: bool,
1191        window: &mut Window,
1192        cx: &mut Context<Self>,
1193    ) -> Option<Task<Result<()>>> {
1194        let mut serialize_dirty_buffers = self.serialize_dirty_buffers;
1195
1196        let project = self.project.clone()?;
1197        if project.read(cx).visible_worktrees(cx).next().is_none() {
1198            // If we don't have a worktree, we don't serialize, because
1199            // projects without worktrees aren't deserialized.
1200            serialize_dirty_buffers = false;
1201        }
1202
1203        if closing && !serialize_dirty_buffers {
1204            return None;
1205        }
1206
1207        let workspace_id = workspace.database_id()?;
1208
1209        let buffer = self.buffer().read(cx).as_singleton()?;
1210
1211        let abs_path = buffer.read(cx).file().and_then(|file| {
1212            let worktree_id = file.worktree_id(cx);
1213            project
1214                .read(cx)
1215                .worktree_for_id(worktree_id, cx)
1216                .and_then(|worktree| worktree.read(cx).absolutize(&file.path()).ok())
1217                .or_else(|| {
1218                    let full_path = file.full_path(cx);
1219                    let project_path = project.read(cx).find_project_path(&full_path, cx)?;
1220                    project.read(cx).absolute_path(&project_path, cx)
1221                })
1222        });
1223
1224        let is_dirty = buffer.read(cx).is_dirty();
1225        let mtime = buffer.read(cx).saved_mtime();
1226
1227        let snapshot = buffer.read(cx).snapshot();
1228
1229        Some(cx.spawn_in(window, async move |_this, cx| {
1230            cx.background_spawn(async move {
1231                let (contents, language) = if serialize_dirty_buffers && is_dirty {
1232                    let contents = snapshot.text();
1233                    let language = snapshot.language().map(|lang| lang.name().to_string());
1234                    (Some(contents), language)
1235                } else {
1236                    (None, None)
1237                };
1238
1239                let editor = SerializedEditor {
1240                    abs_path,
1241                    contents,
1242                    language,
1243                    mtime,
1244                };
1245                DB.save_serialized_editor(item_id, workspace_id, editor)
1246                    .await
1247                    .context("failed to save serialized editor")
1248            })
1249            .await
1250            .context("failed to save contents of buffer")?;
1251
1252            Ok(())
1253        }))
1254    }
1255
1256    fn should_serialize(&self, event: &Self::Event) -> bool {
1257        matches!(
1258            event,
1259            EditorEvent::Saved | EditorEvent::DirtyChanged | EditorEvent::BufferEdited
1260        )
1261    }
1262}
1263
1264#[derive(Debug, Default)]
1265struct EditorRestorationData {
1266    entries: HashMap<PathBuf, RestorationData>,
1267}
1268
1269#[derive(Default, Debug)]
1270pub struct RestorationData {
1271    pub scroll_position: (BufferRow, gpui::Point<f32>),
1272    pub folds: Vec<Range<Point>>,
1273    pub selections: Vec<Range<Point>>,
1274}
1275
1276impl ProjectItem for Editor {
1277    type Item = Buffer;
1278
1279    fn project_item_kind() -> Option<ProjectItemKind> {
1280        Some(ProjectItemKind("Editor"))
1281    }
1282
1283    fn for_project_item(
1284        project: Entity<Project>,
1285        pane: &Pane,
1286        buffer: Entity<Buffer>,
1287        window: &mut Window,
1288        cx: &mut Context<Self>,
1289    ) -> Self {
1290        let mut editor = Self::for_buffer(buffer.clone(), Some(project), window, cx);
1291        if let Some((excerpt_id, buffer_id, snapshot)) =
1292            editor.buffer().read(cx).snapshot(cx).as_singleton()
1293        {
1294            if WorkspaceSettings::get(None, cx).restore_on_file_reopen {
1295                if let Some(restoration_data) = Self::project_item_kind()
1296                    .and_then(|kind| pane.project_item_restoration_data.get(&kind))
1297                    .and_then(|data| data.downcast_ref::<EditorRestorationData>())
1298                    .and_then(|data| {
1299                        let file = project::File::from_dyn(buffer.read(cx).file())?;
1300                        data.entries.get(&file.abs_path(cx))
1301                    })
1302                {
1303                    editor.fold_ranges(
1304                        clip_ranges(&restoration_data.folds, &snapshot),
1305                        false,
1306                        window,
1307                        cx,
1308                    );
1309                    if !restoration_data.selections.is_empty() {
1310                        editor.change_selections(None, window, cx, |s| {
1311                            s.select_ranges(clip_ranges(&restoration_data.selections, &snapshot));
1312                        });
1313                    }
1314                    let (top_row, offset) = restoration_data.scroll_position;
1315                    let anchor = Anchor::in_buffer(
1316                        *excerpt_id,
1317                        buffer_id,
1318                        snapshot.anchor_before(Point::new(top_row, 0)),
1319                    );
1320                    editor.set_scroll_anchor(ScrollAnchor { anchor, offset }, window, cx);
1321                }
1322            }
1323        }
1324
1325        editor
1326    }
1327}
1328
1329fn clip_ranges<'a>(
1330    original: impl IntoIterator<Item = &'a Range<Point>> + 'a,
1331    snapshot: &'a BufferSnapshot,
1332) -> Vec<Range<Point>> {
1333    original
1334        .into_iter()
1335        .map(|range| {
1336            snapshot.clip_point(range.start, Bias::Left)
1337                ..snapshot.clip_point(range.end, Bias::Right)
1338        })
1339        .collect()
1340}
1341
1342impl EventEmitter<SearchEvent> for Editor {}
1343
1344impl Editor {
1345    pub fn update_restoration_data(
1346        &self,
1347        cx: &mut Context<Self>,
1348        write: impl for<'a> FnOnce(&'a mut RestorationData) + 'static,
1349    ) {
1350        if !WorkspaceSettings::get(None, cx).restore_on_file_reopen {
1351            return;
1352        }
1353
1354        let editor = cx.entity();
1355        cx.defer(move |cx| {
1356            editor.update(cx, |editor, cx| {
1357                let kind = Editor::project_item_kind()?;
1358                let pane = editor.workspace()?.read(cx).pane_for(&cx.entity())?;
1359                let buffer = editor.buffer().read(cx).as_singleton()?;
1360                let file_abs_path = project::File::from_dyn(buffer.read(cx).file())?.abs_path(cx);
1361                pane.update(cx, |pane, _| {
1362                    let data = pane
1363                        .project_item_restoration_data
1364                        .entry(kind)
1365                        .or_insert_with(|| Box::new(EditorRestorationData::default()) as Box<_>);
1366                    let data = match data.downcast_mut::<EditorRestorationData>() {
1367                        Some(data) => data,
1368                        None => {
1369                            *data = Box::new(EditorRestorationData::default());
1370                            data.downcast_mut::<EditorRestorationData>()
1371                                .expect("just written the type downcasted to")
1372                        }
1373                    };
1374
1375                    let data = data.entries.entry(file_abs_path).or_default();
1376                    write(data);
1377                    Some(())
1378                })
1379            });
1380        });
1381    }
1382}
1383
1384pub(crate) enum BufferSearchHighlights {}
1385impl SearchableItem for Editor {
1386    type Match = Range<Anchor>;
1387
1388    fn get_matches(&self, _window: &mut Window, _: &mut App) -> Vec<Range<Anchor>> {
1389        self.background_highlights
1390            .get(&TypeId::of::<BufferSearchHighlights>())
1391            .map_or(Vec::new(), |(_color, ranges)| {
1392                ranges.iter().cloned().collect()
1393            })
1394    }
1395
1396    fn clear_matches(&mut self, _: &mut Window, cx: &mut Context<Self>) {
1397        if self
1398            .clear_background_highlights::<BufferSearchHighlights>(cx)
1399            .is_some()
1400        {
1401            cx.emit(SearchEvent::MatchesInvalidated);
1402        }
1403    }
1404
1405    fn update_matches(
1406        &mut self,
1407        matches: &[Range<Anchor>],
1408        _: &mut Window,
1409        cx: &mut Context<Self>,
1410    ) {
1411        let existing_range = self
1412            .background_highlights
1413            .get(&TypeId::of::<BufferSearchHighlights>())
1414            .map(|(_, range)| range.as_ref());
1415        let updated = existing_range != Some(matches);
1416        self.highlight_background::<BufferSearchHighlights>(
1417            matches,
1418            |theme| theme.search_match_background,
1419            cx,
1420        );
1421        if updated {
1422            cx.emit(SearchEvent::MatchesInvalidated);
1423        }
1424    }
1425
1426    fn has_filtered_search_ranges(&mut self) -> bool {
1427        self.has_background_highlights::<SearchWithinRange>()
1428    }
1429
1430    fn toggle_filtered_search_ranges(
1431        &mut self,
1432        enabled: bool,
1433        _: &mut Window,
1434        cx: &mut Context<Self>,
1435    ) {
1436        if self.has_filtered_search_ranges() {
1437            self.previous_search_ranges = self
1438                .clear_background_highlights::<SearchWithinRange>(cx)
1439                .map(|(_, ranges)| ranges)
1440        }
1441
1442        if !enabled {
1443            return;
1444        }
1445
1446        let ranges = self.selections.disjoint_anchor_ranges().collect::<Vec<_>>();
1447        if ranges.iter().any(|s| s.start != s.end) {
1448            self.set_search_within_ranges(&ranges, cx);
1449        } else if let Some(previous_search_ranges) = self.previous_search_ranges.take() {
1450            self.set_search_within_ranges(&previous_search_ranges, cx)
1451        }
1452    }
1453
1454    fn supported_options(&self) -> SearchOptions {
1455        if self.in_project_search {
1456            SearchOptions {
1457                case: true,
1458                word: true,
1459                regex: true,
1460                replacement: false,
1461                selection: false,
1462                find_in_results: true,
1463            }
1464        } else {
1465            SearchOptions {
1466                case: true,
1467                word: true,
1468                regex: true,
1469                replacement: true,
1470                selection: true,
1471                find_in_results: false,
1472            }
1473        }
1474    }
1475
1476    fn query_suggestion(&mut self, window: &mut Window, cx: &mut Context<Self>) -> String {
1477        let setting = EditorSettings::get_global(cx).seed_search_query_from_cursor;
1478        let snapshot = &self.snapshot(window, cx).buffer_snapshot;
1479        let selection = self.selections.newest::<usize>(cx);
1480
1481        match setting {
1482            SeedQuerySetting::Never => String::new(),
1483            SeedQuerySetting::Selection | SeedQuerySetting::Always if !selection.is_empty() => {
1484                let text: String = snapshot
1485                    .text_for_range(selection.start..selection.end)
1486                    .collect();
1487                if text.contains('\n') {
1488                    String::new()
1489                } else {
1490                    text
1491                }
1492            }
1493            SeedQuerySetting::Selection => String::new(),
1494            SeedQuerySetting::Always => {
1495                let (range, kind) = snapshot.surrounding_word(selection.start, true);
1496                if kind == Some(CharKind::Word) {
1497                    let text: String = snapshot.text_for_range(range).collect();
1498                    if !text.trim().is_empty() {
1499                        return text;
1500                    }
1501                }
1502                String::new()
1503            }
1504        }
1505    }
1506
1507    fn activate_match(
1508        &mut self,
1509        index: usize,
1510        matches: &[Range<Anchor>],
1511        window: &mut Window,
1512        cx: &mut Context<Self>,
1513    ) {
1514        self.unfold_ranges(&[matches[index].clone()], false, true, cx);
1515        let range = self.range_for_match(&matches[index]);
1516        self.change_selections(Some(Autoscroll::fit()), window, cx, |s| {
1517            s.select_ranges([range]);
1518        })
1519    }
1520
1521    fn select_matches(
1522        &mut self,
1523        matches: &[Self::Match],
1524        window: &mut Window,
1525        cx: &mut Context<Self>,
1526    ) {
1527        self.unfold_ranges(matches, false, false, cx);
1528        self.change_selections(None, window, cx, |s| {
1529            s.select_ranges(matches.iter().cloned())
1530        });
1531    }
1532    fn replace(
1533        &mut self,
1534        identifier: &Self::Match,
1535        query: &SearchQuery,
1536        window: &mut Window,
1537        cx: &mut Context<Self>,
1538    ) {
1539        let text = self.buffer.read(cx);
1540        let text = text.snapshot(cx);
1541        let text = text.text_for_range(identifier.clone()).collect::<Vec<_>>();
1542        let text: Cow<_> = if text.len() == 1 {
1543            text.first().cloned().unwrap().into()
1544        } else {
1545            let joined_chunks = text.join("");
1546            joined_chunks.into()
1547        };
1548
1549        if let Some(replacement) = query.replacement_for(&text) {
1550            self.transact(window, cx, |this, _, cx| {
1551                this.edit([(identifier.clone(), Arc::from(&*replacement))], cx);
1552            });
1553        }
1554    }
1555    fn replace_all(
1556        &mut self,
1557        matches: &mut dyn Iterator<Item = &Self::Match>,
1558        query: &SearchQuery,
1559        window: &mut Window,
1560        cx: &mut Context<Self>,
1561    ) {
1562        let text = self.buffer.read(cx);
1563        let text = text.snapshot(cx);
1564        let mut edits = vec![];
1565        let mut last_point: Option<Point> = None;
1566
1567        for m in matches {
1568            let point = m.start.to_point(&text);
1569            let text = text.text_for_range(m.clone()).collect::<Vec<_>>();
1570
1571            // Check if the row for the current match is different from the last
1572            // match. If that's not the case and we're still replacing matches
1573            // in the same row/line, skip this match if the `one_match_per_line`
1574            // option is enabled.
1575            if last_point.is_none() {
1576                last_point = Some(point);
1577            } else if last_point.is_some() && point.row != last_point.unwrap().row {
1578                last_point = Some(point);
1579            } else if query.one_match_per_line().is_some_and(|enabled| enabled) {
1580                continue;
1581            }
1582
1583            let text: Cow<_> = if text.len() == 1 {
1584                text.first().cloned().unwrap().into()
1585            } else {
1586                let joined_chunks = text.join("");
1587                joined_chunks.into()
1588            };
1589
1590            if let Some(replacement) = query.replacement_for(&text) {
1591                edits.push((m.clone(), Arc::from(&*replacement)));
1592            }
1593        }
1594
1595        if !edits.is_empty() {
1596            self.transact(window, cx, |this, _, cx| {
1597                this.edit(edits, cx);
1598            });
1599        }
1600    }
1601    fn match_index_for_direction(
1602        &mut self,
1603        matches: &[Range<Anchor>],
1604        current_index: usize,
1605        direction: Direction,
1606        count: usize,
1607        _: &mut Window,
1608        cx: &mut Context<Self>,
1609    ) -> usize {
1610        let buffer = self.buffer().read(cx).snapshot(cx);
1611        let current_index_position = if self.selections.disjoint_anchors().len() == 1 {
1612            self.selections.newest_anchor().head()
1613        } else {
1614            matches[current_index].start
1615        };
1616
1617        let mut count = count % matches.len();
1618        if count == 0 {
1619            return current_index;
1620        }
1621        match direction {
1622            Direction::Next => {
1623                if matches[current_index]
1624                    .start
1625                    .cmp(&current_index_position, &buffer)
1626                    .is_gt()
1627                {
1628                    count -= 1
1629                }
1630
1631                (current_index + count) % matches.len()
1632            }
1633            Direction::Prev => {
1634                if matches[current_index]
1635                    .end
1636                    .cmp(&current_index_position, &buffer)
1637                    .is_lt()
1638                {
1639                    count -= 1;
1640                }
1641
1642                if current_index >= count {
1643                    current_index - count
1644                } else {
1645                    matches.len() - (count - current_index)
1646                }
1647            }
1648        }
1649    }
1650
1651    fn find_matches(
1652        &mut self,
1653        query: Arc<project::search::SearchQuery>,
1654        _: &mut Window,
1655        cx: &mut Context<Self>,
1656    ) -> Task<Vec<Range<Anchor>>> {
1657        let buffer = self.buffer().read(cx).snapshot(cx);
1658        let search_within_ranges = self
1659            .background_highlights
1660            .get(&TypeId::of::<SearchWithinRange>())
1661            .map_or(vec![], |(_color, ranges)| {
1662                ranges.iter().cloned().collect::<Vec<_>>()
1663            });
1664
1665        cx.background_spawn(async move {
1666            let mut ranges = Vec::new();
1667
1668            let search_within_ranges = if search_within_ranges.is_empty() {
1669                vec![buffer.anchor_before(0)..buffer.anchor_after(buffer.len())]
1670            } else {
1671                search_within_ranges
1672            };
1673
1674            for range in search_within_ranges {
1675                for (search_buffer, search_range, excerpt_id, deleted_hunk_anchor) in
1676                    buffer.range_to_buffer_ranges_with_deleted_hunks(range)
1677                {
1678                    ranges.extend(
1679                        query
1680                            .search(search_buffer, Some(search_range.clone()))
1681                            .await
1682                            .into_iter()
1683                            .map(|match_range| {
1684                                if let Some(deleted_hunk_anchor) = deleted_hunk_anchor {
1685                                    let start = search_buffer
1686                                        .anchor_after(search_range.start + match_range.start);
1687                                    let end = search_buffer
1688                                        .anchor_before(search_range.start + match_range.end);
1689                                    Anchor {
1690                                        diff_base_anchor: Some(start),
1691                                        ..deleted_hunk_anchor
1692                                    }..Anchor {
1693                                        diff_base_anchor: Some(end),
1694                                        ..deleted_hunk_anchor
1695                                    }
1696                                } else {
1697                                    let start = search_buffer
1698                                        .anchor_after(search_range.start + match_range.start);
1699                                    let end = search_buffer
1700                                        .anchor_before(search_range.start + match_range.end);
1701                                    Anchor::range_in_buffer(
1702                                        excerpt_id,
1703                                        search_buffer.remote_id(),
1704                                        start..end,
1705                                    )
1706                                }
1707                            }),
1708                    );
1709                }
1710            }
1711
1712            ranges
1713        })
1714    }
1715
1716    fn active_match_index(
1717        &mut self,
1718        direction: Direction,
1719        matches: &[Range<Anchor>],
1720        _: &mut Window,
1721        cx: &mut Context<Self>,
1722    ) -> Option<usize> {
1723        active_match_index(
1724            direction,
1725            matches,
1726            &self.selections.newest_anchor().head(),
1727            &self.buffer().read(cx).snapshot(cx),
1728        )
1729    }
1730
1731    fn search_bar_visibility_changed(&mut self, _: bool, _: &mut Window, _: &mut Context<Self>) {
1732        self.expect_bounds_change = self.last_bounds;
1733    }
1734}
1735
1736pub fn active_match_index(
1737    direction: Direction,
1738    ranges: &[Range<Anchor>],
1739    cursor: &Anchor,
1740    buffer: &MultiBufferSnapshot,
1741) -> Option<usize> {
1742    if ranges.is_empty() {
1743        None
1744    } else {
1745        let r = ranges.binary_search_by(|probe| {
1746            if probe.end.cmp(cursor, buffer).is_lt() {
1747                Ordering::Less
1748            } else if probe.start.cmp(cursor, buffer).is_gt() {
1749                Ordering::Greater
1750            } else {
1751                Ordering::Equal
1752            }
1753        });
1754        match direction {
1755            Direction::Prev => match r {
1756                Ok(i) => Some(i),
1757                Err(i) => Some(i.saturating_sub(1)),
1758            },
1759            Direction::Next => match r {
1760                Ok(i) | Err(i) => Some(cmp::min(i, ranges.len() - 1)),
1761            },
1762        }
1763    }
1764}
1765
1766pub fn entry_label_color(selected: bool) -> Color {
1767    if selected {
1768        Color::Default
1769    } else {
1770        Color::Muted
1771    }
1772}
1773
1774pub fn entry_diagnostic_aware_icon_name_and_color(
1775    diagnostic_severity: Option<DiagnosticSeverity>,
1776) -> Option<(IconName, Color)> {
1777    match diagnostic_severity {
1778        Some(DiagnosticSeverity::ERROR) => Some((IconName::X, Color::Error)),
1779        Some(DiagnosticSeverity::WARNING) => Some((IconName::Triangle, Color::Warning)),
1780        _ => None,
1781    }
1782}
1783
1784pub fn entry_diagnostic_aware_icon_decoration_and_color(
1785    diagnostic_severity: Option<DiagnosticSeverity>,
1786) -> Option<(IconDecorationKind, Color)> {
1787    match diagnostic_severity {
1788        Some(DiagnosticSeverity::ERROR) => Some((IconDecorationKind::X, Color::Error)),
1789        Some(DiagnosticSeverity::WARNING) => Some((IconDecorationKind::Triangle, Color::Warning)),
1790        _ => None,
1791    }
1792}
1793
1794pub fn entry_git_aware_label_color(git_status: GitSummary, ignored: bool, selected: bool) -> Color {
1795    let tracked = git_status.index + git_status.worktree;
1796    if ignored {
1797        Color::Ignored
1798    } else if git_status.conflict > 0 {
1799        Color::Conflict
1800    } else if tracked.modified > 0 {
1801        Color::Modified
1802    } else if tracked.added > 0 || git_status.untracked > 0 {
1803        Color::Created
1804    } else {
1805        entry_label_color(selected)
1806    }
1807}
1808
1809fn path_for_buffer<'a>(
1810    buffer: &Entity<MultiBuffer>,
1811    height: usize,
1812    include_filename: bool,
1813    cx: &'a App,
1814) -> Option<Cow<'a, Path>> {
1815    let file = buffer.read(cx).as_singleton()?.read(cx).file()?;
1816    path_for_file(file.as_ref(), height, include_filename, cx)
1817}
1818
1819fn path_for_file<'a>(
1820    file: &'a dyn language::File,
1821    mut height: usize,
1822    include_filename: bool,
1823    cx: &'a App,
1824) -> Option<Cow<'a, Path>> {
1825    // Ensure we always render at least the filename.
1826    height += 1;
1827
1828    let mut prefix = file.path().as_ref();
1829    while height > 0 {
1830        if let Some(parent) = prefix.parent() {
1831            prefix = parent;
1832            height -= 1;
1833        } else {
1834            break;
1835        }
1836    }
1837
1838    // Here we could have just always used `full_path`, but that is very
1839    // allocation-heavy and so we try to use a `Cow<Path>` if we haven't
1840    // traversed all the way up to the worktree's root.
1841    if height > 0 {
1842        let full_path = file.full_path(cx);
1843        if include_filename {
1844            Some(full_path.into())
1845        } else {
1846            Some(full_path.parent()?.to_path_buf().into())
1847        }
1848    } else {
1849        let mut path = file.path().strip_prefix(prefix).ok()?;
1850        if !include_filename {
1851            path = path.parent()?;
1852        }
1853        Some(path.into())
1854    }
1855}
1856
1857#[cfg(test)]
1858mod tests {
1859    use crate::editor_tests::init_test;
1860    use fs::Fs;
1861
1862    use super::*;
1863    use fs::MTime;
1864    use gpui::{App, VisualTestContext};
1865    use language::{LanguageMatcher, TestFile};
1866    use project::FakeFs;
1867    use std::path::{Path, PathBuf};
1868    use util::path;
1869
1870    #[gpui::test]
1871    fn test_path_for_file(cx: &mut App) {
1872        let file = TestFile {
1873            path: Path::new("").into(),
1874            root_name: String::new(),
1875            local_root: None,
1876        };
1877        assert_eq!(path_for_file(&file, 0, false, cx), None);
1878    }
1879
1880    async fn deserialize_editor(
1881        item_id: ItemId,
1882        workspace_id: WorkspaceId,
1883        workspace: Entity<Workspace>,
1884        project: Entity<Project>,
1885        cx: &mut VisualTestContext,
1886    ) -> Entity<Editor> {
1887        workspace
1888            .update_in(cx, |workspace, window, cx| {
1889                let pane = workspace.active_pane();
1890                pane.update(cx, |_, cx| {
1891                    Editor::deserialize(
1892                        project.clone(),
1893                        workspace.weak_handle(),
1894                        workspace_id,
1895                        item_id,
1896                        window,
1897                        cx,
1898                    )
1899                })
1900            })
1901            .await
1902            .unwrap()
1903    }
1904
1905    fn rust_language() -> Arc<language::Language> {
1906        Arc::new(language::Language::new(
1907            language::LanguageConfig {
1908                name: "Rust".into(),
1909                matcher: LanguageMatcher {
1910                    path_suffixes: vec!["rs".to_string()],
1911                    ..Default::default()
1912                },
1913                ..Default::default()
1914            },
1915            Some(tree_sitter_rust::LANGUAGE.into()),
1916        ))
1917    }
1918
1919    #[gpui::test]
1920    async fn test_deserialize(cx: &mut gpui::TestAppContext) {
1921        init_test(cx, |_| {});
1922
1923        let fs = FakeFs::new(cx.executor());
1924        fs.insert_file(path!("/file.rs"), Default::default()).await;
1925
1926        // Test case 1: Deserialize with path and contents
1927        {
1928            let project = Project::test(fs.clone(), [path!("/file.rs").as_ref()], cx).await;
1929            let (workspace, cx) =
1930                cx.add_window_view(|window, cx| Workspace::test_new(project.clone(), window, cx));
1931            let workspace_id = workspace::WORKSPACE_DB.next_id().await.unwrap();
1932            let item_id = 1234 as ItemId;
1933            let mtime = fs
1934                .metadata(Path::new(path!("/file.rs")))
1935                .await
1936                .unwrap()
1937                .unwrap()
1938                .mtime;
1939
1940            let serialized_editor = SerializedEditor {
1941                abs_path: Some(PathBuf::from(path!("/file.rs"))),
1942                contents: Some("fn main() {}".to_string()),
1943                language: Some("Rust".to_string()),
1944                mtime: Some(mtime),
1945            };
1946
1947            DB.save_serialized_editor(item_id, workspace_id, serialized_editor.clone())
1948                .await
1949                .unwrap();
1950
1951            let deserialized =
1952                deserialize_editor(item_id, workspace_id, workspace, project, cx).await;
1953
1954            deserialized.update(cx, |editor, cx| {
1955                assert_eq!(editor.text(cx), "fn main() {}");
1956                assert!(editor.is_dirty(cx));
1957                assert!(!editor.has_conflict(cx));
1958                let buffer = editor.buffer().read(cx).as_singleton().unwrap().read(cx);
1959                assert!(buffer.file().is_some());
1960            });
1961        }
1962
1963        // Test case 2: Deserialize with only path
1964        {
1965            let project = Project::test(fs.clone(), [path!("/file.rs").as_ref()], cx).await;
1966            let (workspace, cx) =
1967                cx.add_window_view(|window, cx| Workspace::test_new(project.clone(), window, cx));
1968
1969            let workspace_id = workspace::WORKSPACE_DB.next_id().await.unwrap();
1970
1971            let item_id = 5678 as ItemId;
1972            let serialized_editor = SerializedEditor {
1973                abs_path: Some(PathBuf::from(path!("/file.rs"))),
1974                contents: None,
1975                language: None,
1976                mtime: None,
1977            };
1978
1979            DB.save_serialized_editor(item_id, workspace_id, serialized_editor)
1980                .await
1981                .unwrap();
1982
1983            let deserialized =
1984                deserialize_editor(item_id, workspace_id, workspace, project, cx).await;
1985
1986            deserialized.update(cx, |editor, cx| {
1987                assert_eq!(editor.text(cx), ""); // The file should be empty as per our initial setup
1988                assert!(!editor.is_dirty(cx));
1989                assert!(!editor.has_conflict(cx));
1990
1991                let buffer = editor.buffer().read(cx).as_singleton().unwrap().read(cx);
1992                assert!(buffer.file().is_some());
1993            });
1994        }
1995
1996        // Test case 3: Deserialize with no path (untitled buffer, with content and language)
1997        {
1998            let project = Project::test(fs.clone(), [path!("/file.rs").as_ref()], cx).await;
1999            // Add Rust to the language, so that we can restore the language of the buffer
2000            project.update(cx, |project, _| project.languages().add(rust_language()));
2001
2002            let (workspace, cx) =
2003                cx.add_window_view(|window, cx| Workspace::test_new(project.clone(), window, cx));
2004
2005            let workspace_id = workspace::WORKSPACE_DB.next_id().await.unwrap();
2006
2007            let item_id = 9012 as ItemId;
2008            let serialized_editor = SerializedEditor {
2009                abs_path: None,
2010                contents: Some("hello".to_string()),
2011                language: Some("Rust".to_string()),
2012                mtime: None,
2013            };
2014
2015            DB.save_serialized_editor(item_id, workspace_id, serialized_editor)
2016                .await
2017                .unwrap();
2018
2019            let deserialized =
2020                deserialize_editor(item_id, workspace_id, workspace, project, cx).await;
2021
2022            deserialized.update(cx, |editor, cx| {
2023                assert_eq!(editor.text(cx), "hello");
2024                assert!(editor.is_dirty(cx)); // The editor should be dirty for an untitled buffer
2025
2026                let buffer = editor.buffer().read(cx).as_singleton().unwrap().read(cx);
2027                assert_eq!(
2028                    buffer.language().map(|lang| lang.name()),
2029                    Some("Rust".into())
2030                ); // Language should be set to Rust
2031                assert!(buffer.file().is_none()); // The buffer should not have an associated file
2032            });
2033        }
2034
2035        // Test case 4: Deserialize with path, content, and old mtime
2036        {
2037            let project = Project::test(fs.clone(), [path!("/file.rs").as_ref()], cx).await;
2038            let (workspace, cx) =
2039                cx.add_window_view(|window, cx| Workspace::test_new(project.clone(), window, cx));
2040
2041            let workspace_id = workspace::WORKSPACE_DB.next_id().await.unwrap();
2042
2043            let item_id = 9345 as ItemId;
2044            let old_mtime = MTime::from_seconds_and_nanos(0, 50);
2045            let serialized_editor = SerializedEditor {
2046                abs_path: Some(PathBuf::from(path!("/file.rs"))),
2047                contents: Some("fn main() {}".to_string()),
2048                language: Some("Rust".to_string()),
2049                mtime: Some(old_mtime),
2050            };
2051
2052            DB.save_serialized_editor(item_id, workspace_id, serialized_editor)
2053                .await
2054                .unwrap();
2055
2056            let deserialized =
2057                deserialize_editor(item_id, workspace_id, workspace, project, cx).await;
2058
2059            deserialized.update(cx, |editor, cx| {
2060                assert_eq!(editor.text(cx), "fn main() {}");
2061                assert!(editor.has_conflict(cx)); // The editor should have a conflict
2062            });
2063        }
2064    }
2065}