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