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