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