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));
2614 let start = start.saturating_sub_usize(1);
2615 let end = snapshot.len().min(end + 1usize);
2616 cursor.seek(&start, Bias::Right);
2617 while let Some(item) = cursor.item() {
2618 if *cursor.start() >= end {
2619 break;
2620 }
2621 if item.hunk_info().is_some() {
2622 return true;
2623 }
2624 cursor.next();
2625 }
2626 }
2627 false
2628 }
2629
2630 pub fn expand_or_collapse_diff_hunks_inner(
2631 &mut self,
2632 ranges: impl IntoIterator<Item = (Range<Point>, ExcerptId)>,
2633 expand: bool,
2634 cx: &mut Context<Self>,
2635 ) {
2636 if self.snapshot.borrow().all_diff_hunks_expanded && !expand {
2637 return;
2638 }
2639 self.sync_mut(cx);
2640 let mut snapshot = self.snapshot.get_mut();
2641 let mut excerpt_edits = Vec::new();
2642 let mut last_hunk_row = None;
2643 for (range, end_excerpt_id) in ranges {
2644 for diff_hunk in snapshot.diff_hunks_in_range(range) {
2645 if diff_hunk.excerpt_id.cmp(&end_excerpt_id, &snapshot).is_gt() {
2646 continue;
2647 }
2648 if last_hunk_row.is_some_and(|row| row >= diff_hunk.row_range.start) {
2649 continue;
2650 }
2651 let start = Anchor::in_buffer(diff_hunk.excerpt_id, diff_hunk.buffer_range.start);
2652 let end = Anchor::in_buffer(diff_hunk.excerpt_id, diff_hunk.buffer_range.end);
2653 let start = snapshot.excerpt_offset_for_anchor(&start);
2654 let end = snapshot.excerpt_offset_for_anchor(&end);
2655 last_hunk_row = Some(diff_hunk.row_range.start);
2656 excerpt_edits.push(text::Edit {
2657 old: start..end,
2658 new: start..end,
2659 });
2660 }
2661 }
2662
2663 let edits = Self::sync_diff_transforms(
2664 &mut snapshot,
2665 excerpt_edits,
2666 DiffChangeKind::ExpandOrCollapseHunks { expand },
2667 self.filter_mode,
2668 );
2669 if !edits.is_empty() {
2670 self.subscriptions.publish(edits);
2671 }
2672 cx.emit(Event::DiffHunksToggled);
2673 cx.emit(Event::Edited {
2674 edited_buffer: None,
2675 });
2676 }
2677
2678 pub fn expand_or_collapse_diff_hunks(
2679 &mut self,
2680 ranges: Vec<Range<Anchor>>,
2681 expand: bool,
2682 cx: &mut Context<Self>,
2683 ) {
2684 let snapshot = self.snapshot.borrow().clone();
2685 let ranges = ranges.iter().map(move |range| {
2686 let end_excerpt_id = range.end.excerpt_id;
2687 let range = range.to_point(&snapshot);
2688 let mut peek_end = range.end;
2689 if range.end.row < snapshot.max_row().0 {
2690 peek_end = Point::new(range.end.row + 1, 0);
2691 };
2692 (range.start..peek_end, end_excerpt_id)
2693 });
2694 self.expand_or_collapse_diff_hunks_inner(ranges, expand, cx);
2695 }
2696
2697 pub fn resize_excerpt(
2698 &mut self,
2699 id: ExcerptId,
2700 range: Range<text::Anchor>,
2701 cx: &mut Context<Self>,
2702 ) {
2703 self.sync_mut(cx);
2704
2705 let mut snapshot = self.snapshot.get_mut();
2706 let locator = snapshot.excerpt_locator_for_id(id);
2707 let mut new_excerpts = SumTree::default();
2708 let mut cursor = snapshot
2709 .excerpts
2710 .cursor::<Dimensions<Option<&Locator>, ExcerptOffset>>(());
2711 let mut edits = Vec::<Edit<ExcerptOffset>>::new();
2712
2713 let prefix = cursor.slice(&Some(locator), Bias::Left);
2714 new_excerpts.append(prefix, ());
2715
2716 let mut excerpt = cursor.item().unwrap().clone();
2717 let old_text_len = excerpt.text_summary.len;
2718
2719 excerpt.range.context.start = range.start;
2720 excerpt.range.context.end = range.end;
2721 excerpt.max_buffer_row = range.end.to_point(&excerpt.buffer).row;
2722
2723 excerpt.text_summary = excerpt
2724 .buffer
2725 .text_summary_for_range(excerpt.range.context.clone());
2726
2727 let new_start_offset = ExcerptDimension(new_excerpts.summary().text.len);
2728 let old_start_offset = cursor.start().1;
2729 let new_text_len = excerpt.text_summary.len;
2730 let edit = Edit {
2731 old: old_start_offset..old_start_offset + old_text_len,
2732 new: new_start_offset..new_start_offset + new_text_len,
2733 };
2734
2735 if let Some(last_edit) = edits.last_mut() {
2736 if last_edit.old.end == edit.old.start {
2737 last_edit.old.end = edit.old.end;
2738 last_edit.new.end = edit.new.end;
2739 } else {
2740 edits.push(edit);
2741 }
2742 } else {
2743 edits.push(edit);
2744 }
2745
2746 new_excerpts.push(excerpt, ());
2747
2748 cursor.next();
2749
2750 new_excerpts.append(cursor.suffix(), ());
2751
2752 drop(cursor);
2753 snapshot.excerpts = new_excerpts;
2754
2755 if let Some(follower) = &self.follower {
2756 follower.update(cx, |follower, cx| follower.resize_excerpt(id, range, cx));
2757 }
2758
2759 let edits = Self::sync_diff_transforms(
2760 &mut snapshot,
2761 edits,
2762 DiffChangeKind::BufferEdited,
2763 self.filter_mode,
2764 );
2765 if !edits.is_empty() {
2766 self.subscriptions.publish(edits);
2767 }
2768 cx.emit(Event::Edited {
2769 edited_buffer: None,
2770 });
2771 cx.emit(Event::ExcerptsExpanded { ids: vec![id] });
2772 cx.notify();
2773 }
2774
2775 pub fn expand_excerpts(
2776 &mut self,
2777 ids: impl IntoIterator<Item = ExcerptId>,
2778 line_count: u32,
2779 direction: ExpandExcerptDirection,
2780 cx: &mut Context<Self>,
2781 ) {
2782 if line_count == 0 {
2783 return;
2784 }
2785 self.sync_mut(cx);
2786 if !self.excerpts_by_path.is_empty() {
2787 self.expand_excerpts_with_paths(ids, line_count, direction, cx);
2788 return;
2789 }
2790 let mut snapshot = self.snapshot.get_mut();
2791
2792 let ids = ids.into_iter().collect::<Vec<_>>();
2793 let locators = snapshot.excerpt_locators_for_ids(ids.iter().copied());
2794 let mut new_excerpts = SumTree::default();
2795 let mut cursor = snapshot
2796 .excerpts
2797 .cursor::<Dimensions<Option<&Locator>, ExcerptOffset>>(());
2798 let mut excerpt_edits = Vec::<Edit<ExcerptOffset>>::new();
2799
2800 for locator in &locators {
2801 let prefix = cursor.slice(&Some(locator), Bias::Left);
2802 new_excerpts.append(prefix, ());
2803
2804 let mut excerpt = cursor.item().unwrap().clone();
2805 let old_text_len = excerpt.text_summary.len;
2806
2807 let up_line_count = if direction.should_expand_up() {
2808 line_count
2809 } else {
2810 0
2811 };
2812
2813 let start_row = excerpt
2814 .range
2815 .context
2816 .start
2817 .to_point(&excerpt.buffer)
2818 .row
2819 .saturating_sub(up_line_count);
2820 let start_point = Point::new(start_row, 0);
2821 excerpt.range.context.start = excerpt.buffer.anchor_before(start_point);
2822
2823 let down_line_count = if direction.should_expand_down() {
2824 line_count
2825 } else {
2826 0
2827 };
2828
2829 let mut end_point = excerpt.buffer.clip_point(
2830 excerpt.range.context.end.to_point(&excerpt.buffer)
2831 + Point::new(down_line_count, 0),
2832 Bias::Left,
2833 );
2834 end_point.column = excerpt.buffer.line_len(end_point.row);
2835 excerpt.range.context.end = excerpt.buffer.anchor_after(end_point);
2836 excerpt.max_buffer_row = end_point.row;
2837
2838 excerpt.text_summary = excerpt
2839 .buffer
2840 .text_summary_for_range(excerpt.range.context.clone());
2841
2842 let new_start_offset = ExcerptDimension(new_excerpts.summary().text.len);
2843 let old_start_offset = cursor.start().1;
2844 let new_text_len = excerpt.text_summary.len;
2845 let edit = Edit {
2846 old: old_start_offset..old_start_offset + old_text_len,
2847 new: new_start_offset..new_start_offset + new_text_len,
2848 };
2849
2850 if let Some(last_edit) = excerpt_edits.last_mut() {
2851 if last_edit.old.end == edit.old.start {
2852 last_edit.old.end = edit.old.end;
2853 last_edit.new.end = edit.new.end;
2854 } else {
2855 excerpt_edits.push(edit);
2856 }
2857 } else {
2858 excerpt_edits.push(edit);
2859 }
2860
2861 new_excerpts.push(excerpt, ());
2862
2863 cursor.next();
2864 }
2865
2866 new_excerpts.append(cursor.suffix(), ());
2867
2868 drop(cursor);
2869 snapshot.excerpts = new_excerpts.clone();
2870
2871 let edits = Self::sync_diff_transforms(
2872 &mut snapshot,
2873 excerpt_edits.clone(),
2874 DiffChangeKind::BufferEdited,
2875 self.filter_mode,
2876 );
2877 if !edits.is_empty() {
2878 self.subscriptions.publish(edits);
2879 }
2880 if let Some(follower) = &self.follower {
2881 follower.update(cx, |follower, cx| {
2882 follower.expand_excerpts(ids.clone(), line_count, direction, cx);
2883 })
2884 }
2885 cx.emit(Event::Edited {
2886 edited_buffer: None,
2887 });
2888 cx.emit(Event::ExcerptsExpanded { ids });
2889 cx.notify();
2890 }
2891
2892 #[ztracing::instrument(skip_all)]
2893 fn sync(&self, cx: &App) {
2894 let changed = self.buffer_changed_since_sync.replace(false);
2895 if !changed {
2896 return;
2897 }
2898 let edits = Self::sync_from_buffer_changes(
2899 &mut self.snapshot.borrow_mut(),
2900 &self.buffers,
2901 &self.diffs,
2902 self.filter_mode,
2903 cx,
2904 );
2905 if !edits.is_empty() {
2906 self.subscriptions.publish(edits);
2907 }
2908 }
2909
2910 fn sync_mut(&mut self, cx: &App) {
2911 let changed = self.buffer_changed_since_sync.replace(false);
2912 if !changed {
2913 return;
2914 }
2915 let edits = Self::sync_from_buffer_changes(
2916 self.snapshot.get_mut(),
2917 &self.buffers,
2918 &self.diffs,
2919 self.filter_mode,
2920 cx,
2921 );
2922
2923 if !edits.is_empty() {
2924 self.subscriptions.publish(edits);
2925 }
2926 }
2927
2928 fn sync_from_buffer_changes(
2929 snapshot: &mut MultiBufferSnapshot,
2930 buffers: &HashMap<BufferId, BufferState>,
2931 diffs: &HashMap<BufferId, DiffState>,
2932 filter_mode: Option<MultiBufferFilterMode>,
2933 cx: &App,
2934 ) -> Vec<Edit<MultiBufferOffset>> {
2935 let MultiBufferSnapshot {
2936 excerpts,
2937 diffs: buffer_diff,
2938 diff_transforms: _,
2939 non_text_state_update_count,
2940 edit_count,
2941 is_dirty,
2942 has_deleted_file,
2943 has_conflict,
2944 singleton: _,
2945 excerpt_ids: _,
2946 replaced_excerpts: _,
2947 trailing_excerpt_update_count: _,
2948 all_diff_hunks_expanded: _,
2949 show_headers: _,
2950 } = snapshot;
2951 *is_dirty = false;
2952 *has_deleted_file = false;
2953 *has_conflict = false;
2954
2955 let mut excerpts_to_edit = Vec::new();
2956 let mut non_text_state_updated = false;
2957 let mut edited = false;
2958 for buffer_state in buffers.values() {
2959 let buffer = buffer_state.buffer.read(cx);
2960 let version = buffer.version();
2961 let non_text_state_update_count = buffer.non_text_state_update_count();
2962
2963 let buffer_edited = version.changed_since(&buffer_state.last_version.borrow());
2964 let buffer_non_text_state_updated =
2965 non_text_state_update_count > buffer_state.last_non_text_state_update_count.get();
2966 if buffer_edited || buffer_non_text_state_updated {
2967 *buffer_state.last_version.borrow_mut() = version;
2968 buffer_state
2969 .last_non_text_state_update_count
2970 .set(non_text_state_update_count);
2971 excerpts_to_edit.extend(
2972 buffer_state
2973 .excerpts
2974 .iter()
2975 .map(|locator| (locator, buffer_state.buffer.clone(), buffer_edited)),
2976 );
2977 }
2978
2979 edited |= buffer_edited;
2980 non_text_state_updated |= buffer_non_text_state_updated;
2981 *is_dirty |= buffer.is_dirty();
2982 *has_deleted_file |= buffer
2983 .file()
2984 .is_some_and(|file| file.disk_state() == DiskState::Deleted);
2985 *has_conflict |= buffer.has_conflict();
2986 }
2987 if edited {
2988 *edit_count += 1;
2989 }
2990 if non_text_state_updated {
2991 *non_text_state_update_count += 1;
2992 }
2993
2994 for (id, diff) in diffs.iter() {
2995 if buffer_diff.get(id).is_none() {
2996 buffer_diff.insert(*id, diff.diff.read(cx).snapshot(cx));
2997 }
2998 }
2999
3000 excerpts_to_edit.sort_unstable_by_key(|(locator, _, _)| *locator);
3001
3002 let mut edits = Vec::new();
3003 let mut new_excerpts = SumTree::default();
3004 let mut cursor = excerpts.cursor::<Dimensions<Option<&Locator>, ExcerptOffset>>(());
3005
3006 for (locator, buffer, buffer_edited) in excerpts_to_edit {
3007 new_excerpts.append(cursor.slice(&Some(locator), Bias::Left), ());
3008 let old_excerpt = cursor.item().unwrap();
3009 let buffer = buffer.read(cx);
3010 let buffer_id = buffer.remote_id();
3011
3012 let mut new_excerpt;
3013 if buffer_edited {
3014 edits.extend(
3015 buffer
3016 .edits_since_in_range::<usize>(
3017 old_excerpt.buffer.version(),
3018 old_excerpt.range.context.clone(),
3019 )
3020 .map(|edit| {
3021 let excerpt_old_start = cursor.start().1;
3022 let excerpt_new_start =
3023 ExcerptDimension(new_excerpts.summary().text.len);
3024 let old_start = excerpt_old_start + edit.old.start;
3025 let old_end = excerpt_old_start + edit.old.end;
3026 let new_start = excerpt_new_start + edit.new.start;
3027 let new_end = excerpt_new_start + edit.new.end;
3028 Edit {
3029 old: old_start..old_end,
3030 new: new_start..new_end,
3031 }
3032 }),
3033 );
3034
3035 new_excerpt = Excerpt::new(
3036 old_excerpt.id,
3037 locator.clone(),
3038 buffer_id,
3039 buffer.snapshot(),
3040 old_excerpt.range.clone(),
3041 old_excerpt.has_trailing_newline,
3042 );
3043 } else {
3044 new_excerpt = old_excerpt.clone();
3045 new_excerpt.buffer = buffer.snapshot();
3046 }
3047
3048 new_excerpts.push(new_excerpt, ());
3049 cursor.next();
3050 }
3051 new_excerpts.append(cursor.suffix(), ());
3052
3053 drop(cursor);
3054 *excerpts = new_excerpts;
3055 Self::sync_diff_transforms(snapshot, edits, DiffChangeKind::BufferEdited, filter_mode)
3056 }
3057
3058 fn sync_diff_transforms(
3059 snapshot: &mut MultiBufferSnapshot,
3060 excerpt_edits: Vec<text::Edit<ExcerptOffset>>,
3061 change_kind: DiffChangeKind,
3062 filter_mode: Option<MultiBufferFilterMode>,
3063 ) -> Vec<Edit<MultiBufferOffset>> {
3064 if excerpt_edits.is_empty() {
3065 return vec![];
3066 }
3067
3068 let mut excerpts = snapshot.excerpts.cursor::<ExcerptOffset>(());
3069 let mut old_diff_transforms = snapshot
3070 .diff_transforms
3071 .cursor::<Dimensions<ExcerptOffset, MultiBufferOffset>>(());
3072 let mut new_diff_transforms = SumTree::default();
3073 let mut old_expanded_hunks = HashSet::default();
3074 let mut output_edits = Vec::new();
3075 let mut output_delta = 0_isize;
3076 let mut at_transform_boundary = true;
3077 let mut end_of_current_insert = None;
3078
3079 let mut excerpt_edits: VecDeque<_> = excerpt_edits.into_iter().collect();
3080 while let Some(edit) = excerpt_edits.pop_front() {
3081 excerpts.seek_forward(&edit.new.start, Bias::Right);
3082 if excerpts.item().is_none() && *excerpts.start() == edit.new.start {
3083 excerpts.prev();
3084 }
3085
3086 // Keep any transforms that are before the edit.
3087 if at_transform_boundary {
3088 at_transform_boundary = false;
3089 let transforms_before_edit = old_diff_transforms.slice(&edit.old.start, Bias::Left);
3090 Self::append_diff_transforms(&mut new_diff_transforms, transforms_before_edit);
3091 if let Some(transform) = old_diff_transforms.item()
3092 && old_diff_transforms.end().0 == edit.old.start
3093 && old_diff_transforms.start().0 < edit.old.start
3094 {
3095 Self::push_diff_transform(&mut new_diff_transforms, transform.clone());
3096 old_diff_transforms.next();
3097 }
3098 }
3099
3100 // Compute the start of the edit in output coordinates.
3101 let edit_start_overshoot = if let Some(DiffTransform::FilteredInsertedHunk { .. }) =
3102 old_diff_transforms.item()
3103 {
3104 0
3105 } else {
3106 edit.old.start - old_diff_transforms.start().0
3107 };
3108 let edit_old_start = old_diff_transforms.start().1 + edit_start_overshoot;
3109 let edit_new_start =
3110 MultiBufferOffset((edit_old_start.0 as isize + output_delta) as usize);
3111
3112 let changed_diff_hunks = Self::recompute_diff_transforms_for_edit(
3113 &edit,
3114 &mut excerpts,
3115 &mut old_diff_transforms,
3116 &mut new_diff_transforms,
3117 &mut end_of_current_insert,
3118 &mut old_expanded_hunks,
3119 snapshot,
3120 change_kind,
3121 filter_mode,
3122 );
3123
3124 // When the added range of a hunk is edited, the end anchor of the hunk may be moved later
3125 // in response by hunks_intersecting_range to keep it at a row boundary. In KeepDeletions
3126 // mode, we need to make sure that the whole added range is still filtered out in this situation.
3127 // We do that by adding an additional edit that covers the rest of the hunk added range.
3128 if let Some(current_inserted_hunk) = &end_of_current_insert
3129 && current_inserted_hunk.is_filtered
3130 // No additional edit needed if we've already covered the whole added range.
3131 && current_inserted_hunk.insertion_end_offset > edit.new.end
3132 // No additional edit needed if this edit just touched the start of the hunk
3133 // (this also prevents pushing the deleted region for the hunk twice).
3134 && edit.new.end > current_inserted_hunk.hunk_excerpt_start
3135 // No additional edit needed if there is a subsequent edit that intersects
3136 // the same hunk (the last such edit will take care of it).
3137 && excerpt_edits.front().is_none_or(|next_edit| {
3138 next_edit.new.start >= current_inserted_hunk.insertion_end_offset
3139 })
3140 {
3141 let overshoot = current_inserted_hunk.insertion_end_offset - edit.new.end;
3142 let additional_edit = Edit {
3143 old: edit.old.end..edit.old.end + overshoot,
3144 new: edit.new.end..current_inserted_hunk.insertion_end_offset,
3145 };
3146 excerpt_edits.push_front(additional_edit);
3147 }
3148
3149 // Compute the end of the edit in output coordinates.
3150 let edit_old_end_overshoot = if let Some(DiffTransform::FilteredInsertedHunk {
3151 ..
3152 }) = old_diff_transforms.item()
3153 {
3154 ExcerptDimension(MultiBufferOffset(0))
3155 } else {
3156 ExcerptDimension(MultiBufferOffset(
3157 edit.old.end - old_diff_transforms.start().0,
3158 ))
3159 };
3160 let edit_new_end_overshoot = if let Some(current_inserted_hunk) = &end_of_current_insert
3161 && current_inserted_hunk.is_filtered
3162 {
3163 let insertion_end_offset = current_inserted_hunk.insertion_end_offset;
3164 let excerpt_len = new_diff_transforms.summary().excerpt_len();
3165 let base = insertion_end_offset.max(excerpt_len);
3166 edit.new.end.saturating_sub(base)
3167 } else {
3168 edit.new.end - new_diff_transforms.summary().excerpt_len()
3169 };
3170 let edit_old_end = old_diff_transforms.start().1 + edit_old_end_overshoot.0;
3171 let edit_new_end = new_diff_transforms.summary().output.len + edit_new_end_overshoot;
3172 let output_edit = Edit {
3173 old: edit_old_start..edit_old_end,
3174 new: edit_new_start..edit_new_end,
3175 };
3176
3177 output_delta += (output_edit.new.end - output_edit.new.start) as isize;
3178 output_delta -= (output_edit.old.end - output_edit.old.start) as isize;
3179 if changed_diff_hunks || matches!(change_kind, DiffChangeKind::BufferEdited) {
3180 output_edits.push(output_edit);
3181 }
3182
3183 // If this is the last edit that intersects the current diff transform,
3184 // then recreate the content up to the end of this transform, to prepare
3185 // for reusing additional slices of the old transforms.
3186 if excerpt_edits
3187 .front()
3188 .is_none_or(|next_edit| next_edit.old.start >= old_diff_transforms.end().0)
3189 {
3190 let keep_next_old_transform = (old_diff_transforms.start().0 >= edit.old.end)
3191 && match old_diff_transforms.item() {
3192 Some(
3193 DiffTransform::InsertedHunk { hunk_info, .. }
3194 | DiffTransform::FilteredInsertedHunk { hunk_info, .. },
3195 ) => excerpts.item().is_some_and(|excerpt| {
3196 hunk_info.hunk_start_anchor.is_valid(&excerpt.buffer)
3197 }),
3198 _ => true,
3199 };
3200
3201 let mut excerpt_offset = edit.new.end;
3202 if !keep_next_old_transform {
3203 excerpt_offset += old_diff_transforms.end().0 - edit.old.end;
3204 old_diff_transforms.next();
3205 }
3206
3207 old_expanded_hunks.clear();
3208 Self::push_buffer_content_transform(
3209 snapshot,
3210 &mut new_diff_transforms,
3211 excerpt_offset,
3212 end_of_current_insert.as_ref(),
3213 );
3214 at_transform_boundary = true;
3215 }
3216 }
3217
3218 // Keep any transforms that are after the last edit.
3219 Self::append_diff_transforms(&mut new_diff_transforms, old_diff_transforms.suffix());
3220
3221 // Ensure there's always at least one buffer content transform.
3222 if new_diff_transforms.is_empty() {
3223 new_diff_transforms.push(
3224 DiffTransform::Unmodified {
3225 summary: Default::default(),
3226 },
3227 (),
3228 );
3229 }
3230
3231 drop(old_diff_transforms);
3232 drop(excerpts);
3233 snapshot.diff_transforms = new_diff_transforms;
3234 snapshot.edit_count += 1;
3235
3236 #[cfg(any(test, feature = "test-support"))]
3237 snapshot.check_invariants();
3238 output_edits
3239 }
3240
3241 fn recompute_diff_transforms_for_edit(
3242 edit: &Edit<ExcerptOffset>,
3243 excerpts: &mut Cursor<Excerpt, ExcerptOffset>,
3244 old_diff_transforms: &mut Cursor<
3245 DiffTransform,
3246 Dimensions<ExcerptOffset, MultiBufferOffset>,
3247 >,
3248 new_diff_transforms: &mut SumTree<DiffTransform>,
3249 end_of_current_insert: &mut Option<CurrentInsertedHunk>,
3250 old_expanded_hunks: &mut HashSet<DiffTransformHunkInfo>,
3251 snapshot: &MultiBufferSnapshot,
3252 change_kind: DiffChangeKind,
3253 filter_mode: Option<MultiBufferFilterMode>,
3254 ) -> bool {
3255 log::trace!(
3256 "recomputing diff transform for edit {:?} => {:?}",
3257 edit.old.start..edit.old.end,
3258 edit.new.start..edit.new.end
3259 );
3260
3261 // Record which hunks were previously expanded.
3262 while let Some(item) = old_diff_transforms.item() {
3263 if let Some(hunk_info) = item.hunk_info() {
3264 log::trace!(
3265 "previously expanded hunk at {:?}",
3266 old_diff_transforms.start()
3267 );
3268 old_expanded_hunks.insert(hunk_info);
3269 }
3270 if old_diff_transforms.end().0 > edit.old.end {
3271 break;
3272 }
3273 old_diff_transforms.next();
3274 }
3275
3276 // Avoid querying diff hunks if there's no possibility of hunks being expanded.
3277 let all_diff_hunks_expanded = snapshot.all_diff_hunks_expanded;
3278 if old_expanded_hunks.is_empty()
3279 && change_kind == DiffChangeKind::BufferEdited
3280 && !all_diff_hunks_expanded
3281 {
3282 return false;
3283 }
3284
3285 // Visit each excerpt that intersects the edit.
3286 let mut did_expand_hunks = false;
3287 while let Some(excerpt) = excerpts.item() {
3288 // Recompute the expanded hunks in the portion of the excerpt that
3289 // intersects the edit.
3290 if let Some(diff) = snapshot.diffs.get(&excerpt.buffer_id) {
3291 let buffer = &excerpt.buffer;
3292 let excerpt_start = *excerpts.start();
3293 let excerpt_end = excerpt_start + excerpt.text_summary.len;
3294 let excerpt_buffer_start = excerpt.range.context.start.to_offset(buffer);
3295 let excerpt_buffer_end = excerpt_buffer_start + excerpt.text_summary.len;
3296 let edit_buffer_start =
3297 excerpt_buffer_start + edit.new.start.saturating_sub(excerpt_start);
3298 let edit_buffer_end =
3299 excerpt_buffer_start + edit.new.end.saturating_sub(excerpt_start);
3300 let edit_buffer_end = edit_buffer_end.min(excerpt_buffer_end);
3301 let edit_anchor_range =
3302 buffer.anchor_before(edit_buffer_start)..buffer.anchor_after(edit_buffer_end);
3303
3304 for hunk in diff.hunks_intersecting_range(edit_anchor_range, buffer) {
3305 if hunk.is_created_file() && !all_diff_hunks_expanded {
3306 continue;
3307 }
3308
3309 let hunk_buffer_range = hunk.buffer_range.to_offset(buffer);
3310 if hunk_buffer_range.start < excerpt_buffer_start {
3311 log::trace!("skipping hunk that starts before excerpt");
3312 continue;
3313 }
3314
3315 let hunk_info = DiffTransformHunkInfo {
3316 excerpt_id: excerpt.id,
3317 hunk_start_anchor: hunk.buffer_range.start,
3318 hunk_secondary_status: hunk.secondary_status,
3319 base_text_byte_range: hunk.diff_base_byte_range.clone(),
3320 };
3321
3322 let hunk_excerpt_start = excerpt_start
3323 + hunk_buffer_range.start.saturating_sub(excerpt_buffer_start);
3324 let hunk_excerpt_end = excerpt_end
3325 .min(excerpt_start + (hunk_buffer_range.end - excerpt_buffer_start));
3326
3327 Self::push_buffer_content_transform(
3328 snapshot,
3329 new_diff_transforms,
3330 hunk_excerpt_start,
3331 end_of_current_insert.as_ref(),
3332 );
3333
3334 // For every existing hunk, determine if it was previously expanded
3335 // and if it should currently be expanded.
3336 let was_previously_expanded = old_expanded_hunks.contains(&hunk_info);
3337 let should_expand_hunk = match &change_kind {
3338 DiffChangeKind::DiffUpdated { base_changed: true } => {
3339 was_previously_expanded || all_diff_hunks_expanded
3340 }
3341 DiffChangeKind::ExpandOrCollapseHunks { expand } => {
3342 let intersects = hunk_buffer_range.is_empty()
3343 || hunk_buffer_range.end > edit_buffer_start;
3344 if *expand {
3345 intersects || was_previously_expanded || all_diff_hunks_expanded
3346 } else {
3347 !intersects && (was_previously_expanded || all_diff_hunks_expanded)
3348 }
3349 }
3350 _ => was_previously_expanded || all_diff_hunks_expanded,
3351 };
3352
3353 if should_expand_hunk {
3354 did_expand_hunks = true;
3355 log::trace!(
3356 "expanding hunk {:?}, excerpt:{:?}",
3357 hunk_excerpt_start..hunk_excerpt_end,
3358 excerpt.id
3359 );
3360
3361 if !hunk.diff_base_byte_range.is_empty()
3362 && hunk_buffer_range.start >= edit_buffer_start
3363 && hunk_buffer_range.start <= excerpt_buffer_end
3364 && filter_mode != Some(MultiBufferFilterMode::KeepInsertions)
3365 {
3366 let base_text = diff.base_text();
3367 let mut text_cursor =
3368 base_text.as_rope().cursor(hunk.diff_base_byte_range.start);
3369 let mut base_text_summary =
3370 text_cursor.summary::<TextSummary>(hunk.diff_base_byte_range.end);
3371
3372 let mut has_trailing_newline = false;
3373 if base_text_summary.last_line_chars > 0 {
3374 base_text_summary += TextSummary::newline();
3375 has_trailing_newline = true;
3376 }
3377
3378 new_diff_transforms.push(
3379 DiffTransform::DeletedHunk {
3380 summary: base_text_summary,
3381 buffer_id: excerpt.buffer_id,
3382 hunk_info: hunk_info.clone(),
3383 has_trailing_newline,
3384 },
3385 (),
3386 );
3387 }
3388
3389 if !hunk_buffer_range.is_empty() {
3390 let is_filtered =
3391 filter_mode == Some(MultiBufferFilterMode::KeepDeletions);
3392 let insertion_end_offset = hunk_excerpt_end.min(excerpt_end);
3393 *end_of_current_insert = Some(CurrentInsertedHunk {
3394 hunk_excerpt_start,
3395 insertion_end_offset,
3396 hunk_info,
3397 is_filtered,
3398 });
3399 }
3400 }
3401 }
3402 }
3403
3404 if excerpts.end() <= edit.new.end {
3405 excerpts.next();
3406 } else {
3407 break;
3408 }
3409 }
3410
3411 did_expand_hunks || !old_expanded_hunks.is_empty()
3412 }
3413
3414 fn append_diff_transforms(
3415 new_transforms: &mut SumTree<DiffTransform>,
3416 subtree: SumTree<DiffTransform>,
3417 ) {
3418 if let Some(transform) = subtree.first()
3419 && Self::extend_last_buffer_content_transform(new_transforms, transform)
3420 {
3421 let mut cursor = subtree.cursor::<()>(());
3422 cursor.next();
3423 cursor.next();
3424 new_transforms.append(cursor.suffix(), ());
3425 return;
3426 }
3427 new_transforms.append(subtree, ());
3428 }
3429
3430 fn push_diff_transform(new_transforms: &mut SumTree<DiffTransform>, transform: DiffTransform) {
3431 if Self::extend_last_buffer_content_transform(new_transforms, &transform) {
3432 return;
3433 }
3434 new_transforms.push(transform, ());
3435 }
3436
3437 fn push_buffer_content_transform(
3438 old_snapshot: &MultiBufferSnapshot,
3439 new_transforms: &mut SumTree<DiffTransform>,
3440 end_offset: ExcerptOffset,
3441 current_inserted_hunk: Option<&CurrentInsertedHunk>,
3442 ) {
3443 if let Some(current_inserted_hunk) = current_inserted_hunk {
3444 let start_offset = new_transforms.summary().excerpt_len();
3445 let end_offset = current_inserted_hunk.insertion_end_offset.min(end_offset);
3446 if end_offset > start_offset {
3447 let summary_to_add = old_snapshot
3448 .text_summary_for_excerpt_offset_range::<MBTextSummary>(
3449 start_offset..end_offset,
3450 );
3451
3452 let transform = if current_inserted_hunk.is_filtered {
3453 DiffTransform::FilteredInsertedHunk {
3454 summary: summary_to_add,
3455 hunk_info: current_inserted_hunk.hunk_info.clone(),
3456 }
3457 } else {
3458 DiffTransform::InsertedHunk {
3459 summary: summary_to_add,
3460 hunk_info: current_inserted_hunk.hunk_info.clone(),
3461 }
3462 };
3463 if !Self::extend_last_buffer_content_transform(new_transforms, &transform) {
3464 new_transforms.push(transform, ())
3465 }
3466 }
3467 }
3468
3469 let start_offset = new_transforms.summary().excerpt_len();
3470 if end_offset > start_offset {
3471 let summary_to_add = old_snapshot
3472 .text_summary_for_excerpt_offset_range::<MBTextSummary>(start_offset..end_offset);
3473
3474 let transform = DiffTransform::Unmodified {
3475 summary: summary_to_add,
3476 };
3477 if !Self::extend_last_buffer_content_transform(new_transforms, &transform) {
3478 new_transforms.push(transform, ())
3479 }
3480 }
3481 }
3482
3483 fn extend_last_buffer_content_transform(
3484 new_transforms: &mut SumTree<DiffTransform>,
3485 transform: &DiffTransform,
3486 ) -> bool {
3487 let mut did_extend = false;
3488 new_transforms.update_last(
3489 |last_transform| {
3490 did_extend = last_transform.merge_with(&transform);
3491 },
3492 (),
3493 );
3494 did_extend
3495 }
3496}
3497
3498impl DiffTransform {
3499 /// Ergonomic wrapper for [`DiffTransform::merged_with`] that applies the
3500 /// merging in-place. Returns `true` if merging was possible.
3501 #[must_use = "check whether merging actually succeeded"]
3502 fn merge_with(&mut self, other: &Self) -> bool {
3503 match self.to_owned().merged_with(other) {
3504 Some(merged) => {
3505 *self = merged;
3506 true
3507 }
3508 None => false,
3509 }
3510 }
3511
3512 /// Attempt to merge `self` with `other`, and return the merged transform.
3513 ///
3514 /// This will succeed if all of the following are true:
3515 /// - both transforms are the same variant
3516 /// - neither transform is [`DiffTransform::DeletedHunk`]
3517 /// - if both transform are either [`DiffTransform::InsertedHunk`] or
3518 /// [`DiffTransform::FilteredInsertedHunk`], then their
3519 /// `hunk_info.hunk_start_anchor`s match
3520 #[must_use = "check whether merging actually succeeded"]
3521 #[rustfmt::skip]
3522 fn merged_with(self, other: &Self) -> Option<Self> {
3523 match (self, other) {
3524 (
3525 DiffTransform::Unmodified { mut summary },
3526 DiffTransform::Unmodified { summary: other_summary },
3527 ) => {
3528 summary += *other_summary;
3529 Some(DiffTransform::Unmodified { summary })
3530 }
3531 (
3532 DiffTransform::FilteredInsertedHunk { mut summary, hunk_info },
3533 DiffTransform::FilteredInsertedHunk {
3534 hunk_info: other_hunk_info,
3535 summary: other_summary,
3536 },
3537 ) => {
3538 if hunk_info.hunk_start_anchor == other_hunk_info.hunk_start_anchor {
3539 summary += *other_summary;
3540 Some(DiffTransform::FilteredInsertedHunk { summary, hunk_info })
3541 } else {
3542 None
3543 }
3544 }
3545 (
3546 DiffTransform::InsertedHunk { mut summary, hunk_info },
3547 DiffTransform::InsertedHunk {
3548 hunk_info: other_hunk_info,
3549 summary: other_summary,
3550 },
3551 ) => {
3552 if hunk_info.hunk_start_anchor == other_hunk_info.hunk_start_anchor {
3553 summary += *other_summary;
3554 Some(DiffTransform::InsertedHunk { summary, hunk_info })
3555 } else {
3556 None
3557 }
3558 }
3559 _ => return None,
3560 }
3561 }
3562}
3563
3564fn build_excerpt_ranges(
3565 ranges: impl IntoIterator<Item = Range<Point>>,
3566 context_line_count: u32,
3567 buffer_snapshot: &BufferSnapshot,
3568) -> Vec<ExcerptRange<Point>> {
3569 ranges
3570 .into_iter()
3571 .map(|range| {
3572 let start_row = range.start.row.saturating_sub(context_line_count);
3573 let start = Point::new(start_row, 0);
3574 let end_row = (range.end.row + context_line_count).min(buffer_snapshot.max_point().row);
3575 let end = Point::new(end_row, buffer_snapshot.line_len(end_row));
3576 ExcerptRange {
3577 context: start..end,
3578 primary: range,
3579 }
3580 })
3581 .collect()
3582}
3583
3584#[cfg(any(test, feature = "test-support"))]
3585impl MultiBuffer {
3586 pub fn build_simple(text: &str, cx: &mut gpui::App) -> Entity<Self> {
3587 let buffer = cx.new(|cx| Buffer::local(text, cx));
3588 cx.new(|cx| Self::singleton(buffer, cx))
3589 }
3590
3591 pub fn build_multi<const COUNT: usize>(
3592 excerpts: [(&str, Vec<Range<Point>>); COUNT],
3593 cx: &mut gpui::App,
3594 ) -> Entity<Self> {
3595 let multi = cx.new(|_| Self::new(Capability::ReadWrite));
3596 for (text, ranges) in excerpts {
3597 let buffer = cx.new(|cx| Buffer::local(text, cx));
3598 let excerpt_ranges = ranges.into_iter().map(ExcerptRange::new);
3599 multi.update(cx, |multi, cx| {
3600 multi.push_excerpts(buffer, excerpt_ranges, cx)
3601 });
3602 }
3603
3604 multi
3605 }
3606
3607 pub fn build_from_buffer(buffer: Entity<Buffer>, cx: &mut gpui::App) -> Entity<Self> {
3608 cx.new(|cx| Self::singleton(buffer, cx))
3609 }
3610
3611 pub fn build_random(rng: &mut impl rand::Rng, cx: &mut gpui::App) -> Entity<Self> {
3612 cx.new(|cx| {
3613 let mut multibuffer = MultiBuffer::new(Capability::ReadWrite);
3614 let mutation_count = rng.random_range(1..=5);
3615 multibuffer.randomly_edit_excerpts(rng, mutation_count, cx);
3616 multibuffer
3617 })
3618 }
3619
3620 pub fn randomly_edit(
3621 &mut self,
3622 rng: &mut impl rand::Rng,
3623 edit_count: usize,
3624 cx: &mut Context<Self>,
3625 ) {
3626 use util::RandomCharIter;
3627
3628 let snapshot = self.read(cx);
3629 let mut edits: Vec<(Range<MultiBufferOffset>, Arc<str>)> = Vec::new();
3630 let mut last_end = None;
3631 for _ in 0..edit_count {
3632 if last_end.is_some_and(|last_end| last_end >= snapshot.len()) {
3633 break;
3634 }
3635
3636 let new_start = last_end.map_or(MultiBufferOffset::ZERO, |last_end| last_end + 1usize);
3637 let end =
3638 snapshot.clip_offset(rng.random_range(new_start..=snapshot.len()), Bias::Right);
3639 let start = snapshot.clip_offset(rng.random_range(new_start..=end), Bias::Right);
3640 last_end = Some(end);
3641
3642 let mut range = start..end;
3643 if rng.random_bool(0.2) {
3644 mem::swap(&mut range.start, &mut range.end);
3645 }
3646
3647 let new_text_len = rng.random_range(0..10);
3648 let new_text: String = RandomCharIter::new(&mut *rng).take(new_text_len).collect();
3649
3650 edits.push((range, new_text.into()));
3651 }
3652 log::info!("mutating multi-buffer with {:?}", edits);
3653 drop(snapshot);
3654
3655 self.edit(edits, None, cx);
3656 }
3657
3658 pub fn randomly_edit_excerpts(
3659 &mut self,
3660 rng: &mut impl rand::Rng,
3661 mutation_count: usize,
3662 cx: &mut Context<Self>,
3663 ) {
3664 use rand::prelude::*;
3665 use std::env;
3666 use util::RandomCharIter;
3667
3668 let max_excerpts = env::var("MAX_EXCERPTS")
3669 .map(|i| i.parse().expect("invalid `MAX_EXCERPTS` variable"))
3670 .unwrap_or(5);
3671
3672 let mut buffers = Vec::new();
3673 for _ in 0..mutation_count {
3674 if rng.random_bool(0.05) {
3675 log::info!("Clearing multi-buffer");
3676 self.clear(cx);
3677 continue;
3678 } else if rng.random_bool(0.1) && !self.excerpt_ids().is_empty() {
3679 let ids = self.excerpt_ids();
3680 let mut excerpts = HashSet::default();
3681 for _ in 0..rng.random_range(0..ids.len()) {
3682 excerpts.extend(ids.choose(rng).copied());
3683 }
3684
3685 let line_count = rng.random_range(0..5);
3686
3687 log::info!("Expanding excerpts {excerpts:?} by {line_count} lines");
3688
3689 self.expand_excerpts(
3690 excerpts.iter().cloned(),
3691 line_count,
3692 ExpandExcerptDirection::UpAndDown,
3693 cx,
3694 );
3695 continue;
3696 }
3697
3698 let excerpt_ids = self.excerpt_ids();
3699 if excerpt_ids.is_empty() || (rng.random() && excerpt_ids.len() < max_excerpts) {
3700 let buffer_handle = if rng.random() || self.buffers.is_empty() {
3701 let text = RandomCharIter::new(&mut *rng).take(10).collect::<String>();
3702 buffers.push(cx.new(|cx| Buffer::local(text, cx)));
3703 let buffer = buffers.last().unwrap().read(cx);
3704 log::info!(
3705 "Creating new buffer {} with text: {:?}",
3706 buffer.remote_id(),
3707 buffer.text()
3708 );
3709 buffers.last().unwrap().clone()
3710 } else {
3711 self.buffers.values().choose(rng).unwrap().buffer.clone()
3712 };
3713
3714 let buffer = buffer_handle.read(cx);
3715 let buffer_text = buffer.text();
3716 let ranges = (0..rng.random_range(0..5))
3717 .map(|_| {
3718 let end_ix =
3719 buffer.clip_offset(rng.random_range(0..=buffer.len()), Bias::Right);
3720 let start_ix = buffer.clip_offset(rng.random_range(0..=end_ix), Bias::Left);
3721 ExcerptRange::new(start_ix..end_ix)
3722 })
3723 .collect::<Vec<_>>();
3724 log::info!(
3725 "Inserting excerpts from buffer {} and ranges {:?}: {:?}",
3726 buffer_handle.read(cx).remote_id(),
3727 ranges.iter().map(|r| &r.context).collect::<Vec<_>>(),
3728 ranges
3729 .iter()
3730 .map(|r| &buffer_text[r.context.clone()])
3731 .collect::<Vec<_>>()
3732 );
3733
3734 let excerpt_id = self.push_excerpts(buffer_handle.clone(), ranges, cx);
3735 log::info!("Inserted with ids: {:?}", excerpt_id);
3736 } else {
3737 let remove_count = rng.random_range(1..=excerpt_ids.len());
3738 let mut excerpts_to_remove = excerpt_ids
3739 .choose_multiple(rng, remove_count)
3740 .cloned()
3741 .collect::<Vec<_>>();
3742 let snapshot = self.snapshot.borrow();
3743 excerpts_to_remove.sort_unstable_by(|a, b| a.cmp(b, &snapshot));
3744 drop(snapshot);
3745 log::info!("Removing excerpts {:?}", excerpts_to_remove);
3746 self.remove_excerpts(excerpts_to_remove, cx);
3747 }
3748 }
3749 }
3750
3751 pub fn randomly_mutate(
3752 &mut self,
3753 rng: &mut impl rand::Rng,
3754 mutation_count: usize,
3755 cx: &mut Context<Self>,
3756 ) {
3757 use rand::prelude::*;
3758
3759 if rng.random_bool(0.7) || self.singleton {
3760 let buffer = self
3761 .buffers
3762 .values()
3763 .choose(rng)
3764 .map(|state| state.buffer.clone());
3765
3766 if let Some(buffer) = buffer {
3767 buffer.update(cx, |buffer, cx| {
3768 if rng.random() {
3769 buffer.randomly_edit(rng, mutation_count, cx);
3770 } else {
3771 buffer.randomly_undo_redo(rng, cx);
3772 }
3773 });
3774 } else {
3775 self.randomly_edit(rng, mutation_count, cx);
3776 }
3777 } else {
3778 self.randomly_edit_excerpts(rng, mutation_count, cx);
3779 }
3780
3781 self.check_invariants(cx);
3782 }
3783
3784 fn check_invariants(&self, cx: &App) {
3785 self.read(cx).check_invariants();
3786 }
3787}
3788
3789impl EventEmitter<Event> for MultiBuffer {}
3790
3791impl MultiBufferSnapshot {
3792 pub fn text(&self) -> String {
3793 self.chunks(MultiBufferOffset::ZERO..self.len(), false)
3794 .map(|chunk| chunk.text)
3795 .collect()
3796 }
3797
3798 pub fn reversed_chars_at<T: ToOffset>(&self, position: T) -> impl Iterator<Item = char> + '_ {
3799 self.reversed_chunks_in_range(MultiBufferOffset::ZERO..position.to_offset(self))
3800 .flat_map(|c| c.chars().rev())
3801 }
3802
3803 fn reversed_chunks_in_range(
3804 &self,
3805 range: Range<MultiBufferOffset>,
3806 ) -> ReversedMultiBufferChunks<'_> {
3807 let mut cursor = self.cursor::<MultiBufferOffset, BufferOffset>();
3808 cursor.seek(&range.end);
3809 let current_chunks = cursor.region().as_ref().map(|region| {
3810 let start_overshoot = range.start.saturating_sub(region.range.start);
3811 let end_overshoot = range.end - region.range.start;
3812 let end = (region.buffer_range.start + end_overshoot).min(region.buffer_range.end);
3813 let start = region.buffer_range.start + start_overshoot;
3814 region.buffer.reversed_chunks_in_range(start..end)
3815 });
3816 ReversedMultiBufferChunks {
3817 cursor,
3818 current_chunks,
3819 start: range.start,
3820 offset: range.end,
3821 }
3822 }
3823
3824 pub fn chars_at<T: ToOffset>(&self, position: T) -> impl Iterator<Item = char> + '_ {
3825 let offset = position.to_offset(self);
3826 self.text_for_range(offset..self.len())
3827 .flat_map(|chunk| chunk.chars())
3828 }
3829
3830 pub fn text_for_range<T: ToOffset>(&self, range: Range<T>) -> impl Iterator<Item = &str> + '_ {
3831 self.chunks(range, false).map(|chunk| chunk.text)
3832 }
3833
3834 pub fn is_line_blank(&self, row: MultiBufferRow) -> bool {
3835 self.text_for_range(Point::new(row.0, 0)..Point::new(row.0, self.line_len(row)))
3836 .all(|chunk| chunk.matches(|c: char| !c.is_whitespace()).next().is_none())
3837 }
3838
3839 pub fn contains_str_at<T>(&self, position: T, needle: &str) -> bool
3840 where
3841 T: ToOffset,
3842 {
3843 let position = position.to_offset(self);
3844 position == self.clip_offset(position, Bias::Left)
3845 && self
3846 .bytes_in_range(position..self.len())
3847 .flatten()
3848 .copied()
3849 .take(needle.len())
3850 .eq(needle.bytes())
3851 }
3852
3853 pub fn diff_hunks(&self) -> impl Iterator<Item = MultiBufferDiffHunk> + '_ {
3854 self.diff_hunks_in_range(Anchor::min()..Anchor::max())
3855 }
3856
3857 pub fn diff_hunks_in_range<T: ToPoint>(
3858 &self,
3859 range: Range<T>,
3860 ) -> impl Iterator<Item = MultiBufferDiffHunk> + '_ {
3861 let query_range = range.start.to_point(self)..range.end.to_point(self);
3862 self.lift_buffer_metadata(query_range.clone(), move |buffer, buffer_range| {
3863 let diff = self.diffs.get(&buffer.remote_id())?;
3864 let buffer_start = buffer.anchor_before(buffer_range.start);
3865 let buffer_end = buffer.anchor_after(buffer_range.end);
3866 Some(
3867 diff.hunks_intersecting_range(buffer_start..buffer_end, buffer)
3868 .filter_map(|hunk| {
3869 if hunk.is_created_file() && !self.all_diff_hunks_expanded {
3870 return None;
3871 }
3872 Some((hunk.range.clone(), hunk))
3873 }),
3874 )
3875 })
3876 .filter_map(move |(range, hunk, excerpt)| {
3877 if range.start != range.end && range.end == query_range.start && !hunk.range.is_empty()
3878 {
3879 return None;
3880 }
3881 let end_row = if range.end.column == 0 {
3882 range.end.row
3883 } else {
3884 range.end.row + 1
3885 };
3886
3887 let word_diffs = (!hunk.base_word_diffs.is_empty()
3888 || !hunk.buffer_word_diffs.is_empty())
3889 .then(|| {
3890 let hunk_start_offset =
3891 Anchor::in_buffer(excerpt.id, hunk.buffer_range.start).to_offset(self);
3892
3893 hunk.base_word_diffs
3894 .iter()
3895 .map(|diff| hunk_start_offset + diff.start..hunk_start_offset + diff.end)
3896 .chain(
3897 hunk.buffer_word_diffs
3898 .into_iter()
3899 .map(|diff| Anchor::range_in_buffer(excerpt.id, diff).to_offset(self)),
3900 )
3901 .collect()
3902 })
3903 .unwrap_or_default();
3904
3905 Some(MultiBufferDiffHunk {
3906 row_range: MultiBufferRow(range.start.row)..MultiBufferRow(end_row),
3907 buffer_id: excerpt.buffer_id,
3908 excerpt_id: excerpt.id,
3909 buffer_range: hunk.buffer_range.clone(),
3910 word_diffs,
3911 diff_base_byte_range: BufferOffset(hunk.diff_base_byte_range.start)
3912 ..BufferOffset(hunk.diff_base_byte_range.end),
3913 secondary_status: hunk.secondary_status,
3914 })
3915 })
3916 }
3917
3918 fn excerpts_for_range<T: ToOffset>(
3919 &self,
3920 range: Range<T>,
3921 ) -> impl Iterator<Item = &Excerpt> + '_ {
3922 let range = range.start.to_offset(self)..range.end.to_offset(self);
3923 let mut cursor = self.cursor::<MultiBufferOffset, BufferOffset>();
3924 cursor.seek(&range.start);
3925 std::iter::from_fn(move || {
3926 let region = cursor.region()?;
3927 if region.range.start > range.end
3928 || region.range.start == range.end && region.range.start > range.start
3929 {
3930 return None;
3931 }
3932 cursor.next_excerpt();
3933 Some(region.excerpt)
3934 })
3935 }
3936
3937 pub fn excerpt_ids_for_range<T: ToOffset>(
3938 &self,
3939 range: Range<T>,
3940 ) -> impl Iterator<Item = ExcerptId> + '_ {
3941 self.excerpts_for_range(range).map(|excerpt| excerpt.id)
3942 }
3943
3944 pub fn buffer_ids_for_range<T: ToOffset>(
3945 &self,
3946 range: Range<T>,
3947 ) -> impl Iterator<Item = BufferId> + '_ {
3948 self.excerpts_for_range(range)
3949 .map(|excerpt| excerpt.buffer_id)
3950 }
3951
3952 pub fn ranges_to_buffer_ranges<T: ToOffset>(
3953 &self,
3954 ranges: impl Iterator<Item = Range<T>>,
3955 ) -> impl Iterator<Item = (&BufferSnapshot, Range<BufferOffset>, ExcerptId)> {
3956 ranges.flat_map(|range| self.range_to_buffer_ranges(range).into_iter())
3957 }
3958
3959 pub fn range_to_buffer_ranges<T: ToOffset>(
3960 &self,
3961 range: Range<T>,
3962 ) -> Vec<(&BufferSnapshot, Range<BufferOffset>, ExcerptId)> {
3963 let start = range.start.to_offset(self);
3964 let end = range.end.to_offset(self);
3965
3966 let mut cursor = self.cursor::<MultiBufferOffset, BufferOffset>();
3967 cursor.seek(&start);
3968
3969 let mut result: Vec<(&BufferSnapshot, Range<BufferOffset>, ExcerptId)> = Vec::new();
3970 while let Some(region) = cursor.region() {
3971 if region.range.start > end {
3972 break;
3973 }
3974 if region.is_main_buffer {
3975 let start_overshoot = start.saturating_sub(region.range.start);
3976 let end_overshoot = end.saturating_sub(region.range.start);
3977 let start = region
3978 .buffer_range
3979 .end
3980 .min(region.buffer_range.start + start_overshoot);
3981 let end = region
3982 .buffer_range
3983 .end
3984 .min(region.buffer_range.start + end_overshoot);
3985 if let Some(prev) = result.last_mut().filter(|(_, prev_range, excerpt_id)| {
3986 *excerpt_id == region.excerpt.id && prev_range.end == start
3987 }) {
3988 prev.1.end = end;
3989 } else {
3990 result.push((region.buffer, start..end, region.excerpt.id));
3991 }
3992 }
3993 cursor.next();
3994 }
3995 result
3996 }
3997
3998 pub fn range_to_buffer_ranges_with_deleted_hunks<T: ToOffset>(
3999 &self,
4000 range: Range<T>,
4001 ) -> impl Iterator<
4002 Item = (
4003 &BufferSnapshot,
4004 Range<BufferOffset>,
4005 ExcerptId,
4006 Option<Anchor>,
4007 ),
4008 > + '_ {
4009 let start = range.start.to_offset(self);
4010 let end = range.end.to_offset(self);
4011
4012 let mut cursor = self.cursor::<MultiBufferOffset, BufferOffset>();
4013 cursor.seek(&start);
4014
4015 std::iter::from_fn(move || {
4016 let region = cursor.region()?;
4017 if region.range.start > end {
4018 return None;
4019 }
4020 let start_overshoot = start.saturating_sub(region.range.start);
4021 let end_overshoot = end.saturating_sub(region.range.start);
4022 let start = region
4023 .buffer_range
4024 .end
4025 .min(region.buffer_range.start + start_overshoot);
4026 let end = region
4027 .buffer_range
4028 .end
4029 .min(region.buffer_range.start + end_overshoot);
4030
4031 let region_excerpt_id = region.excerpt.id;
4032 let deleted_hunk_anchor = if region.is_main_buffer {
4033 None
4034 } else {
4035 Some(self.anchor_before(region.range.start))
4036 };
4037 let result = (
4038 region.buffer,
4039 start..end,
4040 region_excerpt_id,
4041 deleted_hunk_anchor,
4042 );
4043 cursor.next();
4044 Some(result)
4045 })
4046 }
4047
4048 /// Retrieves buffer metadata for the given range, and converts it into multi-buffer
4049 /// coordinates.
4050 ///
4051 /// The given callback will be called for every excerpt intersecting the given range. It will
4052 /// be passed the excerpt's buffer and the buffer range that the input range intersects.
4053 /// The callback should return an iterator of metadata items from that buffer, each paired
4054 /// with a buffer range.
4055 ///
4056 /// The returned iterator yields each of these metadata items, paired with its range in
4057 /// multi-buffer coordinates.
4058 fn lift_buffer_metadata<'a, MBD, M, I>(
4059 &'a self,
4060 query_range: Range<MBD>,
4061 get_buffer_metadata: impl 'a + Fn(&'a BufferSnapshot, Range<MBD::TextDimension>) -> Option<I>,
4062 ) -> impl Iterator<Item = (Range<MBD>, M, &'a Excerpt)> + 'a
4063 where
4064 I: Iterator<Item = (Range<MBD::TextDimension>, M)> + 'a,
4065 MBD: MultiBufferDimension
4066 + Ord
4067 + Sub<Output = MBD::TextDimension>
4068 + ops::Add<MBD::TextDimension, Output = MBD>
4069 + ops::AddAssign<MBD::TextDimension>,
4070 MBD::TextDimension: Sub<Output = MBD::TextDimension>
4071 + ops::Add<Output = MBD::TextDimension>
4072 + AddAssign<MBD::TextDimension>
4073 + Ord,
4074 {
4075 let mut current_excerpt_metadata: Option<(ExcerptId, I)> = None;
4076 let mut cursor = self.cursor::<MBD, MBD::TextDimension>();
4077
4078 // Find the excerpt and buffer offset where the given range ends.
4079 cursor.seek(&query_range.end);
4080 let mut range_end = None;
4081 while let Some(region) = cursor.region() {
4082 if region.is_main_buffer {
4083 let mut buffer_end = region.buffer_range.start;
4084 let overshoot = if query_range.end > region.range.start {
4085 query_range.end - region.range.start
4086 } else {
4087 <MBD::TextDimension>::default()
4088 };
4089 buffer_end = buffer_end + overshoot;
4090 range_end = Some((region.excerpt.id, buffer_end));
4091 break;
4092 }
4093 cursor.next();
4094 }
4095
4096 cursor.seek(&query_range.start);
4097
4098 if let Some(region) = cursor.region().filter(|region| !region.is_main_buffer)
4099 && region.range.start > MBD::default()
4100 {
4101 cursor.prev()
4102 }
4103
4104 iter::from_fn(move || {
4105 loop {
4106 let excerpt = cursor.excerpt()?;
4107
4108 // If we have already retrieved metadata for this excerpt, continue to use it.
4109 let metadata_iter = if let Some((_, metadata)) = current_excerpt_metadata
4110 .as_mut()
4111 .filter(|(excerpt_id, _)| *excerpt_id == excerpt.id)
4112 {
4113 Some(metadata)
4114 }
4115 // Otherwise, compute the intersection of the input range with the excerpt's range,
4116 // and retrieve the metadata for the resulting range.
4117 else {
4118 let region = cursor.region()?;
4119 let mut buffer_start;
4120 if region.is_main_buffer {
4121 buffer_start = region.buffer_range.start;
4122 if query_range.start > region.range.start {
4123 let overshoot = query_range.start - region.range.start;
4124 buffer_start = buffer_start + overshoot;
4125 }
4126 buffer_start = buffer_start.min(region.buffer_range.end);
4127 } else {
4128 buffer_start = cursor.main_buffer_position()?;
4129 };
4130 let mut buffer_end = excerpt
4131 .range
4132 .context
4133 .end
4134 .summary::<MBD::TextDimension>(&excerpt.buffer);
4135 if let Some((end_excerpt_id, end_buffer_offset)) = range_end
4136 && excerpt.id == end_excerpt_id
4137 {
4138 buffer_end = buffer_end.min(end_buffer_offset);
4139 }
4140
4141 get_buffer_metadata(&excerpt.buffer, buffer_start..buffer_end).map(|iterator| {
4142 &mut current_excerpt_metadata.insert((excerpt.id, iterator)).1
4143 })
4144 };
4145
4146 // Visit each metadata item.
4147 if let Some((metadata_buffer_range, metadata)) =
4148 metadata_iter.and_then(Iterator::next)
4149 {
4150 // Find the multibuffer regions that contain the start and end of
4151 // the metadata item's range.
4152 if metadata_buffer_range.start > <MBD::TextDimension>::default() {
4153 while let Some(region) = cursor.region() {
4154 if region.is_main_buffer
4155 && (region.buffer_range.end >= metadata_buffer_range.start
4156 || cursor.is_at_end_of_excerpt())
4157 {
4158 break;
4159 }
4160 cursor.next();
4161 }
4162 }
4163 let start_region = cursor.region()?;
4164 while let Some(region) = cursor.region() {
4165 if region.is_main_buffer
4166 && (region.buffer_range.end > metadata_buffer_range.end
4167 || cursor.is_at_end_of_excerpt())
4168 {
4169 break;
4170 }
4171 cursor.next();
4172 }
4173 let end_region = cursor.region();
4174
4175 // Convert the metadata item's range into multibuffer coordinates.
4176 let mut start_position = start_region.range.start;
4177 let region_buffer_start = start_region.buffer_range.start;
4178 if start_region.is_main_buffer
4179 && metadata_buffer_range.start > region_buffer_start
4180 {
4181 start_position =
4182 start_position + (metadata_buffer_range.start - region_buffer_start);
4183 start_position = start_position.min(start_region.range.end);
4184 }
4185
4186 let mut end_position = self.max_position();
4187 if let Some(end_region) = &end_region {
4188 end_position = end_region.range.start;
4189 debug_assert!(end_region.is_main_buffer);
4190 let region_buffer_start = end_region.buffer_range.start;
4191 if metadata_buffer_range.end > region_buffer_start {
4192 end_position =
4193 end_position + (metadata_buffer_range.end - region_buffer_start);
4194 }
4195 end_position = end_position.min(end_region.range.end);
4196 }
4197
4198 if start_position <= query_range.end && end_position >= query_range.start {
4199 return Some((start_position..end_position, metadata, excerpt));
4200 }
4201 }
4202 // When there are no more metadata items for this excerpt, move to the next excerpt.
4203 else {
4204 current_excerpt_metadata.take();
4205 if let Some((end_excerpt_id, _)) = range_end
4206 && excerpt.id == end_excerpt_id
4207 {
4208 return None;
4209 }
4210 cursor.next_excerpt();
4211 }
4212 }
4213 })
4214 }
4215
4216 pub fn diff_hunk_before<T: ToOffset>(&self, position: T) -> Option<MultiBufferRow> {
4217 let offset = position.to_offset(self);
4218
4219 let mut cursor = self
4220 .cursor::<DimensionPair<MultiBufferOffset, Point>, DimensionPair<BufferOffset, Point>>(
4221 );
4222 cursor.seek(&DimensionPair {
4223 key: offset,
4224 value: None,
4225 });
4226 cursor.seek_to_start_of_current_excerpt();
4227 let excerpt = cursor.excerpt()?;
4228
4229 let excerpt_end = excerpt.range.context.end.to_offset(&excerpt.buffer);
4230 let current_position = self
4231 .anchor_before(offset)
4232 .text_anchor
4233 .to_offset(&excerpt.buffer);
4234 let excerpt_end = excerpt
4235 .buffer
4236 .anchor_before(excerpt_end.min(current_position));
4237
4238 if let Some(diff) = self.diffs.get(&excerpt.buffer_id) {
4239 for hunk in diff.hunks_intersecting_range_rev(
4240 excerpt.range.context.start..excerpt_end,
4241 &excerpt.buffer,
4242 ) {
4243 let hunk_end = hunk.buffer_range.end.to_offset(&excerpt.buffer);
4244 if hunk_end >= current_position {
4245 continue;
4246 }
4247 let start = Anchor::in_buffer(excerpt.id, hunk.buffer_range.start).to_point(self);
4248 return Some(MultiBufferRow(start.row));
4249 }
4250 }
4251
4252 loop {
4253 cursor.prev_excerpt();
4254 let excerpt = cursor.excerpt()?;
4255
4256 let Some(diff) = self.diffs.get(&excerpt.buffer_id) else {
4257 continue;
4258 };
4259 let mut hunks =
4260 diff.hunks_intersecting_range_rev(excerpt.range.context.clone(), &excerpt.buffer);
4261 let Some(hunk) = hunks.next() else {
4262 continue;
4263 };
4264 let start = Anchor::in_buffer(excerpt.id, hunk.buffer_range.start).to_point(self);
4265 return Some(MultiBufferRow(start.row));
4266 }
4267 }
4268
4269 pub fn has_diff_hunks(&self) -> bool {
4270 self.diffs.values().any(|diff| !diff.is_empty())
4271 }
4272
4273 pub fn is_inside_word<T: ToOffset>(
4274 &self,
4275 position: T,
4276 scope_context: Option<CharScopeContext>,
4277 ) -> bool {
4278 let position = position.to_offset(self);
4279 let classifier = self
4280 .char_classifier_at(position)
4281 .scope_context(scope_context);
4282 let next_char_kind = self.chars_at(position).next().map(|c| classifier.kind(c));
4283 let prev_char_kind = self
4284 .reversed_chars_at(position)
4285 .next()
4286 .map(|c| classifier.kind(c));
4287 prev_char_kind.zip(next_char_kind) == Some((CharKind::Word, CharKind::Word))
4288 }
4289
4290 pub fn surrounding_word<T: ToOffset>(
4291 &self,
4292 start: T,
4293 scope_context: Option<CharScopeContext>,
4294 ) -> (Range<MultiBufferOffset>, Option<CharKind>) {
4295 let mut start = start.to_offset(self);
4296 let mut end = start;
4297 let mut next_chars = self.chars_at(start).peekable();
4298 let mut prev_chars = self.reversed_chars_at(start).peekable();
4299
4300 let classifier = self.char_classifier_at(start).scope_context(scope_context);
4301
4302 let word_kind = cmp::max(
4303 prev_chars.peek().copied().map(|c| classifier.kind(c)),
4304 next_chars.peek().copied().map(|c| classifier.kind(c)),
4305 );
4306
4307 for ch in prev_chars {
4308 if Some(classifier.kind(ch)) == word_kind && ch != '\n' {
4309 start -= ch.len_utf8();
4310 } else {
4311 break;
4312 }
4313 }
4314
4315 for ch in next_chars {
4316 if Some(classifier.kind(ch)) == word_kind && ch != '\n' {
4317 end += ch.len_utf8();
4318 } else {
4319 break;
4320 }
4321 }
4322
4323 (start..end, word_kind)
4324 }
4325
4326 pub fn char_kind_before<T: ToOffset>(
4327 &self,
4328 start: T,
4329 scope_context: Option<CharScopeContext>,
4330 ) -> Option<CharKind> {
4331 let start = start.to_offset(self);
4332 let classifier = self.char_classifier_at(start).scope_context(scope_context);
4333 self.reversed_chars_at(start)
4334 .next()
4335 .map(|ch| classifier.kind(ch))
4336 }
4337
4338 pub fn is_singleton(&self) -> bool {
4339 self.singleton
4340 }
4341
4342 pub fn as_singleton(&self) -> Option<(&ExcerptId, BufferId, &BufferSnapshot)> {
4343 if self.singleton {
4344 self.excerpts
4345 .iter()
4346 .next()
4347 .map(|e| (&e.id, e.buffer_id, &e.buffer))
4348 } else {
4349 None
4350 }
4351 }
4352
4353 pub fn len(&self) -> MultiBufferOffset {
4354 self.diff_transforms.summary().output.len
4355 }
4356
4357 pub fn max_position<MBD: MultiBufferDimension>(&self) -> MBD {
4358 MBD::from_summary(&self.text_summary())
4359 }
4360
4361 pub fn is_empty(&self) -> bool {
4362 self.diff_transforms.summary().output.len == MultiBufferOffset(0)
4363 }
4364
4365 pub fn widest_line_number(&self) -> u32 {
4366 // widest_line_number is 0-based, so 1 is added to get the displayed line number.
4367 self.excerpts.summary().widest_line_number + 1
4368 }
4369
4370 pub fn bytes_in_range<T: ToOffset>(&self, range: Range<T>) -> MultiBufferBytes<'_> {
4371 let range = range.start.to_offset(self)..range.end.to_offset(self);
4372 let mut excerpts = self.cursor::<MultiBufferOffset, BufferOffset>();
4373 excerpts.seek(&range.start);
4374
4375 let mut chunk;
4376 let mut has_trailing_newline;
4377 let excerpt_bytes;
4378 if let Some(region) = excerpts.region() {
4379 let mut bytes = region.buffer.bytes_in_range(
4380 region.buffer_range.start + (range.start - region.range.start)
4381 ..(region.buffer_range.start + (range.end - region.range.start))
4382 .min(region.buffer_range.end),
4383 );
4384 chunk = bytes.next().unwrap_or(&[][..]);
4385 excerpt_bytes = Some(bytes);
4386 has_trailing_newline = region.has_trailing_newline && range.end >= region.range.end;
4387 if chunk.is_empty() && has_trailing_newline {
4388 chunk = b"\n";
4389 has_trailing_newline = false;
4390 }
4391 } else {
4392 chunk = &[][..];
4393 excerpt_bytes = None;
4394 has_trailing_newline = false;
4395 };
4396
4397 MultiBufferBytes {
4398 range,
4399 cursor: excerpts,
4400 excerpt_bytes,
4401 has_trailing_newline,
4402 chunk,
4403 }
4404 }
4405
4406 pub fn reversed_bytes_in_range<T: ToOffset>(
4407 &self,
4408 range: Range<T>,
4409 ) -> ReversedMultiBufferBytes<'_> {
4410 let range = range.start.to_offset(self)..range.end.to_offset(self);
4411 let mut chunks = self.reversed_chunks_in_range(range.clone());
4412 let chunk = chunks.next().map_or(&[][..], |c| c.as_bytes());
4413 ReversedMultiBufferBytes {
4414 range,
4415 chunks,
4416 chunk,
4417 }
4418 }
4419
4420 pub fn row_infos(&self, start_row: MultiBufferRow) -> MultiBufferRows<'_> {
4421 let mut cursor = self.cursor::<Point, Point>();
4422 cursor.seek(&Point::new(start_row.0, 0));
4423 let mut result = MultiBufferRows {
4424 point: Point::new(0, 0),
4425 is_empty: self.excerpts.is_empty(),
4426 is_singleton: self.is_singleton(),
4427 cursor,
4428 };
4429 result.seek(start_row);
4430 result
4431 }
4432
4433 pub fn chunks<T: ToOffset>(
4434 &self,
4435 range: Range<T>,
4436 language_aware: bool,
4437 ) -> MultiBufferChunks<'_> {
4438 let mut chunks = MultiBufferChunks {
4439 excerpt_offset_range: ExcerptDimension(MultiBufferOffset::ZERO)
4440 ..ExcerptDimension(MultiBufferOffset::ZERO),
4441 range: MultiBufferOffset::ZERO..MultiBufferOffset::ZERO,
4442 excerpts: self.excerpts.cursor(()),
4443 diff_transforms: self.diff_transforms.cursor(()),
4444 diffs: &self.diffs,
4445 diff_base_chunks: None,
4446 excerpt_chunks: None,
4447 buffer_chunk: None,
4448 language_aware,
4449 };
4450 let range = range.start.to_offset(self)..range.end.to_offset(self);
4451 chunks.seek(range);
4452 chunks
4453 }
4454
4455 pub fn clip_offset(&self, offset: MultiBufferOffset, bias: Bias) -> MultiBufferOffset {
4456 self.clip_dimension(offset, bias, text::BufferSnapshot::clip_offset)
4457 }
4458
4459 pub fn clip_point(&self, point: Point, bias: Bias) -> Point {
4460 self.clip_dimension(point, bias, text::BufferSnapshot::clip_point)
4461 }
4462
4463 pub fn clip_offset_utf16(
4464 &self,
4465 offset: MultiBufferOffsetUtf16,
4466 bias: Bias,
4467 ) -> MultiBufferOffsetUtf16 {
4468 self.clip_dimension(offset, bias, text::BufferSnapshot::clip_offset_utf16)
4469 }
4470
4471 pub fn clip_point_utf16(&self, point: Unclipped<PointUtf16>, bias: Bias) -> PointUtf16 {
4472 self.clip_dimension(point.0, bias, |buffer, point, bias| {
4473 buffer.clip_point_utf16(Unclipped(point), bias)
4474 })
4475 }
4476
4477 pub fn offset_to_point(&self, offset: MultiBufferOffset) -> Point {
4478 self.convert_dimension(offset, text::BufferSnapshot::offset_to_point)
4479 }
4480
4481 pub fn offset_to_point_utf16(&self, offset: MultiBufferOffset) -> PointUtf16 {
4482 self.convert_dimension(offset, text::BufferSnapshot::offset_to_point_utf16)
4483 }
4484
4485 pub fn point_to_point_utf16(&self, point: Point) -> PointUtf16 {
4486 self.convert_dimension(point, text::BufferSnapshot::point_to_point_utf16)
4487 }
4488
4489 pub fn point_utf16_to_point(&self, point: PointUtf16) -> Point {
4490 self.convert_dimension(point, text::BufferSnapshot::point_utf16_to_point)
4491 }
4492
4493 #[instrument(skip_all)]
4494 pub fn point_to_offset(&self, point: Point) -> MultiBufferOffset {
4495 self.convert_dimension(point, text::BufferSnapshot::point_to_offset)
4496 }
4497
4498 pub fn point_to_offset_utf16(&self, point: Point) -> MultiBufferOffsetUtf16 {
4499 self.convert_dimension(point, text::BufferSnapshot::point_to_offset_utf16)
4500 }
4501
4502 pub fn offset_utf16_to_offset(&self, offset: MultiBufferOffsetUtf16) -> MultiBufferOffset {
4503 self.convert_dimension(offset, text::BufferSnapshot::offset_utf16_to_offset)
4504 }
4505
4506 pub fn offset_to_offset_utf16(&self, offset: MultiBufferOffset) -> MultiBufferOffsetUtf16 {
4507 self.convert_dimension(offset, text::BufferSnapshot::offset_to_offset_utf16)
4508 }
4509
4510 pub fn point_utf16_to_offset(&self, point: PointUtf16) -> MultiBufferOffset {
4511 self.convert_dimension(point, text::BufferSnapshot::point_utf16_to_offset)
4512 }
4513
4514 pub fn point_utf16_to_offset_utf16(&self, point: PointUtf16) -> MultiBufferOffsetUtf16 {
4515 self.convert_dimension(point, text::BufferSnapshot::point_utf16_to_offset_utf16)
4516 }
4517
4518 fn clip_dimension<MBD, BD>(
4519 &self,
4520 position: MBD,
4521 bias: Bias,
4522 clip_buffer_position: fn(&text::BufferSnapshot, BD, Bias) -> BD,
4523 ) -> MBD
4524 where
4525 MBD: MultiBufferDimension + Ord + Sub + ops::AddAssign<<MBD as Sub>::Output>,
4526 BD: TextDimension + Sub<Output = <MBD as Sub>::Output> + AddAssign<<MBD as Sub>::Output>,
4527 {
4528 let mut cursor = self.cursor::<MBD, BD>();
4529 cursor.seek(&position);
4530 if let Some(region) = cursor.region() {
4531 if position >= region.range.end {
4532 return region.range.end;
4533 }
4534 let overshoot = position - region.range.start;
4535 let mut buffer_position = region.buffer_range.start;
4536 buffer_position += overshoot;
4537 let clipped_buffer_position =
4538 clip_buffer_position(region.buffer, buffer_position, bias);
4539 let mut position = region.range.start;
4540 position += clipped_buffer_position - region.buffer_range.start;
4541 position
4542 } else {
4543 self.max_position()
4544 }
4545 }
4546
4547 #[instrument(skip_all)]
4548 fn convert_dimension<MBR1, MBR2, BR1, BR2>(
4549 &self,
4550 key: MBR1,
4551 convert_buffer_dimension: fn(&text::BufferSnapshot, BR1) -> BR2,
4552 ) -> MBR2
4553 where
4554 MBR1: MultiBufferDimension + Ord + Sub + ops::AddAssign<<MBR1 as Sub>::Output>,
4555 BR1: TextDimension + Sub<Output = <MBR1 as Sub>::Output> + AddAssign<<MBR1 as Sub>::Output>,
4556 MBR2: MultiBufferDimension + Ord + Sub + ops::AddAssign<<MBR2 as Sub>::Output>,
4557 BR2: TextDimension + Sub<Output = <MBR2 as Sub>::Output> + AddAssign<<MBR2 as Sub>::Output>,
4558 {
4559 let mut cursor = self.cursor::<DimensionPair<MBR1, MBR2>, DimensionPair<BR1, BR2>>();
4560 cursor.seek(&DimensionPair { key, value: None });
4561 if let Some(region) = cursor.region() {
4562 if key >= region.range.end.key {
4563 return region.range.end.value.unwrap();
4564 }
4565 let start_key = region.range.start.key;
4566 let start_value = region.range.start.value.unwrap();
4567 let buffer_start_key = region.buffer_range.start.key;
4568 let buffer_start_value = region.buffer_range.start.value.unwrap();
4569 let mut buffer_key = buffer_start_key;
4570 buffer_key += key - start_key;
4571 let buffer_value = convert_buffer_dimension(region.buffer, buffer_key);
4572 let mut result = start_value;
4573 result += buffer_value - buffer_start_value;
4574 result
4575 } else {
4576 self.max_position()
4577 }
4578 }
4579
4580 pub fn point_to_buffer_offset<T: ToOffset>(
4581 &self,
4582 point: T,
4583 ) -> Option<(&BufferSnapshot, BufferOffset)> {
4584 let offset = point.to_offset(self);
4585 let mut cursor = self.cursor::<MultiBufferOffset, BufferOffset>();
4586 cursor.seek(&offset);
4587 let region = cursor.region()?;
4588 let overshoot = offset - region.range.start;
4589 let buffer_offset = region.buffer_range.start + overshoot;
4590 if buffer_offset == BufferOffset(region.buffer.len() + 1)
4591 && region.has_trailing_newline
4592 && !region.is_main_buffer
4593 {
4594 let main_buffer_position = cursor.main_buffer_position()?;
4595 let buffer_snapshot = &cursor.excerpt()?.buffer;
4596 return Some((buffer_snapshot, main_buffer_position));
4597 } else if buffer_offset > BufferOffset(region.buffer.len()) {
4598 return None;
4599 }
4600 Some((region.buffer, buffer_offset))
4601 }
4602
4603 pub fn point_to_buffer_point(
4604 &self,
4605 point: Point,
4606 ) -> Option<(&BufferSnapshot, Point, ExcerptId)> {
4607 let mut cursor = self.cursor::<Point, Point>();
4608 cursor.seek(&point);
4609 let region = cursor.region()?;
4610 let overshoot = point - region.range.start;
4611 let buffer_point = region.buffer_range.start + overshoot;
4612 let excerpt = cursor.excerpt()?;
4613 if buffer_point == region.buffer.max_point() + Point::new(1, 0)
4614 && region.has_trailing_newline
4615 && !region.is_main_buffer
4616 {
4617 return Some((&excerpt.buffer, cursor.main_buffer_position()?, excerpt.id));
4618 } else if buffer_point > region.buffer.max_point() {
4619 return None;
4620 }
4621 Some((region.buffer, buffer_point, excerpt.id))
4622 }
4623
4624 pub fn suggested_indents(
4625 &self,
4626 rows: impl IntoIterator<Item = u32>,
4627 cx: &App,
4628 ) -> BTreeMap<MultiBufferRow, IndentSize> {
4629 let mut result = BTreeMap::new();
4630 self.suggested_indents_callback(
4631 rows,
4632 |row, indent| {
4633 result.insert(row, indent);
4634 ControlFlow::Continue(())
4635 },
4636 cx,
4637 );
4638 result
4639 }
4640
4641 // move this to be a generator once those are a thing
4642 pub fn suggested_indents_callback(
4643 &self,
4644 rows: impl IntoIterator<Item = u32>,
4645 mut cb: impl FnMut(MultiBufferRow, IndentSize) -> ControlFlow<()>,
4646 cx: &App,
4647 ) {
4648 let mut rows_for_excerpt = Vec::new();
4649 let mut cursor = self.cursor::<Point, Point>();
4650 let mut rows = rows.into_iter().peekable();
4651 let mut prev_row = u32::MAX;
4652 let mut prev_language_indent_size = IndentSize::default();
4653
4654 while let Some(row) = rows.next() {
4655 cursor.seek(&Point::new(row, 0));
4656 let Some(region) = cursor.region() else {
4657 continue;
4658 };
4659
4660 // Retrieve the language and indent size once for each disjoint region being indented.
4661 let single_indent_size = if row.saturating_sub(1) == prev_row {
4662 prev_language_indent_size
4663 } else {
4664 region
4665 .buffer
4666 .language_indent_size_at(Point::new(row, 0), cx)
4667 };
4668 prev_language_indent_size = single_indent_size;
4669 prev_row = row;
4670
4671 let start_buffer_row = region.buffer_range.start.row;
4672 let start_multibuffer_row = region.range.start.row;
4673 let end_multibuffer_row = region.range.end.row;
4674
4675 rows_for_excerpt.push(row);
4676 while let Some(next_row) = rows.peek().copied() {
4677 if end_multibuffer_row > next_row {
4678 rows_for_excerpt.push(next_row);
4679 rows.next();
4680 } else {
4681 break;
4682 }
4683 }
4684
4685 let buffer_rows = rows_for_excerpt
4686 .drain(..)
4687 .map(|row| start_buffer_row + row - start_multibuffer_row);
4688 let buffer_indents = region
4689 .buffer
4690 .suggested_indents(buffer_rows, single_indent_size);
4691 for (row, indent) in buffer_indents {
4692 if cb(
4693 MultiBufferRow(start_multibuffer_row + row - start_buffer_row),
4694 indent,
4695 )
4696 .is_break()
4697 {
4698 return;
4699 }
4700 }
4701 }
4702 }
4703
4704 pub fn indent_size_for_line(&self, row: MultiBufferRow) -> IndentSize {
4705 if let Some((buffer, range)) = self.buffer_line_for_row(row) {
4706 let mut size = buffer.indent_size_for_line(range.start.row);
4707 size.len = size
4708 .len
4709 .min(range.end.column)
4710 .saturating_sub(range.start.column);
4711 size
4712 } else {
4713 IndentSize::spaces(0)
4714 }
4715 }
4716
4717 pub fn line_indent_for_row(&self, row: MultiBufferRow) -> LineIndent {
4718 if let Some((buffer, range)) = self.buffer_line_for_row(row) {
4719 LineIndent::from_iter(buffer.text_for_range(range).flat_map(|s| s.chars()))
4720 } else {
4721 LineIndent::spaces(0)
4722 }
4723 }
4724
4725 pub fn indent_and_comment_for_line(&self, row: MultiBufferRow, cx: &App) -> String {
4726 let mut indent = self.indent_size_for_line(row).chars().collect::<String>();
4727
4728 if self.language_settings(cx).extend_comment_on_newline
4729 && let Some(language_scope) = self.language_scope_at(Point::new(row.0, 0))
4730 {
4731 let delimiters = language_scope.line_comment_prefixes();
4732 for delimiter in delimiters {
4733 if *self
4734 .chars_at(Point::new(row.0, indent.len() as u32))
4735 .take(delimiter.chars().count())
4736 .collect::<String>()
4737 .as_str()
4738 == **delimiter
4739 {
4740 indent.push_str(delimiter);
4741 break;
4742 }
4743 }
4744 }
4745
4746 indent
4747 }
4748
4749 pub fn is_line_whitespace_upto<T>(&self, position: T) -> bool
4750 where
4751 T: ToOffset,
4752 {
4753 for char in self.reversed_chars_at(position) {
4754 if !char.is_whitespace() {
4755 return false;
4756 }
4757 if char == '\n' {
4758 return true;
4759 }
4760 }
4761 true
4762 }
4763
4764 pub fn prev_non_blank_row(&self, mut row: MultiBufferRow) -> Option<MultiBufferRow> {
4765 while row.0 > 0 {
4766 row.0 -= 1;
4767 if !self.is_line_blank(row) {
4768 return Some(row);
4769 }
4770 }
4771 None
4772 }
4773
4774 pub fn line_len(&self, row: MultiBufferRow) -> u32 {
4775 if let Some((_, range)) = self.buffer_line_for_row(row) {
4776 range.end.column - range.start.column
4777 } else {
4778 0
4779 }
4780 }
4781
4782 pub fn buffer_line_for_row(
4783 &self,
4784 row: MultiBufferRow,
4785 ) -> Option<(&BufferSnapshot, Range<Point>)> {
4786 let mut cursor = self.cursor::<Point, Point>();
4787 let point = Point::new(row.0, 0);
4788 cursor.seek(&point);
4789 let region = cursor.region()?;
4790 let overshoot = point.min(region.range.end) - region.range.start;
4791 let buffer_point = region.buffer_range.start + overshoot;
4792 if buffer_point.row > region.buffer_range.end.row {
4793 return None;
4794 }
4795 let line_start = Point::new(buffer_point.row, 0).max(region.buffer_range.start);
4796 let line_end = Point::new(buffer_point.row, region.buffer.line_len(buffer_point.row))
4797 .min(region.buffer_range.end);
4798 Some((region.buffer, line_start..line_end))
4799 }
4800
4801 pub fn max_point(&self) -> Point {
4802 self.text_summary().lines
4803 }
4804
4805 pub fn max_row(&self) -> MultiBufferRow {
4806 MultiBufferRow(self.text_summary().lines.row)
4807 }
4808
4809 pub fn text_summary(&self) -> MBTextSummary {
4810 self.diff_transforms.summary().output
4811 }
4812
4813 pub fn text_summary_for_range<MBD, O>(&self, range: Range<O>) -> MBD
4814 where
4815 MBD: MultiBufferDimension + AddAssign,
4816 O: ToOffset,
4817 {
4818 let range = range.start.to_offset(self)..range.end.to_offset(self);
4819 let mut cursor = self
4820 .diff_transforms
4821 .cursor::<Dimensions<MultiBufferOffset, ExcerptOffset>>(());
4822 cursor.seek(&range.start, Bias::Right);
4823
4824 let Some(first_transform) = cursor.item() else {
4825 return MBD::from_summary(&MBTextSummary::default());
4826 };
4827
4828 let diff_transform_start = cursor.start().0;
4829 let diff_transform_end = cursor.end().0;
4830 let diff_start = range.start;
4831 let start_overshoot = diff_start - diff_transform_start;
4832 let end_overshoot = std::cmp::min(range.end, diff_transform_end) - diff_transform_start;
4833
4834 let mut result = match first_transform {
4835 DiffTransform::Unmodified { .. } | DiffTransform::InsertedHunk { .. } => {
4836 let excerpt_start = cursor.start().1 + start_overshoot;
4837 let excerpt_end = cursor.start().1 + end_overshoot;
4838 self.text_summary_for_excerpt_offset_range(excerpt_start..excerpt_end)
4839 }
4840 DiffTransform::FilteredInsertedHunk { .. } => MBD::default(),
4841 DiffTransform::DeletedHunk {
4842 buffer_id,
4843 has_trailing_newline,
4844 hunk_info,
4845 ..
4846 } => {
4847 let buffer_start = hunk_info.base_text_byte_range.start + start_overshoot;
4848 let mut buffer_end = hunk_info.base_text_byte_range.start + end_overshoot;
4849 let Some(base_text) = self.diffs.get(buffer_id).map(|diff| diff.base_text()) else {
4850 panic!("{:?} is in non-existent deleted hunk", range.start)
4851 };
4852
4853 let include_trailing_newline =
4854 *has_trailing_newline && range.end >= diff_transform_end;
4855 if include_trailing_newline {
4856 buffer_end -= 1;
4857 }
4858
4859 let mut summary = base_text
4860 .text_summary_for_range::<MBD::TextDimension, _>(buffer_start..buffer_end);
4861
4862 if include_trailing_newline {
4863 summary.add_assign(&<MBD::TextDimension>::from_text_summary(
4864 &TextSummary::newline(),
4865 ))
4866 }
4867
4868 let mut result = MBD::default();
4869 result.add_text_dim(&summary);
4870 result
4871 }
4872 };
4873 if range.end < diff_transform_end {
4874 return result;
4875 }
4876
4877 cursor.next();
4878 result.add_mb_text_summary(
4879 &cursor
4880 .summary::<_, OutputDimension<_>>(&range.end, Bias::Right)
4881 .0,
4882 );
4883
4884 let Some(last_transform) = cursor.item() else {
4885 return result;
4886 };
4887
4888 let overshoot = range.end - cursor.start().0;
4889 let suffix = match last_transform {
4890 DiffTransform::Unmodified { .. } | DiffTransform::InsertedHunk { .. } => {
4891 let end = cursor.start().1 + overshoot;
4892 self.text_summary_for_excerpt_offset_range::<MBD>(cursor.start().1..end)
4893 }
4894 DiffTransform::FilteredInsertedHunk { .. } => MBD::default(),
4895 DiffTransform::DeletedHunk {
4896 buffer_id,
4897 has_trailing_newline,
4898 hunk_info,
4899 ..
4900 } => {
4901 let buffer_end = hunk_info.base_text_byte_range.start + overshoot;
4902 let Some(base_text) = self.diffs.get(buffer_id).map(|diff| diff.base_text()) else {
4903 panic!("{:?} is in non-existent deleted hunk", range.end)
4904 };
4905
4906 let mut suffix = base_text.text_summary_for_range::<MBD::TextDimension, _>(
4907 hunk_info.base_text_byte_range.start..buffer_end,
4908 );
4909 if *has_trailing_newline && buffer_end == hunk_info.base_text_byte_range.end + 1 {
4910 suffix.add_assign(&<MBD::TextDimension>::from_text_summary(
4911 &TextSummary::from("\n"),
4912 ))
4913 }
4914
4915 let mut result = MBD::default();
4916 result.add_text_dim(&suffix);
4917 result
4918 }
4919 };
4920
4921 result += suffix;
4922 result
4923 }
4924
4925 fn text_summary_for_excerpt_offset_range<MBD>(&self, mut range: Range<ExcerptOffset>) -> MBD
4926 where
4927 MBD: MultiBufferDimension + AddAssign,
4928 {
4929 let mut summary = MBD::default();
4930 let mut cursor = self.excerpts.cursor::<ExcerptOffset>(());
4931 cursor.seek(&range.start, Bias::Right);
4932 if let Some(excerpt) = cursor.item() {
4933 let mut end_before_newline = cursor.end();
4934 if excerpt.has_trailing_newline {
4935 end_before_newline -= 1;
4936 }
4937
4938 let excerpt_start = excerpt.range.context.start.to_offset(&excerpt.buffer);
4939 let start_in_excerpt = excerpt_start + (range.start - *cursor.start());
4940 let end_in_excerpt =
4941 excerpt_start + (cmp::min(end_before_newline, range.end) - *cursor.start());
4942 summary.add_text_dim(
4943 &excerpt
4944 .buffer
4945 .text_summary_for_range::<MBD::TextDimension, _>(
4946 start_in_excerpt..end_in_excerpt,
4947 ),
4948 );
4949
4950 if range.end > end_before_newline {
4951 summary.add_mb_text_summary(&MBTextSummary::from(TextSummary::newline()));
4952 }
4953
4954 cursor.next();
4955 }
4956
4957 if range.end > *cursor.start() {
4958 summary += cursor
4959 .summary::<_, ExcerptDimension<MBD>>(&range.end, Bias::Right)
4960 .0;
4961 if let Some(excerpt) = cursor.item() {
4962 range.end = cmp::max(*cursor.start(), range.end);
4963
4964 let excerpt_start = excerpt.range.context.start.to_offset(&excerpt.buffer);
4965 let end_in_excerpt = excerpt_start + (range.end - *cursor.start());
4966 summary.add_text_dim(
4967 &excerpt
4968 .buffer
4969 .text_summary_for_range::<MBD::TextDimension, _>(
4970 excerpt_start..end_in_excerpt,
4971 ),
4972 );
4973 }
4974 }
4975
4976 summary
4977 }
4978
4979 pub fn summary_for_anchor<MBD>(&self, anchor: &Anchor) -> MBD
4980 where
4981 MBD: MultiBufferDimension
4982 + Ord
4983 + Sub<Output = MBD::TextDimension>
4984 + AddAssign<MBD::TextDimension>,
4985 MBD::TextDimension: Sub<Output = MBD::TextDimension> + Ord,
4986 {
4987 self.summaries_for_anchors([anchor])[0]
4988 }
4989
4990 fn resolve_summary_for_anchor<MBD>(
4991 &self,
4992 anchor: &Anchor,
4993 excerpt_position: ExcerptDimension<MBD>,
4994 diff_transforms: &mut Cursor<
4995 DiffTransform,
4996 Dimensions<ExcerptDimension<MBD>, OutputDimension<MBD>>,
4997 >,
4998 ) -> MBD
4999 where
5000 MBD: MultiBufferDimension + Ord + Sub + AddAssign<<MBD as Sub>::Output>,
5001 {
5002 loop {
5003 let transform_end_position = diff_transforms.end().0;
5004 let at_transform_end =
5005 transform_end_position == excerpt_position && diff_transforms.item().is_some();
5006 if at_transform_end && anchor.text_anchor.bias == Bias::Right {
5007 diff_transforms.next();
5008 continue;
5009 }
5010
5011 let mut position = diff_transforms.start().1;
5012 match diff_transforms.item() {
5013 Some(DiffTransform::DeletedHunk {
5014 buffer_id,
5015 hunk_info,
5016 ..
5017 }) => {
5018 if let Some(diff_base_anchor) = &anchor.diff_base_anchor
5019 && let Some(base_text) =
5020 self.diffs.get(buffer_id).map(|diff| diff.base_text())
5021 && base_text.can_resolve(diff_base_anchor)
5022 {
5023 let base_text_offset = diff_base_anchor.to_offset(base_text);
5024 if base_text_offset >= hunk_info.base_text_byte_range.start
5025 && base_text_offset <= hunk_info.base_text_byte_range.end
5026 {
5027 let position_in_hunk = base_text
5028 .text_summary_for_range::<MBD::TextDimension, _>(
5029 hunk_info.base_text_byte_range.start..base_text_offset,
5030 );
5031 position.0.add_text_dim(&position_in_hunk);
5032 } else if at_transform_end {
5033 diff_transforms.next();
5034 continue;
5035 }
5036 }
5037 }
5038 _ => {
5039 if at_transform_end && anchor.diff_base_anchor.is_some() {
5040 diff_transforms.next();
5041 continue;
5042 }
5043
5044 if !matches!(
5045 diff_transforms.item(),
5046 Some(DiffTransform::FilteredInsertedHunk { .. })
5047 ) {
5048 let overshoot = excerpt_position - diff_transforms.start().0;
5049 position += overshoot;
5050 }
5051 }
5052 }
5053
5054 return position.0;
5055 }
5056 }
5057
5058 fn excerpt_offset_for_anchor(&self, anchor: &Anchor) -> ExcerptOffset {
5059 let mut cursor = self
5060 .excerpts
5061 .cursor::<Dimensions<Option<&Locator>, ExcerptOffset>>(());
5062 let locator = self.excerpt_locator_for_id(anchor.excerpt_id);
5063
5064 cursor.seek(&Some(locator), Bias::Left);
5065 if cursor.item().is_none() && anchor.excerpt_id == ExcerptId::max() {
5066 cursor.prev();
5067 }
5068
5069 let mut position = cursor.start().1;
5070 if let Some(excerpt) = cursor.item()
5071 && (excerpt.id == anchor.excerpt_id || anchor.excerpt_id == ExcerptId::max())
5072 {
5073 let excerpt_buffer_start = excerpt
5074 .buffer
5075 .offset_for_anchor(&excerpt.range.context.start);
5076 let excerpt_buffer_end = excerpt.buffer.offset_for_anchor(&excerpt.range.context.end);
5077 let buffer_position = cmp::min(
5078 excerpt_buffer_end,
5079 excerpt.buffer.offset_for_anchor(&anchor.text_anchor),
5080 );
5081 if buffer_position > excerpt_buffer_start {
5082 position += buffer_position - excerpt_buffer_start;
5083 }
5084 }
5085 position
5086 }
5087
5088 pub fn latest_excerpt_id(&self, mut excerpt_id: ExcerptId) -> ExcerptId {
5089 while let Some(replacement) = self.replaced_excerpts.get(&excerpt_id) {
5090 excerpt_id = *replacement;
5091 }
5092 excerpt_id
5093 }
5094
5095 pub fn summaries_for_anchors<'a, MBD, I>(&'a self, anchors: I) -> Vec<MBD>
5096 where
5097 MBD: MultiBufferDimension
5098 + Ord
5099 + Sub<Output = MBD::TextDimension>
5100 + AddAssign<MBD::TextDimension>,
5101 MBD::TextDimension: Sub<Output = MBD::TextDimension> + Ord,
5102 I: 'a + IntoIterator<Item = &'a Anchor>,
5103 {
5104 let mut anchors = anchors.into_iter().peekable();
5105 let mut cursor = self.excerpts.cursor::<ExcerptSummary>(());
5106 let mut diff_transforms_cursor = self
5107 .diff_transforms
5108 .cursor::<Dimensions<ExcerptDimension<MBD>, OutputDimension<MBD>>>(());
5109 diff_transforms_cursor.next();
5110
5111 let mut summaries = Vec::new();
5112 while let Some(anchor) = anchors.peek() {
5113 let excerpt_id = self.latest_excerpt_id(anchor.excerpt_id);
5114
5115 let excerpt_anchors = anchors.peeking_take_while(|anchor| {
5116 self.latest_excerpt_id(anchor.excerpt_id) == excerpt_id
5117 });
5118
5119 let locator = self.excerpt_locator_for_id(excerpt_id);
5120 cursor.seek_forward(locator, Bias::Left);
5121 if cursor.item().is_none() && excerpt_id == ExcerptId::max() {
5122 cursor.prev();
5123 }
5124
5125 let excerpt_start_position = ExcerptDimension(MBD::from_summary(&cursor.start().text));
5126 if let Some(excerpt) = cursor.item() {
5127 if excerpt.id != excerpt_id && excerpt_id != ExcerptId::max() {
5128 let position = self.resolve_summary_for_anchor(
5129 &Anchor::min(),
5130 excerpt_start_position,
5131 &mut diff_transforms_cursor,
5132 );
5133 summaries.extend(excerpt_anchors.map(|_| position));
5134 continue;
5135 }
5136 let excerpt_buffer_start = excerpt
5137 .range
5138 .context
5139 .start
5140 .summary::<MBD::TextDimension>(&excerpt.buffer);
5141 let excerpt_buffer_end = excerpt
5142 .range
5143 .context
5144 .end
5145 .summary::<MBD::TextDimension>(&excerpt.buffer);
5146 for (buffer_summary, anchor) in excerpt
5147 .buffer
5148 .summaries_for_anchors_with_payload::<MBD::TextDimension, _, _>(
5149 excerpt_anchors.map(|a| (&a.text_anchor, a)),
5150 )
5151 {
5152 let summary = cmp::min(excerpt_buffer_end, buffer_summary);
5153 let mut position = excerpt_start_position;
5154 if summary > excerpt_buffer_start {
5155 position += summary - excerpt_buffer_start;
5156 }
5157
5158 if diff_transforms_cursor.start().0 < position {
5159 diff_transforms_cursor.seek_forward(&position, Bias::Left);
5160 }
5161
5162 summaries.push(self.resolve_summary_for_anchor(
5163 anchor,
5164 position,
5165 &mut diff_transforms_cursor,
5166 ));
5167 }
5168 } else {
5169 diff_transforms_cursor.seek_forward(&excerpt_start_position, Bias::Left);
5170 let position = self.resolve_summary_for_anchor(
5171 &Anchor::max(),
5172 excerpt_start_position,
5173 &mut diff_transforms_cursor,
5174 );
5175 summaries.extend(excerpt_anchors.map(|_| position));
5176 }
5177 }
5178
5179 summaries
5180 }
5181
5182 pub fn dimensions_from_points<'a, MBD>(
5183 &'a self,
5184 points: impl 'a + IntoIterator<Item = Point>,
5185 ) -> impl 'a + Iterator<Item = MBD>
5186 where
5187 MBD: MultiBufferDimension + Sub + AddAssign<<MBD as Sub>::Output>,
5188 {
5189 let mut cursor = self.cursor::<DimensionPair<Point, MBD>, Point>();
5190 cursor.seek(&DimensionPair {
5191 key: Point::default(),
5192 value: None,
5193 });
5194 let mut points = points.into_iter();
5195 iter::from_fn(move || {
5196 let point = points.next()?;
5197
5198 cursor.seek_forward(&DimensionPair {
5199 key: point,
5200 value: None,
5201 });
5202
5203 if let Some(region) = cursor.region() {
5204 let overshoot = point - region.range.start.key;
5205 let buffer_point = region.buffer_range.start + overshoot;
5206 let mut position = region.range.start.value.unwrap();
5207 position.add_text_dim(
5208 ®ion
5209 .buffer
5210 .text_summary_for_range(region.buffer_range.start..buffer_point),
5211 );
5212 if point == region.range.end.key && region.has_trailing_newline {
5213 position.add_mb_text_summary(&MBTextSummary::from(TextSummary::newline()));
5214 }
5215 Some(position)
5216 } else {
5217 Some(MBD::from_summary(&self.text_summary()))
5218 }
5219 })
5220 }
5221
5222 pub fn refresh_anchors<'a, I>(&'a self, anchors: I) -> Vec<(usize, Anchor, bool)>
5223 where
5224 I: 'a + IntoIterator<Item = &'a Anchor>,
5225 {
5226 let mut anchors = anchors.into_iter().enumerate().peekable();
5227 let mut cursor = self.excerpts.cursor::<Option<&Locator>>(());
5228 cursor.next();
5229
5230 let mut result = Vec::new();
5231
5232 while let Some((_, anchor)) = anchors.peek() {
5233 let old_excerpt_id = anchor.excerpt_id;
5234
5235 // Find the location where this anchor's excerpt should be.
5236 let old_locator = self.excerpt_locator_for_id(old_excerpt_id);
5237 cursor.seek_forward(&Some(old_locator), Bias::Left);
5238
5239 let next_excerpt = cursor.item();
5240 let prev_excerpt = cursor.prev_item();
5241
5242 // Process all of the anchors for this excerpt.
5243 while let Some((anchor_ix, &anchor)) =
5244 anchors.next_if(|(_, anchor)| anchor.excerpt_id == old_excerpt_id)
5245 {
5246 let mut anchor = anchor;
5247
5248 // Leave min and max anchors unchanged if invalid or
5249 // if the old excerpt still exists at this location
5250 let mut kept_position = next_excerpt
5251 .is_some_and(|e| e.id == old_excerpt_id && e.contains(&anchor))
5252 || old_excerpt_id == ExcerptId::max()
5253 || old_excerpt_id == ExcerptId::min();
5254
5255 // If the old excerpt no longer exists at this location, then attempt to
5256 // find an equivalent position for this anchor in an adjacent excerpt.
5257 if !kept_position {
5258 for excerpt in [next_excerpt, prev_excerpt].iter().filter_map(|e| *e) {
5259 if excerpt.contains(&anchor) {
5260 anchor.excerpt_id = excerpt.id;
5261 kept_position = true;
5262 break;
5263 }
5264 }
5265 }
5266
5267 // If there's no adjacent excerpt that contains the anchor's position,
5268 // then report that the anchor has lost its position.
5269 if !kept_position {
5270 anchor = if let Some(excerpt) = next_excerpt {
5271 let mut text_anchor = excerpt
5272 .range
5273 .context
5274 .start
5275 .bias(anchor.text_anchor.bias, &excerpt.buffer);
5276 if text_anchor
5277 .cmp(&excerpt.range.context.end, &excerpt.buffer)
5278 .is_gt()
5279 {
5280 text_anchor = excerpt.range.context.end;
5281 }
5282 Anchor::in_buffer(excerpt.id, text_anchor)
5283 } else if let Some(excerpt) = prev_excerpt {
5284 let mut text_anchor = excerpt
5285 .range
5286 .context
5287 .end
5288 .bias(anchor.text_anchor.bias, &excerpt.buffer);
5289 if text_anchor
5290 .cmp(&excerpt.range.context.start, &excerpt.buffer)
5291 .is_lt()
5292 {
5293 text_anchor = excerpt.range.context.start;
5294 }
5295 Anchor::in_buffer(excerpt.id, text_anchor)
5296 } else if anchor.text_anchor.bias == Bias::Left {
5297 Anchor::min()
5298 } else {
5299 Anchor::max()
5300 };
5301 }
5302
5303 result.push((anchor_ix, anchor, kept_position));
5304 }
5305 }
5306 result.sort_unstable_by(|a, b| a.1.cmp(&b.1, self));
5307 result
5308 }
5309
5310 pub fn anchor_before<T: ToOffset>(&self, position: T) -> Anchor {
5311 self.anchor_at(position, Bias::Left)
5312 }
5313
5314 pub fn anchor_after<T: ToOffset>(&self, position: T) -> Anchor {
5315 self.anchor_at(position, Bias::Right)
5316 }
5317
5318 pub fn anchor_at<T: ToOffset>(&self, position: T, mut bias: Bias) -> Anchor {
5319 let offset = position.to_offset(self);
5320
5321 // Find the given position in the diff transforms. Determine the corresponding
5322 // offset in the excerpts, and whether the position is within a deleted hunk.
5323 let mut diff_transforms = self
5324 .diff_transforms
5325 .cursor::<Dimensions<MultiBufferOffset, ExcerptOffset>>(());
5326 diff_transforms.seek(&offset, Bias::Right);
5327
5328 if offset == diff_transforms.start().0
5329 && bias == Bias::Left
5330 && let Some(prev_item) = diff_transforms.prev_item()
5331 && let DiffTransform::DeletedHunk { .. } = prev_item
5332 {
5333 diff_transforms.prev();
5334 }
5335 let offset_in_transform = offset - diff_transforms.start().0;
5336 let mut excerpt_offset = diff_transforms.start().1;
5337 let mut diff_base_anchor = None;
5338 if let Some(DiffTransform::DeletedHunk {
5339 buffer_id,
5340 has_trailing_newline,
5341 hunk_info,
5342 ..
5343 }) = diff_transforms.item()
5344 {
5345 let base_text_byte_range = &hunk_info.base_text_byte_range;
5346 let diff = self.diffs.get(buffer_id).expect("missing diff");
5347 if offset_in_transform > base_text_byte_range.len() {
5348 debug_assert!(*has_trailing_newline);
5349 bias = Bias::Right;
5350 } else {
5351 diff_base_anchor = Some(
5352 diff.base_text()
5353 .anchor_at(base_text_byte_range.start + offset_in_transform, bias),
5354 );
5355 bias = Bias::Left;
5356 }
5357 } else {
5358 excerpt_offset += MultiBufferOffset(offset_in_transform);
5359 };
5360
5361 let mut excerpts = self
5362 .excerpts
5363 .cursor::<Dimensions<ExcerptOffset, Option<ExcerptId>>>(());
5364 excerpts.seek(&excerpt_offset, Bias::Right);
5365 if excerpts.item().is_none() && excerpt_offset == excerpts.start().0 && bias == Bias::Left {
5366 excerpts.prev();
5367 }
5368 if let Some(excerpt) = excerpts.item() {
5369 let mut overshoot = excerpt_offset.saturating_sub(excerpts.start().0);
5370 if excerpt.has_trailing_newline && excerpt_offset == excerpts.end().0 {
5371 overshoot -= 1;
5372 bias = Bias::Right;
5373 }
5374
5375 let buffer_start = excerpt.range.context.start.to_offset(&excerpt.buffer);
5376 let text_anchor =
5377 excerpt.clip_anchor(excerpt.buffer.anchor_at(buffer_start + overshoot, bias));
5378 let anchor = Anchor::in_buffer(excerpt.id, text_anchor);
5379 match diff_base_anchor {
5380 Some(diff_base_anchor) => anchor.with_diff_base_anchor(diff_base_anchor),
5381 None => anchor,
5382 }
5383 } else if excerpt_offset == ExcerptDimension(MultiBufferOffset::ZERO) && bias == Bias::Left
5384 {
5385 Anchor::min()
5386 } else {
5387 Anchor::max()
5388 }
5389 }
5390
5391 /// Wraps the [`text::Anchor`] in a [`multi_buffer::Anchor`] if this multi-buffer is a singleton.
5392 pub fn as_singleton_anchor(&self, text_anchor: text::Anchor) -> Option<Anchor> {
5393 let (excerpt, buffer, _) = self.as_singleton()?;
5394 if text_anchor.buffer_id.is_none_or(|id| id == buffer) {
5395 Some(Anchor::in_buffer(*excerpt, text_anchor))
5396 } else {
5397 None
5398 }
5399 }
5400
5401 /// Returns an anchor for the given excerpt and text anchor,
5402 /// Returns [`None`] if the excerpt_id is no longer valid or the text anchor range is out of excerpt's bounds.
5403 pub fn anchor_range_in_excerpt(
5404 &self,
5405 excerpt_id: ExcerptId,
5406 text_anchor: Range<text::Anchor>,
5407 ) -> Option<Range<Anchor>> {
5408 let excerpt = self.excerpt(self.latest_excerpt_id(excerpt_id))?;
5409
5410 Some(
5411 Self::anchor_in_excerpt_(excerpt, text_anchor.start)?
5412 ..Self::anchor_in_excerpt_(excerpt, text_anchor.end)?,
5413 )
5414 }
5415
5416 /// Returns an anchor for the given excerpt and text anchor,
5417 /// Returns [`None`] if the excerpt_id is no longer valid or the text anchor range is out of excerpt's bounds.
5418 pub fn anchor_in_excerpt(
5419 &self,
5420 excerpt_id: ExcerptId,
5421 text_anchor: text::Anchor,
5422 ) -> Option<Anchor> {
5423 let excerpt = self.excerpt(self.latest_excerpt_id(excerpt_id))?;
5424 Self::anchor_in_excerpt_(excerpt, text_anchor)
5425 }
5426
5427 /// Same as [`MultiBuffer::anchor_in_excerpt`], but more efficient than calling it multiple times.
5428 pub fn anchors_in_excerpt(
5429 &self,
5430 excerpt_id: ExcerptId,
5431 text_anchors: impl IntoIterator<Item = text::Anchor>,
5432 ) -> Option<impl Iterator<Item = Option<Anchor>>> {
5433 let excerpt = self.excerpt(self.latest_excerpt_id(excerpt_id))?;
5434 Some(
5435 text_anchors
5436 .into_iter()
5437 .map(|text_anchor| Self::anchor_in_excerpt_(excerpt, text_anchor)),
5438 )
5439 }
5440
5441 fn anchor_in_excerpt_(excerpt: &Excerpt, text_anchor: text::Anchor) -> Option<Anchor> {
5442 match text_anchor.buffer_id {
5443 Some(buffer_id) if buffer_id == excerpt.buffer_id => (),
5444 Some(_) => return None,
5445 None if text_anchor.is_max() || text_anchor.is_min() => {
5446 return Some(Anchor::in_buffer(excerpt.id, text_anchor));
5447 }
5448 None => return None,
5449 }
5450
5451 let context = &excerpt.range.context;
5452 if context.start.cmp(&text_anchor, &excerpt.buffer).is_gt()
5453 || context.end.cmp(&text_anchor, &excerpt.buffer).is_lt()
5454 {
5455 return None;
5456 }
5457
5458 Some(Anchor::in_buffer(excerpt.id, text_anchor))
5459 }
5460
5461 pub fn context_range_for_excerpt(&self, excerpt_id: ExcerptId) -> Option<Range<text::Anchor>> {
5462 Some(self.excerpt(excerpt_id)?.range.context.clone())
5463 }
5464
5465 pub fn can_resolve(&self, anchor: &Anchor) -> bool {
5466 if anchor.is_min() || anchor.is_max() {
5467 // todo(lw): should be `!self.is_empty()`
5468 true
5469 } else if let Some(excerpt) = self.excerpt(anchor.excerpt_id) {
5470 excerpt.buffer.can_resolve(&anchor.text_anchor)
5471 } else {
5472 false
5473 }
5474 }
5475
5476 pub fn excerpts(
5477 &self,
5478 ) -> impl Iterator<Item = (ExcerptId, &BufferSnapshot, ExcerptRange<text::Anchor>)> {
5479 self.excerpts
5480 .iter()
5481 .map(|excerpt| (excerpt.id, &excerpt.buffer, excerpt.range.clone()))
5482 }
5483
5484 fn cursor<'a, MBD, BD>(&'a self) -> MultiBufferCursor<'a, MBD, BD>
5485 where
5486 MBD: MultiBufferDimension + Ord + Sub + ops::AddAssign<<MBD as Sub>::Output>,
5487 BD: TextDimension + AddAssign<<MBD as Sub>::Output>,
5488 {
5489 let excerpts = self.excerpts.cursor(());
5490 let diff_transforms = self.diff_transforms.cursor(());
5491 MultiBufferCursor {
5492 excerpts,
5493 diff_transforms,
5494 snapshot: &self,
5495 cached_region: None,
5496 }
5497 }
5498
5499 pub fn excerpt_before(&self, excerpt_id: ExcerptId) -> Option<MultiBufferExcerpt<'_>> {
5500 let start_locator = self.excerpt_locator_for_id(excerpt_id);
5501 let mut excerpts = self
5502 .excerpts
5503 .cursor::<Dimensions<Option<&Locator>, ExcerptOffset>>(());
5504 excerpts.seek(&Some(start_locator), Bias::Left);
5505 excerpts.prev();
5506
5507 let mut diff_transforms = self
5508 .diff_transforms
5509 .cursor::<DiffTransforms<MultiBufferOffset>>(());
5510 diff_transforms.seek(&excerpts.start().1, Bias::Left);
5511 if diff_transforms.end().excerpt_dimension < excerpts.start().1 {
5512 diff_transforms.next();
5513 }
5514
5515 let excerpt = excerpts.item()?;
5516 Some(MultiBufferExcerpt {
5517 excerpt,
5518 offset: diff_transforms.start().output_dimension.0,
5519 buffer_offset: BufferOffset(excerpt.range.context.start.to_offset(&excerpt.buffer)),
5520 excerpt_offset: excerpts.start().1,
5521 diff_transforms,
5522 })
5523 }
5524
5525 pub fn excerpt_boundaries_in_range<R, T>(
5526 &self,
5527 range: R,
5528 ) -> impl Iterator<Item = ExcerptBoundary> + '_
5529 where
5530 R: RangeBounds<T>,
5531 T: ToOffset,
5532 {
5533 let start_offset;
5534 let start = match range.start_bound() {
5535 Bound::Included(start) => {
5536 start_offset = start.to_offset(self);
5537 Bound::Included(start_offset)
5538 }
5539 Bound::Excluded(_) => {
5540 panic!("not supported")
5541 }
5542 Bound::Unbounded => {
5543 start_offset = MultiBufferOffset::ZERO;
5544 Bound::Unbounded
5545 }
5546 };
5547 let end = match range.end_bound() {
5548 Bound::Included(end) => Bound::Included(end.to_offset(self)),
5549 Bound::Excluded(end) => Bound::Excluded(end.to_offset(self)),
5550 Bound::Unbounded => Bound::Unbounded,
5551 };
5552 let bounds = (start, end);
5553 let mut cursor = self.cursor::<DimensionPair<MultiBufferOffset, Point>, BufferOffset>();
5554 cursor.seek(&DimensionPair {
5555 key: start_offset,
5556 value: None,
5557 });
5558
5559 if cursor
5560 .region()
5561 .is_some_and(|region| bounds.contains(®ion.range.start.key))
5562 {
5563 cursor.prev_excerpt();
5564 } else {
5565 cursor.seek_to_start_of_current_excerpt();
5566 }
5567 let mut prev_region = cursor.region();
5568
5569 cursor.next_excerpt();
5570
5571 iter::from_fn(move || {
5572 loop {
5573 if self.singleton {
5574 return None;
5575 }
5576
5577 let next_region = cursor.region()?;
5578 cursor.next_excerpt();
5579 if !bounds.contains(&next_region.range.start.key) {
5580 prev_region = Some(next_region);
5581 continue;
5582 }
5583
5584 let next_region_start = next_region.range.start.value.unwrap();
5585 let next_region_end = if let Some(region) = cursor.region() {
5586 region.range.start.value.unwrap()
5587 } else {
5588 self.max_point()
5589 };
5590
5591 let prev = prev_region.as_ref().map(|region| ExcerptInfo {
5592 id: region.excerpt.id,
5593 buffer: region.excerpt.buffer.clone(),
5594 buffer_id: region.excerpt.buffer_id,
5595 range: region.excerpt.range.clone(),
5596 end_row: MultiBufferRow(next_region_start.row),
5597 });
5598
5599 let next = ExcerptInfo {
5600 id: next_region.excerpt.id,
5601 buffer: next_region.excerpt.buffer.clone(),
5602 buffer_id: next_region.excerpt.buffer_id,
5603 range: next_region.excerpt.range.clone(),
5604 end_row: if next_region.excerpt.has_trailing_newline {
5605 MultiBufferRow(next_region_end.row - 1)
5606 } else {
5607 MultiBufferRow(next_region_end.row)
5608 },
5609 };
5610
5611 let row = MultiBufferRow(next_region_start.row);
5612
5613 prev_region = Some(next_region);
5614
5615 return Some(ExcerptBoundary { row, prev, next });
5616 }
5617 })
5618 }
5619
5620 pub fn edit_count(&self) -> usize {
5621 self.edit_count
5622 }
5623
5624 pub fn non_text_state_update_count(&self) -> usize {
5625 self.non_text_state_update_count
5626 }
5627
5628 /// Returns the smallest enclosing bracket ranges containing the given range or
5629 /// None if no brackets contain range or the range is not contained in a single
5630 /// excerpt
5631 ///
5632 /// Can optionally pass a range_filter to filter the ranges of brackets to consider
5633 #[ztracing::instrument(skip_all)]
5634 pub fn innermost_enclosing_bracket_ranges<T: ToOffset>(
5635 &self,
5636 range: Range<T>,
5637 range_filter: Option<
5638 &dyn Fn(&BufferSnapshot, Range<BufferOffset>, Range<BufferOffset>) -> bool,
5639 >,
5640 ) -> Option<(Range<MultiBufferOffset>, Range<MultiBufferOffset>)> {
5641 let range = range.start.to_offset(self)..range.end.to_offset(self);
5642 let mut excerpt = self.excerpt_containing(range.clone())?;
5643 let buffer = excerpt.buffer();
5644 let excerpt_buffer_range = excerpt.buffer_range();
5645
5646 // Filter to ranges contained in the excerpt
5647 let range_filter = |open: Range<usize>, close: Range<usize>| -> bool {
5648 excerpt_buffer_range.contains(&BufferOffset(open.start))
5649 && excerpt_buffer_range.contains(&BufferOffset(close.end))
5650 && range_filter.is_none_or(|filter| {
5651 filter(
5652 buffer,
5653 BufferOffset(open.start)..BufferOffset(close.end),
5654 BufferOffset(close.start)..BufferOffset(close.end),
5655 )
5656 })
5657 };
5658
5659 let (open, close) = excerpt.buffer().innermost_enclosing_bracket_ranges(
5660 excerpt.map_range_to_buffer(range),
5661 Some(&range_filter),
5662 )?;
5663
5664 Some((
5665 excerpt.map_range_from_buffer(BufferOffset(open.start)..BufferOffset(open.end)),
5666 excerpt.map_range_from_buffer(BufferOffset(close.start)..BufferOffset(close.end)),
5667 ))
5668 }
5669
5670 /// Returns enclosing bracket ranges containing the given range or returns None if the range is
5671 /// not contained in a single excerpt
5672 pub fn enclosing_bracket_ranges<T: ToOffset>(
5673 &self,
5674 range: Range<T>,
5675 ) -> Option<impl Iterator<Item = (Range<MultiBufferOffset>, Range<MultiBufferOffset>)> + '_>
5676 {
5677 let range = range.start.to_offset(self)..range.end.to_offset(self);
5678 let mut excerpt = self.excerpt_containing(range.clone())?;
5679
5680 Some(
5681 excerpt
5682 .buffer()
5683 .enclosing_bracket_ranges(excerpt.map_range_to_buffer(range))
5684 .filter_map(move |pair| {
5685 let open_range =
5686 BufferOffset(pair.open_range.start)..BufferOffset(pair.open_range.end);
5687 let close_range =
5688 BufferOffset(pair.close_range.start)..BufferOffset(pair.close_range.end);
5689 if excerpt.contains_buffer_range(open_range.start..close_range.end) {
5690 Some((
5691 excerpt.map_range_from_buffer(open_range),
5692 excerpt.map_range_from_buffer(close_range),
5693 ))
5694 } else {
5695 None
5696 }
5697 }),
5698 )
5699 }
5700
5701 /// Returns enclosing bracket ranges containing the given range or returns None if the range is
5702 /// not contained in a single excerpt
5703 pub fn text_object_ranges<T: ToOffset>(
5704 &self,
5705 range: Range<T>,
5706 options: TreeSitterOptions,
5707 ) -> impl Iterator<Item = (Range<MultiBufferOffset>, TextObject)> + '_ {
5708 let range = range.start.to_offset(self)..range.end.to_offset(self);
5709 self.excerpt_containing(range.clone())
5710 .map(|mut excerpt| {
5711 excerpt
5712 .buffer()
5713 .text_object_ranges(excerpt.map_range_to_buffer(range), options)
5714 .filter_map(move |(range, text_object)| {
5715 let range = BufferOffset(range.start)..BufferOffset(range.end);
5716 if excerpt.contains_buffer_range(range.clone()) {
5717 Some((excerpt.map_range_from_buffer(range), text_object))
5718 } else {
5719 None
5720 }
5721 })
5722 })
5723 .into_iter()
5724 .flatten()
5725 }
5726
5727 /// Returns bracket range pairs overlapping the given `range` or returns None if the `range` is
5728 /// not contained in a single excerpt
5729 pub fn bracket_ranges<T: ToOffset>(
5730 &self,
5731 range: Range<T>,
5732 ) -> Option<impl Iterator<Item = (Range<MultiBufferOffset>, Range<MultiBufferOffset>)> + '_>
5733 {
5734 let range = range.start.to_offset(self)..range.end.to_offset(self);
5735 let mut excerpt = self.excerpt_containing(range.clone())?;
5736 Some(
5737 excerpt
5738 .buffer()
5739 .bracket_ranges(excerpt.map_range_to_buffer(range))
5740 .filter_map(move |pair| {
5741 let open_range =
5742 BufferOffset(pair.open_range.start)..BufferOffset(pair.open_range.end);
5743 let close_range =
5744 BufferOffset(pair.close_range.start)..BufferOffset(pair.close_range.end);
5745 excerpt
5746 .contains_buffer_range(open_range.start..close_range.end)
5747 .then(|| BracketMatch {
5748 open_range: excerpt.map_range_from_buffer(open_range),
5749 close_range: excerpt.map_range_from_buffer(close_range),
5750 color_index: pair.color_index,
5751 newline_only: pair.newline_only,
5752 syntax_layer_depth: pair.syntax_layer_depth,
5753 })
5754 })
5755 .map(BracketMatch::bracket_ranges),
5756 )
5757 }
5758
5759 pub fn redacted_ranges<'a, T: ToOffset>(
5760 &'a self,
5761 range: Range<T>,
5762 redaction_enabled: impl Fn(Option<&Arc<dyn File>>) -> bool + 'a,
5763 ) -> impl Iterator<Item = Range<MultiBufferOffset>> + 'a {
5764 let range = range.start.to_offset(self)..range.end.to_offset(self);
5765 self.lift_buffer_metadata(range, move |buffer, range| {
5766 if redaction_enabled(buffer.file()) {
5767 Some(buffer.redacted_ranges(range).map(|range| (range, ())))
5768 } else {
5769 None
5770 }
5771 })
5772 .map(|(range, _, _)| range)
5773 }
5774
5775 pub fn runnable_ranges(
5776 &self,
5777 range: Range<Anchor>,
5778 ) -> impl Iterator<Item = (Range<MultiBufferOffset>, language::RunnableRange)> + '_ {
5779 let range = range.start.to_offset(self)..range.end.to_offset(self);
5780 self.lift_buffer_metadata(range, move |buffer, range| {
5781 Some(
5782 buffer
5783 .runnable_ranges(range.clone())
5784 .filter(move |runnable| {
5785 runnable.run_range.start >= range.start
5786 && runnable.run_range.end < range.end
5787 })
5788 .map(|runnable| (runnable.run_range.clone(), runnable)),
5789 )
5790 })
5791 .map(|(run_range, runnable, _)| (run_range, runnable))
5792 }
5793
5794 pub fn line_indents(
5795 &self,
5796 start_row: MultiBufferRow,
5797 buffer_filter: impl Fn(&BufferSnapshot) -> bool,
5798 ) -> impl Iterator<Item = (MultiBufferRow, LineIndent, &BufferSnapshot)> {
5799 let max_point = self.max_point();
5800 let mut cursor = self.cursor::<Point, Point>();
5801 cursor.seek(&Point::new(start_row.0, 0));
5802 iter::from_fn(move || {
5803 let mut region = cursor.region()?;
5804 while !buffer_filter(®ion.excerpt.buffer) {
5805 cursor.next();
5806 region = cursor.region()?;
5807 }
5808 let overshoot = start_row.0.saturating_sub(region.range.start.row);
5809 let buffer_start_row =
5810 (region.buffer_range.start.row + overshoot).min(region.buffer_range.end.row);
5811
5812 let buffer_end_row = if region.is_main_buffer
5813 && (region.has_trailing_newline || region.range.end == max_point)
5814 {
5815 region.buffer_range.end.row
5816 } else {
5817 region.buffer_range.end.row.saturating_sub(1)
5818 };
5819
5820 let line_indents = region
5821 .buffer
5822 .line_indents_in_row_range(buffer_start_row..buffer_end_row);
5823 cursor.next();
5824 Some(line_indents.map(move |(buffer_row, indent)| {
5825 let row = region.range.start.row + (buffer_row - region.buffer_range.start.row);
5826 (MultiBufferRow(row), indent, ®ion.excerpt.buffer)
5827 }))
5828 })
5829 .flatten()
5830 }
5831
5832 pub fn reversed_line_indents(
5833 &self,
5834 end_row: MultiBufferRow,
5835 buffer_filter: impl Fn(&BufferSnapshot) -> bool,
5836 ) -> impl Iterator<Item = (MultiBufferRow, LineIndent, &BufferSnapshot)> {
5837 let max_point = self.max_point();
5838 let mut cursor = self.cursor::<Point, Point>();
5839 cursor.seek(&Point::new(end_row.0, 0));
5840 iter::from_fn(move || {
5841 let mut region = cursor.region()?;
5842 while !buffer_filter(®ion.excerpt.buffer) {
5843 cursor.prev();
5844 region = cursor.region()?;
5845 }
5846
5847 let buffer_start_row = region.buffer_range.start.row;
5848 let buffer_end_row = if region.is_main_buffer
5849 && (region.has_trailing_newline || region.range.end == max_point)
5850 {
5851 region.buffer_range.end.row + 1
5852 } else {
5853 region.buffer_range.end.row
5854 };
5855
5856 let overshoot = end_row.0 - region.range.start.row;
5857 let buffer_end_row =
5858 (region.buffer_range.start.row + overshoot + 1).min(buffer_end_row);
5859
5860 let line_indents = region
5861 .buffer
5862 .reversed_line_indents_in_row_range(buffer_start_row..buffer_end_row);
5863 cursor.prev();
5864 Some(line_indents.map(move |(buffer_row, indent)| {
5865 let row = region.range.start.row + (buffer_row - region.buffer_range.start.row);
5866 (MultiBufferRow(row), indent, ®ion.excerpt.buffer)
5867 }))
5868 })
5869 .flatten()
5870 }
5871
5872 pub async fn enclosing_indent(
5873 &self,
5874 mut target_row: MultiBufferRow,
5875 ) -> Option<(Range<MultiBufferRow>, LineIndent)> {
5876 let max_row = MultiBufferRow(self.max_point().row);
5877 if target_row >= max_row {
5878 return None;
5879 }
5880
5881 let mut target_indent = self.line_indent_for_row(target_row);
5882
5883 // If the current row is at the start of an indented block, we want to return this
5884 // block as the enclosing indent.
5885 if !target_indent.is_line_empty() && target_row < max_row {
5886 let next_line_indent = self.line_indent_for_row(MultiBufferRow(target_row.0 + 1));
5887 if !next_line_indent.is_line_empty()
5888 && target_indent.raw_len() < next_line_indent.raw_len()
5889 {
5890 target_indent = next_line_indent;
5891 target_row.0 += 1;
5892 }
5893 }
5894
5895 const SEARCH_ROW_LIMIT: u32 = 25000;
5896 const SEARCH_WHITESPACE_ROW_LIMIT: u32 = 2500;
5897 const YIELD_INTERVAL: u32 = 100;
5898
5899 let mut accessed_row_counter = 0;
5900
5901 // If there is a blank line at the current row, search for the next non indented lines
5902 if target_indent.is_line_empty() {
5903 let start = MultiBufferRow(target_row.0.saturating_sub(SEARCH_WHITESPACE_ROW_LIMIT));
5904 let end =
5905 MultiBufferRow((max_row.0 + 1).min(target_row.0 + SEARCH_WHITESPACE_ROW_LIMIT));
5906
5907 let mut non_empty_line_above = None;
5908 for (row, indent, _) in self.reversed_line_indents(target_row, |_| true) {
5909 if row < start {
5910 break;
5911 }
5912 accessed_row_counter += 1;
5913 if accessed_row_counter == YIELD_INTERVAL {
5914 accessed_row_counter = 0;
5915 yield_now().await;
5916 }
5917 if !indent.is_line_empty() {
5918 non_empty_line_above = Some((row, indent));
5919 break;
5920 }
5921 }
5922
5923 let mut non_empty_line_below = None;
5924 for (row, indent, _) in self.line_indents(target_row, |_| true) {
5925 if row > end {
5926 break;
5927 }
5928 accessed_row_counter += 1;
5929 if accessed_row_counter == YIELD_INTERVAL {
5930 accessed_row_counter = 0;
5931 yield_now().await;
5932 }
5933 if !indent.is_line_empty() {
5934 non_empty_line_below = Some((row, indent));
5935 break;
5936 }
5937 }
5938
5939 let (row, indent) = match (non_empty_line_above, non_empty_line_below) {
5940 (Some((above_row, above_indent)), Some((below_row, below_indent))) => {
5941 if above_indent.raw_len() >= below_indent.raw_len() {
5942 (above_row, above_indent)
5943 } else {
5944 (below_row, below_indent)
5945 }
5946 }
5947 (Some(above), None) => above,
5948 (None, Some(below)) => below,
5949 _ => return None,
5950 };
5951
5952 target_indent = indent;
5953 target_row = row;
5954 }
5955
5956 let start = MultiBufferRow(target_row.0.saturating_sub(SEARCH_ROW_LIMIT));
5957 let end = MultiBufferRow((max_row.0 + 1).min(target_row.0 + SEARCH_ROW_LIMIT));
5958
5959 let mut start_indent = None;
5960 for (row, indent, _) in self.reversed_line_indents(target_row, |_| true) {
5961 if row < start {
5962 break;
5963 }
5964 accessed_row_counter += 1;
5965 if accessed_row_counter == YIELD_INTERVAL {
5966 accessed_row_counter = 0;
5967 yield_now().await;
5968 }
5969 if !indent.is_line_empty() && indent.raw_len() < target_indent.raw_len() {
5970 start_indent = Some((row, indent));
5971 break;
5972 }
5973 }
5974 let (start_row, start_indent_size) = start_indent?;
5975
5976 let mut end_indent = (end, None);
5977 for (row, indent, _) in self.line_indents(target_row, |_| true) {
5978 if row > end {
5979 break;
5980 }
5981 accessed_row_counter += 1;
5982 if accessed_row_counter == YIELD_INTERVAL {
5983 accessed_row_counter = 0;
5984 yield_now().await;
5985 }
5986 if !indent.is_line_empty() && indent.raw_len() < target_indent.raw_len() {
5987 end_indent = (MultiBufferRow(row.0.saturating_sub(1)), Some(indent));
5988 break;
5989 }
5990 }
5991 let (end_row, end_indent_size) = end_indent;
5992
5993 let indent = if let Some(end_indent_size) = end_indent_size {
5994 if start_indent_size.raw_len() > end_indent_size.raw_len() {
5995 start_indent_size
5996 } else {
5997 end_indent_size
5998 }
5999 } else {
6000 start_indent_size
6001 };
6002
6003 Some((start_row..end_row, indent))
6004 }
6005
6006 pub fn indent_guides_in_range<T: ToPoint>(
6007 &self,
6008 range: Range<T>,
6009 ignore_disabled_for_language: bool,
6010 cx: &App,
6011 ) -> impl Iterator<Item = IndentGuide> {
6012 let range = range.start.to_point(self)..range.end.to_point(self);
6013 let start_row = MultiBufferRow(range.start.row);
6014 let end_row = MultiBufferRow(range.end.row);
6015
6016 let mut row_indents = self.line_indents(start_row, |buffer| {
6017 let settings =
6018 language_settings(buffer.language().map(|l| l.name()), buffer.file(), cx);
6019 settings.indent_guides.enabled || ignore_disabled_for_language
6020 });
6021
6022 let mut result = Vec::new();
6023 let mut indent_stack = SmallVec::<[IndentGuide; 8]>::new();
6024
6025 let mut prev_settings = None;
6026 while let Some((first_row, mut line_indent, buffer)) = row_indents.next() {
6027 if first_row > end_row {
6028 break;
6029 }
6030 let current_depth = indent_stack.len() as u32;
6031
6032 // Avoid retrieving the language settings repeatedly for every buffer row.
6033 if let Some((prev_buffer_id, _)) = &prev_settings
6034 && prev_buffer_id != &buffer.remote_id()
6035 {
6036 prev_settings.take();
6037 }
6038 let settings = &prev_settings
6039 .get_or_insert_with(|| {
6040 (
6041 buffer.remote_id(),
6042 language_settings(buffer.language().map(|l| l.name()), buffer.file(), cx),
6043 )
6044 })
6045 .1;
6046 let tab_size = settings.tab_size.get();
6047
6048 // When encountering empty, continue until found useful line indent
6049 // then add to the indent stack with the depth found
6050 let mut found_indent = false;
6051 let mut last_row = first_row;
6052 if line_indent.is_line_blank() {
6053 while !found_indent {
6054 let Some((target_row, new_line_indent, _)) = row_indents.next() else {
6055 break;
6056 };
6057 const TRAILING_ROW_SEARCH_LIMIT: u32 = 25;
6058 if target_row > MultiBufferRow(end_row.0 + TRAILING_ROW_SEARCH_LIMIT) {
6059 break;
6060 }
6061
6062 if new_line_indent.is_line_blank() {
6063 continue;
6064 }
6065 last_row = target_row.min(end_row);
6066 line_indent = new_line_indent;
6067 found_indent = true;
6068 break;
6069 }
6070 } else {
6071 found_indent = true
6072 }
6073
6074 let depth = if found_indent {
6075 line_indent.len(tab_size) / tab_size
6076 } else {
6077 0
6078 };
6079
6080 match depth.cmp(¤t_depth) {
6081 cmp::Ordering::Less => {
6082 for _ in 0..(current_depth - depth) {
6083 let mut indent = indent_stack.pop().unwrap();
6084 if last_row != first_row {
6085 // In this case, we landed on an empty row, had to seek forward,
6086 // and discovered that the indent we where on is ending.
6087 // This means that the last display row must
6088 // be on line that ends this indent range, so we
6089 // should display the range up to the first non-empty line
6090 indent.end_row = MultiBufferRow(first_row.0.saturating_sub(1));
6091 }
6092
6093 result.push(indent)
6094 }
6095 }
6096 cmp::Ordering::Greater => {
6097 for next_depth in current_depth..depth {
6098 indent_stack.push(IndentGuide {
6099 buffer_id: buffer.remote_id(),
6100 start_row: first_row,
6101 end_row: last_row,
6102 depth: next_depth,
6103 tab_size,
6104 settings: settings.indent_guides.clone(),
6105 });
6106 }
6107 }
6108 _ => {}
6109 }
6110
6111 for indent in indent_stack.iter_mut() {
6112 indent.end_row = last_row;
6113 }
6114 }
6115
6116 result.extend(indent_stack);
6117 result.into_iter()
6118 }
6119
6120 pub fn trailing_excerpt_update_count(&self) -> usize {
6121 self.trailing_excerpt_update_count
6122 }
6123
6124 pub fn file_at<T: ToOffset>(&self, point: T) -> Option<&Arc<dyn File>> {
6125 self.point_to_buffer_offset(point)
6126 .and_then(|(buffer, _)| buffer.file())
6127 }
6128
6129 pub fn language_at<T: ToOffset>(&self, offset: T) -> Option<&Arc<Language>> {
6130 self.point_to_buffer_offset(offset)
6131 .and_then(|(buffer, offset)| buffer.language_at(offset))
6132 }
6133
6134 fn language_settings<'a>(&'a self, cx: &'a App) -> Cow<'a, LanguageSettings> {
6135 self.excerpts
6136 .first()
6137 .map(|excerpt| &excerpt.buffer)
6138 .map(|buffer| {
6139 language_settings(
6140 buffer.language().map(|language| language.name()),
6141 buffer.file(),
6142 cx,
6143 )
6144 })
6145 .unwrap_or_else(move || self.language_settings_at(MultiBufferOffset::ZERO, cx))
6146 }
6147
6148 pub fn language_settings_at<'a, T: ToOffset>(
6149 &'a self,
6150 point: T,
6151 cx: &'a App,
6152 ) -> Cow<'a, LanguageSettings> {
6153 let mut language = None;
6154 let mut file = None;
6155 if let Some((buffer, offset)) = self.point_to_buffer_offset(point) {
6156 language = buffer.language_at(offset);
6157 file = buffer.file();
6158 }
6159 language_settings(language.map(|l| l.name()), file, cx)
6160 }
6161
6162 pub fn language_scope_at<T: ToOffset>(&self, point: T) -> Option<LanguageScope> {
6163 self.point_to_buffer_offset(point)
6164 .and_then(|(buffer, offset)| buffer.language_scope_at(offset))
6165 }
6166
6167 pub fn char_classifier_at<T: ToOffset>(&self, point: T) -> CharClassifier {
6168 self.point_to_buffer_offset(point)
6169 .map(|(buffer, offset)| buffer.char_classifier_at(offset))
6170 .unwrap_or_default()
6171 }
6172
6173 pub fn language_indent_size_at<T: ToOffset>(
6174 &self,
6175 position: T,
6176 cx: &App,
6177 ) -> Option<IndentSize> {
6178 let (buffer_snapshot, offset) = self.point_to_buffer_offset(position)?;
6179 Some(buffer_snapshot.language_indent_size_at(offset, cx))
6180 }
6181
6182 pub fn is_dirty(&self) -> bool {
6183 self.is_dirty
6184 }
6185
6186 pub fn has_deleted_file(&self) -> bool {
6187 self.has_deleted_file
6188 }
6189
6190 pub fn has_conflict(&self) -> bool {
6191 self.has_conflict
6192 }
6193
6194 pub fn has_diagnostics(&self) -> bool {
6195 self.excerpts
6196 .iter()
6197 .any(|excerpt| excerpt.buffer.has_diagnostics())
6198 }
6199
6200 pub fn diagnostic_group(
6201 &self,
6202 buffer_id: BufferId,
6203 group_id: usize,
6204 ) -> impl Iterator<Item = DiagnosticEntryRef<'_, Point>> + '_ {
6205 self.lift_buffer_metadata::<Point, _, _>(
6206 Point::zero()..self.max_point(),
6207 move |buffer, range| {
6208 if buffer.remote_id() != buffer_id {
6209 return None;
6210 };
6211 Some(
6212 buffer
6213 .diagnostics_in_range(range, false)
6214 .filter(move |diagnostic| diagnostic.diagnostic.group_id == group_id)
6215 .map(move |DiagnosticEntryRef { diagnostic, range }| (range, diagnostic)),
6216 )
6217 },
6218 )
6219 .map(|(range, diagnostic, _)| DiagnosticEntryRef { diagnostic, range })
6220 }
6221
6222 pub fn diagnostics_in_range<'a, MBD>(
6223 &'a self,
6224 range: Range<MBD>,
6225 ) -> impl Iterator<Item = DiagnosticEntryRef<'a, MBD>> + 'a
6226 where
6227 MBD::TextDimension: 'a
6228 + text::ToOffset
6229 + text::FromAnchor
6230 + Sub<Output = MBD::TextDimension>
6231 + fmt::Debug
6232 + ops::Add<Output = MBD::TextDimension>
6233 + ops::AddAssign
6234 + Ord,
6235 MBD: MultiBufferDimension
6236 + Ord
6237 + Sub<Output = MBD::TextDimension>
6238 + ops::Add<MBD::TextDimension, Output = MBD>
6239 + ops::AddAssign<MBD::TextDimension>
6240 + 'a,
6241 {
6242 self.lift_buffer_metadata::<MBD, _, _>(range, move |buffer, buffer_range| {
6243 Some(
6244 buffer
6245 .diagnostics_in_range(buffer_range.start..buffer_range.end, false)
6246 .map(|entry| (entry.range, entry.diagnostic)),
6247 )
6248 })
6249 .map(|(range, diagnostic, _)| DiagnosticEntryRef { diagnostic, range })
6250 }
6251
6252 pub fn diagnostics_with_buffer_ids_in_range<'a, MBD>(
6253 &'a self,
6254 range: Range<MBD>,
6255 ) -> impl Iterator<Item = (BufferId, DiagnosticEntryRef<'a, MBD>)> + 'a
6256 where
6257 MBD: MultiBufferDimension
6258 + Ord
6259 + Sub<Output = MBD::TextDimension>
6260 + ops::Add<MBD::TextDimension, Output = MBD>
6261 + ops::AddAssign<MBD::TextDimension>,
6262 MBD::TextDimension: Sub<Output = MBD::TextDimension>
6263 + ops::Add<Output = MBD::TextDimension>
6264 + text::ToOffset
6265 + text::FromAnchor
6266 + AddAssign<MBD::TextDimension>
6267 + Ord,
6268 {
6269 self.lift_buffer_metadata::<MBD, _, _>(range, move |buffer, buffer_range| {
6270 Some(
6271 buffer
6272 .diagnostics_in_range(buffer_range.start..buffer_range.end, false)
6273 .map(|entry| (entry.range, entry.diagnostic)),
6274 )
6275 })
6276 .map(|(range, diagnostic, b)| (b.buffer_id, DiagnosticEntryRef { diagnostic, range }))
6277 }
6278
6279 pub fn syntax_ancestor<T: ToOffset>(
6280 &self,
6281 range: Range<T>,
6282 ) -> Option<(tree_sitter::Node<'_>, Range<MultiBufferOffset>)> {
6283 let range = range.start.to_offset(self)..range.end.to_offset(self);
6284 let mut excerpt = self.excerpt_containing(range.clone())?;
6285 let node = excerpt
6286 .buffer()
6287 .syntax_ancestor(excerpt.map_range_to_buffer(range))?;
6288 let node_range = node.byte_range();
6289 let node_range = BufferOffset(node_range.start)..BufferOffset(node_range.end);
6290 if !excerpt.contains_buffer_range(node_range.clone()) {
6291 return None;
6292 };
6293 Some((node, excerpt.map_range_from_buffer(node_range)))
6294 }
6295
6296 pub fn outline(&self, theme: Option<&SyntaxTheme>) -> Option<Outline<Anchor>> {
6297 let (excerpt_id, _, buffer) = self.as_singleton()?;
6298 let outline = buffer.outline(theme);
6299 Some(Outline::new(
6300 outline
6301 .items
6302 .into_iter()
6303 .flat_map(|item| {
6304 Some(OutlineItem {
6305 depth: item.depth,
6306 range: self.anchor_range_in_excerpt(*excerpt_id, item.range)?,
6307 source_range_for_text: self
6308 .anchor_range_in_excerpt(*excerpt_id, item.source_range_for_text)?,
6309 text: item.text,
6310 highlight_ranges: item.highlight_ranges,
6311 name_ranges: item.name_ranges,
6312 body_range: item.body_range.and_then(|body_range| {
6313 self.anchor_range_in_excerpt(*excerpt_id, body_range)
6314 }),
6315 annotation_range: item.annotation_range.and_then(|annotation_range| {
6316 self.anchor_range_in_excerpt(*excerpt_id, annotation_range)
6317 }),
6318 })
6319 })
6320 .collect(),
6321 ))
6322 }
6323
6324 pub fn symbols_containing<T: ToOffset>(
6325 &self,
6326 offset: T,
6327 theme: Option<&SyntaxTheme>,
6328 ) -> Option<(BufferId, Vec<OutlineItem<Anchor>>)> {
6329 let anchor = self.anchor_before(offset);
6330 let excerpt @ &Excerpt {
6331 id: excerpt_id,
6332 buffer_id,
6333 ref buffer,
6334 ..
6335 } = self.excerpt(anchor.excerpt_id)?;
6336 if cfg!(debug_assertions) {
6337 match anchor.text_anchor.buffer_id {
6338 // we clearly are hitting this according to sentry, but in what situations can this occur?
6339 Some(anchor_buffer_id) => {
6340 assert_eq!(
6341 anchor_buffer_id, buffer_id,
6342 "anchor {anchor:?} does not match with resolved excerpt {excerpt:?}"
6343 )
6344 }
6345 None => assert!(anchor.is_max()),
6346 }
6347 };
6348 Some((
6349 buffer_id,
6350 buffer
6351 .symbols_containing(anchor.text_anchor, theme)
6352 .into_iter()
6353 .flat_map(|item| {
6354 Some(OutlineItem {
6355 depth: item.depth,
6356 source_range_for_text: Anchor::range_in_buffer(
6357 excerpt_id,
6358 item.source_range_for_text,
6359 ),
6360 range: Anchor::range_in_buffer(excerpt_id, item.range),
6361 text: item.text,
6362 highlight_ranges: item.highlight_ranges,
6363 name_ranges: item.name_ranges,
6364 body_range: item
6365 .body_range
6366 .map(|body_range| Anchor::range_in_buffer(excerpt_id, body_range)),
6367 annotation_range: item
6368 .annotation_range
6369 .map(|body_range| Anchor::range_in_buffer(excerpt_id, body_range)),
6370 })
6371 })
6372 .collect(),
6373 ))
6374 }
6375
6376 fn excerpt_locator_for_id(&self, id: ExcerptId) -> &Locator {
6377 if id == ExcerptId::min() {
6378 Locator::min_ref()
6379 } else if id == ExcerptId::max() {
6380 Locator::max_ref()
6381 } else {
6382 let (_, _, item) = self.excerpt_ids.find::<ExcerptId, _>((), &id, Bias::Left);
6383 if let Some(entry) = item
6384 && entry.id == id
6385 {
6386 return &entry.locator;
6387 }
6388 panic!("invalid excerpt id {id:?}")
6389 }
6390 }
6391
6392 /// Returns the locators referenced by the given excerpt IDs, sorted by locator.
6393 fn excerpt_locators_for_ids(
6394 &self,
6395 ids: impl IntoIterator<Item = ExcerptId>,
6396 ) -> SmallVec<[Locator; 1]> {
6397 let mut sorted_ids = ids.into_iter().collect::<SmallVec<[_; 1]>>();
6398 sorted_ids.sort_unstable();
6399 sorted_ids.dedup();
6400 let mut locators = SmallVec::new();
6401
6402 while sorted_ids.last() == Some(&ExcerptId::max()) {
6403 sorted_ids.pop();
6404 locators.push(Locator::max());
6405 }
6406
6407 let mut sorted_ids = sorted_ids.into_iter().peekable();
6408 locators.extend(
6409 sorted_ids
6410 .peeking_take_while(|excerpt| *excerpt == ExcerptId::min())
6411 .map(|_| Locator::min()),
6412 );
6413
6414 let mut cursor = self.excerpt_ids.cursor::<ExcerptId>(());
6415 for id in sorted_ids {
6416 if cursor.seek_forward(&id, Bias::Left) {
6417 locators.push(cursor.item().unwrap().locator.clone());
6418 } else {
6419 panic!("invalid excerpt id {:?}", id);
6420 }
6421 }
6422
6423 locators.sort_unstable();
6424 locators
6425 }
6426
6427 pub fn buffer_id_for_excerpt(&self, excerpt_id: ExcerptId) -> Option<BufferId> {
6428 Some(self.excerpt(excerpt_id)?.buffer_id)
6429 }
6430
6431 pub fn buffer_for_excerpt(&self, excerpt_id: ExcerptId) -> Option<&BufferSnapshot> {
6432 Some(&self.excerpt(excerpt_id)?.buffer)
6433 }
6434
6435 pub fn range_for_excerpt(&self, excerpt_id: ExcerptId) -> Option<Range<Point>> {
6436 let mut cursor = self
6437 .excerpts
6438 .cursor::<Dimensions<Option<&Locator>, ExcerptPoint>>(());
6439 let locator = self.excerpt_locator_for_id(excerpt_id);
6440 let mut sought_exact = cursor.seek(&Some(locator), Bias::Left);
6441 if cursor.item().is_none() && excerpt_id == ExcerptId::max() {
6442 sought_exact = true;
6443 cursor.prev();
6444 } else if excerpt_id == ExcerptId::min() {
6445 sought_exact = true;
6446 }
6447 if sought_exact {
6448 let start = cursor.start().1;
6449 let end = cursor.end().1;
6450 let mut diff_transforms = self
6451 .diff_transforms
6452 .cursor::<Dimensions<ExcerptPoint, OutputDimension<Point>>>(());
6453 diff_transforms.seek(&start, Bias::Left);
6454 let overshoot = start - diff_transforms.start().0;
6455 let start = diff_transforms.start().1 + overshoot;
6456 diff_transforms.seek(&end, Bias::Right);
6457 let overshoot = end - diff_transforms.start().0;
6458 let end = diff_transforms.start().1 + overshoot;
6459 Some(start.0..end.0)
6460 } else {
6461 None
6462 }
6463 }
6464
6465 /// Returns the excerpt for the given id. The returned excerpt is guaranteed
6466 /// to have the latest excerpt id for the one passed in and will also remap
6467 /// `ExcerptId::max()` to the corresponding excertp ID.
6468 ///
6469 /// Callers of this function should generally use the resulting excerpt's `id` field
6470 /// afterwards.
6471 fn excerpt(&self, excerpt_id: ExcerptId) -> Option<&Excerpt> {
6472 let excerpt_id = self.latest_excerpt_id(excerpt_id);
6473 let mut cursor = self.excerpts.cursor::<Option<&Locator>>(());
6474 let locator = self.excerpt_locator_for_id(excerpt_id);
6475 cursor.seek(&Some(locator), Bias::Left);
6476 if let Some(excerpt) = cursor.item()
6477 && excerpt.id == excerpt_id
6478 {
6479 return Some(excerpt);
6480 } else if cursor.item().is_none() && excerpt_id == ExcerptId::max() {
6481 cursor.prev();
6482 return cursor.item();
6483 }
6484 None
6485 }
6486
6487 /// Returns the excerpt containing range and its offset start within the multibuffer or none if `range` spans multiple excerpts
6488 pub fn excerpt_containing<T: ToOffset>(
6489 &self,
6490 range: Range<T>,
6491 ) -> Option<MultiBufferExcerpt<'_>> {
6492 let range = range.start.to_offset(self)..range.end.to_offset(self);
6493 let mut cursor = self.cursor::<MultiBufferOffset, BufferOffset>();
6494 cursor.seek(&range.start);
6495
6496 let start_excerpt = cursor.excerpt()?;
6497 if range.end != range.start {
6498 cursor.seek_forward(&range.end);
6499 if cursor.excerpt()?.id != start_excerpt.id {
6500 return None;
6501 }
6502 }
6503
6504 cursor.seek_to_start_of_current_excerpt();
6505 let region = cursor.region()?;
6506 let offset = region.range.start;
6507 let buffer_offset = start_excerpt.buffer_start_offset();
6508 let excerpt_offset = *cursor.excerpts.start();
6509 Some(MultiBufferExcerpt {
6510 diff_transforms: cursor.diff_transforms,
6511 excerpt: start_excerpt,
6512 offset,
6513 buffer_offset,
6514 excerpt_offset,
6515 })
6516 }
6517
6518 pub fn buffer_id_for_anchor(&self, anchor: Anchor) -> Option<BufferId> {
6519 if let Some(id) = anchor.text_anchor.buffer_id {
6520 return Some(id);
6521 }
6522 let excerpt = self.excerpt_containing(anchor..anchor)?;
6523 Some(excerpt.buffer_id())
6524 }
6525
6526 pub fn selections_in_range<'a>(
6527 &'a self,
6528 range: &'a Range<Anchor>,
6529 include_local: bool,
6530 ) -> impl 'a + Iterator<Item = (ReplicaId, bool, CursorShape, Selection<Anchor>)> {
6531 let mut cursor = self.excerpts.cursor::<ExcerptSummary>(());
6532 let start_locator = self.excerpt_locator_for_id(range.start.excerpt_id);
6533 let end_locator = self.excerpt_locator_for_id(range.end.excerpt_id);
6534 cursor.seek(start_locator, Bias::Left);
6535 cursor
6536 .take_while(move |excerpt| excerpt.locator <= *end_locator)
6537 .flat_map(move |excerpt| {
6538 let mut query_range = excerpt.range.context.start..excerpt.range.context.end;
6539 if excerpt.id == range.start.excerpt_id {
6540 query_range.start = range.start.text_anchor;
6541 }
6542 if excerpt.id == range.end.excerpt_id {
6543 query_range.end = range.end.text_anchor;
6544 }
6545
6546 excerpt
6547 .buffer
6548 .selections_in_range(query_range, include_local)
6549 .flat_map(move |(replica_id, line_mode, cursor_shape, selections)| {
6550 selections.map(move |selection| {
6551 let mut start = Anchor::in_buffer(excerpt.id, selection.start);
6552 let mut end = Anchor::in_buffer(excerpt.id, selection.end);
6553 if range.start.cmp(&start, self).is_gt() {
6554 start = range.start;
6555 }
6556 if range.end.cmp(&end, self).is_lt() {
6557 end = range.end;
6558 }
6559
6560 (
6561 replica_id,
6562 line_mode,
6563 cursor_shape,
6564 Selection {
6565 id: selection.id,
6566 start,
6567 end,
6568 reversed: selection.reversed,
6569 goal: selection.goal,
6570 },
6571 )
6572 })
6573 })
6574 })
6575 }
6576
6577 pub fn show_headers(&self) -> bool {
6578 self.show_headers
6579 }
6580
6581 pub fn diff_for_buffer_id(&self, buffer_id: BufferId) -> Option<&BufferDiffSnapshot> {
6582 self.diffs.get(&buffer_id)
6583 }
6584
6585 /// Visually annotates a position or range with the `Debug` representation of a value. The
6586 /// callsite of this function is used as a key - previous annotations will be removed.
6587 #[cfg(debug_assertions)]
6588 #[track_caller]
6589 pub fn debug<V, R>(&self, ranges: &R, value: V)
6590 where
6591 R: debug::ToMultiBufferDebugRanges,
6592 V: std::fmt::Debug,
6593 {
6594 self.debug_with_key(std::panic::Location::caller(), ranges, value);
6595 }
6596
6597 /// Visually annotates a position or range with the `Debug` representation of a value. Previous
6598 /// debug annotations with the same key will be removed. The key is also used to determine the
6599 /// annotation's color.
6600 #[cfg(debug_assertions)]
6601 #[track_caller]
6602 pub fn debug_with_key<K, R, V>(&self, key: &K, ranges: &R, value: V)
6603 where
6604 K: std::hash::Hash + 'static,
6605 R: debug::ToMultiBufferDebugRanges,
6606 V: std::fmt::Debug,
6607 {
6608 let text_ranges = ranges
6609 .to_multi_buffer_debug_ranges(self)
6610 .into_iter()
6611 .flat_map(|range| {
6612 self.range_to_buffer_ranges(range).into_iter().map(
6613 |(buffer, range, _excerpt_id)| {
6614 buffer.anchor_after(range.start)..buffer.anchor_before(range.end)
6615 },
6616 )
6617 })
6618 .collect();
6619 text::debug::GlobalDebugRanges::with_locked(|debug_ranges| {
6620 debug_ranges.insert(key, text_ranges, format!("{value:?}").into())
6621 });
6622 }
6623}
6624
6625#[cfg(any(test, feature = "test-support"))]
6626impl MultiBufferSnapshot {
6627 pub fn random_byte_range(
6628 &self,
6629 start_offset: MultiBufferOffset,
6630 rng: &mut impl rand::Rng,
6631 ) -> Range<MultiBufferOffset> {
6632 let end = self.clip_offset(rng.random_range(start_offset..=self.len()), Bias::Right);
6633 let start = self.clip_offset(rng.random_range(start_offset..=end), Bias::Right);
6634 start..end
6635 }
6636
6637 #[cfg(any(test, feature = "test-support"))]
6638 fn check_invariants(&self) {
6639 let excerpts = self.excerpts.items(());
6640 let excerpt_ids = self.excerpt_ids.items(());
6641
6642 assert!(
6643 self.excerpts.is_empty() || !self.diff_transforms.is_empty(),
6644 "must be at least one diff transform if excerpts exist"
6645 );
6646
6647 for (ix, excerpt) in excerpts.iter().enumerate() {
6648 if ix == 0 {
6649 if excerpt.locator <= Locator::min() {
6650 panic!("invalid first excerpt locator {:?}", excerpt.locator);
6651 }
6652 } else if excerpt.locator <= excerpts[ix - 1].locator {
6653 panic!("excerpts are out-of-order: {:?}", excerpts);
6654 }
6655 }
6656
6657 for (ix, entry) in excerpt_ids.iter().enumerate() {
6658 if ix == 0 {
6659 if entry.id.cmp(&ExcerptId::min(), self).is_le() {
6660 panic!("invalid first excerpt id {:?}", entry.id);
6661 }
6662 } else if entry.id <= excerpt_ids[ix - 1].id {
6663 panic!("excerpt ids are out-of-order: {:?}", excerpt_ids);
6664 }
6665 }
6666
6667 if self.diff_transforms.summary().input != self.excerpts.summary().text {
6668 panic!(
6669 "incorrect input summary. expected {:#?}, got {:#?}. transforms: {:#?}",
6670 self.excerpts.summary().text,
6671 self.diff_transforms.summary().input,
6672 self.diff_transforms.items(()),
6673 );
6674 }
6675
6676 for (left, right) in self.diff_transforms.iter().tuple_windows() {
6677 use sum_tree::Item;
6678
6679 if left.is_buffer_content()
6680 && left.summary(()).input.len == MultiBufferOffset(0)
6681 && !self.is_empty()
6682 {
6683 panic!("empty buffer content transform in non-empty snapshot");
6684 }
6685 assert!(
6686 left.clone().merged_with(right).is_none(),
6687 "two consecutive diff transforms could have been merged, but weren't"
6688 );
6689 }
6690 }
6691}
6692
6693impl<'a, MBD, BD> MultiBufferCursor<'a, MBD, BD>
6694where
6695 MBD: MultiBufferDimension + Ord + Sub + ops::AddAssign<<MBD as Sub>::Output>,
6696 BD: TextDimension + AddAssign<<MBD as Sub>::Output>,
6697{
6698 #[instrument(skip_all)]
6699 fn seek(&mut self, position: &MBD) {
6700 let position = OutputDimension(*position);
6701 self.cached_region.take();
6702 self.diff_transforms.seek(&position, Bias::Right);
6703 if self.diff_transforms.item().is_none()
6704 && self.diff_transforms.start().output_dimension == position
6705 {
6706 self.diff_transforms.prev();
6707 }
6708
6709 let mut excerpt_position = self.diff_transforms.start().excerpt_dimension;
6710 if let Some(item) = self.diff_transforms.item()
6711 && item.is_buffer_content()
6712 {
6713 let overshoot = position - self.diff_transforms.start().output_dimension;
6714 excerpt_position += overshoot;
6715 }
6716
6717 self.excerpts.seek(&excerpt_position, Bias::Right);
6718 if self.excerpts.item().is_none() && excerpt_position == *self.excerpts.start() {
6719 self.excerpts.prev();
6720 }
6721 }
6722
6723 fn seek_forward(&mut self, position: &MBD) {
6724 let position = OutputDimension(*position);
6725 self.cached_region.take();
6726 self.diff_transforms.seek_forward(&position, Bias::Right);
6727 if self.diff_transforms.item().is_none()
6728 && self.diff_transforms.start().output_dimension == position
6729 {
6730 self.diff_transforms.prev();
6731 }
6732
6733 let overshoot = position - self.diff_transforms.start().output_dimension;
6734 let mut excerpt_position = self.diff_transforms.start().excerpt_dimension;
6735 if let Some(item) = self.diff_transforms.item()
6736 && item.is_buffer_content()
6737 {
6738 excerpt_position += overshoot;
6739 }
6740
6741 self.excerpts.seek_forward(&excerpt_position, Bias::Right);
6742 if self.excerpts.item().is_none() && excerpt_position == *self.excerpts.start() {
6743 self.excerpts.prev();
6744 }
6745 }
6746
6747 fn next_excerpt(&mut self) {
6748 self.excerpts.next();
6749 self.seek_to_start_of_current_excerpt();
6750 }
6751
6752 fn prev_excerpt(&mut self) {
6753 self.excerpts.prev();
6754 self.seek_to_start_of_current_excerpt();
6755 }
6756
6757 fn seek_to_start_of_current_excerpt(&mut self) {
6758 self.cached_region.take();
6759 self.diff_transforms.seek(self.excerpts.start(), Bias::Left);
6760 if self.diff_transforms.end().excerpt_dimension == *self.excerpts.start()
6761 && self.diff_transforms.start().excerpt_dimension < *self.excerpts.start()
6762 && self.diff_transforms.next_item().is_some()
6763 {
6764 self.diff_transforms.next();
6765 }
6766 }
6767
6768 fn next(&mut self) {
6769 self.cached_region.take();
6770 match self
6771 .diff_transforms
6772 .end()
6773 .excerpt_dimension
6774 .cmp(&self.excerpts.end())
6775 {
6776 cmp::Ordering::Less => {
6777 self.diff_transforms.next();
6778 }
6779 cmp::Ordering::Greater => {
6780 self.excerpts.next();
6781 }
6782 cmp::Ordering::Equal => {
6783 self.diff_transforms.next();
6784 if self.diff_transforms.end().excerpt_dimension > self.excerpts.end()
6785 || self.diff_transforms.item().is_none()
6786 {
6787 self.excerpts.next();
6788 } else if let Some(DiffTransform::DeletedHunk { hunk_info, .. }) =
6789 self.diff_transforms.item()
6790 && self
6791 .excerpts
6792 .item()
6793 .is_some_and(|excerpt| excerpt.id != hunk_info.excerpt_id)
6794 {
6795 self.excerpts.next();
6796 }
6797 }
6798 }
6799 }
6800
6801 fn prev(&mut self) {
6802 self.cached_region.take();
6803 match self
6804 .diff_transforms
6805 .start()
6806 .excerpt_dimension
6807 .cmp(self.excerpts.start())
6808 {
6809 cmp::Ordering::Less => self.excerpts.prev(),
6810 cmp::Ordering::Greater => self.diff_transforms.prev(),
6811 cmp::Ordering::Equal => {
6812 self.diff_transforms.prev();
6813 if self.diff_transforms.start().excerpt_dimension < *self.excerpts.start()
6814 || self.diff_transforms.item().is_none()
6815 {
6816 self.excerpts.prev();
6817 }
6818 }
6819 }
6820 }
6821
6822 fn region(&mut self) -> Option<MultiBufferRegion<'a, MBD, BD>> {
6823 if self.cached_region.is_none() {
6824 self.cached_region = self.build_region();
6825 }
6826 self.cached_region.clone()
6827 }
6828
6829 fn is_at_start_of_excerpt(&mut self) -> bool {
6830 if self.diff_transforms.start().excerpt_dimension > *self.excerpts.start() {
6831 return false;
6832 } else if self.diff_transforms.start().excerpt_dimension < *self.excerpts.start() {
6833 return true;
6834 }
6835
6836 self.diff_transforms.prev();
6837 let prev_transform = self.diff_transforms.item();
6838 self.diff_transforms.next();
6839
6840 prev_transform.is_none_or(|prev_transform| prev_transform.is_buffer_content())
6841 }
6842
6843 fn is_at_end_of_excerpt(&mut self) -> bool {
6844 if self.diff_transforms.end().excerpt_dimension < self.excerpts.end() {
6845 return false;
6846 } else if self.diff_transforms.end().excerpt_dimension > self.excerpts.end()
6847 || self.diff_transforms.item().is_none()
6848 {
6849 return true;
6850 }
6851
6852 let next_transform = self.diff_transforms.next_item();
6853 next_transform.is_none_or(|next_transform| match next_transform {
6854 DiffTransform::Unmodified { .. }
6855 | DiffTransform::InsertedHunk { .. }
6856 | DiffTransform::FilteredInsertedHunk { .. } => true,
6857 DiffTransform::DeletedHunk { hunk_info, .. } => self
6858 .excerpts
6859 .item()
6860 .is_some_and(|excerpt| excerpt.id != hunk_info.excerpt_id),
6861 })
6862 }
6863
6864 fn main_buffer_position(&self) -> Option<BD> {
6865 let excerpt = self.excerpts.item()?;
6866 let buffer = &excerpt.buffer;
6867 let buffer_context_start = excerpt.range.context.start.summary::<BD>(buffer);
6868 let mut buffer_start = buffer_context_start;
6869 let overshoot = self.diff_transforms.end().excerpt_dimension - *self.excerpts.start();
6870 buffer_start += overshoot;
6871 Some(buffer_start)
6872 }
6873
6874 fn build_region(&self) -> Option<MultiBufferRegion<'a, MBD, BD>> {
6875 let excerpt = self.excerpts.item()?;
6876 match self.diff_transforms.item()? {
6877 DiffTransform::DeletedHunk {
6878 buffer_id,
6879 has_trailing_newline,
6880 hunk_info,
6881 ..
6882 } => {
6883 let diff = self.snapshot.diffs.get(buffer_id)?;
6884 let buffer = diff.base_text();
6885 let mut rope_cursor = buffer.as_rope().cursor(0);
6886 let buffer_start = rope_cursor.summary::<BD>(hunk_info.base_text_byte_range.start);
6887 let buffer_range_len =
6888 rope_cursor.summary::<BD>(hunk_info.base_text_byte_range.end);
6889 let mut buffer_end = buffer_start;
6890 TextDimension::add_assign(&mut buffer_end, &buffer_range_len);
6891 let start = self.diff_transforms.start().output_dimension.0;
6892 let end = self.diff_transforms.end().output_dimension.0;
6893
6894 Some(MultiBufferRegion {
6895 buffer,
6896 excerpt,
6897 has_trailing_newline: *has_trailing_newline,
6898 is_main_buffer: false,
6899 diff_hunk_status: Some(DiffHunkStatus::deleted(
6900 hunk_info.hunk_secondary_status,
6901 )),
6902 buffer_range: buffer_start..buffer_end,
6903 range: start..end,
6904 diff_base_byte_range: Some(hunk_info.base_text_byte_range.clone()),
6905 })
6906 }
6907 transform @ (DiffTransform::Unmodified { .. }
6908 | DiffTransform::InsertedHunk { .. }
6909 | DiffTransform::FilteredInsertedHunk { .. }) => {
6910 let mut diff_hunk_status = transform
6911 .hunk_info()
6912 .map(|hunk_info| DiffHunkStatus::added(hunk_info.hunk_secondary_status));
6913
6914 let diff_base_byte_range = transform
6915 .hunk_info()
6916 .map(|hunk_info| hunk_info.base_text_byte_range);
6917
6918 let buffer = &excerpt.buffer;
6919 let buffer_context_start = excerpt.range.context.start.summary::<BD>(buffer);
6920
6921 let mut start = self.diff_transforms.start().output_dimension.0;
6922 let mut buffer_start = buffer_context_start;
6923 if self.diff_transforms.start().excerpt_dimension < *self.excerpts.start() {
6924 let overshoot =
6925 *self.excerpts.start() - self.diff_transforms.start().excerpt_dimension;
6926 start += overshoot;
6927 } else {
6928 let overshoot =
6929 self.diff_transforms.start().excerpt_dimension - *self.excerpts.start();
6930 buffer_start += overshoot;
6931 }
6932
6933 let mut end;
6934 let mut buffer_end;
6935 let has_trailing_newline;
6936 if self.diff_transforms.end().excerpt_dimension < self.excerpts.end() {
6937 let overshoot =
6938 self.diff_transforms.end().excerpt_dimension - *self.excerpts.start();
6939 end = self.diff_transforms.end().output_dimension.0;
6940 buffer_end = buffer_context_start;
6941 buffer_end += overshoot;
6942 has_trailing_newline = false;
6943 } else {
6944 let overshoot =
6945 self.excerpts.end() - self.diff_transforms.start().excerpt_dimension;
6946 end = self.diff_transforms.start().output_dimension.0;
6947 end += overshoot;
6948 buffer_end = excerpt.range.context.end.summary::<BD>(buffer);
6949 has_trailing_newline = excerpt.has_trailing_newline;
6950 };
6951
6952 if matches!(transform, DiffTransform::FilteredInsertedHunk { .. }) {
6953 buffer_end = buffer_start;
6954 end = start;
6955 diff_hunk_status = None;
6956 }
6957
6958 Some(MultiBufferRegion {
6959 buffer,
6960 excerpt,
6961 has_trailing_newline,
6962 is_main_buffer: true,
6963 diff_hunk_status,
6964 diff_base_byte_range,
6965 buffer_range: buffer_start..buffer_end,
6966 range: start..end,
6967 })
6968 }
6969 }
6970 }
6971
6972 fn excerpt(&self) -> Option<&'a Excerpt> {
6973 self.excerpts.item()
6974 }
6975}
6976
6977impl Excerpt {
6978 fn new(
6979 id: ExcerptId,
6980 locator: Locator,
6981 buffer_id: BufferId,
6982 buffer: BufferSnapshot,
6983 range: ExcerptRange<text::Anchor>,
6984 has_trailing_newline: bool,
6985 ) -> Self {
6986 Excerpt {
6987 id,
6988 locator,
6989 max_buffer_row: range.context.end.to_point(&buffer).row,
6990 text_summary: buffer
6991 .text_summary_for_range::<TextSummary, _>(range.context.to_offset(&buffer)),
6992 buffer_id,
6993 buffer,
6994 range,
6995 has_trailing_newline,
6996 }
6997 }
6998
6999 fn chunks_in_range(&self, range: Range<usize>, language_aware: bool) -> ExcerptChunks<'_> {
7000 let content_start = self.range.context.start.to_offset(&self.buffer);
7001 let chunks_start = content_start + range.start;
7002 let chunks_end = content_start + cmp::min(range.end, self.text_summary.len);
7003
7004 let has_footer = self.has_trailing_newline
7005 && range.start <= self.text_summary.len
7006 && range.end > self.text_summary.len;
7007
7008 let content_chunks = self.buffer.chunks(chunks_start..chunks_end, language_aware);
7009
7010 ExcerptChunks {
7011 excerpt_id: self.id,
7012 content_chunks,
7013 has_footer,
7014 }
7015 }
7016
7017 fn seek_chunks(&self, excerpt_chunks: &mut ExcerptChunks, range: Range<usize>) {
7018 let content_start = self.range.context.start.to_offset(&self.buffer);
7019 let chunks_start = content_start + range.start;
7020 let chunks_end = content_start + cmp::min(range.end, self.text_summary.len);
7021 excerpt_chunks.content_chunks.seek(chunks_start..chunks_end);
7022 excerpt_chunks.has_footer = self.has_trailing_newline
7023 && range.start <= self.text_summary.len
7024 && range.end > self.text_summary.len;
7025 }
7026
7027 fn clip_anchor(&self, text_anchor: text::Anchor) -> text::Anchor {
7028 if text_anchor
7029 .cmp(&self.range.context.start, &self.buffer)
7030 .is_lt()
7031 {
7032 self.range.context.start
7033 } else if text_anchor
7034 .cmp(&self.range.context.end, &self.buffer)
7035 .is_gt()
7036 {
7037 self.range.context.end
7038 } else {
7039 text_anchor
7040 }
7041 }
7042
7043 fn contains(&self, anchor: &Anchor) -> bool {
7044 (anchor.text_anchor.buffer_id == None
7045 || anchor.text_anchor.buffer_id == Some(self.buffer_id))
7046 && self
7047 .range
7048 .context
7049 .start
7050 .cmp(&anchor.text_anchor, &self.buffer)
7051 .is_le()
7052 && self
7053 .range
7054 .context
7055 .end
7056 .cmp(&anchor.text_anchor, &self.buffer)
7057 .is_ge()
7058 }
7059
7060 /// The [`Excerpt`]'s start offset in its [`Buffer`]
7061 fn buffer_start_offset(&self) -> BufferOffset {
7062 BufferOffset(self.range.context.start.to_offset(&self.buffer))
7063 }
7064
7065 /// The [`Excerpt`]'s end offset in its [`Buffer`]
7066 fn buffer_end_offset(&self) -> BufferOffset {
7067 self.buffer_start_offset() + self.text_summary.len
7068 }
7069}
7070
7071impl<'a> MultiBufferExcerpt<'a> {
7072 pub fn id(&self) -> ExcerptId {
7073 self.excerpt.id
7074 }
7075
7076 pub fn buffer_id(&self) -> BufferId {
7077 self.excerpt.buffer_id
7078 }
7079
7080 pub fn start_anchor(&self) -> Anchor {
7081 Anchor::in_buffer(self.excerpt.id, self.excerpt.range.context.start)
7082 }
7083
7084 pub fn end_anchor(&self) -> Anchor {
7085 Anchor::in_buffer(self.excerpt.id, self.excerpt.range.context.end)
7086 }
7087
7088 pub fn buffer(&self) -> &'a BufferSnapshot {
7089 &self.excerpt.buffer
7090 }
7091
7092 pub fn buffer_range(&self) -> Range<BufferOffset> {
7093 self.buffer_offset
7094 ..BufferOffset(
7095 self.excerpt
7096 .range
7097 .context
7098 .end
7099 .to_offset(&self.excerpt.buffer.text),
7100 )
7101 }
7102
7103 pub fn start_offset(&self) -> MultiBufferOffset {
7104 self.offset
7105 }
7106
7107 /// Maps an offset within the [`MultiBuffer`] to an offset within the [`Buffer`]
7108 pub fn map_offset_to_buffer(&mut self, offset: MultiBufferOffset) -> BufferOffset {
7109 self.map_range_to_buffer(offset..offset).start
7110 }
7111
7112 /// Maps a range within the [`MultiBuffer`] to a range within the [`Buffer`]
7113 pub fn map_range_to_buffer(&mut self, range: Range<MultiBufferOffset>) -> Range<BufferOffset> {
7114 self.diff_transforms
7115 .seek(&OutputDimension(range.start), Bias::Right);
7116 let start = self.map_offset_to_buffer_internal(range.start);
7117 let end = if range.end > range.start {
7118 self.diff_transforms
7119 .seek_forward(&OutputDimension(range.end), Bias::Right);
7120 self.map_offset_to_buffer_internal(range.end)
7121 } else {
7122 start
7123 };
7124 start..end
7125 }
7126
7127 fn map_offset_to_buffer_internal(&self, offset: MultiBufferOffset) -> BufferOffset {
7128 let mut excerpt_offset = self.diff_transforms.start().excerpt_dimension;
7129 if self
7130 .diff_transforms
7131 .item()
7132 .is_some_and(|t| t.is_buffer_content())
7133 {
7134 excerpt_offset += offset - self.diff_transforms.start().output_dimension.0;
7135 };
7136 let offset_in_excerpt = excerpt_offset.saturating_sub(self.excerpt_offset);
7137 self.buffer_offset + offset_in_excerpt
7138 }
7139
7140 /// Map an offset within the [`Buffer`] to an offset within the [`MultiBuffer`]
7141 pub fn map_offset_from_buffer(&mut self, buffer_offset: BufferOffset) -> MultiBufferOffset {
7142 self.map_range_from_buffer(buffer_offset..buffer_offset)
7143 .start
7144 }
7145
7146 /// Map a range within the [`Buffer`] to a range within the [`MultiBuffer`]
7147 pub fn map_range_from_buffer(
7148 &mut self,
7149 buffer_range: Range<BufferOffset>,
7150 ) -> Range<MultiBufferOffset> {
7151 if buffer_range.start < self.buffer_offset {
7152 log::warn!(
7153 "Attempting to map a range from a buffer offset that starts before the current buffer offset"
7154 );
7155 return self.offset..self.offset;
7156 }
7157 let overshoot = buffer_range.start - self.buffer_offset;
7158 let excerpt_offset = self.excerpt_offset + overshoot;
7159 let excerpt_seek_dim = excerpt_offset;
7160 self.diff_transforms.seek(&excerpt_seek_dim, Bias::Right);
7161 if self.diff_transforms.start().excerpt_dimension > excerpt_offset {
7162 log::warn!(
7163 "Attempting to map a range from a buffer offset that starts before the current buffer offset"
7164 );
7165 return self.offset..self.offset;
7166 }
7167 let overshoot = excerpt_offset - self.diff_transforms.start().excerpt_dimension;
7168 let start = self.diff_transforms.start().output_dimension.0 + overshoot;
7169
7170 let end = if buffer_range.start < buffer_range.end {
7171 let overshoot = buffer_range.end - self.buffer_offset;
7172 let excerpt_offset = self.excerpt_offset + overshoot;
7173 let excerpt_seek_dim = excerpt_offset;
7174 self.diff_transforms
7175 .seek_forward(&excerpt_seek_dim, Bias::Right);
7176 let overshoot = excerpt_offset - self.diff_transforms.start().excerpt_dimension;
7177 // todo(lw): Clamp end to the excerpt boundaries
7178 self.diff_transforms.start().output_dimension.0 + overshoot
7179 } else {
7180 start
7181 };
7182
7183 start..end
7184 }
7185
7186 /// Returns true if the entirety of the given range is in the buffer's excerpt
7187 pub fn contains_buffer_range(&self, range: Range<BufferOffset>) -> bool {
7188 range.start >= self.excerpt.buffer_start_offset()
7189 && range.end <= self.excerpt.buffer_end_offset()
7190 }
7191
7192 pub fn max_buffer_row(&self) -> u32 {
7193 self.excerpt.max_buffer_row
7194 }
7195}
7196
7197impl ExcerptId {
7198 pub fn min() -> Self {
7199 Self(0)
7200 }
7201
7202 pub fn max() -> Self {
7203 Self(u32::MAX)
7204 }
7205
7206 pub fn to_proto(self) -> u64 {
7207 self.0 as _
7208 }
7209
7210 pub fn from_proto(proto: u64) -> Self {
7211 Self(proto as _)
7212 }
7213
7214 pub fn cmp(&self, other: &Self, snapshot: &MultiBufferSnapshot) -> cmp::Ordering {
7215 let a = snapshot.excerpt_locator_for_id(*self);
7216 let b = snapshot.excerpt_locator_for_id(*other);
7217 a.cmp(b).then_with(|| self.0.cmp(&other.0))
7218 }
7219}
7220
7221impl From<ExcerptId> for usize {
7222 fn from(val: ExcerptId) -> Self {
7223 val.0 as usize
7224 }
7225}
7226
7227impl fmt::Debug for Excerpt {
7228 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
7229 f.debug_struct("Excerpt")
7230 .field("id", &self.id)
7231 .field("locator", &self.locator)
7232 .field("buffer_id", &self.buffer_id)
7233 .field("range", &self.range)
7234 .field("text_summary", &self.text_summary)
7235 .field("has_trailing_newline", &self.has_trailing_newline)
7236 .finish()
7237 }
7238}
7239
7240impl sum_tree::Item for Excerpt {
7241 type Summary = ExcerptSummary;
7242
7243 fn summary(&self, _cx: ()) -> Self::Summary {
7244 let mut text = self.text_summary;
7245 if self.has_trailing_newline {
7246 text += TextSummary::from("\n");
7247 }
7248 ExcerptSummary {
7249 excerpt_id: self.id,
7250 excerpt_locator: self.locator.clone(),
7251 widest_line_number: self.max_buffer_row,
7252 text: text.into(),
7253 }
7254 }
7255}
7256
7257impl sum_tree::Item for ExcerptIdMapping {
7258 type Summary = ExcerptId;
7259
7260 fn summary(&self, _cx: ()) -> Self::Summary {
7261 self.id
7262 }
7263}
7264
7265impl sum_tree::KeyedItem for ExcerptIdMapping {
7266 type Key = ExcerptId;
7267
7268 fn key(&self) -> Self::Key {
7269 self.id
7270 }
7271}
7272
7273impl DiffTransform {
7274 fn hunk_info(&self) -> Option<DiffTransformHunkInfo> {
7275 match self {
7276 DiffTransform::DeletedHunk { hunk_info, .. }
7277 | DiffTransform::InsertedHunk { hunk_info, .. }
7278 | DiffTransform::FilteredInsertedHunk { hunk_info, .. } => Some(hunk_info.clone()),
7279 DiffTransform::Unmodified { .. } => None,
7280 }
7281 }
7282
7283 fn is_buffer_content(&self) -> bool {
7284 match self {
7285 Self::Unmodified { .. }
7286 | Self::InsertedHunk { .. }
7287 | Self::FilteredInsertedHunk { .. } => true,
7288 Self::DeletedHunk { .. } => false,
7289 }
7290 }
7291}
7292
7293impl sum_tree::Item for DiffTransform {
7294 type Summary = DiffTransformSummary;
7295
7296 fn summary(&self, _: <Self::Summary as sum_tree::Summary>::Context<'_>) -> Self::Summary {
7297 match self {
7298 DiffTransform::InsertedHunk { summary, .. }
7299 | DiffTransform::Unmodified { summary, .. } => DiffTransformSummary {
7300 input: *summary,
7301 output: *summary,
7302 },
7303 &DiffTransform::DeletedHunk { summary, .. } => DiffTransformSummary {
7304 input: MBTextSummary::default(),
7305 output: summary.into(),
7306 },
7307 DiffTransform::FilteredInsertedHunk { summary, .. } => DiffTransformSummary {
7308 input: *summary,
7309 output: MBTextSummary::default(),
7310 },
7311 }
7312 }
7313}
7314
7315impl DiffTransformSummary {
7316 fn excerpt_len(&self) -> ExcerptOffset {
7317 ExcerptDimension(self.input.len)
7318 }
7319}
7320
7321impl sum_tree::ContextLessSummary for DiffTransformSummary {
7322 fn zero() -> Self {
7323 DiffTransformSummary {
7324 input: MBTextSummary::default(),
7325 output: MBTextSummary::default(),
7326 }
7327 }
7328
7329 fn add_summary(&mut self, other: &Self) {
7330 self.input += other.input;
7331 self.output += other.output;
7332 }
7333}
7334
7335impl sum_tree::ContextLessSummary for ExcerptId {
7336 fn zero() -> Self {
7337 Self(0)
7338 }
7339
7340 fn add_summary(&mut self, summary: &Self) {
7341 *self = cmp::max(*self, *summary);
7342 }
7343}
7344
7345impl sum_tree::ContextLessSummary for ExcerptSummary {
7346 fn zero() -> Self {
7347 Self::default()
7348 }
7349
7350 fn add_summary(&mut self, summary: &Self) {
7351 debug_assert!(summary.excerpt_locator > self.excerpt_locator);
7352 self.excerpt_locator = summary.excerpt_locator.clone();
7353 self.text += summary.text;
7354 self.widest_line_number = cmp::max(self.widest_line_number, summary.widest_line_number);
7355 }
7356}
7357
7358impl<'a> sum_tree::SeekTarget<'a, ExcerptSummary, Option<&'a Locator>> for Locator {
7359 fn cmp(&self, cursor_location: &Option<&'a Locator>, _: ()) -> cmp::Ordering {
7360 Ord::cmp(&Some(self), cursor_location)
7361 }
7362}
7363
7364impl sum_tree::SeekTarget<'_, ExcerptSummary, ExcerptSummary> for Locator {
7365 fn cmp(&self, cursor_location: &ExcerptSummary, _: ()) -> cmp::Ordering {
7366 Ord::cmp(self, &cursor_location.excerpt_locator)
7367 }
7368}
7369
7370impl<'a, MBD> sum_tree::Dimension<'a, ExcerptSummary> for ExcerptDimension<MBD>
7371where
7372 MBD: MultiBufferDimension + Default,
7373{
7374 fn zero(_: ()) -> Self {
7375 ExcerptDimension(MBD::default())
7376 }
7377
7378 fn add_summary(&mut self, summary: &'a ExcerptSummary, _: ()) {
7379 MultiBufferDimension::add_mb_text_summary(&mut self.0, &summary.text)
7380 }
7381}
7382
7383impl<'a> sum_tree::Dimension<'a, ExcerptSummary> for Option<&'a Locator> {
7384 fn zero(_cx: ()) -> Self {
7385 Default::default()
7386 }
7387
7388 fn add_summary(&mut self, summary: &'a ExcerptSummary, _: ()) {
7389 *self = Some(&summary.excerpt_locator);
7390 }
7391}
7392
7393impl<'a> sum_tree::Dimension<'a, ExcerptSummary> for Option<ExcerptId> {
7394 fn zero(_cx: ()) -> Self {
7395 Default::default()
7396 }
7397
7398 fn add_summary(&mut self, summary: &'a ExcerptSummary, _: ()) {
7399 *self = Some(summary.excerpt_id);
7400 }
7401}
7402
7403#[derive(Copy, Clone, PartialOrd, Ord, Eq, PartialEq, Debug)]
7404struct OutputDimension<T>(T);
7405
7406impl<T: PartialEq> PartialEq<T> for OutputDimension<T> {
7407 fn eq(&self, other: &T) -> bool {
7408 self.0 == *other
7409 }
7410}
7411
7412impl<T: PartialOrd> PartialOrd<T> for OutputDimension<T> {
7413 fn partial_cmp(&self, other: &T) -> Option<cmp::Ordering> {
7414 self.0.partial_cmp(other)
7415 }
7416}
7417
7418impl<R, T, U> ops::Sub<OutputDimension<U>> for OutputDimension<T>
7419where
7420 T: ops::Sub<U, Output = R>,
7421{
7422 type Output = R;
7423
7424 fn sub(self, other: OutputDimension<U>) -> Self::Output {
7425 self.0 - other.0
7426 }
7427}
7428
7429impl<R, T, U> ops::Add<U> for OutputDimension<T>
7430where
7431 T: ops::Add<U, Output = R>,
7432{
7433 type Output = OutputDimension<R>;
7434
7435 fn add(self, other: U) -> Self::Output {
7436 OutputDimension(self.0 + other)
7437 }
7438}
7439
7440impl<T, U> AddAssign<U> for OutputDimension<T>
7441where
7442 T: AddAssign<U>,
7443{
7444 fn add_assign(&mut self, other: U) {
7445 self.0 += other;
7446 }
7447}
7448
7449impl<T, U> SubAssign<U> for OutputDimension<T>
7450where
7451 T: SubAssign<U>,
7452{
7453 fn sub_assign(&mut self, other: U) {
7454 self.0 -= other;
7455 }
7456}
7457
7458#[derive(Copy, Clone, PartialOrd, Ord, Eq, PartialEq, Debug)]
7459struct ExcerptDimension<T>(T);
7460
7461impl<T: PartialEq> PartialEq<T> for ExcerptDimension<T> {
7462 fn eq(&self, other: &T) -> bool {
7463 self.0 == *other
7464 }
7465}
7466
7467impl<T: PartialOrd> PartialOrd<T> for ExcerptDimension<T> {
7468 fn partial_cmp(&self, other: &T) -> Option<cmp::Ordering> {
7469 self.0.partial_cmp(other)
7470 }
7471}
7472
7473impl ExcerptOffset {
7474 fn saturating_sub(self, other: ExcerptOffset) -> usize {
7475 self.0.saturating_sub(other.0)
7476 }
7477}
7478
7479impl<R, T, U> ops::Sub<ExcerptDimension<U>> for ExcerptDimension<T>
7480where
7481 T: ops::Sub<U, Output = R>,
7482{
7483 type Output = R;
7484
7485 fn sub(self, other: ExcerptDimension<U>) -> Self::Output {
7486 self.0 - other.0
7487 }
7488}
7489
7490impl<R, T, U> ops::Add<U> for ExcerptDimension<T>
7491where
7492 T: ops::Add<U, Output = R>,
7493{
7494 type Output = ExcerptDimension<R>;
7495
7496 fn add(self, other: U) -> Self::Output {
7497 ExcerptDimension(self.0 + other)
7498 }
7499}
7500
7501impl<T, U> AddAssign<U> for ExcerptDimension<T>
7502where
7503 T: AddAssign<U>,
7504{
7505 fn add_assign(&mut self, other: U) {
7506 self.0 += other;
7507 }
7508}
7509
7510impl<T, U> SubAssign<U> for ExcerptDimension<T>
7511where
7512 T: SubAssign<U>,
7513{
7514 fn sub_assign(&mut self, other: U) {
7515 self.0 -= other;
7516 }
7517}
7518
7519impl<'a> sum_tree::Dimension<'a, DiffTransformSummary> for MultiBufferOffset {
7520 fn zero(_: ()) -> Self {
7521 MultiBufferOffset::ZERO
7522 }
7523
7524 fn add_summary(&mut self, summary: &'a DiffTransformSummary, _: ()) {
7525 *self += summary.output.len;
7526 }
7527}
7528
7529impl<MBD> sum_tree::SeekTarget<'_, DiffTransformSummary, DiffTransformSummary>
7530 for ExcerptDimension<MBD>
7531where
7532 MBD: MultiBufferDimension + Ord,
7533{
7534 fn cmp(&self, cursor_location: &DiffTransformSummary, _: ()) -> cmp::Ordering {
7535 Ord::cmp(&self.0, &MBD::from_summary(&cursor_location.input))
7536 }
7537}
7538
7539impl<'a, MBD> sum_tree::SeekTarget<'a, DiffTransformSummary, DiffTransforms<MBD>>
7540 for ExcerptDimension<MBD>
7541where
7542 MBD: MultiBufferDimension + Ord,
7543{
7544 fn cmp(&self, cursor_location: &DiffTransforms<MBD>, _: ()) -> cmp::Ordering {
7545 Ord::cmp(&self.0, &cursor_location.excerpt_dimension.0)
7546 }
7547}
7548
7549impl<'a, MBD: MultiBufferDimension> sum_tree::Dimension<'a, DiffTransformSummary>
7550 for ExcerptDimension<MBD>
7551{
7552 fn zero(_: ()) -> Self {
7553 ExcerptDimension(MBD::default())
7554 }
7555
7556 fn add_summary(&mut self, summary: &'a DiffTransformSummary, _: ()) {
7557 self.0.add_mb_text_summary(&summary.input)
7558 }
7559}
7560
7561impl<'a, MBD> sum_tree::SeekTarget<'a, DiffTransformSummary, DiffTransforms<MBD>>
7562 for OutputDimension<MBD>
7563where
7564 MBD: MultiBufferDimension + Ord,
7565{
7566 fn cmp(&self, cursor_location: &DiffTransforms<MBD>, _: ()) -> cmp::Ordering {
7567 Ord::cmp(&self.0, &cursor_location.output_dimension.0)
7568 }
7569}
7570
7571impl<'a, MBD: MultiBufferDimension> sum_tree::Dimension<'a, DiffTransformSummary>
7572 for OutputDimension<MBD>
7573{
7574 fn zero(_: ()) -> Self {
7575 OutputDimension(MBD::default())
7576 }
7577
7578 fn add_summary(&mut self, summary: &'a DiffTransformSummary, _: ()) {
7579 self.0.add_mb_text_summary(&summary.output)
7580 }
7581}
7582
7583impl MultiBufferRows<'_> {
7584 pub fn seek(&mut self, MultiBufferRow(row): MultiBufferRow) {
7585 self.point = Point::new(row, 0);
7586 self.cursor.seek(&self.point);
7587 }
7588}
7589
7590impl Iterator for MultiBufferRows<'_> {
7591 type Item = RowInfo;
7592
7593 fn next(&mut self) -> Option<Self::Item> {
7594 if self.is_empty && self.point.row == 0 {
7595 self.point += Point::new(1, 0);
7596 return Some(RowInfo {
7597 buffer_id: None,
7598 buffer_row: Some(0),
7599 base_text_row: Some(BaseTextRow(0)),
7600 multibuffer_row: Some(MultiBufferRow(0)),
7601 diff_status: None,
7602 expand_info: None,
7603 wrapped_buffer_row: None,
7604 });
7605 }
7606
7607 let mut region = self.cursor.region()?;
7608 while self.point >= region.range.end {
7609 self.cursor.next();
7610 if let Some(next_region) = self.cursor.region() {
7611 region = next_region;
7612 } else if self.point == self.cursor.diff_transforms.end().output_dimension.0 {
7613 let multibuffer_row = MultiBufferRow(self.point.row);
7614 let last_excerpt = self
7615 .cursor
7616 .excerpts
7617 .item()
7618 .or(self.cursor.excerpts.prev_item())?;
7619 let last_row = last_excerpt
7620 .range
7621 .context
7622 .end
7623 .to_point(&last_excerpt.buffer)
7624 .row;
7625 // TODO(split-diff) perf
7626 let base_text_row = self
7627 .cursor
7628 .snapshot
7629 .diffs
7630 .get(&last_excerpt.buffer_id)
7631 .map(|diff| diff.row_to_base_text_row(last_row, &last_excerpt.buffer))
7632 .map(BaseTextRow);
7633
7634 let first_row = last_excerpt
7635 .range
7636 .context
7637 .start
7638 .to_point(&last_excerpt.buffer)
7639 .row;
7640
7641 let expand_info = if self.is_singleton {
7642 None
7643 } else {
7644 let needs_expand_up = first_row == last_row
7645 && (last_row > 0)
7646 && !region.diff_hunk_status.is_some_and(|d| d.is_deleted())
7647 && !(region.is_filtered()
7648 && region
7649 .diff_base_byte_range
7650 .is_some_and(|range| !range.is_empty()));
7651 let needs_expand_down = last_row < last_excerpt.buffer.max_point().row;
7652
7653 if needs_expand_up && needs_expand_down {
7654 Some(ExpandExcerptDirection::UpAndDown)
7655 } else if needs_expand_up {
7656 Some(ExpandExcerptDirection::Up)
7657 } else if needs_expand_down {
7658 Some(ExpandExcerptDirection::Down)
7659 } else {
7660 None
7661 }
7662 .map(|direction| ExpandInfo {
7663 direction,
7664 excerpt_id: last_excerpt.id,
7665 })
7666 };
7667 self.point += Point::new(1, 0);
7668 return Some(RowInfo {
7669 buffer_id: Some(last_excerpt.buffer_id),
7670 buffer_row: Some(last_row),
7671 base_text_row,
7672 multibuffer_row: Some(multibuffer_row),
7673 diff_status: None,
7674 wrapped_buffer_row: None,
7675 expand_info,
7676 });
7677 } else {
7678 return None;
7679 };
7680 }
7681
7682 let overshoot = self.point - region.range.start;
7683 let buffer_point = region.buffer_range.start + overshoot;
7684 let diff_status = region
7685 .diff_hunk_status
7686 .filter(|_| self.point < region.range.end);
7687 let base_text_row = match diff_status {
7688 // TODO(split-diff) perf
7689 None => self
7690 .cursor
7691 .snapshot
7692 .diffs
7693 .get(®ion.excerpt.buffer_id)
7694 .map(|diff| diff.row_to_base_text_row(buffer_point.row, ®ion.buffer))
7695 .map(BaseTextRow),
7696 Some(DiffHunkStatus {
7697 kind: DiffHunkStatusKind::Added,
7698 ..
7699 }) => None,
7700 Some(DiffHunkStatus {
7701 kind: DiffHunkStatusKind::Deleted,
7702 ..
7703 }) => Some(BaseTextRow(buffer_point.row)),
7704 Some(DiffHunkStatus {
7705 kind: DiffHunkStatusKind::Modified,
7706 ..
7707 }) => unreachable!(),
7708 };
7709 let expand_info = if self.is_singleton {
7710 None
7711 } else {
7712 let needs_expand_up = self.point.row == region.range.start.row
7713 && self.cursor.is_at_start_of_excerpt()
7714 && buffer_point.row > 0;
7715 let needs_expand_down = (region.excerpt.has_trailing_newline
7716 && self.point.row + 1 == region.range.end.row
7717 || !region.excerpt.has_trailing_newline && self.point.row == region.range.end.row)
7718 && self.cursor.is_at_end_of_excerpt()
7719 && buffer_point.row < region.buffer.max_point().row;
7720
7721 if needs_expand_up && needs_expand_down {
7722 Some(ExpandExcerptDirection::UpAndDown)
7723 } else if needs_expand_up {
7724 Some(ExpandExcerptDirection::Up)
7725 } else if needs_expand_down {
7726 Some(ExpandExcerptDirection::Down)
7727 } else {
7728 None
7729 }
7730 .map(|direction| ExpandInfo {
7731 direction,
7732 excerpt_id: region.excerpt.id,
7733 })
7734 };
7735
7736 let result = Some(RowInfo {
7737 buffer_id: Some(region.buffer.remote_id()),
7738 buffer_row: Some(buffer_point.row),
7739 base_text_row,
7740 multibuffer_row: Some(MultiBufferRow(self.point.row)),
7741 diff_status,
7742 expand_info,
7743 wrapped_buffer_row: None,
7744 });
7745 self.point += Point::new(1, 0);
7746 result
7747 }
7748}
7749
7750impl<'a> MultiBufferChunks<'a> {
7751 pub fn offset(&self) -> MultiBufferOffset {
7752 self.range.start
7753 }
7754
7755 pub fn seek(&mut self, range: Range<MultiBufferOffset>) {
7756 self.diff_transforms.seek(&range.end, Bias::Right);
7757 let mut excerpt_end = self.diff_transforms.start().1;
7758 if self
7759 .diff_transforms
7760 .item()
7761 .is_some_and(|t| t.is_buffer_content())
7762 {
7763 let overshoot = range.end - self.diff_transforms.start().0;
7764 excerpt_end += overshoot;
7765 }
7766
7767 self.diff_transforms.seek(&range.start, Bias::Right);
7768 let mut excerpt_start = self.diff_transforms.start().1;
7769 if self
7770 .diff_transforms
7771 .item()
7772 .is_some_and(|t| t.is_buffer_content())
7773 {
7774 let overshoot = range.start - self.diff_transforms.start().0;
7775 excerpt_start += overshoot;
7776 }
7777
7778 self.seek_to_excerpt_offset_range(excerpt_start..excerpt_end);
7779 self.buffer_chunk.take();
7780 self.range = range;
7781 }
7782
7783 fn seek_to_excerpt_offset_range(&mut self, new_range: Range<ExcerptOffset>) {
7784 self.excerpt_offset_range = new_range.clone();
7785 self.excerpts.seek(&new_range.start, Bias::Right);
7786 if let Some(excerpt) = self.excerpts.item() {
7787 let excerpt_start = *self.excerpts.start();
7788 if let Some(excerpt_chunks) = self
7789 .excerpt_chunks
7790 .as_mut()
7791 .filter(|chunks| excerpt.id == chunks.excerpt_id)
7792 {
7793 excerpt.seek_chunks(
7794 excerpt_chunks,
7795 (self.excerpt_offset_range.start - excerpt_start)
7796 ..(self.excerpt_offset_range.end - excerpt_start),
7797 );
7798 } else {
7799 self.excerpt_chunks = Some(excerpt.chunks_in_range(
7800 (self.excerpt_offset_range.start - excerpt_start)
7801 ..(self.excerpt_offset_range.end - excerpt_start),
7802 self.language_aware,
7803 ));
7804 }
7805 } else {
7806 self.excerpt_chunks = None;
7807 }
7808 }
7809
7810 fn next_excerpt_chunk(&mut self) -> Option<Chunk<'a>> {
7811 loop {
7812 if self.excerpt_offset_range.is_empty() {
7813 return None;
7814 } else if let Some(chunk) = self.excerpt_chunks.as_mut()?.next() {
7815 self.excerpt_offset_range.start += chunk.text.len();
7816 return Some(chunk);
7817 } else {
7818 self.excerpts.next();
7819 let excerpt = self.excerpts.item()?;
7820 self.excerpt_chunks = Some(excerpt.chunks_in_range(
7821 0..(self.excerpt_offset_range.end - *self.excerpts.start()),
7822 self.language_aware,
7823 ));
7824 }
7825 }
7826 }
7827}
7828
7829impl<'a> Iterator for ReversedMultiBufferChunks<'a> {
7830 type Item = &'a str;
7831
7832 fn next(&mut self) -> Option<Self::Item> {
7833 let mut region = self.cursor.region()?;
7834 if self.offset == region.range.start {
7835 self.cursor.prev();
7836 while let Some(region) = self.cursor.region()
7837 && region.buffer_range.is_empty()
7838 && !region.has_trailing_newline
7839 {
7840 self.cursor.prev();
7841 }
7842 region = self.cursor.region()?;
7843 let start_overshoot = self.start.saturating_sub(region.range.start);
7844 self.current_chunks = Some(region.buffer.reversed_chunks_in_range(
7845 region.buffer_range.start + start_overshoot..region.buffer_range.end,
7846 ));
7847 }
7848
7849 if self.offset == region.range.end && region.has_trailing_newline {
7850 self.offset -= 1;
7851 Some("\n")
7852 } else {
7853 let chunk = self.current_chunks.as_mut().unwrap().next()?;
7854 self.offset -= chunk.len();
7855 Some(chunk)
7856 }
7857 }
7858}
7859
7860impl<'a> Iterator for MultiBufferChunks<'a> {
7861 type Item = Chunk<'a>;
7862
7863 fn next(&mut self) -> Option<Chunk<'a>> {
7864 if self.range.start >= self.range.end {
7865 return None;
7866 }
7867 if self.range.start == self.diff_transforms.end().0 {
7868 self.diff_transforms.next();
7869 }
7870 while let Some(DiffTransform::FilteredInsertedHunk { .. }) = self.diff_transforms.item() {
7871 self.diff_transforms.next();
7872 let mut range = self.excerpt_offset_range.clone();
7873 range.start = self.diff_transforms.start().1;
7874 self.seek_to_excerpt_offset_range(range);
7875 self.buffer_chunk.take();
7876 }
7877
7878 let diff_transform_start = self.diff_transforms.start().0;
7879 let diff_transform_end = self.diff_transforms.end().0;
7880 debug_assert!(
7881 self.range.start < diff_transform_end,
7882 "{:?} < {:?} of ({1:?}..{2:?})",
7883 self.range.start,
7884 diff_transform_end,
7885 diff_transform_start
7886 );
7887
7888 let diff_transform = self.diff_transforms.item()?;
7889 match diff_transform {
7890 DiffTransform::Unmodified { .. }
7891 | DiffTransform::InsertedHunk { .. }
7892 | DiffTransform::FilteredInsertedHunk { .. } => {
7893 let chunk = if let Some(chunk) = &mut self.buffer_chunk {
7894 chunk
7895 } else {
7896 let chunk = self.next_excerpt_chunk().unwrap();
7897 self.buffer_chunk.insert(chunk)
7898 };
7899
7900 let chunk_end = self.range.start + chunk.text.len();
7901 let diff_transform_end = diff_transform_end.min(self.range.end);
7902
7903 if diff_transform_end < chunk_end {
7904 let split_idx = diff_transform_end - self.range.start;
7905 let (before, after) = chunk.text.split_at(split_idx);
7906 self.range.start = diff_transform_end;
7907 let mask = 1u128.unbounded_shl(split_idx as u32).wrapping_sub(1);
7908 let chars = chunk.chars & mask;
7909 let tabs = chunk.tabs & mask;
7910
7911 chunk.text = after;
7912 chunk.chars = chunk.chars >> split_idx;
7913 chunk.tabs = chunk.tabs >> split_idx;
7914
7915 Some(Chunk {
7916 text: before,
7917 chars,
7918 tabs,
7919 ..chunk.clone()
7920 })
7921 } else {
7922 self.range.start = chunk_end;
7923 self.buffer_chunk.take()
7924 }
7925 }
7926 DiffTransform::DeletedHunk {
7927 buffer_id,
7928 hunk_info,
7929 has_trailing_newline,
7930 ..
7931 } => {
7932 let base_text_start = hunk_info.base_text_byte_range.start
7933 + (self.range.start - diff_transform_start);
7934 let base_text_end =
7935 hunk_info.base_text_byte_range.start + (self.range.end - diff_transform_start);
7936 let base_text_end = base_text_end.min(hunk_info.base_text_byte_range.end);
7937
7938 let mut chunks = if let Some((_, mut chunks)) = self
7939 .diff_base_chunks
7940 .take()
7941 .filter(|(id, _)| id == buffer_id)
7942 {
7943 if chunks.range().start != base_text_start || chunks.range().end < base_text_end
7944 {
7945 chunks.seek(base_text_start..base_text_end);
7946 }
7947 chunks
7948 } else {
7949 let base_buffer = &self.diffs.get(buffer_id)?.base_text();
7950 base_buffer.chunks(base_text_start..base_text_end, self.language_aware)
7951 };
7952
7953 let chunk = if let Some(chunk) = chunks.next() {
7954 self.range.start += chunk.text.len();
7955 self.diff_base_chunks = Some((*buffer_id, chunks));
7956 chunk
7957 } else {
7958 debug_assert!(has_trailing_newline);
7959 self.range.start += "\n".len();
7960 Chunk {
7961 text: "\n",
7962 chars: 1u128,
7963 ..Default::default()
7964 }
7965 };
7966 Some(chunk)
7967 }
7968 }
7969 }
7970}
7971
7972impl MultiBufferBytes<'_> {
7973 fn consume(&mut self, len: usize) {
7974 self.range.start += len;
7975 self.chunk = &self.chunk[len..];
7976
7977 if !self.range.is_empty() && self.chunk.is_empty() {
7978 if let Some(chunk) = self.excerpt_bytes.as_mut().and_then(|bytes| bytes.next()) {
7979 self.chunk = chunk;
7980 } else if self.has_trailing_newline {
7981 self.has_trailing_newline = false;
7982 self.chunk = b"\n";
7983 } else {
7984 self.cursor.next();
7985 while let Some(region) = self.cursor.region()
7986 && region.buffer_range.is_empty()
7987 && !region.has_trailing_newline
7988 {
7989 self.cursor.next();
7990 }
7991 if let Some(region) = self.cursor.region() {
7992 let mut excerpt_bytes = region.buffer.bytes_in_range(
7993 region.buffer_range.start
7994 ..(region.buffer_range.start + (self.range.end - region.range.start))
7995 .min(region.buffer_range.end),
7996 );
7997 self.chunk = excerpt_bytes.next().unwrap_or(&[]);
7998 self.excerpt_bytes = Some(excerpt_bytes);
7999 self.has_trailing_newline =
8000 region.has_trailing_newline && self.range.end >= region.range.end;
8001 if self.chunk.is_empty() && self.has_trailing_newline {
8002 self.has_trailing_newline = false;
8003 self.chunk = b"\n";
8004 }
8005 }
8006 }
8007 }
8008 }
8009}
8010
8011impl<'a> Iterator for MultiBufferBytes<'a> {
8012 type Item = &'a [u8];
8013
8014 fn next(&mut self) -> Option<Self::Item> {
8015 let chunk = self.chunk;
8016 if chunk.is_empty() {
8017 None
8018 } else {
8019 self.consume(chunk.len());
8020 Some(chunk)
8021 }
8022 }
8023}
8024
8025impl io::Read for MultiBufferBytes<'_> {
8026 fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
8027 let len = cmp::min(buf.len(), self.chunk.len());
8028 buf[..len].copy_from_slice(&self.chunk[..len]);
8029 if len > 0 {
8030 self.consume(len);
8031 }
8032 Ok(len)
8033 }
8034}
8035
8036impl io::Read for ReversedMultiBufferBytes<'_> {
8037 fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
8038 let len = cmp::min(buf.len(), self.chunk.len());
8039 buf[..len].copy_from_slice(&self.chunk[..len]);
8040 buf[..len].reverse();
8041 if len > 0 {
8042 self.range.end -= len;
8043 self.chunk = &self.chunk[..self.chunk.len() - len];
8044 if !self.range.is_empty()
8045 && self.chunk.is_empty()
8046 && let Some(chunk) = self.chunks.next()
8047 {
8048 self.chunk = chunk.as_bytes();
8049 }
8050 }
8051 Ok(len)
8052 }
8053}
8054
8055impl<'a> Iterator for ExcerptChunks<'a> {
8056 type Item = Chunk<'a>;
8057
8058 fn next(&mut self) -> Option<Self::Item> {
8059 if let Some(chunk) = self.content_chunks.next() {
8060 return Some(chunk);
8061 }
8062
8063 if self.has_footer {
8064 let text = "\n";
8065 let chars = 0b1;
8066 self.has_footer = false;
8067 return Some(Chunk {
8068 text,
8069 chars,
8070 ..Default::default()
8071 });
8072 }
8073
8074 None
8075 }
8076}
8077
8078impl ToOffset for Point {
8079 fn to_offset<'a>(&self, snapshot: &MultiBufferSnapshot) -> MultiBufferOffset {
8080 snapshot.point_to_offset(*self)
8081 }
8082 fn to_offset_utf16(&self, snapshot: &MultiBufferSnapshot) -> MultiBufferOffsetUtf16 {
8083 snapshot.point_to_offset_utf16(*self)
8084 }
8085}
8086
8087impl ToOffset for MultiBufferOffset {
8088 #[track_caller]
8089 fn to_offset<'a>(&self, snapshot: &MultiBufferSnapshot) -> MultiBufferOffset {
8090 assert!(
8091 *self <= snapshot.len(),
8092 "offset {} is greater than the snapshot.len() {}",
8093 self.0,
8094 snapshot.len().0,
8095 );
8096 *self
8097 }
8098 fn to_offset_utf16(&self, snapshot: &MultiBufferSnapshot) -> MultiBufferOffsetUtf16 {
8099 snapshot.offset_to_offset_utf16(*self)
8100 }
8101}
8102
8103impl ToOffset for MultiBufferOffsetUtf16 {
8104 fn to_offset<'a>(&self, snapshot: &MultiBufferSnapshot) -> MultiBufferOffset {
8105 snapshot.offset_utf16_to_offset(*self)
8106 }
8107
8108 fn to_offset_utf16(&self, _snapshot: &MultiBufferSnapshot) -> MultiBufferOffsetUtf16 {
8109 *self
8110 }
8111}
8112
8113impl ToOffset for PointUtf16 {
8114 fn to_offset<'a>(&self, snapshot: &MultiBufferSnapshot) -> MultiBufferOffset {
8115 snapshot.point_utf16_to_offset(*self)
8116 }
8117 fn to_offset_utf16(&self, snapshot: &MultiBufferSnapshot) -> MultiBufferOffsetUtf16 {
8118 snapshot.point_utf16_to_offset_utf16(*self)
8119 }
8120}
8121
8122impl ToPoint for MultiBufferOffset {
8123 fn to_point<'a>(&self, snapshot: &MultiBufferSnapshot) -> Point {
8124 snapshot.offset_to_point(*self)
8125 }
8126 fn to_point_utf16<'a>(&self, snapshot: &MultiBufferSnapshot) -> PointUtf16 {
8127 snapshot.offset_to_point_utf16(*self)
8128 }
8129}
8130
8131impl ToPoint for Point {
8132 fn to_point<'a>(&self, _: &MultiBufferSnapshot) -> Point {
8133 *self
8134 }
8135 fn to_point_utf16<'a>(&self, snapshot: &MultiBufferSnapshot) -> PointUtf16 {
8136 snapshot.point_to_point_utf16(*self)
8137 }
8138}
8139
8140impl ToPoint for PointUtf16 {
8141 fn to_point<'a>(&self, snapshot: &MultiBufferSnapshot) -> Point {
8142 snapshot.point_utf16_to_point(*self)
8143 }
8144 fn to_point_utf16<'a>(&self, _: &MultiBufferSnapshot) -> PointUtf16 {
8145 *self
8146 }
8147}
8148
8149impl From<ExcerptId> for EntityId {
8150 fn from(id: ExcerptId) -> Self {
8151 EntityId::from(id.0 as u64)
8152 }
8153}
8154
8155#[cfg(debug_assertions)]
8156pub mod debug {
8157 use super::*;
8158
8159 pub trait ToMultiBufferDebugRanges {
8160 fn to_multi_buffer_debug_ranges(
8161 &self,
8162 snapshot: &MultiBufferSnapshot,
8163 ) -> Vec<Range<MultiBufferOffset>>;
8164 }
8165
8166 impl<T: ToOffset> ToMultiBufferDebugRanges for T {
8167 fn to_multi_buffer_debug_ranges(
8168 &self,
8169 snapshot: &MultiBufferSnapshot,
8170 ) -> Vec<Range<MultiBufferOffset>> {
8171 [self.to_offset(snapshot)].to_multi_buffer_debug_ranges(snapshot)
8172 }
8173 }
8174
8175 impl<T: ToOffset> ToMultiBufferDebugRanges for Range<T> {
8176 fn to_multi_buffer_debug_ranges(
8177 &self,
8178 snapshot: &MultiBufferSnapshot,
8179 ) -> Vec<Range<MultiBufferOffset>> {
8180 [self.start.to_offset(snapshot)..self.end.to_offset(snapshot)]
8181 .to_multi_buffer_debug_ranges(snapshot)
8182 }
8183 }
8184
8185 impl<T: ToOffset> ToMultiBufferDebugRanges for Vec<T> {
8186 fn to_multi_buffer_debug_ranges(
8187 &self,
8188 snapshot: &MultiBufferSnapshot,
8189 ) -> Vec<Range<MultiBufferOffset>> {
8190 self.as_slice().to_multi_buffer_debug_ranges(snapshot)
8191 }
8192 }
8193
8194 impl<T: ToOffset> ToMultiBufferDebugRanges for Vec<Range<T>> {
8195 fn to_multi_buffer_debug_ranges(
8196 &self,
8197 snapshot: &MultiBufferSnapshot,
8198 ) -> Vec<Range<MultiBufferOffset>> {
8199 self.as_slice().to_multi_buffer_debug_ranges(snapshot)
8200 }
8201 }
8202
8203 impl<T: ToOffset> ToMultiBufferDebugRanges for [T] {
8204 fn to_multi_buffer_debug_ranges(
8205 &self,
8206 snapshot: &MultiBufferSnapshot,
8207 ) -> Vec<Range<MultiBufferOffset>> {
8208 self.iter()
8209 .map(|item| {
8210 let offset = item.to_offset(snapshot);
8211 offset..offset
8212 })
8213 .collect()
8214 }
8215 }
8216
8217 impl<T: ToOffset> ToMultiBufferDebugRanges for [Range<T>] {
8218 fn to_multi_buffer_debug_ranges(
8219 &self,
8220 snapshot: &MultiBufferSnapshot,
8221 ) -> Vec<Range<MultiBufferOffset>> {
8222 self.iter()
8223 .map(|range| range.start.to_offset(snapshot)..range.end.to_offset(snapshot))
8224 .collect()
8225 }
8226 }
8227}