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