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