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