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