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