multi_buffer_tests.rs

   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(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(
 879            multibuffer
 880                .snapshot(cx)
 881                .excerpts()
 882                .map(|(_, info)| Anchor::in_buffer(info.path_key_index, info.range.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    let new_snapshot = multibuffer.read(cx).snapshot(cx);
1113
1114    assert_eq!(old_snapshot.text(), "abcd");
1115    assert_eq!(new_snapshot.text(), "XabcdY");
1116
1117    assert_eq!(
1118        old_snapshot
1119            .anchor_before(MultiBufferOffset(0))
1120            .to_offset(&new_snapshot),
1121        MultiBufferOffset(0)
1122    );
1123    assert_eq!(
1124        old_snapshot
1125            .anchor_after(MultiBufferOffset(0))
1126            .to_offset(&new_snapshot),
1127        MultiBufferOffset(1)
1128    );
1129    assert_eq!(
1130        old_snapshot
1131            .anchor_before(MultiBufferOffset(4))
1132            .to_offset(&new_snapshot),
1133        MultiBufferOffset(5)
1134    );
1135    assert_eq!(
1136        old_snapshot
1137            .anchor_after(MultiBufferOffset(4))
1138            .to_offset(&new_snapshot),
1139        MultiBufferOffset(6)
1140    );
1141}
1142
1143#[gpui::test]
1144fn test_multibuffer_anchors(cx: &mut App) {
1145    let buffer_1 = cx.new(|cx| Buffer::local("abcd", cx));
1146    let buffer_2 = cx.new(|cx| Buffer::local("efghi", cx));
1147    let multibuffer = cx.new(|cx| {
1148        let mut multibuffer = MultiBuffer::new(Capability::ReadWrite);
1149        multibuffer.set_excerpts_for_path(
1150            PathKey::sorted(0),
1151            buffer_1.clone(),
1152            [Point::new(0, 0)..Point::new(0, 4)],
1153            0,
1154            cx,
1155        );
1156        multibuffer.set_excerpts_for_path(
1157            PathKey::sorted(1),
1158            buffer_2.clone(),
1159            [Point::new(0, 0)..Point::new(0, 5)],
1160            0,
1161            cx,
1162        );
1163        multibuffer
1164    });
1165    let old_snapshot = multibuffer.read(cx).snapshot(cx);
1166
1167    assert_eq!(
1168        old_snapshot
1169            .anchor_before(MultiBufferOffset(0))
1170            .to_offset(&old_snapshot),
1171        MultiBufferOffset(0)
1172    );
1173    assert_eq!(
1174        old_snapshot
1175            .anchor_after(MultiBufferOffset(0))
1176            .to_offset(&old_snapshot),
1177        MultiBufferOffset(0)
1178    );
1179    assert_eq!(Anchor::min().to_offset(&old_snapshot), MultiBufferOffset(0));
1180    assert_eq!(Anchor::min().to_offset(&old_snapshot), MultiBufferOffset(0));
1181    assert_eq!(
1182        Anchor::max().to_offset(&old_snapshot),
1183        MultiBufferOffset(10)
1184    );
1185    assert_eq!(
1186        Anchor::max().to_offset(&old_snapshot),
1187        MultiBufferOffset(10)
1188    );
1189
1190    buffer_1.update(cx, |buffer, cx| {
1191        buffer.edit([(0..0, "W")], None, cx);
1192        buffer.edit([(5..5, "X")], None, cx);
1193    });
1194    buffer_2.update(cx, |buffer, cx| {
1195        buffer.edit([(0..0, "Y")], None, cx);
1196        buffer.edit([(6..6, "Z")], None, cx);
1197    });
1198    let new_snapshot = multibuffer.read(cx).snapshot(cx);
1199
1200    assert_eq!(old_snapshot.text(), "abcd\nefghi");
1201    assert_eq!(new_snapshot.text(), "WabcdX\nYefghiZ");
1202
1203    assert_eq!(
1204        old_snapshot
1205            .anchor_before(MultiBufferOffset(0))
1206            .to_offset(&new_snapshot),
1207        MultiBufferOffset(0)
1208    );
1209    assert_eq!(
1210        old_snapshot
1211            .anchor_after(MultiBufferOffset(0))
1212            .to_offset(&new_snapshot),
1213        MultiBufferOffset(1)
1214    );
1215    assert_eq!(
1216        old_snapshot
1217            .anchor_before(MultiBufferOffset(1))
1218            .to_offset(&new_snapshot),
1219        MultiBufferOffset(2)
1220    );
1221    assert_eq!(
1222        old_snapshot
1223            .anchor_after(MultiBufferOffset(1))
1224            .to_offset(&new_snapshot),
1225        MultiBufferOffset(2)
1226    );
1227    assert_eq!(
1228        old_snapshot
1229            .anchor_before(MultiBufferOffset(2))
1230            .to_offset(&new_snapshot),
1231        MultiBufferOffset(3)
1232    );
1233    assert_eq!(
1234        old_snapshot
1235            .anchor_after(MultiBufferOffset(2))
1236            .to_offset(&new_snapshot),
1237        MultiBufferOffset(3)
1238    );
1239    assert_eq!(
1240        old_snapshot
1241            .anchor_before(MultiBufferOffset(5))
1242            .to_offset(&new_snapshot),
1243        MultiBufferOffset(7)
1244    );
1245    assert_eq!(
1246        old_snapshot
1247            .anchor_after(MultiBufferOffset(5))
1248            .to_offset(&new_snapshot),
1249        MultiBufferOffset(8)
1250    );
1251    assert_eq!(
1252        old_snapshot
1253            .anchor_before(MultiBufferOffset(10))
1254            .to_offset(&new_snapshot),
1255        MultiBufferOffset(13)
1256    );
1257    assert_eq!(
1258        old_snapshot
1259            .anchor_after(MultiBufferOffset(10))
1260            .to_offset(&new_snapshot),
1261        MultiBufferOffset(14)
1262    );
1263}
1264
1265#[gpui::test]
1266async fn test_basic_diff_hunks(cx: &mut TestAppContext) {
1267    let text = indoc!(
1268        "
1269        ZERO
1270        one
1271        TWO
1272        three
1273        six
1274        "
1275    );
1276    let base_text = indoc!(
1277        "
1278        one
1279        two
1280        three
1281        four
1282        five
1283        six
1284        "
1285    );
1286
1287    let buffer = cx.new(|cx| Buffer::local(text, cx));
1288    let diff = cx
1289        .new(|cx| BufferDiff::new_with_base_text(base_text, &buffer.read(cx).text_snapshot(), cx));
1290    cx.run_until_parked();
1291
1292    let multibuffer = cx.new(|cx| {
1293        let mut multibuffer = MultiBuffer::singleton(buffer.clone(), cx);
1294        multibuffer.add_diff(diff.clone(), cx);
1295        multibuffer
1296    });
1297
1298    let (mut snapshot, mut subscription) = multibuffer.update(cx, |multibuffer, cx| {
1299        (multibuffer.snapshot(cx), multibuffer.subscribe())
1300    });
1301    assert_eq!(
1302        snapshot.text(),
1303        indoc!(
1304            "
1305            ZERO
1306            one
1307            TWO
1308            three
1309            six
1310            "
1311        ),
1312    );
1313
1314    multibuffer.update(cx, |multibuffer, cx| {
1315        multibuffer.expand_diff_hunks(vec![Anchor::min()..Anchor::max()], cx);
1316    });
1317
1318    assert_new_snapshot(
1319        &multibuffer,
1320        &mut snapshot,
1321        &mut subscription,
1322        cx,
1323        indoc!(
1324            "
1325            + ZERO
1326              one
1327            - two
1328            + TWO
1329              three
1330            - four
1331            - five
1332              six
1333            "
1334        ),
1335    );
1336
1337    assert_eq!(
1338        snapshot
1339            .row_infos(MultiBufferRow(0))
1340            .map(|info| (info.buffer_row, info.diff_status))
1341            .collect::<Vec<_>>(),
1342        vec![
1343            (Some(0), Some(DiffHunkStatus::added_none())),
1344            (Some(1), None),
1345            (Some(1), Some(DiffHunkStatus::deleted_none())),
1346            (Some(2), Some(DiffHunkStatus::added_none())),
1347            (Some(3), None),
1348            (Some(3), Some(DiffHunkStatus::deleted_none())),
1349            (Some(4), Some(DiffHunkStatus::deleted_none())),
1350            (Some(4), None),
1351            (Some(5), None)
1352        ]
1353    );
1354
1355    assert_chunks_in_ranges(&snapshot);
1356    assert_consistent_line_numbers(&snapshot);
1357    assert_position_translation(&snapshot);
1358    assert_line_indents(&snapshot);
1359
1360    multibuffer.update(cx, |multibuffer, cx| {
1361        multibuffer.collapse_diff_hunks(vec![Anchor::min()..Anchor::max()], cx)
1362    });
1363    assert_new_snapshot(
1364        &multibuffer,
1365        &mut snapshot,
1366        &mut subscription,
1367        cx,
1368        indoc!(
1369            "
1370            ZERO
1371            one
1372            TWO
1373            three
1374            six
1375            "
1376        ),
1377    );
1378
1379    assert_chunks_in_ranges(&snapshot);
1380    assert_consistent_line_numbers(&snapshot);
1381    assert_position_translation(&snapshot);
1382    assert_line_indents(&snapshot);
1383
1384    // Expand the first diff hunk
1385    multibuffer.update(cx, |multibuffer, cx| {
1386        let position = multibuffer.read(cx).anchor_before(Point::new(2, 2));
1387        multibuffer.expand_diff_hunks(vec![position..position], cx)
1388    });
1389    assert_new_snapshot(
1390        &multibuffer,
1391        &mut snapshot,
1392        &mut subscription,
1393        cx,
1394        indoc!(
1395            "
1396              ZERO
1397              one
1398            - two
1399            + TWO
1400              three
1401              six
1402            "
1403        ),
1404    );
1405
1406    // Expand the second diff hunk
1407    multibuffer.update(cx, |multibuffer, cx| {
1408        let start = multibuffer.read(cx).anchor_before(Point::new(4, 0));
1409        let end = multibuffer.read(cx).anchor_before(Point::new(5, 0));
1410        multibuffer.expand_diff_hunks(vec![start..end], cx)
1411    });
1412    assert_new_snapshot(
1413        &multibuffer,
1414        &mut snapshot,
1415        &mut subscription,
1416        cx,
1417        indoc!(
1418            "
1419              ZERO
1420              one
1421            - two
1422            + TWO
1423              three
1424            - four
1425            - five
1426              six
1427            "
1428        ),
1429    );
1430
1431    assert_chunks_in_ranges(&snapshot);
1432    assert_consistent_line_numbers(&snapshot);
1433    assert_position_translation(&snapshot);
1434    assert_line_indents(&snapshot);
1435
1436    // Edit the buffer before the first hunk
1437    buffer.update(cx, |buffer, cx| {
1438        buffer.edit_via_marked_text(
1439            indoc!(
1440                "
1441                ZERO
1442                one« hundred
1443                  thousand»
1444                TWO
1445                three
1446                six
1447                "
1448            ),
1449            None,
1450            cx,
1451        );
1452    });
1453    assert_new_snapshot(
1454        &multibuffer,
1455        &mut snapshot,
1456        &mut subscription,
1457        cx,
1458        indoc!(
1459            "
1460              ZERO
1461              one hundred
1462                thousand
1463            - two
1464            + TWO
1465              three
1466            - four
1467            - five
1468              six
1469            "
1470        ),
1471    );
1472
1473    assert_chunks_in_ranges(&snapshot);
1474    assert_consistent_line_numbers(&snapshot);
1475    assert_position_translation(&snapshot);
1476    assert_line_indents(&snapshot);
1477
1478    // Recalculate the diff, changing the first diff hunk.
1479    diff.update(cx, |diff, cx| {
1480        diff.recalculate_diff_sync(&buffer.read(cx).text_snapshot(), cx);
1481    });
1482    cx.run_until_parked();
1483    assert_new_snapshot(
1484        &multibuffer,
1485        &mut snapshot,
1486        &mut subscription,
1487        cx,
1488        indoc!(
1489            "
1490              ZERO
1491              one hundred
1492                thousand
1493              TWO
1494              three
1495            - four
1496            - five
1497              six
1498            "
1499        ),
1500    );
1501
1502    assert_eq!(
1503        snapshot
1504            .diff_hunks_in_range(MultiBufferOffset(0)..snapshot.len())
1505            .map(|hunk| hunk.row_range.start.0..hunk.row_range.end.0)
1506            .collect::<Vec<_>>(),
1507        &[0..4, 5..7]
1508    );
1509}
1510
1511#[gpui::test]
1512async fn test_repeatedly_expand_a_diff_hunk(cx: &mut TestAppContext) {
1513    let text = indoc!(
1514        "
1515        one
1516        TWO
1517        THREE
1518        four
1519        FIVE
1520        six
1521        "
1522    );
1523    let base_text = indoc!(
1524        "
1525        one
1526        four
1527        five
1528        six
1529        "
1530    );
1531
1532    let buffer = cx.new(|cx| Buffer::local(text, cx));
1533    let diff = cx
1534        .new(|cx| BufferDiff::new_with_base_text(base_text, &buffer.read(cx).text_snapshot(), cx));
1535    cx.run_until_parked();
1536
1537    let multibuffer = cx.new(|cx| {
1538        let mut multibuffer = MultiBuffer::singleton(buffer.clone(), cx);
1539        multibuffer.add_diff(diff.clone(), cx);
1540        multibuffer
1541    });
1542
1543    let (mut snapshot, mut subscription) = multibuffer.update(cx, |multibuffer, cx| {
1544        (multibuffer.snapshot(cx), multibuffer.subscribe())
1545    });
1546
1547    multibuffer.update(cx, |multibuffer, cx| {
1548        multibuffer.expand_diff_hunks(vec![Anchor::min()..Anchor::max()], cx);
1549    });
1550
1551    assert_new_snapshot(
1552        &multibuffer,
1553        &mut snapshot,
1554        &mut subscription,
1555        cx,
1556        indoc!(
1557            "
1558              one
1559            + TWO
1560            + THREE
1561              four
1562            - five
1563            + FIVE
1564              six
1565            "
1566        ),
1567    );
1568
1569    // Regression test: expanding diff hunks that are already expanded should not change anything.
1570    multibuffer.update(cx, |multibuffer, cx| {
1571        multibuffer.expand_diff_hunks(
1572            vec![
1573                snapshot.anchor_before(Point::new(2, 0))..snapshot.anchor_before(Point::new(2, 0)),
1574            ],
1575            cx,
1576        );
1577    });
1578
1579    assert_new_snapshot(
1580        &multibuffer,
1581        &mut snapshot,
1582        &mut subscription,
1583        cx,
1584        indoc!(
1585            "
1586              one
1587            + TWO
1588            + THREE
1589              four
1590            - five
1591            + FIVE
1592              six
1593            "
1594        ),
1595    );
1596
1597    // Now collapse all diff hunks
1598    multibuffer.update(cx, |multibuffer, cx| {
1599        multibuffer.collapse_diff_hunks(vec![Anchor::min()..Anchor::max()], cx);
1600    });
1601
1602    assert_new_snapshot(
1603        &multibuffer,
1604        &mut snapshot,
1605        &mut subscription,
1606        cx,
1607        indoc!(
1608            "
1609            one
1610            TWO
1611            THREE
1612            four
1613            FIVE
1614            six
1615            "
1616        ),
1617    );
1618
1619    // Expand the hunks again, but this time provide two ranges that are both within the same hunk
1620    // Target the first hunk which is between "one" and "four"
1621    multibuffer.update(cx, |multibuffer, cx| {
1622        multibuffer.expand_diff_hunks(
1623            vec![
1624                snapshot.anchor_before(Point::new(4, 0))..snapshot.anchor_before(Point::new(4, 0)),
1625                snapshot.anchor_before(Point::new(4, 2))..snapshot.anchor_before(Point::new(4, 2)),
1626            ],
1627            cx,
1628        );
1629    });
1630    assert_new_snapshot(
1631        &multibuffer,
1632        &mut snapshot,
1633        &mut subscription,
1634        cx,
1635        indoc!(
1636            "
1637              one
1638              TWO
1639              THREE
1640              four
1641            - five
1642            + FIVE
1643              six
1644            "
1645        ),
1646    );
1647}
1648
1649#[gpui::test]
1650fn test_set_excerpts_for_buffer_ordering(cx: &mut TestAppContext) {
1651    let buf1 = cx.new(|cx| {
1652        Buffer::local(
1653            indoc! {
1654            "zero
1655            one
1656            two
1657            two.five
1658            three
1659            four
1660            five
1661            six
1662            seven
1663            eight
1664            nine
1665            ten
1666            eleven
1667            ",
1668            },
1669            cx,
1670        )
1671    });
1672    let path1: PathKey = PathKey::with_sort_prefix(0, rel_path("root").into_arc());
1673
1674    let multibuffer = cx.new(|_| MultiBuffer::new(Capability::ReadWrite));
1675    multibuffer.update(cx, |multibuffer, cx| {
1676        multibuffer.set_excerpts_for_path(
1677            path1.clone(),
1678            buf1.clone(),
1679            vec![
1680                Point::row_range(1..2),
1681                Point::row_range(6..7),
1682                Point::row_range(11..12),
1683            ],
1684            1,
1685            cx,
1686        );
1687    });
1688
1689    assert_excerpts_match(
1690        &multibuffer,
1691        cx,
1692        indoc! {
1693            "-----
1694            zero
1695            one
1696            two
1697            two.five
1698            -----
1699            four
1700            five
1701            six
1702            seven
1703            -----
1704            nine
1705            ten
1706            eleven
1707            "
1708        },
1709    );
1710
1711    buf1.update(cx, |buffer, cx| buffer.edit([(0..5, "")], None, cx));
1712
1713    multibuffer.update(cx, |multibuffer, cx| {
1714        multibuffer.set_excerpts_for_path(
1715            path1.clone(),
1716            buf1.clone(),
1717            vec![
1718                Point::row_range(0..3),
1719                Point::row_range(5..7),
1720                Point::row_range(10..11),
1721            ],
1722            1,
1723            cx,
1724        );
1725    });
1726
1727    assert_excerpts_match(
1728        &multibuffer,
1729        cx,
1730        indoc! {
1731            "-----
1732             one
1733             two
1734             two.five
1735             three
1736             four
1737             five
1738             six
1739             seven
1740             eight
1741             nine
1742             ten
1743             eleven
1744            "
1745        },
1746    );
1747}
1748
1749#[gpui::test]
1750fn test_set_excerpts_for_buffer(cx: &mut TestAppContext) {
1751    let buf1 = cx.new(|cx| {
1752        Buffer::local(
1753            indoc! {
1754            "zero
1755            one
1756            two
1757            three
1758            four
1759            five
1760            six
1761            seven
1762            ",
1763            },
1764            cx,
1765        )
1766    });
1767    let path1: PathKey = PathKey::with_sort_prefix(0, rel_path("root").into_arc());
1768    let buf2 = cx.new(|cx| {
1769        Buffer::local(
1770            indoc! {
1771            "000
1772            111
1773            222
1774            333
1775            444
1776            555
1777            666
1778            777
1779            888
1780            999
1781            "
1782            },
1783            cx,
1784        )
1785    });
1786    let path2 = PathKey::with_sort_prefix(1, rel_path("root").into_arc());
1787
1788    let multibuffer = cx.new(|_| MultiBuffer::new(Capability::ReadWrite));
1789    multibuffer.update(cx, |multibuffer, cx| {
1790        multibuffer.set_excerpts_for_path(
1791            path1.clone(),
1792            buf1.clone(),
1793            vec![Point::row_range(0..1)],
1794            2,
1795            cx,
1796        );
1797    });
1798
1799    assert_excerpts_match(
1800        &multibuffer,
1801        cx,
1802        indoc! {
1803        "-----
1804        zero
1805        one
1806        two
1807        three
1808        "
1809        },
1810    );
1811
1812    multibuffer.update(cx, |multibuffer, cx| {
1813        multibuffer.set_excerpts_for_path(path1.clone(), buf1.clone(), vec![], 2, cx);
1814    });
1815
1816    assert_excerpts_match(&multibuffer, cx, "");
1817
1818    multibuffer.update(cx, |multibuffer, cx| {
1819        multibuffer.set_excerpts_for_path(
1820            path1.clone(),
1821            buf1.clone(),
1822            vec![Point::row_range(0..1), Point::row_range(7..8)],
1823            2,
1824            cx,
1825        );
1826    });
1827
1828    assert_excerpts_match(
1829        &multibuffer,
1830        cx,
1831        indoc! {"-----
1832                zero
1833                one
1834                two
1835                three
1836                -----
1837                five
1838                six
1839                seven
1840                "},
1841    );
1842
1843    multibuffer.update(cx, |multibuffer, cx| {
1844        multibuffer.set_excerpts_for_path(
1845            path1.clone(),
1846            buf1.clone(),
1847            vec![Point::row_range(0..1), Point::row_range(5..6)],
1848            2,
1849            cx,
1850        );
1851    });
1852
1853    assert_excerpts_match(
1854        &multibuffer,
1855        cx,
1856        indoc! {"-----
1857                    zero
1858                    one
1859                    two
1860                    three
1861                    four
1862                    five
1863                    six
1864                    seven
1865                    "},
1866    );
1867
1868    multibuffer.update(cx, |multibuffer, cx| {
1869        multibuffer.set_excerpts_for_path(
1870            path2.clone(),
1871            buf2.clone(),
1872            vec![Point::row_range(2..3)],
1873            2,
1874            cx,
1875        );
1876    });
1877
1878    assert_excerpts_match(
1879        &multibuffer,
1880        cx,
1881        indoc! {"-----
1882                zero
1883                one
1884                two
1885                three
1886                four
1887                five
1888                six
1889                seven
1890                -----
1891                000
1892                111
1893                222
1894                333
1895                444
1896                555
1897                "},
1898    );
1899
1900    multibuffer.update(cx, |multibuffer, cx| {
1901        multibuffer.set_excerpts_for_path(path1.clone(), buf1.clone(), vec![], 2, cx);
1902    });
1903
1904    multibuffer.update(cx, |multibuffer, cx| {
1905        multibuffer.set_excerpts_for_path(
1906            path1.clone(),
1907            buf1.clone(),
1908            vec![Point::row_range(3..4)],
1909            2,
1910            cx,
1911        );
1912    });
1913
1914    assert_excerpts_match(
1915        &multibuffer,
1916        cx,
1917        indoc! {"-----
1918                one
1919                two
1920                three
1921                four
1922                five
1923                six
1924                -----
1925                000
1926                111
1927                222
1928                333
1929                444
1930                555
1931                "},
1932    );
1933
1934    multibuffer.update(cx, |multibuffer, cx| {
1935        multibuffer.set_excerpts_for_path(
1936            path1.clone(),
1937            buf1.clone(),
1938            vec![Point::row_range(3..4)],
1939            2,
1940            cx,
1941        );
1942    });
1943}
1944
1945#[gpui::test]
1946fn test_set_excerpts_for_buffer_rename(cx: &mut TestAppContext) {
1947    let buf1 = cx.new(|cx| {
1948        Buffer::local(
1949            indoc! {
1950            "zero
1951            one
1952            two
1953            three
1954            four
1955            five
1956            six
1957            seven
1958            ",
1959            },
1960            cx,
1961        )
1962    });
1963    let path: PathKey = PathKey::with_sort_prefix(0, rel_path("root").into_arc());
1964    let buf2 = cx.new(|cx| {
1965        Buffer::local(
1966            indoc! {
1967            "000
1968            111
1969            222
1970            333
1971            "
1972            },
1973            cx,
1974        )
1975    });
1976
1977    let multibuffer = cx.new(|_| MultiBuffer::new(Capability::ReadWrite));
1978    multibuffer.update(cx, |multibuffer, cx| {
1979        multibuffer.set_excerpts_for_path(
1980            path.clone(),
1981            buf1.clone(),
1982            vec![Point::row_range(1..1), Point::row_range(4..5)],
1983            1,
1984            cx,
1985        );
1986    });
1987
1988    assert_excerpts_match(
1989        &multibuffer,
1990        cx,
1991        indoc! {
1992        "-----
1993        zero
1994        one
1995        two
1996        three
1997        four
1998        five
1999        six
2000        "
2001        },
2002    );
2003
2004    multibuffer.update(cx, |multibuffer, cx| {
2005        multibuffer.set_excerpts_for_path(
2006            path.clone(),
2007            buf2.clone(),
2008            vec![Point::row_range(0..1)],
2009            2,
2010            cx,
2011        );
2012    });
2013
2014    assert_excerpts_match(
2015        &multibuffer,
2016        cx,
2017        indoc! {"-----
2018                000
2019                111
2020                222
2021                333
2022                "},
2023    );
2024}
2025
2026#[gpui::test]
2027async fn test_diff_hunks_with_multiple_excerpts(cx: &mut TestAppContext) {
2028    let base_text_1 = indoc!(
2029        "
2030        one
2031        two
2032            three
2033        four
2034        five
2035        six
2036        "
2037    );
2038    let text_1 = indoc!(
2039        "
2040        ZERO
2041        one
2042        TWO
2043            three
2044        six
2045        "
2046    );
2047    let base_text_2 = indoc!(
2048        "
2049        seven
2050          eight
2051        nine
2052        ten
2053        eleven
2054        twelve
2055        "
2056    );
2057    let text_2 = indoc!(
2058        "
2059          eight
2060        nine
2061        eleven
2062        THIRTEEN
2063        FOURTEEN
2064        "
2065    );
2066
2067    let buffer_1 = cx.new(|cx| Buffer::local(text_1, cx));
2068    let buffer_2 = cx.new(|cx| Buffer::local(text_2, cx));
2069    let diff_1 = cx.new(|cx| {
2070        BufferDiff::new_with_base_text(base_text_1, &buffer_1.read(cx).text_snapshot(), cx)
2071    });
2072    let diff_2 = cx.new(|cx| {
2073        BufferDiff::new_with_base_text(base_text_2, &buffer_2.read(cx).text_snapshot(), cx)
2074    });
2075    cx.run_until_parked();
2076
2077    let multibuffer = cx.new(|cx| {
2078        let mut multibuffer = MultiBuffer::new(Capability::ReadWrite);
2079        multibuffer.set_excerpts_for_path(
2080            PathKey::sorted(0),
2081            buffer_1.clone(),
2082            [Point::zero()..buffer_1.read(cx).max_point()],
2083            0,
2084            cx,
2085        );
2086        multibuffer.set_excerpts_for_path(
2087            PathKey::sorted(1),
2088            buffer_2.clone(),
2089            [Point::zero()..buffer_2.read(cx).max_point()],
2090            0,
2091            cx,
2092        );
2093        multibuffer.add_diff(diff_1.clone(), cx);
2094        multibuffer.add_diff(diff_2.clone(), cx);
2095        multibuffer
2096    });
2097
2098    let (mut snapshot, mut subscription) = multibuffer.update(cx, |multibuffer, cx| {
2099        (multibuffer.snapshot(cx), multibuffer.subscribe())
2100    });
2101    assert_eq!(
2102        snapshot.text(),
2103        indoc!(
2104            "
2105            ZERO
2106            one
2107            TWO
2108                three
2109            six
2110
2111              eight
2112            nine
2113            eleven
2114            THIRTEEN
2115            FOURTEEN
2116            "
2117        ),
2118    );
2119
2120    multibuffer.update(cx, |multibuffer, cx| {
2121        multibuffer.expand_diff_hunks(vec![Anchor::min()..Anchor::max()], cx);
2122    });
2123
2124    assert_new_snapshot(
2125        &multibuffer,
2126        &mut snapshot,
2127        &mut subscription,
2128        cx,
2129        indoc!(
2130            "
2131            + ZERO
2132              one
2133            - two
2134            + TWO
2135                  three
2136            - four
2137            - five
2138              six
2139
2140            - seven
2141                eight
2142              nine
2143            - ten
2144              eleven
2145            - twelve
2146            + THIRTEEN
2147            + FOURTEEN
2148            "
2149        ),
2150    );
2151
2152    let id_1 = buffer_1.read_with(cx, |buffer, _| buffer.remote_id());
2153    let id_2 = buffer_2.read_with(cx, |buffer, _| buffer.remote_id());
2154    let base_id_1 = diff_1.read_with(cx, |diff, cx| diff.base_text(cx).remote_id());
2155    let base_id_2 = diff_2.read_with(cx, |diff, cx| diff.base_text(cx).remote_id());
2156
2157    let buffer_lines = (0..=snapshot.max_row().0)
2158        .map(|row| {
2159            let (buffer, range) = snapshot.buffer_line_for_row(MultiBufferRow(row))?;
2160            Some((
2161                buffer.remote_id(),
2162                buffer.text_for_range(range).collect::<String>(),
2163            ))
2164        })
2165        .collect::<Vec<_>>();
2166    pretty_assertions::assert_eq!(
2167        buffer_lines,
2168        [
2169            Some((id_1, "ZERO".into())),
2170            Some((id_1, "one".into())),
2171            Some((base_id_1, "two".into())),
2172            Some((id_1, "TWO".into())),
2173            Some((id_1, "    three".into())),
2174            Some((base_id_1, "four".into())),
2175            Some((base_id_1, "five".into())),
2176            Some((id_1, "six".into())),
2177            Some((id_1, "".into())),
2178            Some((base_id_2, "seven".into())),
2179            Some((id_2, "  eight".into())),
2180            Some((id_2, "nine".into())),
2181            Some((base_id_2, "ten".into())),
2182            Some((id_2, "eleven".into())),
2183            Some((base_id_2, "twelve".into())),
2184            Some((id_2, "THIRTEEN".into())),
2185            Some((id_2, "FOURTEEN".into())),
2186            Some((id_2, "".into())),
2187        ]
2188    );
2189
2190    let buffer_ids_by_range = [
2191        (Point::new(0, 0)..Point::new(0, 0), &[id_1] as &[_]),
2192        (Point::new(0, 0)..Point::new(2, 0), &[id_1]),
2193        (Point::new(2, 0)..Point::new(2, 0), &[id_1]),
2194        (Point::new(3, 0)..Point::new(3, 0), &[id_1]),
2195        (Point::new(8, 0)..Point::new(9, 0), &[id_1]),
2196        (Point::new(8, 0)..Point::new(10, 0), &[id_1, id_2]),
2197        (Point::new(9, 0)..Point::new(9, 0), &[id_2]),
2198    ];
2199    for (range, buffer_ids) in buffer_ids_by_range {
2200        assert_eq!(
2201            snapshot
2202                .buffer_ids_for_range(range.clone())
2203                .collect::<Vec<_>>(),
2204            buffer_ids,
2205            "buffer_ids_for_range({range:?}"
2206        );
2207    }
2208
2209    assert_position_translation(&snapshot);
2210    assert_line_indents(&snapshot);
2211
2212    assert_eq!(
2213        snapshot
2214            .diff_hunks_in_range(MultiBufferOffset(0)..snapshot.len())
2215            .map(|hunk| hunk.row_range.start.0..hunk.row_range.end.0)
2216            .collect::<Vec<_>>(),
2217        &[0..1, 2..4, 5..7, 9..10, 12..13, 14..17]
2218    );
2219
2220    buffer_2.update(cx, |buffer, cx| {
2221        buffer.edit_via_marked_text(
2222            indoc!(
2223                "
2224                  eight
2225                «»eleven
2226                THIRTEEN
2227                FOURTEEN
2228                "
2229            ),
2230            None,
2231            cx,
2232        );
2233    });
2234
2235    assert_new_snapshot(
2236        &multibuffer,
2237        &mut snapshot,
2238        &mut subscription,
2239        cx,
2240        indoc!(
2241            "
2242            + ZERO
2243              one
2244            - two
2245            + TWO
2246                  three
2247            - four
2248            - five
2249              six
2250
2251            - seven
2252                eight
2253              eleven
2254            - twelve
2255            + THIRTEEN
2256            + FOURTEEN
2257            "
2258        ),
2259    );
2260
2261    assert_line_indents(&snapshot);
2262}
2263
2264/// A naive implementation of a multi-buffer that does not maintain
2265/// any derived state, used for comparison in a randomized test.
2266#[derive(Default)]
2267struct ReferenceMultibuffer {
2268    excerpts: Vec<ReferenceExcerpt>,
2269    diffs: HashMap<BufferId, Entity<BufferDiff>>,
2270    inverted_diffs: HashMap<BufferId, (Entity<BufferDiff>, Entity<language::Buffer>)>,
2271    expanded_diff_hunks_by_buffer: HashMap<BufferId, Vec<text::Anchor>>,
2272}
2273
2274#[derive(Debug)]
2275struct ReferenceExcerpt {
2276    path_key: PathKey,
2277    path_key_index: PathKeyIndex,
2278    buffer: Entity<Buffer>,
2279    range: Range<text::Anchor>,
2280}
2281
2282#[derive(Clone, Debug)]
2283struct ReferenceRegion {
2284    buffer_id: Option<BufferId>,
2285    range: Range<usize>,
2286    buffer_range: Option<Range<Point>>,
2287    status: Option<DiffHunkStatus>,
2288    excerpt_info: Option<ExcerptInfo>,
2289}
2290
2291impl ReferenceExcerpt {
2292    fn info(&self, cx: &App) -> ExcerptInfo {
2293        ExcerptInfo {
2294            path_key_index: self.path_key_index,
2295            buffer_id: self.buffer.read(cx).remote_id(),
2296            range: self.range.clone(),
2297        }
2298    }
2299}
2300
2301impl ReferenceMultibuffer {
2302    fn expand_excerpts(&mut self, excerpts: &HashSet<ExcerptInfo>, line_count: u32, cx: &App) {
2303        if line_count == 0 {
2304            return;
2305        }
2306
2307        for info in excerpts {
2308            let excerpt = self
2309                .excerpts
2310                .iter_mut()
2311                .find(|e| &e.info(cx) == info)
2312                .unwrap();
2313            let snapshot = excerpt.buffer.read(cx).snapshot();
2314            let mut point_range = excerpt.range.to_point(&snapshot);
2315            point_range.start = Point::new(point_range.start.row.saturating_sub(line_count), 0);
2316            point_range.end =
2317                snapshot.clip_point(Point::new(point_range.end.row + line_count, 0), Bias::Left);
2318            point_range.end.column = snapshot.line_len(point_range.end.row);
2319            excerpt.range =
2320                snapshot.anchor_before(point_range.start)..snapshot.anchor_after(point_range.end);
2321        }
2322    }
2323
2324    fn set_excerpts(
2325        &mut self,
2326        path_key: PathKey,
2327        path_key_index: PathKeyIndex,
2328        buffer: Entity<Buffer>,
2329        buffer_snapshot: &BufferSnapshot,
2330        ranges: Vec<ExcerptRange<Point>>,
2331    ) {
2332        self.excerpts.retain(|excerpt| {
2333            excerpt.path_key != path_key && excerpt.buffer.entity_id() != buffer.entity_id()
2334        });
2335
2336        let ranges = MultiBuffer::merge_excerpt_ranges(&ranges);
2337
2338        let (Ok(ix) | Err(ix)) = self
2339            .excerpts
2340            .binary_search_by(|probe| probe.path_key.cmp(&path_key));
2341        self.excerpts.splice(
2342            ix..ix,
2343            ranges.into_iter().map(|range| ReferenceExcerpt {
2344                path_key: path_key.clone(),
2345                path_key_index,
2346                buffer: buffer.clone(),
2347                range: buffer_snapshot.anchor_before(range.context.start)
2348                    ..buffer_snapshot.anchor_after(range.context.end),
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                            || &regions[region_ix - 1].excerpt_info != &region.excerpt_info
2621                            || regions[region_ix - 1].range.is_empty();
2622                        let mut is_excerpt_end = region_ix == regions.len() - 1
2623                            || &regions[region_ix + 1].excerpt_info != &region.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,
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.start.to_point(buf);
2791            let end = info.range.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]
2819async fn test_remove_last_excerpt(cx: &mut TestAppContext) {
2820    let buffer = cx.new(|cx| {
2821        Buffer::local(
2822            indoc! {"
2823    aaa
2824    bbb
2825    ccc
2826    ddd
2827    eee
2828    fff
2829    ggg
2830    hhh
2831    "},
2832            cx,
2833        )
2834    });
2835    let buffer_snapshot = buffer.read_with(cx, |buffer, _| buffer.snapshot());
2836
2837    let multibuffer = cx.new(|cx| {
2838        let mut multibuffer = MultiBuffer::new(Capability::ReadWrite);
2839        multibuffer.set_excerpt_ranges_for_path(
2840            PathKey::sorted(0),
2841            buffer.clone(),
2842            &buffer_snapshot,
2843            vec![
2844                ExcerptRange::new(Point::zero()..Point::new(3, 0)),
2845                ExcerptRange::new(Point::new(5, 0)..Point::new(7, 0)),
2846            ],
2847            cx,
2848        );
2849        multibuffer
2850    });
2851
2852    multibuffer.read_with(cx, |multibuffer, cx| {
2853        let snapshot = multibuffer.snapshot(cx);
2854
2855        let actual_boundary_rows = snapshot
2856            .excerpt_boundaries_in_range(MultiBufferOffset(0)..)
2857            .map(|b| b.row)
2858            .collect::<HashSet<_>>();
2859        let actual_row_infos = snapshot.row_infos(MultiBufferRow(0)).collect::<Vec<_>>();
2860        let text = snapshot.text();
2861        eprintln!(
2862            "{}",
2863            format_diff(&text, &actual_row_infos, &actual_boundary_rows, Some(false))
2864        );
2865    });
2866
2867    multibuffer.update(cx, |multibuffer, cx| {
2868        multibuffer.set_excerpt_ranges_for_path(
2869            PathKey::sorted(0),
2870            buffer,
2871            &buffer_snapshot,
2872            vec![ExcerptRange::new(Point::zero()..Point::new(3, 0))],
2873            cx,
2874        );
2875    });
2876
2877    multibuffer.read_with(cx, |multibuffer, cx| {
2878        let snapshot = multibuffer.snapshot(cx);
2879        let actual_text = snapshot.text();
2880        let actual_boundary_rows = snapshot
2881            .excerpt_boundaries_in_range(MultiBufferOffset(0)..)
2882            .map(|b| b.row)
2883            .collect::<HashSet<_>>();
2884        let actual_row_infos = snapshot.row_infos(MultiBufferRow(0)).collect::<Vec<_>>();
2885        let text = snapshot.text();
2886
2887        eprintln!(
2888            "{}",
2889            format_diff(
2890                &actual_text,
2891                &actual_row_infos,
2892                &actual_boundary_rows,
2893                Some(false)
2894            )
2895        );
2896    });
2897}
2898
2899#[gpui::test(iterations = 100)]
2900async fn test_random_multibuffer(cx: &mut TestAppContext, mut rng: StdRng) {
2901    let operations = env::var("OPERATIONS")
2902        .map(|i| i.parse().expect("invalid `OPERATIONS` variable"))
2903        .unwrap_or(10);
2904    let multibuffer = cx.new(|_| MultiBuffer::new(Capability::ReadWrite));
2905    let mut buffers: Vec<Entity<Buffer>> = Vec::new();
2906    let mut base_texts: HashMap<BufferId, String> = HashMap::default();
2907    let mut reference = ReferenceMultibuffer::default();
2908    let mut anchors = Vec::new();
2909    let mut old_versions = Vec::new();
2910    let mut needs_diff_calculation = false;
2911    let mut inverted_diff_main_buffers: HashMap<BufferId, Entity<BufferDiff>> = HashMap::default();
2912    for _ in 0..operations {
2913        match rng.random_range(0..100) {
2914            0..=14 if !buffers.is_empty() => {
2915                let buffer = buffers.choose(&mut rng).unwrap();
2916                buffer.update(cx, |buf, cx| {
2917                    let edit_count = rng.random_range(1..5);
2918                    buf.randomly_edit(&mut rng, edit_count, cx);
2919                    log::info!("buffer text:\n{}", buf.text());
2920                    needs_diff_calculation = true;
2921                });
2922                cx.update(|cx| reference.diffs_updated(cx));
2923            }
2924            15..=24 if !reference.excerpts.is_empty() => {
2925                multibuffer.update(cx, |multibuffer, cx| {
2926                    let snapshot = multibuffer.snapshot(cx);
2927                    let infos = snapshot
2928                        .excerpts()
2929                        .map(|(_, info)| info)
2930                        .collect::<Vec<_>>();
2931                    let mut excerpts = HashSet::default();
2932                    for _ in 0..rng.random_range(0..infos.len()) {
2933                        excerpts.extend(infos.choose(&mut rng).cloned());
2934                    }
2935
2936                    let line_count = rng.random_range(0..5);
2937
2938                    let excerpt_ixs = excerpts
2939                        .iter()
2940                        .map(|info| {
2941                            reference
2942                                .excerpts
2943                                .iter()
2944                                .position(|e| e.info(cx) == *info)
2945                                .unwrap()
2946                        })
2947                        .collect::<Vec<_>>();
2948                    log::info!("Expanding excerpts {excerpt_ixs:?} by {line_count} lines");
2949                    multibuffer.expand_excerpts(
2950                        excerpts
2951                            .iter()
2952                            .map(|info| Anchor::in_buffer(info.path_key_index, info.range.end)),
2953                        line_count,
2954                        ExpandExcerptDirection::UpAndDown,
2955                        cx,
2956                    );
2957
2958                    reference.expand_excerpts(&excerpts, line_count, cx);
2959                });
2960            }
2961            25..=34 if !reference.excerpts.is_empty() => {
2962                let multibuffer =
2963                    multibuffer.read_with(cx, |multibuffer, cx| multibuffer.snapshot(cx));
2964                let offset = multibuffer.clip_offset(
2965                    MultiBufferOffset(rng.random_range(0..=multibuffer.len().0)),
2966                    Bias::Left,
2967                );
2968                let bias = if rng.random() {
2969                    Bias::Left
2970                } else {
2971                    Bias::Right
2972                };
2973                log::info!("Creating anchor at {} with bias {:?}", offset.0, bias);
2974                anchors.push(multibuffer.anchor_at(offset, bias));
2975                anchors.sort_by(|a, b| a.cmp(b, &multibuffer));
2976            }
2977            35..=45 if !reference.excerpts.is_empty() => {
2978                multibuffer.update(cx, |multibuffer, cx| {
2979                    let snapshot = multibuffer.snapshot(cx);
2980                    let excerpt_ix = rng.random_range(0..reference.excerpts.len());
2981                    let excerpt = &reference.excerpts[excerpt_ix];
2982
2983                    // Skip inverted excerpts - hunks can't be collapsed
2984                    let buffer_id = excerpt.buffer.read(cx).remote_id();
2985                    if reference.inverted_diffs.contains_key(&buffer_id) {
2986                        return;
2987                    }
2988
2989                    let start = excerpt.range.start;
2990                    let end = excerpt.range.end;
2991                    let range = snapshot.anchor_in_buffer(excerpt.info(cx).buffer_id, start).unwrap()
2992                        ..snapshot.anchor_in_buffer(excerpt.info(cx).buffer_id, end).unwrap();
2993
2994                    log::info!(
2995                        "expanding diff hunks in range {:?} (excerpt index {excerpt_ix:?}, buffer id {:?})",
2996                        range.to_offset(&snapshot),
2997                        buffer_id,
2998                    );
2999                    reference.expand_diff_hunks(excerpt.path_key.clone(), start..end, cx);
3000                    multibuffer.expand_diff_hunks(vec![range], cx);
3001                });
3002            }
3003            46..=75 if needs_diff_calculation => {
3004                multibuffer.update(cx, |multibuffer, cx| {
3005                    for buffer in multibuffer.all_buffers() {
3006                        let snapshot = buffer.read(cx).snapshot();
3007                        let buffer_id = snapshot.remote_id();
3008
3009                        if let Some(diff) = multibuffer.diff_for(buffer_id) {
3010                            diff.update(cx, |diff, cx| {
3011                                log::info!("recalculating diff for buffer {:?}", buffer_id,);
3012                                diff.recalculate_diff_sync(&snapshot.text, cx);
3013                            });
3014                        }
3015
3016                        if let Some(inverted_diff) = inverted_diff_main_buffers.get(&buffer_id) {
3017                            inverted_diff.update(cx, |diff, cx| {
3018                                log::info!(
3019                                    "recalculating inverted diff for main buffer {:?}",
3020                                    buffer_id,
3021                                );
3022                                diff.recalculate_diff_sync(&snapshot.text, cx);
3023                            });
3024                        }
3025                    }
3026                    reference.diffs_updated(cx);
3027                    needs_diff_calculation = false;
3028                });
3029            }
3030            _ => {
3031                // Decide if we're creating a new buffer or reusing an existing one
3032                let create_new_buffer = buffers.is_empty() || rng.random_bool(0.4);
3033
3034                let (excerpt_buffer, diff, inverted_main_buffer) = if create_new_buffer {
3035                    let create_inverted = rng.random_bool(0.3);
3036
3037                    if create_inverted {
3038                        let mut main_buffer_text = util::RandomCharIter::new(&mut rng)
3039                            .take(256)
3040                            .collect::<String>();
3041                        let main_buffer = cx.new(|cx| Buffer::local(main_buffer_text.clone(), cx));
3042                        text::LineEnding::normalize(&mut main_buffer_text);
3043                        let main_buffer_id =
3044                            main_buffer.read_with(cx, |buffer, _| buffer.remote_id());
3045                        base_texts.insert(main_buffer_id, main_buffer_text.clone());
3046                        buffers.push(main_buffer.clone());
3047
3048                        let diff = cx.new(|cx| {
3049                            BufferDiff::new_with_base_text(
3050                                &main_buffer_text,
3051                                &main_buffer.read(cx).text_snapshot(),
3052                                cx,
3053                            )
3054                        });
3055
3056                        let base_text_buffer =
3057                            diff.read_with(cx, |diff, _| diff.base_text_buffer().clone());
3058
3059                        // Track for recalculation when main buffer is edited
3060                        inverted_diff_main_buffers.insert(main_buffer_id, diff.clone());
3061
3062                        (base_text_buffer, diff, Some(main_buffer))
3063                    } else {
3064                        let mut base_text = util::RandomCharIter::new(&mut rng)
3065                            .take(256)
3066                            .collect::<String>();
3067
3068                        let buffer_handle = cx.new(|cx| Buffer::local(base_text.clone(), cx));
3069                        text::LineEnding::normalize(&mut base_text);
3070                        let buffer_id = buffer_handle.read_with(cx, |buffer, _| buffer.remote_id());
3071                        base_texts.insert(buffer_id, base_text.clone());
3072                        buffers.push(buffer_handle.clone());
3073
3074                        let diff = cx.new(|cx| {
3075                            BufferDiff::new_with_base_text(
3076                                &base_text,
3077                                &buffer_handle.read(cx).text_snapshot(),
3078                                cx,
3079                            )
3080                        });
3081
3082                        (buffer_handle, diff, None)
3083                    }
3084                } else {
3085                    // Reuse an existing buffer
3086                    let buffer_handle = buffers.choose(&mut rng).unwrap().clone();
3087                    let buffer_id = buffer_handle.read_with(cx, |buffer, _| buffer.remote_id());
3088
3089                    if let Some(diff) = inverted_diff_main_buffers.get(&buffer_id) {
3090                        let base_text_buffer =
3091                            diff.read_with(cx, |diff, _| diff.base_text_buffer().clone());
3092                        (base_text_buffer, diff.clone(), Some(buffer_handle))
3093                    } else {
3094                        // Get existing diff or create new one for regular buffer
3095                        let diff = multibuffer
3096                            .read_with(cx, |mb, _| mb.diff_for(buffer_id))
3097                            .unwrap_or_else(|| {
3098                                let base_text = base_texts.get(&buffer_id).unwrap();
3099                                cx.new(|cx| {
3100                                    BufferDiff::new_with_base_text(
3101                                        base_text,
3102                                        &buffer_handle.read(cx).text_snapshot(),
3103                                        cx,
3104                                    )
3105                                })
3106                            });
3107                        (buffer_handle, diff, None)
3108                    }
3109                };
3110
3111                let excerpt_buffer_snapshot =
3112                    excerpt_buffer.read_with(cx, |excerpt_buffer, _| excerpt_buffer.snapshot());
3113                let mut ranges = reference
3114                    .excerpts
3115                    .iter()
3116                    .filter(|excerpt| excerpt.buffer == excerpt_buffer)
3117                    .map(|excerpt| excerpt.range.to_point(&excerpt_buffer_snapshot))
3118                    .collect::<Vec<_>>();
3119                mutate_excerpt_ranges(&mut rng, &mut ranges, &excerpt_buffer_snapshot, 1);
3120                let ranges = ranges
3121                    .iter()
3122                    .cloned()
3123                    .map(ExcerptRange::new)
3124                    .collect::<Vec<_>>();
3125                let path = cx.update(|cx| PathKey::for_buffer(&excerpt_buffer, cx));
3126
3127                let (_, path_key_index, _) = multibuffer.update(cx, |multibuffer, cx| {
3128                    multibuffer.set_excerpt_ranges_for_path(
3129                        path.clone(),
3130                        excerpt_buffer.clone(),
3131                        &excerpt_buffer_snapshot,
3132                        ranges.clone(),
3133                        cx,
3134                    )
3135                });
3136
3137                reference.set_excerpts(
3138                    path,
3139                    path_key_index,
3140                    excerpt_buffer.clone(),
3141                    &excerpt_buffer_snapshot,
3142                    ranges,
3143                );
3144
3145                let excerpt_buffer_id =
3146                    excerpt_buffer.read_with(cx, |buffer, _| buffer.remote_id());
3147                multibuffer.update(cx, |multibuffer, cx| {
3148                    if multibuffer.diff_for(excerpt_buffer_id).is_none() {
3149                        if let Some(main_buffer) = inverted_main_buffer {
3150                            reference.add_inverted_diff(diff.clone(), main_buffer.clone(), cx);
3151                            multibuffer.add_inverted_diff(diff, main_buffer, cx);
3152                        } else {
3153                            reference.add_diff(diff.clone(), cx);
3154                            multibuffer.add_diff(diff, cx);
3155                        }
3156                    }
3157                });
3158            }
3159        }
3160
3161        if rng.random_bool(0.3) {
3162            multibuffer.update(cx, |multibuffer, cx| {
3163                old_versions.push((multibuffer.snapshot(cx), multibuffer.subscribe()));
3164            })
3165        }
3166
3167        multibuffer.read_with(cx, |multibuffer, cx| {
3168            check_multibuffer(multibuffer, &reference, &anchors, cx, &mut rng);
3169        });
3170    }
3171    let snapshot = multibuffer.read_with(cx, |multibuffer, cx| multibuffer.snapshot(cx));
3172    for (old_snapshot, subscription) in old_versions {
3173        check_multibuffer_edits(&snapshot, &old_snapshot, subscription);
3174    }
3175}
3176
3177fn mutate_excerpt_ranges(
3178    rng: &mut StdRng,
3179    existing_ranges: &mut Vec<Range<Point>>,
3180    buffer: &BufferSnapshot,
3181    operations: u32,
3182) {
3183    let mut ranges_to_add = Vec::new();
3184
3185    for _ in 0..operations {
3186        // todo!() logging
3187        match rng.random_range(0..5) {
3188            0..=1 if !existing_ranges.is_empty() => {
3189                log::info!("Removing excerpt",);
3190                let index = rng.random_range(0..existing_ranges.len());
3191                existing_ranges.remove(index);
3192            }
3193            _ => {
3194                log::info!("Inserting excerpt",);
3195                let end_row = rng.random_range(0..=buffer.max_point().row);
3196                let start_row = rng.random_range(0..=end_row);
3197                ranges_to_add.push(Point::new(start_row, 0)..Point::new(end_row, 0));
3198            }
3199        }
3200    }
3201
3202    existing_ranges.extend(ranges_to_add);
3203    existing_ranges.sort_by(|l, r| l.start.cmp(&r.start));
3204}
3205
3206fn check_multibuffer(
3207    multibuffer: &MultiBuffer,
3208    reference: &ReferenceMultibuffer,
3209    anchors: &[Anchor],
3210    cx: &App,
3211    rng: &mut StdRng,
3212) {
3213    let snapshot = multibuffer.snapshot(cx);
3214    let actual_text = snapshot.text();
3215    let actual_boundary_rows = snapshot
3216        .excerpt_boundaries_in_range(MultiBufferOffset(0)..)
3217        .map(|b| b.row)
3218        .collect::<HashSet<_>>();
3219    let actual_row_infos = snapshot.row_infos(MultiBufferRow(0)).collect::<Vec<_>>();
3220
3221    let (expected_text, expected_row_infos, expected_boundary_rows) =
3222        reference.expected_content(cx);
3223
3224    let has_diff = actual_row_infos
3225        .iter()
3226        .any(|info| info.diff_status.is_some())
3227        || expected_row_infos
3228            .iter()
3229            .any(|info| info.diff_status.is_some());
3230    let actual_diff = format_diff(
3231        &actual_text,
3232        &actual_row_infos,
3233        &actual_boundary_rows,
3234        Some(has_diff),
3235    );
3236    let expected_diff = format_diff(
3237        &expected_text,
3238        &expected_row_infos,
3239        &expected_boundary_rows,
3240        Some(has_diff),
3241    );
3242
3243    log::info!("Multibuffer content:\n{}", actual_diff);
3244
3245    assert_eq!(
3246        actual_row_infos.len(),
3247        actual_text.split('\n').count(),
3248        "line count: {}",
3249        actual_text.split('\n').count()
3250    );
3251    pretty_assertions::assert_eq!(actual_diff, expected_diff);
3252    pretty_assertions::assert_eq!(actual_text, expected_text);
3253    pretty_assertions::assert_eq!(actual_row_infos, expected_row_infos);
3254
3255    for _ in 0..5 {
3256        let start_row = rng.random_range(0..=expected_row_infos.len());
3257        assert_eq!(
3258            snapshot
3259                .row_infos(MultiBufferRow(start_row as u32))
3260                .collect::<Vec<_>>(),
3261            &expected_row_infos[start_row..],
3262            "buffer_rows({})",
3263            start_row
3264        );
3265    }
3266
3267    assert_eq!(
3268        snapshot.widest_line_number(),
3269        expected_row_infos
3270            .into_iter()
3271            .filter_map(|info| {
3272                // For inverted diffs, deleted rows are visible and should be counted.
3273                // Only filter out deleted rows that are NOT from inverted diffs.
3274                let is_inverted_diff = info
3275                    .buffer_id
3276                    .is_some_and(|id| reference.inverted_diffs.contains_key(&id));
3277                if info.diff_status.is_some_and(|status| status.is_deleted()) && !is_inverted_diff {
3278                    None
3279                } else {
3280                    info.buffer_row
3281                }
3282            })
3283            .max()
3284            .unwrap()
3285            + 1
3286    );
3287    for i in 0..snapshot.len().0 {
3288        // todo!() this seems not useful
3289        let excerpt = snapshot
3290            .excerpt_containing(MultiBufferOffset(i)..MultiBufferOffset(i))
3291            .unwrap();
3292        let reference_range = reference
3293            .excerpts
3294            .iter()
3295            .find(|reference_excerpt| reference_excerpt.info(cx) == excerpt.excerpt.info())
3296            .map(|excerpt| excerpt.range.to_offset(&excerpt.buffer.read(cx).snapshot()))
3297            .expect("corresponding excerpt should exist in reference multibuffer");
3298        assert_eq!(
3299            excerpt.buffer_range(&snapshot).start.0..excerpt.buffer_range(&snapshot).end.0,
3300            reference_range
3301        );
3302    }
3303
3304    assert_consistent_line_numbers(&snapshot);
3305    assert_position_translation(&snapshot);
3306
3307    for (row, line) in expected_text.split('\n').enumerate() {
3308        assert_eq!(
3309            snapshot.line_len(MultiBufferRow(row as u32)),
3310            line.len() as u32,
3311            "line_len({}).",
3312            row
3313        );
3314    }
3315
3316    let text_rope = Rope::from(expected_text.as_str());
3317    for _ in 0..10 {
3318        let end_ix = text_rope.clip_offset(rng.random_range(0..=text_rope.len()), Bias::Right);
3319        let start_ix = text_rope.clip_offset(rng.random_range(0..=end_ix), Bias::Left);
3320
3321        let text_for_range = snapshot
3322            .text_for_range(MultiBufferOffset(start_ix)..MultiBufferOffset(end_ix))
3323            .collect::<String>();
3324        assert_eq!(
3325            text_for_range,
3326            &expected_text[start_ix..end_ix],
3327            "incorrect text for range {:?}",
3328            start_ix..end_ix
3329        );
3330
3331        let expected_summary =
3332            MBTextSummary::from(TextSummary::from(&expected_text[start_ix..end_ix]));
3333        assert_eq!(
3334            snapshot.text_summary_for_range::<MBTextSummary, _>(
3335                MultiBufferOffset(start_ix)..MultiBufferOffset(end_ix)
3336            ),
3337            expected_summary,
3338            "incorrect summary for range {:?}",
3339            start_ix..end_ix
3340        );
3341    }
3342
3343    // Anchor resolution
3344    let summaries = snapshot.summaries_for_anchors::<MultiBufferOffset, _>(anchors);
3345    assert_eq!(anchors.len(), summaries.len());
3346    for (anchor, resolved_offset) in anchors.iter().zip(summaries) {
3347        assert!(resolved_offset <= snapshot.len());
3348        assert_eq!(
3349            snapshot.summary_for_anchor::<MultiBufferOffset>(anchor),
3350            resolved_offset,
3351            "anchor: {:?}",
3352            anchor
3353        );
3354    }
3355
3356    for _ in 0..10 {
3357        let end_ix = text_rope.clip_offset(rng.random_range(0..=text_rope.len()), Bias::Right);
3358        assert_eq!(
3359            snapshot
3360                .reversed_chars_at(MultiBufferOffset(end_ix))
3361                .collect::<String>(),
3362            expected_text[..end_ix].chars().rev().collect::<String>(),
3363        );
3364    }
3365
3366    for _ in 0..10 {
3367        let end_ix = rng.random_range(0..=text_rope.len());
3368        let end_ix = text_rope.floor_char_boundary(end_ix);
3369        let start_ix = rng.random_range(0..=end_ix);
3370        let start_ix = text_rope.floor_char_boundary(start_ix);
3371        assert_eq!(
3372            snapshot
3373                .bytes_in_range(MultiBufferOffset(start_ix)..MultiBufferOffset(end_ix))
3374                .flatten()
3375                .copied()
3376                .collect::<Vec<_>>(),
3377            expected_text.as_bytes()[start_ix..end_ix].to_vec(),
3378            "bytes_in_range({:?})",
3379            start_ix..end_ix,
3380        );
3381    }
3382}
3383
3384fn check_multibuffer_edits(
3385    snapshot: &MultiBufferSnapshot,
3386    old_snapshot: &MultiBufferSnapshot,
3387    subscription: Subscription<MultiBufferOffset>,
3388) {
3389    let edits = subscription.consume().into_inner();
3390
3391    log::info!(
3392        "applying subscription edits to old text: {:?}: {:#?}",
3393        old_snapshot.text(),
3394        edits,
3395    );
3396
3397    let mut text = old_snapshot.text();
3398    for edit in edits {
3399        let new_text: String = snapshot
3400            .text_for_range(edit.new.start..edit.new.end)
3401            .collect();
3402        text.replace_range(
3403            (edit.new.start.0..edit.new.start.0 + (edit.old.end.0 - edit.old.start.0)).clone(),
3404            &new_text,
3405        );
3406        pretty_assertions::assert_eq!(
3407            &text[0..edit.new.end.0],
3408            snapshot
3409                .text_for_range(MultiBufferOffset(0)..edit.new.end)
3410                .collect::<String>()
3411        );
3412    }
3413    pretty_assertions::assert_eq!(text, snapshot.text());
3414}
3415
3416#[gpui::test]
3417fn test_history(cx: &mut App) {
3418    let test_settings = SettingsStore::test(cx);
3419    cx.set_global(test_settings);
3420
3421    let group_interval: Duration = Duration::from_millis(1);
3422    let buffer_1 = cx.new(|cx| {
3423        let mut buf = Buffer::local("1234", cx);
3424        buf.set_group_interval(group_interval);
3425        buf
3426    });
3427    let buffer_2 = cx.new(|cx| {
3428        let mut buf = Buffer::local("5678", cx);
3429        buf.set_group_interval(group_interval);
3430        buf
3431    });
3432    let multibuffer = cx.new(|_| MultiBuffer::new(Capability::ReadWrite));
3433    multibuffer.update(cx, |this, _| {
3434        this.set_group_interval(group_interval);
3435    });
3436    multibuffer.update(cx, |multibuffer, cx| {
3437        multibuffer.set_excerpts_for_path(
3438            PathKey::sorted(0),
3439            buffer_1.clone(),
3440            [Point::zero()..buffer_1.read(cx).max_point()],
3441            0,
3442            cx,
3443        );
3444        multibuffer.set_excerpts_for_path(
3445            PathKey::sorted(1),
3446            buffer_2.clone(),
3447            [Point::zero()..buffer_2.read(cx).max_point()],
3448            0,
3449            cx,
3450        );
3451    });
3452
3453    let mut now = Instant::now();
3454
3455    multibuffer.update(cx, |multibuffer, cx| {
3456        let transaction_1 = multibuffer.start_transaction_at(now, cx).unwrap();
3457        multibuffer.edit(
3458            [
3459                (Point::new(0, 0)..Point::new(0, 0), "A"),
3460                (Point::new(1, 0)..Point::new(1, 0), "A"),
3461            ],
3462            None,
3463            cx,
3464        );
3465        multibuffer.edit(
3466            [
3467                (Point::new(0, 1)..Point::new(0, 1), "B"),
3468                (Point::new(1, 1)..Point::new(1, 1), "B"),
3469            ],
3470            None,
3471            cx,
3472        );
3473        multibuffer.end_transaction_at(now, cx);
3474        assert_eq!(multibuffer.read(cx).text(), "AB1234\nAB5678");
3475
3476        // Verify edited ranges for transaction 1
3477        assert_eq!(
3478            multibuffer.edited_ranges_for_transaction(transaction_1, cx),
3479            &[
3480                MultiBufferOffset(0)..MultiBufferOffset(2),
3481                MultiBufferOffset(7)..MultiBufferOffset(9),
3482            ]
3483        );
3484
3485        // Edit buffer 1 through the multibuffer
3486        now += 2 * group_interval;
3487        multibuffer.start_transaction_at(now, cx);
3488        multibuffer.edit(
3489            [(MultiBufferOffset(2)..MultiBufferOffset(2), "C")],
3490            None,
3491            cx,
3492        );
3493        multibuffer.end_transaction_at(now, cx);
3494        assert_eq!(multibuffer.read(cx).text(), "ABC1234\nAB5678");
3495
3496        // Edit buffer 1 independently
3497        buffer_1.update(cx, |buffer_1, cx| {
3498            buffer_1.start_transaction_at(now);
3499            buffer_1.edit([(3..3, "D")], None, cx);
3500            buffer_1.end_transaction_at(now, cx);
3501
3502            now += 2 * group_interval;
3503            buffer_1.start_transaction_at(now);
3504            buffer_1.edit([(4..4, "E")], None, cx);
3505            buffer_1.end_transaction_at(now, cx);
3506        });
3507        assert_eq!(multibuffer.read(cx).text(), "ABCDE1234\nAB5678");
3508
3509        // An undo in the multibuffer undoes the multibuffer transaction
3510        // and also any individual buffer edits that have occurred since
3511        // that transaction.
3512        multibuffer.undo(cx);
3513        assert_eq!(multibuffer.read(cx).text(), "AB1234\nAB5678");
3514
3515        multibuffer.undo(cx);
3516        assert_eq!(multibuffer.read(cx).text(), "1234\n5678");
3517
3518        multibuffer.redo(cx);
3519        assert_eq!(multibuffer.read(cx).text(), "AB1234\nAB5678");
3520
3521        multibuffer.redo(cx);
3522        assert_eq!(multibuffer.read(cx).text(), "ABCDE1234\nAB5678");
3523
3524        // Undo buffer 2 independently.
3525        buffer_2.update(cx, |buffer_2, cx| buffer_2.undo(cx));
3526        assert_eq!(multibuffer.read(cx).text(), "ABCDE1234\n5678");
3527
3528        // An undo in the multibuffer undoes the components of the
3529        // the last multibuffer transaction that are not already undone.
3530        multibuffer.undo(cx);
3531        assert_eq!(multibuffer.read(cx).text(), "AB1234\n5678");
3532
3533        multibuffer.undo(cx);
3534        assert_eq!(multibuffer.read(cx).text(), "1234\n5678");
3535
3536        multibuffer.redo(cx);
3537        assert_eq!(multibuffer.read(cx).text(), "AB1234\nAB5678");
3538
3539        buffer_1.update(cx, |buffer_1, cx| buffer_1.redo(cx));
3540        assert_eq!(multibuffer.read(cx).text(), "ABCD1234\nAB5678");
3541
3542        // Redo stack gets cleared after an edit.
3543        now += 2 * group_interval;
3544        multibuffer.start_transaction_at(now, cx);
3545        multibuffer.edit(
3546            [(MultiBufferOffset(0)..MultiBufferOffset(0), "X")],
3547            None,
3548            cx,
3549        );
3550        multibuffer.end_transaction_at(now, cx);
3551        assert_eq!(multibuffer.read(cx).text(), "XABCD1234\nAB5678");
3552        multibuffer.redo(cx);
3553        assert_eq!(multibuffer.read(cx).text(), "XABCD1234\nAB5678");
3554        multibuffer.undo(cx);
3555        assert_eq!(multibuffer.read(cx).text(), "ABCD1234\nAB5678");
3556        multibuffer.undo(cx);
3557        assert_eq!(multibuffer.read(cx).text(), "1234\n5678");
3558
3559        // Transactions can be grouped manually.
3560        multibuffer.redo(cx);
3561        multibuffer.redo(cx);
3562        assert_eq!(multibuffer.read(cx).text(), "XABCD1234\nAB5678");
3563        multibuffer.group_until_transaction(transaction_1, cx);
3564        multibuffer.undo(cx);
3565        assert_eq!(multibuffer.read(cx).text(), "1234\n5678");
3566        multibuffer.redo(cx);
3567        assert_eq!(multibuffer.read(cx).text(), "XABCD1234\nAB5678");
3568    });
3569}
3570
3571#[gpui::test]
3572async fn test_enclosing_indent(cx: &mut TestAppContext) {
3573    async fn enclosing_indent(
3574        text: &str,
3575        buffer_row: u32,
3576        cx: &mut TestAppContext,
3577    ) -> Option<(Range<u32>, LineIndent)> {
3578        let buffer = cx.update(|cx| MultiBuffer::build_simple(text, cx));
3579        let snapshot = cx.read(|cx| buffer.read(cx).snapshot(cx));
3580        let (range, indent) = snapshot
3581            .enclosing_indent(MultiBufferRow(buffer_row))
3582            .await?;
3583        Some((range.start.0..range.end.0, indent))
3584    }
3585
3586    assert_eq!(
3587        enclosing_indent(
3588            indoc!(
3589                "
3590                fn b() {
3591                    if c {
3592                        let d = 2;
3593                    }
3594                }
3595                "
3596            ),
3597            1,
3598            cx,
3599        )
3600        .await,
3601        Some((
3602            1..2,
3603            LineIndent {
3604                tabs: 0,
3605                spaces: 4,
3606                line_blank: false,
3607            }
3608        ))
3609    );
3610
3611    assert_eq!(
3612        enclosing_indent(
3613            indoc!(
3614                "
3615                fn b() {
3616                    if c {
3617                        let d = 2;
3618                    }
3619                }
3620                "
3621            ),
3622            2,
3623            cx,
3624        )
3625        .await,
3626        Some((
3627            1..2,
3628            LineIndent {
3629                tabs: 0,
3630                spaces: 4,
3631                line_blank: false,
3632            }
3633        ))
3634    );
3635
3636    assert_eq!(
3637        enclosing_indent(
3638            indoc!(
3639                "
3640                fn b() {
3641                    if c {
3642                        let d = 2;
3643
3644                        let e = 5;
3645                    }
3646                }
3647                "
3648            ),
3649            3,
3650            cx,
3651        )
3652        .await,
3653        Some((
3654            1..4,
3655            LineIndent {
3656                tabs: 0,
3657                spaces: 4,
3658                line_blank: false,
3659            }
3660        ))
3661    );
3662}
3663
3664#[gpui::test]
3665async fn test_summaries_for_anchors(cx: &mut TestAppContext) {
3666    let base_text_1 = indoc!(
3667        "
3668        bar
3669        "
3670    );
3671    let text_1 = indoc!(
3672        "
3673        BAR
3674        "
3675    );
3676    let base_text_2 = indoc!(
3677        "
3678        foo
3679        "
3680    );
3681    let text_2 = indoc!(
3682        "
3683        FOO
3684        "
3685    );
3686
3687    let buffer_1 = cx.new(|cx| Buffer::local(text_1, cx));
3688    let buffer_2 = cx.new(|cx| Buffer::local(text_2, cx));
3689    let diff_1 = cx.new(|cx| {
3690        BufferDiff::new_with_base_text(base_text_1, &buffer_1.read(cx).text_snapshot(), cx)
3691    });
3692    let diff_2 = cx.new(|cx| {
3693        BufferDiff::new_with_base_text(base_text_2, &buffer_2.read(cx).text_snapshot(), cx)
3694    });
3695    cx.run_until_parked();
3696
3697    let multibuffer = cx.new(|cx| {
3698        let mut multibuffer = MultiBuffer::new(Capability::ReadWrite);
3699        multibuffer.set_all_diff_hunks_expanded(cx);
3700        multibuffer.set_excerpts_for_path(
3701            PathKey::sorted(0),
3702            buffer_1.clone(),
3703            [Point::zero()..buffer_1.read(cx).max_point()],
3704            0,
3705            cx,
3706        );
3707        multibuffer.set_excerpts_for_path(
3708            PathKey::sorted(1),
3709            buffer_2.clone(),
3710            [Point::zero()..buffer_2.read(cx).max_point()],
3711            0,
3712            cx,
3713        );
3714        multibuffer.add_diff(diff_1.clone(), cx);
3715        multibuffer.add_diff(diff_2.clone(), cx);
3716        multibuffer
3717    });
3718
3719    let (mut snapshot, mut subscription) = multibuffer.update(cx, |multibuffer, cx| {
3720        (multibuffer.snapshot(cx), multibuffer.subscribe())
3721    });
3722
3723    assert_new_snapshot(
3724        &multibuffer,
3725        &mut snapshot,
3726        &mut subscription,
3727        cx,
3728        indoc!(
3729            "
3730            - bar
3731            + BAR
3732
3733            - foo
3734            + FOO
3735            "
3736        ),
3737    );
3738
3739    let anchor_1 = multibuffer.read_with(cx, |multibuffer, cx| {
3740        multibuffer
3741            .buffer_anchor_to_anchor(
3742                &buffer_1,
3743                text::Anchor::min_for_buffer(buffer_1.read(cx).remote_id()),
3744                cx,
3745            )
3746            .unwrap()
3747    });
3748    let point_1 = snapshot.summaries_for_anchors::<Point, _>([&anchor_1])[0];
3749    assert_eq!(point_1, Point::new(0, 0));
3750
3751    let anchor_2 = multibuffer.read_with(cx, |multibuffer, cx| {
3752        multibuffer
3753            .buffer_anchor_to_anchor(
3754                &buffer_2,
3755                text::Anchor::min_for_buffer(buffer_2.read(cx).remote_id()),
3756                cx,
3757            )
3758            .unwrap()
3759    });
3760    let point_2 = snapshot.summaries_for_anchors::<Point, _>([&anchor_2])[0];
3761    assert_eq!(point_2, Point::new(3, 0));
3762}
3763
3764#[gpui::test]
3765async fn test_trailing_deletion_without_newline(cx: &mut TestAppContext) {
3766    let base_text_1 = "one\ntwo".to_owned();
3767    let text_1 = "one\n".to_owned();
3768
3769    let buffer_1 = cx.new(|cx| Buffer::local(text_1, cx));
3770    let diff_1 = cx.new(|cx| {
3771        BufferDiff::new_with_base_text(&base_text_1, &buffer_1.read(cx).text_snapshot(), cx)
3772    });
3773    cx.run_until_parked();
3774
3775    let multibuffer = cx.new(|cx| {
3776        let mut multibuffer = MultiBuffer::new(Capability::ReadWrite);
3777        multibuffer.set_excerpts_for_path(
3778            PathKey::sorted(0),
3779            buffer_1.clone(),
3780            [Point::zero()..buffer_1.read(cx).max_point()],
3781            0,
3782            cx,
3783        );
3784        multibuffer.add_diff(diff_1.clone(), cx);
3785        multibuffer.expand_diff_hunks(vec![Anchor::min()..Anchor::max()], cx);
3786        multibuffer
3787    });
3788
3789    let (mut snapshot, mut subscription) = multibuffer.update(cx, |multibuffer, cx| {
3790        (multibuffer.snapshot(cx), multibuffer.subscribe())
3791    });
3792
3793    assert_new_snapshot(
3794        &multibuffer,
3795        &mut snapshot,
3796        &mut subscription,
3797        cx,
3798        indoc!(
3799            "
3800              one
3801            - two
3802            "
3803        ),
3804    );
3805
3806    assert_eq!(snapshot.max_point(), Point::new(2, 0));
3807    assert_eq!(snapshot.len().0, 8);
3808
3809    assert_eq!(
3810        snapshot
3811            .dimensions_from_points::<Point>([Point::new(2, 0)])
3812            .collect::<Vec<_>>(),
3813        vec![Point::new(2, 0)]
3814    );
3815
3816    let (_, translated_offset) = snapshot.point_to_buffer_offset(Point::new(2, 0)).unwrap();
3817    assert_eq!(translated_offset.0, "one\n".len());
3818    let (_, translated_point) = snapshot.point_to_buffer_point(Point::new(2, 0)).unwrap();
3819    assert_eq!(translated_point, Point::new(1, 0));
3820
3821    // The same, for an excerpt that's not at the end of the multibuffer.
3822
3823    let text_2 = "foo\n".to_owned();
3824    let buffer_2 = cx.new(|cx| Buffer::local(&text_2, cx));
3825    multibuffer.update(cx, |multibuffer, cx| {
3826        multibuffer.set_excerpt_ranges_for_path(
3827            PathKey::sorted(1),
3828            buffer_2.clone(),
3829            &buffer_2.read(cx).snapshot(),
3830            vec![ExcerptRange::new(Point::new(0, 0)..Point::new(1, 0))],
3831            cx,
3832        );
3833    });
3834
3835    assert_new_snapshot(
3836        &multibuffer,
3837        &mut snapshot,
3838        &mut subscription,
3839        cx,
3840        indoc!(
3841            "
3842              one
3843            - two
3844
3845              foo
3846            "
3847        ),
3848    );
3849
3850    assert_eq!(
3851        snapshot
3852            .dimensions_from_points::<Point>([Point::new(2, 0)])
3853            .collect::<Vec<_>>(),
3854        vec![Point::new(2, 0)]
3855    );
3856
3857    let buffer_1_id = buffer_1.read_with(cx, |buffer_1, _| buffer_1.remote_id());
3858    let (buffer, translated_offset) = snapshot.point_to_buffer_offset(Point::new(2, 0)).unwrap();
3859    assert_eq!(buffer.remote_id(), buffer_1_id);
3860    assert_eq!(translated_offset.0, "one\n".len());
3861    let (buffer, translated_point) = snapshot.point_to_buffer_point(Point::new(2, 0)).unwrap();
3862    assert_eq!(buffer.remote_id(), buffer_1_id);
3863    assert_eq!(translated_point, Point::new(1, 0));
3864}
3865
3866fn format_diff(
3867    text: &str,
3868    row_infos: &Vec<RowInfo>,
3869    boundary_rows: &HashSet<MultiBufferRow>,
3870    has_diff: Option<bool>,
3871) -> String {
3872    let has_diff =
3873        has_diff.unwrap_or_else(|| row_infos.iter().any(|info| info.diff_status.is_some()));
3874    text.split('\n')
3875        .enumerate()
3876        .zip(row_infos)
3877        .map(|((ix, line), info)| {
3878            let marker = match info.diff_status.map(|status| status.kind) {
3879                Some(DiffHunkStatusKind::Added) => "+ ",
3880                Some(DiffHunkStatusKind::Deleted) => "- ",
3881                Some(DiffHunkStatusKind::Modified) => unreachable!(),
3882                None => {
3883                    if has_diff && !line.is_empty() {
3884                        "  "
3885                    } else {
3886                        ""
3887                    }
3888                }
3889            };
3890            let boundary_row = if boundary_rows.contains(&MultiBufferRow(ix as u32)) {
3891                if has_diff {
3892                    "  ----------\n"
3893                } else {
3894                    "---------\n"
3895                }
3896            } else {
3897                ""
3898            };
3899            let expand = info
3900                .expand_info
3901                .as_ref()
3902                .map(|expand_info| match expand_info.direction {
3903                    ExpandExcerptDirection::Up => " [↑]",
3904                    ExpandExcerptDirection::Down => " [↓]",
3905                    ExpandExcerptDirection::UpAndDown => " [↕]",
3906                })
3907                .unwrap_or_default();
3908
3909            format!("{boundary_row}{marker}{line}{expand}")
3910            // let mbr = info
3911            //     .multibuffer_row
3912            //     .map(|row| format!("{:0>3}", row.0))
3913            //     .unwrap_or_else(|| "???".to_string());
3914            // let byte_range = format!("{byte_range_start:0>3}..{byte_range_end:0>3}");
3915            // format!("{boundary_row}Row: {mbr}, Bytes: {byte_range} | {marker}{line}{expand}")
3916        })
3917        .collect::<Vec<_>>()
3918        .join("\n")
3919}
3920
3921// fn format_transforms(snapshot: &MultiBufferSnapshot) -> String {
3922//     snapshot
3923//         .diff_transforms
3924//         .iter()
3925//         .map(|transform| {
3926//             let (kind, summary) = match transform {
3927//                 DiffTransform::DeletedHunk { summary, .. } => ("   Deleted", (*summary).into()),
3928//                 DiffTransform::FilteredInsertedHunk { summary, .. } => ("  Filtered", *summary),
3929//                 DiffTransform::InsertedHunk { summary, .. } => ("  Inserted", *summary),
3930//                 DiffTransform::Unmodified { summary, .. } => ("Unmodified", *summary),
3931//             };
3932//             format!("{kind}(len: {}, lines: {:?})", summary.len, summary.lines)
3933//         })
3934//         .join("\n")
3935// }
3936
3937// fn format_excerpts(snapshot: &MultiBufferSnapshot) -> String {
3938//     snapshot
3939//         .excerpts
3940//         .iter()
3941//         .map(|excerpt| {
3942//             format!(
3943//                 "Excerpt(buffer_range = {:?}, lines = {:?}, has_trailing_newline = {:?})",
3944//                 excerpt.range.context.to_point(&excerpt.buffer),
3945//                 excerpt.text_summary.lines,
3946//                 excerpt.has_trailing_newline
3947//             )
3948//         })
3949//         .join("\n")
3950// }
3951
3952#[gpui::test]
3953async fn test_singleton_with_inverted_diff(cx: &mut TestAppContext) {
3954    let text = indoc!(
3955        "
3956        ZERO
3957        one
3958        TWO
3959        three
3960        six
3961        "
3962    );
3963    let base_text = indoc!(
3964        "
3965        one
3966        two
3967        three
3968        four
3969        five
3970        six
3971        "
3972    );
3973
3974    let buffer = cx.new(|cx| Buffer::local(text, cx));
3975    let diff = cx
3976        .new(|cx| BufferDiff::new_with_base_text(base_text, &buffer.read(cx).text_snapshot(), cx));
3977    cx.run_until_parked();
3978
3979    let base_text_buffer = diff.read_with(cx, |diff, _| diff.base_text_buffer().clone());
3980
3981    let multibuffer = cx.new(|cx| {
3982        let mut multibuffer = MultiBuffer::singleton(base_text_buffer.clone(), cx);
3983        multibuffer.set_all_diff_hunks_expanded(cx);
3984        multibuffer.add_inverted_diff(diff.clone(), buffer.clone(), cx);
3985        multibuffer
3986    });
3987
3988    let (mut snapshot, mut subscription) = multibuffer.update(cx, |multibuffer, cx| {
3989        (multibuffer.snapshot(cx), multibuffer.subscribe())
3990    });
3991
3992    assert_eq!(snapshot.text(), base_text);
3993    assert_new_snapshot(
3994        &multibuffer,
3995        &mut snapshot,
3996        &mut subscription,
3997        cx,
3998        indoc!(
3999            "
4000              one
4001            - two
4002              three
4003            - four
4004            - five
4005              six
4006            "
4007        ),
4008    );
4009
4010    buffer.update(cx, |buffer, cx| {
4011        buffer.edit_via_marked_text(
4012            indoc!(
4013                "
4014                ZERO
4015                one
4016                «<inserted>»W«O
4017                T»hree
4018                six
4019                "
4020            ),
4021            None,
4022            cx,
4023        );
4024    });
4025    cx.run_until_parked();
4026    let update = diff
4027        .update(cx, |diff, cx| {
4028            diff.update_diff(
4029                buffer.read(cx).text_snapshot(),
4030                Some(base_text.into()),
4031                None,
4032                None,
4033                cx,
4034            )
4035        })
4036        .await;
4037    diff.update(cx, |diff, cx| {
4038        diff.set_snapshot(update, &buffer.read(cx).text_snapshot(), cx)
4039    })
4040    .await;
4041    cx.run_until_parked();
4042
4043    assert_new_snapshot(
4044        &multibuffer,
4045        &mut snapshot,
4046        &mut subscription,
4047        cx,
4048        indoc! {
4049            "
4050              one
4051            - two
4052            - three
4053            - four
4054            - five
4055              six
4056            "
4057        },
4058    );
4059
4060    buffer.update(cx, |buffer, cx| {
4061        buffer.set_text("ZERO\nONE\nTWO\n", cx);
4062    });
4063    cx.run_until_parked();
4064    let update = diff
4065        .update(cx, |diff, cx| {
4066            diff.update_diff(
4067                buffer.read(cx).text_snapshot(),
4068                Some(base_text.into()),
4069                None,
4070                None,
4071                cx,
4072            )
4073        })
4074        .await;
4075    diff.update(cx, |diff, cx| {
4076        diff.set_snapshot(update, &buffer.read(cx).text_snapshot(), cx)
4077    })
4078    .await;
4079    cx.run_until_parked();
4080
4081    assert_new_snapshot(
4082        &multibuffer,
4083        &mut snapshot,
4084        &mut subscription,
4085        cx,
4086        indoc! {
4087            "
4088            - one
4089            - two
4090            - three
4091            - four
4092            - five
4093            - six
4094            "
4095        },
4096    );
4097
4098    diff.update(cx, |diff, cx| {
4099        diff.set_base_text(
4100            Some("new base\n".into()),
4101            None,
4102            buffer.read(cx).text_snapshot(),
4103            cx,
4104        )
4105    })
4106    .await
4107    .unwrap();
4108    cx.run_until_parked();
4109
4110    assert_new_snapshot(
4111        &multibuffer,
4112        &mut snapshot,
4113        &mut subscription,
4114        cx,
4115        indoc! {"
4116            - new base
4117        "},
4118    );
4119}
4120
4121#[gpui::test]
4122async fn test_inverted_diff_base_text_change(cx: &mut TestAppContext) {
4123    let base_text = "aaa\nbbb\nccc\n";
4124    let text = "ddd\n";
4125    let buffer = cx.new(|cx| Buffer::local(text, cx));
4126    let diff = cx
4127        .new(|cx| BufferDiff::new_with_base_text(base_text, &buffer.read(cx).text_snapshot(), cx));
4128    cx.run_until_parked();
4129
4130    let base_text_buffer = diff.read_with(cx, |diff, _| diff.base_text_buffer().clone());
4131
4132    let multibuffer = cx.new(|cx| {
4133        let mut multibuffer = MultiBuffer::singleton(base_text_buffer.clone(), cx);
4134        multibuffer.set_all_diff_hunks_expanded(cx);
4135        multibuffer.add_inverted_diff(diff.clone(), buffer.clone(), cx);
4136        multibuffer
4137    });
4138
4139    let (mut snapshot, mut subscription) = multibuffer.update(cx, |multibuffer, cx| {
4140        (multibuffer.snapshot(cx), multibuffer.subscribe())
4141    });
4142
4143    assert_eq!(snapshot.text(), base_text);
4144    assert_new_snapshot(
4145        &multibuffer,
4146        &mut snapshot,
4147        &mut subscription,
4148        cx,
4149        indoc!(
4150            "
4151            - aaa
4152            - bbb
4153            - ccc
4154            "
4155        ),
4156    );
4157
4158    let update = diff
4159        .update(cx, |diff, cx| {
4160            diff.update_diff(
4161                buffer.read(cx).text_snapshot(),
4162                Some("ddd\n".into()),
4163                Some(true),
4164                None,
4165                cx,
4166            )
4167        })
4168        .await;
4169    diff.update(cx, |diff, cx| {
4170        diff.set_snapshot(update, &buffer.read(cx).text_snapshot(), cx)
4171    })
4172    .detach();
4173
4174    let _hunks: Vec<_> = multibuffer
4175        .read_with(cx, |multibuffer, cx| multibuffer.snapshot(cx))
4176        .diff_hunks()
4177        .collect();
4178}
4179
4180#[gpui::test]
4181async fn test_inverted_diff_secondary_version_mismatch(cx: &mut TestAppContext) {
4182    let base_text = "one\ntwo\nthree\nfour\nfive\n";
4183    let index_text = "one\nTWO\nthree\nfour\nfive\n";
4184    let buffer_text = "one\nTWO\nthree\nFOUR\nfive\n";
4185
4186    let buffer = cx.new(|cx| Buffer::local(buffer_text, cx));
4187
4188    let unstaged_diff = cx
4189        .new(|cx| BufferDiff::new_with_base_text(index_text, &buffer.read(cx).text_snapshot(), cx));
4190    cx.run_until_parked();
4191
4192    let uncommitted_diff = cx.new(|cx| {
4193        let mut diff =
4194            BufferDiff::new_with_base_text(base_text, &buffer.read(cx).text_snapshot(), cx);
4195        diff.set_secondary_diff(unstaged_diff.clone());
4196        diff
4197    });
4198    cx.run_until_parked();
4199
4200    buffer.update(cx, |buffer, cx| {
4201        buffer.edit([(0..0, "ZERO\n")], None, cx);
4202    });
4203
4204    let update = unstaged_diff
4205        .update(cx, |diff, cx| {
4206            diff.update_diff(
4207                buffer.read(cx).text_snapshot(),
4208                Some(index_text.into()),
4209                None,
4210                None,
4211                cx,
4212            )
4213        })
4214        .await;
4215    unstaged_diff
4216        .update(cx, |diff, cx| {
4217            diff.set_snapshot(update, &buffer.read(cx).text_snapshot(), cx)
4218        })
4219        .await;
4220
4221    let base_text_buffer =
4222        uncommitted_diff.read_with(cx, |diff, _| diff.base_text_buffer().clone());
4223
4224    let multibuffer = cx.new(|cx| {
4225        let mut multibuffer = MultiBuffer::singleton(base_text_buffer.clone(), cx);
4226        multibuffer.set_all_diff_hunks_expanded(cx);
4227        multibuffer.add_inverted_diff(uncommitted_diff.clone(), buffer.clone(), cx);
4228        multibuffer
4229    });
4230
4231    let _hunks: Vec<_> = multibuffer
4232        .read_with(cx, |multibuffer, cx| multibuffer.snapshot(cx))
4233        .diff_hunks()
4234        .collect();
4235}
4236
4237#[track_caller]
4238fn assert_excerpts_match(
4239    multibuffer: &Entity<MultiBuffer>,
4240    cx: &mut TestAppContext,
4241    expected: &str,
4242) {
4243    let mut output = String::new();
4244    multibuffer.read_with(cx, |multibuffer, cx| {
4245        for (buffer, info) in multibuffer.snapshot(cx).excerpts() {
4246            output.push_str("-----\n");
4247            output.extend(buffer.text_for_range(info.range));
4248            if !output.ends_with('\n') {
4249                output.push('\n');
4250            }
4251        }
4252    });
4253    assert_eq!(output, expected);
4254}
4255
4256#[track_caller]
4257fn assert_new_snapshot(
4258    multibuffer: &Entity<MultiBuffer>,
4259    snapshot: &mut MultiBufferSnapshot,
4260    subscription: &mut Subscription<MultiBufferOffset>,
4261    cx: &mut TestAppContext,
4262    expected_diff: &str,
4263) {
4264    let new_snapshot = multibuffer.read_with(cx, |multibuffer, cx| multibuffer.snapshot(cx));
4265    let actual_text = new_snapshot.text();
4266    let line_infos = new_snapshot
4267        .row_infos(MultiBufferRow(0))
4268        .collect::<Vec<_>>();
4269    let actual_diff = format_diff(&actual_text, &line_infos, &Default::default(), None);
4270    pretty_assertions::assert_eq!(actual_diff, expected_diff);
4271    check_edits(
4272        snapshot,
4273        &new_snapshot,
4274        &subscription.consume().into_inner(),
4275    );
4276    *snapshot = new_snapshot;
4277}
4278
4279#[track_caller]
4280fn check_edits(
4281    old_snapshot: &MultiBufferSnapshot,
4282    new_snapshot: &MultiBufferSnapshot,
4283    edits: &[Edit<MultiBufferOffset>],
4284) {
4285    let mut text = old_snapshot.text();
4286    let new_text = new_snapshot.text();
4287    for edit in edits.iter().rev() {
4288        if !text.is_char_boundary(edit.old.start.0)
4289            || !text.is_char_boundary(edit.old.end.0)
4290            || !new_text.is_char_boundary(edit.new.start.0)
4291            || !new_text.is_char_boundary(edit.new.end.0)
4292        {
4293            panic!(
4294                "invalid edits: {:?}\nold text: {:?}\nnew text: {:?}",
4295                edits, text, new_text
4296            );
4297        }
4298
4299        text.replace_range(
4300            edit.old.start.0..edit.old.end.0,
4301            &new_text[edit.new.start.0..edit.new.end.0],
4302        );
4303    }
4304
4305    pretty_assertions::assert_eq!(text, new_text, "invalid edits: {:?}", edits);
4306}
4307
4308#[track_caller]
4309fn assert_chunks_in_ranges(snapshot: &MultiBufferSnapshot) {
4310    let full_text = snapshot.text();
4311    for ix in 0..full_text.len() {
4312        let mut chunks = snapshot.chunks(MultiBufferOffset(0)..snapshot.len(), false);
4313        chunks.seek(MultiBufferOffset(ix)..snapshot.len());
4314        let tail = chunks.map(|chunk| chunk.text).collect::<String>();
4315        assert_eq!(tail, &full_text[ix..], "seek to range: {:?}", ix..);
4316    }
4317}
4318
4319#[track_caller]
4320fn assert_consistent_line_numbers(snapshot: &MultiBufferSnapshot) {
4321    let all_line_numbers = snapshot.row_infos(MultiBufferRow(0)).collect::<Vec<_>>();
4322    for start_row in 1..all_line_numbers.len() {
4323        let line_numbers = snapshot
4324            .row_infos(MultiBufferRow(start_row as u32))
4325            .collect::<Vec<_>>();
4326        assert_eq!(
4327            line_numbers,
4328            all_line_numbers[start_row..],
4329            "start_row: {start_row}"
4330        );
4331    }
4332}
4333
4334#[track_caller]
4335fn assert_position_translation(snapshot: &MultiBufferSnapshot) {
4336    let text = Rope::from(snapshot.text());
4337
4338    let mut left_anchors = Vec::new();
4339    let mut right_anchors = Vec::new();
4340    let mut offsets = Vec::new();
4341    let mut points = Vec::new();
4342    for offset in 0..=text.len() + 1 {
4343        let offset = MultiBufferOffset(offset);
4344        let clipped_left = snapshot.clip_offset(offset, Bias::Left);
4345        let clipped_right = snapshot.clip_offset(offset, Bias::Right);
4346        assert_eq!(
4347            clipped_left.0,
4348            text.clip_offset(offset.0, Bias::Left),
4349            "clip_offset({offset:?}, Left)"
4350        );
4351        assert_eq!(
4352            clipped_right.0,
4353            text.clip_offset(offset.0, Bias::Right),
4354            "clip_offset({offset:?}, Right)"
4355        );
4356        assert_eq!(
4357            snapshot.offset_to_point(clipped_left),
4358            text.offset_to_point(clipped_left.0),
4359            "offset_to_point({})",
4360            clipped_left.0
4361        );
4362        assert_eq!(
4363            snapshot.offset_to_point(clipped_right),
4364            text.offset_to_point(clipped_right.0),
4365            "offset_to_point({})",
4366            clipped_right.0
4367        );
4368        let anchor_after = snapshot.anchor_after(clipped_left);
4369        assert_eq!(
4370            anchor_after.to_offset(snapshot),
4371            clipped_left,
4372            "anchor_after({}).to_offset {anchor_after:?}",
4373            clipped_left.0
4374        );
4375        let anchor_before = snapshot.anchor_before(clipped_left);
4376        assert_eq!(
4377            anchor_before.to_offset(snapshot),
4378            clipped_left,
4379            "anchor_before({}).to_offset",
4380            clipped_left.0
4381        );
4382        left_anchors.push(anchor_before);
4383        right_anchors.push(anchor_after);
4384        offsets.push(clipped_left);
4385        points.push(text.offset_to_point(clipped_left.0));
4386    }
4387
4388    for row in 0..text.max_point().row {
4389        for column in 0..text.line_len(row) + 1 {
4390            let point = Point { row, column };
4391            let clipped_left = snapshot.clip_point(point, Bias::Left);
4392            let clipped_right = snapshot.clip_point(point, Bias::Right);
4393            assert_eq!(
4394                clipped_left,
4395                text.clip_point(point, Bias::Left),
4396                "clip_point({point:?}, Left)"
4397            );
4398            assert_eq!(
4399                clipped_right,
4400                text.clip_point(point, Bias::Right),
4401                "clip_point({point:?}, Right)"
4402            );
4403            assert_eq!(
4404                snapshot.point_to_offset(clipped_left).0,
4405                text.point_to_offset(clipped_left),
4406                "point_to_offset({clipped_left:?})"
4407            );
4408            assert_eq!(
4409                snapshot.point_to_offset(clipped_right).0,
4410                text.point_to_offset(clipped_right),
4411                "point_to_offset({clipped_right:?})"
4412            );
4413        }
4414    }
4415
4416    assert_eq!(
4417        snapshot.summaries_for_anchors::<MultiBufferOffset, _>(&left_anchors),
4418        offsets,
4419        "left_anchors <-> offsets"
4420    );
4421    assert_eq!(
4422        snapshot.summaries_for_anchors::<Point, _>(&left_anchors),
4423        points,
4424        "left_anchors <-> points"
4425    );
4426    assert_eq!(
4427        snapshot.summaries_for_anchors::<MultiBufferOffset, _>(&right_anchors),
4428        offsets,
4429        "right_anchors <-> offsets"
4430    );
4431    assert_eq!(
4432        snapshot.summaries_for_anchors::<Point, _>(&right_anchors),
4433        points,
4434        "right_anchors <-> points"
4435    );
4436
4437    for (anchors, bias) in [(&left_anchors, Bias::Left), (&right_anchors, Bias::Right)] {
4438        for (ix, (offset, anchor)) in offsets.iter().zip(anchors).enumerate() {
4439            if ix > 0 && *offset == MultiBufferOffset(252) && offset > &offsets[ix - 1] {
4440                let prev_anchor = left_anchors[ix - 1];
4441                assert!(
4442                    anchor.cmp(&prev_anchor, snapshot).is_gt(),
4443                    "anchor({}, {bias:?}).cmp(&anchor({}, {bias:?}).is_gt()",
4444                    offsets[ix],
4445                    offsets[ix - 1],
4446                );
4447                assert!(
4448                    prev_anchor.cmp(anchor, snapshot).is_lt(),
4449                    "anchor({}, {bias:?}).cmp(&anchor({}, {bias:?}).is_lt()",
4450                    offsets[ix - 1],
4451                    offsets[ix],
4452                );
4453            }
4454        }
4455    }
4456
4457    if let Some((buffer, offset)) = snapshot.point_to_buffer_offset(snapshot.max_point()) {
4458        assert!(offset.0 <= buffer.len());
4459    }
4460    if let Some((buffer, point)) = snapshot.point_to_buffer_point(snapshot.max_point()) {
4461        assert!(point <= buffer.max_point());
4462    }
4463}
4464
4465fn assert_line_indents(snapshot: &MultiBufferSnapshot) {
4466    let max_row = snapshot.max_point().row;
4467    let buffer_id = snapshot.excerpts().next().unwrap().1.buffer_id;
4468    let text = text::Buffer::new(ReplicaId::LOCAL, buffer_id, snapshot.text());
4469    let mut line_indents = text
4470        .line_indents_in_row_range(0..max_row + 1)
4471        .collect::<Vec<_>>();
4472    for start_row in 0..snapshot.max_point().row {
4473        pretty_assertions::assert_eq!(
4474            snapshot
4475                .line_indents(MultiBufferRow(start_row), |_| true)
4476                .map(|(row, indent, _)| (row.0, indent))
4477                .collect::<Vec<_>>(),
4478            &line_indents[(start_row as usize)..],
4479            "line_indents({start_row})"
4480        );
4481    }
4482
4483    line_indents.reverse();
4484    pretty_assertions::assert_eq!(
4485        snapshot
4486            .reversed_line_indents(MultiBufferRow(max_row), |_| true)
4487            .map(|(row, indent, _)| (row.0, indent))
4488            .collect::<Vec<_>>(),
4489        &line_indents[..],
4490        "reversed_line_indents({max_row})"
4491    );
4492}
4493
4494#[gpui::test]
4495fn test_new_empty_buffer_uses_untitled_title(cx: &mut App) {
4496    let buffer = cx.new(|cx| Buffer::local("", cx));
4497    let multibuffer = cx.new(|cx| MultiBuffer::singleton(buffer.clone(), cx));
4498
4499    assert_eq!(multibuffer.read(cx).title(cx), "untitled");
4500}
4501
4502#[gpui::test]
4503fn test_new_empty_buffer_uses_untitled_title_when_only_contains_whitespace(cx: &mut App) {
4504    let buffer = cx.new(|cx| Buffer::local("\n ", cx));
4505    let multibuffer = cx.new(|cx| MultiBuffer::singleton(buffer.clone(), cx));
4506
4507    assert_eq!(multibuffer.read(cx).title(cx), "untitled");
4508}
4509
4510#[gpui::test]
4511fn test_new_empty_buffer_takes_first_line_for_title(cx: &mut App) {
4512    let buffer = cx.new(|cx| Buffer::local("Hello World\nSecond line", cx));
4513    let multibuffer = cx.new(|cx| MultiBuffer::singleton(buffer.clone(), cx));
4514
4515    assert_eq!(multibuffer.read(cx).title(cx), "Hello World");
4516}
4517
4518#[gpui::test]
4519fn test_new_empty_buffer_takes_trimmed_first_line_for_title(cx: &mut App) {
4520    let buffer = cx.new(|cx| Buffer::local("\nHello, World ", cx));
4521    let multibuffer = cx.new(|cx| MultiBuffer::singleton(buffer.clone(), cx));
4522
4523    assert_eq!(multibuffer.read(cx).title(cx), "Hello, World");
4524}
4525
4526#[gpui::test]
4527fn test_new_empty_buffer_uses_truncated_first_line_for_title(cx: &mut App) {
4528    let title = "aaaaaaaaaabbbbbbbbbbccccccccccddddddddddeeeeeeeeee";
4529    let title_after = "aaaaaaaaaabbbbbbbbbbccccccccccdddddddddd";
4530    let buffer = cx.new(|cx| Buffer::local(title, cx));
4531    let multibuffer = cx.new(|cx| MultiBuffer::singleton(buffer.clone(), cx));
4532
4533    assert_eq!(multibuffer.read(cx).title(cx), title_after);
4534}
4535
4536#[gpui::test]
4537fn test_new_empty_buffer_uses_truncated_first_line_for_title_after_merging_adjacent_spaces(
4538    cx: &mut App,
4539) {
4540    let title = "aaaaaaaaaabbbbbbbbbb    ccccccccccddddddddddeeeeeeeeee";
4541    let title_after = "aaaaaaaaaabbbbbbbbbb ccccccccccddddddddd";
4542    let buffer = cx.new(|cx| Buffer::local(title, cx));
4543    let multibuffer = cx.new(|cx| MultiBuffer::singleton(buffer.clone(), cx));
4544
4545    assert_eq!(multibuffer.read(cx).title(cx), title_after);
4546}
4547
4548#[gpui::test]
4549fn test_new_empty_buffers_title_can_be_set(cx: &mut App) {
4550    let buffer = cx.new(|cx| Buffer::local("Hello World", cx));
4551    let multibuffer = cx.new(|cx| MultiBuffer::singleton(buffer.clone(), cx));
4552    assert_eq!(multibuffer.read(cx).title(cx), "Hello World");
4553
4554    multibuffer.update(cx, |multibuffer, cx| {
4555        multibuffer.set_title("Hey".into(), cx)
4556    });
4557    assert_eq!(multibuffer.read(cx).title(cx), "Hey");
4558}
4559
4560#[gpui::test(iterations = 100)]
4561fn test_random_chunk_bitmaps(cx: &mut App, mut rng: StdRng) {
4562    let multibuffer = if rng.random() {
4563        let len = rng.random_range(0..10000);
4564        let text = RandomCharIter::new(&mut rng).take(len).collect::<String>();
4565        let buffer = cx.new(|cx| Buffer::local(text, cx));
4566        cx.new(|cx| MultiBuffer::singleton(buffer, cx))
4567    } else {
4568        MultiBuffer::build_random(&mut rng, cx)
4569    };
4570
4571    let snapshot = multibuffer.read(cx).snapshot(cx);
4572
4573    let chunks = snapshot.chunks(MultiBufferOffset(0)..snapshot.len(), false);
4574
4575    for chunk in chunks {
4576        let chunk_text = chunk.text;
4577        let chars_bitmap = chunk.chars;
4578        let tabs_bitmap = chunk.tabs;
4579
4580        if chunk_text.is_empty() {
4581            assert_eq!(
4582                chars_bitmap, 0,
4583                "Empty chunk should have empty chars bitmap"
4584            );
4585            assert_eq!(tabs_bitmap, 0, "Empty chunk should have empty tabs bitmap");
4586            continue;
4587        }
4588
4589        assert!(
4590            chunk_text.len() <= 128,
4591            "Chunk text length {} exceeds 128 bytes",
4592            chunk_text.len()
4593        );
4594
4595        // Verify chars bitmap
4596        let char_indices = chunk_text
4597            .char_indices()
4598            .map(|(i, _)| i)
4599            .collect::<Vec<_>>();
4600
4601        for byte_idx in 0..chunk_text.len() {
4602            let should_have_bit = char_indices.contains(&byte_idx);
4603            let has_bit = chars_bitmap & (1 << byte_idx) != 0;
4604
4605            if has_bit != should_have_bit {
4606                eprintln!("Chunk text bytes: {:?}", chunk_text.as_bytes());
4607                eprintln!("Char indices: {:?}", char_indices);
4608                eprintln!("Chars bitmap: {:#b}", chars_bitmap);
4609            }
4610
4611            assert_eq!(
4612                has_bit, should_have_bit,
4613                "Chars bitmap mismatch at byte index {} in chunk {:?}. Expected bit: {}, Got bit: {}",
4614                byte_idx, chunk_text, should_have_bit, has_bit
4615            );
4616        }
4617
4618        for (byte_idx, byte) in chunk_text.bytes().enumerate() {
4619            let is_tab = byte == b'\t';
4620            let has_bit = tabs_bitmap & (1 << byte_idx) != 0;
4621
4622            if has_bit != is_tab {
4623                eprintln!("Chunk text bytes: {:?}", chunk_text.as_bytes());
4624                eprintln!("Tabs bitmap: {:#b}", tabs_bitmap);
4625                assert_eq!(
4626                    has_bit, is_tab,
4627                    "Tabs bitmap mismatch at byte index {} in chunk {:?}. Byte: {:?}, Expected bit: {}, Got bit: {}",
4628                    byte_idx, chunk_text, byte as char, is_tab, has_bit
4629                );
4630            }
4631        }
4632    }
4633}
4634
4635#[gpui::test(iterations = 10)]
4636fn test_random_chunk_bitmaps_with_diffs(cx: &mut App, mut rng: StdRng) {
4637    let settings_store = SettingsStore::test(cx);
4638    cx.set_global(settings_store);
4639    use buffer_diff::BufferDiff;
4640    use util::RandomCharIter;
4641
4642    let multibuffer = if rng.random() {
4643        let len = rng.random_range(100..10000);
4644        let text = RandomCharIter::new(&mut rng).take(len).collect::<String>();
4645        let buffer = cx.new(|cx| Buffer::local(text, cx));
4646        cx.new(|cx| MultiBuffer::singleton(buffer, cx))
4647    } else {
4648        MultiBuffer::build_random(&mut rng, cx)
4649    };
4650
4651    let _diff_count = rng.random_range(1..5);
4652    let mut diffs = Vec::new();
4653
4654    multibuffer.update(cx, |multibuffer, cx| {
4655        for buffer_id in multibuffer.all_buffer_ids() {
4656            if rng.random_bool(0.7) {
4657                if let Some(buffer_handle) = multibuffer.buffer(buffer_id) {
4658                    let buffer_text = buffer_handle.read(cx).text();
4659                    let mut base_text = String::new();
4660
4661                    for line in buffer_text.lines() {
4662                        if rng.random_bool(0.3) {
4663                            continue;
4664                        } else if rng.random_bool(0.3) {
4665                            let line_len = rng.random_range(0..50);
4666                            let modified_line = RandomCharIter::new(&mut rng)
4667                                .take(line_len)
4668                                .collect::<String>();
4669                            base_text.push_str(&modified_line);
4670                            base_text.push('\n');
4671                        } else {
4672                            base_text.push_str(line);
4673                            base_text.push('\n');
4674                        }
4675                    }
4676
4677                    if rng.random_bool(0.5) {
4678                        let extra_lines = rng.random_range(1..5);
4679                        for _ in 0..extra_lines {
4680                            let line_len = rng.random_range(0..50);
4681                            let extra_line = RandomCharIter::new(&mut rng)
4682                                .take(line_len)
4683                                .collect::<String>();
4684                            base_text.push_str(&extra_line);
4685                            base_text.push('\n');
4686                        }
4687                    }
4688
4689                    let diff = cx.new(|cx| {
4690                        BufferDiff::new_with_base_text(
4691                            &base_text,
4692                            &buffer_handle.read(cx).text_snapshot(),
4693                            cx,
4694                        )
4695                    });
4696                    diffs.push(diff.clone());
4697                    multibuffer.add_diff(diff, cx);
4698                }
4699            }
4700        }
4701    });
4702
4703    multibuffer.update(cx, |multibuffer, cx| {
4704        if rng.random_bool(0.5) {
4705            multibuffer.set_all_diff_hunks_expanded(cx);
4706        } else {
4707            let snapshot = multibuffer.snapshot(cx);
4708            let text = snapshot.text();
4709
4710            let mut ranges = Vec::new();
4711            for _ in 0..rng.random_range(1..5) {
4712                if snapshot.len().0 == 0 {
4713                    break;
4714                }
4715
4716                let diff_size = rng.random_range(5..1000);
4717                let mut start = rng.random_range(0..snapshot.len().0);
4718
4719                while !text.is_char_boundary(start) {
4720                    start = start.saturating_sub(1);
4721                }
4722
4723                let mut end = rng.random_range(start..snapshot.len().0.min(start + diff_size));
4724
4725                while !text.is_char_boundary(end) {
4726                    end = end.saturating_add(1);
4727                }
4728                let start_anchor = snapshot.anchor_after(MultiBufferOffset(start));
4729                let end_anchor = snapshot.anchor_before(MultiBufferOffset(end));
4730                ranges.push(start_anchor..end_anchor);
4731            }
4732            multibuffer.expand_diff_hunks(ranges, cx);
4733        }
4734    });
4735
4736    let snapshot = multibuffer.read(cx).snapshot(cx);
4737
4738    let chunks = snapshot.chunks(MultiBufferOffset(0)..snapshot.len(), false);
4739
4740    for chunk in chunks {
4741        let chunk_text = chunk.text;
4742        let chars_bitmap = chunk.chars;
4743        let tabs_bitmap = chunk.tabs;
4744
4745        if chunk_text.is_empty() {
4746            assert_eq!(
4747                chars_bitmap, 0,
4748                "Empty chunk should have empty chars bitmap"
4749            );
4750            assert_eq!(tabs_bitmap, 0, "Empty chunk should have empty tabs bitmap");
4751            continue;
4752        }
4753
4754        assert!(
4755            chunk_text.len() <= 128,
4756            "Chunk text length {} exceeds 128 bytes",
4757            chunk_text.len()
4758        );
4759
4760        let char_indices = chunk_text
4761            .char_indices()
4762            .map(|(i, _)| i)
4763            .collect::<Vec<_>>();
4764
4765        for byte_idx in 0..chunk_text.len() {
4766            let should_have_bit = char_indices.contains(&byte_idx);
4767            let has_bit = chars_bitmap & (1 << byte_idx) != 0;
4768
4769            if has_bit != should_have_bit {
4770                eprintln!("Chunk text bytes: {:?}", chunk_text.as_bytes());
4771                eprintln!("Char indices: {:?}", char_indices);
4772                eprintln!("Chars bitmap: {:#b}", chars_bitmap);
4773            }
4774
4775            assert_eq!(
4776                has_bit, should_have_bit,
4777                "Chars bitmap mismatch at byte index {} in chunk {:?}. Expected bit: {}, Got bit: {}",
4778                byte_idx, chunk_text, should_have_bit, has_bit
4779            );
4780        }
4781
4782        for (byte_idx, byte) in chunk_text.bytes().enumerate() {
4783            let is_tab = byte == b'\t';
4784            let has_bit = tabs_bitmap & (1 << byte_idx) != 0;
4785
4786            if has_bit != is_tab {
4787                eprintln!("Chunk text bytes: {:?}", chunk_text.as_bytes());
4788                eprintln!("Tabs bitmap: {:#b}", tabs_bitmap);
4789                assert_eq!(
4790                    has_bit, is_tab,
4791                    "Tabs bitmap mismatch at byte index {} in chunk {:?}. Byte: {:?}, Expected bit: {}, Got bit: {}",
4792                    byte_idx, chunk_text, byte as char, is_tab, has_bit
4793                );
4794            }
4795        }
4796    }
4797}
4798
4799fn collect_word_diffs(
4800    base_text: &str,
4801    modified_text: &str,
4802    cx: &mut TestAppContext,
4803) -> Vec<String> {
4804    let buffer = cx.new(|cx| Buffer::local(modified_text, cx));
4805    let diff = cx
4806        .new(|cx| BufferDiff::new_with_base_text(base_text, &buffer.read(cx).text_snapshot(), cx));
4807    cx.run_until_parked();
4808
4809    let multibuffer = cx.new(|cx| {
4810        let mut multibuffer = MultiBuffer::singleton(buffer.clone(), cx);
4811        multibuffer.add_diff(diff.clone(), cx);
4812        multibuffer
4813    });
4814
4815    multibuffer.update(cx, |multibuffer, cx| {
4816        multibuffer.expand_diff_hunks(vec![Anchor::min()..Anchor::max()], cx);
4817    });
4818
4819    let snapshot = multibuffer.read_with(cx, |multibuffer, cx| multibuffer.snapshot(cx));
4820    let text = snapshot.text();
4821
4822    snapshot
4823        .diff_hunks()
4824        .flat_map(|hunk| hunk.word_diffs)
4825        .map(|range| text[range.start.0..range.end.0].to_string())
4826        .collect()
4827}
4828
4829#[gpui::test]
4830async fn test_word_diff_simple_replacement(cx: &mut TestAppContext) {
4831    let settings_store = cx.update(|cx| SettingsStore::test(cx));
4832    cx.set_global(settings_store);
4833
4834    let base_text = "hello world foo bar\n";
4835    let modified_text = "hello WORLD foo BAR\n";
4836
4837    let word_diffs = collect_word_diffs(base_text, modified_text, cx);
4838
4839    assert_eq!(word_diffs, vec!["world", "bar", "WORLD", "BAR"]);
4840}
4841
4842#[gpui::test]
4843async fn test_word_diff_white_space(cx: &mut TestAppContext) {
4844    let settings_store = cx.update(|cx| SettingsStore::test(cx));
4845    cx.set_global(settings_store);
4846
4847    let base_text = "hello world foo bar\n";
4848    let modified_text = "    hello world foo bar\n";
4849
4850    let word_diffs = collect_word_diffs(base_text, modified_text, cx);
4851
4852    assert_eq!(word_diffs, vec!["    "]);
4853}
4854
4855#[gpui::test]
4856async fn test_word_diff_consecutive_modified_lines(cx: &mut TestAppContext) {
4857    let settings_store = cx.update(|cx| SettingsStore::test(cx));
4858    cx.set_global(settings_store);
4859
4860    let base_text = "aaa bbb\nccc ddd\n";
4861    let modified_text = "aaa BBB\nccc DDD\n";
4862
4863    let word_diffs = collect_word_diffs(base_text, modified_text, cx);
4864
4865    assert_eq!(
4866        word_diffs,
4867        vec!["bbb", "ddd", "BBB", "DDD"],
4868        "consecutive modified lines should produce word diffs when line counts match"
4869    );
4870}
4871
4872#[gpui::test]
4873async fn test_word_diff_modified_lines_with_deletion_between(cx: &mut TestAppContext) {
4874    let settings_store = cx.update(|cx| SettingsStore::test(cx));
4875    cx.set_global(settings_store);
4876
4877    let base_text = "aaa bbb\ndeleted line\nccc ddd\n";
4878    let modified_text = "aaa BBB\nccc DDD\n";
4879
4880    let word_diffs = collect_word_diffs(base_text, modified_text, cx);
4881
4882    assert_eq!(
4883        word_diffs,
4884        Vec::<String>::new(),
4885        "modified lines with a deleted line between should not produce word diffs"
4886    );
4887}
4888
4889#[gpui::test]
4890async fn test_word_diff_disabled(cx: &mut TestAppContext) {
4891    let settings_store = cx.update(|cx| {
4892        let mut settings_store = SettingsStore::test(cx);
4893        settings_store.update_user_settings(cx, |settings| {
4894            settings.project.all_languages.defaults.word_diff_enabled = Some(false);
4895        });
4896        settings_store
4897    });
4898    cx.set_global(settings_store);
4899
4900    let base_text = "hello world\n";
4901    let modified_text = "hello WORLD\n";
4902
4903    let word_diffs = collect_word_diffs(base_text, modified_text, cx);
4904
4905    assert_eq!(
4906        word_diffs,
4907        Vec::<String>::new(),
4908        "word diffs should be empty when disabled"
4909    );
4910}
4911
4912/// Tests `excerpt_containing` and `excerpts_for_range` (functions mapping multi-buffer text-coordinates to excerpts)
4913#[gpui::test]
4914fn test_excerpts_containment_functions(cx: &mut App) {
4915    // Multibuffer content for these tests:
4916    //    0123
4917    // 0: aa0
4918    // 1: aa1
4919    //    -----
4920    // 2: bb0
4921    // 3: bb1
4922    //    -----MultiBufferOffset(0)..
4923    // 4: cc0
4924
4925    let buffer_1 = cx.new(|cx| Buffer::local("aa0\naa1", cx));
4926    let buffer_2 = cx.new(|cx| Buffer::local("bb0\nbb1", cx));
4927    let buffer_3 = cx.new(|cx| Buffer::local("cc0", cx));
4928
4929    let multibuffer = cx.new(|_| MultiBuffer::new(Capability::ReadWrite));
4930
4931    let (excerpt_1_info, excerpt_2_info, excerpt_3_info) =
4932        multibuffer.update(cx, |multibuffer, cx| {
4933            multibuffer.set_excerpts_for_path(
4934                PathKey::sorted(0),
4935                buffer_1.clone(),
4936                [Point::new(0, 0)..Point::new(1, 3)],
4937                0,
4938                cx,
4939            );
4940
4941            multibuffer.set_excerpts_for_path(
4942                PathKey::sorted(1),
4943                buffer_2.clone(),
4944                [Point::new(0, 0)..Point::new(1, 3)],
4945                0,
4946                cx,
4947            );
4948
4949            multibuffer.set_excerpts_for_path(
4950                PathKey::sorted(2),
4951                buffer_3.clone(),
4952                [Point::new(0, 0)..Point::new(0, 3)],
4953                0,
4954                cx,
4955            );
4956
4957            let snapshot = multibuffer.snapshot(cx);
4958            let mut infos = snapshot.excerpts().map(|(_, info)| info);
4959            (
4960                infos.next().unwrap(),
4961                infos.next().unwrap(),
4962                infos.next().unwrap(),
4963            )
4964        });
4965
4966    let snapshot = multibuffer.read(cx).snapshot(cx);
4967
4968    assert_eq!(snapshot.text(), "aa0\naa1\nbb0\nbb1\ncc0");
4969
4970    //// Test `excerpts_for_range`
4971
4972    let p00 = snapshot.point_to_offset(Point::new(0, 0));
4973    let p10 = snapshot.point_to_offset(Point::new(1, 0));
4974    let p20 = snapshot.point_to_offset(Point::new(2, 0));
4975    let p23 = snapshot.point_to_offset(Point::new(2, 3));
4976    let p13 = snapshot.point_to_offset(Point::new(1, 3));
4977    let p40 = snapshot.point_to_offset(Point::new(4, 0));
4978    let p43 = snapshot.point_to_offset(Point::new(4, 3));
4979
4980    let excerpts: Vec<_> = snapshot.excerpts_for_range(p00..p00).collect();
4981    assert_eq!(excerpts.len(), 1);
4982    assert_eq!(excerpts[0].info(), excerpt_1_info);
4983
4984    // Cursor at very end of excerpt 3
4985    let excerpts: Vec<_> = snapshot.excerpts_for_range(p43..p43).collect();
4986    assert_eq!(excerpts.len(), 1);
4987    assert_eq!(excerpts[0].info(), excerpt_3_info);
4988
4989    let excerpts: Vec<_> = snapshot.excerpts_for_range(p00..p23).collect();
4990    assert_eq!(excerpts.len(), 2);
4991    assert_eq!(excerpts[0].info(), excerpt_1_info);
4992    assert_eq!(excerpts[1].info(), excerpt_2_info);
4993
4994    // This range represent an selection with end-point just inside excerpt_2
4995    // Today we only expand the first excerpt, but another interpretation that
4996    // we could consider is expanding both here
4997    let excerpts: Vec<_> = snapshot.excerpts_for_range(p10..p20).collect();
4998    assert_eq!(excerpts.len(), 1);
4999    assert_eq!(excerpts[0].info(), excerpt_1_info);
5000
5001    //// Test that `excerpts_for_range` and `excerpt_containing` agree for all single offsets (cursor positions)
5002    for offset in 0..=snapshot.len().0 {
5003        let offset = MultiBufferOffset(offset);
5004        let excerpts_for_range: Vec<_> = snapshot.excerpts_for_range(offset..offset).collect();
5005        assert_eq!(
5006            excerpts_for_range.len(),
5007            1,
5008            "Expected exactly one excerpt for offset {offset}",
5009        );
5010
5011        let excerpt_containing = snapshot.excerpt_containing(offset..offset);
5012        assert!(
5013            excerpt_containing.is_some(),
5014            "Expected excerpt_containing to find excerpt for offset {offset}",
5015        );
5016
5017        assert_eq!(
5018            excerpts_for_range[0].info(),
5019            excerpt_containing.unwrap().excerpt.info(),
5020            "excerpts_for_range and excerpt_containing should agree for offset {offset}",
5021        );
5022    }
5023
5024    //// Test `excerpt_containing` behavior with ranges:
5025
5026    // Ranges intersecting a single-excerpt
5027    let containing = snapshot.excerpt_containing(p00..p13);
5028    assert!(containing.is_some());
5029    assert_eq!(containing.unwrap().excerpt.info(), excerpt_1_info);
5030
5031    // Ranges intersecting multiple excerpts (should return None)
5032    let containing = snapshot.excerpt_containing(p20..p40);
5033    assert!(
5034        containing.is_none(),
5035        "excerpt_containing should return None for ranges spanning multiple excerpts"
5036    );
5037}
5038
5039#[gpui::test]
5040fn test_range_to_buffer_ranges(cx: &mut App) {
5041    let buffer_1 = cx.new(|cx| Buffer::local("aaa\nbbb", cx));
5042    let buffer_2 = cx.new(|cx| Buffer::local("ccc", cx));
5043
5044    let multibuffer = cx.new(|_| MultiBuffer::new(Capability::ReadWrite));
5045    multibuffer.update(cx, |multibuffer, cx| {
5046        multibuffer.set_excerpts_for_path(
5047            PathKey::sorted(0),
5048            buffer_1.clone(),
5049            [Point::new(0, 0)..Point::new(1, 3)],
5050            0,
5051            cx,
5052        );
5053
5054        multibuffer.set_excerpts_for_path(
5055            PathKey::sorted(1),
5056            buffer_2.clone(),
5057            [Point::new(0, 0)..Point::new(0, 3)],
5058            0,
5059            cx,
5060        );
5061    });
5062
5063    let snapshot = multibuffer.read(cx).snapshot(cx);
5064    assert_eq!(snapshot.text(), "aaa\nbbb\nccc");
5065
5066    let excerpt_2_start = Point::new(2, 0);
5067
5068    let ranges_half_open = snapshot.range_to_buffer_ranges(Point::zero()..excerpt_2_start);
5069    assert_eq!(
5070        ranges_half_open.len(),
5071        1,
5072        "Half-open range ending at excerpt start should EXCLUDE that excerpt"
5073    );
5074    assert_eq!(ranges_half_open[0].1, BufferOffset(0)..BufferOffset(7));
5075    assert_eq!(
5076        ranges_half_open[0].0.remote_id(),
5077        buffer_1.read(cx).remote_id()
5078    );
5079
5080    let buffer_empty = cx.new(|cx| Buffer::local("", cx));
5081    let multibuffer_trailing_empty = cx.new(|_| MultiBuffer::new(Capability::ReadWrite));
5082    let (te_excerpt_1_info, te_excerpt_2_info) =
5083        multibuffer_trailing_empty.update(cx, |multibuffer, cx| {
5084            multibuffer.set_excerpts_for_path(
5085                PathKey::sorted(0),
5086                buffer_1.clone(),
5087                [Point::new(0, 0)..Point::new(1, 3)],
5088                0,
5089                cx,
5090            );
5091
5092            multibuffer.set_excerpts_for_path(
5093                PathKey::sorted(1),
5094                buffer_empty.clone(),
5095                [Point::new(0, 0)..Point::new(0, 0)],
5096                0,
5097                cx,
5098            );
5099
5100            let snapshot = multibuffer.snapshot(cx);
5101            let mut infos = snapshot.excerpts().map(|(_, info)| info);
5102            (infos.next().unwrap(), infos.next().unwrap())
5103        });
5104
5105    let snapshot_trailing = multibuffer_trailing_empty.read(cx).snapshot(cx);
5106    assert_eq!(snapshot_trailing.text(), "aaa\nbbb\n");
5107
5108    let max_point = snapshot_trailing.max_point();
5109
5110    let ranges_half_open_max =
5111        snapshot_trailing.range_to_buffer_ranges_with_context(Point::zero()..max_point);
5112    assert_eq!(
5113        ranges_half_open_max.len(),
5114        2,
5115        "Should include trailing empty excerpts"
5116    );
5117    assert_eq!(ranges_half_open_max[0].2, te_excerpt_1_info.range);
5118}
5119
5120#[gpui::test]
5121fn test_cannot_seek_backward_after_excerpt_replacement(cx: &mut TestAppContext) {
5122    let buffer_b_text: String = (0..50).map(|i| format!("line_b {i}\n")).collect();
5123    let buffer_b = cx.new(|cx| Buffer::local(buffer_b_text, cx));
5124
5125    let buffer_c_text: String = (0..10).map(|i| format!("line_c {i}\n")).collect();
5126    let buffer_c = cx.new(|cx| Buffer::local(buffer_c_text, cx));
5127
5128    let buffer_d_text: String = (0..10).map(|i| format!("line_d {i}\n")).collect();
5129    let buffer_d = cx.new(|cx| Buffer::local(buffer_d_text, cx));
5130
5131    let path_b = PathKey::with_sort_prefix(0, rel_path("bbb.rs").into_arc());
5132    let path_c = PathKey::with_sort_prefix(0, rel_path("ddd.rs").into_arc());
5133    let path_d = PathKey::with_sort_prefix(0, rel_path("ccc.rs").into_arc());
5134
5135    let multibuffer = cx.new(|_| MultiBuffer::new(Capability::ReadWrite));
5136
5137    multibuffer.update(cx, |multibuffer, cx| {
5138        multibuffer.set_excerpts_for_path(
5139            path_b.clone(),
5140            buffer_b.clone(),
5141            vec![
5142                Point::row_range(0..3),
5143                Point::row_range(15..18),
5144                Point::row_range(30..33),
5145            ],
5146            0,
5147            cx,
5148        );
5149    });
5150
5151    multibuffer.update(cx, |multibuffer, cx| {
5152        multibuffer.set_excerpts_for_path(
5153            path_c.clone(),
5154            buffer_c.clone(),
5155            vec![Point::row_range(0..3)],
5156            0,
5157            cx,
5158        );
5159    });
5160
5161    let (anchor_in_e_b2, anchor_in_e_b3) = multibuffer.read_with(cx, |multibuffer, cx| {
5162        let snapshot = multibuffer.snapshot(cx);
5163        let excerpt_infos: Vec<ExcerptInfo> = snapshot.excerpts().map(|(_, info)| info).collect();
5164        assert_eq!(excerpt_infos.len(), 4, "expected 4 excerpts (3×B + 1×C)");
5165
5166        let e_b2_info = excerpt_infos[1].clone();
5167        let e_b3_info = excerpt_infos[2].clone();
5168
5169        let anchor_b2 = Anchor::in_buffer(e_b2_info.path_key_index, e_b2_info.range.start);
5170        let anchor_b3 = Anchor::in_buffer(e_b3_info.path_key_index, e_b3_info.range.start);
5171        (anchor_b2, anchor_b3)
5172    });
5173
5174    multibuffer.update(cx, |multibuffer, cx| {
5175        multibuffer.set_excerpts_for_path(
5176            path_b.clone(),
5177            buffer_b.clone(),
5178            vec![Point::row_range(0..3), Point::row_range(28..36)],
5179            0,
5180            cx,
5181        );
5182    });
5183
5184    multibuffer.update(cx, |multibuffer, cx| {
5185        multibuffer.set_excerpts_for_path(
5186            path_d.clone(),
5187            buffer_d.clone(),
5188            vec![Point::row_range(0..3)],
5189            0,
5190            cx,
5191        );
5192    });
5193
5194    multibuffer.read_with(cx, |multibuffer, cx| {
5195        let snapshot = multibuffer.snapshot(cx);
5196        snapshot.summaries_for_anchors::<Point, _>(&[anchor_in_e_b2, anchor_in_e_b3]);
5197    });
5198}