1use super::*;
2use buffer_diff::{DiffHunkStatus, DiffHunkStatusKind};
3use gpui::{App, TestAppContext};
4use indoc::indoc;
5use language::{Buffer, Rope};
6use parking_lot::RwLock;
7use rand::prelude::*;
8use settings::SettingsStore;
9use std::env;
10use std::time::{Duration, Instant};
11use util::RandomCharIter;
12use util::rel_path::rel_path;
13use util::test::sample_text;
14
15#[ctor::ctor]
16fn init_logger() {
17 zlog::init_test();
18}
19
20#[gpui::test]
21fn test_empty_singleton(cx: &mut App) {
22 let buffer = cx.new(|cx| Buffer::local("", cx));
23 let buffer_id = buffer.read(cx).remote_id();
24 let multibuffer = cx.new(|cx| MultiBuffer::singleton(buffer.clone(), cx));
25 let snapshot = multibuffer.read(cx).snapshot(cx);
26 assert_eq!(snapshot.text(), "");
27 assert_eq!(
28 snapshot.row_infos(MultiBufferRow(0)).collect::<Vec<_>>(),
29 [RowInfo {
30 buffer_id: Some(buffer_id),
31 buffer_row: Some(0),
32 multibuffer_row: Some(MultiBufferRow(0)),
33 diff_status: None,
34 expand_info: None,
35 wrapped_buffer_row: None,
36 }]
37 );
38}
39
40#[gpui::test]
41fn test_singleton(cx: &mut App) {
42 let buffer = cx.new(|cx| Buffer::local(sample_text(6, 6, 'a'), cx));
43 let multibuffer = cx.new(|cx| MultiBuffer::singleton(buffer.clone(), cx));
44
45 let snapshot = multibuffer.read(cx).snapshot(cx);
46 assert_eq!(snapshot.text(), buffer.read(cx).text());
47
48 assert_eq!(
49 snapshot
50 .row_infos(MultiBufferRow(0))
51 .map(|info| info.buffer_row)
52 .collect::<Vec<_>>(),
53 (0..buffer.read(cx).row_count())
54 .map(Some)
55 .collect::<Vec<_>>()
56 );
57 assert_consistent_line_numbers(&snapshot);
58
59 buffer.update(cx, |buffer, cx| buffer.edit([(1..3, "XXX\n")], None, cx));
60 let snapshot = multibuffer.read(cx).snapshot(cx);
61
62 assert_eq!(snapshot.text(), buffer.read(cx).text());
63 assert_eq!(
64 snapshot
65 .row_infos(MultiBufferRow(0))
66 .map(|info| info.buffer_row)
67 .collect::<Vec<_>>(),
68 (0..buffer.read(cx).row_count())
69 .map(Some)
70 .collect::<Vec<_>>()
71 );
72 assert_consistent_line_numbers(&snapshot);
73}
74
75#[gpui::test]
76fn test_remote(cx: &mut App) {
77 let host_buffer = cx.new(|cx| Buffer::local("a", cx));
78 let guest_buffer = cx.new(|cx| {
79 let state = host_buffer.read(cx).to_proto(cx);
80 let ops = cx
81 .foreground_executor()
82 .block_on(host_buffer.read(cx).serialize_ops(None, cx));
83 let mut buffer =
84 Buffer::from_proto(ReplicaId::REMOTE_SERVER, Capability::ReadWrite, state, None)
85 .unwrap();
86 buffer.apply_ops(
87 ops.into_iter()
88 .map(|op| language::proto::deserialize_operation(op).unwrap()),
89 cx,
90 );
91 buffer
92 });
93 let multibuffer = cx.new(|cx| MultiBuffer::singleton(guest_buffer.clone(), cx));
94 let snapshot = multibuffer.read(cx).snapshot(cx);
95 assert_eq!(snapshot.text(), "a");
96
97 guest_buffer.update(cx, |buffer, cx| buffer.edit([(1..1, "b")], None, cx));
98 let snapshot = multibuffer.read(cx).snapshot(cx);
99 assert_eq!(snapshot.text(), "ab");
100
101 guest_buffer.update(cx, |buffer, cx| buffer.edit([(2..2, "c")], None, cx));
102 let snapshot = multibuffer.read(cx).snapshot(cx);
103 assert_eq!(snapshot.text(), "abc");
104}
105
106#[gpui::test]
107fn test_excerpt_boundaries_and_clipping(cx: &mut App) {
108 let buffer_1 = cx.new(|cx| Buffer::local(sample_text(7, 6, 'a'), cx));
109 let buffer_2 = cx.new(|cx| Buffer::local(sample_text(7, 6, 'g'), cx));
110 let multibuffer = cx.new(|_| MultiBuffer::new(Capability::ReadWrite));
111
112 let events = Arc::new(RwLock::new(Vec::<Event>::new()));
113 multibuffer.update(cx, |_, cx| {
114 let events = events.clone();
115 cx.subscribe(&multibuffer, move |_, _, event, _| {
116 if let Event::Edited { .. } = event {
117 events.write().push(event.clone())
118 }
119 })
120 .detach();
121 });
122
123 let subscription = multibuffer.update(cx, |multibuffer, cx| {
124 let subscription = multibuffer.subscribe();
125 multibuffer.set_excerpt_ranges_for_path(
126 PathKey::sorted(0),
127 buffer_1.clone(),
128 &buffer_1.read(cx).snapshot(),
129 vec![ExcerptRange::new(Point::new(1, 2)..Point::new(2, 5))],
130 cx,
131 );
132 assert_eq!(
133 subscription.consume().into_inner(),
134 [Edit {
135 old: MultiBufferOffset(0)..MultiBufferOffset(0),
136 new: MultiBufferOffset(0)..MultiBufferOffset(10)
137 }]
138 );
139
140 multibuffer.set_excerpt_ranges_for_path(
141 PathKey::sorted(0),
142 buffer_1.clone(),
143 &buffer_1.read(cx).snapshot(),
144 vec![
145 ExcerptRange::new(Point::new(1, 2)..Point::new(2, 5)),
146 ExcerptRange::new(Point::new(5, 3)..Point::new(6, 4)),
147 ],
148 cx,
149 );
150 multibuffer.set_excerpt_ranges_for_path(
151 PathKey::sorted(1),
152 buffer_2.clone(),
153 &buffer_2.read(cx).snapshot(),
154 vec![ExcerptRange::new(Point::new(3, 1)..Point::new(3, 3))],
155 cx,
156 );
157 assert_eq!(
158 subscription.consume().into_inner(),
159 [Edit {
160 old: MultiBufferOffset(10)..MultiBufferOffset(10),
161 new: MultiBufferOffset(10)..MultiBufferOffset(22)
162 }]
163 );
164
165 subscription
166 });
167
168 // Adding excerpts emits an edited event.
169 assert_eq!(
170 events.read().as_slice(),
171 &[
172 Event::Edited {
173 edited_buffer: None,
174 },
175 Event::Edited {
176 edited_buffer: None,
177 },
178 Event::Edited {
179 edited_buffer: None,
180 }
181 ]
182 );
183
184 let snapshot = multibuffer.read(cx).snapshot(cx);
185 assert_eq!(
186 snapshot.text(),
187 indoc!(
188 "
189 bbbb
190 ccccc
191 fff
192 gggg
193 jj"
194 ),
195 );
196 assert_eq!(
197 snapshot
198 .row_infos(MultiBufferRow(0))
199 .map(|info| info.buffer_row)
200 .collect::<Vec<_>>(),
201 [Some(1), Some(2), Some(5), Some(6), Some(3)]
202 );
203 assert_eq!(
204 snapshot
205 .row_infos(MultiBufferRow(2))
206 .map(|info| info.buffer_row)
207 .collect::<Vec<_>>(),
208 [Some(5), Some(6), Some(3)]
209 );
210 assert_eq!(
211 snapshot
212 .row_infos(MultiBufferRow(4))
213 .map(|info| info.buffer_row)
214 .collect::<Vec<_>>(),
215 [Some(3)]
216 );
217 assert!(
218 snapshot
219 .row_infos(MultiBufferRow(5))
220 .map(|info| info.buffer_row)
221 .collect::<Vec<_>>()
222 .is_empty()
223 );
224
225 assert_eq!(
226 boundaries_in_range(Point::new(0, 0)..Point::new(4, 2), &snapshot),
227 &[
228 (MultiBufferRow(0), "bbbb\nccccc".to_string(), true),
229 (MultiBufferRow(2), "fff\ngggg".to_string(), false),
230 (MultiBufferRow(4), "jj".to_string(), true),
231 ]
232 );
233 assert_eq!(
234 boundaries_in_range(Point::new(0, 0)..Point::new(2, 0), &snapshot),
235 &[(MultiBufferRow(0), "bbbb\nccccc".to_string(), true)]
236 );
237 assert_eq!(
238 boundaries_in_range(Point::new(1, 0)..Point::new(1, 5), &snapshot),
239 &[]
240 );
241 assert_eq!(
242 boundaries_in_range(Point::new(1, 0)..Point::new(2, 0), &snapshot),
243 &[]
244 );
245 assert_eq!(
246 boundaries_in_range(Point::new(1, 0)..Point::new(4, 0), &snapshot),
247 &[(MultiBufferRow(2), "fff\ngggg".to_string(), false)]
248 );
249 assert_eq!(
250 boundaries_in_range(Point::new(1, 0)..Point::new(4, 0), &snapshot),
251 &[(MultiBufferRow(2), "fff\ngggg".to_string(), false)]
252 );
253 assert_eq!(
254 boundaries_in_range(Point::new(2, 0)..Point::new(3, 0), &snapshot),
255 &[(MultiBufferRow(2), "fff\ngggg".to_string(), false)]
256 );
257 assert_eq!(
258 boundaries_in_range(Point::new(4, 0)..Point::new(4, 2), &snapshot),
259 &[(MultiBufferRow(4), "jj".to_string(), true)]
260 );
261 assert_eq!(
262 boundaries_in_range(Point::new(4, 2)..Point::new(4, 2), &snapshot),
263 &[]
264 );
265
266 buffer_1.update(cx, |buffer, cx| {
267 let text = "\n";
268 buffer.edit(
269 [
270 (Point::new(0, 0)..Point::new(0, 0), text),
271 (Point::new(2, 1)..Point::new(2, 3), text),
272 ],
273 None,
274 cx,
275 );
276 });
277
278 let snapshot = multibuffer.read(cx).snapshot(cx);
279 assert_eq!(
280 snapshot.text(),
281 concat!(
282 "bbbb\n", // Preserve newlines
283 "c\n", //
284 "cc\n", //
285 "fff\n", //
286 "gggg\n", //
287 "jj" //
288 )
289 );
290
291 assert_eq!(
292 subscription.consume().into_inner(),
293 [Edit {
294 old: MultiBufferOffset(6)..MultiBufferOffset(8),
295 new: MultiBufferOffset(6)..MultiBufferOffset(7)
296 }]
297 );
298
299 let snapshot = multibuffer.read(cx).snapshot(cx);
300 assert_eq!(
301 snapshot.clip_point(Point::new(0, 5), Bias::Left),
302 Point::new(0, 4)
303 );
304 assert_eq!(
305 snapshot.clip_point(Point::new(0, 5), Bias::Right),
306 Point::new(0, 4)
307 );
308 assert_eq!(
309 snapshot.clip_point(Point::new(5, 1), Bias::Right),
310 Point::new(5, 1)
311 );
312 assert_eq!(
313 snapshot.clip_point(Point::new(5, 2), Bias::Right),
314 Point::new(5, 2)
315 );
316 assert_eq!(
317 snapshot.clip_point(Point::new(5, 3), Bias::Right),
318 Point::new(5, 2)
319 );
320
321 let snapshot = multibuffer.update(cx, |multibuffer, cx| {
322 multibuffer.remove_excerpts_for_path(PathKey::sorted(1), cx);
323 multibuffer.snapshot(cx)
324 });
325
326 assert_eq!(
327 snapshot.text(),
328 concat!(
329 "bbbb\n", // Preserve newlines
330 "c\n", //
331 "cc\n", //
332 "fff\n", //
333 "gggg", //
334 )
335 );
336
337 fn boundaries_in_range(
338 range: Range<Point>,
339 snapshot: &MultiBufferSnapshot,
340 ) -> Vec<(MultiBufferRow, String, bool)> {
341 snapshot
342 .excerpt_boundaries_in_range(range)
343 .map(|boundary| {
344 let starts_new_buffer = boundary.starts_new_buffer();
345 (
346 boundary.row,
347 boundary
348 .next
349 .buffer
350 .text_for_range(boundary.next.range.context)
351 .collect::<String>(),
352 starts_new_buffer,
353 )
354 })
355 .collect::<Vec<_>>()
356 }
357}
358
359#[gpui::test]
360async fn test_diff_boundary_anchors(cx: &mut TestAppContext) {
361 let base_text = "one\ntwo\nthree\n";
362 let text = "one\nthree\n";
363 let buffer = cx.new(|cx| Buffer::local(text, cx));
364 let diff = cx
365 .new(|cx| BufferDiff::new_with_base_text(base_text, &buffer.read(cx).text_snapshot(), cx));
366 let multibuffer = cx.new(|cx| MultiBuffer::singleton(buffer, cx));
367 multibuffer.update(cx, |multibuffer, cx| multibuffer.add_diff(diff, cx));
368
369 let (before, after) = multibuffer.update(cx, |multibuffer, cx| {
370 let before = multibuffer.snapshot(cx).anchor_before(Point::new(1, 0));
371 let after = multibuffer.snapshot(cx).anchor_after(Point::new(1, 0));
372 multibuffer.set_all_diff_hunks_expanded(cx);
373 (before, after)
374 });
375 cx.run_until_parked();
376
377 let snapshot = multibuffer.read_with(cx, |multibuffer, cx| multibuffer.snapshot(cx));
378 let actual_text = snapshot.text();
379 let actual_row_infos = snapshot.row_infos(MultiBufferRow(0)).collect::<Vec<_>>();
380 let actual_diff = format_diff(&actual_text, &actual_row_infos, &Default::default(), None);
381 pretty_assertions::assert_eq!(
382 actual_diff,
383 indoc! {
384 " one
385 - two
386 three
387 "
388 },
389 );
390
391 multibuffer.update(cx, |multibuffer, cx| {
392 let snapshot = multibuffer.snapshot(cx);
393 assert_eq!(before.to_point(&snapshot), Point::new(1, 0));
394 assert_eq!(after.to_point(&snapshot), Point::new(2, 0));
395 assert_eq!(
396 vec![Point::new(1, 0), Point::new(2, 0),],
397 snapshot.summaries_for_anchors::<Point, _>(&[before, after]),
398 )
399 })
400}
401
402#[gpui::test]
403async fn test_diff_hunks_in_range(cx: &mut TestAppContext) {
404 let base_text = "one\ntwo\nthree\nfour\nfive\nsix\nseven\neight\n";
405 let text = "one\nfour\nseven\n";
406 let buffer = cx.new(|cx| Buffer::local(text, cx));
407 let diff = cx
408 .new(|cx| BufferDiff::new_with_base_text(base_text, &buffer.read(cx).text_snapshot(), cx));
409 let multibuffer = cx.new(|cx| MultiBuffer::singleton(buffer, cx));
410 let (mut snapshot, mut subscription) = multibuffer.update(cx, |multibuffer, cx| {
411 (multibuffer.snapshot(cx), multibuffer.subscribe())
412 });
413
414 multibuffer.update(cx, |multibuffer, cx| {
415 multibuffer.add_diff(diff, cx);
416 multibuffer.expand_diff_hunks(vec![Anchor::min()..Anchor::max()], cx);
417 });
418
419 assert_new_snapshot(
420 &multibuffer,
421 &mut snapshot,
422 &mut subscription,
423 cx,
424 indoc! {
425 " one
426 - two
427 - three
428 four
429 - five
430 - six
431 seven
432 - eight
433 "
434 },
435 );
436
437 assert_eq!(
438 snapshot
439 .diff_hunks_in_range(Point::new(1, 0)..Point::MAX)
440 .map(|hunk| hunk.row_range.start.0..hunk.row_range.end.0)
441 .collect::<Vec<_>>(),
442 vec![1..3, 4..6, 7..8]
443 );
444
445 assert_eq!(snapshot.diff_hunk_before(Point::new(1, 1)), None,);
446 assert_eq!(
447 snapshot.diff_hunk_before(Point::new(7, 0)),
448 Some(MultiBufferRow(4))
449 );
450 assert_eq!(
451 snapshot.diff_hunk_before(Point::new(4, 0)),
452 Some(MultiBufferRow(1))
453 );
454
455 multibuffer.update(cx, |multibuffer, cx| {
456 multibuffer.collapse_diff_hunks(vec![Anchor::min()..Anchor::max()], cx);
457 });
458
459 assert_new_snapshot(
460 &multibuffer,
461 &mut snapshot,
462 &mut subscription,
463 cx,
464 indoc! {
465 "
466 one
467 four
468 seven
469 "
470 },
471 );
472
473 assert_eq!(
474 snapshot.diff_hunk_before(Point::new(2, 0)),
475 Some(MultiBufferRow(1)),
476 );
477 assert_eq!(
478 snapshot.diff_hunk_before(Point::new(4, 0)),
479 Some(MultiBufferRow(2))
480 );
481}
482
483#[gpui::test]
484async fn test_diff_hunks_in_range_query_starting_at_added_row(cx: &mut TestAppContext) {
485 let base_text = "one\ntwo\nthree\n";
486 let text = "one\nTWO\nthree\n";
487 let buffer = cx.new(|cx| Buffer::local(text, cx));
488 let diff = cx
489 .new(|cx| BufferDiff::new_with_base_text(base_text, &buffer.read(cx).text_snapshot(), cx));
490 let multibuffer = cx.new(|cx| MultiBuffer::singleton(buffer, cx));
491 let (mut snapshot, mut subscription) = multibuffer.update(cx, |multibuffer, cx| {
492 (multibuffer.snapshot(cx), multibuffer.subscribe())
493 });
494
495 multibuffer.update(cx, |multibuffer, cx| {
496 multibuffer.add_diff(diff, cx);
497 multibuffer.expand_diff_hunks(vec![Anchor::min()..Anchor::max()], cx);
498 });
499
500 assert_new_snapshot(
501 &multibuffer,
502 &mut snapshot,
503 &mut subscription,
504 cx,
505 indoc! {
506 " one
507 - two
508 + TWO
509 three
510 "
511 },
512 );
513
514 assert_eq!(
515 snapshot
516 .diff_hunks_in_range(Point::new(2, 0)..Point::MAX)
517 .map(|hunk| hunk.row_range.start.0..hunk.row_range.end.0)
518 .collect::<Vec<_>>(),
519 vec![1..3],
520 "querying starting at the added row should still return the full hunk including deleted lines"
521 );
522}
523
524#[gpui::test]
525async fn test_inverted_diff_hunks_in_range(cx: &mut TestAppContext) {
526 let base_text = "one\ntwo\nthree\nfour\nfive\nsix\nseven\neight\n";
527 let text = "ZERO\none\nTHREE\nfour\nseven\nEIGHT\nNINE\n";
528 let buffer = cx.new(|cx| Buffer::local(text, cx));
529 let diff = cx
530 .new(|cx| BufferDiff::new_with_base_text(base_text, &buffer.read(cx).text_snapshot(), cx));
531 let base_text_buffer = diff.read_with(cx, |diff, _| diff.base_text_buffer().clone());
532 let multibuffer = cx.new(|cx| MultiBuffer::singleton(base_text_buffer.clone(), cx));
533 let (mut snapshot, mut subscription) = multibuffer.update(cx, |multibuffer, cx| {
534 (multibuffer.snapshot(cx), multibuffer.subscribe())
535 });
536
537 multibuffer.update(cx, |multibuffer, cx| {
538 multibuffer.add_inverted_diff(diff, buffer.clone(), cx);
539 });
540
541 assert_new_snapshot(
542 &multibuffer,
543 &mut snapshot,
544 &mut subscription,
545 cx,
546 indoc! {
547 " one
548 - two
549 - three
550 four
551 - five
552 - six
553 seven
554 - eight
555 "
556 },
557 );
558
559 assert_eq!(
560 snapshot
561 .diff_hunks_in_range(Point::new(0, 0)..Point::MAX)
562 .map(|hunk| hunk.row_range.start.0..hunk.row_range.end.0)
563 .collect::<Vec<_>>(),
564 vec![0..0, 1..3, 4..6, 7..8]
565 );
566
567 assert_eq!(
568 snapshot.diff_hunk_before(Point::new(1, 1)),
569 Some(MultiBufferRow(0))
570 );
571 assert_eq!(
572 snapshot.diff_hunk_before(Point::new(7, 0)),
573 Some(MultiBufferRow(4))
574 );
575 assert_eq!(
576 snapshot.diff_hunk_before(Point::new(4, 0)),
577 Some(MultiBufferRow(1))
578 );
579}
580
581#[gpui::test]
582async fn test_editing_text_in_diff_hunks(cx: &mut TestAppContext) {
583 let base_text = "one\ntwo\nfour\nfive\nsix\nseven\n";
584 let text = "one\ntwo\nTHREE\nfour\nfive\nseven\n";
585 let buffer = cx.new(|cx| Buffer::local(text, cx));
586 let diff = cx
587 .new(|cx| BufferDiff::new_with_base_text(base_text, &buffer.read(cx).text_snapshot(), cx));
588 let multibuffer = cx.new(|cx| MultiBuffer::singleton(buffer.clone(), cx));
589
590 let (mut snapshot, mut subscription) = multibuffer.update(cx, |multibuffer, cx| {
591 multibuffer.add_diff(diff.clone(), cx);
592 (multibuffer.snapshot(cx), multibuffer.subscribe())
593 });
594
595 cx.executor().run_until_parked();
596 multibuffer.update(cx, |multibuffer, cx| {
597 multibuffer.set_all_diff_hunks_expanded(cx);
598 });
599
600 assert_new_snapshot(
601 &multibuffer,
602 &mut snapshot,
603 &mut subscription,
604 cx,
605 indoc! {
606 "
607 one
608 two
609 + THREE
610 four
611 five
612 - six
613 seven
614 "
615 },
616 );
617
618 // Insert a newline within an insertion hunk
619 multibuffer.update(cx, |multibuffer, cx| {
620 multibuffer.edit([(Point::new(2, 0)..Point::new(2, 0), "__\n__")], None, cx);
621 });
622 assert_new_snapshot(
623 &multibuffer,
624 &mut snapshot,
625 &mut subscription,
626 cx,
627 indoc! {
628 "
629 one
630 two
631 + __
632 + __THREE
633 four
634 five
635 - six
636 seven
637 "
638 },
639 );
640
641 // Delete the newline before a deleted hunk.
642 multibuffer.update(cx, |multibuffer, cx| {
643 multibuffer.edit([(Point::new(5, 4)..Point::new(6, 0), "")], None, cx);
644 });
645 assert_new_snapshot(
646 &multibuffer,
647 &mut snapshot,
648 &mut subscription,
649 cx,
650 indoc! {
651 "
652 one
653 two
654 + __
655 + __THREE
656 four
657 fiveseven
658 "
659 },
660 );
661
662 multibuffer.update(cx, |multibuffer, cx| multibuffer.undo(cx));
663 assert_new_snapshot(
664 &multibuffer,
665 &mut snapshot,
666 &mut subscription,
667 cx,
668 indoc! {
669 "
670 one
671 two
672 + __
673 + __THREE
674 four
675 five
676 - six
677 seven
678 "
679 },
680 );
681
682 // Cannot (yet) insert at the beginning of a deleted hunk.
683 // (because it would put the newline in the wrong place)
684 multibuffer.update(cx, |multibuffer, cx| {
685 multibuffer.edit([(Point::new(6, 0)..Point::new(6, 0), "\n")], None, cx);
686 });
687 assert_new_snapshot(
688 &multibuffer,
689 &mut snapshot,
690 &mut subscription,
691 cx,
692 indoc! {
693 "
694 one
695 two
696 + __
697 + __THREE
698 four
699 five
700 - six
701 seven
702 "
703 },
704 );
705
706 // Replace a range that ends in a deleted hunk.
707 multibuffer.update(cx, |multibuffer, cx| {
708 multibuffer.edit([(Point::new(5, 2)..Point::new(6, 2), "fty-")], None, cx);
709 });
710 assert_new_snapshot(
711 &multibuffer,
712 &mut snapshot,
713 &mut subscription,
714 cx,
715 indoc! {
716 "
717 one
718 two
719 + __
720 + __THREE
721 four
722 fifty-seven
723 "
724 },
725 );
726}
727
728#[gpui::test]
729fn test_excerpt_events(cx: &mut App) {
730 let buffer_1 = cx.new(|cx| Buffer::local(sample_text(10, 3, 'a'), cx));
731 let buffer_2 = cx.new(|cx| Buffer::local(sample_text(10, 3, 'm'), cx));
732
733 let leader_multibuffer = cx.new(|_| MultiBuffer::new(Capability::ReadWrite));
734 let follower_multibuffer = cx.new(|_| MultiBuffer::new(Capability::ReadWrite));
735 let follower_edit_event_count = Arc::new(RwLock::new(0));
736
737 follower_multibuffer.update(cx, |_, cx| {
738 let follower_edit_event_count = follower_edit_event_count.clone();
739 cx.subscribe(
740 &leader_multibuffer,
741 move |follower, _, event, cx| match event.clone() {
742 Event::BufferUpdated {
743 buffer,
744 path_key,
745 ranges,
746 } => {
747 let buffer_snapshot = buffer.read(cx).snapshot();
748 follower.set_merged_excerpt_ranges_for_path(
749 path_key,
750 buffer,
751 &buffer_snapshot,
752 ranges,
753 cx,
754 );
755 }
756 Event::BuffersRemoved {
757 removed_buffer_ids, ..
758 } => {
759 for id in removed_buffer_ids {
760 follower.remove_excerpts_for_buffer(id, cx);
761 }
762 }
763 Event::Edited { .. } => {
764 *follower_edit_event_count.write() += 1;
765 }
766 _ => {}
767 },
768 )
769 .detach();
770 });
771
772 let buffer_1_snapshot = buffer_1.read(cx).snapshot();
773 let buffer_2_snapshot = buffer_2.read(cx).snapshot();
774 leader_multibuffer.update(cx, |leader, cx| {
775 leader.set_excerpt_ranges_for_path(
776 PathKey::sorted(0),
777 buffer_1.clone(),
778 &buffer_1_snapshot,
779 vec![
780 ExcerptRange::new((0..8).to_point(&buffer_1_snapshot)),
781 ExcerptRange::new((22..26).to_point(&buffer_1_snapshot)),
782 ],
783 cx,
784 );
785 leader.set_excerpt_ranges_for_path(
786 PathKey::sorted(1),
787 buffer_2.clone(),
788 &buffer_2_snapshot,
789 vec![
790 ExcerptRange::new((0..5).to_point(&buffer_2_snapshot)),
791 ExcerptRange::new((20..25).to_point(&buffer_2_snapshot)),
792 ],
793 cx,
794 );
795 });
796 assert_eq!(
797 leader_multibuffer.read(cx).snapshot(cx).text(),
798 follower_multibuffer.read(cx).snapshot(cx).text(),
799 );
800 assert_eq!(*follower_edit_event_count.read(), 2);
801
802 leader_multibuffer.update(cx, |leader, cx| {
803 leader.set_excerpt_ranges_for_path(
804 PathKey::sorted(0),
805 buffer_1.clone(),
806 &buffer_1_snapshot,
807 vec![ExcerptRange::new((0..8).to_point(&buffer_1_snapshot))],
808 cx,
809 );
810 leader.set_excerpt_ranges_for_path(
811 PathKey::sorted(1),
812 buffer_2,
813 &buffer_2_snapshot,
814 vec![ExcerptRange::new((0..5).to_point(&buffer_2_snapshot))],
815 cx,
816 );
817 });
818 assert_eq!(
819 leader_multibuffer.read(cx).snapshot(cx).text(),
820 follower_multibuffer.read(cx).snapshot(cx).text(),
821 );
822 assert_eq!(*follower_edit_event_count.read(), 4);
823
824 leader_multibuffer.update(cx, |leader, cx| {
825 leader.clear(cx);
826 });
827 assert_eq!(
828 leader_multibuffer.read(cx).snapshot(cx).text(),
829 follower_multibuffer.read(cx).snapshot(cx).text(),
830 );
831 assert_eq!(*follower_edit_event_count.read(), 5);
832}
833
834#[gpui::test]
835fn test_expand_excerpts(cx: &mut App) {
836 let buffer = cx.new(|cx| Buffer::local(sample_text(20, 3, 'a'), cx));
837 let multibuffer = cx.new(|_| MultiBuffer::new(Capability::ReadWrite));
838
839 multibuffer.update(cx, |multibuffer, cx| {
840 multibuffer.set_excerpts_for_path(
841 PathKey::for_buffer(&buffer, cx),
842 buffer,
843 vec![
844 // Note that in this test, this first excerpt
845 // does not contain a new line
846 Point::new(3, 2)..Point::new(3, 3),
847 Point::new(7, 1)..Point::new(7, 3),
848 Point::new(15, 0)..Point::new(15, 0),
849 ],
850 1,
851 cx,
852 )
853 });
854
855 let snapshot = multibuffer.read(cx).snapshot(cx);
856
857 assert_eq!(
858 snapshot.text(),
859 concat!(
860 "ccc\n", //
861 "ddd\n", //
862 "eee", //
863 "\n", // End of excerpt
864 "ggg\n", //
865 "hhh\n", //
866 "iii", //
867 "\n", // End of excerpt
868 "ooo\n", //
869 "ppp\n", //
870 "qqq", // End of excerpt
871 )
872 );
873 drop(snapshot);
874
875 multibuffer.update(cx, |multibuffer, cx| {
876 let line_zero = multibuffer.snapshot(cx).anchor_before(Point::new(0, 0));
877
878 multibuffer.expand_excerpts_with_paths(
879 multibuffer
880 .snapshot(cx)
881 .excerpts()
882 .map(|(_, info)| Anchor::in_buffer(info.path_key_index, info.range.context.end)),
883 1,
884 ExpandExcerptDirection::UpAndDown,
885 cx,
886 );
887 let snapshot = multibuffer.snapshot(cx);
888 let line_two = snapshot.anchor_before(Point::new(2, 0));
889 assert_eq!(line_two.cmp(&line_zero, &snapshot), cmp::Ordering::Greater);
890 });
891
892 let snapshot = multibuffer.read(cx).snapshot(cx);
893
894 assert_eq!(
895 snapshot.text(),
896 concat!(
897 "bbb\n", //
898 "ccc\n", //
899 "ddd\n", //
900 "eee\n", //
901 "fff\n", //
902 "ggg\n", //
903 "hhh\n", //
904 "iii\n", //
905 "jjj\n", // End of excerpt
906 "nnn\n", //
907 "ooo\n", //
908 "ppp\n", //
909 "qqq\n", //
910 "rrr", // End of excerpt
911 )
912 );
913}
914
915#[gpui::test(iterations = 100)]
916async fn test_set_anchored_excerpts_for_path(cx: &mut TestAppContext) {
917 let buffer_1 = cx.new(|cx| Buffer::local(sample_text(20, 3, 'a'), cx));
918 let buffer_2 = cx.new(|cx| Buffer::local(sample_text(15, 4, 'a'), cx));
919 let snapshot_1 = buffer_1.update(cx, |buffer, _| buffer.snapshot());
920 let snapshot_2 = buffer_2.update(cx, |buffer, _| buffer.snapshot());
921 let ranges_1 = vec![
922 snapshot_1.anchor_before(Point::new(3, 2))..snapshot_1.anchor_before(Point::new(4, 2)),
923 snapshot_1.anchor_before(Point::new(7, 1))..snapshot_1.anchor_before(Point::new(7, 3)),
924 snapshot_1.anchor_before(Point::new(15, 0))..snapshot_1.anchor_before(Point::new(15, 0)),
925 ];
926 let ranges_2 = vec![
927 snapshot_2.anchor_before(Point::new(2, 1))..snapshot_2.anchor_before(Point::new(3, 1)),
928 snapshot_2.anchor_before(Point::new(10, 0))..snapshot_2.anchor_before(Point::new(10, 2)),
929 ];
930
931 let multibuffer = cx.new(|_| MultiBuffer::new(Capability::ReadWrite));
932 let anchor_ranges_1 = multibuffer
933 .update(cx, |multibuffer, cx| {
934 multibuffer.set_anchored_excerpts_for_path(
935 PathKey::for_buffer(&buffer_1, cx),
936 buffer_1.clone(),
937 ranges_1,
938 2,
939 cx,
940 )
941 })
942 .await;
943 let snapshot_1 = multibuffer.update(cx, |multibuffer, cx| multibuffer.snapshot(cx));
944 assert_eq!(
945 anchor_ranges_1
946 .iter()
947 .map(|range| range.to_point(&snapshot_1))
948 .collect::<Vec<_>>(),
949 vec![
950 Point::new(2, 2)..Point::new(3, 2),
951 Point::new(6, 1)..Point::new(6, 3),
952 Point::new(11, 0)..Point::new(11, 0),
953 ]
954 );
955 let anchor_ranges_2 = multibuffer
956 .update(cx, |multibuffer, cx| {
957 multibuffer.set_anchored_excerpts_for_path(
958 PathKey::for_buffer(&buffer_2, cx),
959 buffer_2.clone(),
960 ranges_2,
961 2,
962 cx,
963 )
964 })
965 .await;
966 let snapshot_2 = multibuffer.update(cx, |multibuffer, cx| multibuffer.snapshot(cx));
967 assert_eq!(
968 anchor_ranges_2
969 .iter()
970 .map(|range| range.to_point(&snapshot_2))
971 .collect::<Vec<_>>(),
972 vec![
973 Point::new(16, 1)..Point::new(17, 1),
974 Point::new(22, 0)..Point::new(22, 2)
975 ]
976 );
977
978 let snapshot = multibuffer.update(cx, |multibuffer, cx| multibuffer.snapshot(cx));
979 assert_eq!(
980 snapshot.text(),
981 concat!(
982 "bbb\n", // buffer_1
983 "ccc\n", //
984 "ddd\n", // <-- excerpt 1
985 "eee\n", // <-- excerpt 1
986 "fff\n", //
987 "ggg\n", //
988 "hhh\n", // <-- excerpt 2
989 "iii\n", //
990 "jjj\n", //
991 //
992 "nnn\n", //
993 "ooo\n", //
994 "ppp\n", // <-- excerpt 3
995 "qqq\n", //
996 "rrr\n", //
997 //
998 "aaaa\n", // buffer 2
999 "bbbb\n", //
1000 "cccc\n", // <-- excerpt 4
1001 "dddd\n", // <-- excerpt 4
1002 "eeee\n", //
1003 "ffff\n", //
1004 //
1005 "iiii\n", //
1006 "jjjj\n", //
1007 "kkkk\n", // <-- excerpt 5
1008 "llll\n", //
1009 "mmmm", //
1010 )
1011 );
1012}
1013
1014#[gpui::test]
1015fn test_empty_multibuffer(cx: &mut App) {
1016 let multibuffer = cx.new(|_| MultiBuffer::new(Capability::ReadWrite));
1017
1018 let snapshot = multibuffer.read(cx).snapshot(cx);
1019 assert_eq!(snapshot.text(), "");
1020 assert_eq!(
1021 snapshot
1022 .row_infos(MultiBufferRow(0))
1023 .map(|info| info.buffer_row)
1024 .collect::<Vec<_>>(),
1025 &[Some(0)]
1026 );
1027 assert!(
1028 snapshot
1029 .row_infos(MultiBufferRow(1))
1030 .map(|info| info.buffer_row)
1031 .collect::<Vec<_>>()
1032 .is_empty(),
1033 );
1034}
1035
1036#[gpui::test]
1037async fn test_empty_diff_excerpt(cx: &mut TestAppContext) {
1038 let multibuffer = cx.new(|_| MultiBuffer::new(Capability::ReadWrite));
1039 let buffer = cx.new(|cx| Buffer::local("", cx));
1040 let base_text = "a\nb\nc";
1041
1042 let diff = cx
1043 .new(|cx| BufferDiff::new_with_base_text(base_text, &buffer.read(cx).text_snapshot(), cx));
1044 multibuffer.update(cx, |multibuffer, cx| {
1045 multibuffer.set_excerpt_ranges_for_path(
1046 PathKey::sorted(0),
1047 buffer.clone(),
1048 &buffer.read(cx).snapshot(),
1049 vec![ExcerptRange::new(Point::zero()..Point::zero())],
1050 cx,
1051 );
1052 multibuffer.set_all_diff_hunks_expanded(cx);
1053 multibuffer.add_diff(diff.clone(), cx);
1054 });
1055 cx.run_until_parked();
1056
1057 let snapshot = multibuffer.update(cx, |multibuffer, cx| multibuffer.snapshot(cx));
1058 assert_eq!(snapshot.text(), "a\nb\nc\n");
1059
1060 let hunk = snapshot
1061 .diff_hunks_in_range(Point::new(1, 1)..Point::new(1, 1))
1062 .next()
1063 .unwrap();
1064
1065 assert_eq!(hunk.diff_base_byte_range.start, BufferOffset(0));
1066
1067 let buf2 = cx.new(|cx| Buffer::local("X", cx));
1068 multibuffer.update(cx, |multibuffer, cx| {
1069 multibuffer.set_excerpts_for_path(
1070 PathKey::sorted(1),
1071 buf2,
1072 [Point::new(0, 0)..Point::new(0, 1)],
1073 0,
1074 cx,
1075 );
1076 });
1077
1078 buffer.update(cx, |buffer, cx| {
1079 buffer.edit([(0..0, "a\nb\nc")], None, cx);
1080 diff.update(cx, |diff, cx| {
1081 diff.recalculate_diff_sync(&buffer.text_snapshot(), cx);
1082 });
1083 assert_eq!(buffer.text(), "a\nb\nc")
1084 });
1085 cx.run_until_parked();
1086
1087 let snapshot = multibuffer.update(cx, |multibuffer, cx| multibuffer.snapshot(cx));
1088 assert_eq!(snapshot.text(), "a\nb\nc\nX");
1089
1090 buffer.update(cx, |buffer, cx| {
1091 buffer.undo(cx);
1092 diff.update(cx, |diff, cx| {
1093 diff.recalculate_diff_sync(&buffer.text_snapshot(), cx);
1094 });
1095 assert_eq!(buffer.text(), "")
1096 });
1097 cx.run_until_parked();
1098
1099 let snapshot = multibuffer.update(cx, |multibuffer, cx| multibuffer.snapshot(cx));
1100 assert_eq!(snapshot.text(), "a\nb\nc\n\nX");
1101}
1102
1103#[gpui::test]
1104fn test_singleton_multibuffer_anchors(cx: &mut App) {
1105 let buffer = cx.new(|cx| Buffer::local("abcd", cx));
1106 let multibuffer = cx.new(|cx| MultiBuffer::singleton(buffer.clone(), cx));
1107 let old_snapshot = multibuffer.read(cx).snapshot(cx);
1108 buffer.update(cx, |buffer, cx| {
1109 buffer.edit([(0..0, "X")], None, cx);
1110 buffer.edit([(5..5, "Y")], None, cx);
1111 });
1112 dbg!("-------");
1113 let new_snapshot = multibuffer.read(cx).snapshot(cx);
1114
1115 assert_eq!(old_snapshot.text(), "abcd");
1116 assert_eq!(new_snapshot.text(), "XabcdY");
1117
1118 assert_eq!(
1119 old_snapshot
1120 .anchor_before(MultiBufferOffset(0))
1121 .to_offset(&new_snapshot),
1122 MultiBufferOffset(0)
1123 );
1124 assert_eq!(
1125 old_snapshot
1126 .anchor_after(MultiBufferOffset(0))
1127 .to_offset(&new_snapshot),
1128 MultiBufferOffset(1)
1129 );
1130 assert_eq!(
1131 old_snapshot
1132 .anchor_before(MultiBufferOffset(4))
1133 .to_offset(&new_snapshot),
1134 MultiBufferOffset(5)
1135 );
1136 assert_eq!(
1137 old_snapshot
1138 .anchor_after(MultiBufferOffset(4))
1139 .to_offset(&new_snapshot),
1140 MultiBufferOffset(6)
1141 );
1142}
1143
1144#[gpui::test]
1145fn test_multibuffer_anchors(cx: &mut App) {
1146 let buffer_1 = cx.new(|cx| Buffer::local("abcd", cx));
1147 let buffer_2 = cx.new(|cx| Buffer::local("efghi", cx));
1148 let multibuffer = cx.new(|cx| {
1149 let mut multibuffer = MultiBuffer::new(Capability::ReadWrite);
1150 multibuffer.set_excerpts_for_path(
1151 PathKey::sorted(0),
1152 buffer_1.clone(),
1153 [Point::new(0, 0)..Point::new(0, 4)],
1154 0,
1155 cx,
1156 );
1157 multibuffer.set_excerpts_for_path(
1158 PathKey::sorted(1),
1159 buffer_2.clone(),
1160 [Point::new(0, 0)..Point::new(0, 5)],
1161 0,
1162 cx,
1163 );
1164 multibuffer
1165 });
1166 let old_snapshot = multibuffer.read(cx).snapshot(cx);
1167
1168 assert_eq!(
1169 old_snapshot
1170 .anchor_before(MultiBufferOffset(0))
1171 .to_offset(&old_snapshot),
1172 MultiBufferOffset(0)
1173 );
1174 assert_eq!(
1175 old_snapshot
1176 .anchor_after(MultiBufferOffset(0))
1177 .to_offset(&old_snapshot),
1178 MultiBufferOffset(0)
1179 );
1180 assert_eq!(Anchor::min().to_offset(&old_snapshot), MultiBufferOffset(0));
1181 assert_eq!(Anchor::min().to_offset(&old_snapshot), MultiBufferOffset(0));
1182 assert_eq!(
1183 Anchor::max().to_offset(&old_snapshot),
1184 MultiBufferOffset(10)
1185 );
1186 assert_eq!(
1187 Anchor::max().to_offset(&old_snapshot),
1188 MultiBufferOffset(10)
1189 );
1190
1191 buffer_1.update(cx, |buffer, cx| {
1192 buffer.edit([(0..0, "W")], None, cx);
1193 buffer.edit([(5..5, "X")], None, cx);
1194 });
1195 buffer_2.update(cx, |buffer, cx| {
1196 buffer.edit([(0..0, "Y")], None, cx);
1197 buffer.edit([(6..6, "Z")], None, cx);
1198 });
1199 let new_snapshot = multibuffer.read(cx).snapshot(cx);
1200
1201 assert_eq!(old_snapshot.text(), "abcd\nefghi");
1202 assert_eq!(new_snapshot.text(), "WabcdX\nYefghiZ");
1203
1204 assert_eq!(
1205 old_snapshot
1206 .anchor_before(MultiBufferOffset(0))
1207 .to_offset(&new_snapshot),
1208 MultiBufferOffset(0)
1209 );
1210 assert_eq!(
1211 old_snapshot
1212 .anchor_after(MultiBufferOffset(0))
1213 .to_offset(&new_snapshot),
1214 MultiBufferOffset(1)
1215 );
1216 assert_eq!(
1217 old_snapshot
1218 .anchor_before(MultiBufferOffset(1))
1219 .to_offset(&new_snapshot),
1220 MultiBufferOffset(2)
1221 );
1222 assert_eq!(
1223 old_snapshot
1224 .anchor_after(MultiBufferOffset(1))
1225 .to_offset(&new_snapshot),
1226 MultiBufferOffset(2)
1227 );
1228 assert_eq!(
1229 old_snapshot
1230 .anchor_before(MultiBufferOffset(2))
1231 .to_offset(&new_snapshot),
1232 MultiBufferOffset(3)
1233 );
1234 assert_eq!(
1235 old_snapshot
1236 .anchor_after(MultiBufferOffset(2))
1237 .to_offset(&new_snapshot),
1238 MultiBufferOffset(3)
1239 );
1240 assert_eq!(
1241 old_snapshot
1242 .anchor_before(MultiBufferOffset(5))
1243 .to_offset(&new_snapshot),
1244 MultiBufferOffset(7)
1245 );
1246 assert_eq!(
1247 old_snapshot
1248 .anchor_after(MultiBufferOffset(5))
1249 .to_offset(&new_snapshot),
1250 MultiBufferOffset(8)
1251 );
1252 assert_eq!(
1253 old_snapshot
1254 .anchor_before(MultiBufferOffset(10))
1255 .to_offset(&new_snapshot),
1256 MultiBufferOffset(13)
1257 );
1258 assert_eq!(
1259 old_snapshot
1260 .anchor_after(MultiBufferOffset(10))
1261 .to_offset(&new_snapshot),
1262 MultiBufferOffset(14)
1263 );
1264}
1265
1266#[gpui::test]
1267async fn test_basic_diff_hunks(cx: &mut TestAppContext) {
1268 let text = indoc!(
1269 "
1270 ZERO
1271 one
1272 TWO
1273 three
1274 six
1275 "
1276 );
1277 let base_text = indoc!(
1278 "
1279 one
1280 two
1281 three
1282 four
1283 five
1284 six
1285 "
1286 );
1287
1288 let buffer = cx.new(|cx| Buffer::local(text, cx));
1289 let diff = cx
1290 .new(|cx| BufferDiff::new_with_base_text(base_text, &buffer.read(cx).text_snapshot(), cx));
1291 cx.run_until_parked();
1292
1293 let multibuffer = cx.new(|cx| {
1294 let mut multibuffer = MultiBuffer::singleton(buffer.clone(), cx);
1295 multibuffer.add_diff(diff.clone(), cx);
1296 multibuffer
1297 });
1298
1299 let (mut snapshot, mut subscription) = multibuffer.update(cx, |multibuffer, cx| {
1300 (multibuffer.snapshot(cx), multibuffer.subscribe())
1301 });
1302 assert_eq!(
1303 snapshot.text(),
1304 indoc!(
1305 "
1306 ZERO
1307 one
1308 TWO
1309 three
1310 six
1311 "
1312 ),
1313 );
1314
1315 multibuffer.update(cx, |multibuffer, cx| {
1316 multibuffer.expand_diff_hunks(vec![Anchor::min()..Anchor::max()], cx);
1317 });
1318
1319 assert_new_snapshot(
1320 &multibuffer,
1321 &mut snapshot,
1322 &mut subscription,
1323 cx,
1324 indoc!(
1325 "
1326 + ZERO
1327 one
1328 - two
1329 + TWO
1330 three
1331 - four
1332 - five
1333 six
1334 "
1335 ),
1336 );
1337
1338 assert_eq!(
1339 snapshot
1340 .row_infos(MultiBufferRow(0))
1341 .map(|info| (info.buffer_row, info.diff_status))
1342 .collect::<Vec<_>>(),
1343 vec![
1344 (Some(0), Some(DiffHunkStatus::added_none())),
1345 (Some(1), None),
1346 (Some(1), Some(DiffHunkStatus::deleted_none())),
1347 (Some(2), Some(DiffHunkStatus::added_none())),
1348 (Some(3), None),
1349 (Some(3), Some(DiffHunkStatus::deleted_none())),
1350 (Some(4), Some(DiffHunkStatus::deleted_none())),
1351 (Some(4), None),
1352 (Some(5), None)
1353 ]
1354 );
1355
1356 assert_chunks_in_ranges(&snapshot);
1357 assert_consistent_line_numbers(&snapshot);
1358 assert_position_translation(&snapshot);
1359 assert_line_indents(&snapshot);
1360
1361 multibuffer.update(cx, |multibuffer, cx| {
1362 multibuffer.collapse_diff_hunks(vec![Anchor::min()..Anchor::max()], cx)
1363 });
1364 assert_new_snapshot(
1365 &multibuffer,
1366 &mut snapshot,
1367 &mut subscription,
1368 cx,
1369 indoc!(
1370 "
1371 ZERO
1372 one
1373 TWO
1374 three
1375 six
1376 "
1377 ),
1378 );
1379
1380 assert_chunks_in_ranges(&snapshot);
1381 assert_consistent_line_numbers(&snapshot);
1382 assert_position_translation(&snapshot);
1383 assert_line_indents(&snapshot);
1384
1385 // Expand the first diff hunk
1386 multibuffer.update(cx, |multibuffer, cx| {
1387 let position = multibuffer.read(cx).anchor_before(Point::new(2, 2));
1388 multibuffer.expand_diff_hunks(vec![position..position], cx)
1389 });
1390 assert_new_snapshot(
1391 &multibuffer,
1392 &mut snapshot,
1393 &mut subscription,
1394 cx,
1395 indoc!(
1396 "
1397 ZERO
1398 one
1399 - two
1400 + TWO
1401 three
1402 six
1403 "
1404 ),
1405 );
1406
1407 // Expand the second diff hunk
1408 multibuffer.update(cx, |multibuffer, cx| {
1409 let start = multibuffer.read(cx).anchor_before(Point::new(4, 0));
1410 let end = multibuffer.read(cx).anchor_before(Point::new(5, 0));
1411 multibuffer.expand_diff_hunks(vec![start..end], cx)
1412 });
1413 assert_new_snapshot(
1414 &multibuffer,
1415 &mut snapshot,
1416 &mut subscription,
1417 cx,
1418 indoc!(
1419 "
1420 ZERO
1421 one
1422 - two
1423 + TWO
1424 three
1425 - four
1426 - five
1427 six
1428 "
1429 ),
1430 );
1431
1432 assert_chunks_in_ranges(&snapshot);
1433 assert_consistent_line_numbers(&snapshot);
1434 assert_position_translation(&snapshot);
1435 assert_line_indents(&snapshot);
1436
1437 // Edit the buffer before the first hunk
1438 buffer.update(cx, |buffer, cx| {
1439 buffer.edit_via_marked_text(
1440 indoc!(
1441 "
1442 ZERO
1443 one« hundred
1444 thousand»
1445 TWO
1446 three
1447 six
1448 "
1449 ),
1450 None,
1451 cx,
1452 );
1453 });
1454 assert_new_snapshot(
1455 &multibuffer,
1456 &mut snapshot,
1457 &mut subscription,
1458 cx,
1459 indoc!(
1460 "
1461 ZERO
1462 one hundred
1463 thousand
1464 - two
1465 + TWO
1466 three
1467 - four
1468 - five
1469 six
1470 "
1471 ),
1472 );
1473
1474 assert_chunks_in_ranges(&snapshot);
1475 assert_consistent_line_numbers(&snapshot);
1476 assert_position_translation(&snapshot);
1477 assert_line_indents(&snapshot);
1478
1479 // Recalculate the diff, changing the first diff hunk.
1480 diff.update(cx, |diff, cx| {
1481 diff.recalculate_diff_sync(&buffer.read(cx).text_snapshot(), cx);
1482 });
1483 cx.run_until_parked();
1484 assert_new_snapshot(
1485 &multibuffer,
1486 &mut snapshot,
1487 &mut subscription,
1488 cx,
1489 indoc!(
1490 "
1491 ZERO
1492 one hundred
1493 thousand
1494 TWO
1495 three
1496 - four
1497 - five
1498 six
1499 "
1500 ),
1501 );
1502
1503 assert_eq!(
1504 snapshot
1505 .diff_hunks_in_range(MultiBufferOffset(0)..snapshot.len())
1506 .map(|hunk| hunk.row_range.start.0..hunk.row_range.end.0)
1507 .collect::<Vec<_>>(),
1508 &[0..4, 5..7]
1509 );
1510}
1511
1512#[gpui::test]
1513async fn test_repeatedly_expand_a_diff_hunk(cx: &mut TestAppContext) {
1514 let text = indoc!(
1515 "
1516 one
1517 TWO
1518 THREE
1519 four
1520 FIVE
1521 six
1522 "
1523 );
1524 let base_text = indoc!(
1525 "
1526 one
1527 four
1528 five
1529 six
1530 "
1531 );
1532
1533 let buffer = cx.new(|cx| Buffer::local(text, cx));
1534 let diff = cx
1535 .new(|cx| BufferDiff::new_with_base_text(base_text, &buffer.read(cx).text_snapshot(), cx));
1536 cx.run_until_parked();
1537
1538 let multibuffer = cx.new(|cx| {
1539 let mut multibuffer = MultiBuffer::singleton(buffer.clone(), cx);
1540 multibuffer.add_diff(diff.clone(), cx);
1541 multibuffer
1542 });
1543
1544 let (mut snapshot, mut subscription) = multibuffer.update(cx, |multibuffer, cx| {
1545 (multibuffer.snapshot(cx), multibuffer.subscribe())
1546 });
1547
1548 multibuffer.update(cx, |multibuffer, cx| {
1549 multibuffer.expand_diff_hunks(vec![Anchor::min()..Anchor::max()], cx);
1550 });
1551
1552 assert_new_snapshot(
1553 &multibuffer,
1554 &mut snapshot,
1555 &mut subscription,
1556 cx,
1557 indoc!(
1558 "
1559 one
1560 + TWO
1561 + THREE
1562 four
1563 - five
1564 + FIVE
1565 six
1566 "
1567 ),
1568 );
1569
1570 // Regression test: expanding diff hunks that are already expanded should not change anything.
1571 multibuffer.update(cx, |multibuffer, cx| {
1572 multibuffer.expand_diff_hunks(
1573 vec![
1574 snapshot.anchor_before(Point::new(2, 0))..snapshot.anchor_before(Point::new(2, 0)),
1575 ],
1576 cx,
1577 );
1578 });
1579
1580 assert_new_snapshot(
1581 &multibuffer,
1582 &mut snapshot,
1583 &mut subscription,
1584 cx,
1585 indoc!(
1586 "
1587 one
1588 + TWO
1589 + THREE
1590 four
1591 - five
1592 + FIVE
1593 six
1594 "
1595 ),
1596 );
1597
1598 // Now collapse all diff hunks
1599 multibuffer.update(cx, |multibuffer, cx| {
1600 multibuffer.collapse_diff_hunks(vec![Anchor::min()..Anchor::max()], cx);
1601 });
1602
1603 assert_new_snapshot(
1604 &multibuffer,
1605 &mut snapshot,
1606 &mut subscription,
1607 cx,
1608 indoc!(
1609 "
1610 one
1611 TWO
1612 THREE
1613 four
1614 FIVE
1615 six
1616 "
1617 ),
1618 );
1619
1620 // Expand the hunks again, but this time provide two ranges that are both within the same hunk
1621 // Target the first hunk which is between "one" and "four"
1622 multibuffer.update(cx, |multibuffer, cx| {
1623 multibuffer.expand_diff_hunks(
1624 vec![
1625 snapshot.anchor_before(Point::new(4, 0))..snapshot.anchor_before(Point::new(4, 0)),
1626 snapshot.anchor_before(Point::new(4, 2))..snapshot.anchor_before(Point::new(4, 2)),
1627 ],
1628 cx,
1629 );
1630 });
1631 assert_new_snapshot(
1632 &multibuffer,
1633 &mut snapshot,
1634 &mut subscription,
1635 cx,
1636 indoc!(
1637 "
1638 one
1639 TWO
1640 THREE
1641 four
1642 - five
1643 + FIVE
1644 six
1645 "
1646 ),
1647 );
1648}
1649
1650#[gpui::test]
1651fn test_set_excerpts_for_buffer_ordering(cx: &mut TestAppContext) {
1652 let buf1 = cx.new(|cx| {
1653 Buffer::local(
1654 indoc! {
1655 "zero
1656 one
1657 two
1658 two.five
1659 three
1660 four
1661 five
1662 six
1663 seven
1664 eight
1665 nine
1666 ten
1667 eleven
1668 ",
1669 },
1670 cx,
1671 )
1672 });
1673 let path1: PathKey = PathKey::with_sort_prefix(0, rel_path("root").into_arc());
1674
1675 let multibuffer = cx.new(|_| MultiBuffer::new(Capability::ReadWrite));
1676 multibuffer.update(cx, |multibuffer, cx| {
1677 multibuffer.set_excerpts_for_path(
1678 path1.clone(),
1679 buf1.clone(),
1680 vec![
1681 Point::row_range(1..2),
1682 Point::row_range(6..7),
1683 Point::row_range(11..12),
1684 ],
1685 1,
1686 cx,
1687 );
1688 });
1689
1690 assert_excerpts_match(
1691 &multibuffer,
1692 cx,
1693 indoc! {
1694 "-----
1695 zero
1696 one
1697 two
1698 two.five
1699 -----
1700 four
1701 five
1702 six
1703 seven
1704 -----
1705 nine
1706 ten
1707 eleven
1708 "
1709 },
1710 );
1711
1712 buf1.update(cx, |buffer, cx| buffer.edit([(0..5, "")], None, cx));
1713
1714 multibuffer.update(cx, |multibuffer, cx| {
1715 multibuffer.set_excerpts_for_path(
1716 path1.clone(),
1717 buf1.clone(),
1718 vec![
1719 Point::row_range(0..3),
1720 Point::row_range(5..7),
1721 Point::row_range(10..11),
1722 ],
1723 1,
1724 cx,
1725 );
1726 });
1727
1728 assert_excerpts_match(
1729 &multibuffer,
1730 cx,
1731 indoc! {
1732 "-----
1733 one
1734 two
1735 two.five
1736 three
1737 four
1738 five
1739 six
1740 seven
1741 eight
1742 nine
1743 ten
1744 eleven
1745 "
1746 },
1747 );
1748}
1749
1750#[gpui::test]
1751fn test_set_excerpts_for_buffer(cx: &mut TestAppContext) {
1752 let buf1 = cx.new(|cx| {
1753 Buffer::local(
1754 indoc! {
1755 "zero
1756 one
1757 two
1758 three
1759 four
1760 five
1761 six
1762 seven
1763 ",
1764 },
1765 cx,
1766 )
1767 });
1768 let path1: PathKey = PathKey::with_sort_prefix(0, rel_path("root").into_arc());
1769 let buf2 = cx.new(|cx| {
1770 Buffer::local(
1771 indoc! {
1772 "000
1773 111
1774 222
1775 333
1776 444
1777 555
1778 666
1779 777
1780 888
1781 999
1782 "
1783 },
1784 cx,
1785 )
1786 });
1787 let path2 = PathKey::with_sort_prefix(1, rel_path("root").into_arc());
1788
1789 let multibuffer = cx.new(|_| MultiBuffer::new(Capability::ReadWrite));
1790 multibuffer.update(cx, |multibuffer, cx| {
1791 multibuffer.set_excerpts_for_path(
1792 path1.clone(),
1793 buf1.clone(),
1794 vec![Point::row_range(0..1)],
1795 2,
1796 cx,
1797 );
1798 });
1799
1800 assert_excerpts_match(
1801 &multibuffer,
1802 cx,
1803 indoc! {
1804 "-----
1805 zero
1806 one
1807 two
1808 three
1809 "
1810 },
1811 );
1812
1813 multibuffer.update(cx, |multibuffer, cx| {
1814 multibuffer.set_excerpts_for_path(path1.clone(), buf1.clone(), vec![], 2, cx);
1815 });
1816
1817 assert_excerpts_match(&multibuffer, cx, "");
1818
1819 multibuffer.update(cx, |multibuffer, cx| {
1820 multibuffer.set_excerpts_for_path(
1821 path1.clone(),
1822 buf1.clone(),
1823 vec![Point::row_range(0..1), Point::row_range(7..8)],
1824 2,
1825 cx,
1826 );
1827 });
1828
1829 assert_excerpts_match(
1830 &multibuffer,
1831 cx,
1832 indoc! {"-----
1833 zero
1834 one
1835 two
1836 three
1837 -----
1838 five
1839 six
1840 seven
1841 "},
1842 );
1843
1844 multibuffer.update(cx, |multibuffer, cx| {
1845 multibuffer.set_excerpts_for_path(
1846 path1.clone(),
1847 buf1.clone(),
1848 vec![Point::row_range(0..1), Point::row_range(5..6)],
1849 2,
1850 cx,
1851 );
1852 });
1853
1854 assert_excerpts_match(
1855 &multibuffer,
1856 cx,
1857 indoc! {"-----
1858 zero
1859 one
1860 two
1861 three
1862 four
1863 five
1864 six
1865 seven
1866 "},
1867 );
1868
1869 multibuffer.update(cx, |multibuffer, cx| {
1870 multibuffer.set_excerpts_for_path(
1871 path2.clone(),
1872 buf2.clone(),
1873 vec![Point::row_range(2..3)],
1874 2,
1875 cx,
1876 );
1877 });
1878
1879 assert_excerpts_match(
1880 &multibuffer,
1881 cx,
1882 indoc! {"-----
1883 zero
1884 one
1885 two
1886 three
1887 four
1888 five
1889 six
1890 seven
1891 -----
1892 000
1893 111
1894 222
1895 333
1896 444
1897 555
1898 "},
1899 );
1900
1901 multibuffer.update(cx, |multibuffer, cx| {
1902 multibuffer.set_excerpts_for_path(path1.clone(), buf1.clone(), vec![], 2, cx);
1903 });
1904
1905 multibuffer.update(cx, |multibuffer, cx| {
1906 multibuffer.set_excerpts_for_path(
1907 path1.clone(),
1908 buf1.clone(),
1909 vec![Point::row_range(3..4)],
1910 2,
1911 cx,
1912 );
1913 });
1914
1915 assert_excerpts_match(
1916 &multibuffer,
1917 cx,
1918 indoc! {"-----
1919 one
1920 two
1921 three
1922 four
1923 five
1924 six
1925 -----
1926 000
1927 111
1928 222
1929 333
1930 444
1931 555
1932 "},
1933 );
1934
1935 multibuffer.update(cx, |multibuffer, cx| {
1936 multibuffer.set_excerpts_for_path(
1937 path1.clone(),
1938 buf1.clone(),
1939 vec![Point::row_range(3..4)],
1940 2,
1941 cx,
1942 );
1943 });
1944}
1945
1946#[gpui::test]
1947fn test_set_excerpts_for_buffer_rename(cx: &mut TestAppContext) {
1948 let buf1 = cx.new(|cx| {
1949 Buffer::local(
1950 indoc! {
1951 "zero
1952 one
1953 two
1954 three
1955 four
1956 five
1957 six
1958 seven
1959 ",
1960 },
1961 cx,
1962 )
1963 });
1964 let path: PathKey = PathKey::with_sort_prefix(0, rel_path("root").into_arc());
1965 let buf2 = cx.new(|cx| {
1966 Buffer::local(
1967 indoc! {
1968 "000
1969 111
1970 222
1971 333
1972 "
1973 },
1974 cx,
1975 )
1976 });
1977
1978 let multibuffer = cx.new(|_| MultiBuffer::new(Capability::ReadWrite));
1979 multibuffer.update(cx, |multibuffer, cx| {
1980 multibuffer.set_excerpts_for_path(
1981 path.clone(),
1982 buf1.clone(),
1983 vec![Point::row_range(1..1), Point::row_range(4..5)],
1984 1,
1985 cx,
1986 );
1987 });
1988
1989 assert_excerpts_match(
1990 &multibuffer,
1991 cx,
1992 indoc! {
1993 "-----
1994 zero
1995 one
1996 two
1997 three
1998 four
1999 five
2000 six
2001 "
2002 },
2003 );
2004
2005 multibuffer.update(cx, |multibuffer, cx| {
2006 multibuffer.set_excerpts_for_path(
2007 path.clone(),
2008 buf2.clone(),
2009 vec![Point::row_range(0..1)],
2010 2,
2011 cx,
2012 );
2013 });
2014
2015 assert_excerpts_match(
2016 &multibuffer,
2017 cx,
2018 indoc! {"-----
2019 000
2020 111
2021 222
2022 333
2023 "},
2024 );
2025}
2026
2027#[gpui::test]
2028async fn test_diff_hunks_with_multiple_excerpts(cx: &mut TestAppContext) {
2029 let base_text_1 = indoc!(
2030 "
2031 one
2032 two
2033 three
2034 four
2035 five
2036 six
2037 "
2038 );
2039 let text_1 = indoc!(
2040 "
2041 ZERO
2042 one
2043 TWO
2044 three
2045 six
2046 "
2047 );
2048 let base_text_2 = indoc!(
2049 "
2050 seven
2051 eight
2052 nine
2053 ten
2054 eleven
2055 twelve
2056 "
2057 );
2058 let text_2 = indoc!(
2059 "
2060 eight
2061 nine
2062 eleven
2063 THIRTEEN
2064 FOURTEEN
2065 "
2066 );
2067
2068 let buffer_1 = cx.new(|cx| Buffer::local(text_1, cx));
2069 let buffer_2 = cx.new(|cx| Buffer::local(text_2, cx));
2070 let diff_1 = cx.new(|cx| {
2071 BufferDiff::new_with_base_text(base_text_1, &buffer_1.read(cx).text_snapshot(), cx)
2072 });
2073 let diff_2 = cx.new(|cx| {
2074 BufferDiff::new_with_base_text(base_text_2, &buffer_2.read(cx).text_snapshot(), cx)
2075 });
2076 cx.run_until_parked();
2077
2078 let multibuffer = cx.new(|cx| {
2079 let mut multibuffer = MultiBuffer::new(Capability::ReadWrite);
2080 multibuffer.set_excerpts_for_path(
2081 PathKey::sorted(0),
2082 buffer_1.clone(),
2083 [Point::zero()..buffer_1.read(cx).max_point()],
2084 0,
2085 cx,
2086 );
2087 multibuffer.set_excerpts_for_path(
2088 PathKey::sorted(1),
2089 buffer_2.clone(),
2090 [Point::zero()..buffer_2.read(cx).max_point()],
2091 0,
2092 cx,
2093 );
2094 multibuffer.add_diff(diff_1.clone(), cx);
2095 multibuffer.add_diff(diff_2.clone(), cx);
2096 multibuffer
2097 });
2098
2099 let (mut snapshot, mut subscription) = multibuffer.update(cx, |multibuffer, cx| {
2100 (multibuffer.snapshot(cx), multibuffer.subscribe())
2101 });
2102 assert_eq!(
2103 snapshot.text(),
2104 indoc!(
2105 "
2106 ZERO
2107 one
2108 TWO
2109 three
2110 six
2111
2112 eight
2113 nine
2114 eleven
2115 THIRTEEN
2116 FOURTEEN
2117 "
2118 ),
2119 );
2120
2121 multibuffer.update(cx, |multibuffer, cx| {
2122 multibuffer.expand_diff_hunks(vec![Anchor::min()..Anchor::max()], cx);
2123 });
2124
2125 assert_new_snapshot(
2126 &multibuffer,
2127 &mut snapshot,
2128 &mut subscription,
2129 cx,
2130 indoc!(
2131 "
2132 + ZERO
2133 one
2134 - two
2135 + TWO
2136 three
2137 - four
2138 - five
2139 six
2140
2141 - seven
2142 eight
2143 nine
2144 - ten
2145 eleven
2146 - twelve
2147 + THIRTEEN
2148 + FOURTEEN
2149 "
2150 ),
2151 );
2152
2153 let id_1 = buffer_1.read_with(cx, |buffer, _| buffer.remote_id());
2154 let id_2 = buffer_2.read_with(cx, |buffer, _| buffer.remote_id());
2155 let base_id_1 = diff_1.read_with(cx, |diff, cx| diff.base_text(cx).remote_id());
2156 let base_id_2 = diff_2.read_with(cx, |diff, cx| diff.base_text(cx).remote_id());
2157
2158 let buffer_lines = (0..=snapshot.max_row().0)
2159 .map(|row| {
2160 let (buffer, range) = snapshot.buffer_line_for_row(MultiBufferRow(row))?;
2161 Some((
2162 buffer.remote_id(),
2163 buffer.text_for_range(range).collect::<String>(),
2164 ))
2165 })
2166 .collect::<Vec<_>>();
2167 pretty_assertions::assert_eq!(
2168 buffer_lines,
2169 [
2170 Some((id_1, "ZERO".into())),
2171 Some((id_1, "one".into())),
2172 Some((base_id_1, "two".into())),
2173 Some((id_1, "TWO".into())),
2174 Some((id_1, " three".into())),
2175 Some((base_id_1, "four".into())),
2176 Some((base_id_1, "five".into())),
2177 Some((id_1, "six".into())),
2178 Some((id_1, "".into())),
2179 Some((base_id_2, "seven".into())),
2180 Some((id_2, " eight".into())),
2181 Some((id_2, "nine".into())),
2182 Some((base_id_2, "ten".into())),
2183 Some((id_2, "eleven".into())),
2184 Some((base_id_2, "twelve".into())),
2185 Some((id_2, "THIRTEEN".into())),
2186 Some((id_2, "FOURTEEN".into())),
2187 Some((id_2, "".into())),
2188 ]
2189 );
2190
2191 let buffer_ids_by_range = [
2192 (Point::new(0, 0)..Point::new(0, 0), &[id_1] as &[_]),
2193 (Point::new(0, 0)..Point::new(2, 0), &[id_1]),
2194 (Point::new(2, 0)..Point::new(2, 0), &[id_1]),
2195 (Point::new(3, 0)..Point::new(3, 0), &[id_1]),
2196 (Point::new(8, 0)..Point::new(9, 0), &[id_1]),
2197 (Point::new(8, 0)..Point::new(10, 0), &[id_1, id_2]),
2198 (Point::new(9, 0)..Point::new(9, 0), &[id_2]),
2199 ];
2200 for (range, buffer_ids) in buffer_ids_by_range {
2201 assert_eq!(
2202 snapshot
2203 .buffer_ids_for_range(range.clone())
2204 .collect::<Vec<_>>(),
2205 buffer_ids,
2206 "buffer_ids_for_range({range:?}"
2207 );
2208 }
2209
2210 assert_position_translation(&snapshot);
2211 assert_line_indents(&snapshot);
2212
2213 assert_eq!(
2214 snapshot
2215 .diff_hunks_in_range(MultiBufferOffset(0)..snapshot.len())
2216 .map(|hunk| hunk.row_range.start.0..hunk.row_range.end.0)
2217 .collect::<Vec<_>>(),
2218 &[0..1, 2..4, 5..7, 9..10, 12..13, 14..17]
2219 );
2220
2221 buffer_2.update(cx, |buffer, cx| {
2222 buffer.edit_via_marked_text(
2223 indoc!(
2224 "
2225 eight
2226 «»eleven
2227 THIRTEEN
2228 FOURTEEN
2229 "
2230 ),
2231 None,
2232 cx,
2233 );
2234 });
2235
2236 assert_new_snapshot(
2237 &multibuffer,
2238 &mut snapshot,
2239 &mut subscription,
2240 cx,
2241 indoc!(
2242 "
2243 + ZERO
2244 one
2245 - two
2246 + TWO
2247 three
2248 - four
2249 - five
2250 six
2251
2252 - seven
2253 eight
2254 eleven
2255 - twelve
2256 + THIRTEEN
2257 + FOURTEEN
2258 "
2259 ),
2260 );
2261
2262 assert_line_indents(&snapshot);
2263}
2264
2265/// A naive implementation of a multi-buffer that does not maintain
2266/// any derived state, used for comparison in a randomized test.
2267#[derive(Default)]
2268struct ReferenceMultibuffer {
2269 excerpts: Vec<ReferenceExcerpt>,
2270 diffs: HashMap<BufferId, Entity<BufferDiff>>,
2271 inverted_diffs: HashMap<BufferId, (Entity<BufferDiff>, Entity<language::Buffer>)>,
2272 expanded_diff_hunks_by_buffer: HashMap<BufferId, Vec<text::Anchor>>,
2273}
2274
2275#[derive(Debug)]
2276struct ReferenceExcerpt {
2277 path_key: PathKey,
2278 path_key_index: PathKeyIndex,
2279 buffer: Entity<Buffer>,
2280 range: Range<text::Anchor>,
2281}
2282
2283#[derive(Clone, Debug)]
2284struct ReferenceRegion {
2285 buffer_id: Option<BufferId>,
2286 range: Range<usize>,
2287 buffer_range: Option<Range<Point>>,
2288 status: Option<DiffHunkStatus>,
2289 excerpt_info: Option<ExcerptInfo>,
2290}
2291
2292impl ReferenceExcerpt {
2293 fn info(&self, cx: &App) -> ExcerptInfo {
2294 ExcerptInfo {
2295 path_key_index: self.path_key_index,
2296 buffer_id: self.buffer.read(cx).remote_id(),
2297 range: ExcerptRange::new(self.range.clone()),
2298 }
2299 }
2300}
2301
2302impl ReferenceMultibuffer {
2303 fn expand_excerpts(&mut self, excerpts: &HashSet<ExcerptInfo>, line_count: u32, cx: &App) {
2304 if line_count == 0 {
2305 return;
2306 }
2307
2308 for info in excerpts {
2309 let excerpt = self
2310 .excerpts
2311 .iter_mut()
2312 .find(|e| &e.info(cx) == info)
2313 .unwrap();
2314 let snapshot = excerpt.buffer.read(cx).snapshot();
2315 let mut point_range = excerpt.range.to_point(&snapshot);
2316 point_range.start = Point::new(point_range.start.row.saturating_sub(line_count), 0);
2317 point_range.end =
2318 snapshot.clip_point(Point::new(point_range.end.row + line_count, 0), Bias::Left);
2319 point_range.end.column = snapshot.line_len(point_range.end.row);
2320 excerpt.range =
2321 snapshot.anchor_before(point_range.start)..snapshot.anchor_after(point_range.end);
2322 }
2323 }
2324
2325 fn set_excerpts(
2326 &mut self,
2327 path_key: PathKey,
2328 path_key_index: PathKeyIndex,
2329 buffer: Entity<Buffer>,
2330 buffer_snapshot: &BufferSnapshot,
2331 ranges: Vec<ExcerptRange<Point>>,
2332 ) {
2333 self.excerpts.retain(|excerpt| {
2334 excerpt.path_key != path_key && excerpt.buffer.entity_id() != buffer.entity_id()
2335 });
2336
2337 let ranges = MultiBuffer::merge_excerpt_ranges(&ranges);
2338
2339 let (Ok(ix) | Err(ix)) = self
2340 .excerpts
2341 .binary_search_by(|probe| probe.path_key.cmp(&path_key));
2342 self.excerpts.splice(
2343 ix..ix,
2344 ranges.into_iter().map(|range| ReferenceExcerpt {
2345 path_key: path_key.clone(),
2346 path_key_index,
2347 buffer: buffer.clone(),
2348 range: buffer_snapshot.anchor_range_around(range.context),
2349 }),
2350 );
2351 }
2352
2353 fn expand_diff_hunks(&mut self, path_key: PathKey, range: Range<text::Anchor>, cx: &App) {
2354 let excerpt = self
2355 .excerpts
2356 .iter_mut()
2357 .find(|e| {
2358 e.path_key == path_key
2359 && e.range
2360 .start
2361 .cmp(&range.start, &e.buffer.read(cx).snapshot())
2362 .is_le()
2363 })
2364 .unwrap();
2365 let buffer = excerpt.buffer.read(cx).snapshot();
2366 let buffer_id = buffer.remote_id();
2367
2368 // Skip inverted excerpts - hunks are always expanded
2369 if self.inverted_diffs.contains_key(&buffer_id) {
2370 return;
2371 }
2372
2373 let Some(diff) = self.diffs.get(&buffer_id) else {
2374 return;
2375 };
2376 let excerpt_range = excerpt.range.to_offset(&buffer);
2377 let expanded_diff_hunks = self
2378 .expanded_diff_hunks_by_buffer
2379 .entry(buffer_id)
2380 .or_default();
2381 for hunk in diff
2382 .read(cx)
2383 .snapshot(cx)
2384 .hunks_intersecting_range(range, &buffer)
2385 {
2386 let hunk_range = hunk.buffer_range.to_offset(&buffer);
2387 if hunk_range.start < excerpt_range.start || hunk_range.start > excerpt_range.end {
2388 continue;
2389 }
2390 if let Err(ix) = expanded_diff_hunks
2391 .binary_search_by(|anchor| anchor.cmp(&hunk.buffer_range.start, &buffer))
2392 {
2393 log::info!(
2394 "expanding diff hunk {:?}. excerpt range:{:?}",
2395 hunk_range,
2396 excerpt_range
2397 );
2398 expanded_diff_hunks.insert(ix, hunk.buffer_range.start);
2399 } else {
2400 log::trace!("hunk {hunk_range:?} already expanded in excerpt");
2401 }
2402 }
2403 }
2404
2405 fn expected_content(&self, cx: &App) -> (String, Vec<RowInfo>, HashSet<MultiBufferRow>) {
2406 let mut text = String::new();
2407 let mut regions = Vec::<ReferenceRegion>::new();
2408 let mut excerpt_boundary_rows = HashSet::default();
2409 for excerpt in &self.excerpts {
2410 excerpt_boundary_rows.insert(MultiBufferRow(text.matches('\n').count() as u32));
2411 let buffer = excerpt.buffer.read(cx);
2412 let buffer_id = buffer.remote_id();
2413 let buffer_range = excerpt.range.to_offset(buffer);
2414
2415 if let Some((diff, main_buffer)) = self.inverted_diffs.get(&buffer_id) {
2416 let diff_snapshot = diff.read(cx).snapshot(cx);
2417 let main_buffer_snapshot = main_buffer.read(cx).snapshot();
2418
2419 let mut offset = buffer_range.start;
2420 for hunk in diff_snapshot.hunks_intersecting_base_text_range(
2421 buffer_range.clone(),
2422 &main_buffer_snapshot.text,
2423 ) {
2424 let mut hunk_base_range = hunk.diff_base_byte_range.clone();
2425
2426 hunk_base_range.end = hunk_base_range.end.min(buffer_range.end);
2427 if hunk_base_range.start > buffer_range.end
2428 || hunk_base_range.start < buffer_range.start
2429 {
2430 continue;
2431 }
2432
2433 // Add the text before the hunk
2434 if hunk_base_range.start >= offset {
2435 let len = text.len();
2436 text.extend(buffer.text_for_range(offset..hunk_base_range.start));
2437 if text.len() > len {
2438 regions.push(ReferenceRegion {
2439 buffer_id: Some(buffer_id),
2440 range: len..text.len(),
2441 buffer_range: Some(
2442 (offset..hunk_base_range.start).to_point(&buffer),
2443 ),
2444 status: None,
2445 excerpt_info: Some(excerpt.info(cx)),
2446 });
2447 }
2448 }
2449
2450 // Add the "deleted" region (base text that's not in main)
2451 if !hunk_base_range.is_empty() {
2452 let len = text.len();
2453 text.extend(buffer.text_for_range(hunk_base_range.clone()));
2454 regions.push(ReferenceRegion {
2455 buffer_id: Some(buffer_id),
2456 range: len..text.len(),
2457 buffer_range: Some(hunk_base_range.to_point(&buffer)),
2458 status: Some(DiffHunkStatus::deleted(hunk.secondary_status)),
2459 excerpt_info: Some(excerpt.info(cx)),
2460 });
2461 }
2462
2463 offset = hunk_base_range.end;
2464 }
2465
2466 // Add remaining buffer text
2467 let len = text.len();
2468 text.extend(buffer.text_for_range(offset..buffer_range.end));
2469 text.push('\n');
2470 regions.push(ReferenceRegion {
2471 buffer_id: Some(buffer_id),
2472 range: len..text.len(),
2473 buffer_range: Some((offset..buffer_range.end).to_point(&buffer)),
2474 status: None,
2475 excerpt_info: Some(excerpt.info(cx)),
2476 });
2477 } else {
2478 let diff = self.diffs.get(&buffer_id).unwrap().read(cx).snapshot(cx);
2479 let base_buffer = diff.base_text();
2480
2481 let mut offset = buffer_range.start;
2482 let hunks = diff
2483 .hunks_intersecting_range(excerpt.range.clone(), buffer)
2484 .peekable();
2485
2486 for hunk in hunks {
2487 // Ignore hunks that are outside the excerpt range.
2488 let mut hunk_range = hunk.buffer_range.to_offset(buffer);
2489
2490 hunk_range.end = hunk_range.end.min(buffer_range.end);
2491 if hunk_range.start > buffer_range.end || hunk_range.start < buffer_range.start
2492 {
2493 log::trace!("skipping hunk outside excerpt range");
2494 continue;
2495 }
2496
2497 if !self
2498 .expanded_diff_hunks_by_buffer
2499 .get(&buffer_id)
2500 .cloned()
2501 .into_iter()
2502 .flatten()
2503 .any(|expanded_anchor| {
2504 expanded_anchor.to_offset(buffer).max(buffer_range.start)
2505 == hunk_range.start.max(buffer_range.start)
2506 })
2507 {
2508 log::trace!("skipping a hunk that's not marked as expanded");
2509 continue;
2510 }
2511
2512 if !hunk.buffer_range.start.is_valid(buffer) {
2513 log::trace!("skipping hunk with deleted start: {:?}", hunk.range);
2514 continue;
2515 }
2516
2517 if hunk_range.start >= offset {
2518 // Add the buffer text before the hunk
2519 let len = text.len();
2520 text.extend(buffer.text_for_range(offset..hunk_range.start));
2521 if text.len() > len {
2522 regions.push(ReferenceRegion {
2523 buffer_id: Some(buffer_id),
2524 range: len..text.len(),
2525 buffer_range: Some((offset..hunk_range.start).to_point(&buffer)),
2526 status: None,
2527 excerpt_info: Some(excerpt.info(cx)),
2528 });
2529 }
2530
2531 // Add the deleted text for the hunk.
2532 if !hunk.diff_base_byte_range.is_empty() {
2533 let mut base_text = base_buffer
2534 .text_for_range(hunk.diff_base_byte_range.clone())
2535 .collect::<String>();
2536 if !base_text.ends_with('\n') {
2537 base_text.push('\n');
2538 }
2539 let len = text.len();
2540 text.push_str(&base_text);
2541 regions.push(ReferenceRegion {
2542 buffer_id: Some(base_buffer.remote_id()),
2543 range: len..text.len(),
2544 buffer_range: Some(
2545 hunk.diff_base_byte_range.to_point(&base_buffer),
2546 ),
2547 status: Some(DiffHunkStatus::deleted(hunk.secondary_status)),
2548 excerpt_info: Some(excerpt.info(cx)),
2549 });
2550 }
2551
2552 offset = hunk_range.start;
2553 }
2554
2555 // Add the inserted text for the hunk.
2556 if hunk_range.end > offset {
2557 let len = text.len();
2558 text.extend(buffer.text_for_range(offset..hunk_range.end));
2559 let range = len..text.len();
2560 let region = ReferenceRegion {
2561 buffer_id: Some(buffer_id),
2562 range,
2563 buffer_range: Some((offset..hunk_range.end).to_point(&buffer)),
2564 status: Some(DiffHunkStatus::added(hunk.secondary_status)),
2565 excerpt_info: Some(excerpt.info(cx)),
2566 };
2567 offset = hunk_range.end;
2568 regions.push(region);
2569 }
2570 }
2571
2572 // Add the buffer text for the rest of the excerpt.
2573 let len = text.len();
2574 text.extend(buffer.text_for_range(offset..buffer_range.end));
2575 text.push('\n');
2576 regions.push(ReferenceRegion {
2577 buffer_id: Some(buffer_id),
2578 range: len..text.len(),
2579 buffer_range: Some((offset..buffer_range.end).to_point(&buffer)),
2580 status: None,
2581 excerpt_info: Some(excerpt.info(cx)),
2582 });
2583 }
2584 }
2585
2586 // Remove final trailing newline.
2587 if self.excerpts.is_empty() {
2588 regions.push(ReferenceRegion {
2589 buffer_id: None,
2590 range: 0..1,
2591 buffer_range: Some(Point::new(0, 0)..Point::new(0, 1)),
2592 status: None,
2593 excerpt_info: None,
2594 });
2595 } else {
2596 text.pop();
2597 }
2598
2599 // Retrieve the row info using the region that contains
2600 // the start of each multi-buffer line.
2601 let mut ix = 0;
2602 let row_infos = text
2603 .split('\n')
2604 .map(|line| {
2605 let row_info = regions
2606 .iter()
2607 .position(|region| region.range.contains(&ix))
2608 .map_or(RowInfo::default(), |region_ix| {
2609 let region = regions[region_ix].clone();
2610 let buffer_row = region.buffer_range.as_ref().map(|buffer_range| {
2611 buffer_range.start.row
2612 + text[region.range.start..ix].matches('\n').count() as u32
2613 });
2614 let main_buffer = self
2615 .excerpts
2616 .iter()
2617 .find(|e| e.info(cx) == region.excerpt_info.clone().unwrap())
2618 .map(|e| e.buffer.clone());
2619 let is_excerpt_start = region_ix == 0
2620 || ®ions[region_ix - 1].excerpt_info != ®ion.excerpt_info
2621 || regions[region_ix - 1].range.is_empty();
2622 let mut is_excerpt_end = region_ix == regions.len() - 1
2623 || ®ions[region_ix + 1].excerpt_info != ®ion.excerpt_info;
2624 let is_start = !text[region.range.start..ix].contains('\n');
2625 let mut is_end = if region.range.end > text.len() {
2626 !text[ix..].contains('\n')
2627 } else {
2628 text[ix..region.range.end.min(text.len())]
2629 .matches('\n')
2630 .count()
2631 == 1
2632 };
2633 if region_ix < regions.len() - 1
2634 && !text[ix..].contains("\n")
2635 && (region.status == Some(DiffHunkStatus::added_none())
2636 || region.status.is_some_and(|s| s.is_deleted()))
2637 && regions[region_ix + 1].excerpt_info == region.excerpt_info
2638 && regions[region_ix + 1].range.start == text.len()
2639 {
2640 is_end = true;
2641 is_excerpt_end = true;
2642 }
2643 let multibuffer_row =
2644 MultiBufferRow(text[..ix].matches('\n').count() as u32);
2645 let mut expand_direction = None;
2646 if let Some(buffer) = &main_buffer {
2647 let buffer_row = buffer_row.unwrap();
2648 let needs_expand_up = is_excerpt_start && is_start && buffer_row > 0;
2649 let needs_expand_down = is_excerpt_end
2650 && is_end
2651 && buffer.read(cx).max_point().row > buffer_row;
2652 expand_direction = if needs_expand_up && needs_expand_down {
2653 Some(ExpandExcerptDirection::UpAndDown)
2654 } else if needs_expand_up {
2655 Some(ExpandExcerptDirection::Up)
2656 } else if needs_expand_down {
2657 Some(ExpandExcerptDirection::Down)
2658 } else {
2659 None
2660 };
2661 }
2662 RowInfo {
2663 buffer_id: region.buffer_id,
2664 diff_status: region.status,
2665 buffer_row,
2666 wrapped_buffer_row: None,
2667
2668 multibuffer_row: Some(multibuffer_row),
2669 expand_info: expand_direction.zip(region.excerpt_info.clone()).map(
2670 |(direction, excerpt_info)| ExpandInfo {
2671 direction,
2672 excerpt_range: excerpt_info.range.context,
2673 },
2674 ),
2675 }
2676 });
2677 ix += line.len() + 1;
2678 row_info
2679 })
2680 .collect();
2681
2682 (text, row_infos, excerpt_boundary_rows)
2683 }
2684
2685 fn diffs_updated(&mut self, cx: &App) {
2686 for excerpt in &mut self.excerpts {
2687 let buffer = excerpt.buffer.read(cx).snapshot();
2688 let buffer_id = buffer.remote_id();
2689
2690 // Skip inverted diff excerpts - hunks are always expanded
2691 if self.inverted_diffs.contains_key(&buffer_id) {
2692 continue;
2693 }
2694
2695 let excerpt_range = excerpt.range.to_offset(&buffer);
2696 let Some(diff) = self.diffs.get(&buffer_id) else {
2697 continue;
2698 };
2699 let diff = diff.read(cx).snapshot(cx);
2700 let mut hunks = diff.hunks_in_row_range(0..u32::MAX, &buffer).peekable();
2701 self.expanded_diff_hunks_by_buffer
2702 .entry(buffer_id)
2703 .or_default()
2704 .retain(|hunk_anchor| {
2705 if !hunk_anchor.is_valid(&buffer) {
2706 return false;
2707 }
2708 while let Some(hunk) = hunks.peek() {
2709 match hunk.buffer_range.start.cmp(hunk_anchor, &buffer) {
2710 cmp::Ordering::Less => {
2711 hunks.next();
2712 }
2713 cmp::Ordering::Equal => {
2714 let hunk_range = hunk.buffer_range.to_offset(&buffer);
2715 return hunk_range.end >= excerpt_range.start
2716 && hunk_range.start <= excerpt_range.end;
2717 }
2718 cmp::Ordering::Greater => break,
2719 }
2720 }
2721 false
2722 });
2723 }
2724 }
2725
2726 fn add_diff(&mut self, diff: Entity<BufferDiff>, cx: &mut App) {
2727 let buffer_id = diff.read(cx).buffer_id;
2728 self.diffs.insert(buffer_id, diff);
2729 }
2730
2731 fn add_inverted_diff(
2732 &mut self,
2733 diff: Entity<BufferDiff>,
2734 main_buffer: Entity<language::Buffer>,
2735 cx: &App,
2736 ) {
2737 let base_text_buffer_id = diff.read(cx).base_text(cx).remote_id();
2738 self.inverted_diffs
2739 .insert(base_text_buffer_id, (diff, main_buffer));
2740 }
2741}
2742
2743#[gpui::test(iterations = 100)]
2744async fn test_random_set_ranges(cx: &mut TestAppContext, mut rng: StdRng) {
2745 let base_text = "a\n".repeat(100);
2746 let buf = cx.update(|cx| cx.new(|cx| Buffer::local(base_text, cx)));
2747 let multibuffer = cx.new(|_| MultiBuffer::new(Capability::ReadWrite));
2748
2749 let operations = env::var("OPERATIONS")
2750 .map(|i| i.parse().expect("invalid `OPERATIONS` variable"))
2751 .unwrap_or(10);
2752
2753 fn row_ranges(ranges: &Vec<Range<Point>>) -> Vec<Range<u32>> {
2754 ranges
2755 .iter()
2756 .map(|range| range.start.row..range.end.row)
2757 .collect()
2758 }
2759
2760 for _ in 0..operations {
2761 let snapshot = buf.update(cx, |buf, _| buf.snapshot());
2762 let num_ranges = rng.random_range(0..=10);
2763 let max_row = snapshot.max_point().row;
2764 let mut ranges = (0..num_ranges)
2765 .map(|_| {
2766 let start = rng.random_range(0..max_row);
2767 let end = rng.random_range(start + 1..max_row + 1);
2768 Point::row_range(start..end)
2769 })
2770 .collect::<Vec<_>>();
2771 ranges.sort_by_key(|range| range.start);
2772 log::info!("Setting ranges: {:?}", row_ranges(&ranges));
2773 let (created, _) = multibuffer.update(cx, |multibuffer, cx| {
2774 multibuffer.set_excerpts_for_path(
2775 PathKey::for_buffer(&buf, cx),
2776 buf.clone(),
2777 ranges.clone(),
2778 2,
2779 cx,
2780 )
2781 });
2782
2783 assert_eq!(created.len(), ranges.len());
2784
2785 let snapshot = multibuffer.update(cx, |multibuffer, cx| multibuffer.snapshot(cx));
2786 let mut last_end = None;
2787 let mut seen_ranges = Vec::default();
2788
2789 for (buf, info) in snapshot.excerpts() {
2790 let start = info.range.context.start.to_point(buf);
2791 let end = info.range.context.end.to_point(buf);
2792 seen_ranges.push(start..end);
2793
2794 if let Some(last_end) = last_end.take() {
2795 assert!(
2796 start > last_end,
2797 "multibuffer has out-of-order ranges: {:?}; {:?} <= {:?}",
2798 row_ranges(&seen_ranges),
2799 start,
2800 last_end
2801 )
2802 }
2803
2804 ranges.retain(|range| range.start < start || range.end > end);
2805
2806 last_end = Some(end)
2807 }
2808
2809 assert!(
2810 ranges.is_empty(),
2811 "multibuffer {:?} did not include all ranges: {:?}",
2812 row_ranges(&seen_ranges),
2813 row_ranges(&ranges)
2814 );
2815 }
2816}
2817
2818#[gpui::test(iterations = 100)]
2819async fn test_random_multibuffer(cx: &mut TestAppContext, mut rng: StdRng) {
2820 let operations = env::var("OPERATIONS")
2821 .map(|i| i.parse().expect("invalid `OPERATIONS` variable"))
2822 .unwrap_or(10);
2823 let multibuffer = cx.new(|_| MultiBuffer::new(Capability::ReadWrite));
2824 let mut buffers: Vec<Entity<Buffer>> = Vec::new();
2825 let mut base_texts: HashMap<BufferId, String> = HashMap::default();
2826 let mut reference = ReferenceMultibuffer::default();
2827 let mut anchors = Vec::new();
2828 let mut old_versions = Vec::new();
2829 let mut needs_diff_calculation = false;
2830 let mut inverted_diff_main_buffers: HashMap<BufferId, Entity<BufferDiff>> = HashMap::default();
2831 for _ in 0..operations {
2832 match rng.random_range(0..100) {
2833 0..=14 if !buffers.is_empty() => {
2834 let buffer = buffers.choose(&mut rng).unwrap();
2835 buffer.update(cx, |buf, cx| {
2836 let edit_count = rng.random_range(1..5);
2837 buf.randomly_edit(&mut rng, edit_count, cx);
2838 log::info!("buffer text:\n{}", buf.text());
2839 needs_diff_calculation = true;
2840 });
2841 cx.update(|cx| reference.diffs_updated(cx));
2842 }
2843 15..=24 if !reference.excerpts.is_empty() => {
2844 multibuffer.update(cx, |multibuffer, cx| {
2845 let snapshot = multibuffer.snapshot(cx);
2846 let infos = snapshot
2847 .excerpts()
2848 .map(|(_, info)| info)
2849 .collect::<Vec<_>>();
2850 let mut excerpts = HashSet::default();
2851 for _ in 0..rng.random_range(0..infos.len()) {
2852 excerpts.extend(infos.choose(&mut rng).cloned());
2853 }
2854
2855 let line_count = rng.random_range(0..5);
2856
2857 let excerpt_ixs = excerpts
2858 .iter()
2859 .map(|info| {
2860 reference
2861 .excerpts
2862 .iter()
2863 .position(|e| e.info(cx) == *info)
2864 .unwrap()
2865 })
2866 .collect::<Vec<_>>();
2867 log::info!("Expanding excerpts {excerpt_ixs:?} by {line_count} lines");
2868 multibuffer.expand_excerpts_with_paths(
2869 excerpts.iter().map(|info| {
2870 Anchor::in_buffer(info.path_key_index, info.range.context.end)
2871 }),
2872 line_count,
2873 ExpandExcerptDirection::UpAndDown,
2874 cx,
2875 );
2876
2877 reference.expand_excerpts(&excerpts, line_count, cx);
2878 });
2879 }
2880 25..=34 if !reference.excerpts.is_empty() => {
2881 let multibuffer =
2882 multibuffer.read_with(cx, |multibuffer, cx| multibuffer.snapshot(cx));
2883 let offset = multibuffer.clip_offset(
2884 MultiBufferOffset(rng.random_range(0..=multibuffer.len().0)),
2885 Bias::Left,
2886 );
2887 let bias = if rng.random() {
2888 Bias::Left
2889 } else {
2890 Bias::Right
2891 };
2892 log::info!("Creating anchor at {} with bias {:?}", offset.0, bias);
2893 anchors.push(multibuffer.anchor_at(offset, bias));
2894 anchors.sort_by(|a, b| a.cmp(b, &multibuffer));
2895 }
2896 35..=45 if !reference.excerpts.is_empty() => {
2897 multibuffer.update(cx, |multibuffer, cx| {
2898 let snapshot = multibuffer.snapshot(cx);
2899 let excerpt_ix = rng.random_range(0..reference.excerpts.len());
2900 let excerpt = &reference.excerpts[excerpt_ix];
2901
2902 // Skip inverted excerpts - hunks can't be collapsed
2903 let buffer_id = excerpt.buffer.read(cx).remote_id();
2904 if reference.inverted_diffs.contains_key(&buffer_id) {
2905 return;
2906 }
2907
2908 let start = excerpt.range.start;
2909 let end = excerpt.range.end;
2910 let range = snapshot.anchor_in_buffer(excerpt.info(cx).buffer_id, start).unwrap()
2911 ..snapshot.anchor_in_buffer(excerpt.info(cx).buffer_id, end).unwrap();
2912
2913 log::info!(
2914 "expanding diff hunks in range {:?} (excerpt index {excerpt_ix:?}, buffer id {:?})",
2915 range.to_offset(&snapshot),
2916 buffer_id,
2917 );
2918 reference.expand_diff_hunks(excerpt.path_key.clone(), start..end, cx);
2919 multibuffer.expand_diff_hunks(vec![range], cx);
2920 });
2921 }
2922 46..=75 if needs_diff_calculation => {
2923 multibuffer.update(cx, |multibuffer, cx| {
2924 for buffer in multibuffer.all_buffers() {
2925 let snapshot = buffer.read(cx).snapshot();
2926 let buffer_id = snapshot.remote_id();
2927
2928 if let Some(diff) = multibuffer.diff_for(buffer_id) {
2929 diff.update(cx, |diff, cx| {
2930 log::info!("recalculating diff for buffer {:?}", buffer_id,);
2931 diff.recalculate_diff_sync(&snapshot.text, cx);
2932 });
2933 }
2934
2935 if let Some(inverted_diff) = inverted_diff_main_buffers.get(&buffer_id) {
2936 inverted_diff.update(cx, |diff, cx| {
2937 log::info!(
2938 "recalculating inverted diff for main buffer {:?}",
2939 buffer_id,
2940 );
2941 diff.recalculate_diff_sync(&snapshot.text, cx);
2942 });
2943 }
2944 }
2945 reference.diffs_updated(cx);
2946 needs_diff_calculation = false;
2947 });
2948 }
2949 _ => {
2950 // Decide if we're creating a new buffer or reusing an existing one
2951 let create_new_buffer = buffers.is_empty() || rng.random_bool(0.4);
2952
2953 let (excerpt_buffer, diff, inverted_main_buffer) = if create_new_buffer {
2954 let create_inverted = rng.random_bool(0.3);
2955
2956 if create_inverted {
2957 let mut main_buffer_text = util::RandomCharIter::new(&mut rng)
2958 .take(256)
2959 .collect::<String>();
2960 let main_buffer = cx.new(|cx| Buffer::local(main_buffer_text.clone(), cx));
2961 text::LineEnding::normalize(&mut main_buffer_text);
2962 let main_buffer_id =
2963 main_buffer.read_with(cx, |buffer, _| buffer.remote_id());
2964 base_texts.insert(main_buffer_id, main_buffer_text.clone());
2965 buffers.push(main_buffer.clone());
2966
2967 let diff = cx.new(|cx| {
2968 BufferDiff::new_with_base_text(
2969 &main_buffer_text,
2970 &main_buffer.read(cx).text_snapshot(),
2971 cx,
2972 )
2973 });
2974
2975 let base_text_buffer =
2976 diff.read_with(cx, |diff, _| diff.base_text_buffer().clone());
2977
2978 // Track for recalculation when main buffer is edited
2979 inverted_diff_main_buffers.insert(main_buffer_id, diff.clone());
2980
2981 (base_text_buffer, diff, Some(main_buffer))
2982 } else {
2983 let mut base_text = util::RandomCharIter::new(&mut rng)
2984 .take(256)
2985 .collect::<String>();
2986
2987 let buffer_handle = cx.new(|cx| Buffer::local(base_text.clone(), cx));
2988 text::LineEnding::normalize(&mut base_text);
2989 let buffer_id = buffer_handle.read_with(cx, |buffer, _| buffer.remote_id());
2990 base_texts.insert(buffer_id, base_text.clone());
2991 buffers.push(buffer_handle.clone());
2992
2993 let diff = cx.new(|cx| {
2994 BufferDiff::new_with_base_text(
2995 &base_text,
2996 &buffer_handle.read(cx).text_snapshot(),
2997 cx,
2998 )
2999 });
3000
3001 (buffer_handle, diff, None)
3002 }
3003 } else {
3004 // Reuse an existing buffer
3005 let buffer_handle = buffers.choose(&mut rng).unwrap().clone();
3006 let buffer_id = buffer_handle.read_with(cx, |buffer, _| buffer.remote_id());
3007
3008 if let Some(diff) = inverted_diff_main_buffers.get(&buffer_id) {
3009 let base_text_buffer =
3010 diff.read_with(cx, |diff, _| diff.base_text_buffer().clone());
3011 (base_text_buffer, diff.clone(), Some(buffer_handle))
3012 } else {
3013 // Get existing diff or create new one for regular buffer
3014 let diff = multibuffer
3015 .read_with(cx, |mb, _| mb.diff_for(buffer_id))
3016 .unwrap_or_else(|| {
3017 let base_text = base_texts.get(&buffer_id).unwrap();
3018 cx.new(|cx| {
3019 BufferDiff::new_with_base_text(
3020 base_text,
3021 &buffer_handle.read(cx).text_snapshot(),
3022 cx,
3023 )
3024 })
3025 });
3026 (buffer_handle, diff, None)
3027 }
3028 };
3029
3030 let excerpt_buffer_snapshot =
3031 excerpt_buffer.read_with(cx, |excerpt_buffer, _| excerpt_buffer.snapshot());
3032 let mut ranges = reference
3033 .excerpts
3034 .iter()
3035 .filter(|excerpt| excerpt.buffer == excerpt_buffer)
3036 .map(|excerpt| excerpt.range.to_point(&excerpt_buffer_snapshot))
3037 .collect::<Vec<_>>();
3038 mutate_excerpt_ranges(&mut rng, &mut ranges, &excerpt_buffer_snapshot, 1);
3039 let ranges = ranges
3040 .iter()
3041 .cloned()
3042 .map(ExcerptRange::new)
3043 .collect::<Vec<_>>();
3044 let path = cx.update(|cx| PathKey::for_buffer(&excerpt_buffer, cx));
3045
3046 let (_, path_key_index, _) = multibuffer.update(cx, |multibuffer, cx| {
3047 multibuffer.set_excerpt_ranges_for_path(
3048 path.clone(),
3049 excerpt_buffer.clone(),
3050 &excerpt_buffer_snapshot,
3051 ranges.clone(),
3052 cx,
3053 )
3054 });
3055
3056 reference.set_excerpts(
3057 path,
3058 path_key_index,
3059 excerpt_buffer.clone(),
3060 &excerpt_buffer_snapshot,
3061 ranges,
3062 );
3063
3064 let excerpt_buffer_id =
3065 excerpt_buffer.read_with(cx, |buffer, _| buffer.remote_id());
3066 multibuffer.update(cx, |multibuffer, cx| {
3067 if multibuffer.diff_for(excerpt_buffer_id).is_none() {
3068 if let Some(main_buffer) = inverted_main_buffer {
3069 reference.add_inverted_diff(diff.clone(), main_buffer.clone(), cx);
3070 multibuffer.add_inverted_diff(diff, main_buffer, cx);
3071 } else {
3072 reference.add_diff(diff.clone(), cx);
3073 multibuffer.add_diff(diff, cx);
3074 }
3075 }
3076 });
3077 }
3078 }
3079
3080 if rng.random_bool(0.3) {
3081 multibuffer.update(cx, |multibuffer, cx| {
3082 old_versions.push((multibuffer.snapshot(cx), multibuffer.subscribe()));
3083 })
3084 }
3085
3086 multibuffer.read_with(cx, |multibuffer, cx| {
3087 check_multibuffer(multibuffer, &reference, &anchors, cx, &mut rng);
3088 });
3089 }
3090 let snapshot = multibuffer.read_with(cx, |multibuffer, cx| multibuffer.snapshot(cx));
3091 for (old_snapshot, subscription) in old_versions {
3092 check_multibuffer_edits(&snapshot, &old_snapshot, subscription);
3093 }
3094}
3095
3096fn mutate_excerpt_ranges(
3097 rng: &mut StdRng,
3098 existing_ranges: &mut Vec<Range<Point>>,
3099 buffer: &BufferSnapshot,
3100 operations: u32,
3101) {
3102 let mut ranges_to_add = Vec::new();
3103
3104 for _ in 0..operations {
3105 // todo!() logging
3106 match rng.random_range(0..5) {
3107 0..=1 if !existing_ranges.is_empty() => {
3108 log::info!("Removing excerpt",);
3109 let index = rng.random_range(0..existing_ranges.len());
3110 existing_ranges.remove(index);
3111 }
3112 _ => {
3113 log::info!("Inserting excerpt",);
3114 let end_row = rng.random_range(0..=buffer.max_point().row);
3115 let start_row = rng.random_range(0..=end_row);
3116 ranges_to_add.push(Point::new(start_row, 0)..Point::new(end_row, 0));
3117 }
3118 }
3119 }
3120
3121 existing_ranges.extend(ranges_to_add);
3122 existing_ranges.sort_by(|l, r| l.start.cmp(&r.start));
3123}
3124
3125fn check_multibuffer(
3126 multibuffer: &MultiBuffer,
3127 reference: &ReferenceMultibuffer,
3128 anchors: &[Anchor],
3129 cx: &App,
3130 rng: &mut StdRng,
3131) {
3132 let snapshot = multibuffer.snapshot(cx);
3133 let actual_text = snapshot.text();
3134 let actual_boundary_rows = snapshot
3135 .excerpt_boundaries_in_range(MultiBufferOffset(0)..)
3136 .map(|b| b.row)
3137 .collect::<HashSet<_>>();
3138 let actual_row_infos = snapshot.row_infos(MultiBufferRow(0)).collect::<Vec<_>>();
3139
3140 let (expected_text, expected_row_infos, expected_boundary_rows) =
3141 reference.expected_content(cx);
3142
3143 let has_diff = actual_row_infos
3144 .iter()
3145 .any(|info| info.diff_status.is_some())
3146 || expected_row_infos
3147 .iter()
3148 .any(|info| info.diff_status.is_some());
3149 let actual_diff = format_diff(
3150 &actual_text,
3151 &actual_row_infos,
3152 &actual_boundary_rows,
3153 Some(has_diff),
3154 );
3155 let expected_diff = format_diff(
3156 &expected_text,
3157 &expected_row_infos,
3158 &expected_boundary_rows,
3159 Some(has_diff),
3160 );
3161
3162 log::info!("Multibuffer content:\n{}", actual_diff);
3163
3164 assert_eq!(
3165 actual_row_infos.len(),
3166 actual_text.split('\n').count(),
3167 "line count: {}",
3168 actual_text.split('\n').count()
3169 );
3170 pretty_assertions::assert_eq!(actual_diff, expected_diff);
3171 pretty_assertions::assert_eq!(actual_text, expected_text);
3172 pretty_assertions::assert_eq!(actual_row_infos, expected_row_infos);
3173
3174 for _ in 0..5 {
3175 let start_row = rng.random_range(0..=expected_row_infos.len());
3176 assert_eq!(
3177 snapshot
3178 .row_infos(MultiBufferRow(start_row as u32))
3179 .collect::<Vec<_>>(),
3180 &expected_row_infos[start_row..],
3181 "buffer_rows({})",
3182 start_row
3183 );
3184 }
3185
3186 assert_eq!(
3187 snapshot.widest_line_number(),
3188 expected_row_infos
3189 .into_iter()
3190 .filter_map(|info| {
3191 // For inverted diffs, deleted rows are visible and should be counted.
3192 // Only filter out deleted rows that are NOT from inverted diffs.
3193 let is_inverted_diff = info
3194 .buffer_id
3195 .is_some_and(|id| reference.inverted_diffs.contains_key(&id));
3196 if info.diff_status.is_some_and(|status| status.is_deleted()) && !is_inverted_diff {
3197 None
3198 } else {
3199 info.buffer_row
3200 }
3201 })
3202 .max()
3203 .unwrap()
3204 + 1
3205 );
3206 // let reference_ranges = reference
3207 // .excerpts
3208 // .iter()
3209 // .map(|excerpt| {
3210 // (
3211 // excerpt.info(cx),
3212 // excerpt.range.to_offset(&excerpt.buffer.read(cx).snapshot()),
3213 // )
3214 // })
3215 // .collect::<Vec<_>>();
3216 for i in 0..snapshot.len().0 {
3217 // todo!() this seems not useful
3218 let excerpt = snapshot
3219 .excerpt_containing(MultiBufferOffset(i)..MultiBufferOffset(i))
3220 .unwrap();
3221 let reference_range = reference
3222 .excerpts
3223 .iter()
3224 .find(|reference_excerpt| reference_excerpt.info(cx) == excerpt.excerpt.info())
3225 .map(|excerpt| excerpt.range.to_offset(&excerpt.buffer.read(cx).snapshot()))
3226 .expect("corresponding excerpt should exist in reference multibuffer");
3227 assert_eq!(
3228 excerpt.buffer_range(&snapshot).start.0..excerpt.buffer_range(&snapshot).end.0,
3229 reference_range
3230 );
3231 }
3232
3233 assert_consistent_line_numbers(&snapshot);
3234 assert_position_translation(&snapshot);
3235
3236 for (row, line) in expected_text.split('\n').enumerate() {
3237 assert_eq!(
3238 snapshot.line_len(MultiBufferRow(row as u32)),
3239 line.len() as u32,
3240 "line_len({}).",
3241 row
3242 );
3243 }
3244
3245 let text_rope = Rope::from(expected_text.as_str());
3246 for _ in 0..10 {
3247 let end_ix = text_rope.clip_offset(rng.random_range(0..=text_rope.len()), Bias::Right);
3248 let start_ix = text_rope.clip_offset(rng.random_range(0..=end_ix), Bias::Left);
3249
3250 let text_for_range = snapshot
3251 .text_for_range(MultiBufferOffset(start_ix)..MultiBufferOffset(end_ix))
3252 .collect::<String>();
3253 assert_eq!(
3254 text_for_range,
3255 &expected_text[start_ix..end_ix],
3256 "incorrect text for range {:?}",
3257 start_ix..end_ix
3258 );
3259
3260 let expected_summary =
3261 MBTextSummary::from(TextSummary::from(&expected_text[start_ix..end_ix]));
3262 assert_eq!(
3263 snapshot.text_summary_for_range::<MBTextSummary, _>(
3264 MultiBufferOffset(start_ix)..MultiBufferOffset(end_ix)
3265 ),
3266 expected_summary,
3267 "incorrect summary for range {:?}",
3268 start_ix..end_ix
3269 );
3270 }
3271
3272 // Anchor resolution
3273 let summaries = snapshot.summaries_for_anchors::<MultiBufferOffset, _>(anchors);
3274 assert_eq!(anchors.len(), summaries.len());
3275 for (anchor, resolved_offset) in anchors.iter().zip(summaries) {
3276 assert!(resolved_offset <= snapshot.len());
3277 assert_eq!(
3278 snapshot.summary_for_anchor::<MultiBufferOffset>(anchor),
3279 resolved_offset,
3280 "anchor: {:?}",
3281 anchor
3282 );
3283 }
3284
3285 for _ in 0..10 {
3286 let end_ix = text_rope.clip_offset(rng.random_range(0..=text_rope.len()), Bias::Right);
3287 assert_eq!(
3288 snapshot
3289 .reversed_chars_at(MultiBufferOffset(end_ix))
3290 .collect::<String>(),
3291 expected_text[..end_ix].chars().rev().collect::<String>(),
3292 );
3293 }
3294
3295 for _ in 0..10 {
3296 let end_ix = rng.random_range(0..=text_rope.len());
3297 let end_ix = text_rope.floor_char_boundary(end_ix);
3298 let start_ix = rng.random_range(0..=end_ix);
3299 let start_ix = text_rope.floor_char_boundary(start_ix);
3300 assert_eq!(
3301 snapshot
3302 .bytes_in_range(MultiBufferOffset(start_ix)..MultiBufferOffset(end_ix))
3303 .flatten()
3304 .copied()
3305 .collect::<Vec<_>>(),
3306 expected_text.as_bytes()[start_ix..end_ix].to_vec(),
3307 "bytes_in_range({:?})",
3308 start_ix..end_ix,
3309 );
3310 }
3311}
3312
3313fn check_multibuffer_edits(
3314 snapshot: &MultiBufferSnapshot,
3315 old_snapshot: &MultiBufferSnapshot,
3316 subscription: Subscription<MultiBufferOffset>,
3317) {
3318 let edits = subscription.consume().into_inner();
3319
3320 log::info!(
3321 "applying subscription edits to old text: {:?}: {:#?}",
3322 old_snapshot.text(),
3323 edits,
3324 );
3325
3326 let mut text = old_snapshot.text();
3327 for edit in edits {
3328 let new_text: String = snapshot
3329 .text_for_range(edit.new.start..edit.new.end)
3330 .collect();
3331 text.replace_range(
3332 (edit.new.start.0..edit.new.start.0 + (edit.old.end.0 - edit.old.start.0)).clone(),
3333 &new_text,
3334 );
3335 pretty_assertions::assert_eq!(
3336 &text[0..edit.new.end.0],
3337 snapshot
3338 .text_for_range(MultiBufferOffset(0)..edit.new.end)
3339 .collect::<String>()
3340 );
3341 }
3342 pretty_assertions::assert_eq!(text, snapshot.text());
3343}
3344
3345#[gpui::test]
3346fn test_history(cx: &mut App) {
3347 let test_settings = SettingsStore::test(cx);
3348 cx.set_global(test_settings);
3349
3350 let group_interval: Duration = Duration::from_millis(1);
3351 let buffer_1 = cx.new(|cx| {
3352 let mut buf = Buffer::local("1234", cx);
3353 buf.set_group_interval(group_interval);
3354 buf
3355 });
3356 let buffer_2 = cx.new(|cx| {
3357 let mut buf = Buffer::local("5678", cx);
3358 buf.set_group_interval(group_interval);
3359 buf
3360 });
3361 let multibuffer = cx.new(|_| MultiBuffer::new(Capability::ReadWrite));
3362 multibuffer.update(cx, |this, _| {
3363 this.set_group_interval(group_interval);
3364 });
3365 multibuffer.update(cx, |multibuffer, cx| {
3366 multibuffer.set_excerpts_for_path(
3367 PathKey::sorted(0),
3368 buffer_1.clone(),
3369 [Point::zero()..buffer_1.read(cx).max_point()],
3370 0,
3371 cx,
3372 );
3373 multibuffer.set_excerpts_for_path(
3374 PathKey::sorted(1),
3375 buffer_2.clone(),
3376 [Point::zero()..buffer_2.read(cx).max_point()],
3377 0,
3378 cx,
3379 );
3380 });
3381
3382 let mut now = Instant::now();
3383
3384 multibuffer.update(cx, |multibuffer, cx| {
3385 let transaction_1 = multibuffer.start_transaction_at(now, cx).unwrap();
3386 multibuffer.edit(
3387 [
3388 (Point::new(0, 0)..Point::new(0, 0), "A"),
3389 (Point::new(1, 0)..Point::new(1, 0), "A"),
3390 ],
3391 None,
3392 cx,
3393 );
3394 multibuffer.edit(
3395 [
3396 (Point::new(0, 1)..Point::new(0, 1), "B"),
3397 (Point::new(1, 1)..Point::new(1, 1), "B"),
3398 ],
3399 None,
3400 cx,
3401 );
3402 multibuffer.end_transaction_at(now, cx);
3403 assert_eq!(multibuffer.read(cx).text(), "AB1234\nAB5678");
3404
3405 // Verify edited ranges for transaction 1
3406 assert_eq!(
3407 multibuffer.edited_ranges_for_transaction(transaction_1, cx),
3408 &[
3409 MultiBufferOffset(0)..MultiBufferOffset(2),
3410 MultiBufferOffset(7)..MultiBufferOffset(9),
3411 ]
3412 );
3413
3414 // Edit buffer 1 through the multibuffer
3415 now += 2 * group_interval;
3416 multibuffer.start_transaction_at(now, cx);
3417 multibuffer.edit(
3418 [(MultiBufferOffset(2)..MultiBufferOffset(2), "C")],
3419 None,
3420 cx,
3421 );
3422 multibuffer.end_transaction_at(now, cx);
3423 assert_eq!(multibuffer.read(cx).text(), "ABC1234\nAB5678");
3424
3425 // Edit buffer 1 independently
3426 buffer_1.update(cx, |buffer_1, cx| {
3427 buffer_1.start_transaction_at(now);
3428 buffer_1.edit([(3..3, "D")], None, cx);
3429 buffer_1.end_transaction_at(now, cx);
3430
3431 now += 2 * group_interval;
3432 buffer_1.start_transaction_at(now);
3433 buffer_1.edit([(4..4, "E")], None, cx);
3434 buffer_1.end_transaction_at(now, cx);
3435 });
3436 assert_eq!(multibuffer.read(cx).text(), "ABCDE1234\nAB5678");
3437
3438 // An undo in the multibuffer undoes the multibuffer transaction
3439 // and also any individual buffer edits that have occurred since
3440 // that transaction.
3441 multibuffer.undo(cx);
3442 assert_eq!(multibuffer.read(cx).text(), "AB1234\nAB5678");
3443
3444 multibuffer.undo(cx);
3445 assert_eq!(multibuffer.read(cx).text(), "1234\n5678");
3446
3447 multibuffer.redo(cx);
3448 assert_eq!(multibuffer.read(cx).text(), "AB1234\nAB5678");
3449
3450 multibuffer.redo(cx);
3451 assert_eq!(multibuffer.read(cx).text(), "ABCDE1234\nAB5678");
3452
3453 // Undo buffer 2 independently.
3454 buffer_2.update(cx, |buffer_2, cx| buffer_2.undo(cx));
3455 assert_eq!(multibuffer.read(cx).text(), "ABCDE1234\n5678");
3456
3457 // An undo in the multibuffer undoes the components of the
3458 // the last multibuffer transaction that are not already undone.
3459 multibuffer.undo(cx);
3460 assert_eq!(multibuffer.read(cx).text(), "AB1234\n5678");
3461
3462 multibuffer.undo(cx);
3463 assert_eq!(multibuffer.read(cx).text(), "1234\n5678");
3464
3465 multibuffer.redo(cx);
3466 assert_eq!(multibuffer.read(cx).text(), "AB1234\nAB5678");
3467
3468 buffer_1.update(cx, |buffer_1, cx| buffer_1.redo(cx));
3469 assert_eq!(multibuffer.read(cx).text(), "ABCD1234\nAB5678");
3470
3471 // Redo stack gets cleared after an edit.
3472 now += 2 * group_interval;
3473 multibuffer.start_transaction_at(now, cx);
3474 multibuffer.edit(
3475 [(MultiBufferOffset(0)..MultiBufferOffset(0), "X")],
3476 None,
3477 cx,
3478 );
3479 multibuffer.end_transaction_at(now, cx);
3480 assert_eq!(multibuffer.read(cx).text(), "XABCD1234\nAB5678");
3481 multibuffer.redo(cx);
3482 assert_eq!(multibuffer.read(cx).text(), "XABCD1234\nAB5678");
3483 multibuffer.undo(cx);
3484 assert_eq!(multibuffer.read(cx).text(), "ABCD1234\nAB5678");
3485 multibuffer.undo(cx);
3486 assert_eq!(multibuffer.read(cx).text(), "1234\n5678");
3487
3488 // Transactions can be grouped manually.
3489 multibuffer.redo(cx);
3490 multibuffer.redo(cx);
3491 assert_eq!(multibuffer.read(cx).text(), "XABCD1234\nAB5678");
3492 multibuffer.group_until_transaction(transaction_1, cx);
3493 multibuffer.undo(cx);
3494 assert_eq!(multibuffer.read(cx).text(), "1234\n5678");
3495 multibuffer.redo(cx);
3496 assert_eq!(multibuffer.read(cx).text(), "XABCD1234\nAB5678");
3497 });
3498}
3499
3500#[gpui::test]
3501async fn test_enclosing_indent(cx: &mut TestAppContext) {
3502 async fn enclosing_indent(
3503 text: &str,
3504 buffer_row: u32,
3505 cx: &mut TestAppContext,
3506 ) -> Option<(Range<u32>, LineIndent)> {
3507 let buffer = cx.update(|cx| MultiBuffer::build_simple(text, cx));
3508 let snapshot = cx.read(|cx| buffer.read(cx).snapshot(cx));
3509 let (range, indent) = snapshot
3510 .enclosing_indent(MultiBufferRow(buffer_row))
3511 .await?;
3512 Some((range.start.0..range.end.0, indent))
3513 }
3514
3515 assert_eq!(
3516 enclosing_indent(
3517 indoc!(
3518 "
3519 fn b() {
3520 if c {
3521 let d = 2;
3522 }
3523 }
3524 "
3525 ),
3526 1,
3527 cx,
3528 )
3529 .await,
3530 Some((
3531 1..2,
3532 LineIndent {
3533 tabs: 0,
3534 spaces: 4,
3535 line_blank: false,
3536 }
3537 ))
3538 );
3539
3540 assert_eq!(
3541 enclosing_indent(
3542 indoc!(
3543 "
3544 fn b() {
3545 if c {
3546 let d = 2;
3547 }
3548 }
3549 "
3550 ),
3551 2,
3552 cx,
3553 )
3554 .await,
3555 Some((
3556 1..2,
3557 LineIndent {
3558 tabs: 0,
3559 spaces: 4,
3560 line_blank: false,
3561 }
3562 ))
3563 );
3564
3565 assert_eq!(
3566 enclosing_indent(
3567 indoc!(
3568 "
3569 fn b() {
3570 if c {
3571 let d = 2;
3572
3573 let e = 5;
3574 }
3575 }
3576 "
3577 ),
3578 3,
3579 cx,
3580 )
3581 .await,
3582 Some((
3583 1..4,
3584 LineIndent {
3585 tabs: 0,
3586 spaces: 4,
3587 line_blank: false,
3588 }
3589 ))
3590 );
3591}
3592
3593#[gpui::test]
3594async fn test_summaries_for_anchors(cx: &mut TestAppContext) {
3595 let base_text_1 = indoc!(
3596 "
3597 bar
3598 "
3599 );
3600 let text_1 = indoc!(
3601 "
3602 BAR
3603 "
3604 );
3605 let base_text_2 = indoc!(
3606 "
3607 foo
3608 "
3609 );
3610 let text_2 = indoc!(
3611 "
3612 FOO
3613 "
3614 );
3615
3616 let buffer_1 = cx.new(|cx| Buffer::local(text_1, cx));
3617 let buffer_2 = cx.new(|cx| Buffer::local(text_2, cx));
3618 let diff_1 = cx.new(|cx| {
3619 BufferDiff::new_with_base_text(base_text_1, &buffer_1.read(cx).text_snapshot(), cx)
3620 });
3621 let diff_2 = cx.new(|cx| {
3622 BufferDiff::new_with_base_text(base_text_2, &buffer_2.read(cx).text_snapshot(), cx)
3623 });
3624 cx.run_until_parked();
3625
3626 let multibuffer = cx.new(|cx| {
3627 let mut multibuffer = MultiBuffer::new(Capability::ReadWrite);
3628 multibuffer.set_all_diff_hunks_expanded(cx);
3629 multibuffer.set_excerpts_for_path(
3630 PathKey::sorted(0),
3631 buffer_1.clone(),
3632 [Point::zero()..buffer_1.read(cx).max_point()],
3633 0,
3634 cx,
3635 );
3636 multibuffer.set_excerpts_for_path(
3637 PathKey::sorted(1),
3638 buffer_2.clone(),
3639 [Point::zero()..buffer_2.read(cx).max_point()],
3640 0,
3641 cx,
3642 );
3643 multibuffer.add_diff(diff_1.clone(), cx);
3644 multibuffer.add_diff(diff_2.clone(), cx);
3645 multibuffer
3646 });
3647
3648 let (mut snapshot, mut subscription) = multibuffer.update(cx, |multibuffer, cx| {
3649 (multibuffer.snapshot(cx), multibuffer.subscribe())
3650 });
3651
3652 assert_new_snapshot(
3653 &multibuffer,
3654 &mut snapshot,
3655 &mut subscription,
3656 cx,
3657 indoc!(
3658 "
3659 - bar
3660 + BAR
3661
3662 - foo
3663 + FOO
3664 "
3665 ),
3666 );
3667
3668 let anchor_1 = multibuffer.read_with(cx, |multibuffer, cx| {
3669 multibuffer
3670 .buffer_anchor_to_anchor(
3671 &buffer_1,
3672 text::Anchor::min_for_buffer(buffer_1.read(cx).remote_id()),
3673 cx,
3674 )
3675 .unwrap()
3676 });
3677 let point_1 = snapshot.summaries_for_anchors::<Point, _>([&anchor_1])[0];
3678 assert_eq!(point_1, Point::new(0, 0));
3679
3680 let anchor_2 = multibuffer.read_with(cx, |multibuffer, cx| {
3681 multibuffer
3682 .buffer_anchor_to_anchor(
3683 &buffer_2,
3684 text::Anchor::min_for_buffer(buffer_2.read(cx).remote_id()),
3685 cx,
3686 )
3687 .unwrap()
3688 });
3689 let point_2 = snapshot.summaries_for_anchors::<Point, _>([&anchor_2])[0];
3690 assert_eq!(point_2, Point::new(3, 0));
3691}
3692
3693#[gpui::test]
3694async fn test_trailing_deletion_without_newline(cx: &mut TestAppContext) {
3695 let base_text_1 = "one\ntwo".to_owned();
3696 let text_1 = "one\n".to_owned();
3697
3698 let buffer_1 = cx.new(|cx| Buffer::local(text_1, cx));
3699 let diff_1 = cx.new(|cx| {
3700 BufferDiff::new_with_base_text(&base_text_1, &buffer_1.read(cx).text_snapshot(), cx)
3701 });
3702 cx.run_until_parked();
3703
3704 let multibuffer = cx.new(|cx| {
3705 let mut multibuffer = MultiBuffer::new(Capability::ReadWrite);
3706 multibuffer.set_excerpts_for_path(
3707 PathKey::sorted(0),
3708 buffer_1.clone(),
3709 [Point::zero()..buffer_1.read(cx).max_point()],
3710 0,
3711 cx,
3712 );
3713 multibuffer.add_diff(diff_1.clone(), cx);
3714 multibuffer.expand_diff_hunks(vec![Anchor::min()..Anchor::max()], cx);
3715 multibuffer
3716 });
3717
3718 let (mut snapshot, mut subscription) = multibuffer.update(cx, |multibuffer, cx| {
3719 (multibuffer.snapshot(cx), multibuffer.subscribe())
3720 });
3721
3722 assert_new_snapshot(
3723 &multibuffer,
3724 &mut snapshot,
3725 &mut subscription,
3726 cx,
3727 indoc!(
3728 "
3729 one
3730 - two
3731 "
3732 ),
3733 );
3734
3735 assert_eq!(snapshot.max_point(), Point::new(2, 0));
3736 assert_eq!(snapshot.len().0, 8);
3737
3738 assert_eq!(
3739 snapshot
3740 .dimensions_from_points::<Point>([Point::new(2, 0)])
3741 .collect::<Vec<_>>(),
3742 vec![Point::new(2, 0)]
3743 );
3744
3745 let (_, translated_offset) = snapshot.point_to_buffer_offset(Point::new(2, 0)).unwrap();
3746 assert_eq!(translated_offset.0, "one\n".len());
3747 let (_, translated_point) = snapshot.point_to_buffer_point(Point::new(2, 0)).unwrap();
3748 assert_eq!(translated_point, Point::new(1, 0));
3749
3750 // The same, for an excerpt that's not at the end of the multibuffer.
3751
3752 let text_2 = "foo\n".to_owned();
3753 let buffer_2 = cx.new(|cx| Buffer::local(&text_2, cx));
3754 multibuffer.update(cx, |multibuffer, cx| {
3755 multibuffer.set_excerpt_ranges_for_path(
3756 PathKey::sorted(1),
3757 buffer_2.clone(),
3758 &buffer_2.read(cx).snapshot(),
3759 vec![ExcerptRange::new(Point::new(0, 0)..Point::new(1, 0))],
3760 cx,
3761 );
3762 });
3763
3764 assert_new_snapshot(
3765 &multibuffer,
3766 &mut snapshot,
3767 &mut subscription,
3768 cx,
3769 indoc!(
3770 "
3771 one
3772 - two
3773
3774 foo
3775 "
3776 ),
3777 );
3778
3779 assert_eq!(
3780 snapshot
3781 .dimensions_from_points::<Point>([Point::new(2, 0)])
3782 .collect::<Vec<_>>(),
3783 vec![Point::new(2, 0)]
3784 );
3785
3786 let buffer_1_id = buffer_1.read_with(cx, |buffer_1, _| buffer_1.remote_id());
3787 let (buffer, translated_offset) = snapshot.point_to_buffer_offset(Point::new(2, 0)).unwrap();
3788 assert_eq!(buffer.remote_id(), buffer_1_id);
3789 assert_eq!(translated_offset.0, "one\n".len());
3790 let (buffer, translated_point) = snapshot.point_to_buffer_point(Point::new(2, 0)).unwrap();
3791 assert_eq!(buffer.remote_id(), buffer_1_id);
3792 assert_eq!(translated_point, Point::new(1, 0));
3793}
3794
3795fn format_diff(
3796 text: &str,
3797 row_infos: &Vec<RowInfo>,
3798 boundary_rows: &HashSet<MultiBufferRow>,
3799 has_diff: Option<bool>,
3800) -> String {
3801 let has_diff =
3802 has_diff.unwrap_or_else(|| row_infos.iter().any(|info| info.diff_status.is_some()));
3803 text.split('\n')
3804 .enumerate()
3805 .zip(row_infos)
3806 .map(|((ix, line), info)| {
3807 let marker = match info.diff_status.map(|status| status.kind) {
3808 Some(DiffHunkStatusKind::Added) => "+ ",
3809 Some(DiffHunkStatusKind::Deleted) => "- ",
3810 Some(DiffHunkStatusKind::Modified) => unreachable!(),
3811 None => {
3812 if has_diff && !line.is_empty() {
3813 " "
3814 } else {
3815 ""
3816 }
3817 }
3818 };
3819 let boundary_row = if boundary_rows.contains(&MultiBufferRow(ix as u32)) {
3820 if has_diff {
3821 " ----------\n"
3822 } else {
3823 "---------\n"
3824 }
3825 } else {
3826 ""
3827 };
3828 let expand = info
3829 .expand_info
3830 .as_ref()
3831 .map(|expand_info| match expand_info.direction {
3832 ExpandExcerptDirection::Up => " [↑]",
3833 ExpandExcerptDirection::Down => " [↓]",
3834 ExpandExcerptDirection::UpAndDown => " [↕]",
3835 })
3836 .unwrap_or_default();
3837
3838 format!("{boundary_row}{marker}{line}{expand}")
3839 // let mbr = info
3840 // .multibuffer_row
3841 // .map(|row| format!("{:0>3}", row.0))
3842 // .unwrap_or_else(|| "???".to_string());
3843 // let byte_range = format!("{byte_range_start:0>3}..{byte_range_end:0>3}");
3844 // format!("{boundary_row}Row: {mbr}, Bytes: {byte_range} | {marker}{line}{expand}")
3845 })
3846 .collect::<Vec<_>>()
3847 .join("\n")
3848}
3849
3850// fn format_transforms(snapshot: &MultiBufferSnapshot) -> String {
3851// snapshot
3852// .diff_transforms
3853// .iter()
3854// .map(|transform| {
3855// let (kind, summary) = match transform {
3856// DiffTransform::DeletedHunk { summary, .. } => (" Deleted", (*summary).into()),
3857// DiffTransform::FilteredInsertedHunk { summary, .. } => (" Filtered", *summary),
3858// DiffTransform::InsertedHunk { summary, .. } => (" Inserted", *summary),
3859// DiffTransform::Unmodified { summary, .. } => ("Unmodified", *summary),
3860// };
3861// format!("{kind}(len: {}, lines: {:?})", summary.len, summary.lines)
3862// })
3863// .join("\n")
3864// }
3865
3866// fn format_excerpts(snapshot: &MultiBufferSnapshot) -> String {
3867// snapshot
3868// .excerpts
3869// .iter()
3870// .map(|excerpt| {
3871// format!(
3872// "Excerpt(buffer_range = {:?}, lines = {:?}, has_trailing_newline = {:?})",
3873// excerpt.range.context.to_point(&excerpt.buffer),
3874// excerpt.text_summary.lines,
3875// excerpt.has_trailing_newline
3876// )
3877// })
3878// .join("\n")
3879// }
3880
3881#[gpui::test]
3882async fn test_singleton_with_inverted_diff(cx: &mut TestAppContext) {
3883 let text = indoc!(
3884 "
3885 ZERO
3886 one
3887 TWO
3888 three
3889 six
3890 "
3891 );
3892 let base_text = indoc!(
3893 "
3894 one
3895 two
3896 three
3897 four
3898 five
3899 six
3900 "
3901 );
3902
3903 let buffer = cx.new(|cx| Buffer::local(text, cx));
3904 let diff = cx
3905 .new(|cx| BufferDiff::new_with_base_text(base_text, &buffer.read(cx).text_snapshot(), cx));
3906 cx.run_until_parked();
3907
3908 let base_text_buffer = diff.read_with(cx, |diff, _| diff.base_text_buffer().clone());
3909
3910 let multibuffer = cx.new(|cx| {
3911 let mut multibuffer = MultiBuffer::singleton(base_text_buffer.clone(), cx);
3912 multibuffer.set_all_diff_hunks_expanded(cx);
3913 multibuffer.add_inverted_diff(diff.clone(), buffer.clone(), cx);
3914 multibuffer
3915 });
3916
3917 let (mut snapshot, mut subscription) = multibuffer.update(cx, |multibuffer, cx| {
3918 (multibuffer.snapshot(cx), multibuffer.subscribe())
3919 });
3920
3921 assert_eq!(snapshot.text(), base_text);
3922 assert_new_snapshot(
3923 &multibuffer,
3924 &mut snapshot,
3925 &mut subscription,
3926 cx,
3927 indoc!(
3928 "
3929 one
3930 - two
3931 three
3932 - four
3933 - five
3934 six
3935 "
3936 ),
3937 );
3938
3939 buffer.update(cx, |buffer, cx| {
3940 buffer.edit_via_marked_text(
3941 indoc!(
3942 "
3943 ZERO
3944 one
3945 «<inserted>»W«O
3946 T»hree
3947 six
3948 "
3949 ),
3950 None,
3951 cx,
3952 );
3953 });
3954 cx.run_until_parked();
3955 let update = diff
3956 .update(cx, |diff, cx| {
3957 diff.update_diff(
3958 buffer.read(cx).text_snapshot(),
3959 Some(base_text.into()),
3960 None,
3961 None,
3962 cx,
3963 )
3964 })
3965 .await;
3966 diff.update(cx, |diff, cx| {
3967 diff.set_snapshot(update, &buffer.read(cx).text_snapshot(), cx)
3968 })
3969 .await;
3970 cx.run_until_parked();
3971
3972 assert_new_snapshot(
3973 &multibuffer,
3974 &mut snapshot,
3975 &mut subscription,
3976 cx,
3977 indoc! {
3978 "
3979 one
3980 - two
3981 - three
3982 - four
3983 - five
3984 six
3985 "
3986 },
3987 );
3988
3989 buffer.update(cx, |buffer, cx| {
3990 buffer.set_text("ZERO\nONE\nTWO\n", cx);
3991 });
3992 cx.run_until_parked();
3993 let update = diff
3994 .update(cx, |diff, cx| {
3995 diff.update_diff(
3996 buffer.read(cx).text_snapshot(),
3997 Some(base_text.into()),
3998 None,
3999 None,
4000 cx,
4001 )
4002 })
4003 .await;
4004 diff.update(cx, |diff, cx| {
4005 diff.set_snapshot(update, &buffer.read(cx).text_snapshot(), cx)
4006 })
4007 .await;
4008 cx.run_until_parked();
4009
4010 assert_new_snapshot(
4011 &multibuffer,
4012 &mut snapshot,
4013 &mut subscription,
4014 cx,
4015 indoc! {
4016 "
4017 - one
4018 - two
4019 - three
4020 - four
4021 - five
4022 - six
4023 "
4024 },
4025 );
4026
4027 diff.update(cx, |diff, cx| {
4028 diff.set_base_text(
4029 Some("new base\n".into()),
4030 None,
4031 buffer.read(cx).text_snapshot(),
4032 cx,
4033 )
4034 })
4035 .await
4036 .unwrap();
4037 cx.run_until_parked();
4038
4039 assert_new_snapshot(
4040 &multibuffer,
4041 &mut snapshot,
4042 &mut subscription,
4043 cx,
4044 indoc! {"
4045 - new base
4046 "},
4047 );
4048}
4049
4050#[gpui::test]
4051async fn test_inverted_diff_base_text_change(cx: &mut TestAppContext) {
4052 let base_text = "aaa\nbbb\nccc\n";
4053 let text = "ddd\n";
4054 let buffer = cx.new(|cx| Buffer::local(text, cx));
4055 let diff = cx
4056 .new(|cx| BufferDiff::new_with_base_text(base_text, &buffer.read(cx).text_snapshot(), cx));
4057 cx.run_until_parked();
4058
4059 let base_text_buffer = diff.read_with(cx, |diff, _| diff.base_text_buffer().clone());
4060
4061 let multibuffer = cx.new(|cx| {
4062 let mut multibuffer = MultiBuffer::singleton(base_text_buffer.clone(), cx);
4063 multibuffer.set_all_diff_hunks_expanded(cx);
4064 multibuffer.add_inverted_diff(diff.clone(), buffer.clone(), cx);
4065 multibuffer
4066 });
4067
4068 let (mut snapshot, mut subscription) = multibuffer.update(cx, |multibuffer, cx| {
4069 (multibuffer.snapshot(cx), multibuffer.subscribe())
4070 });
4071
4072 assert_eq!(snapshot.text(), base_text);
4073 assert_new_snapshot(
4074 &multibuffer,
4075 &mut snapshot,
4076 &mut subscription,
4077 cx,
4078 indoc!(
4079 "
4080 - aaa
4081 - bbb
4082 - ccc
4083 "
4084 ),
4085 );
4086
4087 let update = diff
4088 .update(cx, |diff, cx| {
4089 diff.update_diff(
4090 buffer.read(cx).text_snapshot(),
4091 Some("ddd\n".into()),
4092 Some(true),
4093 None,
4094 cx,
4095 )
4096 })
4097 .await;
4098 diff.update(cx, |diff, cx| {
4099 diff.set_snapshot(update, &buffer.read(cx).text_snapshot(), cx)
4100 })
4101 .detach();
4102
4103 let _hunks: Vec<_> = multibuffer
4104 .read_with(cx, |multibuffer, cx| multibuffer.snapshot(cx))
4105 .diff_hunks()
4106 .collect();
4107}
4108
4109#[gpui::test]
4110async fn test_inverted_diff_secondary_version_mismatch(cx: &mut TestAppContext) {
4111 let base_text = "one\ntwo\nthree\nfour\nfive\n";
4112 let index_text = "one\nTWO\nthree\nfour\nfive\n";
4113 let buffer_text = "one\nTWO\nthree\nFOUR\nfive\n";
4114
4115 let buffer = cx.new(|cx| Buffer::local(buffer_text, cx));
4116
4117 let unstaged_diff = cx
4118 .new(|cx| BufferDiff::new_with_base_text(index_text, &buffer.read(cx).text_snapshot(), cx));
4119 cx.run_until_parked();
4120
4121 let uncommitted_diff = cx.new(|cx| {
4122 let mut diff =
4123 BufferDiff::new_with_base_text(base_text, &buffer.read(cx).text_snapshot(), cx);
4124 diff.set_secondary_diff(unstaged_diff.clone());
4125 diff
4126 });
4127 cx.run_until_parked();
4128
4129 buffer.update(cx, |buffer, cx| {
4130 buffer.edit([(0..0, "ZERO\n")], None, cx);
4131 });
4132
4133 let update = unstaged_diff
4134 .update(cx, |diff, cx| {
4135 diff.update_diff(
4136 buffer.read(cx).text_snapshot(),
4137 Some(index_text.into()),
4138 None,
4139 None,
4140 cx,
4141 )
4142 })
4143 .await;
4144 unstaged_diff
4145 .update(cx, |diff, cx| {
4146 diff.set_snapshot(update, &buffer.read(cx).text_snapshot(), cx)
4147 })
4148 .await;
4149
4150 let base_text_buffer =
4151 uncommitted_diff.read_with(cx, |diff, _| diff.base_text_buffer().clone());
4152
4153 let multibuffer = cx.new(|cx| {
4154 let mut multibuffer = MultiBuffer::singleton(base_text_buffer.clone(), cx);
4155 multibuffer.set_all_diff_hunks_expanded(cx);
4156 multibuffer.add_inverted_diff(uncommitted_diff.clone(), buffer.clone(), cx);
4157 multibuffer
4158 });
4159
4160 let _hunks: Vec<_> = multibuffer
4161 .read_with(cx, |multibuffer, cx| multibuffer.snapshot(cx))
4162 .diff_hunks()
4163 .collect();
4164}
4165
4166#[track_caller]
4167fn assert_excerpts_match(
4168 multibuffer: &Entity<MultiBuffer>,
4169 cx: &mut TestAppContext,
4170 expected: &str,
4171) {
4172 let mut output = String::new();
4173 multibuffer.read_with(cx, |multibuffer, cx| {
4174 for (buffer, info) in multibuffer.snapshot(cx).excerpts() {
4175 output.push_str("-----\n");
4176 output.extend(buffer.text_for_range(info.range.context));
4177 if !output.ends_with('\n') {
4178 output.push('\n');
4179 }
4180 }
4181 });
4182 assert_eq!(output, expected);
4183}
4184
4185#[track_caller]
4186fn assert_new_snapshot(
4187 multibuffer: &Entity<MultiBuffer>,
4188 snapshot: &mut MultiBufferSnapshot,
4189 subscription: &mut Subscription<MultiBufferOffset>,
4190 cx: &mut TestAppContext,
4191 expected_diff: &str,
4192) {
4193 let new_snapshot = multibuffer.read_with(cx, |multibuffer, cx| multibuffer.snapshot(cx));
4194 let actual_text = new_snapshot.text();
4195 let line_infos = new_snapshot
4196 .row_infos(MultiBufferRow(0))
4197 .collect::<Vec<_>>();
4198 let actual_diff = format_diff(&actual_text, &line_infos, &Default::default(), None);
4199 pretty_assertions::assert_eq!(actual_diff, expected_diff);
4200 check_edits(
4201 snapshot,
4202 &new_snapshot,
4203 &subscription.consume().into_inner(),
4204 );
4205 *snapshot = new_snapshot;
4206}
4207
4208#[track_caller]
4209fn check_edits(
4210 old_snapshot: &MultiBufferSnapshot,
4211 new_snapshot: &MultiBufferSnapshot,
4212 edits: &[Edit<MultiBufferOffset>],
4213) {
4214 let mut text = old_snapshot.text();
4215 let new_text = new_snapshot.text();
4216 for edit in edits.iter().rev() {
4217 if !text.is_char_boundary(edit.old.start.0)
4218 || !text.is_char_boundary(edit.old.end.0)
4219 || !new_text.is_char_boundary(edit.new.start.0)
4220 || !new_text.is_char_boundary(edit.new.end.0)
4221 {
4222 panic!(
4223 "invalid edits: {:?}\nold text: {:?}\nnew text: {:?}",
4224 edits, text, new_text
4225 );
4226 }
4227
4228 text.replace_range(
4229 edit.old.start.0..edit.old.end.0,
4230 &new_text[edit.new.start.0..edit.new.end.0],
4231 );
4232 }
4233
4234 pretty_assertions::assert_eq!(text, new_text, "invalid edits: {:?}", edits);
4235}
4236
4237#[track_caller]
4238fn assert_chunks_in_ranges(snapshot: &MultiBufferSnapshot) {
4239 let full_text = snapshot.text();
4240 for ix in 0..full_text.len() {
4241 let mut chunks = snapshot.chunks(MultiBufferOffset(0)..snapshot.len(), false);
4242 chunks.seek(MultiBufferOffset(ix)..snapshot.len());
4243 let tail = chunks.map(|chunk| chunk.text).collect::<String>();
4244 assert_eq!(tail, &full_text[ix..], "seek to range: {:?}", ix..);
4245 }
4246}
4247
4248#[track_caller]
4249fn assert_consistent_line_numbers(snapshot: &MultiBufferSnapshot) {
4250 let all_line_numbers = snapshot.row_infos(MultiBufferRow(0)).collect::<Vec<_>>();
4251 for start_row in 1..all_line_numbers.len() {
4252 let line_numbers = snapshot
4253 .row_infos(MultiBufferRow(start_row as u32))
4254 .collect::<Vec<_>>();
4255 assert_eq!(
4256 line_numbers,
4257 all_line_numbers[start_row..],
4258 "start_row: {start_row}"
4259 );
4260 }
4261}
4262
4263#[track_caller]
4264fn assert_position_translation(snapshot: &MultiBufferSnapshot) {
4265 let text = Rope::from(snapshot.text());
4266
4267 let mut left_anchors = Vec::new();
4268 let mut right_anchors = Vec::new();
4269 let mut offsets = Vec::new();
4270 let mut points = Vec::new();
4271 for offset in 0..=text.len() + 1 {
4272 let offset = MultiBufferOffset(offset);
4273 let clipped_left = snapshot.clip_offset(offset, Bias::Left);
4274 let clipped_right = snapshot.clip_offset(offset, Bias::Right);
4275 assert_eq!(
4276 clipped_left.0,
4277 text.clip_offset(offset.0, Bias::Left),
4278 "clip_offset({offset:?}, Left)"
4279 );
4280 assert_eq!(
4281 clipped_right.0,
4282 text.clip_offset(offset.0, Bias::Right),
4283 "clip_offset({offset:?}, Right)"
4284 );
4285 assert_eq!(
4286 snapshot.offset_to_point(clipped_left),
4287 text.offset_to_point(clipped_left.0),
4288 "offset_to_point({})",
4289 clipped_left.0
4290 );
4291 assert_eq!(
4292 snapshot.offset_to_point(clipped_right),
4293 text.offset_to_point(clipped_right.0),
4294 "offset_to_point({})",
4295 clipped_right.0
4296 );
4297 let anchor_after = snapshot.anchor_after(clipped_left);
4298 assert_eq!(
4299 anchor_after.to_offset(snapshot),
4300 clipped_left,
4301 "anchor_after({}).to_offset {anchor_after:?}",
4302 clipped_left.0
4303 );
4304 let anchor_before = snapshot.anchor_before(clipped_left);
4305 assert_eq!(
4306 anchor_before.to_offset(snapshot),
4307 clipped_left,
4308 "anchor_before({}).to_offset",
4309 clipped_left.0
4310 );
4311 left_anchors.push(anchor_before);
4312 right_anchors.push(anchor_after);
4313 offsets.push(clipped_left);
4314 points.push(text.offset_to_point(clipped_left.0));
4315 }
4316
4317 for row in 0..text.max_point().row {
4318 for column in 0..text.line_len(row) + 1 {
4319 let point = Point { row, column };
4320 let clipped_left = snapshot.clip_point(point, Bias::Left);
4321 let clipped_right = snapshot.clip_point(point, Bias::Right);
4322 assert_eq!(
4323 clipped_left,
4324 text.clip_point(point, Bias::Left),
4325 "clip_point({point:?}, Left)"
4326 );
4327 assert_eq!(
4328 clipped_right,
4329 text.clip_point(point, Bias::Right),
4330 "clip_point({point:?}, Right)"
4331 );
4332 assert_eq!(
4333 snapshot.point_to_offset(clipped_left).0,
4334 text.point_to_offset(clipped_left),
4335 "point_to_offset({clipped_left:?})"
4336 );
4337 assert_eq!(
4338 snapshot.point_to_offset(clipped_right).0,
4339 text.point_to_offset(clipped_right),
4340 "point_to_offset({clipped_right:?})"
4341 );
4342 }
4343 }
4344
4345 assert_eq!(
4346 snapshot.summaries_for_anchors::<MultiBufferOffset, _>(&left_anchors),
4347 offsets,
4348 "left_anchors <-> offsets"
4349 );
4350 assert_eq!(
4351 snapshot.summaries_for_anchors::<Point, _>(&left_anchors),
4352 points,
4353 "left_anchors <-> points"
4354 );
4355 assert_eq!(
4356 snapshot.summaries_for_anchors::<MultiBufferOffset, _>(&right_anchors),
4357 offsets,
4358 "right_anchors <-> offsets"
4359 );
4360 assert_eq!(
4361 snapshot.summaries_for_anchors::<Point, _>(&right_anchors),
4362 points,
4363 "right_anchors <-> points"
4364 );
4365
4366 for (anchors, bias) in [(&left_anchors, Bias::Left), (&right_anchors, Bias::Right)] {
4367 for (ix, (offset, anchor)) in offsets.iter().zip(anchors).enumerate() {
4368 if ix > 0 && *offset == MultiBufferOffset(252) && offset > &offsets[ix - 1] {
4369 let prev_anchor = left_anchors[ix - 1];
4370 assert!(
4371 anchor.cmp(&prev_anchor, snapshot).is_gt(),
4372 "anchor({}, {bias:?}).cmp(&anchor({}, {bias:?}).is_gt()",
4373 offsets[ix],
4374 offsets[ix - 1],
4375 );
4376 assert!(
4377 prev_anchor.cmp(anchor, snapshot).is_lt(),
4378 "anchor({}, {bias:?}).cmp(&anchor({}, {bias:?}).is_lt()",
4379 offsets[ix - 1],
4380 offsets[ix],
4381 );
4382 }
4383 }
4384 }
4385
4386 if let Some((buffer, offset)) = snapshot.point_to_buffer_offset(snapshot.max_point()) {
4387 assert!(offset.0 <= buffer.len());
4388 }
4389 if let Some((buffer, point)) = snapshot.point_to_buffer_point(snapshot.max_point()) {
4390 assert!(point <= buffer.max_point());
4391 }
4392}
4393
4394fn assert_line_indents(snapshot: &MultiBufferSnapshot) {
4395 let max_row = snapshot.max_point().row;
4396 let buffer_id = snapshot.excerpts().next().unwrap().1.buffer_id;
4397 let text = text::Buffer::new(ReplicaId::LOCAL, buffer_id, snapshot.text());
4398 let mut line_indents = text
4399 .line_indents_in_row_range(0..max_row + 1)
4400 .collect::<Vec<_>>();
4401 for start_row in 0..snapshot.max_point().row {
4402 pretty_assertions::assert_eq!(
4403 snapshot
4404 .line_indents(MultiBufferRow(start_row), |_| true)
4405 .map(|(row, indent, _)| (row.0, indent))
4406 .collect::<Vec<_>>(),
4407 &line_indents[(start_row as usize)..],
4408 "line_indents({start_row})"
4409 );
4410 }
4411
4412 line_indents.reverse();
4413 pretty_assertions::assert_eq!(
4414 snapshot
4415 .reversed_line_indents(MultiBufferRow(max_row), |_| true)
4416 .map(|(row, indent, _)| (row.0, indent))
4417 .collect::<Vec<_>>(),
4418 &line_indents[..],
4419 "reversed_line_indents({max_row})"
4420 );
4421}
4422
4423#[gpui::test]
4424fn test_new_empty_buffer_uses_untitled_title(cx: &mut App) {
4425 let buffer = cx.new(|cx| Buffer::local("", cx));
4426 let multibuffer = cx.new(|cx| MultiBuffer::singleton(buffer.clone(), cx));
4427
4428 assert_eq!(multibuffer.read(cx).title(cx), "untitled");
4429}
4430
4431#[gpui::test]
4432fn test_new_empty_buffer_uses_untitled_title_when_only_contains_whitespace(cx: &mut App) {
4433 let buffer = cx.new(|cx| Buffer::local("\n ", cx));
4434 let multibuffer = cx.new(|cx| MultiBuffer::singleton(buffer.clone(), cx));
4435
4436 assert_eq!(multibuffer.read(cx).title(cx), "untitled");
4437}
4438
4439#[gpui::test]
4440fn test_new_empty_buffer_takes_first_line_for_title(cx: &mut App) {
4441 let buffer = cx.new(|cx| Buffer::local("Hello World\nSecond line", cx));
4442 let multibuffer = cx.new(|cx| MultiBuffer::singleton(buffer.clone(), cx));
4443
4444 assert_eq!(multibuffer.read(cx).title(cx), "Hello World");
4445}
4446
4447#[gpui::test]
4448fn test_new_empty_buffer_takes_trimmed_first_line_for_title(cx: &mut App) {
4449 let buffer = cx.new(|cx| Buffer::local("\nHello, World ", cx));
4450 let multibuffer = cx.new(|cx| MultiBuffer::singleton(buffer.clone(), cx));
4451
4452 assert_eq!(multibuffer.read(cx).title(cx), "Hello, World");
4453}
4454
4455#[gpui::test]
4456fn test_new_empty_buffer_uses_truncated_first_line_for_title(cx: &mut App) {
4457 let title = "aaaaaaaaaabbbbbbbbbbccccccccccddddddddddeeeeeeeeee";
4458 let title_after = "aaaaaaaaaabbbbbbbbbbccccccccccdddddddddd";
4459 let buffer = cx.new(|cx| Buffer::local(title, cx));
4460 let multibuffer = cx.new(|cx| MultiBuffer::singleton(buffer.clone(), cx));
4461
4462 assert_eq!(multibuffer.read(cx).title(cx), title_after);
4463}
4464
4465#[gpui::test]
4466fn test_new_empty_buffer_uses_truncated_first_line_for_title_after_merging_adjacent_spaces(
4467 cx: &mut App,
4468) {
4469 let title = "aaaaaaaaaabbbbbbbbbb ccccccccccddddddddddeeeeeeeeee";
4470 let title_after = "aaaaaaaaaabbbbbbbbbb ccccccccccddddddddd";
4471 let buffer = cx.new(|cx| Buffer::local(title, cx));
4472 let multibuffer = cx.new(|cx| MultiBuffer::singleton(buffer.clone(), cx));
4473
4474 assert_eq!(multibuffer.read(cx).title(cx), title_after);
4475}
4476
4477#[gpui::test]
4478fn test_new_empty_buffers_title_can_be_set(cx: &mut App) {
4479 let buffer = cx.new(|cx| Buffer::local("Hello World", cx));
4480 let multibuffer = cx.new(|cx| MultiBuffer::singleton(buffer.clone(), cx));
4481 assert_eq!(multibuffer.read(cx).title(cx), "Hello World");
4482
4483 multibuffer.update(cx, |multibuffer, cx| {
4484 multibuffer.set_title("Hey".into(), cx)
4485 });
4486 assert_eq!(multibuffer.read(cx).title(cx), "Hey");
4487}
4488
4489#[gpui::test(iterations = 100)]
4490fn test_random_chunk_bitmaps(cx: &mut App, mut rng: StdRng) {
4491 let multibuffer = if rng.random() {
4492 let len = rng.random_range(0..10000);
4493 let text = RandomCharIter::new(&mut rng).take(len).collect::<String>();
4494 let buffer = cx.new(|cx| Buffer::local(text, cx));
4495 cx.new(|cx| MultiBuffer::singleton(buffer, cx))
4496 } else {
4497 MultiBuffer::build_random(&mut rng, cx)
4498 };
4499
4500 let snapshot = multibuffer.read(cx).snapshot(cx);
4501
4502 let chunks = snapshot.chunks(MultiBufferOffset(0)..snapshot.len(), false);
4503
4504 for chunk in chunks {
4505 let chunk_text = chunk.text;
4506 let chars_bitmap = chunk.chars;
4507 let tabs_bitmap = chunk.tabs;
4508
4509 if chunk_text.is_empty() {
4510 assert_eq!(
4511 chars_bitmap, 0,
4512 "Empty chunk should have empty chars bitmap"
4513 );
4514 assert_eq!(tabs_bitmap, 0, "Empty chunk should have empty tabs bitmap");
4515 continue;
4516 }
4517
4518 assert!(
4519 chunk_text.len() <= 128,
4520 "Chunk text length {} exceeds 128 bytes",
4521 chunk_text.len()
4522 );
4523
4524 // Verify chars bitmap
4525 let char_indices = chunk_text
4526 .char_indices()
4527 .map(|(i, _)| i)
4528 .collect::<Vec<_>>();
4529
4530 for byte_idx in 0..chunk_text.len() {
4531 let should_have_bit = char_indices.contains(&byte_idx);
4532 let has_bit = chars_bitmap & (1 << byte_idx) != 0;
4533
4534 if has_bit != should_have_bit {
4535 eprintln!("Chunk text bytes: {:?}", chunk_text.as_bytes());
4536 eprintln!("Char indices: {:?}", char_indices);
4537 eprintln!("Chars bitmap: {:#b}", chars_bitmap);
4538 }
4539
4540 assert_eq!(
4541 has_bit, should_have_bit,
4542 "Chars bitmap mismatch at byte index {} in chunk {:?}. Expected bit: {}, Got bit: {}",
4543 byte_idx, chunk_text, should_have_bit, has_bit
4544 );
4545 }
4546
4547 for (byte_idx, byte) in chunk_text.bytes().enumerate() {
4548 let is_tab = byte == b'\t';
4549 let has_bit = tabs_bitmap & (1 << byte_idx) != 0;
4550
4551 if has_bit != is_tab {
4552 eprintln!("Chunk text bytes: {:?}", chunk_text.as_bytes());
4553 eprintln!("Tabs bitmap: {:#b}", tabs_bitmap);
4554 assert_eq!(
4555 has_bit, is_tab,
4556 "Tabs bitmap mismatch at byte index {} in chunk {:?}. Byte: {:?}, Expected bit: {}, Got bit: {}",
4557 byte_idx, chunk_text, byte as char, is_tab, has_bit
4558 );
4559 }
4560 }
4561 }
4562}
4563
4564#[gpui::test(iterations = 10)]
4565fn test_random_chunk_bitmaps_with_diffs(cx: &mut App, mut rng: StdRng) {
4566 let settings_store = SettingsStore::test(cx);
4567 cx.set_global(settings_store);
4568 use buffer_diff::BufferDiff;
4569 use util::RandomCharIter;
4570
4571 let multibuffer = if rng.random() {
4572 let len = rng.random_range(100..10000);
4573 let text = RandomCharIter::new(&mut rng).take(len).collect::<String>();
4574 let buffer = cx.new(|cx| Buffer::local(text, cx));
4575 cx.new(|cx| MultiBuffer::singleton(buffer, cx))
4576 } else {
4577 MultiBuffer::build_random(&mut rng, cx)
4578 };
4579
4580 let _diff_count = rng.random_range(1..5);
4581 let mut diffs = Vec::new();
4582
4583 multibuffer.update(cx, |multibuffer, cx| {
4584 for buffer_id in multibuffer.all_buffer_ids() {
4585 if rng.random_bool(0.7) {
4586 if let Some(buffer_handle) = multibuffer.buffer(buffer_id) {
4587 let buffer_text = buffer_handle.read(cx).text();
4588 let mut base_text = String::new();
4589
4590 for line in buffer_text.lines() {
4591 if rng.random_bool(0.3) {
4592 continue;
4593 } else if rng.random_bool(0.3) {
4594 let line_len = rng.random_range(0..50);
4595 let modified_line = RandomCharIter::new(&mut rng)
4596 .take(line_len)
4597 .collect::<String>();
4598 base_text.push_str(&modified_line);
4599 base_text.push('\n');
4600 } else {
4601 base_text.push_str(line);
4602 base_text.push('\n');
4603 }
4604 }
4605
4606 if rng.random_bool(0.5) {
4607 let extra_lines = rng.random_range(1..5);
4608 for _ in 0..extra_lines {
4609 let line_len = rng.random_range(0..50);
4610 let extra_line = RandomCharIter::new(&mut rng)
4611 .take(line_len)
4612 .collect::<String>();
4613 base_text.push_str(&extra_line);
4614 base_text.push('\n');
4615 }
4616 }
4617
4618 let diff = cx.new(|cx| {
4619 BufferDiff::new_with_base_text(
4620 &base_text,
4621 &buffer_handle.read(cx).text_snapshot(),
4622 cx,
4623 )
4624 });
4625 diffs.push(diff.clone());
4626 multibuffer.add_diff(diff, cx);
4627 }
4628 }
4629 }
4630 });
4631
4632 multibuffer.update(cx, |multibuffer, cx| {
4633 if rng.random_bool(0.5) {
4634 multibuffer.set_all_diff_hunks_expanded(cx);
4635 } else {
4636 let snapshot = multibuffer.snapshot(cx);
4637 let text = snapshot.text();
4638
4639 let mut ranges = Vec::new();
4640 for _ in 0..rng.random_range(1..5) {
4641 if snapshot.len().0 == 0 {
4642 break;
4643 }
4644
4645 let diff_size = rng.random_range(5..1000);
4646 let mut start = rng.random_range(0..snapshot.len().0);
4647
4648 while !text.is_char_boundary(start) {
4649 start = start.saturating_sub(1);
4650 }
4651
4652 let mut end = rng.random_range(start..snapshot.len().0.min(start + diff_size));
4653
4654 while !text.is_char_boundary(end) {
4655 end = end.saturating_add(1);
4656 }
4657 let start_anchor = snapshot.anchor_after(MultiBufferOffset(start));
4658 let end_anchor = snapshot.anchor_before(MultiBufferOffset(end));
4659 ranges.push(start_anchor..end_anchor);
4660 }
4661 multibuffer.expand_diff_hunks(ranges, cx);
4662 }
4663 });
4664
4665 let snapshot = multibuffer.read(cx).snapshot(cx);
4666
4667 let chunks = snapshot.chunks(MultiBufferOffset(0)..snapshot.len(), false);
4668
4669 for chunk in chunks {
4670 let chunk_text = chunk.text;
4671 let chars_bitmap = chunk.chars;
4672 let tabs_bitmap = chunk.tabs;
4673
4674 if chunk_text.is_empty() {
4675 assert_eq!(
4676 chars_bitmap, 0,
4677 "Empty chunk should have empty chars bitmap"
4678 );
4679 assert_eq!(tabs_bitmap, 0, "Empty chunk should have empty tabs bitmap");
4680 continue;
4681 }
4682
4683 assert!(
4684 chunk_text.len() <= 128,
4685 "Chunk text length {} exceeds 128 bytes",
4686 chunk_text.len()
4687 );
4688
4689 let char_indices = chunk_text
4690 .char_indices()
4691 .map(|(i, _)| i)
4692 .collect::<Vec<_>>();
4693
4694 for byte_idx in 0..chunk_text.len() {
4695 let should_have_bit = char_indices.contains(&byte_idx);
4696 let has_bit = chars_bitmap & (1 << byte_idx) != 0;
4697
4698 if has_bit != should_have_bit {
4699 eprintln!("Chunk text bytes: {:?}", chunk_text.as_bytes());
4700 eprintln!("Char indices: {:?}", char_indices);
4701 eprintln!("Chars bitmap: {:#b}", chars_bitmap);
4702 }
4703
4704 assert_eq!(
4705 has_bit, should_have_bit,
4706 "Chars bitmap mismatch at byte index {} in chunk {:?}. Expected bit: {}, Got bit: {}",
4707 byte_idx, chunk_text, should_have_bit, has_bit
4708 );
4709 }
4710
4711 for (byte_idx, byte) in chunk_text.bytes().enumerate() {
4712 let is_tab = byte == b'\t';
4713 let has_bit = tabs_bitmap & (1 << byte_idx) != 0;
4714
4715 if has_bit != is_tab {
4716 eprintln!("Chunk text bytes: {:?}", chunk_text.as_bytes());
4717 eprintln!("Tabs bitmap: {:#b}", tabs_bitmap);
4718 assert_eq!(
4719 has_bit, is_tab,
4720 "Tabs bitmap mismatch at byte index {} in chunk {:?}. Byte: {:?}, Expected bit: {}, Got bit: {}",
4721 byte_idx, chunk_text, byte as char, is_tab, has_bit
4722 );
4723 }
4724 }
4725 }
4726}
4727
4728fn collect_word_diffs(
4729 base_text: &str,
4730 modified_text: &str,
4731 cx: &mut TestAppContext,
4732) -> Vec<String> {
4733 let buffer = cx.new(|cx| Buffer::local(modified_text, cx));
4734 let diff = cx
4735 .new(|cx| BufferDiff::new_with_base_text(base_text, &buffer.read(cx).text_snapshot(), cx));
4736 cx.run_until_parked();
4737
4738 let multibuffer = cx.new(|cx| {
4739 let mut multibuffer = MultiBuffer::singleton(buffer.clone(), cx);
4740 multibuffer.add_diff(diff.clone(), cx);
4741 multibuffer
4742 });
4743
4744 multibuffer.update(cx, |multibuffer, cx| {
4745 multibuffer.expand_diff_hunks(vec![Anchor::min()..Anchor::max()], cx);
4746 });
4747
4748 let snapshot = multibuffer.read_with(cx, |multibuffer, cx| multibuffer.snapshot(cx));
4749 let text = snapshot.text();
4750
4751 snapshot
4752 .diff_hunks()
4753 .flat_map(|hunk| hunk.word_diffs)
4754 .map(|range| text[range.start.0..range.end.0].to_string())
4755 .collect()
4756}
4757
4758#[gpui::test]
4759async fn test_word_diff_simple_replacement(cx: &mut TestAppContext) {
4760 let settings_store = cx.update(|cx| SettingsStore::test(cx));
4761 cx.set_global(settings_store);
4762
4763 let base_text = "hello world foo bar\n";
4764 let modified_text = "hello WORLD foo BAR\n";
4765
4766 let word_diffs = collect_word_diffs(base_text, modified_text, cx);
4767
4768 assert_eq!(word_diffs, vec!["world", "bar", "WORLD", "BAR"]);
4769}
4770
4771#[gpui::test]
4772async fn test_word_diff_white_space(cx: &mut TestAppContext) {
4773 let settings_store = cx.update(|cx| SettingsStore::test(cx));
4774 cx.set_global(settings_store);
4775
4776 let base_text = "hello world foo bar\n";
4777 let modified_text = " hello world foo bar\n";
4778
4779 let word_diffs = collect_word_diffs(base_text, modified_text, cx);
4780
4781 assert_eq!(word_diffs, vec![" "]);
4782}
4783
4784#[gpui::test]
4785async fn test_word_diff_consecutive_modified_lines(cx: &mut TestAppContext) {
4786 let settings_store = cx.update(|cx| SettingsStore::test(cx));
4787 cx.set_global(settings_store);
4788
4789 let base_text = "aaa bbb\nccc ddd\n";
4790 let modified_text = "aaa BBB\nccc DDD\n";
4791
4792 let word_diffs = collect_word_diffs(base_text, modified_text, cx);
4793
4794 assert_eq!(
4795 word_diffs,
4796 vec!["bbb", "ddd", "BBB", "DDD"],
4797 "consecutive modified lines should produce word diffs when line counts match"
4798 );
4799}
4800
4801#[gpui::test]
4802async fn test_word_diff_modified_lines_with_deletion_between(cx: &mut TestAppContext) {
4803 let settings_store = cx.update(|cx| SettingsStore::test(cx));
4804 cx.set_global(settings_store);
4805
4806 let base_text = "aaa bbb\ndeleted line\nccc ddd\n";
4807 let modified_text = "aaa BBB\nccc DDD\n";
4808
4809 let word_diffs = collect_word_diffs(base_text, modified_text, cx);
4810
4811 assert_eq!(
4812 word_diffs,
4813 Vec::<String>::new(),
4814 "modified lines with a deleted line between should not produce word diffs"
4815 );
4816}
4817
4818#[gpui::test]
4819async fn test_word_diff_disabled(cx: &mut TestAppContext) {
4820 let settings_store = cx.update(|cx| {
4821 let mut settings_store = SettingsStore::test(cx);
4822 settings_store.update_user_settings(cx, |settings| {
4823 settings.project.all_languages.defaults.word_diff_enabled = Some(false);
4824 });
4825 settings_store
4826 });
4827 cx.set_global(settings_store);
4828
4829 let base_text = "hello world\n";
4830 let modified_text = "hello WORLD\n";
4831
4832 let word_diffs = collect_word_diffs(base_text, modified_text, cx);
4833
4834 assert_eq!(
4835 word_diffs,
4836 Vec::<String>::new(),
4837 "word diffs should be empty when disabled"
4838 );
4839}
4840
4841/// Tests `excerpt_containing` and `excerpts_for_range` (functions mapping multi-buffer text-coordinates to excerpts)
4842#[gpui::test]
4843fn test_excerpts_containment_functions(cx: &mut App) {
4844 // Multibuffer content for these tests:
4845 // 0123
4846 // 0: aa0
4847 // 1: aa1
4848 // -----
4849 // 2: bb0
4850 // 3: bb1
4851 // -----MultiBufferOffset(0)..
4852 // 4: cc0
4853
4854 let buffer_1 = cx.new(|cx| Buffer::local("aa0\naa1", cx));
4855 let buffer_2 = cx.new(|cx| Buffer::local("bb0\nbb1", cx));
4856 let buffer_3 = cx.new(|cx| Buffer::local("cc0", cx));
4857
4858 let multibuffer = cx.new(|_| MultiBuffer::new(Capability::ReadWrite));
4859
4860 let (excerpt_1_info, excerpt_2_info, excerpt_3_info) =
4861 multibuffer.update(cx, |multibuffer, cx| {
4862 multibuffer.set_excerpts_for_path(
4863 PathKey::sorted(0),
4864 buffer_1.clone(),
4865 [Point::new(0, 0)..Point::new(1, 3)],
4866 0,
4867 cx,
4868 );
4869
4870 multibuffer.set_excerpts_for_path(
4871 PathKey::sorted(1),
4872 buffer_2.clone(),
4873 [Point::new(0, 0)..Point::new(1, 3)],
4874 0,
4875 cx,
4876 );
4877
4878 multibuffer.set_excerpts_for_path(
4879 PathKey::sorted(2),
4880 buffer_3.clone(),
4881 [Point::new(0, 0)..Point::new(0, 3)],
4882 0,
4883 cx,
4884 );
4885
4886 let snapshot = multibuffer.snapshot(cx);
4887 let mut infos = snapshot.excerpts().map(|(_, info)| info);
4888 (
4889 infos.next().unwrap(),
4890 infos.next().unwrap(),
4891 infos.next().unwrap(),
4892 )
4893 });
4894
4895 let snapshot = multibuffer.read(cx).snapshot(cx);
4896
4897 assert_eq!(snapshot.text(), "aa0\naa1\nbb0\nbb1\ncc0");
4898
4899 //// Test `excerpts_for_range`
4900
4901 let p00 = snapshot.point_to_offset(Point::new(0, 0));
4902 let p10 = snapshot.point_to_offset(Point::new(1, 0));
4903 let p20 = snapshot.point_to_offset(Point::new(2, 0));
4904 let p23 = snapshot.point_to_offset(Point::new(2, 3));
4905 let p13 = snapshot.point_to_offset(Point::new(1, 3));
4906 let p40 = snapshot.point_to_offset(Point::new(4, 0));
4907 let p43 = snapshot.point_to_offset(Point::new(4, 3));
4908
4909 let excerpts: Vec<_> = snapshot.excerpts_for_range(p00..p00).collect();
4910 assert_eq!(excerpts.len(), 1);
4911 assert_eq!(excerpts[0].info(), excerpt_1_info);
4912
4913 // Cursor at very end of excerpt 3
4914 let excerpts: Vec<_> = snapshot.excerpts_for_range(p43..p43).collect();
4915 assert_eq!(excerpts.len(), 1);
4916 assert_eq!(excerpts[0].info(), excerpt_3_info);
4917
4918 let excerpts: Vec<_> = snapshot.excerpts_for_range(p00..p23).collect();
4919 assert_eq!(excerpts.len(), 2);
4920 assert_eq!(excerpts[0].info(), excerpt_1_info);
4921 assert_eq!(excerpts[1].info(), excerpt_2_info);
4922
4923 // This range represent an selection with end-point just inside excerpt_2
4924 // Today we only expand the first excerpt, but another interpretation that
4925 // we could consider is expanding both here
4926 let excerpts: Vec<_> = snapshot.excerpts_for_range(p10..p20).collect();
4927 assert_eq!(excerpts.len(), 1);
4928 assert_eq!(excerpts[0].info(), excerpt_1_info);
4929
4930 //// Test that `excerpts_for_range` and `excerpt_containing` agree for all single offsets (cursor positions)
4931 for offset in 0..=snapshot.len().0 {
4932 let offset = MultiBufferOffset(offset);
4933 let excerpts_for_range: Vec<_> = snapshot.excerpts_for_range(offset..offset).collect();
4934 assert_eq!(
4935 excerpts_for_range.len(),
4936 1,
4937 "Expected exactly one excerpt for offset {offset}",
4938 );
4939
4940 let excerpt_containing = snapshot.excerpt_containing(offset..offset);
4941 assert!(
4942 excerpt_containing.is_some(),
4943 "Expected excerpt_containing to find excerpt for offset {offset}",
4944 );
4945
4946 assert_eq!(
4947 excerpts_for_range[0].info(),
4948 excerpt_containing.unwrap().excerpt.info(),
4949 "excerpts_for_range and excerpt_containing should agree for offset {offset}",
4950 );
4951 }
4952
4953 //// Test `excerpt_containing` behavior with ranges:
4954
4955 // Ranges intersecting a single-excerpt
4956 let containing = snapshot.excerpt_containing(p00..p13);
4957 assert!(containing.is_some());
4958 assert_eq!(containing.unwrap().excerpt.info(), excerpt_1_info);
4959
4960 // Ranges intersecting multiple excerpts (should return None)
4961 let containing = snapshot.excerpt_containing(p20..p40);
4962 assert!(
4963 containing.is_none(),
4964 "excerpt_containing should return None for ranges spanning multiple excerpts"
4965 );
4966}
4967
4968#[gpui::test]
4969fn test_range_to_buffer_ranges_with_range_bounds(cx: &mut App) {
4970 use std::ops::Bound;
4971
4972 let buffer_1 = cx.new(|cx| Buffer::local("aaa\nbbb", cx));
4973 let buffer_2 = cx.new(|cx| Buffer::local("ccc", cx));
4974
4975 let multibuffer = cx.new(|_| MultiBuffer::new(Capability::ReadWrite));
4976 multibuffer.update(cx, |multibuffer, cx| {
4977 multibuffer.set_excerpts_for_path(
4978 PathKey::sorted(0),
4979 buffer_1.clone(),
4980 [Point::new(0, 0)..Point::new(1, 3)],
4981 0,
4982 cx,
4983 );
4984
4985 multibuffer.set_excerpts_for_path(
4986 PathKey::sorted(1),
4987 buffer_2.clone(),
4988 [Point::new(0, 0)..Point::new(0, 3)],
4989 0,
4990 cx,
4991 );
4992 });
4993
4994 let snapshot = multibuffer.read(cx).snapshot(cx);
4995 assert_eq!(snapshot.text(), "aaa\nbbb\nccc");
4996
4997 let excerpt_2_start = Point::new(2, 0);
4998
4999 let ranges_half_open = snapshot.range_to_buffer_ranges(Point::zero()..excerpt_2_start);
5000 assert_eq!(
5001 ranges_half_open.len(),
5002 1,
5003 "Half-open range ending at excerpt start should EXCLUDE that excerpt"
5004 );
5005 assert_eq!(ranges_half_open[0].1, BufferOffset(0)..BufferOffset(7));
5006
5007 let ranges_inclusive = snapshot.range_to_buffer_ranges(Point::zero()..=excerpt_2_start);
5008 assert_eq!(
5009 ranges_inclusive.len(),
5010 2,
5011 "Inclusive range ending at excerpt start should INCLUDE that excerpt"
5012 );
5013 assert_eq!(ranges_half_open[0].1, BufferOffset(0)..BufferOffset(7));
5014 assert_eq!(
5015 ranges_half_open[0].0.remote_id(),
5016 buffer_1.read(cx).remote_id()
5017 );
5018 assert_eq!(ranges_half_open[1].1, BufferOffset(0)..BufferOffset(0));
5019 assert_eq!(
5020 ranges_half_open[1].0.remote_id(),
5021 buffer_2.read(cx).remote_id()
5022 );
5023
5024 let ranges_unbounded =
5025 snapshot.range_to_buffer_ranges((Bound::Included(Point::zero()), Bound::Unbounded));
5026 assert_eq!(
5027 ranges_unbounded.len(),
5028 2,
5029 "Unbounded end should include all excerpts"
5030 );
5031 assert_eq!(ranges_half_open[0].1, BufferOffset(0)..BufferOffset(7));
5032 assert_eq!(
5033 ranges_half_open[0].0.remote_id(),
5034 buffer_1.read(cx).remote_id()
5035 );
5036 assert_eq!(ranges_half_open[1].1, BufferOffset(0)..BufferOffset(3));
5037 assert_eq!(
5038 ranges_half_open[1].0.remote_id(),
5039 buffer_2.read(cx).remote_id()
5040 );
5041
5042 let ranges_excluded_end = snapshot.range_to_buffer_ranges((
5043 Bound::Included(Point::zero()),
5044 Bound::Excluded(excerpt_2_start),
5045 ));
5046 assert_eq!(
5047 ranges_excluded_end.len(),
5048 1,
5049 "Excluded end bound should exclude excerpt starting at that point"
5050 );
5051 assert_eq!(ranges_half_open[0].1, BufferOffset(0)..BufferOffset(7));
5052 assert_eq!(
5053 ranges_half_open[0].0.remote_id(),
5054 buffer_1.read(cx).remote_id()
5055 );
5056
5057 let buffer_empty = cx.new(|cx| Buffer::local("", cx));
5058 let multibuffer_trailing_empty = cx.new(|_| MultiBuffer::new(Capability::ReadWrite));
5059 let (te_excerpt_1_info, te_excerpt_2_info) =
5060 multibuffer_trailing_empty.update(cx, |multibuffer, cx| {
5061 multibuffer.set_excerpts_for_path(
5062 PathKey::sorted(0),
5063 buffer_1.clone(),
5064 [Point::new(0, 0)..Point::new(1, 3)],
5065 0,
5066 cx,
5067 );
5068
5069 multibuffer.set_excerpts_for_path(
5070 PathKey::sorted(1),
5071 buffer_empty.clone(),
5072 [Point::new(0, 0)..Point::new(0, 0)],
5073 0,
5074 cx,
5075 );
5076
5077 let snapshot = multibuffer.snapshot(cx);
5078 let mut infos = snapshot.excerpts().map(|(_, info)| info);
5079 (infos.next().unwrap(), infos.next().unwrap())
5080 });
5081
5082 let snapshot_trailing = multibuffer_trailing_empty.read(cx).snapshot(cx);
5083 assert_eq!(snapshot_trailing.text(), "aaa\nbbb\n");
5084
5085 let max_point = snapshot_trailing.max_point();
5086
5087 let ranges_half_open_max =
5088 snapshot_trailing.range_to_buffer_ranges_with_context(Point::zero()..max_point);
5089 assert_eq!(
5090 ranges_half_open_max.len(),
5091 1,
5092 "Half-open range to max_point should EXCLUDE trailing empty excerpt at max_point"
5093 );
5094 assert_eq!(ranges_half_open_max[0].2, te_excerpt_1_info.range.context);
5095
5096 let ranges_inclusive_max =
5097 snapshot_trailing.range_to_buffer_ranges_with_context(Point::zero()..=max_point);
5098 assert_eq!(
5099 ranges_inclusive_max.len(),
5100 2,
5101 "Inclusive range to max_point should INCLUDE trailing empty excerpt"
5102 );
5103 assert_eq!(ranges_inclusive_max[0].2, te_excerpt_1_info.range.context);
5104 assert_eq!(ranges_inclusive_max[1].2, te_excerpt_2_info.range.context);
5105
5106 let ranges_unbounded_trailing = snapshot_trailing
5107 .range_to_buffer_ranges_with_context((Bound::Included(Point::zero()), Bound::Unbounded));
5108 assert_eq!(
5109 ranges_unbounded_trailing.len(),
5110 2,
5111 "Unbounded end should include trailing empty excerpt"
5112 );
5113 assert_eq!(
5114 ranges_unbounded_trailing[0].2,
5115 te_excerpt_1_info.range.context
5116 );
5117 assert_eq!(
5118 ranges_unbounded_trailing[1].2,
5119 te_excerpt_2_info.range.context
5120 );
5121}
5122
5123#[gpui::test]
5124fn test_cannot_seek_backward_after_excerpt_replacement(cx: &mut TestAppContext) {
5125 let buffer_b_text: String = (0..50).map(|i| format!("line_b {i}\n")).collect();
5126 let buffer_b = cx.new(|cx| Buffer::local(buffer_b_text, cx));
5127
5128 let buffer_c_text: String = (0..10).map(|i| format!("line_c {i}\n")).collect();
5129 let buffer_c = cx.new(|cx| Buffer::local(buffer_c_text, cx));
5130
5131 let buffer_d_text: String = (0..10).map(|i| format!("line_d {i}\n")).collect();
5132 let buffer_d = cx.new(|cx| Buffer::local(buffer_d_text, cx));
5133
5134 let path_b = PathKey::with_sort_prefix(0, rel_path("bbb.rs").into_arc());
5135 let path_c = PathKey::with_sort_prefix(0, rel_path("ddd.rs").into_arc());
5136 let path_d = PathKey::with_sort_prefix(0, rel_path("ccc.rs").into_arc());
5137
5138 let multibuffer = cx.new(|_| MultiBuffer::new(Capability::ReadWrite));
5139
5140 multibuffer.update(cx, |multibuffer, cx| {
5141 multibuffer.set_excerpts_for_path(
5142 path_b.clone(),
5143 buffer_b.clone(),
5144 vec![
5145 Point::row_range(0..3),
5146 Point::row_range(15..18),
5147 Point::row_range(30..33),
5148 ],
5149 0,
5150 cx,
5151 );
5152 });
5153
5154 multibuffer.update(cx, |multibuffer, cx| {
5155 multibuffer.set_excerpts_for_path(
5156 path_c.clone(),
5157 buffer_c.clone(),
5158 vec![Point::row_range(0..3)],
5159 0,
5160 cx,
5161 );
5162 });
5163
5164 let (anchor_in_e_b2, anchor_in_e_b3) = multibuffer.read_with(cx, |multibuffer, cx| {
5165 let snapshot = multibuffer.snapshot(cx);
5166 let excerpt_infos: Vec<ExcerptInfo> = snapshot.excerpts().map(|(_, info)| info).collect();
5167 assert_eq!(excerpt_infos.len(), 4, "expected 4 excerpts (3×B + 1×C)");
5168
5169 let e_b2_info = excerpt_infos[1].clone();
5170 let e_b3_info = excerpt_infos[2].clone();
5171
5172 let anchor_b2 = Anchor::in_buffer(e_b2_info.path_key_index, e_b2_info.range.context.start);
5173 let anchor_b3 = Anchor::in_buffer(e_b3_info.path_key_index, e_b3_info.range.context.start);
5174 (anchor_b2, anchor_b3)
5175 });
5176
5177 multibuffer.update(cx, |multibuffer, cx| {
5178 multibuffer.set_excerpts_for_path(
5179 path_b.clone(),
5180 buffer_b.clone(),
5181 vec![Point::row_range(0..3), Point::row_range(28..36)],
5182 0,
5183 cx,
5184 );
5185 });
5186
5187 multibuffer.update(cx, |multibuffer, cx| {
5188 multibuffer.set_excerpts_for_path(
5189 path_d.clone(),
5190 buffer_d.clone(),
5191 vec![Point::row_range(0..3)],
5192 0,
5193 cx,
5194 );
5195 });
5196
5197 multibuffer.read_with(cx, |multibuffer, cx| {
5198 let snapshot = multibuffer.snapshot(cx);
5199 snapshot.summaries_for_anchors::<Point, _>(&[anchor_in_e_b2, anchor_in_e_b3]);
5200 });
5201}