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