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, Selection,
10 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 fn on_buffer_event(
793 &mut self,
794 _: ModelHandle<Buffer>,
795 event: &Event,
796 cx: &mut ModelContext<Self>,
797 ) {
798 cx.emit(event.clone());
799 }
800
801 pub fn save(&mut self, cx: &mut ModelContext<Self>) -> Result<Task<Result<()>>> {
802 let mut save_tasks = Vec::new();
803 for BufferState { buffer, .. } in self.buffers.borrow().values() {
804 save_tasks.push(buffer.update(cx, |buffer, cx| buffer.save(cx))?);
805 }
806
807 Ok(cx.spawn(|_, _| async move {
808 for save in save_tasks {
809 save.await?;
810 }
811 Ok(())
812 }))
813 }
814
815 pub fn language<'a>(&self, cx: &'a AppContext) -> Option<&'a Arc<Language>> {
816 self.buffers
817 .borrow()
818 .values()
819 .next()
820 .and_then(|state| state.buffer.read(cx).language())
821 }
822
823 pub fn file<'a>(&self, cx: &'a AppContext) -> Option<&'a dyn File> {
824 self.as_singleton()?.read(cx).file()
825 }
826
827 #[cfg(test)]
828 pub fn is_parsing(&self, cx: &AppContext) -> bool {
829 self.as_singleton().unwrap().read(cx).is_parsing()
830 }
831
832 fn sync(&self, cx: &AppContext) {
833 let mut snapshot = self.snapshot.borrow_mut();
834 let mut excerpts_to_edit = Vec::new();
835 let mut reparsed = false;
836 let mut diagnostics_updated = false;
837 let mut is_dirty = false;
838 let mut has_conflict = false;
839 let mut buffers = self.buffers.borrow_mut();
840 for buffer_state in buffers.values_mut() {
841 let buffer = buffer_state.buffer.read(cx);
842 let version = buffer.version();
843 let parse_count = buffer.parse_count();
844 let selections_update_count = buffer.selections_update_count();
845 let diagnostics_update_count = buffer.diagnostics_update_count();
846
847 let buffer_edited = version.changed_since(&buffer_state.last_version);
848 let buffer_reparsed = parse_count > buffer_state.last_parse_count;
849 let buffer_selections_updated =
850 selections_update_count > buffer_state.last_selections_update_count;
851 let buffer_diagnostics_updated =
852 diagnostics_update_count > buffer_state.last_diagnostics_update_count;
853 if buffer_edited
854 || buffer_reparsed
855 || buffer_selections_updated
856 || buffer_diagnostics_updated
857 {
858 buffer_state.last_version = version;
859 buffer_state.last_parse_count = parse_count;
860 buffer_state.last_selections_update_count = selections_update_count;
861 buffer_state.last_diagnostics_update_count = diagnostics_update_count;
862 excerpts_to_edit.extend(
863 buffer_state
864 .excerpts
865 .iter()
866 .map(|excerpt_id| (excerpt_id, buffer_state.buffer.clone(), buffer_edited)),
867 );
868 }
869
870 reparsed |= buffer_reparsed;
871 diagnostics_updated |= buffer_diagnostics_updated;
872 is_dirty |= buffer.is_dirty();
873 has_conflict |= buffer.has_conflict();
874 }
875 if reparsed {
876 snapshot.parse_count += 1;
877 }
878 if diagnostics_updated {
879 snapshot.diagnostics_update_count += 1;
880 }
881 snapshot.is_dirty = is_dirty;
882 snapshot.has_conflict = has_conflict;
883
884 excerpts_to_edit.sort_unstable_by_key(|(excerpt_id, _, _)| *excerpt_id);
885
886 let mut edits = Vec::new();
887 let mut new_excerpts = SumTree::new();
888 let mut cursor = snapshot.excerpts.cursor::<(Option<&ExcerptId>, usize)>();
889
890 for (id, buffer, buffer_edited) in excerpts_to_edit {
891 new_excerpts.push_tree(cursor.slice(&Some(id), Bias::Left, &()), &());
892 let old_excerpt = cursor.item().unwrap();
893 let buffer_id = buffer.id();
894 let buffer = buffer.read(cx);
895
896 let mut new_excerpt;
897 if buffer_edited {
898 edits.extend(
899 buffer
900 .edits_since_in_range::<usize>(
901 old_excerpt.buffer.version(),
902 old_excerpt.range.clone(),
903 )
904 .map(|mut edit| {
905 let excerpt_old_start = cursor.start().1;
906 let excerpt_new_start = new_excerpts.summary().text.bytes;
907 edit.old.start += excerpt_old_start;
908 edit.old.end += excerpt_old_start;
909 edit.new.start += excerpt_new_start;
910 edit.new.end += excerpt_new_start;
911 edit
912 }),
913 );
914
915 new_excerpt = Excerpt::new(
916 id.clone(),
917 buffer_id,
918 buffer.snapshot(),
919 old_excerpt.range.clone(),
920 old_excerpt.has_trailing_newline,
921 );
922 } else {
923 new_excerpt = old_excerpt.clone();
924 new_excerpt.buffer = buffer.snapshot();
925 }
926
927 new_excerpts.push(new_excerpt, &());
928 cursor.next(&());
929 }
930 new_excerpts.push_tree(cursor.suffix(&()), &());
931
932 drop(cursor);
933 snapshot.excerpts = new_excerpts;
934
935 self.subscriptions.publish(edits);
936 }
937}
938
939#[cfg(any(test, feature = "test-support"))]
940impl MultiBuffer {
941 pub fn randomly_edit(
942 &mut self,
943 rng: &mut impl rand::Rng,
944 count: usize,
945 cx: &mut ModelContext<Self>,
946 ) {
947 use text::RandomCharIter;
948
949 let snapshot = self.read(cx);
950 let mut old_ranges: Vec<Range<usize>> = Vec::new();
951 for _ in 0..count {
952 let last_end = old_ranges.last().map_or(0, |last_range| last_range.end + 1);
953 if last_end > snapshot.len() {
954 break;
955 }
956 let end_ix = snapshot.clip_offset(rng.gen_range(0..=last_end), Bias::Right);
957 let start_ix = snapshot.clip_offset(rng.gen_range(0..=end_ix), Bias::Left);
958 old_ranges.push(start_ix..end_ix);
959 }
960 let new_text_len = rng.gen_range(0..10);
961 let new_text: String = RandomCharIter::new(&mut *rng).take(new_text_len).collect();
962 log::info!("mutating multi-buffer at {:?}: {:?}", old_ranges, new_text);
963 drop(snapshot);
964
965 self.edit(old_ranges.iter().cloned(), new_text.as_str(), cx);
966 }
967}
968
969impl Entity for MultiBuffer {
970 type Event = language::Event;
971}
972
973impl MultiBufferSnapshot {
974 pub fn text(&self) -> String {
975 self.chunks(0..self.len(), None)
976 .map(|chunk| chunk.text)
977 .collect()
978 }
979
980 pub fn reversed_chars_at<'a, T: ToOffset>(
981 &'a self,
982 position: T,
983 ) -> impl Iterator<Item = char> + 'a {
984 let mut offset = position.to_offset(self);
985 let mut cursor = self.excerpts.cursor::<usize>();
986 cursor.seek(&offset, Bias::Left, &());
987 let mut excerpt_chunks = cursor.item().map(|excerpt| {
988 let end_before_footer = cursor.start() + excerpt.text_summary.bytes;
989 let start = excerpt.range.start.to_offset(&excerpt.buffer);
990 let end = start + (cmp::min(offset, end_before_footer) - cursor.start());
991 excerpt.buffer.reversed_chunks_in_range(start..end)
992 });
993 iter::from_fn(move || {
994 if offset == *cursor.start() {
995 cursor.prev(&());
996 let excerpt = cursor.item()?;
997 excerpt_chunks = Some(
998 excerpt
999 .buffer
1000 .reversed_chunks_in_range(excerpt.range.clone()),
1001 );
1002 }
1003
1004 let excerpt = cursor.item().unwrap();
1005 if offset == cursor.end(&()) && excerpt.has_trailing_newline {
1006 offset -= 1;
1007 Some("\n")
1008 } else {
1009 let chunk = excerpt_chunks.as_mut().unwrap().next().unwrap();
1010 offset -= chunk.len();
1011 Some(chunk)
1012 }
1013 })
1014 .flat_map(|c| c.chars().rev())
1015 }
1016
1017 pub fn chars_at<'a, T: ToOffset>(&'a self, position: T) -> impl Iterator<Item = char> + 'a {
1018 let offset = position.to_offset(self);
1019 self.text_for_range(offset..self.len())
1020 .flat_map(|chunk| chunk.chars())
1021 }
1022
1023 pub fn text_for_range<'a, T: ToOffset>(
1024 &'a self,
1025 range: Range<T>,
1026 ) -> impl Iterator<Item = &'a str> {
1027 self.chunks(range, None).map(|chunk| chunk.text)
1028 }
1029
1030 pub fn is_line_blank(&self, row: u32) -> bool {
1031 self.text_for_range(Point::new(row, 0)..Point::new(row, self.line_len(row)))
1032 .all(|chunk| chunk.matches(|c: char| !c.is_whitespace()).next().is_none())
1033 }
1034
1035 pub fn contains_str_at<T>(&self, position: T, needle: &str) -> bool
1036 where
1037 T: ToOffset,
1038 {
1039 let position = position.to_offset(self);
1040 position == self.clip_offset(position, Bias::Left)
1041 && self
1042 .bytes_in_range(position..self.len())
1043 .flatten()
1044 .copied()
1045 .take(needle.len())
1046 .eq(needle.bytes())
1047 }
1048
1049 fn as_singleton(&self) -> Option<&BufferSnapshot> {
1050 let mut excerpts = self.excerpts.iter();
1051 let buffer = excerpts.next().map(|excerpt| &excerpt.buffer);
1052 if excerpts.next().is_none() {
1053 buffer
1054 } else {
1055 None
1056 }
1057 }
1058
1059 pub fn len(&self) -> usize {
1060 self.excerpts.summary().text.bytes
1061 }
1062
1063 pub fn max_buffer_row(&self) -> u32 {
1064 self.excerpts.summary().max_buffer_row
1065 }
1066
1067 pub fn clip_offset(&self, offset: usize, bias: Bias) -> usize {
1068 let mut cursor = self.excerpts.cursor::<usize>();
1069 cursor.seek(&offset, Bias::Right, &());
1070 let overshoot = if let Some(excerpt) = cursor.item() {
1071 let excerpt_start = excerpt.range.start.to_offset(&excerpt.buffer);
1072 let buffer_offset = excerpt
1073 .buffer
1074 .clip_offset(excerpt_start + (offset - cursor.start()), bias);
1075 buffer_offset.saturating_sub(excerpt_start)
1076 } else {
1077 0
1078 };
1079 cursor.start() + overshoot
1080 }
1081
1082 pub fn clip_point(&self, point: Point, bias: Bias) -> Point {
1083 let mut cursor = self.excerpts.cursor::<Point>();
1084 cursor.seek(&point, Bias::Right, &());
1085 let overshoot = if let Some(excerpt) = cursor.item() {
1086 let excerpt_start = excerpt.range.start.to_point(&excerpt.buffer);
1087 let buffer_point = excerpt
1088 .buffer
1089 .clip_point(excerpt_start + (point - cursor.start()), bias);
1090 buffer_point.saturating_sub(excerpt_start)
1091 } else {
1092 Point::zero()
1093 };
1094 *cursor.start() + overshoot
1095 }
1096
1097 pub fn clip_point_utf16(&self, point: PointUtf16, bias: Bias) -> PointUtf16 {
1098 let mut cursor = self.excerpts.cursor::<PointUtf16>();
1099 cursor.seek(&point, Bias::Right, &());
1100 let overshoot = if let Some(excerpt) = cursor.item() {
1101 let excerpt_start = excerpt
1102 .buffer
1103 .offset_to_point_utf16(excerpt.range.start.to_offset(&excerpt.buffer));
1104 let buffer_point = excerpt
1105 .buffer
1106 .clip_point_utf16(excerpt_start + (point - cursor.start()), bias);
1107 buffer_point.saturating_sub(excerpt_start)
1108 } else {
1109 PointUtf16::zero()
1110 };
1111 *cursor.start() + overshoot
1112 }
1113
1114 pub fn bytes_in_range<'a, T: ToOffset>(&'a self, range: Range<T>) -> MultiBufferBytes<'a> {
1115 let range = range.start.to_offset(self)..range.end.to_offset(self);
1116 let mut excerpts = self.excerpts.cursor::<usize>();
1117 excerpts.seek(&range.start, Bias::Right, &());
1118
1119 let mut chunk = &[][..];
1120 let excerpt_bytes = if let Some(excerpt) = excerpts.item() {
1121 let mut excerpt_bytes = excerpt
1122 .bytes_in_range(range.start - excerpts.start()..range.end - excerpts.start());
1123 chunk = excerpt_bytes.next().unwrap_or(&[][..]);
1124 Some(excerpt_bytes)
1125 } else {
1126 None
1127 };
1128
1129 MultiBufferBytes {
1130 range,
1131 excerpts,
1132 excerpt_bytes,
1133 chunk,
1134 }
1135 }
1136
1137 pub fn buffer_rows<'a>(&'a self, start_row: u32) -> MultiBufferRows<'a> {
1138 let mut result = MultiBufferRows {
1139 buffer_row_range: 0..0,
1140 excerpts: self.excerpts.cursor(),
1141 };
1142 result.seek(start_row);
1143 result
1144 }
1145
1146 pub fn chunks<'a, T: ToOffset>(
1147 &'a self,
1148 range: Range<T>,
1149 theme: Option<&'a SyntaxTheme>,
1150 ) -> MultiBufferChunks<'a> {
1151 let range = range.start.to_offset(self)..range.end.to_offset(self);
1152 let mut chunks = MultiBufferChunks {
1153 range: range.clone(),
1154 excerpts: self.excerpts.cursor(),
1155 excerpt_chunks: None,
1156 theme,
1157 };
1158 chunks.seek(range.start);
1159 chunks
1160 }
1161
1162 pub fn offset_to_point(&self, offset: usize) -> Point {
1163 let mut cursor = self.excerpts.cursor::<(usize, Point)>();
1164 cursor.seek(&offset, Bias::Right, &());
1165 if let Some(excerpt) = cursor.item() {
1166 let (start_offset, start_point) = cursor.start();
1167 let overshoot = offset - start_offset;
1168 let excerpt_start_offset = excerpt.range.start.to_offset(&excerpt.buffer);
1169 let excerpt_start_point = excerpt.range.start.to_point(&excerpt.buffer);
1170 let buffer_point = excerpt
1171 .buffer
1172 .offset_to_point(excerpt_start_offset + overshoot);
1173 *start_point + (buffer_point - excerpt_start_point)
1174 } else {
1175 self.excerpts.summary().text.lines
1176 }
1177 }
1178
1179 pub fn point_to_offset(&self, point: Point) -> usize {
1180 let mut cursor = self.excerpts.cursor::<(Point, usize)>();
1181 cursor.seek(&point, Bias::Right, &());
1182 if let Some(excerpt) = cursor.item() {
1183 let (start_point, start_offset) = cursor.start();
1184 let overshoot = point - start_point;
1185 let excerpt_start_offset = excerpt.range.start.to_offset(&excerpt.buffer);
1186 let excerpt_start_point = excerpt.range.start.to_point(&excerpt.buffer);
1187 let buffer_offset = excerpt
1188 .buffer
1189 .point_to_offset(excerpt_start_point + overshoot);
1190 *start_offset + buffer_offset - excerpt_start_offset
1191 } else {
1192 self.excerpts.summary().text.bytes
1193 }
1194 }
1195
1196 pub fn point_utf16_to_offset(&self, point: PointUtf16) -> usize {
1197 let mut cursor = self.excerpts.cursor::<(PointUtf16, usize)>();
1198 cursor.seek(&point, Bias::Right, &());
1199 if let Some(excerpt) = cursor.item() {
1200 let (start_point, start_offset) = cursor.start();
1201 let overshoot = point - start_point;
1202 let excerpt_start_offset = excerpt.range.start.to_offset(&excerpt.buffer);
1203 let excerpt_start_point = excerpt
1204 .buffer
1205 .offset_to_point_utf16(excerpt.range.start.to_offset(&excerpt.buffer));
1206 let buffer_offset = excerpt
1207 .buffer
1208 .point_utf16_to_offset(excerpt_start_point + overshoot);
1209 *start_offset + (buffer_offset - excerpt_start_offset)
1210 } else {
1211 self.excerpts.summary().text.bytes
1212 }
1213 }
1214
1215 pub fn indent_column_for_line(&self, row: u32) -> u32 {
1216 if let Some((buffer, range)) = self.buffer_line_for_row(row) {
1217 buffer
1218 .indent_column_for_line(range.start.row)
1219 .min(range.end.column)
1220 .saturating_sub(range.start.column)
1221 } else {
1222 0
1223 }
1224 }
1225
1226 pub fn line_len(&self, row: u32) -> u32 {
1227 if let Some((_, range)) = self.buffer_line_for_row(row) {
1228 range.end.column - range.start.column
1229 } else {
1230 0
1231 }
1232 }
1233
1234 fn buffer_line_for_row(&self, row: u32) -> Option<(&BufferSnapshot, Range<Point>)> {
1235 let mut cursor = self.excerpts.cursor::<Point>();
1236 cursor.seek(&Point::new(row, 0), Bias::Right, &());
1237 if let Some(excerpt) = cursor.item() {
1238 let overshoot = row - cursor.start().row;
1239 let excerpt_start = excerpt.range.start.to_point(&excerpt.buffer);
1240 let excerpt_end = excerpt.range.end.to_point(&excerpt.buffer);
1241 let buffer_row = excerpt_start.row + overshoot;
1242 let line_start = Point::new(buffer_row, 0);
1243 let line_end = Point::new(buffer_row, excerpt.buffer.line_len(buffer_row));
1244 return Some((
1245 &excerpt.buffer,
1246 line_start.max(excerpt_start)..line_end.min(excerpt_end),
1247 ));
1248 }
1249 None
1250 }
1251
1252 pub fn max_point(&self) -> Point {
1253 self.text_summary().lines
1254 }
1255
1256 pub fn text_summary(&self) -> TextSummary {
1257 self.excerpts.summary().text
1258 }
1259
1260 pub fn text_summary_for_range<'a, D, O>(&'a self, range: Range<O>) -> D
1261 where
1262 D: TextDimension,
1263 O: ToOffset,
1264 {
1265 let mut summary = D::default();
1266 let mut range = range.start.to_offset(self)..range.end.to_offset(self);
1267 let mut cursor = self.excerpts.cursor::<usize>();
1268 cursor.seek(&range.start, Bias::Right, &());
1269 if let Some(excerpt) = cursor.item() {
1270 let mut end_before_newline = cursor.end(&());
1271 if excerpt.has_trailing_newline {
1272 end_before_newline -= 1;
1273 }
1274
1275 let excerpt_start = excerpt.range.start.to_offset(&excerpt.buffer);
1276 let start_in_excerpt = excerpt_start + (range.start - cursor.start());
1277 let end_in_excerpt =
1278 excerpt_start + (cmp::min(end_before_newline, range.end) - cursor.start());
1279 summary.add_assign(
1280 &excerpt
1281 .buffer
1282 .text_summary_for_range(start_in_excerpt..end_in_excerpt),
1283 );
1284
1285 if range.end > end_before_newline {
1286 summary.add_assign(&D::from_text_summary(&TextSummary {
1287 bytes: 1,
1288 lines: Point::new(1 as u32, 0),
1289 lines_utf16: PointUtf16::new(1 as u32, 0),
1290 first_line_chars: 0,
1291 last_line_chars: 0,
1292 longest_row: 0,
1293 longest_row_chars: 0,
1294 }));
1295 }
1296
1297 cursor.next(&());
1298 }
1299
1300 if range.end > *cursor.start() {
1301 summary.add_assign(&D::from_text_summary(&cursor.summary::<_, TextSummary>(
1302 &range.end,
1303 Bias::Right,
1304 &(),
1305 )));
1306 if let Some(excerpt) = cursor.item() {
1307 range.end = cmp::max(*cursor.start(), range.end);
1308
1309 let excerpt_start = excerpt.range.start.to_offset(&excerpt.buffer);
1310 let end_in_excerpt = excerpt_start + (range.end - cursor.start());
1311 summary.add_assign(
1312 &excerpt
1313 .buffer
1314 .text_summary_for_range(excerpt_start..end_in_excerpt),
1315 );
1316 }
1317 }
1318
1319 summary
1320 }
1321
1322 pub fn summary_for_anchor<D>(&self, anchor: &Anchor) -> D
1323 where
1324 D: TextDimension + Ord + Sub<D, Output = D>,
1325 {
1326 let mut cursor = self.excerpts.cursor::<ExcerptSummary>();
1327 cursor.seek(&Some(&anchor.excerpt_id), Bias::Left, &());
1328 if cursor.item().is_none() {
1329 cursor.next(&());
1330 }
1331
1332 let mut position = D::from_text_summary(&cursor.start().text);
1333 if let Some(excerpt) = cursor.item() {
1334 if excerpt.id == anchor.excerpt_id && excerpt.buffer_id == anchor.buffer_id {
1335 let excerpt_buffer_start = excerpt.range.start.summary::<D>(&excerpt.buffer);
1336 let buffer_position = anchor.text_anchor.summary::<D>(&excerpt.buffer);
1337 if buffer_position > excerpt_buffer_start {
1338 position.add_assign(&(buffer_position - excerpt_buffer_start));
1339 }
1340 }
1341 }
1342 position
1343 }
1344
1345 pub fn summaries_for_anchors<'a, D, I>(&'a self, anchors: I) -> Vec<D>
1346 where
1347 D: TextDimension + Ord + Sub<D, Output = D>,
1348 I: 'a + IntoIterator<Item = &'a Anchor>,
1349 {
1350 let mut anchors = anchors.into_iter().peekable();
1351 let mut cursor = self.excerpts.cursor::<ExcerptSummary>();
1352 let mut summaries = Vec::new();
1353 while let Some(anchor) = anchors.peek() {
1354 let excerpt_id = &anchor.excerpt_id;
1355 let buffer_id = anchor.buffer_id;
1356 let excerpt_anchors = iter::from_fn(|| {
1357 let anchor = anchors.peek()?;
1358 if anchor.excerpt_id == *excerpt_id && anchor.buffer_id == buffer_id {
1359 Some(&anchors.next().unwrap().text_anchor)
1360 } else {
1361 None
1362 }
1363 });
1364
1365 cursor.seek_forward(&Some(excerpt_id), Bias::Left, &());
1366 if cursor.item().is_none() {
1367 cursor.next(&());
1368 }
1369
1370 let position = D::from_text_summary(&cursor.start().text);
1371 if let Some(excerpt) = cursor.item() {
1372 if excerpt.id == *excerpt_id && excerpt.buffer_id == buffer_id {
1373 let excerpt_buffer_start = excerpt.range.start.summary::<D>(&excerpt.buffer);
1374 summaries.extend(
1375 excerpt
1376 .buffer
1377 .summaries_for_anchors::<D, _>(excerpt_anchors)
1378 .map(move |summary| {
1379 let mut position = position.clone();
1380 let excerpt_buffer_start = excerpt_buffer_start.clone();
1381 if summary > excerpt_buffer_start {
1382 position.add_assign(&(summary - excerpt_buffer_start));
1383 }
1384 position
1385 }),
1386 );
1387 continue;
1388 }
1389 }
1390
1391 summaries.extend(excerpt_anchors.map(|_| position.clone()));
1392 }
1393
1394 summaries
1395 }
1396
1397 pub fn refresh_anchors<'a, I>(&'a self, anchors: I) -> Vec<(Anchor, bool)>
1398 where
1399 I: 'a + IntoIterator<Item = &'a Anchor>,
1400 {
1401 let mut anchors = anchors.into_iter().peekable();
1402 let mut cursor = self.excerpts.cursor::<Option<&ExcerptId>>();
1403 let mut result = Vec::new();
1404 while let Some(anchor) = anchors.peek() {
1405 let old_excerpt_id = &anchor.excerpt_id;
1406
1407 // Find the location where this anchor's excerpt should be.
1408 cursor.seek_forward(&Some(old_excerpt_id), Bias::Left, &());
1409 if cursor.item().is_none() {
1410 cursor.next(&());
1411 }
1412
1413 let next_excerpt = cursor.item();
1414 let prev_excerpt = cursor.prev_item();
1415
1416 // Process all of the anchors for this excerpt.
1417 while let Some(&anchor) = anchors.peek() {
1418 if anchor.excerpt_id != *old_excerpt_id {
1419 break;
1420 }
1421 let mut kept_position = false;
1422 let mut anchor = anchors.next().unwrap().clone();
1423
1424 // Leave min and max anchors unchanged.
1425 if *old_excerpt_id == ExcerptId::max() || *old_excerpt_id == ExcerptId::min() {
1426 kept_position = true;
1427 }
1428 // If the old excerpt still exists at this location, then leave
1429 // the anchor unchanged.
1430 else if next_excerpt.map_or(false, |excerpt| {
1431 excerpt.id == *old_excerpt_id && excerpt.buffer_id == anchor.buffer_id
1432 }) {
1433 kept_position = true;
1434 }
1435 // If the old excerpt no longer exists at this location, then attempt to
1436 // find an equivalent position for this anchor in an adjacent excerpt.
1437 else {
1438 for excerpt in [next_excerpt, prev_excerpt].iter().filter_map(|e| *e) {
1439 if excerpt.contains(&anchor) {
1440 anchor.excerpt_id = excerpt.id.clone();
1441 kept_position = true;
1442 break;
1443 }
1444 }
1445 }
1446 // If there's no adjacent excerpt that contains the anchor's position,
1447 // then report that the anchor has lost its position.
1448 if !kept_position {
1449 anchor = if let Some(excerpt) = next_excerpt {
1450 Anchor {
1451 buffer_id: excerpt.buffer_id,
1452 excerpt_id: excerpt.id.clone(),
1453 text_anchor: excerpt
1454 .buffer
1455 .anchor_at(&excerpt.range.start, anchor.text_anchor.bias),
1456 }
1457 } else if let Some(excerpt) = prev_excerpt {
1458 Anchor {
1459 buffer_id: excerpt.buffer_id,
1460 excerpt_id: excerpt.id.clone(),
1461 text_anchor: excerpt
1462 .buffer
1463 .anchor_at(&excerpt.range.end, anchor.text_anchor.bias),
1464 }
1465 } else if anchor.text_anchor.bias == Bias::Left {
1466 Anchor::min()
1467 } else {
1468 Anchor::max()
1469 };
1470 }
1471
1472 result.push((anchor, kept_position));
1473 }
1474 }
1475 result
1476 }
1477
1478 pub fn anchor_before<T: ToOffset>(&self, position: T) -> Anchor {
1479 self.anchor_at(position, Bias::Left)
1480 }
1481
1482 pub fn anchor_after<T: ToOffset>(&self, position: T) -> Anchor {
1483 self.anchor_at(position, Bias::Right)
1484 }
1485
1486 pub fn anchor_at<T: ToOffset>(&self, position: T, mut bias: Bias) -> Anchor {
1487 let offset = position.to_offset(self);
1488 let mut cursor = self.excerpts.cursor::<(usize, Option<&ExcerptId>)>();
1489 cursor.seek(&offset, Bias::Right, &());
1490 if cursor.item().is_none() && offset == cursor.start().0 && bias == Bias::Left {
1491 cursor.prev(&());
1492 }
1493 if let Some(excerpt) = cursor.item() {
1494 let mut overshoot = offset.saturating_sub(cursor.start().0);
1495 if excerpt.has_trailing_newline && offset == cursor.end(&()).0 {
1496 overshoot -= 1;
1497 bias = Bias::Right;
1498 }
1499
1500 let buffer_start = excerpt.range.start.to_offset(&excerpt.buffer);
1501 let text_anchor =
1502 excerpt.clip_anchor(excerpt.buffer.anchor_at(buffer_start + overshoot, bias));
1503 Anchor {
1504 buffer_id: excerpt.buffer_id,
1505 excerpt_id: excerpt.id.clone(),
1506 text_anchor,
1507 }
1508 } else if offset == 0 && bias == Bias::Left {
1509 Anchor::min()
1510 } else {
1511 Anchor::max()
1512 }
1513 }
1514
1515 pub fn anchor_in_excerpt(&self, excerpt_id: ExcerptId, text_anchor: text::Anchor) -> Anchor {
1516 let mut cursor = self.excerpts.cursor::<Option<&ExcerptId>>();
1517 cursor.seek(&Some(&excerpt_id), Bias::Left, &());
1518 if let Some(excerpt) = cursor.item() {
1519 if excerpt.id == excerpt_id {
1520 let text_anchor = excerpt.clip_anchor(text_anchor);
1521 drop(cursor);
1522 return Anchor {
1523 buffer_id: excerpt.buffer_id,
1524 excerpt_id,
1525 text_anchor,
1526 };
1527 }
1528 }
1529 panic!("excerpt not found");
1530 }
1531
1532 pub fn range_contains_excerpt_boundary<T: ToOffset>(&self, range: Range<T>) -> bool {
1533 let start = range.start.to_offset(self);
1534 let end = range.end.to_offset(self);
1535 let mut cursor = self.excerpts.cursor::<(usize, Option<&ExcerptId>)>();
1536 cursor.seek(&start, Bias::Right, &());
1537 let start_id = cursor
1538 .item()
1539 .or_else(|| cursor.prev_item())
1540 .map(|excerpt| &excerpt.id);
1541 cursor.seek_forward(&end, Bias::Right, &());
1542 let end_id = cursor
1543 .item()
1544 .or_else(|| cursor.prev_item())
1545 .map(|excerpt| &excerpt.id);
1546 start_id != end_id
1547 }
1548
1549 pub fn parse_count(&self) -> usize {
1550 self.parse_count
1551 }
1552
1553 pub fn enclosing_bracket_ranges<T: ToOffset>(
1554 &self,
1555 range: Range<T>,
1556 ) -> Option<(Range<usize>, Range<usize>)> {
1557 let range = range.start.to_offset(self)..range.end.to_offset(self);
1558
1559 let mut cursor = self.excerpts.cursor::<usize>();
1560 cursor.seek(&range.start, Bias::Right, &());
1561 let start_excerpt = cursor.item();
1562
1563 cursor.seek(&range.end, Bias::Right, &());
1564 let end_excerpt = cursor.item();
1565
1566 start_excerpt
1567 .zip(end_excerpt)
1568 .and_then(|(start_excerpt, end_excerpt)| {
1569 if start_excerpt.id != end_excerpt.id {
1570 return None;
1571 }
1572
1573 let excerpt_buffer_start =
1574 start_excerpt.range.start.to_offset(&start_excerpt.buffer);
1575 let excerpt_buffer_end = excerpt_buffer_start + start_excerpt.text_summary.bytes;
1576
1577 let start_in_buffer =
1578 excerpt_buffer_start + range.start.saturating_sub(*cursor.start());
1579 let end_in_buffer =
1580 excerpt_buffer_start + range.end.saturating_sub(*cursor.start());
1581 let (mut start_bracket_range, mut end_bracket_range) = start_excerpt
1582 .buffer
1583 .enclosing_bracket_ranges(start_in_buffer..end_in_buffer)?;
1584
1585 if start_bracket_range.start >= excerpt_buffer_start
1586 && end_bracket_range.end < excerpt_buffer_end
1587 {
1588 start_bracket_range.start =
1589 cursor.start() + (start_bracket_range.start - excerpt_buffer_start);
1590 start_bracket_range.end =
1591 cursor.start() + (start_bracket_range.end - excerpt_buffer_start);
1592 end_bracket_range.start =
1593 cursor.start() + (end_bracket_range.start - excerpt_buffer_start);
1594 end_bracket_range.end =
1595 cursor.start() + (end_bracket_range.end - excerpt_buffer_start);
1596 Some((start_bracket_range, end_bracket_range))
1597 } else {
1598 None
1599 }
1600 })
1601 }
1602
1603 pub fn diagnostics_update_count(&self) -> usize {
1604 self.diagnostics_update_count
1605 }
1606
1607 pub fn language(&self) -> Option<&Arc<Language>> {
1608 self.excerpts
1609 .iter()
1610 .next()
1611 .and_then(|excerpt| excerpt.buffer.language())
1612 }
1613
1614 pub fn is_dirty(&self) -> bool {
1615 self.is_dirty
1616 }
1617
1618 pub fn has_conflict(&self) -> bool {
1619 self.has_conflict
1620 }
1621
1622 pub fn diagnostic_group<'a, O>(
1623 &'a self,
1624 group_id: usize,
1625 ) -> impl Iterator<Item = DiagnosticEntry<O>> + 'a
1626 where
1627 O: text::FromAnchor + 'a,
1628 {
1629 self.as_singleton()
1630 .into_iter()
1631 .flat_map(move |buffer| buffer.diagnostic_group(group_id))
1632 }
1633
1634 pub fn diagnostics_in_range<'a, T, O>(
1635 &'a self,
1636 range: Range<T>,
1637 ) -> impl Iterator<Item = DiagnosticEntry<O>> + 'a
1638 where
1639 T: 'a + ToOffset,
1640 O: 'a + text::FromAnchor,
1641 {
1642 self.as_singleton().into_iter().flat_map(move |buffer| {
1643 buffer.diagnostics_in_range(range.start.to_offset(self)..range.end.to_offset(self))
1644 })
1645 }
1646
1647 pub fn range_for_syntax_ancestor<T: ToOffset>(&self, range: Range<T>) -> Option<Range<usize>> {
1648 let range = range.start.to_offset(self)..range.end.to_offset(self);
1649
1650 let mut cursor = self.excerpts.cursor::<usize>();
1651 cursor.seek(&range.start, Bias::Right, &());
1652 let start_excerpt = cursor.item();
1653
1654 cursor.seek(&range.end, Bias::Right, &());
1655 let end_excerpt = cursor.item();
1656
1657 start_excerpt
1658 .zip(end_excerpt)
1659 .and_then(|(start_excerpt, end_excerpt)| {
1660 if start_excerpt.id != end_excerpt.id {
1661 return None;
1662 }
1663
1664 let excerpt_buffer_start =
1665 start_excerpt.range.start.to_offset(&start_excerpt.buffer);
1666 let excerpt_buffer_end = excerpt_buffer_start + start_excerpt.text_summary.bytes;
1667
1668 let start_in_buffer =
1669 excerpt_buffer_start + range.start.saturating_sub(*cursor.start());
1670 let end_in_buffer =
1671 excerpt_buffer_start + range.end.saturating_sub(*cursor.start());
1672 let mut ancestor_buffer_range = start_excerpt
1673 .buffer
1674 .range_for_syntax_ancestor(start_in_buffer..end_in_buffer)?;
1675 ancestor_buffer_range.start =
1676 cmp::max(ancestor_buffer_range.start, excerpt_buffer_start);
1677 ancestor_buffer_range.end = cmp::min(ancestor_buffer_range.end, excerpt_buffer_end);
1678
1679 let start = cursor.start() + (ancestor_buffer_range.start - excerpt_buffer_start);
1680 let end = cursor.start() + (ancestor_buffer_range.end - excerpt_buffer_start);
1681 Some(start..end)
1682 })
1683 }
1684
1685 fn buffer_snapshot_for_excerpt<'a>(
1686 &'a self,
1687 excerpt_id: &'a ExcerptId,
1688 ) -> Option<(usize, &'a BufferSnapshot)> {
1689 let mut cursor = self.excerpts.cursor::<Option<&ExcerptId>>();
1690 cursor.seek(&Some(excerpt_id), Bias::Left, &());
1691 if let Some(excerpt) = cursor.item() {
1692 if excerpt.id == *excerpt_id {
1693 return Some((excerpt.buffer_id, &excerpt.buffer));
1694 }
1695 }
1696 None
1697 }
1698
1699 pub fn remote_selections_in_range<'a>(
1700 &'a self,
1701 range: &'a Range<Anchor>,
1702 ) -> impl 'a + Iterator<Item = (ReplicaId, Selection<Anchor>)> {
1703 let mut cursor = self.excerpts.cursor::<Option<&ExcerptId>>();
1704 cursor.seek(&Some(&range.start.excerpt_id), Bias::Left, &());
1705 cursor
1706 .take_while(move |excerpt| excerpt.id <= range.end.excerpt_id)
1707 .flat_map(move |excerpt| {
1708 let mut query_range = excerpt.range.start.clone()..excerpt.range.end.clone();
1709 if excerpt.id == range.start.excerpt_id {
1710 query_range.start = range.start.text_anchor.clone();
1711 }
1712 if excerpt.id == range.end.excerpt_id {
1713 query_range.end = range.end.text_anchor.clone();
1714 }
1715
1716 excerpt
1717 .buffer
1718 .remote_selections_in_range(query_range)
1719 .flat_map(move |(replica_id, selections)| {
1720 selections.map(move |selection| {
1721 let mut start = Anchor {
1722 buffer_id: excerpt.buffer_id,
1723 excerpt_id: excerpt.id.clone(),
1724 text_anchor: selection.start.clone(),
1725 };
1726 let mut end = Anchor {
1727 buffer_id: excerpt.buffer_id,
1728 excerpt_id: excerpt.id.clone(),
1729 text_anchor: selection.end.clone(),
1730 };
1731 if range.start.cmp(&start, self).unwrap().is_gt() {
1732 start = range.start.clone();
1733 }
1734 if range.end.cmp(&end, self).unwrap().is_lt() {
1735 end = range.end.clone();
1736 }
1737
1738 (
1739 replica_id,
1740 Selection {
1741 id: selection.id,
1742 start,
1743 end,
1744 reversed: selection.reversed,
1745 goal: selection.goal,
1746 },
1747 )
1748 })
1749 })
1750 })
1751 }
1752}
1753
1754impl History {
1755 fn start_transaction(&mut self, now: Instant) -> Option<TransactionId> {
1756 self.transaction_depth += 1;
1757 if self.transaction_depth == 1 {
1758 let id = post_inc(&mut self.next_transaction_id);
1759 self.undo_stack.push(Transaction {
1760 id,
1761 buffer_transactions: Default::default(),
1762 first_edit_at: now,
1763 last_edit_at: now,
1764 });
1765 Some(id)
1766 } else {
1767 None
1768 }
1769 }
1770
1771 fn end_transaction(
1772 &mut self,
1773 now: Instant,
1774 buffer_transactions: HashSet<(usize, TransactionId)>,
1775 ) -> bool {
1776 assert_ne!(self.transaction_depth, 0);
1777 self.transaction_depth -= 1;
1778 if self.transaction_depth == 0 {
1779 if buffer_transactions.is_empty() {
1780 self.undo_stack.pop();
1781 false
1782 } else {
1783 let transaction = self.undo_stack.last_mut().unwrap();
1784 transaction.last_edit_at = now;
1785 transaction.buffer_transactions.extend(buffer_transactions);
1786 true
1787 }
1788 } else {
1789 false
1790 }
1791 }
1792
1793 fn pop_undo(&mut self) -> Option<&Transaction> {
1794 assert_eq!(self.transaction_depth, 0);
1795 if let Some(transaction) = self.undo_stack.pop() {
1796 self.redo_stack.push(transaction);
1797 self.redo_stack.last()
1798 } else {
1799 None
1800 }
1801 }
1802
1803 fn pop_redo(&mut self) -> Option<&Transaction> {
1804 assert_eq!(self.transaction_depth, 0);
1805 if let Some(transaction) = self.redo_stack.pop() {
1806 self.undo_stack.push(transaction);
1807 self.undo_stack.last()
1808 } else {
1809 None
1810 }
1811 }
1812
1813 fn group(&mut self) -> Option<TransactionId> {
1814 let mut new_len = self.undo_stack.len();
1815 let mut transactions = self.undo_stack.iter_mut();
1816
1817 if let Some(mut transaction) = transactions.next_back() {
1818 while let Some(prev_transaction) = transactions.next_back() {
1819 if transaction.first_edit_at - prev_transaction.last_edit_at <= self.group_interval
1820 {
1821 transaction = prev_transaction;
1822 new_len -= 1;
1823 } else {
1824 break;
1825 }
1826 }
1827 }
1828
1829 let (transactions_to_keep, transactions_to_merge) = self.undo_stack.split_at_mut(new_len);
1830 if let Some(last_transaction) = transactions_to_keep.last_mut() {
1831 if let Some(transaction) = transactions_to_merge.last() {
1832 last_transaction.last_edit_at = transaction.last_edit_at;
1833 }
1834 }
1835
1836 self.undo_stack.truncate(new_len);
1837 self.undo_stack.last().map(|t| t.id)
1838 }
1839}
1840
1841impl Excerpt {
1842 fn new(
1843 id: ExcerptId,
1844 buffer_id: usize,
1845 buffer: BufferSnapshot,
1846 range: Range<text::Anchor>,
1847 has_trailing_newline: bool,
1848 ) -> Self {
1849 Excerpt {
1850 id,
1851 max_buffer_row: range.end.to_point(&buffer).row,
1852 text_summary: buffer.text_summary_for_range::<TextSummary, _>(range.to_offset(&buffer)),
1853 buffer_id,
1854 buffer,
1855 range,
1856 has_trailing_newline,
1857 }
1858 }
1859
1860 fn chunks_in_range<'a>(
1861 &'a self,
1862 range: Range<usize>,
1863 theme: Option<&'a SyntaxTheme>,
1864 ) -> ExcerptChunks<'a> {
1865 let content_start = self.range.start.to_offset(&self.buffer);
1866 let chunks_start = content_start + range.start;
1867 let chunks_end = content_start + cmp::min(range.end, self.text_summary.bytes);
1868
1869 let footer_height = if self.has_trailing_newline
1870 && range.start <= self.text_summary.bytes
1871 && range.end > self.text_summary.bytes
1872 {
1873 1
1874 } else {
1875 0
1876 };
1877
1878 let content_chunks = self.buffer.chunks(chunks_start..chunks_end, theme);
1879
1880 ExcerptChunks {
1881 content_chunks,
1882 footer_height,
1883 }
1884 }
1885
1886 fn bytes_in_range(&self, range: Range<usize>) -> ExcerptBytes {
1887 let content_start = self.range.start.to_offset(&self.buffer);
1888 let bytes_start = content_start + range.start;
1889 let bytes_end = content_start + cmp::min(range.end, self.text_summary.bytes);
1890 let footer_height = if self.has_trailing_newline
1891 && range.start <= self.text_summary.bytes
1892 && range.end > self.text_summary.bytes
1893 {
1894 1
1895 } else {
1896 0
1897 };
1898 let content_bytes = self.buffer.bytes_in_range(bytes_start..bytes_end);
1899
1900 ExcerptBytes {
1901 content_bytes,
1902 footer_height,
1903 }
1904 }
1905
1906 fn clip_anchor(&self, text_anchor: text::Anchor) -> text::Anchor {
1907 if text_anchor
1908 .cmp(&self.range.start, &self.buffer)
1909 .unwrap()
1910 .is_lt()
1911 {
1912 self.range.start.clone()
1913 } else if text_anchor
1914 .cmp(&self.range.end, &self.buffer)
1915 .unwrap()
1916 .is_gt()
1917 {
1918 self.range.end.clone()
1919 } else {
1920 text_anchor
1921 }
1922 }
1923
1924 fn contains(&self, anchor: &Anchor) -> bool {
1925 self.buffer_id == anchor.buffer_id
1926 && self
1927 .range
1928 .start
1929 .cmp(&anchor.text_anchor, &self.buffer)
1930 .unwrap()
1931 .is_le()
1932 && self
1933 .range
1934 .end
1935 .cmp(&anchor.text_anchor, &self.buffer)
1936 .unwrap()
1937 .is_ge()
1938 }
1939}
1940
1941impl fmt::Debug for Excerpt {
1942 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1943 f.debug_struct("Excerpt")
1944 .field("id", &self.id)
1945 .field("buffer_id", &self.buffer_id)
1946 .field("range", &self.range)
1947 .field("text_summary", &self.text_summary)
1948 .field("has_trailing_newline", &self.has_trailing_newline)
1949 .finish()
1950 }
1951}
1952
1953impl sum_tree::Item for Excerpt {
1954 type Summary = ExcerptSummary;
1955
1956 fn summary(&self) -> Self::Summary {
1957 let mut text = self.text_summary.clone();
1958 if self.has_trailing_newline {
1959 text += TextSummary::from("\n");
1960 }
1961 ExcerptSummary {
1962 excerpt_id: self.id.clone(),
1963 max_buffer_row: self.max_buffer_row,
1964 text,
1965 }
1966 }
1967}
1968
1969impl sum_tree::Summary for ExcerptSummary {
1970 type Context = ();
1971
1972 fn add_summary(&mut self, summary: &Self, _: &()) {
1973 debug_assert!(summary.excerpt_id > self.excerpt_id);
1974 self.excerpt_id = summary.excerpt_id.clone();
1975 self.text.add_summary(&summary.text, &());
1976 self.max_buffer_row = cmp::max(self.max_buffer_row, summary.max_buffer_row);
1977 }
1978}
1979
1980impl<'a> sum_tree::Dimension<'a, ExcerptSummary> for TextSummary {
1981 fn add_summary(&mut self, summary: &'a ExcerptSummary, _: &()) {
1982 *self += &summary.text;
1983 }
1984}
1985
1986impl<'a> sum_tree::Dimension<'a, ExcerptSummary> for usize {
1987 fn add_summary(&mut self, summary: &'a ExcerptSummary, _: &()) {
1988 *self += summary.text.bytes;
1989 }
1990}
1991
1992impl<'a> sum_tree::SeekTarget<'a, ExcerptSummary, ExcerptSummary> for usize {
1993 fn cmp(&self, cursor_location: &ExcerptSummary, _: &()) -> cmp::Ordering {
1994 Ord::cmp(self, &cursor_location.text.bytes)
1995 }
1996}
1997
1998impl<'a> sum_tree::SeekTarget<'a, ExcerptSummary, ExcerptSummary> for Option<&'a ExcerptId> {
1999 fn cmp(&self, cursor_location: &ExcerptSummary, _: &()) -> cmp::Ordering {
2000 Ord::cmp(self, &Some(&cursor_location.excerpt_id))
2001 }
2002}
2003
2004impl<'a> sum_tree::Dimension<'a, ExcerptSummary> for Point {
2005 fn add_summary(&mut self, summary: &'a ExcerptSummary, _: &()) {
2006 *self += summary.text.lines;
2007 }
2008}
2009
2010impl<'a> sum_tree::Dimension<'a, ExcerptSummary> for PointUtf16 {
2011 fn add_summary(&mut self, summary: &'a ExcerptSummary, _: &()) {
2012 *self += summary.text.lines_utf16
2013 }
2014}
2015
2016impl<'a> sum_tree::Dimension<'a, ExcerptSummary> for Option<&'a ExcerptId> {
2017 fn add_summary(&mut self, summary: &'a ExcerptSummary, _: &()) {
2018 *self = Some(&summary.excerpt_id);
2019 }
2020}
2021
2022impl<'a> MultiBufferRows<'a> {
2023 pub fn seek(&mut self, row: u32) {
2024 self.buffer_row_range = 0..0;
2025
2026 self.excerpts
2027 .seek_forward(&Point::new(row, 0), Bias::Right, &());
2028 if self.excerpts.item().is_none() {
2029 self.excerpts.prev(&());
2030
2031 if self.excerpts.item().is_none() && row == 0 {
2032 self.buffer_row_range = 0..1;
2033 return;
2034 }
2035 }
2036
2037 if let Some(excerpt) = self.excerpts.item() {
2038 let overshoot = row - self.excerpts.start().row;
2039 let excerpt_start = excerpt.range.start.to_point(&excerpt.buffer).row;
2040 self.buffer_row_range.start = excerpt_start + overshoot;
2041 self.buffer_row_range.end = excerpt_start + excerpt.text_summary.lines.row + 1;
2042 }
2043 }
2044}
2045
2046impl<'a> Iterator for MultiBufferRows<'a> {
2047 type Item = Option<u32>;
2048
2049 fn next(&mut self) -> Option<Self::Item> {
2050 loop {
2051 if !self.buffer_row_range.is_empty() {
2052 let row = Some(self.buffer_row_range.start);
2053 self.buffer_row_range.start += 1;
2054 return Some(row);
2055 }
2056 self.excerpts.item()?;
2057 self.excerpts.next(&());
2058 let excerpt = self.excerpts.item()?;
2059 self.buffer_row_range.start = excerpt.range.start.to_point(&excerpt.buffer).row;
2060 self.buffer_row_range.end =
2061 self.buffer_row_range.start + excerpt.text_summary.lines.row + 1;
2062 }
2063 }
2064}
2065
2066impl<'a> MultiBufferChunks<'a> {
2067 pub fn offset(&self) -> usize {
2068 self.range.start
2069 }
2070
2071 pub fn seek(&mut self, offset: usize) {
2072 self.range.start = offset;
2073 self.excerpts.seek(&offset, Bias::Right, &());
2074 if let Some(excerpt) = self.excerpts.item() {
2075 self.excerpt_chunks = Some(excerpt.chunks_in_range(
2076 self.range.start - self.excerpts.start()..self.range.end - self.excerpts.start(),
2077 self.theme,
2078 ));
2079 } else {
2080 self.excerpt_chunks = None;
2081 }
2082 }
2083}
2084
2085impl<'a> Iterator for MultiBufferChunks<'a> {
2086 type Item = Chunk<'a>;
2087
2088 fn next(&mut self) -> Option<Self::Item> {
2089 if self.range.is_empty() {
2090 None
2091 } else if let Some(chunk) = self.excerpt_chunks.as_mut()?.next() {
2092 self.range.start += chunk.text.len();
2093 Some(chunk)
2094 } else {
2095 self.excerpts.next(&());
2096 let excerpt = self.excerpts.item()?;
2097 self.excerpt_chunks = Some(
2098 excerpt.chunks_in_range(0..self.range.end - self.excerpts.start(), self.theme),
2099 );
2100 self.next()
2101 }
2102 }
2103}
2104
2105impl<'a> MultiBufferBytes<'a> {
2106 fn consume(&mut self, len: usize) {
2107 self.range.start += len;
2108 self.chunk = &self.chunk[len..];
2109
2110 if !self.range.is_empty() && self.chunk.is_empty() {
2111 if let Some(chunk) = self.excerpt_bytes.as_mut().and_then(|bytes| bytes.next()) {
2112 self.chunk = chunk;
2113 } else {
2114 self.excerpts.next(&());
2115 if let Some(excerpt) = self.excerpts.item() {
2116 let mut excerpt_bytes =
2117 excerpt.bytes_in_range(0..self.range.end - self.excerpts.start());
2118 self.chunk = excerpt_bytes.next().unwrap();
2119 self.excerpt_bytes = Some(excerpt_bytes);
2120 }
2121 }
2122 }
2123 }
2124}
2125
2126impl<'a> Iterator for MultiBufferBytes<'a> {
2127 type Item = &'a [u8];
2128
2129 fn next(&mut self) -> Option<Self::Item> {
2130 let chunk = self.chunk;
2131 if chunk.is_empty() {
2132 None
2133 } else {
2134 self.consume(chunk.len());
2135 Some(chunk)
2136 }
2137 }
2138}
2139
2140impl<'a> io::Read for MultiBufferBytes<'a> {
2141 fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
2142 let len = cmp::min(buf.len(), self.chunk.len());
2143 buf[..len].copy_from_slice(&self.chunk[..len]);
2144 if len > 0 {
2145 self.consume(len);
2146 }
2147 Ok(len)
2148 }
2149}
2150
2151impl<'a> Iterator for ExcerptBytes<'a> {
2152 type Item = &'a [u8];
2153
2154 fn next(&mut self) -> Option<Self::Item> {
2155 if let Some(chunk) = self.content_bytes.next() {
2156 if !chunk.is_empty() {
2157 return Some(chunk);
2158 }
2159 }
2160
2161 if self.footer_height > 0 {
2162 let result = &NEWLINES[..self.footer_height];
2163 self.footer_height = 0;
2164 return Some(result);
2165 }
2166
2167 None
2168 }
2169}
2170
2171impl<'a> Iterator for ExcerptChunks<'a> {
2172 type Item = Chunk<'a>;
2173
2174 fn next(&mut self) -> Option<Self::Item> {
2175 if let Some(chunk) = self.content_chunks.next() {
2176 return Some(chunk);
2177 }
2178
2179 if self.footer_height > 0 {
2180 let text = unsafe { str::from_utf8_unchecked(&NEWLINES[..self.footer_height]) };
2181 self.footer_height = 0;
2182 return Some(Chunk {
2183 text,
2184 ..Default::default()
2185 });
2186 }
2187
2188 None
2189 }
2190}
2191
2192impl ToOffset for Point {
2193 fn to_offset<'a>(&self, snapshot: &MultiBufferSnapshot) -> usize {
2194 snapshot.point_to_offset(*self)
2195 }
2196}
2197
2198impl ToOffset for PointUtf16 {
2199 fn to_offset<'a>(&self, snapshot: &MultiBufferSnapshot) -> usize {
2200 snapshot.point_utf16_to_offset(*self)
2201 }
2202}
2203
2204impl ToOffset for usize {
2205 fn to_offset<'a>(&self, snapshot: &MultiBufferSnapshot) -> usize {
2206 assert!(*self <= snapshot.len(), "offset is out of range");
2207 *self
2208 }
2209}
2210
2211impl ToPoint for usize {
2212 fn to_point<'a>(&self, snapshot: &MultiBufferSnapshot) -> Point {
2213 snapshot.offset_to_point(*self)
2214 }
2215}
2216
2217impl ToPoint for Point {
2218 fn to_point<'a>(&self, _: &MultiBufferSnapshot) -> Point {
2219 *self
2220 }
2221}
2222
2223#[cfg(test)]
2224mod tests {
2225 use super::*;
2226 use gpui::MutableAppContext;
2227 use language::{Buffer, Rope};
2228 use rand::prelude::*;
2229 use std::env;
2230 use text::{Point, RandomCharIter};
2231 use util::test::sample_text;
2232
2233 #[gpui::test]
2234 fn test_singleton_multibuffer(cx: &mut MutableAppContext) {
2235 let buffer = cx.add_model(|cx| Buffer::new(0, sample_text(6, 6, 'a'), cx));
2236 let multibuffer = cx.add_model(|cx| MultiBuffer::singleton(buffer.clone(), cx));
2237
2238 let snapshot = multibuffer.read(cx).snapshot(cx);
2239 assert_eq!(snapshot.text(), buffer.read(cx).text());
2240
2241 assert_eq!(
2242 snapshot.buffer_rows(0).collect::<Vec<_>>(),
2243 (0..buffer.read(cx).row_count())
2244 .map(Some)
2245 .collect::<Vec<_>>()
2246 );
2247
2248 buffer.update(cx, |buffer, cx| buffer.edit([1..3], "XXX\n", cx));
2249 let snapshot = multibuffer.read(cx).snapshot(cx);
2250
2251 assert_eq!(snapshot.text(), buffer.read(cx).text());
2252 assert_eq!(
2253 snapshot.buffer_rows(0).collect::<Vec<_>>(),
2254 (0..buffer.read(cx).row_count())
2255 .map(Some)
2256 .collect::<Vec<_>>()
2257 );
2258 }
2259
2260 #[gpui::test]
2261 fn test_remote_multibuffer(cx: &mut MutableAppContext) {
2262 let host_buffer = cx.add_model(|cx| Buffer::new(0, "a", cx));
2263 let guest_buffer = cx.add_model(|cx| {
2264 let message = host_buffer.read(cx).to_proto();
2265 Buffer::from_proto(1, message, None, cx).unwrap()
2266 });
2267 let multibuffer = cx.add_model(|cx| MultiBuffer::singleton(guest_buffer.clone(), cx));
2268 let snapshot = multibuffer.read(cx).snapshot(cx);
2269 assert_eq!(snapshot.text(), "a");
2270
2271 guest_buffer.update(cx, |buffer, cx| buffer.edit([1..1], "b", cx));
2272 let snapshot = multibuffer.read(cx).snapshot(cx);
2273 assert_eq!(snapshot.text(), "ab");
2274
2275 guest_buffer.update(cx, |buffer, cx| buffer.edit([2..2], "c", cx));
2276 let snapshot = multibuffer.read(cx).snapshot(cx);
2277 assert_eq!(snapshot.text(), "abc");
2278 }
2279
2280 #[gpui::test]
2281 fn test_excerpt_buffer(cx: &mut MutableAppContext) {
2282 let buffer_1 = cx.add_model(|cx| Buffer::new(0, sample_text(6, 6, 'a'), cx));
2283 let buffer_2 = cx.add_model(|cx| Buffer::new(0, sample_text(6, 6, 'g'), cx));
2284 let multibuffer = cx.add_model(|_| MultiBuffer::new(0));
2285
2286 let subscription = multibuffer.update(cx, |multibuffer, cx| {
2287 let subscription = multibuffer.subscribe();
2288 multibuffer.push_excerpt(
2289 ExcerptProperties {
2290 buffer: &buffer_1,
2291 range: Point::new(1, 2)..Point::new(2, 5),
2292 },
2293 cx,
2294 );
2295 assert_eq!(
2296 subscription.consume().into_inner(),
2297 [Edit {
2298 old: 0..0,
2299 new: 0..10
2300 }]
2301 );
2302
2303 multibuffer.push_excerpt(
2304 ExcerptProperties {
2305 buffer: &buffer_1,
2306 range: Point::new(3, 3)..Point::new(4, 4),
2307 },
2308 cx,
2309 );
2310 multibuffer.push_excerpt(
2311 ExcerptProperties {
2312 buffer: &buffer_2,
2313 range: Point::new(3, 1)..Point::new(3, 3),
2314 },
2315 cx,
2316 );
2317 assert_eq!(
2318 subscription.consume().into_inner(),
2319 [Edit {
2320 old: 10..10,
2321 new: 10..22
2322 }]
2323 );
2324
2325 subscription
2326 });
2327
2328 let snapshot = multibuffer.read(cx).snapshot(cx);
2329 assert_eq!(
2330 snapshot.text(),
2331 concat!(
2332 "bbbb\n", // Preserve newlines
2333 "ccccc\n", //
2334 "ddd\n", //
2335 "eeee\n", //
2336 "jj" //
2337 )
2338 );
2339 assert_eq!(
2340 snapshot.buffer_rows(0).collect::<Vec<_>>(),
2341 [Some(1), Some(2), Some(3), Some(4), Some(3)]
2342 );
2343 assert_eq!(
2344 snapshot.buffer_rows(2).collect::<Vec<_>>(),
2345 [Some(3), Some(4), Some(3)]
2346 );
2347 assert_eq!(snapshot.buffer_rows(4).collect::<Vec<_>>(), [Some(3)]);
2348 assert_eq!(snapshot.buffer_rows(5).collect::<Vec<_>>(), []);
2349 assert!(!snapshot.range_contains_excerpt_boundary(Point::new(1, 0)..Point::new(1, 5)));
2350 assert!(snapshot.range_contains_excerpt_boundary(Point::new(1, 0)..Point::new(2, 0)));
2351 assert!(snapshot.range_contains_excerpt_boundary(Point::new(1, 0)..Point::new(4, 0)));
2352 assert!(!snapshot.range_contains_excerpt_boundary(Point::new(2, 0)..Point::new(3, 0)));
2353 assert!(!snapshot.range_contains_excerpt_boundary(Point::new(4, 0)..Point::new(4, 2)));
2354 assert!(!snapshot.range_contains_excerpt_boundary(Point::new(4, 2)..Point::new(4, 2)));
2355
2356 buffer_1.update(cx, |buffer, cx| {
2357 buffer.edit(
2358 [
2359 Point::new(0, 0)..Point::new(0, 0),
2360 Point::new(2, 1)..Point::new(2, 3),
2361 ],
2362 "\n",
2363 cx,
2364 );
2365 });
2366
2367 let snapshot = multibuffer.read(cx).snapshot(cx);
2368 assert_eq!(
2369 snapshot.text(),
2370 concat!(
2371 "bbbb\n", // Preserve newlines
2372 "c\n", //
2373 "cc\n", //
2374 "ddd\n", //
2375 "eeee\n", //
2376 "jj" //
2377 )
2378 );
2379
2380 assert_eq!(
2381 subscription.consume().into_inner(),
2382 [Edit {
2383 old: 6..8,
2384 new: 6..7
2385 }]
2386 );
2387
2388 let snapshot = multibuffer.read(cx).snapshot(cx);
2389 assert_eq!(
2390 snapshot.clip_point(Point::new(0, 5), Bias::Left),
2391 Point::new(0, 4)
2392 );
2393 assert_eq!(
2394 snapshot.clip_point(Point::new(0, 5), Bias::Right),
2395 Point::new(0, 4)
2396 );
2397 assert_eq!(
2398 snapshot.clip_point(Point::new(5, 1), Bias::Right),
2399 Point::new(5, 1)
2400 );
2401 assert_eq!(
2402 snapshot.clip_point(Point::new(5, 2), Bias::Right),
2403 Point::new(5, 2)
2404 );
2405 assert_eq!(
2406 snapshot.clip_point(Point::new(5, 3), Bias::Right),
2407 Point::new(5, 2)
2408 );
2409
2410 let snapshot = multibuffer.update(cx, |multibuffer, cx| {
2411 let buffer_2_excerpt_id = multibuffer.excerpt_ids_for_buffer(&buffer_2)[0].clone();
2412 multibuffer.remove_excerpts(&[buffer_2_excerpt_id], cx);
2413 multibuffer.snapshot(cx)
2414 });
2415
2416 assert_eq!(
2417 snapshot.text(),
2418 concat!(
2419 "bbbb\n", // Preserve newlines
2420 "c\n", //
2421 "cc\n", //
2422 "ddd\n", //
2423 "eeee", //
2424 )
2425 );
2426 }
2427
2428 #[gpui::test]
2429 fn test_empty_excerpt_buffer(cx: &mut MutableAppContext) {
2430 let multibuffer = cx.add_model(|_| MultiBuffer::new(0));
2431
2432 let snapshot = multibuffer.read(cx).snapshot(cx);
2433 assert_eq!(snapshot.text(), "");
2434 assert_eq!(snapshot.buffer_rows(0).collect::<Vec<_>>(), &[Some(0)]);
2435 assert_eq!(snapshot.buffer_rows(1).collect::<Vec<_>>(), &[]);
2436 }
2437
2438 #[gpui::test]
2439 fn test_singleton_multibuffer_anchors(cx: &mut MutableAppContext) {
2440 let buffer = cx.add_model(|cx| Buffer::new(0, "abcd", cx));
2441 let multibuffer = cx.add_model(|cx| MultiBuffer::singleton(buffer.clone(), cx));
2442 let old_snapshot = multibuffer.read(cx).snapshot(cx);
2443 buffer.update(cx, |buffer, cx| {
2444 buffer.edit([0..0], "X", cx);
2445 buffer.edit([5..5], "Y", cx);
2446 });
2447 let new_snapshot = multibuffer.read(cx).snapshot(cx);
2448
2449 assert_eq!(old_snapshot.text(), "abcd");
2450 assert_eq!(new_snapshot.text(), "XabcdY");
2451
2452 assert_eq!(old_snapshot.anchor_before(0).to_offset(&new_snapshot), 0);
2453 assert_eq!(old_snapshot.anchor_after(0).to_offset(&new_snapshot), 1);
2454 assert_eq!(old_snapshot.anchor_before(4).to_offset(&new_snapshot), 5);
2455 assert_eq!(old_snapshot.anchor_after(4).to_offset(&new_snapshot), 6);
2456 }
2457
2458 #[gpui::test]
2459 fn test_multibuffer_anchors(cx: &mut MutableAppContext) {
2460 let buffer_1 = cx.add_model(|cx| Buffer::new(0, "abcd", cx));
2461 let buffer_2 = cx.add_model(|cx| Buffer::new(0, "efghi", cx));
2462 let multibuffer = cx.add_model(|cx| {
2463 let mut multibuffer = MultiBuffer::new(0);
2464 multibuffer.push_excerpt(
2465 ExcerptProperties {
2466 buffer: &buffer_1,
2467 range: 0..4,
2468 },
2469 cx,
2470 );
2471 multibuffer.push_excerpt(
2472 ExcerptProperties {
2473 buffer: &buffer_2,
2474 range: 0..5,
2475 },
2476 cx,
2477 );
2478 multibuffer
2479 });
2480 let old_snapshot = multibuffer.read(cx).snapshot(cx);
2481
2482 assert_eq!(old_snapshot.anchor_before(0).to_offset(&old_snapshot), 0);
2483 assert_eq!(old_snapshot.anchor_after(0).to_offset(&old_snapshot), 0);
2484 assert_eq!(Anchor::min().to_offset(&old_snapshot), 0);
2485 assert_eq!(Anchor::min().to_offset(&old_snapshot), 0);
2486 assert_eq!(Anchor::max().to_offset(&old_snapshot), 10);
2487 assert_eq!(Anchor::max().to_offset(&old_snapshot), 10);
2488
2489 buffer_1.update(cx, |buffer, cx| {
2490 buffer.edit([0..0], "W", cx);
2491 buffer.edit([5..5], "X", cx);
2492 });
2493 buffer_2.update(cx, |buffer, cx| {
2494 buffer.edit([0..0], "Y", cx);
2495 buffer.edit([6..0], "Z", cx);
2496 });
2497 let new_snapshot = multibuffer.read(cx).snapshot(cx);
2498
2499 assert_eq!(old_snapshot.text(), "abcd\nefghi");
2500 assert_eq!(new_snapshot.text(), "WabcdX\nYefghiZ");
2501
2502 assert_eq!(old_snapshot.anchor_before(0).to_offset(&new_snapshot), 0);
2503 assert_eq!(old_snapshot.anchor_after(0).to_offset(&new_snapshot), 1);
2504 assert_eq!(old_snapshot.anchor_before(1).to_offset(&new_snapshot), 2);
2505 assert_eq!(old_snapshot.anchor_after(1).to_offset(&new_snapshot), 2);
2506 assert_eq!(old_snapshot.anchor_before(2).to_offset(&new_snapshot), 3);
2507 assert_eq!(old_snapshot.anchor_after(2).to_offset(&new_snapshot), 3);
2508 assert_eq!(old_snapshot.anchor_before(5).to_offset(&new_snapshot), 7);
2509 assert_eq!(old_snapshot.anchor_after(5).to_offset(&new_snapshot), 8);
2510 assert_eq!(old_snapshot.anchor_before(10).to_offset(&new_snapshot), 13);
2511 assert_eq!(old_snapshot.anchor_after(10).to_offset(&new_snapshot), 14);
2512 }
2513
2514 #[gpui::test]
2515 fn test_multibuffer_resolving_anchors_after_replacing_their_excerpts(
2516 cx: &mut MutableAppContext,
2517 ) {
2518 let buffer_1 = cx.add_model(|cx| Buffer::new(0, "abcd", cx));
2519 let buffer_2 = cx.add_model(|cx| Buffer::new(0, "ABCDEFGHIJKLMNOP", cx));
2520 let multibuffer = cx.add_model(|_| MultiBuffer::new(0));
2521
2522 // Create an insertion id in buffer 1 that doesn't exist in buffer 2.
2523 // Add an excerpt from buffer 1 that spans this new insertion.
2524 buffer_1.update(cx, |buffer, cx| buffer.edit([4..4], "123", cx));
2525 let excerpt_id_1 = multibuffer.update(cx, |multibuffer, cx| {
2526 multibuffer.push_excerpt(
2527 ExcerptProperties {
2528 buffer: &buffer_1,
2529 range: 0..7,
2530 },
2531 cx,
2532 )
2533 });
2534
2535 let snapshot_1 = multibuffer.read(cx).snapshot(cx);
2536 assert_eq!(snapshot_1.text(), "abcd123");
2537
2538 // Replace the buffer 1 excerpt with new excerpts from buffer 2.
2539 let (excerpt_id_2, excerpt_id_3, _) = multibuffer.update(cx, |multibuffer, cx| {
2540 multibuffer.remove_excerpts([&excerpt_id_1], cx);
2541 (
2542 multibuffer.push_excerpt(
2543 ExcerptProperties {
2544 buffer: &buffer_2,
2545 range: 0..4,
2546 },
2547 cx,
2548 ),
2549 multibuffer.push_excerpt(
2550 ExcerptProperties {
2551 buffer: &buffer_2,
2552 range: 6..10,
2553 },
2554 cx,
2555 ),
2556 multibuffer.push_excerpt(
2557 ExcerptProperties {
2558 buffer: &buffer_2,
2559 range: 12..16,
2560 },
2561 cx,
2562 ),
2563 )
2564 });
2565 let snapshot_2 = multibuffer.read(cx).snapshot(cx);
2566 assert_eq!(snapshot_2.text(), "ABCD\nGHIJ\nMNOP");
2567
2568 // The old excerpt id has been reused.
2569 assert_eq!(excerpt_id_2, excerpt_id_1);
2570
2571 // Resolve some anchors from the previous snapshot in the new snapshot.
2572 // Although there is still an excerpt with the same id, it is for
2573 // a different buffer, so we don't attempt to resolve the old text
2574 // anchor in the new buffer.
2575 assert_eq!(
2576 snapshot_2.summary_for_anchor::<usize>(&snapshot_1.anchor_before(2)),
2577 0
2578 );
2579 assert_eq!(
2580 snapshot_2.summaries_for_anchors::<usize, _>(&[
2581 snapshot_1.anchor_before(2),
2582 snapshot_1.anchor_after(3)
2583 ]),
2584 vec![0, 0]
2585 );
2586 let refresh =
2587 snapshot_2.refresh_anchors(&[snapshot_1.anchor_before(2), snapshot_1.anchor_after(3)]);
2588 assert_eq!(
2589 refresh,
2590 &[
2591 (snapshot_2.anchor_before(0), false),
2592 (snapshot_2.anchor_after(0), false),
2593 ]
2594 );
2595
2596 // Replace the middle excerpt with a smaller excerpt in buffer 2,
2597 // that intersects the old excerpt.
2598 let excerpt_id_5 = multibuffer.update(cx, |multibuffer, cx| {
2599 multibuffer.remove_excerpts([&excerpt_id_3], cx);
2600 multibuffer.insert_excerpt_after(
2601 &excerpt_id_3,
2602 ExcerptProperties {
2603 buffer: &buffer_2,
2604 range: 5..8,
2605 },
2606 cx,
2607 )
2608 });
2609
2610 let snapshot_3 = multibuffer.read(cx).snapshot(cx);
2611 assert_eq!(snapshot_3.text(), "ABCD\nFGH\nMNOP");
2612 assert_ne!(excerpt_id_5, excerpt_id_3);
2613
2614 // Resolve some anchors from the previous snapshot in the new snapshot.
2615 // The anchor in the middle excerpt snaps to the beginning of the
2616 // excerpt, since it is not
2617 let anchors = [
2618 snapshot_2.anchor_before(0),
2619 snapshot_2.anchor_after(2),
2620 snapshot_2.anchor_after(6),
2621 snapshot_2.anchor_after(14),
2622 ];
2623 assert_eq!(
2624 snapshot_3.summaries_for_anchors::<usize, _>(&anchors),
2625 &[0, 2, 9, 13]
2626 );
2627
2628 let new_anchors = snapshot_3.refresh_anchors(&anchors);
2629 assert_eq!(
2630 new_anchors.iter().map(|a| a.1).collect::<Vec<_>>(),
2631 &[true, true, true, true]
2632 );
2633 assert_eq!(
2634 snapshot_3.summaries_for_anchors::<usize, _>(new_anchors.iter().map(|a| &a.0)),
2635 &[0, 2, 7, 13]
2636 );
2637 }
2638
2639 #[gpui::test(iterations = 100)]
2640 fn test_random_multibuffer(cx: &mut MutableAppContext, mut rng: StdRng) {
2641 let operations = env::var("OPERATIONS")
2642 .map(|i| i.parse().expect("invalid `OPERATIONS` variable"))
2643 .unwrap_or(10);
2644
2645 let mut buffers: Vec<ModelHandle<Buffer>> = Vec::new();
2646 let multibuffer = cx.add_model(|_| MultiBuffer::new(0));
2647 let mut excerpt_ids = Vec::new();
2648 let mut expected_excerpts = Vec::<(ModelHandle<Buffer>, Range<text::Anchor>)>::new();
2649 let mut anchors = Vec::new();
2650 let mut old_versions = Vec::new();
2651
2652 for _ in 0..operations {
2653 match rng.gen_range(0..100) {
2654 0..=19 if !buffers.is_empty() => {
2655 let buffer = buffers.choose(&mut rng).unwrap();
2656 buffer.update(cx, |buf, cx| buf.randomly_edit(&mut rng, 5, cx));
2657 }
2658 20..=29 if !expected_excerpts.is_empty() => {
2659 let mut ids_to_remove = vec![];
2660 for _ in 0..rng.gen_range(1..=3) {
2661 if expected_excerpts.is_empty() {
2662 break;
2663 }
2664
2665 let ix = rng.gen_range(0..expected_excerpts.len());
2666 ids_to_remove.push(excerpt_ids.remove(ix));
2667 let (buffer, range) = expected_excerpts.remove(ix);
2668 let buffer = buffer.read(cx);
2669 log::info!(
2670 "Removing excerpt {}: {:?}",
2671 ix,
2672 buffer
2673 .text_for_range(range.to_offset(&buffer))
2674 .collect::<String>(),
2675 );
2676 }
2677 ids_to_remove.sort_unstable();
2678 multibuffer.update(cx, |multibuffer, cx| {
2679 multibuffer.remove_excerpts(&ids_to_remove, cx)
2680 });
2681 }
2682 30..=39 if !expected_excerpts.is_empty() => {
2683 let multibuffer = multibuffer.read(cx).read(cx);
2684 let offset =
2685 multibuffer.clip_offset(rng.gen_range(0..=multibuffer.len()), Bias::Left);
2686 let bias = if rng.gen() { Bias::Left } else { Bias::Right };
2687 log::info!("Creating anchor at {} with bias {:?}", offset, bias);
2688 anchors.push(multibuffer.anchor_at(offset, bias));
2689 anchors.sort_by(|a, b| a.cmp(&b, &multibuffer).unwrap());
2690 }
2691 40..=44 if !anchors.is_empty() => {
2692 let multibuffer = multibuffer.read(cx).read(cx);
2693 anchors = multibuffer
2694 .refresh_anchors(&anchors)
2695 .into_iter()
2696 .map(|a| a.0)
2697 .collect();
2698 anchors.sort_by(|a, b| a.cmp(&b, &multibuffer).unwrap());
2699 }
2700 _ => {
2701 let buffer_handle = if buffers.is_empty() || rng.gen_bool(0.4) {
2702 let base_text = RandomCharIter::new(&mut rng).take(10).collect::<String>();
2703 buffers.push(cx.add_model(|cx| Buffer::new(0, base_text, cx)));
2704 buffers.last().unwrap()
2705 } else {
2706 buffers.choose(&mut rng).unwrap()
2707 };
2708
2709 let buffer = buffer_handle.read(cx);
2710 let end_ix = buffer.clip_offset(rng.gen_range(0..=buffer.len()), Bias::Right);
2711 let start_ix = buffer.clip_offset(rng.gen_range(0..=end_ix), Bias::Left);
2712 let anchor_range = buffer.anchor_before(start_ix)..buffer.anchor_after(end_ix);
2713 let prev_excerpt_ix = rng.gen_range(0..=expected_excerpts.len());
2714 let prev_excerpt_id = excerpt_ids
2715 .get(prev_excerpt_ix)
2716 .cloned()
2717 .unwrap_or(ExcerptId::max());
2718 let excerpt_ix = (prev_excerpt_ix + 1).min(expected_excerpts.len());
2719
2720 log::info!(
2721 "Inserting excerpt at {} of {} for buffer {}: {:?}[{:?}] = {:?}",
2722 excerpt_ix,
2723 expected_excerpts.len(),
2724 buffer_handle.id(),
2725 buffer.text(),
2726 start_ix..end_ix,
2727 &buffer.text()[start_ix..end_ix]
2728 );
2729
2730 let excerpt_id = multibuffer.update(cx, |multibuffer, cx| {
2731 multibuffer.insert_excerpt_after(
2732 &prev_excerpt_id,
2733 ExcerptProperties {
2734 buffer: &buffer_handle,
2735 range: start_ix..end_ix,
2736 },
2737 cx,
2738 )
2739 });
2740
2741 excerpt_ids.insert(excerpt_ix, excerpt_id);
2742 expected_excerpts.insert(excerpt_ix, (buffer_handle.clone(), anchor_range));
2743 }
2744 }
2745
2746 if rng.gen_bool(0.3) {
2747 multibuffer.update(cx, |multibuffer, cx| {
2748 old_versions.push((multibuffer.snapshot(cx), multibuffer.subscribe()));
2749 })
2750 }
2751
2752 let snapshot = multibuffer.read(cx).snapshot(cx);
2753
2754 let mut excerpt_starts = Vec::new();
2755 let mut expected_text = String::new();
2756 let mut expected_buffer_rows = Vec::new();
2757 for (buffer, range) in &expected_excerpts {
2758 let buffer = buffer.read(cx);
2759 let buffer_range = range.to_offset(buffer);
2760
2761 excerpt_starts.push(TextSummary::from(expected_text.as_str()));
2762 expected_text.extend(buffer.text_for_range(buffer_range.clone()));
2763 expected_text.push('\n');
2764
2765 let buffer_row_range = buffer.offset_to_point(buffer_range.start).row
2766 ..=buffer.offset_to_point(buffer_range.end).row;
2767 for row in buffer_row_range {
2768 expected_buffer_rows.push(Some(row));
2769 }
2770 }
2771 // Remove final trailing newline.
2772 if !expected_excerpts.is_empty() {
2773 expected_text.pop();
2774 }
2775
2776 // Always report one buffer row
2777 if expected_buffer_rows.is_empty() {
2778 expected_buffer_rows.push(Some(0));
2779 }
2780
2781 assert_eq!(snapshot.text(), expected_text);
2782 log::info!("MultiBuffer text: {:?}", expected_text);
2783
2784 assert_eq!(
2785 snapshot.buffer_rows(0).collect::<Vec<_>>(),
2786 expected_buffer_rows,
2787 );
2788
2789 for _ in 0..5 {
2790 let start_row = rng.gen_range(0..=expected_buffer_rows.len());
2791 assert_eq!(
2792 snapshot.buffer_rows(start_row as u32).collect::<Vec<_>>(),
2793 &expected_buffer_rows[start_row..],
2794 "buffer_rows({})",
2795 start_row
2796 );
2797 }
2798
2799 assert_eq!(
2800 snapshot.max_buffer_row(),
2801 expected_buffer_rows
2802 .into_iter()
2803 .filter_map(|r| r)
2804 .max()
2805 .unwrap()
2806 );
2807
2808 let mut excerpt_starts = excerpt_starts.into_iter();
2809 for (buffer, range) in &expected_excerpts {
2810 let buffer_id = buffer.id();
2811 let buffer = buffer.read(cx);
2812 let buffer_range = range.to_offset(buffer);
2813 let buffer_start_point = buffer.offset_to_point(buffer_range.start);
2814 let buffer_start_point_utf16 =
2815 buffer.text_summary_for_range::<PointUtf16, _>(0..buffer_range.start);
2816
2817 let excerpt_start = excerpt_starts.next().unwrap();
2818 let mut offset = excerpt_start.bytes;
2819 let mut buffer_offset = buffer_range.start;
2820 let mut point = excerpt_start.lines;
2821 let mut buffer_point = buffer_start_point;
2822 let mut point_utf16 = excerpt_start.lines_utf16;
2823 let mut buffer_point_utf16 = buffer_start_point_utf16;
2824 for ch in buffer
2825 .snapshot()
2826 .chunks(buffer_range.clone(), None)
2827 .flat_map(|c| c.text.chars())
2828 {
2829 for _ in 0..ch.len_utf8() {
2830 let left_offset = snapshot.clip_offset(offset, Bias::Left);
2831 let right_offset = snapshot.clip_offset(offset, Bias::Right);
2832 let buffer_left_offset = buffer.clip_offset(buffer_offset, Bias::Left);
2833 let buffer_right_offset = buffer.clip_offset(buffer_offset, Bias::Right);
2834 assert_eq!(
2835 left_offset,
2836 excerpt_start.bytes + (buffer_left_offset - buffer_range.start),
2837 "clip_offset({:?}, Left). buffer: {:?}, buffer offset: {:?}",
2838 offset,
2839 buffer_id,
2840 buffer_offset,
2841 );
2842 assert_eq!(
2843 right_offset,
2844 excerpt_start.bytes + (buffer_right_offset - buffer_range.start),
2845 "clip_offset({:?}, Right). buffer: {:?}, buffer offset: {:?}",
2846 offset,
2847 buffer_id,
2848 buffer_offset,
2849 );
2850
2851 let left_point = snapshot.clip_point(point, Bias::Left);
2852 let right_point = snapshot.clip_point(point, Bias::Right);
2853 let buffer_left_point = buffer.clip_point(buffer_point, Bias::Left);
2854 let buffer_right_point = buffer.clip_point(buffer_point, Bias::Right);
2855 assert_eq!(
2856 left_point,
2857 excerpt_start.lines + (buffer_left_point - buffer_start_point),
2858 "clip_point({:?}, Left). buffer: {:?}, buffer point: {:?}",
2859 point,
2860 buffer_id,
2861 buffer_point,
2862 );
2863 assert_eq!(
2864 right_point,
2865 excerpt_start.lines + (buffer_right_point - buffer_start_point),
2866 "clip_point({:?}, Right). buffer: {:?}, buffer point: {:?}",
2867 point,
2868 buffer_id,
2869 buffer_point,
2870 );
2871
2872 assert_eq!(
2873 snapshot.point_to_offset(left_point),
2874 left_offset,
2875 "point_to_offset({:?})",
2876 left_point,
2877 );
2878 assert_eq!(
2879 snapshot.offset_to_point(left_offset),
2880 left_point,
2881 "offset_to_point({:?})",
2882 left_offset,
2883 );
2884
2885 offset += 1;
2886 buffer_offset += 1;
2887 if ch == '\n' {
2888 point += Point::new(1, 0);
2889 buffer_point += Point::new(1, 0);
2890 } else {
2891 point += Point::new(0, 1);
2892 buffer_point += Point::new(0, 1);
2893 }
2894 }
2895
2896 for _ in 0..ch.len_utf16() {
2897 let left_point_utf16 = snapshot.clip_point_utf16(point_utf16, Bias::Left);
2898 let right_point_utf16 = snapshot.clip_point_utf16(point_utf16, Bias::Right);
2899 let buffer_left_point_utf16 =
2900 buffer.clip_point_utf16(buffer_point_utf16, Bias::Left);
2901 let buffer_right_point_utf16 =
2902 buffer.clip_point_utf16(buffer_point_utf16, Bias::Right);
2903 assert_eq!(
2904 left_point_utf16,
2905 excerpt_start.lines_utf16
2906 + (buffer_left_point_utf16 - buffer_start_point_utf16),
2907 "clip_point_utf16({:?}, Left). buffer: {:?}, buffer point_utf16: {:?}",
2908 point_utf16,
2909 buffer_id,
2910 buffer_point_utf16,
2911 );
2912 assert_eq!(
2913 right_point_utf16,
2914 excerpt_start.lines_utf16
2915 + (buffer_right_point_utf16 - buffer_start_point_utf16),
2916 "clip_point_utf16({:?}, Right). buffer: {:?}, buffer point_utf16: {:?}",
2917 point_utf16,
2918 buffer_id,
2919 buffer_point_utf16,
2920 );
2921
2922 if ch == '\n' {
2923 point_utf16 += PointUtf16::new(1, 0);
2924 buffer_point_utf16 += PointUtf16::new(1, 0);
2925 } else {
2926 point_utf16 += PointUtf16::new(0, 1);
2927 buffer_point_utf16 += PointUtf16::new(0, 1);
2928 }
2929 }
2930 }
2931 }
2932
2933 for (row, line) in expected_text.split('\n').enumerate() {
2934 assert_eq!(
2935 snapshot.line_len(row as u32),
2936 line.len() as u32,
2937 "line_len({}).",
2938 row
2939 );
2940 }
2941
2942 let text_rope = Rope::from(expected_text.as_str());
2943 for _ in 0..10 {
2944 let end_ix = text_rope.clip_offset(rng.gen_range(0..=text_rope.len()), Bias::Right);
2945 let start_ix = text_rope.clip_offset(rng.gen_range(0..=end_ix), Bias::Left);
2946
2947 let text_for_range = snapshot
2948 .text_for_range(start_ix..end_ix)
2949 .collect::<String>();
2950 assert_eq!(
2951 text_for_range,
2952 &expected_text[start_ix..end_ix],
2953 "incorrect text for range {:?}",
2954 start_ix..end_ix
2955 );
2956
2957 let excerpted_buffer_ranges =
2958 multibuffer.read(cx).excerpted_buffers(start_ix..end_ix, cx);
2959 let excerpted_buffers_text = excerpted_buffer_ranges
2960 .into_iter()
2961 .map(|(buffer, buffer_range)| {
2962 buffer
2963 .read(cx)
2964 .text_for_range(buffer_range)
2965 .collect::<String>()
2966 })
2967 .collect::<Vec<_>>()
2968 .join("\n");
2969 assert_eq!(excerpted_buffers_text, text_for_range);
2970
2971 let expected_summary = TextSummary::from(&expected_text[start_ix..end_ix]);
2972 assert_eq!(
2973 snapshot.text_summary_for_range::<TextSummary, _>(start_ix..end_ix),
2974 expected_summary,
2975 "incorrect summary for range {:?}",
2976 start_ix..end_ix
2977 );
2978 }
2979
2980 // Anchor resolution
2981 for (anchor, resolved_offset) in anchors
2982 .iter()
2983 .zip(snapshot.summaries_for_anchors::<usize, _>(&anchors))
2984 {
2985 assert_eq!(
2986 snapshot.summary_for_anchor::<usize>(anchor),
2987 resolved_offset
2988 );
2989 }
2990
2991 for _ in 0..10 {
2992 let end_ix = text_rope.clip_offset(rng.gen_range(0..=text_rope.len()), Bias::Right);
2993 assert_eq!(
2994 snapshot.reversed_chars_at(end_ix).collect::<String>(),
2995 expected_text[..end_ix].chars().rev().collect::<String>(),
2996 );
2997 }
2998
2999 for _ in 0..10 {
3000 let end_ix = rng.gen_range(0..=text_rope.len());
3001 let start_ix = rng.gen_range(0..=end_ix);
3002 assert_eq!(
3003 snapshot
3004 .bytes_in_range(start_ix..end_ix)
3005 .flatten()
3006 .copied()
3007 .collect::<Vec<_>>(),
3008 expected_text.as_bytes()[start_ix..end_ix].to_vec(),
3009 "bytes_in_range({:?})",
3010 start_ix..end_ix,
3011 );
3012 }
3013 }
3014
3015 let snapshot = multibuffer.read(cx).snapshot(cx);
3016 for (old_snapshot, subscription) in old_versions {
3017 let edits = subscription.consume().into_inner();
3018
3019 log::info!(
3020 "applying subscription edits to old text: {:?}: {:?}",
3021 old_snapshot.text(),
3022 edits,
3023 );
3024
3025 let mut text = old_snapshot.text();
3026 for edit in edits {
3027 let new_text: String = snapshot.text_for_range(edit.new.clone()).collect();
3028 text.replace_range(edit.new.start..edit.new.start + edit.old.len(), &new_text);
3029 }
3030 assert_eq!(text.to_string(), snapshot.text());
3031 }
3032 }
3033
3034 #[gpui::test]
3035 fn test_history(cx: &mut MutableAppContext) {
3036 let buffer_1 = cx.add_model(|cx| Buffer::new(0, "1234", cx));
3037 let buffer_2 = cx.add_model(|cx| Buffer::new(0, "5678", cx));
3038 let multibuffer = cx.add_model(|_| MultiBuffer::new(0));
3039 let group_interval = multibuffer.read(cx).history.group_interval;
3040 multibuffer.update(cx, |multibuffer, cx| {
3041 multibuffer.push_excerpt(
3042 ExcerptProperties {
3043 buffer: &buffer_1,
3044 range: 0..buffer_1.read(cx).len(),
3045 },
3046 cx,
3047 );
3048 multibuffer.push_excerpt(
3049 ExcerptProperties {
3050 buffer: &buffer_2,
3051 range: 0..buffer_2.read(cx).len(),
3052 },
3053 cx,
3054 );
3055 });
3056
3057 let mut now = Instant::now();
3058
3059 multibuffer.update(cx, |multibuffer, cx| {
3060 multibuffer.start_transaction_at(now, cx);
3061 multibuffer.edit(
3062 [
3063 Point::new(0, 0)..Point::new(0, 0),
3064 Point::new(1, 0)..Point::new(1, 0),
3065 ],
3066 "A",
3067 cx,
3068 );
3069 multibuffer.edit(
3070 [
3071 Point::new(0, 1)..Point::new(0, 1),
3072 Point::new(1, 1)..Point::new(1, 1),
3073 ],
3074 "B",
3075 cx,
3076 );
3077 multibuffer.end_transaction_at(now, cx);
3078 assert_eq!(multibuffer.read(cx).text(), "AB1234\nAB5678");
3079
3080 now += 2 * group_interval;
3081 multibuffer.start_transaction_at(now, cx);
3082 multibuffer.edit([2..2], "C", cx);
3083 multibuffer.end_transaction_at(now, cx);
3084 assert_eq!(multibuffer.read(cx).text(), "ABC1234\nAB5678");
3085
3086 multibuffer.undo(cx);
3087 assert_eq!(multibuffer.read(cx).text(), "AB1234\nAB5678");
3088
3089 multibuffer.undo(cx);
3090 assert_eq!(multibuffer.read(cx).text(), "1234\n5678");
3091
3092 multibuffer.redo(cx);
3093 assert_eq!(multibuffer.read(cx).text(), "AB1234\nAB5678");
3094
3095 multibuffer.redo(cx);
3096 assert_eq!(multibuffer.read(cx).text(), "ABC1234\nAB5678");
3097
3098 buffer_1.update(cx, |buffer_1, cx| buffer_1.undo(cx));
3099 assert_eq!(multibuffer.read(cx).text(), "AB1234\nAB5678");
3100
3101 multibuffer.undo(cx);
3102 assert_eq!(multibuffer.read(cx).text(), "1234\n5678");
3103
3104 multibuffer.redo(cx);
3105 assert_eq!(multibuffer.read(cx).text(), "AB1234\nAB5678");
3106
3107 multibuffer.redo(cx);
3108 assert_eq!(multibuffer.read(cx).text(), "ABC1234\nAB5678");
3109
3110 multibuffer.undo(cx);
3111 assert_eq!(multibuffer.read(cx).text(), "AB1234\nAB5678");
3112
3113 buffer_1.update(cx, |buffer_1, cx| buffer_1.redo(cx));
3114 assert_eq!(multibuffer.read(cx).text(), "ABC1234\nAB5678");
3115
3116 multibuffer.undo(cx);
3117 assert_eq!(multibuffer.read(cx).text(), "C1234\n5678");
3118 });
3119 }
3120}