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