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