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