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