multi_buffer.rs

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