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