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