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