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