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