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