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