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