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