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