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