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