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