1mod anchor;
2
3pub use anchor::{Anchor, AnchorRangeExt, Offset};
4use anyhow::{anyhow, Result};
5use clock::ReplicaId;
6use collections::{BTreeMap, Bound, HashMap, HashSet};
7use futures::{channel::mpsc, SinkExt};
8use git::diff::DiffHunk;
9use gpui::{AppContext, EventEmitter, Model, ModelContext};
10use language::{
11 char_kind,
12 language_settings::{language_settings, LanguageSettings},
13 AutoindentMode, Buffer, BufferChunks, BufferSnapshot, Capability, CharKind, Chunk, CursorShape,
14 DiagnosticEntry, File, IndentSize, Language, LanguageScope, OffsetRangeExt, OffsetUtf16,
15 Outline, OutlineItem, Point, PointUtf16, Selection, TextDimension, ToOffset as _,
16 ToOffsetUtf16 as _, ToPoint as _, ToPointUtf16 as _, TransactionId, Unclipped,
17};
18use std::{
19 borrow::Cow,
20 cell::{Ref, RefCell},
21 cmp, fmt,
22 future::Future,
23 io,
24 iter::{self, FromIterator},
25 mem,
26 ops::{Range, RangeBounds, Sub},
27 str,
28 sync::Arc,
29 time::{Duration, Instant},
30};
31use sum_tree::{Bias, Cursor, SumTree};
32use text::{
33 locator::Locator,
34 subscription::{Subscription, Topic},
35 BufferId, Edit, TextSummary,
36};
37use theme::SyntaxTheme;
38
39use util::post_inc;
40
41#[cfg(any(test, feature = "test-support"))]
42use gpui::Context;
43
44const NEWLINES: &[u8] = &[b'\n'; u8::MAX as usize];
45
46#[derive(Debug, Default, Clone, Copy, Hash, PartialEq, Eq, PartialOrd, Ord)]
47pub struct ExcerptId(usize);
48
49/// One or more [`Buffers`](Buffer) being edited in a single view.
50///
51/// See <https://zed.dev/features#multi-buffers>
52pub struct MultiBuffer {
53 /// A snapshot of the [`Excerpt`]s in the MultiBuffer.
54 /// Use [`MultiBuffer::snapshot`] to get a up-to-date snapshot.
55 snapshot: RefCell<MultiBufferSnapshot>,
56 /// Contains the state of the buffers being edited
57 buffers: RefCell<HashMap<BufferId, BufferState>>,
58 subscriptions: Topic,
59 /// If true, the multi-buffer only contains a single [`Buffer`] and a single [`Excerpt`]
60 singleton: bool,
61 replica_id: ReplicaId,
62 history: History,
63 title: Option<String>,
64 capability: Capability,
65}
66
67#[derive(Clone, Debug, PartialEq, Eq)]
68pub enum Event {
69 ExcerptsAdded {
70 buffer: Model<Buffer>,
71 predecessor: ExcerptId,
72 excerpts: Vec<(ExcerptId, ExcerptRange<language::Anchor>)>,
73 },
74 ExcerptsRemoved {
75 ids: Vec<ExcerptId>,
76 },
77 ExcerptsEdited {
78 ids: Vec<ExcerptId>,
79 },
80 Edited {
81 singleton_buffer_edited: bool,
82 },
83 TransactionUndone {
84 transaction_id: TransactionId,
85 },
86 Reloaded,
87 DiffBaseChanged,
88 LanguageChanged,
89 CapabilityChanged,
90 Reparsed,
91 Saved,
92 FileHandleChanged,
93 Closed,
94 DirtyChanged,
95 DiagnosticsUpdated,
96}
97
98#[derive(Clone)]
99struct History {
100 next_transaction_id: TransactionId,
101 undo_stack: Vec<Transaction>,
102 redo_stack: Vec<Transaction>,
103 transaction_depth: usize,
104 group_interval: Duration,
105}
106
107#[derive(Clone)]
108struct Transaction {
109 id: TransactionId,
110 buffer_transactions: HashMap<BufferId, text::TransactionId>,
111 first_edit_at: Instant,
112 last_edit_at: Instant,
113 suppress_grouping: bool,
114}
115
116pub trait ToOffset: 'static + fmt::Debug {
117 fn to_offset(&self, snapshot: &MultiBufferSnapshot) -> usize;
118}
119
120pub trait ToOffsetUtf16: 'static + fmt::Debug {
121 fn to_offset_utf16(&self, snapshot: &MultiBufferSnapshot) -> OffsetUtf16;
122}
123
124pub trait ToPoint: 'static + fmt::Debug {
125 fn to_point(&self, snapshot: &MultiBufferSnapshot) -> Point;
126}
127
128pub trait ToPointUtf16: 'static + fmt::Debug {
129 fn to_point_utf16(&self, snapshot: &MultiBufferSnapshot) -> PointUtf16;
130}
131
132struct BufferState {
133 buffer: Model<Buffer>,
134 last_version: clock::Global,
135 last_parse_count: usize,
136 last_selections_update_count: usize,
137 last_diagnostics_update_count: usize,
138 last_file_update_count: usize,
139 last_git_diff_update_count: usize,
140 excerpts: Vec<Locator>,
141 _subscriptions: [gpui::Subscription; 2],
142}
143
144/// The contents of a [`MultiBuffer`] at a single point in time.
145#[derive(Clone, Default)]
146pub struct MultiBufferSnapshot {
147 singleton: bool,
148 excerpts: SumTree<Excerpt>,
149 excerpt_ids: SumTree<ExcerptIdMapping>,
150 parse_count: usize,
151 diagnostics_update_count: usize,
152 trailing_excerpt_update_count: usize,
153 git_diff_update_count: usize,
154 edit_count: usize,
155 is_dirty: bool,
156 has_conflict: bool,
157}
158
159/// A boundary between [`Excerpt`]s in a [`MultiBuffer`]
160pub struct ExcerptBoundary {
161 pub id: ExcerptId,
162 /// The row in the `MultiBuffer` where the boundary is located
163 pub row: u32,
164 pub buffer: BufferSnapshot,
165 pub range: ExcerptRange<text::Anchor>,
166 /// It's possible to have multiple excerpts in the same buffer,
167 /// and they are rendered together without a new File header.
168 ///
169 /// This flag indicates that the excerpt is the first one in the buffer.
170 pub starts_new_buffer: bool,
171}
172
173/// A slice into a [`Buffer`] that is being edited in a [`MultiBuffer`].
174#[derive(Clone)]
175struct Excerpt {
176 /// The unique identifier for this excerpt
177 id: ExcerptId,
178 /// The location of the excerpt in the [`MultiBuffer`]
179 locator: Locator,
180 /// The buffer being excerpted
181 buffer_id: BufferId,
182 /// A snapshot of the buffer being excerpted
183 buffer: BufferSnapshot,
184 /// The range of the buffer to be shown in the excerpt
185 range: ExcerptRange<text::Anchor>,
186 /// The last row in the excerpted slice of the buffer
187 max_buffer_row: u32,
188 /// A summary of the text in the excerpt
189 text_summary: TextSummary,
190 has_trailing_newline: bool,
191}
192
193/// A public view into an [`Excerpt`] in a [`MultiBuffer`].
194///
195/// Contains methods for getting the [`Buffer`] of the excerpt,
196/// as well as mapping offsets to/from buffer and multibuffer coordinates.
197#[derive(Clone)]
198pub struct MultiBufferExcerpt<'a> {
199 excerpt: &'a Excerpt,
200 excerpt_offset: usize,
201}
202
203#[derive(Clone, Debug)]
204struct ExcerptIdMapping {
205 id: ExcerptId,
206 locator: Locator,
207}
208
209/// A range of text from a single [`Buffer`], to be shown as an [`Excerpt`].
210/// These ranges are relative to the buffer itself
211#[derive(Clone, Debug, Eq, PartialEq)]
212pub struct ExcerptRange<T> {
213 /// The full range of text to be shown in the excerpt.
214 pub context: Range<T>,
215 /// The primary range of text to be highlighted in the excerpt.
216 /// In a multi-buffer search, this would be the text that matched the search
217 pub primary: Option<Range<T>>,
218}
219
220#[derive(Clone, Debug, Default)]
221struct ExcerptSummary {
222 excerpt_id: ExcerptId,
223 /// The location of the last [`Excerpt`] being summarized
224 excerpt_locator: Locator,
225 /// The maximum row of the [`Excerpt`]s being summarized
226 max_buffer_row: u32,
227 text: TextSummary,
228}
229
230#[derive(Clone)]
231pub struct MultiBufferRows<'a> {
232 buffer_row_range: Range<u32>,
233 excerpts: Cursor<'a, Excerpt, Point>,
234}
235
236pub struct MultiBufferChunks<'a> {
237 range: Range<usize>,
238 excerpts: Cursor<'a, Excerpt, usize>,
239 excerpt_chunks: Option<ExcerptChunks<'a>>,
240 language_aware: bool,
241}
242
243pub struct MultiBufferBytes<'a> {
244 range: Range<usize>,
245 excerpts: Cursor<'a, Excerpt, usize>,
246 excerpt_bytes: Option<ExcerptBytes<'a>>,
247 chunk: &'a [u8],
248}
249
250pub struct ReversedMultiBufferBytes<'a> {
251 range: Range<usize>,
252 excerpts: Cursor<'a, Excerpt, usize>,
253 excerpt_bytes: Option<ExcerptBytes<'a>>,
254 chunk: &'a [u8],
255}
256
257struct ExcerptChunks<'a> {
258 content_chunks: BufferChunks<'a>,
259 footer_height: usize,
260}
261
262struct ExcerptBytes<'a> {
263 content_bytes: text::Bytes<'a>,
264 padding_height: usize,
265 reversed: bool,
266}
267
268impl MultiBuffer {
269 pub fn new(replica_id: ReplicaId, capability: Capability) -> Self {
270 Self {
271 snapshot: Default::default(),
272 buffers: Default::default(),
273 subscriptions: Default::default(),
274 singleton: false,
275 capability,
276 replica_id,
277 history: History {
278 next_transaction_id: Default::default(),
279 undo_stack: Default::default(),
280 redo_stack: Default::default(),
281 transaction_depth: 0,
282 group_interval: Duration::from_millis(300),
283 },
284 title: Default::default(),
285 }
286 }
287
288 pub fn clone(&self, new_cx: &mut ModelContext<Self>) -> Self {
289 let mut buffers = HashMap::default();
290 for (buffer_id, buffer_state) in self.buffers.borrow().iter() {
291 buffers.insert(
292 *buffer_id,
293 BufferState {
294 buffer: buffer_state.buffer.clone(),
295 last_version: buffer_state.last_version.clone(),
296 last_parse_count: buffer_state.last_parse_count,
297 last_selections_update_count: buffer_state.last_selections_update_count,
298 last_diagnostics_update_count: buffer_state.last_diagnostics_update_count,
299 last_file_update_count: buffer_state.last_file_update_count,
300 last_git_diff_update_count: buffer_state.last_git_diff_update_count,
301 excerpts: buffer_state.excerpts.clone(),
302 _subscriptions: [
303 new_cx.observe(&buffer_state.buffer, |_, _, cx| cx.notify()),
304 new_cx.subscribe(&buffer_state.buffer, Self::on_buffer_event),
305 ],
306 },
307 );
308 }
309 Self {
310 snapshot: RefCell::new(self.snapshot.borrow().clone()),
311 buffers: RefCell::new(buffers),
312 subscriptions: Default::default(),
313 singleton: self.singleton,
314 capability: self.capability,
315 replica_id: self.replica_id,
316 history: self.history.clone(),
317 title: self.title.clone(),
318 }
319 }
320
321 pub fn with_title(mut self, title: String) -> Self {
322 self.title = Some(title);
323 self
324 }
325
326 pub fn read_only(&self) -> bool {
327 self.capability == Capability::ReadOnly
328 }
329
330 pub fn singleton(buffer: Model<Buffer>, cx: &mut ModelContext<Self>) -> Self {
331 let mut this = Self::new(buffer.read(cx).replica_id(), buffer.read(cx).capability());
332 this.singleton = true;
333 this.push_excerpts(
334 buffer,
335 [ExcerptRange {
336 context: text::Anchor::MIN..text::Anchor::MAX,
337 primary: None,
338 }],
339 cx,
340 );
341 this.snapshot.borrow_mut().singleton = true;
342 this
343 }
344
345 pub fn replica_id(&self) -> ReplicaId {
346 self.replica_id
347 }
348
349 /// Returns an up-to-date snapshot of the MultiBuffer.
350 pub fn snapshot(&self, cx: &AppContext) -> MultiBufferSnapshot {
351 self.sync(cx);
352 self.snapshot.borrow().clone()
353 }
354
355 pub fn read(&self, cx: &AppContext) -> Ref<MultiBufferSnapshot> {
356 self.sync(cx);
357 self.snapshot.borrow()
358 }
359
360 pub fn as_singleton(&self) -> Option<Model<Buffer>> {
361 if self.singleton {
362 return Some(
363 self.buffers
364 .borrow()
365 .values()
366 .next()
367 .unwrap()
368 .buffer
369 .clone(),
370 );
371 } else {
372 None
373 }
374 }
375
376 pub fn is_singleton(&self) -> bool {
377 self.singleton
378 }
379
380 pub fn subscribe(&mut self) -> Subscription {
381 self.subscriptions.subscribe()
382 }
383
384 pub fn is_dirty(&self, cx: &AppContext) -> bool {
385 self.read(cx).is_dirty()
386 }
387
388 pub fn has_conflict(&self, cx: &AppContext) -> bool {
389 self.read(cx).has_conflict()
390 }
391
392 // The `is_empty` signature doesn't match what clippy expects
393 #[allow(clippy::len_without_is_empty)]
394 pub fn len(&self, cx: &AppContext) -> usize {
395 self.read(cx).len()
396 }
397
398 pub fn is_empty(&self, cx: &AppContext) -> bool {
399 self.len(cx) != 0
400 }
401
402 pub fn symbols_containing<T: ToOffset>(
403 &self,
404 offset: T,
405 theme: Option<&SyntaxTheme>,
406 cx: &AppContext,
407 ) -> Option<(BufferId, Vec<OutlineItem<Anchor>>)> {
408 self.read(cx).symbols_containing(offset, theme)
409 }
410
411 pub fn edit<I, S, T>(
412 &mut self,
413 edits: I,
414 mut autoindent_mode: Option<AutoindentMode>,
415 cx: &mut ModelContext<Self>,
416 ) where
417 I: IntoIterator<Item = (Range<S>, T)>,
418 S: ToOffset,
419 T: Into<Arc<str>>,
420 {
421 if self.buffers.borrow().is_empty() {
422 return;
423 }
424
425 let snapshot = self.read(cx);
426 let edits = edits.into_iter().map(|(range, new_text)| {
427 let mut range = range.start.to_offset(&snapshot)..range.end.to_offset(&snapshot);
428 if range.start > range.end {
429 mem::swap(&mut range.start, &mut range.end);
430 }
431 (range, new_text)
432 });
433
434 if let Some(buffer) = self.as_singleton() {
435 return buffer.update(cx, |buffer, cx| {
436 buffer.edit(edits, autoindent_mode, cx);
437 });
438 }
439
440 let original_indent_columns = match &mut autoindent_mode {
441 Some(AutoindentMode::Block {
442 original_indent_columns,
443 }) => mem::take(original_indent_columns),
444 _ => Default::default(),
445 };
446
447 struct BufferEdit {
448 range: Range<usize>,
449 new_text: Arc<str>,
450 is_insertion: bool,
451 original_indent_column: u32,
452 }
453 let mut buffer_edits: HashMap<BufferId, Vec<BufferEdit>> = Default::default();
454 let mut edited_excerpt_ids = Vec::new();
455 let mut cursor = snapshot.excerpts.cursor::<usize>();
456 for (ix, (range, new_text)) in edits.enumerate() {
457 let new_text: Arc<str> = new_text.into();
458 let original_indent_column = original_indent_columns.get(ix).copied().unwrap_or(0);
459 cursor.seek(&range.start, Bias::Right, &());
460 if cursor.item().is_none() && range.start == *cursor.start() {
461 cursor.prev(&());
462 }
463 let start_excerpt = cursor.item().expect("start offset out of bounds");
464 let start_overshoot = range.start - cursor.start();
465 let buffer_start = start_excerpt
466 .range
467 .context
468 .start
469 .to_offset(&start_excerpt.buffer)
470 + start_overshoot;
471 edited_excerpt_ids.push(start_excerpt.id);
472
473 cursor.seek(&range.end, Bias::Right, &());
474 if cursor.item().is_none() && range.end == *cursor.start() {
475 cursor.prev(&());
476 }
477 let end_excerpt = cursor.item().expect("end offset out of bounds");
478 let end_overshoot = range.end - cursor.start();
479 let buffer_end = end_excerpt
480 .range
481 .context
482 .start
483 .to_offset(&end_excerpt.buffer)
484 + end_overshoot;
485
486 if start_excerpt.id == end_excerpt.id {
487 buffer_edits
488 .entry(start_excerpt.buffer_id)
489 .or_insert(Vec::new())
490 .push(BufferEdit {
491 range: buffer_start..buffer_end,
492 new_text,
493 is_insertion: true,
494 original_indent_column,
495 });
496 } else {
497 edited_excerpt_ids.push(end_excerpt.id);
498 let start_excerpt_range = buffer_start
499 ..start_excerpt
500 .range
501 .context
502 .end
503 .to_offset(&start_excerpt.buffer);
504 let end_excerpt_range = end_excerpt
505 .range
506 .context
507 .start
508 .to_offset(&end_excerpt.buffer)
509 ..buffer_end;
510 buffer_edits
511 .entry(start_excerpt.buffer_id)
512 .or_insert(Vec::new())
513 .push(BufferEdit {
514 range: start_excerpt_range,
515 new_text: new_text.clone(),
516 is_insertion: true,
517 original_indent_column,
518 });
519 buffer_edits
520 .entry(end_excerpt.buffer_id)
521 .or_insert(Vec::new())
522 .push(BufferEdit {
523 range: end_excerpt_range,
524 new_text: new_text.clone(),
525 is_insertion: false,
526 original_indent_column,
527 });
528
529 cursor.seek(&range.start, Bias::Right, &());
530 cursor.next(&());
531 while let Some(excerpt) = cursor.item() {
532 if excerpt.id == end_excerpt.id {
533 break;
534 }
535 buffer_edits
536 .entry(excerpt.buffer_id)
537 .or_insert(Vec::new())
538 .push(BufferEdit {
539 range: excerpt.range.context.to_offset(&excerpt.buffer),
540 new_text: new_text.clone(),
541 is_insertion: false,
542 original_indent_column,
543 });
544 edited_excerpt_ids.push(excerpt.id);
545 cursor.next(&());
546 }
547 }
548 }
549
550 drop(cursor);
551 drop(snapshot);
552 // Non-generic part of edit, hoisted out to avoid blowing up LLVM IR.
553 fn tail(
554 this: &mut MultiBuffer,
555 buffer_edits: HashMap<BufferId, Vec<BufferEdit>>,
556 autoindent_mode: Option<AutoindentMode>,
557 edited_excerpt_ids: Vec<ExcerptId>,
558 cx: &mut ModelContext<MultiBuffer>,
559 ) {
560 for (buffer_id, mut edits) in buffer_edits {
561 edits.sort_unstable_by_key(|edit| edit.range.start);
562 this.buffers.borrow()[&buffer_id]
563 .buffer
564 .update(cx, |buffer, cx| {
565 let mut edits = edits.into_iter().peekable();
566 let mut insertions = Vec::new();
567 let mut original_indent_columns = Vec::new();
568 let mut deletions = Vec::new();
569 let empty_str: Arc<str> = "".into();
570 while let Some(BufferEdit {
571 mut range,
572 new_text,
573 mut is_insertion,
574 original_indent_column,
575 }) = edits.next()
576 {
577 while let Some(BufferEdit {
578 range: next_range,
579 is_insertion: next_is_insertion,
580 ..
581 }) = edits.peek()
582 {
583 if range.end >= next_range.start {
584 range.end = cmp::max(next_range.end, range.end);
585 is_insertion |= *next_is_insertion;
586 edits.next();
587 } else {
588 break;
589 }
590 }
591
592 if is_insertion {
593 original_indent_columns.push(original_indent_column);
594 insertions.push((
595 buffer.anchor_before(range.start)
596 ..buffer.anchor_before(range.end),
597 new_text.clone(),
598 ));
599 } else if !range.is_empty() {
600 deletions.push((
601 buffer.anchor_before(range.start)
602 ..buffer.anchor_before(range.end),
603 empty_str.clone(),
604 ));
605 }
606 }
607
608 let deletion_autoindent_mode =
609 if let Some(AutoindentMode::Block { .. }) = autoindent_mode {
610 Some(AutoindentMode::Block {
611 original_indent_columns: Default::default(),
612 })
613 } else {
614 None
615 };
616 let insertion_autoindent_mode =
617 if let Some(AutoindentMode::Block { .. }) = autoindent_mode {
618 Some(AutoindentMode::Block {
619 original_indent_columns,
620 })
621 } else {
622 None
623 };
624
625 buffer.edit(deletions, deletion_autoindent_mode, cx);
626 buffer.edit(insertions, insertion_autoindent_mode, cx);
627 })
628 }
629
630 cx.emit(Event::ExcerptsEdited {
631 ids: edited_excerpt_ids,
632 });
633 }
634 tail(self, buffer_edits, autoindent_mode, edited_excerpt_ids, cx);
635 }
636
637 pub fn start_transaction(&mut self, cx: &mut ModelContext<Self>) -> Option<TransactionId> {
638 self.start_transaction_at(Instant::now(), cx)
639 }
640
641 pub fn start_transaction_at(
642 &mut self,
643 now: Instant,
644 cx: &mut ModelContext<Self>,
645 ) -> Option<TransactionId> {
646 if let Some(buffer) = self.as_singleton() {
647 return buffer.update(cx, |buffer, _| buffer.start_transaction_at(now));
648 }
649
650 for BufferState { buffer, .. } in self.buffers.borrow().values() {
651 buffer.update(cx, |buffer, _| buffer.start_transaction_at(now));
652 }
653 self.history.start_transaction(now)
654 }
655
656 pub fn end_transaction(&mut self, cx: &mut ModelContext<Self>) -> Option<TransactionId> {
657 self.end_transaction_at(Instant::now(), cx)
658 }
659
660 pub fn end_transaction_at(
661 &mut self,
662 now: Instant,
663 cx: &mut ModelContext<Self>,
664 ) -> Option<TransactionId> {
665 if let Some(buffer) = self.as_singleton() {
666 return buffer.update(cx, |buffer, cx| buffer.end_transaction_at(now, cx));
667 }
668
669 let mut buffer_transactions = HashMap::default();
670 for BufferState { buffer, .. } in self.buffers.borrow().values() {
671 if let Some(transaction_id) =
672 buffer.update(cx, |buffer, cx| buffer.end_transaction_at(now, cx))
673 {
674 buffer_transactions.insert(buffer.read(cx).remote_id(), transaction_id);
675 }
676 }
677
678 if self.history.end_transaction(now, buffer_transactions) {
679 let transaction_id = self.history.group().unwrap();
680 Some(transaction_id)
681 } else {
682 None
683 }
684 }
685
686 pub fn merge_transactions(
687 &mut self,
688 transaction: TransactionId,
689 destination: TransactionId,
690 cx: &mut ModelContext<Self>,
691 ) {
692 if let Some(buffer) = self.as_singleton() {
693 buffer.update(cx, |buffer, _| {
694 buffer.merge_transactions(transaction, destination)
695 });
696 } else {
697 if let Some(transaction) = self.history.forget(transaction) {
698 if let Some(destination) = self.history.transaction_mut(destination) {
699 for (buffer_id, buffer_transaction_id) in transaction.buffer_transactions {
700 if let Some(destination_buffer_transaction_id) =
701 destination.buffer_transactions.get(&buffer_id)
702 {
703 if let Some(state) = self.buffers.borrow().get(&buffer_id) {
704 state.buffer.update(cx, |buffer, _| {
705 buffer.merge_transactions(
706 buffer_transaction_id,
707 *destination_buffer_transaction_id,
708 )
709 });
710 }
711 } else {
712 destination
713 .buffer_transactions
714 .insert(buffer_id, buffer_transaction_id);
715 }
716 }
717 }
718 }
719 }
720 }
721
722 pub fn finalize_last_transaction(&mut self, cx: &mut ModelContext<Self>) {
723 self.history.finalize_last_transaction();
724 for BufferState { buffer, .. } in self.buffers.borrow().values() {
725 buffer.update(cx, |buffer, _| {
726 buffer.finalize_last_transaction();
727 });
728 }
729 }
730
731 pub fn push_transaction<'a, T>(&mut self, buffer_transactions: T, cx: &mut ModelContext<Self>)
732 where
733 T: IntoIterator<Item = (&'a Model<Buffer>, &'a language::Transaction)>,
734 {
735 self.history
736 .push_transaction(buffer_transactions, Instant::now(), cx);
737 self.history.finalize_last_transaction();
738 }
739
740 pub fn group_until_transaction(
741 &mut self,
742 transaction_id: TransactionId,
743 cx: &mut ModelContext<Self>,
744 ) {
745 if let Some(buffer) = self.as_singleton() {
746 buffer.update(cx, |buffer, _| {
747 buffer.group_until_transaction(transaction_id)
748 });
749 } else {
750 self.history.group_until(transaction_id);
751 }
752 }
753
754 pub fn set_active_selections(
755 &mut self,
756 selections: &[Selection<Anchor>],
757 line_mode: bool,
758 cursor_shape: CursorShape,
759 cx: &mut ModelContext<Self>,
760 ) {
761 let mut selections_by_buffer: HashMap<BufferId, Vec<Selection<text::Anchor>>> =
762 Default::default();
763 let snapshot = self.read(cx);
764 let mut cursor = snapshot.excerpts.cursor::<Option<&Locator>>();
765 for selection in selections {
766 let start_locator = snapshot.excerpt_locator_for_id(selection.start.excerpt_id);
767 let end_locator = snapshot.excerpt_locator_for_id(selection.end.excerpt_id);
768
769 cursor.seek(&Some(start_locator), Bias::Left, &());
770 while let Some(excerpt) = cursor.item() {
771 if excerpt.locator > *end_locator {
772 break;
773 }
774
775 let mut start = excerpt.range.context.start;
776 let mut end = excerpt.range.context.end;
777 if excerpt.id == selection.start.excerpt_id {
778 start = selection.start.text_anchor;
779 }
780 if excerpt.id == selection.end.excerpt_id {
781 end = selection.end.text_anchor;
782 }
783 selections_by_buffer
784 .entry(excerpt.buffer_id)
785 .or_default()
786 .push(Selection {
787 id: selection.id,
788 start,
789 end,
790 reversed: selection.reversed,
791 goal: selection.goal,
792 });
793
794 cursor.next(&());
795 }
796 }
797
798 for (buffer_id, buffer_state) in self.buffers.borrow().iter() {
799 if !selections_by_buffer.contains_key(buffer_id) {
800 buffer_state
801 .buffer
802 .update(cx, |buffer, cx| buffer.remove_active_selections(cx));
803 }
804 }
805
806 for (buffer_id, mut selections) in selections_by_buffer {
807 self.buffers.borrow()[&buffer_id]
808 .buffer
809 .update(cx, |buffer, cx| {
810 selections.sort_unstable_by(|a, b| a.start.cmp(&b.start, buffer));
811 let mut selections = selections.into_iter().peekable();
812 let merged_selections = Arc::from_iter(iter::from_fn(|| {
813 let mut selection = selections.next()?;
814 while let Some(next_selection) = selections.peek() {
815 if selection.end.cmp(&next_selection.start, buffer).is_ge() {
816 let next_selection = selections.next().unwrap();
817 if next_selection.end.cmp(&selection.end, buffer).is_ge() {
818 selection.end = next_selection.end;
819 }
820 } else {
821 break;
822 }
823 }
824 Some(selection)
825 }));
826 buffer.set_active_selections(merged_selections, line_mode, cursor_shape, cx);
827 });
828 }
829 }
830
831 pub fn remove_active_selections(&mut self, cx: &mut ModelContext<Self>) {
832 for buffer in self.buffers.borrow().values() {
833 buffer
834 .buffer
835 .update(cx, |buffer, cx| buffer.remove_active_selections(cx));
836 }
837 }
838
839 pub fn undo(&mut self, cx: &mut ModelContext<Self>) -> Option<TransactionId> {
840 let mut transaction_id = None;
841 if let Some(buffer) = self.as_singleton() {
842 transaction_id = buffer.update(cx, |buffer, cx| buffer.undo(cx));
843 } else {
844 while let Some(transaction) = self.history.pop_undo() {
845 let mut undone = false;
846 for (buffer_id, buffer_transaction_id) in &mut transaction.buffer_transactions {
847 if let Some(BufferState { buffer, .. }) = self.buffers.borrow().get(buffer_id) {
848 undone |= buffer.update(cx, |buffer, cx| {
849 let undo_to = *buffer_transaction_id;
850 if let Some(entry) = buffer.peek_undo_stack() {
851 *buffer_transaction_id = entry.transaction_id();
852 }
853 buffer.undo_to_transaction(undo_to, cx)
854 });
855 }
856 }
857
858 if undone {
859 transaction_id = Some(transaction.id);
860 break;
861 }
862 }
863 }
864
865 if let Some(transaction_id) = transaction_id {
866 cx.emit(Event::TransactionUndone { transaction_id });
867 }
868
869 transaction_id
870 }
871
872 pub fn redo(&mut self, cx: &mut ModelContext<Self>) -> Option<TransactionId> {
873 if let Some(buffer) = self.as_singleton() {
874 return buffer.update(cx, |buffer, cx| buffer.redo(cx));
875 }
876
877 while let Some(transaction) = self.history.pop_redo() {
878 let mut redone = false;
879 for (buffer_id, buffer_transaction_id) in &mut transaction.buffer_transactions {
880 if let Some(BufferState { buffer, .. }) = self.buffers.borrow().get(buffer_id) {
881 redone |= buffer.update(cx, |buffer, cx| {
882 let redo_to = *buffer_transaction_id;
883 if let Some(entry) = buffer.peek_redo_stack() {
884 *buffer_transaction_id = entry.transaction_id();
885 }
886 buffer.redo_to_transaction(redo_to, cx)
887 });
888 }
889 }
890
891 if redone {
892 return Some(transaction.id);
893 }
894 }
895
896 None
897 }
898
899 pub fn undo_transaction(&mut self, transaction_id: TransactionId, cx: &mut ModelContext<Self>) {
900 if let Some(buffer) = self.as_singleton() {
901 buffer.update(cx, |buffer, cx| buffer.undo_transaction(transaction_id, cx));
902 } else if let Some(transaction) = self.history.remove_from_undo(transaction_id) {
903 for (buffer_id, transaction_id) in &transaction.buffer_transactions {
904 if let Some(BufferState { buffer, .. }) = self.buffers.borrow().get(buffer_id) {
905 buffer.update(cx, |buffer, cx| {
906 buffer.undo_transaction(*transaction_id, cx)
907 });
908 }
909 }
910 }
911 }
912
913 pub fn stream_excerpts_with_context_lines(
914 &mut self,
915 buffer: Model<Buffer>,
916 ranges: Vec<Range<text::Anchor>>,
917 context_line_count: u32,
918 cx: &mut ModelContext<Self>,
919 ) -> mpsc::Receiver<Range<Anchor>> {
920 let (buffer_id, buffer_snapshot) =
921 buffer.update(cx, |buffer, _| (buffer.remote_id(), buffer.snapshot()));
922
923 let (mut tx, rx) = mpsc::channel(256);
924 cx.spawn(move |this, mut cx| async move {
925 let mut excerpt_ranges = Vec::new();
926 let mut range_counts = Vec::new();
927 cx.background_executor()
928 .scoped(|scope| {
929 scope.spawn(async {
930 let (ranges, counts) =
931 build_excerpt_ranges(&buffer_snapshot, &ranges, context_line_count);
932 excerpt_ranges = ranges;
933 range_counts = counts;
934 });
935 })
936 .await;
937
938 let mut ranges = ranges.into_iter();
939 let mut range_counts = range_counts.into_iter();
940 for excerpt_ranges in excerpt_ranges.chunks(100) {
941 let excerpt_ids = match this.update(&mut cx, |this, cx| {
942 this.push_excerpts(buffer.clone(), excerpt_ranges.iter().cloned(), cx)
943 }) {
944 Ok(excerpt_ids) => excerpt_ids,
945 Err(_) => return,
946 };
947
948 for (excerpt_id, range_count) in excerpt_ids.into_iter().zip(range_counts.by_ref())
949 {
950 for range in ranges.by_ref().take(range_count) {
951 let start = Anchor {
952 buffer_id: Some(buffer_id),
953 excerpt_id: excerpt_id,
954 text_anchor: range.start,
955 };
956 let end = Anchor {
957 buffer_id: Some(buffer_id),
958 excerpt_id: excerpt_id,
959 text_anchor: range.end,
960 };
961 if tx.send(start..end).await.is_err() {
962 break;
963 }
964 }
965 }
966 }
967 })
968 .detach();
969
970 rx
971 }
972
973 pub fn push_excerpts<O>(
974 &mut self,
975 buffer: Model<Buffer>,
976 ranges: impl IntoIterator<Item = ExcerptRange<O>>,
977 cx: &mut ModelContext<Self>,
978 ) -> Vec<ExcerptId>
979 where
980 O: text::ToOffset,
981 {
982 self.insert_excerpts_after(ExcerptId::max(), buffer, ranges, cx)
983 }
984
985 pub fn push_excerpts_with_context_lines<O>(
986 &mut self,
987 buffer: Model<Buffer>,
988 ranges: Vec<Range<O>>,
989 context_line_count: u32,
990 cx: &mut ModelContext<Self>,
991 ) -> Vec<Range<Anchor>>
992 where
993 O: text::ToPoint + text::ToOffset,
994 {
995 let buffer_id = buffer.read(cx).remote_id();
996 let buffer_snapshot = buffer.read(cx).snapshot();
997 let (excerpt_ranges, range_counts) =
998 build_excerpt_ranges(&buffer_snapshot, &ranges, context_line_count);
999
1000 let excerpt_ids = self.push_excerpts(buffer, excerpt_ranges, cx);
1001
1002 let mut anchor_ranges = Vec::new();
1003 let mut ranges = ranges.into_iter();
1004 for (excerpt_id, range_count) in excerpt_ids.into_iter().zip(range_counts.into_iter()) {
1005 anchor_ranges.extend(ranges.by_ref().take(range_count).map(|range| {
1006 let start = Anchor {
1007 buffer_id: Some(buffer_id),
1008 excerpt_id: excerpt_id,
1009 text_anchor: buffer_snapshot.anchor_after(range.start),
1010 };
1011 let end = Anchor {
1012 buffer_id: Some(buffer_id),
1013 excerpt_id: excerpt_id,
1014 text_anchor: buffer_snapshot.anchor_after(range.end),
1015 };
1016 start..end
1017 }))
1018 }
1019 anchor_ranges
1020 }
1021
1022 pub fn insert_excerpts_after<O>(
1023 &mut self,
1024 prev_excerpt_id: ExcerptId,
1025 buffer: Model<Buffer>,
1026 ranges: impl IntoIterator<Item = ExcerptRange<O>>,
1027 cx: &mut ModelContext<Self>,
1028 ) -> Vec<ExcerptId>
1029 where
1030 O: text::ToOffset,
1031 {
1032 let mut ids = Vec::new();
1033 let mut next_excerpt_id =
1034 if let Some(last_entry) = self.snapshot.borrow().excerpt_ids.last() {
1035 last_entry.id.0 + 1
1036 } else {
1037 1
1038 };
1039 self.insert_excerpts_with_ids_after(
1040 prev_excerpt_id,
1041 buffer,
1042 ranges.into_iter().map(|range| {
1043 let id = ExcerptId(post_inc(&mut next_excerpt_id));
1044 ids.push(id);
1045 (id, range)
1046 }),
1047 cx,
1048 );
1049 ids
1050 }
1051
1052 pub fn insert_excerpts_with_ids_after<O>(
1053 &mut self,
1054 prev_excerpt_id: ExcerptId,
1055 buffer: Model<Buffer>,
1056 ranges: impl IntoIterator<Item = (ExcerptId, ExcerptRange<O>)>,
1057 cx: &mut ModelContext<Self>,
1058 ) where
1059 O: text::ToOffset,
1060 {
1061 assert_eq!(self.history.transaction_depth, 0);
1062 let mut ranges = ranges.into_iter().peekable();
1063 if ranges.peek().is_none() {
1064 return Default::default();
1065 }
1066
1067 self.sync(cx);
1068
1069 let buffer_id = buffer.read(cx).remote_id();
1070 let buffer_snapshot = buffer.read(cx).snapshot();
1071
1072 let mut buffers = self.buffers.borrow_mut();
1073 let buffer_state = buffers.entry(buffer_id).or_insert_with(|| BufferState {
1074 last_version: buffer_snapshot.version().clone(),
1075 last_parse_count: buffer_snapshot.parse_count(),
1076 last_selections_update_count: buffer_snapshot.selections_update_count(),
1077 last_diagnostics_update_count: buffer_snapshot.diagnostics_update_count(),
1078 last_file_update_count: buffer_snapshot.file_update_count(),
1079 last_git_diff_update_count: buffer_snapshot.git_diff_update_count(),
1080 excerpts: Default::default(),
1081 _subscriptions: [
1082 cx.observe(&buffer, |_, _, cx| cx.notify()),
1083 cx.subscribe(&buffer, Self::on_buffer_event),
1084 ],
1085 buffer: buffer.clone(),
1086 });
1087
1088 let mut snapshot = self.snapshot.borrow_mut();
1089
1090 let mut prev_locator = snapshot.excerpt_locator_for_id(prev_excerpt_id).clone();
1091 let mut new_excerpt_ids = mem::take(&mut snapshot.excerpt_ids);
1092 let mut cursor = snapshot.excerpts.cursor::<Option<&Locator>>();
1093 let mut new_excerpts = cursor.slice(&prev_locator, Bias::Right, &());
1094 prev_locator = cursor.start().unwrap_or(Locator::min_ref()).clone();
1095
1096 let edit_start = new_excerpts.summary().text.len;
1097 new_excerpts.update_last(
1098 |excerpt| {
1099 excerpt.has_trailing_newline = true;
1100 },
1101 &(),
1102 );
1103
1104 let next_locator = if let Some(excerpt) = cursor.item() {
1105 excerpt.locator.clone()
1106 } else {
1107 Locator::max()
1108 };
1109
1110 let mut excerpts = Vec::new();
1111 while let Some((id, range)) = ranges.next() {
1112 let locator = Locator::between(&prev_locator, &next_locator);
1113 if let Err(ix) = buffer_state.excerpts.binary_search(&locator) {
1114 buffer_state.excerpts.insert(ix, locator.clone());
1115 }
1116 let range = ExcerptRange {
1117 context: buffer_snapshot.anchor_before(&range.context.start)
1118 ..buffer_snapshot.anchor_after(&range.context.end),
1119 primary: range.primary.map(|primary| {
1120 buffer_snapshot.anchor_before(&primary.start)
1121 ..buffer_snapshot.anchor_after(&primary.end)
1122 }),
1123 };
1124 excerpts.push((id, range.clone()));
1125 let excerpt = Excerpt::new(
1126 id,
1127 locator.clone(),
1128 buffer_id,
1129 buffer_snapshot.clone(),
1130 range,
1131 ranges.peek().is_some() || cursor.item().is_some(),
1132 );
1133 new_excerpts.push(excerpt, &());
1134 prev_locator = locator.clone();
1135
1136 if let Some(last_mapping_entry) = new_excerpt_ids.last() {
1137 assert!(id > last_mapping_entry.id, "excerpt ids must be increasing");
1138 }
1139 new_excerpt_ids.push(ExcerptIdMapping { id, locator }, &());
1140 }
1141
1142 let edit_end = new_excerpts.summary().text.len;
1143
1144 let suffix = cursor.suffix(&());
1145 let changed_trailing_excerpt = suffix.is_empty();
1146 new_excerpts.append(suffix, &());
1147 drop(cursor);
1148 snapshot.excerpts = new_excerpts;
1149 snapshot.excerpt_ids = new_excerpt_ids;
1150 if changed_trailing_excerpt {
1151 snapshot.trailing_excerpt_update_count += 1;
1152 }
1153
1154 self.subscriptions.publish_mut([Edit {
1155 old: edit_start..edit_start,
1156 new: edit_start..edit_end,
1157 }]);
1158 cx.emit(Event::Edited {
1159 singleton_buffer_edited: false,
1160 });
1161 cx.emit(Event::ExcerptsAdded {
1162 buffer,
1163 predecessor: prev_excerpt_id,
1164 excerpts,
1165 });
1166 cx.notify();
1167 }
1168
1169 pub fn clear(&mut self, cx: &mut ModelContext<Self>) {
1170 self.sync(cx);
1171 let ids = self.excerpt_ids();
1172 self.buffers.borrow_mut().clear();
1173 let mut snapshot = self.snapshot.borrow_mut();
1174 let prev_len = snapshot.len();
1175 snapshot.excerpts = Default::default();
1176 snapshot.trailing_excerpt_update_count += 1;
1177 snapshot.is_dirty = false;
1178 snapshot.has_conflict = false;
1179
1180 self.subscriptions.publish_mut([Edit {
1181 old: 0..prev_len,
1182 new: 0..0,
1183 }]);
1184 cx.emit(Event::Edited {
1185 singleton_buffer_edited: false,
1186 });
1187 cx.emit(Event::ExcerptsRemoved { ids });
1188 cx.notify();
1189 }
1190
1191 pub fn excerpts_for_buffer(
1192 &self,
1193 buffer: &Model<Buffer>,
1194 cx: &AppContext,
1195 ) -> Vec<(ExcerptId, ExcerptRange<text::Anchor>)> {
1196 let mut excerpts = Vec::new();
1197 let snapshot = self.read(cx);
1198 let buffers = self.buffers.borrow();
1199 let mut cursor = snapshot.excerpts.cursor::<Option<&Locator>>();
1200 for locator in buffers
1201 .get(&buffer.read(cx).remote_id())
1202 .map(|state| &state.excerpts)
1203 .into_iter()
1204 .flatten()
1205 {
1206 cursor.seek_forward(&Some(locator), Bias::Left, &());
1207 if let Some(excerpt) = cursor.item() {
1208 if excerpt.locator == *locator {
1209 excerpts.push((excerpt.id, excerpt.range.clone()));
1210 }
1211 }
1212 }
1213
1214 excerpts
1215 }
1216
1217 pub fn excerpt_ids(&self) -> Vec<ExcerptId> {
1218 self.snapshot
1219 .borrow()
1220 .excerpts
1221 .iter()
1222 .map(|entry| entry.id)
1223 .collect()
1224 }
1225
1226 pub fn excerpt_containing(
1227 &self,
1228 position: impl ToOffset,
1229 cx: &AppContext,
1230 ) -> Option<(ExcerptId, Model<Buffer>, Range<text::Anchor>)> {
1231 let snapshot = self.read(cx);
1232 let position = position.to_offset(&snapshot);
1233
1234 let mut cursor = snapshot.excerpts.cursor::<usize>();
1235 cursor.seek(&position, Bias::Right, &());
1236 cursor
1237 .item()
1238 .or_else(|| snapshot.excerpts.last())
1239 .map(|excerpt| {
1240 (
1241 excerpt.id,
1242 self.buffers
1243 .borrow()
1244 .get(&excerpt.buffer_id)
1245 .unwrap()
1246 .buffer
1247 .clone(),
1248 excerpt.range.context.clone(),
1249 )
1250 })
1251 }
1252
1253 // If point is at the end of the buffer, the last excerpt is returned
1254 pub fn point_to_buffer_offset<T: ToOffset>(
1255 &self,
1256 point: T,
1257 cx: &AppContext,
1258 ) -> Option<(Model<Buffer>, usize, ExcerptId)> {
1259 let snapshot = self.read(cx);
1260 let offset = point.to_offset(&snapshot);
1261 let mut cursor = snapshot.excerpts.cursor::<usize>();
1262 cursor.seek(&offset, Bias::Right, &());
1263 if cursor.item().is_none() {
1264 cursor.prev(&());
1265 }
1266
1267 cursor.item().map(|excerpt| {
1268 let excerpt_start = excerpt.range.context.start.to_offset(&excerpt.buffer);
1269 let buffer_point = excerpt_start + offset - *cursor.start();
1270 let buffer = self.buffers.borrow()[&excerpt.buffer_id].buffer.clone();
1271
1272 (buffer, buffer_point, excerpt.id)
1273 })
1274 }
1275
1276 pub fn range_to_buffer_ranges<T: ToOffset>(
1277 &self,
1278 range: Range<T>,
1279 cx: &AppContext,
1280 ) -> Vec<(Model<Buffer>, Range<usize>, ExcerptId)> {
1281 let snapshot = self.read(cx);
1282 let start = range.start.to_offset(&snapshot);
1283 let end = range.end.to_offset(&snapshot);
1284
1285 let mut result = Vec::new();
1286 let mut cursor = snapshot.excerpts.cursor::<usize>();
1287 cursor.seek(&start, Bias::Right, &());
1288 if cursor.item().is_none() {
1289 cursor.prev(&());
1290 }
1291
1292 while let Some(excerpt) = cursor.item() {
1293 if *cursor.start() > end {
1294 break;
1295 }
1296
1297 let mut end_before_newline = cursor.end(&());
1298 if excerpt.has_trailing_newline {
1299 end_before_newline -= 1;
1300 }
1301 let excerpt_start = excerpt.range.context.start.to_offset(&excerpt.buffer);
1302 let start = excerpt_start + (cmp::max(start, *cursor.start()) - *cursor.start());
1303 let end = excerpt_start + (cmp::min(end, end_before_newline) - *cursor.start());
1304 let buffer = self.buffers.borrow()[&excerpt.buffer_id].buffer.clone();
1305 result.push((buffer, start..end, excerpt.id));
1306 cursor.next(&());
1307 }
1308
1309 result
1310 }
1311
1312 pub fn remove_excerpts(
1313 &mut self,
1314 excerpt_ids: impl IntoIterator<Item = ExcerptId>,
1315 cx: &mut ModelContext<Self>,
1316 ) {
1317 self.sync(cx);
1318 let ids = excerpt_ids.into_iter().collect::<Vec<_>>();
1319 if ids.is_empty() {
1320 return;
1321 }
1322
1323 let mut buffers = self.buffers.borrow_mut();
1324 let mut snapshot = self.snapshot.borrow_mut();
1325 let mut new_excerpts = SumTree::new();
1326 let mut cursor = snapshot.excerpts.cursor::<(Option<&Locator>, usize)>();
1327 let mut edits = Vec::new();
1328 let mut excerpt_ids = ids.iter().copied().peekable();
1329
1330 while let Some(excerpt_id) = excerpt_ids.next() {
1331 // Seek to the next excerpt to remove, preserving any preceding excerpts.
1332 let locator = snapshot.excerpt_locator_for_id(excerpt_id);
1333 new_excerpts.append(cursor.slice(&Some(locator), Bias::Left, &()), &());
1334
1335 if let Some(mut excerpt) = cursor.item() {
1336 if excerpt.id != excerpt_id {
1337 continue;
1338 }
1339 let mut old_start = cursor.start().1;
1340
1341 // Skip over the removed excerpt.
1342 'remove_excerpts: loop {
1343 if let Some(buffer_state) = buffers.get_mut(&excerpt.buffer_id) {
1344 buffer_state.excerpts.retain(|l| l != &excerpt.locator);
1345 if buffer_state.excerpts.is_empty() {
1346 buffers.remove(&excerpt.buffer_id);
1347 }
1348 }
1349 cursor.next(&());
1350
1351 // Skip over any subsequent excerpts that are also removed.
1352 if let Some(&next_excerpt_id) = excerpt_ids.peek() {
1353 let next_locator = snapshot.excerpt_locator_for_id(next_excerpt_id);
1354 if let Some(next_excerpt) = cursor.item() {
1355 if next_excerpt.locator == *next_locator {
1356 excerpt_ids.next();
1357 excerpt = next_excerpt;
1358 continue 'remove_excerpts;
1359 }
1360 }
1361 }
1362
1363 break;
1364 }
1365
1366 // When removing the last excerpt, remove the trailing newline from
1367 // the previous excerpt.
1368 if cursor.item().is_none() && old_start > 0 {
1369 old_start -= 1;
1370 new_excerpts.update_last(|e| e.has_trailing_newline = false, &());
1371 }
1372
1373 // Push an edit for the removal of this run of excerpts.
1374 let old_end = cursor.start().1;
1375 let new_start = new_excerpts.summary().text.len;
1376 edits.push(Edit {
1377 old: old_start..old_end,
1378 new: new_start..new_start,
1379 });
1380 }
1381 }
1382 let suffix = cursor.suffix(&());
1383 let changed_trailing_excerpt = suffix.is_empty();
1384 new_excerpts.append(suffix, &());
1385 drop(cursor);
1386 snapshot.excerpts = new_excerpts;
1387
1388 if changed_trailing_excerpt {
1389 snapshot.trailing_excerpt_update_count += 1;
1390 }
1391
1392 self.subscriptions.publish_mut(edits);
1393 cx.emit(Event::Edited {
1394 singleton_buffer_edited: false,
1395 });
1396 cx.emit(Event::ExcerptsRemoved { ids });
1397 cx.notify();
1398 }
1399
1400 pub fn wait_for_anchors<'a>(
1401 &self,
1402 anchors: impl 'a + Iterator<Item = Anchor>,
1403 cx: &mut ModelContext<Self>,
1404 ) -> impl 'static + Future<Output = Result<()>> {
1405 let borrow = self.buffers.borrow();
1406 let mut error = None;
1407 let mut futures = Vec::new();
1408 for anchor in anchors {
1409 if let Some(buffer_id) = anchor.buffer_id {
1410 if let Some(buffer) = borrow.get(&buffer_id) {
1411 buffer.buffer.update(cx, |buffer, _| {
1412 futures.push(buffer.wait_for_anchors([anchor.text_anchor]))
1413 });
1414 } else {
1415 error = Some(anyhow!(
1416 "buffer {buffer_id} is not part of this multi-buffer"
1417 ));
1418 break;
1419 }
1420 }
1421 }
1422 async move {
1423 if let Some(error) = error {
1424 Err(error)?;
1425 }
1426 for future in futures {
1427 future.await?;
1428 }
1429 Ok(())
1430 }
1431 }
1432
1433 pub fn text_anchor_for_position<T: ToOffset>(
1434 &self,
1435 position: T,
1436 cx: &AppContext,
1437 ) -> Option<(Model<Buffer>, language::Anchor)> {
1438 let snapshot = self.read(cx);
1439 let anchor = snapshot.anchor_before(position);
1440 let buffer = self
1441 .buffers
1442 .borrow()
1443 .get(&anchor.buffer_id?)?
1444 .buffer
1445 .clone();
1446 Some((buffer, anchor.text_anchor))
1447 }
1448
1449 fn on_buffer_event(
1450 &mut self,
1451 buffer: Model<Buffer>,
1452 event: &language::Event,
1453 cx: &mut ModelContext<Self>,
1454 ) {
1455 cx.emit(match event {
1456 language::Event::Edited => Event::Edited {
1457 singleton_buffer_edited: true,
1458 },
1459 language::Event::DirtyChanged => Event::DirtyChanged,
1460 language::Event::Saved => Event::Saved,
1461 language::Event::FileHandleChanged => Event::FileHandleChanged,
1462 language::Event::Reloaded => Event::Reloaded,
1463 language::Event::DiffBaseChanged => Event::DiffBaseChanged,
1464 language::Event::LanguageChanged => Event::LanguageChanged,
1465 language::Event::Reparsed => Event::Reparsed,
1466 language::Event::DiagnosticsUpdated => Event::DiagnosticsUpdated,
1467 language::Event::Closed => Event::Closed,
1468 language::Event::CapabilityChanged => {
1469 self.capability = buffer.read(cx).capability();
1470 Event::CapabilityChanged
1471 }
1472
1473 //
1474 language::Event::Operation(_) => return,
1475 });
1476 }
1477
1478 pub fn all_buffers(&self) -> HashSet<Model<Buffer>> {
1479 self.buffers
1480 .borrow()
1481 .values()
1482 .map(|state| state.buffer.clone())
1483 .collect()
1484 }
1485
1486 pub fn buffer(&self, buffer_id: BufferId) -> Option<Model<Buffer>> {
1487 self.buffers
1488 .borrow()
1489 .get(&buffer_id)
1490 .map(|state| state.buffer.clone())
1491 }
1492
1493 pub fn is_completion_trigger(&self, position: Anchor, text: &str, cx: &AppContext) -> bool {
1494 let mut chars = text.chars();
1495 let char = if let Some(char) = chars.next() {
1496 char
1497 } else {
1498 return false;
1499 };
1500 if chars.next().is_some() {
1501 return false;
1502 }
1503
1504 let snapshot = self.snapshot(cx);
1505 let position = position.to_offset(&snapshot);
1506 let scope = snapshot.language_scope_at(position);
1507 if char_kind(&scope, char) == CharKind::Word {
1508 return true;
1509 }
1510
1511 let anchor = snapshot.anchor_before(position);
1512 anchor
1513 .buffer_id
1514 .and_then(|buffer_id| {
1515 let buffer = self.buffers.borrow().get(&buffer_id)?.buffer.clone();
1516 Some(
1517 buffer
1518 .read(cx)
1519 .completion_triggers()
1520 .iter()
1521 .any(|string| string == text),
1522 )
1523 })
1524 .unwrap_or(false)
1525 }
1526
1527 pub fn language_at<T: ToOffset>(&self, point: T, cx: &AppContext) -> Option<Arc<Language>> {
1528 self.point_to_buffer_offset(point, cx)
1529 .and_then(|(buffer, offset, _)| buffer.read(cx).language_at(offset))
1530 }
1531
1532 pub fn settings_at<'a, T: ToOffset>(
1533 &self,
1534 point: T,
1535 cx: &'a AppContext,
1536 ) -> &'a LanguageSettings {
1537 let mut language = None;
1538 let mut file = None;
1539 if let Some((buffer, offset, _)) = self.point_to_buffer_offset(point, cx) {
1540 let buffer = buffer.read(cx);
1541 language = buffer.language_at(offset);
1542 file = buffer.file();
1543 }
1544 language_settings(language.as_ref(), file, cx)
1545 }
1546
1547 pub fn for_each_buffer(&self, mut f: impl FnMut(&Model<Buffer>)) {
1548 self.buffers
1549 .borrow()
1550 .values()
1551 .for_each(|state| f(&state.buffer))
1552 }
1553
1554 pub fn title<'a>(&'a self, cx: &'a AppContext) -> Cow<'a, str> {
1555 if let Some(title) = self.title.as_ref() {
1556 return title.into();
1557 }
1558
1559 if let Some(buffer) = self.as_singleton() {
1560 if let Some(file) = buffer.read(cx).file() {
1561 return file.file_name(cx).to_string_lossy();
1562 }
1563 }
1564
1565 "untitled".into()
1566 }
1567
1568 #[cfg(any(test, feature = "test-support"))]
1569 pub fn is_parsing(&self, cx: &AppContext) -> bool {
1570 self.as_singleton().unwrap().read(cx).is_parsing()
1571 }
1572
1573 fn sync(&self, cx: &AppContext) {
1574 let mut snapshot = self.snapshot.borrow_mut();
1575 let mut excerpts_to_edit = Vec::new();
1576 let mut reparsed = false;
1577 let mut diagnostics_updated = false;
1578 let mut git_diff_updated = false;
1579 let mut is_dirty = false;
1580 let mut has_conflict = false;
1581 let mut edited = false;
1582 let mut buffers = self.buffers.borrow_mut();
1583 for buffer_state in buffers.values_mut() {
1584 let buffer = buffer_state.buffer.read(cx);
1585 let version = buffer.version();
1586 let parse_count = buffer.parse_count();
1587 let selections_update_count = buffer.selections_update_count();
1588 let diagnostics_update_count = buffer.diagnostics_update_count();
1589 let file_update_count = buffer.file_update_count();
1590 let git_diff_update_count = buffer.git_diff_update_count();
1591
1592 let buffer_edited = version.changed_since(&buffer_state.last_version);
1593 let buffer_reparsed = parse_count > buffer_state.last_parse_count;
1594 let buffer_selections_updated =
1595 selections_update_count > buffer_state.last_selections_update_count;
1596 let buffer_diagnostics_updated =
1597 diagnostics_update_count > buffer_state.last_diagnostics_update_count;
1598 let buffer_file_updated = file_update_count > buffer_state.last_file_update_count;
1599 let buffer_git_diff_updated =
1600 git_diff_update_count > buffer_state.last_git_diff_update_count;
1601 if buffer_edited
1602 || buffer_reparsed
1603 || buffer_selections_updated
1604 || buffer_diagnostics_updated
1605 || buffer_file_updated
1606 || buffer_git_diff_updated
1607 {
1608 buffer_state.last_version = version;
1609 buffer_state.last_parse_count = parse_count;
1610 buffer_state.last_selections_update_count = selections_update_count;
1611 buffer_state.last_diagnostics_update_count = diagnostics_update_count;
1612 buffer_state.last_file_update_count = file_update_count;
1613 buffer_state.last_git_diff_update_count = git_diff_update_count;
1614 excerpts_to_edit.extend(
1615 buffer_state
1616 .excerpts
1617 .iter()
1618 .map(|locator| (locator, buffer_state.buffer.clone(), buffer_edited)),
1619 );
1620 }
1621
1622 edited |= buffer_edited;
1623 reparsed |= buffer_reparsed;
1624 diagnostics_updated |= buffer_diagnostics_updated;
1625 git_diff_updated |= buffer_git_diff_updated;
1626 is_dirty |= buffer.is_dirty();
1627 has_conflict |= buffer.has_conflict();
1628 }
1629 if edited {
1630 snapshot.edit_count += 1;
1631 }
1632 if reparsed {
1633 snapshot.parse_count += 1;
1634 }
1635 if diagnostics_updated {
1636 snapshot.diagnostics_update_count += 1;
1637 }
1638 if git_diff_updated {
1639 snapshot.git_diff_update_count += 1;
1640 }
1641 snapshot.is_dirty = is_dirty;
1642 snapshot.has_conflict = has_conflict;
1643
1644 excerpts_to_edit.sort_unstable_by_key(|(locator, _, _)| *locator);
1645
1646 let mut edits = Vec::new();
1647 let mut new_excerpts = SumTree::new();
1648 let mut cursor = snapshot.excerpts.cursor::<(Option<&Locator>, usize)>();
1649
1650 for (locator, buffer, buffer_edited) in excerpts_to_edit {
1651 new_excerpts.append(cursor.slice(&Some(locator), Bias::Left, &()), &());
1652 let old_excerpt = cursor.item().unwrap();
1653 let buffer = buffer.read(cx);
1654 let buffer_id = buffer.remote_id();
1655
1656 let mut new_excerpt;
1657 if buffer_edited {
1658 edits.extend(
1659 buffer
1660 .edits_since_in_range::<usize>(
1661 old_excerpt.buffer.version(),
1662 old_excerpt.range.context.clone(),
1663 )
1664 .map(|mut edit| {
1665 let excerpt_old_start = cursor.start().1;
1666 let excerpt_new_start = new_excerpts.summary().text.len;
1667 edit.old.start += excerpt_old_start;
1668 edit.old.end += excerpt_old_start;
1669 edit.new.start += excerpt_new_start;
1670 edit.new.end += excerpt_new_start;
1671 edit
1672 }),
1673 );
1674
1675 new_excerpt = Excerpt::new(
1676 old_excerpt.id,
1677 locator.clone(),
1678 buffer_id,
1679 buffer.snapshot(),
1680 old_excerpt.range.clone(),
1681 old_excerpt.has_trailing_newline,
1682 );
1683 } else {
1684 new_excerpt = old_excerpt.clone();
1685 new_excerpt.buffer = buffer.snapshot();
1686 }
1687
1688 new_excerpts.push(new_excerpt, &());
1689 cursor.next(&());
1690 }
1691 new_excerpts.append(cursor.suffix(&()), &());
1692
1693 drop(cursor);
1694 snapshot.excerpts = new_excerpts;
1695
1696 self.subscriptions.publish(edits);
1697 }
1698}
1699
1700#[cfg(any(test, feature = "test-support"))]
1701impl MultiBuffer {
1702 pub fn build_simple(text: &str, cx: &mut gpui::AppContext) -> Model<Self> {
1703 let buffer = cx
1704 .new_model(|cx| Buffer::new(0, BufferId::new(cx.entity_id().as_u64()).unwrap(), text));
1705 cx.new_model(|cx| Self::singleton(buffer, cx))
1706 }
1707
1708 pub fn build_multi<const COUNT: usize>(
1709 excerpts: [(&str, Vec<Range<Point>>); COUNT],
1710 cx: &mut gpui::AppContext,
1711 ) -> Model<Self> {
1712 let multi = cx.new_model(|_| Self::new(0, Capability::ReadWrite));
1713 for (text, ranges) in excerpts {
1714 let buffer = cx.new_model(|cx| {
1715 Buffer::new(0, BufferId::new(cx.entity_id().as_u64()).unwrap(), text)
1716 });
1717 let excerpt_ranges = ranges.into_iter().map(|range| ExcerptRange {
1718 context: range,
1719 primary: None,
1720 });
1721 multi.update(cx, |multi, cx| {
1722 multi.push_excerpts(buffer, excerpt_ranges, cx)
1723 });
1724 }
1725
1726 multi
1727 }
1728
1729 pub fn build_from_buffer(buffer: Model<Buffer>, cx: &mut gpui::AppContext) -> Model<Self> {
1730 cx.new_model(|cx| Self::singleton(buffer, cx))
1731 }
1732
1733 pub fn build_random(rng: &mut impl rand::Rng, cx: &mut gpui::AppContext) -> Model<Self> {
1734 cx.new_model(|cx| {
1735 let mut multibuffer = MultiBuffer::new(0, Capability::ReadWrite);
1736 let mutation_count = rng.gen_range(1..=5);
1737 multibuffer.randomly_edit_excerpts(rng, mutation_count, cx);
1738 multibuffer
1739 })
1740 }
1741
1742 pub fn randomly_edit(
1743 &mut self,
1744 rng: &mut impl rand::Rng,
1745 edit_count: usize,
1746 cx: &mut ModelContext<Self>,
1747 ) {
1748 use util::RandomCharIter;
1749
1750 let snapshot = self.read(cx);
1751 let mut edits: Vec<(Range<usize>, Arc<str>)> = Vec::new();
1752 let mut last_end = None;
1753 for _ in 0..edit_count {
1754 if last_end.map_or(false, |last_end| last_end >= snapshot.len()) {
1755 break;
1756 }
1757
1758 let new_start = last_end.map_or(0, |last_end| last_end + 1);
1759 let end = snapshot.clip_offset(rng.gen_range(new_start..=snapshot.len()), Bias::Right);
1760 let start = snapshot.clip_offset(rng.gen_range(new_start..=end), Bias::Right);
1761 last_end = Some(end);
1762
1763 let mut range = start..end;
1764 if rng.gen_bool(0.2) {
1765 mem::swap(&mut range.start, &mut range.end);
1766 }
1767
1768 let new_text_len = rng.gen_range(0..10);
1769 let new_text: String = RandomCharIter::new(&mut *rng).take(new_text_len).collect();
1770
1771 edits.push((range, new_text.into()));
1772 }
1773 log::info!("mutating multi-buffer with {:?}", edits);
1774 drop(snapshot);
1775
1776 self.edit(edits, None, cx);
1777 }
1778
1779 pub fn randomly_edit_excerpts(
1780 &mut self,
1781 rng: &mut impl rand::Rng,
1782 mutation_count: usize,
1783 cx: &mut ModelContext<Self>,
1784 ) {
1785 use rand::prelude::*;
1786 use std::env;
1787 use util::RandomCharIter;
1788
1789 let max_excerpts = env::var("MAX_EXCERPTS")
1790 .map(|i| i.parse().expect("invalid `MAX_EXCERPTS` variable"))
1791 .unwrap_or(5);
1792
1793 let mut buffers = Vec::new();
1794 for _ in 0..mutation_count {
1795 if rng.gen_bool(0.05) {
1796 log::info!("Clearing multi-buffer");
1797 self.clear(cx);
1798 continue;
1799 }
1800
1801 let excerpt_ids = self.excerpt_ids();
1802 if excerpt_ids.is_empty() || (rng.gen() && excerpt_ids.len() < max_excerpts) {
1803 let buffer_handle = if rng.gen() || self.buffers.borrow().is_empty() {
1804 let text = RandomCharIter::new(&mut *rng).take(10).collect::<String>();
1805 buffers.push(cx.new_model(|cx| {
1806 Buffer::new(0, BufferId::new(cx.entity_id().as_u64()).unwrap(), text)
1807 }));
1808 let buffer = buffers.last().unwrap().read(cx);
1809 log::info!(
1810 "Creating new buffer {} with text: {:?}",
1811 buffer.remote_id(),
1812 buffer.text()
1813 );
1814 buffers.last().unwrap().clone()
1815 } else {
1816 self.buffers
1817 .borrow()
1818 .values()
1819 .choose(rng)
1820 .unwrap()
1821 .buffer
1822 .clone()
1823 };
1824
1825 let buffer = buffer_handle.read(cx);
1826 let buffer_text = buffer.text();
1827 let ranges = (0..rng.gen_range(0..5))
1828 .map(|_| {
1829 let end_ix =
1830 buffer.clip_offset(rng.gen_range(0..=buffer.len()), Bias::Right);
1831 let start_ix = buffer.clip_offset(rng.gen_range(0..=end_ix), Bias::Left);
1832 ExcerptRange {
1833 context: start_ix..end_ix,
1834 primary: None,
1835 }
1836 })
1837 .collect::<Vec<_>>();
1838 log::info!(
1839 "Inserting excerpts from buffer {} and ranges {:?}: {:?}",
1840 buffer_handle.read(cx).remote_id(),
1841 ranges.iter().map(|r| &r.context).collect::<Vec<_>>(),
1842 ranges
1843 .iter()
1844 .map(|r| &buffer_text[r.context.clone()])
1845 .collect::<Vec<_>>()
1846 );
1847
1848 let excerpt_id = self.push_excerpts(buffer_handle.clone(), ranges, cx);
1849 log::info!("Inserted with ids: {:?}", excerpt_id);
1850 } else {
1851 let remove_count = rng.gen_range(1..=excerpt_ids.len());
1852 let mut excerpts_to_remove = excerpt_ids
1853 .choose_multiple(rng, remove_count)
1854 .cloned()
1855 .collect::<Vec<_>>();
1856 let snapshot = self.snapshot.borrow();
1857 excerpts_to_remove.sort_unstable_by(|a, b| a.cmp(b, &snapshot));
1858 drop(snapshot);
1859 log::info!("Removing excerpts {:?}", excerpts_to_remove);
1860 self.remove_excerpts(excerpts_to_remove, cx);
1861 }
1862 }
1863 }
1864
1865 pub fn randomly_mutate(
1866 &mut self,
1867 rng: &mut impl rand::Rng,
1868 mutation_count: usize,
1869 cx: &mut ModelContext<Self>,
1870 ) {
1871 use rand::prelude::*;
1872
1873 if rng.gen_bool(0.7) || self.singleton {
1874 let buffer = self
1875 .buffers
1876 .borrow()
1877 .values()
1878 .choose(rng)
1879 .map(|state| state.buffer.clone());
1880
1881 if let Some(buffer) = buffer {
1882 buffer.update(cx, |buffer, cx| {
1883 if rng.gen() {
1884 buffer.randomly_edit(rng, mutation_count, cx);
1885 } else {
1886 buffer.randomly_undo_redo(rng, cx);
1887 }
1888 });
1889 } else {
1890 self.randomly_edit(rng, mutation_count, cx);
1891 }
1892 } else {
1893 self.randomly_edit_excerpts(rng, mutation_count, cx);
1894 }
1895
1896 self.check_invariants(cx);
1897 }
1898
1899 fn check_invariants(&self, cx: &mut ModelContext<Self>) {
1900 let snapshot = self.read(cx);
1901 let excerpts = snapshot.excerpts.items(&());
1902 let excerpt_ids = snapshot.excerpt_ids.items(&());
1903
1904 for (ix, excerpt) in excerpts.iter().enumerate() {
1905 if ix == 0 {
1906 if excerpt.locator <= Locator::min() {
1907 panic!("invalid first excerpt locator {:?}", excerpt.locator);
1908 }
1909 } else {
1910 if excerpt.locator <= excerpts[ix - 1].locator {
1911 panic!("excerpts are out-of-order: {:?}", excerpts);
1912 }
1913 }
1914 }
1915
1916 for (ix, entry) in excerpt_ids.iter().enumerate() {
1917 if ix == 0 {
1918 if entry.id.cmp(&ExcerptId::min(), &snapshot).is_le() {
1919 panic!("invalid first excerpt id {:?}", entry.id);
1920 }
1921 } else {
1922 if entry.id <= excerpt_ids[ix - 1].id {
1923 panic!("excerpt ids are out-of-order: {:?}", excerpt_ids);
1924 }
1925 }
1926 }
1927 }
1928}
1929
1930impl EventEmitter<Event> for MultiBuffer {}
1931
1932impl MultiBufferSnapshot {
1933 pub fn text(&self) -> String {
1934 self.chunks(0..self.len(), false)
1935 .map(|chunk| chunk.text)
1936 .collect()
1937 }
1938
1939 pub fn reversed_chars_at<T: ToOffset>(&self, position: T) -> impl Iterator<Item = char> + '_ {
1940 let mut offset = position.to_offset(self);
1941 let mut cursor = self.excerpts.cursor::<usize>();
1942 cursor.seek(&offset, Bias::Left, &());
1943 let mut excerpt_chunks = cursor.item().map(|excerpt| {
1944 let end_before_footer = cursor.start() + excerpt.text_summary.len;
1945 let start = excerpt.range.context.start.to_offset(&excerpt.buffer);
1946 let end = start + (cmp::min(offset, end_before_footer) - cursor.start());
1947 excerpt.buffer.reversed_chunks_in_range(start..end)
1948 });
1949 iter::from_fn(move || {
1950 if offset == *cursor.start() {
1951 cursor.prev(&());
1952 let excerpt = cursor.item()?;
1953 excerpt_chunks = Some(
1954 excerpt
1955 .buffer
1956 .reversed_chunks_in_range(excerpt.range.context.clone()),
1957 );
1958 }
1959
1960 let excerpt = cursor.item().unwrap();
1961 if offset == cursor.end(&()) && excerpt.has_trailing_newline {
1962 offset -= 1;
1963 Some("\n")
1964 } else {
1965 let chunk = excerpt_chunks.as_mut().unwrap().next().unwrap();
1966 offset -= chunk.len();
1967 Some(chunk)
1968 }
1969 })
1970 .flat_map(|c| c.chars().rev())
1971 }
1972
1973 pub fn chars_at<T: ToOffset>(&self, position: T) -> impl Iterator<Item = char> + '_ {
1974 let offset = position.to_offset(self);
1975 self.text_for_range(offset..self.len())
1976 .flat_map(|chunk| chunk.chars())
1977 }
1978
1979 pub fn text_for_range<T: ToOffset>(&self, range: Range<T>) -> impl Iterator<Item = &str> + '_ {
1980 self.chunks(range, false).map(|chunk| chunk.text)
1981 }
1982
1983 pub fn is_line_blank(&self, row: u32) -> bool {
1984 self.text_for_range(Point::new(row, 0)..Point::new(row, self.line_len(row)))
1985 .all(|chunk| chunk.matches(|c: char| !c.is_whitespace()).next().is_none())
1986 }
1987
1988 pub fn contains_str_at<T>(&self, position: T, needle: &str) -> bool
1989 where
1990 T: ToOffset,
1991 {
1992 let position = position.to_offset(self);
1993 position == self.clip_offset(position, Bias::Left)
1994 && self
1995 .bytes_in_range(position..self.len())
1996 .flatten()
1997 .copied()
1998 .take(needle.len())
1999 .eq(needle.bytes())
2000 }
2001
2002 pub fn surrounding_word<T: ToOffset>(&self, start: T) -> (Range<usize>, Option<CharKind>) {
2003 let mut start = start.to_offset(self);
2004 let mut end = start;
2005 let mut next_chars = self.chars_at(start).peekable();
2006 let mut prev_chars = self.reversed_chars_at(start).peekable();
2007
2008 let scope = self.language_scope_at(start);
2009 let kind = |c| char_kind(&scope, c);
2010 let word_kind = cmp::max(
2011 prev_chars.peek().copied().map(kind),
2012 next_chars.peek().copied().map(kind),
2013 );
2014
2015 for ch in prev_chars {
2016 if Some(kind(ch)) == word_kind && ch != '\n' {
2017 start -= ch.len_utf8();
2018 } else {
2019 break;
2020 }
2021 }
2022
2023 for ch in next_chars {
2024 if Some(kind(ch)) == word_kind && ch != '\n' {
2025 end += ch.len_utf8();
2026 } else {
2027 break;
2028 }
2029 }
2030
2031 (start..end, word_kind)
2032 }
2033
2034 pub fn as_singleton(&self) -> Option<(&ExcerptId, BufferId, &BufferSnapshot)> {
2035 if self.singleton {
2036 self.excerpts
2037 .iter()
2038 .next()
2039 .map(|e| (&e.id, e.buffer_id, &e.buffer))
2040 } else {
2041 None
2042 }
2043 }
2044
2045 pub fn len(&self) -> usize {
2046 self.excerpts.summary().text.len
2047 }
2048
2049 pub fn is_empty(&self) -> bool {
2050 self.excerpts.summary().text.len == 0
2051 }
2052
2053 pub fn max_buffer_row(&self) -> u32 {
2054 self.excerpts.summary().max_buffer_row
2055 }
2056
2057 pub fn clip_offset(&self, offset: usize, bias: Bias) -> usize {
2058 if let Some((_, _, buffer)) = self.as_singleton() {
2059 return buffer.clip_offset(offset, bias);
2060 }
2061
2062 let mut cursor = self.excerpts.cursor::<usize>();
2063 cursor.seek(&offset, Bias::Right, &());
2064 let overshoot = if let Some(excerpt) = cursor.item() {
2065 let excerpt_start = excerpt.range.context.start.to_offset(&excerpt.buffer);
2066 let buffer_offset = excerpt
2067 .buffer
2068 .clip_offset(excerpt_start + (offset - cursor.start()), bias);
2069 buffer_offset.saturating_sub(excerpt_start)
2070 } else {
2071 0
2072 };
2073 cursor.start() + overshoot
2074 }
2075
2076 pub fn clip_point(&self, point: Point, bias: Bias) -> Point {
2077 if let Some((_, _, buffer)) = self.as_singleton() {
2078 return buffer.clip_point(point, bias);
2079 }
2080
2081 let mut cursor = self.excerpts.cursor::<Point>();
2082 cursor.seek(&point, Bias::Right, &());
2083 let overshoot = if let Some(excerpt) = cursor.item() {
2084 let excerpt_start = excerpt.range.context.start.to_point(&excerpt.buffer);
2085 let buffer_point = excerpt
2086 .buffer
2087 .clip_point(excerpt_start + (point - cursor.start()), bias);
2088 buffer_point.saturating_sub(excerpt_start)
2089 } else {
2090 Point::zero()
2091 };
2092 *cursor.start() + overshoot
2093 }
2094
2095 pub fn clip_offset_utf16(&self, offset: OffsetUtf16, bias: Bias) -> OffsetUtf16 {
2096 if let Some((_, _, buffer)) = self.as_singleton() {
2097 return buffer.clip_offset_utf16(offset, bias);
2098 }
2099
2100 let mut cursor = self.excerpts.cursor::<OffsetUtf16>();
2101 cursor.seek(&offset, Bias::Right, &());
2102 let overshoot = if let Some(excerpt) = cursor.item() {
2103 let excerpt_start = excerpt.range.context.start.to_offset_utf16(&excerpt.buffer);
2104 let buffer_offset = excerpt
2105 .buffer
2106 .clip_offset_utf16(excerpt_start + (offset - cursor.start()), bias);
2107 OffsetUtf16(buffer_offset.0.saturating_sub(excerpt_start.0))
2108 } else {
2109 OffsetUtf16(0)
2110 };
2111 *cursor.start() + overshoot
2112 }
2113
2114 pub fn clip_point_utf16(&self, point: Unclipped<PointUtf16>, bias: Bias) -> PointUtf16 {
2115 if let Some((_, _, buffer)) = self.as_singleton() {
2116 return buffer.clip_point_utf16(point, bias);
2117 }
2118
2119 let mut cursor = self.excerpts.cursor::<PointUtf16>();
2120 cursor.seek(&point.0, Bias::Right, &());
2121 let overshoot = if let Some(excerpt) = cursor.item() {
2122 let excerpt_start = excerpt
2123 .buffer
2124 .offset_to_point_utf16(excerpt.range.context.start.to_offset(&excerpt.buffer));
2125 let buffer_point = excerpt
2126 .buffer
2127 .clip_point_utf16(Unclipped(excerpt_start + (point.0 - cursor.start())), bias);
2128 buffer_point.saturating_sub(excerpt_start)
2129 } else {
2130 PointUtf16::zero()
2131 };
2132 *cursor.start() + overshoot
2133 }
2134
2135 pub fn bytes_in_range<T: ToOffset>(&self, range: Range<T>) -> MultiBufferBytes {
2136 let range = range.start.to_offset(self)..range.end.to_offset(self);
2137 let mut excerpts = self.excerpts.cursor::<usize>();
2138 excerpts.seek(&range.start, Bias::Right, &());
2139
2140 let mut chunk = &[][..];
2141 let excerpt_bytes = if let Some(excerpt) = excerpts.item() {
2142 let mut excerpt_bytes = excerpt
2143 .bytes_in_range(range.start - excerpts.start()..range.end - excerpts.start());
2144 chunk = excerpt_bytes.next().unwrap_or(&[][..]);
2145 Some(excerpt_bytes)
2146 } else {
2147 None
2148 };
2149 MultiBufferBytes {
2150 range,
2151 excerpts,
2152 excerpt_bytes,
2153 chunk,
2154 }
2155 }
2156
2157 pub fn reversed_bytes_in_range<T: ToOffset>(
2158 &self,
2159 range: Range<T>,
2160 ) -> ReversedMultiBufferBytes {
2161 let range = range.start.to_offset(self)..range.end.to_offset(self);
2162 let mut excerpts = self.excerpts.cursor::<usize>();
2163 excerpts.seek(&range.end, Bias::Left, &());
2164
2165 let mut chunk = &[][..];
2166 let excerpt_bytes = if let Some(excerpt) = excerpts.item() {
2167 let mut excerpt_bytes = excerpt.reversed_bytes_in_range(
2168 range.start.saturating_sub(*excerpts.start())..range.end - *excerpts.start(),
2169 );
2170 chunk = excerpt_bytes.next().unwrap_or(&[][..]);
2171 Some(excerpt_bytes)
2172 } else {
2173 None
2174 };
2175
2176 ReversedMultiBufferBytes {
2177 range,
2178 excerpts,
2179 excerpt_bytes,
2180 chunk,
2181 }
2182 }
2183
2184 pub fn buffer_rows(&self, start_row: u32) -> MultiBufferRows {
2185 let mut result = MultiBufferRows {
2186 buffer_row_range: 0..0,
2187 excerpts: self.excerpts.cursor(),
2188 };
2189 result.seek(start_row);
2190 result
2191 }
2192
2193 pub fn chunks<T: ToOffset>(&self, range: Range<T>, language_aware: bool) -> MultiBufferChunks {
2194 let range = range.start.to_offset(self)..range.end.to_offset(self);
2195 let mut chunks = MultiBufferChunks {
2196 range: range.clone(),
2197 excerpts: self.excerpts.cursor(),
2198 excerpt_chunks: None,
2199 language_aware,
2200 };
2201 chunks.seek(range.start);
2202 chunks
2203 }
2204
2205 pub fn offset_to_point(&self, offset: usize) -> Point {
2206 if let Some((_, _, buffer)) = self.as_singleton() {
2207 return buffer.offset_to_point(offset);
2208 }
2209
2210 let mut cursor = self.excerpts.cursor::<(usize, Point)>();
2211 cursor.seek(&offset, Bias::Right, &());
2212 if let Some(excerpt) = cursor.item() {
2213 let (start_offset, start_point) = cursor.start();
2214 let overshoot = offset - start_offset;
2215 let excerpt_start_offset = excerpt.range.context.start.to_offset(&excerpt.buffer);
2216 let excerpt_start_point = excerpt.range.context.start.to_point(&excerpt.buffer);
2217 let buffer_point = excerpt
2218 .buffer
2219 .offset_to_point(excerpt_start_offset + overshoot);
2220 *start_point + (buffer_point - excerpt_start_point)
2221 } else {
2222 self.excerpts.summary().text.lines
2223 }
2224 }
2225
2226 pub fn offset_to_point_utf16(&self, offset: usize) -> PointUtf16 {
2227 if let Some((_, _, buffer)) = self.as_singleton() {
2228 return buffer.offset_to_point_utf16(offset);
2229 }
2230
2231 let mut cursor = self.excerpts.cursor::<(usize, PointUtf16)>();
2232 cursor.seek(&offset, Bias::Right, &());
2233 if let Some(excerpt) = cursor.item() {
2234 let (start_offset, start_point) = cursor.start();
2235 let overshoot = offset - start_offset;
2236 let excerpt_start_offset = excerpt.range.context.start.to_offset(&excerpt.buffer);
2237 let excerpt_start_point = excerpt.range.context.start.to_point_utf16(&excerpt.buffer);
2238 let buffer_point = excerpt
2239 .buffer
2240 .offset_to_point_utf16(excerpt_start_offset + overshoot);
2241 *start_point + (buffer_point - excerpt_start_point)
2242 } else {
2243 self.excerpts.summary().text.lines_utf16()
2244 }
2245 }
2246
2247 pub fn point_to_point_utf16(&self, point: Point) -> PointUtf16 {
2248 if let Some((_, _, buffer)) = self.as_singleton() {
2249 return buffer.point_to_point_utf16(point);
2250 }
2251
2252 let mut cursor = self.excerpts.cursor::<(Point, PointUtf16)>();
2253 cursor.seek(&point, Bias::Right, &());
2254 if let Some(excerpt) = cursor.item() {
2255 let (start_offset, start_point) = cursor.start();
2256 let overshoot = point - start_offset;
2257 let excerpt_start_point = excerpt.range.context.start.to_point(&excerpt.buffer);
2258 let excerpt_start_point_utf16 =
2259 excerpt.range.context.start.to_point_utf16(&excerpt.buffer);
2260 let buffer_point = excerpt
2261 .buffer
2262 .point_to_point_utf16(excerpt_start_point + overshoot);
2263 *start_point + (buffer_point - excerpt_start_point_utf16)
2264 } else {
2265 self.excerpts.summary().text.lines_utf16()
2266 }
2267 }
2268
2269 pub fn point_to_offset(&self, point: Point) -> usize {
2270 if let Some((_, _, buffer)) = self.as_singleton() {
2271 return buffer.point_to_offset(point);
2272 }
2273
2274 let mut cursor = self.excerpts.cursor::<(Point, usize)>();
2275 cursor.seek(&point, Bias::Right, &());
2276 if let Some(excerpt) = cursor.item() {
2277 let (start_point, start_offset) = cursor.start();
2278 let overshoot = point - start_point;
2279 let excerpt_start_offset = excerpt.range.context.start.to_offset(&excerpt.buffer);
2280 let excerpt_start_point = excerpt.range.context.start.to_point(&excerpt.buffer);
2281 let buffer_offset = excerpt
2282 .buffer
2283 .point_to_offset(excerpt_start_point + overshoot);
2284 *start_offset + buffer_offset - excerpt_start_offset
2285 } else {
2286 self.excerpts.summary().text.len
2287 }
2288 }
2289
2290 pub fn offset_utf16_to_offset(&self, offset_utf16: OffsetUtf16) -> usize {
2291 if let Some((_, _, buffer)) = self.as_singleton() {
2292 return buffer.offset_utf16_to_offset(offset_utf16);
2293 }
2294
2295 let mut cursor = self.excerpts.cursor::<(OffsetUtf16, usize)>();
2296 cursor.seek(&offset_utf16, Bias::Right, &());
2297 if let Some(excerpt) = cursor.item() {
2298 let (start_offset_utf16, start_offset) = cursor.start();
2299 let overshoot = offset_utf16 - start_offset_utf16;
2300 let excerpt_start_offset = excerpt.range.context.start.to_offset(&excerpt.buffer);
2301 let excerpt_start_offset_utf16 =
2302 excerpt.buffer.offset_to_offset_utf16(excerpt_start_offset);
2303 let buffer_offset = excerpt
2304 .buffer
2305 .offset_utf16_to_offset(excerpt_start_offset_utf16 + overshoot);
2306 *start_offset + (buffer_offset - excerpt_start_offset)
2307 } else {
2308 self.excerpts.summary().text.len
2309 }
2310 }
2311
2312 pub fn offset_to_offset_utf16(&self, offset: usize) -> OffsetUtf16 {
2313 if let Some((_, _, buffer)) = self.as_singleton() {
2314 return buffer.offset_to_offset_utf16(offset);
2315 }
2316
2317 let mut cursor = self.excerpts.cursor::<(usize, OffsetUtf16)>();
2318 cursor.seek(&offset, Bias::Right, &());
2319 if let Some(excerpt) = cursor.item() {
2320 let (start_offset, start_offset_utf16) = cursor.start();
2321 let overshoot = offset - start_offset;
2322 let excerpt_start_offset_utf16 =
2323 excerpt.range.context.start.to_offset_utf16(&excerpt.buffer);
2324 let excerpt_start_offset = excerpt
2325 .buffer
2326 .offset_utf16_to_offset(excerpt_start_offset_utf16);
2327 let buffer_offset_utf16 = excerpt
2328 .buffer
2329 .offset_to_offset_utf16(excerpt_start_offset + overshoot);
2330 *start_offset_utf16 + (buffer_offset_utf16 - excerpt_start_offset_utf16)
2331 } else {
2332 self.excerpts.summary().text.len_utf16
2333 }
2334 }
2335
2336 pub fn point_utf16_to_offset(&self, point: PointUtf16) -> usize {
2337 if let Some((_, _, buffer)) = self.as_singleton() {
2338 return buffer.point_utf16_to_offset(point);
2339 }
2340
2341 let mut cursor = self.excerpts.cursor::<(PointUtf16, usize)>();
2342 cursor.seek(&point, Bias::Right, &());
2343 if let Some(excerpt) = cursor.item() {
2344 let (start_point, start_offset) = cursor.start();
2345 let overshoot = point - start_point;
2346 let excerpt_start_offset = excerpt.range.context.start.to_offset(&excerpt.buffer);
2347 let excerpt_start_point = excerpt
2348 .buffer
2349 .offset_to_point_utf16(excerpt.range.context.start.to_offset(&excerpt.buffer));
2350 let buffer_offset = excerpt
2351 .buffer
2352 .point_utf16_to_offset(excerpt_start_point + overshoot);
2353 *start_offset + (buffer_offset - excerpt_start_offset)
2354 } else {
2355 self.excerpts.summary().text.len
2356 }
2357 }
2358
2359 pub fn point_to_buffer_offset<T: ToOffset>(
2360 &self,
2361 point: T,
2362 ) -> Option<(&BufferSnapshot, usize)> {
2363 let offset = point.to_offset(self);
2364 let mut cursor = self.excerpts.cursor::<usize>();
2365 cursor.seek(&offset, Bias::Right, &());
2366 if cursor.item().is_none() {
2367 cursor.prev(&());
2368 }
2369
2370 cursor.item().map(|excerpt| {
2371 let excerpt_start = excerpt.range.context.start.to_offset(&excerpt.buffer);
2372 let buffer_point = excerpt_start + offset - *cursor.start();
2373 (&excerpt.buffer, buffer_point)
2374 })
2375 }
2376
2377 pub fn suggested_indents(
2378 &self,
2379 rows: impl IntoIterator<Item = u32>,
2380 cx: &AppContext,
2381 ) -> BTreeMap<u32, IndentSize> {
2382 let mut result = BTreeMap::new();
2383
2384 let mut rows_for_excerpt = Vec::new();
2385 let mut cursor = self.excerpts.cursor::<Point>();
2386 let mut rows = rows.into_iter().peekable();
2387 let mut prev_row = u32::MAX;
2388 let mut prev_language_indent_size = IndentSize::default();
2389
2390 while let Some(row) = rows.next() {
2391 cursor.seek(&Point::new(row, 0), Bias::Right, &());
2392 let excerpt = match cursor.item() {
2393 Some(excerpt) => excerpt,
2394 _ => continue,
2395 };
2396
2397 // Retrieve the language and indent size once for each disjoint region being indented.
2398 let single_indent_size = if row.saturating_sub(1) == prev_row {
2399 prev_language_indent_size
2400 } else {
2401 excerpt
2402 .buffer
2403 .language_indent_size_at(Point::new(row, 0), cx)
2404 };
2405 prev_language_indent_size = single_indent_size;
2406 prev_row = row;
2407
2408 let start_buffer_row = excerpt.range.context.start.to_point(&excerpt.buffer).row;
2409 let start_multibuffer_row = cursor.start().row;
2410
2411 rows_for_excerpt.push(row);
2412 while let Some(next_row) = rows.peek().copied() {
2413 if cursor.end(&()).row > next_row {
2414 rows_for_excerpt.push(next_row);
2415 rows.next();
2416 } else {
2417 break;
2418 }
2419 }
2420
2421 let buffer_rows = rows_for_excerpt
2422 .drain(..)
2423 .map(|row| start_buffer_row + row - start_multibuffer_row);
2424 let buffer_indents = excerpt
2425 .buffer
2426 .suggested_indents(buffer_rows, single_indent_size);
2427 let multibuffer_indents = buffer_indents
2428 .into_iter()
2429 .map(|(row, indent)| (start_multibuffer_row + row - start_buffer_row, indent));
2430 result.extend(multibuffer_indents);
2431 }
2432
2433 result
2434 }
2435
2436 pub fn indent_size_for_line(&self, row: u32) -> IndentSize {
2437 if let Some((buffer, range)) = self.buffer_line_for_row(row) {
2438 let mut size = buffer.indent_size_for_line(range.start.row);
2439 size.len = size
2440 .len
2441 .min(range.end.column)
2442 .saturating_sub(range.start.column);
2443 size
2444 } else {
2445 IndentSize::spaces(0)
2446 }
2447 }
2448
2449 pub fn prev_non_blank_row(&self, mut row: u32) -> Option<u32> {
2450 while row > 0 {
2451 row -= 1;
2452 if !self.is_line_blank(row) {
2453 return Some(row);
2454 }
2455 }
2456 None
2457 }
2458
2459 pub fn line_len(&self, row: u32) -> u32 {
2460 if let Some((_, range)) = self.buffer_line_for_row(row) {
2461 range.end.column - range.start.column
2462 } else {
2463 0
2464 }
2465 }
2466
2467 pub fn buffer_line_for_row(&self, row: u32) -> Option<(&BufferSnapshot, Range<Point>)> {
2468 let mut cursor = self.excerpts.cursor::<Point>();
2469 let point = Point::new(row, 0);
2470 cursor.seek(&point, Bias::Right, &());
2471 if cursor.item().is_none() && *cursor.start() == point {
2472 cursor.prev(&());
2473 }
2474 if let Some(excerpt) = cursor.item() {
2475 let overshoot = row - cursor.start().row;
2476 let excerpt_start = excerpt.range.context.start.to_point(&excerpt.buffer);
2477 let excerpt_end = excerpt.range.context.end.to_point(&excerpt.buffer);
2478 let buffer_row = excerpt_start.row + overshoot;
2479 let line_start = Point::new(buffer_row, 0);
2480 let line_end = Point::new(buffer_row, excerpt.buffer.line_len(buffer_row));
2481 return Some((
2482 &excerpt.buffer,
2483 line_start.max(excerpt_start)..line_end.min(excerpt_end),
2484 ));
2485 }
2486 None
2487 }
2488
2489 pub fn max_point(&self) -> Point {
2490 self.text_summary().lines
2491 }
2492
2493 pub fn text_summary(&self) -> TextSummary {
2494 self.excerpts.summary().text.clone()
2495 }
2496
2497 pub fn text_summary_for_range<D, O>(&self, range: Range<O>) -> D
2498 where
2499 D: TextDimension,
2500 O: ToOffset,
2501 {
2502 let mut summary = D::default();
2503 let mut range = range.start.to_offset(self)..range.end.to_offset(self);
2504 let mut cursor = self.excerpts.cursor::<usize>();
2505 cursor.seek(&range.start, Bias::Right, &());
2506 if let Some(excerpt) = cursor.item() {
2507 let mut end_before_newline = cursor.end(&());
2508 if excerpt.has_trailing_newline {
2509 end_before_newline -= 1;
2510 }
2511
2512 let excerpt_start = excerpt.range.context.start.to_offset(&excerpt.buffer);
2513 let start_in_excerpt = excerpt_start + (range.start - cursor.start());
2514 let end_in_excerpt =
2515 excerpt_start + (cmp::min(end_before_newline, range.end) - cursor.start());
2516 summary.add_assign(
2517 &excerpt
2518 .buffer
2519 .text_summary_for_range(start_in_excerpt..end_in_excerpt),
2520 );
2521
2522 if range.end > end_before_newline {
2523 summary.add_assign(&D::from_text_summary(&TextSummary::from("\n")));
2524 }
2525
2526 cursor.next(&());
2527 }
2528
2529 if range.end > *cursor.start() {
2530 summary.add_assign(&D::from_text_summary(&cursor.summary::<_, TextSummary>(
2531 &range.end,
2532 Bias::Right,
2533 &(),
2534 )));
2535 if let Some(excerpt) = cursor.item() {
2536 range.end = cmp::max(*cursor.start(), range.end);
2537
2538 let excerpt_start = excerpt.range.context.start.to_offset(&excerpt.buffer);
2539 let end_in_excerpt = excerpt_start + (range.end - cursor.start());
2540 summary.add_assign(
2541 &excerpt
2542 .buffer
2543 .text_summary_for_range(excerpt_start..end_in_excerpt),
2544 );
2545 }
2546 }
2547
2548 summary
2549 }
2550
2551 pub fn summary_for_anchor<D>(&self, anchor: &Anchor) -> D
2552 where
2553 D: TextDimension + Ord + Sub<D, Output = D>,
2554 {
2555 let mut cursor = self.excerpts.cursor::<ExcerptSummary>();
2556 let locator = self.excerpt_locator_for_id(anchor.excerpt_id);
2557
2558 cursor.seek(locator, Bias::Left, &());
2559 if cursor.item().is_none() {
2560 cursor.next(&());
2561 }
2562
2563 let mut position = D::from_text_summary(&cursor.start().text);
2564 if let Some(excerpt) = cursor.item() {
2565 if excerpt.id == anchor.excerpt_id {
2566 let excerpt_buffer_start =
2567 excerpt.range.context.start.summary::<D>(&excerpt.buffer);
2568 let excerpt_buffer_end = excerpt.range.context.end.summary::<D>(&excerpt.buffer);
2569 let buffer_position = cmp::min(
2570 excerpt_buffer_end,
2571 anchor.text_anchor.summary::<D>(&excerpt.buffer),
2572 );
2573 if buffer_position > excerpt_buffer_start {
2574 position.add_assign(&(buffer_position - excerpt_buffer_start));
2575 }
2576 }
2577 }
2578 position
2579 }
2580
2581 pub fn summaries_for_anchors<'a, D, I>(&'a self, anchors: I) -> Vec<D>
2582 where
2583 D: TextDimension + Ord + Sub<D, Output = D>,
2584 I: 'a + IntoIterator<Item = &'a Anchor>,
2585 {
2586 if let Some((_, _, buffer)) = self.as_singleton() {
2587 return buffer
2588 .summaries_for_anchors(anchors.into_iter().map(|a| &a.text_anchor))
2589 .collect();
2590 }
2591
2592 let mut anchors = anchors.into_iter().peekable();
2593 let mut cursor = self.excerpts.cursor::<ExcerptSummary>();
2594 let mut summaries = Vec::new();
2595 while let Some(anchor) = anchors.peek() {
2596 let excerpt_id = anchor.excerpt_id;
2597 let excerpt_anchors = iter::from_fn(|| {
2598 let anchor = anchors.peek()?;
2599 if anchor.excerpt_id == excerpt_id {
2600 Some(&anchors.next().unwrap().text_anchor)
2601 } else {
2602 None
2603 }
2604 });
2605
2606 let locator = self.excerpt_locator_for_id(excerpt_id);
2607 cursor.seek_forward(locator, Bias::Left, &());
2608 if cursor.item().is_none() {
2609 cursor.next(&());
2610 }
2611
2612 let position = D::from_text_summary(&cursor.start().text);
2613 if let Some(excerpt) = cursor.item() {
2614 if excerpt.id == excerpt_id {
2615 let excerpt_buffer_start =
2616 excerpt.range.context.start.summary::<D>(&excerpt.buffer);
2617 let excerpt_buffer_end =
2618 excerpt.range.context.end.summary::<D>(&excerpt.buffer);
2619 summaries.extend(
2620 excerpt
2621 .buffer
2622 .summaries_for_anchors::<D, _>(excerpt_anchors)
2623 .map(move |summary| {
2624 let summary = cmp::min(excerpt_buffer_end.clone(), summary);
2625 let mut position = position.clone();
2626 let excerpt_buffer_start = excerpt_buffer_start.clone();
2627 if summary > excerpt_buffer_start {
2628 position.add_assign(&(summary - excerpt_buffer_start));
2629 }
2630 position
2631 }),
2632 );
2633 continue;
2634 }
2635 }
2636
2637 summaries.extend(excerpt_anchors.map(|_| position.clone()));
2638 }
2639
2640 summaries
2641 }
2642
2643 pub fn refresh_anchors<'a, I>(&'a self, anchors: I) -> Vec<(usize, Anchor, bool)>
2644 where
2645 I: 'a + IntoIterator<Item = &'a Anchor>,
2646 {
2647 let mut anchors = anchors.into_iter().enumerate().peekable();
2648 let mut cursor = self.excerpts.cursor::<Option<&Locator>>();
2649 cursor.next(&());
2650
2651 let mut result = Vec::new();
2652
2653 while let Some((_, anchor)) = anchors.peek() {
2654 let old_excerpt_id = anchor.excerpt_id;
2655
2656 // Find the location where this anchor's excerpt should be.
2657 let old_locator = self.excerpt_locator_for_id(old_excerpt_id);
2658 cursor.seek_forward(&Some(old_locator), Bias::Left, &());
2659
2660 if cursor.item().is_none() {
2661 cursor.next(&());
2662 }
2663
2664 let next_excerpt = cursor.item();
2665 let prev_excerpt = cursor.prev_item();
2666
2667 // Process all of the anchors for this excerpt.
2668 while let Some((_, anchor)) = anchors.peek() {
2669 if anchor.excerpt_id != old_excerpt_id {
2670 break;
2671 }
2672 let (anchor_ix, anchor) = anchors.next().unwrap();
2673 let mut anchor = *anchor;
2674
2675 // Leave min and max anchors unchanged if invalid or
2676 // if the old excerpt still exists at this location
2677 let mut kept_position = next_excerpt
2678 .map_or(false, |e| e.id == old_excerpt_id && e.contains(&anchor))
2679 || old_excerpt_id == ExcerptId::max()
2680 || old_excerpt_id == ExcerptId::min();
2681
2682 // If the old excerpt no longer exists at this location, then attempt to
2683 // find an equivalent position for this anchor in an adjacent excerpt.
2684 if !kept_position {
2685 for excerpt in [next_excerpt, prev_excerpt].iter().filter_map(|e| *e) {
2686 if excerpt.contains(&anchor) {
2687 anchor.excerpt_id = excerpt.id;
2688 kept_position = true;
2689 break;
2690 }
2691 }
2692 }
2693
2694 // If there's no adjacent excerpt that contains the anchor's position,
2695 // then report that the anchor has lost its position.
2696 if !kept_position {
2697 anchor = if let Some(excerpt) = next_excerpt {
2698 let mut text_anchor = excerpt
2699 .range
2700 .context
2701 .start
2702 .bias(anchor.text_anchor.bias, &excerpt.buffer);
2703 if text_anchor
2704 .cmp(&excerpt.range.context.end, &excerpt.buffer)
2705 .is_gt()
2706 {
2707 text_anchor = excerpt.range.context.end;
2708 }
2709 Anchor {
2710 buffer_id: Some(excerpt.buffer_id),
2711 excerpt_id: excerpt.id,
2712 text_anchor,
2713 }
2714 } else if let Some(excerpt) = prev_excerpt {
2715 let mut text_anchor = excerpt
2716 .range
2717 .context
2718 .end
2719 .bias(anchor.text_anchor.bias, &excerpt.buffer);
2720 if text_anchor
2721 .cmp(&excerpt.range.context.start, &excerpt.buffer)
2722 .is_lt()
2723 {
2724 text_anchor = excerpt.range.context.start;
2725 }
2726 Anchor {
2727 buffer_id: Some(excerpt.buffer_id),
2728 excerpt_id: excerpt.id,
2729 text_anchor,
2730 }
2731 } else if anchor.text_anchor.bias == Bias::Left {
2732 Anchor::min()
2733 } else {
2734 Anchor::max()
2735 };
2736 }
2737
2738 result.push((anchor_ix, anchor, kept_position));
2739 }
2740 }
2741 result.sort_unstable_by(|a, b| a.1.cmp(&b.1, self));
2742 result
2743 }
2744
2745 pub fn anchor_before<T: ToOffset>(&self, position: T) -> Anchor {
2746 self.anchor_at(position, Bias::Left)
2747 }
2748
2749 pub fn anchor_after<T: ToOffset>(&self, position: T) -> Anchor {
2750 self.anchor_at(position, Bias::Right)
2751 }
2752
2753 pub fn anchor_at<T: ToOffset>(&self, position: T, mut bias: Bias) -> Anchor {
2754 let offset = position.to_offset(self);
2755 if let Some((excerpt_id, buffer_id, buffer)) = self.as_singleton() {
2756 return Anchor {
2757 buffer_id: Some(buffer_id),
2758 excerpt_id: *excerpt_id,
2759 text_anchor: buffer.anchor_at(offset, bias),
2760 };
2761 }
2762
2763 let mut cursor = self.excerpts.cursor::<(usize, Option<ExcerptId>)>();
2764 cursor.seek(&offset, Bias::Right, &());
2765 if cursor.item().is_none() && offset == cursor.start().0 && bias == Bias::Left {
2766 cursor.prev(&());
2767 }
2768 if let Some(excerpt) = cursor.item() {
2769 let mut overshoot = offset.saturating_sub(cursor.start().0);
2770 if excerpt.has_trailing_newline && offset == cursor.end(&()).0 {
2771 overshoot -= 1;
2772 bias = Bias::Right;
2773 }
2774
2775 let buffer_start = excerpt.range.context.start.to_offset(&excerpt.buffer);
2776 let text_anchor =
2777 excerpt.clip_anchor(excerpt.buffer.anchor_at(buffer_start + overshoot, bias));
2778 Anchor {
2779 buffer_id: Some(excerpt.buffer_id),
2780 excerpt_id: excerpt.id,
2781 text_anchor,
2782 }
2783 } else if offset == 0 && bias == Bias::Left {
2784 Anchor::min()
2785 } else {
2786 Anchor::max()
2787 }
2788 }
2789
2790 /// Returns an anchor for the given excerpt and text anchor,
2791 /// returns None if the excerpt_id is no longer valid.
2792 pub fn anchor_in_excerpt(
2793 &self,
2794 excerpt_id: ExcerptId,
2795 text_anchor: text::Anchor,
2796 ) -> Option<Anchor> {
2797 let locator = self.excerpt_locator_for_id(excerpt_id);
2798 let mut cursor = self.excerpts.cursor::<Option<&Locator>>();
2799 cursor.seek(locator, Bias::Left, &());
2800 if let Some(excerpt) = cursor.item() {
2801 if excerpt.id == excerpt_id {
2802 let text_anchor = excerpt.clip_anchor(text_anchor);
2803 drop(cursor);
2804 return Some(Anchor {
2805 buffer_id: Some(excerpt.buffer_id),
2806 excerpt_id,
2807 text_anchor,
2808 });
2809 }
2810 }
2811 None
2812 }
2813
2814 pub fn can_resolve(&self, anchor: &Anchor) -> bool {
2815 if anchor.excerpt_id == ExcerptId::min() || anchor.excerpt_id == ExcerptId::max() {
2816 true
2817 } else if let Some(excerpt) = self.excerpt(anchor.excerpt_id) {
2818 excerpt.buffer.can_resolve(&anchor.text_anchor)
2819 } else {
2820 false
2821 }
2822 }
2823
2824 pub fn excerpts(
2825 &self,
2826 ) -> impl Iterator<Item = (ExcerptId, &BufferSnapshot, ExcerptRange<text::Anchor>)> {
2827 self.excerpts
2828 .iter()
2829 .map(|excerpt| (excerpt.id, &excerpt.buffer, excerpt.range.clone()))
2830 }
2831
2832 fn excerpts_for_range<T: ToOffset>(
2833 &self,
2834 range: Range<T>,
2835 ) -> impl Iterator<Item = (&Excerpt, usize)> + '_ {
2836 let range = range.start.to_offset(self)..range.end.to_offset(self);
2837
2838 let mut cursor = self.excerpts.cursor::<usize>();
2839 cursor.seek(&range.start, Bias::Right, &());
2840 cursor.prev(&());
2841
2842 iter::from_fn(move || {
2843 cursor.next(&());
2844 if cursor.start() < &range.end {
2845 cursor.item().map(|item| (item, *cursor.start()))
2846 } else {
2847 None
2848 }
2849 })
2850 }
2851
2852 pub fn excerpt_boundaries_in_range<R, T>(
2853 &self,
2854 range: R,
2855 ) -> impl Iterator<Item = ExcerptBoundary> + '_
2856 where
2857 R: RangeBounds<T>,
2858 T: ToOffset,
2859 {
2860 let start_offset;
2861 let start = match range.start_bound() {
2862 Bound::Included(start) => {
2863 start_offset = start.to_offset(self);
2864 Bound::Included(start_offset)
2865 }
2866 Bound::Excluded(start) => {
2867 start_offset = start.to_offset(self);
2868 Bound::Excluded(start_offset)
2869 }
2870 Bound::Unbounded => {
2871 start_offset = 0;
2872 Bound::Unbounded
2873 }
2874 };
2875 let end = match range.end_bound() {
2876 Bound::Included(end) => Bound::Included(end.to_offset(self)),
2877 Bound::Excluded(end) => Bound::Excluded(end.to_offset(self)),
2878 Bound::Unbounded => Bound::Unbounded,
2879 };
2880 let bounds = (start, end);
2881
2882 let mut cursor = self.excerpts.cursor::<(usize, Point)>();
2883 cursor.seek(&start_offset, Bias::Right, &());
2884 if cursor.item().is_none() {
2885 cursor.prev(&());
2886 }
2887 if !bounds.contains(&cursor.start().0) {
2888 cursor.next(&());
2889 }
2890
2891 let mut prev_buffer_id = cursor.prev_item().map(|excerpt| excerpt.buffer_id);
2892 std::iter::from_fn(move || {
2893 if self.singleton {
2894 None
2895 } else if bounds.contains(&cursor.start().0) {
2896 let excerpt = cursor.item()?;
2897 let starts_new_buffer = Some(excerpt.buffer_id) != prev_buffer_id;
2898 let boundary = ExcerptBoundary {
2899 id: excerpt.id,
2900 row: cursor.start().1.row,
2901 buffer: excerpt.buffer.clone(),
2902 range: excerpt.range.clone(),
2903 starts_new_buffer,
2904 };
2905
2906 prev_buffer_id = Some(excerpt.buffer_id);
2907 cursor.next(&());
2908 Some(boundary)
2909 } else {
2910 None
2911 }
2912 })
2913 }
2914
2915 pub fn edit_count(&self) -> usize {
2916 self.edit_count
2917 }
2918
2919 pub fn parse_count(&self) -> usize {
2920 self.parse_count
2921 }
2922
2923 /// Returns the smallest enclosing bracket ranges containing the given range or
2924 /// None if no brackets contain range or the range is not contained in a single
2925 /// excerpt
2926 ///
2927 /// Can optionally pass a range_filter to filter the ranges of brackets to consider
2928 pub fn innermost_enclosing_bracket_ranges<T: ToOffset>(
2929 &self,
2930 range: Range<T>,
2931 range_filter: Option<&dyn Fn(Range<usize>, Range<usize>) -> bool>,
2932 ) -> Option<(Range<usize>, Range<usize>)> {
2933 let range = range.start.to_offset(self)..range.end.to_offset(self);
2934 let excerpt = self.excerpt_containing(range.clone())?;
2935
2936 // Filter to ranges contained in the excerpt
2937 let range_filter = |open: Range<usize>, close: Range<usize>| -> bool {
2938 excerpt.contains_buffer_range(open.start..close.end)
2939 && range_filter.map_or(true, |filter| {
2940 filter(
2941 excerpt.map_range_from_buffer(open),
2942 excerpt.map_range_from_buffer(close),
2943 )
2944 })
2945 };
2946
2947 let (open, close) = excerpt.buffer().innermost_enclosing_bracket_ranges(
2948 excerpt.map_range_to_buffer(range),
2949 Some(&range_filter),
2950 )?;
2951
2952 Some((
2953 excerpt.map_range_from_buffer(open),
2954 excerpt.map_range_from_buffer(close),
2955 ))
2956 }
2957
2958 /// Returns enclosing bracket ranges containing the given range or returns None if the range is
2959 /// not contained in a single excerpt
2960 pub fn enclosing_bracket_ranges<T: ToOffset>(
2961 &self,
2962 range: Range<T>,
2963 ) -> Option<impl Iterator<Item = (Range<usize>, Range<usize>)> + '_> {
2964 let range = range.start.to_offset(self)..range.end.to_offset(self);
2965 let excerpt = self.excerpt_containing(range.clone())?;
2966
2967 Some(
2968 excerpt
2969 .buffer()
2970 .enclosing_bracket_ranges(excerpt.map_range_to_buffer(range))
2971 .filter_map(move |(open, close)| {
2972 if excerpt.contains_buffer_range(open.start..close.end) {
2973 Some((
2974 excerpt.map_range_from_buffer(open),
2975 excerpt.map_range_from_buffer(close),
2976 ))
2977 } else {
2978 None
2979 }
2980 }),
2981 )
2982 }
2983
2984 /// Returns bracket range pairs overlapping the given `range` or returns None if the `range` is
2985 /// not contained in a single excerpt
2986 pub fn bracket_ranges<T: ToOffset>(
2987 &self,
2988 range: Range<T>,
2989 ) -> Option<impl Iterator<Item = (Range<usize>, Range<usize>)> + '_> {
2990 let range = range.start.to_offset(self)..range.end.to_offset(self);
2991 let excerpt = self.excerpt_containing(range.clone())?;
2992
2993 Some(
2994 excerpt
2995 .buffer()
2996 .bracket_ranges(excerpt.map_range_to_buffer(range))
2997 .filter_map(move |(start_bracket_range, close_bracket_range)| {
2998 let buffer_range = start_bracket_range.start..close_bracket_range.end;
2999 if excerpt.contains_buffer_range(buffer_range) {
3000 Some((
3001 excerpt.map_range_from_buffer(start_bracket_range),
3002 excerpt.map_range_from_buffer(close_bracket_range),
3003 ))
3004 } else {
3005 None
3006 }
3007 }),
3008 )
3009 }
3010
3011 pub fn redacted_ranges<'a, T: ToOffset>(
3012 &'a self,
3013 range: Range<T>,
3014 redaction_enabled: impl Fn(Option<&Arc<dyn File>>) -> bool + 'a,
3015 ) -> impl Iterator<Item = Range<usize>> + 'a {
3016 let range = range.start.to_offset(self)..range.end.to_offset(self);
3017 self.excerpts_for_range(range.clone())
3018 .filter_map(move |(excerpt, excerpt_offset)| {
3019 redaction_enabled(excerpt.buffer.file()).then(move || {
3020 let excerpt_buffer_start =
3021 excerpt.range.context.start.to_offset(&excerpt.buffer);
3022
3023 excerpt
3024 .buffer
3025 .redacted_ranges(excerpt.range.context.clone())
3026 .map(move |mut redacted_range| {
3027 // Re-base onto the excerpts coordinates in the multibuffer
3028 redacted_range.start =
3029 excerpt_offset + (redacted_range.start - excerpt_buffer_start);
3030 redacted_range.end =
3031 excerpt_offset + (redacted_range.end - excerpt_buffer_start);
3032
3033 redacted_range
3034 })
3035 .skip_while(move |redacted_range| redacted_range.end < range.start)
3036 .take_while(move |redacted_range| redacted_range.start < range.end)
3037 })
3038 })
3039 .flatten()
3040 }
3041
3042 pub fn diagnostics_update_count(&self) -> usize {
3043 self.diagnostics_update_count
3044 }
3045
3046 pub fn git_diff_update_count(&self) -> usize {
3047 self.git_diff_update_count
3048 }
3049
3050 pub fn trailing_excerpt_update_count(&self) -> usize {
3051 self.trailing_excerpt_update_count
3052 }
3053
3054 pub fn file_at<T: ToOffset>(&self, point: T) -> Option<&Arc<dyn File>> {
3055 self.point_to_buffer_offset(point)
3056 .and_then(|(buffer, _)| buffer.file())
3057 }
3058
3059 pub fn language_at<T: ToOffset>(&self, point: T) -> Option<&Arc<Language>> {
3060 self.point_to_buffer_offset(point)
3061 .and_then(|(buffer, offset)| buffer.language_at(offset))
3062 }
3063
3064 pub fn settings_at<'a, T: ToOffset>(
3065 &'a self,
3066 point: T,
3067 cx: &'a AppContext,
3068 ) -> &'a LanguageSettings {
3069 let mut language = None;
3070 let mut file = None;
3071 if let Some((buffer, offset)) = self.point_to_buffer_offset(point) {
3072 language = buffer.language_at(offset);
3073 file = buffer.file();
3074 }
3075 language_settings(language, file, cx)
3076 }
3077
3078 pub fn language_scope_at<T: ToOffset>(&self, point: T) -> Option<LanguageScope> {
3079 self.point_to_buffer_offset(point)
3080 .and_then(|(buffer, offset)| buffer.language_scope_at(offset))
3081 }
3082
3083 pub fn language_indent_size_at<T: ToOffset>(
3084 &self,
3085 position: T,
3086 cx: &AppContext,
3087 ) -> Option<IndentSize> {
3088 let (buffer_snapshot, offset) = self.point_to_buffer_offset(position)?;
3089 Some(buffer_snapshot.language_indent_size_at(offset, cx))
3090 }
3091
3092 pub fn is_dirty(&self) -> bool {
3093 self.is_dirty
3094 }
3095
3096 pub fn has_conflict(&self) -> bool {
3097 self.has_conflict
3098 }
3099
3100 pub fn has_diagnostics(&self) -> bool {
3101 self.excerpts
3102 .iter()
3103 .any(|excerpt| excerpt.buffer.has_diagnostics())
3104 }
3105
3106 pub fn diagnostic_group<'a, O>(
3107 &'a self,
3108 group_id: usize,
3109 ) -> impl Iterator<Item = DiagnosticEntry<O>> + 'a
3110 where
3111 O: text::FromAnchor + 'a,
3112 {
3113 self.as_singleton()
3114 .into_iter()
3115 .flat_map(move |(_, _, buffer)| buffer.diagnostic_group(group_id))
3116 }
3117
3118 pub fn diagnostics_in_range<'a, T, O>(
3119 &'a self,
3120 range: Range<T>,
3121 reversed: bool,
3122 ) -> impl Iterator<Item = DiagnosticEntry<O>> + 'a
3123 where
3124 T: 'a + ToOffset,
3125 O: 'a + text::FromAnchor + Ord,
3126 {
3127 self.as_singleton()
3128 .into_iter()
3129 .flat_map(move |(_, _, buffer)| {
3130 buffer.diagnostics_in_range(
3131 range.start.to_offset(self)..range.end.to_offset(self),
3132 reversed,
3133 )
3134 })
3135 }
3136
3137 pub fn has_git_diffs(&self) -> bool {
3138 for excerpt in self.excerpts.iter() {
3139 if excerpt.buffer.has_git_diff() {
3140 return true;
3141 }
3142 }
3143 false
3144 }
3145
3146 pub fn git_diff_hunks_in_range_rev(
3147 &self,
3148 row_range: Range<u32>,
3149 ) -> impl Iterator<Item = DiffHunk<u32>> + '_ {
3150 let mut cursor = self.excerpts.cursor::<Point>();
3151
3152 cursor.seek(&Point::new(row_range.end, 0), Bias::Left, &());
3153 if cursor.item().is_none() {
3154 cursor.prev(&());
3155 }
3156
3157 std::iter::from_fn(move || {
3158 let excerpt = cursor.item()?;
3159 let multibuffer_start = *cursor.start();
3160 let multibuffer_end = multibuffer_start + excerpt.text_summary.lines;
3161 if multibuffer_start.row >= row_range.end {
3162 return None;
3163 }
3164
3165 let mut buffer_start = excerpt.range.context.start;
3166 let mut buffer_end = excerpt.range.context.end;
3167 let excerpt_start_point = buffer_start.to_point(&excerpt.buffer);
3168 let excerpt_end_point = excerpt_start_point + excerpt.text_summary.lines;
3169
3170 if row_range.start > multibuffer_start.row {
3171 let buffer_start_point =
3172 excerpt_start_point + Point::new(row_range.start - multibuffer_start.row, 0);
3173 buffer_start = excerpt.buffer.anchor_before(buffer_start_point);
3174 }
3175
3176 if row_range.end < multibuffer_end.row {
3177 let buffer_end_point =
3178 excerpt_start_point + Point::new(row_range.end - multibuffer_start.row, 0);
3179 buffer_end = excerpt.buffer.anchor_before(buffer_end_point);
3180 }
3181
3182 let buffer_hunks = excerpt
3183 .buffer
3184 .git_diff_hunks_intersecting_range_rev(buffer_start..buffer_end)
3185 .map(move |hunk| {
3186 let start = multibuffer_start.row
3187 + hunk
3188 .associated_range
3189 .start
3190 .saturating_sub(excerpt_start_point.row);
3191 let end = multibuffer_start.row
3192 + hunk
3193 .associated_range
3194 .end
3195 .min(excerpt_end_point.row + 1)
3196 .saturating_sub(excerpt_start_point.row);
3197
3198 DiffHunk {
3199 associated_range: start..end,
3200 diff_base_byte_range: hunk.diff_base_byte_range.clone(),
3201 buffer_range: hunk.buffer_range.clone(),
3202 buffer_id: hunk.buffer_id,
3203 }
3204 });
3205
3206 cursor.prev(&());
3207
3208 Some(buffer_hunks)
3209 })
3210 .flatten()
3211 }
3212
3213 pub fn git_diff_hunks_in_range(
3214 &self,
3215 row_range: Range<u32>,
3216 ) -> impl Iterator<Item = DiffHunk<u32>> + '_ {
3217 let mut cursor = self.excerpts.cursor::<Point>();
3218
3219 cursor.seek(&Point::new(row_range.start, 0), Bias::Left, &());
3220
3221 std::iter::from_fn(move || {
3222 let excerpt = cursor.item()?;
3223 let multibuffer_start = *cursor.start();
3224 let multibuffer_end = multibuffer_start + excerpt.text_summary.lines;
3225 let mut buffer_start = excerpt.range.context.start;
3226 let mut buffer_end = excerpt.range.context.end;
3227
3228 let excerpt_rows = match multibuffer_start.row.cmp(&row_range.end) {
3229 cmp::Ordering::Less => {
3230 let excerpt_start_point = buffer_start.to_point(&excerpt.buffer);
3231 let excerpt_end_point = excerpt_start_point + excerpt.text_summary.lines;
3232
3233 if row_range.start > multibuffer_start.row {
3234 let buffer_start_point = excerpt_start_point
3235 + Point::new(row_range.start - multibuffer_start.row, 0);
3236 buffer_start = excerpt.buffer.anchor_before(buffer_start_point);
3237 }
3238
3239 if row_range.end < multibuffer_end.row {
3240 let buffer_end_point = excerpt_start_point
3241 + Point::new(row_range.end - multibuffer_start.row, 0);
3242 buffer_end = excerpt.buffer.anchor_before(buffer_end_point);
3243 }
3244 excerpt_start_point.row..excerpt_end_point.row
3245 }
3246 cmp::Ordering::Equal if row_range.end == 0 => {
3247 buffer_end = buffer_start;
3248 0..0
3249 }
3250 cmp::Ordering::Greater | cmp::Ordering::Equal => return None,
3251 };
3252
3253 let buffer_hunks = excerpt
3254 .buffer
3255 .git_diff_hunks_intersecting_range(buffer_start..buffer_end)
3256 .map(move |hunk| {
3257 let buffer_range = if excerpt_rows.start == 0 && excerpt_rows.end == 0 {
3258 0..1
3259 } else {
3260 let start = multibuffer_start.row
3261 + hunk
3262 .associated_range
3263 .start
3264 .saturating_sub(excerpt_rows.start);
3265 let end = multibuffer_start.row
3266 + hunk
3267 .associated_range
3268 .end
3269 .min(excerpt_rows.end + 1)
3270 .saturating_sub(excerpt_rows.start);
3271 start..end
3272 };
3273 DiffHunk {
3274 associated_range: buffer_range,
3275 diff_base_byte_range: hunk.diff_base_byte_range.clone(),
3276 buffer_range: hunk.buffer_range.clone(),
3277 buffer_id: hunk.buffer_id,
3278 }
3279 });
3280
3281 cursor.next(&());
3282
3283 Some(buffer_hunks)
3284 })
3285 .flatten()
3286 }
3287
3288 pub fn range_for_syntax_ancestor<T: ToOffset>(&self, range: Range<T>) -> Option<Range<usize>> {
3289 let range = range.start.to_offset(self)..range.end.to_offset(self);
3290 let excerpt = self.excerpt_containing(range.clone())?;
3291
3292 let ancestor_buffer_range = excerpt
3293 .buffer()
3294 .range_for_syntax_ancestor(excerpt.map_range_to_buffer(range))?;
3295
3296 Some(excerpt.map_range_from_buffer(ancestor_buffer_range))
3297 }
3298
3299 pub fn outline(&self, theme: Option<&SyntaxTheme>) -> Option<Outline<Anchor>> {
3300 let (excerpt_id, _, buffer) = self.as_singleton()?;
3301 let outline = buffer.outline(theme)?;
3302 Some(Outline::new(
3303 outline
3304 .items
3305 .into_iter()
3306 .flat_map(|item| {
3307 Some(OutlineItem {
3308 depth: item.depth,
3309 range: self.anchor_in_excerpt(*excerpt_id, item.range.start)?
3310 ..self.anchor_in_excerpt(*excerpt_id, item.range.end)?,
3311 text: item.text,
3312 highlight_ranges: item.highlight_ranges,
3313 name_ranges: item.name_ranges,
3314 })
3315 })
3316 .collect(),
3317 ))
3318 }
3319
3320 pub fn symbols_containing<T: ToOffset>(
3321 &self,
3322 offset: T,
3323 theme: Option<&SyntaxTheme>,
3324 ) -> Option<(BufferId, Vec<OutlineItem<Anchor>>)> {
3325 let anchor = self.anchor_before(offset);
3326 let excerpt_id = anchor.excerpt_id;
3327 let excerpt = self.excerpt(excerpt_id)?;
3328 Some((
3329 excerpt.buffer_id,
3330 excerpt
3331 .buffer
3332 .symbols_containing(anchor.text_anchor, theme)
3333 .into_iter()
3334 .flatten()
3335 .flat_map(|item| {
3336 Some(OutlineItem {
3337 depth: item.depth,
3338 range: self.anchor_in_excerpt(excerpt_id, item.range.start)?
3339 ..self.anchor_in_excerpt(excerpt_id, item.range.end)?,
3340 text: item.text,
3341 highlight_ranges: item.highlight_ranges,
3342 name_ranges: item.name_ranges,
3343 })
3344 })
3345 .collect(),
3346 ))
3347 }
3348
3349 fn excerpt_locator_for_id(&self, id: ExcerptId) -> &Locator {
3350 if id == ExcerptId::min() {
3351 Locator::min_ref()
3352 } else if id == ExcerptId::max() {
3353 Locator::max_ref()
3354 } else {
3355 let mut cursor = self.excerpt_ids.cursor::<ExcerptId>();
3356 cursor.seek(&id, Bias::Left, &());
3357 if let Some(entry) = cursor.item() {
3358 if entry.id == id {
3359 return &entry.locator;
3360 }
3361 }
3362 panic!("invalid excerpt id {:?}", id)
3363 }
3364 }
3365
3366 pub fn buffer_id_for_excerpt(&self, excerpt_id: ExcerptId) -> Option<BufferId> {
3367 Some(self.excerpt(excerpt_id)?.buffer_id)
3368 }
3369
3370 pub fn buffer_for_excerpt(&self, excerpt_id: ExcerptId) -> Option<&BufferSnapshot> {
3371 Some(&self.excerpt(excerpt_id)?.buffer)
3372 }
3373
3374 fn excerpt(&self, excerpt_id: ExcerptId) -> Option<&Excerpt> {
3375 let mut cursor = self.excerpts.cursor::<Option<&Locator>>();
3376 let locator = self.excerpt_locator_for_id(excerpt_id);
3377 cursor.seek(&Some(locator), Bias::Left, &());
3378 if let Some(excerpt) = cursor.item() {
3379 if excerpt.id == excerpt_id {
3380 return Some(excerpt);
3381 }
3382 }
3383 None
3384 }
3385
3386 /// Returns the excerpt containing range and its offset start within the multibuffer or none if `range` spans multiple excerpts
3387 pub fn excerpt_containing<T: ToOffset>(&self, range: Range<T>) -> Option<MultiBufferExcerpt> {
3388 let range = range.start.to_offset(self)..range.end.to_offset(self);
3389
3390 let mut cursor = self.excerpts.cursor::<usize>();
3391 cursor.seek(&range.start, Bias::Right, &());
3392 let start_excerpt = cursor.item()?;
3393
3394 if range.start == range.end {
3395 return Some(MultiBufferExcerpt::new(start_excerpt, *cursor.start()));
3396 }
3397
3398 cursor.seek(&range.end, Bias::Right, &());
3399 let end_excerpt = cursor.item()?;
3400
3401 if start_excerpt.id != end_excerpt.id {
3402 None
3403 } else {
3404 Some(MultiBufferExcerpt::new(start_excerpt, *cursor.start()))
3405 }
3406 }
3407
3408 pub fn remote_selections_in_range<'a>(
3409 &'a self,
3410 range: &'a Range<Anchor>,
3411 ) -> impl 'a + Iterator<Item = (ReplicaId, bool, CursorShape, Selection<Anchor>)> {
3412 let mut cursor = self.excerpts.cursor::<ExcerptSummary>();
3413 let start_locator = self.excerpt_locator_for_id(range.start.excerpt_id);
3414 let end_locator = self.excerpt_locator_for_id(range.end.excerpt_id);
3415 cursor.seek(start_locator, Bias::Left, &());
3416 cursor
3417 .take_while(move |excerpt| excerpt.locator <= *end_locator)
3418 .flat_map(move |excerpt| {
3419 let mut query_range = excerpt.range.context.start..excerpt.range.context.end;
3420 if excerpt.id == range.start.excerpt_id {
3421 query_range.start = range.start.text_anchor;
3422 }
3423 if excerpt.id == range.end.excerpt_id {
3424 query_range.end = range.end.text_anchor;
3425 }
3426
3427 excerpt
3428 .buffer
3429 .remote_selections_in_range(query_range)
3430 .flat_map(move |(replica_id, line_mode, cursor_shape, selections)| {
3431 selections.map(move |selection| {
3432 let mut start = Anchor {
3433 buffer_id: Some(excerpt.buffer_id),
3434 excerpt_id: excerpt.id,
3435 text_anchor: selection.start,
3436 };
3437 let mut end = Anchor {
3438 buffer_id: Some(excerpt.buffer_id),
3439 excerpt_id: excerpt.id,
3440 text_anchor: selection.end,
3441 };
3442 if range.start.cmp(&start, self).is_gt() {
3443 start = range.start;
3444 }
3445 if range.end.cmp(&end, self).is_lt() {
3446 end = range.end;
3447 }
3448
3449 (
3450 replica_id,
3451 line_mode,
3452 cursor_shape,
3453 Selection {
3454 id: selection.id,
3455 start,
3456 end,
3457 reversed: selection.reversed,
3458 goal: selection.goal,
3459 },
3460 )
3461 })
3462 })
3463 })
3464 }
3465}
3466
3467#[cfg(any(test, feature = "test-support"))]
3468impl MultiBufferSnapshot {
3469 pub fn random_byte_range(&self, start_offset: usize, rng: &mut impl rand::Rng) -> Range<usize> {
3470 let end = self.clip_offset(rng.gen_range(start_offset..=self.len()), Bias::Right);
3471 let start = self.clip_offset(rng.gen_range(start_offset..=end), Bias::Right);
3472 start..end
3473 }
3474}
3475
3476impl History {
3477 fn start_transaction(&mut self, now: Instant) -> Option<TransactionId> {
3478 self.transaction_depth += 1;
3479 if self.transaction_depth == 1 {
3480 let id = self.next_transaction_id.tick();
3481 self.undo_stack.push(Transaction {
3482 id,
3483 buffer_transactions: Default::default(),
3484 first_edit_at: now,
3485 last_edit_at: now,
3486 suppress_grouping: false,
3487 });
3488 Some(id)
3489 } else {
3490 None
3491 }
3492 }
3493
3494 fn end_transaction(
3495 &mut self,
3496 now: Instant,
3497 buffer_transactions: HashMap<BufferId, TransactionId>,
3498 ) -> bool {
3499 assert_ne!(self.transaction_depth, 0);
3500 self.transaction_depth -= 1;
3501 if self.transaction_depth == 0 {
3502 if buffer_transactions.is_empty() {
3503 self.undo_stack.pop();
3504 false
3505 } else {
3506 self.redo_stack.clear();
3507 let transaction = self.undo_stack.last_mut().unwrap();
3508 transaction.last_edit_at = now;
3509 for (buffer_id, transaction_id) in buffer_transactions {
3510 transaction
3511 .buffer_transactions
3512 .entry(buffer_id)
3513 .or_insert(transaction_id);
3514 }
3515 true
3516 }
3517 } else {
3518 false
3519 }
3520 }
3521
3522 fn push_transaction<'a, T>(
3523 &mut self,
3524 buffer_transactions: T,
3525 now: Instant,
3526 cx: &mut ModelContext<MultiBuffer>,
3527 ) where
3528 T: IntoIterator<Item = (&'a Model<Buffer>, &'a language::Transaction)>,
3529 {
3530 assert_eq!(self.transaction_depth, 0);
3531 let transaction = Transaction {
3532 id: self.next_transaction_id.tick(),
3533 buffer_transactions: buffer_transactions
3534 .into_iter()
3535 .map(|(buffer, transaction)| (buffer.read(cx).remote_id(), transaction.id))
3536 .collect(),
3537 first_edit_at: now,
3538 last_edit_at: now,
3539 suppress_grouping: false,
3540 };
3541 if !transaction.buffer_transactions.is_empty() {
3542 self.undo_stack.push(transaction);
3543 self.redo_stack.clear();
3544 }
3545 }
3546
3547 fn finalize_last_transaction(&mut self) {
3548 if let Some(transaction) = self.undo_stack.last_mut() {
3549 transaction.suppress_grouping = true;
3550 }
3551 }
3552
3553 fn forget(&mut self, transaction_id: TransactionId) -> Option<Transaction> {
3554 if let Some(ix) = self
3555 .undo_stack
3556 .iter()
3557 .rposition(|transaction| transaction.id == transaction_id)
3558 {
3559 Some(self.undo_stack.remove(ix))
3560 } else if let Some(ix) = self
3561 .redo_stack
3562 .iter()
3563 .rposition(|transaction| transaction.id == transaction_id)
3564 {
3565 Some(self.redo_stack.remove(ix))
3566 } else {
3567 None
3568 }
3569 }
3570
3571 fn transaction_mut(&mut self, transaction_id: TransactionId) -> Option<&mut Transaction> {
3572 self.undo_stack
3573 .iter_mut()
3574 .find(|transaction| transaction.id == transaction_id)
3575 .or_else(|| {
3576 self.redo_stack
3577 .iter_mut()
3578 .find(|transaction| transaction.id == transaction_id)
3579 })
3580 }
3581
3582 fn pop_undo(&mut self) -> Option<&mut Transaction> {
3583 assert_eq!(self.transaction_depth, 0);
3584 if let Some(transaction) = self.undo_stack.pop() {
3585 self.redo_stack.push(transaction);
3586 self.redo_stack.last_mut()
3587 } else {
3588 None
3589 }
3590 }
3591
3592 fn pop_redo(&mut self) -> Option<&mut Transaction> {
3593 assert_eq!(self.transaction_depth, 0);
3594 if let Some(transaction) = self.redo_stack.pop() {
3595 self.undo_stack.push(transaction);
3596 self.undo_stack.last_mut()
3597 } else {
3598 None
3599 }
3600 }
3601
3602 fn remove_from_undo(&mut self, transaction_id: TransactionId) -> Option<&Transaction> {
3603 let ix = self
3604 .undo_stack
3605 .iter()
3606 .rposition(|transaction| transaction.id == transaction_id)?;
3607 let transaction = self.undo_stack.remove(ix);
3608 self.redo_stack.push(transaction);
3609 self.redo_stack.last()
3610 }
3611
3612 fn group(&mut self) -> Option<TransactionId> {
3613 let mut count = 0;
3614 let mut transactions = self.undo_stack.iter();
3615 if let Some(mut transaction) = transactions.next_back() {
3616 while let Some(prev_transaction) = transactions.next_back() {
3617 if !prev_transaction.suppress_grouping
3618 && transaction.first_edit_at - prev_transaction.last_edit_at
3619 <= self.group_interval
3620 {
3621 transaction = prev_transaction;
3622 count += 1;
3623 } else {
3624 break;
3625 }
3626 }
3627 }
3628 self.group_trailing(count)
3629 }
3630
3631 fn group_until(&mut self, transaction_id: TransactionId) {
3632 let mut count = 0;
3633 for transaction in self.undo_stack.iter().rev() {
3634 if transaction.id == transaction_id {
3635 self.group_trailing(count);
3636 break;
3637 } else if transaction.suppress_grouping {
3638 break;
3639 } else {
3640 count += 1;
3641 }
3642 }
3643 }
3644
3645 fn group_trailing(&mut self, n: usize) -> Option<TransactionId> {
3646 let new_len = self.undo_stack.len() - n;
3647 let (transactions_to_keep, transactions_to_merge) = self.undo_stack.split_at_mut(new_len);
3648 if let Some(last_transaction) = transactions_to_keep.last_mut() {
3649 if let Some(transaction) = transactions_to_merge.last() {
3650 last_transaction.last_edit_at = transaction.last_edit_at;
3651 }
3652 for to_merge in transactions_to_merge {
3653 for (buffer_id, transaction_id) in &to_merge.buffer_transactions {
3654 last_transaction
3655 .buffer_transactions
3656 .entry(*buffer_id)
3657 .or_insert(*transaction_id);
3658 }
3659 }
3660 }
3661
3662 self.undo_stack.truncate(new_len);
3663 self.undo_stack.last().map(|t| t.id)
3664 }
3665}
3666
3667impl Excerpt {
3668 fn new(
3669 id: ExcerptId,
3670 locator: Locator,
3671 buffer_id: BufferId,
3672 buffer: BufferSnapshot,
3673 range: ExcerptRange<text::Anchor>,
3674 has_trailing_newline: bool,
3675 ) -> Self {
3676 Excerpt {
3677 id,
3678 locator,
3679 max_buffer_row: range.context.end.to_point(&buffer).row,
3680 text_summary: buffer
3681 .text_summary_for_range::<TextSummary, _>(range.context.to_offset(&buffer)),
3682 buffer_id,
3683 buffer,
3684 range,
3685 has_trailing_newline,
3686 }
3687 }
3688
3689 fn chunks_in_range(&self, range: Range<usize>, language_aware: bool) -> ExcerptChunks {
3690 let content_start = self.range.context.start.to_offset(&self.buffer);
3691 let chunks_start = content_start + range.start;
3692 let chunks_end = content_start + cmp::min(range.end, self.text_summary.len);
3693
3694 let footer_height = if self.has_trailing_newline
3695 && range.start <= self.text_summary.len
3696 && range.end > self.text_summary.len
3697 {
3698 1
3699 } else {
3700 0
3701 };
3702
3703 let content_chunks = self.buffer.chunks(chunks_start..chunks_end, language_aware);
3704
3705 ExcerptChunks {
3706 content_chunks,
3707 footer_height,
3708 }
3709 }
3710
3711 fn bytes_in_range(&self, range: Range<usize>) -> ExcerptBytes {
3712 let content_start = self.range.context.start.to_offset(&self.buffer);
3713 let bytes_start = content_start + range.start;
3714 let bytes_end = content_start + cmp::min(range.end, self.text_summary.len);
3715 let footer_height = if self.has_trailing_newline
3716 && range.start <= self.text_summary.len
3717 && range.end > self.text_summary.len
3718 {
3719 1
3720 } else {
3721 0
3722 };
3723 let content_bytes = self.buffer.bytes_in_range(bytes_start..bytes_end);
3724
3725 ExcerptBytes {
3726 content_bytes,
3727 padding_height: footer_height,
3728 reversed: false,
3729 }
3730 }
3731
3732 fn reversed_bytes_in_range(&self, range: Range<usize>) -> ExcerptBytes {
3733 let content_start = self.range.context.start.to_offset(&self.buffer);
3734 let bytes_start = content_start + range.start;
3735 let bytes_end = content_start + cmp::min(range.end, self.text_summary.len);
3736 let footer_height = if self.has_trailing_newline
3737 && range.start <= self.text_summary.len
3738 && range.end > self.text_summary.len
3739 {
3740 1
3741 } else {
3742 0
3743 };
3744 let content_bytes = self.buffer.reversed_bytes_in_range(bytes_start..bytes_end);
3745
3746 ExcerptBytes {
3747 content_bytes,
3748 padding_height: footer_height,
3749 reversed: true,
3750 }
3751 }
3752
3753 fn clip_anchor(&self, text_anchor: text::Anchor) -> text::Anchor {
3754 if text_anchor
3755 .cmp(&self.range.context.start, &self.buffer)
3756 .is_lt()
3757 {
3758 self.range.context.start
3759 } else if text_anchor
3760 .cmp(&self.range.context.end, &self.buffer)
3761 .is_gt()
3762 {
3763 self.range.context.end
3764 } else {
3765 text_anchor
3766 }
3767 }
3768
3769 fn contains(&self, anchor: &Anchor) -> bool {
3770 Some(self.buffer_id) == anchor.buffer_id
3771 && self
3772 .range
3773 .context
3774 .start
3775 .cmp(&anchor.text_anchor, &self.buffer)
3776 .is_le()
3777 && self
3778 .range
3779 .context
3780 .end
3781 .cmp(&anchor.text_anchor, &self.buffer)
3782 .is_ge()
3783 }
3784
3785 /// The [`Excerpt`]'s start offset in its [`Buffer`]
3786 fn buffer_start_offset(&self) -> usize {
3787 self.range.context.start.to_offset(&self.buffer)
3788 }
3789
3790 /// The [`Excerpt`]'s end offset in its [`Buffer`]
3791 fn buffer_end_offset(&self) -> usize {
3792 self.buffer_start_offset() + self.text_summary.len
3793 }
3794}
3795
3796impl<'a> MultiBufferExcerpt<'a> {
3797 fn new(excerpt: &'a Excerpt, excerpt_offset: usize) -> Self {
3798 MultiBufferExcerpt {
3799 excerpt,
3800 excerpt_offset,
3801 }
3802 }
3803
3804 pub fn buffer(&self) -> &'a BufferSnapshot {
3805 &self.excerpt.buffer
3806 }
3807
3808 /// Maps an offset within the [`MultiBuffer`] to an offset within the [`Buffer`]
3809 pub fn map_offset_to_buffer(&self, offset: usize) -> usize {
3810 self.excerpt.buffer_start_offset() + offset.saturating_sub(self.excerpt_offset)
3811 }
3812
3813 /// Maps a range within the [`MultiBuffer`] to a range within the [`Buffer`]
3814 pub fn map_range_to_buffer(&self, range: Range<usize>) -> Range<usize> {
3815 self.map_offset_to_buffer(range.start)..self.map_offset_to_buffer(range.end)
3816 }
3817
3818 /// Map an offset within the [`Buffer`] to an offset within the [`MultiBuffer`]
3819 pub fn map_offset_from_buffer(&self, buffer_offset: usize) -> usize {
3820 let mut buffer_offset_in_excerpt =
3821 buffer_offset.saturating_sub(self.excerpt.buffer_start_offset());
3822 buffer_offset_in_excerpt =
3823 cmp::min(buffer_offset_in_excerpt, self.excerpt.text_summary.len);
3824
3825 self.excerpt_offset + buffer_offset_in_excerpt
3826 }
3827
3828 /// Map a range within the [`Buffer`] to a range within the [`MultiBuffer`]
3829 pub fn map_range_from_buffer(&self, buffer_range: Range<usize>) -> Range<usize> {
3830 self.map_offset_from_buffer(buffer_range.start)
3831 ..self.map_offset_from_buffer(buffer_range.end)
3832 }
3833
3834 /// Returns true if the entirety of the given range is in the buffer's excerpt
3835 pub fn contains_buffer_range(&self, range: Range<usize>) -> bool {
3836 range.start >= self.excerpt.buffer_start_offset()
3837 && range.end <= self.excerpt.buffer_end_offset()
3838 }
3839}
3840
3841impl ExcerptId {
3842 pub fn min() -> Self {
3843 Self(0)
3844 }
3845
3846 pub fn max() -> Self {
3847 Self(usize::MAX)
3848 }
3849
3850 pub fn to_proto(&self) -> u64 {
3851 self.0 as _
3852 }
3853
3854 pub fn from_proto(proto: u64) -> Self {
3855 Self(proto as _)
3856 }
3857
3858 pub fn cmp(&self, other: &Self, snapshot: &MultiBufferSnapshot) -> cmp::Ordering {
3859 let a = snapshot.excerpt_locator_for_id(*self);
3860 let b = snapshot.excerpt_locator_for_id(*other);
3861 a.cmp(b).then_with(|| self.0.cmp(&other.0))
3862 }
3863}
3864
3865impl Into<usize> for ExcerptId {
3866 fn into(self) -> usize {
3867 self.0
3868 }
3869}
3870
3871impl fmt::Debug for Excerpt {
3872 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
3873 f.debug_struct("Excerpt")
3874 .field("id", &self.id)
3875 .field("locator", &self.locator)
3876 .field("buffer_id", &self.buffer_id)
3877 .field("range", &self.range)
3878 .field("text_summary", &self.text_summary)
3879 .field("has_trailing_newline", &self.has_trailing_newline)
3880 .finish()
3881 }
3882}
3883
3884impl sum_tree::Item for Excerpt {
3885 type Summary = ExcerptSummary;
3886
3887 fn summary(&self) -> Self::Summary {
3888 let mut text = self.text_summary.clone();
3889 if self.has_trailing_newline {
3890 text += TextSummary::from("\n");
3891 }
3892 ExcerptSummary {
3893 excerpt_id: self.id,
3894 excerpt_locator: self.locator.clone(),
3895 max_buffer_row: self.max_buffer_row,
3896 text,
3897 }
3898 }
3899}
3900
3901impl sum_tree::Item for ExcerptIdMapping {
3902 type Summary = ExcerptId;
3903
3904 fn summary(&self) -> Self::Summary {
3905 self.id
3906 }
3907}
3908
3909impl sum_tree::KeyedItem for ExcerptIdMapping {
3910 type Key = ExcerptId;
3911
3912 fn key(&self) -> Self::Key {
3913 self.id
3914 }
3915}
3916
3917impl sum_tree::Summary for ExcerptId {
3918 type Context = ();
3919
3920 fn add_summary(&mut self, other: &Self, _: &()) {
3921 *self = *other;
3922 }
3923}
3924
3925impl sum_tree::Summary for ExcerptSummary {
3926 type Context = ();
3927
3928 fn add_summary(&mut self, summary: &Self, _: &()) {
3929 debug_assert!(summary.excerpt_locator > self.excerpt_locator);
3930 self.excerpt_locator = summary.excerpt_locator.clone();
3931 self.text.add_summary(&summary.text, &());
3932 self.max_buffer_row = cmp::max(self.max_buffer_row, summary.max_buffer_row);
3933 }
3934}
3935
3936impl<'a> sum_tree::Dimension<'a, ExcerptSummary> for TextSummary {
3937 fn add_summary(&mut self, summary: &'a ExcerptSummary, _: &()) {
3938 *self += &summary.text;
3939 }
3940}
3941
3942impl<'a> sum_tree::Dimension<'a, ExcerptSummary> for usize {
3943 fn add_summary(&mut self, summary: &'a ExcerptSummary, _: &()) {
3944 *self += summary.text.len;
3945 }
3946}
3947
3948impl<'a> sum_tree::SeekTarget<'a, ExcerptSummary, ExcerptSummary> for usize {
3949 fn cmp(&self, cursor_location: &ExcerptSummary, _: &()) -> cmp::Ordering {
3950 Ord::cmp(self, &cursor_location.text.len)
3951 }
3952}
3953
3954impl<'a> sum_tree::SeekTarget<'a, ExcerptSummary, Option<&'a Locator>> for Locator {
3955 fn cmp(&self, cursor_location: &Option<&'a Locator>, _: &()) -> cmp::Ordering {
3956 Ord::cmp(&Some(self), cursor_location)
3957 }
3958}
3959
3960impl<'a> sum_tree::SeekTarget<'a, ExcerptSummary, ExcerptSummary> for Locator {
3961 fn cmp(&self, cursor_location: &ExcerptSummary, _: &()) -> cmp::Ordering {
3962 Ord::cmp(self, &cursor_location.excerpt_locator)
3963 }
3964}
3965
3966impl<'a> sum_tree::Dimension<'a, ExcerptSummary> for OffsetUtf16 {
3967 fn add_summary(&mut self, summary: &'a ExcerptSummary, _: &()) {
3968 *self += summary.text.len_utf16;
3969 }
3970}
3971
3972impl<'a> sum_tree::Dimension<'a, ExcerptSummary> for Point {
3973 fn add_summary(&mut self, summary: &'a ExcerptSummary, _: &()) {
3974 *self += summary.text.lines;
3975 }
3976}
3977
3978impl<'a> sum_tree::Dimension<'a, ExcerptSummary> for PointUtf16 {
3979 fn add_summary(&mut self, summary: &'a ExcerptSummary, _: &()) {
3980 *self += summary.text.lines_utf16()
3981 }
3982}
3983
3984impl<'a> sum_tree::Dimension<'a, ExcerptSummary> for Option<&'a Locator> {
3985 fn add_summary(&mut self, summary: &'a ExcerptSummary, _: &()) {
3986 *self = Some(&summary.excerpt_locator);
3987 }
3988}
3989
3990impl<'a> sum_tree::Dimension<'a, ExcerptSummary> for Option<ExcerptId> {
3991 fn add_summary(&mut self, summary: &'a ExcerptSummary, _: &()) {
3992 *self = Some(summary.excerpt_id);
3993 }
3994}
3995
3996impl<'a> MultiBufferRows<'a> {
3997 pub fn seek(&mut self, row: u32) {
3998 self.buffer_row_range = 0..0;
3999
4000 self.excerpts
4001 .seek_forward(&Point::new(row, 0), Bias::Right, &());
4002 if self.excerpts.item().is_none() {
4003 self.excerpts.prev(&());
4004
4005 if self.excerpts.item().is_none() && row == 0 {
4006 self.buffer_row_range = 0..1;
4007 return;
4008 }
4009 }
4010
4011 if let Some(excerpt) = self.excerpts.item() {
4012 let overshoot = row - self.excerpts.start().row;
4013 let excerpt_start = excerpt.range.context.start.to_point(&excerpt.buffer).row;
4014 self.buffer_row_range.start = excerpt_start + overshoot;
4015 self.buffer_row_range.end = excerpt_start + excerpt.text_summary.lines.row + 1;
4016 }
4017 }
4018}
4019
4020impl<'a> Iterator for MultiBufferRows<'a> {
4021 type Item = Option<u32>;
4022
4023 fn next(&mut self) -> Option<Self::Item> {
4024 loop {
4025 if !self.buffer_row_range.is_empty() {
4026 let row = Some(self.buffer_row_range.start);
4027 self.buffer_row_range.start += 1;
4028 return Some(row);
4029 }
4030 self.excerpts.item()?;
4031 self.excerpts.next(&());
4032 let excerpt = self.excerpts.item()?;
4033 self.buffer_row_range.start = excerpt.range.context.start.to_point(&excerpt.buffer).row;
4034 self.buffer_row_range.end =
4035 self.buffer_row_range.start + excerpt.text_summary.lines.row + 1;
4036 }
4037 }
4038}
4039
4040impl<'a> MultiBufferChunks<'a> {
4041 pub fn offset(&self) -> usize {
4042 self.range.start
4043 }
4044
4045 pub fn seek(&mut self, offset: usize) {
4046 self.range.start = offset;
4047 self.excerpts.seek(&offset, Bias::Right, &());
4048 if let Some(excerpt) = self.excerpts.item() {
4049 self.excerpt_chunks = Some(excerpt.chunks_in_range(
4050 self.range.start - self.excerpts.start()..self.range.end - self.excerpts.start(),
4051 self.language_aware,
4052 ));
4053 } else {
4054 self.excerpt_chunks = None;
4055 }
4056 }
4057}
4058
4059impl<'a> Iterator for MultiBufferChunks<'a> {
4060 type Item = Chunk<'a>;
4061
4062 fn next(&mut self) -> Option<Self::Item> {
4063 if self.range.is_empty() {
4064 None
4065 } else if let Some(chunk) = self.excerpt_chunks.as_mut()?.next() {
4066 self.range.start += chunk.text.len();
4067 Some(chunk)
4068 } else {
4069 self.excerpts.next(&());
4070 let excerpt = self.excerpts.item()?;
4071 self.excerpt_chunks = Some(excerpt.chunks_in_range(
4072 0..self.range.end - self.excerpts.start(),
4073 self.language_aware,
4074 ));
4075 self.next()
4076 }
4077 }
4078}
4079
4080impl<'a> MultiBufferBytes<'a> {
4081 fn consume(&mut self, len: usize) {
4082 self.range.start += len;
4083 self.chunk = &self.chunk[len..];
4084
4085 if !self.range.is_empty() && self.chunk.is_empty() {
4086 if let Some(chunk) = self.excerpt_bytes.as_mut().and_then(|bytes| bytes.next()) {
4087 self.chunk = chunk;
4088 } else {
4089 self.excerpts.next(&());
4090 if let Some(excerpt) = self.excerpts.item() {
4091 let mut excerpt_bytes =
4092 excerpt.bytes_in_range(0..self.range.end - self.excerpts.start());
4093 self.chunk = excerpt_bytes.next().unwrap();
4094 self.excerpt_bytes = Some(excerpt_bytes);
4095 }
4096 }
4097 }
4098 }
4099}
4100
4101impl<'a> Iterator for MultiBufferBytes<'a> {
4102 type Item = &'a [u8];
4103
4104 fn next(&mut self) -> Option<Self::Item> {
4105 let chunk = self.chunk;
4106 if chunk.is_empty() {
4107 None
4108 } else {
4109 self.consume(chunk.len());
4110 Some(chunk)
4111 }
4112 }
4113}
4114
4115impl<'a> io::Read for MultiBufferBytes<'a> {
4116 fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
4117 let len = cmp::min(buf.len(), self.chunk.len());
4118 buf[..len].copy_from_slice(&self.chunk[..len]);
4119 if len > 0 {
4120 self.consume(len);
4121 }
4122 Ok(len)
4123 }
4124}
4125
4126impl<'a> ReversedMultiBufferBytes<'a> {
4127 fn consume(&mut self, len: usize) {
4128 self.range.end -= len;
4129 self.chunk = &self.chunk[..self.chunk.len() - len];
4130
4131 if !self.range.is_empty() && self.chunk.is_empty() {
4132 if let Some(chunk) = self.excerpt_bytes.as_mut().and_then(|bytes| bytes.next()) {
4133 self.chunk = chunk;
4134 } else {
4135 self.excerpts.prev(&());
4136 if let Some(excerpt) = self.excerpts.item() {
4137 let mut excerpt_bytes = excerpt.reversed_bytes_in_range(
4138 self.range.start.saturating_sub(*self.excerpts.start())..usize::MAX,
4139 );
4140 self.chunk = excerpt_bytes.next().unwrap();
4141 self.excerpt_bytes = Some(excerpt_bytes);
4142 }
4143 }
4144 } else {
4145 }
4146 }
4147}
4148
4149impl<'a> io::Read for ReversedMultiBufferBytes<'a> {
4150 fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
4151 let len = cmp::min(buf.len(), self.chunk.len());
4152 buf[..len].copy_from_slice(&self.chunk[..len]);
4153 buf[..len].reverse();
4154 if len > 0 {
4155 self.consume(len);
4156 }
4157 Ok(len)
4158 }
4159}
4160impl<'a> Iterator for ExcerptBytes<'a> {
4161 type Item = &'a [u8];
4162
4163 fn next(&mut self) -> Option<Self::Item> {
4164 if self.reversed && self.padding_height > 0 {
4165 let result = &NEWLINES[..self.padding_height];
4166 self.padding_height = 0;
4167 return Some(result);
4168 }
4169
4170 if let Some(chunk) = self.content_bytes.next() {
4171 if !chunk.is_empty() {
4172 return Some(chunk);
4173 }
4174 }
4175
4176 if self.padding_height > 0 {
4177 let result = &NEWLINES[..self.padding_height];
4178 self.padding_height = 0;
4179 return Some(result);
4180 }
4181
4182 None
4183 }
4184}
4185
4186impl<'a> Iterator for ExcerptChunks<'a> {
4187 type Item = Chunk<'a>;
4188
4189 fn next(&mut self) -> Option<Self::Item> {
4190 if let Some(chunk) = self.content_chunks.next() {
4191 return Some(chunk);
4192 }
4193
4194 if self.footer_height > 0 {
4195 let text = unsafe { str::from_utf8_unchecked(&NEWLINES[..self.footer_height]) };
4196 self.footer_height = 0;
4197 return Some(Chunk {
4198 text,
4199 ..Default::default()
4200 });
4201 }
4202
4203 None
4204 }
4205}
4206
4207impl ToOffset for Point {
4208 fn to_offset<'a>(&self, snapshot: &MultiBufferSnapshot) -> usize {
4209 snapshot.point_to_offset(*self)
4210 }
4211}
4212
4213impl ToOffset for usize {
4214 fn to_offset<'a>(&self, snapshot: &MultiBufferSnapshot) -> usize {
4215 assert!(*self <= snapshot.len(), "offset is out of range");
4216 *self
4217 }
4218}
4219
4220impl ToOffset for OffsetUtf16 {
4221 fn to_offset<'a>(&self, snapshot: &MultiBufferSnapshot) -> usize {
4222 snapshot.offset_utf16_to_offset(*self)
4223 }
4224}
4225
4226impl ToOffset for PointUtf16 {
4227 fn to_offset<'a>(&self, snapshot: &MultiBufferSnapshot) -> usize {
4228 snapshot.point_utf16_to_offset(*self)
4229 }
4230}
4231
4232impl ToOffsetUtf16 for OffsetUtf16 {
4233 fn to_offset_utf16(&self, _snapshot: &MultiBufferSnapshot) -> OffsetUtf16 {
4234 *self
4235 }
4236}
4237
4238impl ToOffsetUtf16 for usize {
4239 fn to_offset_utf16(&self, snapshot: &MultiBufferSnapshot) -> OffsetUtf16 {
4240 snapshot.offset_to_offset_utf16(*self)
4241 }
4242}
4243
4244impl ToPoint for usize {
4245 fn to_point<'a>(&self, snapshot: &MultiBufferSnapshot) -> Point {
4246 snapshot.offset_to_point(*self)
4247 }
4248}
4249
4250impl ToPoint for Point {
4251 fn to_point<'a>(&self, _: &MultiBufferSnapshot) -> Point {
4252 *self
4253 }
4254}
4255
4256impl ToPointUtf16 for usize {
4257 fn to_point_utf16<'a>(&self, snapshot: &MultiBufferSnapshot) -> PointUtf16 {
4258 snapshot.offset_to_point_utf16(*self)
4259 }
4260}
4261
4262impl ToPointUtf16 for Point {
4263 fn to_point_utf16<'a>(&self, snapshot: &MultiBufferSnapshot) -> PointUtf16 {
4264 snapshot.point_to_point_utf16(*self)
4265 }
4266}
4267
4268impl ToPointUtf16 for PointUtf16 {
4269 fn to_point_utf16<'a>(&self, _: &MultiBufferSnapshot) -> PointUtf16 {
4270 *self
4271 }
4272}
4273
4274fn build_excerpt_ranges<T>(
4275 buffer: &BufferSnapshot,
4276 ranges: &[Range<T>],
4277 context_line_count: u32,
4278) -> (Vec<ExcerptRange<Point>>, Vec<usize>)
4279where
4280 T: text::ToPoint,
4281{
4282 let max_point = buffer.max_point();
4283 let mut range_counts = Vec::new();
4284 let mut excerpt_ranges = Vec::new();
4285 let mut range_iter = ranges
4286 .iter()
4287 .map(|range| range.start.to_point(buffer)..range.end.to_point(buffer))
4288 .peekable();
4289 while let Some(range) = range_iter.next() {
4290 let excerpt_start = Point::new(range.start.row.saturating_sub(context_line_count), 0);
4291 let mut excerpt_end = Point::new(range.end.row + context_line_count, 0).min(max_point);
4292
4293 let mut ranges_in_excerpt = 1;
4294
4295 while let Some(next_range) = range_iter.peek() {
4296 if next_range.start.row <= excerpt_end.row + context_line_count {
4297 excerpt_end =
4298 Point::new(next_range.end.row + 1 + context_line_count, 0).min(max_point);
4299 ranges_in_excerpt += 1;
4300 range_iter.next();
4301 } else {
4302 break;
4303 }
4304 }
4305
4306 excerpt_ranges.push(ExcerptRange {
4307 context: excerpt_start..excerpt_end,
4308 primary: Some(range),
4309 });
4310 range_counts.push(ranges_in_excerpt);
4311 }
4312
4313 (excerpt_ranges, range_counts)
4314}
4315
4316#[cfg(test)]
4317mod tests {
4318 use super::*;
4319 use futures::StreamExt;
4320 use gpui::{AppContext, Context, TestAppContext};
4321 use language::{Buffer, Rope};
4322 use parking_lot::RwLock;
4323 use rand::prelude::*;
4324 use settings::SettingsStore;
4325 use std::env;
4326 use util::test::sample_text;
4327
4328 #[gpui::test]
4329 fn test_singleton(cx: &mut AppContext) {
4330 let buffer = cx.new_model(|cx| {
4331 Buffer::new(
4332 0,
4333 BufferId::new(cx.entity_id().as_u64()).unwrap(),
4334 sample_text(6, 6, 'a'),
4335 )
4336 });
4337 let multibuffer = cx.new_model(|cx| MultiBuffer::singleton(buffer.clone(), cx));
4338
4339 let snapshot = multibuffer.read(cx).snapshot(cx);
4340 assert_eq!(snapshot.text(), buffer.read(cx).text());
4341
4342 assert_eq!(
4343 snapshot.buffer_rows(0).collect::<Vec<_>>(),
4344 (0..buffer.read(cx).row_count())
4345 .map(Some)
4346 .collect::<Vec<_>>()
4347 );
4348
4349 buffer.update(cx, |buffer, cx| buffer.edit([(1..3, "XXX\n")], None, cx));
4350 let snapshot = multibuffer.read(cx).snapshot(cx);
4351
4352 assert_eq!(snapshot.text(), buffer.read(cx).text());
4353 assert_eq!(
4354 snapshot.buffer_rows(0).collect::<Vec<_>>(),
4355 (0..buffer.read(cx).row_count())
4356 .map(Some)
4357 .collect::<Vec<_>>()
4358 );
4359 }
4360
4361 #[gpui::test]
4362 fn test_remote(cx: &mut AppContext) {
4363 let host_buffer =
4364 cx.new_model(|cx| Buffer::new(0, BufferId::new(cx.entity_id().as_u64()).unwrap(), "a"));
4365 let guest_buffer = cx.new_model(|cx| {
4366 let state = host_buffer.read(cx).to_proto();
4367 let ops = cx
4368 .background_executor()
4369 .block(host_buffer.read(cx).serialize_ops(None, cx));
4370 let mut buffer = Buffer::from_proto(1, Capability::ReadWrite, state, None).unwrap();
4371 buffer
4372 .apply_ops(
4373 ops.into_iter()
4374 .map(|op| language::proto::deserialize_operation(op).unwrap()),
4375 cx,
4376 )
4377 .unwrap();
4378 buffer
4379 });
4380 let multibuffer = cx.new_model(|cx| MultiBuffer::singleton(guest_buffer.clone(), cx));
4381 let snapshot = multibuffer.read(cx).snapshot(cx);
4382 assert_eq!(snapshot.text(), "a");
4383
4384 guest_buffer.update(cx, |buffer, cx| buffer.edit([(1..1, "b")], None, cx));
4385 let snapshot = multibuffer.read(cx).snapshot(cx);
4386 assert_eq!(snapshot.text(), "ab");
4387
4388 guest_buffer.update(cx, |buffer, cx| buffer.edit([(2..2, "c")], None, cx));
4389 let snapshot = multibuffer.read(cx).snapshot(cx);
4390 assert_eq!(snapshot.text(), "abc");
4391 }
4392
4393 #[gpui::test]
4394 fn test_excerpt_boundaries_and_clipping(cx: &mut AppContext) {
4395 let buffer_1 = cx.new_model(|cx| {
4396 Buffer::new(
4397 0,
4398 BufferId::new(cx.entity_id().as_u64()).unwrap(),
4399 sample_text(6, 6, 'a'),
4400 )
4401 });
4402 let buffer_2 = cx.new_model(|cx| {
4403 Buffer::new(
4404 0,
4405 BufferId::new(cx.entity_id().as_u64()).unwrap(),
4406 sample_text(6, 6, 'g'),
4407 )
4408 });
4409 let multibuffer = cx.new_model(|_| MultiBuffer::new(0, Capability::ReadWrite));
4410
4411 let events = Arc::new(RwLock::new(Vec::<Event>::new()));
4412 multibuffer.update(cx, |_, cx| {
4413 let events = events.clone();
4414 cx.subscribe(&multibuffer, move |_, _, event, _| {
4415 if let Event::Edited { .. } = event {
4416 events.write().push(event.clone())
4417 }
4418 })
4419 .detach();
4420 });
4421
4422 let subscription = multibuffer.update(cx, |multibuffer, cx| {
4423 let subscription = multibuffer.subscribe();
4424 multibuffer.push_excerpts(
4425 buffer_1.clone(),
4426 [ExcerptRange {
4427 context: Point::new(1, 2)..Point::new(2, 5),
4428 primary: None,
4429 }],
4430 cx,
4431 );
4432 assert_eq!(
4433 subscription.consume().into_inner(),
4434 [Edit {
4435 old: 0..0,
4436 new: 0..10
4437 }]
4438 );
4439
4440 multibuffer.push_excerpts(
4441 buffer_1.clone(),
4442 [ExcerptRange {
4443 context: Point::new(3, 3)..Point::new(4, 4),
4444 primary: None,
4445 }],
4446 cx,
4447 );
4448 multibuffer.push_excerpts(
4449 buffer_2.clone(),
4450 [ExcerptRange {
4451 context: Point::new(3, 1)..Point::new(3, 3),
4452 primary: None,
4453 }],
4454 cx,
4455 );
4456 assert_eq!(
4457 subscription.consume().into_inner(),
4458 [Edit {
4459 old: 10..10,
4460 new: 10..22
4461 }]
4462 );
4463
4464 subscription
4465 });
4466
4467 // Adding excerpts emits an edited event.
4468 assert_eq!(
4469 events.read().as_slice(),
4470 &[
4471 Event::Edited {
4472 singleton_buffer_edited: false
4473 },
4474 Event::Edited {
4475 singleton_buffer_edited: false
4476 },
4477 Event::Edited {
4478 singleton_buffer_edited: false
4479 }
4480 ]
4481 );
4482
4483 let snapshot = multibuffer.read(cx).snapshot(cx);
4484 assert_eq!(
4485 snapshot.text(),
4486 concat!(
4487 "bbbb\n", // Preserve newlines
4488 "ccccc\n", //
4489 "ddd\n", //
4490 "eeee\n", //
4491 "jj" //
4492 )
4493 );
4494 assert_eq!(
4495 snapshot.buffer_rows(0).collect::<Vec<_>>(),
4496 [Some(1), Some(2), Some(3), Some(4), Some(3)]
4497 );
4498 assert_eq!(
4499 snapshot.buffer_rows(2).collect::<Vec<_>>(),
4500 [Some(3), Some(4), Some(3)]
4501 );
4502 assert_eq!(snapshot.buffer_rows(4).collect::<Vec<_>>(), [Some(3)]);
4503 assert_eq!(snapshot.buffer_rows(5).collect::<Vec<_>>(), []);
4504
4505 assert_eq!(
4506 boundaries_in_range(Point::new(0, 0)..Point::new(4, 2), &snapshot),
4507 &[
4508 (0, "bbbb\nccccc".to_string(), true),
4509 (2, "ddd\neeee".to_string(), false),
4510 (4, "jj".to_string(), true),
4511 ]
4512 );
4513 assert_eq!(
4514 boundaries_in_range(Point::new(0, 0)..Point::new(2, 0), &snapshot),
4515 &[(0, "bbbb\nccccc".to_string(), true)]
4516 );
4517 assert_eq!(
4518 boundaries_in_range(Point::new(1, 0)..Point::new(1, 5), &snapshot),
4519 &[]
4520 );
4521 assert_eq!(
4522 boundaries_in_range(Point::new(1, 0)..Point::new(2, 0), &snapshot),
4523 &[]
4524 );
4525 assert_eq!(
4526 boundaries_in_range(Point::new(1, 0)..Point::new(4, 0), &snapshot),
4527 &[(2, "ddd\neeee".to_string(), false)]
4528 );
4529 assert_eq!(
4530 boundaries_in_range(Point::new(1, 0)..Point::new(4, 0), &snapshot),
4531 &[(2, "ddd\neeee".to_string(), false)]
4532 );
4533 assert_eq!(
4534 boundaries_in_range(Point::new(2, 0)..Point::new(3, 0), &snapshot),
4535 &[(2, "ddd\neeee".to_string(), false)]
4536 );
4537 assert_eq!(
4538 boundaries_in_range(Point::new(4, 0)..Point::new(4, 2), &snapshot),
4539 &[(4, "jj".to_string(), true)]
4540 );
4541 assert_eq!(
4542 boundaries_in_range(Point::new(4, 2)..Point::new(4, 2), &snapshot),
4543 &[]
4544 );
4545
4546 buffer_1.update(cx, |buffer, cx| {
4547 let text = "\n";
4548 buffer.edit(
4549 [
4550 (Point::new(0, 0)..Point::new(0, 0), text),
4551 (Point::new(2, 1)..Point::new(2, 3), text),
4552 ],
4553 None,
4554 cx,
4555 );
4556 });
4557
4558 let snapshot = multibuffer.read(cx).snapshot(cx);
4559 assert_eq!(
4560 snapshot.text(),
4561 concat!(
4562 "bbbb\n", // Preserve newlines
4563 "c\n", //
4564 "cc\n", //
4565 "ddd\n", //
4566 "eeee\n", //
4567 "jj" //
4568 )
4569 );
4570
4571 assert_eq!(
4572 subscription.consume().into_inner(),
4573 [Edit {
4574 old: 6..8,
4575 new: 6..7
4576 }]
4577 );
4578
4579 let snapshot = multibuffer.read(cx).snapshot(cx);
4580 assert_eq!(
4581 snapshot.clip_point(Point::new(0, 5), Bias::Left),
4582 Point::new(0, 4)
4583 );
4584 assert_eq!(
4585 snapshot.clip_point(Point::new(0, 5), Bias::Right),
4586 Point::new(0, 4)
4587 );
4588 assert_eq!(
4589 snapshot.clip_point(Point::new(5, 1), Bias::Right),
4590 Point::new(5, 1)
4591 );
4592 assert_eq!(
4593 snapshot.clip_point(Point::new(5, 2), Bias::Right),
4594 Point::new(5, 2)
4595 );
4596 assert_eq!(
4597 snapshot.clip_point(Point::new(5, 3), Bias::Right),
4598 Point::new(5, 2)
4599 );
4600
4601 let snapshot = multibuffer.update(cx, |multibuffer, cx| {
4602 let (buffer_2_excerpt_id, _) =
4603 multibuffer.excerpts_for_buffer(&buffer_2, cx)[0].clone();
4604 multibuffer.remove_excerpts([buffer_2_excerpt_id], cx);
4605 multibuffer.snapshot(cx)
4606 });
4607
4608 assert_eq!(
4609 snapshot.text(),
4610 concat!(
4611 "bbbb\n", // Preserve newlines
4612 "c\n", //
4613 "cc\n", //
4614 "ddd\n", //
4615 "eeee", //
4616 )
4617 );
4618
4619 fn boundaries_in_range(
4620 range: Range<Point>,
4621 snapshot: &MultiBufferSnapshot,
4622 ) -> Vec<(u32, String, bool)> {
4623 snapshot
4624 .excerpt_boundaries_in_range(range)
4625 .map(|boundary| {
4626 (
4627 boundary.row,
4628 boundary
4629 .buffer
4630 .text_for_range(boundary.range.context)
4631 .collect::<String>(),
4632 boundary.starts_new_buffer,
4633 )
4634 })
4635 .collect::<Vec<_>>()
4636 }
4637 }
4638
4639 #[gpui::test]
4640 fn test_excerpt_events(cx: &mut AppContext) {
4641 let buffer_1 = cx.new_model(|cx| {
4642 Buffer::new(
4643 0,
4644 BufferId::new(cx.entity_id().as_u64()).unwrap(),
4645 sample_text(10, 3, 'a'),
4646 )
4647 });
4648 let buffer_2 = cx.new_model(|cx| {
4649 Buffer::new(
4650 0,
4651 BufferId::new(cx.entity_id().as_u64()).unwrap(),
4652 sample_text(10, 3, 'm'),
4653 )
4654 });
4655
4656 let leader_multibuffer = cx.new_model(|_| MultiBuffer::new(0, Capability::ReadWrite));
4657 let follower_multibuffer = cx.new_model(|_| MultiBuffer::new(0, Capability::ReadWrite));
4658 let follower_edit_event_count = Arc::new(RwLock::new(0));
4659
4660 follower_multibuffer.update(cx, |_, cx| {
4661 let follower_edit_event_count = follower_edit_event_count.clone();
4662 cx.subscribe(
4663 &leader_multibuffer,
4664 move |follower, _, event, cx| match event.clone() {
4665 Event::ExcerptsAdded {
4666 buffer,
4667 predecessor,
4668 excerpts,
4669 } => follower.insert_excerpts_with_ids_after(predecessor, buffer, excerpts, cx),
4670 Event::ExcerptsRemoved { ids } => follower.remove_excerpts(ids, cx),
4671 Event::Edited { .. } => {
4672 *follower_edit_event_count.write() += 1;
4673 }
4674 _ => {}
4675 },
4676 )
4677 .detach();
4678 });
4679
4680 leader_multibuffer.update(cx, |leader, cx| {
4681 leader.push_excerpts(
4682 buffer_1.clone(),
4683 [
4684 ExcerptRange {
4685 context: 0..8,
4686 primary: None,
4687 },
4688 ExcerptRange {
4689 context: 12..16,
4690 primary: None,
4691 },
4692 ],
4693 cx,
4694 );
4695 leader.insert_excerpts_after(
4696 leader.excerpt_ids()[0],
4697 buffer_2.clone(),
4698 [
4699 ExcerptRange {
4700 context: 0..5,
4701 primary: None,
4702 },
4703 ExcerptRange {
4704 context: 10..15,
4705 primary: None,
4706 },
4707 ],
4708 cx,
4709 )
4710 });
4711 assert_eq!(
4712 leader_multibuffer.read(cx).snapshot(cx).text(),
4713 follower_multibuffer.read(cx).snapshot(cx).text(),
4714 );
4715 assert_eq!(*follower_edit_event_count.read(), 2);
4716
4717 leader_multibuffer.update(cx, |leader, cx| {
4718 let excerpt_ids = leader.excerpt_ids();
4719 leader.remove_excerpts([excerpt_ids[1], excerpt_ids[3]], cx);
4720 });
4721 assert_eq!(
4722 leader_multibuffer.read(cx).snapshot(cx).text(),
4723 follower_multibuffer.read(cx).snapshot(cx).text(),
4724 );
4725 assert_eq!(*follower_edit_event_count.read(), 3);
4726
4727 // Removing an empty set of excerpts is a noop.
4728 leader_multibuffer.update(cx, |leader, cx| {
4729 leader.remove_excerpts([], cx);
4730 });
4731 assert_eq!(
4732 leader_multibuffer.read(cx).snapshot(cx).text(),
4733 follower_multibuffer.read(cx).snapshot(cx).text(),
4734 );
4735 assert_eq!(*follower_edit_event_count.read(), 3);
4736
4737 // Adding an empty set of excerpts is a noop.
4738 leader_multibuffer.update(cx, |leader, cx| {
4739 leader.push_excerpts::<usize>(buffer_2.clone(), [], cx);
4740 });
4741 assert_eq!(
4742 leader_multibuffer.read(cx).snapshot(cx).text(),
4743 follower_multibuffer.read(cx).snapshot(cx).text(),
4744 );
4745 assert_eq!(*follower_edit_event_count.read(), 3);
4746
4747 leader_multibuffer.update(cx, |leader, cx| {
4748 leader.clear(cx);
4749 });
4750 assert_eq!(
4751 leader_multibuffer.read(cx).snapshot(cx).text(),
4752 follower_multibuffer.read(cx).snapshot(cx).text(),
4753 );
4754 assert_eq!(*follower_edit_event_count.read(), 4);
4755 }
4756
4757 #[gpui::test]
4758 fn test_push_excerpts_with_context_lines(cx: &mut AppContext) {
4759 let buffer = cx.new_model(|cx| {
4760 Buffer::new(
4761 0,
4762 BufferId::new(cx.entity_id().as_u64()).unwrap(),
4763 sample_text(20, 3, 'a'),
4764 )
4765 });
4766 let multibuffer = cx.new_model(|_| MultiBuffer::new(0, Capability::ReadWrite));
4767 let anchor_ranges = multibuffer.update(cx, |multibuffer, cx| {
4768 multibuffer.push_excerpts_with_context_lines(
4769 buffer.clone(),
4770 vec![
4771 Point::new(3, 2)..Point::new(4, 2),
4772 Point::new(7, 1)..Point::new(7, 3),
4773 Point::new(15, 0)..Point::new(15, 0),
4774 ],
4775 2,
4776 cx,
4777 )
4778 });
4779
4780 let snapshot = multibuffer.read(cx).snapshot(cx);
4781 assert_eq!(
4782 snapshot.text(),
4783 "bbb\nccc\nddd\neee\nfff\nggg\nhhh\niii\njjj\n\nnnn\nooo\nppp\nqqq\n"
4784 );
4785
4786 assert_eq!(
4787 anchor_ranges
4788 .iter()
4789 .map(|range| range.to_point(&snapshot))
4790 .collect::<Vec<_>>(),
4791 vec![
4792 Point::new(2, 2)..Point::new(3, 2),
4793 Point::new(6, 1)..Point::new(6, 3),
4794 Point::new(12, 0)..Point::new(12, 0)
4795 ]
4796 );
4797 }
4798
4799 #[gpui::test]
4800 async fn test_stream_excerpts_with_context_lines(cx: &mut TestAppContext) {
4801 let buffer = cx.new_model(|cx| {
4802 Buffer::new(
4803 0,
4804 BufferId::new(cx.entity_id().as_u64()).unwrap(),
4805 sample_text(20, 3, 'a'),
4806 )
4807 });
4808 let multibuffer = cx.new_model(|_| MultiBuffer::new(0, Capability::ReadWrite));
4809 let anchor_ranges = multibuffer.update(cx, |multibuffer, cx| {
4810 let snapshot = buffer.read(cx);
4811 let ranges = vec![
4812 snapshot.anchor_before(Point::new(3, 2))..snapshot.anchor_before(Point::new(4, 2)),
4813 snapshot.anchor_before(Point::new(7, 1))..snapshot.anchor_before(Point::new(7, 3)),
4814 snapshot.anchor_before(Point::new(15, 0))
4815 ..snapshot.anchor_before(Point::new(15, 0)),
4816 ];
4817 multibuffer.stream_excerpts_with_context_lines(buffer.clone(), ranges, 2, cx)
4818 });
4819
4820 let anchor_ranges = anchor_ranges.collect::<Vec<_>>().await;
4821
4822 let snapshot = multibuffer.update(cx, |multibuffer, cx| multibuffer.snapshot(cx));
4823 assert_eq!(
4824 snapshot.text(),
4825 "bbb\nccc\nddd\neee\nfff\nggg\nhhh\niii\njjj\n\nnnn\nooo\nppp\nqqq\n"
4826 );
4827
4828 assert_eq!(
4829 anchor_ranges
4830 .iter()
4831 .map(|range| range.to_point(&snapshot))
4832 .collect::<Vec<_>>(),
4833 vec![
4834 Point::new(2, 2)..Point::new(3, 2),
4835 Point::new(6, 1)..Point::new(6, 3),
4836 Point::new(12, 0)..Point::new(12, 0)
4837 ]
4838 );
4839 }
4840
4841 #[gpui::test]
4842 fn test_empty_multibuffer(cx: &mut AppContext) {
4843 let multibuffer = cx.new_model(|_| MultiBuffer::new(0, Capability::ReadWrite));
4844
4845 let snapshot = multibuffer.read(cx).snapshot(cx);
4846 assert_eq!(snapshot.text(), "");
4847 assert_eq!(snapshot.buffer_rows(0).collect::<Vec<_>>(), &[Some(0)]);
4848 assert_eq!(snapshot.buffer_rows(1).collect::<Vec<_>>(), &[]);
4849 }
4850
4851 #[gpui::test]
4852 fn test_singleton_multibuffer_anchors(cx: &mut AppContext) {
4853 let buffer = cx.new_model(|cx| {
4854 Buffer::new(0, BufferId::new(cx.entity_id().as_u64()).unwrap(), "abcd")
4855 });
4856 let multibuffer = cx.new_model(|cx| MultiBuffer::singleton(buffer.clone(), cx));
4857 let old_snapshot = multibuffer.read(cx).snapshot(cx);
4858 buffer.update(cx, |buffer, cx| {
4859 buffer.edit([(0..0, "X")], None, cx);
4860 buffer.edit([(5..5, "Y")], None, cx);
4861 });
4862 let new_snapshot = multibuffer.read(cx).snapshot(cx);
4863
4864 assert_eq!(old_snapshot.text(), "abcd");
4865 assert_eq!(new_snapshot.text(), "XabcdY");
4866
4867 assert_eq!(old_snapshot.anchor_before(0).to_offset(&new_snapshot), 0);
4868 assert_eq!(old_snapshot.anchor_after(0).to_offset(&new_snapshot), 1);
4869 assert_eq!(old_snapshot.anchor_before(4).to_offset(&new_snapshot), 5);
4870 assert_eq!(old_snapshot.anchor_after(4).to_offset(&new_snapshot), 6);
4871 }
4872
4873 #[gpui::test]
4874 fn test_multibuffer_anchors(cx: &mut AppContext) {
4875 let buffer_1 = cx.new_model(|cx| {
4876 Buffer::new(0, BufferId::new(cx.entity_id().as_u64()).unwrap(), "abcd")
4877 });
4878 let buffer_2 = cx.new_model(|cx| {
4879 Buffer::new(0, BufferId::new(cx.entity_id().as_u64()).unwrap(), "efghi")
4880 });
4881 let multibuffer = cx.new_model(|cx| {
4882 let mut multibuffer = MultiBuffer::new(0, Capability::ReadWrite);
4883 multibuffer.push_excerpts(
4884 buffer_1.clone(),
4885 [ExcerptRange {
4886 context: 0..4,
4887 primary: None,
4888 }],
4889 cx,
4890 );
4891 multibuffer.push_excerpts(
4892 buffer_2.clone(),
4893 [ExcerptRange {
4894 context: 0..5,
4895 primary: None,
4896 }],
4897 cx,
4898 );
4899 multibuffer
4900 });
4901 let old_snapshot = multibuffer.read(cx).snapshot(cx);
4902
4903 assert_eq!(old_snapshot.anchor_before(0).to_offset(&old_snapshot), 0);
4904 assert_eq!(old_snapshot.anchor_after(0).to_offset(&old_snapshot), 0);
4905 assert_eq!(Anchor::min().to_offset(&old_snapshot), 0);
4906 assert_eq!(Anchor::min().to_offset(&old_snapshot), 0);
4907 assert_eq!(Anchor::max().to_offset(&old_snapshot), 10);
4908 assert_eq!(Anchor::max().to_offset(&old_snapshot), 10);
4909
4910 buffer_1.update(cx, |buffer, cx| {
4911 buffer.edit([(0..0, "W")], None, cx);
4912 buffer.edit([(5..5, "X")], None, cx);
4913 });
4914 buffer_2.update(cx, |buffer, cx| {
4915 buffer.edit([(0..0, "Y")], None, cx);
4916 buffer.edit([(6..6, "Z")], None, cx);
4917 });
4918 let new_snapshot = multibuffer.read(cx).snapshot(cx);
4919
4920 assert_eq!(old_snapshot.text(), "abcd\nefghi");
4921 assert_eq!(new_snapshot.text(), "WabcdX\nYefghiZ");
4922
4923 assert_eq!(old_snapshot.anchor_before(0).to_offset(&new_snapshot), 0);
4924 assert_eq!(old_snapshot.anchor_after(0).to_offset(&new_snapshot), 1);
4925 assert_eq!(old_snapshot.anchor_before(1).to_offset(&new_snapshot), 2);
4926 assert_eq!(old_snapshot.anchor_after(1).to_offset(&new_snapshot), 2);
4927 assert_eq!(old_snapshot.anchor_before(2).to_offset(&new_snapshot), 3);
4928 assert_eq!(old_snapshot.anchor_after(2).to_offset(&new_snapshot), 3);
4929 assert_eq!(old_snapshot.anchor_before(5).to_offset(&new_snapshot), 7);
4930 assert_eq!(old_snapshot.anchor_after(5).to_offset(&new_snapshot), 8);
4931 assert_eq!(old_snapshot.anchor_before(10).to_offset(&new_snapshot), 13);
4932 assert_eq!(old_snapshot.anchor_after(10).to_offset(&new_snapshot), 14);
4933 }
4934
4935 #[gpui::test]
4936 fn test_resolving_anchors_after_replacing_their_excerpts(cx: &mut AppContext) {
4937 let buffer_1 = cx.new_model(|cx| {
4938 Buffer::new(0, BufferId::new(cx.entity_id().as_u64()).unwrap(), "abcd")
4939 });
4940 let buffer_2 = cx.new_model(|cx| {
4941 Buffer::new(
4942 0,
4943 BufferId::new(cx.entity_id().as_u64()).unwrap(),
4944 "ABCDEFGHIJKLMNOP",
4945 )
4946 });
4947 let multibuffer = cx.new_model(|_| MultiBuffer::new(0, Capability::ReadWrite));
4948
4949 // Create an insertion id in buffer 1 that doesn't exist in buffer 2.
4950 // Add an excerpt from buffer 1 that spans this new insertion.
4951 buffer_1.update(cx, |buffer, cx| buffer.edit([(4..4, "123")], None, cx));
4952 let excerpt_id_1 = multibuffer.update(cx, |multibuffer, cx| {
4953 multibuffer
4954 .push_excerpts(
4955 buffer_1.clone(),
4956 [ExcerptRange {
4957 context: 0..7,
4958 primary: None,
4959 }],
4960 cx,
4961 )
4962 .pop()
4963 .unwrap()
4964 });
4965
4966 let snapshot_1 = multibuffer.read(cx).snapshot(cx);
4967 assert_eq!(snapshot_1.text(), "abcd123");
4968
4969 // Replace the buffer 1 excerpt with new excerpts from buffer 2.
4970 let (excerpt_id_2, excerpt_id_3) = multibuffer.update(cx, |multibuffer, cx| {
4971 multibuffer.remove_excerpts([excerpt_id_1], cx);
4972 let mut ids = multibuffer
4973 .push_excerpts(
4974 buffer_2.clone(),
4975 [
4976 ExcerptRange {
4977 context: 0..4,
4978 primary: None,
4979 },
4980 ExcerptRange {
4981 context: 6..10,
4982 primary: None,
4983 },
4984 ExcerptRange {
4985 context: 12..16,
4986 primary: None,
4987 },
4988 ],
4989 cx,
4990 )
4991 .into_iter();
4992 (ids.next().unwrap(), ids.next().unwrap())
4993 });
4994 let snapshot_2 = multibuffer.read(cx).snapshot(cx);
4995 assert_eq!(snapshot_2.text(), "ABCD\nGHIJ\nMNOP");
4996
4997 // The old excerpt id doesn't get reused.
4998 assert_ne!(excerpt_id_2, excerpt_id_1);
4999
5000 // Resolve some anchors from the previous snapshot in the new snapshot.
5001 // The current excerpts are from a different buffer, so we don't attempt to
5002 // resolve the old text anchor in the new buffer.
5003 assert_eq!(
5004 snapshot_2.summary_for_anchor::<usize>(&snapshot_1.anchor_before(2)),
5005 0
5006 );
5007 assert_eq!(
5008 snapshot_2.summaries_for_anchors::<usize, _>(&[
5009 snapshot_1.anchor_before(2),
5010 snapshot_1.anchor_after(3)
5011 ]),
5012 vec![0, 0]
5013 );
5014
5015 // Refresh anchors from the old snapshot. The return value indicates that both
5016 // anchors lost their original excerpt.
5017 let refresh =
5018 snapshot_2.refresh_anchors(&[snapshot_1.anchor_before(2), snapshot_1.anchor_after(3)]);
5019 assert_eq!(
5020 refresh,
5021 &[
5022 (0, snapshot_2.anchor_before(0), false),
5023 (1, snapshot_2.anchor_after(0), false),
5024 ]
5025 );
5026
5027 // Replace the middle excerpt with a smaller excerpt in buffer 2,
5028 // that intersects the old excerpt.
5029 let excerpt_id_5 = multibuffer.update(cx, |multibuffer, cx| {
5030 multibuffer.remove_excerpts([excerpt_id_3], cx);
5031 multibuffer
5032 .insert_excerpts_after(
5033 excerpt_id_2,
5034 buffer_2.clone(),
5035 [ExcerptRange {
5036 context: 5..8,
5037 primary: None,
5038 }],
5039 cx,
5040 )
5041 .pop()
5042 .unwrap()
5043 });
5044
5045 let snapshot_3 = multibuffer.read(cx).snapshot(cx);
5046 assert_eq!(snapshot_3.text(), "ABCD\nFGH\nMNOP");
5047 assert_ne!(excerpt_id_5, excerpt_id_3);
5048
5049 // Resolve some anchors from the previous snapshot in the new snapshot.
5050 // The third anchor can't be resolved, since its excerpt has been removed,
5051 // so it resolves to the same position as its predecessor.
5052 let anchors = [
5053 snapshot_2.anchor_before(0),
5054 snapshot_2.anchor_after(2),
5055 snapshot_2.anchor_after(6),
5056 snapshot_2.anchor_after(14),
5057 ];
5058 assert_eq!(
5059 snapshot_3.summaries_for_anchors::<usize, _>(&anchors),
5060 &[0, 2, 9, 13]
5061 );
5062
5063 let new_anchors = snapshot_3.refresh_anchors(&anchors);
5064 assert_eq!(
5065 new_anchors.iter().map(|a| (a.0, a.2)).collect::<Vec<_>>(),
5066 &[(0, true), (1, true), (2, true), (3, true)]
5067 );
5068 assert_eq!(
5069 snapshot_3.summaries_for_anchors::<usize, _>(new_anchors.iter().map(|a| &a.1)),
5070 &[0, 2, 7, 13]
5071 );
5072 }
5073
5074 #[gpui::test(iterations = 100)]
5075 fn test_random_multibuffer(cx: &mut AppContext, mut rng: StdRng) {
5076 let operations = env::var("OPERATIONS")
5077 .map(|i| i.parse().expect("invalid `OPERATIONS` variable"))
5078 .unwrap_or(10);
5079
5080 let mut buffers: Vec<Model<Buffer>> = Vec::new();
5081 let multibuffer = cx.new_model(|_| MultiBuffer::new(0, Capability::ReadWrite));
5082 let mut excerpt_ids = Vec::<ExcerptId>::new();
5083 let mut expected_excerpts = Vec::<(Model<Buffer>, Range<text::Anchor>)>::new();
5084 let mut anchors = Vec::new();
5085 let mut old_versions = Vec::new();
5086
5087 for _ in 0..operations {
5088 match rng.gen_range(0..100) {
5089 0..=19 if !buffers.is_empty() => {
5090 let buffer = buffers.choose(&mut rng).unwrap();
5091 buffer.update(cx, |buf, cx| buf.randomly_edit(&mut rng, 5, cx));
5092 }
5093 20..=29 if !expected_excerpts.is_empty() => {
5094 let mut ids_to_remove = vec![];
5095 for _ in 0..rng.gen_range(1..=3) {
5096 if expected_excerpts.is_empty() {
5097 break;
5098 }
5099
5100 let ix = rng.gen_range(0..expected_excerpts.len());
5101 ids_to_remove.push(excerpt_ids.remove(ix));
5102 let (buffer, range) = expected_excerpts.remove(ix);
5103 let buffer = buffer.read(cx);
5104 log::info!(
5105 "Removing excerpt {}: {:?}",
5106 ix,
5107 buffer
5108 .text_for_range(range.to_offset(buffer))
5109 .collect::<String>(),
5110 );
5111 }
5112 let snapshot = multibuffer.read(cx).read(cx);
5113 ids_to_remove.sort_unstable_by(|a, b| a.cmp(&b, &snapshot));
5114 drop(snapshot);
5115 multibuffer.update(cx, |multibuffer, cx| {
5116 multibuffer.remove_excerpts(ids_to_remove, cx)
5117 });
5118 }
5119 30..=39 if !expected_excerpts.is_empty() => {
5120 let multibuffer = multibuffer.read(cx).read(cx);
5121 let offset =
5122 multibuffer.clip_offset(rng.gen_range(0..=multibuffer.len()), Bias::Left);
5123 let bias = if rng.gen() { Bias::Left } else { Bias::Right };
5124 log::info!("Creating anchor at {} with bias {:?}", offset, bias);
5125 anchors.push(multibuffer.anchor_at(offset, bias));
5126 anchors.sort_by(|a, b| a.cmp(b, &multibuffer));
5127 }
5128 40..=44 if !anchors.is_empty() => {
5129 let multibuffer = multibuffer.read(cx).read(cx);
5130 let prev_len = anchors.len();
5131 anchors = multibuffer
5132 .refresh_anchors(&anchors)
5133 .into_iter()
5134 .map(|a| a.1)
5135 .collect();
5136
5137 // Ensure the newly-refreshed anchors point to a valid excerpt and don't
5138 // overshoot its boundaries.
5139 assert_eq!(anchors.len(), prev_len);
5140 for anchor in &anchors {
5141 if anchor.excerpt_id == ExcerptId::min()
5142 || anchor.excerpt_id == ExcerptId::max()
5143 {
5144 continue;
5145 }
5146
5147 let excerpt = multibuffer.excerpt(anchor.excerpt_id).unwrap();
5148 assert_eq!(excerpt.id, anchor.excerpt_id);
5149 assert!(excerpt.contains(anchor));
5150 }
5151 }
5152 _ => {
5153 let buffer_handle = if buffers.is_empty() || rng.gen_bool(0.4) {
5154 let base_text = util::RandomCharIter::new(&mut rng)
5155 .take(10)
5156 .collect::<String>();
5157 buffers.push(cx.new_model(|cx| {
5158 Buffer::new(
5159 0,
5160 BufferId::new(cx.entity_id().as_u64()).unwrap(),
5161 base_text,
5162 )
5163 }));
5164 buffers.last().unwrap()
5165 } else {
5166 buffers.choose(&mut rng).unwrap()
5167 };
5168
5169 let buffer = buffer_handle.read(cx);
5170 let end_ix = buffer.clip_offset(rng.gen_range(0..=buffer.len()), Bias::Right);
5171 let start_ix = buffer.clip_offset(rng.gen_range(0..=end_ix), Bias::Left);
5172 let anchor_range = buffer.anchor_before(start_ix)..buffer.anchor_after(end_ix);
5173 let prev_excerpt_ix = rng.gen_range(0..=expected_excerpts.len());
5174 let prev_excerpt_id = excerpt_ids
5175 .get(prev_excerpt_ix)
5176 .cloned()
5177 .unwrap_or_else(ExcerptId::max);
5178 let excerpt_ix = (prev_excerpt_ix + 1).min(expected_excerpts.len());
5179
5180 log::info!(
5181 "Inserting excerpt at {} of {} for buffer {}: {:?}[{:?}] = {:?}",
5182 excerpt_ix,
5183 expected_excerpts.len(),
5184 buffer_handle.read(cx).remote_id(),
5185 buffer.text(),
5186 start_ix..end_ix,
5187 &buffer.text()[start_ix..end_ix]
5188 );
5189
5190 let excerpt_id = multibuffer.update(cx, |multibuffer, cx| {
5191 multibuffer
5192 .insert_excerpts_after(
5193 prev_excerpt_id,
5194 buffer_handle.clone(),
5195 [ExcerptRange {
5196 context: start_ix..end_ix,
5197 primary: None,
5198 }],
5199 cx,
5200 )
5201 .pop()
5202 .unwrap()
5203 });
5204
5205 excerpt_ids.insert(excerpt_ix, excerpt_id);
5206 expected_excerpts.insert(excerpt_ix, (buffer_handle.clone(), anchor_range));
5207 }
5208 }
5209
5210 if rng.gen_bool(0.3) {
5211 multibuffer.update(cx, |multibuffer, cx| {
5212 old_versions.push((multibuffer.snapshot(cx), multibuffer.subscribe()));
5213 })
5214 }
5215
5216 let snapshot = multibuffer.read(cx).snapshot(cx);
5217
5218 let mut excerpt_starts = Vec::new();
5219 let mut expected_text = String::new();
5220 let mut expected_buffer_rows = Vec::new();
5221 for (buffer, range) in &expected_excerpts {
5222 let buffer = buffer.read(cx);
5223 let buffer_range = range.to_offset(buffer);
5224
5225 excerpt_starts.push(TextSummary::from(expected_text.as_str()));
5226 expected_text.extend(buffer.text_for_range(buffer_range.clone()));
5227 expected_text.push('\n');
5228
5229 let buffer_row_range = buffer.offset_to_point(buffer_range.start).row
5230 ..=buffer.offset_to_point(buffer_range.end).row;
5231 for row in buffer_row_range {
5232 expected_buffer_rows.push(Some(row));
5233 }
5234 }
5235 // Remove final trailing newline.
5236 if !expected_excerpts.is_empty() {
5237 expected_text.pop();
5238 }
5239
5240 // Always report one buffer row
5241 if expected_buffer_rows.is_empty() {
5242 expected_buffer_rows.push(Some(0));
5243 }
5244
5245 assert_eq!(snapshot.text(), expected_text);
5246 log::info!("MultiBuffer text: {:?}", expected_text);
5247
5248 assert_eq!(
5249 snapshot.buffer_rows(0).collect::<Vec<_>>(),
5250 expected_buffer_rows,
5251 );
5252
5253 for _ in 0..5 {
5254 let start_row = rng.gen_range(0..=expected_buffer_rows.len());
5255 assert_eq!(
5256 snapshot.buffer_rows(start_row as u32).collect::<Vec<_>>(),
5257 &expected_buffer_rows[start_row..],
5258 "buffer_rows({})",
5259 start_row
5260 );
5261 }
5262
5263 assert_eq!(
5264 snapshot.max_buffer_row(),
5265 expected_buffer_rows.into_iter().flatten().max().unwrap()
5266 );
5267
5268 let mut excerpt_starts = excerpt_starts.into_iter();
5269 for (buffer, range) in &expected_excerpts {
5270 let buffer = buffer.read(cx);
5271 let buffer_id = buffer.remote_id();
5272 let buffer_range = range.to_offset(buffer);
5273 let buffer_start_point = buffer.offset_to_point(buffer_range.start);
5274 let buffer_start_point_utf16 =
5275 buffer.text_summary_for_range::<PointUtf16, _>(0..buffer_range.start);
5276
5277 let excerpt_start = excerpt_starts.next().unwrap();
5278 let mut offset = excerpt_start.len;
5279 let mut buffer_offset = buffer_range.start;
5280 let mut point = excerpt_start.lines;
5281 let mut buffer_point = buffer_start_point;
5282 let mut point_utf16 = excerpt_start.lines_utf16();
5283 let mut buffer_point_utf16 = buffer_start_point_utf16;
5284 for ch in buffer
5285 .snapshot()
5286 .chunks(buffer_range.clone(), false)
5287 .flat_map(|c| c.text.chars())
5288 {
5289 for _ in 0..ch.len_utf8() {
5290 let left_offset = snapshot.clip_offset(offset, Bias::Left);
5291 let right_offset = snapshot.clip_offset(offset, Bias::Right);
5292 let buffer_left_offset = buffer.clip_offset(buffer_offset, Bias::Left);
5293 let buffer_right_offset = buffer.clip_offset(buffer_offset, Bias::Right);
5294 assert_eq!(
5295 left_offset,
5296 excerpt_start.len + (buffer_left_offset - buffer_range.start),
5297 "clip_offset({:?}, Left). buffer: {:?}, buffer offset: {:?}",
5298 offset,
5299 buffer_id,
5300 buffer_offset,
5301 );
5302 assert_eq!(
5303 right_offset,
5304 excerpt_start.len + (buffer_right_offset - buffer_range.start),
5305 "clip_offset({:?}, Right). buffer: {:?}, buffer offset: {:?}",
5306 offset,
5307 buffer_id,
5308 buffer_offset,
5309 );
5310
5311 let left_point = snapshot.clip_point(point, Bias::Left);
5312 let right_point = snapshot.clip_point(point, Bias::Right);
5313 let buffer_left_point = buffer.clip_point(buffer_point, Bias::Left);
5314 let buffer_right_point = buffer.clip_point(buffer_point, Bias::Right);
5315 assert_eq!(
5316 left_point,
5317 excerpt_start.lines + (buffer_left_point - buffer_start_point),
5318 "clip_point({:?}, Left). buffer: {:?}, buffer point: {:?}",
5319 point,
5320 buffer_id,
5321 buffer_point,
5322 );
5323 assert_eq!(
5324 right_point,
5325 excerpt_start.lines + (buffer_right_point - buffer_start_point),
5326 "clip_point({:?}, Right). buffer: {:?}, buffer point: {:?}",
5327 point,
5328 buffer_id,
5329 buffer_point,
5330 );
5331
5332 assert_eq!(
5333 snapshot.point_to_offset(left_point),
5334 left_offset,
5335 "point_to_offset({:?})",
5336 left_point,
5337 );
5338 assert_eq!(
5339 snapshot.offset_to_point(left_offset),
5340 left_point,
5341 "offset_to_point({:?})",
5342 left_offset,
5343 );
5344
5345 offset += 1;
5346 buffer_offset += 1;
5347 if ch == '\n' {
5348 point += Point::new(1, 0);
5349 buffer_point += Point::new(1, 0);
5350 } else {
5351 point += Point::new(0, 1);
5352 buffer_point += Point::new(0, 1);
5353 }
5354 }
5355
5356 for _ in 0..ch.len_utf16() {
5357 let left_point_utf16 =
5358 snapshot.clip_point_utf16(Unclipped(point_utf16), Bias::Left);
5359 let right_point_utf16 =
5360 snapshot.clip_point_utf16(Unclipped(point_utf16), Bias::Right);
5361 let buffer_left_point_utf16 =
5362 buffer.clip_point_utf16(Unclipped(buffer_point_utf16), Bias::Left);
5363 let buffer_right_point_utf16 =
5364 buffer.clip_point_utf16(Unclipped(buffer_point_utf16), Bias::Right);
5365 assert_eq!(
5366 left_point_utf16,
5367 excerpt_start.lines_utf16()
5368 + (buffer_left_point_utf16 - buffer_start_point_utf16),
5369 "clip_point_utf16({:?}, Left). buffer: {:?}, buffer point_utf16: {:?}",
5370 point_utf16,
5371 buffer_id,
5372 buffer_point_utf16,
5373 );
5374 assert_eq!(
5375 right_point_utf16,
5376 excerpt_start.lines_utf16()
5377 + (buffer_right_point_utf16 - buffer_start_point_utf16),
5378 "clip_point_utf16({:?}, Right). buffer: {:?}, buffer point_utf16: {:?}",
5379 point_utf16,
5380 buffer_id,
5381 buffer_point_utf16,
5382 );
5383
5384 if ch == '\n' {
5385 point_utf16 += PointUtf16::new(1, 0);
5386 buffer_point_utf16 += PointUtf16::new(1, 0);
5387 } else {
5388 point_utf16 += PointUtf16::new(0, 1);
5389 buffer_point_utf16 += PointUtf16::new(0, 1);
5390 }
5391 }
5392 }
5393 }
5394
5395 for (row, line) in expected_text.split('\n').enumerate() {
5396 assert_eq!(
5397 snapshot.line_len(row as u32),
5398 line.len() as u32,
5399 "line_len({}).",
5400 row
5401 );
5402 }
5403
5404 let text_rope = Rope::from(expected_text.as_str());
5405 for _ in 0..10 {
5406 let end_ix = text_rope.clip_offset(rng.gen_range(0..=text_rope.len()), Bias::Right);
5407 let start_ix = text_rope.clip_offset(rng.gen_range(0..=end_ix), Bias::Left);
5408
5409 let text_for_range = snapshot
5410 .text_for_range(start_ix..end_ix)
5411 .collect::<String>();
5412 assert_eq!(
5413 text_for_range,
5414 &expected_text[start_ix..end_ix],
5415 "incorrect text for range {:?}",
5416 start_ix..end_ix
5417 );
5418
5419 let excerpted_buffer_ranges = multibuffer
5420 .read(cx)
5421 .range_to_buffer_ranges(start_ix..end_ix, cx);
5422 let excerpted_buffers_text = excerpted_buffer_ranges
5423 .iter()
5424 .map(|(buffer, buffer_range, _)| {
5425 buffer
5426 .read(cx)
5427 .text_for_range(buffer_range.clone())
5428 .collect::<String>()
5429 })
5430 .collect::<Vec<_>>()
5431 .join("\n");
5432 assert_eq!(excerpted_buffers_text, text_for_range);
5433 if !expected_excerpts.is_empty() {
5434 assert!(!excerpted_buffer_ranges.is_empty());
5435 }
5436
5437 let expected_summary = TextSummary::from(&expected_text[start_ix..end_ix]);
5438 assert_eq!(
5439 snapshot.text_summary_for_range::<TextSummary, _>(start_ix..end_ix),
5440 expected_summary,
5441 "incorrect summary for range {:?}",
5442 start_ix..end_ix
5443 );
5444 }
5445
5446 // Anchor resolution
5447 let summaries = snapshot.summaries_for_anchors::<usize, _>(&anchors);
5448 assert_eq!(anchors.len(), summaries.len());
5449 for (anchor, resolved_offset) in anchors.iter().zip(summaries) {
5450 assert!(resolved_offset <= snapshot.len());
5451 assert_eq!(
5452 snapshot.summary_for_anchor::<usize>(anchor),
5453 resolved_offset
5454 );
5455 }
5456
5457 for _ in 0..10 {
5458 let end_ix = text_rope.clip_offset(rng.gen_range(0..=text_rope.len()), Bias::Right);
5459 assert_eq!(
5460 snapshot.reversed_chars_at(end_ix).collect::<String>(),
5461 expected_text[..end_ix].chars().rev().collect::<String>(),
5462 );
5463 }
5464
5465 for _ in 0..10 {
5466 let end_ix = rng.gen_range(0..=text_rope.len());
5467 let start_ix = rng.gen_range(0..=end_ix);
5468 assert_eq!(
5469 snapshot
5470 .bytes_in_range(start_ix..end_ix)
5471 .flatten()
5472 .copied()
5473 .collect::<Vec<_>>(),
5474 expected_text.as_bytes()[start_ix..end_ix].to_vec(),
5475 "bytes_in_range({:?})",
5476 start_ix..end_ix,
5477 );
5478 }
5479 }
5480
5481 let snapshot = multibuffer.read(cx).snapshot(cx);
5482 for (old_snapshot, subscription) in old_versions {
5483 let edits = subscription.consume().into_inner();
5484
5485 log::info!(
5486 "applying subscription edits to old text: {:?}: {:?}",
5487 old_snapshot.text(),
5488 edits,
5489 );
5490
5491 let mut text = old_snapshot.text();
5492 for edit in edits {
5493 let new_text: String = snapshot.text_for_range(edit.new.clone()).collect();
5494 text.replace_range(edit.new.start..edit.new.start + edit.old.len(), &new_text);
5495 }
5496 assert_eq!(text.to_string(), snapshot.text());
5497 }
5498 }
5499
5500 #[gpui::test]
5501 fn test_history(cx: &mut AppContext) {
5502 let test_settings = SettingsStore::test(cx);
5503 cx.set_global(test_settings);
5504
5505 let buffer_1 = cx.new_model(|cx| {
5506 Buffer::new(0, BufferId::new(cx.entity_id().as_u64()).unwrap(), "1234")
5507 });
5508 let buffer_2 = cx.new_model(|cx| {
5509 Buffer::new(0, BufferId::new(cx.entity_id().as_u64()).unwrap(), "5678")
5510 });
5511 let multibuffer = cx.new_model(|_| MultiBuffer::new(0, Capability::ReadWrite));
5512 let group_interval = multibuffer.read(cx).history.group_interval;
5513 multibuffer.update(cx, |multibuffer, cx| {
5514 multibuffer.push_excerpts(
5515 buffer_1.clone(),
5516 [ExcerptRange {
5517 context: 0..buffer_1.read(cx).len(),
5518 primary: None,
5519 }],
5520 cx,
5521 );
5522 multibuffer.push_excerpts(
5523 buffer_2.clone(),
5524 [ExcerptRange {
5525 context: 0..buffer_2.read(cx).len(),
5526 primary: None,
5527 }],
5528 cx,
5529 );
5530 });
5531
5532 let mut now = Instant::now();
5533
5534 multibuffer.update(cx, |multibuffer, cx| {
5535 let transaction_1 = multibuffer.start_transaction_at(now, cx).unwrap();
5536 multibuffer.edit(
5537 [
5538 (Point::new(0, 0)..Point::new(0, 0), "A"),
5539 (Point::new(1, 0)..Point::new(1, 0), "A"),
5540 ],
5541 None,
5542 cx,
5543 );
5544 multibuffer.edit(
5545 [
5546 (Point::new(0, 1)..Point::new(0, 1), "B"),
5547 (Point::new(1, 1)..Point::new(1, 1), "B"),
5548 ],
5549 None,
5550 cx,
5551 );
5552 multibuffer.end_transaction_at(now, cx);
5553 assert_eq!(multibuffer.read(cx).text(), "AB1234\nAB5678");
5554
5555 // Edit buffer 1 through the multibuffer
5556 now += 2 * group_interval;
5557 multibuffer.start_transaction_at(now, cx);
5558 multibuffer.edit([(2..2, "C")], None, cx);
5559 multibuffer.end_transaction_at(now, cx);
5560 assert_eq!(multibuffer.read(cx).text(), "ABC1234\nAB5678");
5561
5562 // Edit buffer 1 independently
5563 buffer_1.update(cx, |buffer_1, cx| {
5564 buffer_1.start_transaction_at(now);
5565 buffer_1.edit([(3..3, "D")], None, cx);
5566 buffer_1.end_transaction_at(now, cx);
5567
5568 now += 2 * group_interval;
5569 buffer_1.start_transaction_at(now);
5570 buffer_1.edit([(4..4, "E")], None, cx);
5571 buffer_1.end_transaction_at(now, cx);
5572 });
5573 assert_eq!(multibuffer.read(cx).text(), "ABCDE1234\nAB5678");
5574
5575 // An undo in the multibuffer undoes the multibuffer transaction
5576 // and also any individual buffer edits that have occurred since
5577 // that transaction.
5578 multibuffer.undo(cx);
5579 assert_eq!(multibuffer.read(cx).text(), "AB1234\nAB5678");
5580
5581 multibuffer.undo(cx);
5582 assert_eq!(multibuffer.read(cx).text(), "1234\n5678");
5583
5584 multibuffer.redo(cx);
5585 assert_eq!(multibuffer.read(cx).text(), "AB1234\nAB5678");
5586
5587 multibuffer.redo(cx);
5588 assert_eq!(multibuffer.read(cx).text(), "ABCDE1234\nAB5678");
5589
5590 // Undo buffer 2 independently.
5591 buffer_2.update(cx, |buffer_2, cx| buffer_2.undo(cx));
5592 assert_eq!(multibuffer.read(cx).text(), "ABCDE1234\n5678");
5593
5594 // An undo in the multibuffer undoes the components of the
5595 // the last multibuffer transaction that are not already undone.
5596 multibuffer.undo(cx);
5597 assert_eq!(multibuffer.read(cx).text(), "AB1234\n5678");
5598
5599 multibuffer.undo(cx);
5600 assert_eq!(multibuffer.read(cx).text(), "1234\n5678");
5601
5602 multibuffer.redo(cx);
5603 assert_eq!(multibuffer.read(cx).text(), "AB1234\nAB5678");
5604
5605 buffer_1.update(cx, |buffer_1, cx| buffer_1.redo(cx));
5606 assert_eq!(multibuffer.read(cx).text(), "ABCD1234\nAB5678");
5607
5608 // Redo stack gets cleared after an edit.
5609 now += 2 * group_interval;
5610 multibuffer.start_transaction_at(now, cx);
5611 multibuffer.edit([(0..0, "X")], None, cx);
5612 multibuffer.end_transaction_at(now, cx);
5613 assert_eq!(multibuffer.read(cx).text(), "XABCD1234\nAB5678");
5614 multibuffer.redo(cx);
5615 assert_eq!(multibuffer.read(cx).text(), "XABCD1234\nAB5678");
5616 multibuffer.undo(cx);
5617 assert_eq!(multibuffer.read(cx).text(), "ABCD1234\nAB5678");
5618 multibuffer.undo(cx);
5619 assert_eq!(multibuffer.read(cx).text(), "1234\n5678");
5620
5621 // Transactions can be grouped manually.
5622 multibuffer.redo(cx);
5623 multibuffer.redo(cx);
5624 assert_eq!(multibuffer.read(cx).text(), "XABCD1234\nAB5678");
5625 multibuffer.group_until_transaction(transaction_1, cx);
5626 multibuffer.undo(cx);
5627 assert_eq!(multibuffer.read(cx).text(), "1234\n5678");
5628 multibuffer.redo(cx);
5629 assert_eq!(multibuffer.read(cx).text(), "XABCD1234\nAB5678");
5630 });
5631 }
5632}