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