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