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