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