1mod anchor;
2
3pub use anchor::{Anchor, AnchorRangeExt};
4use anyhow::Result;
5use clock::ReplicaId;
6use collections::{HashMap, HashSet};
7use gpui::{AppContext, Entity, ModelContext, ModelHandle, Task};
8use language::{
9 Buffer, BufferChunks, BufferSnapshot, Chunk, DiagnosticEntry, Event, File, Language, Outline,
10 OutlineItem, Selection, ToOffset as _, ToPoint as _, TransactionId,
11};
12use std::{
13 cell::{Ref, RefCell},
14 cmp, fmt, io,
15 iter::{self, FromIterator},
16 ops::{Range, Sub},
17 str,
18 sync::Arc,
19 time::{Duration, Instant},
20};
21use sum_tree::{Bias, Cursor, SumTree};
22use text::{
23 locator::Locator,
24 rope::TextDimension,
25 subscription::{Subscription, Topic},
26 AnchorRangeExt as _, Edit, Point, PointUtf16, TextSummary,
27};
28use theme::SyntaxTheme;
29use util::post_inc;
30
31const NEWLINES: &'static [u8] = &[b'\n'; u8::MAX as usize];
32
33pub type ExcerptId = Locator;
34
35pub struct MultiBuffer {
36 snapshot: RefCell<MultiBufferSnapshot>,
37 buffers: RefCell<HashMap<usize, BufferState>>,
38 subscriptions: Topic,
39 singleton: bool,
40 replica_id: ReplicaId,
41 history: History,
42}
43
44struct History {
45 next_transaction_id: usize,
46 undo_stack: Vec<Transaction>,
47 redo_stack: Vec<Transaction>,
48 transaction_depth: usize,
49 group_interval: Duration,
50}
51
52struct Transaction {
53 id: usize,
54 buffer_transactions: HashSet<(usize, text::TransactionId)>,
55 first_edit_at: Instant,
56 last_edit_at: Instant,
57}
58
59pub trait ToOffset: 'static + fmt::Debug {
60 fn to_offset(&self, snapshot: &MultiBufferSnapshot) -> usize;
61}
62
63pub trait ToPoint: 'static + fmt::Debug {
64 fn to_point(&self, snapshot: &MultiBufferSnapshot) -> Point;
65}
66
67struct BufferState {
68 buffer: ModelHandle<Buffer>,
69 last_version: clock::Global,
70 last_parse_count: usize,
71 last_selections_update_count: usize,
72 last_diagnostics_update_count: usize,
73 excerpts: Vec<ExcerptId>,
74 _subscriptions: [gpui::Subscription; 2],
75}
76
77#[derive(Clone, Default)]
78pub struct MultiBufferSnapshot {
79 excerpts: SumTree<Excerpt>,
80 parse_count: usize,
81 diagnostics_update_count: usize,
82 is_dirty: bool,
83 has_conflict: bool,
84}
85
86pub struct ExcerptProperties<'a, T> {
87 pub buffer: &'a ModelHandle<Buffer>,
88 pub range: Range<T>,
89}
90
91#[derive(Clone)]
92struct Excerpt {
93 id: ExcerptId,
94 buffer_id: usize,
95 buffer: BufferSnapshot,
96 range: Range<text::Anchor>,
97 max_buffer_row: u32,
98 text_summary: TextSummary,
99 has_trailing_newline: bool,
100}
101
102#[derive(Clone, Debug, Default)]
103struct ExcerptSummary {
104 excerpt_id: ExcerptId,
105 max_buffer_row: u32,
106 text: TextSummary,
107}
108
109pub struct MultiBufferRows<'a> {
110 buffer_row_range: Range<u32>,
111 excerpts: Cursor<'a, Excerpt, Point>,
112}
113
114pub struct MultiBufferChunks<'a> {
115 range: Range<usize>,
116 excerpts: Cursor<'a, Excerpt, usize>,
117 excerpt_chunks: Option<ExcerptChunks<'a>>,
118 theme: Option<&'a SyntaxTheme>,
119}
120
121pub struct MultiBufferBytes<'a> {
122 range: Range<usize>,
123 excerpts: Cursor<'a, Excerpt, usize>,
124 excerpt_bytes: Option<ExcerptBytes<'a>>,
125 chunk: &'a [u8],
126}
127
128struct ExcerptChunks<'a> {
129 content_chunks: BufferChunks<'a>,
130 footer_height: usize,
131}
132
133struct ExcerptBytes<'a> {
134 content_bytes: language::rope::Bytes<'a>,
135 footer_height: usize,
136}
137
138impl MultiBuffer {
139 pub fn new(replica_id: ReplicaId) -> Self {
140 Self {
141 snapshot: Default::default(),
142 buffers: Default::default(),
143 subscriptions: Default::default(),
144 singleton: false,
145 replica_id,
146 history: History {
147 next_transaction_id: Default::default(),
148 undo_stack: Default::default(),
149 redo_stack: Default::default(),
150 transaction_depth: 0,
151 group_interval: Duration::from_millis(300),
152 },
153 }
154 }
155
156 pub fn singleton(buffer: ModelHandle<Buffer>, cx: &mut ModelContext<Self>) -> Self {
157 let mut this = Self::new(buffer.read(cx).replica_id());
158 this.singleton = true;
159 this.push_excerpt(
160 ExcerptProperties {
161 buffer: &buffer,
162 range: text::Anchor::min()..text::Anchor::max(),
163 },
164 cx,
165 );
166 this
167 }
168
169 #[cfg(any(test, feature = "test-support"))]
170 pub fn build_simple(text: &str, cx: &mut gpui::MutableAppContext) -> ModelHandle<Self> {
171 let buffer = cx.add_model(|cx| Buffer::new(0, text, cx));
172 cx.add_model(|cx| Self::singleton(buffer, cx))
173 }
174
175 #[cfg(any(test, feature = "test-support"))]
176 pub fn build_random(
177 mut rng: &mut impl rand::Rng,
178 cx: &mut gpui::MutableAppContext,
179 ) -> ModelHandle<Self> {
180 use rand::prelude::*;
181 use std::env;
182 use text::RandomCharIter;
183
184 let max_excerpts = env::var("MAX_EXCERPTS")
185 .map(|i| i.parse().expect("invalid `MAX_EXCERPTS` variable"))
186 .unwrap_or(5);
187 let excerpts = rng.gen_range(1..=max_excerpts);
188
189 cx.add_model(|cx| {
190 let mut multibuffer = MultiBuffer::new(0);
191 let mut buffers = Vec::new();
192 for _ in 0..excerpts {
193 let buffer_handle = if rng.gen() || buffers.is_empty() {
194 let text = RandomCharIter::new(&mut rng).take(10).collect::<String>();
195 buffers.push(cx.add_model(|cx| Buffer::new(0, text, cx)));
196 let buffer = buffers.last().unwrap();
197 log::info!(
198 "Creating new buffer {} with text: {:?}",
199 buffer.id(),
200 buffer.read(cx).text()
201 );
202 buffers.last().unwrap()
203 } else {
204 buffers.choose(rng).unwrap()
205 };
206
207 let buffer = buffer_handle.read(cx);
208 let end_ix = buffer.clip_offset(rng.gen_range(0..=buffer.len()), Bias::Right);
209 let start_ix = buffer.clip_offset(rng.gen_range(0..=end_ix), Bias::Left);
210 let header_height = rng.gen_range(0..=5);
211 log::info!(
212 "Inserting excerpt from buffer {} with header height {} and range {:?}: {:?}",
213 buffer_handle.id(),
214 header_height,
215 start_ix..end_ix,
216 &buffer.text()[start_ix..end_ix]
217 );
218
219 multibuffer.push_excerpt(
220 ExcerptProperties {
221 buffer: buffer_handle,
222 range: start_ix..end_ix,
223 },
224 cx,
225 );
226 }
227 multibuffer
228 })
229 }
230
231 pub fn replica_id(&self) -> ReplicaId {
232 self.replica_id
233 }
234
235 pub fn snapshot(&self, cx: &AppContext) -> MultiBufferSnapshot {
236 self.sync(cx);
237 self.snapshot.borrow().clone()
238 }
239
240 pub fn read(&self, cx: &AppContext) -> Ref<MultiBufferSnapshot> {
241 self.sync(cx);
242 self.snapshot.borrow()
243 }
244
245 pub fn as_singleton(&self) -> Option<ModelHandle<Buffer>> {
246 if self.singleton {
247 return Some(
248 self.buffers
249 .borrow()
250 .values()
251 .next()
252 .unwrap()
253 .buffer
254 .clone(),
255 );
256 } else {
257 None
258 }
259 }
260
261 pub fn subscribe(&mut self) -> Subscription {
262 self.subscriptions.subscribe()
263 }
264
265 pub fn edit<I, S, T>(&mut self, ranges: I, new_text: T, cx: &mut ModelContext<Self>)
266 where
267 I: IntoIterator<Item = Range<S>>,
268 S: ToOffset,
269 T: Into<String>,
270 {
271 self.edit_internal(ranges, new_text, false, cx)
272 }
273
274 pub fn edit_with_autoindent<I, S, T>(
275 &mut self,
276 ranges: I,
277 new_text: T,
278 cx: &mut ModelContext<Self>,
279 ) where
280 I: IntoIterator<Item = Range<S>>,
281 S: ToOffset,
282 T: Into<String>,
283 {
284 self.edit_internal(ranges, new_text, true, cx)
285 }
286
287 pub fn edit_internal<I, S, T>(
288 &mut self,
289 ranges_iter: I,
290 new_text: T,
291 autoindent: bool,
292 cx: &mut ModelContext<Self>,
293 ) where
294 I: IntoIterator<Item = Range<S>>,
295 S: ToOffset,
296 T: Into<String>,
297 {
298 if let Some(buffer) = self.as_singleton() {
299 let snapshot = self.read(cx);
300 let ranges = ranges_iter
301 .into_iter()
302 .map(|range| range.start.to_offset(&snapshot)..range.end.to_offset(&snapshot));
303 return buffer.update(cx, |buffer, cx| {
304 if autoindent {
305 buffer.edit_with_autoindent(ranges, new_text, cx)
306 } else {
307 buffer.edit(ranges, new_text, cx)
308 }
309 });
310 }
311
312 let snapshot = self.read(cx);
313 let mut buffer_edits: HashMap<usize, Vec<(Range<usize>, bool)>> = Default::default();
314 let mut cursor = snapshot.excerpts.cursor::<usize>();
315 for range in ranges_iter {
316 let start = range.start.to_offset(&snapshot);
317 let end = range.end.to_offset(&snapshot);
318 cursor.seek(&start, Bias::Right, &());
319 if cursor.item().is_none() && start == *cursor.start() {
320 cursor.prev(&());
321 }
322 let start_excerpt = cursor.item().expect("start offset out of bounds");
323 let start_overshoot = start - cursor.start();
324 let buffer_start =
325 start_excerpt.range.start.to_offset(&start_excerpt.buffer) + start_overshoot;
326
327 cursor.seek(&end, Bias::Right, &());
328 if cursor.item().is_none() && end == *cursor.start() {
329 cursor.prev(&());
330 }
331 let end_excerpt = cursor.item().expect("end offset out of bounds");
332 let end_overshoot = end - cursor.start();
333 let buffer_end = end_excerpt.range.start.to_offset(&end_excerpt.buffer) + end_overshoot;
334
335 if start_excerpt.id == end_excerpt.id {
336 buffer_edits
337 .entry(start_excerpt.buffer_id)
338 .or_insert(Vec::new())
339 .push((buffer_start..buffer_end, true));
340 } else {
341 let start_excerpt_range =
342 buffer_start..start_excerpt.range.end.to_offset(&start_excerpt.buffer);
343 let end_excerpt_range =
344 end_excerpt.range.start.to_offset(&end_excerpt.buffer)..buffer_end;
345 buffer_edits
346 .entry(start_excerpt.buffer_id)
347 .or_insert(Vec::new())
348 .push((start_excerpt_range, true));
349 buffer_edits
350 .entry(end_excerpt.buffer_id)
351 .or_insert(Vec::new())
352 .push((end_excerpt_range, false));
353
354 cursor.seek(&start, Bias::Right, &());
355 cursor.next(&());
356 while let Some(excerpt) = cursor.item() {
357 if excerpt.id == end_excerpt.id {
358 break;
359 }
360 buffer_edits
361 .entry(excerpt.buffer_id)
362 .or_insert(Vec::new())
363 .push((excerpt.range.to_offset(&excerpt.buffer), false));
364 cursor.next(&());
365 }
366 }
367 }
368
369 let new_text = new_text.into();
370 for (buffer_id, mut edits) in buffer_edits {
371 edits.sort_unstable_by_key(|(range, _)| range.start);
372 self.buffers.borrow()[&buffer_id]
373 .buffer
374 .update(cx, |buffer, cx| {
375 let mut edits = edits.into_iter().peekable();
376 let mut insertions = Vec::new();
377 let mut deletions = Vec::new();
378 while let Some((mut range, mut is_insertion)) = edits.next() {
379 while let Some((next_range, next_is_insertion)) = edits.peek() {
380 if range.end >= next_range.start {
381 range.end = cmp::max(next_range.end, range.end);
382 is_insertion |= *next_is_insertion;
383 edits.next();
384 } else {
385 break;
386 }
387 }
388
389 if is_insertion {
390 insertions.push(
391 buffer.anchor_before(range.start)..buffer.anchor_before(range.end),
392 );
393 } else if !range.is_empty() {
394 deletions.push(
395 buffer.anchor_before(range.start)..buffer.anchor_before(range.end),
396 );
397 }
398 }
399
400 if autoindent {
401 buffer.edit_with_autoindent(deletions, "", cx);
402 buffer.edit_with_autoindent(insertions, new_text.clone(), cx);
403 } else {
404 buffer.edit(deletions, "", cx);
405 buffer.edit(insertions, new_text.clone(), cx);
406 }
407 })
408 }
409 }
410
411 pub fn start_transaction(&mut self, cx: &mut ModelContext<Self>) -> Option<TransactionId> {
412 self.start_transaction_at(Instant::now(), cx)
413 }
414
415 pub(crate) fn start_transaction_at(
416 &mut self,
417 now: Instant,
418 cx: &mut ModelContext<Self>,
419 ) -> Option<TransactionId> {
420 if let Some(buffer) = self.as_singleton() {
421 return buffer.update(cx, |buffer, _| buffer.start_transaction_at(now));
422 }
423
424 for BufferState { buffer, .. } in self.buffers.borrow().values() {
425 buffer.update(cx, |buffer, _| buffer.start_transaction_at(now));
426 }
427 self.history.start_transaction(now)
428 }
429
430 pub fn end_transaction(&mut self, cx: &mut ModelContext<Self>) -> Option<TransactionId> {
431 self.end_transaction_at(Instant::now(), cx)
432 }
433
434 pub(crate) fn end_transaction_at(
435 &mut self,
436 now: Instant,
437 cx: &mut ModelContext<Self>,
438 ) -> Option<TransactionId> {
439 if let Some(buffer) = self.as_singleton() {
440 return buffer.update(cx, |buffer, cx| buffer.end_transaction_at(now, cx));
441 }
442
443 let mut buffer_transactions = HashSet::default();
444 for BufferState { buffer, .. } in self.buffers.borrow().values() {
445 if let Some(transaction_id) =
446 buffer.update(cx, |buffer, cx| buffer.end_transaction_at(now, cx))
447 {
448 buffer_transactions.insert((buffer.id(), transaction_id));
449 }
450 }
451
452 if self.history.end_transaction(now, buffer_transactions) {
453 let transaction_id = self.history.group().unwrap();
454 Some(transaction_id)
455 } else {
456 None
457 }
458 }
459
460 pub fn set_active_selections(
461 &mut self,
462 selections: &[Selection<Anchor>],
463 cx: &mut ModelContext<Self>,
464 ) {
465 let mut selections_by_buffer: HashMap<usize, Vec<Selection<text::Anchor>>> =
466 Default::default();
467 let snapshot = self.read(cx);
468 let mut cursor = snapshot.excerpts.cursor::<Option<&ExcerptId>>();
469 for selection in selections {
470 cursor.seek(&Some(&selection.start.excerpt_id), Bias::Left, &());
471 while let Some(excerpt) = cursor.item() {
472 if excerpt.id > selection.end.excerpt_id {
473 break;
474 }
475
476 let mut start = excerpt.range.start.clone();
477 let mut end = excerpt.range.end.clone();
478 if excerpt.id == selection.start.excerpt_id {
479 start = selection.start.text_anchor.clone();
480 }
481 if excerpt.id == selection.end.excerpt_id {
482 end = selection.end.text_anchor.clone();
483 }
484 selections_by_buffer
485 .entry(excerpt.buffer_id)
486 .or_default()
487 .push(Selection {
488 id: selection.id,
489 start,
490 end,
491 reversed: selection.reversed,
492 goal: selection.goal,
493 });
494
495 cursor.next(&());
496 }
497 }
498
499 for (buffer_id, buffer_state) in self.buffers.borrow().iter() {
500 if !selections_by_buffer.contains_key(buffer_id) {
501 buffer_state
502 .buffer
503 .update(cx, |buffer, cx| buffer.remove_active_selections(cx));
504 }
505 }
506
507 for (buffer_id, mut selections) in selections_by_buffer {
508 self.buffers.borrow()[&buffer_id]
509 .buffer
510 .update(cx, |buffer, cx| {
511 selections.sort_unstable_by(|a, b| a.start.cmp(&b.start, buffer).unwrap());
512 let mut selections = selections.into_iter().peekable();
513 let merged_selections = Arc::from_iter(iter::from_fn(|| {
514 let mut selection = selections.next()?;
515 while let Some(next_selection) = selections.peek() {
516 if selection
517 .end
518 .cmp(&next_selection.start, buffer)
519 .unwrap()
520 .is_ge()
521 {
522 let next_selection = selections.next().unwrap();
523 if next_selection
524 .end
525 .cmp(&selection.end, buffer)
526 .unwrap()
527 .is_ge()
528 {
529 selection.end = next_selection.end;
530 }
531 } else {
532 break;
533 }
534 }
535 Some(selection)
536 }));
537 buffer.set_active_selections(merged_selections, cx);
538 });
539 }
540 }
541
542 pub fn remove_active_selections(&mut self, cx: &mut ModelContext<Self>) {
543 for buffer in self.buffers.borrow().values() {
544 buffer
545 .buffer
546 .update(cx, |buffer, cx| buffer.remove_active_selections(cx));
547 }
548 }
549
550 pub fn undo(&mut self, cx: &mut ModelContext<Self>) -> Option<TransactionId> {
551 if let Some(buffer) = self.as_singleton() {
552 return buffer.update(cx, |buffer, cx| buffer.undo(cx));
553 }
554
555 while let Some(transaction) = self.history.pop_undo() {
556 let mut undone = false;
557 for (buffer_id, buffer_transaction_id) in &transaction.buffer_transactions {
558 if let Some(BufferState { buffer, .. }) = self.buffers.borrow().get(&buffer_id) {
559 undone |= buffer.update(cx, |buf, cx| {
560 buf.undo_transaction(*buffer_transaction_id, cx)
561 });
562 }
563 }
564
565 if undone {
566 return Some(transaction.id);
567 }
568 }
569
570 None
571 }
572
573 pub fn redo(&mut self, cx: &mut ModelContext<Self>) -> Option<TransactionId> {
574 if let Some(buffer) = self.as_singleton() {
575 return buffer.update(cx, |buffer, cx| buffer.redo(cx));
576 }
577
578 while let Some(transaction) = self.history.pop_redo() {
579 let mut redone = false;
580 for (buffer_id, buffer_transaction_id) in &transaction.buffer_transactions {
581 if let Some(BufferState { buffer, .. }) = self.buffers.borrow().get(&buffer_id) {
582 redone |= buffer.update(cx, |buf, cx| {
583 buf.redo_transaction(*buffer_transaction_id, cx)
584 });
585 }
586 }
587
588 if redone {
589 return Some(transaction.id);
590 }
591 }
592
593 None
594 }
595
596 pub fn push_excerpt<O>(
597 &mut self,
598 props: ExcerptProperties<O>,
599 cx: &mut ModelContext<Self>,
600 ) -> ExcerptId
601 where
602 O: text::ToOffset,
603 {
604 self.insert_excerpt_after(&ExcerptId::max(), props, cx)
605 }
606
607 pub fn insert_excerpt_after<O>(
608 &mut self,
609 prev_excerpt_id: &ExcerptId,
610 props: ExcerptProperties<O>,
611 cx: &mut ModelContext<Self>,
612 ) -> ExcerptId
613 where
614 O: text::ToOffset,
615 {
616 assert_eq!(self.history.transaction_depth, 0);
617 self.sync(cx);
618
619 let buffer_snapshot = props.buffer.read(cx).snapshot();
620 let range = buffer_snapshot.anchor_before(&props.range.start)
621 ..buffer_snapshot.anchor_after(&props.range.end);
622 let mut snapshot = self.snapshot.borrow_mut();
623 let mut cursor = snapshot.excerpts.cursor::<Option<&ExcerptId>>();
624 let mut new_excerpts = cursor.slice(&Some(prev_excerpt_id), Bias::Right, &());
625
626 let mut prev_id = ExcerptId::min();
627 let edit_start = new_excerpts.summary().text.bytes;
628 new_excerpts.update_last(
629 |excerpt| {
630 excerpt.has_trailing_newline = true;
631 prev_id = excerpt.id.clone();
632 },
633 &(),
634 );
635
636 let mut next_id = ExcerptId::max();
637 if let Some(next_excerpt) = cursor.item() {
638 next_id = next_excerpt.id.clone();
639 }
640
641 let id = ExcerptId::between(&prev_id, &next_id);
642
643 let mut buffers = self.buffers.borrow_mut();
644 let buffer_state = buffers
645 .entry(props.buffer.id())
646 .or_insert_with(|| BufferState {
647 last_version: buffer_snapshot.version().clone(),
648 last_parse_count: buffer_snapshot.parse_count(),
649 last_selections_update_count: buffer_snapshot.selections_update_count(),
650 last_diagnostics_update_count: buffer_snapshot.diagnostics_update_count(),
651 excerpts: Default::default(),
652 _subscriptions: [
653 cx.observe(&props.buffer, |_, _, cx| cx.notify()),
654 cx.subscribe(&props.buffer, Self::on_buffer_event),
655 ],
656 buffer: props.buffer.clone(),
657 });
658 if let Err(ix) = buffer_state.excerpts.binary_search(&id) {
659 buffer_state.excerpts.insert(ix, id.clone());
660 }
661
662 let excerpt = Excerpt::new(
663 id.clone(),
664 props.buffer.id(),
665 buffer_snapshot,
666 range,
667 cursor.item().is_some(),
668 );
669 new_excerpts.push(excerpt, &());
670 let edit_end = new_excerpts.summary().text.bytes;
671
672 new_excerpts.push_tree(cursor.suffix(&()), &());
673 drop(cursor);
674 snapshot.excerpts = new_excerpts;
675
676 self.subscriptions.publish_mut([Edit {
677 old: edit_start..edit_start,
678 new: edit_start..edit_end,
679 }]);
680
681 cx.notify();
682 id
683 }
684
685 pub fn excerpt_ids_for_buffer(&self, buffer: &ModelHandle<Buffer>) -> Vec<ExcerptId> {
686 self.buffers
687 .borrow()
688 .get(&buffer.id())
689 .map_or(Vec::new(), |state| state.excerpts.clone())
690 }
691
692 pub fn excerpted_buffers<'a, T: ToOffset>(
693 &'a self,
694 range: Range<T>,
695 cx: &AppContext,
696 ) -> Vec<(ModelHandle<Buffer>, Range<usize>)> {
697 let snapshot = self.snapshot(cx);
698 let start = range.start.to_offset(&snapshot);
699 let end = range.end.to_offset(&snapshot);
700
701 let mut result = Vec::new();
702 let mut cursor = snapshot.excerpts.cursor::<usize>();
703 cursor.seek(&start, Bias::Right, &());
704 while let Some(excerpt) = cursor.item() {
705 if *cursor.start() > end {
706 break;
707 }
708
709 let mut end_before_newline = cursor.end(&());
710 if excerpt.has_trailing_newline {
711 end_before_newline -= 1;
712 }
713 let excerpt_start = excerpt.range.start.to_offset(&excerpt.buffer);
714 let start = excerpt_start + (cmp::max(start, *cursor.start()) - *cursor.start());
715 let end = excerpt_start + (cmp::min(end, end_before_newline) - *cursor.start());
716 let buffer = self.buffers.borrow()[&excerpt.buffer_id].buffer.clone();
717 result.push((buffer, start..end));
718 cursor.next(&());
719 }
720
721 result
722 }
723
724 pub fn remove_excerpts<'a>(
725 &mut self,
726 excerpt_ids: impl IntoIterator<Item = &'a ExcerptId>,
727 cx: &mut ModelContext<Self>,
728 ) {
729 let mut buffers = self.buffers.borrow_mut();
730 let mut snapshot = self.snapshot.borrow_mut();
731 let mut new_excerpts = SumTree::new();
732 let mut cursor = snapshot.excerpts.cursor::<(Option<&ExcerptId>, usize)>();
733 let mut edits = Vec::new();
734 let mut excerpt_ids = excerpt_ids.into_iter().peekable();
735
736 while let Some(mut excerpt_id) = excerpt_ids.next() {
737 // Seek to the next excerpt to remove, preserving any preceding excerpts.
738 new_excerpts.push_tree(cursor.slice(&Some(excerpt_id), Bias::Left, &()), &());
739 if let Some(mut excerpt) = cursor.item() {
740 if excerpt.id != *excerpt_id {
741 continue;
742 }
743 let mut old_start = cursor.start().1;
744
745 // Skip over the removed excerpt.
746 loop {
747 if let Some(buffer_state) = buffers.get_mut(&excerpt.buffer_id) {
748 buffer_state.excerpts.retain(|id| id != excerpt_id);
749 if buffer_state.excerpts.is_empty() {
750 buffers.remove(&excerpt.buffer_id);
751 }
752 }
753 cursor.next(&());
754
755 // Skip over any subsequent excerpts that are also removed.
756 if let Some(&next_excerpt_id) = excerpt_ids.peek() {
757 if let Some(next_excerpt) = cursor.item() {
758 if next_excerpt.id == *next_excerpt_id {
759 excerpt = next_excerpt;
760 excerpt_id = excerpt_ids.next().unwrap();
761 continue;
762 }
763 }
764 }
765
766 break;
767 }
768
769 // When removing the last excerpt, remove the trailing newline from
770 // the previous excerpt.
771 if cursor.item().is_none() && old_start > 0 {
772 old_start -= 1;
773 new_excerpts.update_last(|e| e.has_trailing_newline = false, &());
774 }
775
776 // Push an edit for the removal of this run of excerpts.
777 let old_end = cursor.start().1;
778 let new_start = new_excerpts.summary().text.bytes;
779 edits.push(Edit {
780 old: old_start..old_end,
781 new: new_start..new_start,
782 });
783 }
784 }
785 new_excerpts.push_tree(cursor.suffix(&()), &());
786 drop(cursor);
787 snapshot.excerpts = new_excerpts;
788 self.subscriptions.publish_mut(edits);
789 cx.notify();
790 }
791
792 pub fn text_anchor_for_position<'a, T: ToOffset>(
793 &'a self,
794 position: T,
795 cx: &AppContext,
796 ) -> (ModelHandle<Buffer>, language::Anchor) {
797 let snapshot = self.read(cx);
798 let anchor = snapshot.anchor_before(position);
799 (
800 self.buffers.borrow()[&anchor.buffer_id].buffer.clone(),
801 anchor.text_anchor,
802 )
803 }
804
805 fn on_buffer_event(
806 &mut self,
807 _: ModelHandle<Buffer>,
808 event: &Event,
809 cx: &mut ModelContext<Self>,
810 ) {
811 cx.emit(event.clone());
812 }
813
814 pub fn format(&mut self, cx: &mut ModelContext<Self>) -> Task<Result<()>> {
815 let mut format_tasks = Vec::new();
816 for BufferState { buffer, .. } in self.buffers.borrow().values() {
817 format_tasks.push(buffer.update(cx, |buffer, cx| buffer.format(cx)));
818 }
819
820 cx.spawn(|_, _| async move {
821 for format in format_tasks {
822 format.await?;
823 }
824 Ok(())
825 })
826 }
827
828 pub fn save(&mut self, cx: &mut ModelContext<Self>) -> Task<Result<()>> {
829 let mut save_tasks = Vec::new();
830 for BufferState { buffer, .. } in self.buffers.borrow().values() {
831 save_tasks.push(buffer.update(cx, |buffer, cx| buffer.save(cx)));
832 }
833
834 cx.spawn(|_, _| async move {
835 for save in save_tasks {
836 save.await?;
837 }
838 Ok(())
839 })
840 }
841
842 pub fn language<'a>(&self, cx: &'a AppContext) -> Option<&'a Arc<Language>> {
843 self.buffers
844 .borrow()
845 .values()
846 .next()
847 .and_then(|state| state.buffer.read(cx).language())
848 }
849
850 pub fn file<'a>(&self, cx: &'a AppContext) -> Option<&'a dyn File> {
851 self.as_singleton()?.read(cx).file()
852 }
853
854 #[cfg(test)]
855 pub fn is_parsing(&self, cx: &AppContext) -> bool {
856 self.as_singleton().unwrap().read(cx).is_parsing()
857 }
858
859 fn sync(&self, cx: &AppContext) {
860 let mut snapshot = self.snapshot.borrow_mut();
861 let mut excerpts_to_edit = Vec::new();
862 let mut reparsed = false;
863 let mut diagnostics_updated = false;
864 let mut is_dirty = false;
865 let mut has_conflict = false;
866 let mut buffers = self.buffers.borrow_mut();
867 for buffer_state in buffers.values_mut() {
868 let buffer = buffer_state.buffer.read(cx);
869 let version = buffer.version();
870 let parse_count = buffer.parse_count();
871 let selections_update_count = buffer.selections_update_count();
872 let diagnostics_update_count = buffer.diagnostics_update_count();
873
874 let buffer_edited = version.changed_since(&buffer_state.last_version);
875 let buffer_reparsed = parse_count > buffer_state.last_parse_count;
876 let buffer_selections_updated =
877 selections_update_count > buffer_state.last_selections_update_count;
878 let buffer_diagnostics_updated =
879 diagnostics_update_count > buffer_state.last_diagnostics_update_count;
880 if buffer_edited
881 || buffer_reparsed
882 || buffer_selections_updated
883 || buffer_diagnostics_updated
884 {
885 buffer_state.last_version = version;
886 buffer_state.last_parse_count = parse_count;
887 buffer_state.last_selections_update_count = selections_update_count;
888 buffer_state.last_diagnostics_update_count = diagnostics_update_count;
889 excerpts_to_edit.extend(
890 buffer_state
891 .excerpts
892 .iter()
893 .map(|excerpt_id| (excerpt_id, buffer_state.buffer.clone(), buffer_edited)),
894 );
895 }
896
897 reparsed |= buffer_reparsed;
898 diagnostics_updated |= buffer_diagnostics_updated;
899 is_dirty |= buffer.is_dirty();
900 has_conflict |= buffer.has_conflict();
901 }
902 if reparsed {
903 snapshot.parse_count += 1;
904 }
905 if diagnostics_updated {
906 snapshot.diagnostics_update_count += 1;
907 }
908 snapshot.is_dirty = is_dirty;
909 snapshot.has_conflict = has_conflict;
910
911 excerpts_to_edit.sort_unstable_by_key(|(excerpt_id, _, _)| *excerpt_id);
912
913 let mut edits = Vec::new();
914 let mut new_excerpts = SumTree::new();
915 let mut cursor = snapshot.excerpts.cursor::<(Option<&ExcerptId>, usize)>();
916
917 for (id, buffer, buffer_edited) in excerpts_to_edit {
918 new_excerpts.push_tree(cursor.slice(&Some(id), Bias::Left, &()), &());
919 let old_excerpt = cursor.item().unwrap();
920 let buffer_id = buffer.id();
921 let buffer = buffer.read(cx);
922
923 let mut new_excerpt;
924 if buffer_edited {
925 edits.extend(
926 buffer
927 .edits_since_in_range::<usize>(
928 old_excerpt.buffer.version(),
929 old_excerpt.range.clone(),
930 )
931 .map(|mut edit| {
932 let excerpt_old_start = cursor.start().1;
933 let excerpt_new_start = new_excerpts.summary().text.bytes;
934 edit.old.start += excerpt_old_start;
935 edit.old.end += excerpt_old_start;
936 edit.new.start += excerpt_new_start;
937 edit.new.end += excerpt_new_start;
938 edit
939 }),
940 );
941
942 new_excerpt = Excerpt::new(
943 id.clone(),
944 buffer_id,
945 buffer.snapshot(),
946 old_excerpt.range.clone(),
947 old_excerpt.has_trailing_newline,
948 );
949 } else {
950 new_excerpt = old_excerpt.clone();
951 new_excerpt.buffer = buffer.snapshot();
952 }
953
954 new_excerpts.push(new_excerpt, &());
955 cursor.next(&());
956 }
957 new_excerpts.push_tree(cursor.suffix(&()), &());
958
959 drop(cursor);
960 snapshot.excerpts = new_excerpts;
961
962 self.subscriptions.publish(edits);
963 }
964}
965
966#[cfg(any(test, feature = "test-support"))]
967impl MultiBuffer {
968 pub fn randomly_edit(
969 &mut self,
970 rng: &mut impl rand::Rng,
971 count: usize,
972 cx: &mut ModelContext<Self>,
973 ) {
974 use text::RandomCharIter;
975
976 let snapshot = self.read(cx);
977 let mut old_ranges: Vec<Range<usize>> = Vec::new();
978 for _ in 0..count {
979 let last_end = old_ranges.last().map_or(0, |last_range| last_range.end + 1);
980 if last_end > snapshot.len() {
981 break;
982 }
983 let end_ix = snapshot.clip_offset(rng.gen_range(0..=last_end), Bias::Right);
984 let start_ix = snapshot.clip_offset(rng.gen_range(0..=end_ix), Bias::Left);
985 old_ranges.push(start_ix..end_ix);
986 }
987 let new_text_len = rng.gen_range(0..10);
988 let new_text: String = RandomCharIter::new(&mut *rng).take(new_text_len).collect();
989 log::info!("mutating multi-buffer at {:?}: {:?}", old_ranges, new_text);
990 drop(snapshot);
991
992 self.edit(old_ranges.iter().cloned(), new_text.as_str(), cx);
993 }
994}
995
996impl Entity for MultiBuffer {
997 type Event = language::Event;
998}
999
1000impl MultiBufferSnapshot {
1001 pub fn text(&self) -> String {
1002 self.chunks(0..self.len(), None)
1003 .map(|chunk| chunk.text)
1004 .collect()
1005 }
1006
1007 pub fn reversed_chars_at<'a, T: ToOffset>(
1008 &'a self,
1009 position: T,
1010 ) -> impl Iterator<Item = char> + 'a {
1011 let mut offset = position.to_offset(self);
1012 let mut cursor = self.excerpts.cursor::<usize>();
1013 cursor.seek(&offset, Bias::Left, &());
1014 let mut excerpt_chunks = cursor.item().map(|excerpt| {
1015 let end_before_footer = cursor.start() + excerpt.text_summary.bytes;
1016 let start = excerpt.range.start.to_offset(&excerpt.buffer);
1017 let end = start + (cmp::min(offset, end_before_footer) - cursor.start());
1018 excerpt.buffer.reversed_chunks_in_range(start..end)
1019 });
1020 iter::from_fn(move || {
1021 if offset == *cursor.start() {
1022 cursor.prev(&());
1023 let excerpt = cursor.item()?;
1024 excerpt_chunks = Some(
1025 excerpt
1026 .buffer
1027 .reversed_chunks_in_range(excerpt.range.clone()),
1028 );
1029 }
1030
1031 let excerpt = cursor.item().unwrap();
1032 if offset == cursor.end(&()) && excerpt.has_trailing_newline {
1033 offset -= 1;
1034 Some("\n")
1035 } else {
1036 let chunk = excerpt_chunks.as_mut().unwrap().next().unwrap();
1037 offset -= chunk.len();
1038 Some(chunk)
1039 }
1040 })
1041 .flat_map(|c| c.chars().rev())
1042 }
1043
1044 pub fn chars_at<'a, T: ToOffset>(&'a self, position: T) -> impl Iterator<Item = char> + 'a {
1045 let offset = position.to_offset(self);
1046 self.text_for_range(offset..self.len())
1047 .flat_map(|chunk| chunk.chars())
1048 }
1049
1050 pub fn text_for_range<'a, T: ToOffset>(
1051 &'a self,
1052 range: Range<T>,
1053 ) -> impl Iterator<Item = &'a str> {
1054 self.chunks(range, None).map(|chunk| chunk.text)
1055 }
1056
1057 pub fn is_line_blank(&self, row: u32) -> bool {
1058 self.text_for_range(Point::new(row, 0)..Point::new(row, self.line_len(row)))
1059 .all(|chunk| chunk.matches(|c: char| !c.is_whitespace()).next().is_none())
1060 }
1061
1062 pub fn contains_str_at<T>(&self, position: T, needle: &str) -> bool
1063 where
1064 T: ToOffset,
1065 {
1066 let position = position.to_offset(self);
1067 position == self.clip_offset(position, Bias::Left)
1068 && self
1069 .bytes_in_range(position..self.len())
1070 .flatten()
1071 .copied()
1072 .take(needle.len())
1073 .eq(needle.bytes())
1074 }
1075
1076 fn as_singleton(&self) -> Option<&BufferSnapshot> {
1077 let mut excerpts = self.excerpts.iter();
1078 let buffer = excerpts.next().map(|excerpt| &excerpt.buffer);
1079 if excerpts.next().is_none() {
1080 buffer
1081 } else {
1082 None
1083 }
1084 }
1085
1086 pub fn len(&self) -> usize {
1087 self.excerpts.summary().text.bytes
1088 }
1089
1090 pub fn max_buffer_row(&self) -> u32 {
1091 self.excerpts.summary().max_buffer_row
1092 }
1093
1094 pub fn clip_offset(&self, offset: usize, bias: Bias) -> usize {
1095 let mut cursor = self.excerpts.cursor::<usize>();
1096 cursor.seek(&offset, Bias::Right, &());
1097 let overshoot = if let Some(excerpt) = cursor.item() {
1098 let excerpt_start = excerpt.range.start.to_offset(&excerpt.buffer);
1099 let buffer_offset = excerpt
1100 .buffer
1101 .clip_offset(excerpt_start + (offset - cursor.start()), bias);
1102 buffer_offset.saturating_sub(excerpt_start)
1103 } else {
1104 0
1105 };
1106 cursor.start() + overshoot
1107 }
1108
1109 pub fn clip_point(&self, point: Point, bias: Bias) -> Point {
1110 let mut cursor = self.excerpts.cursor::<Point>();
1111 cursor.seek(&point, Bias::Right, &());
1112 let overshoot = if let Some(excerpt) = cursor.item() {
1113 let excerpt_start = excerpt.range.start.to_point(&excerpt.buffer);
1114 let buffer_point = excerpt
1115 .buffer
1116 .clip_point(excerpt_start + (point - cursor.start()), bias);
1117 buffer_point.saturating_sub(excerpt_start)
1118 } else {
1119 Point::zero()
1120 };
1121 *cursor.start() + overshoot
1122 }
1123
1124 pub fn clip_point_utf16(&self, point: PointUtf16, bias: Bias) -> PointUtf16 {
1125 let mut cursor = self.excerpts.cursor::<PointUtf16>();
1126 cursor.seek(&point, Bias::Right, &());
1127 let overshoot = if let Some(excerpt) = cursor.item() {
1128 let excerpt_start = excerpt
1129 .buffer
1130 .offset_to_point_utf16(excerpt.range.start.to_offset(&excerpt.buffer));
1131 let buffer_point = excerpt
1132 .buffer
1133 .clip_point_utf16(excerpt_start + (point - cursor.start()), bias);
1134 buffer_point.saturating_sub(excerpt_start)
1135 } else {
1136 PointUtf16::zero()
1137 };
1138 *cursor.start() + overshoot
1139 }
1140
1141 pub fn bytes_in_range<'a, T: ToOffset>(&'a self, range: Range<T>) -> MultiBufferBytes<'a> {
1142 let range = range.start.to_offset(self)..range.end.to_offset(self);
1143 let mut excerpts = self.excerpts.cursor::<usize>();
1144 excerpts.seek(&range.start, Bias::Right, &());
1145
1146 let mut chunk = &[][..];
1147 let excerpt_bytes = if let Some(excerpt) = excerpts.item() {
1148 let mut excerpt_bytes = excerpt
1149 .bytes_in_range(range.start - excerpts.start()..range.end - excerpts.start());
1150 chunk = excerpt_bytes.next().unwrap_or(&[][..]);
1151 Some(excerpt_bytes)
1152 } else {
1153 None
1154 };
1155
1156 MultiBufferBytes {
1157 range,
1158 excerpts,
1159 excerpt_bytes,
1160 chunk,
1161 }
1162 }
1163
1164 pub fn buffer_rows<'a>(&'a self, start_row: u32) -> MultiBufferRows<'a> {
1165 let mut result = MultiBufferRows {
1166 buffer_row_range: 0..0,
1167 excerpts: self.excerpts.cursor(),
1168 };
1169 result.seek(start_row);
1170 result
1171 }
1172
1173 pub fn chunks<'a, T: ToOffset>(
1174 &'a self,
1175 range: Range<T>,
1176 theme: Option<&'a SyntaxTheme>,
1177 ) -> MultiBufferChunks<'a> {
1178 let range = range.start.to_offset(self)..range.end.to_offset(self);
1179 let mut chunks = MultiBufferChunks {
1180 range: range.clone(),
1181 excerpts: self.excerpts.cursor(),
1182 excerpt_chunks: None,
1183 theme,
1184 };
1185 chunks.seek(range.start);
1186 chunks
1187 }
1188
1189 pub fn offset_to_point(&self, offset: usize) -> Point {
1190 let mut cursor = self.excerpts.cursor::<(usize, Point)>();
1191 cursor.seek(&offset, Bias::Right, &());
1192 if let Some(excerpt) = cursor.item() {
1193 let (start_offset, start_point) = cursor.start();
1194 let overshoot = offset - start_offset;
1195 let excerpt_start_offset = excerpt.range.start.to_offset(&excerpt.buffer);
1196 let excerpt_start_point = excerpt.range.start.to_point(&excerpt.buffer);
1197 let buffer_point = excerpt
1198 .buffer
1199 .offset_to_point(excerpt_start_offset + overshoot);
1200 *start_point + (buffer_point - excerpt_start_point)
1201 } else {
1202 self.excerpts.summary().text.lines
1203 }
1204 }
1205
1206 pub fn point_to_offset(&self, point: Point) -> usize {
1207 let mut cursor = self.excerpts.cursor::<(Point, usize)>();
1208 cursor.seek(&point, Bias::Right, &());
1209 if let Some(excerpt) = cursor.item() {
1210 let (start_point, start_offset) = cursor.start();
1211 let overshoot = point - start_point;
1212 let excerpt_start_offset = excerpt.range.start.to_offset(&excerpt.buffer);
1213 let excerpt_start_point = excerpt.range.start.to_point(&excerpt.buffer);
1214 let buffer_offset = excerpt
1215 .buffer
1216 .point_to_offset(excerpt_start_point + overshoot);
1217 *start_offset + buffer_offset - excerpt_start_offset
1218 } else {
1219 self.excerpts.summary().text.bytes
1220 }
1221 }
1222
1223 pub fn point_utf16_to_offset(&self, point: PointUtf16) -> usize {
1224 let mut cursor = self.excerpts.cursor::<(PointUtf16, usize)>();
1225 cursor.seek(&point, Bias::Right, &());
1226 if let Some(excerpt) = cursor.item() {
1227 let (start_point, start_offset) = cursor.start();
1228 let overshoot = point - start_point;
1229 let excerpt_start_offset = excerpt.range.start.to_offset(&excerpt.buffer);
1230 let excerpt_start_point = excerpt
1231 .buffer
1232 .offset_to_point_utf16(excerpt.range.start.to_offset(&excerpt.buffer));
1233 let buffer_offset = excerpt
1234 .buffer
1235 .point_utf16_to_offset(excerpt_start_point + overshoot);
1236 *start_offset + (buffer_offset - excerpt_start_offset)
1237 } else {
1238 self.excerpts.summary().text.bytes
1239 }
1240 }
1241
1242 pub fn indent_column_for_line(&self, row: u32) -> u32 {
1243 if let Some((buffer, range)) = self.buffer_line_for_row(row) {
1244 buffer
1245 .indent_column_for_line(range.start.row)
1246 .min(range.end.column)
1247 .saturating_sub(range.start.column)
1248 } else {
1249 0
1250 }
1251 }
1252
1253 pub fn line_len(&self, row: u32) -> u32 {
1254 if let Some((_, range)) = self.buffer_line_for_row(row) {
1255 range.end.column - range.start.column
1256 } else {
1257 0
1258 }
1259 }
1260
1261 fn buffer_line_for_row(&self, row: u32) -> Option<(&BufferSnapshot, Range<Point>)> {
1262 let mut cursor = self.excerpts.cursor::<Point>();
1263 cursor.seek(&Point::new(row, 0), Bias::Right, &());
1264 if let Some(excerpt) = cursor.item() {
1265 let overshoot = row - cursor.start().row;
1266 let excerpt_start = excerpt.range.start.to_point(&excerpt.buffer);
1267 let excerpt_end = excerpt.range.end.to_point(&excerpt.buffer);
1268 let buffer_row = excerpt_start.row + overshoot;
1269 let line_start = Point::new(buffer_row, 0);
1270 let line_end = Point::new(buffer_row, excerpt.buffer.line_len(buffer_row));
1271 return Some((
1272 &excerpt.buffer,
1273 line_start.max(excerpt_start)..line_end.min(excerpt_end),
1274 ));
1275 }
1276 None
1277 }
1278
1279 pub fn max_point(&self) -> Point {
1280 self.text_summary().lines
1281 }
1282
1283 pub fn text_summary(&self) -> TextSummary {
1284 self.excerpts.summary().text
1285 }
1286
1287 pub fn text_summary_for_range<'a, D, O>(&'a self, range: Range<O>) -> D
1288 where
1289 D: TextDimension,
1290 O: ToOffset,
1291 {
1292 let mut summary = D::default();
1293 let mut range = range.start.to_offset(self)..range.end.to_offset(self);
1294 let mut cursor = self.excerpts.cursor::<usize>();
1295 cursor.seek(&range.start, Bias::Right, &());
1296 if let Some(excerpt) = cursor.item() {
1297 let mut end_before_newline = cursor.end(&());
1298 if excerpt.has_trailing_newline {
1299 end_before_newline -= 1;
1300 }
1301
1302 let excerpt_start = excerpt.range.start.to_offset(&excerpt.buffer);
1303 let start_in_excerpt = excerpt_start + (range.start - cursor.start());
1304 let end_in_excerpt =
1305 excerpt_start + (cmp::min(end_before_newline, range.end) - cursor.start());
1306 summary.add_assign(
1307 &excerpt
1308 .buffer
1309 .text_summary_for_range(start_in_excerpt..end_in_excerpt),
1310 );
1311
1312 if range.end > end_before_newline {
1313 summary.add_assign(&D::from_text_summary(&TextSummary {
1314 bytes: 1,
1315 lines: Point::new(1 as u32, 0),
1316 lines_utf16: PointUtf16::new(1 as u32, 0),
1317 first_line_chars: 0,
1318 last_line_chars: 0,
1319 longest_row: 0,
1320 longest_row_chars: 0,
1321 }));
1322 }
1323
1324 cursor.next(&());
1325 }
1326
1327 if range.end > *cursor.start() {
1328 summary.add_assign(&D::from_text_summary(&cursor.summary::<_, TextSummary>(
1329 &range.end,
1330 Bias::Right,
1331 &(),
1332 )));
1333 if let Some(excerpt) = cursor.item() {
1334 range.end = cmp::max(*cursor.start(), range.end);
1335
1336 let excerpt_start = excerpt.range.start.to_offset(&excerpt.buffer);
1337 let end_in_excerpt = excerpt_start + (range.end - cursor.start());
1338 summary.add_assign(
1339 &excerpt
1340 .buffer
1341 .text_summary_for_range(excerpt_start..end_in_excerpt),
1342 );
1343 }
1344 }
1345
1346 summary
1347 }
1348
1349 pub fn summary_for_anchor<D>(&self, anchor: &Anchor) -> D
1350 where
1351 D: TextDimension + Ord + Sub<D, Output = D>,
1352 {
1353 let mut cursor = self.excerpts.cursor::<ExcerptSummary>();
1354 cursor.seek(&Some(&anchor.excerpt_id), Bias::Left, &());
1355 if cursor.item().is_none() {
1356 cursor.next(&());
1357 }
1358
1359 let mut position = D::from_text_summary(&cursor.start().text);
1360 if let Some(excerpt) = cursor.item() {
1361 if excerpt.id == anchor.excerpt_id && excerpt.buffer_id == anchor.buffer_id {
1362 let excerpt_buffer_start = excerpt.range.start.summary::<D>(&excerpt.buffer);
1363 let buffer_position = anchor.text_anchor.summary::<D>(&excerpt.buffer);
1364 if buffer_position > excerpt_buffer_start {
1365 position.add_assign(&(buffer_position - excerpt_buffer_start));
1366 }
1367 }
1368 }
1369 position
1370 }
1371
1372 pub fn summaries_for_anchors<'a, D, I>(&'a self, anchors: I) -> Vec<D>
1373 where
1374 D: TextDimension + Ord + Sub<D, Output = D>,
1375 I: 'a + IntoIterator<Item = &'a Anchor>,
1376 {
1377 let mut anchors = anchors.into_iter().peekable();
1378 let mut cursor = self.excerpts.cursor::<ExcerptSummary>();
1379 let mut summaries = Vec::new();
1380 while let Some(anchor) = anchors.peek() {
1381 let excerpt_id = &anchor.excerpt_id;
1382 let buffer_id = anchor.buffer_id;
1383 let excerpt_anchors = iter::from_fn(|| {
1384 let anchor = anchors.peek()?;
1385 if anchor.excerpt_id == *excerpt_id && anchor.buffer_id == buffer_id {
1386 Some(&anchors.next().unwrap().text_anchor)
1387 } else {
1388 None
1389 }
1390 });
1391
1392 cursor.seek_forward(&Some(excerpt_id), Bias::Left, &());
1393 if cursor.item().is_none() {
1394 cursor.next(&());
1395 }
1396
1397 let position = D::from_text_summary(&cursor.start().text);
1398 if let Some(excerpt) = cursor.item() {
1399 if excerpt.id == *excerpt_id && excerpt.buffer_id == buffer_id {
1400 let excerpt_buffer_start = excerpt.range.start.summary::<D>(&excerpt.buffer);
1401 summaries.extend(
1402 excerpt
1403 .buffer
1404 .summaries_for_anchors::<D, _>(excerpt_anchors)
1405 .map(move |summary| {
1406 let mut position = position.clone();
1407 let excerpt_buffer_start = excerpt_buffer_start.clone();
1408 if summary > excerpt_buffer_start {
1409 position.add_assign(&(summary - excerpt_buffer_start));
1410 }
1411 position
1412 }),
1413 );
1414 continue;
1415 }
1416 }
1417
1418 summaries.extend(excerpt_anchors.map(|_| position.clone()));
1419 }
1420
1421 summaries
1422 }
1423
1424 pub fn refresh_anchors<'a, I>(&'a self, anchors: I) -> Vec<(usize, Anchor, bool)>
1425 where
1426 I: 'a + IntoIterator<Item = &'a Anchor>,
1427 {
1428 let mut anchors = anchors.into_iter().enumerate().peekable();
1429 let mut cursor = self.excerpts.cursor::<Option<&ExcerptId>>();
1430 let mut result = Vec::new();
1431 while let Some((_, anchor)) = anchors.peek() {
1432 let old_excerpt_id = &anchor.excerpt_id;
1433
1434 // Find the location where this anchor's excerpt should be.
1435 cursor.seek_forward(&Some(old_excerpt_id), Bias::Left, &());
1436 if cursor.item().is_none() {
1437 cursor.next(&());
1438 }
1439
1440 let next_excerpt = cursor.item();
1441 let prev_excerpt = cursor.prev_item();
1442
1443 // Process all of the anchors for this excerpt.
1444 while let Some((_, anchor)) = anchors.peek() {
1445 if anchor.excerpt_id != *old_excerpt_id {
1446 break;
1447 }
1448 let mut kept_position = false;
1449 let (anchor_ix, anchor) = anchors.next().unwrap();
1450 let mut anchor = anchor.clone();
1451
1452 // Leave min and max anchors unchanged.
1453 if *old_excerpt_id == ExcerptId::max() || *old_excerpt_id == ExcerptId::min() {
1454 kept_position = true;
1455 }
1456 // If the old excerpt still exists at this location, then leave
1457 // the anchor unchanged.
1458 else if next_excerpt.map_or(false, |excerpt| {
1459 excerpt.id == *old_excerpt_id && excerpt.buffer_id == anchor.buffer_id
1460 }) {
1461 kept_position = true;
1462 }
1463 // If the old excerpt no longer exists at this location, then attempt to
1464 // find an equivalent position for this anchor in an adjacent excerpt.
1465 else {
1466 for excerpt in [next_excerpt, prev_excerpt].iter().filter_map(|e| *e) {
1467 if excerpt.contains(&anchor) {
1468 anchor.excerpt_id = excerpt.id.clone();
1469 kept_position = true;
1470 break;
1471 }
1472 }
1473 }
1474 // If there's no adjacent excerpt that contains the anchor's position,
1475 // then report that the anchor has lost its position.
1476 if !kept_position {
1477 anchor = if let Some(excerpt) = next_excerpt {
1478 Anchor {
1479 buffer_id: excerpt.buffer_id,
1480 excerpt_id: excerpt.id.clone(),
1481 text_anchor: excerpt
1482 .buffer
1483 .anchor_at(&excerpt.range.start, anchor.text_anchor.bias),
1484 }
1485 } else if let Some(excerpt) = prev_excerpt {
1486 Anchor {
1487 buffer_id: excerpt.buffer_id,
1488 excerpt_id: excerpt.id.clone(),
1489 text_anchor: excerpt
1490 .buffer
1491 .anchor_at(&excerpt.range.end, anchor.text_anchor.bias),
1492 }
1493 } else if anchor.text_anchor.bias == Bias::Left {
1494 Anchor::min()
1495 } else {
1496 Anchor::max()
1497 };
1498 }
1499
1500 result.push((anchor_ix, anchor, kept_position));
1501 }
1502 }
1503 result.sort_unstable_by(|a, b| a.1.cmp(&b.1, self).unwrap());
1504 result
1505 }
1506
1507 pub fn anchor_before<T: ToOffset>(&self, position: T) -> Anchor {
1508 self.anchor_at(position, Bias::Left)
1509 }
1510
1511 pub fn anchor_after<T: ToOffset>(&self, position: T) -> Anchor {
1512 self.anchor_at(position, Bias::Right)
1513 }
1514
1515 pub fn anchor_at<T: ToOffset>(&self, position: T, mut bias: Bias) -> Anchor {
1516 let offset = position.to_offset(self);
1517 let mut cursor = self.excerpts.cursor::<(usize, Option<&ExcerptId>)>();
1518 cursor.seek(&offset, Bias::Right, &());
1519 if cursor.item().is_none() && offset == cursor.start().0 && bias == Bias::Left {
1520 cursor.prev(&());
1521 }
1522 if let Some(excerpt) = cursor.item() {
1523 let mut overshoot = offset.saturating_sub(cursor.start().0);
1524 if excerpt.has_trailing_newline && offset == cursor.end(&()).0 {
1525 overshoot -= 1;
1526 bias = Bias::Right;
1527 }
1528
1529 let buffer_start = excerpt.range.start.to_offset(&excerpt.buffer);
1530 let text_anchor =
1531 excerpt.clip_anchor(excerpt.buffer.anchor_at(buffer_start + overshoot, bias));
1532 Anchor {
1533 buffer_id: excerpt.buffer_id,
1534 excerpt_id: excerpt.id.clone(),
1535 text_anchor,
1536 }
1537 } else if offset == 0 && bias == Bias::Left {
1538 Anchor::min()
1539 } else {
1540 Anchor::max()
1541 }
1542 }
1543
1544 pub fn anchor_in_excerpt(&self, excerpt_id: ExcerptId, text_anchor: text::Anchor) -> Anchor {
1545 let mut cursor = self.excerpts.cursor::<Option<&ExcerptId>>();
1546 cursor.seek(&Some(&excerpt_id), Bias::Left, &());
1547 if let Some(excerpt) = cursor.item() {
1548 if excerpt.id == excerpt_id {
1549 let text_anchor = excerpt.clip_anchor(text_anchor);
1550 drop(cursor);
1551 return Anchor {
1552 buffer_id: excerpt.buffer_id,
1553 excerpt_id,
1554 text_anchor,
1555 };
1556 }
1557 }
1558 panic!("excerpt not found");
1559 }
1560
1561 pub fn can_resolve(&self, anchor: &Anchor) -> bool {
1562 if anchor.excerpt_id == ExcerptId::min() || anchor.excerpt_id == ExcerptId::max() {
1563 true
1564 } else if let Some((buffer_id, buffer_snapshot)) =
1565 self.buffer_snapshot_for_excerpt(&anchor.excerpt_id)
1566 {
1567 anchor.buffer_id == buffer_id && buffer_snapshot.can_resolve(&anchor.text_anchor)
1568 } else {
1569 false
1570 }
1571 }
1572
1573 pub fn range_contains_excerpt_boundary<T: ToOffset>(&self, range: Range<T>) -> bool {
1574 let start = range.start.to_offset(self);
1575 let end = range.end.to_offset(self);
1576 let mut cursor = self.excerpts.cursor::<(usize, Option<&ExcerptId>)>();
1577 cursor.seek(&start, Bias::Right, &());
1578 let start_id = cursor
1579 .item()
1580 .or_else(|| cursor.prev_item())
1581 .map(|excerpt| &excerpt.id);
1582 cursor.seek_forward(&end, Bias::Right, &());
1583 let end_id = cursor
1584 .item()
1585 .or_else(|| cursor.prev_item())
1586 .map(|excerpt| &excerpt.id);
1587 start_id != end_id
1588 }
1589
1590 pub fn parse_count(&self) -> usize {
1591 self.parse_count
1592 }
1593
1594 pub fn enclosing_bracket_ranges<T: ToOffset>(
1595 &self,
1596 range: Range<T>,
1597 ) -> Option<(Range<usize>, Range<usize>)> {
1598 let range = range.start.to_offset(self)..range.end.to_offset(self);
1599
1600 let mut cursor = self.excerpts.cursor::<usize>();
1601 cursor.seek(&range.start, Bias::Right, &());
1602 let start_excerpt = cursor.item();
1603
1604 cursor.seek(&range.end, Bias::Right, &());
1605 let end_excerpt = cursor.item();
1606
1607 start_excerpt
1608 .zip(end_excerpt)
1609 .and_then(|(start_excerpt, end_excerpt)| {
1610 if start_excerpt.id != end_excerpt.id {
1611 return None;
1612 }
1613
1614 let excerpt_buffer_start =
1615 start_excerpt.range.start.to_offset(&start_excerpt.buffer);
1616 let excerpt_buffer_end = excerpt_buffer_start + start_excerpt.text_summary.bytes;
1617
1618 let start_in_buffer =
1619 excerpt_buffer_start + range.start.saturating_sub(*cursor.start());
1620 let end_in_buffer =
1621 excerpt_buffer_start + range.end.saturating_sub(*cursor.start());
1622 let (mut start_bracket_range, mut end_bracket_range) = start_excerpt
1623 .buffer
1624 .enclosing_bracket_ranges(start_in_buffer..end_in_buffer)?;
1625
1626 if start_bracket_range.start >= excerpt_buffer_start
1627 && end_bracket_range.end < excerpt_buffer_end
1628 {
1629 start_bracket_range.start =
1630 cursor.start() + (start_bracket_range.start - excerpt_buffer_start);
1631 start_bracket_range.end =
1632 cursor.start() + (start_bracket_range.end - excerpt_buffer_start);
1633 end_bracket_range.start =
1634 cursor.start() + (end_bracket_range.start - excerpt_buffer_start);
1635 end_bracket_range.end =
1636 cursor.start() + (end_bracket_range.end - excerpt_buffer_start);
1637 Some((start_bracket_range, end_bracket_range))
1638 } else {
1639 None
1640 }
1641 })
1642 }
1643
1644 pub fn diagnostics_update_count(&self) -> usize {
1645 self.diagnostics_update_count
1646 }
1647
1648 pub fn language(&self) -> Option<&Arc<Language>> {
1649 self.excerpts
1650 .iter()
1651 .next()
1652 .and_then(|excerpt| excerpt.buffer.language())
1653 }
1654
1655 pub fn is_dirty(&self) -> bool {
1656 self.is_dirty
1657 }
1658
1659 pub fn has_conflict(&self) -> bool {
1660 self.has_conflict
1661 }
1662
1663 pub fn diagnostic_group<'a, O>(
1664 &'a self,
1665 group_id: usize,
1666 ) -> impl Iterator<Item = DiagnosticEntry<O>> + 'a
1667 where
1668 O: text::FromAnchor + 'a,
1669 {
1670 self.as_singleton()
1671 .into_iter()
1672 .flat_map(move |buffer| buffer.diagnostic_group(group_id))
1673 }
1674
1675 pub fn diagnostics_in_range<'a, T, O>(
1676 &'a self,
1677 range: Range<T>,
1678 ) -> impl Iterator<Item = DiagnosticEntry<O>> + 'a
1679 where
1680 T: 'a + ToOffset,
1681 O: 'a + text::FromAnchor,
1682 {
1683 self.as_singleton().into_iter().flat_map(move |buffer| {
1684 buffer.diagnostics_in_range(range.start.to_offset(self)..range.end.to_offset(self))
1685 })
1686 }
1687
1688 pub fn range_for_syntax_ancestor<T: ToOffset>(&self, range: Range<T>) -> Option<Range<usize>> {
1689 let range = range.start.to_offset(self)..range.end.to_offset(self);
1690
1691 let mut cursor = self.excerpts.cursor::<usize>();
1692 cursor.seek(&range.start, Bias::Right, &());
1693 let start_excerpt = cursor.item();
1694
1695 cursor.seek(&range.end, Bias::Right, &());
1696 let end_excerpt = cursor.item();
1697
1698 start_excerpt
1699 .zip(end_excerpt)
1700 .and_then(|(start_excerpt, end_excerpt)| {
1701 if start_excerpt.id != end_excerpt.id {
1702 return None;
1703 }
1704
1705 let excerpt_buffer_start =
1706 start_excerpt.range.start.to_offset(&start_excerpt.buffer);
1707 let excerpt_buffer_end = excerpt_buffer_start + start_excerpt.text_summary.bytes;
1708
1709 let start_in_buffer =
1710 excerpt_buffer_start + range.start.saturating_sub(*cursor.start());
1711 let end_in_buffer =
1712 excerpt_buffer_start + range.end.saturating_sub(*cursor.start());
1713 let mut ancestor_buffer_range = start_excerpt
1714 .buffer
1715 .range_for_syntax_ancestor(start_in_buffer..end_in_buffer)?;
1716 ancestor_buffer_range.start =
1717 cmp::max(ancestor_buffer_range.start, excerpt_buffer_start);
1718 ancestor_buffer_range.end = cmp::min(ancestor_buffer_range.end, excerpt_buffer_end);
1719
1720 let start = cursor.start() + (ancestor_buffer_range.start - excerpt_buffer_start);
1721 let end = cursor.start() + (ancestor_buffer_range.end - excerpt_buffer_start);
1722 Some(start..end)
1723 })
1724 }
1725
1726 pub fn outline(&self, theme: Option<&SyntaxTheme>) -> Option<Outline<Anchor>> {
1727 let buffer = self.as_singleton()?;
1728 let outline = buffer.outline(theme)?;
1729 let excerpt_id = &self.excerpts.iter().next().unwrap().id;
1730 Some(Outline::new(
1731 outline
1732 .items
1733 .into_iter()
1734 .map(|item| OutlineItem {
1735 depth: item.depth,
1736 range: self.anchor_in_excerpt(excerpt_id.clone(), item.range.start)
1737 ..self.anchor_in_excerpt(excerpt_id.clone(), item.range.end),
1738 text: item.text,
1739 highlight_ranges: item.highlight_ranges,
1740 name_ranges: item.name_ranges,
1741 })
1742 .collect(),
1743 ))
1744 }
1745
1746 fn buffer_snapshot_for_excerpt<'a>(
1747 &'a self,
1748 excerpt_id: &'a ExcerptId,
1749 ) -> Option<(usize, &'a BufferSnapshot)> {
1750 let mut cursor = self.excerpts.cursor::<Option<&ExcerptId>>();
1751 cursor.seek(&Some(excerpt_id), Bias::Left, &());
1752 if let Some(excerpt) = cursor.item() {
1753 if excerpt.id == *excerpt_id {
1754 return Some((excerpt.buffer_id, &excerpt.buffer));
1755 }
1756 }
1757 None
1758 }
1759
1760 pub fn remote_selections_in_range<'a>(
1761 &'a self,
1762 range: &'a Range<Anchor>,
1763 ) -> impl 'a + Iterator<Item = (ReplicaId, Selection<Anchor>)> {
1764 let mut cursor = self.excerpts.cursor::<Option<&ExcerptId>>();
1765 cursor.seek(&Some(&range.start.excerpt_id), Bias::Left, &());
1766 cursor
1767 .take_while(move |excerpt| excerpt.id <= range.end.excerpt_id)
1768 .flat_map(move |excerpt| {
1769 let mut query_range = excerpt.range.start.clone()..excerpt.range.end.clone();
1770 if excerpt.id == range.start.excerpt_id {
1771 query_range.start = range.start.text_anchor.clone();
1772 }
1773 if excerpt.id == range.end.excerpt_id {
1774 query_range.end = range.end.text_anchor.clone();
1775 }
1776
1777 excerpt
1778 .buffer
1779 .remote_selections_in_range(query_range)
1780 .flat_map(move |(replica_id, selections)| {
1781 selections.map(move |selection| {
1782 let mut start = Anchor {
1783 buffer_id: excerpt.buffer_id,
1784 excerpt_id: excerpt.id.clone(),
1785 text_anchor: selection.start.clone(),
1786 };
1787 let mut end = Anchor {
1788 buffer_id: excerpt.buffer_id,
1789 excerpt_id: excerpt.id.clone(),
1790 text_anchor: selection.end.clone(),
1791 };
1792 if range.start.cmp(&start, self).unwrap().is_gt() {
1793 start = range.start.clone();
1794 }
1795 if range.end.cmp(&end, self).unwrap().is_lt() {
1796 end = range.end.clone();
1797 }
1798
1799 (
1800 replica_id,
1801 Selection {
1802 id: selection.id,
1803 start,
1804 end,
1805 reversed: selection.reversed,
1806 goal: selection.goal,
1807 },
1808 )
1809 })
1810 })
1811 })
1812 }
1813}
1814
1815impl History {
1816 fn start_transaction(&mut self, now: Instant) -> Option<TransactionId> {
1817 self.transaction_depth += 1;
1818 if self.transaction_depth == 1 {
1819 let id = post_inc(&mut self.next_transaction_id);
1820 self.undo_stack.push(Transaction {
1821 id,
1822 buffer_transactions: Default::default(),
1823 first_edit_at: now,
1824 last_edit_at: now,
1825 });
1826 Some(id)
1827 } else {
1828 None
1829 }
1830 }
1831
1832 fn end_transaction(
1833 &mut self,
1834 now: Instant,
1835 buffer_transactions: HashSet<(usize, TransactionId)>,
1836 ) -> bool {
1837 assert_ne!(self.transaction_depth, 0);
1838 self.transaction_depth -= 1;
1839 if self.transaction_depth == 0 {
1840 if buffer_transactions.is_empty() {
1841 self.undo_stack.pop();
1842 false
1843 } else {
1844 let transaction = self.undo_stack.last_mut().unwrap();
1845 transaction.last_edit_at = now;
1846 transaction.buffer_transactions.extend(buffer_transactions);
1847 true
1848 }
1849 } else {
1850 false
1851 }
1852 }
1853
1854 fn pop_undo(&mut self) -> Option<&Transaction> {
1855 assert_eq!(self.transaction_depth, 0);
1856 if let Some(transaction) = self.undo_stack.pop() {
1857 self.redo_stack.push(transaction);
1858 self.redo_stack.last()
1859 } else {
1860 None
1861 }
1862 }
1863
1864 fn pop_redo(&mut self) -> Option<&Transaction> {
1865 assert_eq!(self.transaction_depth, 0);
1866 if let Some(transaction) = self.redo_stack.pop() {
1867 self.undo_stack.push(transaction);
1868 self.undo_stack.last()
1869 } else {
1870 None
1871 }
1872 }
1873
1874 fn group(&mut self) -> Option<TransactionId> {
1875 let mut new_len = self.undo_stack.len();
1876 let mut transactions = self.undo_stack.iter_mut();
1877
1878 if let Some(mut transaction) = transactions.next_back() {
1879 while let Some(prev_transaction) = transactions.next_back() {
1880 if transaction.first_edit_at - prev_transaction.last_edit_at <= self.group_interval
1881 {
1882 transaction = prev_transaction;
1883 new_len -= 1;
1884 } else {
1885 break;
1886 }
1887 }
1888 }
1889
1890 let (transactions_to_keep, transactions_to_merge) = self.undo_stack.split_at_mut(new_len);
1891 if let Some(last_transaction) = transactions_to_keep.last_mut() {
1892 if let Some(transaction) = transactions_to_merge.last() {
1893 last_transaction.last_edit_at = transaction.last_edit_at;
1894 }
1895 }
1896
1897 self.undo_stack.truncate(new_len);
1898 self.undo_stack.last().map(|t| t.id)
1899 }
1900}
1901
1902impl Excerpt {
1903 fn new(
1904 id: ExcerptId,
1905 buffer_id: usize,
1906 buffer: BufferSnapshot,
1907 range: Range<text::Anchor>,
1908 has_trailing_newline: bool,
1909 ) -> Self {
1910 Excerpt {
1911 id,
1912 max_buffer_row: range.end.to_point(&buffer).row,
1913 text_summary: buffer.text_summary_for_range::<TextSummary, _>(range.to_offset(&buffer)),
1914 buffer_id,
1915 buffer,
1916 range,
1917 has_trailing_newline,
1918 }
1919 }
1920
1921 fn chunks_in_range<'a>(
1922 &'a self,
1923 range: Range<usize>,
1924 theme: Option<&'a SyntaxTheme>,
1925 ) -> ExcerptChunks<'a> {
1926 let content_start = self.range.start.to_offset(&self.buffer);
1927 let chunks_start = content_start + range.start;
1928 let chunks_end = content_start + cmp::min(range.end, self.text_summary.bytes);
1929
1930 let footer_height = if self.has_trailing_newline
1931 && range.start <= self.text_summary.bytes
1932 && range.end > self.text_summary.bytes
1933 {
1934 1
1935 } else {
1936 0
1937 };
1938
1939 let content_chunks = self.buffer.chunks(chunks_start..chunks_end, theme);
1940
1941 ExcerptChunks {
1942 content_chunks,
1943 footer_height,
1944 }
1945 }
1946
1947 fn bytes_in_range(&self, range: Range<usize>) -> ExcerptBytes {
1948 let content_start = self.range.start.to_offset(&self.buffer);
1949 let bytes_start = content_start + range.start;
1950 let bytes_end = content_start + cmp::min(range.end, self.text_summary.bytes);
1951 let footer_height = if self.has_trailing_newline
1952 && range.start <= self.text_summary.bytes
1953 && range.end > self.text_summary.bytes
1954 {
1955 1
1956 } else {
1957 0
1958 };
1959 let content_bytes = self.buffer.bytes_in_range(bytes_start..bytes_end);
1960
1961 ExcerptBytes {
1962 content_bytes,
1963 footer_height,
1964 }
1965 }
1966
1967 fn clip_anchor(&self, text_anchor: text::Anchor) -> text::Anchor {
1968 if text_anchor
1969 .cmp(&self.range.start, &self.buffer)
1970 .unwrap()
1971 .is_lt()
1972 {
1973 self.range.start.clone()
1974 } else if text_anchor
1975 .cmp(&self.range.end, &self.buffer)
1976 .unwrap()
1977 .is_gt()
1978 {
1979 self.range.end.clone()
1980 } else {
1981 text_anchor
1982 }
1983 }
1984
1985 fn contains(&self, anchor: &Anchor) -> bool {
1986 self.buffer_id == anchor.buffer_id
1987 && self
1988 .range
1989 .start
1990 .cmp(&anchor.text_anchor, &self.buffer)
1991 .unwrap()
1992 .is_le()
1993 && self
1994 .range
1995 .end
1996 .cmp(&anchor.text_anchor, &self.buffer)
1997 .unwrap()
1998 .is_ge()
1999 }
2000}
2001
2002impl fmt::Debug for Excerpt {
2003 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2004 f.debug_struct("Excerpt")
2005 .field("id", &self.id)
2006 .field("buffer_id", &self.buffer_id)
2007 .field("range", &self.range)
2008 .field("text_summary", &self.text_summary)
2009 .field("has_trailing_newline", &self.has_trailing_newline)
2010 .finish()
2011 }
2012}
2013
2014impl sum_tree::Item for Excerpt {
2015 type Summary = ExcerptSummary;
2016
2017 fn summary(&self) -> Self::Summary {
2018 let mut text = self.text_summary.clone();
2019 if self.has_trailing_newline {
2020 text += TextSummary::from("\n");
2021 }
2022 ExcerptSummary {
2023 excerpt_id: self.id.clone(),
2024 max_buffer_row: self.max_buffer_row,
2025 text,
2026 }
2027 }
2028}
2029
2030impl sum_tree::Summary for ExcerptSummary {
2031 type Context = ();
2032
2033 fn add_summary(&mut self, summary: &Self, _: &()) {
2034 debug_assert!(summary.excerpt_id > self.excerpt_id);
2035 self.excerpt_id = summary.excerpt_id.clone();
2036 self.text.add_summary(&summary.text, &());
2037 self.max_buffer_row = cmp::max(self.max_buffer_row, summary.max_buffer_row);
2038 }
2039}
2040
2041impl<'a> sum_tree::Dimension<'a, ExcerptSummary> for TextSummary {
2042 fn add_summary(&mut self, summary: &'a ExcerptSummary, _: &()) {
2043 *self += &summary.text;
2044 }
2045}
2046
2047impl<'a> sum_tree::Dimension<'a, ExcerptSummary> for usize {
2048 fn add_summary(&mut self, summary: &'a ExcerptSummary, _: &()) {
2049 *self += summary.text.bytes;
2050 }
2051}
2052
2053impl<'a> sum_tree::SeekTarget<'a, ExcerptSummary, ExcerptSummary> for usize {
2054 fn cmp(&self, cursor_location: &ExcerptSummary, _: &()) -> cmp::Ordering {
2055 Ord::cmp(self, &cursor_location.text.bytes)
2056 }
2057}
2058
2059impl<'a> sum_tree::SeekTarget<'a, ExcerptSummary, ExcerptSummary> for Option<&'a ExcerptId> {
2060 fn cmp(&self, cursor_location: &ExcerptSummary, _: &()) -> cmp::Ordering {
2061 Ord::cmp(self, &Some(&cursor_location.excerpt_id))
2062 }
2063}
2064
2065impl<'a> sum_tree::Dimension<'a, ExcerptSummary> for Point {
2066 fn add_summary(&mut self, summary: &'a ExcerptSummary, _: &()) {
2067 *self += summary.text.lines;
2068 }
2069}
2070
2071impl<'a> sum_tree::Dimension<'a, ExcerptSummary> for PointUtf16 {
2072 fn add_summary(&mut self, summary: &'a ExcerptSummary, _: &()) {
2073 *self += summary.text.lines_utf16
2074 }
2075}
2076
2077impl<'a> sum_tree::Dimension<'a, ExcerptSummary> for Option<&'a ExcerptId> {
2078 fn add_summary(&mut self, summary: &'a ExcerptSummary, _: &()) {
2079 *self = Some(&summary.excerpt_id);
2080 }
2081}
2082
2083impl<'a> MultiBufferRows<'a> {
2084 pub fn seek(&mut self, row: u32) {
2085 self.buffer_row_range = 0..0;
2086
2087 self.excerpts
2088 .seek_forward(&Point::new(row, 0), Bias::Right, &());
2089 if self.excerpts.item().is_none() {
2090 self.excerpts.prev(&());
2091
2092 if self.excerpts.item().is_none() && row == 0 {
2093 self.buffer_row_range = 0..1;
2094 return;
2095 }
2096 }
2097
2098 if let Some(excerpt) = self.excerpts.item() {
2099 let overshoot = row - self.excerpts.start().row;
2100 let excerpt_start = excerpt.range.start.to_point(&excerpt.buffer).row;
2101 self.buffer_row_range.start = excerpt_start + overshoot;
2102 self.buffer_row_range.end = excerpt_start + excerpt.text_summary.lines.row + 1;
2103 }
2104 }
2105}
2106
2107impl<'a> Iterator for MultiBufferRows<'a> {
2108 type Item = Option<u32>;
2109
2110 fn next(&mut self) -> Option<Self::Item> {
2111 loop {
2112 if !self.buffer_row_range.is_empty() {
2113 let row = Some(self.buffer_row_range.start);
2114 self.buffer_row_range.start += 1;
2115 return Some(row);
2116 }
2117 self.excerpts.item()?;
2118 self.excerpts.next(&());
2119 let excerpt = self.excerpts.item()?;
2120 self.buffer_row_range.start = excerpt.range.start.to_point(&excerpt.buffer).row;
2121 self.buffer_row_range.end =
2122 self.buffer_row_range.start + excerpt.text_summary.lines.row + 1;
2123 }
2124 }
2125}
2126
2127impl<'a> MultiBufferChunks<'a> {
2128 pub fn offset(&self) -> usize {
2129 self.range.start
2130 }
2131
2132 pub fn seek(&mut self, offset: usize) {
2133 self.range.start = offset;
2134 self.excerpts.seek(&offset, Bias::Right, &());
2135 if let Some(excerpt) = self.excerpts.item() {
2136 self.excerpt_chunks = Some(excerpt.chunks_in_range(
2137 self.range.start - self.excerpts.start()..self.range.end - self.excerpts.start(),
2138 self.theme,
2139 ));
2140 } else {
2141 self.excerpt_chunks = None;
2142 }
2143 }
2144}
2145
2146impl<'a> Iterator for MultiBufferChunks<'a> {
2147 type Item = Chunk<'a>;
2148
2149 fn next(&mut self) -> Option<Self::Item> {
2150 if self.range.is_empty() {
2151 None
2152 } else if let Some(chunk) = self.excerpt_chunks.as_mut()?.next() {
2153 self.range.start += chunk.text.len();
2154 Some(chunk)
2155 } else {
2156 self.excerpts.next(&());
2157 let excerpt = self.excerpts.item()?;
2158 self.excerpt_chunks = Some(
2159 excerpt.chunks_in_range(0..self.range.end - self.excerpts.start(), self.theme),
2160 );
2161 self.next()
2162 }
2163 }
2164}
2165
2166impl<'a> MultiBufferBytes<'a> {
2167 fn consume(&mut self, len: usize) {
2168 self.range.start += len;
2169 self.chunk = &self.chunk[len..];
2170
2171 if !self.range.is_empty() && self.chunk.is_empty() {
2172 if let Some(chunk) = self.excerpt_bytes.as_mut().and_then(|bytes| bytes.next()) {
2173 self.chunk = chunk;
2174 } else {
2175 self.excerpts.next(&());
2176 if let Some(excerpt) = self.excerpts.item() {
2177 let mut excerpt_bytes =
2178 excerpt.bytes_in_range(0..self.range.end - self.excerpts.start());
2179 self.chunk = excerpt_bytes.next().unwrap();
2180 self.excerpt_bytes = Some(excerpt_bytes);
2181 }
2182 }
2183 }
2184 }
2185}
2186
2187impl<'a> Iterator for MultiBufferBytes<'a> {
2188 type Item = &'a [u8];
2189
2190 fn next(&mut self) -> Option<Self::Item> {
2191 let chunk = self.chunk;
2192 if chunk.is_empty() {
2193 None
2194 } else {
2195 self.consume(chunk.len());
2196 Some(chunk)
2197 }
2198 }
2199}
2200
2201impl<'a> io::Read for MultiBufferBytes<'a> {
2202 fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
2203 let len = cmp::min(buf.len(), self.chunk.len());
2204 buf[..len].copy_from_slice(&self.chunk[..len]);
2205 if len > 0 {
2206 self.consume(len);
2207 }
2208 Ok(len)
2209 }
2210}
2211
2212impl<'a> Iterator for ExcerptBytes<'a> {
2213 type Item = &'a [u8];
2214
2215 fn next(&mut self) -> Option<Self::Item> {
2216 if let Some(chunk) = self.content_bytes.next() {
2217 if !chunk.is_empty() {
2218 return Some(chunk);
2219 }
2220 }
2221
2222 if self.footer_height > 0 {
2223 let result = &NEWLINES[..self.footer_height];
2224 self.footer_height = 0;
2225 return Some(result);
2226 }
2227
2228 None
2229 }
2230}
2231
2232impl<'a> Iterator for ExcerptChunks<'a> {
2233 type Item = Chunk<'a>;
2234
2235 fn next(&mut self) -> Option<Self::Item> {
2236 if let Some(chunk) = self.content_chunks.next() {
2237 return Some(chunk);
2238 }
2239
2240 if self.footer_height > 0 {
2241 let text = unsafe { str::from_utf8_unchecked(&NEWLINES[..self.footer_height]) };
2242 self.footer_height = 0;
2243 return Some(Chunk {
2244 text,
2245 ..Default::default()
2246 });
2247 }
2248
2249 None
2250 }
2251}
2252
2253impl ToOffset for Point {
2254 fn to_offset<'a>(&self, snapshot: &MultiBufferSnapshot) -> usize {
2255 snapshot.point_to_offset(*self)
2256 }
2257}
2258
2259impl ToOffset for PointUtf16 {
2260 fn to_offset<'a>(&self, snapshot: &MultiBufferSnapshot) -> usize {
2261 snapshot.point_utf16_to_offset(*self)
2262 }
2263}
2264
2265impl ToOffset for usize {
2266 fn to_offset<'a>(&self, snapshot: &MultiBufferSnapshot) -> usize {
2267 assert!(*self <= snapshot.len(), "offset is out of range");
2268 *self
2269 }
2270}
2271
2272impl ToPoint for usize {
2273 fn to_point<'a>(&self, snapshot: &MultiBufferSnapshot) -> Point {
2274 snapshot.offset_to_point(*self)
2275 }
2276}
2277
2278impl ToPoint for Point {
2279 fn to_point<'a>(&self, _: &MultiBufferSnapshot) -> Point {
2280 *self
2281 }
2282}
2283
2284#[cfg(test)]
2285mod tests {
2286 use super::*;
2287 use gpui::MutableAppContext;
2288 use language::{Buffer, Rope};
2289 use rand::prelude::*;
2290 use std::env;
2291 use text::{Point, RandomCharIter};
2292 use util::test::sample_text;
2293
2294 #[gpui::test]
2295 fn test_singleton_multibuffer(cx: &mut MutableAppContext) {
2296 let buffer = cx.add_model(|cx| Buffer::new(0, sample_text(6, 6, 'a'), cx));
2297 let multibuffer = cx.add_model(|cx| MultiBuffer::singleton(buffer.clone(), cx));
2298
2299 let snapshot = multibuffer.read(cx).snapshot(cx);
2300 assert_eq!(snapshot.text(), buffer.read(cx).text());
2301
2302 assert_eq!(
2303 snapshot.buffer_rows(0).collect::<Vec<_>>(),
2304 (0..buffer.read(cx).row_count())
2305 .map(Some)
2306 .collect::<Vec<_>>()
2307 );
2308
2309 buffer.update(cx, |buffer, cx| buffer.edit([1..3], "XXX\n", cx));
2310 let snapshot = multibuffer.read(cx).snapshot(cx);
2311
2312 assert_eq!(snapshot.text(), buffer.read(cx).text());
2313 assert_eq!(
2314 snapshot.buffer_rows(0).collect::<Vec<_>>(),
2315 (0..buffer.read(cx).row_count())
2316 .map(Some)
2317 .collect::<Vec<_>>()
2318 );
2319 }
2320
2321 #[gpui::test]
2322 fn test_remote_multibuffer(cx: &mut MutableAppContext) {
2323 let host_buffer = cx.add_model(|cx| Buffer::new(0, "a", cx));
2324 let guest_buffer = cx.add_model(|cx| {
2325 let message = host_buffer.read(cx).to_proto();
2326 Buffer::from_proto(1, message, None, cx).unwrap()
2327 });
2328 let multibuffer = cx.add_model(|cx| MultiBuffer::singleton(guest_buffer.clone(), cx));
2329 let snapshot = multibuffer.read(cx).snapshot(cx);
2330 assert_eq!(snapshot.text(), "a");
2331
2332 guest_buffer.update(cx, |buffer, cx| buffer.edit([1..1], "b", cx));
2333 let snapshot = multibuffer.read(cx).snapshot(cx);
2334 assert_eq!(snapshot.text(), "ab");
2335
2336 guest_buffer.update(cx, |buffer, cx| buffer.edit([2..2], "c", cx));
2337 let snapshot = multibuffer.read(cx).snapshot(cx);
2338 assert_eq!(snapshot.text(), "abc");
2339 }
2340
2341 #[gpui::test]
2342 fn test_excerpt_buffer(cx: &mut MutableAppContext) {
2343 let buffer_1 = cx.add_model(|cx| Buffer::new(0, sample_text(6, 6, 'a'), cx));
2344 let buffer_2 = cx.add_model(|cx| Buffer::new(0, sample_text(6, 6, 'g'), cx));
2345 let multibuffer = cx.add_model(|_| MultiBuffer::new(0));
2346
2347 let subscription = multibuffer.update(cx, |multibuffer, cx| {
2348 let subscription = multibuffer.subscribe();
2349 multibuffer.push_excerpt(
2350 ExcerptProperties {
2351 buffer: &buffer_1,
2352 range: Point::new(1, 2)..Point::new(2, 5),
2353 },
2354 cx,
2355 );
2356 assert_eq!(
2357 subscription.consume().into_inner(),
2358 [Edit {
2359 old: 0..0,
2360 new: 0..10
2361 }]
2362 );
2363
2364 multibuffer.push_excerpt(
2365 ExcerptProperties {
2366 buffer: &buffer_1,
2367 range: Point::new(3, 3)..Point::new(4, 4),
2368 },
2369 cx,
2370 );
2371 multibuffer.push_excerpt(
2372 ExcerptProperties {
2373 buffer: &buffer_2,
2374 range: Point::new(3, 1)..Point::new(3, 3),
2375 },
2376 cx,
2377 );
2378 assert_eq!(
2379 subscription.consume().into_inner(),
2380 [Edit {
2381 old: 10..10,
2382 new: 10..22
2383 }]
2384 );
2385
2386 subscription
2387 });
2388
2389 let snapshot = multibuffer.read(cx).snapshot(cx);
2390 assert_eq!(
2391 snapshot.text(),
2392 concat!(
2393 "bbbb\n", // Preserve newlines
2394 "ccccc\n", //
2395 "ddd\n", //
2396 "eeee\n", //
2397 "jj" //
2398 )
2399 );
2400 assert_eq!(
2401 snapshot.buffer_rows(0).collect::<Vec<_>>(),
2402 [Some(1), Some(2), Some(3), Some(4), Some(3)]
2403 );
2404 assert_eq!(
2405 snapshot.buffer_rows(2).collect::<Vec<_>>(),
2406 [Some(3), Some(4), Some(3)]
2407 );
2408 assert_eq!(snapshot.buffer_rows(4).collect::<Vec<_>>(), [Some(3)]);
2409 assert_eq!(snapshot.buffer_rows(5).collect::<Vec<_>>(), []);
2410 assert!(!snapshot.range_contains_excerpt_boundary(Point::new(1, 0)..Point::new(1, 5)));
2411 assert!(snapshot.range_contains_excerpt_boundary(Point::new(1, 0)..Point::new(2, 0)));
2412 assert!(snapshot.range_contains_excerpt_boundary(Point::new(1, 0)..Point::new(4, 0)));
2413 assert!(!snapshot.range_contains_excerpt_boundary(Point::new(2, 0)..Point::new(3, 0)));
2414 assert!(!snapshot.range_contains_excerpt_boundary(Point::new(4, 0)..Point::new(4, 2)));
2415 assert!(!snapshot.range_contains_excerpt_boundary(Point::new(4, 2)..Point::new(4, 2)));
2416
2417 buffer_1.update(cx, |buffer, cx| {
2418 buffer.edit(
2419 [
2420 Point::new(0, 0)..Point::new(0, 0),
2421 Point::new(2, 1)..Point::new(2, 3),
2422 ],
2423 "\n",
2424 cx,
2425 );
2426 });
2427
2428 let snapshot = multibuffer.read(cx).snapshot(cx);
2429 assert_eq!(
2430 snapshot.text(),
2431 concat!(
2432 "bbbb\n", // Preserve newlines
2433 "c\n", //
2434 "cc\n", //
2435 "ddd\n", //
2436 "eeee\n", //
2437 "jj" //
2438 )
2439 );
2440
2441 assert_eq!(
2442 subscription.consume().into_inner(),
2443 [Edit {
2444 old: 6..8,
2445 new: 6..7
2446 }]
2447 );
2448
2449 let snapshot = multibuffer.read(cx).snapshot(cx);
2450 assert_eq!(
2451 snapshot.clip_point(Point::new(0, 5), Bias::Left),
2452 Point::new(0, 4)
2453 );
2454 assert_eq!(
2455 snapshot.clip_point(Point::new(0, 5), Bias::Right),
2456 Point::new(0, 4)
2457 );
2458 assert_eq!(
2459 snapshot.clip_point(Point::new(5, 1), Bias::Right),
2460 Point::new(5, 1)
2461 );
2462 assert_eq!(
2463 snapshot.clip_point(Point::new(5, 2), Bias::Right),
2464 Point::new(5, 2)
2465 );
2466 assert_eq!(
2467 snapshot.clip_point(Point::new(5, 3), Bias::Right),
2468 Point::new(5, 2)
2469 );
2470
2471 let snapshot = multibuffer.update(cx, |multibuffer, cx| {
2472 let buffer_2_excerpt_id = multibuffer.excerpt_ids_for_buffer(&buffer_2)[0].clone();
2473 multibuffer.remove_excerpts(&[buffer_2_excerpt_id], cx);
2474 multibuffer.snapshot(cx)
2475 });
2476
2477 assert_eq!(
2478 snapshot.text(),
2479 concat!(
2480 "bbbb\n", // Preserve newlines
2481 "c\n", //
2482 "cc\n", //
2483 "ddd\n", //
2484 "eeee", //
2485 )
2486 );
2487 }
2488
2489 #[gpui::test]
2490 fn test_empty_excerpt_buffer(cx: &mut MutableAppContext) {
2491 let multibuffer = cx.add_model(|_| MultiBuffer::new(0));
2492
2493 let snapshot = multibuffer.read(cx).snapshot(cx);
2494 assert_eq!(snapshot.text(), "");
2495 assert_eq!(snapshot.buffer_rows(0).collect::<Vec<_>>(), &[Some(0)]);
2496 assert_eq!(snapshot.buffer_rows(1).collect::<Vec<_>>(), &[]);
2497 }
2498
2499 #[gpui::test]
2500 fn test_singleton_multibuffer_anchors(cx: &mut MutableAppContext) {
2501 let buffer = cx.add_model(|cx| Buffer::new(0, "abcd", cx));
2502 let multibuffer = cx.add_model(|cx| MultiBuffer::singleton(buffer.clone(), cx));
2503 let old_snapshot = multibuffer.read(cx).snapshot(cx);
2504 buffer.update(cx, |buffer, cx| {
2505 buffer.edit([0..0], "X", cx);
2506 buffer.edit([5..5], "Y", cx);
2507 });
2508 let new_snapshot = multibuffer.read(cx).snapshot(cx);
2509
2510 assert_eq!(old_snapshot.text(), "abcd");
2511 assert_eq!(new_snapshot.text(), "XabcdY");
2512
2513 assert_eq!(old_snapshot.anchor_before(0).to_offset(&new_snapshot), 0);
2514 assert_eq!(old_snapshot.anchor_after(0).to_offset(&new_snapshot), 1);
2515 assert_eq!(old_snapshot.anchor_before(4).to_offset(&new_snapshot), 5);
2516 assert_eq!(old_snapshot.anchor_after(4).to_offset(&new_snapshot), 6);
2517 }
2518
2519 #[gpui::test]
2520 fn test_multibuffer_anchors(cx: &mut MutableAppContext) {
2521 let buffer_1 = cx.add_model(|cx| Buffer::new(0, "abcd", cx));
2522 let buffer_2 = cx.add_model(|cx| Buffer::new(0, "efghi", cx));
2523 let multibuffer = cx.add_model(|cx| {
2524 let mut multibuffer = MultiBuffer::new(0);
2525 multibuffer.push_excerpt(
2526 ExcerptProperties {
2527 buffer: &buffer_1,
2528 range: 0..4,
2529 },
2530 cx,
2531 );
2532 multibuffer.push_excerpt(
2533 ExcerptProperties {
2534 buffer: &buffer_2,
2535 range: 0..5,
2536 },
2537 cx,
2538 );
2539 multibuffer
2540 });
2541 let old_snapshot = multibuffer.read(cx).snapshot(cx);
2542
2543 assert_eq!(old_snapshot.anchor_before(0).to_offset(&old_snapshot), 0);
2544 assert_eq!(old_snapshot.anchor_after(0).to_offset(&old_snapshot), 0);
2545 assert_eq!(Anchor::min().to_offset(&old_snapshot), 0);
2546 assert_eq!(Anchor::min().to_offset(&old_snapshot), 0);
2547 assert_eq!(Anchor::max().to_offset(&old_snapshot), 10);
2548 assert_eq!(Anchor::max().to_offset(&old_snapshot), 10);
2549
2550 buffer_1.update(cx, |buffer, cx| {
2551 buffer.edit([0..0], "W", cx);
2552 buffer.edit([5..5], "X", cx);
2553 });
2554 buffer_2.update(cx, |buffer, cx| {
2555 buffer.edit([0..0], "Y", cx);
2556 buffer.edit([6..0], "Z", cx);
2557 });
2558 let new_snapshot = multibuffer.read(cx).snapshot(cx);
2559
2560 assert_eq!(old_snapshot.text(), "abcd\nefghi");
2561 assert_eq!(new_snapshot.text(), "WabcdX\nYefghiZ");
2562
2563 assert_eq!(old_snapshot.anchor_before(0).to_offset(&new_snapshot), 0);
2564 assert_eq!(old_snapshot.anchor_after(0).to_offset(&new_snapshot), 1);
2565 assert_eq!(old_snapshot.anchor_before(1).to_offset(&new_snapshot), 2);
2566 assert_eq!(old_snapshot.anchor_after(1).to_offset(&new_snapshot), 2);
2567 assert_eq!(old_snapshot.anchor_before(2).to_offset(&new_snapshot), 3);
2568 assert_eq!(old_snapshot.anchor_after(2).to_offset(&new_snapshot), 3);
2569 assert_eq!(old_snapshot.anchor_before(5).to_offset(&new_snapshot), 7);
2570 assert_eq!(old_snapshot.anchor_after(5).to_offset(&new_snapshot), 8);
2571 assert_eq!(old_snapshot.anchor_before(10).to_offset(&new_snapshot), 13);
2572 assert_eq!(old_snapshot.anchor_after(10).to_offset(&new_snapshot), 14);
2573 }
2574
2575 #[gpui::test]
2576 fn test_multibuffer_resolving_anchors_after_replacing_their_excerpts(
2577 cx: &mut MutableAppContext,
2578 ) {
2579 let buffer_1 = cx.add_model(|cx| Buffer::new(0, "abcd", cx));
2580 let buffer_2 = cx.add_model(|cx| Buffer::new(0, "ABCDEFGHIJKLMNOP", cx));
2581 let multibuffer = cx.add_model(|_| MultiBuffer::new(0));
2582
2583 // Create an insertion id in buffer 1 that doesn't exist in buffer 2.
2584 // Add an excerpt from buffer 1 that spans this new insertion.
2585 buffer_1.update(cx, |buffer, cx| buffer.edit([4..4], "123", cx));
2586 let excerpt_id_1 = multibuffer.update(cx, |multibuffer, cx| {
2587 multibuffer.push_excerpt(
2588 ExcerptProperties {
2589 buffer: &buffer_1,
2590 range: 0..7,
2591 },
2592 cx,
2593 )
2594 });
2595
2596 let snapshot_1 = multibuffer.read(cx).snapshot(cx);
2597 assert_eq!(snapshot_1.text(), "abcd123");
2598
2599 // Replace the buffer 1 excerpt with new excerpts from buffer 2.
2600 let (excerpt_id_2, excerpt_id_3, _) = multibuffer.update(cx, |multibuffer, cx| {
2601 multibuffer.remove_excerpts([&excerpt_id_1], cx);
2602 (
2603 multibuffer.push_excerpt(
2604 ExcerptProperties {
2605 buffer: &buffer_2,
2606 range: 0..4,
2607 },
2608 cx,
2609 ),
2610 multibuffer.push_excerpt(
2611 ExcerptProperties {
2612 buffer: &buffer_2,
2613 range: 6..10,
2614 },
2615 cx,
2616 ),
2617 multibuffer.push_excerpt(
2618 ExcerptProperties {
2619 buffer: &buffer_2,
2620 range: 12..16,
2621 },
2622 cx,
2623 ),
2624 )
2625 });
2626 let snapshot_2 = multibuffer.read(cx).snapshot(cx);
2627 assert_eq!(snapshot_2.text(), "ABCD\nGHIJ\nMNOP");
2628
2629 // The old excerpt id has been reused.
2630 assert_eq!(excerpt_id_2, excerpt_id_1);
2631
2632 // Resolve some anchors from the previous snapshot in the new snapshot.
2633 // Although there is still an excerpt with the same id, it is for
2634 // a different buffer, so we don't attempt to resolve the old text
2635 // anchor in the new buffer.
2636 assert_eq!(
2637 snapshot_2.summary_for_anchor::<usize>(&snapshot_1.anchor_before(2)),
2638 0
2639 );
2640 assert_eq!(
2641 snapshot_2.summaries_for_anchors::<usize, _>(&[
2642 snapshot_1.anchor_before(2),
2643 snapshot_1.anchor_after(3)
2644 ]),
2645 vec![0, 0]
2646 );
2647 let refresh =
2648 snapshot_2.refresh_anchors(&[snapshot_1.anchor_before(2), snapshot_1.anchor_after(3)]);
2649 assert_eq!(
2650 refresh,
2651 &[
2652 (0, snapshot_2.anchor_before(0), false),
2653 (1, snapshot_2.anchor_after(0), false),
2654 ]
2655 );
2656
2657 // Replace the middle excerpt with a smaller excerpt in buffer 2,
2658 // that intersects the old excerpt.
2659 let excerpt_id_5 = multibuffer.update(cx, |multibuffer, cx| {
2660 multibuffer.remove_excerpts([&excerpt_id_3], cx);
2661 multibuffer.insert_excerpt_after(
2662 &excerpt_id_3,
2663 ExcerptProperties {
2664 buffer: &buffer_2,
2665 range: 5..8,
2666 },
2667 cx,
2668 )
2669 });
2670
2671 let snapshot_3 = multibuffer.read(cx).snapshot(cx);
2672 assert_eq!(snapshot_3.text(), "ABCD\nFGH\nMNOP");
2673 assert_ne!(excerpt_id_5, excerpt_id_3);
2674
2675 // Resolve some anchors from the previous snapshot in the new snapshot.
2676 // The anchor in the middle excerpt snaps to the beginning of the
2677 // excerpt, since it is not
2678 let anchors = [
2679 snapshot_2.anchor_before(0),
2680 snapshot_2.anchor_after(2),
2681 snapshot_2.anchor_after(6),
2682 snapshot_2.anchor_after(14),
2683 ];
2684 assert_eq!(
2685 snapshot_3.summaries_for_anchors::<usize, _>(&anchors),
2686 &[0, 2, 9, 13]
2687 );
2688
2689 let new_anchors = snapshot_3.refresh_anchors(&anchors);
2690 assert_eq!(
2691 new_anchors.iter().map(|a| (a.0, a.2)).collect::<Vec<_>>(),
2692 &[(0, true), (1, true), (2, true), (3, true)]
2693 );
2694 assert_eq!(
2695 snapshot_3.summaries_for_anchors::<usize, _>(new_anchors.iter().map(|a| &a.1)),
2696 &[0, 2, 7, 13]
2697 );
2698 }
2699
2700 #[gpui::test(iterations = 100)]
2701 fn test_random_multibuffer(cx: &mut MutableAppContext, mut rng: StdRng) {
2702 let operations = env::var("OPERATIONS")
2703 .map(|i| i.parse().expect("invalid `OPERATIONS` variable"))
2704 .unwrap_or(10);
2705
2706 let mut buffers: Vec<ModelHandle<Buffer>> = Vec::new();
2707 let multibuffer = cx.add_model(|_| MultiBuffer::new(0));
2708 let mut excerpt_ids = Vec::new();
2709 let mut expected_excerpts = Vec::<(ModelHandle<Buffer>, Range<text::Anchor>)>::new();
2710 let mut anchors = Vec::new();
2711 let mut old_versions = Vec::new();
2712
2713 for _ in 0..operations {
2714 match rng.gen_range(0..100) {
2715 0..=19 if !buffers.is_empty() => {
2716 let buffer = buffers.choose(&mut rng).unwrap();
2717 buffer.update(cx, |buf, cx| buf.randomly_edit(&mut rng, 5, cx));
2718 }
2719 20..=29 if !expected_excerpts.is_empty() => {
2720 let mut ids_to_remove = vec![];
2721 for _ in 0..rng.gen_range(1..=3) {
2722 if expected_excerpts.is_empty() {
2723 break;
2724 }
2725
2726 let ix = rng.gen_range(0..expected_excerpts.len());
2727 ids_to_remove.push(excerpt_ids.remove(ix));
2728 let (buffer, range) = expected_excerpts.remove(ix);
2729 let buffer = buffer.read(cx);
2730 log::info!(
2731 "Removing excerpt {}: {:?}",
2732 ix,
2733 buffer
2734 .text_for_range(range.to_offset(&buffer))
2735 .collect::<String>(),
2736 );
2737 }
2738 ids_to_remove.sort_unstable();
2739 multibuffer.update(cx, |multibuffer, cx| {
2740 multibuffer.remove_excerpts(&ids_to_remove, cx)
2741 });
2742 }
2743 30..=39 if !expected_excerpts.is_empty() => {
2744 let multibuffer = multibuffer.read(cx).read(cx);
2745 let offset =
2746 multibuffer.clip_offset(rng.gen_range(0..=multibuffer.len()), Bias::Left);
2747 let bias = if rng.gen() { Bias::Left } else { Bias::Right };
2748 log::info!("Creating anchor at {} with bias {:?}", offset, bias);
2749 anchors.push(multibuffer.anchor_at(offset, bias));
2750 anchors.sort_by(|a, b| a.cmp(&b, &multibuffer).unwrap());
2751 }
2752 40..=44 if !anchors.is_empty() => {
2753 let multibuffer = multibuffer.read(cx).read(cx);
2754 anchors = multibuffer
2755 .refresh_anchors(&anchors)
2756 .into_iter()
2757 .map(|a| a.1)
2758 .collect();
2759 }
2760 _ => {
2761 let buffer_handle = if buffers.is_empty() || rng.gen_bool(0.4) {
2762 let base_text = RandomCharIter::new(&mut rng).take(10).collect::<String>();
2763 buffers.push(cx.add_model(|cx| Buffer::new(0, base_text, cx)));
2764 buffers.last().unwrap()
2765 } else {
2766 buffers.choose(&mut rng).unwrap()
2767 };
2768
2769 let buffer = buffer_handle.read(cx);
2770 let end_ix = buffer.clip_offset(rng.gen_range(0..=buffer.len()), Bias::Right);
2771 let start_ix = buffer.clip_offset(rng.gen_range(0..=end_ix), Bias::Left);
2772 let anchor_range = buffer.anchor_before(start_ix)..buffer.anchor_after(end_ix);
2773 let prev_excerpt_ix = rng.gen_range(0..=expected_excerpts.len());
2774 let prev_excerpt_id = excerpt_ids
2775 .get(prev_excerpt_ix)
2776 .cloned()
2777 .unwrap_or(ExcerptId::max());
2778 let excerpt_ix = (prev_excerpt_ix + 1).min(expected_excerpts.len());
2779
2780 log::info!(
2781 "Inserting excerpt at {} of {} for buffer {}: {:?}[{:?}] = {:?}",
2782 excerpt_ix,
2783 expected_excerpts.len(),
2784 buffer_handle.id(),
2785 buffer.text(),
2786 start_ix..end_ix,
2787 &buffer.text()[start_ix..end_ix]
2788 );
2789
2790 let excerpt_id = multibuffer.update(cx, |multibuffer, cx| {
2791 multibuffer.insert_excerpt_after(
2792 &prev_excerpt_id,
2793 ExcerptProperties {
2794 buffer: &buffer_handle,
2795 range: start_ix..end_ix,
2796 },
2797 cx,
2798 )
2799 });
2800
2801 excerpt_ids.insert(excerpt_ix, excerpt_id);
2802 expected_excerpts.insert(excerpt_ix, (buffer_handle.clone(), anchor_range));
2803 }
2804 }
2805
2806 if rng.gen_bool(0.3) {
2807 multibuffer.update(cx, |multibuffer, cx| {
2808 old_versions.push((multibuffer.snapshot(cx), multibuffer.subscribe()));
2809 })
2810 }
2811
2812 let snapshot = multibuffer.read(cx).snapshot(cx);
2813
2814 let mut excerpt_starts = Vec::new();
2815 let mut expected_text = String::new();
2816 let mut expected_buffer_rows = Vec::new();
2817 for (buffer, range) in &expected_excerpts {
2818 let buffer = buffer.read(cx);
2819 let buffer_range = range.to_offset(buffer);
2820
2821 excerpt_starts.push(TextSummary::from(expected_text.as_str()));
2822 expected_text.extend(buffer.text_for_range(buffer_range.clone()));
2823 expected_text.push('\n');
2824
2825 let buffer_row_range = buffer.offset_to_point(buffer_range.start).row
2826 ..=buffer.offset_to_point(buffer_range.end).row;
2827 for row in buffer_row_range {
2828 expected_buffer_rows.push(Some(row));
2829 }
2830 }
2831 // Remove final trailing newline.
2832 if !expected_excerpts.is_empty() {
2833 expected_text.pop();
2834 }
2835
2836 // Always report one buffer row
2837 if expected_buffer_rows.is_empty() {
2838 expected_buffer_rows.push(Some(0));
2839 }
2840
2841 assert_eq!(snapshot.text(), expected_text);
2842 log::info!("MultiBuffer text: {:?}", expected_text);
2843
2844 assert_eq!(
2845 snapshot.buffer_rows(0).collect::<Vec<_>>(),
2846 expected_buffer_rows,
2847 );
2848
2849 for _ in 0..5 {
2850 let start_row = rng.gen_range(0..=expected_buffer_rows.len());
2851 assert_eq!(
2852 snapshot.buffer_rows(start_row as u32).collect::<Vec<_>>(),
2853 &expected_buffer_rows[start_row..],
2854 "buffer_rows({})",
2855 start_row
2856 );
2857 }
2858
2859 assert_eq!(
2860 snapshot.max_buffer_row(),
2861 expected_buffer_rows
2862 .into_iter()
2863 .filter_map(|r| r)
2864 .max()
2865 .unwrap()
2866 );
2867
2868 let mut excerpt_starts = excerpt_starts.into_iter();
2869 for (buffer, range) in &expected_excerpts {
2870 let buffer_id = buffer.id();
2871 let buffer = buffer.read(cx);
2872 let buffer_range = range.to_offset(buffer);
2873 let buffer_start_point = buffer.offset_to_point(buffer_range.start);
2874 let buffer_start_point_utf16 =
2875 buffer.text_summary_for_range::<PointUtf16, _>(0..buffer_range.start);
2876
2877 let excerpt_start = excerpt_starts.next().unwrap();
2878 let mut offset = excerpt_start.bytes;
2879 let mut buffer_offset = buffer_range.start;
2880 let mut point = excerpt_start.lines;
2881 let mut buffer_point = buffer_start_point;
2882 let mut point_utf16 = excerpt_start.lines_utf16;
2883 let mut buffer_point_utf16 = buffer_start_point_utf16;
2884 for ch in buffer
2885 .snapshot()
2886 .chunks(buffer_range.clone(), None)
2887 .flat_map(|c| c.text.chars())
2888 {
2889 for _ in 0..ch.len_utf8() {
2890 let left_offset = snapshot.clip_offset(offset, Bias::Left);
2891 let right_offset = snapshot.clip_offset(offset, Bias::Right);
2892 let buffer_left_offset = buffer.clip_offset(buffer_offset, Bias::Left);
2893 let buffer_right_offset = buffer.clip_offset(buffer_offset, Bias::Right);
2894 assert_eq!(
2895 left_offset,
2896 excerpt_start.bytes + (buffer_left_offset - buffer_range.start),
2897 "clip_offset({:?}, Left). buffer: {:?}, buffer offset: {:?}",
2898 offset,
2899 buffer_id,
2900 buffer_offset,
2901 );
2902 assert_eq!(
2903 right_offset,
2904 excerpt_start.bytes + (buffer_right_offset - buffer_range.start),
2905 "clip_offset({:?}, Right). buffer: {:?}, buffer offset: {:?}",
2906 offset,
2907 buffer_id,
2908 buffer_offset,
2909 );
2910
2911 let left_point = snapshot.clip_point(point, Bias::Left);
2912 let right_point = snapshot.clip_point(point, Bias::Right);
2913 let buffer_left_point = buffer.clip_point(buffer_point, Bias::Left);
2914 let buffer_right_point = buffer.clip_point(buffer_point, Bias::Right);
2915 assert_eq!(
2916 left_point,
2917 excerpt_start.lines + (buffer_left_point - buffer_start_point),
2918 "clip_point({:?}, Left). buffer: {:?}, buffer point: {:?}",
2919 point,
2920 buffer_id,
2921 buffer_point,
2922 );
2923 assert_eq!(
2924 right_point,
2925 excerpt_start.lines + (buffer_right_point - buffer_start_point),
2926 "clip_point({:?}, Right). buffer: {:?}, buffer point: {:?}",
2927 point,
2928 buffer_id,
2929 buffer_point,
2930 );
2931
2932 assert_eq!(
2933 snapshot.point_to_offset(left_point),
2934 left_offset,
2935 "point_to_offset({:?})",
2936 left_point,
2937 );
2938 assert_eq!(
2939 snapshot.offset_to_point(left_offset),
2940 left_point,
2941 "offset_to_point({:?})",
2942 left_offset,
2943 );
2944
2945 offset += 1;
2946 buffer_offset += 1;
2947 if ch == '\n' {
2948 point += Point::new(1, 0);
2949 buffer_point += Point::new(1, 0);
2950 } else {
2951 point += Point::new(0, 1);
2952 buffer_point += Point::new(0, 1);
2953 }
2954 }
2955
2956 for _ in 0..ch.len_utf16() {
2957 let left_point_utf16 = snapshot.clip_point_utf16(point_utf16, Bias::Left);
2958 let right_point_utf16 = snapshot.clip_point_utf16(point_utf16, Bias::Right);
2959 let buffer_left_point_utf16 =
2960 buffer.clip_point_utf16(buffer_point_utf16, Bias::Left);
2961 let buffer_right_point_utf16 =
2962 buffer.clip_point_utf16(buffer_point_utf16, Bias::Right);
2963 assert_eq!(
2964 left_point_utf16,
2965 excerpt_start.lines_utf16
2966 + (buffer_left_point_utf16 - buffer_start_point_utf16),
2967 "clip_point_utf16({:?}, Left). buffer: {:?}, buffer point_utf16: {:?}",
2968 point_utf16,
2969 buffer_id,
2970 buffer_point_utf16,
2971 );
2972 assert_eq!(
2973 right_point_utf16,
2974 excerpt_start.lines_utf16
2975 + (buffer_right_point_utf16 - buffer_start_point_utf16),
2976 "clip_point_utf16({:?}, Right). buffer: {:?}, buffer point_utf16: {:?}",
2977 point_utf16,
2978 buffer_id,
2979 buffer_point_utf16,
2980 );
2981
2982 if ch == '\n' {
2983 point_utf16 += PointUtf16::new(1, 0);
2984 buffer_point_utf16 += PointUtf16::new(1, 0);
2985 } else {
2986 point_utf16 += PointUtf16::new(0, 1);
2987 buffer_point_utf16 += PointUtf16::new(0, 1);
2988 }
2989 }
2990 }
2991 }
2992
2993 for (row, line) in expected_text.split('\n').enumerate() {
2994 assert_eq!(
2995 snapshot.line_len(row as u32),
2996 line.len() as u32,
2997 "line_len({}).",
2998 row
2999 );
3000 }
3001
3002 let text_rope = Rope::from(expected_text.as_str());
3003 for _ in 0..10 {
3004 let end_ix = text_rope.clip_offset(rng.gen_range(0..=text_rope.len()), Bias::Right);
3005 let start_ix = text_rope.clip_offset(rng.gen_range(0..=end_ix), Bias::Left);
3006
3007 let text_for_range = snapshot
3008 .text_for_range(start_ix..end_ix)
3009 .collect::<String>();
3010 assert_eq!(
3011 text_for_range,
3012 &expected_text[start_ix..end_ix],
3013 "incorrect text for range {:?}",
3014 start_ix..end_ix
3015 );
3016
3017 let excerpted_buffer_ranges =
3018 multibuffer.read(cx).excerpted_buffers(start_ix..end_ix, cx);
3019 let excerpted_buffers_text = excerpted_buffer_ranges
3020 .into_iter()
3021 .map(|(buffer, buffer_range)| {
3022 buffer
3023 .read(cx)
3024 .text_for_range(buffer_range)
3025 .collect::<String>()
3026 })
3027 .collect::<Vec<_>>()
3028 .join("\n");
3029 assert_eq!(excerpted_buffers_text, text_for_range);
3030
3031 let expected_summary = TextSummary::from(&expected_text[start_ix..end_ix]);
3032 assert_eq!(
3033 snapshot.text_summary_for_range::<TextSummary, _>(start_ix..end_ix),
3034 expected_summary,
3035 "incorrect summary for range {:?}",
3036 start_ix..end_ix
3037 );
3038 }
3039
3040 // Anchor resolution
3041 for (anchor, resolved_offset) in anchors
3042 .iter()
3043 .zip(snapshot.summaries_for_anchors::<usize, _>(&anchors))
3044 {
3045 assert_eq!(
3046 snapshot.summary_for_anchor::<usize>(anchor),
3047 resolved_offset
3048 );
3049 }
3050
3051 for _ in 0..10 {
3052 let end_ix = text_rope.clip_offset(rng.gen_range(0..=text_rope.len()), Bias::Right);
3053 assert_eq!(
3054 snapshot.reversed_chars_at(end_ix).collect::<String>(),
3055 expected_text[..end_ix].chars().rev().collect::<String>(),
3056 );
3057 }
3058
3059 for _ in 0..10 {
3060 let end_ix = rng.gen_range(0..=text_rope.len());
3061 let start_ix = rng.gen_range(0..=end_ix);
3062 assert_eq!(
3063 snapshot
3064 .bytes_in_range(start_ix..end_ix)
3065 .flatten()
3066 .copied()
3067 .collect::<Vec<_>>(),
3068 expected_text.as_bytes()[start_ix..end_ix].to_vec(),
3069 "bytes_in_range({:?})",
3070 start_ix..end_ix,
3071 );
3072 }
3073 }
3074
3075 let snapshot = multibuffer.read(cx).snapshot(cx);
3076 for (old_snapshot, subscription) in old_versions {
3077 let edits = subscription.consume().into_inner();
3078
3079 log::info!(
3080 "applying subscription edits to old text: {:?}: {:?}",
3081 old_snapshot.text(),
3082 edits,
3083 );
3084
3085 let mut text = old_snapshot.text();
3086 for edit in edits {
3087 let new_text: String = snapshot.text_for_range(edit.new.clone()).collect();
3088 text.replace_range(edit.new.start..edit.new.start + edit.old.len(), &new_text);
3089 }
3090 assert_eq!(text.to_string(), snapshot.text());
3091 }
3092 }
3093
3094 #[gpui::test]
3095 fn test_history(cx: &mut MutableAppContext) {
3096 let buffer_1 = cx.add_model(|cx| Buffer::new(0, "1234", cx));
3097 let buffer_2 = cx.add_model(|cx| Buffer::new(0, "5678", cx));
3098 let multibuffer = cx.add_model(|_| MultiBuffer::new(0));
3099 let group_interval = multibuffer.read(cx).history.group_interval;
3100 multibuffer.update(cx, |multibuffer, cx| {
3101 multibuffer.push_excerpt(
3102 ExcerptProperties {
3103 buffer: &buffer_1,
3104 range: 0..buffer_1.read(cx).len(),
3105 },
3106 cx,
3107 );
3108 multibuffer.push_excerpt(
3109 ExcerptProperties {
3110 buffer: &buffer_2,
3111 range: 0..buffer_2.read(cx).len(),
3112 },
3113 cx,
3114 );
3115 });
3116
3117 let mut now = Instant::now();
3118
3119 multibuffer.update(cx, |multibuffer, cx| {
3120 multibuffer.start_transaction_at(now, cx);
3121 multibuffer.edit(
3122 [
3123 Point::new(0, 0)..Point::new(0, 0),
3124 Point::new(1, 0)..Point::new(1, 0),
3125 ],
3126 "A",
3127 cx,
3128 );
3129 multibuffer.edit(
3130 [
3131 Point::new(0, 1)..Point::new(0, 1),
3132 Point::new(1, 1)..Point::new(1, 1),
3133 ],
3134 "B",
3135 cx,
3136 );
3137 multibuffer.end_transaction_at(now, cx);
3138 assert_eq!(multibuffer.read(cx).text(), "AB1234\nAB5678");
3139
3140 now += 2 * group_interval;
3141 multibuffer.start_transaction_at(now, cx);
3142 multibuffer.edit([2..2], "C", cx);
3143 multibuffer.end_transaction_at(now, cx);
3144 assert_eq!(multibuffer.read(cx).text(), "ABC1234\nAB5678");
3145
3146 multibuffer.undo(cx);
3147 assert_eq!(multibuffer.read(cx).text(), "AB1234\nAB5678");
3148
3149 multibuffer.undo(cx);
3150 assert_eq!(multibuffer.read(cx).text(), "1234\n5678");
3151
3152 multibuffer.redo(cx);
3153 assert_eq!(multibuffer.read(cx).text(), "AB1234\nAB5678");
3154
3155 multibuffer.redo(cx);
3156 assert_eq!(multibuffer.read(cx).text(), "ABC1234\nAB5678");
3157
3158 buffer_1.update(cx, |buffer_1, cx| buffer_1.undo(cx));
3159 assert_eq!(multibuffer.read(cx).text(), "AB1234\nAB5678");
3160
3161 multibuffer.undo(cx);
3162 assert_eq!(multibuffer.read(cx).text(), "1234\n5678");
3163
3164 multibuffer.redo(cx);
3165 assert_eq!(multibuffer.read(cx).text(), "AB1234\nAB5678");
3166
3167 multibuffer.redo(cx);
3168 assert_eq!(multibuffer.read(cx).text(), "ABC1234\nAB5678");
3169
3170 multibuffer.undo(cx);
3171 assert_eq!(multibuffer.read(cx).text(), "AB1234\nAB5678");
3172
3173 buffer_1.update(cx, |buffer_1, cx| buffer_1.redo(cx));
3174 assert_eq!(multibuffer.read(cx).text(), "ABC1234\nAB5678");
3175
3176 multibuffer.undo(cx);
3177 assert_eq!(multibuffer.read(cx).text(), "C1234\n5678");
3178 });
3179 }
3180}