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