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