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