1mod anchor;
   2#[cfg(test)]
   3mod multi_buffer_tests;
   4mod position;
   5
   6pub use anchor::{Anchor, AnchorRangeExt, Offset};
   7pub use position::{TypedOffset, TypedPoint, TypedRow};
   8
   9use anyhow::{Result, anyhow};
  10use buffer_diff::{
  11    BufferDiff, BufferDiffEvent, BufferDiffSnapshot, DiffHunkSecondaryStatus, DiffHunkStatus,
  12    DiffHunkStatusKind,
  13};
  14use clock::ReplicaId;
  15use collections::{BTreeMap, Bound, HashMap, HashSet};
  16use gpui::{App, AppContext as _, Context, Entity, EntityId, EventEmitter, Task};
  17use itertools::Itertools;
  18use language::{
  19    AutoindentMode, Buffer, BufferChunks, BufferRow, BufferSnapshot, Capability, CharClassifier,
  20    CharKind, CharScopeContext, Chunk, CursorShape, DiagnosticEntryRef, DiskState, File,
  21    IndentGuideSettings, IndentSize, Language, LanguageScope, OffsetRangeExt, OffsetUtf16, Outline,
  22    OutlineItem, Point, PointUtf16, Selection, TextDimension, TextObject, ToOffset as _,
  23    ToPoint as _, TransactionId, TreeSitterOptions, Unclipped,
  24    language_settings::{LanguageSettings, language_settings},
  25};
  26
  27use rope::DimensionPair;
  28use smallvec::SmallVec;
  29use smol::future::yield_now;
  30use std::{
  31    any::type_name,
  32    borrow::Cow,
  33    cell::{Cell, Ref, RefCell},
  34    cmp, fmt,
  35    future::Future,
  36    io,
  37    iter::{self, FromIterator},
  38    mem,
  39    ops::{Range, RangeBounds, Sub},
  40    rc::Rc,
  41    str,
  42    sync::Arc,
  43    time::{Duration, Instant},
  44};
  45use sum_tree::{Bias, Cursor, Dimension, Dimensions, SumTree, Summary, TreeMap};
  46use text::{
  47    BufferId, Edit, LineIndent, TextSummary,
  48    locator::Locator,
  49    subscription::{Subscription, Topic},
  50};
  51use theme::SyntaxTheme;
  52use util::{post_inc, rel_path::RelPath};
  53
  54const NEWLINES: &[u8] = &[b'\n'; u8::MAX as usize];
  55
  56#[derive(Debug, Default, Clone, Copy, Hash, PartialEq, Eq, PartialOrd, Ord)]
  57pub struct ExcerptId(u32);
  58
  59/// One or more [`Buffers`](Buffer) being edited in a single view.
  60///
  61/// See <https://zed.dev/features#multi-buffers>
  62pub struct MultiBuffer {
  63    /// A snapshot of the [`Excerpt`]s in the MultiBuffer.
  64    /// Use [`MultiBuffer::snapshot`] to get a up-to-date snapshot.
  65    snapshot: RefCell<MultiBufferSnapshot>,
  66    /// Contains the state of the buffers being edited
  67    buffers: RefCell<HashMap<BufferId, BufferState>>,
  68    // only used by consumers using `set_excerpts_for_buffer`
  69    excerpts_by_path: BTreeMap<PathKey, Vec<ExcerptId>>,
  70    paths_by_excerpt: HashMap<ExcerptId, PathKey>,
  71    diffs: HashMap<BufferId, DiffState>,
  72    // all_diff_hunks_expanded: bool,
  73    subscriptions: Topic,
  74    /// If true, the multi-buffer only contains a single [`Buffer`] and a single [`Excerpt`]
  75    singleton: bool,
  76    history: History,
  77    title: Option<String>,
  78    capability: Capability,
  79    buffer_changed_since_sync: Rc<Cell<bool>>,
  80}
  81
  82#[derive(Clone, Debug, PartialEq, Eq)]
  83pub enum Event {
  84    ExcerptsAdded {
  85        buffer: Entity<Buffer>,
  86        predecessor: ExcerptId,
  87        excerpts: Vec<(ExcerptId, ExcerptRange<language::Anchor>)>,
  88    },
  89    ExcerptsRemoved {
  90        ids: Vec<ExcerptId>,
  91        removed_buffer_ids: Vec<BufferId>,
  92    },
  93    ExcerptsExpanded {
  94        ids: Vec<ExcerptId>,
  95    },
  96    ExcerptsEdited {
  97        excerpt_ids: Vec<ExcerptId>,
  98        buffer_ids: Vec<BufferId>,
  99    },
 100    DiffHunksToggled,
 101    Edited {
 102        edited_buffer: Option<Entity<Buffer>>,
 103    },
 104    TransactionUndone {
 105        transaction_id: TransactionId,
 106    },
 107    Reloaded,
 108    LanguageChanged(BufferId),
 109    Reparsed(BufferId),
 110    Saved,
 111    FileHandleChanged,
 112    DirtyChanged,
 113    DiagnosticsUpdated,
 114    BufferDiffChanged,
 115}
 116
 117/// A diff hunk, representing a range of consequent lines in a multibuffer.
 118#[derive(Debug, Clone, PartialEq, Eq)]
 119pub struct MultiBufferDiffHunk {
 120    /// The row range in the multibuffer where this diff hunk appears.
 121    pub row_range: Range<MultiBufferRow>,
 122    /// The buffer ID that this hunk belongs to.
 123    pub buffer_id: BufferId,
 124    /// The range of the underlying buffer that this hunk corresponds to.
 125    pub buffer_range: Range<text::Anchor>,
 126    /// The excerpt that contains the diff hunk.
 127    pub excerpt_id: ExcerptId,
 128    /// The range within the buffer's diff base that this hunk corresponds to.
 129    pub diff_base_byte_range: Range<usize>,
 130    /// Whether or not this hunk also appears in the 'secondary diff'.
 131    pub secondary_status: DiffHunkSecondaryStatus,
 132}
 133
 134impl MultiBufferDiffHunk {
 135    pub fn status(&self) -> DiffHunkStatus {
 136        let kind = if self.buffer_range.start == self.buffer_range.end {
 137            DiffHunkStatusKind::Deleted
 138        } else if self.diff_base_byte_range.is_empty() {
 139            DiffHunkStatusKind::Added
 140        } else {
 141            DiffHunkStatusKind::Modified
 142        };
 143        DiffHunkStatus {
 144            kind,
 145            secondary: self.secondary_status,
 146        }
 147    }
 148
 149    pub fn is_created_file(&self) -> bool {
 150        self.diff_base_byte_range == (0..0)
 151            && self.buffer_range == (text::Anchor::MIN..text::Anchor::MAX)
 152    }
 153
 154    pub fn multi_buffer_range(&self) -> Range<Anchor> {
 155        let start = Anchor::in_buffer(self.excerpt_id, self.buffer_id, self.buffer_range.start);
 156        let end = Anchor::in_buffer(self.excerpt_id, self.buffer_id, self.buffer_range.end);
 157        start..end
 158    }
 159}
 160
 161#[derive(PartialEq, Eq, Ord, PartialOrd, Clone, Hash, Debug)]
 162pub struct PathKey {
 163    // Used by the derived PartialOrd & Ord
 164    sort_prefix: Option<u64>,
 165    path: Arc<RelPath>,
 166}
 167
 168impl PathKey {
 169    pub fn with_sort_prefix(sort_prefix: u64, path: Arc<RelPath>) -> Self {
 170        Self {
 171            sort_prefix: Some(sort_prefix),
 172            path,
 173        }
 174    }
 175
 176    pub fn for_buffer(buffer: &Entity<Buffer>, cx: &App) -> Self {
 177        if let Some(file) = buffer.read(cx).file() {
 178            Self::with_sort_prefix(file.worktree_id(cx).to_proto(), file.path().clone())
 179        } else {
 180            Self {
 181                sort_prefix: None,
 182                path: RelPath::unix(&buffer.entity_id().to_string())
 183                    .unwrap()
 184                    .into_arc(),
 185            }
 186        }
 187    }
 188
 189    #[cfg(any(test, feature = "test-support"))]
 190    pub fn path(&self) -> &Arc<RelPath> {
 191        &self.path
 192    }
 193}
 194
 195pub type MultiBufferPoint = Point;
 196type ExcerptOffset = TypedOffset<Excerpt>;
 197type ExcerptPoint = TypedPoint<Excerpt>;
 198
 199#[derive(Copy, Clone, Debug, Default, Eq, Ord, PartialOrd, PartialEq, Hash, serde::Deserialize)]
 200#[serde(transparent)]
 201pub struct MultiBufferRow(pub u32);
 202
 203impl MultiBufferRow {
 204    pub const MIN: Self = Self(0);
 205    pub const MAX: Self = Self(u32::MAX);
 206}
 207
 208impl std::ops::Add<usize> for MultiBufferRow {
 209    type Output = Self;
 210
 211    fn add(self, rhs: usize) -> Self::Output {
 212        MultiBufferRow(self.0 + rhs as u32)
 213    }
 214}
 215
 216#[derive(Clone)]
 217struct History {
 218    next_transaction_id: TransactionId,
 219    undo_stack: Vec<Transaction>,
 220    redo_stack: Vec<Transaction>,
 221    transaction_depth: usize,
 222    group_interval: Duration,
 223}
 224
 225#[derive(Clone)]
 226struct Transaction {
 227    id: TransactionId,
 228    buffer_transactions: HashMap<BufferId, text::TransactionId>,
 229    first_edit_at: Instant,
 230    last_edit_at: Instant,
 231    suppress_grouping: bool,
 232}
 233
 234pub trait ToOffset: 'static + fmt::Debug {
 235    fn to_offset(&self, snapshot: &MultiBufferSnapshot) -> usize;
 236}
 237
 238pub trait ToOffsetUtf16: 'static + fmt::Debug {
 239    fn to_offset_utf16(&self, snapshot: &MultiBufferSnapshot) -> OffsetUtf16;
 240}
 241
 242pub trait ToPoint: 'static + fmt::Debug {
 243    fn to_point(&self, snapshot: &MultiBufferSnapshot) -> Point;
 244}
 245
 246pub trait ToPointUtf16: 'static + fmt::Debug {
 247    fn to_point_utf16(&self, snapshot: &MultiBufferSnapshot) -> PointUtf16;
 248}
 249
 250struct BufferState {
 251    buffer: Entity<Buffer>,
 252    last_version: clock::Global,
 253    last_non_text_state_update_count: usize,
 254    excerpts: Vec<Locator>,
 255    _subscriptions: [gpui::Subscription; 2],
 256}
 257
 258struct DiffState {
 259    diff: Entity<BufferDiff>,
 260    _subscription: gpui::Subscription,
 261}
 262
 263impl DiffState {
 264    fn new(diff: Entity<BufferDiff>, cx: &mut Context<MultiBuffer>) -> Self {
 265        DiffState {
 266            _subscription: cx.subscribe(&diff, |this, diff, event, cx| match event {
 267                BufferDiffEvent::DiffChanged { changed_range } => {
 268                    if let Some(changed_range) = changed_range.clone() {
 269                        this.buffer_diff_changed(diff, changed_range, cx)
 270                    }
 271                    cx.emit(Event::BufferDiffChanged);
 272                }
 273                BufferDiffEvent::LanguageChanged => this.buffer_diff_language_changed(diff, cx),
 274                _ => {}
 275            }),
 276            diff,
 277        }
 278    }
 279}
 280
 281/// The contents of a [`MultiBuffer`] at a single point in time.
 282#[derive(Clone, Default)]
 283pub struct MultiBufferSnapshot {
 284    singleton: bool,
 285    excerpts: SumTree<Excerpt>,
 286    excerpt_ids: SumTree<ExcerptIdMapping>,
 287    diffs: TreeMap<BufferId, BufferDiffSnapshot>,
 288    diff_transforms: SumTree<DiffTransform>,
 289    replaced_excerpts: TreeMap<ExcerptId, ExcerptId>,
 290    trailing_excerpt_update_count: usize,
 291    all_diff_hunks_expanded: bool,
 292    non_text_state_update_count: usize,
 293    edit_count: usize,
 294    is_dirty: bool,
 295    has_deleted_file: bool,
 296    has_conflict: bool,
 297    show_headers: bool,
 298}
 299
 300#[derive(Debug, Clone)]
 301enum DiffTransform {
 302    BufferContent {
 303        summary: TextSummary,
 304        inserted_hunk_info: Option<DiffTransformHunkInfo>,
 305    },
 306    DeletedHunk {
 307        summary: TextSummary,
 308        buffer_id: BufferId,
 309        hunk_info: DiffTransformHunkInfo,
 310        base_text_byte_range: Range<usize>,
 311        has_trailing_newline: bool,
 312    },
 313}
 314
 315#[derive(Clone, Copy, Debug)]
 316struct DiffTransformHunkInfo {
 317    excerpt_id: ExcerptId,
 318    hunk_start_anchor: text::Anchor,
 319    hunk_secondary_status: DiffHunkSecondaryStatus,
 320}
 321
 322impl Eq for DiffTransformHunkInfo {}
 323
 324impl PartialEq for DiffTransformHunkInfo {
 325    fn eq(&self, other: &DiffTransformHunkInfo) -> bool {
 326        self.excerpt_id == other.excerpt_id && self.hunk_start_anchor == other.hunk_start_anchor
 327    }
 328}
 329
 330impl std::hash::Hash for DiffTransformHunkInfo {
 331    fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
 332        self.excerpt_id.hash(state);
 333        self.hunk_start_anchor.hash(state);
 334    }
 335}
 336
 337#[derive(Clone)]
 338pub struct ExcerptInfo {
 339    pub id: ExcerptId,
 340    pub buffer: BufferSnapshot,
 341    pub buffer_id: BufferId,
 342    pub range: ExcerptRange<text::Anchor>,
 343    pub end_row: MultiBufferRow,
 344}
 345
 346impl std::fmt::Debug for ExcerptInfo {
 347    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
 348        f.debug_struct(type_name::<Self>())
 349            .field("id", &self.id)
 350            .field("buffer_id", &self.buffer_id)
 351            .field("path", &self.buffer.file().map(|f| f.path()))
 352            .field("range", &self.range)
 353            .finish()
 354    }
 355}
 356
 357/// A boundary between `Excerpt`s in a [`MultiBuffer`]
 358#[derive(Debug)]
 359pub struct ExcerptBoundary {
 360    pub prev: Option<ExcerptInfo>,
 361    pub next: ExcerptInfo,
 362    /// The row in the `MultiBuffer` where the boundary is located
 363    pub row: MultiBufferRow,
 364}
 365
 366impl ExcerptBoundary {
 367    pub fn starts_new_buffer(&self) -> bool {
 368        match (self.prev.as_ref(), &self.next) {
 369            (None, _) => true,
 370            (Some(prev), next) => prev.buffer_id != next.buffer_id,
 371        }
 372    }
 373}
 374
 375#[derive(Copy, Clone, Debug, PartialEq, Eq)]
 376pub struct ExpandInfo {
 377    pub direction: ExpandExcerptDirection,
 378    pub excerpt_id: ExcerptId,
 379}
 380
 381#[derive(Copy, Clone, Debug, Default, PartialEq, Eq)]
 382pub struct RowInfo {
 383    pub buffer_id: Option<BufferId>,
 384    pub buffer_row: Option<u32>,
 385    pub multibuffer_row: Option<MultiBufferRow>,
 386    pub diff_status: Option<buffer_diff::DiffHunkStatus>,
 387    pub expand_info: Option<ExpandInfo>,
 388}
 389
 390/// A slice into a [`Buffer`] that is being edited in a [`MultiBuffer`].
 391#[derive(Clone)]
 392struct Excerpt {
 393    /// The unique identifier for this excerpt
 394    id: ExcerptId,
 395    /// The location of the excerpt in the [`MultiBuffer`]
 396    locator: Locator,
 397    /// The buffer being excerpted
 398    buffer_id: BufferId,
 399    /// A snapshot of the buffer being excerpted
 400    buffer: BufferSnapshot,
 401    /// The range of the buffer to be shown in the excerpt
 402    range: ExcerptRange<text::Anchor>,
 403    /// The last row in the excerpted slice of the buffer
 404    max_buffer_row: BufferRow,
 405    /// A summary of the text in the excerpt
 406    text_summary: TextSummary,
 407    has_trailing_newline: bool,
 408}
 409
 410/// A public view into an `Excerpt` in a [`MultiBuffer`].
 411///
 412/// Contains methods for getting the [`Buffer`] of the excerpt,
 413/// as well as mapping offsets to/from buffer and multibuffer coordinates.
 414#[derive(Clone)]
 415pub struct MultiBufferExcerpt<'a> {
 416    excerpt: &'a Excerpt,
 417    diff_transforms: sum_tree::Cursor<'a, 'static, DiffTransform, DiffTransforms<usize>>,
 418    offset: usize,
 419    excerpt_offset: ExcerptDimension<usize>,
 420    buffer_offset: usize,
 421}
 422
 423#[derive(Clone, Debug)]
 424struct ExcerptIdMapping {
 425    id: ExcerptId,
 426    locator: Locator,
 427}
 428
 429/// A range of text from a single [`Buffer`], to be shown as an `Excerpt`.
 430/// These ranges are relative to the buffer itself
 431#[derive(Clone, Debug, Eq, PartialEq, Hash)]
 432pub struct ExcerptRange<T> {
 433    /// The full range of text to be shown in the excerpt.
 434    pub context: Range<T>,
 435    /// The primary range of text to be highlighted in the excerpt.
 436    /// In a multi-buffer search, this would be the text that matched the search
 437    pub primary: Range<T>,
 438}
 439
 440impl<T: Clone> ExcerptRange<T> {
 441    pub fn new(context: Range<T>) -> Self {
 442        Self {
 443            context: context.clone(),
 444            primary: context,
 445        }
 446    }
 447}
 448
 449#[derive(Clone, Debug, Default)]
 450pub struct ExcerptSummary {
 451    excerpt_id: ExcerptId,
 452    /// The location of the last [`Excerpt`] being summarized
 453    excerpt_locator: Locator,
 454    widest_line_number: u32,
 455    text: TextSummary,
 456}
 457
 458#[derive(Debug, Clone)]
 459pub struct DiffTransformSummary {
 460    input: TextSummary,
 461    output: TextSummary,
 462}
 463
 464#[derive(Clone)]
 465pub struct MultiBufferRows<'a> {
 466    point: Point,
 467    is_empty: bool,
 468    is_singleton: bool,
 469    cursor: MultiBufferCursor<'a, Point>,
 470}
 471
 472pub struct MultiBufferChunks<'a> {
 473    excerpts: Cursor<'a, 'static, Excerpt, ExcerptOffset>,
 474    diff_transforms: Cursor<'a, 'static, DiffTransform, Dimensions<usize, ExcerptOffset>>,
 475    diffs: &'a TreeMap<BufferId, BufferDiffSnapshot>,
 476    diff_base_chunks: Option<(BufferId, BufferChunks<'a>)>,
 477    buffer_chunk: Option<Chunk<'a>>,
 478    range: Range<usize>,
 479    excerpt_offset_range: Range<ExcerptOffset>,
 480    excerpt_chunks: Option<ExcerptChunks<'a>>,
 481    language_aware: bool,
 482}
 483
 484pub struct ReversedMultiBufferChunks<'a> {
 485    cursor: MultiBufferCursor<'a, usize>,
 486    current_chunks: Option<rope::Chunks<'a>>,
 487    start: usize,
 488    offset: usize,
 489}
 490
 491pub struct MultiBufferBytes<'a> {
 492    range: Range<usize>,
 493    cursor: MultiBufferCursor<'a, usize>,
 494    excerpt_bytes: Option<text::Bytes<'a>>,
 495    has_trailing_newline: bool,
 496    chunk: &'a [u8],
 497}
 498
 499pub struct ReversedMultiBufferBytes<'a> {
 500    range: Range<usize>,
 501    chunks: ReversedMultiBufferChunks<'a>,
 502    chunk: &'a [u8],
 503}
 504
 505#[derive(Clone)]
 506struct DiffTransforms<D> {
 507    output_dimension: OutputDimension<D>,
 508    excerpt_dimension: ExcerptDimension<D>,
 509}
 510
 511impl<'a, D: TextDimension> Dimension<'a, DiffTransformSummary> for DiffTransforms<D> {
 512    fn zero(cx: <DiffTransformSummary as sum_tree::Summary>::Context<'_>) -> Self {
 513        Self {
 514            output_dimension: OutputDimension::zero(cx),
 515            excerpt_dimension: <ExcerptDimension<D> as Dimension<'a, DiffTransformSummary>>::zero(
 516                cx,
 517            ),
 518        }
 519    }
 520
 521    fn add_summary(
 522        &mut self,
 523        summary: &'a DiffTransformSummary,
 524        cx: <DiffTransformSummary as sum_tree::Summary>::Context<'_>,
 525    ) {
 526        self.output_dimension.add_summary(summary, cx);
 527        self.excerpt_dimension.add_summary(summary, cx);
 528    }
 529}
 530
 531#[derive(Clone)]
 532struct MultiBufferCursor<'a, D: TextDimension> {
 533    excerpts: Cursor<'a, 'static, Excerpt, ExcerptDimension<D>>,
 534    diff_transforms: Cursor<'a, 'static, DiffTransform, DiffTransforms<D>>,
 535    diffs: &'a TreeMap<BufferId, BufferDiffSnapshot>,
 536    cached_region: Option<MultiBufferRegion<'a, D>>,
 537}
 538
 539#[derive(Clone)]
 540struct MultiBufferRegion<'a, D: TextDimension> {
 541    buffer: &'a BufferSnapshot,
 542    is_main_buffer: bool,
 543    diff_hunk_status: Option<DiffHunkStatus>,
 544    excerpt: &'a Excerpt,
 545    buffer_range: Range<D>,
 546    range: Range<D>,
 547    has_trailing_newline: bool,
 548}
 549
 550struct ExcerptChunks<'a> {
 551    excerpt_id: ExcerptId,
 552    content_chunks: BufferChunks<'a>,
 553    footer_height: usize,
 554}
 555
 556#[derive(Debug)]
 557struct BufferEdit {
 558    range: Range<usize>,
 559    new_text: Arc<str>,
 560    is_insertion: bool,
 561    original_indent_column: Option<u32>,
 562    excerpt_id: ExcerptId,
 563}
 564
 565#[derive(Clone, Copy, Debug, PartialEq)]
 566enum DiffChangeKind {
 567    BufferEdited,
 568    DiffUpdated { base_changed: bool },
 569    ExpandOrCollapseHunks { expand: bool },
 570}
 571
 572#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
 573pub enum ExpandExcerptDirection {
 574    Up,
 575    Down,
 576    UpAndDown,
 577}
 578
 579impl ExpandExcerptDirection {
 580    pub fn should_expand_up(&self) -> bool {
 581        match self {
 582            ExpandExcerptDirection::Up => true,
 583            ExpandExcerptDirection::Down => false,
 584            ExpandExcerptDirection::UpAndDown => true,
 585        }
 586    }
 587
 588    pub fn should_expand_down(&self) -> bool {
 589        match self {
 590            ExpandExcerptDirection::Up => false,
 591            ExpandExcerptDirection::Down => true,
 592            ExpandExcerptDirection::UpAndDown => true,
 593        }
 594    }
 595}
 596
 597#[derive(Clone, Debug, PartialEq)]
 598pub struct IndentGuide {
 599    pub buffer_id: BufferId,
 600    pub start_row: MultiBufferRow,
 601    pub end_row: MultiBufferRow,
 602    pub depth: u32,
 603    pub tab_size: u32,
 604    pub settings: IndentGuideSettings,
 605}
 606
 607impl IndentGuide {
 608    pub fn indent_level(&self) -> u32 {
 609        self.depth * self.tab_size
 610    }
 611}
 612
 613impl MultiBuffer {
 614    pub fn new(capability: Capability) -> Self {
 615        Self {
 616            snapshot: RefCell::new(MultiBufferSnapshot {
 617                show_headers: true,
 618                ..MultiBufferSnapshot::default()
 619            }),
 620            buffers: RefCell::default(),
 621            diffs: HashMap::default(),
 622            subscriptions: Topic::default(),
 623            singleton: false,
 624            capability,
 625            title: None,
 626            excerpts_by_path: Default::default(),
 627            paths_by_excerpt: Default::default(),
 628            buffer_changed_since_sync: Default::default(),
 629            history: History {
 630                next_transaction_id: clock::Lamport::default(),
 631                undo_stack: Vec::new(),
 632                redo_stack: Vec::new(),
 633                transaction_depth: 0,
 634                group_interval: Duration::from_millis(300),
 635            },
 636        }
 637    }
 638
 639    pub fn without_headers(capability: Capability) -> Self {
 640        Self {
 641            snapshot: Default::default(),
 642            buffers: Default::default(),
 643            excerpts_by_path: Default::default(),
 644            paths_by_excerpt: Default::default(),
 645            diffs: HashMap::default(),
 646            subscriptions: Default::default(),
 647            singleton: false,
 648            capability,
 649            buffer_changed_since_sync: Default::default(),
 650            history: History {
 651                next_transaction_id: Default::default(),
 652                undo_stack: Default::default(),
 653                redo_stack: Default::default(),
 654                transaction_depth: 0,
 655                group_interval: Duration::from_millis(300),
 656            },
 657            title: Default::default(),
 658        }
 659    }
 660
 661    pub fn clone(&self, new_cx: &mut Context<Self>) -> Self {
 662        let mut buffers = HashMap::default();
 663        let buffer_changed_since_sync = Rc::new(Cell::new(false));
 664        for (buffer_id, buffer_state) in self.buffers.borrow().iter() {
 665            buffer_state.buffer.update(new_cx, |buffer, _| {
 666                buffer.record_changes(Rc::downgrade(&buffer_changed_since_sync));
 667            });
 668            buffers.insert(
 669                *buffer_id,
 670                BufferState {
 671                    buffer: buffer_state.buffer.clone(),
 672                    last_version: buffer_state.last_version.clone(),
 673                    last_non_text_state_update_count: buffer_state.last_non_text_state_update_count,
 674                    excerpts: buffer_state.excerpts.clone(),
 675                    _subscriptions: [
 676                        new_cx.observe(&buffer_state.buffer, |_, _, cx| cx.notify()),
 677                        new_cx.subscribe(&buffer_state.buffer, Self::on_buffer_event),
 678                    ],
 679                },
 680            );
 681        }
 682        let mut diff_bases = HashMap::default();
 683        for (buffer_id, diff) in self.diffs.iter() {
 684            diff_bases.insert(*buffer_id, DiffState::new(diff.diff.clone(), new_cx));
 685        }
 686        Self {
 687            snapshot: RefCell::new(self.snapshot.borrow().clone()),
 688            buffers: RefCell::new(buffers),
 689            excerpts_by_path: Default::default(),
 690            paths_by_excerpt: Default::default(),
 691            diffs: diff_bases,
 692            subscriptions: Default::default(),
 693            singleton: self.singleton,
 694            capability: self.capability,
 695            history: self.history.clone(),
 696            title: self.title.clone(),
 697            buffer_changed_since_sync,
 698        }
 699    }
 700
 701    pub fn with_title(mut self, title: String) -> Self {
 702        self.title = Some(title);
 703        self
 704    }
 705
 706    pub fn read_only(&self) -> bool {
 707        self.capability == Capability::ReadOnly
 708    }
 709
 710    pub fn singleton(buffer: Entity<Buffer>, cx: &mut Context<Self>) -> Self {
 711        let mut this = Self::new(buffer.read(cx).capability());
 712        this.singleton = true;
 713        this.push_excerpts(
 714            buffer,
 715            [ExcerptRange::new(text::Anchor::MIN..text::Anchor::MAX)],
 716            cx,
 717        );
 718        this.snapshot.borrow_mut().singleton = true;
 719        this
 720    }
 721
 722    /// Returns an up-to-date snapshot of the MultiBuffer.
 723    pub fn snapshot(&self, cx: &App) -> MultiBufferSnapshot {
 724        self.sync(cx);
 725        self.snapshot.borrow().clone()
 726    }
 727
 728    pub fn read(&self, cx: &App) -> Ref<'_, MultiBufferSnapshot> {
 729        self.sync(cx);
 730        self.snapshot.borrow()
 731    }
 732
 733    pub fn as_singleton(&self) -> Option<Entity<Buffer>> {
 734        if self.singleton {
 735            Some(
 736                self.buffers
 737                    .borrow()
 738                    .values()
 739                    .next()
 740                    .unwrap()
 741                    .buffer
 742                    .clone(),
 743            )
 744        } else {
 745            None
 746        }
 747    }
 748
 749    pub fn is_singleton(&self) -> bool {
 750        self.singleton
 751    }
 752
 753    pub fn subscribe(&mut self) -> Subscription {
 754        self.subscriptions.subscribe()
 755    }
 756
 757    pub fn is_dirty(&self, cx: &App) -> bool {
 758        self.read(cx).is_dirty()
 759    }
 760
 761    pub fn has_deleted_file(&self, cx: &App) -> bool {
 762        self.read(cx).has_deleted_file()
 763    }
 764
 765    pub fn has_conflict(&self, cx: &App) -> bool {
 766        self.read(cx).has_conflict()
 767    }
 768
 769    // The `is_empty` signature doesn't match what clippy expects
 770    #[allow(clippy::len_without_is_empty)]
 771    pub fn len(&self, cx: &App) -> usize {
 772        self.read(cx).len()
 773    }
 774
 775    pub fn is_empty(&self) -> bool {
 776        self.buffers.borrow().is_empty()
 777    }
 778
 779    pub fn symbols_containing<T: ToOffset>(
 780        &self,
 781        offset: T,
 782        theme: Option<&SyntaxTheme>,
 783        cx: &App,
 784    ) -> Option<(BufferId, Vec<OutlineItem<Anchor>>)> {
 785        self.read(cx).symbols_containing(offset, theme)
 786    }
 787
 788    pub fn edit<I, S, T>(
 789        &self,
 790        edits: I,
 791        autoindent_mode: Option<AutoindentMode>,
 792        cx: &mut Context<Self>,
 793    ) where
 794        I: IntoIterator<Item = (Range<S>, T)>,
 795        S: ToOffset,
 796        T: Into<Arc<str>>,
 797    {
 798        let snapshot = self.read(cx);
 799        let edits = edits
 800            .into_iter()
 801            .map(|(range, new_text)| {
 802                let mut range = range.start.to_offset(&snapshot)..range.end.to_offset(&snapshot);
 803                if range.start > range.end {
 804                    mem::swap(&mut range.start, &mut range.end);
 805                }
 806                (range, new_text.into())
 807            })
 808            .collect::<Vec<_>>();
 809
 810        return edit_internal(self, snapshot, edits, autoindent_mode, cx);
 811
 812        // Non-generic part of edit, hoisted out to avoid blowing up LLVM IR.
 813        fn edit_internal(
 814            this: &MultiBuffer,
 815            snapshot: Ref<MultiBufferSnapshot>,
 816            edits: Vec<(Range<usize>, Arc<str>)>,
 817            mut autoindent_mode: Option<AutoindentMode>,
 818            cx: &mut Context<MultiBuffer>,
 819        ) {
 820            if this.read_only() || this.buffers.borrow().is_empty() {
 821                return;
 822            }
 823
 824            let original_indent_columns = match &mut autoindent_mode {
 825                Some(AutoindentMode::Block {
 826                    original_indent_columns,
 827                }) => mem::take(original_indent_columns),
 828                _ => Default::default(),
 829            };
 830
 831            let (buffer_edits, edited_excerpt_ids) =
 832                this.convert_edits_to_buffer_edits(edits, &snapshot, &original_indent_columns);
 833            drop(snapshot);
 834
 835            let mut buffer_ids = Vec::with_capacity(buffer_edits.len());
 836            for (buffer_id, mut edits) in buffer_edits {
 837                buffer_ids.push(buffer_id);
 838                edits.sort_by_key(|edit| edit.range.start);
 839                this.buffers.borrow()[&buffer_id]
 840                    .buffer
 841                    .update(cx, |buffer, cx| {
 842                        let mut edits = edits.into_iter().peekable();
 843                        let mut insertions = Vec::new();
 844                        let mut original_indent_columns = Vec::new();
 845                        let mut deletions = Vec::new();
 846                        let empty_str: Arc<str> = Arc::default();
 847                        while let Some(BufferEdit {
 848                            mut range,
 849                            mut new_text,
 850                            mut is_insertion,
 851                            original_indent_column,
 852                            excerpt_id,
 853                        }) = edits.next()
 854                        {
 855                            while let Some(BufferEdit {
 856                                range: next_range,
 857                                is_insertion: next_is_insertion,
 858                                new_text: next_new_text,
 859                                excerpt_id: next_excerpt_id,
 860                                ..
 861                            }) = edits.peek()
 862                            {
 863                                if range.end >= next_range.start {
 864                                    range.end = cmp::max(next_range.end, range.end);
 865                                    is_insertion |= *next_is_insertion;
 866                                    if excerpt_id == *next_excerpt_id {
 867                                        new_text = format!("{new_text}{next_new_text}").into();
 868                                    }
 869                                    edits.next();
 870                                } else {
 871                                    break;
 872                                }
 873                            }
 874
 875                            if is_insertion {
 876                                original_indent_columns.push(original_indent_column);
 877                                insertions.push((
 878                                    buffer.anchor_before(range.start)
 879                                        ..buffer.anchor_before(range.end),
 880                                    new_text.clone(),
 881                                ));
 882                            } else if !range.is_empty() {
 883                                deletions.push((
 884                                    buffer.anchor_before(range.start)
 885                                        ..buffer.anchor_before(range.end),
 886                                    empty_str.clone(),
 887                                ));
 888                            }
 889                        }
 890
 891                        let deletion_autoindent_mode =
 892                            if let Some(AutoindentMode::Block { .. }) = autoindent_mode {
 893                                Some(AutoindentMode::Block {
 894                                    original_indent_columns: Default::default(),
 895                                })
 896                            } else {
 897                                autoindent_mode.clone()
 898                            };
 899                        let insertion_autoindent_mode =
 900                            if let Some(AutoindentMode::Block { .. }) = autoindent_mode {
 901                                Some(AutoindentMode::Block {
 902                                    original_indent_columns,
 903                                })
 904                            } else {
 905                                autoindent_mode.clone()
 906                            };
 907
 908                        buffer.edit(deletions, deletion_autoindent_mode, cx);
 909                        buffer.edit(insertions, insertion_autoindent_mode, cx);
 910                    })
 911            }
 912
 913            cx.emit(Event::ExcerptsEdited {
 914                excerpt_ids: edited_excerpt_ids,
 915                buffer_ids,
 916            });
 917        }
 918    }
 919
 920    fn convert_edits_to_buffer_edits(
 921        &self,
 922        edits: Vec<(Range<usize>, Arc<str>)>,
 923        snapshot: &MultiBufferSnapshot,
 924        original_indent_columns: &[Option<u32>],
 925    ) -> (HashMap<BufferId, Vec<BufferEdit>>, Vec<ExcerptId>) {
 926        let mut buffer_edits: HashMap<BufferId, Vec<BufferEdit>> = Default::default();
 927        let mut edited_excerpt_ids = Vec::new();
 928        let mut cursor = snapshot.cursor::<usize>();
 929        for (ix, (range, new_text)) in edits.into_iter().enumerate() {
 930            let original_indent_column = original_indent_columns.get(ix).copied().flatten();
 931
 932            cursor.seek(&range.start);
 933            let mut start_region = cursor.region().expect("start offset out of bounds");
 934            if !start_region.is_main_buffer {
 935                cursor.next();
 936                if let Some(region) = cursor.region() {
 937                    start_region = region;
 938                } else {
 939                    continue;
 940                }
 941            }
 942
 943            if range.end < start_region.range.start {
 944                continue;
 945            }
 946
 947            if range.end > start_region.range.end {
 948                cursor.seek_forward(&range.end);
 949            }
 950            let mut end_region = cursor.region().expect("end offset out of bounds");
 951            if !end_region.is_main_buffer {
 952                cursor.prev();
 953                if let Some(region) = cursor.region() {
 954                    end_region = region;
 955                } else {
 956                    continue;
 957                }
 958            }
 959
 960            if range.start > end_region.range.end {
 961                continue;
 962            }
 963
 964            let start_overshoot = range.start.saturating_sub(start_region.range.start);
 965            let end_overshoot = range.end.saturating_sub(end_region.range.start);
 966            let buffer_start = (start_region.buffer_range.start + start_overshoot)
 967                .min(start_region.buffer_range.end);
 968            let buffer_end =
 969                (end_region.buffer_range.start + end_overshoot).min(end_region.buffer_range.end);
 970
 971            if start_region.excerpt.id == end_region.excerpt.id {
 972                if start_region.is_main_buffer {
 973                    edited_excerpt_ids.push(start_region.excerpt.id);
 974                    buffer_edits
 975                        .entry(start_region.buffer.remote_id())
 976                        .or_default()
 977                        .push(BufferEdit {
 978                            range: buffer_start..buffer_end,
 979                            new_text,
 980                            is_insertion: true,
 981                            original_indent_column,
 982                            excerpt_id: start_region.excerpt.id,
 983                        });
 984                }
 985            } else {
 986                let start_excerpt_range = buffer_start..start_region.buffer_range.end;
 987                let end_excerpt_range = end_region.buffer_range.start..buffer_end;
 988                if start_region.is_main_buffer {
 989                    edited_excerpt_ids.push(start_region.excerpt.id);
 990                    buffer_edits
 991                        .entry(start_region.buffer.remote_id())
 992                        .or_default()
 993                        .push(BufferEdit {
 994                            range: start_excerpt_range,
 995                            new_text: new_text.clone(),
 996                            is_insertion: true,
 997                            original_indent_column,
 998                            excerpt_id: start_region.excerpt.id,
 999                        });
1000                }
1001                if end_region.is_main_buffer {
1002                    edited_excerpt_ids.push(end_region.excerpt.id);
1003                    buffer_edits
1004                        .entry(end_region.buffer.remote_id())
1005                        .or_default()
1006                        .push(BufferEdit {
1007                            range: end_excerpt_range,
1008                            new_text: new_text.clone(),
1009                            is_insertion: false,
1010                            original_indent_column,
1011                            excerpt_id: end_region.excerpt.id,
1012                        });
1013                }
1014
1015                cursor.seek(&range.start);
1016                cursor.next_excerpt();
1017                while let Some(region) = cursor.region() {
1018                    if region.excerpt.id == end_region.excerpt.id {
1019                        break;
1020                    }
1021                    if region.is_main_buffer {
1022                        edited_excerpt_ids.push(region.excerpt.id);
1023                        buffer_edits
1024                            .entry(region.buffer.remote_id())
1025                            .or_default()
1026                            .push(BufferEdit {
1027                                range: region.buffer_range,
1028                                new_text: new_text.clone(),
1029                                is_insertion: false,
1030                                original_indent_column,
1031                                excerpt_id: region.excerpt.id,
1032                            });
1033                    }
1034                    cursor.next_excerpt();
1035                }
1036            }
1037        }
1038        (buffer_edits, edited_excerpt_ids)
1039    }
1040
1041    pub fn autoindent_ranges<I, S>(&self, ranges: I, cx: &mut Context<Self>)
1042    where
1043        I: IntoIterator<Item = Range<S>>,
1044        S: ToOffset,
1045    {
1046        let snapshot = self.read(cx);
1047        let empty = Arc::<str>::from("");
1048        let edits = ranges
1049            .into_iter()
1050            .map(|range| {
1051                let mut range = range.start.to_offset(&snapshot)..range.end.to_offset(&snapshot);
1052                if range.start > range.end {
1053                    mem::swap(&mut range.start, &mut range.end);
1054                }
1055                (range, empty.clone())
1056            })
1057            .collect::<Vec<_>>();
1058
1059        return autoindent_ranges_internal(self, snapshot, edits, cx);
1060
1061        fn autoindent_ranges_internal(
1062            this: &MultiBuffer,
1063            snapshot: Ref<MultiBufferSnapshot>,
1064            edits: Vec<(Range<usize>, Arc<str>)>,
1065            cx: &mut Context<MultiBuffer>,
1066        ) {
1067            if this.read_only() || this.buffers.borrow().is_empty() {
1068                return;
1069            }
1070
1071            let (buffer_edits, edited_excerpt_ids) =
1072                this.convert_edits_to_buffer_edits(edits, &snapshot, &[]);
1073            drop(snapshot);
1074
1075            let mut buffer_ids = Vec::new();
1076            for (buffer_id, mut edits) in buffer_edits {
1077                buffer_ids.push(buffer_id);
1078                edits.sort_unstable_by_key(|edit| edit.range.start);
1079
1080                let mut ranges: Vec<Range<usize>> = Vec::new();
1081                for edit in edits {
1082                    if let Some(last_range) = ranges.last_mut()
1083                        && edit.range.start <= last_range.end
1084                    {
1085                        last_range.end = last_range.end.max(edit.range.end);
1086                        continue;
1087                    }
1088                    ranges.push(edit.range);
1089                }
1090
1091                this.buffers.borrow()[&buffer_id]
1092                    .buffer
1093                    .update(cx, |buffer, cx| {
1094                        buffer.autoindent_ranges(ranges, cx);
1095                    })
1096            }
1097
1098            cx.emit(Event::ExcerptsEdited {
1099                excerpt_ids: edited_excerpt_ids,
1100                buffer_ids,
1101            });
1102        }
1103    }
1104
1105    // Inserts newlines at the given position to create an empty line, returning the start of the new line.
1106    // You can also request the insertion of empty lines above and below the line starting at the returned point.
1107    // Panics if the given position is invalid.
1108    pub fn insert_empty_line(
1109        &mut self,
1110        position: impl ToPoint,
1111        space_above: bool,
1112        space_below: bool,
1113        cx: &mut Context<Self>,
1114    ) -> Point {
1115        let multibuffer_point = position.to_point(&self.read(cx));
1116        let (buffer, buffer_point, _) = self.point_to_buffer_point(multibuffer_point, cx).unwrap();
1117        self.start_transaction(cx);
1118        let empty_line_start = buffer.update(cx, |buffer, cx| {
1119            buffer.insert_empty_line(buffer_point, space_above, space_below, cx)
1120        });
1121        self.end_transaction(cx);
1122        multibuffer_point + (empty_line_start - buffer_point)
1123    }
1124
1125    pub fn start_transaction(&mut self, cx: &mut Context<Self>) -> Option<TransactionId> {
1126        self.start_transaction_at(Instant::now(), cx)
1127    }
1128
1129    pub fn start_transaction_at(
1130        &mut self,
1131        now: Instant,
1132        cx: &mut Context<Self>,
1133    ) -> Option<TransactionId> {
1134        if let Some(buffer) = self.as_singleton() {
1135            return buffer.update(cx, |buffer, _| buffer.start_transaction_at(now));
1136        }
1137
1138        for BufferState { buffer, .. } in self.buffers.borrow().values() {
1139            buffer.update(cx, |buffer, _| buffer.start_transaction_at(now));
1140        }
1141        self.history.start_transaction(now)
1142    }
1143
1144    pub fn last_transaction_id(&self, cx: &App) -> Option<TransactionId> {
1145        if let Some(buffer) = self.as_singleton() {
1146            buffer
1147                .read(cx)
1148                .peek_undo_stack()
1149                .map(|history_entry| history_entry.transaction_id())
1150        } else {
1151            let last_transaction = self.history.undo_stack.last()?;
1152            Some(last_transaction.id)
1153        }
1154    }
1155
1156    pub fn end_transaction(&mut self, cx: &mut Context<Self>) -> Option<TransactionId> {
1157        self.end_transaction_at(Instant::now(), cx)
1158    }
1159
1160    pub fn end_transaction_at(
1161        &mut self,
1162        now: Instant,
1163        cx: &mut Context<Self>,
1164    ) -> Option<TransactionId> {
1165        if let Some(buffer) = self.as_singleton() {
1166            return buffer.update(cx, |buffer, cx| buffer.end_transaction_at(now, cx));
1167        }
1168
1169        let mut buffer_transactions = HashMap::default();
1170        for BufferState { buffer, .. } in self.buffers.borrow().values() {
1171            if let Some(transaction_id) =
1172                buffer.update(cx, |buffer, cx| buffer.end_transaction_at(now, cx))
1173            {
1174                buffer_transactions.insert(buffer.read(cx).remote_id(), transaction_id);
1175            }
1176        }
1177
1178        if self.history.end_transaction(now, buffer_transactions) {
1179            let transaction_id = self.history.group().unwrap();
1180            Some(transaction_id)
1181        } else {
1182            None
1183        }
1184    }
1185
1186    pub fn edited_ranges_for_transaction<D>(
1187        &self,
1188        transaction_id: TransactionId,
1189        cx: &App,
1190    ) -> Vec<Range<D>>
1191    where
1192        D: TextDimension + Ord + Sub<D, Output = D>,
1193    {
1194        let Some(transaction) = self.history.transaction(transaction_id) else {
1195            return Vec::new();
1196        };
1197
1198        let mut ranges = Vec::new();
1199        let snapshot = self.read(cx);
1200        let buffers = self.buffers.borrow();
1201        let mut cursor = snapshot.excerpts.cursor::<ExcerptSummary>(());
1202
1203        for (buffer_id, buffer_transaction) in &transaction.buffer_transactions {
1204            let Some(buffer_state) = buffers.get(buffer_id) else {
1205                continue;
1206            };
1207
1208            let buffer = buffer_state.buffer.read(cx);
1209            for range in buffer.edited_ranges_for_transaction_id::<D>(*buffer_transaction) {
1210                for excerpt_id in &buffer_state.excerpts {
1211                    cursor.seek(excerpt_id, Bias::Left);
1212                    if let Some(excerpt) = cursor.item()
1213                        && excerpt.locator == *excerpt_id
1214                    {
1215                        let excerpt_buffer_start = excerpt.range.context.start.summary::<D>(buffer);
1216                        let excerpt_buffer_end = excerpt.range.context.end.summary::<D>(buffer);
1217                        let excerpt_range = excerpt_buffer_start..excerpt_buffer_end;
1218                        if excerpt_range.contains(&range.start)
1219                            && excerpt_range.contains(&range.end)
1220                        {
1221                            let excerpt_start = D::from_text_summary(&cursor.start().text);
1222
1223                            let mut start = excerpt_start;
1224                            start.add_assign(&(range.start - excerpt_buffer_start));
1225                            let mut end = excerpt_start;
1226                            end.add_assign(&(range.end - excerpt_buffer_start));
1227
1228                            ranges.push(start..end);
1229                            break;
1230                        }
1231                    }
1232                }
1233            }
1234        }
1235
1236        ranges.sort_by_key(|range| range.start);
1237        ranges
1238    }
1239
1240    pub fn merge_transactions(
1241        &mut self,
1242        transaction: TransactionId,
1243        destination: TransactionId,
1244        cx: &mut Context<Self>,
1245    ) {
1246        if let Some(buffer) = self.as_singleton() {
1247            buffer.update(cx, |buffer, _| {
1248                buffer.merge_transactions(transaction, destination)
1249            });
1250        } else if let Some(transaction) = self.history.forget(transaction)
1251            && let Some(destination) = self.history.transaction_mut(destination)
1252        {
1253            for (buffer_id, buffer_transaction_id) in transaction.buffer_transactions {
1254                if let Some(destination_buffer_transaction_id) =
1255                    destination.buffer_transactions.get(&buffer_id)
1256                {
1257                    if let Some(state) = self.buffers.borrow().get(&buffer_id) {
1258                        state.buffer.update(cx, |buffer, _| {
1259                            buffer.merge_transactions(
1260                                buffer_transaction_id,
1261                                *destination_buffer_transaction_id,
1262                            )
1263                        });
1264                    }
1265                } else {
1266                    destination
1267                        .buffer_transactions
1268                        .insert(buffer_id, buffer_transaction_id);
1269                }
1270            }
1271        }
1272    }
1273
1274    pub fn finalize_last_transaction(&mut self, cx: &mut Context<Self>) {
1275        self.history.finalize_last_transaction();
1276        for BufferState { buffer, .. } in self.buffers.borrow().values() {
1277            buffer.update(cx, |buffer, _| {
1278                buffer.finalize_last_transaction();
1279            });
1280        }
1281    }
1282
1283    pub fn push_transaction<'a, T>(&mut self, buffer_transactions: T, cx: &Context<Self>)
1284    where
1285        T: IntoIterator<Item = (&'a Entity<Buffer>, &'a language::Transaction)>,
1286    {
1287        self.history
1288            .push_transaction(buffer_transactions, Instant::now(), cx);
1289        self.history.finalize_last_transaction();
1290    }
1291
1292    pub fn group_until_transaction(
1293        &mut self,
1294        transaction_id: TransactionId,
1295        cx: &mut Context<Self>,
1296    ) {
1297        if let Some(buffer) = self.as_singleton() {
1298            buffer.update(cx, |buffer, _| {
1299                buffer.group_until_transaction(transaction_id)
1300            });
1301        } else {
1302            self.history.group_until(transaction_id);
1303        }
1304    }
1305
1306    pub fn set_active_selections(
1307        &self,
1308        selections: &[Selection<Anchor>],
1309        line_mode: bool,
1310        cursor_shape: CursorShape,
1311        cx: &mut Context<Self>,
1312    ) {
1313        let mut selections_by_buffer: HashMap<BufferId, Vec<Selection<text::Anchor>>> =
1314            Default::default();
1315        let snapshot = self.read(cx);
1316        let mut cursor = snapshot.excerpts.cursor::<Option<&Locator>>(());
1317        for selection in selections {
1318            let start_locator = snapshot.excerpt_locator_for_id(selection.start.excerpt_id);
1319            let end_locator = snapshot.excerpt_locator_for_id(selection.end.excerpt_id);
1320
1321            cursor.seek(&Some(start_locator), Bias::Left);
1322            while let Some(excerpt) = cursor.item()
1323                && excerpt.locator <= *end_locator
1324            {
1325                let mut start = excerpt.range.context.start;
1326                let mut end = excerpt.range.context.end;
1327                if excerpt.id == selection.start.excerpt_id {
1328                    start = selection.start.text_anchor;
1329                }
1330                if excerpt.id == selection.end.excerpt_id {
1331                    end = selection.end.text_anchor;
1332                }
1333                selections_by_buffer
1334                    .entry(excerpt.buffer_id)
1335                    .or_default()
1336                    .push(Selection {
1337                        id: selection.id,
1338                        start,
1339                        end,
1340                        reversed: selection.reversed,
1341                        goal: selection.goal,
1342                    });
1343
1344                cursor.next();
1345            }
1346        }
1347
1348        for (buffer_id, buffer_state) in self.buffers.borrow().iter() {
1349            if !selections_by_buffer.contains_key(buffer_id) {
1350                buffer_state
1351                    .buffer
1352                    .update(cx, |buffer, cx| buffer.remove_active_selections(cx));
1353            }
1354        }
1355
1356        for (buffer_id, mut selections) in selections_by_buffer {
1357            self.buffers.borrow()[&buffer_id]
1358                .buffer
1359                .update(cx, |buffer, cx| {
1360                    selections.sort_unstable_by(|a, b| a.start.cmp(&b.start, buffer));
1361                    let mut selections = selections.into_iter().peekable();
1362                    let merged_selections = Arc::from_iter(iter::from_fn(|| {
1363                        let mut selection = selections.next()?;
1364                        while let Some(next_selection) = selections.peek() {
1365                            if selection.end.cmp(&next_selection.start, buffer).is_ge() {
1366                                let next_selection = selections.next().unwrap();
1367                                if next_selection.end.cmp(&selection.end, buffer).is_ge() {
1368                                    selection.end = next_selection.end;
1369                                }
1370                            } else {
1371                                break;
1372                            }
1373                        }
1374                        Some(selection)
1375                    }));
1376                    buffer.set_active_selections(merged_selections, line_mode, cursor_shape, cx);
1377                });
1378        }
1379    }
1380
1381    pub fn remove_active_selections(&self, cx: &mut Context<Self>) {
1382        for buffer in self.buffers.borrow().values() {
1383            buffer
1384                .buffer
1385                .update(cx, |buffer, cx| buffer.remove_active_selections(cx));
1386        }
1387    }
1388
1389    pub fn undo(&mut self, cx: &mut Context<Self>) -> Option<TransactionId> {
1390        let mut transaction_id = None;
1391        if let Some(buffer) = self.as_singleton() {
1392            transaction_id = buffer.update(cx, |buffer, cx| buffer.undo(cx));
1393        } else {
1394            while let Some(transaction) = self.history.pop_undo() {
1395                let mut undone = false;
1396                for (buffer_id, buffer_transaction_id) in &mut transaction.buffer_transactions {
1397                    if let Some(BufferState { buffer, .. }) = self.buffers.borrow().get(buffer_id) {
1398                        undone |= buffer.update(cx, |buffer, cx| {
1399                            let undo_to = *buffer_transaction_id;
1400                            if let Some(entry) = buffer.peek_undo_stack() {
1401                                *buffer_transaction_id = entry.transaction_id();
1402                            }
1403                            buffer.undo_to_transaction(undo_to, cx)
1404                        });
1405                    }
1406                }
1407
1408                if undone {
1409                    transaction_id = Some(transaction.id);
1410                    break;
1411                }
1412            }
1413        }
1414
1415        if let Some(transaction_id) = transaction_id {
1416            cx.emit(Event::TransactionUndone { transaction_id });
1417        }
1418
1419        transaction_id
1420    }
1421
1422    pub fn redo(&mut self, cx: &mut Context<Self>) -> Option<TransactionId> {
1423        if let Some(buffer) = self.as_singleton() {
1424            return buffer.update(cx, |buffer, cx| buffer.redo(cx));
1425        }
1426
1427        while let Some(transaction) = self.history.pop_redo() {
1428            let mut redone = false;
1429            for (buffer_id, buffer_transaction_id) in &mut transaction.buffer_transactions {
1430                if let Some(BufferState { buffer, .. }) = self.buffers.borrow().get(buffer_id) {
1431                    redone |= buffer.update(cx, |buffer, cx| {
1432                        let redo_to = *buffer_transaction_id;
1433                        if let Some(entry) = buffer.peek_redo_stack() {
1434                            *buffer_transaction_id = entry.transaction_id();
1435                        }
1436                        buffer.redo_to_transaction(redo_to, cx)
1437                    });
1438                }
1439            }
1440
1441            if redone {
1442                return Some(transaction.id);
1443            }
1444        }
1445
1446        None
1447    }
1448
1449    pub fn undo_transaction(&mut self, transaction_id: TransactionId, cx: &mut Context<Self>) {
1450        if let Some(buffer) = self.as_singleton() {
1451            buffer.update(cx, |buffer, cx| buffer.undo_transaction(transaction_id, cx));
1452        } else if let Some(transaction) = self.history.remove_from_undo(transaction_id) {
1453            for (buffer_id, transaction_id) in &transaction.buffer_transactions {
1454                if let Some(BufferState { buffer, .. }) = self.buffers.borrow().get(buffer_id) {
1455                    buffer.update(cx, |buffer, cx| {
1456                        buffer.undo_transaction(*transaction_id, cx)
1457                    });
1458                }
1459            }
1460        }
1461    }
1462
1463    pub fn forget_transaction(&mut self, transaction_id: TransactionId, cx: &mut Context<Self>) {
1464        if let Some(buffer) = self.as_singleton() {
1465            buffer.update(cx, |buffer, _| {
1466                buffer.forget_transaction(transaction_id);
1467            });
1468        } else if let Some(transaction) = self.history.forget(transaction_id) {
1469            for (buffer_id, buffer_transaction_id) in transaction.buffer_transactions {
1470                if let Some(state) = self.buffers.borrow_mut().get_mut(&buffer_id) {
1471                    state.buffer.update(cx, |buffer, _| {
1472                        buffer.forget_transaction(buffer_transaction_id);
1473                    });
1474                }
1475            }
1476        }
1477    }
1478
1479    pub fn push_excerpts<O>(
1480        &mut self,
1481        buffer: Entity<Buffer>,
1482        ranges: impl IntoIterator<Item = ExcerptRange<O>>,
1483        cx: &mut Context<Self>,
1484    ) -> Vec<ExcerptId>
1485    where
1486        O: text::ToOffset,
1487    {
1488        self.insert_excerpts_after(ExcerptId::max(), buffer, ranges, cx)
1489    }
1490
1491    pub fn location_for_path(&self, path: &PathKey, cx: &App) -> Option<Anchor> {
1492        let excerpt_id = self.excerpts_by_path.get(path)?.first()?;
1493        let snapshot = self.snapshot(cx);
1494        let excerpt = snapshot.excerpt(*excerpt_id)?;
1495        Some(Anchor::in_buffer(
1496            *excerpt_id,
1497            excerpt.buffer_id,
1498            excerpt.range.context.start,
1499        ))
1500    }
1501
1502    pub fn excerpt_paths(&self) -> impl Iterator<Item = &PathKey> {
1503        self.excerpts_by_path.keys()
1504    }
1505
1506    fn expand_excerpts_with_paths(
1507        &mut self,
1508        ids: impl IntoIterator<Item = ExcerptId>,
1509        line_count: u32,
1510        direction: ExpandExcerptDirection,
1511        cx: &mut Context<Self>,
1512    ) {
1513        let grouped = ids
1514            .into_iter()
1515            .chunk_by(|id| self.paths_by_excerpt.get(id).cloned())
1516            .into_iter()
1517            .flat_map(|(k, v)| Some((k?, v.into_iter().collect::<Vec<_>>())))
1518            .collect::<Vec<_>>();
1519        let snapshot = self.snapshot(cx);
1520
1521        for (path, ids) in grouped.into_iter() {
1522            let Some(excerpt_ids) = self.excerpts_by_path.get(&path) else {
1523                continue;
1524            };
1525
1526            let ids_to_expand = HashSet::from_iter(ids);
1527            let expanded_ranges = excerpt_ids.iter().filter_map(|excerpt_id| {
1528                let excerpt = snapshot.excerpt(*excerpt_id)?;
1529
1530                let mut context = excerpt.range.context.to_point(&excerpt.buffer);
1531                if ids_to_expand.contains(excerpt_id) {
1532                    match direction {
1533                        ExpandExcerptDirection::Up => {
1534                            context.start.row = context.start.row.saturating_sub(line_count);
1535                            context.start.column = 0;
1536                        }
1537                        ExpandExcerptDirection::Down => {
1538                            context.end.row =
1539                                (context.end.row + line_count).min(excerpt.buffer.max_point().row);
1540                            context.end.column = excerpt.buffer.line_len(context.end.row);
1541                        }
1542                        ExpandExcerptDirection::UpAndDown => {
1543                            context.start.row = context.start.row.saturating_sub(line_count);
1544                            context.start.column = 0;
1545                            context.end.row =
1546                                (context.end.row + line_count).min(excerpt.buffer.max_point().row);
1547                            context.end.column = excerpt.buffer.line_len(context.end.row);
1548                        }
1549                    }
1550                }
1551
1552                Some(ExcerptRange {
1553                    context,
1554                    primary: excerpt.range.primary.to_point(&excerpt.buffer),
1555                })
1556            });
1557            let mut merged_ranges: Vec<ExcerptRange<Point>> = Vec::new();
1558            for range in expanded_ranges {
1559                if let Some(last_range) = merged_ranges.last_mut()
1560                    && last_range.context.end >= range.context.start
1561                {
1562                    last_range.context.end = range.context.end;
1563                    continue;
1564                }
1565                merged_ranges.push(range)
1566            }
1567            let Some(excerpt_id) = excerpt_ids.first() else {
1568                continue;
1569            };
1570            let Some(buffer_id) = &snapshot.buffer_id_for_excerpt(*excerpt_id) else {
1571                continue;
1572            };
1573
1574            let Some(buffer) = self
1575                .buffers
1576                .borrow()
1577                .get(buffer_id)
1578                .map(|b| b.buffer.clone())
1579            else {
1580                continue;
1581            };
1582
1583            let buffer_snapshot = buffer.read(cx).snapshot();
1584            self.update_path_excerpts(path.clone(), buffer, &buffer_snapshot, merged_ranges, cx);
1585        }
1586    }
1587
1588    /// Sets excerpts, returns `true` if at least one new excerpt was added.
1589    pub fn set_excerpts_for_path(
1590        &mut self,
1591        path: PathKey,
1592        buffer: Entity<Buffer>,
1593        ranges: impl IntoIterator<Item = Range<Point>>,
1594        context_line_count: u32,
1595        cx: &mut Context<Self>,
1596    ) -> (Vec<Range<Anchor>>, bool) {
1597        let buffer_snapshot = buffer.read(cx).snapshot();
1598        let excerpt_ranges = build_excerpt_ranges(ranges, context_line_count, &buffer_snapshot);
1599
1600        let (new, counts) = Self::merge_excerpt_ranges(&excerpt_ranges);
1601        self.set_merged_excerpt_ranges_for_path(
1602            path,
1603            buffer,
1604            excerpt_ranges,
1605            &buffer_snapshot,
1606            new,
1607            counts,
1608            cx,
1609        )
1610    }
1611
1612    pub fn set_excerpt_ranges_for_path(
1613        &mut self,
1614        path: PathKey,
1615        buffer: Entity<Buffer>,
1616        buffer_snapshot: &BufferSnapshot,
1617        excerpt_ranges: Vec<ExcerptRange<Point>>,
1618        cx: &mut Context<Self>,
1619    ) -> (Vec<Range<Anchor>>, bool) {
1620        let (new, counts) = Self::merge_excerpt_ranges(&excerpt_ranges);
1621        self.set_merged_excerpt_ranges_for_path(
1622            path,
1623            buffer,
1624            excerpt_ranges,
1625            buffer_snapshot,
1626            new,
1627            counts,
1628            cx,
1629        )
1630    }
1631
1632    pub fn set_anchored_excerpts_for_path(
1633        &self,
1634        buffer: Entity<Buffer>,
1635        ranges: Vec<Range<text::Anchor>>,
1636        context_line_count: u32,
1637        cx: &mut Context<Self>,
1638    ) -> Task<Vec<Range<Anchor>>> {
1639        let buffer_snapshot = buffer.read(cx).snapshot();
1640        let path_key = PathKey::for_buffer(&buffer, cx);
1641        cx.spawn(async move |multi_buffer, cx| {
1642            let snapshot = buffer_snapshot.clone();
1643            let (excerpt_ranges, new, counts) = cx
1644                .background_spawn(async move {
1645                    let ranges = ranges.into_iter().map(|range| range.to_point(&snapshot));
1646                    let excerpt_ranges =
1647                        build_excerpt_ranges(ranges, context_line_count, &snapshot);
1648                    let (new, counts) = Self::merge_excerpt_ranges(&excerpt_ranges);
1649                    (excerpt_ranges, new, counts)
1650                })
1651                .await;
1652
1653            multi_buffer
1654                .update(cx, move |multi_buffer, cx| {
1655                    let (ranges, _) = multi_buffer.set_merged_excerpt_ranges_for_path(
1656                        path_key,
1657                        buffer,
1658                        excerpt_ranges,
1659                        &buffer_snapshot,
1660                        new,
1661                        counts,
1662                        cx,
1663                    );
1664                    ranges
1665                })
1666                .ok()
1667                .unwrap_or_default()
1668        })
1669    }
1670
1671    /// Sets excerpts, returns `true` if at least one new excerpt was added.
1672    fn set_merged_excerpt_ranges_for_path(
1673        &mut self,
1674        path: PathKey,
1675        buffer: Entity<Buffer>,
1676        ranges: Vec<ExcerptRange<Point>>,
1677        buffer_snapshot: &BufferSnapshot,
1678        new: Vec<ExcerptRange<Point>>,
1679        counts: Vec<usize>,
1680        cx: &mut Context<Self>,
1681    ) -> (Vec<Range<Anchor>>, bool) {
1682        let (excerpt_ids, added_a_new_excerpt) =
1683            self.update_path_excerpts(path, buffer, buffer_snapshot, new, cx);
1684
1685        let mut result = Vec::new();
1686        let mut ranges = ranges.into_iter();
1687        for (excerpt_id, range_count) in excerpt_ids.into_iter().zip(counts.into_iter()) {
1688            for range in ranges.by_ref().take(range_count) {
1689                let range = Anchor::range_in_buffer(
1690                    excerpt_id,
1691                    buffer_snapshot.remote_id(),
1692                    buffer_snapshot.anchor_before(&range.primary.start)
1693                        ..buffer_snapshot.anchor_after(&range.primary.end),
1694                );
1695                result.push(range)
1696            }
1697        }
1698        (result, added_a_new_excerpt)
1699    }
1700
1701    fn merge_excerpt_ranges<'a>(
1702        expanded_ranges: impl IntoIterator<Item = &'a ExcerptRange<Point>> + 'a,
1703    ) -> (Vec<ExcerptRange<Point>>, Vec<usize>) {
1704        let mut merged_ranges: Vec<ExcerptRange<Point>> = Vec::new();
1705        let mut counts: Vec<usize> = Vec::new();
1706        for range in expanded_ranges {
1707            if let Some(last_range) = merged_ranges.last_mut() {
1708                debug_assert!(
1709                    last_range.context.start <= range.context.start,
1710                    "Last range: {last_range:?} Range: {range:?}"
1711                );
1712                if last_range.context.end >= range.context.start
1713                    || last_range.context.end.row + 1 == range.context.start.row
1714                {
1715                    last_range.context.end = range.context.end.max(last_range.context.end);
1716                    *counts.last_mut().unwrap() += 1;
1717                    continue;
1718                }
1719            }
1720            merged_ranges.push(range.clone());
1721            counts.push(1);
1722        }
1723        (merged_ranges, counts)
1724    }
1725
1726    fn update_path_excerpts(
1727        &mut self,
1728        path: PathKey,
1729        buffer: Entity<Buffer>,
1730        buffer_snapshot: &BufferSnapshot,
1731        new: Vec<ExcerptRange<Point>>,
1732        cx: &mut Context<Self>,
1733    ) -> (Vec<ExcerptId>, bool) {
1734        let mut insert_after = self
1735            .excerpts_by_path
1736            .range(..path.clone())
1737            .next_back()
1738            .map(|(_, value)| *value.last().unwrap())
1739            .unwrap_or(ExcerptId::min());
1740
1741        let existing = self
1742            .excerpts_by_path
1743            .get(&path)
1744            .cloned()
1745            .unwrap_or_default();
1746
1747        let mut new_iter = new.into_iter().peekable();
1748        let mut existing_iter = existing.into_iter().peekable();
1749
1750        let mut excerpt_ids = Vec::new();
1751        let mut to_remove = Vec::new();
1752        let mut to_insert: Vec<(ExcerptId, ExcerptRange<Point>)> = Vec::new();
1753        let mut added_a_new_excerpt = false;
1754        let snapshot = self.snapshot(cx);
1755
1756        let mut next_excerpt_id =
1757            if let Some(last_entry) = self.snapshot.borrow().excerpt_ids.last() {
1758                last_entry.id.0 + 1
1759            } else {
1760                1
1761            };
1762
1763        let mut next_excerpt_id = move || ExcerptId(post_inc(&mut next_excerpt_id));
1764
1765        let mut excerpts_cursor = snapshot.excerpts.cursor::<Option<&Locator>>(());
1766        excerpts_cursor.next();
1767
1768        loop {
1769            let new = new_iter.peek();
1770            let existing = if let Some(existing_id) = existing_iter.peek() {
1771                let locator = snapshot.excerpt_locator_for_id(*existing_id);
1772                excerpts_cursor.seek_forward(&Some(locator), Bias::Left);
1773                if let Some(excerpt) = excerpts_cursor.item() {
1774                    if excerpt.buffer_id != buffer_snapshot.remote_id() {
1775                        to_remove.push(*existing_id);
1776                        existing_iter.next();
1777                        continue;
1778                    }
1779                    Some((
1780                        *existing_id,
1781                        excerpt.range.context.to_point(buffer_snapshot),
1782                    ))
1783                } else {
1784                    None
1785                }
1786            } else {
1787                None
1788            };
1789
1790            if let Some((last_id, last)) = to_insert.last_mut() {
1791                if let Some(new) = new
1792                    && last.context.end >= new.context.start
1793                {
1794                    last.context.end = last.context.end.max(new.context.end);
1795                    excerpt_ids.push(*last_id);
1796                    new_iter.next();
1797                    continue;
1798                }
1799                if let Some((existing_id, existing_range)) = &existing
1800                    && last.context.end >= existing_range.start
1801                {
1802                    last.context.end = last.context.end.max(existing_range.end);
1803                    to_remove.push(*existing_id);
1804                    self.snapshot
1805                        .borrow_mut()
1806                        .replaced_excerpts
1807                        .insert(*existing_id, *last_id);
1808                    existing_iter.next();
1809                    continue;
1810                }
1811            }
1812
1813            match (new, existing) {
1814                (None, None) => break,
1815                (None, Some((existing_id, _))) => {
1816                    existing_iter.next();
1817                    to_remove.push(existing_id);
1818                    continue;
1819                }
1820                (Some(_), None) => {
1821                    added_a_new_excerpt = true;
1822                    let new_id = next_excerpt_id();
1823                    excerpt_ids.push(new_id);
1824                    to_insert.push((new_id, new_iter.next().unwrap()));
1825                    continue;
1826                }
1827                (Some(new), Some((_, existing_range))) => {
1828                    if existing_range.end < new.context.start {
1829                        let existing_id = existing_iter.next().unwrap();
1830                        to_remove.push(existing_id);
1831                        continue;
1832                    } else if existing_range.start > new.context.end {
1833                        let new_id = next_excerpt_id();
1834                        excerpt_ids.push(new_id);
1835                        to_insert.push((new_id, new_iter.next().unwrap()));
1836                        continue;
1837                    }
1838
1839                    if existing_range.start == new.context.start
1840                        && existing_range.end == new.context.end
1841                    {
1842                        self.insert_excerpts_with_ids_after(
1843                            insert_after,
1844                            buffer.clone(),
1845                            mem::take(&mut to_insert),
1846                            cx,
1847                        );
1848                        insert_after = existing_iter.next().unwrap();
1849                        excerpt_ids.push(insert_after);
1850                        new_iter.next();
1851                    } else {
1852                        let existing_id = existing_iter.next().unwrap();
1853                        let new_id = next_excerpt_id();
1854                        self.snapshot
1855                            .borrow_mut()
1856                            .replaced_excerpts
1857                            .insert(existing_id, new_id);
1858                        to_remove.push(existing_id);
1859                        let mut range = new_iter.next().unwrap();
1860                        range.context.start = range.context.start.min(existing_range.start);
1861                        range.context.end = range.context.end.max(existing_range.end);
1862                        excerpt_ids.push(new_id);
1863                        to_insert.push((new_id, range));
1864                    }
1865                }
1866            };
1867        }
1868
1869        self.insert_excerpts_with_ids_after(insert_after, buffer, to_insert, cx);
1870        self.remove_excerpts(to_remove, cx);
1871        if excerpt_ids.is_empty() {
1872            self.excerpts_by_path.remove(&path);
1873        } else {
1874            for excerpt_id in &excerpt_ids {
1875                self.paths_by_excerpt.insert(*excerpt_id, path.clone());
1876            }
1877            self.excerpts_by_path
1878                .insert(path, excerpt_ids.iter().dedup().cloned().collect());
1879        }
1880
1881        (excerpt_ids, added_a_new_excerpt)
1882    }
1883
1884    pub fn paths(&self) -> impl Iterator<Item = PathKey> + '_ {
1885        self.excerpts_by_path.keys().cloned()
1886    }
1887
1888    pub fn remove_excerpts_for_path(&mut self, path: PathKey, cx: &mut Context<Self>) {
1889        if let Some(to_remove) = self.excerpts_by_path.remove(&path) {
1890            self.remove_excerpts(to_remove, cx)
1891        }
1892    }
1893
1894    pub fn insert_excerpts_after<O>(
1895        &mut self,
1896        prev_excerpt_id: ExcerptId,
1897        buffer: Entity<Buffer>,
1898        ranges: impl IntoIterator<Item = ExcerptRange<O>>,
1899        cx: &mut Context<Self>,
1900    ) -> Vec<ExcerptId>
1901    where
1902        O: text::ToOffset,
1903    {
1904        let mut ids = Vec::new();
1905        let mut next_excerpt_id =
1906            if let Some(last_entry) = self.snapshot.borrow().excerpt_ids.last() {
1907                last_entry.id.0 + 1
1908            } else {
1909                1
1910            };
1911        self.insert_excerpts_with_ids_after(
1912            prev_excerpt_id,
1913            buffer,
1914            ranges.into_iter().map(|range| {
1915                let id = ExcerptId(post_inc(&mut next_excerpt_id));
1916                ids.push(id);
1917                (id, range)
1918            }),
1919            cx,
1920        );
1921        ids
1922    }
1923
1924    pub fn insert_excerpts_with_ids_after<O>(
1925        &mut self,
1926        prev_excerpt_id: ExcerptId,
1927        buffer: Entity<Buffer>,
1928        ranges: impl IntoIterator<Item = (ExcerptId, ExcerptRange<O>)>,
1929        cx: &mut Context<Self>,
1930    ) where
1931        O: text::ToOffset,
1932    {
1933        assert_eq!(self.history.transaction_depth, 0);
1934        let mut ranges = ranges.into_iter().peekable();
1935        if ranges.peek().is_none() {
1936            return Default::default();
1937        }
1938
1939        self.sync(cx);
1940
1941        let buffer_snapshot = buffer.read(cx).snapshot();
1942        let buffer_id = buffer_snapshot.remote_id();
1943
1944        let mut buffers = self.buffers.borrow_mut();
1945        let buffer_state = buffers.entry(buffer_id).or_insert_with(|| {
1946            self.buffer_changed_since_sync.replace(true);
1947            buffer.update(cx, |buffer, _| {
1948                buffer.record_changes(Rc::downgrade(&self.buffer_changed_since_sync));
1949            });
1950            BufferState {
1951                last_version: buffer_snapshot.version().clone(),
1952                last_non_text_state_update_count: buffer_snapshot.non_text_state_update_count(),
1953                excerpts: Default::default(),
1954                _subscriptions: [
1955                    cx.observe(&buffer, |_, _, cx| cx.notify()),
1956                    cx.subscribe(&buffer, Self::on_buffer_event),
1957                ],
1958                buffer: buffer.clone(),
1959            }
1960        });
1961
1962        let mut snapshot = self.snapshot.borrow_mut();
1963
1964        let mut prev_locator = snapshot.excerpt_locator_for_id(prev_excerpt_id).clone();
1965        let mut new_excerpt_ids = mem::take(&mut snapshot.excerpt_ids);
1966        let mut cursor = snapshot.excerpts.cursor::<Option<&Locator>>(());
1967        let mut new_excerpts = cursor.slice(&prev_locator, Bias::Right);
1968        prev_locator = cursor.start().unwrap_or(Locator::min_ref()).clone();
1969
1970        let edit_start = ExcerptOffset::new(new_excerpts.summary().text.len);
1971        new_excerpts.update_last(
1972            |excerpt| {
1973                excerpt.has_trailing_newline = true;
1974            },
1975            (),
1976        );
1977
1978        let next_locator = if let Some(excerpt) = cursor.item() {
1979            excerpt.locator.clone()
1980        } else {
1981            Locator::max()
1982        };
1983
1984        let mut excerpts = Vec::new();
1985        while let Some((id, range)) = ranges.next() {
1986            let locator = Locator::between(&prev_locator, &next_locator);
1987            if let Err(ix) = buffer_state.excerpts.binary_search(&locator) {
1988                buffer_state.excerpts.insert(ix, locator.clone());
1989            }
1990            let range = ExcerptRange {
1991                context: buffer_snapshot.anchor_before(&range.context.start)
1992                    ..buffer_snapshot.anchor_after(&range.context.end),
1993                primary: buffer_snapshot.anchor_before(&range.primary.start)
1994                    ..buffer_snapshot.anchor_after(&range.primary.end),
1995            };
1996            excerpts.push((id, range.clone()));
1997            let excerpt = Excerpt::new(
1998                id,
1999                locator.clone(),
2000                buffer_id,
2001                buffer_snapshot.clone(),
2002                range,
2003                ranges.peek().is_some() || cursor.item().is_some(),
2004            );
2005            new_excerpts.push(excerpt, ());
2006            prev_locator = locator.clone();
2007
2008            if let Some(last_mapping_entry) = new_excerpt_ids.last() {
2009                assert!(id > last_mapping_entry.id, "excerpt ids must be increasing");
2010            }
2011            new_excerpt_ids.push(ExcerptIdMapping { id, locator }, ());
2012        }
2013
2014        let edit_end = ExcerptOffset::new(new_excerpts.summary().text.len);
2015
2016        let suffix = cursor.suffix();
2017        let changed_trailing_excerpt = suffix.is_empty();
2018        new_excerpts.append(suffix, ());
2019        drop(cursor);
2020        snapshot.excerpts = new_excerpts;
2021        snapshot.excerpt_ids = new_excerpt_ids;
2022        if changed_trailing_excerpt {
2023            snapshot.trailing_excerpt_update_count += 1;
2024        }
2025
2026        self.sync_diff_transforms(
2027            &mut snapshot,
2028            vec![Edit {
2029                old: edit_start..edit_start,
2030                new: edit_start..edit_end,
2031            }],
2032            DiffChangeKind::BufferEdited,
2033        );
2034        cx.emit(Event::Edited {
2035            edited_buffer: None,
2036        });
2037        cx.emit(Event::ExcerptsAdded {
2038            buffer,
2039            predecessor: prev_excerpt_id,
2040            excerpts,
2041        });
2042        cx.notify();
2043    }
2044
2045    pub fn clear(&mut self, cx: &mut Context<Self>) {
2046        self.sync(cx);
2047        let ids = self.excerpt_ids();
2048        let removed_buffer_ids = self
2049            .buffers
2050            .borrow_mut()
2051            .drain()
2052            .map(|(id, _)| id)
2053            .collect();
2054        self.excerpts_by_path.clear();
2055        self.paths_by_excerpt.clear();
2056        let mut snapshot = self.snapshot.borrow_mut();
2057        let start = ExcerptOffset::new(0);
2058        let prev_len = ExcerptOffset::new(snapshot.excerpts.summary().text.len);
2059        snapshot.excerpts = Default::default();
2060        snapshot.trailing_excerpt_update_count += 1;
2061        snapshot.is_dirty = false;
2062        snapshot.has_deleted_file = false;
2063        snapshot.has_conflict = false;
2064        snapshot.replaced_excerpts.clear();
2065
2066        self.sync_diff_transforms(
2067            &mut snapshot,
2068            vec![Edit {
2069                old: start..prev_len,
2070                new: start..start,
2071            }],
2072            DiffChangeKind::BufferEdited,
2073        );
2074        cx.emit(Event::Edited {
2075            edited_buffer: None,
2076        });
2077        cx.emit(Event::ExcerptsRemoved {
2078            ids,
2079            removed_buffer_ids,
2080        });
2081        cx.notify();
2082    }
2083
2084    pub fn excerpts_for_buffer(
2085        &self,
2086        buffer_id: BufferId,
2087        cx: &App,
2088    ) -> Vec<(ExcerptId, ExcerptRange<text::Anchor>)> {
2089        let mut excerpts = Vec::new();
2090        let snapshot = self.read(cx);
2091        let buffers = self.buffers.borrow();
2092        let mut cursor = snapshot.excerpts.cursor::<Option<&Locator>>(());
2093        if let Some(locators) = buffers.get(&buffer_id).map(|state| &state.excerpts) {
2094            for locator in locators {
2095                cursor.seek_forward(&Some(locator), Bias::Left);
2096                if let Some(excerpt) = cursor.item()
2097                    && excerpt.locator == *locator
2098                {
2099                    excerpts.push((excerpt.id, excerpt.range.clone()));
2100                }
2101            }
2102        }
2103
2104        excerpts
2105    }
2106
2107    pub fn excerpt_ranges_for_buffer(&self, buffer_id: BufferId, cx: &App) -> Vec<Range<Point>> {
2108        let snapshot = self.read(cx);
2109        let buffers = self.buffers.borrow();
2110        let mut excerpts = snapshot
2111            .excerpts
2112            .cursor::<Dimensions<Option<&Locator>, ExcerptDimension<Point>>>(());
2113        let mut diff_transforms = snapshot
2114            .diff_transforms
2115            .cursor::<Dimensions<ExcerptDimension<Point>, OutputDimension<Point>>>(());
2116        diff_transforms.next();
2117        let locators = buffers
2118            .get(&buffer_id)
2119            .into_iter()
2120            .flat_map(|state| &state.excerpts);
2121        let mut result = Vec::new();
2122        for locator in locators {
2123            excerpts.seek_forward(&Some(locator), Bias::Left);
2124            if let Some(excerpt) = excerpts.item()
2125                && excerpt.locator == *locator
2126            {
2127                let excerpt_start = excerpts.start().1.clone();
2128                let excerpt_end = ExcerptDimension(excerpt_start.0 + excerpt.text_summary.lines);
2129
2130                diff_transforms.seek_forward(&excerpt_start, Bias::Left);
2131                let overshoot = excerpt_start.0 - diff_transforms.start().0.0;
2132                let start = diff_transforms.start().1.0 + overshoot;
2133
2134                diff_transforms.seek_forward(&excerpt_end, Bias::Right);
2135                let overshoot = excerpt_end.0 - diff_transforms.start().0.0;
2136                let end = diff_transforms.start().1.0 + overshoot;
2137
2138                result.push(start..end)
2139            }
2140        }
2141        result
2142    }
2143
2144    pub fn excerpt_buffer_ids(&self) -> Vec<BufferId> {
2145        self.snapshot
2146            .borrow()
2147            .excerpts
2148            .iter()
2149            .map(|entry| entry.buffer_id)
2150            .collect()
2151    }
2152
2153    pub fn excerpt_ids(&self) -> Vec<ExcerptId> {
2154        self.snapshot
2155            .borrow()
2156            .excerpts
2157            .iter()
2158            .map(|entry| entry.id)
2159            .collect()
2160    }
2161
2162    pub fn excerpt_containing(
2163        &self,
2164        position: impl ToOffset,
2165        cx: &App,
2166    ) -> Option<(ExcerptId, Entity<Buffer>, Range<text::Anchor>)> {
2167        let snapshot = self.read(cx);
2168        let offset = position.to_offset(&snapshot);
2169
2170        let mut cursor = snapshot.cursor::<usize>();
2171        cursor.seek(&offset);
2172        cursor
2173            .excerpt()
2174            .or_else(|| snapshot.excerpts.last())
2175            .map(|excerpt| {
2176                (
2177                    excerpt.id,
2178                    self.buffers
2179                        .borrow()
2180                        .get(&excerpt.buffer_id)
2181                        .unwrap()
2182                        .buffer
2183                        .clone(),
2184                    excerpt.range.context.clone(),
2185                )
2186            })
2187    }
2188
2189    pub fn buffer_for_anchor(&self, anchor: Anchor, cx: &App) -> Option<Entity<Buffer>> {
2190        if let Some(buffer_id) = anchor.buffer_id {
2191            self.buffer(buffer_id)
2192        } else {
2193            let (_, buffer, _) = self.excerpt_containing(anchor, cx)?;
2194            Some(buffer)
2195        }
2196    }
2197
2198    // If point is at the end of the buffer, the last excerpt is returned
2199    pub fn point_to_buffer_offset<T: ToOffset>(
2200        &self,
2201        point: T,
2202        cx: &App,
2203    ) -> Option<(Entity<Buffer>, usize)> {
2204        let snapshot = self.read(cx);
2205        let (buffer, offset) = snapshot.point_to_buffer_offset(point)?;
2206        Some((
2207            self.buffers
2208                .borrow()
2209                .get(&buffer.remote_id())?
2210                .buffer
2211                .clone(),
2212            offset,
2213        ))
2214    }
2215
2216    // If point is at the end of the buffer, the last excerpt is returned
2217    pub fn point_to_buffer_point<T: ToPoint>(
2218        &self,
2219        point: T,
2220        cx: &App,
2221    ) -> Option<(Entity<Buffer>, Point, ExcerptId)> {
2222        let snapshot = self.read(cx);
2223        let (buffer, point, is_main_buffer) =
2224            snapshot.point_to_buffer_point(point.to_point(&snapshot))?;
2225        Some((
2226            self.buffers
2227                .borrow()
2228                .get(&buffer.remote_id())?
2229                .buffer
2230                .clone(),
2231            point,
2232            is_main_buffer,
2233        ))
2234    }
2235
2236    pub fn buffer_point_to_anchor(
2237        &self,
2238        buffer: &Entity<Buffer>,
2239        point: Point,
2240        cx: &App,
2241    ) -> Option<Anchor> {
2242        let mut found = None;
2243        let snapshot = buffer.read(cx).snapshot();
2244        for (excerpt_id, range) in self.excerpts_for_buffer(snapshot.remote_id(), cx) {
2245            let start = range.context.start.to_point(&snapshot);
2246            let end = range.context.end.to_point(&snapshot);
2247            if start <= point && point < end {
2248                found = Some((snapshot.clip_point(point, Bias::Left), excerpt_id));
2249                break;
2250            }
2251            if point < start {
2252                found = Some((start, excerpt_id));
2253            }
2254            if point > end {
2255                found = Some((end, excerpt_id));
2256            }
2257        }
2258
2259        found.map(|(point, excerpt_id)| {
2260            let text_anchor = snapshot.anchor_after(point);
2261            Anchor::in_buffer(excerpt_id, snapshot.remote_id(), text_anchor)
2262        })
2263    }
2264
2265    pub fn remove_excerpts(
2266        &mut self,
2267        excerpt_ids: impl IntoIterator<Item = ExcerptId>,
2268        cx: &mut Context<Self>,
2269    ) {
2270        self.sync(cx);
2271        let ids = excerpt_ids.into_iter().collect::<Vec<_>>();
2272        if ids.is_empty() {
2273            return;
2274        }
2275
2276        let mut buffers = self.buffers.borrow_mut();
2277        let mut snapshot = self.snapshot.borrow_mut();
2278        let mut new_excerpts = SumTree::default();
2279        let mut cursor = snapshot
2280            .excerpts
2281            .cursor::<Dimensions<Option<&Locator>, ExcerptOffset>>(());
2282        let mut edits = Vec::new();
2283        let mut excerpt_ids = ids.iter().copied().peekable();
2284        let mut removed_buffer_ids = Vec::new();
2285
2286        while let Some(excerpt_id) = excerpt_ids.next() {
2287            self.paths_by_excerpt.remove(&excerpt_id);
2288            // Seek to the next excerpt to remove, preserving any preceding excerpts.
2289            let locator = snapshot.excerpt_locator_for_id(excerpt_id);
2290            new_excerpts.append(cursor.slice(&Some(locator), Bias::Left), ());
2291
2292            if let Some(mut excerpt) = cursor.item() {
2293                if excerpt.id != excerpt_id {
2294                    continue;
2295                }
2296                let mut old_start = cursor.start().1;
2297
2298                // Skip over the removed excerpt.
2299                'remove_excerpts: loop {
2300                    if let Some(buffer_state) = buffers.get_mut(&excerpt.buffer_id) {
2301                        buffer_state.excerpts.retain(|l| l != &excerpt.locator);
2302                        if buffer_state.excerpts.is_empty() {
2303                            log::debug!(
2304                                "removing buffer and diff for buffer {}",
2305                                excerpt.buffer_id
2306                            );
2307                            buffers.remove(&excerpt.buffer_id);
2308                            removed_buffer_ids.push(excerpt.buffer_id);
2309                        }
2310                    }
2311                    cursor.next();
2312
2313                    // Skip over any subsequent excerpts that are also removed.
2314                    if let Some(&next_excerpt_id) = excerpt_ids.peek() {
2315                        let next_locator = snapshot.excerpt_locator_for_id(next_excerpt_id);
2316                        if let Some(next_excerpt) = cursor.item()
2317                            && next_excerpt.locator == *next_locator
2318                        {
2319                            excerpt_ids.next();
2320                            excerpt = next_excerpt;
2321                            continue 'remove_excerpts;
2322                        }
2323                    }
2324
2325                    break;
2326                }
2327
2328                // When removing the last excerpt, remove the trailing newline from
2329                // the previous excerpt.
2330                if cursor.item().is_none() && old_start.value > 0 {
2331                    old_start.value -= 1;
2332                    new_excerpts.update_last(|e| e.has_trailing_newline = false, ());
2333                }
2334
2335                // Push an edit for the removal of this run of excerpts.
2336                let old_end = cursor.start().1;
2337                let new_start = ExcerptOffset::new(new_excerpts.summary().text.len);
2338                edits.push(Edit {
2339                    old: old_start..old_end,
2340                    new: new_start..new_start,
2341                });
2342            }
2343        }
2344        let suffix = cursor.suffix();
2345        let changed_trailing_excerpt = suffix.is_empty();
2346        new_excerpts.append(suffix, ());
2347        drop(cursor);
2348        snapshot.excerpts = new_excerpts;
2349        for buffer_id in &removed_buffer_ids {
2350            self.diffs.remove(buffer_id);
2351            snapshot.diffs.remove(buffer_id);
2352        }
2353
2354        if changed_trailing_excerpt {
2355            snapshot.trailing_excerpt_update_count += 1;
2356        }
2357
2358        self.sync_diff_transforms(&mut snapshot, edits, DiffChangeKind::BufferEdited);
2359        self.buffer_changed_since_sync.replace(true);
2360        cx.emit(Event::Edited {
2361            edited_buffer: None,
2362        });
2363        cx.emit(Event::ExcerptsRemoved {
2364            ids,
2365            removed_buffer_ids,
2366        });
2367        cx.notify();
2368    }
2369
2370    pub fn wait_for_anchors<'a, Anchors: 'a + Iterator<Item = Anchor>>(
2371        &self,
2372        anchors: Anchors,
2373        cx: &mut Context<Self>,
2374    ) -> impl 'static + Future<Output = Result<()>> + use<Anchors> {
2375        let borrow = self.buffers.borrow();
2376        let mut error = None;
2377        let mut futures = Vec::new();
2378        for anchor in anchors {
2379            if let Some(buffer_id) = anchor.buffer_id {
2380                if let Some(buffer) = borrow.get(&buffer_id) {
2381                    buffer.buffer.update(cx, |buffer, _| {
2382                        futures.push(buffer.wait_for_anchors([anchor.text_anchor]))
2383                    });
2384                } else {
2385                    error = Some(anyhow!(
2386                        "buffer {buffer_id} is not part of this multi-buffer"
2387                    ));
2388                    break;
2389                }
2390            }
2391        }
2392        async move {
2393            if let Some(error) = error {
2394                Err(error)?;
2395            }
2396            for future in futures {
2397                future.await?;
2398            }
2399            Ok(())
2400        }
2401    }
2402
2403    pub fn text_anchor_for_position<T: ToOffset>(
2404        &self,
2405        position: T,
2406        cx: &App,
2407    ) -> Option<(Entity<Buffer>, language::Anchor)> {
2408        let snapshot = self.read(cx);
2409        let anchor = snapshot.anchor_before(position);
2410        let buffer = self
2411            .buffers
2412            .borrow()
2413            .get(&anchor.buffer_id?)?
2414            .buffer
2415            .clone();
2416        Some((buffer, anchor.text_anchor))
2417    }
2418
2419    fn on_buffer_event(
2420        &mut self,
2421        buffer: Entity<Buffer>,
2422        event: &language::BufferEvent,
2423        cx: &mut Context<Self>,
2424    ) {
2425        use language::BufferEvent;
2426        cx.emit(match event {
2427            BufferEvent::Edited => Event::Edited {
2428                edited_buffer: Some(buffer),
2429            },
2430            BufferEvent::DirtyChanged => Event::DirtyChanged,
2431            BufferEvent::Saved => Event::Saved,
2432            BufferEvent::FileHandleChanged => Event::FileHandleChanged,
2433            BufferEvent::Reloaded => Event::Reloaded,
2434            BufferEvent::LanguageChanged => Event::LanguageChanged(buffer.read(cx).remote_id()),
2435            BufferEvent::Reparsed => Event::Reparsed(buffer.read(cx).remote_id()),
2436            BufferEvent::DiagnosticsUpdated => Event::DiagnosticsUpdated,
2437            BufferEvent::CapabilityChanged => {
2438                self.capability = buffer.read(cx).capability();
2439                return;
2440            }
2441            BufferEvent::Operation { .. } | BufferEvent::ReloadNeeded => return,
2442        });
2443    }
2444
2445    fn buffer_diff_language_changed(&mut self, diff: Entity<BufferDiff>, cx: &mut Context<Self>) {
2446        self.sync(cx);
2447        let mut snapshot = self.snapshot.borrow_mut();
2448        let diff = diff.read(cx);
2449        let buffer_id = diff.buffer_id;
2450        let diff = diff.snapshot(cx);
2451        snapshot.diffs.insert(buffer_id, diff);
2452    }
2453
2454    fn buffer_diff_changed(
2455        &mut self,
2456        diff: Entity<BufferDiff>,
2457        range: Range<text::Anchor>,
2458        cx: &mut Context<Self>,
2459    ) {
2460        self.sync(cx);
2461        self.buffer_changed_since_sync.replace(true);
2462
2463        let diff = diff.read(cx);
2464        let buffer_id = diff.buffer_id;
2465        let buffers = self.buffers.borrow();
2466        let Some(buffer_state) = buffers.get(&buffer_id) else {
2467            return;
2468        };
2469
2470        let buffer = buffer_state.buffer.read(cx);
2471        let diff_change_range = range.to_offset(buffer);
2472
2473        let new_diff = diff.snapshot(cx);
2474        let mut snapshot = self.snapshot.borrow_mut();
2475        let base_text_changed = snapshot
2476            .diffs
2477            .get(&buffer_id)
2478            .is_none_or(|old_diff| !new_diff.base_texts_eq(old_diff));
2479
2480        snapshot.diffs.insert(buffer_id, new_diff);
2481
2482        let mut excerpt_edits = Vec::new();
2483        for locator in &buffer_state.excerpts {
2484            let mut cursor = snapshot
2485                .excerpts
2486                .cursor::<Dimensions<Option<&Locator>, ExcerptOffset>>(());
2487            cursor.seek_forward(&Some(locator), Bias::Left);
2488            if let Some(excerpt) = cursor.item()
2489                && excerpt.locator == *locator
2490            {
2491                let excerpt_buffer_range = excerpt.range.context.to_offset(&excerpt.buffer);
2492                if diff_change_range.end < excerpt_buffer_range.start
2493                    || diff_change_range.start > excerpt_buffer_range.end
2494                {
2495                    continue;
2496                }
2497                let excerpt_start = cursor.start().1;
2498                let excerpt_len = ExcerptOffset::new(excerpt.text_summary.len);
2499                let diff_change_start_in_excerpt = ExcerptOffset::new(
2500                    diff_change_range
2501                        .start
2502                        .saturating_sub(excerpt_buffer_range.start),
2503                );
2504                let diff_change_end_in_excerpt = ExcerptOffset::new(
2505                    diff_change_range
2506                        .end
2507                        .saturating_sub(excerpt_buffer_range.start),
2508                );
2509                let edit_start = excerpt_start + diff_change_start_in_excerpt.min(excerpt_len);
2510                let edit_end = excerpt_start + diff_change_end_in_excerpt.min(excerpt_len);
2511                excerpt_edits.push(Edit {
2512                    old: edit_start..edit_end,
2513                    new: edit_start..edit_end,
2514                });
2515            }
2516        }
2517
2518        self.sync_diff_transforms(
2519            &mut snapshot,
2520            excerpt_edits,
2521            DiffChangeKind::DiffUpdated {
2522                base_changed: base_text_changed,
2523            },
2524        );
2525        cx.emit(Event::Edited {
2526            edited_buffer: None,
2527        });
2528    }
2529
2530    pub fn all_buffers(&self) -> HashSet<Entity<Buffer>> {
2531        self.buffers
2532            .borrow()
2533            .values()
2534            .map(|state| state.buffer.clone())
2535            .collect()
2536    }
2537
2538    pub fn all_buffer_ids(&self) -> Vec<BufferId> {
2539        self.buffers.borrow().keys().copied().collect()
2540    }
2541
2542    pub fn buffer(&self, buffer_id: BufferId) -> Option<Entity<Buffer>> {
2543        self.buffers
2544            .borrow()
2545            .get(&buffer_id)
2546            .map(|state| state.buffer.clone())
2547    }
2548
2549    pub fn language_at<T: ToOffset>(&self, point: T, cx: &App) -> Option<Arc<Language>> {
2550        self.point_to_buffer_offset(point, cx)
2551            .and_then(|(buffer, offset)| buffer.read(cx).language_at(offset))
2552    }
2553
2554    pub fn language_settings<'a>(&'a self, cx: &'a App) -> Cow<'a, LanguageSettings> {
2555        let buffer_id = self
2556            .snapshot
2557            .borrow()
2558            .excerpts
2559            .first()
2560            .map(|excerpt| excerpt.buffer.remote_id());
2561        buffer_id
2562            .and_then(|buffer_id| self.buffer(buffer_id))
2563            .map(|buffer| {
2564                let buffer = buffer.read(cx);
2565                language_settings(buffer.language().map(|l| l.name()), buffer.file(), cx)
2566            })
2567            .unwrap_or_else(move || self.language_settings_at(0, cx))
2568    }
2569
2570    pub fn language_settings_at<'a, T: ToOffset>(
2571        &'a self,
2572        point: T,
2573        cx: &'a App,
2574    ) -> Cow<'a, LanguageSettings> {
2575        let mut language = None;
2576        let mut file = None;
2577        if let Some((buffer, offset)) = self.point_to_buffer_offset(point, cx) {
2578            let buffer = buffer.read(cx);
2579            language = buffer.language_at(offset);
2580            file = buffer.file();
2581        }
2582        language_settings(language.map(|l| l.name()), file, cx)
2583    }
2584
2585    pub fn for_each_buffer(&self, mut f: impl FnMut(&Entity<Buffer>)) {
2586        self.buffers
2587            .borrow()
2588            .values()
2589            .for_each(|state| f(&state.buffer))
2590    }
2591
2592    pub fn title<'a>(&'a self, cx: &'a App) -> Cow<'a, str> {
2593        if let Some(title) = self.title.as_ref() {
2594            return title.into();
2595        }
2596
2597        if let Some(buffer) = self.as_singleton() {
2598            let buffer = buffer.read(cx);
2599
2600            if let Some(file) = buffer.file() {
2601                return file.file_name(cx).into();
2602            }
2603
2604            if let Some(title) = self.buffer_content_title(buffer) {
2605                return title;
2606            }
2607        };
2608
2609        "untitled".into()
2610    }
2611
2612    fn buffer_content_title(&self, buffer: &Buffer) -> Option<Cow<'_, str>> {
2613        let mut is_leading_whitespace = true;
2614        let mut count = 0;
2615        let mut prev_was_space = false;
2616        let mut title = String::new();
2617
2618        for ch in buffer.snapshot().chars() {
2619            if is_leading_whitespace && ch.is_whitespace() {
2620                continue;
2621            }
2622
2623            is_leading_whitespace = false;
2624
2625            if ch == '\n' || count >= 40 {
2626                break;
2627            }
2628
2629            if ch.is_whitespace() {
2630                if !prev_was_space {
2631                    title.push(' ');
2632                    count += 1;
2633                    prev_was_space = true;
2634                }
2635            } else {
2636                title.push(ch);
2637                count += 1;
2638                prev_was_space = false;
2639            }
2640        }
2641
2642        let title = title.trim_end().to_string();
2643
2644        if title.is_empty() {
2645            return None;
2646        }
2647
2648        Some(title.into())
2649    }
2650
2651    pub fn set_title(&mut self, title: String, cx: &mut Context<Self>) {
2652        self.title = Some(title);
2653        cx.notify();
2654    }
2655
2656    /// Preserve preview tabs containing this multibuffer until additional edits occur.
2657    pub fn refresh_preview(&self, cx: &mut Context<Self>) {
2658        for buffer_state in self.buffers.borrow().values() {
2659            buffer_state
2660                .buffer
2661                .update(cx, |buffer, _cx| buffer.refresh_preview());
2662        }
2663    }
2664
2665    /// Whether we should preserve the preview status of a tab containing this multi-buffer.
2666    pub fn preserve_preview(&self, cx: &App) -> bool {
2667        self.buffers
2668            .borrow()
2669            .values()
2670            .all(|state| state.buffer.read(cx).preserve_preview())
2671    }
2672
2673    #[cfg(any(test, feature = "test-support"))]
2674    pub fn is_parsing(&self, cx: &App) -> bool {
2675        self.as_singleton().unwrap().read(cx).is_parsing()
2676    }
2677
2678    pub fn add_diff(&mut self, diff: Entity<BufferDiff>, cx: &mut Context<Self>) {
2679        let buffer_id = diff.read(cx).buffer_id;
2680        self.buffer_diff_changed(diff.clone(), text::Anchor::MIN..text::Anchor::MAX, cx);
2681        self.diffs.insert(buffer_id, DiffState::new(diff, cx));
2682    }
2683
2684    pub fn diff_for(&self, buffer_id: BufferId) -> Option<Entity<BufferDiff>> {
2685        self.diffs.get(&buffer_id).map(|state| state.diff.clone())
2686    }
2687
2688    pub fn expand_diff_hunks(&mut self, ranges: Vec<Range<Anchor>>, cx: &mut Context<Self>) {
2689        self.expand_or_collapse_diff_hunks(ranges, true, cx);
2690    }
2691
2692    pub fn collapse_diff_hunks(&mut self, ranges: Vec<Range<Anchor>>, cx: &mut Context<Self>) {
2693        self.expand_or_collapse_diff_hunks(ranges, false, cx);
2694    }
2695
2696    pub fn set_all_diff_hunks_expanded(&mut self, cx: &mut Context<Self>) {
2697        self.snapshot.borrow_mut().all_diff_hunks_expanded = true;
2698        self.expand_or_collapse_diff_hunks(vec![Anchor::min()..Anchor::max()], true, cx);
2699    }
2700
2701    pub fn all_diff_hunks_expanded(&self) -> bool {
2702        self.snapshot.borrow().all_diff_hunks_expanded
2703    }
2704
2705    pub fn set_all_diff_hunks_collapsed(&mut self, cx: &mut Context<Self>) {
2706        self.snapshot.borrow_mut().all_diff_hunks_expanded = false;
2707        self.expand_or_collapse_diff_hunks(vec![Anchor::min()..Anchor::max()], false, cx);
2708    }
2709
2710    pub fn has_multiple_hunks(&self, cx: &App) -> bool {
2711        self.read(cx)
2712            .diff_hunks_in_range(Anchor::min()..Anchor::max())
2713            .nth(1)
2714            .is_some()
2715    }
2716
2717    pub fn single_hunk_is_expanded(&self, range: Range<Anchor>, cx: &App) -> bool {
2718        let snapshot = self.read(cx);
2719        let mut cursor = snapshot.diff_transforms.cursor::<usize>(());
2720        let offset_range = range.to_offset(&snapshot);
2721        cursor.seek(&offset_range.start, Bias::Left);
2722        while let Some(item) = cursor.item() {
2723            if *cursor.start() >= offset_range.end && *cursor.start() > offset_range.start {
2724                break;
2725            }
2726            if item.hunk_info().is_some() {
2727                return true;
2728            }
2729            cursor.next();
2730        }
2731        false
2732    }
2733
2734    pub fn has_expanded_diff_hunks_in_ranges(&self, ranges: &[Range<Anchor>], cx: &App) -> bool {
2735        let snapshot = self.read(cx);
2736        let mut cursor = snapshot.diff_transforms.cursor::<usize>(());
2737        for range in ranges {
2738            let range = range.to_point(&snapshot);
2739            let start = snapshot.point_to_offset(Point::new(range.start.row, 0));
2740            let end = snapshot.point_to_offset(Point::new(range.end.row + 1, 0));
2741            let start = start.saturating_sub(1);
2742            let end = snapshot.len().min(end + 1);
2743            cursor.seek(&start, Bias::Right);
2744            while let Some(item) = cursor.item() {
2745                if *cursor.start() >= end {
2746                    break;
2747                }
2748                if item.hunk_info().is_some() {
2749                    return true;
2750                }
2751                cursor.next();
2752            }
2753        }
2754        false
2755    }
2756
2757    pub fn expand_or_collapse_diff_hunks_inner(
2758        &mut self,
2759        ranges: impl IntoIterator<Item = (Range<Point>, ExcerptId)>,
2760        expand: bool,
2761        cx: &mut Context<Self>,
2762    ) {
2763        if self.snapshot.borrow().all_diff_hunks_expanded && !expand {
2764            return;
2765        }
2766        self.sync(cx);
2767        let mut snapshot = self.snapshot.borrow_mut();
2768        let mut excerpt_edits = Vec::new();
2769        let mut last_hunk_row = None;
2770        for (range, end_excerpt_id) in ranges {
2771            for diff_hunk in snapshot.diff_hunks_in_range(range) {
2772                if diff_hunk.excerpt_id.cmp(&end_excerpt_id, &snapshot).is_gt() {
2773                    continue;
2774                }
2775                if last_hunk_row.is_some_and(|row| row >= diff_hunk.row_range.start) {
2776                    continue;
2777                }
2778                let start = Anchor::in_buffer(
2779                    diff_hunk.excerpt_id,
2780                    diff_hunk.buffer_id,
2781                    diff_hunk.buffer_range.start,
2782                );
2783                let end = Anchor::in_buffer(
2784                    diff_hunk.excerpt_id,
2785                    diff_hunk.buffer_id,
2786                    diff_hunk.buffer_range.end,
2787                );
2788                let start = snapshot.excerpt_offset_for_anchor(&start);
2789                let end = snapshot.excerpt_offset_for_anchor(&end);
2790                last_hunk_row = Some(diff_hunk.row_range.start);
2791                excerpt_edits.push(text::Edit {
2792                    old: start..end,
2793                    new: start..end,
2794                });
2795            }
2796        }
2797
2798        self.sync_diff_transforms(
2799            &mut snapshot,
2800            excerpt_edits,
2801            DiffChangeKind::ExpandOrCollapseHunks { expand },
2802        );
2803        cx.emit(Event::DiffHunksToggled);
2804        cx.emit(Event::Edited {
2805            edited_buffer: None,
2806        });
2807    }
2808
2809    pub fn expand_or_collapse_diff_hunks(
2810        &mut self,
2811        ranges: Vec<Range<Anchor>>,
2812        expand: bool,
2813        cx: &mut Context<Self>,
2814    ) {
2815        let snapshot = self.snapshot.borrow().clone();
2816        let ranges = ranges.iter().map(move |range| {
2817            let end_excerpt_id = range.end.excerpt_id;
2818            let range = range.to_point(&snapshot);
2819            let mut peek_end = range.end;
2820            if range.end.row < snapshot.max_row().0 {
2821                peek_end = Point::new(range.end.row + 1, 0);
2822            };
2823            (range.start..peek_end, end_excerpt_id)
2824        });
2825        self.expand_or_collapse_diff_hunks_inner(ranges, expand, cx);
2826    }
2827
2828    pub fn resize_excerpt(
2829        &mut self,
2830        id: ExcerptId,
2831        range: Range<text::Anchor>,
2832        cx: &mut Context<Self>,
2833    ) {
2834        self.sync(cx);
2835
2836        let mut snapshot = self.snapshot.borrow_mut();
2837        let locator = snapshot.excerpt_locator_for_id(id);
2838        let mut new_excerpts = SumTree::default();
2839        let mut cursor = snapshot
2840            .excerpts
2841            .cursor::<Dimensions<Option<&Locator>, ExcerptOffset>>(());
2842        let mut edits = Vec::<Edit<ExcerptOffset>>::new();
2843
2844        let prefix = cursor.slice(&Some(locator), Bias::Left);
2845        new_excerpts.append(prefix, ());
2846
2847        let mut excerpt = cursor.item().unwrap().clone();
2848        let old_text_len = ExcerptOffset::new(excerpt.text_summary.len);
2849
2850        excerpt.range.context.start = range.start;
2851        excerpt.range.context.end = range.end;
2852        excerpt.max_buffer_row = range.end.to_point(&excerpt.buffer).row;
2853
2854        excerpt.text_summary = excerpt
2855            .buffer
2856            .text_summary_for_range(excerpt.range.context.clone());
2857
2858        let new_start_offset = ExcerptOffset::new(new_excerpts.summary().text.len);
2859        let old_start_offset = cursor.start().1;
2860        let new_text_len = ExcerptOffset::new(excerpt.text_summary.len);
2861        let edit = Edit {
2862            old: old_start_offset..old_start_offset + old_text_len,
2863            new: new_start_offset..new_start_offset + new_text_len,
2864        };
2865
2866        if let Some(last_edit) = edits.last_mut() {
2867            if last_edit.old.end == edit.old.start {
2868                last_edit.old.end = edit.old.end;
2869                last_edit.new.end = edit.new.end;
2870            } else {
2871                edits.push(edit);
2872            }
2873        } else {
2874            edits.push(edit);
2875        }
2876
2877        new_excerpts.push(excerpt, ());
2878
2879        cursor.next();
2880
2881        new_excerpts.append(cursor.suffix(), ());
2882
2883        drop(cursor);
2884        snapshot.excerpts = new_excerpts;
2885
2886        self.sync_diff_transforms(&mut snapshot, edits, DiffChangeKind::BufferEdited);
2887        cx.emit(Event::Edited {
2888            edited_buffer: None,
2889        });
2890        cx.emit(Event::ExcerptsExpanded { ids: vec![id] });
2891        cx.notify();
2892    }
2893
2894    pub fn expand_excerpts(
2895        &mut self,
2896        ids: impl IntoIterator<Item = ExcerptId>,
2897        line_count: u32,
2898        direction: ExpandExcerptDirection,
2899        cx: &mut Context<Self>,
2900    ) {
2901        if line_count == 0 {
2902            return;
2903        }
2904        self.sync(cx);
2905        if !self.excerpts_by_path.is_empty() {
2906            self.expand_excerpts_with_paths(ids, line_count, direction, cx);
2907            return;
2908        }
2909        let mut snapshot = self.snapshot.borrow_mut();
2910
2911        let ids = ids.into_iter().collect::<Vec<_>>();
2912        let locators = snapshot.excerpt_locators_for_ids(ids.iter().copied());
2913        let mut new_excerpts = SumTree::default();
2914        let mut cursor = snapshot
2915            .excerpts
2916            .cursor::<Dimensions<Option<&Locator>, ExcerptOffset>>(());
2917        let mut edits = Vec::<Edit<ExcerptOffset>>::new();
2918
2919        for locator in &locators {
2920            let prefix = cursor.slice(&Some(locator), Bias::Left);
2921            new_excerpts.append(prefix, ());
2922
2923            let mut excerpt = cursor.item().unwrap().clone();
2924            let old_text_len = ExcerptOffset::new(excerpt.text_summary.len);
2925
2926            let up_line_count = if direction.should_expand_up() {
2927                line_count
2928            } else {
2929                0
2930            };
2931
2932            let start_row = excerpt
2933                .range
2934                .context
2935                .start
2936                .to_point(&excerpt.buffer)
2937                .row
2938                .saturating_sub(up_line_count);
2939            let start_point = Point::new(start_row, 0);
2940            excerpt.range.context.start = excerpt.buffer.anchor_before(start_point);
2941
2942            let down_line_count = if direction.should_expand_down() {
2943                line_count
2944            } else {
2945                0
2946            };
2947
2948            let mut end_point = excerpt.buffer.clip_point(
2949                excerpt.range.context.end.to_point(&excerpt.buffer)
2950                    + Point::new(down_line_count, 0),
2951                Bias::Left,
2952            );
2953            end_point.column = excerpt.buffer.line_len(end_point.row);
2954            excerpt.range.context.end = excerpt.buffer.anchor_after(end_point);
2955            excerpt.max_buffer_row = end_point.row;
2956
2957            excerpt.text_summary = excerpt
2958                .buffer
2959                .text_summary_for_range(excerpt.range.context.clone());
2960
2961            let new_start_offset = ExcerptOffset::new(new_excerpts.summary().text.len);
2962            let old_start_offset = cursor.start().1;
2963            let new_text_len = ExcerptOffset::new(excerpt.text_summary.len);
2964            let edit = Edit {
2965                old: old_start_offset..old_start_offset + old_text_len,
2966                new: new_start_offset..new_start_offset + new_text_len,
2967            };
2968
2969            if let Some(last_edit) = edits.last_mut() {
2970                if last_edit.old.end == edit.old.start {
2971                    last_edit.old.end = edit.old.end;
2972                    last_edit.new.end = edit.new.end;
2973                } else {
2974                    edits.push(edit);
2975                }
2976            } else {
2977                edits.push(edit);
2978            }
2979
2980            new_excerpts.push(excerpt, ());
2981
2982            cursor.next();
2983        }
2984
2985        new_excerpts.append(cursor.suffix(), ());
2986
2987        drop(cursor);
2988        snapshot.excerpts = new_excerpts;
2989
2990        self.sync_diff_transforms(&mut snapshot, edits, DiffChangeKind::BufferEdited);
2991        cx.emit(Event::Edited {
2992            edited_buffer: None,
2993        });
2994        cx.emit(Event::ExcerptsExpanded { ids });
2995        cx.notify();
2996    }
2997
2998    fn sync(&self, cx: &App) {
2999        let changed = self.buffer_changed_since_sync.replace(false);
3000        if !changed {
3001            return;
3002        }
3003
3004        let mut snapshot = self.snapshot.borrow_mut();
3005        let mut excerpts_to_edit = Vec::new();
3006        let mut non_text_state_updated = false;
3007        let mut is_dirty = false;
3008        let mut has_deleted_file = false;
3009        let mut has_conflict = false;
3010        let mut edited = false;
3011        let mut buffers = self.buffers.borrow_mut();
3012        for buffer_state in buffers.values_mut() {
3013            let buffer = buffer_state.buffer.read(cx);
3014            let version = buffer.version();
3015            let non_text_state_update_count = buffer.non_text_state_update_count();
3016
3017            let buffer_edited = version.changed_since(&buffer_state.last_version);
3018            let buffer_non_text_state_updated =
3019                non_text_state_update_count > buffer_state.last_non_text_state_update_count;
3020            if buffer_edited || buffer_non_text_state_updated {
3021                buffer_state.last_version = version;
3022                buffer_state.last_non_text_state_update_count = non_text_state_update_count;
3023                excerpts_to_edit.extend(
3024                    buffer_state
3025                        .excerpts
3026                        .iter()
3027                        .map(|locator| (locator, buffer_state.buffer.clone(), buffer_edited)),
3028                );
3029            }
3030
3031            edited |= buffer_edited;
3032            non_text_state_updated |= buffer_non_text_state_updated;
3033            is_dirty |= buffer.is_dirty();
3034            has_deleted_file |= buffer
3035                .file()
3036                .is_some_and(|file| file.disk_state() == DiskState::Deleted);
3037            has_conflict |= buffer.has_conflict();
3038        }
3039        if edited {
3040            snapshot.edit_count += 1;
3041        }
3042        if non_text_state_updated {
3043            snapshot.non_text_state_update_count += 1;
3044        }
3045        snapshot.is_dirty = is_dirty;
3046        snapshot.has_deleted_file = has_deleted_file;
3047        snapshot.has_conflict = has_conflict;
3048
3049        for (id, diff) in self.diffs.iter() {
3050            if snapshot.diffs.get(id).is_none() {
3051                snapshot.diffs.insert(*id, diff.diff.read(cx).snapshot(cx));
3052            }
3053        }
3054
3055        excerpts_to_edit.sort_unstable_by_key(|(locator, _, _)| *locator);
3056
3057        let mut edits = Vec::new();
3058        let mut new_excerpts = SumTree::default();
3059        let mut cursor = snapshot
3060            .excerpts
3061            .cursor::<Dimensions<Option<&Locator>, ExcerptOffset>>(());
3062
3063        for (locator, buffer, buffer_edited) in excerpts_to_edit {
3064            new_excerpts.append(cursor.slice(&Some(locator), Bias::Left), ());
3065            let old_excerpt = cursor.item().unwrap();
3066            let buffer = buffer.read(cx);
3067            let buffer_id = buffer.remote_id();
3068
3069            let mut new_excerpt;
3070            if buffer_edited {
3071                edits.extend(
3072                    buffer
3073                        .edits_since_in_range::<usize>(
3074                            old_excerpt.buffer.version(),
3075                            old_excerpt.range.context.clone(),
3076                        )
3077                        .map(|edit| {
3078                            let excerpt_old_start = cursor.start().1;
3079                            let excerpt_new_start =
3080                                ExcerptOffset::new(new_excerpts.summary().text.len);
3081                            let old_start = excerpt_old_start + ExcerptOffset::new(edit.old.start);
3082                            let old_end = excerpt_old_start + ExcerptOffset::new(edit.old.end);
3083                            let new_start = excerpt_new_start + ExcerptOffset::new(edit.new.start);
3084                            let new_end = excerpt_new_start + ExcerptOffset::new(edit.new.end);
3085                            Edit {
3086                                old: old_start..old_end,
3087                                new: new_start..new_end,
3088                            }
3089                        }),
3090                );
3091
3092                new_excerpt = Excerpt::new(
3093                    old_excerpt.id,
3094                    locator.clone(),
3095                    buffer_id,
3096                    buffer.snapshot(),
3097                    old_excerpt.range.clone(),
3098                    old_excerpt.has_trailing_newline,
3099                );
3100            } else {
3101                new_excerpt = old_excerpt.clone();
3102                new_excerpt.buffer = buffer.snapshot();
3103            }
3104
3105            new_excerpts.push(new_excerpt, ());
3106            cursor.next();
3107        }
3108        new_excerpts.append(cursor.suffix(), ());
3109
3110        drop(cursor);
3111        snapshot.excerpts = new_excerpts;
3112
3113        self.sync_diff_transforms(&mut snapshot, edits, DiffChangeKind::BufferEdited);
3114    }
3115
3116    fn sync_diff_transforms(
3117        &self,
3118        snapshot: &mut MultiBufferSnapshot,
3119        excerpt_edits: Vec<text::Edit<ExcerptOffset>>,
3120        change_kind: DiffChangeKind,
3121    ) {
3122        if excerpt_edits.is_empty() {
3123            return;
3124        }
3125
3126        let mut excerpts = snapshot.excerpts.cursor::<ExcerptOffset>(());
3127        let mut old_diff_transforms = snapshot
3128            .diff_transforms
3129            .cursor::<Dimensions<ExcerptOffset, usize>>(());
3130        let mut new_diff_transforms = SumTree::default();
3131        let mut old_expanded_hunks = HashSet::default();
3132        let mut output_edits = Vec::new();
3133        let mut output_delta = 0_isize;
3134        let mut at_transform_boundary = true;
3135        let mut end_of_current_insert = None;
3136
3137        let mut excerpt_edits = excerpt_edits.into_iter().peekable();
3138        while let Some(edit) = excerpt_edits.next() {
3139            excerpts.seek_forward(&edit.new.start, Bias::Right);
3140            if excerpts.item().is_none() && *excerpts.start() == edit.new.start {
3141                excerpts.prev();
3142            }
3143
3144            // Keep any transforms that are before the edit.
3145            if at_transform_boundary {
3146                at_transform_boundary = false;
3147                let transforms_before_edit = old_diff_transforms.slice(&edit.old.start, Bias::Left);
3148                self.append_diff_transforms(&mut new_diff_transforms, transforms_before_edit);
3149                if let Some(transform) = old_diff_transforms.item()
3150                    && old_diff_transforms.end().0 == edit.old.start
3151                    && old_diff_transforms.start().0 < edit.old.start
3152                {
3153                    self.push_diff_transform(&mut new_diff_transforms, transform.clone());
3154                    old_diff_transforms.next();
3155                }
3156            }
3157
3158            // Compute the start of the edit in output coordinates.
3159            let edit_start_overshoot = (edit.old.start - old_diff_transforms.start().0).value;
3160            let edit_old_start = old_diff_transforms.start().1 + edit_start_overshoot;
3161            let edit_new_start = (edit_old_start as isize + output_delta) as usize;
3162
3163            let changed_diff_hunks = self.recompute_diff_transforms_for_edit(
3164                &edit,
3165                &mut excerpts,
3166                &mut old_diff_transforms,
3167                &mut new_diff_transforms,
3168                &mut end_of_current_insert,
3169                &mut old_expanded_hunks,
3170                snapshot,
3171                change_kind,
3172            );
3173
3174            // Compute the end of the edit in output coordinates.
3175            let edit_old_end_overshoot = edit.old.end - old_diff_transforms.start().0;
3176            let edit_new_end_overshoot = edit.new.end - new_diff_transforms.summary().excerpt_len();
3177            let edit_old_end = old_diff_transforms.start().1 + edit_old_end_overshoot.value;
3178            let edit_new_end =
3179                new_diff_transforms.summary().output.len + edit_new_end_overshoot.value;
3180            let output_edit = Edit {
3181                old: edit_old_start..edit_old_end,
3182                new: edit_new_start..edit_new_end,
3183            };
3184
3185            output_delta += (output_edit.new.end - output_edit.new.start) as isize;
3186            output_delta -= (output_edit.old.end - output_edit.old.start) as isize;
3187            if changed_diff_hunks || matches!(change_kind, DiffChangeKind::BufferEdited) {
3188                output_edits.push(output_edit);
3189            }
3190
3191            // If this is the last edit that intersects the current diff transform,
3192            // then recreate the content up to the end of this transform, to prepare
3193            // for reusing additional slices of the old transforms.
3194            if excerpt_edits
3195                .peek()
3196                .is_none_or(|next_edit| next_edit.old.start >= old_diff_transforms.end().0)
3197            {
3198                let keep_next_old_transform = (old_diff_transforms.start().0 >= edit.old.end)
3199                    && match old_diff_transforms.item() {
3200                        Some(DiffTransform::BufferContent {
3201                            inserted_hunk_info: Some(hunk),
3202                            ..
3203                        }) => excerpts.item().is_some_and(|excerpt| {
3204                            hunk.hunk_start_anchor.is_valid(&excerpt.buffer)
3205                        }),
3206                        _ => true,
3207                    };
3208
3209                let mut excerpt_offset = edit.new.end;
3210                if !keep_next_old_transform {
3211                    excerpt_offset += old_diff_transforms.end().0 - edit.old.end;
3212                    old_diff_transforms.next();
3213                }
3214
3215                old_expanded_hunks.clear();
3216                self.push_buffer_content_transform(
3217                    snapshot,
3218                    &mut new_diff_transforms,
3219                    excerpt_offset,
3220                    end_of_current_insert,
3221                );
3222                at_transform_boundary = true;
3223            }
3224        }
3225
3226        // Keep any transforms that are after the last edit.
3227        self.append_diff_transforms(&mut new_diff_transforms, old_diff_transforms.suffix());
3228
3229        // Ensure there's always at least one buffer content transform.
3230        if new_diff_transforms.is_empty() {
3231            new_diff_transforms.push(
3232                DiffTransform::BufferContent {
3233                    summary: Default::default(),
3234                    inserted_hunk_info: None,
3235                },
3236                (),
3237            );
3238        }
3239
3240        self.subscriptions.publish(output_edits);
3241        drop(old_diff_transforms);
3242        drop(excerpts);
3243        snapshot.diff_transforms = new_diff_transforms;
3244        snapshot.edit_count += 1;
3245
3246        #[cfg(any(test, feature = "test-support"))]
3247        snapshot.check_invariants();
3248    }
3249
3250    fn recompute_diff_transforms_for_edit(
3251        &self,
3252        edit: &Edit<TypedOffset<Excerpt>>,
3253        excerpts: &mut Cursor<Excerpt, TypedOffset<Excerpt>>,
3254        old_diff_transforms: &mut Cursor<DiffTransform, Dimensions<TypedOffset<Excerpt>, usize>>,
3255        new_diff_transforms: &mut SumTree<DiffTransform>,
3256        end_of_current_insert: &mut Option<(TypedOffset<Excerpt>, DiffTransformHunkInfo)>,
3257        old_expanded_hunks: &mut HashSet<DiffTransformHunkInfo>,
3258        snapshot: &MultiBufferSnapshot,
3259        change_kind: DiffChangeKind,
3260    ) -> bool {
3261        log::trace!(
3262            "recomputing diff transform for edit {:?} => {:?}",
3263            edit.old.start.value..edit.old.end.value,
3264            edit.new.start.value..edit.new.end.value
3265        );
3266
3267        // Record which hunks were previously expanded.
3268        while let Some(item) = old_diff_transforms.item() {
3269            if let Some(hunk_info) = item.hunk_info() {
3270                log::trace!(
3271                    "previously expanded hunk at {}",
3272                    old_diff_transforms.start().0
3273                );
3274                old_expanded_hunks.insert(hunk_info);
3275            }
3276            if old_diff_transforms.end().0 > edit.old.end {
3277                break;
3278            }
3279            old_diff_transforms.next();
3280        }
3281
3282        // Avoid querying diff hunks if there's no possibility of hunks being expanded.
3283        let all_diff_hunks_expanded = snapshot.all_diff_hunks_expanded;
3284        if old_expanded_hunks.is_empty()
3285            && change_kind == DiffChangeKind::BufferEdited
3286            && !all_diff_hunks_expanded
3287        {
3288            return false;
3289        }
3290
3291        // Visit each excerpt that intersects the edit.
3292        let mut did_expand_hunks = false;
3293        while let Some(excerpt) = excerpts.item() {
3294            // Recompute the expanded hunks in the portion of the excerpt that
3295            // intersects the edit.
3296            if let Some(diff) = snapshot.diffs.get(&excerpt.buffer_id) {
3297                let buffer = &excerpt.buffer;
3298                let excerpt_start = *excerpts.start();
3299                let excerpt_end = excerpt_start + ExcerptOffset::new(excerpt.text_summary.len);
3300                let excerpt_buffer_start = excerpt.range.context.start.to_offset(buffer);
3301                let excerpt_buffer_end = excerpt_buffer_start + excerpt.text_summary.len;
3302                let edit_buffer_start =
3303                    excerpt_buffer_start + edit.new.start.value.saturating_sub(excerpt_start.value);
3304                let edit_buffer_end =
3305                    excerpt_buffer_start + edit.new.end.value.saturating_sub(excerpt_start.value);
3306                let edit_buffer_end = edit_buffer_end.min(excerpt_buffer_end);
3307                let edit_anchor_range =
3308                    buffer.anchor_before(edit_buffer_start)..buffer.anchor_after(edit_buffer_end);
3309
3310                for hunk in diff.hunks_intersecting_range(edit_anchor_range, buffer) {
3311                    if hunk.is_created_file() && !all_diff_hunks_expanded {
3312                        continue;
3313                    }
3314
3315                    let hunk_buffer_range = hunk.buffer_range.to_offset(buffer);
3316                    if hunk_buffer_range.start < excerpt_buffer_start {
3317                        log::trace!("skipping hunk that starts before excerpt");
3318                        continue;
3319                    }
3320
3321                    let hunk_info = DiffTransformHunkInfo {
3322                        excerpt_id: excerpt.id,
3323                        hunk_start_anchor: hunk.buffer_range.start,
3324                        hunk_secondary_status: hunk.secondary_status,
3325                    };
3326
3327                    let hunk_excerpt_start = excerpt_start
3328                        + ExcerptOffset::new(
3329                            hunk_buffer_range.start.saturating_sub(excerpt_buffer_start),
3330                        );
3331                    let hunk_excerpt_end = excerpt_end.min(
3332                        excerpt_start
3333                            + ExcerptOffset::new(hunk_buffer_range.end - excerpt_buffer_start),
3334                    );
3335
3336                    self.push_buffer_content_transform(
3337                        snapshot,
3338                        new_diff_transforms,
3339                        hunk_excerpt_start,
3340                        *end_of_current_insert,
3341                    );
3342
3343                    // For every existing hunk, determine if it was previously expanded
3344                    // and if it should currently be expanded.
3345                    let was_previously_expanded = old_expanded_hunks.contains(&hunk_info);
3346                    let should_expand_hunk = match &change_kind {
3347                        DiffChangeKind::DiffUpdated { base_changed: true } => {
3348                            was_previously_expanded || all_diff_hunks_expanded
3349                        }
3350                        DiffChangeKind::ExpandOrCollapseHunks { expand } => {
3351                            let intersects = hunk_buffer_range.is_empty()
3352                                || hunk_buffer_range.end > edit_buffer_start;
3353                            if *expand {
3354                                intersects || was_previously_expanded || all_diff_hunks_expanded
3355                            } else {
3356                                !intersects && (was_previously_expanded || all_diff_hunks_expanded)
3357                            }
3358                        }
3359                        _ => was_previously_expanded || all_diff_hunks_expanded,
3360                    };
3361
3362                    if should_expand_hunk {
3363                        did_expand_hunks = true;
3364                        log::trace!(
3365                            "expanding hunk {:?}, excerpt:{:?}",
3366                            hunk_excerpt_start.value..hunk_excerpt_end.value,
3367                            excerpt.id
3368                        );
3369
3370                        if !hunk.diff_base_byte_range.is_empty()
3371                            && hunk_buffer_range.start >= edit_buffer_start
3372                            && hunk_buffer_range.start <= excerpt_buffer_end
3373                        {
3374                            let base_text = diff.base_text();
3375                            let mut text_cursor =
3376                                base_text.as_rope().cursor(hunk.diff_base_byte_range.start);
3377                            let mut base_text_summary =
3378                                text_cursor.summary::<TextSummary>(hunk.diff_base_byte_range.end);
3379
3380                            let mut has_trailing_newline = false;
3381                            if base_text_summary.last_line_chars > 0 {
3382                                base_text_summary += TextSummary::newline();
3383                                has_trailing_newline = true;
3384                            }
3385
3386                            new_diff_transforms.push(
3387                                DiffTransform::DeletedHunk {
3388                                    base_text_byte_range: hunk.diff_base_byte_range.clone(),
3389                                    summary: base_text_summary,
3390                                    buffer_id: excerpt.buffer_id,
3391                                    hunk_info,
3392                                    has_trailing_newline,
3393                                },
3394                                (),
3395                            );
3396                        }
3397
3398                        if !hunk_buffer_range.is_empty() {
3399                            *end_of_current_insert =
3400                                Some((hunk_excerpt_end.min(excerpt_end), hunk_info));
3401                        }
3402                    }
3403                }
3404            }
3405
3406            if excerpts.end() <= edit.new.end {
3407                excerpts.next();
3408            } else {
3409                break;
3410            }
3411        }
3412
3413        did_expand_hunks || !old_expanded_hunks.is_empty()
3414    }
3415
3416    fn append_diff_transforms(
3417        &self,
3418        new_transforms: &mut SumTree<DiffTransform>,
3419        subtree: SumTree<DiffTransform>,
3420    ) {
3421        if let Some(DiffTransform::BufferContent {
3422            inserted_hunk_info,
3423            summary,
3424        }) = subtree.first()
3425            && self.extend_last_buffer_content_transform(
3426                new_transforms,
3427                *inserted_hunk_info,
3428                *summary,
3429            )
3430        {
3431            let mut cursor = subtree.cursor::<()>(());
3432            cursor.next();
3433            cursor.next();
3434            new_transforms.append(cursor.suffix(), ());
3435            return;
3436        }
3437        new_transforms.append(subtree, ());
3438    }
3439
3440    fn push_diff_transform(
3441        &self,
3442        new_transforms: &mut SumTree<DiffTransform>,
3443        transform: DiffTransform,
3444    ) {
3445        if let DiffTransform::BufferContent {
3446            inserted_hunk_info: inserted_hunk_anchor,
3447            summary,
3448        } = transform
3449            && self.extend_last_buffer_content_transform(
3450                new_transforms,
3451                inserted_hunk_anchor,
3452                summary,
3453            )
3454        {
3455            return;
3456        }
3457        new_transforms.push(transform, ());
3458    }
3459
3460    fn push_buffer_content_transform(
3461        &self,
3462        old_snapshot: &MultiBufferSnapshot,
3463        new_transforms: &mut SumTree<DiffTransform>,
3464        end_offset: ExcerptOffset,
3465        current_inserted_hunk: Option<(ExcerptOffset, DiffTransformHunkInfo)>,
3466    ) {
3467        let inserted_region = current_inserted_hunk.map(|(insertion_end_offset, hunk_info)| {
3468            (end_offset.min(insertion_end_offset), Some(hunk_info))
3469        });
3470        let unchanged_region = [(end_offset, None)];
3471
3472        for (end_offset, inserted_hunk_info) in inserted_region.into_iter().chain(unchanged_region)
3473        {
3474            let start_offset = new_transforms.summary().excerpt_len();
3475            if end_offset <= start_offset {
3476                continue;
3477            }
3478            let summary_to_add = old_snapshot
3479                .text_summary_for_excerpt_offset_range::<TextSummary>(start_offset..end_offset);
3480
3481            if !self.extend_last_buffer_content_transform(
3482                new_transforms,
3483                inserted_hunk_info,
3484                summary_to_add,
3485            ) {
3486                new_transforms.push(
3487                    DiffTransform::BufferContent {
3488                        summary: summary_to_add,
3489                        inserted_hunk_info,
3490                    },
3491                    (),
3492                )
3493            }
3494        }
3495    }
3496
3497    fn extend_last_buffer_content_transform(
3498        &self,
3499        new_transforms: &mut SumTree<DiffTransform>,
3500        new_inserted_hunk_info: Option<DiffTransformHunkInfo>,
3501        summary_to_add: TextSummary,
3502    ) -> bool {
3503        let mut did_extend = false;
3504        new_transforms.update_last(
3505            |last_transform| {
3506                if let DiffTransform::BufferContent {
3507                    summary,
3508                    inserted_hunk_info: inserted_hunk_anchor,
3509                } = last_transform
3510                    && *inserted_hunk_anchor == new_inserted_hunk_info
3511                {
3512                    *summary += summary_to_add;
3513                    did_extend = true;
3514                }
3515            },
3516            (),
3517        );
3518        did_extend
3519    }
3520}
3521
3522fn build_excerpt_ranges(
3523    ranges: impl IntoIterator<Item = Range<Point>>,
3524    context_line_count: u32,
3525    buffer_snapshot: &BufferSnapshot,
3526) -> Vec<ExcerptRange<Point>> {
3527    ranges
3528        .into_iter()
3529        .map(|range| {
3530            let start_row = range.start.row.saturating_sub(context_line_count);
3531            let start = Point::new(start_row, 0);
3532            let end_row = (range.end.row + context_line_count).min(buffer_snapshot.max_point().row);
3533            let end = Point::new(end_row, buffer_snapshot.line_len(end_row));
3534            ExcerptRange {
3535                context: start..end,
3536                primary: range,
3537            }
3538        })
3539        .collect()
3540}
3541
3542#[cfg(any(test, feature = "test-support"))]
3543impl MultiBuffer {
3544    pub fn build_simple(text: &str, cx: &mut gpui::App) -> Entity<Self> {
3545        let buffer = cx.new(|cx| Buffer::local(text, cx));
3546        cx.new(|cx| Self::singleton(buffer, cx))
3547    }
3548
3549    pub fn build_multi<const COUNT: usize>(
3550        excerpts: [(&str, Vec<Range<Point>>); COUNT],
3551        cx: &mut gpui::App,
3552    ) -> Entity<Self> {
3553        let multi = cx.new(|_| Self::new(Capability::ReadWrite));
3554        for (text, ranges) in excerpts {
3555            let buffer = cx.new(|cx| Buffer::local(text, cx));
3556            let excerpt_ranges = ranges.into_iter().map(ExcerptRange::new);
3557            multi.update(cx, |multi, cx| {
3558                multi.push_excerpts(buffer, excerpt_ranges, cx)
3559            });
3560        }
3561
3562        multi
3563    }
3564
3565    pub fn build_from_buffer(buffer: Entity<Buffer>, cx: &mut gpui::App) -> Entity<Self> {
3566        cx.new(|cx| Self::singleton(buffer, cx))
3567    }
3568
3569    pub fn build_random(rng: &mut impl rand::Rng, cx: &mut gpui::App) -> Entity<Self> {
3570        cx.new(|cx| {
3571            let mut multibuffer = MultiBuffer::new(Capability::ReadWrite);
3572            let mutation_count = rng.random_range(1..=5);
3573            multibuffer.randomly_edit_excerpts(rng, mutation_count, cx);
3574            multibuffer
3575        })
3576    }
3577
3578    pub fn randomly_edit(
3579        &mut self,
3580        rng: &mut impl rand::Rng,
3581        edit_count: usize,
3582        cx: &mut Context<Self>,
3583    ) {
3584        use util::RandomCharIter;
3585
3586        let snapshot = self.read(cx);
3587        let mut edits: Vec<(Range<usize>, Arc<str>)> = Vec::new();
3588        let mut last_end = None;
3589        for _ in 0..edit_count {
3590            if last_end.is_some_and(|last_end| last_end >= snapshot.len()) {
3591                break;
3592            }
3593
3594            let new_start = last_end.map_or(0, |last_end| last_end + 1);
3595            let end =
3596                snapshot.clip_offset(rng.random_range(new_start..=snapshot.len()), Bias::Right);
3597            let start = snapshot.clip_offset(rng.random_range(new_start..=end), Bias::Right);
3598            last_end = Some(end);
3599
3600            let mut range = start..end;
3601            if rng.random_bool(0.2) {
3602                mem::swap(&mut range.start, &mut range.end);
3603            }
3604
3605            let new_text_len = rng.random_range(0..10);
3606            let new_text: String = RandomCharIter::new(&mut *rng).take(new_text_len).collect();
3607
3608            edits.push((range, new_text.into()));
3609        }
3610        log::info!("mutating multi-buffer with {:?}", edits);
3611        drop(snapshot);
3612
3613        self.edit(edits, None, cx);
3614    }
3615
3616    pub fn randomly_edit_excerpts(
3617        &mut self,
3618        rng: &mut impl rand::Rng,
3619        mutation_count: usize,
3620        cx: &mut Context<Self>,
3621    ) {
3622        use rand::prelude::*;
3623        use std::env;
3624        use util::RandomCharIter;
3625
3626        let max_excerpts = env::var("MAX_EXCERPTS")
3627            .map(|i| i.parse().expect("invalid `MAX_EXCERPTS` variable"))
3628            .unwrap_or(5);
3629
3630        let mut buffers = Vec::new();
3631        for _ in 0..mutation_count {
3632            if rng.random_bool(0.05) {
3633                log::info!("Clearing multi-buffer");
3634                self.clear(cx);
3635                continue;
3636            } else if rng.random_bool(0.1) && !self.excerpt_ids().is_empty() {
3637                let ids = self.excerpt_ids();
3638                let mut excerpts = HashSet::default();
3639                for _ in 0..rng.random_range(0..ids.len()) {
3640                    excerpts.extend(ids.choose(rng).copied());
3641                }
3642
3643                let line_count = rng.random_range(0..5);
3644
3645                log::info!("Expanding excerpts {excerpts:?} by {line_count} lines");
3646
3647                self.expand_excerpts(
3648                    excerpts.iter().cloned(),
3649                    line_count,
3650                    ExpandExcerptDirection::UpAndDown,
3651                    cx,
3652                );
3653                continue;
3654            }
3655
3656            let excerpt_ids = self.excerpt_ids();
3657            if excerpt_ids.is_empty() || (rng.random() && excerpt_ids.len() < max_excerpts) {
3658                let buffer_handle = if rng.random() || self.buffers.borrow().is_empty() {
3659                    let text = RandomCharIter::new(&mut *rng).take(10).collect::<String>();
3660                    buffers.push(cx.new(|cx| Buffer::local(text, cx)));
3661                    let buffer = buffers.last().unwrap().read(cx);
3662                    log::info!(
3663                        "Creating new buffer {} with text: {:?}",
3664                        buffer.remote_id(),
3665                        buffer.text()
3666                    );
3667                    buffers.last().unwrap().clone()
3668                } else {
3669                    self.buffers
3670                        .borrow()
3671                        .values()
3672                        .choose(rng)
3673                        .unwrap()
3674                        .buffer
3675                        .clone()
3676                };
3677
3678                let buffer = buffer_handle.read(cx);
3679                let buffer_text = buffer.text();
3680                let ranges = (0..rng.random_range(0..5))
3681                    .map(|_| {
3682                        let end_ix =
3683                            buffer.clip_offset(rng.random_range(0..=buffer.len()), Bias::Right);
3684                        let start_ix = buffer.clip_offset(rng.random_range(0..=end_ix), Bias::Left);
3685                        ExcerptRange::new(start_ix..end_ix)
3686                    })
3687                    .collect::<Vec<_>>();
3688                log::info!(
3689                    "Inserting excerpts from buffer {} and ranges {:?}: {:?}",
3690                    buffer_handle.read(cx).remote_id(),
3691                    ranges.iter().map(|r| &r.context).collect::<Vec<_>>(),
3692                    ranges
3693                        .iter()
3694                        .map(|r| &buffer_text[r.context.clone()])
3695                        .collect::<Vec<_>>()
3696                );
3697
3698                let excerpt_id = self.push_excerpts(buffer_handle.clone(), ranges, cx);
3699                log::info!("Inserted with ids: {:?}", excerpt_id);
3700            } else {
3701                let remove_count = rng.random_range(1..=excerpt_ids.len());
3702                let mut excerpts_to_remove = excerpt_ids
3703                    .choose_multiple(rng, remove_count)
3704                    .cloned()
3705                    .collect::<Vec<_>>();
3706                let snapshot = self.snapshot.borrow();
3707                excerpts_to_remove.sort_unstable_by(|a, b| a.cmp(b, &snapshot));
3708                drop(snapshot);
3709                log::info!("Removing excerpts {:?}", excerpts_to_remove);
3710                self.remove_excerpts(excerpts_to_remove, cx);
3711            }
3712        }
3713    }
3714
3715    pub fn randomly_mutate(
3716        &mut self,
3717        rng: &mut impl rand::Rng,
3718        mutation_count: usize,
3719        cx: &mut Context<Self>,
3720    ) {
3721        use rand::prelude::*;
3722
3723        if rng.random_bool(0.7) || self.singleton {
3724            let buffer = self
3725                .buffers
3726                .borrow()
3727                .values()
3728                .choose(rng)
3729                .map(|state| state.buffer.clone());
3730
3731            if let Some(buffer) = buffer {
3732                buffer.update(cx, |buffer, cx| {
3733                    if rng.random() {
3734                        buffer.randomly_edit(rng, mutation_count, cx);
3735                    } else {
3736                        buffer.randomly_undo_redo(rng, cx);
3737                    }
3738                });
3739            } else {
3740                self.randomly_edit(rng, mutation_count, cx);
3741            }
3742        } else {
3743            self.randomly_edit_excerpts(rng, mutation_count, cx);
3744        }
3745
3746        self.check_invariants(cx);
3747    }
3748
3749    fn check_invariants(&self, cx: &App) {
3750        self.read(cx).check_invariants();
3751    }
3752}
3753
3754impl EventEmitter<Event> for MultiBuffer {}
3755
3756impl MultiBufferSnapshot {
3757    pub fn text(&self) -> String {
3758        self.chunks(0..self.len(), false)
3759            .map(|chunk| chunk.text)
3760            .collect()
3761    }
3762
3763    pub fn reversed_chars_at<T: ToOffset>(&self, position: T) -> impl Iterator<Item = char> + '_ {
3764        self.reversed_chunks_in_range(0..position.to_offset(self))
3765            .flat_map(|c| c.chars().rev())
3766    }
3767
3768    fn reversed_chunks_in_range(&self, range: Range<usize>) -> ReversedMultiBufferChunks<'_> {
3769        let mut cursor = self.cursor::<usize>();
3770        cursor.seek(&range.end);
3771        let current_chunks = cursor.region().as_ref().map(|region| {
3772            let start_overshoot = range.start.saturating_sub(region.range.start);
3773            let end_overshoot = range.end - region.range.start;
3774            let end = (region.buffer_range.start + end_overshoot).min(region.buffer_range.end);
3775            let start = region.buffer_range.start + start_overshoot;
3776            region.buffer.reversed_chunks_in_range(start..end)
3777        });
3778        ReversedMultiBufferChunks {
3779            cursor,
3780            current_chunks,
3781            start: range.start,
3782            offset: range.end,
3783        }
3784    }
3785
3786    pub fn chars_at<T: ToOffset>(&self, position: T) -> impl Iterator<Item = char> + '_ {
3787        let offset = position.to_offset(self);
3788        self.text_for_range(offset..self.len())
3789            .flat_map(|chunk| chunk.chars())
3790    }
3791
3792    pub fn text_for_range<T: ToOffset>(&self, range: Range<T>) -> impl Iterator<Item = &str> + '_ {
3793        self.chunks(range, false).map(|chunk| chunk.text)
3794    }
3795
3796    pub fn is_line_blank(&self, row: MultiBufferRow) -> bool {
3797        self.text_for_range(Point::new(row.0, 0)..Point::new(row.0, self.line_len(row)))
3798            .all(|chunk| chunk.matches(|c: char| !c.is_whitespace()).next().is_none())
3799    }
3800
3801    pub fn contains_str_at<T>(&self, position: T, needle: &str) -> bool
3802    where
3803        T: ToOffset,
3804    {
3805        let position = position.to_offset(self);
3806        position == self.clip_offset(position, Bias::Left)
3807            && self
3808                .bytes_in_range(position..self.len())
3809                .flatten()
3810                .copied()
3811                .take(needle.len())
3812                .eq(needle.bytes())
3813    }
3814
3815    pub fn diff_hunks(&self) -> impl Iterator<Item = MultiBufferDiffHunk> + '_ {
3816        self.diff_hunks_in_range(Anchor::min()..Anchor::max())
3817    }
3818
3819    pub fn diff_hunks_in_range<T: ToPoint>(
3820        &self,
3821        range: Range<T>,
3822    ) -> impl Iterator<Item = MultiBufferDiffHunk> + '_ {
3823        let query_range = range.start.to_point(self)..range.end.to_point(self);
3824        self.lift_buffer_metadata(query_range.clone(), move |buffer, buffer_range| {
3825            let diff = self.diffs.get(&buffer.remote_id())?;
3826            let buffer_start = buffer.anchor_before(buffer_range.start);
3827            let buffer_end = buffer.anchor_after(buffer_range.end);
3828            Some(
3829                diff.hunks_intersecting_range(buffer_start..buffer_end, buffer)
3830                    .filter_map(|hunk| {
3831                        if hunk.is_created_file() && !self.all_diff_hunks_expanded {
3832                            return None;
3833                        }
3834                        Some((hunk.range.clone(), hunk))
3835                    }),
3836            )
3837        })
3838        .filter_map(move |(range, hunk, excerpt)| {
3839            if range.start != range.end && range.end == query_range.start && !hunk.range.is_empty()
3840            {
3841                return None;
3842            }
3843            let end_row = if range.end.column == 0 {
3844                range.end.row
3845            } else {
3846                range.end.row + 1
3847            };
3848            Some(MultiBufferDiffHunk {
3849                row_range: MultiBufferRow(range.start.row)..MultiBufferRow(end_row),
3850                buffer_id: excerpt.buffer_id,
3851                excerpt_id: excerpt.id,
3852                buffer_range: hunk.buffer_range.clone(),
3853                diff_base_byte_range: hunk.diff_base_byte_range.clone(),
3854                secondary_status: hunk.secondary_status,
3855            })
3856        })
3857    }
3858
3859    pub fn excerpt_ids_for_range<T: ToOffset>(
3860        &self,
3861        range: Range<T>,
3862    ) -> impl Iterator<Item = ExcerptId> + '_ {
3863        let range = range.start.to_offset(self)..range.end.to_offset(self);
3864        let mut cursor = self.cursor::<usize>();
3865        cursor.seek(&range.start);
3866        std::iter::from_fn(move || {
3867            let region = cursor.region()?;
3868            if region.range.start >= range.end {
3869                return None;
3870            }
3871            cursor.next_excerpt();
3872            Some(region.excerpt.id)
3873        })
3874    }
3875
3876    pub fn buffer_ids_for_range<T: ToOffset>(
3877        &self,
3878        range: Range<T>,
3879    ) -> impl Iterator<Item = BufferId> + '_ {
3880        let range = range.start.to_offset(self)..range.end.to_offset(self);
3881        let mut cursor = self.cursor::<usize>();
3882        cursor.seek(&range.start);
3883        std::iter::from_fn(move || {
3884            let region = cursor.region()?;
3885            if region.range.start > range.end
3886                || region.range.start == range.end && region.range.start > range.start
3887            {
3888                return None;
3889            }
3890            cursor.next_excerpt();
3891            Some(region.excerpt.buffer_id)
3892        })
3893    }
3894
3895    pub fn ranges_to_buffer_ranges<T: ToOffset>(
3896        &self,
3897        ranges: impl Iterator<Item = Range<T>>,
3898    ) -> impl Iterator<Item = (&BufferSnapshot, Range<usize>, ExcerptId)> {
3899        ranges.flat_map(|range| self.range_to_buffer_ranges(range).into_iter())
3900    }
3901
3902    pub fn range_to_buffer_ranges<T: ToOffset>(
3903        &self,
3904        range: Range<T>,
3905    ) -> Vec<(&BufferSnapshot, Range<usize>, ExcerptId)> {
3906        let start = range.start.to_offset(self);
3907        let end = range.end.to_offset(self);
3908
3909        let mut cursor = self.cursor::<usize>();
3910        cursor.seek(&start);
3911
3912        let mut result: Vec<(&BufferSnapshot, Range<usize>, ExcerptId)> = Vec::new();
3913        while let Some(region) = cursor.region() {
3914            if region.range.start > end {
3915                break;
3916            }
3917            if region.is_main_buffer {
3918                let start_overshoot = start.saturating_sub(region.range.start);
3919                let end_overshoot = end.saturating_sub(region.range.start);
3920                let start = region
3921                    .buffer_range
3922                    .end
3923                    .min(region.buffer_range.start + start_overshoot);
3924                let end = region
3925                    .buffer_range
3926                    .end
3927                    .min(region.buffer_range.start + end_overshoot);
3928                if let Some(prev) = result.last_mut().filter(|(_, prev_range, excerpt_id)| {
3929                    *excerpt_id == region.excerpt.id && prev_range.end == start
3930                }) {
3931                    prev.1.end = end;
3932                } else {
3933                    result.push((region.buffer, start..end, region.excerpt.id));
3934                }
3935            }
3936            cursor.next();
3937        }
3938        result
3939    }
3940
3941    pub fn range_to_buffer_ranges_with_deleted_hunks<T: ToOffset>(
3942        &self,
3943        range: Range<T>,
3944    ) -> impl Iterator<Item = (&BufferSnapshot, Range<usize>, ExcerptId, Option<Anchor>)> + '_ {
3945        let start = range.start.to_offset(self);
3946        let end = range.end.to_offset(self);
3947
3948        let mut cursor = self.cursor::<usize>();
3949        cursor.seek(&start);
3950
3951        std::iter::from_fn(move || {
3952            let region = cursor.region()?;
3953            if region.range.start > end {
3954                return None;
3955            }
3956            let start_overshoot = start.saturating_sub(region.range.start);
3957            let end_overshoot = end.saturating_sub(region.range.start);
3958            let start = region
3959                .buffer_range
3960                .end
3961                .min(region.buffer_range.start + start_overshoot);
3962            let end = region
3963                .buffer_range
3964                .end
3965                .min(region.buffer_range.start + end_overshoot);
3966
3967            let region_excerpt_id = region.excerpt.id;
3968            let deleted_hunk_anchor = if region.is_main_buffer {
3969                None
3970            } else {
3971                Some(self.anchor_before(region.range.start))
3972            };
3973            let result = (
3974                region.buffer,
3975                start..end,
3976                region_excerpt_id,
3977                deleted_hunk_anchor,
3978            );
3979            cursor.next();
3980            Some(result)
3981        })
3982    }
3983
3984    /// Retrieves buffer metadata for the given range, and converts it into multi-buffer
3985    /// coordinates.
3986    ///
3987    /// The given callback will be called for every excerpt intersecting the given range. It will
3988    /// be passed the excerpt's buffer and the buffer range that the input range intersects.
3989    /// The callback should return an iterator of metadata items from that buffer, each paired
3990    /// with a buffer range.
3991    ///
3992    /// The returned iterator yields each of these metadata items, paired with its range in
3993    /// multi-buffer coordinates.
3994    fn lift_buffer_metadata<'a, D, M, I>(
3995        &'a self,
3996        query_range: Range<D>,
3997        get_buffer_metadata: impl 'a + Fn(&'a BufferSnapshot, Range<D>) -> Option<I>,
3998    ) -> impl Iterator<Item = (Range<D>, M, &'a Excerpt)> + 'a
3999    where
4000        I: Iterator<Item = (Range<D>, M)> + 'a,
4001        D: TextDimension + Ord + Sub<D, Output = D>,
4002    {
4003        let max_position = D::from_text_summary(&self.text_summary());
4004        let mut current_excerpt_metadata: Option<(ExcerptId, I)> = None;
4005        let mut cursor = self.cursor::<D>();
4006
4007        // Find the excerpt and buffer offset where the given range ends.
4008        cursor.seek(&query_range.end);
4009        let mut range_end = None;
4010        while let Some(region) = cursor.region() {
4011            if region.is_main_buffer {
4012                let mut buffer_end = region.buffer_range.start;
4013                let overshoot = if query_range.end > region.range.start {
4014                    query_range.end - region.range.start
4015                } else {
4016                    D::default()
4017                };
4018                buffer_end.add_assign(&overshoot);
4019                range_end = Some((region.excerpt.id, buffer_end));
4020                break;
4021            }
4022            cursor.next();
4023        }
4024
4025        cursor.seek(&query_range.start);
4026
4027        if let Some(region) = cursor.region().filter(|region| !region.is_main_buffer)
4028            && region.range.start > D::zero(())
4029        {
4030            cursor.prev()
4031        }
4032
4033        iter::from_fn(move || {
4034            loop {
4035                let excerpt = cursor.excerpt()?;
4036
4037                // If we have already retrieved metadata for this excerpt, continue to use it.
4038                let metadata_iter = if let Some((_, metadata)) = current_excerpt_metadata
4039                    .as_mut()
4040                    .filter(|(excerpt_id, _)| *excerpt_id == excerpt.id)
4041                {
4042                    Some(metadata)
4043                }
4044                // Otherwise, compute the intersection of the input range with the excerpt's range,
4045                // and retrieve the metadata for the resulting range.
4046                else {
4047                    let region = cursor.region()?;
4048                    let mut buffer_start;
4049                    if region.is_main_buffer {
4050                        buffer_start = region.buffer_range.start;
4051                        if query_range.start > region.range.start {
4052                            let overshoot = query_range.start - region.range.start;
4053                            buffer_start.add_assign(&overshoot);
4054                        }
4055                        buffer_start = buffer_start.min(region.buffer_range.end);
4056                    } else {
4057                        buffer_start = cursor.main_buffer_position()?;
4058                    };
4059                    let mut buffer_end = excerpt.range.context.end.summary::<D>(&excerpt.buffer);
4060                    if let Some((end_excerpt_id, end_buffer_offset)) = range_end
4061                        && excerpt.id == end_excerpt_id
4062                    {
4063                        buffer_end = buffer_end.min(end_buffer_offset);
4064                    }
4065
4066                    get_buffer_metadata(&excerpt.buffer, buffer_start..buffer_end).map(|iterator| {
4067                        &mut current_excerpt_metadata.insert((excerpt.id, iterator)).1
4068                    })
4069                };
4070
4071                // Visit each metadata item.
4072                if let Some((metadata_buffer_range, metadata)) =
4073                    metadata_iter.and_then(Iterator::next)
4074                {
4075                    // Find the multibuffer regions that contain the start and end of
4076                    // the metadata item's range.
4077                    if metadata_buffer_range.start > D::default() {
4078                        while let Some(region) = cursor.region() {
4079                            if region.is_main_buffer
4080                                && (region.buffer_range.end >= metadata_buffer_range.start
4081                                    || cursor.is_at_end_of_excerpt())
4082                            {
4083                                break;
4084                            }
4085                            cursor.next();
4086                        }
4087                    }
4088                    let start_region = cursor.region()?;
4089                    while let Some(region) = cursor.region() {
4090                        if region.is_main_buffer
4091                            && (region.buffer_range.end > metadata_buffer_range.end
4092                                || cursor.is_at_end_of_excerpt())
4093                        {
4094                            break;
4095                        }
4096                        cursor.next();
4097                    }
4098                    let end_region = cursor.region();
4099
4100                    // Convert the metadata item's range into multibuffer coordinates.
4101                    let mut start_position = start_region.range.start;
4102                    let region_buffer_start = start_region.buffer_range.start;
4103                    if start_region.is_main_buffer
4104                        && metadata_buffer_range.start > region_buffer_start
4105                    {
4106                        start_position
4107                            .add_assign(&(metadata_buffer_range.start - region_buffer_start));
4108                        start_position = start_position.min(start_region.range.end);
4109                    }
4110
4111                    let mut end_position = max_position;
4112                    if let Some(end_region) = &end_region {
4113                        end_position = end_region.range.start;
4114                        debug_assert!(end_region.is_main_buffer);
4115                        let region_buffer_start = end_region.buffer_range.start;
4116                        if metadata_buffer_range.end > region_buffer_start {
4117                            end_position
4118                                .add_assign(&(metadata_buffer_range.end - region_buffer_start));
4119                        }
4120                        end_position = end_position.min(end_region.range.end);
4121                    }
4122
4123                    if start_position <= query_range.end && end_position >= query_range.start {
4124                        return Some((start_position..end_position, metadata, excerpt));
4125                    }
4126                }
4127                // When there are no more metadata items for this excerpt, move to the next excerpt.
4128                else {
4129                    current_excerpt_metadata.take();
4130                    if let Some((end_excerpt_id, _)) = range_end
4131                        && excerpt.id == end_excerpt_id
4132                    {
4133                        return None;
4134                    }
4135                    cursor.next_excerpt();
4136                }
4137            }
4138        })
4139    }
4140
4141    pub fn diff_hunk_before<T: ToOffset>(&self, position: T) -> Option<MultiBufferRow> {
4142        let offset = position.to_offset(self);
4143
4144        let mut cursor = self.cursor::<DimensionPair<usize, Point>>();
4145        cursor.seek(&DimensionPair {
4146            key: offset,
4147            value: None,
4148        });
4149        cursor.seek_to_start_of_current_excerpt();
4150        let excerpt = cursor.excerpt()?;
4151
4152        let excerpt_end = excerpt.range.context.end.to_offset(&excerpt.buffer);
4153        let current_position = self
4154            .anchor_before(offset)
4155            .text_anchor
4156            .to_offset(&excerpt.buffer);
4157        let excerpt_end = excerpt
4158            .buffer
4159            .anchor_before(excerpt_end.min(current_position));
4160
4161        if let Some(diff) = self.diffs.get(&excerpt.buffer_id) {
4162            for hunk in diff.hunks_intersecting_range_rev(
4163                excerpt.range.context.start..excerpt_end,
4164                &excerpt.buffer,
4165            ) {
4166                let hunk_end = hunk.buffer_range.end.to_offset(&excerpt.buffer);
4167                if hunk_end >= current_position {
4168                    continue;
4169                }
4170                let start =
4171                    Anchor::in_buffer(excerpt.id, excerpt.buffer_id, hunk.buffer_range.start)
4172                        .to_point(self);
4173                return Some(MultiBufferRow(start.row));
4174            }
4175        }
4176
4177        loop {
4178            cursor.prev_excerpt();
4179            let excerpt = cursor.excerpt()?;
4180
4181            let Some(diff) = self.diffs.get(&excerpt.buffer_id) else {
4182                continue;
4183            };
4184            let mut hunks =
4185                diff.hunks_intersecting_range_rev(excerpt.range.context.clone(), &excerpt.buffer);
4186            let Some(hunk) = hunks.next() else {
4187                continue;
4188            };
4189            let start = Anchor::in_buffer(excerpt.id, excerpt.buffer_id, hunk.buffer_range.start)
4190                .to_point(self);
4191            return Some(MultiBufferRow(start.row));
4192        }
4193    }
4194
4195    pub fn has_diff_hunks(&self) -> bool {
4196        self.diffs.values().any(|diff| !diff.is_empty())
4197    }
4198
4199    pub fn is_inside_word<T: ToOffset>(
4200        &self,
4201        position: T,
4202        scope_context: Option<CharScopeContext>,
4203    ) -> bool {
4204        let position = position.to_offset(self);
4205        let classifier = self
4206            .char_classifier_at(position)
4207            .scope_context(scope_context);
4208        let next_char_kind = self.chars_at(position).next().map(|c| classifier.kind(c));
4209        let prev_char_kind = self
4210            .reversed_chars_at(position)
4211            .next()
4212            .map(|c| classifier.kind(c));
4213        prev_char_kind.zip(next_char_kind) == Some((CharKind::Word, CharKind::Word))
4214    }
4215
4216    pub fn surrounding_word<T: ToOffset>(
4217        &self,
4218        start: T,
4219        scope_context: Option<CharScopeContext>,
4220    ) -> (Range<usize>, Option<CharKind>) {
4221        let mut start = start.to_offset(self);
4222        let mut end = start;
4223        let mut next_chars = self.chars_at(start).peekable();
4224        let mut prev_chars = self.reversed_chars_at(start).peekable();
4225
4226        let classifier = self.char_classifier_at(start).scope_context(scope_context);
4227
4228        let word_kind = cmp::max(
4229            prev_chars.peek().copied().map(|c| classifier.kind(c)),
4230            next_chars.peek().copied().map(|c| classifier.kind(c)),
4231        );
4232
4233        for ch in prev_chars {
4234            if Some(classifier.kind(ch)) == word_kind && ch != '\n' {
4235                start -= ch.len_utf8();
4236            } else {
4237                break;
4238            }
4239        }
4240
4241        for ch in next_chars {
4242            if Some(classifier.kind(ch)) == word_kind && ch != '\n' {
4243                end += ch.len_utf8();
4244            } else {
4245                break;
4246            }
4247        }
4248
4249        (start..end, word_kind)
4250    }
4251
4252    pub fn char_kind_before<T: ToOffset>(
4253        &self,
4254        start: T,
4255        scope_context: Option<CharScopeContext>,
4256    ) -> Option<CharKind> {
4257        let start = start.to_offset(self);
4258        let classifier = self.char_classifier_at(start).scope_context(scope_context);
4259        self.reversed_chars_at(start)
4260            .next()
4261            .map(|ch| classifier.kind(ch))
4262    }
4263
4264    pub fn is_singleton(&self) -> bool {
4265        self.singleton
4266    }
4267
4268    pub fn as_singleton(&self) -> Option<(&ExcerptId, BufferId, &BufferSnapshot)> {
4269        if self.singleton {
4270            self.excerpts
4271                .iter()
4272                .next()
4273                .map(|e| (&e.id, e.buffer_id, &e.buffer))
4274        } else {
4275            None
4276        }
4277    }
4278
4279    pub fn len(&self) -> usize {
4280        self.diff_transforms.summary().output.len
4281    }
4282
4283    pub fn is_empty(&self) -> bool {
4284        self.excerpts.summary().text.len == 0
4285    }
4286
4287    pub fn widest_line_number(&self) -> u32 {
4288        // widest_line_number is 0-based, so 1 is added to get the displayed line number.
4289        self.excerpts.summary().widest_line_number + 1
4290    }
4291
4292    pub fn bytes_in_range<T: ToOffset>(&self, range: Range<T>) -> MultiBufferBytes<'_> {
4293        let range = range.start.to_offset(self)..range.end.to_offset(self);
4294        let mut excerpts = self.cursor::<usize>();
4295        excerpts.seek(&range.start);
4296
4297        let mut chunk;
4298        let mut has_trailing_newline;
4299        let excerpt_bytes;
4300        if let Some(region) = excerpts.region() {
4301            let mut bytes = region.buffer.bytes_in_range(
4302                region.buffer_range.start + range.start - region.range.start
4303                    ..(region.buffer_range.start + range.end - region.range.start)
4304                        .min(region.buffer_range.end),
4305            );
4306            chunk = bytes.next().unwrap_or(&[][..]);
4307            excerpt_bytes = Some(bytes);
4308            has_trailing_newline = region.has_trailing_newline && range.end >= region.range.end;
4309            if chunk.is_empty() && has_trailing_newline {
4310                chunk = b"\n";
4311                has_trailing_newline = false;
4312            }
4313        } else {
4314            chunk = &[][..];
4315            excerpt_bytes = None;
4316            has_trailing_newline = false;
4317        };
4318
4319        MultiBufferBytes {
4320            range,
4321            cursor: excerpts,
4322            excerpt_bytes,
4323            has_trailing_newline,
4324            chunk,
4325        }
4326    }
4327
4328    pub fn reversed_bytes_in_range<T: ToOffset>(
4329        &self,
4330        range: Range<T>,
4331    ) -> ReversedMultiBufferBytes<'_> {
4332        let range = range.start.to_offset(self)..range.end.to_offset(self);
4333        let mut chunks = self.reversed_chunks_in_range(range.clone());
4334        let chunk = chunks.next().map_or(&[][..], |c| c.as_bytes());
4335        ReversedMultiBufferBytes {
4336            range,
4337            chunks,
4338            chunk,
4339        }
4340    }
4341
4342    pub fn row_infos(&self, start_row: MultiBufferRow) -> MultiBufferRows<'_> {
4343        let mut cursor = self.cursor::<Point>();
4344        cursor.seek(&Point::new(start_row.0, 0));
4345        let mut result = MultiBufferRows {
4346            point: Point::new(0, 0),
4347            is_empty: self.excerpts.is_empty(),
4348            is_singleton: self.is_singleton(),
4349            cursor,
4350        };
4351        result.seek(start_row);
4352        result
4353    }
4354
4355    pub fn chunks<T: ToOffset>(
4356        &self,
4357        range: Range<T>,
4358        language_aware: bool,
4359    ) -> MultiBufferChunks<'_> {
4360        let mut chunks = MultiBufferChunks {
4361            excerpt_offset_range: ExcerptOffset::new(0)..ExcerptOffset::new(0),
4362            range: 0..0,
4363            excerpts: self.excerpts.cursor(()),
4364            diff_transforms: self.diff_transforms.cursor(()),
4365            diffs: &self.diffs,
4366            diff_base_chunks: None,
4367            excerpt_chunks: None,
4368            buffer_chunk: None,
4369            language_aware,
4370        };
4371        let range = range.start.to_offset(self)..range.end.to_offset(self);
4372        chunks.seek(range);
4373        chunks
4374    }
4375
4376    pub fn clip_offset(&self, offset: usize, bias: Bias) -> usize {
4377        self.clip_dimension(offset, bias, text::BufferSnapshot::clip_offset)
4378    }
4379
4380    pub fn clip_point(&self, point: Point, bias: Bias) -> Point {
4381        self.clip_dimension(point, bias, text::BufferSnapshot::clip_point)
4382    }
4383
4384    pub fn clip_offset_utf16(&self, offset: OffsetUtf16, bias: Bias) -> OffsetUtf16 {
4385        self.clip_dimension(offset, bias, text::BufferSnapshot::clip_offset_utf16)
4386    }
4387
4388    pub fn clip_point_utf16(&self, point: Unclipped<PointUtf16>, bias: Bias) -> PointUtf16 {
4389        self.clip_dimension(point.0, bias, |buffer, point, bias| {
4390            buffer.clip_point_utf16(Unclipped(point), bias)
4391        })
4392    }
4393
4394    pub fn offset_to_point(&self, offset: usize) -> Point {
4395        self.convert_dimension(offset, text::BufferSnapshot::offset_to_point)
4396    }
4397
4398    pub fn offset_to_point_utf16(&self, offset: usize) -> PointUtf16 {
4399        self.convert_dimension(offset, text::BufferSnapshot::offset_to_point_utf16)
4400    }
4401
4402    pub fn point_to_point_utf16(&self, point: Point) -> PointUtf16 {
4403        self.convert_dimension(point, text::BufferSnapshot::point_to_point_utf16)
4404    }
4405
4406    pub fn point_to_offset(&self, point: Point) -> usize {
4407        self.convert_dimension(point, text::BufferSnapshot::point_to_offset)
4408    }
4409
4410    pub fn offset_utf16_to_offset(&self, offset: OffsetUtf16) -> usize {
4411        self.convert_dimension(offset, text::BufferSnapshot::offset_utf16_to_offset)
4412    }
4413
4414    pub fn offset_to_offset_utf16(&self, offset: usize) -> OffsetUtf16 {
4415        self.convert_dimension(offset, text::BufferSnapshot::offset_to_offset_utf16)
4416    }
4417
4418    pub fn point_utf16_to_offset(&self, point: PointUtf16) -> usize {
4419        self.convert_dimension(point, text::BufferSnapshot::point_utf16_to_offset)
4420    }
4421
4422    fn clip_dimension<D>(
4423        &self,
4424        position: D,
4425        bias: Bias,
4426        clip_buffer_position: fn(&text::BufferSnapshot, D, Bias) -> D,
4427    ) -> D
4428    where
4429        D: TextDimension + Ord + Sub<D, Output = D>,
4430    {
4431        let mut cursor = self.cursor();
4432        cursor.seek(&position);
4433        if let Some(region) = cursor.region() {
4434            if position >= region.range.end {
4435                return region.range.end;
4436            }
4437            let overshoot = position - region.range.start;
4438            let mut buffer_position = region.buffer_range.start;
4439            buffer_position.add_assign(&overshoot);
4440            let clipped_buffer_position =
4441                clip_buffer_position(region.buffer, buffer_position, bias);
4442            let mut position = region.range.start;
4443            position.add_assign(&(clipped_buffer_position - region.buffer_range.start));
4444            position
4445        } else {
4446            D::from_text_summary(&self.text_summary())
4447        }
4448    }
4449
4450    fn convert_dimension<D1, D2>(
4451        &self,
4452        key: D1,
4453        convert_buffer_dimension: fn(&text::BufferSnapshot, D1) -> D2,
4454    ) -> D2
4455    where
4456        D1: TextDimension + Ord + Sub<D1, Output = D1>,
4457        D2: TextDimension + Ord + Sub<D2, Output = D2>,
4458    {
4459        let mut cursor = self.cursor::<DimensionPair<D1, D2>>();
4460        cursor.seek(&DimensionPair { key, value: None });
4461        if let Some(region) = cursor.region() {
4462            if key >= region.range.end.key {
4463                return region.range.end.value.unwrap();
4464            }
4465            let start_key = region.range.start.key;
4466            let start_value = region.range.start.value.unwrap();
4467            let buffer_start_key = region.buffer_range.start.key;
4468            let buffer_start_value = region.buffer_range.start.value.unwrap();
4469            let mut buffer_key = buffer_start_key;
4470            buffer_key.add_assign(&(key - start_key));
4471            let buffer_value = convert_buffer_dimension(region.buffer, buffer_key);
4472            let mut result = start_value;
4473            result.add_assign(&(buffer_value - buffer_start_value));
4474            result
4475        } else {
4476            D2::from_text_summary(&self.text_summary())
4477        }
4478    }
4479
4480    pub fn point_to_buffer_offset<T: ToOffset>(
4481        &self,
4482        point: T,
4483    ) -> Option<(&BufferSnapshot, usize)> {
4484        let offset = point.to_offset(self);
4485        let mut cursor = self.cursor::<usize>();
4486        cursor.seek(&offset);
4487        let region = cursor.region()?;
4488        let overshoot = offset - region.range.start;
4489        let buffer_offset = region.buffer_range.start + overshoot;
4490        if buffer_offset == region.buffer.len() + 1
4491            && region.has_trailing_newline
4492            && !region.is_main_buffer
4493        {
4494            return Some((&cursor.excerpt()?.buffer, cursor.main_buffer_position()?));
4495        } else if buffer_offset > region.buffer.len() {
4496            return None;
4497        }
4498        Some((region.buffer, buffer_offset))
4499    }
4500
4501    pub fn point_to_buffer_point(
4502        &self,
4503        point: Point,
4504    ) -> Option<(&BufferSnapshot, Point, ExcerptId)> {
4505        let mut cursor = self.cursor::<Point>();
4506        cursor.seek(&point);
4507        let region = cursor.region()?;
4508        let overshoot = point - region.range.start;
4509        let buffer_point = region.buffer_range.start + overshoot;
4510        let excerpt = cursor.excerpt()?;
4511        if buffer_point == region.buffer.max_point() + Point::new(1, 0)
4512            && region.has_trailing_newline
4513            && !region.is_main_buffer
4514        {
4515            return Some((&excerpt.buffer, cursor.main_buffer_position()?, excerpt.id));
4516        } else if buffer_point > region.buffer.max_point() {
4517            return None;
4518        }
4519        Some((region.buffer, buffer_point, excerpt.id))
4520    }
4521
4522    pub fn suggested_indents(
4523        &self,
4524        rows: impl IntoIterator<Item = u32>,
4525        cx: &App,
4526    ) -> BTreeMap<MultiBufferRow, IndentSize> {
4527        let mut result = BTreeMap::new();
4528
4529        let mut rows_for_excerpt = Vec::new();
4530        let mut cursor = self.cursor::<Point>();
4531        let mut rows = rows.into_iter().peekable();
4532        let mut prev_row = u32::MAX;
4533        let mut prev_language_indent_size = IndentSize::default();
4534
4535        while let Some(row) = rows.next() {
4536            cursor.seek(&Point::new(row, 0));
4537            let Some(region) = cursor.region() else {
4538                continue;
4539            };
4540
4541            // Retrieve the language and indent size once for each disjoint region being indented.
4542            let single_indent_size = if row.saturating_sub(1) == prev_row {
4543                prev_language_indent_size
4544            } else {
4545                region
4546                    .buffer
4547                    .language_indent_size_at(Point::new(row, 0), cx)
4548            };
4549            prev_language_indent_size = single_indent_size;
4550            prev_row = row;
4551
4552            let start_buffer_row = region.buffer_range.start.row;
4553            let start_multibuffer_row = region.range.start.row;
4554            let end_multibuffer_row = region.range.end.row;
4555
4556            rows_for_excerpt.push(row);
4557            while let Some(next_row) = rows.peek().copied() {
4558                if end_multibuffer_row > next_row {
4559                    rows_for_excerpt.push(next_row);
4560                    rows.next();
4561                } else {
4562                    break;
4563                }
4564            }
4565
4566            let buffer_rows = rows_for_excerpt
4567                .drain(..)
4568                .map(|row| start_buffer_row + row - start_multibuffer_row);
4569            let buffer_indents = region
4570                .buffer
4571                .suggested_indents(buffer_rows, single_indent_size);
4572            let multibuffer_indents = buffer_indents.into_iter().map(|(row, indent)| {
4573                (
4574                    MultiBufferRow(start_multibuffer_row + row - start_buffer_row),
4575                    indent,
4576                )
4577            });
4578            result.extend(multibuffer_indents);
4579        }
4580
4581        result
4582    }
4583
4584    pub fn indent_size_for_line(&self, row: MultiBufferRow) -> IndentSize {
4585        if let Some((buffer, range)) = self.buffer_line_for_row(row) {
4586            let mut size = buffer.indent_size_for_line(range.start.row);
4587            size.len = size
4588                .len
4589                .min(range.end.column)
4590                .saturating_sub(range.start.column);
4591            size
4592        } else {
4593            IndentSize::spaces(0)
4594        }
4595    }
4596
4597    pub fn line_indent_for_row(&self, row: MultiBufferRow) -> LineIndent {
4598        if let Some((buffer, range)) = self.buffer_line_for_row(row) {
4599            LineIndent::from_iter(buffer.text_for_range(range).flat_map(|s| s.chars()))
4600        } else {
4601            LineIndent::spaces(0)
4602        }
4603    }
4604
4605    pub fn indent_and_comment_for_line(&self, row: MultiBufferRow, cx: &App) -> String {
4606        let mut indent = self.indent_size_for_line(row).chars().collect::<String>();
4607
4608        if self.language_settings(cx).extend_comment_on_newline
4609            && let Some(language_scope) = self.language_scope_at(Point::new(row.0, 0))
4610        {
4611            let delimiters = language_scope.line_comment_prefixes();
4612            for delimiter in delimiters {
4613                if *self
4614                    .chars_at(Point::new(row.0, indent.len() as u32))
4615                    .take(delimiter.chars().count())
4616                    .collect::<String>()
4617                    .as_str()
4618                    == **delimiter
4619                {
4620                    indent.push_str(delimiter);
4621                    break;
4622                }
4623            }
4624        }
4625
4626        indent
4627    }
4628
4629    pub fn is_line_whitespace_upto<T>(&self, position: T) -> bool
4630    where
4631        T: ToOffset,
4632    {
4633        for char in self.reversed_chars_at(position) {
4634            if !char.is_whitespace() {
4635                return false;
4636            }
4637            if char == '\n' {
4638                return true;
4639            }
4640        }
4641        true
4642    }
4643
4644    pub fn prev_non_blank_row(&self, mut row: MultiBufferRow) -> Option<MultiBufferRow> {
4645        while row.0 > 0 {
4646            row.0 -= 1;
4647            if !self.is_line_blank(row) {
4648                return Some(row);
4649            }
4650        }
4651        None
4652    }
4653
4654    pub fn line_len(&self, row: MultiBufferRow) -> u32 {
4655        if let Some((_, range)) = self.buffer_line_for_row(row) {
4656            range.end.column - range.start.column
4657        } else {
4658            0
4659        }
4660    }
4661
4662    pub fn buffer_line_for_row(
4663        &self,
4664        row: MultiBufferRow,
4665    ) -> Option<(&BufferSnapshot, Range<Point>)> {
4666        let mut cursor = self.cursor::<Point>();
4667        let point = Point::new(row.0, 0);
4668        cursor.seek(&point);
4669        let region = cursor.region()?;
4670        let overshoot = point.min(region.range.end) - region.range.start;
4671        let buffer_point = region.buffer_range.start + overshoot;
4672        if buffer_point.row > region.buffer_range.end.row {
4673            return None;
4674        }
4675        let line_start = Point::new(buffer_point.row, 0).max(region.buffer_range.start);
4676        let line_end = Point::new(buffer_point.row, region.buffer.line_len(buffer_point.row))
4677            .min(region.buffer_range.end);
4678        Some((region.buffer, line_start..line_end))
4679    }
4680
4681    pub fn max_point(&self) -> Point {
4682        self.text_summary().lines
4683    }
4684
4685    pub fn max_row(&self) -> MultiBufferRow {
4686        MultiBufferRow(self.text_summary().lines.row)
4687    }
4688
4689    pub fn text_summary(&self) -> TextSummary {
4690        self.diff_transforms.summary().output
4691    }
4692
4693    pub fn text_summary_for_range<D, O>(&self, range: Range<O>) -> D
4694    where
4695        D: TextDimension,
4696        O: ToOffset,
4697    {
4698        let range = range.start.to_offset(self)..range.end.to_offset(self);
4699        let mut cursor = self
4700            .diff_transforms
4701            .cursor::<Dimensions<usize, ExcerptOffset>>(());
4702        cursor.seek(&range.start, Bias::Right);
4703
4704        let Some(first_transform) = cursor.item() else {
4705            return D::from_text_summary(&TextSummary::default());
4706        };
4707
4708        let diff_transform_start = cursor.start().0;
4709        let diff_transform_end = cursor.end().0;
4710        let diff_start = range.start;
4711        let start_overshoot = diff_start - diff_transform_start;
4712        let end_overshoot = std::cmp::min(range.end, diff_transform_end) - diff_transform_start;
4713
4714        let mut result = match first_transform {
4715            DiffTransform::BufferContent { .. } => {
4716                let excerpt_start = cursor.start().1 + ExcerptOffset::new(start_overshoot);
4717                let excerpt_end = cursor.start().1 + ExcerptOffset::new(end_overshoot);
4718                self.text_summary_for_excerpt_offset_range(excerpt_start..excerpt_end)
4719            }
4720            DiffTransform::DeletedHunk {
4721                buffer_id,
4722                base_text_byte_range,
4723                has_trailing_newline,
4724                ..
4725            } => {
4726                let buffer_start = base_text_byte_range.start + start_overshoot;
4727                let mut buffer_end = base_text_byte_range.start + end_overshoot;
4728                let Some(base_text) = self.diffs.get(buffer_id).map(|diff| diff.base_text()) else {
4729                    panic!("{:?} is in non-existent deleted hunk", range.start)
4730                };
4731
4732                let include_trailing_newline =
4733                    *has_trailing_newline && range.end >= diff_transform_end;
4734                if include_trailing_newline {
4735                    buffer_end -= 1;
4736                }
4737
4738                let mut summary =
4739                    base_text.text_summary_for_range::<D, _>(buffer_start..buffer_end);
4740
4741                if include_trailing_newline {
4742                    summary.add_assign(&D::from_text_summary(&TextSummary::newline()))
4743                }
4744
4745                summary
4746            }
4747        };
4748        if range.end < diff_transform_end {
4749            return result;
4750        }
4751
4752        cursor.next();
4753        result.add_assign(&D::from_text_summary(
4754            &cursor.summary(&range.end, Bias::Right),
4755        ));
4756
4757        let Some(last_transform) = cursor.item() else {
4758            return result;
4759        };
4760
4761        let overshoot = range.end - cursor.start().0;
4762        let suffix = match last_transform {
4763            DiffTransform::BufferContent { .. } => {
4764                let end = cursor.start().1 + ExcerptOffset::new(overshoot);
4765                self.text_summary_for_excerpt_offset_range::<D>(cursor.start().1..end)
4766            }
4767            DiffTransform::DeletedHunk {
4768                base_text_byte_range,
4769                buffer_id,
4770                has_trailing_newline,
4771                ..
4772            } => {
4773                let buffer_end = base_text_byte_range.start + overshoot;
4774                let Some(base_text) = self.diffs.get(buffer_id).map(|diff| diff.base_text()) else {
4775                    panic!("{:?} is in non-existent deleted hunk", range.end)
4776                };
4777
4778                let mut suffix = base_text
4779                    .text_summary_for_range::<D, _>(base_text_byte_range.start..buffer_end);
4780                if *has_trailing_newline && buffer_end == base_text_byte_range.end + 1 {
4781                    suffix.add_assign(&D::from_text_summary(&TextSummary::newline()))
4782                }
4783                suffix
4784            }
4785        };
4786
4787        result.add_assign(&suffix);
4788        result
4789    }
4790
4791    fn text_summary_for_excerpt_offset_range<D>(&self, mut range: Range<ExcerptOffset>) -> D
4792    where
4793        D: TextDimension,
4794    {
4795        let mut summary = D::zero(());
4796        let mut cursor = self.excerpts.cursor::<ExcerptOffset>(());
4797        cursor.seek(&range.start, Bias::Right);
4798        if let Some(excerpt) = cursor.item() {
4799            let mut end_before_newline = cursor.end();
4800            if excerpt.has_trailing_newline {
4801                end_before_newline -= ExcerptOffset::new(1);
4802            }
4803
4804            let excerpt_start = excerpt.range.context.start.to_offset(&excerpt.buffer);
4805            let start_in_excerpt = excerpt_start + (range.start - *cursor.start()).value;
4806            let end_in_excerpt =
4807                excerpt_start + (cmp::min(end_before_newline, range.end) - *cursor.start()).value;
4808            summary.add_assign(
4809                &excerpt
4810                    .buffer
4811                    .text_summary_for_range(start_in_excerpt..end_in_excerpt),
4812            );
4813
4814            if range.end > end_before_newline {
4815                summary.add_assign(&D::from_text_summary(&TextSummary::from("\n")));
4816            }
4817
4818            cursor.next();
4819        }
4820
4821        if range.end > *cursor.start() {
4822            summary.add_assign(
4823                &cursor
4824                    .summary::<_, ExcerptDimension<D>>(&range.end, Bias::Right)
4825                    .0,
4826            );
4827            if let Some(excerpt) = cursor.item() {
4828                range.end = cmp::max(*cursor.start(), range.end);
4829
4830                let excerpt_start = excerpt.range.context.start.to_offset(&excerpt.buffer);
4831                let end_in_excerpt = excerpt_start + (range.end - *cursor.start()).value;
4832                summary.add_assign(
4833                    &excerpt
4834                        .buffer
4835                        .text_summary_for_range(excerpt_start..end_in_excerpt),
4836                );
4837            }
4838        }
4839
4840        summary
4841    }
4842
4843    pub fn summary_for_anchor<D>(&self, anchor: &Anchor) -> D
4844    where
4845        D: TextDimension + Ord + Sub<D, Output = D>,
4846    {
4847        self.summaries_for_anchors([anchor])[0]
4848    }
4849
4850    fn resolve_summary_for_anchor<D>(
4851        &self,
4852        anchor: &Anchor,
4853        excerpt_position: D,
4854        diff_transforms: &mut Cursor<
4855            DiffTransform,
4856            Dimensions<ExcerptDimension<D>, OutputDimension<D>>,
4857        >,
4858    ) -> D
4859    where
4860        D: TextDimension + Ord + Sub<D, Output = D>,
4861    {
4862        loop {
4863            let transform_end_position = diff_transforms.end().0.0;
4864            let at_transform_end =
4865                excerpt_position == transform_end_position && diff_transforms.item().is_some();
4866            if at_transform_end && anchor.text_anchor.bias == Bias::Right {
4867                diff_transforms.next();
4868                continue;
4869            }
4870
4871            let mut position = diff_transforms.start().1.0;
4872            match diff_transforms.item() {
4873                Some(DiffTransform::DeletedHunk {
4874                    buffer_id,
4875                    base_text_byte_range,
4876                    ..
4877                }) => {
4878                    if let Some(diff_base_anchor) = &anchor.diff_base_anchor
4879                        && let Some(base_text) =
4880                            self.diffs.get(buffer_id).map(|diff| diff.base_text())
4881                        && base_text.can_resolve(diff_base_anchor)
4882                    {
4883                        let base_text_offset = diff_base_anchor.to_offset(base_text);
4884                        if base_text_offset >= base_text_byte_range.start
4885                            && base_text_offset <= base_text_byte_range.end
4886                        {
4887                            let position_in_hunk = base_text.text_summary_for_range::<D, _>(
4888                                base_text_byte_range.start..base_text_offset,
4889                            );
4890                            position.add_assign(&position_in_hunk);
4891                        } else if at_transform_end {
4892                            diff_transforms.next();
4893                            continue;
4894                        }
4895                    }
4896                }
4897                _ => {
4898                    if at_transform_end && anchor.diff_base_anchor.is_some() {
4899                        diff_transforms.next();
4900                        continue;
4901                    }
4902                    let overshoot = excerpt_position - diff_transforms.start().0.0;
4903                    position.add_assign(&overshoot);
4904                }
4905            }
4906
4907            return position;
4908        }
4909    }
4910
4911    fn excerpt_offset_for_anchor(&self, anchor: &Anchor) -> ExcerptOffset {
4912        let mut cursor = self
4913            .excerpts
4914            .cursor::<Dimensions<Option<&Locator>, ExcerptOffset>>(());
4915        let locator = self.excerpt_locator_for_id(anchor.excerpt_id);
4916
4917        cursor.seek(&Some(locator), Bias::Left);
4918        if cursor.item().is_none() && anchor.excerpt_id == ExcerptId::max() {
4919            cursor.prev();
4920        }
4921
4922        let mut position = cursor.start().1;
4923        if let Some(excerpt) = cursor.item()
4924            && (excerpt.id == anchor.excerpt_id || anchor.excerpt_id == ExcerptId::max())
4925        {
4926            let excerpt_buffer_start = excerpt
4927                .buffer
4928                .offset_for_anchor(&excerpt.range.context.start);
4929            let excerpt_buffer_end = excerpt.buffer.offset_for_anchor(&excerpt.range.context.end);
4930            let buffer_position = cmp::min(
4931                excerpt_buffer_end,
4932                excerpt.buffer.offset_for_anchor(&anchor.text_anchor),
4933            );
4934            if buffer_position > excerpt_buffer_start {
4935                position.value += buffer_position - excerpt_buffer_start;
4936            }
4937        }
4938        position
4939    }
4940
4941    pub fn latest_excerpt_id(&self, mut excerpt_id: ExcerptId) -> ExcerptId {
4942        while let Some(replacement) = self.replaced_excerpts.get(&excerpt_id) {
4943            excerpt_id = *replacement;
4944        }
4945        excerpt_id
4946    }
4947
4948    pub fn summaries_for_anchors<'a, D, I>(&'a self, anchors: I) -> Vec<D>
4949    where
4950        D: TextDimension + Ord + Sub<D, Output = D>,
4951        I: 'a + IntoIterator<Item = &'a Anchor>,
4952    {
4953        let mut anchors = anchors.into_iter().peekable();
4954        let mut cursor = self.excerpts.cursor::<ExcerptSummary>(());
4955        let mut diff_transforms_cursor = self
4956            .diff_transforms
4957            .cursor::<Dimensions<ExcerptDimension<D>, OutputDimension<D>>>(());
4958        diff_transforms_cursor.next();
4959
4960        let mut summaries = Vec::new();
4961        while let Some(anchor) = anchors.peek() {
4962            let excerpt_id = self.latest_excerpt_id(anchor.excerpt_id);
4963
4964            let excerpt_anchors = anchors.peeking_take_while(|anchor| {
4965                self.latest_excerpt_id(anchor.excerpt_id) == excerpt_id
4966            });
4967
4968            let locator = self.excerpt_locator_for_id(excerpt_id);
4969            cursor.seek_forward(locator, Bias::Left);
4970            if cursor.item().is_none() && excerpt_id == ExcerptId::max() {
4971                cursor.prev();
4972            }
4973
4974            let excerpt_start_position = D::from_text_summary(&cursor.start().text);
4975            if let Some(excerpt) = cursor.item() {
4976                if excerpt.id != excerpt_id && excerpt_id != ExcerptId::max() {
4977                    let position = self.resolve_summary_for_anchor(
4978                        &Anchor::min(),
4979                        excerpt_start_position,
4980                        &mut diff_transforms_cursor,
4981                    );
4982                    summaries.extend(excerpt_anchors.map(|_| position));
4983                    continue;
4984                }
4985                let excerpt_buffer_start =
4986                    excerpt.range.context.start.summary::<D>(&excerpt.buffer);
4987                let excerpt_buffer_end = excerpt.range.context.end.summary::<D>(&excerpt.buffer);
4988                for (buffer_summary, anchor) in excerpt
4989                    .buffer
4990                    .summaries_for_anchors_with_payload::<D, _, _>(
4991                        excerpt_anchors.map(|a| (&a.text_anchor, a)),
4992                    )
4993                {
4994                    let summary = cmp::min(excerpt_buffer_end, buffer_summary);
4995                    let mut position = excerpt_start_position;
4996                    if summary > excerpt_buffer_start {
4997                        position.add_assign(&(summary - excerpt_buffer_start));
4998                    }
4999
5000                    if position > diff_transforms_cursor.start().0.0 {
5001                        diff_transforms_cursor
5002                            .seek_forward(&ExcerptDimension(position), Bias::Left);
5003                    }
5004
5005                    summaries.push(self.resolve_summary_for_anchor(
5006                        anchor,
5007                        position,
5008                        &mut diff_transforms_cursor,
5009                    ));
5010                }
5011            } else {
5012                diff_transforms_cursor
5013                    .seek_forward(&ExcerptDimension(excerpt_start_position), Bias::Left);
5014                let position = self.resolve_summary_for_anchor(
5015                    &Anchor::max(),
5016                    excerpt_start_position,
5017                    &mut diff_transforms_cursor,
5018                );
5019                summaries.extend(excerpt_anchors.map(|_| position));
5020            }
5021        }
5022
5023        summaries
5024    }
5025
5026    pub fn dimensions_from_points<'a, D>(
5027        &'a self,
5028        points: impl 'a + IntoIterator<Item = Point>,
5029    ) -> impl 'a + Iterator<Item = D>
5030    where
5031        D: TextDimension + Sub<D, Output = D>,
5032    {
5033        let mut cursor = self.cursor::<DimensionPair<Point, D>>();
5034        cursor.seek(&DimensionPair {
5035            key: Point::default(),
5036            value: None,
5037        });
5038        let mut points = points.into_iter();
5039        iter::from_fn(move || {
5040            let point = points.next()?;
5041
5042            cursor.seek_forward(&DimensionPair {
5043                key: point,
5044                value: None,
5045            });
5046
5047            if let Some(region) = cursor.region() {
5048                let overshoot = point - region.range.start.key;
5049                let buffer_point = region.buffer_range.start.key + overshoot;
5050                let mut position = region.range.start.value.unwrap();
5051                position.add_assign(
5052                    &region
5053                        .buffer
5054                        .text_summary_for_range(region.buffer_range.start.key..buffer_point),
5055                );
5056                if point == region.range.end.key && region.has_trailing_newline {
5057                    position.add_assign(&D::from_text_summary(&TextSummary::newline()));
5058                }
5059                Some(position)
5060            } else {
5061                Some(D::from_text_summary(&self.text_summary()))
5062            }
5063        })
5064    }
5065
5066    pub fn refresh_anchors<'a, I>(&'a self, anchors: I) -> Vec<(usize, Anchor, bool)>
5067    where
5068        I: 'a + IntoIterator<Item = &'a Anchor>,
5069    {
5070        let mut anchors = anchors.into_iter().enumerate().peekable();
5071        let mut cursor = self.excerpts.cursor::<Option<&Locator>>(());
5072        cursor.next();
5073
5074        let mut result = Vec::new();
5075
5076        while let Some((_, anchor)) = anchors.peek() {
5077            let old_excerpt_id = anchor.excerpt_id;
5078
5079            // Find the location where this anchor's excerpt should be.
5080            let old_locator = self.excerpt_locator_for_id(old_excerpt_id);
5081            cursor.seek_forward(&Some(old_locator), Bias::Left);
5082
5083            let next_excerpt = cursor.item();
5084            let prev_excerpt = cursor.prev_item();
5085
5086            // Process all of the anchors for this excerpt.
5087            while let Some((anchor_ix, &anchor)) =
5088                anchors.next_if(|(_, anchor)| anchor.excerpt_id == old_excerpt_id)
5089            {
5090                let mut anchor = anchor;
5091
5092                // Leave min and max anchors unchanged if invalid or
5093                // if the old excerpt still exists at this location
5094                let mut kept_position = next_excerpt
5095                    .is_some_and(|e| e.id == old_excerpt_id && e.contains(&anchor))
5096                    || old_excerpt_id == ExcerptId::max()
5097                    || old_excerpt_id == ExcerptId::min();
5098
5099                // If the old excerpt no longer exists at this location, then attempt to
5100                // find an equivalent position for this anchor in an adjacent excerpt.
5101                if !kept_position {
5102                    for excerpt in [next_excerpt, prev_excerpt].iter().filter_map(|e| *e) {
5103                        if excerpt.contains(&anchor) {
5104                            anchor.excerpt_id = excerpt.id;
5105                            kept_position = true;
5106                            break;
5107                        }
5108                    }
5109                }
5110
5111                // If there's no adjacent excerpt that contains the anchor's position,
5112                // then report that the anchor has lost its position.
5113                if !kept_position {
5114                    anchor = if let Some(excerpt) = next_excerpt {
5115                        let mut text_anchor = excerpt
5116                            .range
5117                            .context
5118                            .start
5119                            .bias(anchor.text_anchor.bias, &excerpt.buffer);
5120                        if text_anchor
5121                            .cmp(&excerpt.range.context.end, &excerpt.buffer)
5122                            .is_gt()
5123                        {
5124                            text_anchor = excerpt.range.context.end;
5125                        }
5126                        Anchor::in_buffer(excerpt.id, excerpt.buffer_id, text_anchor)
5127                    } else if let Some(excerpt) = prev_excerpt {
5128                        let mut text_anchor = excerpt
5129                            .range
5130                            .context
5131                            .end
5132                            .bias(anchor.text_anchor.bias, &excerpt.buffer);
5133                        if text_anchor
5134                            .cmp(&excerpt.range.context.start, &excerpt.buffer)
5135                            .is_lt()
5136                        {
5137                            text_anchor = excerpt.range.context.start;
5138                        }
5139                        Anchor::in_buffer(excerpt.id, excerpt.buffer_id, text_anchor)
5140                    } else if anchor.text_anchor.bias == Bias::Left {
5141                        Anchor::min()
5142                    } else {
5143                        Anchor::max()
5144                    };
5145                }
5146
5147                result.push((anchor_ix, anchor, kept_position));
5148            }
5149        }
5150        result.sort_unstable_by(|a, b| a.1.cmp(&b.1, self));
5151        result
5152    }
5153
5154    pub fn anchor_before<T: ToOffset>(&self, position: T) -> Anchor {
5155        self.anchor_at(position, Bias::Left)
5156    }
5157
5158    pub fn anchor_after<T: ToOffset>(&self, position: T) -> Anchor {
5159        self.anchor_at(position, Bias::Right)
5160    }
5161
5162    pub fn anchor_at<T: ToOffset>(&self, position: T, mut bias: Bias) -> Anchor {
5163        let offset = position.to_offset(self);
5164
5165        // Find the given position in the diff transforms. Determine the corresponding
5166        // offset in the excerpts, and whether the position is within a deleted hunk.
5167        let mut diff_transforms = self
5168            .diff_transforms
5169            .cursor::<Dimensions<usize, ExcerptOffset>>(());
5170        diff_transforms.seek(&offset, Bias::Right);
5171
5172        if offset == diff_transforms.start().0
5173            && bias == Bias::Left
5174            && let Some(prev_item) = diff_transforms.prev_item()
5175            && let DiffTransform::DeletedHunk { .. } = prev_item
5176        {
5177            diff_transforms.prev();
5178        }
5179        let offset_in_transform = offset - diff_transforms.start().0;
5180        let mut excerpt_offset = diff_transforms.start().1;
5181        let mut diff_base_anchor = None;
5182        if let Some(DiffTransform::DeletedHunk {
5183            buffer_id,
5184            base_text_byte_range,
5185            has_trailing_newline,
5186            ..
5187        }) = diff_transforms.item()
5188        {
5189            let diff = self.diffs.get(buffer_id).expect("missing diff");
5190            if offset_in_transform > base_text_byte_range.len() {
5191                debug_assert!(*has_trailing_newline);
5192                bias = Bias::Right;
5193            } else {
5194                diff_base_anchor = Some(
5195                    diff.base_text()
5196                        .anchor_at(base_text_byte_range.start + offset_in_transform, bias),
5197                );
5198                bias = Bias::Left;
5199            }
5200        } else {
5201            excerpt_offset += ExcerptOffset::new(offset_in_transform);
5202        };
5203
5204        let mut excerpts = self
5205            .excerpts
5206            .cursor::<Dimensions<ExcerptOffset, Option<ExcerptId>>>(());
5207        excerpts.seek(&excerpt_offset, Bias::Right);
5208        if excerpts.item().is_none() && excerpt_offset == excerpts.start().0 && bias == Bias::Left {
5209            excerpts.prev();
5210        }
5211        if let Some(excerpt) = excerpts.item() {
5212            let mut overshoot = excerpt_offset.saturating_sub(excerpts.start().0).value;
5213            if excerpt.has_trailing_newline && excerpt_offset == excerpts.end().0 {
5214                overshoot -= 1;
5215                bias = Bias::Right;
5216            }
5217
5218            let buffer_start = excerpt.range.context.start.to_offset(&excerpt.buffer);
5219            let text_anchor =
5220                excerpt.clip_anchor(excerpt.buffer.anchor_at(buffer_start + overshoot, bias));
5221            let anchor = Anchor::in_buffer(excerpt.id, excerpt.buffer_id, text_anchor);
5222            match diff_base_anchor {
5223                Some(diff_base_anchor) => anchor.with_diff_base_anchor(diff_base_anchor),
5224                None => anchor,
5225            }
5226        } else if excerpt_offset.is_zero() && bias == Bias::Left {
5227            Anchor::min()
5228        } else {
5229            Anchor::max()
5230        }
5231    }
5232
5233    /// Wraps the [`text::Anchor`] in a [`multi_buffer::Anchor`] if this multi-buffer is a singleton.
5234    pub fn as_singleton_anchor(&self, text_anchor: text::Anchor) -> Option<Anchor> {
5235        let (excerpt, buffer, _) = self.as_singleton()?;
5236        Some(Anchor::in_buffer(*excerpt, buffer, text_anchor))
5237    }
5238
5239    /// Returns an anchor for the given excerpt and text anchor,
5240    /// Returns [`None`] if the excerpt_id is no longer valid or the text anchor range is out of excerpt's bounds.
5241    pub fn anchor_range_in_excerpt(
5242        &self,
5243        excerpt_id: ExcerptId,
5244        text_anchor: Range<text::Anchor>,
5245    ) -> Option<Range<Anchor>> {
5246        let excerpt_id = self.latest_excerpt_id(excerpt_id);
5247        let excerpt = self.excerpt(excerpt_id)?;
5248
5249        Some(
5250            self.anchor_in_excerpt_(excerpt, text_anchor.start)?
5251                ..self.anchor_in_excerpt_(excerpt, text_anchor.end)?,
5252        )
5253    }
5254
5255    /// Returns an anchor for the given excerpt and text anchor,
5256    /// Returns [`None`] if the excerpt_id is no longer valid or the text anchor range is out of excerpt's bounds.
5257    pub fn anchor_in_excerpt(
5258        &self,
5259        excerpt_id: ExcerptId,
5260        text_anchor: text::Anchor,
5261    ) -> Option<Anchor> {
5262        let excerpt_id = self.latest_excerpt_id(excerpt_id);
5263        let excerpt = self.excerpt(excerpt_id)?;
5264        self.anchor_in_excerpt_(excerpt, text_anchor)
5265    }
5266
5267    fn anchor_in_excerpt_(&self, excerpt: &Excerpt, text_anchor: text::Anchor) -> Option<Anchor> {
5268        match text_anchor.buffer_id {
5269            Some(buffer_id) if buffer_id == excerpt.buffer_id => (),
5270            Some(_) => return None,
5271            None if text_anchor == text::Anchor::MAX || text_anchor == text::Anchor::MIN => {
5272                return Some(Anchor::in_buffer(
5273                    excerpt.id,
5274                    excerpt.buffer_id,
5275                    text_anchor,
5276                ));
5277            }
5278            None => return None,
5279        }
5280
5281        let context = &excerpt.range.context;
5282        if context.start.cmp(&text_anchor, &excerpt.buffer).is_gt()
5283            || context.end.cmp(&text_anchor, &excerpt.buffer).is_lt()
5284        {
5285            return None;
5286        }
5287
5288        Some(Anchor::in_buffer(
5289            excerpt.id,
5290            excerpt.buffer_id,
5291            text_anchor,
5292        ))
5293    }
5294
5295    pub fn context_range_for_excerpt(&self, excerpt_id: ExcerptId) -> Option<Range<text::Anchor>> {
5296        Some(self.excerpt(excerpt_id)?.range.context.clone())
5297    }
5298
5299    pub fn can_resolve(&self, anchor: &Anchor) -> bool {
5300        if anchor.excerpt_id == ExcerptId::min() || anchor.excerpt_id == ExcerptId::max() {
5301            true
5302        } else if let Some(excerpt) = self.excerpt(anchor.excerpt_id) {
5303            excerpt.buffer.can_resolve(&anchor.text_anchor)
5304        } else {
5305            false
5306        }
5307    }
5308
5309    pub fn excerpts(
5310        &self,
5311    ) -> impl Iterator<Item = (ExcerptId, &BufferSnapshot, ExcerptRange<text::Anchor>)> {
5312        self.excerpts
5313            .iter()
5314            .map(|excerpt| (excerpt.id, &excerpt.buffer, excerpt.range.clone()))
5315    }
5316
5317    fn cursor<D: TextDimension + Default>(&self) -> MultiBufferCursor<'_, D> {
5318        let excerpts = self.excerpts.cursor(());
5319        let diff_transforms = self.diff_transforms.cursor(());
5320        MultiBufferCursor {
5321            excerpts,
5322            diff_transforms,
5323            diffs: &self.diffs,
5324            cached_region: None,
5325        }
5326    }
5327
5328    pub fn excerpt_before(&self, excerpt_id: ExcerptId) -> Option<MultiBufferExcerpt<'_>> {
5329        let start_locator = self.excerpt_locator_for_id(excerpt_id);
5330        let mut excerpts = self
5331            .excerpts
5332            .cursor::<Dimensions<Option<&Locator>, ExcerptDimension<usize>>>(());
5333        excerpts.seek(&Some(start_locator), Bias::Left);
5334        excerpts.prev();
5335
5336        let mut diff_transforms = self.diff_transforms.cursor::<DiffTransforms<usize>>(());
5337        diff_transforms.seek(&excerpts.start().1, Bias::Left);
5338        if diff_transforms.end().excerpt_dimension < excerpts.start().1 {
5339            diff_transforms.next();
5340        }
5341
5342        let excerpt = excerpts.item()?;
5343        Some(MultiBufferExcerpt {
5344            excerpt,
5345            offset: diff_transforms.start().output_dimension.0,
5346            buffer_offset: excerpt.range.context.start.to_offset(&excerpt.buffer),
5347            excerpt_offset: excerpts.start().1.clone(),
5348            diff_transforms,
5349        })
5350    }
5351
5352    pub fn excerpt_boundaries_in_range<R, T>(
5353        &self,
5354        range: R,
5355    ) -> impl Iterator<Item = ExcerptBoundary> + '_
5356    where
5357        R: RangeBounds<T>,
5358        T: ToOffset,
5359    {
5360        let start_offset;
5361        let start = match range.start_bound() {
5362            Bound::Included(start) => {
5363                start_offset = start.to_offset(self);
5364                Bound::Included(start_offset)
5365            }
5366            Bound::Excluded(_) => {
5367                panic!("not supported")
5368            }
5369            Bound::Unbounded => {
5370                start_offset = 0;
5371                Bound::Unbounded
5372            }
5373        };
5374        let end = match range.end_bound() {
5375            Bound::Included(end) => Bound::Included(end.to_offset(self)),
5376            Bound::Excluded(end) => Bound::Excluded(end.to_offset(self)),
5377            Bound::Unbounded => Bound::Unbounded,
5378        };
5379        let bounds = (start, end);
5380
5381        let mut cursor = self.cursor::<DimensionPair<usize, Point>>();
5382        cursor.seek(&DimensionPair {
5383            key: start_offset,
5384            value: None,
5385        });
5386
5387        if cursor
5388            .region()
5389            .is_some_and(|region| bounds.contains(&region.range.start.key))
5390        {
5391            cursor.prev_excerpt();
5392        } else {
5393            cursor.seek_to_start_of_current_excerpt();
5394        }
5395        let mut prev_region = cursor.region();
5396
5397        cursor.next_excerpt();
5398
5399        iter::from_fn(move || {
5400            loop {
5401                if self.singleton {
5402                    return None;
5403                }
5404
5405                let next_region = cursor.region()?;
5406                cursor.next_excerpt();
5407                if !bounds.contains(&next_region.range.start.key) {
5408                    prev_region = Some(next_region);
5409                    continue;
5410                }
5411
5412                let next_region_start = next_region.range.start.value.unwrap();
5413                let next_region_end = if let Some(region) = cursor.region() {
5414                    region.range.start.value.unwrap()
5415                } else {
5416                    self.max_point()
5417                };
5418
5419                let prev = prev_region.as_ref().map(|region| ExcerptInfo {
5420                    id: region.excerpt.id,
5421                    buffer: region.excerpt.buffer.clone(),
5422                    buffer_id: region.excerpt.buffer_id,
5423                    range: region.excerpt.range.clone(),
5424                    end_row: MultiBufferRow(next_region_start.row),
5425                });
5426
5427                let next = ExcerptInfo {
5428                    id: next_region.excerpt.id,
5429                    buffer: next_region.excerpt.buffer.clone(),
5430                    buffer_id: next_region.excerpt.buffer_id,
5431                    range: next_region.excerpt.range.clone(),
5432                    end_row: if next_region.excerpt.has_trailing_newline {
5433                        MultiBufferRow(next_region_end.row - 1)
5434                    } else {
5435                        MultiBufferRow(next_region_end.row)
5436                    },
5437                };
5438
5439                let row = MultiBufferRow(next_region_start.row);
5440
5441                prev_region = Some(next_region);
5442
5443                return Some(ExcerptBoundary { row, prev, next });
5444            }
5445        })
5446    }
5447
5448    pub fn edit_count(&self) -> usize {
5449        self.edit_count
5450    }
5451
5452    pub fn non_text_state_update_count(&self) -> usize {
5453        self.non_text_state_update_count
5454    }
5455
5456    /// Returns the smallest enclosing bracket ranges containing the given range or
5457    /// None if no brackets contain range or the range is not contained in a single
5458    /// excerpt
5459    ///
5460    /// Can optionally pass a range_filter to filter the ranges of brackets to consider
5461    pub fn innermost_enclosing_bracket_ranges<T: ToOffset>(
5462        &self,
5463        range: Range<T>,
5464        range_filter: Option<&dyn Fn(&BufferSnapshot, Range<usize>, Range<usize>) -> bool>,
5465    ) -> Option<(Range<usize>, Range<usize>)> {
5466        let range = range.start.to_offset(self)..range.end.to_offset(self);
5467        let mut excerpt = self.excerpt_containing(range.clone())?;
5468        let buffer = excerpt.buffer();
5469        let excerpt_buffer_range = excerpt.buffer_range();
5470
5471        // Filter to ranges contained in the excerpt
5472        let range_filter = |open: Range<usize>, close: Range<usize>| -> bool {
5473            excerpt_buffer_range.contains(&open.start)
5474                && excerpt_buffer_range.contains(&close.end)
5475                && range_filter.is_none_or(|filter| filter(buffer, open, close))
5476        };
5477
5478        let (open, close) = excerpt.buffer().innermost_enclosing_bracket_ranges(
5479            excerpt.map_range_to_buffer(range),
5480            Some(&range_filter),
5481        )?;
5482
5483        Some((
5484            excerpt.map_range_from_buffer(open),
5485            excerpt.map_range_from_buffer(close),
5486        ))
5487    }
5488
5489    /// Returns enclosing bracket ranges containing the given range or returns None if the range is
5490    /// not contained in a single excerpt
5491    pub fn enclosing_bracket_ranges<T: ToOffset>(
5492        &self,
5493        range: Range<T>,
5494    ) -> Option<impl Iterator<Item = (Range<usize>, Range<usize>)> + '_> {
5495        let range = range.start.to_offset(self)..range.end.to_offset(self);
5496        let mut excerpt = self.excerpt_containing(range.clone())?;
5497
5498        Some(
5499            excerpt
5500                .buffer()
5501                .enclosing_bracket_ranges(excerpt.map_range_to_buffer(range))
5502                .filter_map(move |pair| {
5503                    if excerpt.contains_buffer_range(pair.open_range.start..pair.close_range.end) {
5504                        Some((
5505                            excerpt.map_range_from_buffer(pair.open_range),
5506                            excerpt.map_range_from_buffer(pair.close_range),
5507                        ))
5508                    } else {
5509                        None
5510                    }
5511                }),
5512        )
5513    }
5514
5515    /// Returns enclosing bracket ranges containing the given range or returns None if the range is
5516    /// not contained in a single excerpt
5517    pub fn text_object_ranges<T: ToOffset>(
5518        &self,
5519        range: Range<T>,
5520        options: TreeSitterOptions,
5521    ) -> impl Iterator<Item = (Range<usize>, TextObject)> + '_ {
5522        let range = range.start.to_offset(self)..range.end.to_offset(self);
5523        self.excerpt_containing(range.clone())
5524            .map(|mut excerpt| {
5525                excerpt
5526                    .buffer()
5527                    .text_object_ranges(excerpt.map_range_to_buffer(range), options)
5528                    .filter_map(move |(range, text_object)| {
5529                        if excerpt.contains_buffer_range(range.clone()) {
5530                            Some((excerpt.map_range_from_buffer(range), text_object))
5531                        } else {
5532                            None
5533                        }
5534                    })
5535            })
5536            .into_iter()
5537            .flatten()
5538    }
5539
5540    /// Returns bracket range pairs overlapping the given `range` or returns None if the `range` is
5541    /// not contained in a single excerpt
5542    pub fn bracket_ranges<T: ToOffset>(
5543        &self,
5544        range: Range<T>,
5545    ) -> Option<impl Iterator<Item = (Range<usize>, Range<usize>)> + '_> {
5546        let range = range.start.to_offset(self)..range.end.to_offset(self);
5547        let mut excerpt = self.excerpt_containing(range.clone())?;
5548
5549        Some(
5550            excerpt
5551                .buffer()
5552                .bracket_ranges(excerpt.map_range_to_buffer(range))
5553                .filter_map(move |pair| {
5554                    let buffer_range = pair.open_range.start..pair.close_range.end;
5555                    if excerpt.contains_buffer_range(buffer_range) {
5556                        Some((
5557                            excerpt.map_range_from_buffer(pair.open_range),
5558                            excerpt.map_range_from_buffer(pair.close_range),
5559                        ))
5560                    } else {
5561                        None
5562                    }
5563                }),
5564        )
5565    }
5566
5567    pub fn redacted_ranges<'a, T: ToOffset>(
5568        &'a self,
5569        range: Range<T>,
5570        redaction_enabled: impl Fn(Option<&Arc<dyn File>>) -> bool + 'a,
5571    ) -> impl Iterator<Item = Range<usize>> + 'a {
5572        let range = range.start.to_offset(self)..range.end.to_offset(self);
5573        self.lift_buffer_metadata(range, move |buffer, range| {
5574            if redaction_enabled(buffer.file()) {
5575                Some(buffer.redacted_ranges(range).map(|range| (range, ())))
5576            } else {
5577                None
5578            }
5579        })
5580        .map(|(range, _, _)| range)
5581    }
5582
5583    pub fn runnable_ranges(
5584        &self,
5585        range: Range<Anchor>,
5586    ) -> impl Iterator<Item = language::RunnableRange> + '_ {
5587        let range = range.start.to_offset(self)..range.end.to_offset(self);
5588        self.lift_buffer_metadata(range, move |buffer, range| {
5589            Some(
5590                buffer
5591                    .runnable_ranges(range.clone())
5592                    .filter(move |runnable| {
5593                        runnable.run_range.start >= range.start
5594                            && runnable.run_range.end < range.end
5595                    })
5596                    .map(|runnable| (runnable.run_range.clone(), runnable)),
5597            )
5598        })
5599        .map(|(run_range, runnable, _)| language::RunnableRange {
5600            run_range,
5601            ..runnable
5602        })
5603    }
5604
5605    pub fn line_indents(
5606        &self,
5607        start_row: MultiBufferRow,
5608        buffer_filter: impl Fn(&BufferSnapshot) -> bool,
5609    ) -> impl Iterator<Item = (MultiBufferRow, LineIndent, &BufferSnapshot)> {
5610        let max_point = self.max_point();
5611        let mut cursor = self.cursor::<Point>();
5612        cursor.seek(&Point::new(start_row.0, 0));
5613        iter::from_fn(move || {
5614            let mut region = cursor.region()?;
5615            while !buffer_filter(&region.excerpt.buffer) {
5616                cursor.next();
5617                region = cursor.region()?;
5618            }
5619            let overshoot = start_row.0.saturating_sub(region.range.start.row);
5620            let buffer_start_row =
5621                (region.buffer_range.start.row + overshoot).min(region.buffer_range.end.row);
5622
5623            let buffer_end_row = if region.is_main_buffer
5624                && (region.has_trailing_newline || region.range.end == max_point)
5625            {
5626                region.buffer_range.end.row
5627            } else {
5628                region.buffer_range.end.row.saturating_sub(1)
5629            };
5630
5631            let line_indents = region
5632                .buffer
5633                .line_indents_in_row_range(buffer_start_row..buffer_end_row);
5634            cursor.next();
5635            Some(line_indents.map(move |(buffer_row, indent)| {
5636                let row = region.range.start.row + (buffer_row - region.buffer_range.start.row);
5637                (MultiBufferRow(row), indent, &region.excerpt.buffer)
5638            }))
5639        })
5640        .flatten()
5641    }
5642
5643    pub fn reversed_line_indents(
5644        &self,
5645        end_row: MultiBufferRow,
5646        buffer_filter: impl Fn(&BufferSnapshot) -> bool,
5647    ) -> impl Iterator<Item = (MultiBufferRow, LineIndent, &BufferSnapshot)> {
5648        let max_point = self.max_point();
5649        let mut cursor = self.cursor::<Point>();
5650        cursor.seek(&Point::new(end_row.0, 0));
5651        iter::from_fn(move || {
5652            let mut region = cursor.region()?;
5653            while !buffer_filter(&region.excerpt.buffer) {
5654                cursor.prev();
5655                region = cursor.region()?;
5656            }
5657
5658            let buffer_start_row = region.buffer_range.start.row;
5659            let buffer_end_row = if region.is_main_buffer
5660                && (region.has_trailing_newline || region.range.end == max_point)
5661            {
5662                region.buffer_range.end.row + 1
5663            } else {
5664                region.buffer_range.end.row
5665            };
5666
5667            let overshoot = end_row.0 - region.range.start.row;
5668            let buffer_end_row =
5669                (region.buffer_range.start.row + overshoot + 1).min(buffer_end_row);
5670
5671            let line_indents = region
5672                .buffer
5673                .reversed_line_indents_in_row_range(buffer_start_row..buffer_end_row);
5674            cursor.prev();
5675            Some(line_indents.map(move |(buffer_row, indent)| {
5676                let row = region.range.start.row + (buffer_row - region.buffer_range.start.row);
5677                (MultiBufferRow(row), indent, &region.excerpt.buffer)
5678            }))
5679        })
5680        .flatten()
5681    }
5682
5683    pub async fn enclosing_indent(
5684        &self,
5685        mut target_row: MultiBufferRow,
5686    ) -> Option<(Range<MultiBufferRow>, LineIndent)> {
5687        let max_row = MultiBufferRow(self.max_point().row);
5688        if target_row >= max_row {
5689            return None;
5690        }
5691
5692        let mut target_indent = self.line_indent_for_row(target_row);
5693
5694        // If the current row is at the start of an indented block, we want to return this
5695        // block as the enclosing indent.
5696        if !target_indent.is_line_empty() && target_row < max_row {
5697            let next_line_indent = self.line_indent_for_row(MultiBufferRow(target_row.0 + 1));
5698            if !next_line_indent.is_line_empty()
5699                && target_indent.raw_len() < next_line_indent.raw_len()
5700            {
5701                target_indent = next_line_indent;
5702                target_row.0 += 1;
5703            }
5704        }
5705
5706        const SEARCH_ROW_LIMIT: u32 = 25000;
5707        const SEARCH_WHITESPACE_ROW_LIMIT: u32 = 2500;
5708        const YIELD_INTERVAL: u32 = 100;
5709
5710        let mut accessed_row_counter = 0;
5711
5712        // If there is a blank line at the current row, search for the next non indented lines
5713        if target_indent.is_line_empty() {
5714            let start = MultiBufferRow(target_row.0.saturating_sub(SEARCH_WHITESPACE_ROW_LIMIT));
5715            let end =
5716                MultiBufferRow((max_row.0 + 1).min(target_row.0 + SEARCH_WHITESPACE_ROW_LIMIT));
5717
5718            let mut non_empty_line_above = None;
5719            for (row, indent, _) in self.reversed_line_indents(target_row, |_| true) {
5720                if row < start {
5721                    break;
5722                }
5723                accessed_row_counter += 1;
5724                if accessed_row_counter == YIELD_INTERVAL {
5725                    accessed_row_counter = 0;
5726                    yield_now().await;
5727                }
5728                if !indent.is_line_empty() {
5729                    non_empty_line_above = Some((row, indent));
5730                    break;
5731                }
5732            }
5733
5734            let mut non_empty_line_below = None;
5735            for (row, indent, _) in self.line_indents(target_row, |_| true) {
5736                if row > end {
5737                    break;
5738                }
5739                accessed_row_counter += 1;
5740                if accessed_row_counter == YIELD_INTERVAL {
5741                    accessed_row_counter = 0;
5742                    yield_now().await;
5743                }
5744                if !indent.is_line_empty() {
5745                    non_empty_line_below = Some((row, indent));
5746                    break;
5747                }
5748            }
5749
5750            let (row, indent) = match (non_empty_line_above, non_empty_line_below) {
5751                (Some((above_row, above_indent)), Some((below_row, below_indent))) => {
5752                    if above_indent.raw_len() >= below_indent.raw_len() {
5753                        (above_row, above_indent)
5754                    } else {
5755                        (below_row, below_indent)
5756                    }
5757                }
5758                (Some(above), None) => above,
5759                (None, Some(below)) => below,
5760                _ => return None,
5761            };
5762
5763            target_indent = indent;
5764            target_row = row;
5765        }
5766
5767        let start = MultiBufferRow(target_row.0.saturating_sub(SEARCH_ROW_LIMIT));
5768        let end = MultiBufferRow((max_row.0 + 1).min(target_row.0 + SEARCH_ROW_LIMIT));
5769
5770        let mut start_indent = None;
5771        for (row, indent, _) in self.reversed_line_indents(target_row, |_| true) {
5772            if row < start {
5773                break;
5774            }
5775            accessed_row_counter += 1;
5776            if accessed_row_counter == YIELD_INTERVAL {
5777                accessed_row_counter = 0;
5778                yield_now().await;
5779            }
5780            if !indent.is_line_empty() && indent.raw_len() < target_indent.raw_len() {
5781                start_indent = Some((row, indent));
5782                break;
5783            }
5784        }
5785        let (start_row, start_indent_size) = start_indent?;
5786
5787        let mut end_indent = (end, None);
5788        for (row, indent, _) in self.line_indents(target_row, |_| true) {
5789            if row > end {
5790                break;
5791            }
5792            accessed_row_counter += 1;
5793            if accessed_row_counter == YIELD_INTERVAL {
5794                accessed_row_counter = 0;
5795                yield_now().await;
5796            }
5797            if !indent.is_line_empty() && indent.raw_len() < target_indent.raw_len() {
5798                end_indent = (MultiBufferRow(row.0.saturating_sub(1)), Some(indent));
5799                break;
5800            }
5801        }
5802        let (end_row, end_indent_size) = end_indent;
5803
5804        let indent = if let Some(end_indent_size) = end_indent_size {
5805            if start_indent_size.raw_len() > end_indent_size.raw_len() {
5806                start_indent_size
5807            } else {
5808                end_indent_size
5809            }
5810        } else {
5811            start_indent_size
5812        };
5813
5814        Some((start_row..end_row, indent))
5815    }
5816
5817    pub fn indent_guides_in_range<T: ToPoint>(
5818        &self,
5819        range: Range<T>,
5820        ignore_disabled_for_language: bool,
5821        cx: &App,
5822    ) -> impl Iterator<Item = IndentGuide> {
5823        let range = range.start.to_point(self)..range.end.to_point(self);
5824        let start_row = MultiBufferRow(range.start.row);
5825        let end_row = MultiBufferRow(range.end.row);
5826
5827        let mut row_indents = self.line_indents(start_row, |buffer| {
5828            let settings =
5829                language_settings(buffer.language().map(|l| l.name()), buffer.file(), cx);
5830            settings.indent_guides.enabled || ignore_disabled_for_language
5831        });
5832
5833        let mut result = Vec::new();
5834        let mut indent_stack = SmallVec::<[IndentGuide; 8]>::new();
5835
5836        let mut prev_settings = None;
5837        while let Some((first_row, mut line_indent, buffer)) = row_indents.next() {
5838            if first_row > end_row {
5839                break;
5840            }
5841            let current_depth = indent_stack.len() as u32;
5842
5843            // Avoid retrieving the language settings repeatedly for every buffer row.
5844            if let Some((prev_buffer_id, _)) = &prev_settings
5845                && prev_buffer_id != &buffer.remote_id()
5846            {
5847                prev_settings.take();
5848            }
5849            let settings = &prev_settings
5850                .get_or_insert_with(|| {
5851                    (
5852                        buffer.remote_id(),
5853                        language_settings(buffer.language().map(|l| l.name()), buffer.file(), cx),
5854                    )
5855                })
5856                .1;
5857            let tab_size = settings.tab_size.get();
5858
5859            // When encountering empty, continue until found useful line indent
5860            // then add to the indent stack with the depth found
5861            let mut found_indent = false;
5862            let mut last_row = first_row;
5863            if line_indent.is_line_blank() {
5864                while !found_indent {
5865                    let Some((target_row, new_line_indent, _)) = row_indents.next() else {
5866                        break;
5867                    };
5868                    const TRAILING_ROW_SEARCH_LIMIT: u32 = 25;
5869                    if target_row > MultiBufferRow(end_row.0 + TRAILING_ROW_SEARCH_LIMIT) {
5870                        break;
5871                    }
5872
5873                    if new_line_indent.is_line_blank() {
5874                        continue;
5875                    }
5876                    last_row = target_row.min(end_row);
5877                    line_indent = new_line_indent;
5878                    found_indent = true;
5879                    break;
5880                }
5881            } else {
5882                found_indent = true
5883            }
5884
5885            let depth = if found_indent {
5886                line_indent.len(tab_size) / tab_size
5887            } else {
5888                0
5889            };
5890
5891            match depth.cmp(&current_depth) {
5892                cmp::Ordering::Less => {
5893                    for _ in 0..(current_depth - depth) {
5894                        let mut indent = indent_stack.pop().unwrap();
5895                        if last_row != first_row {
5896                            // In this case, we landed on an empty row, had to seek forward,
5897                            // and discovered that the indent we where on is ending.
5898                            // This means that the last display row must
5899                            // be on line that ends this indent range, so we
5900                            // should display the range up to the first non-empty line
5901                            indent.end_row = MultiBufferRow(first_row.0.saturating_sub(1));
5902                        }
5903
5904                        result.push(indent)
5905                    }
5906                }
5907                cmp::Ordering::Greater => {
5908                    for next_depth in current_depth..depth {
5909                        indent_stack.push(IndentGuide {
5910                            buffer_id: buffer.remote_id(),
5911                            start_row: first_row,
5912                            end_row: last_row,
5913                            depth: next_depth,
5914                            tab_size,
5915                            settings: settings.indent_guides.clone(),
5916                        });
5917                    }
5918                }
5919                _ => {}
5920            }
5921
5922            for indent in indent_stack.iter_mut() {
5923                indent.end_row = last_row;
5924            }
5925        }
5926
5927        result.extend(indent_stack);
5928        result.into_iter()
5929    }
5930
5931    pub fn trailing_excerpt_update_count(&self) -> usize {
5932        self.trailing_excerpt_update_count
5933    }
5934
5935    pub fn file_at<T: ToOffset>(&self, point: T) -> Option<&Arc<dyn File>> {
5936        self.point_to_buffer_offset(point)
5937            .and_then(|(buffer, _)| buffer.file())
5938    }
5939
5940    pub fn language_at<T: ToOffset>(&self, point: T) -> Option<&Arc<Language>> {
5941        self.point_to_buffer_offset(point)
5942            .and_then(|(buffer, offset)| buffer.language_at(offset))
5943    }
5944
5945    fn language_settings<'a>(&'a self, cx: &'a App) -> Cow<'a, LanguageSettings> {
5946        self.excerpts
5947            .first()
5948            .map(|excerpt| &excerpt.buffer)
5949            .map(|buffer| {
5950                language_settings(
5951                    buffer.language().map(|language| language.name()),
5952                    buffer.file(),
5953                    cx,
5954                )
5955            })
5956            .unwrap_or_else(move || self.language_settings_at(0, cx))
5957    }
5958
5959    pub fn language_settings_at<'a, T: ToOffset>(
5960        &'a self,
5961        point: T,
5962        cx: &'a App,
5963    ) -> Cow<'a, LanguageSettings> {
5964        let mut language = None;
5965        let mut file = None;
5966        if let Some((buffer, offset)) = self.point_to_buffer_offset(point) {
5967            language = buffer.language_at(offset);
5968            file = buffer.file();
5969        }
5970        language_settings(language.map(|l| l.name()), file, cx)
5971    }
5972
5973    pub fn language_scope_at<T: ToOffset>(&self, point: T) -> Option<LanguageScope> {
5974        self.point_to_buffer_offset(point)
5975            .and_then(|(buffer, offset)| buffer.language_scope_at(offset))
5976    }
5977
5978    pub fn char_classifier_at<T: ToOffset>(&self, point: T) -> CharClassifier {
5979        self.point_to_buffer_offset(point)
5980            .map(|(buffer, offset)| buffer.char_classifier_at(offset))
5981            .unwrap_or_default()
5982    }
5983
5984    pub fn language_indent_size_at<T: ToOffset>(
5985        &self,
5986        position: T,
5987        cx: &App,
5988    ) -> Option<IndentSize> {
5989        let (buffer_snapshot, offset) = self.point_to_buffer_offset(position)?;
5990        Some(buffer_snapshot.language_indent_size_at(offset, cx))
5991    }
5992
5993    pub fn is_dirty(&self) -> bool {
5994        self.is_dirty
5995    }
5996
5997    pub fn has_deleted_file(&self) -> bool {
5998        self.has_deleted_file
5999    }
6000
6001    pub fn has_conflict(&self) -> bool {
6002        self.has_conflict
6003    }
6004
6005    pub fn has_diagnostics(&self) -> bool {
6006        self.excerpts
6007            .iter()
6008            .any(|excerpt| excerpt.buffer.has_diagnostics())
6009    }
6010
6011    pub fn diagnostic_group(
6012        &self,
6013        buffer_id: BufferId,
6014        group_id: usize,
6015    ) -> impl Iterator<Item = DiagnosticEntryRef<'_, Point>> + '_ {
6016        self.lift_buffer_metadata(Point::zero()..self.max_point(), move |buffer, range| {
6017            if buffer.remote_id() != buffer_id {
6018                return None;
6019            };
6020            Some(
6021                buffer
6022                    .diagnostics_in_range(range, false)
6023                    .filter(move |diagnostic| diagnostic.diagnostic.group_id == group_id)
6024                    .map(move |DiagnosticEntryRef { diagnostic, range }| (range, diagnostic)),
6025            )
6026        })
6027        .map(|(range, diagnostic, _)| DiagnosticEntryRef { diagnostic, range })
6028    }
6029
6030    pub fn diagnostics_in_range<'a, T>(
6031        &'a self,
6032        range: Range<T>,
6033    ) -> impl Iterator<Item = DiagnosticEntryRef<'a, T>> + 'a
6034    where
6035        T: 'a
6036            + text::ToOffset
6037            + text::FromAnchor
6038            + TextDimension
6039            + Ord
6040            + Sub<T, Output = T>
6041            + fmt::Debug,
6042    {
6043        self.lift_buffer_metadata(range, move |buffer, buffer_range| {
6044            Some(
6045                buffer
6046                    .diagnostics_in_range(buffer_range.start..buffer_range.end, false)
6047                    .map(|entry| (entry.range, entry.diagnostic)),
6048            )
6049        })
6050        .map(|(range, diagnostic, _)| DiagnosticEntryRef { diagnostic, range })
6051    }
6052
6053    pub fn diagnostics_with_buffer_ids_in_range<'a, T>(
6054        &'a self,
6055        range: Range<T>,
6056    ) -> impl Iterator<Item = (BufferId, DiagnosticEntryRef<'a, T>)> + 'a
6057    where
6058        T: 'a
6059            + text::ToOffset
6060            + text::FromAnchor
6061            + TextDimension
6062            + Ord
6063            + Sub<T, Output = T>
6064            + fmt::Debug,
6065    {
6066        self.lift_buffer_metadata(range, move |buffer, buffer_range| {
6067            Some(
6068                buffer
6069                    .diagnostics_in_range(buffer_range.start..buffer_range.end, false)
6070                    .map(|entry| (entry.range, entry.diagnostic)),
6071            )
6072        })
6073        .map(|(range, diagnostic, b)| (b.buffer_id, DiagnosticEntryRef { diagnostic, range }))
6074    }
6075
6076    pub fn syntax_ancestor<T: ToOffset>(
6077        &self,
6078        range: Range<T>,
6079    ) -> Option<(tree_sitter::Node<'_>, Range<usize>)> {
6080        let range = range.start.to_offset(self)..range.end.to_offset(self);
6081        let mut excerpt = self.excerpt_containing(range.clone())?;
6082        let node = excerpt
6083            .buffer()
6084            .syntax_ancestor(excerpt.map_range_to_buffer(range))?;
6085        let node_range = node.byte_range();
6086        if !excerpt.contains_buffer_range(node_range.clone()) {
6087            return None;
6088        };
6089        Some((node, excerpt.map_range_from_buffer(node_range)))
6090    }
6091
6092    pub fn syntax_next_sibling<T: ToOffset>(
6093        &self,
6094        range: Range<T>,
6095    ) -> Option<tree_sitter::Node<'_>> {
6096        let range = range.start.to_offset(self)..range.end.to_offset(self);
6097        let mut excerpt = self.excerpt_containing(range.clone())?;
6098        excerpt
6099            .buffer()
6100            .syntax_next_sibling(excerpt.map_range_to_buffer(range))
6101    }
6102
6103    pub fn syntax_prev_sibling<T: ToOffset>(
6104        &self,
6105        range: Range<T>,
6106    ) -> Option<tree_sitter::Node<'_>> {
6107        let range = range.start.to_offset(self)..range.end.to_offset(self);
6108        let mut excerpt = self.excerpt_containing(range.clone())?;
6109        excerpt
6110            .buffer()
6111            .syntax_prev_sibling(excerpt.map_range_to_buffer(range))
6112    }
6113
6114    pub fn outline(&self, theme: Option<&SyntaxTheme>) -> Option<Outline<Anchor>> {
6115        let (excerpt_id, _, buffer) = self.as_singleton()?;
6116        let outline = buffer.outline(theme);
6117        Some(Outline::new(
6118            outline
6119                .items
6120                .into_iter()
6121                .flat_map(|item| {
6122                    Some(OutlineItem {
6123                        depth: item.depth,
6124                        range: self.anchor_range_in_excerpt(*excerpt_id, item.range)?,
6125                        text: item.text,
6126                        highlight_ranges: item.highlight_ranges,
6127                        name_ranges: item.name_ranges,
6128                        body_range: item.body_range.and_then(|body_range| {
6129                            self.anchor_range_in_excerpt(*excerpt_id, body_range)
6130                        }),
6131                        annotation_range: item.annotation_range.and_then(|annotation_range| {
6132                            self.anchor_range_in_excerpt(*excerpt_id, annotation_range)
6133                        }),
6134                    })
6135                })
6136                .collect(),
6137        ))
6138    }
6139
6140    pub fn symbols_containing<T: ToOffset>(
6141        &self,
6142        offset: T,
6143        theme: Option<&SyntaxTheme>,
6144    ) -> Option<(BufferId, Vec<OutlineItem<Anchor>>)> {
6145        let anchor = self.anchor_before(offset);
6146        let excerpt_id = anchor.excerpt_id;
6147        let excerpt = self.excerpt(excerpt_id)?;
6148        let buffer_id = excerpt.buffer_id;
6149        Some((
6150            buffer_id,
6151            excerpt
6152                .buffer
6153                .symbols_containing(anchor.text_anchor, theme)
6154                .into_iter()
6155                .flat_map(|item| {
6156                    Some(OutlineItem {
6157                        depth: item.depth,
6158                        range: Anchor::range_in_buffer(excerpt_id, buffer_id, item.range),
6159                        text: item.text,
6160                        highlight_ranges: item.highlight_ranges,
6161                        name_ranges: item.name_ranges,
6162                        body_range: item.body_range.map(|body_range| {
6163                            Anchor::range_in_buffer(excerpt_id, buffer_id, body_range)
6164                        }),
6165                        annotation_range: item.annotation_range.map(|body_range| {
6166                            Anchor::range_in_buffer(excerpt_id, buffer_id, body_range)
6167                        }),
6168                    })
6169                })
6170                .collect(),
6171        ))
6172    }
6173
6174    fn excerpt_locator_for_id(&self, id: ExcerptId) -> &Locator {
6175        if id == ExcerptId::min() {
6176            Locator::min_ref()
6177        } else if id == ExcerptId::max() {
6178            Locator::max_ref()
6179        } else {
6180            let mut cursor = self.excerpt_ids.cursor::<ExcerptId>(());
6181            cursor.seek(&id, Bias::Left);
6182            if let Some(entry) = cursor.item()
6183                && entry.id == id
6184            {
6185                return &entry.locator;
6186            }
6187            panic!("invalid excerpt id {id:?}")
6188        }
6189    }
6190
6191    /// Returns the locators referenced by the given excerpt IDs, sorted by locator.
6192    fn excerpt_locators_for_ids(
6193        &self,
6194        ids: impl IntoIterator<Item = ExcerptId>,
6195    ) -> SmallVec<[Locator; 1]> {
6196        let mut sorted_ids = ids.into_iter().collect::<SmallVec<[_; 1]>>();
6197        sorted_ids.sort_unstable();
6198        let mut locators = SmallVec::new();
6199
6200        while sorted_ids.last() == Some(&ExcerptId::max()) {
6201            sorted_ids.pop();
6202            if let Some(mapping) = self.excerpt_ids.last() {
6203                locators.push(mapping.locator.clone());
6204            }
6205        }
6206
6207        let mut sorted_ids = sorted_ids.into_iter().dedup().peekable();
6208        if sorted_ids.peek() == Some(&ExcerptId::min()) {
6209            sorted_ids.next();
6210            if let Some(mapping) = self.excerpt_ids.first() {
6211                locators.push(mapping.locator.clone());
6212            }
6213        }
6214
6215        let mut cursor = self.excerpt_ids.cursor::<ExcerptId>(());
6216        for id in sorted_ids {
6217            if cursor.seek_forward(&id, Bias::Left) {
6218                locators.push(cursor.item().unwrap().locator.clone());
6219            } else {
6220                panic!("invalid excerpt id {:?}", id);
6221            }
6222        }
6223
6224        locators.sort_unstable();
6225        locators
6226    }
6227
6228    pub fn buffer_id_for_excerpt(&self, excerpt_id: ExcerptId) -> Option<BufferId> {
6229        Some(self.excerpt(excerpt_id)?.buffer_id)
6230    }
6231
6232    pub fn buffer_for_excerpt(&self, excerpt_id: ExcerptId) -> Option<&BufferSnapshot> {
6233        Some(&self.excerpt(excerpt_id)?.buffer)
6234    }
6235
6236    pub fn range_for_excerpt(&self, excerpt_id: ExcerptId) -> Option<Range<Point>> {
6237        let mut cursor = self
6238            .excerpts
6239            .cursor::<Dimensions<Option<&Locator>, ExcerptDimension<Point>>>(());
6240        let locator = self.excerpt_locator_for_id(excerpt_id);
6241        let mut sought_exact = cursor.seek(&Some(locator), Bias::Left);
6242        if cursor.item().is_none() && excerpt_id == ExcerptId::max() {
6243            sought_exact = true;
6244            cursor.prev();
6245        } else if excerpt_id == ExcerptId::min() {
6246            sought_exact = true;
6247        }
6248        if sought_exact {
6249            let start = cursor.start().1.clone();
6250            let end = cursor.end().1;
6251            let mut diff_transforms = self
6252                .diff_transforms
6253                .cursor::<Dimensions<ExcerptDimension<Point>, OutputDimension<Point>>>(());
6254            diff_transforms.seek(&start, Bias::Left);
6255            let overshoot = start.0 - diff_transforms.start().0.0;
6256            let start = diff_transforms.start().1.0 + overshoot;
6257            diff_transforms.seek(&end, Bias::Right);
6258            let overshoot = end.0 - diff_transforms.start().0.0;
6259            let end = diff_transforms.start().1.0 + overshoot;
6260            Some(start..end)
6261        } else {
6262            None
6263        }
6264    }
6265
6266    fn excerpt(&self, excerpt_id: ExcerptId) -> Option<&Excerpt> {
6267        let mut cursor = self.excerpts.cursor::<Option<&Locator>>(());
6268        let locator = self.excerpt_locator_for_id(excerpt_id);
6269        cursor.seek(&Some(locator), Bias::Left);
6270        if let Some(excerpt) = cursor.item()
6271            && excerpt.id == excerpt_id
6272        {
6273            return Some(excerpt);
6274        } else if cursor.item().is_none() && excerpt_id == ExcerptId::max() {
6275            cursor.prev();
6276            return cursor.item();
6277        }
6278        None
6279    }
6280
6281    /// Returns the excerpt containing range and its offset start within the multibuffer or none if `range` spans multiple excerpts
6282    pub fn excerpt_containing<T: ToOffset>(
6283        &self,
6284        range: Range<T>,
6285    ) -> Option<MultiBufferExcerpt<'_>> {
6286        let range = range.start.to_offset(self)..range.end.to_offset(self);
6287        let mut cursor = self.cursor::<usize>();
6288        cursor.seek(&range.start);
6289
6290        let start_excerpt = cursor.excerpt()?;
6291        if range.end != range.start {
6292            cursor.seek_forward(&range.end);
6293            if cursor.excerpt()?.id != start_excerpt.id {
6294                return None;
6295            }
6296        }
6297
6298        cursor.seek_to_start_of_current_excerpt();
6299        let region = cursor.region()?;
6300        let offset = region.range.start;
6301        let buffer_offset = start_excerpt.buffer_start_offset();
6302        let excerpt_offset = cursor.excerpts.start().clone();
6303        Some(MultiBufferExcerpt {
6304            diff_transforms: cursor.diff_transforms,
6305            excerpt: start_excerpt,
6306            offset,
6307            buffer_offset,
6308            excerpt_offset,
6309        })
6310    }
6311
6312    pub fn buffer_id_for_anchor(&self, anchor: Anchor) -> Option<BufferId> {
6313        if let Some(id) = anchor.buffer_id {
6314            return Some(id);
6315        }
6316        let excerpt = self.excerpt_containing(anchor..anchor)?;
6317        Some(excerpt.buffer_id())
6318    }
6319
6320    pub fn selections_in_range<'a>(
6321        &'a self,
6322        range: &'a Range<Anchor>,
6323        include_local: bool,
6324    ) -> impl 'a + Iterator<Item = (ReplicaId, bool, CursorShape, Selection<Anchor>)> {
6325        let mut cursor = self.excerpts.cursor::<ExcerptSummary>(());
6326        let start_locator = self.excerpt_locator_for_id(range.start.excerpt_id);
6327        let end_locator = self.excerpt_locator_for_id(range.end.excerpt_id);
6328        cursor.seek(start_locator, Bias::Left);
6329        cursor
6330            .take_while(move |excerpt| excerpt.locator <= *end_locator)
6331            .flat_map(move |excerpt| {
6332                let mut query_range = excerpt.range.context.start..excerpt.range.context.end;
6333                if excerpt.id == range.start.excerpt_id {
6334                    query_range.start = range.start.text_anchor;
6335                }
6336                if excerpt.id == range.end.excerpt_id {
6337                    query_range.end = range.end.text_anchor;
6338                }
6339
6340                excerpt
6341                    .buffer
6342                    .selections_in_range(query_range, include_local)
6343                    .flat_map(move |(replica_id, line_mode, cursor_shape, selections)| {
6344                        selections.map(move |selection| {
6345                            let mut start =
6346                                Anchor::in_buffer(excerpt.id, excerpt.buffer_id, selection.start);
6347                            let mut end =
6348                                Anchor::in_buffer(excerpt.id, excerpt.buffer_id, selection.end);
6349                            if range.start.cmp(&start, self).is_gt() {
6350                                start = range.start;
6351                            }
6352                            if range.end.cmp(&end, self).is_lt() {
6353                                end = range.end;
6354                            }
6355
6356                            (
6357                                replica_id,
6358                                line_mode,
6359                                cursor_shape,
6360                                Selection {
6361                                    id: selection.id,
6362                                    start,
6363                                    end,
6364                                    reversed: selection.reversed,
6365                                    goal: selection.goal,
6366                                },
6367                            )
6368                        })
6369                    })
6370            })
6371    }
6372
6373    pub fn show_headers(&self) -> bool {
6374        self.show_headers
6375    }
6376
6377    pub fn diff_for_buffer_id(&self, buffer_id: BufferId) -> Option<&BufferDiffSnapshot> {
6378        self.diffs.get(&buffer_id)
6379    }
6380
6381    /// Visually annotates a position or range with the `Debug` representation of a value. The
6382    /// callsite of this function is used as a key - previous annotations will be removed.
6383    #[cfg(debug_assertions)]
6384    #[track_caller]
6385    pub fn debug<V, R>(&self, ranges: &R, value: V)
6386    where
6387        R: debug::ToMultiBufferDebugRanges,
6388        V: std::fmt::Debug,
6389    {
6390        self.debug_with_key(std::panic::Location::caller(), ranges, value);
6391    }
6392
6393    /// Visually annotates a position or range with the `Debug` representation of a value. Previous
6394    /// debug annotations with the same key will be removed. The key is also used to determine the
6395    /// annotation's color.
6396    #[cfg(debug_assertions)]
6397    #[track_caller]
6398    pub fn debug_with_key<K, R, V>(&self, key: &K, ranges: &R, value: V)
6399    where
6400        K: std::hash::Hash + 'static,
6401        R: debug::ToMultiBufferDebugRanges,
6402        V: std::fmt::Debug,
6403    {
6404        let text_ranges = ranges
6405            .to_multi_buffer_debug_ranges(self)
6406            .into_iter()
6407            .flat_map(|range| {
6408                self.range_to_buffer_ranges(range).into_iter().map(
6409                    |(buffer, range, _excerpt_id)| {
6410                        buffer.anchor_after(range.start)..buffer.anchor_before(range.end)
6411                    },
6412                )
6413            })
6414            .collect();
6415        text::debug::GlobalDebugRanges::with_locked(|debug_ranges| {
6416            debug_ranges.insert(key, text_ranges, format!("{value:?}").into())
6417        });
6418    }
6419
6420    // used by line_mode selections and tries to match vim behavior
6421    pub fn expand_to_line(&self, range: Range<Point>) -> Range<Point> {
6422        let new_start = MultiBufferPoint::new(range.start.row, 0);
6423        let new_end = if range.end.column > 0 {
6424            MultiBufferPoint::new(range.end.row, self.line_len(MultiBufferRow(range.end.row)))
6425        } else {
6426            range.end
6427        };
6428        new_start..new_end
6429    }
6430}
6431
6432#[cfg(any(test, feature = "test-support"))]
6433impl MultiBufferSnapshot {
6434    pub fn random_byte_range(&self, start_offset: usize, rng: &mut impl rand::Rng) -> Range<usize> {
6435        let end = self.clip_offset(rng.random_range(start_offset..=self.len()), Bias::Right);
6436        let start = self.clip_offset(rng.random_range(start_offset..=end), Bias::Right);
6437        start..end
6438    }
6439
6440    #[cfg(any(test, feature = "test-support"))]
6441    fn check_invariants(&self) {
6442        let excerpts = self.excerpts.items(());
6443        let excerpt_ids = self.excerpt_ids.items(());
6444
6445        for (ix, excerpt) in excerpts.iter().enumerate() {
6446            if ix == 0 {
6447                if excerpt.locator <= Locator::min() {
6448                    panic!("invalid first excerpt locator {:?}", excerpt.locator);
6449                }
6450            } else if excerpt.locator <= excerpts[ix - 1].locator {
6451                panic!("excerpts are out-of-order: {:?}", excerpts);
6452            }
6453        }
6454
6455        for (ix, entry) in excerpt_ids.iter().enumerate() {
6456            if ix == 0 {
6457                if entry.id.cmp(&ExcerptId::min(), self).is_le() {
6458                    panic!("invalid first excerpt id {:?}", entry.id);
6459                }
6460            } else if entry.id <= excerpt_ids[ix - 1].id {
6461                panic!("excerpt ids are out-of-order: {:?}", excerpt_ids);
6462            }
6463        }
6464
6465        if self.diff_transforms.summary().input != self.excerpts.summary().text {
6466            panic!(
6467                "incorrect input summary. expected {:?}, got {:?}. transforms: {:+?}",
6468                self.excerpts.summary().text.len,
6469                self.diff_transforms.summary().input,
6470                self.diff_transforms.items(()),
6471            );
6472        }
6473
6474        let mut prev_transform: Option<&DiffTransform> = None;
6475        for item in self.diff_transforms.iter() {
6476            if let DiffTransform::BufferContent {
6477                summary,
6478                inserted_hunk_info,
6479            } = item
6480            {
6481                if let Some(DiffTransform::BufferContent {
6482                    inserted_hunk_info: prev_inserted_hunk_info,
6483                    ..
6484                }) = prev_transform
6485                    && *inserted_hunk_info == *prev_inserted_hunk_info
6486                {
6487                    panic!(
6488                        "multiple adjacent buffer content transforms with is_inserted_hunk = {inserted_hunk_info:?}. transforms: {:+?}",
6489                        self.diff_transforms.items(())
6490                    );
6491                }
6492                if summary.len == 0 && !self.is_empty() {
6493                    panic!("empty buffer content transform");
6494                }
6495            }
6496            prev_transform = Some(item);
6497        }
6498    }
6499}
6500
6501impl<'a, D> MultiBufferCursor<'a, D>
6502where
6503    D: TextDimension + Ord + Sub<D, Output = D>,
6504{
6505    fn seek(&mut self, position: &D) {
6506        self.cached_region.take();
6507        self.diff_transforms
6508            .seek(&OutputDimension(*position), Bias::Right);
6509        if self.diff_transforms.item().is_none()
6510            && *position == self.diff_transforms.start().output_dimension.0
6511        {
6512            self.diff_transforms.prev();
6513        }
6514
6515        let mut excerpt_position = self.diff_transforms.start().excerpt_dimension.0;
6516        if let Some(DiffTransform::BufferContent { .. }) = self.diff_transforms.item() {
6517            let overshoot = *position - self.diff_transforms.start().output_dimension.0;
6518            excerpt_position.add_assign(&overshoot);
6519        }
6520
6521        self.excerpts
6522            .seek(&ExcerptDimension(excerpt_position), Bias::Right);
6523        if self.excerpts.item().is_none() && excerpt_position == self.excerpts.start().0 {
6524            self.excerpts.prev();
6525        }
6526    }
6527
6528    fn seek_forward(&mut self, position: &D) {
6529        self.cached_region.take();
6530        self.diff_transforms
6531            .seek_forward(&OutputDimension(*position), Bias::Right);
6532        if self.diff_transforms.item().is_none()
6533            && *position == self.diff_transforms.start().output_dimension.0
6534        {
6535            self.diff_transforms.prev();
6536        }
6537
6538        let overshoot = *position - self.diff_transforms.start().output_dimension.0;
6539        let mut excerpt_position = self.diff_transforms.start().excerpt_dimension.0;
6540        if let Some(DiffTransform::BufferContent { .. }) = self.diff_transforms.item() {
6541            excerpt_position.add_assign(&overshoot);
6542        }
6543
6544        self.excerpts
6545            .seek_forward(&ExcerptDimension(excerpt_position), Bias::Right);
6546        if self.excerpts.item().is_none() && excerpt_position == self.excerpts.start().0 {
6547            self.excerpts.prev();
6548        }
6549    }
6550
6551    fn next_excerpt(&mut self) {
6552        self.excerpts.next();
6553        self.seek_to_start_of_current_excerpt();
6554    }
6555
6556    fn prev_excerpt(&mut self) {
6557        self.excerpts.prev();
6558        self.seek_to_start_of_current_excerpt();
6559    }
6560
6561    fn seek_to_start_of_current_excerpt(&mut self) {
6562        self.cached_region.take();
6563        self.diff_transforms.seek(self.excerpts.start(), Bias::Left);
6564        if self.diff_transforms.end().excerpt_dimension == *self.excerpts.start()
6565            && self.diff_transforms.start().excerpt_dimension < *self.excerpts.start()
6566            && self.diff_transforms.next_item().is_some()
6567        {
6568            self.diff_transforms.next();
6569        }
6570    }
6571
6572    fn next(&mut self) {
6573        self.cached_region.take();
6574        match self
6575            .diff_transforms
6576            .end()
6577            .excerpt_dimension
6578            .cmp(&self.excerpts.end())
6579        {
6580            cmp::Ordering::Less => self.diff_transforms.next(),
6581            cmp::Ordering::Greater => self.excerpts.next(),
6582            cmp::Ordering::Equal => {
6583                self.diff_transforms.next();
6584                if self.diff_transforms.end().excerpt_dimension > self.excerpts.end()
6585                    || self.diff_transforms.item().is_none()
6586                {
6587                    self.excerpts.next();
6588                } else if let Some(DiffTransform::DeletedHunk { hunk_info, .. }) =
6589                    self.diff_transforms.item()
6590                    && self
6591                        .excerpts
6592                        .item()
6593                        .is_some_and(|excerpt| excerpt.id != hunk_info.excerpt_id)
6594                {
6595                    self.excerpts.next();
6596                }
6597            }
6598        }
6599    }
6600
6601    fn prev(&mut self) {
6602        self.cached_region.take();
6603        match self
6604            .diff_transforms
6605            .start()
6606            .excerpt_dimension
6607            .cmp(self.excerpts.start())
6608        {
6609            cmp::Ordering::Less => self.excerpts.prev(),
6610            cmp::Ordering::Greater => self.diff_transforms.prev(),
6611            cmp::Ordering::Equal => {
6612                self.diff_transforms.prev();
6613                if self.diff_transforms.start().excerpt_dimension < *self.excerpts.start()
6614                    || self.diff_transforms.item().is_none()
6615                {
6616                    self.excerpts.prev();
6617                }
6618            }
6619        }
6620    }
6621
6622    fn region(&mut self) -> Option<MultiBufferRegion<'a, D>> {
6623        if self.cached_region.is_none() {
6624            self.cached_region = self.build_region();
6625        }
6626        self.cached_region.clone()
6627    }
6628
6629    fn is_at_start_of_excerpt(&mut self) -> bool {
6630        if self.diff_transforms.start().excerpt_dimension > *self.excerpts.start() {
6631            return false;
6632        } else if self.diff_transforms.start().excerpt_dimension < *self.excerpts.start() {
6633            return true;
6634        }
6635
6636        self.diff_transforms.prev();
6637        let prev_transform = self.diff_transforms.item();
6638        self.diff_transforms.next();
6639
6640        prev_transform.is_none_or(|next_transform| {
6641            matches!(next_transform, DiffTransform::BufferContent { .. })
6642        })
6643    }
6644
6645    fn is_at_end_of_excerpt(&mut self) -> bool {
6646        if self.diff_transforms.end().excerpt_dimension < self.excerpts.end() {
6647            return false;
6648        } else if self.diff_transforms.end().excerpt_dimension > self.excerpts.end()
6649            || self.diff_transforms.item().is_none()
6650        {
6651            return true;
6652        }
6653
6654        let next_transform = self.diff_transforms.next_item();
6655        next_transform.is_none_or(|next_transform| match next_transform {
6656            DiffTransform::BufferContent { .. } => true,
6657            DiffTransform::DeletedHunk { hunk_info, .. } => self
6658                .excerpts
6659                .item()
6660                .is_some_and(|excerpt| excerpt.id != hunk_info.excerpt_id),
6661        })
6662    }
6663
6664    fn main_buffer_position(&self) -> Option<D> {
6665        let excerpt = self.excerpts.item()?;
6666        let buffer = &excerpt.buffer;
6667        let buffer_context_start = excerpt.range.context.start.summary::<D>(buffer);
6668        let mut buffer_start = buffer_context_start;
6669        let overshoot = self.diff_transforms.end().excerpt_dimension.0 - self.excerpts.start().0;
6670        buffer_start.add_assign(&overshoot);
6671        Some(buffer_start)
6672    }
6673
6674    fn build_region(&self) -> Option<MultiBufferRegion<'a, D>> {
6675        let excerpt = self.excerpts.item()?;
6676        match self.diff_transforms.item()? {
6677            DiffTransform::DeletedHunk {
6678                buffer_id,
6679                base_text_byte_range,
6680                has_trailing_newline,
6681                hunk_info,
6682                ..
6683            } => {
6684                let diff = self.diffs.get(buffer_id)?;
6685                let buffer = diff.base_text();
6686                let mut rope_cursor = buffer.as_rope().cursor(0);
6687                let buffer_start = rope_cursor.summary::<D>(base_text_byte_range.start);
6688                let buffer_range_len = rope_cursor.summary::<D>(base_text_byte_range.end);
6689                let mut buffer_end = buffer_start;
6690                buffer_end.add_assign(&buffer_range_len);
6691                let start = self.diff_transforms.start().output_dimension.0;
6692                let end = self.diff_transforms.end().output_dimension.0;
6693                Some(MultiBufferRegion {
6694                    buffer,
6695                    excerpt,
6696                    has_trailing_newline: *has_trailing_newline,
6697                    is_main_buffer: false,
6698                    diff_hunk_status: Some(DiffHunkStatus::deleted(
6699                        hunk_info.hunk_secondary_status,
6700                    )),
6701                    buffer_range: buffer_start..buffer_end,
6702                    range: start..end,
6703                })
6704            }
6705            DiffTransform::BufferContent {
6706                inserted_hunk_info, ..
6707            } => {
6708                let buffer = &excerpt.buffer;
6709                let buffer_context_start = excerpt.range.context.start.summary::<D>(buffer);
6710
6711                let mut start = self.diff_transforms.start().output_dimension.0;
6712                let mut buffer_start = buffer_context_start;
6713                if self.diff_transforms.start().excerpt_dimension < *self.excerpts.start() {
6714                    let overshoot =
6715                        self.excerpts.start().0 - self.diff_transforms.start().excerpt_dimension.0;
6716                    start.add_assign(&overshoot);
6717                } else {
6718                    let overshoot =
6719                        self.diff_transforms.start().excerpt_dimension.0 - self.excerpts.start().0;
6720                    buffer_start.add_assign(&overshoot);
6721                }
6722
6723                let mut end;
6724                let mut buffer_end;
6725                let has_trailing_newline;
6726                if self.diff_transforms.end().excerpt_dimension.0 < self.excerpts.end().0 {
6727                    let overshoot =
6728                        self.diff_transforms.end().excerpt_dimension.0 - self.excerpts.start().0;
6729                    end = self.diff_transforms.end().output_dimension.0;
6730                    buffer_end = buffer_context_start;
6731                    buffer_end.add_assign(&overshoot);
6732                    has_trailing_newline = false;
6733                } else {
6734                    let overshoot =
6735                        self.excerpts.end().0 - self.diff_transforms.start().excerpt_dimension.0;
6736                    end = self.diff_transforms.start().output_dimension.0;
6737                    end.add_assign(&overshoot);
6738                    buffer_end = excerpt.range.context.end.summary::<D>(buffer);
6739                    has_trailing_newline = excerpt.has_trailing_newline;
6740                };
6741
6742                Some(MultiBufferRegion {
6743                    buffer,
6744                    excerpt,
6745                    has_trailing_newline,
6746                    is_main_buffer: true,
6747                    diff_hunk_status: inserted_hunk_info
6748                        .map(|info| DiffHunkStatus::added(info.hunk_secondary_status)),
6749                    buffer_range: buffer_start..buffer_end,
6750                    range: start..end,
6751                })
6752            }
6753        }
6754    }
6755
6756    fn excerpt(&self) -> Option<&'a Excerpt> {
6757        self.excerpts.item()
6758    }
6759}
6760
6761impl History {
6762    fn start_transaction(&mut self, now: Instant) -> Option<TransactionId> {
6763        self.transaction_depth += 1;
6764        if self.transaction_depth == 1 {
6765            let id = self.next_transaction_id.tick();
6766            self.undo_stack.push(Transaction {
6767                id,
6768                buffer_transactions: Default::default(),
6769                first_edit_at: now,
6770                last_edit_at: now,
6771                suppress_grouping: false,
6772            });
6773            Some(id)
6774        } else {
6775            None
6776        }
6777    }
6778
6779    fn end_transaction(
6780        &mut self,
6781        now: Instant,
6782        buffer_transactions: HashMap<BufferId, TransactionId>,
6783    ) -> bool {
6784        assert_ne!(self.transaction_depth, 0);
6785        self.transaction_depth -= 1;
6786        if self.transaction_depth == 0 {
6787            if buffer_transactions.is_empty() {
6788                self.undo_stack.pop();
6789                false
6790            } else {
6791                self.redo_stack.clear();
6792                let transaction = self.undo_stack.last_mut().unwrap();
6793                transaction.last_edit_at = now;
6794                for (buffer_id, transaction_id) in buffer_transactions {
6795                    transaction
6796                        .buffer_transactions
6797                        .entry(buffer_id)
6798                        .or_insert(transaction_id);
6799                }
6800                true
6801            }
6802        } else {
6803            false
6804        }
6805    }
6806
6807    fn push_transaction<'a, T>(
6808        &mut self,
6809        buffer_transactions: T,
6810        now: Instant,
6811        cx: &Context<MultiBuffer>,
6812    ) where
6813        T: IntoIterator<Item = (&'a Entity<Buffer>, &'a language::Transaction)>,
6814    {
6815        assert_eq!(self.transaction_depth, 0);
6816        let transaction = Transaction {
6817            id: self.next_transaction_id.tick(),
6818            buffer_transactions: buffer_transactions
6819                .into_iter()
6820                .map(|(buffer, transaction)| (buffer.read(cx).remote_id(), transaction.id))
6821                .collect(),
6822            first_edit_at: now,
6823            last_edit_at: now,
6824            suppress_grouping: false,
6825        };
6826        if !transaction.buffer_transactions.is_empty() {
6827            self.undo_stack.push(transaction);
6828            self.redo_stack.clear();
6829        }
6830    }
6831
6832    fn finalize_last_transaction(&mut self) {
6833        if let Some(transaction) = self.undo_stack.last_mut() {
6834            transaction.suppress_grouping = true;
6835        }
6836    }
6837
6838    fn forget(&mut self, transaction_id: TransactionId) -> Option<Transaction> {
6839        if let Some(ix) = self
6840            .undo_stack
6841            .iter()
6842            .rposition(|transaction| transaction.id == transaction_id)
6843        {
6844            Some(self.undo_stack.remove(ix))
6845        } else if let Some(ix) = self
6846            .redo_stack
6847            .iter()
6848            .rposition(|transaction| transaction.id == transaction_id)
6849        {
6850            Some(self.redo_stack.remove(ix))
6851        } else {
6852            None
6853        }
6854    }
6855
6856    fn transaction(&self, transaction_id: TransactionId) -> Option<&Transaction> {
6857        self.undo_stack
6858            .iter()
6859            .find(|transaction| transaction.id == transaction_id)
6860            .or_else(|| {
6861                self.redo_stack
6862                    .iter()
6863                    .find(|transaction| transaction.id == transaction_id)
6864            })
6865    }
6866
6867    fn transaction_mut(&mut self, transaction_id: TransactionId) -> Option<&mut Transaction> {
6868        self.undo_stack
6869            .iter_mut()
6870            .find(|transaction| transaction.id == transaction_id)
6871            .or_else(|| {
6872                self.redo_stack
6873                    .iter_mut()
6874                    .find(|transaction| transaction.id == transaction_id)
6875            })
6876    }
6877
6878    fn pop_undo(&mut self) -> Option<&mut Transaction> {
6879        assert_eq!(self.transaction_depth, 0);
6880        if let Some(transaction) = self.undo_stack.pop() {
6881            self.redo_stack.push(transaction);
6882            self.redo_stack.last_mut()
6883        } else {
6884            None
6885        }
6886    }
6887
6888    fn pop_redo(&mut self) -> Option<&mut Transaction> {
6889        assert_eq!(self.transaction_depth, 0);
6890        if let Some(transaction) = self.redo_stack.pop() {
6891            self.undo_stack.push(transaction);
6892            self.undo_stack.last_mut()
6893        } else {
6894            None
6895        }
6896    }
6897
6898    fn remove_from_undo(&mut self, transaction_id: TransactionId) -> Option<&Transaction> {
6899        let ix = self
6900            .undo_stack
6901            .iter()
6902            .rposition(|transaction| transaction.id == transaction_id)?;
6903        let transaction = self.undo_stack.remove(ix);
6904        self.redo_stack.push(transaction);
6905        self.redo_stack.last()
6906    }
6907
6908    fn group(&mut self) -> Option<TransactionId> {
6909        let mut count = 0;
6910        let mut transactions = self.undo_stack.iter();
6911        if let Some(mut transaction) = transactions.next_back() {
6912            while let Some(prev_transaction) = transactions.next_back() {
6913                if !prev_transaction.suppress_grouping
6914                    && transaction.first_edit_at - prev_transaction.last_edit_at
6915                        <= self.group_interval
6916                {
6917                    transaction = prev_transaction;
6918                    count += 1;
6919                } else {
6920                    break;
6921                }
6922            }
6923        }
6924        self.group_trailing(count)
6925    }
6926
6927    fn group_until(&mut self, transaction_id: TransactionId) {
6928        let mut count = 0;
6929        for transaction in self.undo_stack.iter().rev() {
6930            if transaction.id == transaction_id {
6931                self.group_trailing(count);
6932                break;
6933            } else if transaction.suppress_grouping {
6934                break;
6935            } else {
6936                count += 1;
6937            }
6938        }
6939    }
6940
6941    fn group_trailing(&mut self, n: usize) -> Option<TransactionId> {
6942        let new_len = self.undo_stack.len() - n;
6943        let (transactions_to_keep, transactions_to_merge) = self.undo_stack.split_at_mut(new_len);
6944        if let Some(last_transaction) = transactions_to_keep.last_mut() {
6945            if let Some(transaction) = transactions_to_merge.last() {
6946                last_transaction.last_edit_at = transaction.last_edit_at;
6947            }
6948            for to_merge in transactions_to_merge {
6949                for (buffer_id, transaction_id) in &to_merge.buffer_transactions {
6950                    last_transaction
6951                        .buffer_transactions
6952                        .entry(*buffer_id)
6953                        .or_insert(*transaction_id);
6954                }
6955            }
6956        }
6957
6958        self.undo_stack.truncate(new_len);
6959        self.undo_stack.last().map(|t| t.id)
6960    }
6961}
6962
6963impl Excerpt {
6964    fn new(
6965        id: ExcerptId,
6966        locator: Locator,
6967        buffer_id: BufferId,
6968        buffer: BufferSnapshot,
6969        range: ExcerptRange<text::Anchor>,
6970        has_trailing_newline: bool,
6971    ) -> Self {
6972        Excerpt {
6973            id,
6974            locator,
6975            max_buffer_row: range.context.end.to_point(&buffer).row,
6976            text_summary: buffer
6977                .text_summary_for_range::<TextSummary, _>(range.context.to_offset(&buffer)),
6978            buffer_id,
6979            buffer,
6980            range,
6981            has_trailing_newline,
6982        }
6983    }
6984
6985    fn chunks_in_range(&self, range: Range<usize>, language_aware: bool) -> ExcerptChunks<'_> {
6986        let content_start = self.range.context.start.to_offset(&self.buffer);
6987        let chunks_start = content_start + range.start;
6988        let chunks_end = content_start + cmp::min(range.end, self.text_summary.len);
6989
6990        let footer_height = if self.has_trailing_newline
6991            && range.start <= self.text_summary.len
6992            && range.end > self.text_summary.len
6993        {
6994            1
6995        } else {
6996            0
6997        };
6998
6999        let content_chunks = self.buffer.chunks(chunks_start..chunks_end, language_aware);
7000
7001        ExcerptChunks {
7002            excerpt_id: self.id,
7003            content_chunks,
7004            footer_height,
7005        }
7006    }
7007
7008    fn seek_chunks(&self, excerpt_chunks: &mut ExcerptChunks, range: Range<usize>) {
7009        let content_start = self.range.context.start.to_offset(&self.buffer);
7010        let chunks_start = content_start + range.start;
7011        let chunks_end = content_start + cmp::min(range.end, self.text_summary.len);
7012        excerpt_chunks.content_chunks.seek(chunks_start..chunks_end);
7013        excerpt_chunks.footer_height = if self.has_trailing_newline
7014            && range.start <= self.text_summary.len
7015            && range.end > self.text_summary.len
7016        {
7017            1
7018        } else {
7019            0
7020        };
7021    }
7022
7023    fn clip_anchor(&self, text_anchor: text::Anchor) -> text::Anchor {
7024        if text_anchor
7025            .cmp(&self.range.context.start, &self.buffer)
7026            .is_lt()
7027        {
7028            self.range.context.start
7029        } else if text_anchor
7030            .cmp(&self.range.context.end, &self.buffer)
7031            .is_gt()
7032        {
7033            self.range.context.end
7034        } else {
7035            text_anchor
7036        }
7037    }
7038
7039    fn contains(&self, anchor: &Anchor) -> bool {
7040        (anchor.buffer_id == None || anchor.buffer_id == Some(self.buffer_id))
7041            && self
7042                .range
7043                .context
7044                .start
7045                .cmp(&anchor.text_anchor, &self.buffer)
7046                .is_le()
7047            && self
7048                .range
7049                .context
7050                .end
7051                .cmp(&anchor.text_anchor, &self.buffer)
7052                .is_ge()
7053    }
7054
7055    /// The [`Excerpt`]'s start offset in its [`Buffer`]
7056    fn buffer_start_offset(&self) -> usize {
7057        self.range.context.start.to_offset(&self.buffer)
7058    }
7059
7060    /// The [`Excerpt`]'s end offset in its [`Buffer`]
7061    fn buffer_end_offset(&self) -> usize {
7062        self.buffer_start_offset() + self.text_summary.len
7063    }
7064}
7065
7066impl<'a> MultiBufferExcerpt<'a> {
7067    pub fn id(&self) -> ExcerptId {
7068        self.excerpt.id
7069    }
7070
7071    pub fn buffer_id(&self) -> BufferId {
7072        self.excerpt.buffer_id
7073    }
7074
7075    pub fn start_anchor(&self) -> Anchor {
7076        Anchor::in_buffer(
7077            self.excerpt.id,
7078            self.excerpt.buffer_id,
7079            self.excerpt.range.context.start,
7080        )
7081    }
7082
7083    pub fn end_anchor(&self) -> Anchor {
7084        Anchor::in_buffer(
7085            self.excerpt.id,
7086            self.excerpt.buffer_id,
7087            self.excerpt.range.context.end,
7088        )
7089    }
7090
7091    pub fn buffer(&self) -> &'a BufferSnapshot {
7092        &self.excerpt.buffer
7093    }
7094
7095    pub fn buffer_range(&self) -> Range<usize> {
7096        self.buffer_offset
7097            ..self
7098                .excerpt
7099                .range
7100                .context
7101                .end
7102                .to_offset(&self.excerpt.buffer.text)
7103    }
7104
7105    pub fn start_offset(&self) -> usize {
7106        self.offset
7107    }
7108
7109    /// Maps an offset within the [`MultiBuffer`] to an offset within the [`Buffer`]
7110    pub fn map_offset_to_buffer(&mut self, offset: usize) -> usize {
7111        self.map_range_to_buffer(offset..offset).start
7112    }
7113
7114    /// Maps a range within the [`MultiBuffer`] to a range within the [`Buffer`]
7115    pub fn map_range_to_buffer(&mut self, range: Range<usize>) -> Range<usize> {
7116        self.diff_transforms
7117            .seek(&OutputDimension(range.start), Bias::Right);
7118        let start = self.map_offset_to_buffer_internal(range.start);
7119        let end = if range.end > range.start {
7120            self.diff_transforms
7121                .seek_forward(&OutputDimension(range.end), Bias::Right);
7122            self.map_offset_to_buffer_internal(range.end)
7123        } else {
7124            start
7125        };
7126        start..end
7127    }
7128
7129    fn map_offset_to_buffer_internal(&self, offset: usize) -> usize {
7130        let mut excerpt_offset = self.diff_transforms.start().excerpt_dimension.clone();
7131        if let Some(DiffTransform::BufferContent { .. }) = self.diff_transforms.item() {
7132            excerpt_offset.0 += offset - self.diff_transforms.start().output_dimension.0;
7133        };
7134        let offset_in_excerpt = excerpt_offset.0.saturating_sub(self.excerpt_offset.0);
7135        self.buffer_offset + offset_in_excerpt
7136    }
7137
7138    /// Map an offset within the [`Buffer`] to an offset within the [`MultiBuffer`]
7139    pub fn map_offset_from_buffer(&mut self, buffer_offset: usize) -> usize {
7140        self.map_range_from_buffer(buffer_offset..buffer_offset)
7141            .start
7142    }
7143
7144    /// Map a range within the [`Buffer`] to a range within the [`MultiBuffer`]
7145    pub fn map_range_from_buffer(&mut self, buffer_range: Range<usize>) -> Range<usize> {
7146        if buffer_range.start < self.buffer_offset {
7147            log::warn!(
7148                "Attempting to map a range from a buffer offset that starts before the current buffer offset"
7149            );
7150            return buffer_range;
7151        }
7152        let overshoot = buffer_range.start - self.buffer_offset;
7153        let excerpt_offset = ExcerptDimension(self.excerpt_offset.0 + overshoot);
7154        self.diff_transforms.seek(&excerpt_offset, Bias::Right);
7155        if excerpt_offset.0 < self.diff_transforms.start().excerpt_dimension.0 {
7156            log::warn!(
7157                "Attempting to map a range from a buffer offset that starts before the current buffer offset"
7158            );
7159            return buffer_range;
7160        }
7161        let overshoot = excerpt_offset.0 - self.diff_transforms.start().excerpt_dimension.0;
7162        let start = self.diff_transforms.start().output_dimension.0 + overshoot;
7163
7164        let end = if buffer_range.end > buffer_range.start {
7165            let overshoot = buffer_range.end - self.buffer_offset;
7166            let excerpt_offset = ExcerptDimension(self.excerpt_offset.0 + overshoot);
7167            self.diff_transforms
7168                .seek_forward(&excerpt_offset, Bias::Right);
7169            let overshoot = excerpt_offset.0 - self.diff_transforms.start().excerpt_dimension.0;
7170            self.diff_transforms.start().output_dimension.0 + overshoot
7171        } else {
7172            start
7173        };
7174
7175        start..end
7176    }
7177
7178    /// Returns true if the entirety of the given range is in the buffer's excerpt
7179    pub fn contains_buffer_range(&self, range: Range<usize>) -> bool {
7180        range.start >= self.excerpt.buffer_start_offset()
7181            && range.end <= self.excerpt.buffer_end_offset()
7182    }
7183
7184    pub fn max_buffer_row(&self) -> u32 {
7185        self.excerpt.max_buffer_row
7186    }
7187}
7188
7189impl ExcerptId {
7190    pub fn min() -> Self {
7191        Self(0)
7192    }
7193
7194    pub fn max() -> Self {
7195        Self(u32::MAX)
7196    }
7197
7198    pub fn to_proto(self) -> u64 {
7199        self.0 as _
7200    }
7201
7202    pub fn from_proto(proto: u64) -> Self {
7203        Self(proto as _)
7204    }
7205
7206    pub fn cmp(&self, other: &Self, snapshot: &MultiBufferSnapshot) -> cmp::Ordering {
7207        let a = snapshot.excerpt_locator_for_id(*self);
7208        let b = snapshot.excerpt_locator_for_id(*other);
7209        a.cmp(b).then_with(|| self.0.cmp(&other.0))
7210    }
7211}
7212
7213impl From<ExcerptId> for usize {
7214    fn from(val: ExcerptId) -> Self {
7215        val.0 as usize
7216    }
7217}
7218
7219impl fmt::Debug for Excerpt {
7220    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
7221        f.debug_struct("Excerpt")
7222            .field("id", &self.id)
7223            .field("locator", &self.locator)
7224            .field("buffer_id", &self.buffer_id)
7225            .field("range", &self.range)
7226            .field("text_summary", &self.text_summary)
7227            .field("has_trailing_newline", &self.has_trailing_newline)
7228            .finish()
7229    }
7230}
7231
7232impl sum_tree::Item for Excerpt {
7233    type Summary = ExcerptSummary;
7234
7235    fn summary(&self, _cx: ()) -> Self::Summary {
7236        let mut text = self.text_summary;
7237        if self.has_trailing_newline {
7238            text += TextSummary::from("\n");
7239        }
7240        ExcerptSummary {
7241            excerpt_id: self.id,
7242            excerpt_locator: self.locator.clone(),
7243            widest_line_number: self.max_buffer_row,
7244            text,
7245        }
7246    }
7247}
7248
7249impl sum_tree::Item for ExcerptIdMapping {
7250    type Summary = ExcerptId;
7251
7252    fn summary(&self, _cx: ()) -> Self::Summary {
7253        self.id
7254    }
7255}
7256
7257impl sum_tree::KeyedItem for ExcerptIdMapping {
7258    type Key = ExcerptId;
7259
7260    fn key(&self) -> Self::Key {
7261        self.id
7262    }
7263}
7264
7265impl DiffTransform {
7266    fn hunk_info(&self) -> Option<DiffTransformHunkInfo> {
7267        match self {
7268            DiffTransform::DeletedHunk { hunk_info, .. } => Some(*hunk_info),
7269            DiffTransform::BufferContent {
7270                inserted_hunk_info, ..
7271            } => *inserted_hunk_info,
7272        }
7273    }
7274}
7275
7276impl sum_tree::Item for DiffTransform {
7277    type Summary = DiffTransformSummary;
7278
7279    fn summary(&self, _: <Self::Summary as sum_tree::Summary>::Context<'_>) -> Self::Summary {
7280        match self {
7281            DiffTransform::BufferContent { summary, .. } => DiffTransformSummary {
7282                input: *summary,
7283                output: *summary,
7284            },
7285            DiffTransform::DeletedHunk { summary, .. } => DiffTransformSummary {
7286                input: TextSummary::default(),
7287                output: *summary,
7288            },
7289        }
7290    }
7291}
7292
7293impl DiffTransformSummary {
7294    fn excerpt_len(&self) -> ExcerptOffset {
7295        ExcerptOffset::new(self.input.len)
7296    }
7297}
7298
7299impl sum_tree::ContextLessSummary for DiffTransformSummary {
7300    fn zero() -> Self {
7301        DiffTransformSummary {
7302            input: TextSummary::default(),
7303            output: TextSummary::default(),
7304        }
7305    }
7306
7307    fn add_summary(&mut self, other: &Self) {
7308        self.input += other.input;
7309        self.output += other.output;
7310    }
7311}
7312
7313impl sum_tree::ContextLessSummary for ExcerptId {
7314    fn zero() -> Self {
7315        Self(0)
7316    }
7317
7318    fn add_summary(&mut self, summary: &Self) {
7319        *self = cmp::max(*self, *summary);
7320    }
7321}
7322
7323impl sum_tree::ContextLessSummary for ExcerptSummary {
7324    fn zero() -> Self {
7325        Self::default()
7326    }
7327
7328    fn add_summary(&mut self, summary: &Self) {
7329        debug_assert!(summary.excerpt_locator > self.excerpt_locator);
7330        self.excerpt_locator = summary.excerpt_locator.clone();
7331        Summary::add_summary(&mut self.text, &summary.text, ());
7332        self.widest_line_number = cmp::max(self.widest_line_number, summary.widest_line_number);
7333    }
7334}
7335
7336impl<'a> sum_tree::Dimension<'a, ExcerptSummary> for ExcerptOffset {
7337    fn zero(_cx: ()) -> Self {
7338        Default::default()
7339    }
7340
7341    fn add_summary(&mut self, summary: &'a ExcerptSummary, _: ()) {
7342        self.value += summary.text.len;
7343    }
7344}
7345
7346impl sum_tree::SeekTarget<'_, ExcerptSummary, ExcerptSummary> for ExcerptOffset {
7347    fn cmp(&self, cursor_location: &ExcerptSummary, _: ()) -> cmp::Ordering {
7348        Ord::cmp(&self.value, &cursor_location.text.len)
7349    }
7350}
7351
7352impl<'a> sum_tree::SeekTarget<'a, ExcerptSummary, Option<&'a Locator>> for Locator {
7353    fn cmp(&self, cursor_location: &Option<&'a Locator>, _: ()) -> cmp::Ordering {
7354        Ord::cmp(&Some(self), cursor_location)
7355    }
7356}
7357
7358impl sum_tree::SeekTarget<'_, ExcerptSummary, ExcerptSummary> for Locator {
7359    fn cmp(&self, cursor_location: &ExcerptSummary, _: ()) -> cmp::Ordering {
7360        Ord::cmp(self, &cursor_location.excerpt_locator)
7361    }
7362}
7363
7364impl<'a> sum_tree::Dimension<'a, ExcerptSummary> for ExcerptPoint {
7365    fn zero(_cx: ()) -> Self {
7366        Default::default()
7367    }
7368
7369    fn add_summary(&mut self, summary: &'a ExcerptSummary, _: ()) {
7370        self.value += summary.text.lines;
7371    }
7372}
7373
7374impl<'a, D: TextDimension + Default> sum_tree::Dimension<'a, ExcerptSummary>
7375    for ExcerptDimension<D>
7376{
7377    fn zero(_: ()) -> Self {
7378        ExcerptDimension(D::default())
7379    }
7380
7381    fn add_summary(&mut self, summary: &'a ExcerptSummary, _: ()) {
7382        self.0.add_assign(&D::from_text_summary(&summary.text))
7383    }
7384}
7385
7386impl<'a> sum_tree::Dimension<'a, ExcerptSummary> for Option<&'a Locator> {
7387    fn zero(_cx: ()) -> Self {
7388        Default::default()
7389    }
7390
7391    fn add_summary(&mut self, summary: &'a ExcerptSummary, _: ()) {
7392        *self = Some(&summary.excerpt_locator);
7393    }
7394}
7395
7396impl<'a> sum_tree::Dimension<'a, ExcerptSummary> for Option<ExcerptId> {
7397    fn zero(_cx: ()) -> Self {
7398        Default::default()
7399    }
7400
7401    fn add_summary(&mut self, summary: &'a ExcerptSummary, _: ()) {
7402        *self = Some(summary.excerpt_id);
7403    }
7404}
7405
7406#[derive(Clone, PartialOrd, Ord, Eq, PartialEq, Debug)]
7407struct ExcerptDimension<T>(T);
7408
7409#[derive(Clone, PartialOrd, Ord, Eq, PartialEq, Debug)]
7410struct OutputDimension<T>(T);
7411
7412impl<'a> sum_tree::Dimension<'a, DiffTransformSummary> for ExcerptOffset {
7413    fn zero(_: ()) -> Self {
7414        ExcerptOffset::new(0)
7415    }
7416
7417    fn add_summary(&mut self, summary: &'a DiffTransformSummary, _: ()) {
7418        self.value += summary.input.len;
7419    }
7420}
7421
7422impl<'a> sum_tree::Dimension<'a, DiffTransformSummary> for ExcerptPoint {
7423    fn zero(_: ()) -> Self {
7424        ExcerptPoint::new(0, 0)
7425    }
7426
7427    fn add_summary(&mut self, summary: &'a DiffTransformSummary, _: ()) {
7428        self.value += summary.input.lines;
7429    }
7430}
7431
7432impl<D: TextDimension + Ord> sum_tree::SeekTarget<'_, DiffTransformSummary, DiffTransformSummary>
7433    for ExcerptDimension<D>
7434{
7435    fn cmp(&self, cursor_location: &DiffTransformSummary, _: ()) -> cmp::Ordering {
7436        Ord::cmp(&self.0, &D::from_text_summary(&cursor_location.input))
7437    }
7438}
7439
7440impl<D: TextDimension + Ord> sum_tree::SeekTarget<'_, DiffTransformSummary, DiffTransforms<D>>
7441    for ExcerptDimension<D>
7442{
7443    fn cmp(&self, cursor_location: &DiffTransforms<D>, _: ()) -> cmp::Ordering {
7444        Ord::cmp(&self.0, &cursor_location.excerpt_dimension.0)
7445    }
7446}
7447
7448impl<'a, D: TextDimension> sum_tree::Dimension<'a, DiffTransformSummary> for ExcerptDimension<D> {
7449    fn zero(_: ()) -> Self {
7450        ExcerptDimension(D::default())
7451    }
7452
7453    fn add_summary(&mut self, summary: &'a DiffTransformSummary, _: ()) {
7454        self.0.add_assign(&D::from_text_summary(&summary.input))
7455    }
7456}
7457
7458impl<D: TextDimension + Ord> sum_tree::SeekTarget<'_, DiffTransformSummary, DiffTransforms<D>>
7459    for OutputDimension<D>
7460{
7461    fn cmp(&self, cursor_location: &DiffTransforms<D>, _: ()) -> cmp::Ordering {
7462        Ord::cmp(&self.0, &cursor_location.output_dimension.0)
7463    }
7464}
7465
7466impl<'a, D: TextDimension> sum_tree::Dimension<'a, DiffTransformSummary> for OutputDimension<D> {
7467    fn zero(_: ()) -> Self {
7468        OutputDimension(D::default())
7469    }
7470
7471    fn add_summary(&mut self, summary: &'a DiffTransformSummary, _: ()) {
7472        self.0.add_assign(&D::from_text_summary(&summary.output))
7473    }
7474}
7475
7476impl<'a> sum_tree::Dimension<'a, DiffTransformSummary> for TextSummary {
7477    fn zero(_: ()) -> Self {
7478        TextSummary::default()
7479    }
7480
7481    fn add_summary(&mut self, summary: &'a DiffTransformSummary, _: ()) {
7482        *self += summary.output
7483    }
7484}
7485
7486impl<'a> sum_tree::Dimension<'a, DiffTransformSummary> for usize {
7487    fn zero(_: ()) -> Self {
7488        0
7489    }
7490
7491    fn add_summary(&mut self, summary: &'a DiffTransformSummary, _: ()) {
7492        *self += summary.output.len
7493    }
7494}
7495
7496impl<'a> sum_tree::Dimension<'a, DiffTransformSummary> for Point {
7497    fn zero(_: ()) -> Self {
7498        Point::new(0, 0)
7499    }
7500
7501    fn add_summary(&mut self, summary: &'a DiffTransformSummary, _: ()) {
7502        *self += summary.output.lines
7503    }
7504}
7505
7506impl MultiBufferRows<'_> {
7507    pub fn seek(&mut self, MultiBufferRow(row): MultiBufferRow) {
7508        self.point = Point::new(row, 0);
7509        self.cursor.seek(&self.point);
7510    }
7511}
7512
7513impl Iterator for MultiBufferRows<'_> {
7514    type Item = RowInfo;
7515
7516    fn next(&mut self) -> Option<Self::Item> {
7517        if self.is_empty && self.point.row == 0 {
7518            self.point += Point::new(1, 0);
7519            return Some(RowInfo {
7520                buffer_id: None,
7521                buffer_row: Some(0),
7522                multibuffer_row: Some(MultiBufferRow(0)),
7523                diff_status: None,
7524                expand_info: None,
7525            });
7526        }
7527
7528        let mut region = self.cursor.region()?;
7529        while self.point >= region.range.end {
7530            self.cursor.next();
7531            if let Some(next_region) = self.cursor.region() {
7532                region = next_region;
7533            } else if self.point == self.cursor.diff_transforms.end().output_dimension.0 {
7534                let multibuffer_row = MultiBufferRow(self.point.row);
7535                let last_excerpt = self
7536                    .cursor
7537                    .excerpts
7538                    .item()
7539                    .or(self.cursor.excerpts.prev_item())?;
7540                let last_row = last_excerpt
7541                    .range
7542                    .context
7543                    .end
7544                    .to_point(&last_excerpt.buffer)
7545                    .row;
7546
7547                let first_row = last_excerpt
7548                    .range
7549                    .context
7550                    .start
7551                    .to_point(&last_excerpt.buffer)
7552                    .row;
7553
7554                let expand_info = if self.is_singleton {
7555                    None
7556                } else {
7557                    let needs_expand_up = first_row == last_row
7558                        && last_row > 0
7559                        && !region.diff_hunk_status.is_some_and(|d| d.is_deleted());
7560                    let needs_expand_down = last_row < last_excerpt.buffer.max_point().row;
7561
7562                    if needs_expand_up && needs_expand_down {
7563                        Some(ExpandExcerptDirection::UpAndDown)
7564                    } else if needs_expand_up {
7565                        Some(ExpandExcerptDirection::Up)
7566                    } else if needs_expand_down {
7567                        Some(ExpandExcerptDirection::Down)
7568                    } else {
7569                        None
7570                    }
7571                    .map(|direction| ExpandInfo {
7572                        direction,
7573                        excerpt_id: last_excerpt.id,
7574                    })
7575                };
7576                self.point += Point::new(1, 0);
7577                return Some(RowInfo {
7578                    buffer_id: Some(last_excerpt.buffer_id),
7579                    buffer_row: Some(last_row),
7580                    multibuffer_row: Some(multibuffer_row),
7581                    diff_status: None,
7582                    expand_info,
7583                });
7584            } else {
7585                return None;
7586            };
7587        }
7588
7589        let overshoot = self.point - region.range.start;
7590        let buffer_point = region.buffer_range.start + overshoot;
7591        let expand_info = if self.is_singleton {
7592            None
7593        } else {
7594            let needs_expand_up = self.point.row == region.range.start.row
7595                && self.cursor.is_at_start_of_excerpt()
7596                && buffer_point.row > 0;
7597            let needs_expand_down = (region.excerpt.has_trailing_newline
7598                && self.point.row + 1 == region.range.end.row
7599                || !region.excerpt.has_trailing_newline && self.point.row == region.range.end.row)
7600                && self.cursor.is_at_end_of_excerpt()
7601                && buffer_point.row < region.buffer.max_point().row;
7602
7603            if needs_expand_up && needs_expand_down {
7604                Some(ExpandExcerptDirection::UpAndDown)
7605            } else if needs_expand_up {
7606                Some(ExpandExcerptDirection::Up)
7607            } else if needs_expand_down {
7608                Some(ExpandExcerptDirection::Down)
7609            } else {
7610                None
7611            }
7612            .map(|direction| ExpandInfo {
7613                direction,
7614                excerpt_id: region.excerpt.id,
7615            })
7616        };
7617
7618        let result = Some(RowInfo {
7619            buffer_id: Some(region.buffer.remote_id()),
7620            buffer_row: Some(buffer_point.row),
7621            multibuffer_row: Some(MultiBufferRow(self.point.row)),
7622            diff_status: region
7623                .diff_hunk_status
7624                .filter(|_| self.point < region.range.end),
7625            expand_info,
7626        });
7627        self.point += Point::new(1, 0);
7628        result
7629    }
7630}
7631
7632impl<'a> MultiBufferChunks<'a> {
7633    pub fn offset(&self) -> usize {
7634        self.range.start
7635    }
7636
7637    pub fn seek(&mut self, range: Range<usize>) {
7638        self.diff_transforms.seek(&range.end, Bias::Right);
7639        let mut excerpt_end = self.diff_transforms.start().1;
7640        if let Some(DiffTransform::BufferContent { .. }) = self.diff_transforms.item() {
7641            let overshoot = range.end - self.diff_transforms.start().0;
7642            excerpt_end.value += overshoot;
7643        }
7644
7645        self.diff_transforms.seek(&range.start, Bias::Right);
7646        let mut excerpt_start = self.diff_transforms.start().1;
7647        if let Some(DiffTransform::BufferContent { .. }) = self.diff_transforms.item() {
7648            let overshoot = range.start - self.diff_transforms.start().0;
7649            excerpt_start.value += overshoot;
7650        }
7651
7652        self.seek_to_excerpt_offset_range(excerpt_start..excerpt_end);
7653        self.buffer_chunk.take();
7654        self.range = range;
7655    }
7656
7657    fn seek_to_excerpt_offset_range(&mut self, new_range: Range<ExcerptOffset>) {
7658        self.excerpt_offset_range = new_range.clone();
7659        self.excerpts.seek(&new_range.start, Bias::Right);
7660        if let Some(excerpt) = self.excerpts.item() {
7661            let excerpt_start = *self.excerpts.start();
7662            if let Some(excerpt_chunks) = self
7663                .excerpt_chunks
7664                .as_mut()
7665                .filter(|chunks| excerpt.id == chunks.excerpt_id)
7666            {
7667                excerpt.seek_chunks(
7668                    excerpt_chunks,
7669                    (self.excerpt_offset_range.start - excerpt_start).value
7670                        ..(self.excerpt_offset_range.end - excerpt_start).value,
7671                );
7672            } else {
7673                self.excerpt_chunks = Some(excerpt.chunks_in_range(
7674                    (self.excerpt_offset_range.start - excerpt_start).value
7675                        ..(self.excerpt_offset_range.end - excerpt_start).value,
7676                    self.language_aware,
7677                ));
7678            }
7679        } else {
7680            self.excerpt_chunks = None;
7681        }
7682    }
7683
7684    fn next_excerpt_chunk(&mut self) -> Option<Chunk<'a>> {
7685        loop {
7686            if self.excerpt_offset_range.is_empty() {
7687                return None;
7688            } else if let Some(chunk) = self.excerpt_chunks.as_mut()?.next() {
7689                self.excerpt_offset_range.start.value += chunk.text.len();
7690                return Some(chunk);
7691            } else {
7692                self.excerpts.next();
7693                let excerpt = self.excerpts.item()?;
7694                self.excerpt_chunks = Some(excerpt.chunks_in_range(
7695                    0..(self.excerpt_offset_range.end - *self.excerpts.start()).value,
7696                    self.language_aware,
7697                ));
7698            }
7699        }
7700    }
7701}
7702
7703impl<'a> Iterator for ReversedMultiBufferChunks<'a> {
7704    type Item = &'a str;
7705
7706    fn next(&mut self) -> Option<Self::Item> {
7707        let mut region = self.cursor.region()?;
7708        if self.offset == region.range.start {
7709            self.cursor.prev();
7710            region = self.cursor.region()?;
7711            let start_overshoot = self.start.saturating_sub(region.range.start);
7712            self.current_chunks = Some(region.buffer.reversed_chunks_in_range(
7713                region.buffer_range.start + start_overshoot..region.buffer_range.end,
7714            ));
7715        }
7716
7717        if self.offset == region.range.end && region.has_trailing_newline {
7718            self.offset -= 1;
7719            Some("\n")
7720        } else {
7721            let chunk = self.current_chunks.as_mut().unwrap().next()?;
7722            self.offset -= chunk.len();
7723            Some(chunk)
7724        }
7725    }
7726}
7727
7728impl<'a> Iterator for MultiBufferChunks<'a> {
7729    type Item = Chunk<'a>;
7730
7731    fn next(&mut self) -> Option<Chunk<'a>> {
7732        if self.range.start >= self.range.end {
7733            return None;
7734        }
7735        if self.range.start == self.diff_transforms.end().0 {
7736            self.diff_transforms.next();
7737        }
7738
7739        let diff_transform_start = self.diff_transforms.start().0;
7740        let diff_transform_end = self.diff_transforms.end().0;
7741        debug_assert!(self.range.start < diff_transform_end);
7742
7743        let diff_transform = self.diff_transforms.item()?;
7744        match diff_transform {
7745            DiffTransform::BufferContent { .. } => {
7746                let chunk = if let Some(chunk) = &mut self.buffer_chunk {
7747                    chunk
7748                } else {
7749                    let chunk = self.next_excerpt_chunk().unwrap();
7750                    self.buffer_chunk.insert(chunk)
7751                };
7752
7753                let chunk_end = self.range.start + chunk.text.len();
7754                let diff_transform_end = diff_transform_end.min(self.range.end);
7755
7756                if diff_transform_end < chunk_end {
7757                    let split_idx = diff_transform_end - self.range.start;
7758                    let (before, after) = chunk.text.split_at(split_idx);
7759                    self.range.start = diff_transform_end;
7760                    let mask = (1 << split_idx) - 1;
7761                    let chars = chunk.chars & mask;
7762                    let tabs = chunk.tabs & mask;
7763
7764                    chunk.text = after;
7765                    chunk.chars = chunk.chars >> split_idx;
7766                    chunk.tabs = chunk.tabs >> split_idx;
7767
7768                    Some(Chunk {
7769                        text: before,
7770                        chars,
7771                        tabs,
7772                        ..chunk.clone()
7773                    })
7774                } else {
7775                    self.range.start = chunk_end;
7776                    self.buffer_chunk.take()
7777                }
7778            }
7779            DiffTransform::DeletedHunk {
7780                buffer_id,
7781                base_text_byte_range,
7782                has_trailing_newline,
7783                ..
7784            } => {
7785                let base_text_start =
7786                    base_text_byte_range.start + self.range.start - diff_transform_start;
7787                let base_text_end =
7788                    base_text_byte_range.start + self.range.end - diff_transform_start;
7789                let base_text_end = base_text_end.min(base_text_byte_range.end);
7790
7791                let mut chunks = if let Some((_, mut chunks)) = self
7792                    .diff_base_chunks
7793                    .take()
7794                    .filter(|(id, _)| id == buffer_id)
7795                {
7796                    if chunks.range().start != base_text_start || chunks.range().end < base_text_end
7797                    {
7798                        chunks.seek(base_text_start..base_text_end);
7799                    }
7800                    chunks
7801                } else {
7802                    let base_buffer = &self.diffs.get(buffer_id)?.base_text();
7803                    base_buffer.chunks(base_text_start..base_text_end, self.language_aware)
7804                };
7805
7806                let chunk = if let Some(chunk) = chunks.next() {
7807                    self.range.start += chunk.text.len();
7808                    self.diff_base_chunks = Some((*buffer_id, chunks));
7809                    chunk
7810                } else {
7811                    debug_assert!(has_trailing_newline);
7812                    self.range.start += "\n".len();
7813                    Chunk {
7814                        text: "\n",
7815                        chars: 1u128,
7816                        ..Default::default()
7817                    }
7818                };
7819                Some(chunk)
7820            }
7821        }
7822    }
7823}
7824
7825impl MultiBufferBytes<'_> {
7826    fn consume(&mut self, len: usize) {
7827        self.range.start += len;
7828        self.chunk = &self.chunk[len..];
7829
7830        if !self.range.is_empty() && self.chunk.is_empty() {
7831            if let Some(chunk) = self.excerpt_bytes.as_mut().and_then(|bytes| bytes.next()) {
7832                self.chunk = chunk;
7833            } else if self.has_trailing_newline {
7834                self.has_trailing_newline = false;
7835                self.chunk = b"\n";
7836            } else {
7837                self.cursor.next();
7838                if let Some(region) = self.cursor.region() {
7839                    let mut excerpt_bytes = region.buffer.bytes_in_range(
7840                        region.buffer_range.start
7841                            ..(region.buffer_range.start + self.range.end - region.range.start)
7842                                .min(region.buffer_range.end),
7843                    );
7844                    self.chunk = excerpt_bytes.next().unwrap_or(&[]);
7845                    self.excerpt_bytes = Some(excerpt_bytes);
7846                    self.has_trailing_newline =
7847                        region.has_trailing_newline && self.range.end >= region.range.end;
7848                    if self.chunk.is_empty() && self.has_trailing_newline {
7849                        self.has_trailing_newline = false;
7850                        self.chunk = b"\n";
7851                    }
7852                }
7853            }
7854        }
7855    }
7856}
7857
7858impl<'a> Iterator for MultiBufferBytes<'a> {
7859    type Item = &'a [u8];
7860
7861    fn next(&mut self) -> Option<Self::Item> {
7862        let chunk = self.chunk;
7863        if chunk.is_empty() {
7864            None
7865        } else {
7866            self.consume(chunk.len());
7867            Some(chunk)
7868        }
7869    }
7870}
7871
7872impl io::Read for MultiBufferBytes<'_> {
7873    fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
7874        let len = cmp::min(buf.len(), self.chunk.len());
7875        buf[..len].copy_from_slice(&self.chunk[..len]);
7876        if len > 0 {
7877            self.consume(len);
7878        }
7879        Ok(len)
7880    }
7881}
7882
7883impl io::Read for ReversedMultiBufferBytes<'_> {
7884    fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
7885        let len = cmp::min(buf.len(), self.chunk.len());
7886        buf[..len].copy_from_slice(&self.chunk[..len]);
7887        buf[..len].reverse();
7888        if len > 0 {
7889            self.range.end -= len;
7890            self.chunk = &self.chunk[..self.chunk.len() - len];
7891            if !self.range.is_empty()
7892                && self.chunk.is_empty()
7893                && let Some(chunk) = self.chunks.next()
7894            {
7895                self.chunk = chunk.as_bytes();
7896            }
7897        }
7898        Ok(len)
7899    }
7900}
7901
7902impl<'a> Iterator for ExcerptChunks<'a> {
7903    type Item = Chunk<'a>;
7904
7905    fn next(&mut self) -> Option<Self::Item> {
7906        if let Some(chunk) = self.content_chunks.next() {
7907            return Some(chunk);
7908        }
7909
7910        if self.footer_height > 0 {
7911            let text = unsafe { str::from_utf8_unchecked(&NEWLINES[..self.footer_height]) };
7912            let chars = (1 << self.footer_height) - 1;
7913            self.footer_height = 0;
7914            return Some(Chunk {
7915                text,
7916                chars,
7917                ..Default::default()
7918            });
7919        }
7920
7921        None
7922    }
7923}
7924
7925impl ToOffset for Point {
7926    fn to_offset<'a>(&self, snapshot: &MultiBufferSnapshot) -> usize {
7927        snapshot.point_to_offset(*self)
7928    }
7929}
7930
7931impl ToOffset for usize {
7932    #[track_caller]
7933    fn to_offset<'a>(&self, snapshot: &MultiBufferSnapshot) -> usize {
7934        assert!(
7935            *self <= snapshot.len(),
7936            "offset {} is greater than the snapshot.len() {}",
7937            *self,
7938            snapshot.len(),
7939        );
7940        *self
7941    }
7942}
7943
7944impl ToOffset for OffsetUtf16 {
7945    fn to_offset<'a>(&self, snapshot: &MultiBufferSnapshot) -> usize {
7946        snapshot.offset_utf16_to_offset(*self)
7947    }
7948}
7949
7950impl ToOffset for PointUtf16 {
7951    fn to_offset<'a>(&self, snapshot: &MultiBufferSnapshot) -> usize {
7952        snapshot.point_utf16_to_offset(*self)
7953    }
7954}
7955
7956impl ToOffsetUtf16 for OffsetUtf16 {
7957    fn to_offset_utf16(&self, _snapshot: &MultiBufferSnapshot) -> OffsetUtf16 {
7958        *self
7959    }
7960}
7961
7962impl ToOffsetUtf16 for usize {
7963    fn to_offset_utf16(&self, snapshot: &MultiBufferSnapshot) -> OffsetUtf16 {
7964        snapshot.offset_to_offset_utf16(*self)
7965    }
7966}
7967
7968impl ToPoint for usize {
7969    fn to_point<'a>(&self, snapshot: &MultiBufferSnapshot) -> Point {
7970        snapshot.offset_to_point(*self)
7971    }
7972}
7973
7974impl ToPoint for Point {
7975    fn to_point<'a>(&self, _: &MultiBufferSnapshot) -> Point {
7976        *self
7977    }
7978}
7979
7980impl ToPointUtf16 for usize {
7981    fn to_point_utf16<'a>(&self, snapshot: &MultiBufferSnapshot) -> PointUtf16 {
7982        snapshot.offset_to_point_utf16(*self)
7983    }
7984}
7985
7986impl ToPointUtf16 for Point {
7987    fn to_point_utf16<'a>(&self, snapshot: &MultiBufferSnapshot) -> PointUtf16 {
7988        snapshot.point_to_point_utf16(*self)
7989    }
7990}
7991
7992impl ToPointUtf16 for PointUtf16 {
7993    fn to_point_utf16<'a>(&self, _: &MultiBufferSnapshot) -> PointUtf16 {
7994        *self
7995    }
7996}
7997
7998impl From<ExcerptId> for EntityId {
7999    fn from(id: ExcerptId) -> Self {
8000        EntityId::from(id.0 as u64)
8001    }
8002}
8003
8004#[cfg(debug_assertions)]
8005pub mod debug {
8006    use super::*;
8007
8008    pub trait ToMultiBufferDebugRanges {
8009        fn to_multi_buffer_debug_ranges(&self, snapshot: &MultiBufferSnapshot)
8010        -> Vec<Range<usize>>;
8011    }
8012
8013    impl<T: ToOffset> ToMultiBufferDebugRanges for T {
8014        fn to_multi_buffer_debug_ranges(
8015            &self,
8016            snapshot: &MultiBufferSnapshot,
8017        ) -> Vec<Range<usize>> {
8018            [self.to_offset(snapshot)].to_multi_buffer_debug_ranges(snapshot)
8019        }
8020    }
8021
8022    impl<T: ToOffset> ToMultiBufferDebugRanges for Range<T> {
8023        fn to_multi_buffer_debug_ranges(
8024            &self,
8025            snapshot: &MultiBufferSnapshot,
8026        ) -> Vec<Range<usize>> {
8027            [self.start.to_offset(snapshot)..self.end.to_offset(snapshot)]
8028                .to_multi_buffer_debug_ranges(snapshot)
8029        }
8030    }
8031
8032    impl<T: ToOffset> ToMultiBufferDebugRanges for Vec<T> {
8033        fn to_multi_buffer_debug_ranges(
8034            &self,
8035            snapshot: &MultiBufferSnapshot,
8036        ) -> Vec<Range<usize>> {
8037            self.as_slice().to_multi_buffer_debug_ranges(snapshot)
8038        }
8039    }
8040
8041    impl<T: ToOffset> ToMultiBufferDebugRanges for Vec<Range<T>> {
8042        fn to_multi_buffer_debug_ranges(
8043            &self,
8044            snapshot: &MultiBufferSnapshot,
8045        ) -> Vec<Range<usize>> {
8046            self.as_slice().to_multi_buffer_debug_ranges(snapshot)
8047        }
8048    }
8049
8050    impl<T: ToOffset> ToMultiBufferDebugRanges for [T] {
8051        fn to_multi_buffer_debug_ranges(
8052            &self,
8053            snapshot: &MultiBufferSnapshot,
8054        ) -> Vec<Range<usize>> {
8055            self.iter()
8056                .map(|item| {
8057                    let offset = item.to_offset(snapshot);
8058                    offset..offset
8059                })
8060                .collect()
8061        }
8062    }
8063
8064    impl<T: ToOffset> ToMultiBufferDebugRanges for [Range<T>] {
8065        fn to_multi_buffer_debug_ranges(
8066            &self,
8067            snapshot: &MultiBufferSnapshot,
8068        ) -> Vec<Range<usize>> {
8069            self.iter()
8070                .map(|range| range.start.to_offset(snapshot)..range.end.to_offset(snapshot))
8071                .collect()
8072        }
8073    }
8074}