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