multi_buffer.rs

   1mod anchor;
   2
   3pub use anchor::{Anchor, AnchorRangeExt};
   4use anyhow::Result;
   5use clock::ReplicaId;
   6use collections::{HashMap, HashSet};
   7use gpui::{AppContext, Entity, ModelContext, ModelHandle, Task};
   8pub use language::Completion;
   9use language::{
  10    Buffer, BufferChunks, BufferSnapshot, Chunk, DiagnosticEntry, Event, File, Language, Outline,
  11    OutlineItem, Selection, ToOffset as _, ToPoint as _, TransactionId,
  12};
  13use std::{
  14    cell::{Ref, RefCell},
  15    cmp, fmt, io,
  16    iter::{self, FromIterator},
  17    ops::{Range, Sub},
  18    str,
  19    sync::Arc,
  20    time::{Duration, Instant},
  21};
  22use sum_tree::{Bias, Cursor, SumTree};
  23use text::{
  24    locator::Locator,
  25    rope::TextDimension,
  26    subscription::{Subscription, Topic},
  27    AnchorRangeExt as _, Edit, Point, PointUtf16, TextSummary,
  28};
  29use theme::SyntaxTheme;
  30use util::post_inc;
  31
  32const NEWLINES: &'static [u8] = &[b'\n'; u8::MAX as usize];
  33
  34pub type ExcerptId = Locator;
  35
  36pub struct MultiBuffer {
  37    snapshot: RefCell<MultiBufferSnapshot>,
  38    buffers: RefCell<HashMap<usize, BufferState>>,
  39    subscriptions: Topic,
  40    singleton: bool,
  41    replica_id: ReplicaId,
  42    history: History,
  43}
  44
  45struct History {
  46    next_transaction_id: usize,
  47    undo_stack: Vec<Transaction>,
  48    redo_stack: Vec<Transaction>,
  49    transaction_depth: usize,
  50    group_interval: Duration,
  51}
  52
  53struct Transaction {
  54    id: usize,
  55    buffer_transactions: HashSet<(usize, text::TransactionId)>,
  56    first_edit_at: Instant,
  57    last_edit_at: Instant,
  58}
  59
  60pub trait ToOffset: 'static + fmt::Debug {
  61    fn to_offset(&self, snapshot: &MultiBufferSnapshot) -> usize;
  62}
  63
  64pub trait ToPoint: 'static + fmt::Debug {
  65    fn to_point(&self, snapshot: &MultiBufferSnapshot) -> Point;
  66}
  67
  68struct BufferState {
  69    buffer: ModelHandle<Buffer>,
  70    last_version: clock::Global,
  71    last_parse_count: usize,
  72    last_selections_update_count: usize,
  73    last_diagnostics_update_count: usize,
  74    excerpts: Vec<ExcerptId>,
  75    _subscriptions: [gpui::Subscription; 2],
  76}
  77
  78#[derive(Clone, Default)]
  79pub struct MultiBufferSnapshot {
  80    singleton: bool,
  81    excerpts: SumTree<Excerpt>,
  82    parse_count: usize,
  83    diagnostics_update_count: usize,
  84    is_dirty: bool,
  85    has_conflict: bool,
  86}
  87
  88pub struct ExcerptProperties<'a, T> {
  89    pub buffer: &'a ModelHandle<Buffer>,
  90    pub range: Range<T>,
  91}
  92
  93#[derive(Clone)]
  94struct Excerpt {
  95    id: ExcerptId,
  96    buffer_id: usize,
  97    buffer: BufferSnapshot,
  98    range: Range<text::Anchor>,
  99    max_buffer_row: u32,
 100    text_summary: TextSummary,
 101    has_trailing_newline: bool,
 102}
 103
 104#[derive(Clone, Debug, Default)]
 105struct ExcerptSummary {
 106    excerpt_id: ExcerptId,
 107    max_buffer_row: u32,
 108    text: TextSummary,
 109}
 110
 111pub struct MultiBufferRows<'a> {
 112    buffer_row_range: Range<u32>,
 113    excerpts: Cursor<'a, Excerpt, Point>,
 114}
 115
 116pub struct MultiBufferChunks<'a> {
 117    range: Range<usize>,
 118    excerpts: Cursor<'a, Excerpt, usize>,
 119    excerpt_chunks: Option<ExcerptChunks<'a>>,
 120    theme: Option<&'a SyntaxTheme>,
 121}
 122
 123pub struct MultiBufferBytes<'a> {
 124    range: Range<usize>,
 125    excerpts: Cursor<'a, Excerpt, usize>,
 126    excerpt_bytes: Option<ExcerptBytes<'a>>,
 127    chunk: &'a [u8],
 128}
 129
 130struct ExcerptChunks<'a> {
 131    content_chunks: BufferChunks<'a>,
 132    footer_height: usize,
 133}
 134
 135struct ExcerptBytes<'a> {
 136    content_bytes: language::rope::Bytes<'a>,
 137    footer_height: usize,
 138}
 139
 140impl MultiBuffer {
 141    pub fn new(replica_id: ReplicaId) -> Self {
 142        Self {
 143            snapshot: Default::default(),
 144            buffers: Default::default(),
 145            subscriptions: Default::default(),
 146            singleton: false,
 147            replica_id,
 148            history: History {
 149                next_transaction_id: Default::default(),
 150                undo_stack: Default::default(),
 151                redo_stack: Default::default(),
 152                transaction_depth: 0,
 153                group_interval: Duration::from_millis(300),
 154            },
 155        }
 156    }
 157
 158    pub fn singleton(buffer: ModelHandle<Buffer>, cx: &mut ModelContext<Self>) -> Self {
 159        let mut this = Self::new(buffer.read(cx).replica_id());
 160        this.singleton = true;
 161        this.push_excerpt(
 162            ExcerptProperties {
 163                buffer: &buffer,
 164                range: text::Anchor::min()..text::Anchor::max(),
 165            },
 166            cx,
 167        );
 168        this.snapshot.borrow_mut().singleton = true;
 169        this
 170    }
 171
 172    #[cfg(any(test, feature = "test-support"))]
 173    pub fn build_simple(text: &str, cx: &mut gpui::MutableAppContext) -> ModelHandle<Self> {
 174        let buffer = cx.add_model(|cx| Buffer::new(0, text, cx));
 175        cx.add_model(|cx| Self::singleton(buffer, cx))
 176    }
 177
 178    #[cfg(any(test, feature = "test-support"))]
 179    pub fn build_random(
 180        mut rng: &mut impl rand::Rng,
 181        cx: &mut gpui::MutableAppContext,
 182    ) -> ModelHandle<Self> {
 183        use rand::prelude::*;
 184        use std::env;
 185        use text::RandomCharIter;
 186
 187        let max_excerpts = env::var("MAX_EXCERPTS")
 188            .map(|i| i.parse().expect("invalid `MAX_EXCERPTS` variable"))
 189            .unwrap_or(5);
 190        let excerpts = rng.gen_range(1..=max_excerpts);
 191
 192        cx.add_model(|cx| {
 193            let mut multibuffer = MultiBuffer::new(0);
 194            let mut buffers = Vec::new();
 195            for _ in 0..excerpts {
 196                let buffer_handle = if rng.gen() || buffers.is_empty() {
 197                    let text = RandomCharIter::new(&mut rng).take(10).collect::<String>();
 198                    buffers.push(cx.add_model(|cx| Buffer::new(0, text, cx)));
 199                    let buffer = buffers.last().unwrap();
 200                    log::info!(
 201                        "Creating new buffer {} with text: {:?}",
 202                        buffer.id(),
 203                        buffer.read(cx).text()
 204                    );
 205                    buffers.last().unwrap()
 206                } else {
 207                    buffers.choose(rng).unwrap()
 208                };
 209
 210                let buffer = buffer_handle.read(cx);
 211                let end_ix = buffer.clip_offset(rng.gen_range(0..=buffer.len()), Bias::Right);
 212                let start_ix = buffer.clip_offset(rng.gen_range(0..=end_ix), Bias::Left);
 213                let header_height = rng.gen_range(0..=5);
 214                log::info!(
 215                    "Inserting excerpt from buffer {} with header height {} and range {:?}: {:?}",
 216                    buffer_handle.id(),
 217                    header_height,
 218                    start_ix..end_ix,
 219                    &buffer.text()[start_ix..end_ix]
 220                );
 221
 222                multibuffer.push_excerpt(
 223                    ExcerptProperties {
 224                        buffer: buffer_handle,
 225                        range: start_ix..end_ix,
 226                    },
 227                    cx,
 228                );
 229            }
 230            multibuffer
 231        })
 232    }
 233
 234    pub fn replica_id(&self) -> ReplicaId {
 235        self.replica_id
 236    }
 237
 238    pub fn snapshot(&self, cx: &AppContext) -> MultiBufferSnapshot {
 239        self.sync(cx);
 240        self.snapshot.borrow().clone()
 241    }
 242
 243    pub fn read(&self, cx: &AppContext) -> Ref<MultiBufferSnapshot> {
 244        self.sync(cx);
 245        self.snapshot.borrow()
 246    }
 247
 248    pub fn as_singleton(&self) -> Option<ModelHandle<Buffer>> {
 249        if self.singleton {
 250            return Some(
 251                self.buffers
 252                    .borrow()
 253                    .values()
 254                    .next()
 255                    .unwrap()
 256                    .buffer
 257                    .clone(),
 258            );
 259        } else {
 260            None
 261        }
 262    }
 263
 264    pub fn subscribe(&mut self) -> Subscription {
 265        self.subscriptions.subscribe()
 266    }
 267
 268    pub fn edit<I, S, T>(&mut self, ranges: I, new_text: T, cx: &mut ModelContext<Self>)
 269    where
 270        I: IntoIterator<Item = Range<S>>,
 271        S: ToOffset,
 272        T: Into<String>,
 273    {
 274        self.edit_internal(ranges, new_text, false, cx)
 275    }
 276
 277    pub fn edit_with_autoindent<I, S, T>(
 278        &mut self,
 279        ranges: I,
 280        new_text: T,
 281        cx: &mut ModelContext<Self>,
 282    ) where
 283        I: IntoIterator<Item = Range<S>>,
 284        S: ToOffset,
 285        T: Into<String>,
 286    {
 287        self.edit_internal(ranges, new_text, true, cx)
 288    }
 289
 290    pub fn edit_internal<I, S, T>(
 291        &mut self,
 292        ranges_iter: I,
 293        new_text: T,
 294        autoindent: bool,
 295        cx: &mut ModelContext<Self>,
 296    ) where
 297        I: IntoIterator<Item = Range<S>>,
 298        S: ToOffset,
 299        T: Into<String>,
 300    {
 301        if let Some(buffer) = self.as_singleton() {
 302            let snapshot = self.read(cx);
 303            let ranges = ranges_iter
 304                .into_iter()
 305                .map(|range| range.start.to_offset(&snapshot)..range.end.to_offset(&snapshot));
 306            return buffer.update(cx, |buffer, cx| {
 307                if autoindent {
 308                    buffer.edit_with_autoindent(ranges, new_text, cx)
 309                } else {
 310                    buffer.edit(ranges, new_text, cx)
 311                }
 312            });
 313        }
 314
 315        let snapshot = self.read(cx);
 316        let mut buffer_edits: HashMap<usize, Vec<(Range<usize>, bool)>> = Default::default();
 317        let mut cursor = snapshot.excerpts.cursor::<usize>();
 318        for range in ranges_iter {
 319            let start = range.start.to_offset(&snapshot);
 320            let end = range.end.to_offset(&snapshot);
 321            cursor.seek(&start, Bias::Right, &());
 322            if cursor.item().is_none() && start == *cursor.start() {
 323                cursor.prev(&());
 324            }
 325            let start_excerpt = cursor.item().expect("start offset out of bounds");
 326            let start_overshoot = start - cursor.start();
 327            let buffer_start =
 328                start_excerpt.range.start.to_offset(&start_excerpt.buffer) + start_overshoot;
 329
 330            cursor.seek(&end, Bias::Right, &());
 331            if cursor.item().is_none() && end == *cursor.start() {
 332                cursor.prev(&());
 333            }
 334            let end_excerpt = cursor.item().expect("end offset out of bounds");
 335            let end_overshoot = end - cursor.start();
 336            let buffer_end = end_excerpt.range.start.to_offset(&end_excerpt.buffer) + end_overshoot;
 337
 338            if start_excerpt.id == end_excerpt.id {
 339                buffer_edits
 340                    .entry(start_excerpt.buffer_id)
 341                    .or_insert(Vec::new())
 342                    .push((buffer_start..buffer_end, true));
 343            } else {
 344                let start_excerpt_range =
 345                    buffer_start..start_excerpt.range.end.to_offset(&start_excerpt.buffer);
 346                let end_excerpt_range =
 347                    end_excerpt.range.start.to_offset(&end_excerpt.buffer)..buffer_end;
 348                buffer_edits
 349                    .entry(start_excerpt.buffer_id)
 350                    .or_insert(Vec::new())
 351                    .push((start_excerpt_range, true));
 352                buffer_edits
 353                    .entry(end_excerpt.buffer_id)
 354                    .or_insert(Vec::new())
 355                    .push((end_excerpt_range, false));
 356
 357                cursor.seek(&start, Bias::Right, &());
 358                cursor.next(&());
 359                while let Some(excerpt) = cursor.item() {
 360                    if excerpt.id == end_excerpt.id {
 361                        break;
 362                    }
 363                    buffer_edits
 364                        .entry(excerpt.buffer_id)
 365                        .or_insert(Vec::new())
 366                        .push((excerpt.range.to_offset(&excerpt.buffer), false));
 367                    cursor.next(&());
 368                }
 369            }
 370        }
 371
 372        let new_text = new_text.into();
 373        for (buffer_id, mut edits) in buffer_edits {
 374            edits.sort_unstable_by_key(|(range, _)| range.start);
 375            self.buffers.borrow()[&buffer_id]
 376                .buffer
 377                .update(cx, |buffer, cx| {
 378                    let mut edits = edits.into_iter().peekable();
 379                    let mut insertions = Vec::new();
 380                    let mut deletions = Vec::new();
 381                    while let Some((mut range, mut is_insertion)) = edits.next() {
 382                        while let Some((next_range, next_is_insertion)) = edits.peek() {
 383                            if range.end >= next_range.start {
 384                                range.end = cmp::max(next_range.end, range.end);
 385                                is_insertion |= *next_is_insertion;
 386                                edits.next();
 387                            } else {
 388                                break;
 389                            }
 390                        }
 391
 392                        if is_insertion {
 393                            insertions.push(
 394                                buffer.anchor_before(range.start)..buffer.anchor_before(range.end),
 395                            );
 396                        } else if !range.is_empty() {
 397                            deletions.push(
 398                                buffer.anchor_before(range.start)..buffer.anchor_before(range.end),
 399                            );
 400                        }
 401                    }
 402
 403                    if autoindent {
 404                        buffer.edit_with_autoindent(deletions, "", cx);
 405                        buffer.edit_with_autoindent(insertions, new_text.clone(), cx);
 406                    } else {
 407                        buffer.edit(deletions, "", cx);
 408                        buffer.edit(insertions, new_text.clone(), cx);
 409                    }
 410                })
 411        }
 412    }
 413
 414    pub fn start_transaction(&mut self, cx: &mut ModelContext<Self>) -> Option<TransactionId> {
 415        self.start_transaction_at(Instant::now(), cx)
 416    }
 417
 418    pub(crate) fn start_transaction_at(
 419        &mut self,
 420        now: Instant,
 421        cx: &mut ModelContext<Self>,
 422    ) -> Option<TransactionId> {
 423        if let Some(buffer) = self.as_singleton() {
 424            return buffer.update(cx, |buffer, _| buffer.start_transaction_at(now));
 425        }
 426
 427        for BufferState { buffer, .. } in self.buffers.borrow().values() {
 428            buffer.update(cx, |buffer, _| buffer.start_transaction_at(now));
 429        }
 430        self.history.start_transaction(now)
 431    }
 432
 433    pub fn end_transaction(&mut self, cx: &mut ModelContext<Self>) -> Option<TransactionId> {
 434        self.end_transaction_at(Instant::now(), cx)
 435    }
 436
 437    pub(crate) fn end_transaction_at(
 438        &mut self,
 439        now: Instant,
 440        cx: &mut ModelContext<Self>,
 441    ) -> Option<TransactionId> {
 442        if let Some(buffer) = self.as_singleton() {
 443            return buffer.update(cx, |buffer, cx| buffer.end_transaction_at(now, cx));
 444        }
 445
 446        let mut buffer_transactions = HashSet::default();
 447        for BufferState { buffer, .. } in self.buffers.borrow().values() {
 448            if let Some(transaction_id) =
 449                buffer.update(cx, |buffer, cx| buffer.end_transaction_at(now, cx))
 450            {
 451                buffer_transactions.insert((buffer.id(), transaction_id));
 452            }
 453        }
 454
 455        if self.history.end_transaction(now, buffer_transactions) {
 456            let transaction_id = self.history.group().unwrap();
 457            Some(transaction_id)
 458        } else {
 459            None
 460        }
 461    }
 462
 463    pub fn avoid_grouping_next_transaction(&mut self, cx: &mut ModelContext<Self>) {
 464        for BufferState { buffer, .. } in self.buffers.borrow().values() {
 465            buffer.update(cx, |buffer, _| buffer.avoid_grouping_next_transaction());
 466        }
 467    }
 468
 469    pub fn set_active_selections(
 470        &mut self,
 471        selections: &[Selection<Anchor>],
 472        cx: &mut ModelContext<Self>,
 473    ) {
 474        let mut selections_by_buffer: HashMap<usize, Vec<Selection<text::Anchor>>> =
 475            Default::default();
 476        let snapshot = self.read(cx);
 477        let mut cursor = snapshot.excerpts.cursor::<Option<&ExcerptId>>();
 478        for selection in selections {
 479            cursor.seek(&Some(&selection.start.excerpt_id), Bias::Left, &());
 480            while let Some(excerpt) = cursor.item() {
 481                if excerpt.id > selection.end.excerpt_id {
 482                    break;
 483                }
 484
 485                let mut start = excerpt.range.start.clone();
 486                let mut end = excerpt.range.end.clone();
 487                if excerpt.id == selection.start.excerpt_id {
 488                    start = selection.start.text_anchor.clone();
 489                }
 490                if excerpt.id == selection.end.excerpt_id {
 491                    end = selection.end.text_anchor.clone();
 492                }
 493                selections_by_buffer
 494                    .entry(excerpt.buffer_id)
 495                    .or_default()
 496                    .push(Selection {
 497                        id: selection.id,
 498                        start,
 499                        end,
 500                        reversed: selection.reversed,
 501                        goal: selection.goal,
 502                    });
 503
 504                cursor.next(&());
 505            }
 506        }
 507
 508        for (buffer_id, buffer_state) in self.buffers.borrow().iter() {
 509            if !selections_by_buffer.contains_key(buffer_id) {
 510                buffer_state
 511                    .buffer
 512                    .update(cx, |buffer, cx| buffer.remove_active_selections(cx));
 513            }
 514        }
 515
 516        for (buffer_id, mut selections) in selections_by_buffer {
 517            self.buffers.borrow()[&buffer_id]
 518                .buffer
 519                .update(cx, |buffer, cx| {
 520                    selections.sort_unstable_by(|a, b| a.start.cmp(&b.start, buffer).unwrap());
 521                    let mut selections = selections.into_iter().peekable();
 522                    let merged_selections = Arc::from_iter(iter::from_fn(|| {
 523                        let mut selection = selections.next()?;
 524                        while let Some(next_selection) = selections.peek() {
 525                            if selection
 526                                .end
 527                                .cmp(&next_selection.start, buffer)
 528                                .unwrap()
 529                                .is_ge()
 530                            {
 531                                let next_selection = selections.next().unwrap();
 532                                if next_selection
 533                                    .end
 534                                    .cmp(&selection.end, buffer)
 535                                    .unwrap()
 536                                    .is_ge()
 537                                {
 538                                    selection.end = next_selection.end;
 539                                }
 540                            } else {
 541                                break;
 542                            }
 543                        }
 544                        Some(selection)
 545                    }));
 546                    buffer.set_active_selections(merged_selections, cx);
 547                });
 548        }
 549    }
 550
 551    pub fn remove_active_selections(&mut self, cx: &mut ModelContext<Self>) {
 552        for buffer in self.buffers.borrow().values() {
 553            buffer
 554                .buffer
 555                .update(cx, |buffer, cx| buffer.remove_active_selections(cx));
 556        }
 557    }
 558
 559    pub fn undo(&mut self, cx: &mut ModelContext<Self>) -> Option<TransactionId> {
 560        if let Some(buffer) = self.as_singleton() {
 561            return buffer.update(cx, |buffer, cx| buffer.undo(cx));
 562        }
 563
 564        while let Some(transaction) = self.history.pop_undo() {
 565            let mut undone = false;
 566            for (buffer_id, buffer_transaction_id) in &transaction.buffer_transactions {
 567                if let Some(BufferState { buffer, .. }) = self.buffers.borrow().get(&buffer_id) {
 568                    undone |= buffer.update(cx, |buf, cx| {
 569                        buf.undo_transaction(*buffer_transaction_id, cx)
 570                    });
 571                }
 572            }
 573
 574            if undone {
 575                return Some(transaction.id);
 576            }
 577        }
 578
 579        None
 580    }
 581
 582    pub fn redo(&mut self, cx: &mut ModelContext<Self>) -> Option<TransactionId> {
 583        if let Some(buffer) = self.as_singleton() {
 584            return buffer.update(cx, |buffer, cx| buffer.redo(cx));
 585        }
 586
 587        while let Some(transaction) = self.history.pop_redo() {
 588            let mut redone = false;
 589            for (buffer_id, buffer_transaction_id) in &transaction.buffer_transactions {
 590                if let Some(BufferState { buffer, .. }) = self.buffers.borrow().get(&buffer_id) {
 591                    redone |= buffer.update(cx, |buf, cx| {
 592                        buf.redo_transaction(*buffer_transaction_id, cx)
 593                    });
 594                }
 595            }
 596
 597            if redone {
 598                return Some(transaction.id);
 599            }
 600        }
 601
 602        None
 603    }
 604
 605    pub fn push_excerpt<O>(
 606        &mut self,
 607        props: ExcerptProperties<O>,
 608        cx: &mut ModelContext<Self>,
 609    ) -> ExcerptId
 610    where
 611        O: text::ToOffset,
 612    {
 613        self.insert_excerpt_after(&ExcerptId::max(), props, cx)
 614    }
 615
 616    pub fn insert_excerpt_after<O>(
 617        &mut self,
 618        prev_excerpt_id: &ExcerptId,
 619        props: ExcerptProperties<O>,
 620        cx: &mut ModelContext<Self>,
 621    ) -> ExcerptId
 622    where
 623        O: text::ToOffset,
 624    {
 625        assert_eq!(self.history.transaction_depth, 0);
 626        self.sync(cx);
 627
 628        let buffer_snapshot = props.buffer.read(cx).snapshot();
 629        let range = buffer_snapshot.anchor_before(&props.range.start)
 630            ..buffer_snapshot.anchor_after(&props.range.end);
 631        let mut snapshot = self.snapshot.borrow_mut();
 632        let mut cursor = snapshot.excerpts.cursor::<Option<&ExcerptId>>();
 633        let mut new_excerpts = cursor.slice(&Some(prev_excerpt_id), Bias::Right, &());
 634
 635        let mut prev_id = ExcerptId::min();
 636        let edit_start = new_excerpts.summary().text.bytes;
 637        new_excerpts.update_last(
 638            |excerpt| {
 639                excerpt.has_trailing_newline = true;
 640                prev_id = excerpt.id.clone();
 641            },
 642            &(),
 643        );
 644
 645        let mut next_id = ExcerptId::max();
 646        if let Some(next_excerpt) = cursor.item() {
 647            next_id = next_excerpt.id.clone();
 648        }
 649
 650        let id = ExcerptId::between(&prev_id, &next_id);
 651
 652        let mut buffers = self.buffers.borrow_mut();
 653        let buffer_state = buffers
 654            .entry(props.buffer.id())
 655            .or_insert_with(|| BufferState {
 656                last_version: buffer_snapshot.version().clone(),
 657                last_parse_count: buffer_snapshot.parse_count(),
 658                last_selections_update_count: buffer_snapshot.selections_update_count(),
 659                last_diagnostics_update_count: buffer_snapshot.diagnostics_update_count(),
 660                excerpts: Default::default(),
 661                _subscriptions: [
 662                    cx.observe(&props.buffer, |_, _, cx| cx.notify()),
 663                    cx.subscribe(&props.buffer, Self::on_buffer_event),
 664                ],
 665                buffer: props.buffer.clone(),
 666            });
 667        if let Err(ix) = buffer_state.excerpts.binary_search(&id) {
 668            buffer_state.excerpts.insert(ix, id.clone());
 669        }
 670
 671        let excerpt = Excerpt::new(
 672            id.clone(),
 673            props.buffer.id(),
 674            buffer_snapshot,
 675            range,
 676            cursor.item().is_some(),
 677        );
 678        new_excerpts.push(excerpt, &());
 679        let edit_end = new_excerpts.summary().text.bytes;
 680
 681        new_excerpts.push_tree(cursor.suffix(&()), &());
 682        drop(cursor);
 683        snapshot.excerpts = new_excerpts;
 684
 685        self.subscriptions.publish_mut([Edit {
 686            old: edit_start..edit_start,
 687            new: edit_start..edit_end,
 688        }]);
 689
 690        cx.notify();
 691        id
 692    }
 693
 694    pub fn excerpt_ids_for_buffer(&self, buffer: &ModelHandle<Buffer>) -> Vec<ExcerptId> {
 695        self.buffers
 696            .borrow()
 697            .get(&buffer.id())
 698            .map_or(Vec::new(), |state| state.excerpts.clone())
 699    }
 700
 701    pub fn excerpted_buffers<'a, T: ToOffset>(
 702        &'a self,
 703        range: Range<T>,
 704        cx: &AppContext,
 705    ) -> Vec<(ModelHandle<Buffer>, Range<usize>)> {
 706        let snapshot = self.snapshot(cx);
 707        let start = range.start.to_offset(&snapshot);
 708        let end = range.end.to_offset(&snapshot);
 709
 710        let mut result = Vec::new();
 711        let mut cursor = snapshot.excerpts.cursor::<usize>();
 712        cursor.seek(&start, Bias::Right, &());
 713        while let Some(excerpt) = cursor.item() {
 714            if *cursor.start() > end {
 715                break;
 716            }
 717
 718            let mut end_before_newline = cursor.end(&());
 719            if excerpt.has_trailing_newline {
 720                end_before_newline -= 1;
 721            }
 722            let excerpt_start = excerpt.range.start.to_offset(&excerpt.buffer);
 723            let start = excerpt_start + (cmp::max(start, *cursor.start()) - *cursor.start());
 724            let end = excerpt_start + (cmp::min(end, end_before_newline) - *cursor.start());
 725            let buffer = self.buffers.borrow()[&excerpt.buffer_id].buffer.clone();
 726            result.push((buffer, start..end));
 727            cursor.next(&());
 728        }
 729
 730        result
 731    }
 732
 733    pub fn remove_excerpts<'a>(
 734        &mut self,
 735        excerpt_ids: impl IntoIterator<Item = &'a ExcerptId>,
 736        cx: &mut ModelContext<Self>,
 737    ) {
 738        let mut buffers = self.buffers.borrow_mut();
 739        let mut snapshot = self.snapshot.borrow_mut();
 740        let mut new_excerpts = SumTree::new();
 741        let mut cursor = snapshot.excerpts.cursor::<(Option<&ExcerptId>, usize)>();
 742        let mut edits = Vec::new();
 743        let mut excerpt_ids = excerpt_ids.into_iter().peekable();
 744
 745        while let Some(mut excerpt_id) = excerpt_ids.next() {
 746            // Seek to the next excerpt to remove, preserving any preceding excerpts.
 747            new_excerpts.push_tree(cursor.slice(&Some(excerpt_id), Bias::Left, &()), &());
 748            if let Some(mut excerpt) = cursor.item() {
 749                if excerpt.id != *excerpt_id {
 750                    continue;
 751                }
 752                let mut old_start = cursor.start().1;
 753
 754                // Skip over the removed excerpt.
 755                loop {
 756                    if let Some(buffer_state) = buffers.get_mut(&excerpt.buffer_id) {
 757                        buffer_state.excerpts.retain(|id| id != excerpt_id);
 758                        if buffer_state.excerpts.is_empty() {
 759                            buffers.remove(&excerpt.buffer_id);
 760                        }
 761                    }
 762                    cursor.next(&());
 763
 764                    // Skip over any subsequent excerpts that are also removed.
 765                    if let Some(&next_excerpt_id) = excerpt_ids.peek() {
 766                        if let Some(next_excerpt) = cursor.item() {
 767                            if next_excerpt.id == *next_excerpt_id {
 768                                excerpt = next_excerpt;
 769                                excerpt_id = excerpt_ids.next().unwrap();
 770                                continue;
 771                            }
 772                        }
 773                    }
 774
 775                    break;
 776                }
 777
 778                // When removing the last excerpt, remove the trailing newline from
 779                // the previous excerpt.
 780                if cursor.item().is_none() && old_start > 0 {
 781                    old_start -= 1;
 782                    new_excerpts.update_last(|e| e.has_trailing_newline = false, &());
 783                }
 784
 785                // Push an edit for the removal of this run of excerpts.
 786                let old_end = cursor.start().1;
 787                let new_start = new_excerpts.summary().text.bytes;
 788                edits.push(Edit {
 789                    old: old_start..old_end,
 790                    new: new_start..new_start,
 791                });
 792            }
 793        }
 794        new_excerpts.push_tree(cursor.suffix(&()), &());
 795        drop(cursor);
 796        snapshot.excerpts = new_excerpts;
 797        self.subscriptions.publish_mut(edits);
 798        cx.notify();
 799    }
 800
 801    pub fn text_anchor_for_position<'a, T: ToOffset>(
 802        &'a self,
 803        position: T,
 804        cx: &AppContext,
 805    ) -> (ModelHandle<Buffer>, language::Anchor) {
 806        let snapshot = self.read(cx);
 807        let anchor = snapshot.anchor_before(position);
 808        (
 809            self.buffers.borrow()[&anchor.buffer_id].buffer.clone(),
 810            anchor.text_anchor,
 811        )
 812    }
 813
 814    fn on_buffer_event(
 815        &mut self,
 816        _: ModelHandle<Buffer>,
 817        event: &Event,
 818        cx: &mut ModelContext<Self>,
 819    ) {
 820        cx.emit(event.clone());
 821    }
 822
 823    pub fn format(&mut self, cx: &mut ModelContext<Self>) -> Task<Result<()>> {
 824        let mut format_tasks = Vec::new();
 825        for BufferState { buffer, .. } in self.buffers.borrow().values() {
 826            format_tasks.push(buffer.update(cx, |buffer, cx| buffer.format(cx)));
 827        }
 828
 829        cx.spawn(|_, _| async move {
 830            for format in format_tasks {
 831                format.await?;
 832            }
 833            Ok(())
 834        })
 835    }
 836
 837    pub fn save(&mut self, cx: &mut ModelContext<Self>) -> Task<Result<()>> {
 838        let mut save_tasks = Vec::new();
 839        for BufferState { buffer, .. } in self.buffers.borrow().values() {
 840            save_tasks.push(buffer.update(cx, |buffer, cx| buffer.save(cx)));
 841        }
 842
 843        cx.spawn(|_, _| async move {
 844            for save in save_tasks {
 845                save.await?;
 846            }
 847            Ok(())
 848        })
 849    }
 850
 851    pub fn completions<T>(
 852        &self,
 853        position: T,
 854        cx: &mut ModelContext<Self>,
 855    ) -> Task<Result<Vec<Completion<Anchor>>>>
 856    where
 857        T: ToOffset,
 858    {
 859        let snapshot = self.snapshot(cx);
 860        let anchor = snapshot.anchor_before(position);
 861        let buffer = self.buffers.borrow()[&anchor.buffer_id].buffer.clone();
 862        let completions =
 863            buffer.update(cx, |buffer, cx| buffer.completions(anchor.text_anchor, cx));
 864        cx.foreground().spawn(async move {
 865            completions.await.map(|completions| {
 866                completions
 867                    .into_iter()
 868                    .map(|completion| Completion {
 869                        old_range: snapshot.anchor_in_excerpt(
 870                            anchor.excerpt_id.clone(),
 871                            completion.old_range.start,
 872                        )
 873                            ..snapshot.anchor_in_excerpt(
 874                                anchor.excerpt_id.clone(),
 875                                completion.old_range.end,
 876                            ),
 877                        new_text: completion.new_text,
 878                        lsp_completion: completion.lsp_completion,
 879                    })
 880                    .collect()
 881            })
 882        })
 883    }
 884
 885    pub fn is_completion_trigger<T>(&self, position: T, text: &str, cx: &AppContext) -> bool
 886    where
 887        T: ToOffset,
 888    {
 889        let mut chars = text.chars();
 890        let char = if let Some(char) = chars.next() {
 891            char
 892        } else {
 893            return false;
 894        };
 895        if chars.next().is_some() {
 896            return false;
 897        }
 898
 899        if char.is_alphanumeric() || char == '_' {
 900            return true;
 901        }
 902
 903        let snapshot = self.snapshot(cx);
 904        let anchor = snapshot.anchor_before(position);
 905        let buffer = self.buffers.borrow()[&anchor.buffer_id].buffer.clone();
 906        if let Some(language_server) = buffer.read(cx).language_server() {
 907            language_server
 908                .capabilities()
 909                .completion_provider
 910                .as_ref()
 911                .map_or(false, |provider| {
 912                    provider
 913                        .trigger_characters
 914                        .as_ref()
 915                        .map_or(false, |characters| {
 916                            characters.iter().any(|string| string == text)
 917                        })
 918                })
 919        } else {
 920            false
 921        }
 922    }
 923
 924    pub fn language<'a>(&self, cx: &'a AppContext) -> Option<&'a Arc<Language>> {
 925        self.buffers
 926            .borrow()
 927            .values()
 928            .next()
 929            .and_then(|state| state.buffer.read(cx).language())
 930    }
 931
 932    pub fn file<'a>(&self, cx: &'a AppContext) -> Option<&'a dyn File> {
 933        self.as_singleton()?.read(cx).file()
 934    }
 935
 936    #[cfg(test)]
 937    pub fn is_parsing(&self, cx: &AppContext) -> bool {
 938        self.as_singleton().unwrap().read(cx).is_parsing()
 939    }
 940
 941    fn sync(&self, cx: &AppContext) {
 942        let mut snapshot = self.snapshot.borrow_mut();
 943        let mut excerpts_to_edit = Vec::new();
 944        let mut reparsed = false;
 945        let mut diagnostics_updated = false;
 946        let mut is_dirty = false;
 947        let mut has_conflict = false;
 948        let mut buffers = self.buffers.borrow_mut();
 949        for buffer_state in buffers.values_mut() {
 950            let buffer = buffer_state.buffer.read(cx);
 951            let version = buffer.version();
 952            let parse_count = buffer.parse_count();
 953            let selections_update_count = buffer.selections_update_count();
 954            let diagnostics_update_count = buffer.diagnostics_update_count();
 955
 956            let buffer_edited = version.changed_since(&buffer_state.last_version);
 957            let buffer_reparsed = parse_count > buffer_state.last_parse_count;
 958            let buffer_selections_updated =
 959                selections_update_count > buffer_state.last_selections_update_count;
 960            let buffer_diagnostics_updated =
 961                diagnostics_update_count > buffer_state.last_diagnostics_update_count;
 962            if buffer_edited
 963                || buffer_reparsed
 964                || buffer_selections_updated
 965                || buffer_diagnostics_updated
 966            {
 967                buffer_state.last_version = version;
 968                buffer_state.last_parse_count = parse_count;
 969                buffer_state.last_selections_update_count = selections_update_count;
 970                buffer_state.last_diagnostics_update_count = diagnostics_update_count;
 971                excerpts_to_edit.extend(
 972                    buffer_state
 973                        .excerpts
 974                        .iter()
 975                        .map(|excerpt_id| (excerpt_id, buffer_state.buffer.clone(), buffer_edited)),
 976                );
 977            }
 978
 979            reparsed |= buffer_reparsed;
 980            diagnostics_updated |= buffer_diagnostics_updated;
 981            is_dirty |= buffer.is_dirty();
 982            has_conflict |= buffer.has_conflict();
 983        }
 984        if reparsed {
 985            snapshot.parse_count += 1;
 986        }
 987        if diagnostics_updated {
 988            snapshot.diagnostics_update_count += 1;
 989        }
 990        snapshot.is_dirty = is_dirty;
 991        snapshot.has_conflict = has_conflict;
 992
 993        excerpts_to_edit.sort_unstable_by_key(|(excerpt_id, _, _)| *excerpt_id);
 994
 995        let mut edits = Vec::new();
 996        let mut new_excerpts = SumTree::new();
 997        let mut cursor = snapshot.excerpts.cursor::<(Option<&ExcerptId>, usize)>();
 998
 999        for (id, buffer, buffer_edited) in excerpts_to_edit {
1000            new_excerpts.push_tree(cursor.slice(&Some(id), Bias::Left, &()), &());
1001            let old_excerpt = cursor.item().unwrap();
1002            let buffer_id = buffer.id();
1003            let buffer = buffer.read(cx);
1004
1005            let mut new_excerpt;
1006            if buffer_edited {
1007                edits.extend(
1008                    buffer
1009                        .edits_since_in_range::<usize>(
1010                            old_excerpt.buffer.version(),
1011                            old_excerpt.range.clone(),
1012                        )
1013                        .map(|mut edit| {
1014                            let excerpt_old_start = cursor.start().1;
1015                            let excerpt_new_start = new_excerpts.summary().text.bytes;
1016                            edit.old.start += excerpt_old_start;
1017                            edit.old.end += excerpt_old_start;
1018                            edit.new.start += excerpt_new_start;
1019                            edit.new.end += excerpt_new_start;
1020                            edit
1021                        }),
1022                );
1023
1024                new_excerpt = Excerpt::new(
1025                    id.clone(),
1026                    buffer_id,
1027                    buffer.snapshot(),
1028                    old_excerpt.range.clone(),
1029                    old_excerpt.has_trailing_newline,
1030                );
1031            } else {
1032                new_excerpt = old_excerpt.clone();
1033                new_excerpt.buffer = buffer.snapshot();
1034            }
1035
1036            new_excerpts.push(new_excerpt, &());
1037            cursor.next(&());
1038        }
1039        new_excerpts.push_tree(cursor.suffix(&()), &());
1040
1041        drop(cursor);
1042        snapshot.excerpts = new_excerpts;
1043
1044        self.subscriptions.publish(edits);
1045    }
1046}
1047
1048#[cfg(any(test, feature = "test-support"))]
1049impl MultiBuffer {
1050    pub fn randomly_edit(
1051        &mut self,
1052        rng: &mut impl rand::Rng,
1053        count: usize,
1054        cx: &mut ModelContext<Self>,
1055    ) {
1056        use text::RandomCharIter;
1057
1058        let snapshot = self.read(cx);
1059        let mut old_ranges: Vec<Range<usize>> = Vec::new();
1060        for _ in 0..count {
1061            let last_end = old_ranges.last().map_or(0, |last_range| last_range.end + 1);
1062            if last_end > snapshot.len() {
1063                break;
1064            }
1065            let end_ix = snapshot.clip_offset(rng.gen_range(0..=last_end), Bias::Right);
1066            let start_ix = snapshot.clip_offset(rng.gen_range(0..=end_ix), Bias::Left);
1067            old_ranges.push(start_ix..end_ix);
1068        }
1069        let new_text_len = rng.gen_range(0..10);
1070        let new_text: String = RandomCharIter::new(&mut *rng).take(new_text_len).collect();
1071        log::info!("mutating multi-buffer at {:?}: {:?}", old_ranges, new_text);
1072        drop(snapshot);
1073
1074        self.edit(old_ranges.iter().cloned(), new_text.as_str(), cx);
1075    }
1076}
1077
1078impl Entity for MultiBuffer {
1079    type Event = language::Event;
1080}
1081
1082impl MultiBufferSnapshot {
1083    pub fn text(&self) -> String {
1084        self.chunks(0..self.len(), None)
1085            .map(|chunk| chunk.text)
1086            .collect()
1087    }
1088
1089    pub fn reversed_chars_at<'a, T: ToOffset>(
1090        &'a self,
1091        position: T,
1092    ) -> impl Iterator<Item = char> + 'a {
1093        let mut offset = position.to_offset(self);
1094        let mut cursor = self.excerpts.cursor::<usize>();
1095        cursor.seek(&offset, Bias::Left, &());
1096        let mut excerpt_chunks = cursor.item().map(|excerpt| {
1097            let end_before_footer = cursor.start() + excerpt.text_summary.bytes;
1098            let start = excerpt.range.start.to_offset(&excerpt.buffer);
1099            let end = start + (cmp::min(offset, end_before_footer) - cursor.start());
1100            excerpt.buffer.reversed_chunks_in_range(start..end)
1101        });
1102        iter::from_fn(move || {
1103            if offset == *cursor.start() {
1104                cursor.prev(&());
1105                let excerpt = cursor.item()?;
1106                excerpt_chunks = Some(
1107                    excerpt
1108                        .buffer
1109                        .reversed_chunks_in_range(excerpt.range.clone()),
1110                );
1111            }
1112
1113            let excerpt = cursor.item().unwrap();
1114            if offset == cursor.end(&()) && excerpt.has_trailing_newline {
1115                offset -= 1;
1116                Some("\n")
1117            } else {
1118                let chunk = excerpt_chunks.as_mut().unwrap().next().unwrap();
1119                offset -= chunk.len();
1120                Some(chunk)
1121            }
1122        })
1123        .flat_map(|c| c.chars().rev())
1124    }
1125
1126    pub fn chars_at<'a, T: ToOffset>(&'a self, position: T) -> impl Iterator<Item = char> + 'a {
1127        let offset = position.to_offset(self);
1128        self.text_for_range(offset..self.len())
1129            .flat_map(|chunk| chunk.chars())
1130    }
1131
1132    pub fn text_for_range<'a, T: ToOffset>(
1133        &'a self,
1134        range: Range<T>,
1135    ) -> impl Iterator<Item = &'a str> {
1136        self.chunks(range, None).map(|chunk| chunk.text)
1137    }
1138
1139    pub fn is_line_blank(&self, row: u32) -> bool {
1140        self.text_for_range(Point::new(row, 0)..Point::new(row, self.line_len(row)))
1141            .all(|chunk| chunk.matches(|c: char| !c.is_whitespace()).next().is_none())
1142    }
1143
1144    pub fn contains_str_at<T>(&self, position: T, needle: &str) -> bool
1145    where
1146        T: ToOffset,
1147    {
1148        let position = position.to_offset(self);
1149        position == self.clip_offset(position, Bias::Left)
1150            && self
1151                .bytes_in_range(position..self.len())
1152                .flatten()
1153                .copied()
1154                .take(needle.len())
1155                .eq(needle.bytes())
1156    }
1157
1158    fn as_singleton(&self) -> Option<&Excerpt> {
1159        if self.singleton {
1160            self.excerpts.iter().next()
1161        } else {
1162            None
1163        }
1164    }
1165
1166    pub fn len(&self) -> usize {
1167        self.excerpts.summary().text.bytes
1168    }
1169
1170    pub fn max_buffer_row(&self) -> u32 {
1171        self.excerpts.summary().max_buffer_row
1172    }
1173
1174    pub fn clip_offset(&self, offset: usize, bias: Bias) -> usize {
1175        if let Some(excerpt) = self.as_singleton() {
1176            return excerpt.buffer.clip_offset(offset, bias);
1177        }
1178
1179        let mut cursor = self.excerpts.cursor::<usize>();
1180        cursor.seek(&offset, Bias::Right, &());
1181        let overshoot = if let Some(excerpt) = cursor.item() {
1182            let excerpt_start = excerpt.range.start.to_offset(&excerpt.buffer);
1183            let buffer_offset = excerpt
1184                .buffer
1185                .clip_offset(excerpt_start + (offset - cursor.start()), bias);
1186            buffer_offset.saturating_sub(excerpt_start)
1187        } else {
1188            0
1189        };
1190        cursor.start() + overshoot
1191    }
1192
1193    pub fn clip_point(&self, point: Point, bias: Bias) -> Point {
1194        if let Some(excerpt) = self.as_singleton() {
1195            return excerpt.buffer.clip_point(point, bias);
1196        }
1197
1198        let mut cursor = self.excerpts.cursor::<Point>();
1199        cursor.seek(&point, Bias::Right, &());
1200        let overshoot = if let Some(excerpt) = cursor.item() {
1201            let excerpt_start = excerpt.range.start.to_point(&excerpt.buffer);
1202            let buffer_point = excerpt
1203                .buffer
1204                .clip_point(excerpt_start + (point - cursor.start()), bias);
1205            buffer_point.saturating_sub(excerpt_start)
1206        } else {
1207            Point::zero()
1208        };
1209        *cursor.start() + overshoot
1210    }
1211
1212    pub fn clip_point_utf16(&self, point: PointUtf16, bias: Bias) -> PointUtf16 {
1213        if let Some(excerpt) = self.as_singleton() {
1214            return excerpt.buffer.clip_point_utf16(point, bias);
1215        }
1216
1217        let mut cursor = self.excerpts.cursor::<PointUtf16>();
1218        cursor.seek(&point, Bias::Right, &());
1219        let overshoot = if let Some(excerpt) = cursor.item() {
1220            let excerpt_start = excerpt
1221                .buffer
1222                .offset_to_point_utf16(excerpt.range.start.to_offset(&excerpt.buffer));
1223            let buffer_point = excerpt
1224                .buffer
1225                .clip_point_utf16(excerpt_start + (point - cursor.start()), bias);
1226            buffer_point.saturating_sub(excerpt_start)
1227        } else {
1228            PointUtf16::zero()
1229        };
1230        *cursor.start() + overshoot
1231    }
1232
1233    pub fn bytes_in_range<'a, T: ToOffset>(&'a self, range: Range<T>) -> MultiBufferBytes<'a> {
1234        let range = range.start.to_offset(self)..range.end.to_offset(self);
1235        let mut excerpts = self.excerpts.cursor::<usize>();
1236        excerpts.seek(&range.start, Bias::Right, &());
1237
1238        let mut chunk = &[][..];
1239        let excerpt_bytes = if let Some(excerpt) = excerpts.item() {
1240            let mut excerpt_bytes = excerpt
1241                .bytes_in_range(range.start - excerpts.start()..range.end - excerpts.start());
1242            chunk = excerpt_bytes.next().unwrap_or(&[][..]);
1243            Some(excerpt_bytes)
1244        } else {
1245            None
1246        };
1247
1248        MultiBufferBytes {
1249            range,
1250            excerpts,
1251            excerpt_bytes,
1252            chunk,
1253        }
1254    }
1255
1256    pub fn buffer_rows<'a>(&'a self, start_row: u32) -> MultiBufferRows<'a> {
1257        let mut result = MultiBufferRows {
1258            buffer_row_range: 0..0,
1259            excerpts: self.excerpts.cursor(),
1260        };
1261        result.seek(start_row);
1262        result
1263    }
1264
1265    pub fn chunks<'a, T: ToOffset>(
1266        &'a self,
1267        range: Range<T>,
1268        theme: Option<&'a SyntaxTheme>,
1269    ) -> MultiBufferChunks<'a> {
1270        let range = range.start.to_offset(self)..range.end.to_offset(self);
1271        let mut chunks = MultiBufferChunks {
1272            range: range.clone(),
1273            excerpts: self.excerpts.cursor(),
1274            excerpt_chunks: None,
1275            theme,
1276        };
1277        chunks.seek(range.start);
1278        chunks
1279    }
1280
1281    pub fn offset_to_point(&self, offset: usize) -> Point {
1282        if let Some(excerpt) = self.as_singleton() {
1283            return excerpt.buffer.offset_to_point(offset);
1284        }
1285
1286        let mut cursor = self.excerpts.cursor::<(usize, Point)>();
1287        cursor.seek(&offset, Bias::Right, &());
1288        if let Some(excerpt) = cursor.item() {
1289            let (start_offset, start_point) = cursor.start();
1290            let overshoot = offset - start_offset;
1291            let excerpt_start_offset = excerpt.range.start.to_offset(&excerpt.buffer);
1292            let excerpt_start_point = excerpt.range.start.to_point(&excerpt.buffer);
1293            let buffer_point = excerpt
1294                .buffer
1295                .offset_to_point(excerpt_start_offset + overshoot);
1296            *start_point + (buffer_point - excerpt_start_point)
1297        } else {
1298            self.excerpts.summary().text.lines
1299        }
1300    }
1301
1302    pub fn point_to_offset(&self, point: Point) -> usize {
1303        if let Some(excerpt) = self.as_singleton() {
1304            return excerpt.buffer.point_to_offset(point);
1305        }
1306
1307        let mut cursor = self.excerpts.cursor::<(Point, usize)>();
1308        cursor.seek(&point, Bias::Right, &());
1309        if let Some(excerpt) = cursor.item() {
1310            let (start_point, start_offset) = cursor.start();
1311            let overshoot = point - start_point;
1312            let excerpt_start_offset = excerpt.range.start.to_offset(&excerpt.buffer);
1313            let excerpt_start_point = excerpt.range.start.to_point(&excerpt.buffer);
1314            let buffer_offset = excerpt
1315                .buffer
1316                .point_to_offset(excerpt_start_point + overshoot);
1317            *start_offset + buffer_offset - excerpt_start_offset
1318        } else {
1319            self.excerpts.summary().text.bytes
1320        }
1321    }
1322
1323    pub fn point_utf16_to_offset(&self, point: PointUtf16) -> usize {
1324        if let Some(excerpt) = self.as_singleton() {
1325            return excerpt.buffer.point_utf16_to_offset(point);
1326        }
1327
1328        let mut cursor = self.excerpts.cursor::<(PointUtf16, usize)>();
1329        cursor.seek(&point, Bias::Right, &());
1330        if let Some(excerpt) = cursor.item() {
1331            let (start_point, start_offset) = cursor.start();
1332            let overshoot = point - start_point;
1333            let excerpt_start_offset = excerpt.range.start.to_offset(&excerpt.buffer);
1334            let excerpt_start_point = excerpt
1335                .buffer
1336                .offset_to_point_utf16(excerpt.range.start.to_offset(&excerpt.buffer));
1337            let buffer_offset = excerpt
1338                .buffer
1339                .point_utf16_to_offset(excerpt_start_point + overshoot);
1340            *start_offset + (buffer_offset - excerpt_start_offset)
1341        } else {
1342            self.excerpts.summary().text.bytes
1343        }
1344    }
1345
1346    pub fn indent_column_for_line(&self, row: u32) -> u32 {
1347        if let Some((buffer, range)) = self.buffer_line_for_row(row) {
1348            buffer
1349                .indent_column_for_line(range.start.row)
1350                .min(range.end.column)
1351                .saturating_sub(range.start.column)
1352        } else {
1353            0
1354        }
1355    }
1356
1357    pub fn line_len(&self, row: u32) -> u32 {
1358        if let Some((_, range)) = self.buffer_line_for_row(row) {
1359            range.end.column - range.start.column
1360        } else {
1361            0
1362        }
1363    }
1364
1365    fn buffer_line_for_row(&self, row: u32) -> Option<(&BufferSnapshot, Range<Point>)> {
1366        let mut cursor = self.excerpts.cursor::<Point>();
1367        cursor.seek(&Point::new(row, 0), Bias::Right, &());
1368        if let Some(excerpt) = cursor.item() {
1369            let overshoot = row - cursor.start().row;
1370            let excerpt_start = excerpt.range.start.to_point(&excerpt.buffer);
1371            let excerpt_end = excerpt.range.end.to_point(&excerpt.buffer);
1372            let buffer_row = excerpt_start.row + overshoot;
1373            let line_start = Point::new(buffer_row, 0);
1374            let line_end = Point::new(buffer_row, excerpt.buffer.line_len(buffer_row));
1375            return Some((
1376                &excerpt.buffer,
1377                line_start.max(excerpt_start)..line_end.min(excerpt_end),
1378            ));
1379        }
1380        None
1381    }
1382
1383    pub fn max_point(&self) -> Point {
1384        self.text_summary().lines
1385    }
1386
1387    pub fn text_summary(&self) -> TextSummary {
1388        self.excerpts.summary().text
1389    }
1390
1391    pub fn text_summary_for_range<'a, D, O>(&'a self, range: Range<O>) -> D
1392    where
1393        D: TextDimension,
1394        O: ToOffset,
1395    {
1396        let mut summary = D::default();
1397        let mut range = range.start.to_offset(self)..range.end.to_offset(self);
1398        let mut cursor = self.excerpts.cursor::<usize>();
1399        cursor.seek(&range.start, Bias::Right, &());
1400        if let Some(excerpt) = cursor.item() {
1401            let mut end_before_newline = cursor.end(&());
1402            if excerpt.has_trailing_newline {
1403                end_before_newline -= 1;
1404            }
1405
1406            let excerpt_start = excerpt.range.start.to_offset(&excerpt.buffer);
1407            let start_in_excerpt = excerpt_start + (range.start - cursor.start());
1408            let end_in_excerpt =
1409                excerpt_start + (cmp::min(end_before_newline, range.end) - cursor.start());
1410            summary.add_assign(
1411                &excerpt
1412                    .buffer
1413                    .text_summary_for_range(start_in_excerpt..end_in_excerpt),
1414            );
1415
1416            if range.end > end_before_newline {
1417                summary.add_assign(&D::from_text_summary(&TextSummary {
1418                    bytes: 1,
1419                    lines: Point::new(1 as u32, 0),
1420                    lines_utf16: PointUtf16::new(1 as u32, 0),
1421                    first_line_chars: 0,
1422                    last_line_chars: 0,
1423                    longest_row: 0,
1424                    longest_row_chars: 0,
1425                }));
1426            }
1427
1428            cursor.next(&());
1429        }
1430
1431        if range.end > *cursor.start() {
1432            summary.add_assign(&D::from_text_summary(&cursor.summary::<_, TextSummary>(
1433                &range.end,
1434                Bias::Right,
1435                &(),
1436            )));
1437            if let Some(excerpt) = cursor.item() {
1438                range.end = cmp::max(*cursor.start(), range.end);
1439
1440                let excerpt_start = excerpt.range.start.to_offset(&excerpt.buffer);
1441                let end_in_excerpt = excerpt_start + (range.end - cursor.start());
1442                summary.add_assign(
1443                    &excerpt
1444                        .buffer
1445                        .text_summary_for_range(excerpt_start..end_in_excerpt),
1446                );
1447            }
1448        }
1449
1450        summary
1451    }
1452
1453    pub fn summary_for_anchor<D>(&self, anchor: &Anchor) -> D
1454    where
1455        D: TextDimension + Ord + Sub<D, Output = D>,
1456    {
1457        let mut cursor = self.excerpts.cursor::<ExcerptSummary>();
1458        cursor.seek(&Some(&anchor.excerpt_id), Bias::Left, &());
1459        if cursor.item().is_none() {
1460            cursor.next(&());
1461        }
1462
1463        let mut position = D::from_text_summary(&cursor.start().text);
1464        if let Some(excerpt) = cursor.item() {
1465            if excerpt.id == anchor.excerpt_id && excerpt.buffer_id == anchor.buffer_id {
1466                let excerpt_buffer_start = excerpt.range.start.summary::<D>(&excerpt.buffer);
1467                let excerpt_buffer_end = excerpt.range.end.summary::<D>(&excerpt.buffer);
1468                let buffer_position = cmp::min(
1469                    excerpt_buffer_end,
1470                    anchor.text_anchor.summary::<D>(&excerpt.buffer),
1471                );
1472                if buffer_position > excerpt_buffer_start {
1473                    position.add_assign(&(buffer_position - excerpt_buffer_start));
1474                }
1475            }
1476        }
1477        position
1478    }
1479
1480    pub fn summaries_for_anchors<'a, D, I>(&'a self, anchors: I) -> Vec<D>
1481    where
1482        D: TextDimension + Ord + Sub<D, Output = D>,
1483        I: 'a + IntoIterator<Item = &'a Anchor>,
1484    {
1485        let mut anchors = anchors.into_iter().peekable();
1486        let mut cursor = self.excerpts.cursor::<ExcerptSummary>();
1487        let mut summaries = Vec::new();
1488        while let Some(anchor) = anchors.peek() {
1489            let excerpt_id = &anchor.excerpt_id;
1490            let buffer_id = anchor.buffer_id;
1491            let excerpt_anchors = iter::from_fn(|| {
1492                let anchor = anchors.peek()?;
1493                if anchor.excerpt_id == *excerpt_id && anchor.buffer_id == buffer_id {
1494                    Some(&anchors.next().unwrap().text_anchor)
1495                } else {
1496                    None
1497                }
1498            });
1499
1500            cursor.seek_forward(&Some(excerpt_id), Bias::Left, &());
1501            if cursor.item().is_none() {
1502                cursor.next(&());
1503            }
1504
1505            let position = D::from_text_summary(&cursor.start().text);
1506            if let Some(excerpt) = cursor.item() {
1507                if excerpt.id == *excerpt_id && excerpt.buffer_id == buffer_id {
1508                    let excerpt_buffer_start = excerpt.range.start.summary::<D>(&excerpt.buffer);
1509                    let excerpt_buffer_end = excerpt.range.end.summary::<D>(&excerpt.buffer);
1510                    summaries.extend(
1511                        excerpt
1512                            .buffer
1513                            .summaries_for_anchors::<D, _>(excerpt_anchors)
1514                            .map(move |summary| {
1515                                let summary = cmp::min(excerpt_buffer_end.clone(), summary);
1516                                let mut position = position.clone();
1517                                let excerpt_buffer_start = excerpt_buffer_start.clone();
1518                                if summary > excerpt_buffer_start {
1519                                    position.add_assign(&(summary - excerpt_buffer_start));
1520                                }
1521                                position
1522                            }),
1523                    );
1524                    continue;
1525                }
1526            }
1527
1528            summaries.extend(excerpt_anchors.map(|_| position.clone()));
1529        }
1530
1531        summaries
1532    }
1533
1534    pub fn refresh_anchors<'a, I>(&'a self, anchors: I) -> Vec<(usize, Anchor, bool)>
1535    where
1536        I: 'a + IntoIterator<Item = &'a Anchor>,
1537    {
1538        let mut anchors = anchors.into_iter().enumerate().peekable();
1539        let mut cursor = self.excerpts.cursor::<Option<&ExcerptId>>();
1540        let mut result = Vec::new();
1541        while let Some((_, anchor)) = anchors.peek() {
1542            let old_excerpt_id = &anchor.excerpt_id;
1543
1544            // Find the location where this anchor's excerpt should be.
1545            cursor.seek_forward(&Some(old_excerpt_id), Bias::Left, &());
1546            if cursor.item().is_none() {
1547                cursor.next(&());
1548            }
1549
1550            let next_excerpt = cursor.item();
1551            let prev_excerpt = cursor.prev_item();
1552
1553            // Process all of the anchors for this excerpt.
1554            while let Some((_, anchor)) = anchors.peek() {
1555                if anchor.excerpt_id != *old_excerpt_id {
1556                    break;
1557                }
1558                let mut kept_position = false;
1559                let (anchor_ix, anchor) = anchors.next().unwrap();
1560                let mut anchor = anchor.clone();
1561
1562                // Leave min and max anchors unchanged.
1563                if *old_excerpt_id == ExcerptId::max() || *old_excerpt_id == ExcerptId::min() {
1564                    kept_position = true;
1565                }
1566                // If the old excerpt still exists at this location, then leave
1567                // the anchor unchanged.
1568                else if next_excerpt.map_or(false, |excerpt| {
1569                    excerpt.id == *old_excerpt_id && excerpt.contains(&anchor)
1570                }) {
1571                    kept_position = true;
1572                }
1573                // If the old excerpt no longer exists at this location, then attempt to
1574                // find an equivalent position for this anchor in an adjacent excerpt.
1575                else {
1576                    for excerpt in [next_excerpt, prev_excerpt].iter().filter_map(|e| *e) {
1577                        if excerpt.contains(&anchor) {
1578                            anchor.excerpt_id = excerpt.id.clone();
1579                            kept_position = true;
1580                            break;
1581                        }
1582                    }
1583                }
1584                // If there's no adjacent excerpt that contains the anchor's position,
1585                // then report that the anchor has lost its position.
1586                if !kept_position {
1587                    anchor = if let Some(excerpt) = next_excerpt {
1588                        let mut text_anchor = excerpt
1589                            .range
1590                            .start
1591                            .bias(anchor.text_anchor.bias, &excerpt.buffer);
1592                        if text_anchor
1593                            .cmp(&excerpt.range.end, &excerpt.buffer)
1594                            .unwrap()
1595                            .is_gt()
1596                        {
1597                            text_anchor = excerpt.range.end.clone();
1598                        }
1599                        Anchor {
1600                            buffer_id: excerpt.buffer_id,
1601                            excerpt_id: excerpt.id.clone(),
1602                            text_anchor,
1603                        }
1604                    } else if let Some(excerpt) = prev_excerpt {
1605                        let mut text_anchor = excerpt
1606                            .range
1607                            .end
1608                            .bias(anchor.text_anchor.bias, &excerpt.buffer);
1609                        if text_anchor
1610                            .cmp(&excerpt.range.start, &excerpt.buffer)
1611                            .unwrap()
1612                            .is_lt()
1613                        {
1614                            text_anchor = excerpt.range.start.clone();
1615                        }
1616                        Anchor {
1617                            buffer_id: excerpt.buffer_id,
1618                            excerpt_id: excerpt.id.clone(),
1619                            text_anchor,
1620                        }
1621                    } else if anchor.text_anchor.bias == Bias::Left {
1622                        Anchor::min()
1623                    } else {
1624                        Anchor::max()
1625                    };
1626                }
1627
1628                result.push((anchor_ix, anchor, kept_position));
1629            }
1630        }
1631        result.sort_unstable_by(|a, b| a.1.cmp(&b.1, self).unwrap());
1632        result
1633    }
1634
1635    pub fn anchor_before<T: ToOffset>(&self, position: T) -> Anchor {
1636        self.anchor_at(position, Bias::Left)
1637    }
1638
1639    pub fn anchor_after<T: ToOffset>(&self, position: T) -> Anchor {
1640        self.anchor_at(position, Bias::Right)
1641    }
1642
1643    pub fn anchor_at<T: ToOffset>(&self, position: T, mut bias: Bias) -> Anchor {
1644        let offset = position.to_offset(self);
1645        if let Some(excerpt) = self.as_singleton() {
1646            return Anchor {
1647                buffer_id: excerpt.buffer_id,
1648                excerpt_id: excerpt.id.clone(),
1649                text_anchor: excerpt.buffer.anchor_at(offset, bias),
1650            };
1651        }
1652
1653        let mut cursor = self.excerpts.cursor::<(usize, Option<&ExcerptId>)>();
1654        cursor.seek(&offset, Bias::Right, &());
1655        if cursor.item().is_none() && offset == cursor.start().0 && bias == Bias::Left {
1656            cursor.prev(&());
1657        }
1658        if let Some(excerpt) = cursor.item() {
1659            let mut overshoot = offset.saturating_sub(cursor.start().0);
1660            if excerpt.has_trailing_newline && offset == cursor.end(&()).0 {
1661                overshoot -= 1;
1662                bias = Bias::Right;
1663            }
1664
1665            let buffer_start = excerpt.range.start.to_offset(&excerpt.buffer);
1666            let text_anchor =
1667                excerpt.clip_anchor(excerpt.buffer.anchor_at(buffer_start + overshoot, bias));
1668            Anchor {
1669                buffer_id: excerpt.buffer_id,
1670                excerpt_id: excerpt.id.clone(),
1671                text_anchor,
1672            }
1673        } else if offset == 0 && bias == Bias::Left {
1674            Anchor::min()
1675        } else {
1676            Anchor::max()
1677        }
1678    }
1679
1680    pub fn anchor_in_excerpt(&self, excerpt_id: ExcerptId, text_anchor: text::Anchor) -> Anchor {
1681        let mut cursor = self.excerpts.cursor::<Option<&ExcerptId>>();
1682        cursor.seek(&Some(&excerpt_id), Bias::Left, &());
1683        if let Some(excerpt) = cursor.item() {
1684            if excerpt.id == excerpt_id {
1685                let text_anchor = excerpt.clip_anchor(text_anchor);
1686                drop(cursor);
1687                return Anchor {
1688                    buffer_id: excerpt.buffer_id,
1689                    excerpt_id,
1690                    text_anchor,
1691                };
1692            }
1693        }
1694        panic!("excerpt not found");
1695    }
1696
1697    pub fn can_resolve(&self, anchor: &Anchor) -> bool {
1698        if anchor.excerpt_id == ExcerptId::min() || anchor.excerpt_id == ExcerptId::max() {
1699            true
1700        } else if let Some((buffer_id, buffer_snapshot)) =
1701            self.buffer_snapshot_for_excerpt(&anchor.excerpt_id)
1702        {
1703            anchor.buffer_id == buffer_id && buffer_snapshot.can_resolve(&anchor.text_anchor)
1704        } else {
1705            false
1706        }
1707    }
1708
1709    pub fn range_contains_excerpt_boundary<T: ToOffset>(&self, range: Range<T>) -> bool {
1710        let start = range.start.to_offset(self);
1711        let end = range.end.to_offset(self);
1712        let mut cursor = self.excerpts.cursor::<(usize, Option<&ExcerptId>)>();
1713        cursor.seek(&start, Bias::Right, &());
1714        let start_id = cursor
1715            .item()
1716            .or_else(|| cursor.prev_item())
1717            .map(|excerpt| &excerpt.id);
1718        cursor.seek_forward(&end, Bias::Right, &());
1719        let end_id = cursor
1720            .item()
1721            .or_else(|| cursor.prev_item())
1722            .map(|excerpt| &excerpt.id);
1723        start_id != end_id
1724    }
1725
1726    pub fn parse_count(&self) -> usize {
1727        self.parse_count
1728    }
1729
1730    pub fn enclosing_bracket_ranges<T: ToOffset>(
1731        &self,
1732        range: Range<T>,
1733    ) -> Option<(Range<usize>, Range<usize>)> {
1734        let range = range.start.to_offset(self)..range.end.to_offset(self);
1735
1736        let mut cursor = self.excerpts.cursor::<usize>();
1737        cursor.seek(&range.start, Bias::Right, &());
1738        let start_excerpt = cursor.item();
1739
1740        cursor.seek(&range.end, Bias::Right, &());
1741        let end_excerpt = cursor.item();
1742
1743        start_excerpt
1744            .zip(end_excerpt)
1745            .and_then(|(start_excerpt, end_excerpt)| {
1746                if start_excerpt.id != end_excerpt.id {
1747                    return None;
1748                }
1749
1750                let excerpt_buffer_start =
1751                    start_excerpt.range.start.to_offset(&start_excerpt.buffer);
1752                let excerpt_buffer_end = excerpt_buffer_start + start_excerpt.text_summary.bytes;
1753
1754                let start_in_buffer =
1755                    excerpt_buffer_start + range.start.saturating_sub(*cursor.start());
1756                let end_in_buffer =
1757                    excerpt_buffer_start + range.end.saturating_sub(*cursor.start());
1758                let (mut start_bracket_range, mut end_bracket_range) = start_excerpt
1759                    .buffer
1760                    .enclosing_bracket_ranges(start_in_buffer..end_in_buffer)?;
1761
1762                if start_bracket_range.start >= excerpt_buffer_start
1763                    && end_bracket_range.end < excerpt_buffer_end
1764                {
1765                    start_bracket_range.start =
1766                        cursor.start() + (start_bracket_range.start - excerpt_buffer_start);
1767                    start_bracket_range.end =
1768                        cursor.start() + (start_bracket_range.end - excerpt_buffer_start);
1769                    end_bracket_range.start =
1770                        cursor.start() + (end_bracket_range.start - excerpt_buffer_start);
1771                    end_bracket_range.end =
1772                        cursor.start() + (end_bracket_range.end - excerpt_buffer_start);
1773                    Some((start_bracket_range, end_bracket_range))
1774                } else {
1775                    None
1776                }
1777            })
1778    }
1779
1780    pub fn diagnostics_update_count(&self) -> usize {
1781        self.diagnostics_update_count
1782    }
1783
1784    pub fn language(&self) -> Option<&Arc<Language>> {
1785        self.excerpts
1786            .iter()
1787            .next()
1788            .and_then(|excerpt| excerpt.buffer.language())
1789    }
1790
1791    pub fn is_dirty(&self) -> bool {
1792        self.is_dirty
1793    }
1794
1795    pub fn has_conflict(&self) -> bool {
1796        self.has_conflict
1797    }
1798
1799    pub fn diagnostic_group<'a, O>(
1800        &'a self,
1801        group_id: usize,
1802    ) -> impl Iterator<Item = DiagnosticEntry<O>> + 'a
1803    where
1804        O: text::FromAnchor + 'a,
1805    {
1806        self.as_singleton()
1807            .into_iter()
1808            .flat_map(move |excerpt| excerpt.buffer.diagnostic_group(group_id))
1809    }
1810
1811    pub fn diagnostics_in_range<'a, T, O>(
1812        &'a self,
1813        range: Range<T>,
1814    ) -> impl Iterator<Item = DiagnosticEntry<O>> + 'a
1815    where
1816        T: 'a + ToOffset,
1817        O: 'a + text::FromAnchor,
1818    {
1819        self.as_singleton().into_iter().flat_map(move |excerpt| {
1820            excerpt
1821                .buffer
1822                .diagnostics_in_range(range.start.to_offset(self)..range.end.to_offset(self))
1823        })
1824    }
1825
1826    pub fn range_for_syntax_ancestor<T: ToOffset>(&self, range: Range<T>) -> Option<Range<usize>> {
1827        let range = range.start.to_offset(self)..range.end.to_offset(self);
1828
1829        let mut cursor = self.excerpts.cursor::<usize>();
1830        cursor.seek(&range.start, Bias::Right, &());
1831        let start_excerpt = cursor.item();
1832
1833        cursor.seek(&range.end, Bias::Right, &());
1834        let end_excerpt = cursor.item();
1835
1836        start_excerpt
1837            .zip(end_excerpt)
1838            .and_then(|(start_excerpt, end_excerpt)| {
1839                if start_excerpt.id != end_excerpt.id {
1840                    return None;
1841                }
1842
1843                let excerpt_buffer_start =
1844                    start_excerpt.range.start.to_offset(&start_excerpt.buffer);
1845                let excerpt_buffer_end = excerpt_buffer_start + start_excerpt.text_summary.bytes;
1846
1847                let start_in_buffer =
1848                    excerpt_buffer_start + range.start.saturating_sub(*cursor.start());
1849                let end_in_buffer =
1850                    excerpt_buffer_start + range.end.saturating_sub(*cursor.start());
1851                let mut ancestor_buffer_range = start_excerpt
1852                    .buffer
1853                    .range_for_syntax_ancestor(start_in_buffer..end_in_buffer)?;
1854                ancestor_buffer_range.start =
1855                    cmp::max(ancestor_buffer_range.start, excerpt_buffer_start);
1856                ancestor_buffer_range.end = cmp::min(ancestor_buffer_range.end, excerpt_buffer_end);
1857
1858                let start = cursor.start() + (ancestor_buffer_range.start - excerpt_buffer_start);
1859                let end = cursor.start() + (ancestor_buffer_range.end - excerpt_buffer_start);
1860                Some(start..end)
1861            })
1862    }
1863
1864    pub fn outline(&self, theme: Option<&SyntaxTheme>) -> Option<Outline<Anchor>> {
1865        let excerpt = self.as_singleton()?;
1866        let outline = excerpt.buffer.outline(theme)?;
1867        Some(Outline::new(
1868            outline
1869                .items
1870                .into_iter()
1871                .map(|item| OutlineItem {
1872                    depth: item.depth,
1873                    range: self.anchor_in_excerpt(excerpt.id.clone(), item.range.start)
1874                        ..self.anchor_in_excerpt(excerpt.id.clone(), item.range.end),
1875                    text: item.text,
1876                    highlight_ranges: item.highlight_ranges,
1877                    name_ranges: item.name_ranges,
1878                })
1879                .collect(),
1880        ))
1881    }
1882
1883    fn buffer_snapshot_for_excerpt<'a>(
1884        &'a self,
1885        excerpt_id: &'a ExcerptId,
1886    ) -> Option<(usize, &'a BufferSnapshot)> {
1887        let mut cursor = self.excerpts.cursor::<Option<&ExcerptId>>();
1888        cursor.seek(&Some(excerpt_id), Bias::Left, &());
1889        if let Some(excerpt) = cursor.item() {
1890            if excerpt.id == *excerpt_id {
1891                return Some((excerpt.buffer_id, &excerpt.buffer));
1892            }
1893        }
1894        None
1895    }
1896
1897    pub fn remote_selections_in_range<'a>(
1898        &'a self,
1899        range: &'a Range<Anchor>,
1900    ) -> impl 'a + Iterator<Item = (ReplicaId, Selection<Anchor>)> {
1901        let mut cursor = self.excerpts.cursor::<Option<&ExcerptId>>();
1902        cursor.seek(&Some(&range.start.excerpt_id), Bias::Left, &());
1903        cursor
1904            .take_while(move |excerpt| excerpt.id <= range.end.excerpt_id)
1905            .flat_map(move |excerpt| {
1906                let mut query_range = excerpt.range.start.clone()..excerpt.range.end.clone();
1907                if excerpt.id == range.start.excerpt_id {
1908                    query_range.start = range.start.text_anchor.clone();
1909                }
1910                if excerpt.id == range.end.excerpt_id {
1911                    query_range.end = range.end.text_anchor.clone();
1912                }
1913
1914                excerpt
1915                    .buffer
1916                    .remote_selections_in_range(query_range)
1917                    .flat_map(move |(replica_id, selections)| {
1918                        selections.map(move |selection| {
1919                            let mut start = Anchor {
1920                                buffer_id: excerpt.buffer_id,
1921                                excerpt_id: excerpt.id.clone(),
1922                                text_anchor: selection.start.clone(),
1923                            };
1924                            let mut end = Anchor {
1925                                buffer_id: excerpt.buffer_id,
1926                                excerpt_id: excerpt.id.clone(),
1927                                text_anchor: selection.end.clone(),
1928                            };
1929                            if range.start.cmp(&start, self).unwrap().is_gt() {
1930                                start = range.start.clone();
1931                            }
1932                            if range.end.cmp(&end, self).unwrap().is_lt() {
1933                                end = range.end.clone();
1934                            }
1935
1936                            (
1937                                replica_id,
1938                                Selection {
1939                                    id: selection.id,
1940                                    start,
1941                                    end,
1942                                    reversed: selection.reversed,
1943                                    goal: selection.goal,
1944                                },
1945                            )
1946                        })
1947                    })
1948            })
1949    }
1950}
1951
1952impl History {
1953    fn start_transaction(&mut self, now: Instant) -> Option<TransactionId> {
1954        self.transaction_depth += 1;
1955        if self.transaction_depth == 1 {
1956            let id = post_inc(&mut self.next_transaction_id);
1957            self.undo_stack.push(Transaction {
1958                id,
1959                buffer_transactions: Default::default(),
1960                first_edit_at: now,
1961                last_edit_at: now,
1962            });
1963            Some(id)
1964        } else {
1965            None
1966        }
1967    }
1968
1969    fn end_transaction(
1970        &mut self,
1971        now: Instant,
1972        buffer_transactions: HashSet<(usize, TransactionId)>,
1973    ) -> bool {
1974        assert_ne!(self.transaction_depth, 0);
1975        self.transaction_depth -= 1;
1976        if self.transaction_depth == 0 {
1977            if buffer_transactions.is_empty() {
1978                self.undo_stack.pop();
1979                false
1980            } else {
1981                let transaction = self.undo_stack.last_mut().unwrap();
1982                transaction.last_edit_at = now;
1983                transaction.buffer_transactions.extend(buffer_transactions);
1984                true
1985            }
1986        } else {
1987            false
1988        }
1989    }
1990
1991    fn pop_undo(&mut self) -> Option<&Transaction> {
1992        assert_eq!(self.transaction_depth, 0);
1993        if let Some(transaction) = self.undo_stack.pop() {
1994            self.redo_stack.push(transaction);
1995            self.redo_stack.last()
1996        } else {
1997            None
1998        }
1999    }
2000
2001    fn pop_redo(&mut self) -> Option<&Transaction> {
2002        assert_eq!(self.transaction_depth, 0);
2003        if let Some(transaction) = self.redo_stack.pop() {
2004            self.undo_stack.push(transaction);
2005            self.undo_stack.last()
2006        } else {
2007            None
2008        }
2009    }
2010
2011    fn group(&mut self) -> Option<TransactionId> {
2012        let mut new_len = self.undo_stack.len();
2013        let mut transactions = self.undo_stack.iter_mut();
2014
2015        if let Some(mut transaction) = transactions.next_back() {
2016            while let Some(prev_transaction) = transactions.next_back() {
2017                if transaction.first_edit_at - prev_transaction.last_edit_at <= self.group_interval
2018                {
2019                    transaction = prev_transaction;
2020                    new_len -= 1;
2021                } else {
2022                    break;
2023                }
2024            }
2025        }
2026
2027        let (transactions_to_keep, transactions_to_merge) = self.undo_stack.split_at_mut(new_len);
2028        if let Some(last_transaction) = transactions_to_keep.last_mut() {
2029            if let Some(transaction) = transactions_to_merge.last() {
2030                last_transaction.last_edit_at = transaction.last_edit_at;
2031            }
2032        }
2033
2034        self.undo_stack.truncate(new_len);
2035        self.undo_stack.last().map(|t| t.id)
2036    }
2037}
2038
2039impl Excerpt {
2040    fn new(
2041        id: ExcerptId,
2042        buffer_id: usize,
2043        buffer: BufferSnapshot,
2044        range: Range<text::Anchor>,
2045        has_trailing_newline: bool,
2046    ) -> Self {
2047        Excerpt {
2048            id,
2049            max_buffer_row: range.end.to_point(&buffer).row,
2050            text_summary: buffer.text_summary_for_range::<TextSummary, _>(range.to_offset(&buffer)),
2051            buffer_id,
2052            buffer,
2053            range,
2054            has_trailing_newline,
2055        }
2056    }
2057
2058    fn chunks_in_range<'a>(
2059        &'a self,
2060        range: Range<usize>,
2061        theme: Option<&'a SyntaxTheme>,
2062    ) -> ExcerptChunks<'a> {
2063        let content_start = self.range.start.to_offset(&self.buffer);
2064        let chunks_start = content_start + range.start;
2065        let chunks_end = content_start + cmp::min(range.end, self.text_summary.bytes);
2066
2067        let footer_height = if self.has_trailing_newline
2068            && range.start <= self.text_summary.bytes
2069            && range.end > self.text_summary.bytes
2070        {
2071            1
2072        } else {
2073            0
2074        };
2075
2076        let content_chunks = self.buffer.chunks(chunks_start..chunks_end, theme);
2077
2078        ExcerptChunks {
2079            content_chunks,
2080            footer_height,
2081        }
2082    }
2083
2084    fn bytes_in_range(&self, range: Range<usize>) -> ExcerptBytes {
2085        let content_start = self.range.start.to_offset(&self.buffer);
2086        let bytes_start = content_start + range.start;
2087        let bytes_end = content_start + cmp::min(range.end, self.text_summary.bytes);
2088        let footer_height = if self.has_trailing_newline
2089            && range.start <= self.text_summary.bytes
2090            && range.end > self.text_summary.bytes
2091        {
2092            1
2093        } else {
2094            0
2095        };
2096        let content_bytes = self.buffer.bytes_in_range(bytes_start..bytes_end);
2097
2098        ExcerptBytes {
2099            content_bytes,
2100            footer_height,
2101        }
2102    }
2103
2104    fn clip_anchor(&self, text_anchor: text::Anchor) -> text::Anchor {
2105        if text_anchor
2106            .cmp(&self.range.start, &self.buffer)
2107            .unwrap()
2108            .is_lt()
2109        {
2110            self.range.start.clone()
2111        } else if text_anchor
2112            .cmp(&self.range.end, &self.buffer)
2113            .unwrap()
2114            .is_gt()
2115        {
2116            self.range.end.clone()
2117        } else {
2118            text_anchor
2119        }
2120    }
2121
2122    fn contains(&self, anchor: &Anchor) -> bool {
2123        self.buffer_id == anchor.buffer_id
2124            && self
2125                .range
2126                .start
2127                .cmp(&anchor.text_anchor, &self.buffer)
2128                .unwrap()
2129                .is_le()
2130            && self
2131                .range
2132                .end
2133                .cmp(&anchor.text_anchor, &self.buffer)
2134                .unwrap()
2135                .is_ge()
2136    }
2137}
2138
2139impl fmt::Debug for Excerpt {
2140    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2141        f.debug_struct("Excerpt")
2142            .field("id", &self.id)
2143            .field("buffer_id", &self.buffer_id)
2144            .field("range", &self.range)
2145            .field("text_summary", &self.text_summary)
2146            .field("has_trailing_newline", &self.has_trailing_newline)
2147            .finish()
2148    }
2149}
2150
2151impl sum_tree::Item for Excerpt {
2152    type Summary = ExcerptSummary;
2153
2154    fn summary(&self) -> Self::Summary {
2155        let mut text = self.text_summary.clone();
2156        if self.has_trailing_newline {
2157            text += TextSummary::from("\n");
2158        }
2159        ExcerptSummary {
2160            excerpt_id: self.id.clone(),
2161            max_buffer_row: self.max_buffer_row,
2162            text,
2163        }
2164    }
2165}
2166
2167impl sum_tree::Summary for ExcerptSummary {
2168    type Context = ();
2169
2170    fn add_summary(&mut self, summary: &Self, _: &()) {
2171        debug_assert!(summary.excerpt_id > self.excerpt_id);
2172        self.excerpt_id = summary.excerpt_id.clone();
2173        self.text.add_summary(&summary.text, &());
2174        self.max_buffer_row = cmp::max(self.max_buffer_row, summary.max_buffer_row);
2175    }
2176}
2177
2178impl<'a> sum_tree::Dimension<'a, ExcerptSummary> for TextSummary {
2179    fn add_summary(&mut self, summary: &'a ExcerptSummary, _: &()) {
2180        *self += &summary.text;
2181    }
2182}
2183
2184impl<'a> sum_tree::Dimension<'a, ExcerptSummary> for usize {
2185    fn add_summary(&mut self, summary: &'a ExcerptSummary, _: &()) {
2186        *self += summary.text.bytes;
2187    }
2188}
2189
2190impl<'a> sum_tree::SeekTarget<'a, ExcerptSummary, ExcerptSummary> for usize {
2191    fn cmp(&self, cursor_location: &ExcerptSummary, _: &()) -> cmp::Ordering {
2192        Ord::cmp(self, &cursor_location.text.bytes)
2193    }
2194}
2195
2196impl<'a> sum_tree::SeekTarget<'a, ExcerptSummary, ExcerptSummary> for Option<&'a ExcerptId> {
2197    fn cmp(&self, cursor_location: &ExcerptSummary, _: &()) -> cmp::Ordering {
2198        Ord::cmp(self, &Some(&cursor_location.excerpt_id))
2199    }
2200}
2201
2202impl<'a> sum_tree::Dimension<'a, ExcerptSummary> for Point {
2203    fn add_summary(&mut self, summary: &'a ExcerptSummary, _: &()) {
2204        *self += summary.text.lines;
2205    }
2206}
2207
2208impl<'a> sum_tree::Dimension<'a, ExcerptSummary> for PointUtf16 {
2209    fn add_summary(&mut self, summary: &'a ExcerptSummary, _: &()) {
2210        *self += summary.text.lines_utf16
2211    }
2212}
2213
2214impl<'a> sum_tree::Dimension<'a, ExcerptSummary> for Option<&'a ExcerptId> {
2215    fn add_summary(&mut self, summary: &'a ExcerptSummary, _: &()) {
2216        *self = Some(&summary.excerpt_id);
2217    }
2218}
2219
2220impl<'a> MultiBufferRows<'a> {
2221    pub fn seek(&mut self, row: u32) {
2222        self.buffer_row_range = 0..0;
2223
2224        self.excerpts
2225            .seek_forward(&Point::new(row, 0), Bias::Right, &());
2226        if self.excerpts.item().is_none() {
2227            self.excerpts.prev(&());
2228
2229            if self.excerpts.item().is_none() && row == 0 {
2230                self.buffer_row_range = 0..1;
2231                return;
2232            }
2233        }
2234
2235        if let Some(excerpt) = self.excerpts.item() {
2236            let overshoot = row - self.excerpts.start().row;
2237            let excerpt_start = excerpt.range.start.to_point(&excerpt.buffer).row;
2238            self.buffer_row_range.start = excerpt_start + overshoot;
2239            self.buffer_row_range.end = excerpt_start + excerpt.text_summary.lines.row + 1;
2240        }
2241    }
2242}
2243
2244impl<'a> Iterator for MultiBufferRows<'a> {
2245    type Item = Option<u32>;
2246
2247    fn next(&mut self) -> Option<Self::Item> {
2248        loop {
2249            if !self.buffer_row_range.is_empty() {
2250                let row = Some(self.buffer_row_range.start);
2251                self.buffer_row_range.start += 1;
2252                return Some(row);
2253            }
2254            self.excerpts.item()?;
2255            self.excerpts.next(&());
2256            let excerpt = self.excerpts.item()?;
2257            self.buffer_row_range.start = excerpt.range.start.to_point(&excerpt.buffer).row;
2258            self.buffer_row_range.end =
2259                self.buffer_row_range.start + excerpt.text_summary.lines.row + 1;
2260        }
2261    }
2262}
2263
2264impl<'a> MultiBufferChunks<'a> {
2265    pub fn offset(&self) -> usize {
2266        self.range.start
2267    }
2268
2269    pub fn seek(&mut self, offset: usize) {
2270        self.range.start = offset;
2271        self.excerpts.seek(&offset, Bias::Right, &());
2272        if let Some(excerpt) = self.excerpts.item() {
2273            self.excerpt_chunks = Some(excerpt.chunks_in_range(
2274                self.range.start - self.excerpts.start()..self.range.end - self.excerpts.start(),
2275                self.theme,
2276            ));
2277        } else {
2278            self.excerpt_chunks = None;
2279        }
2280    }
2281}
2282
2283impl<'a> Iterator for MultiBufferChunks<'a> {
2284    type Item = Chunk<'a>;
2285
2286    fn next(&mut self) -> Option<Self::Item> {
2287        if self.range.is_empty() {
2288            None
2289        } else if let Some(chunk) = self.excerpt_chunks.as_mut()?.next() {
2290            self.range.start += chunk.text.len();
2291            Some(chunk)
2292        } else {
2293            self.excerpts.next(&());
2294            let excerpt = self.excerpts.item()?;
2295            self.excerpt_chunks = Some(
2296                excerpt.chunks_in_range(0..self.range.end - self.excerpts.start(), self.theme),
2297            );
2298            self.next()
2299        }
2300    }
2301}
2302
2303impl<'a> MultiBufferBytes<'a> {
2304    fn consume(&mut self, len: usize) {
2305        self.range.start += len;
2306        self.chunk = &self.chunk[len..];
2307
2308        if !self.range.is_empty() && self.chunk.is_empty() {
2309            if let Some(chunk) = self.excerpt_bytes.as_mut().and_then(|bytes| bytes.next()) {
2310                self.chunk = chunk;
2311            } else {
2312                self.excerpts.next(&());
2313                if let Some(excerpt) = self.excerpts.item() {
2314                    let mut excerpt_bytes =
2315                        excerpt.bytes_in_range(0..self.range.end - self.excerpts.start());
2316                    self.chunk = excerpt_bytes.next().unwrap();
2317                    self.excerpt_bytes = Some(excerpt_bytes);
2318                }
2319            }
2320        }
2321    }
2322}
2323
2324impl<'a> Iterator for MultiBufferBytes<'a> {
2325    type Item = &'a [u8];
2326
2327    fn next(&mut self) -> Option<Self::Item> {
2328        let chunk = self.chunk;
2329        if chunk.is_empty() {
2330            None
2331        } else {
2332            self.consume(chunk.len());
2333            Some(chunk)
2334        }
2335    }
2336}
2337
2338impl<'a> io::Read for MultiBufferBytes<'a> {
2339    fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
2340        let len = cmp::min(buf.len(), self.chunk.len());
2341        buf[..len].copy_from_slice(&self.chunk[..len]);
2342        if len > 0 {
2343            self.consume(len);
2344        }
2345        Ok(len)
2346    }
2347}
2348
2349impl<'a> Iterator for ExcerptBytes<'a> {
2350    type Item = &'a [u8];
2351
2352    fn next(&mut self) -> Option<Self::Item> {
2353        if let Some(chunk) = self.content_bytes.next() {
2354            if !chunk.is_empty() {
2355                return Some(chunk);
2356            }
2357        }
2358
2359        if self.footer_height > 0 {
2360            let result = &NEWLINES[..self.footer_height];
2361            self.footer_height = 0;
2362            return Some(result);
2363        }
2364
2365        None
2366    }
2367}
2368
2369impl<'a> Iterator for ExcerptChunks<'a> {
2370    type Item = Chunk<'a>;
2371
2372    fn next(&mut self) -> Option<Self::Item> {
2373        if let Some(chunk) = self.content_chunks.next() {
2374            return Some(chunk);
2375        }
2376
2377        if self.footer_height > 0 {
2378            let text = unsafe { str::from_utf8_unchecked(&NEWLINES[..self.footer_height]) };
2379            self.footer_height = 0;
2380            return Some(Chunk {
2381                text,
2382                ..Default::default()
2383            });
2384        }
2385
2386        None
2387    }
2388}
2389
2390impl ToOffset for Point {
2391    fn to_offset<'a>(&self, snapshot: &MultiBufferSnapshot) -> usize {
2392        snapshot.point_to_offset(*self)
2393    }
2394}
2395
2396impl ToOffset for PointUtf16 {
2397    fn to_offset<'a>(&self, snapshot: &MultiBufferSnapshot) -> usize {
2398        snapshot.point_utf16_to_offset(*self)
2399    }
2400}
2401
2402impl ToOffset for usize {
2403    fn to_offset<'a>(&self, snapshot: &MultiBufferSnapshot) -> usize {
2404        assert!(*self <= snapshot.len(), "offset is out of range");
2405        *self
2406    }
2407}
2408
2409impl ToPoint for usize {
2410    fn to_point<'a>(&self, snapshot: &MultiBufferSnapshot) -> Point {
2411        snapshot.offset_to_point(*self)
2412    }
2413}
2414
2415impl ToPoint for Point {
2416    fn to_point<'a>(&self, _: &MultiBufferSnapshot) -> Point {
2417        *self
2418    }
2419}
2420
2421#[cfg(test)]
2422mod tests {
2423    use super::*;
2424    use gpui::MutableAppContext;
2425    use language::{Buffer, Rope};
2426    use rand::prelude::*;
2427    use std::env;
2428    use text::{Point, RandomCharIter};
2429    use util::test::sample_text;
2430
2431    #[gpui::test]
2432    fn test_singleton_multibuffer(cx: &mut MutableAppContext) {
2433        let buffer = cx.add_model(|cx| Buffer::new(0, sample_text(6, 6, 'a'), cx));
2434        let multibuffer = cx.add_model(|cx| MultiBuffer::singleton(buffer.clone(), cx));
2435
2436        let snapshot = multibuffer.read(cx).snapshot(cx);
2437        assert_eq!(snapshot.text(), buffer.read(cx).text());
2438
2439        assert_eq!(
2440            snapshot.buffer_rows(0).collect::<Vec<_>>(),
2441            (0..buffer.read(cx).row_count())
2442                .map(Some)
2443                .collect::<Vec<_>>()
2444        );
2445
2446        buffer.update(cx, |buffer, cx| buffer.edit([1..3], "XXX\n", cx));
2447        let snapshot = multibuffer.read(cx).snapshot(cx);
2448
2449        assert_eq!(snapshot.text(), buffer.read(cx).text());
2450        assert_eq!(
2451            snapshot.buffer_rows(0).collect::<Vec<_>>(),
2452            (0..buffer.read(cx).row_count())
2453                .map(Some)
2454                .collect::<Vec<_>>()
2455        );
2456    }
2457
2458    #[gpui::test]
2459    fn test_remote_multibuffer(cx: &mut MutableAppContext) {
2460        let host_buffer = cx.add_model(|cx| Buffer::new(0, "a", cx));
2461        let guest_buffer = cx.add_model(|cx| {
2462            let message = host_buffer.read(cx).to_proto();
2463            Buffer::from_proto(1, message, None, cx).unwrap()
2464        });
2465        let multibuffer = cx.add_model(|cx| MultiBuffer::singleton(guest_buffer.clone(), cx));
2466        let snapshot = multibuffer.read(cx).snapshot(cx);
2467        assert_eq!(snapshot.text(), "a");
2468
2469        guest_buffer.update(cx, |buffer, cx| buffer.edit([1..1], "b", cx));
2470        let snapshot = multibuffer.read(cx).snapshot(cx);
2471        assert_eq!(snapshot.text(), "ab");
2472
2473        guest_buffer.update(cx, |buffer, cx| buffer.edit([2..2], "c", cx));
2474        let snapshot = multibuffer.read(cx).snapshot(cx);
2475        assert_eq!(snapshot.text(), "abc");
2476    }
2477
2478    #[gpui::test]
2479    fn test_excerpt_buffer(cx: &mut MutableAppContext) {
2480        let buffer_1 = cx.add_model(|cx| Buffer::new(0, sample_text(6, 6, 'a'), cx));
2481        let buffer_2 = cx.add_model(|cx| Buffer::new(0, sample_text(6, 6, 'g'), cx));
2482        let multibuffer = cx.add_model(|_| MultiBuffer::new(0));
2483
2484        let subscription = multibuffer.update(cx, |multibuffer, cx| {
2485            let subscription = multibuffer.subscribe();
2486            multibuffer.push_excerpt(
2487                ExcerptProperties {
2488                    buffer: &buffer_1,
2489                    range: Point::new(1, 2)..Point::new(2, 5),
2490                },
2491                cx,
2492            );
2493            assert_eq!(
2494                subscription.consume().into_inner(),
2495                [Edit {
2496                    old: 0..0,
2497                    new: 0..10
2498                }]
2499            );
2500
2501            multibuffer.push_excerpt(
2502                ExcerptProperties {
2503                    buffer: &buffer_1,
2504                    range: Point::new(3, 3)..Point::new(4, 4),
2505                },
2506                cx,
2507            );
2508            multibuffer.push_excerpt(
2509                ExcerptProperties {
2510                    buffer: &buffer_2,
2511                    range: Point::new(3, 1)..Point::new(3, 3),
2512                },
2513                cx,
2514            );
2515            assert_eq!(
2516                subscription.consume().into_inner(),
2517                [Edit {
2518                    old: 10..10,
2519                    new: 10..22
2520                }]
2521            );
2522
2523            subscription
2524        });
2525
2526        let snapshot = multibuffer.read(cx).snapshot(cx);
2527        assert_eq!(
2528            snapshot.text(),
2529            concat!(
2530                "bbbb\n",  // Preserve newlines
2531                "ccccc\n", //
2532                "ddd\n",   //
2533                "eeee\n",  //
2534                "jj"       //
2535            )
2536        );
2537        assert_eq!(
2538            snapshot.buffer_rows(0).collect::<Vec<_>>(),
2539            [Some(1), Some(2), Some(3), Some(4), Some(3)]
2540        );
2541        assert_eq!(
2542            snapshot.buffer_rows(2).collect::<Vec<_>>(),
2543            [Some(3), Some(4), Some(3)]
2544        );
2545        assert_eq!(snapshot.buffer_rows(4).collect::<Vec<_>>(), [Some(3)]);
2546        assert_eq!(snapshot.buffer_rows(5).collect::<Vec<_>>(), []);
2547        assert!(!snapshot.range_contains_excerpt_boundary(Point::new(1, 0)..Point::new(1, 5)));
2548        assert!(snapshot.range_contains_excerpt_boundary(Point::new(1, 0)..Point::new(2, 0)));
2549        assert!(snapshot.range_contains_excerpt_boundary(Point::new(1, 0)..Point::new(4, 0)));
2550        assert!(!snapshot.range_contains_excerpt_boundary(Point::new(2, 0)..Point::new(3, 0)));
2551        assert!(!snapshot.range_contains_excerpt_boundary(Point::new(4, 0)..Point::new(4, 2)));
2552        assert!(!snapshot.range_contains_excerpt_boundary(Point::new(4, 2)..Point::new(4, 2)));
2553
2554        buffer_1.update(cx, |buffer, cx| {
2555            buffer.edit(
2556                [
2557                    Point::new(0, 0)..Point::new(0, 0),
2558                    Point::new(2, 1)..Point::new(2, 3),
2559                ],
2560                "\n",
2561                cx,
2562            );
2563        });
2564
2565        let snapshot = multibuffer.read(cx).snapshot(cx);
2566        assert_eq!(
2567            snapshot.text(),
2568            concat!(
2569                "bbbb\n", // Preserve newlines
2570                "c\n",    //
2571                "cc\n",   //
2572                "ddd\n",  //
2573                "eeee\n", //
2574                "jj"      //
2575            )
2576        );
2577
2578        assert_eq!(
2579            subscription.consume().into_inner(),
2580            [Edit {
2581                old: 6..8,
2582                new: 6..7
2583            }]
2584        );
2585
2586        let snapshot = multibuffer.read(cx).snapshot(cx);
2587        assert_eq!(
2588            snapshot.clip_point(Point::new(0, 5), Bias::Left),
2589            Point::new(0, 4)
2590        );
2591        assert_eq!(
2592            snapshot.clip_point(Point::new(0, 5), Bias::Right),
2593            Point::new(0, 4)
2594        );
2595        assert_eq!(
2596            snapshot.clip_point(Point::new(5, 1), Bias::Right),
2597            Point::new(5, 1)
2598        );
2599        assert_eq!(
2600            snapshot.clip_point(Point::new(5, 2), Bias::Right),
2601            Point::new(5, 2)
2602        );
2603        assert_eq!(
2604            snapshot.clip_point(Point::new(5, 3), Bias::Right),
2605            Point::new(5, 2)
2606        );
2607
2608        let snapshot = multibuffer.update(cx, |multibuffer, cx| {
2609            let buffer_2_excerpt_id = multibuffer.excerpt_ids_for_buffer(&buffer_2)[0].clone();
2610            multibuffer.remove_excerpts(&[buffer_2_excerpt_id], cx);
2611            multibuffer.snapshot(cx)
2612        });
2613
2614        assert_eq!(
2615            snapshot.text(),
2616            concat!(
2617                "bbbb\n", // Preserve newlines
2618                "c\n",    //
2619                "cc\n",   //
2620                "ddd\n",  //
2621                "eeee",   //
2622            )
2623        );
2624    }
2625
2626    #[gpui::test]
2627    fn test_empty_excerpt_buffer(cx: &mut MutableAppContext) {
2628        let multibuffer = cx.add_model(|_| MultiBuffer::new(0));
2629
2630        let snapshot = multibuffer.read(cx).snapshot(cx);
2631        assert_eq!(snapshot.text(), "");
2632        assert_eq!(snapshot.buffer_rows(0).collect::<Vec<_>>(), &[Some(0)]);
2633        assert_eq!(snapshot.buffer_rows(1).collect::<Vec<_>>(), &[]);
2634    }
2635
2636    #[gpui::test]
2637    fn test_singleton_multibuffer_anchors(cx: &mut MutableAppContext) {
2638        let buffer = cx.add_model(|cx| Buffer::new(0, "abcd", cx));
2639        let multibuffer = cx.add_model(|cx| MultiBuffer::singleton(buffer.clone(), cx));
2640        let old_snapshot = multibuffer.read(cx).snapshot(cx);
2641        buffer.update(cx, |buffer, cx| {
2642            buffer.edit([0..0], "X", cx);
2643            buffer.edit([5..5], "Y", cx);
2644        });
2645        let new_snapshot = multibuffer.read(cx).snapshot(cx);
2646
2647        assert_eq!(old_snapshot.text(), "abcd");
2648        assert_eq!(new_snapshot.text(), "XabcdY");
2649
2650        assert_eq!(old_snapshot.anchor_before(0).to_offset(&new_snapshot), 0);
2651        assert_eq!(old_snapshot.anchor_after(0).to_offset(&new_snapshot), 1);
2652        assert_eq!(old_snapshot.anchor_before(4).to_offset(&new_snapshot), 5);
2653        assert_eq!(old_snapshot.anchor_after(4).to_offset(&new_snapshot), 6);
2654    }
2655
2656    #[gpui::test]
2657    fn test_multibuffer_anchors(cx: &mut MutableAppContext) {
2658        let buffer_1 = cx.add_model(|cx| Buffer::new(0, "abcd", cx));
2659        let buffer_2 = cx.add_model(|cx| Buffer::new(0, "efghi", cx));
2660        let multibuffer = cx.add_model(|cx| {
2661            let mut multibuffer = MultiBuffer::new(0);
2662            multibuffer.push_excerpt(
2663                ExcerptProperties {
2664                    buffer: &buffer_1,
2665                    range: 0..4,
2666                },
2667                cx,
2668            );
2669            multibuffer.push_excerpt(
2670                ExcerptProperties {
2671                    buffer: &buffer_2,
2672                    range: 0..5,
2673                },
2674                cx,
2675            );
2676            multibuffer
2677        });
2678        let old_snapshot = multibuffer.read(cx).snapshot(cx);
2679
2680        assert_eq!(old_snapshot.anchor_before(0).to_offset(&old_snapshot), 0);
2681        assert_eq!(old_snapshot.anchor_after(0).to_offset(&old_snapshot), 0);
2682        assert_eq!(Anchor::min().to_offset(&old_snapshot), 0);
2683        assert_eq!(Anchor::min().to_offset(&old_snapshot), 0);
2684        assert_eq!(Anchor::max().to_offset(&old_snapshot), 10);
2685        assert_eq!(Anchor::max().to_offset(&old_snapshot), 10);
2686
2687        buffer_1.update(cx, |buffer, cx| {
2688            buffer.edit([0..0], "W", cx);
2689            buffer.edit([5..5], "X", cx);
2690        });
2691        buffer_2.update(cx, |buffer, cx| {
2692            buffer.edit([0..0], "Y", cx);
2693            buffer.edit([6..0], "Z", cx);
2694        });
2695        let new_snapshot = multibuffer.read(cx).snapshot(cx);
2696
2697        assert_eq!(old_snapshot.text(), "abcd\nefghi");
2698        assert_eq!(new_snapshot.text(), "WabcdX\nYefghiZ");
2699
2700        assert_eq!(old_snapshot.anchor_before(0).to_offset(&new_snapshot), 0);
2701        assert_eq!(old_snapshot.anchor_after(0).to_offset(&new_snapshot), 1);
2702        assert_eq!(old_snapshot.anchor_before(1).to_offset(&new_snapshot), 2);
2703        assert_eq!(old_snapshot.anchor_after(1).to_offset(&new_snapshot), 2);
2704        assert_eq!(old_snapshot.anchor_before(2).to_offset(&new_snapshot), 3);
2705        assert_eq!(old_snapshot.anchor_after(2).to_offset(&new_snapshot), 3);
2706        assert_eq!(old_snapshot.anchor_before(5).to_offset(&new_snapshot), 7);
2707        assert_eq!(old_snapshot.anchor_after(5).to_offset(&new_snapshot), 8);
2708        assert_eq!(old_snapshot.anchor_before(10).to_offset(&new_snapshot), 13);
2709        assert_eq!(old_snapshot.anchor_after(10).to_offset(&new_snapshot), 14);
2710    }
2711
2712    #[gpui::test]
2713    fn test_multibuffer_resolving_anchors_after_replacing_their_excerpts(
2714        cx: &mut MutableAppContext,
2715    ) {
2716        let buffer_1 = cx.add_model(|cx| Buffer::new(0, "abcd", cx));
2717        let buffer_2 = cx.add_model(|cx| Buffer::new(0, "ABCDEFGHIJKLMNOP", cx));
2718        let multibuffer = cx.add_model(|_| MultiBuffer::new(0));
2719
2720        // Create an insertion id in buffer 1 that doesn't exist in buffer 2.
2721        // Add an excerpt from buffer 1 that spans this new insertion.
2722        buffer_1.update(cx, |buffer, cx| buffer.edit([4..4], "123", cx));
2723        let excerpt_id_1 = multibuffer.update(cx, |multibuffer, cx| {
2724            multibuffer.push_excerpt(
2725                ExcerptProperties {
2726                    buffer: &buffer_1,
2727                    range: 0..7,
2728                },
2729                cx,
2730            )
2731        });
2732
2733        let snapshot_1 = multibuffer.read(cx).snapshot(cx);
2734        assert_eq!(snapshot_1.text(), "abcd123");
2735
2736        // Replace the buffer 1 excerpt with new excerpts from buffer 2.
2737        let (excerpt_id_2, excerpt_id_3, _) = multibuffer.update(cx, |multibuffer, cx| {
2738            multibuffer.remove_excerpts([&excerpt_id_1], cx);
2739            (
2740                multibuffer.push_excerpt(
2741                    ExcerptProperties {
2742                        buffer: &buffer_2,
2743                        range: 0..4,
2744                    },
2745                    cx,
2746                ),
2747                multibuffer.push_excerpt(
2748                    ExcerptProperties {
2749                        buffer: &buffer_2,
2750                        range: 6..10,
2751                    },
2752                    cx,
2753                ),
2754                multibuffer.push_excerpt(
2755                    ExcerptProperties {
2756                        buffer: &buffer_2,
2757                        range: 12..16,
2758                    },
2759                    cx,
2760                ),
2761            )
2762        });
2763        let snapshot_2 = multibuffer.read(cx).snapshot(cx);
2764        assert_eq!(snapshot_2.text(), "ABCD\nGHIJ\nMNOP");
2765
2766        // The old excerpt id has been reused.
2767        assert_eq!(excerpt_id_2, excerpt_id_1);
2768
2769        // Resolve some anchors from the previous snapshot in the new snapshot.
2770        // Although there is still an excerpt with the same id, it is for
2771        // a different buffer, so we don't attempt to resolve the old text
2772        // anchor in the new buffer.
2773        assert_eq!(
2774            snapshot_2.summary_for_anchor::<usize>(&snapshot_1.anchor_before(2)),
2775            0
2776        );
2777        assert_eq!(
2778            snapshot_2.summaries_for_anchors::<usize, _>(&[
2779                snapshot_1.anchor_before(2),
2780                snapshot_1.anchor_after(3)
2781            ]),
2782            vec![0, 0]
2783        );
2784        let refresh =
2785            snapshot_2.refresh_anchors(&[snapshot_1.anchor_before(2), snapshot_1.anchor_after(3)]);
2786        assert_eq!(
2787            refresh,
2788            &[
2789                (0, snapshot_2.anchor_before(0), false),
2790                (1, snapshot_2.anchor_after(0), false),
2791            ]
2792        );
2793
2794        // Replace the middle excerpt with a smaller excerpt in buffer 2,
2795        // that intersects the old excerpt.
2796        let excerpt_id_5 = multibuffer.update(cx, |multibuffer, cx| {
2797            multibuffer.remove_excerpts([&excerpt_id_3], cx);
2798            multibuffer.insert_excerpt_after(
2799                &excerpt_id_3,
2800                ExcerptProperties {
2801                    buffer: &buffer_2,
2802                    range: 5..8,
2803                },
2804                cx,
2805            )
2806        });
2807
2808        let snapshot_3 = multibuffer.read(cx).snapshot(cx);
2809        assert_eq!(snapshot_3.text(), "ABCD\nFGH\nMNOP");
2810        assert_ne!(excerpt_id_5, excerpt_id_3);
2811
2812        // Resolve some anchors from the previous snapshot in the new snapshot.
2813        // The anchor in the middle excerpt snaps to the beginning of the
2814        // excerpt, since it is not
2815        let anchors = [
2816            snapshot_2.anchor_before(0),
2817            snapshot_2.anchor_after(2),
2818            snapshot_2.anchor_after(6),
2819            snapshot_2.anchor_after(14),
2820        ];
2821        assert_eq!(
2822            snapshot_3.summaries_for_anchors::<usize, _>(&anchors),
2823            &[0, 2, 9, 13]
2824        );
2825
2826        let new_anchors = snapshot_3.refresh_anchors(&anchors);
2827        assert_eq!(
2828            new_anchors.iter().map(|a| (a.0, a.2)).collect::<Vec<_>>(),
2829            &[(0, true), (1, true), (2, true), (3, true)]
2830        );
2831        assert_eq!(
2832            snapshot_3.summaries_for_anchors::<usize, _>(new_anchors.iter().map(|a| &a.1)),
2833            &[0, 2, 7, 13]
2834        );
2835    }
2836
2837    #[gpui::test(iterations = 100)]
2838    fn test_random_multibuffer(cx: &mut MutableAppContext, mut rng: StdRng) {
2839        let operations = env::var("OPERATIONS")
2840            .map(|i| i.parse().expect("invalid `OPERATIONS` variable"))
2841            .unwrap_or(10);
2842
2843        let mut buffers: Vec<ModelHandle<Buffer>> = Vec::new();
2844        let multibuffer = cx.add_model(|_| MultiBuffer::new(0));
2845        let mut excerpt_ids = Vec::new();
2846        let mut expected_excerpts = Vec::<(ModelHandle<Buffer>, Range<text::Anchor>)>::new();
2847        let mut anchors = Vec::new();
2848        let mut old_versions = Vec::new();
2849
2850        for _ in 0..operations {
2851            match rng.gen_range(0..100) {
2852                0..=19 if !buffers.is_empty() => {
2853                    let buffer = buffers.choose(&mut rng).unwrap();
2854                    buffer.update(cx, |buf, cx| buf.randomly_edit(&mut rng, 5, cx));
2855                }
2856                20..=29 if !expected_excerpts.is_empty() => {
2857                    let mut ids_to_remove = vec![];
2858                    for _ in 0..rng.gen_range(1..=3) {
2859                        if expected_excerpts.is_empty() {
2860                            break;
2861                        }
2862
2863                        let ix = rng.gen_range(0..expected_excerpts.len());
2864                        ids_to_remove.push(excerpt_ids.remove(ix));
2865                        let (buffer, range) = expected_excerpts.remove(ix);
2866                        let buffer = buffer.read(cx);
2867                        log::info!(
2868                            "Removing excerpt {}: {:?}",
2869                            ix,
2870                            buffer
2871                                .text_for_range(range.to_offset(&buffer))
2872                                .collect::<String>(),
2873                        );
2874                    }
2875                    ids_to_remove.sort_unstable();
2876                    multibuffer.update(cx, |multibuffer, cx| {
2877                        multibuffer.remove_excerpts(&ids_to_remove, cx)
2878                    });
2879                }
2880                30..=39 if !expected_excerpts.is_empty() => {
2881                    let multibuffer = multibuffer.read(cx).read(cx);
2882                    let offset =
2883                        multibuffer.clip_offset(rng.gen_range(0..=multibuffer.len()), Bias::Left);
2884                    let bias = if rng.gen() { Bias::Left } else { Bias::Right };
2885                    log::info!("Creating anchor at {} with bias {:?}", offset, bias);
2886                    anchors.push(multibuffer.anchor_at(offset, bias));
2887                    anchors.sort_by(|a, b| a.cmp(&b, &multibuffer).unwrap());
2888                }
2889                40..=44 if !anchors.is_empty() => {
2890                    let multibuffer = multibuffer.read(cx).read(cx);
2891
2892                    anchors = multibuffer
2893                        .refresh_anchors(&anchors)
2894                        .into_iter()
2895                        .map(|a| a.1)
2896                        .collect();
2897
2898                    // Ensure the newly-refreshed anchors point to a valid excerpt and don't
2899                    // overshoot its boundaries.
2900                    let mut cursor = multibuffer.excerpts.cursor::<Option<&ExcerptId>>();
2901                    for anchor in &anchors {
2902                        if anchor.excerpt_id == ExcerptId::min()
2903                            || anchor.excerpt_id == ExcerptId::max()
2904                        {
2905                            continue;
2906                        }
2907
2908                        cursor.seek_forward(&Some(&anchor.excerpt_id), Bias::Left, &());
2909                        let excerpt = cursor.item().unwrap();
2910                        assert_eq!(excerpt.id, anchor.excerpt_id);
2911                        assert!(excerpt.contains(anchor));
2912                    }
2913                }
2914                _ => {
2915                    let buffer_handle = if buffers.is_empty() || rng.gen_bool(0.4) {
2916                        let base_text = RandomCharIter::new(&mut rng).take(10).collect::<String>();
2917                        buffers.push(cx.add_model(|cx| Buffer::new(0, base_text, cx)));
2918                        buffers.last().unwrap()
2919                    } else {
2920                        buffers.choose(&mut rng).unwrap()
2921                    };
2922
2923                    let buffer = buffer_handle.read(cx);
2924                    let end_ix = buffer.clip_offset(rng.gen_range(0..=buffer.len()), Bias::Right);
2925                    let start_ix = buffer.clip_offset(rng.gen_range(0..=end_ix), Bias::Left);
2926                    let anchor_range = buffer.anchor_before(start_ix)..buffer.anchor_after(end_ix);
2927                    let prev_excerpt_ix = rng.gen_range(0..=expected_excerpts.len());
2928                    let prev_excerpt_id = excerpt_ids
2929                        .get(prev_excerpt_ix)
2930                        .cloned()
2931                        .unwrap_or(ExcerptId::max());
2932                    let excerpt_ix = (prev_excerpt_ix + 1).min(expected_excerpts.len());
2933
2934                    log::info!(
2935                        "Inserting excerpt at {} of {} for buffer {}: {:?}[{:?}] = {:?}",
2936                        excerpt_ix,
2937                        expected_excerpts.len(),
2938                        buffer_handle.id(),
2939                        buffer.text(),
2940                        start_ix..end_ix,
2941                        &buffer.text()[start_ix..end_ix]
2942                    );
2943
2944                    let excerpt_id = multibuffer.update(cx, |multibuffer, cx| {
2945                        multibuffer.insert_excerpt_after(
2946                            &prev_excerpt_id,
2947                            ExcerptProperties {
2948                                buffer: &buffer_handle,
2949                                range: start_ix..end_ix,
2950                            },
2951                            cx,
2952                        )
2953                    });
2954
2955                    excerpt_ids.insert(excerpt_ix, excerpt_id);
2956                    expected_excerpts.insert(excerpt_ix, (buffer_handle.clone(), anchor_range));
2957                }
2958            }
2959
2960            if rng.gen_bool(0.3) {
2961                multibuffer.update(cx, |multibuffer, cx| {
2962                    old_versions.push((multibuffer.snapshot(cx), multibuffer.subscribe()));
2963                })
2964            }
2965
2966            let snapshot = multibuffer.read(cx).snapshot(cx);
2967
2968            let mut excerpt_starts = Vec::new();
2969            let mut expected_text = String::new();
2970            let mut expected_buffer_rows = Vec::new();
2971            for (buffer, range) in &expected_excerpts {
2972                let buffer = buffer.read(cx);
2973                let buffer_range = range.to_offset(buffer);
2974
2975                excerpt_starts.push(TextSummary::from(expected_text.as_str()));
2976                expected_text.extend(buffer.text_for_range(buffer_range.clone()));
2977                expected_text.push('\n');
2978
2979                let buffer_row_range = buffer.offset_to_point(buffer_range.start).row
2980                    ..=buffer.offset_to_point(buffer_range.end).row;
2981                for row in buffer_row_range {
2982                    expected_buffer_rows.push(Some(row));
2983                }
2984            }
2985            // Remove final trailing newline.
2986            if !expected_excerpts.is_empty() {
2987                expected_text.pop();
2988            }
2989
2990            // Always report one buffer row
2991            if expected_buffer_rows.is_empty() {
2992                expected_buffer_rows.push(Some(0));
2993            }
2994
2995            assert_eq!(snapshot.text(), expected_text);
2996            log::info!("MultiBuffer text: {:?}", expected_text);
2997
2998            assert_eq!(
2999                snapshot.buffer_rows(0).collect::<Vec<_>>(),
3000                expected_buffer_rows,
3001            );
3002
3003            for _ in 0..5 {
3004                let start_row = rng.gen_range(0..=expected_buffer_rows.len());
3005                assert_eq!(
3006                    snapshot.buffer_rows(start_row as u32).collect::<Vec<_>>(),
3007                    &expected_buffer_rows[start_row..],
3008                    "buffer_rows({})",
3009                    start_row
3010                );
3011            }
3012
3013            assert_eq!(
3014                snapshot.max_buffer_row(),
3015                expected_buffer_rows
3016                    .into_iter()
3017                    .filter_map(|r| r)
3018                    .max()
3019                    .unwrap()
3020            );
3021
3022            let mut excerpt_starts = excerpt_starts.into_iter();
3023            for (buffer, range) in &expected_excerpts {
3024                let buffer_id = buffer.id();
3025                let buffer = buffer.read(cx);
3026                let buffer_range = range.to_offset(buffer);
3027                let buffer_start_point = buffer.offset_to_point(buffer_range.start);
3028                let buffer_start_point_utf16 =
3029                    buffer.text_summary_for_range::<PointUtf16, _>(0..buffer_range.start);
3030
3031                let excerpt_start = excerpt_starts.next().unwrap();
3032                let mut offset = excerpt_start.bytes;
3033                let mut buffer_offset = buffer_range.start;
3034                let mut point = excerpt_start.lines;
3035                let mut buffer_point = buffer_start_point;
3036                let mut point_utf16 = excerpt_start.lines_utf16;
3037                let mut buffer_point_utf16 = buffer_start_point_utf16;
3038                for ch in buffer
3039                    .snapshot()
3040                    .chunks(buffer_range.clone(), None)
3041                    .flat_map(|c| c.text.chars())
3042                {
3043                    for _ in 0..ch.len_utf8() {
3044                        let left_offset = snapshot.clip_offset(offset, Bias::Left);
3045                        let right_offset = snapshot.clip_offset(offset, Bias::Right);
3046                        let buffer_left_offset = buffer.clip_offset(buffer_offset, Bias::Left);
3047                        let buffer_right_offset = buffer.clip_offset(buffer_offset, Bias::Right);
3048                        assert_eq!(
3049                            left_offset,
3050                            excerpt_start.bytes + (buffer_left_offset - buffer_range.start),
3051                            "clip_offset({:?}, Left). buffer: {:?}, buffer offset: {:?}",
3052                            offset,
3053                            buffer_id,
3054                            buffer_offset,
3055                        );
3056                        assert_eq!(
3057                            right_offset,
3058                            excerpt_start.bytes + (buffer_right_offset - buffer_range.start),
3059                            "clip_offset({:?}, Right). buffer: {:?}, buffer offset: {:?}",
3060                            offset,
3061                            buffer_id,
3062                            buffer_offset,
3063                        );
3064
3065                        let left_point = snapshot.clip_point(point, Bias::Left);
3066                        let right_point = snapshot.clip_point(point, Bias::Right);
3067                        let buffer_left_point = buffer.clip_point(buffer_point, Bias::Left);
3068                        let buffer_right_point = buffer.clip_point(buffer_point, Bias::Right);
3069                        assert_eq!(
3070                            left_point,
3071                            excerpt_start.lines + (buffer_left_point - buffer_start_point),
3072                            "clip_point({:?}, Left). buffer: {:?}, buffer point: {:?}",
3073                            point,
3074                            buffer_id,
3075                            buffer_point,
3076                        );
3077                        assert_eq!(
3078                            right_point,
3079                            excerpt_start.lines + (buffer_right_point - buffer_start_point),
3080                            "clip_point({:?}, Right). buffer: {:?}, buffer point: {:?}",
3081                            point,
3082                            buffer_id,
3083                            buffer_point,
3084                        );
3085
3086                        assert_eq!(
3087                            snapshot.point_to_offset(left_point),
3088                            left_offset,
3089                            "point_to_offset({:?})",
3090                            left_point,
3091                        );
3092                        assert_eq!(
3093                            snapshot.offset_to_point(left_offset),
3094                            left_point,
3095                            "offset_to_point({:?})",
3096                            left_offset,
3097                        );
3098
3099                        offset += 1;
3100                        buffer_offset += 1;
3101                        if ch == '\n' {
3102                            point += Point::new(1, 0);
3103                            buffer_point += Point::new(1, 0);
3104                        } else {
3105                            point += Point::new(0, 1);
3106                            buffer_point += Point::new(0, 1);
3107                        }
3108                    }
3109
3110                    for _ in 0..ch.len_utf16() {
3111                        let left_point_utf16 = snapshot.clip_point_utf16(point_utf16, Bias::Left);
3112                        let right_point_utf16 = snapshot.clip_point_utf16(point_utf16, Bias::Right);
3113                        let buffer_left_point_utf16 =
3114                            buffer.clip_point_utf16(buffer_point_utf16, Bias::Left);
3115                        let buffer_right_point_utf16 =
3116                            buffer.clip_point_utf16(buffer_point_utf16, Bias::Right);
3117                        assert_eq!(
3118                            left_point_utf16,
3119                            excerpt_start.lines_utf16
3120                                + (buffer_left_point_utf16 - buffer_start_point_utf16),
3121                            "clip_point_utf16({:?}, Left). buffer: {:?}, buffer point_utf16: {:?}",
3122                            point_utf16,
3123                            buffer_id,
3124                            buffer_point_utf16,
3125                        );
3126                        assert_eq!(
3127                            right_point_utf16,
3128                            excerpt_start.lines_utf16
3129                                + (buffer_right_point_utf16 - buffer_start_point_utf16),
3130                            "clip_point_utf16({:?}, Right). buffer: {:?}, buffer point_utf16: {:?}",
3131                            point_utf16,
3132                            buffer_id,
3133                            buffer_point_utf16,
3134                        );
3135
3136                        if ch == '\n' {
3137                            point_utf16 += PointUtf16::new(1, 0);
3138                            buffer_point_utf16 += PointUtf16::new(1, 0);
3139                        } else {
3140                            point_utf16 += PointUtf16::new(0, 1);
3141                            buffer_point_utf16 += PointUtf16::new(0, 1);
3142                        }
3143                    }
3144                }
3145            }
3146
3147            for (row, line) in expected_text.split('\n').enumerate() {
3148                assert_eq!(
3149                    snapshot.line_len(row as u32),
3150                    line.len() as u32,
3151                    "line_len({}).",
3152                    row
3153                );
3154            }
3155
3156            let text_rope = Rope::from(expected_text.as_str());
3157            for _ in 0..10 {
3158                let end_ix = text_rope.clip_offset(rng.gen_range(0..=text_rope.len()), Bias::Right);
3159                let start_ix = text_rope.clip_offset(rng.gen_range(0..=end_ix), Bias::Left);
3160
3161                let text_for_range = snapshot
3162                    .text_for_range(start_ix..end_ix)
3163                    .collect::<String>();
3164                assert_eq!(
3165                    text_for_range,
3166                    &expected_text[start_ix..end_ix],
3167                    "incorrect text for range {:?}",
3168                    start_ix..end_ix
3169                );
3170
3171                let excerpted_buffer_ranges =
3172                    multibuffer.read(cx).excerpted_buffers(start_ix..end_ix, cx);
3173                let excerpted_buffers_text = excerpted_buffer_ranges
3174                    .into_iter()
3175                    .map(|(buffer, buffer_range)| {
3176                        buffer
3177                            .read(cx)
3178                            .text_for_range(buffer_range)
3179                            .collect::<String>()
3180                    })
3181                    .collect::<Vec<_>>()
3182                    .join("\n");
3183                assert_eq!(excerpted_buffers_text, text_for_range);
3184
3185                let expected_summary = TextSummary::from(&expected_text[start_ix..end_ix]);
3186                assert_eq!(
3187                    snapshot.text_summary_for_range::<TextSummary, _>(start_ix..end_ix),
3188                    expected_summary,
3189                    "incorrect summary for range {:?}",
3190                    start_ix..end_ix
3191                );
3192            }
3193
3194            // Anchor resolution
3195            for (anchor, resolved_offset) in anchors
3196                .iter()
3197                .zip(snapshot.summaries_for_anchors::<usize, _>(&anchors))
3198            {
3199                assert!(resolved_offset <= snapshot.len());
3200                assert_eq!(
3201                    snapshot.summary_for_anchor::<usize>(anchor),
3202                    resolved_offset
3203                );
3204            }
3205
3206            for _ in 0..10 {
3207                let end_ix = text_rope.clip_offset(rng.gen_range(0..=text_rope.len()), Bias::Right);
3208                assert_eq!(
3209                    snapshot.reversed_chars_at(end_ix).collect::<String>(),
3210                    expected_text[..end_ix].chars().rev().collect::<String>(),
3211                );
3212            }
3213
3214            for _ in 0..10 {
3215                let end_ix = rng.gen_range(0..=text_rope.len());
3216                let start_ix = rng.gen_range(0..=end_ix);
3217                assert_eq!(
3218                    snapshot
3219                        .bytes_in_range(start_ix..end_ix)
3220                        .flatten()
3221                        .copied()
3222                        .collect::<Vec<_>>(),
3223                    expected_text.as_bytes()[start_ix..end_ix].to_vec(),
3224                    "bytes_in_range({:?})",
3225                    start_ix..end_ix,
3226                );
3227            }
3228        }
3229
3230        let snapshot = multibuffer.read(cx).snapshot(cx);
3231        for (old_snapshot, subscription) in old_versions {
3232            let edits = subscription.consume().into_inner();
3233
3234            log::info!(
3235                "applying subscription edits to old text: {:?}: {:?}",
3236                old_snapshot.text(),
3237                edits,
3238            );
3239
3240            let mut text = old_snapshot.text();
3241            for edit in edits {
3242                let new_text: String = snapshot.text_for_range(edit.new.clone()).collect();
3243                text.replace_range(edit.new.start..edit.new.start + edit.old.len(), &new_text);
3244            }
3245            assert_eq!(text.to_string(), snapshot.text());
3246        }
3247    }
3248
3249    #[gpui::test]
3250    fn test_history(cx: &mut MutableAppContext) {
3251        let buffer_1 = cx.add_model(|cx| Buffer::new(0, "1234", cx));
3252        let buffer_2 = cx.add_model(|cx| Buffer::new(0, "5678", cx));
3253        let multibuffer = cx.add_model(|_| MultiBuffer::new(0));
3254        let group_interval = multibuffer.read(cx).history.group_interval;
3255        multibuffer.update(cx, |multibuffer, cx| {
3256            multibuffer.push_excerpt(
3257                ExcerptProperties {
3258                    buffer: &buffer_1,
3259                    range: 0..buffer_1.read(cx).len(),
3260                },
3261                cx,
3262            );
3263            multibuffer.push_excerpt(
3264                ExcerptProperties {
3265                    buffer: &buffer_2,
3266                    range: 0..buffer_2.read(cx).len(),
3267                },
3268                cx,
3269            );
3270        });
3271
3272        let mut now = Instant::now();
3273
3274        multibuffer.update(cx, |multibuffer, cx| {
3275            multibuffer.start_transaction_at(now, cx);
3276            multibuffer.edit(
3277                [
3278                    Point::new(0, 0)..Point::new(0, 0),
3279                    Point::new(1, 0)..Point::new(1, 0),
3280                ],
3281                "A",
3282                cx,
3283            );
3284            multibuffer.edit(
3285                [
3286                    Point::new(0, 1)..Point::new(0, 1),
3287                    Point::new(1, 1)..Point::new(1, 1),
3288                ],
3289                "B",
3290                cx,
3291            );
3292            multibuffer.end_transaction_at(now, cx);
3293            assert_eq!(multibuffer.read(cx).text(), "AB1234\nAB5678");
3294
3295            now += 2 * group_interval;
3296            multibuffer.start_transaction_at(now, cx);
3297            multibuffer.edit([2..2], "C", cx);
3298            multibuffer.end_transaction_at(now, cx);
3299            assert_eq!(multibuffer.read(cx).text(), "ABC1234\nAB5678");
3300
3301            multibuffer.undo(cx);
3302            assert_eq!(multibuffer.read(cx).text(), "AB1234\nAB5678");
3303
3304            multibuffer.undo(cx);
3305            assert_eq!(multibuffer.read(cx).text(), "1234\n5678");
3306
3307            multibuffer.redo(cx);
3308            assert_eq!(multibuffer.read(cx).text(), "AB1234\nAB5678");
3309
3310            multibuffer.redo(cx);
3311            assert_eq!(multibuffer.read(cx).text(), "ABC1234\nAB5678");
3312
3313            buffer_1.update(cx, |buffer_1, cx| buffer_1.undo(cx));
3314            assert_eq!(multibuffer.read(cx).text(), "AB1234\nAB5678");
3315
3316            multibuffer.undo(cx);
3317            assert_eq!(multibuffer.read(cx).text(), "1234\n5678");
3318
3319            multibuffer.redo(cx);
3320            assert_eq!(multibuffer.read(cx).text(), "AB1234\nAB5678");
3321
3322            multibuffer.redo(cx);
3323            assert_eq!(multibuffer.read(cx).text(), "ABC1234\nAB5678");
3324
3325            multibuffer.undo(cx);
3326            assert_eq!(multibuffer.read(cx).text(), "AB1234\nAB5678");
3327
3328            buffer_1.update(cx, |buffer_1, cx| buffer_1.redo(cx));
3329            assert_eq!(multibuffer.read(cx).text(), "ABC1234\nAB5678");
3330
3331            multibuffer.undo(cx);
3332            assert_eq!(multibuffer.read(cx).text(), "C1234\n5678");
3333        });
3334    }
3335}