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