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