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