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