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