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