1use futures::channel::oneshot;
2use git2::{DiffLineType as GitDiffLineType, DiffOptions as GitOptions, Patch as GitPatch};
3use gpui::{App, AppContext as _, Context, Entity, EventEmitter, Task};
4use language::{
5 Capability, Diff, DiffOptions, File, Language, LanguageName, LanguageRegistry,
6 language_settings::language_settings, word_diff_ranges,
7};
8use rope::Rope;
9use std::{
10 cmp::Ordering,
11 future::Future,
12 iter,
13 ops::{Range, RangeInclusive},
14 sync::Arc,
15};
16use sum_tree::SumTree;
17use text::{
18 Anchor, Bias, BufferId, Edit, OffsetRangeExt, Patch, Point, ToOffset as _, ToPoint as _,
19};
20use util::ResultExt;
21
22pub const MAX_WORD_DIFF_LINE_COUNT: usize = 5;
23
24pub struct BufferDiff {
25 pub buffer_id: BufferId,
26 inner: BufferDiffInner<Entity<language::Buffer>>,
27 secondary_diff: Option<Entity<BufferDiff>>,
28}
29
30#[derive(Clone)]
31pub struct BufferDiffSnapshot {
32 inner: BufferDiffInner<language::BufferSnapshot>,
33 secondary_diff: Option<Arc<BufferDiffSnapshot>>,
34}
35
36impl std::fmt::Debug for BufferDiffSnapshot {
37 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
38 f.debug_struct("BufferDiffSnapshot")
39 .field("inner", &self.inner)
40 .field("secondary_diff", &self.secondary_diff)
41 .finish()
42 }
43}
44
45#[derive(Clone)]
46pub struct BufferDiffUpdate {
47 inner: BufferDiffInner<Arc<str>>,
48 buffer_snapshot: text::BufferSnapshot,
49 base_text_edits: Option<Diff>,
50 base_text_changed: bool,
51}
52
53#[derive(Clone)]
54struct BufferDiffInner<BaseText> {
55 hunks: SumTree<InternalDiffHunk>,
56 pending_hunks: SumTree<PendingHunk>,
57 base_text: BaseText,
58 base_text_exists: bool,
59 buffer_snapshot: text::BufferSnapshot,
60}
61
62impl<BaseText> BufferDiffInner<BaseText> {
63 fn buffer_version(&self) -> &clock::Global {
64 self.buffer_snapshot.version()
65 }
66}
67
68#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
69pub struct DiffHunkStatus {
70 pub kind: DiffHunkStatusKind,
71 pub secondary: DiffHunkSecondaryStatus,
72}
73
74#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
75pub enum DiffHunkStatusKind {
76 Added,
77 Modified,
78 Deleted,
79}
80
81#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
82/// Diff of Working Copy vs Index
83/// aka 'is this hunk staged or not'
84pub enum DiffHunkSecondaryStatus {
85 /// Unstaged
86 HasSecondaryHunk,
87 /// Partially staged
88 OverlapsWithSecondaryHunk,
89 /// Staged
90 NoSecondaryHunk,
91 /// We are unstaging
92 SecondaryHunkAdditionPending,
93 /// We are stagind
94 SecondaryHunkRemovalPending,
95}
96
97/// A diff hunk resolved to rows in the buffer.
98#[derive(Debug, Clone, PartialEq, Eq)]
99pub struct DiffHunk {
100 /// The buffer range as points.
101 pub range: Range<Point>,
102 /// The range in the buffer to which this hunk corresponds.
103 pub buffer_range: Range<Anchor>,
104 /// The range in the buffer's diff base text to which this hunk corresponds.
105 pub diff_base_byte_range: Range<usize>,
106 pub secondary_status: DiffHunkSecondaryStatus,
107 // Anchors representing the word diff locations in the active buffer
108 pub buffer_word_diffs: Vec<Range<Anchor>>,
109 // Offsets relative to the start of the deleted diff that represent word diff locations
110 pub base_word_diffs: Vec<Range<usize>>,
111}
112
113/// We store [`InternalDiffHunk`]s internally so we don't need to store the additional row range.
114#[derive(Debug, Clone, PartialEq, Eq)]
115struct InternalDiffHunk {
116 buffer_range: Range<Anchor>,
117 diff_base_byte_range: Range<usize>,
118 base_word_diffs: Vec<Range<usize>>,
119 buffer_word_diffs: Vec<Range<Anchor>>,
120}
121
122#[derive(Debug, Clone, PartialEq, Eq)]
123struct PendingHunk {
124 buffer_range: Range<Anchor>,
125 diff_base_byte_range: Range<usize>,
126 buffer_version: clock::Global,
127 new_status: DiffHunkSecondaryStatus,
128}
129
130#[derive(Debug, Clone)]
131pub struct DiffHunkSummary {
132 buffer_range: Range<Anchor>,
133 diff_base_byte_range: Range<usize>,
134}
135
136impl sum_tree::Item for InternalDiffHunk {
137 type Summary = DiffHunkSummary;
138
139 fn summary(&self, _cx: &text::BufferSnapshot) -> Self::Summary {
140 DiffHunkSummary {
141 buffer_range: self.buffer_range.clone(),
142 diff_base_byte_range: self.diff_base_byte_range.clone(),
143 }
144 }
145}
146
147impl sum_tree::Item for PendingHunk {
148 type Summary = DiffHunkSummary;
149
150 fn summary(&self, _cx: &text::BufferSnapshot) -> Self::Summary {
151 DiffHunkSummary {
152 buffer_range: self.buffer_range.clone(),
153 diff_base_byte_range: self.diff_base_byte_range.clone(),
154 }
155 }
156}
157
158impl sum_tree::Summary for DiffHunkSummary {
159 type Context<'a> = &'a text::BufferSnapshot;
160
161 fn zero(_cx: Self::Context<'_>) -> Self {
162 DiffHunkSummary {
163 buffer_range: Anchor::MIN..Anchor::MIN,
164 diff_base_byte_range: 0..0,
165 }
166 }
167
168 fn add_summary(&mut self, other: &Self, buffer: Self::Context<'_>) {
169 self.buffer_range.start = *self
170 .buffer_range
171 .start
172 .min(&other.buffer_range.start, buffer);
173 self.buffer_range.end = *self.buffer_range.end.max(&other.buffer_range.end, buffer);
174
175 self.diff_base_byte_range.start = self
176 .diff_base_byte_range
177 .start
178 .min(other.diff_base_byte_range.start);
179 self.diff_base_byte_range.end = self
180 .diff_base_byte_range
181 .end
182 .max(other.diff_base_byte_range.end);
183 }
184}
185
186impl sum_tree::SeekTarget<'_, DiffHunkSummary, DiffHunkSummary> for Anchor {
187 fn cmp(&self, cursor_location: &DiffHunkSummary, buffer: &text::BufferSnapshot) -> Ordering {
188 if self
189 .cmp(&cursor_location.buffer_range.start, buffer)
190 .is_lt()
191 {
192 Ordering::Less
193 } else if self.cmp(&cursor_location.buffer_range.end, buffer).is_gt() {
194 Ordering::Greater
195 } else {
196 Ordering::Equal
197 }
198 }
199}
200
201impl sum_tree::SeekTarget<'_, DiffHunkSummary, DiffHunkSummary> for usize {
202 fn cmp(&self, cursor_location: &DiffHunkSummary, _cx: &text::BufferSnapshot) -> Ordering {
203 if *self < cursor_location.diff_base_byte_range.start {
204 Ordering::Less
205 } else if *self > cursor_location.diff_base_byte_range.end {
206 Ordering::Greater
207 } else {
208 Ordering::Equal
209 }
210 }
211}
212
213impl std::fmt::Debug for BufferDiffInner<language::BufferSnapshot> {
214 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
215 f.debug_struct("BufferDiffSnapshot")
216 .field("hunks", &self.hunks)
217 .field("remote_id", &self.base_text.remote_id())
218 .finish()
219 }
220}
221
222impl BufferDiffSnapshot {
223 #[cfg(test)]
224 fn new_sync(
225 buffer: &text::BufferSnapshot,
226 diff_base: String,
227 cx: &mut gpui::TestAppContext,
228 ) -> BufferDiffSnapshot {
229 let buffer_diff = cx.new(|cx| BufferDiff::new_with_base_text(&diff_base, buffer, cx));
230 buffer_diff.update(cx, |buffer_diff, cx| buffer_diff.snapshot(cx))
231 }
232
233 pub fn is_empty(&self) -> bool {
234 self.inner.hunks.is_empty()
235 }
236
237 pub fn base_text_string(&self) -> Option<String> {
238 self.inner
239 .base_text_exists
240 .then(|| self.inner.base_text.text())
241 }
242
243 pub fn secondary_diff(&self) -> Option<&BufferDiffSnapshot> {
244 self.secondary_diff.as_deref()
245 }
246
247 pub fn buffer_version(&self) -> &clock::Global {
248 self.inner.buffer_version()
249 }
250
251 fn original_buffer_snapshot(&self) -> &text::BufferSnapshot {
252 &self.inner.buffer_snapshot
253 }
254
255 #[ztracing::instrument(skip_all)]
256 pub fn hunks_intersecting_range<'a>(
257 &'a self,
258 range: Range<Anchor>,
259 buffer: &'a text::BufferSnapshot,
260 ) -> impl 'a + Iterator<Item = DiffHunk> {
261 let unstaged_counterpart = self.secondary_diff.as_ref().map(|diff| &diff.inner);
262 self.inner
263 .hunks_intersecting_range(range, buffer, unstaged_counterpart)
264 }
265
266 pub fn hunks_intersecting_range_rev<'a>(
267 &'a self,
268 range: Range<Anchor>,
269 buffer: &'a text::BufferSnapshot,
270 ) -> impl 'a + Iterator<Item = DiffHunk> {
271 let filter = move |summary: &DiffHunkSummary| {
272 let before_start = summary.buffer_range.end.cmp(&range.start, buffer).is_lt();
273 let after_end = summary.buffer_range.start.cmp(&range.end, buffer).is_gt();
274 !before_start && !after_end
275 };
276 self.inner.hunks_intersecting_range_rev_impl(filter, buffer)
277 }
278
279 pub fn hunks_intersecting_base_text_range<'a>(
280 &'a self,
281 range: Range<usize>,
282 main_buffer: &'a text::BufferSnapshot,
283 ) -> impl 'a + Iterator<Item = DiffHunk> {
284 let unstaged_counterpart = self.secondary_diff.as_ref().map(|diff| &diff.inner);
285 let filter = move |summary: &DiffHunkSummary| {
286 let before_start = summary.diff_base_byte_range.end < range.start;
287 let after_end = summary.diff_base_byte_range.start > range.end;
288 !before_start && !after_end
289 };
290 self.inner
291 .hunks_intersecting_range_impl(filter, main_buffer, unstaged_counterpart)
292 }
293
294 pub fn hunks_intersecting_base_text_range_rev<'a>(
295 &'a self,
296 range: Range<usize>,
297 main_buffer: &'a text::BufferSnapshot,
298 ) -> impl 'a + Iterator<Item = DiffHunk> {
299 let filter = move |summary: &DiffHunkSummary| {
300 let before_start = summary.diff_base_byte_range.end.cmp(&range.start).is_lt();
301 let after_end = summary.diff_base_byte_range.start.cmp(&range.end).is_gt();
302 !before_start && !after_end
303 };
304 self.inner
305 .hunks_intersecting_range_rev_impl(filter, main_buffer)
306 }
307
308 pub fn hunks<'a>(
309 &'a self,
310 buffer_snapshot: &'a text::BufferSnapshot,
311 ) -> impl 'a + Iterator<Item = DiffHunk> {
312 self.hunks_intersecting_range(
313 Anchor::min_max_range_for_buffer(buffer_snapshot.remote_id()),
314 buffer_snapshot,
315 )
316 }
317
318 pub fn hunks_in_row_range<'a>(
319 &'a self,
320 range: Range<u32>,
321 buffer: &'a text::BufferSnapshot,
322 ) -> impl 'a + Iterator<Item = DiffHunk> {
323 let start = buffer.anchor_before(Point::new(range.start, 0));
324 let end = buffer.anchor_after(Point::new(range.end, 0));
325 self.hunks_intersecting_range(start..end, buffer)
326 }
327
328 pub fn range_to_hunk_range(
329 &self,
330 range: Range<Anchor>,
331 buffer: &text::BufferSnapshot,
332 ) -> (Option<Range<Anchor>>, Option<Range<usize>>) {
333 let first_hunk = self.hunks_intersecting_range(range.clone(), buffer).next();
334 let last_hunk = self.hunks_intersecting_range_rev(range, buffer).next();
335 let range = first_hunk
336 .as_ref()
337 .zip(last_hunk.as_ref())
338 .map(|(first, last)| first.buffer_range.start..last.buffer_range.end);
339 let base_text_range = first_hunk
340 .zip(last_hunk)
341 .map(|(first, last)| first.diff_base_byte_range.start..last.diff_base_byte_range.end);
342 (range, base_text_range)
343 }
344
345 pub fn base_text(&self) -> &language::BufferSnapshot {
346 &self.inner.base_text
347 }
348
349 /// If this function returns `true`, the base texts are equal. If this
350 /// function returns `false`, they might be equal, but might not. This
351 /// result is used to avoid recalculating diffs in situations where we know
352 /// nothing has changed.
353 pub fn base_texts_definitely_eq(&self, other: &Self) -> bool {
354 if self.inner.base_text_exists != other.inner.base_text_exists {
355 return false;
356 }
357 let left = &self.inner.base_text;
358 let right = &other.inner.base_text;
359 let (old_id, old_version, old_empty) = (left.remote_id(), left.version(), left.is_empty());
360 let (new_id, new_version, new_empty) =
361 (right.remote_id(), right.version(), right.is_empty());
362 (new_id == old_id && new_version == old_version) || (new_empty && old_empty)
363 }
364
365 /// Returns the last hunk whose start is less than or equal to the given position.
366 fn hunk_before_base_text_offset<'a>(
367 &self,
368 target: usize,
369 cursor: &mut sum_tree::Cursor<'a, '_, InternalDiffHunk, DiffHunkSummary>,
370 ) -> Option<&'a InternalDiffHunk> {
371 cursor.seek_forward(&target, Bias::Left);
372 if cursor
373 .item()
374 .is_none_or(|hunk| target < hunk.diff_base_byte_range.start)
375 {
376 cursor.prev();
377 }
378 cursor
379 .item()
380 .filter(|hunk| target >= hunk.diff_base_byte_range.start)
381 }
382
383 fn hunk_before_buffer_anchor<'a>(
384 &self,
385 target: Anchor,
386 cursor: &mut sum_tree::Cursor<'a, '_, InternalDiffHunk, DiffHunkSummary>,
387 buffer: &text::BufferSnapshot,
388 ) -> Option<&'a InternalDiffHunk> {
389 cursor.seek_forward(&target, Bias::Left);
390 if cursor
391 .item()
392 .is_none_or(|hunk| target.cmp(&hunk.buffer_range.start, buffer).is_lt())
393 {
394 cursor.prev();
395 }
396 cursor
397 .item()
398 .filter(|hunk| target.cmp(&hunk.buffer_range.start, buffer).is_ge())
399 }
400
401 /// Returns a patch mapping the provided main buffer snapshot to the base text of this diff.
402 ///
403 /// The returned patch is guaranteed to be accurate for all main buffer points in the provided range,
404 /// but not necessarily for points outside that range.
405 pub fn patch_for_buffer_range<'a>(
406 &'a self,
407 range: RangeInclusive<Point>,
408 buffer: &'a text::BufferSnapshot,
409 ) -> Patch<Point> {
410 if !self.inner.base_text_exists {
411 return Patch::new(vec![Edit {
412 old: Point::zero()..buffer.max_point(),
413 new: Point::zero()..Point::zero(),
414 }]);
415 }
416
417 let mut edits_since_diff = Patch::new(
418 buffer
419 .edits_since::<Point>(&self.inner.buffer_snapshot.version)
420 .collect::<Vec<_>>(),
421 );
422 edits_since_diff.invert();
423
424 let mut start_point = edits_since_diff.old_to_new(*range.start());
425 if let Some(first_edit) = edits_since_diff.edits().first() {
426 start_point = start_point.min(first_edit.new.start);
427 }
428
429 let original_snapshot = self.original_buffer_snapshot();
430 let base_text = self.base_text();
431
432 let mut cursor = self.inner.hunks.cursor(original_snapshot);
433 self.hunk_before_buffer_anchor(
434 original_snapshot.anchor_before(start_point),
435 &mut cursor,
436 original_snapshot,
437 );
438 if cursor.item().is_none() {
439 cursor.next();
440 }
441
442 let mut prefix_edit = cursor.prev_item().map(|prev_hunk| Edit {
443 old: Point::zero()..prev_hunk.buffer_range.end.to_point(original_snapshot),
444 new: Point::zero()..prev_hunk.diff_base_byte_range.end.to_point(base_text),
445 });
446
447 let mut range_end = edits_since_diff.old_to_new(*range.end());
448 if let Some(last_edit) = edits_since_diff.edits().last() {
449 range_end = range_end.max(last_edit.new.end);
450 }
451 let range_end = original_snapshot.anchor_before(range_end);
452
453 let hunk_iter = std::iter::from_fn(move || {
454 if let Some(edit) = prefix_edit.take() {
455 return Some(edit);
456 }
457 let hunk = cursor.item()?;
458 if hunk
459 .buffer_range
460 .start
461 .cmp(&range_end, original_snapshot)
462 .is_gt()
463 {
464 return None;
465 }
466 let edit = Edit {
467 old: hunk.buffer_range.to_point(original_snapshot),
468 new: hunk.diff_base_byte_range.to_point(base_text),
469 };
470 cursor.next();
471 Some(edit)
472 });
473
474 edits_since_diff.compose(hunk_iter)
475 }
476
477 #[cfg(test)]
478 pub(crate) fn patch_for_buffer_range_naive<'a>(
479 &'a self,
480 buffer: &'a text::BufferSnapshot,
481 ) -> Patch<Point> {
482 let original_snapshot = self.original_buffer_snapshot();
483
484 let edits_since: Vec<Edit<Point>> = buffer
485 .edits_since::<Point>(original_snapshot.version())
486 .collect();
487 let mut inverted_edits_since = Patch::new(edits_since);
488 inverted_edits_since.invert();
489
490 inverted_edits_since.compose(
491 self.inner
492 .hunks
493 .iter()
494 .map(|hunk| {
495 let old_start = hunk.buffer_range.start.to_point(original_snapshot);
496 let old_end = hunk.buffer_range.end.to_point(original_snapshot);
497 let new_start = self
498 .base_text()
499 .offset_to_point(hunk.diff_base_byte_range.start);
500 let new_end = self
501 .base_text()
502 .offset_to_point(hunk.diff_base_byte_range.end);
503 Edit {
504 old: old_start..old_end,
505 new: new_start..new_end,
506 }
507 })
508 .chain(
509 if !self.inner.base_text_exists && self.inner.hunks.is_empty() {
510 Some(Edit {
511 old: Point::zero()..original_snapshot.max_point(),
512 new: Point::zero()..Point::zero(),
513 })
514 } else {
515 None
516 },
517 ),
518 )
519 }
520
521 /// Returns a patch mapping the base text of this diff to the provided main buffer snapshot.
522 ///
523 /// The returned patch is guaranteed to be accurate for all base text points in the provided range,
524 /// but not necessarily for points outside that range.
525 pub fn patch_for_base_text_range<'a>(
526 &'a self,
527 range: RangeInclusive<Point>,
528 buffer: &'a text::BufferSnapshot,
529 ) -> Patch<Point> {
530 if !self.inner.base_text_exists {
531 return Patch::new(vec![Edit {
532 old: Point::zero()..Point::zero(),
533 new: Point::zero()..buffer.max_point(),
534 }]);
535 }
536
537 let edits_since_diff = buffer
538 .edits_since::<Point>(&self.inner.buffer_snapshot.version)
539 .collect::<Vec<_>>();
540
541 let mut hunk_patch = Vec::new();
542 let mut cursor = self.inner.hunks.cursor(self.original_buffer_snapshot());
543 let hunk_before = self
544 .hunk_before_base_text_offset(range.start().to_offset(self.base_text()), &mut cursor);
545
546 if let Some(hunk) = hunk_before
547 && let Some(first_edit) = edits_since_diff.first()
548 && hunk
549 .buffer_range
550 .start
551 .to_point(self.original_buffer_snapshot())
552 > first_edit.old.start
553 {
554 cursor.reset();
555 self.hunk_before_buffer_anchor(
556 self.original_buffer_snapshot()
557 .anchor_before(first_edit.old.start),
558 &mut cursor,
559 self.original_buffer_snapshot(),
560 );
561 }
562 if cursor.item().is_none() {
563 cursor.next();
564 }
565 if let Some(prev_hunk) = cursor.prev_item() {
566 hunk_patch.push(Edit {
567 old: Point::zero()
568 ..prev_hunk
569 .diff_base_byte_range
570 .end
571 .to_point(self.base_text()),
572 new: Point::zero()
573 ..prev_hunk
574 .buffer_range
575 .end
576 .to_point(self.original_buffer_snapshot()),
577 })
578 }
579 let range_end = range.end().to_offset(self.base_text());
580 while let Some(hunk) = cursor.item()
581 && (hunk.diff_base_byte_range.start <= range_end
582 || edits_since_diff.last().is_some_and(|last_edit| {
583 hunk.buffer_range
584 .start
585 .to_point(self.original_buffer_snapshot())
586 <= last_edit.old.end
587 }))
588 {
589 hunk_patch.push(Edit {
590 old: hunk.diff_base_byte_range.to_point(self.base_text()),
591 new: hunk.buffer_range.to_point(self.original_buffer_snapshot()),
592 });
593 cursor.next();
594 }
595
596 Patch::new(hunk_patch).compose(edits_since_diff)
597 }
598
599 #[cfg(test)]
600 pub(crate) fn patch_for_base_text_range_naive<'a>(
601 &'a self,
602 buffer: &'a text::BufferSnapshot,
603 ) -> Patch<Point> {
604 let original_snapshot = self.original_buffer_snapshot();
605
606 let mut hunk_edits: Vec<Edit<Point>> = Vec::new();
607 for hunk in self.inner.hunks.iter() {
608 let old_start = self
609 .base_text()
610 .offset_to_point(hunk.diff_base_byte_range.start);
611 let old_end = self
612 .base_text()
613 .offset_to_point(hunk.diff_base_byte_range.end);
614 let new_start = hunk.buffer_range.start.to_point(original_snapshot);
615 let new_end = hunk.buffer_range.end.to_point(original_snapshot);
616 hunk_edits.push(Edit {
617 old: old_start..old_end,
618 new: new_start..new_end,
619 });
620 }
621 if !self.inner.base_text_exists && hunk_edits.is_empty() {
622 hunk_edits.push(Edit {
623 old: Point::zero()..Point::zero(),
624 new: Point::zero()..original_snapshot.max_point(),
625 })
626 }
627 let hunk_patch = Patch::new(hunk_edits);
628
629 hunk_patch.compose(buffer.edits_since::<Point>(original_snapshot.version()))
630 }
631
632 pub fn buffer_point_to_base_text_range(
633 &self,
634 point: Point,
635 buffer: &text::BufferSnapshot,
636 ) -> Range<Point> {
637 let patch = self.patch_for_buffer_range(point..=point, buffer);
638 let edit = patch.edit_for_old_position(point);
639 edit.new
640 }
641
642 pub fn base_text_point_to_buffer_range(
643 &self,
644 point: Point,
645 buffer: &text::BufferSnapshot,
646 ) -> Range<Point> {
647 let patch = self.patch_for_base_text_range(point..=point, buffer);
648 let edit = patch.edit_for_old_position(point);
649 edit.new
650 }
651
652 pub fn buffer_point_to_base_text_point(
653 &self,
654 point: Point,
655 buffer: &text::BufferSnapshot,
656 ) -> Point {
657 let patch = self.patch_for_buffer_range(point..=point, buffer);
658 let edit = patch.edit_for_old_position(point);
659 if point == edit.old.end {
660 edit.new.end
661 } else {
662 edit.new.start
663 }
664 }
665
666 pub fn base_text_point_to_buffer_point(
667 &self,
668 point: Point,
669 buffer: &text::BufferSnapshot,
670 ) -> Point {
671 let patch = self.patch_for_base_text_range(point..=point, buffer);
672 let edit = patch.edit_for_old_position(point);
673 if point == edit.old.end {
674 edit.new.end
675 } else {
676 edit.new.start
677 }
678 }
679}
680
681impl BufferDiffInner<Entity<language::Buffer>> {
682 /// Returns the new index text and new pending hunks.
683 fn stage_or_unstage_hunks_impl(
684 &mut self,
685 unstaged_diff: &Self,
686 stage: bool,
687 hunks: &[DiffHunk],
688 buffer: &text::BufferSnapshot,
689 file_exists: bool,
690 cx: &mut Context<BufferDiff>,
691 ) -> Option<Rope> {
692 let head_text = self
693 .base_text_exists
694 .then(|| self.base_text.read(cx).as_rope().clone());
695 let index_text = unstaged_diff
696 .base_text_exists
697 .then(|| unstaged_diff.base_text.read(cx).as_rope().clone());
698
699 // If the file doesn't exist in either HEAD or the index, then the
700 // entire file must be either created or deleted in the index.
701 let (index_text, head_text) = match (index_text, head_text) {
702 (Some(index_text), Some(head_text)) if file_exists || !stage => (index_text, head_text),
703 (index_text, head_text) => {
704 let (new_index_text, new_status) = if stage {
705 log::debug!("stage all");
706 (
707 file_exists.then(|| buffer.as_rope().clone()),
708 DiffHunkSecondaryStatus::SecondaryHunkRemovalPending,
709 )
710 } else {
711 log::debug!("unstage all");
712 (
713 head_text,
714 DiffHunkSecondaryStatus::SecondaryHunkAdditionPending,
715 )
716 };
717
718 let hunk = PendingHunk {
719 buffer_range: Anchor::min_max_range_for_buffer(buffer.remote_id()),
720 diff_base_byte_range: 0..index_text.map_or(0, |rope| rope.len()),
721 buffer_version: buffer.version().clone(),
722 new_status,
723 };
724 self.pending_hunks = SumTree::from_item(hunk, buffer);
725 return new_index_text;
726 }
727 };
728
729 let mut pending_hunks = SumTree::new(buffer);
730 let mut old_pending_hunks = self.pending_hunks.cursor::<DiffHunkSummary>(buffer);
731
732 // first, merge new hunks into pending_hunks
733 for DiffHunk {
734 buffer_range,
735 diff_base_byte_range,
736 secondary_status,
737 ..
738 } in hunks.iter().cloned()
739 {
740 let preceding_pending_hunks = old_pending_hunks.slice(&buffer_range.start, Bias::Left);
741 pending_hunks.append(preceding_pending_hunks, buffer);
742
743 // Skip all overlapping or adjacent old pending hunks
744 while old_pending_hunks.item().is_some_and(|old_hunk| {
745 old_hunk
746 .buffer_range
747 .start
748 .cmp(&buffer_range.end, buffer)
749 .is_le()
750 }) {
751 old_pending_hunks.next();
752 }
753
754 if (stage && secondary_status == DiffHunkSecondaryStatus::NoSecondaryHunk)
755 || (!stage && secondary_status == DiffHunkSecondaryStatus::HasSecondaryHunk)
756 {
757 continue;
758 }
759
760 pending_hunks.push(
761 PendingHunk {
762 buffer_range,
763 diff_base_byte_range,
764 buffer_version: buffer.version().clone(),
765 new_status: if stage {
766 DiffHunkSecondaryStatus::SecondaryHunkRemovalPending
767 } else {
768 DiffHunkSecondaryStatus::SecondaryHunkAdditionPending
769 },
770 },
771 buffer,
772 );
773 }
774 // append the remainder
775 pending_hunks.append(old_pending_hunks.suffix(), buffer);
776
777 let mut unstaged_hunk_cursor = unstaged_diff.hunks.cursor::<DiffHunkSummary>(buffer);
778 unstaged_hunk_cursor.next();
779
780 // then, iterate over all pending hunks (both new ones and the existing ones) and compute the edits
781 let mut prev_unstaged_hunk_buffer_end = 0;
782 let mut prev_unstaged_hunk_base_text_end = 0;
783 let mut edits = Vec::<(Range<usize>, String)>::new();
784 let mut pending_hunks_iter = pending_hunks.iter().cloned().peekable();
785 while let Some(PendingHunk {
786 buffer_range,
787 diff_base_byte_range,
788 new_status,
789 ..
790 }) = pending_hunks_iter.next()
791 {
792 // Advance unstaged_hunk_cursor to skip unstaged hunks before current hunk
793 let skipped_unstaged = unstaged_hunk_cursor.slice(&buffer_range.start, Bias::Left);
794
795 if let Some(unstaged_hunk) = skipped_unstaged.last() {
796 prev_unstaged_hunk_base_text_end = unstaged_hunk.diff_base_byte_range.end;
797 prev_unstaged_hunk_buffer_end = unstaged_hunk.buffer_range.end.to_offset(buffer);
798 }
799
800 // Find where this hunk is in the index if it doesn't overlap
801 let mut buffer_offset_range = buffer_range.to_offset(buffer);
802 let start_overshoot = buffer_offset_range.start - prev_unstaged_hunk_buffer_end;
803 let mut index_start = prev_unstaged_hunk_base_text_end + start_overshoot;
804
805 loop {
806 // Merge this hunk with any overlapping unstaged hunks.
807 if let Some(unstaged_hunk) = unstaged_hunk_cursor.item() {
808 let unstaged_hunk_offset_range = unstaged_hunk.buffer_range.to_offset(buffer);
809 if unstaged_hunk_offset_range.start <= buffer_offset_range.end {
810 prev_unstaged_hunk_base_text_end = unstaged_hunk.diff_base_byte_range.end;
811 prev_unstaged_hunk_buffer_end = unstaged_hunk_offset_range.end;
812
813 index_start = index_start.min(unstaged_hunk.diff_base_byte_range.start);
814 buffer_offset_range.start = buffer_offset_range
815 .start
816 .min(unstaged_hunk_offset_range.start);
817 buffer_offset_range.end =
818 buffer_offset_range.end.max(unstaged_hunk_offset_range.end);
819
820 unstaged_hunk_cursor.next();
821 continue;
822 }
823 }
824
825 // If any unstaged hunks were merged, then subsequent pending hunks may
826 // now overlap this hunk. Merge them.
827 if let Some(next_pending_hunk) = pending_hunks_iter.peek() {
828 let next_pending_hunk_offset_range =
829 next_pending_hunk.buffer_range.to_offset(buffer);
830 if next_pending_hunk_offset_range.start <= buffer_offset_range.end {
831 buffer_offset_range.end = buffer_offset_range
832 .end
833 .max(next_pending_hunk_offset_range.end);
834 pending_hunks_iter.next();
835 continue;
836 }
837 }
838
839 break;
840 }
841
842 let end_overshoot = buffer_offset_range
843 .end
844 .saturating_sub(prev_unstaged_hunk_buffer_end);
845 let index_end = prev_unstaged_hunk_base_text_end + end_overshoot;
846 let index_byte_range = index_start..index_end;
847
848 let replacement_text = match new_status {
849 DiffHunkSecondaryStatus::SecondaryHunkRemovalPending => {
850 log::debug!("staging hunk {:?}", buffer_offset_range);
851 buffer
852 .text_for_range(buffer_offset_range)
853 .collect::<String>()
854 }
855 DiffHunkSecondaryStatus::SecondaryHunkAdditionPending => {
856 log::debug!("unstaging hunk {:?}", buffer_offset_range);
857 head_text
858 .chunks_in_range(diff_base_byte_range.clone())
859 .collect::<String>()
860 }
861 _ => {
862 debug_assert!(false);
863 continue;
864 }
865 };
866
867 edits.push((index_byte_range, replacement_text));
868 }
869 drop(pending_hunks_iter);
870 drop(old_pending_hunks);
871 self.pending_hunks = pending_hunks;
872
873 #[cfg(debug_assertions)] // invariants: non-overlapping and sorted
874 {
875 for window in edits.windows(2) {
876 let (range_a, range_b) = (&window[0].0, &window[1].0);
877 debug_assert!(range_a.end < range_b.start);
878 }
879 }
880
881 let mut new_index_text = Rope::new();
882 let mut index_cursor = index_text.cursor(0);
883
884 for (old_range, replacement_text) in edits {
885 new_index_text.append(index_cursor.slice(old_range.start));
886 index_cursor.seek_forward(old_range.end);
887 new_index_text.push(&replacement_text);
888 }
889 new_index_text.append(index_cursor.suffix());
890 Some(new_index_text)
891 }
892}
893
894impl BufferDiffInner<language::BufferSnapshot> {
895 fn hunks_intersecting_range<'a>(
896 &'a self,
897 range: Range<Anchor>,
898 buffer: &'a text::BufferSnapshot,
899 secondary: Option<&'a Self>,
900 ) -> impl 'a + Iterator<Item = DiffHunk> {
901 let range = range.to_offset(buffer);
902 let filter = move |summary: &DiffHunkSummary| {
903 let summary_range = summary.buffer_range.to_offset(buffer);
904 let before_start = summary_range.end < range.start;
905 let after_end = summary_range.start > range.end;
906 !before_start && !after_end
907 };
908 self.hunks_intersecting_range_impl(filter, buffer, secondary)
909 }
910
911 fn hunks_intersecting_range_impl<'a>(
912 &'a self,
913 filter: impl 'a + Fn(&DiffHunkSummary) -> bool,
914 buffer: &'a text::BufferSnapshot,
915 secondary: Option<&'a Self>,
916 ) -> impl 'a + Iterator<Item = DiffHunk> {
917 let anchor_iter = self
918 .hunks
919 .filter::<_, DiffHunkSummary>(buffer, filter)
920 .flat_map(move |hunk| {
921 [
922 (
923 &hunk.buffer_range.start,
924 (
925 hunk.buffer_range.start,
926 hunk.diff_base_byte_range.start,
927 hunk,
928 ),
929 ),
930 (
931 &hunk.buffer_range.end,
932 (hunk.buffer_range.end, hunk.diff_base_byte_range.end, hunk),
933 ),
934 ]
935 });
936
937 let mut pending_hunks_cursor = self.pending_hunks.cursor::<DiffHunkSummary>(buffer);
938 pending_hunks_cursor.next();
939
940 let mut secondary_cursor = None;
941 if let Some(secondary) = secondary.as_ref() {
942 let mut cursor = secondary.hunks.cursor::<DiffHunkSummary>(buffer);
943 cursor.next();
944 secondary_cursor = Some(cursor);
945 }
946
947 let max_point = buffer.max_point();
948 let mut summaries = buffer.summaries_for_anchors_with_payload::<Point, _, _>(anchor_iter);
949 iter::from_fn(move || {
950 loop {
951 let (start_point, (start_anchor, start_base, hunk)) = summaries.next()?;
952 let (mut end_point, (mut end_anchor, end_base, _)) = summaries.next()?;
953
954 let base_word_diffs = hunk.base_word_diffs.clone();
955 let buffer_word_diffs = hunk.buffer_word_diffs.clone();
956
957 if !start_anchor.is_valid(buffer) {
958 continue;
959 }
960
961 if end_point.column > 0 && end_point < max_point {
962 end_point.row += 1;
963 end_point.column = 0;
964 end_anchor = buffer.anchor_before(end_point);
965 }
966
967 let mut secondary_status = DiffHunkSecondaryStatus::NoSecondaryHunk;
968
969 let mut has_pending = false;
970 if start_anchor
971 .cmp(&pending_hunks_cursor.start().buffer_range.start, buffer)
972 .is_gt()
973 {
974 pending_hunks_cursor.seek_forward(&start_anchor, Bias::Left);
975 }
976
977 if let Some(pending_hunk) = pending_hunks_cursor.item() {
978 let mut pending_range = pending_hunk.buffer_range.to_point(buffer);
979 if pending_range.end.column > 0 {
980 pending_range.end.row += 1;
981 pending_range.end.column = 0;
982 }
983
984 if pending_range == (start_point..end_point)
985 && !buffer.has_edits_since_in_range(
986 &pending_hunk.buffer_version,
987 start_anchor..end_anchor,
988 )
989 {
990 has_pending = true;
991 secondary_status = pending_hunk.new_status;
992 }
993 }
994
995 if let (Some(secondary_cursor), false) = (secondary_cursor.as_mut(), has_pending) {
996 if start_anchor
997 .cmp(&secondary_cursor.start().buffer_range.start, buffer)
998 .is_gt()
999 {
1000 secondary_cursor.seek_forward(&start_anchor, Bias::Left);
1001 }
1002
1003 if let Some(secondary_hunk) = secondary_cursor.item() {
1004 let mut secondary_range = secondary_hunk.buffer_range.to_point(buffer);
1005 if secondary_range.end.column > 0 {
1006 secondary_range.end.row += 1;
1007 secondary_range.end.column = 0;
1008 }
1009 if secondary_range.is_empty()
1010 && secondary_hunk.diff_base_byte_range.is_empty()
1011 {
1012 // ignore
1013 } else if secondary_range == (start_point..end_point) {
1014 secondary_status = DiffHunkSecondaryStatus::HasSecondaryHunk;
1015 } else if secondary_range.start <= end_point {
1016 secondary_status = DiffHunkSecondaryStatus::OverlapsWithSecondaryHunk;
1017 }
1018 }
1019 }
1020
1021 return Some(DiffHunk {
1022 range: start_point..end_point,
1023 diff_base_byte_range: start_base..end_base,
1024 buffer_range: start_anchor..end_anchor,
1025 base_word_diffs,
1026 buffer_word_diffs,
1027 secondary_status,
1028 });
1029 }
1030 })
1031 }
1032
1033 fn hunks_intersecting_range_rev_impl<'a>(
1034 &'a self,
1035 filter: impl 'a + Fn(&DiffHunkSummary) -> bool,
1036 buffer: &'a text::BufferSnapshot,
1037 ) -> impl 'a + Iterator<Item = DiffHunk> {
1038 let mut cursor = self.hunks.filter::<_, DiffHunkSummary>(buffer, filter);
1039
1040 iter::from_fn(move || {
1041 cursor.prev();
1042
1043 let hunk = cursor.item()?;
1044 let range = hunk.buffer_range.to_point(buffer);
1045
1046 Some(DiffHunk {
1047 range,
1048 diff_base_byte_range: hunk.diff_base_byte_range.clone(),
1049 buffer_range: hunk.buffer_range.clone(),
1050 // The secondary status is not used by callers of this method.
1051 secondary_status: DiffHunkSecondaryStatus::NoSecondaryHunk,
1052 base_word_diffs: hunk.base_word_diffs.clone(),
1053 buffer_word_diffs: hunk.buffer_word_diffs.clone(),
1054 })
1055 })
1056 }
1057}
1058
1059fn build_diff_options(
1060 file: Option<&Arc<dyn File>>,
1061 language: Option<LanguageName>,
1062 language_scope: Option<language::LanguageScope>,
1063 cx: &App,
1064) -> Option<DiffOptions> {
1065 #[cfg(any(test, feature = "test-support"))]
1066 {
1067 if !cx.has_global::<settings::SettingsStore>() {
1068 return Some(DiffOptions {
1069 language_scope,
1070 max_word_diff_line_count: MAX_WORD_DIFF_LINE_COUNT,
1071 ..Default::default()
1072 });
1073 }
1074 }
1075
1076 language_settings(language, file, cx)
1077 .word_diff_enabled
1078 .then_some(DiffOptions {
1079 language_scope,
1080 max_word_diff_line_count: MAX_WORD_DIFF_LINE_COUNT,
1081 ..Default::default()
1082 })
1083}
1084
1085fn compute_hunks(
1086 diff_base: Option<(Arc<str>, Rope)>,
1087 buffer: &text::BufferSnapshot,
1088 diff_options: Option<DiffOptions>,
1089) -> SumTree<InternalDiffHunk> {
1090 let mut tree = SumTree::new(buffer);
1091
1092 if let Some((diff_base, diff_base_rope)) = diff_base {
1093 let buffer_text = buffer.as_rope().to_string();
1094
1095 let mut options = GitOptions::default();
1096 options.context_lines(0);
1097 let patch = GitPatch::from_buffers(
1098 diff_base.as_bytes(),
1099 None,
1100 buffer_text.as_bytes(),
1101 None,
1102 Some(&mut options),
1103 )
1104 .log_err();
1105
1106 // A common case in Zed is that the empty buffer is represented as just a newline,
1107 // but if we just compute a naive diff you get a "preserved" line in the middle,
1108 // which is a bit odd.
1109 if buffer_text == "\n" && diff_base.ends_with("\n") && diff_base.len() > 1 {
1110 tree.push(
1111 InternalDiffHunk {
1112 buffer_range: buffer.anchor_before(0)..buffer.anchor_before(0),
1113 diff_base_byte_range: 0..diff_base.len() - 1,
1114 base_word_diffs: Vec::default(),
1115 buffer_word_diffs: Vec::default(),
1116 },
1117 buffer,
1118 );
1119 return tree;
1120 }
1121
1122 if let Some(patch) = patch {
1123 let mut divergence = 0;
1124 for hunk_index in 0..patch.num_hunks() {
1125 let hunk = process_patch_hunk(
1126 &patch,
1127 hunk_index,
1128 &diff_base_rope,
1129 buffer,
1130 &mut divergence,
1131 diff_options.as_ref(),
1132 );
1133 tree.push(hunk, buffer);
1134 }
1135 }
1136 } else {
1137 tree.push(
1138 InternalDiffHunk {
1139 buffer_range: Anchor::min_max_range_for_buffer(buffer.remote_id()),
1140 diff_base_byte_range: 0..0,
1141 base_word_diffs: Vec::default(),
1142 buffer_word_diffs: Vec::default(),
1143 },
1144 buffer,
1145 );
1146 }
1147
1148 tree
1149}
1150
1151fn compare_hunks(
1152 new_hunks: &SumTree<InternalDiffHunk>,
1153 old_hunks: &SumTree<InternalDiffHunk>,
1154 old_snapshot: &text::BufferSnapshot,
1155 new_snapshot: &text::BufferSnapshot,
1156 old_base_text: &text::BufferSnapshot,
1157 new_base_text: &text::BufferSnapshot,
1158) -> DiffChanged {
1159 let mut new_cursor = new_hunks.cursor::<()>(new_snapshot);
1160 let mut old_cursor = old_hunks.cursor::<()>(new_snapshot);
1161 old_cursor.next();
1162 new_cursor.next();
1163 let mut start = None;
1164 let mut end = None;
1165 let mut base_text_start: Option<Anchor> = None;
1166 let mut base_text_end: Option<Anchor> = None;
1167
1168 let mut last_unchanged_new_hunk_end: Option<text::Anchor> = None;
1169 let mut has_changes = false;
1170 let mut extended_end_candidate: Option<text::Anchor> = None;
1171
1172 loop {
1173 match (new_cursor.item(), old_cursor.item()) {
1174 (Some(new_hunk), Some(old_hunk)) => {
1175 match new_hunk
1176 .buffer_range
1177 .start
1178 .cmp(&old_hunk.buffer_range.start, new_snapshot)
1179 {
1180 Ordering::Less => {
1181 has_changes = true;
1182 extended_end_candidate = None;
1183 start.get_or_insert(new_hunk.buffer_range.start);
1184 base_text_start.get_or_insert(
1185 new_base_text.anchor_before(new_hunk.diff_base_byte_range.start),
1186 );
1187 end.replace(new_hunk.buffer_range.end);
1188 let new_diff_range_end =
1189 new_base_text.anchor_after(new_hunk.diff_base_byte_range.end);
1190 if base_text_end.is_none_or(|base_text_end| {
1191 new_diff_range_end
1192 .cmp(&base_text_end, &new_base_text)
1193 .is_gt()
1194 }) {
1195 base_text_end = Some(new_diff_range_end)
1196 }
1197 new_cursor.next();
1198 }
1199 Ordering::Equal => {
1200 if new_hunk != old_hunk {
1201 has_changes = true;
1202 extended_end_candidate = None;
1203 start.get_or_insert(new_hunk.buffer_range.start);
1204 base_text_start.get_or_insert(
1205 new_base_text.anchor_before(new_hunk.diff_base_byte_range.start),
1206 );
1207 if old_hunk
1208 .buffer_range
1209 .end
1210 .cmp(&new_hunk.buffer_range.end, new_snapshot)
1211 .is_ge()
1212 {
1213 end.replace(old_hunk.buffer_range.end);
1214 } else {
1215 end.replace(new_hunk.buffer_range.end);
1216 }
1217
1218 let old_hunk_diff_base_range_end =
1219 old_base_text.anchor_after(old_hunk.diff_base_byte_range.end);
1220 let new_hunk_diff_base_range_end =
1221 new_base_text.anchor_after(new_hunk.diff_base_byte_range.end);
1222
1223 base_text_end.replace(
1224 *old_hunk_diff_base_range_end
1225 .max(&new_hunk_diff_base_range_end, new_base_text),
1226 );
1227 } else {
1228 if !has_changes {
1229 last_unchanged_new_hunk_end = Some(new_hunk.buffer_range.end);
1230 } else if extended_end_candidate.is_none() {
1231 extended_end_candidate = Some(new_hunk.buffer_range.start);
1232 }
1233 }
1234
1235 new_cursor.next();
1236 old_cursor.next();
1237 }
1238 Ordering::Greater => {
1239 has_changes = true;
1240 extended_end_candidate = None;
1241 start.get_or_insert(old_hunk.buffer_range.start);
1242 base_text_start.get_or_insert(
1243 old_base_text.anchor_after(old_hunk.diff_base_byte_range.start),
1244 );
1245 end.replace(old_hunk.buffer_range.end);
1246 let old_diff_range_end =
1247 old_base_text.anchor_after(old_hunk.diff_base_byte_range.end);
1248 if base_text_end.is_none_or(|base_text_end| {
1249 old_diff_range_end
1250 .cmp(&base_text_end, new_base_text)
1251 .is_gt()
1252 }) {
1253 base_text_end = Some(old_diff_range_end)
1254 }
1255 old_cursor.next();
1256 }
1257 }
1258 }
1259 (Some(new_hunk), None) => {
1260 has_changes = true;
1261 extended_end_candidate = None;
1262 start.get_or_insert(new_hunk.buffer_range.start);
1263 base_text_start
1264 .get_or_insert(new_base_text.anchor_after(new_hunk.diff_base_byte_range.start));
1265 if end.is_none_or(|end| end.cmp(&new_hunk.buffer_range.end, &new_snapshot).is_le())
1266 {
1267 end.replace(new_hunk.buffer_range.end);
1268 }
1269 let new_base_text_end =
1270 new_base_text.anchor_after(new_hunk.diff_base_byte_range.end);
1271 if base_text_end.is_none_or(|base_text_end| {
1272 new_base_text_end.cmp(&base_text_end, new_base_text).is_gt()
1273 }) {
1274 base_text_end = Some(new_base_text_end)
1275 }
1276 new_cursor.next();
1277 }
1278 (None, Some(old_hunk)) => {
1279 has_changes = true;
1280 extended_end_candidate = None;
1281 start.get_or_insert(old_hunk.buffer_range.start);
1282 base_text_start
1283 .get_or_insert(old_base_text.anchor_after(old_hunk.diff_base_byte_range.start));
1284 if end.is_none_or(|end| end.cmp(&old_hunk.buffer_range.end, &new_snapshot).is_le())
1285 {
1286 end.replace(old_hunk.buffer_range.end);
1287 }
1288 let old_base_text_end =
1289 old_base_text.anchor_after(old_hunk.diff_base_byte_range.end);
1290 if base_text_end.is_none_or(|base_text_end| {
1291 old_base_text_end.cmp(&base_text_end, new_base_text).is_gt()
1292 }) {
1293 base_text_end = Some(old_base_text_end);
1294 }
1295 old_cursor.next();
1296 }
1297 (None, None) => break,
1298 }
1299 }
1300
1301 let changed_range = start.zip(end).map(|(start, end)| start..end);
1302 let base_text_changed_range = base_text_start
1303 .zip(base_text_end)
1304 .map(|(start, end)| (start..end).to_offset(new_base_text));
1305
1306 let extended_range = if has_changes && let Some(changed_range) = changed_range.clone() {
1307 let extended_start = *last_unchanged_new_hunk_end
1308 .unwrap_or(text::Anchor::min_for_buffer(new_snapshot.remote_id()))
1309 .min(&changed_range.start, new_snapshot);
1310 let extended_start = new_snapshot
1311 .anchored_edits_since_in_range::<usize>(
1312 &old_snapshot.version(),
1313 extended_start..changed_range.start,
1314 )
1315 .map(|(_, anchors)| anchors.start)
1316 .min_by(|a, b| a.cmp(b, new_snapshot))
1317 .unwrap_or(changed_range.start);
1318
1319 let extended_end = *extended_end_candidate
1320 .unwrap_or(text::Anchor::max_for_buffer(new_snapshot.remote_id()))
1321 .max(&changed_range.end, new_snapshot);
1322 let extended_end = new_snapshot
1323 .anchored_edits_since_in_range::<usize>(
1324 &old_snapshot.version(),
1325 changed_range.end..extended_end,
1326 )
1327 .map(|(_, anchors)| anchors.end)
1328 .max_by(|a, b| a.cmp(b, new_snapshot))
1329 .unwrap_or(changed_range.end);
1330
1331 Some(extended_start..extended_end)
1332 } else {
1333 None
1334 };
1335
1336 DiffChanged {
1337 changed_range,
1338 base_text_changed_range,
1339 extended_range,
1340 }
1341}
1342
1343fn process_patch_hunk(
1344 patch: &GitPatch<'_>,
1345 hunk_index: usize,
1346 diff_base: &Rope,
1347 buffer: &text::BufferSnapshot,
1348 buffer_row_divergence: &mut i64,
1349 diff_options: Option<&DiffOptions>,
1350) -> InternalDiffHunk {
1351 let line_item_count = patch.num_lines_in_hunk(hunk_index).unwrap();
1352 assert!(line_item_count > 0);
1353
1354 let mut first_deletion_buffer_row: Option<u32> = None;
1355 let mut buffer_row_range: Option<Range<u32>> = None;
1356 let mut diff_base_byte_range: Option<Range<usize>> = None;
1357 let mut first_addition_old_row: Option<u32> = None;
1358
1359 for line_index in 0..line_item_count {
1360 let line = patch.line_in_hunk(hunk_index, line_index).unwrap();
1361 let kind = line.origin_value();
1362 let content_offset = line.content_offset() as isize;
1363 let content_len = line.content().len() as isize;
1364 match kind {
1365 GitDiffLineType::Addition => {
1366 if first_addition_old_row.is_none() {
1367 first_addition_old_row = Some(
1368 (line.new_lineno().unwrap() as i64 - *buffer_row_divergence - 1) as u32,
1369 );
1370 }
1371 *buffer_row_divergence += 1;
1372 let row = line.new_lineno().unwrap().saturating_sub(1);
1373
1374 match &mut buffer_row_range {
1375 Some(Range { end, .. }) => *end = row + 1,
1376 None => buffer_row_range = Some(row..row + 1),
1377 }
1378 }
1379 GitDiffLineType::Deletion => {
1380 let end = content_offset + content_len;
1381
1382 match &mut diff_base_byte_range {
1383 Some(head_byte_range) => head_byte_range.end = end as usize,
1384 None => diff_base_byte_range = Some(content_offset as usize..end as usize),
1385 }
1386
1387 if first_deletion_buffer_row.is_none() {
1388 let old_row = line.old_lineno().unwrap().saturating_sub(1);
1389 let row = old_row as i64 + *buffer_row_divergence;
1390 first_deletion_buffer_row = Some(row as u32);
1391 }
1392
1393 *buffer_row_divergence -= 1;
1394 }
1395 _ => {}
1396 }
1397 }
1398
1399 let buffer_row_range = buffer_row_range.unwrap_or_else(|| {
1400 // Pure deletion hunk without addition.
1401 let row = first_deletion_buffer_row.unwrap();
1402 row..row
1403 });
1404 let diff_base_byte_range = diff_base_byte_range.unwrap_or_else(|| {
1405 // Pure addition hunk without deletion.
1406 let row = first_addition_old_row.unwrap();
1407 let offset = diff_base.point_to_offset(Point::new(row, 0));
1408 offset..offset
1409 });
1410
1411 let start = Point::new(buffer_row_range.start, 0);
1412 let end = Point::new(buffer_row_range.end, 0);
1413 let buffer_range = buffer.anchor_before(start)..buffer.anchor_before(end);
1414
1415 let base_line_count = line_item_count.saturating_sub(buffer_row_range.len());
1416
1417 let (base_word_diffs, buffer_word_diffs) = if let Some(diff_options) = diff_options
1418 && !buffer_row_range.is_empty()
1419 && base_line_count == buffer_row_range.len()
1420 && diff_options.max_word_diff_line_count >= base_line_count
1421 {
1422 let base_text: String = diff_base
1423 .chunks_in_range(diff_base_byte_range.clone())
1424 .collect();
1425
1426 let buffer_text: String = buffer.text_for_range(buffer_range.clone()).collect();
1427
1428 let (base_word_diffs, buffer_word_diffs_relative) = word_diff_ranges(
1429 &base_text,
1430 &buffer_text,
1431 DiffOptions {
1432 language_scope: diff_options.language_scope.clone(),
1433 ..*diff_options
1434 },
1435 );
1436
1437 let buffer_start_offset = buffer_range.start.to_offset(buffer);
1438 let buffer_word_diffs = buffer_word_diffs_relative
1439 .into_iter()
1440 .map(|range| {
1441 let start = buffer.anchor_after(buffer_start_offset + range.start);
1442 let end = buffer.anchor_after(buffer_start_offset + range.end);
1443 start..end
1444 })
1445 .collect();
1446
1447 (base_word_diffs, buffer_word_diffs)
1448 } else {
1449 (Vec::default(), Vec::default())
1450 };
1451
1452 InternalDiffHunk {
1453 buffer_range,
1454 diff_base_byte_range,
1455 base_word_diffs,
1456 buffer_word_diffs,
1457 }
1458}
1459
1460impl std::fmt::Debug for BufferDiff {
1461 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1462 f.debug_struct("BufferChangeSet")
1463 .field("buffer_id", &self.buffer_id)
1464 .finish()
1465 }
1466}
1467
1468#[derive(Clone, Debug, Default)]
1469pub struct DiffChanged {
1470 pub changed_range: Option<Range<text::Anchor>>,
1471 pub base_text_changed_range: Option<Range<usize>>,
1472 pub extended_range: Option<Range<text::Anchor>>,
1473}
1474
1475#[derive(Clone, Debug)]
1476pub enum BufferDiffEvent {
1477 DiffChanged(DiffChanged),
1478 LanguageChanged,
1479 HunksStagedOrUnstaged(Option<Rope>),
1480}
1481
1482impl EventEmitter<BufferDiffEvent> for BufferDiff {}
1483
1484impl BufferDiff {
1485 pub fn new(buffer: &text::BufferSnapshot, cx: &mut App) -> Self {
1486 let base_text = cx.new(|cx| {
1487 let mut buffer = language::Buffer::local("", cx);
1488 buffer.set_capability(Capability::ReadOnly, cx);
1489 buffer
1490 });
1491
1492 BufferDiff {
1493 buffer_id: buffer.remote_id(),
1494 inner: BufferDiffInner {
1495 base_text,
1496 hunks: SumTree::new(buffer),
1497 pending_hunks: SumTree::new(buffer),
1498 base_text_exists: false,
1499 buffer_snapshot: buffer.clone(),
1500 },
1501 secondary_diff: None,
1502 }
1503 }
1504
1505 pub fn new_unchanged(buffer: &text::BufferSnapshot, cx: &mut Context<Self>) -> Self {
1506 let base_text = buffer.text();
1507 let base_text = cx.new(|cx| {
1508 let mut buffer = language::Buffer::local(base_text, cx);
1509 buffer.set_capability(Capability::ReadOnly, cx);
1510 buffer
1511 });
1512
1513 BufferDiff {
1514 buffer_id: buffer.remote_id(),
1515 inner: BufferDiffInner {
1516 base_text,
1517 hunks: SumTree::new(buffer),
1518 pending_hunks: SumTree::new(buffer),
1519 base_text_exists: true,
1520 buffer_snapshot: buffer.clone(),
1521 },
1522 secondary_diff: None,
1523 }
1524 }
1525
1526 #[cfg(any(test, feature = "test-support"))]
1527 pub fn new_with_base_text(
1528 base_text: &str,
1529 buffer: &text::BufferSnapshot,
1530 cx: &mut Context<Self>,
1531 ) -> Self {
1532 let mut this = BufferDiff::new(&buffer, cx);
1533 let mut base_text = base_text.to_owned();
1534 text::LineEnding::normalize(&mut base_text);
1535 let inner = cx.foreground_executor().block_on(this.update_diff(
1536 buffer.clone(),
1537 Some(Arc::from(base_text)),
1538 Some(false),
1539 None,
1540 cx,
1541 ));
1542 this.set_snapshot(inner, &buffer, cx).detach();
1543 this
1544 }
1545
1546 pub fn set_secondary_diff(&mut self, diff: Entity<BufferDiff>) {
1547 self.secondary_diff = Some(diff);
1548 }
1549
1550 pub fn secondary_diff(&self) -> Option<Entity<BufferDiff>> {
1551 self.secondary_diff.clone()
1552 }
1553
1554 pub fn clear_pending_hunks(&mut self, cx: &mut Context<Self>) {
1555 if self.secondary_diff.is_some() {
1556 self.inner.pending_hunks = SumTree::from_summary(DiffHunkSummary {
1557 buffer_range: Anchor::min_min_range_for_buffer(self.buffer_id),
1558 diff_base_byte_range: 0..0,
1559 });
1560 let changed_range = Some(Anchor::min_max_range_for_buffer(self.buffer_id));
1561 let base_text_range = Some(0..self.base_text(cx).len());
1562 cx.emit(BufferDiffEvent::DiffChanged(DiffChanged {
1563 changed_range: changed_range.clone(),
1564 base_text_changed_range: base_text_range,
1565 extended_range: changed_range,
1566 }));
1567 }
1568 }
1569
1570 pub fn stage_or_unstage_hunks(
1571 &mut self,
1572 stage: bool,
1573 hunks: &[DiffHunk],
1574 buffer: &text::BufferSnapshot,
1575 file_exists: bool,
1576 cx: &mut Context<Self>,
1577 ) -> Option<Rope> {
1578 let new_index_text = self
1579 .secondary_diff
1580 .as_ref()?
1581 .update(cx, |secondary_diff, cx| {
1582 self.inner.stage_or_unstage_hunks_impl(
1583 &secondary_diff.inner,
1584 stage,
1585 hunks,
1586 buffer,
1587 file_exists,
1588 cx,
1589 )
1590 });
1591
1592 cx.emit(BufferDiffEvent::HunksStagedOrUnstaged(
1593 new_index_text.clone(),
1594 ));
1595 if let Some((first, last)) = hunks.first().zip(hunks.last()) {
1596 let changed_range = Some(first.buffer_range.start..last.buffer_range.end);
1597 let base_text_changed_range =
1598 Some(first.diff_base_byte_range.start..last.diff_base_byte_range.end);
1599 cx.emit(BufferDiffEvent::DiffChanged(DiffChanged {
1600 changed_range: changed_range.clone(),
1601 base_text_changed_range,
1602 extended_range: changed_range,
1603 }));
1604 }
1605 new_index_text
1606 }
1607
1608 pub fn stage_or_unstage_all_hunks(
1609 &mut self,
1610 stage: bool,
1611 buffer: &text::BufferSnapshot,
1612 file_exists: bool,
1613 cx: &mut Context<Self>,
1614 ) {
1615 let hunks = self
1616 .snapshot(cx)
1617 .hunks_intersecting_range(Anchor::MIN..Anchor::MAX, buffer)
1618 .collect::<Vec<_>>();
1619 let Some(secondary) = self.secondary_diff.clone() else {
1620 return;
1621 };
1622 let secondary = secondary.read(cx).inner.clone();
1623 self.inner
1624 .stage_or_unstage_hunks_impl(&secondary, stage, &hunks, buffer, file_exists, cx);
1625 if let Some((first, last)) = hunks.first().zip(hunks.last()) {
1626 let changed_range = Some(first.buffer_range.start..last.buffer_range.end);
1627 let base_text_changed_range =
1628 Some(first.diff_base_byte_range.start..last.diff_base_byte_range.end);
1629 cx.emit(BufferDiffEvent::DiffChanged(DiffChanged {
1630 changed_range: changed_range.clone(),
1631 base_text_changed_range,
1632 extended_range: changed_range,
1633 }));
1634 }
1635 }
1636
1637 pub fn update_diff(
1638 &self,
1639 buffer: text::BufferSnapshot,
1640 base_text: Option<Arc<str>>,
1641 base_text_change: Option<bool>,
1642 language: Option<Arc<Language>>,
1643 cx: &App,
1644 ) -> Task<BufferDiffUpdate> {
1645 let prev_base_text = self.base_text(cx).as_rope().clone();
1646 let base_text_changed = base_text_change.is_some();
1647 let compute_base_text_edits = base_text_change == Some(true);
1648 let diff_options = build_diff_options(
1649 None,
1650 language.as_ref().map(|l| l.name()),
1651 language.as_ref().map(|l| l.default_scope()),
1652 cx,
1653 );
1654 let buffer_snapshot = buffer.clone();
1655
1656 let base_text_diff_task = if base_text_changed && compute_base_text_edits {
1657 base_text
1658 .as_ref()
1659 .map(|new_text| self.inner.base_text.read(cx).diff(new_text.clone(), cx))
1660 } else {
1661 None
1662 };
1663
1664 let hunk_task = cx.background_executor().spawn({
1665 let buffer_snapshot = buffer_snapshot.clone();
1666 async move {
1667 let base_text_rope = if let Some(base_text) = &base_text {
1668 if base_text_changed {
1669 Rope::from(base_text.as_ref())
1670 } else {
1671 prev_base_text
1672 }
1673 } else {
1674 Rope::new()
1675 };
1676 let base_text_exists = base_text.is_some();
1677 let hunks = compute_hunks(
1678 base_text
1679 .clone()
1680 .map(|base_text| (base_text, base_text_rope.clone())),
1681 &buffer,
1682 diff_options,
1683 );
1684 let base_text = base_text.unwrap_or_default();
1685 BufferDiffInner {
1686 base_text,
1687 hunks,
1688 base_text_exists,
1689 pending_hunks: SumTree::new(&buffer),
1690 buffer_snapshot,
1691 }
1692 }
1693 });
1694
1695 cx.background_executor().spawn(async move {
1696 let (inner, base_text_edits) = match base_text_diff_task {
1697 Some(diff_task) => {
1698 let (inner, diff) = futures::join!(hunk_task, diff_task);
1699 (inner, Some(diff))
1700 }
1701 None => (hunk_task.await, None),
1702 };
1703
1704 BufferDiffUpdate {
1705 inner,
1706 buffer_snapshot,
1707 base_text_edits,
1708 base_text_changed,
1709 }
1710 })
1711 }
1712
1713 #[ztracing::instrument(skip_all)]
1714 pub fn language_changed(
1715 &mut self,
1716 language: Option<Arc<Language>>,
1717 language_registry: Option<Arc<LanguageRegistry>>,
1718 cx: &mut Context<Self>,
1719 ) {
1720 let fut = self.inner.base_text.update(cx, |base_text, cx| {
1721 if let Some(language_registry) = language_registry {
1722 base_text.set_language_registry(language_registry);
1723 }
1724 base_text.set_language(language, cx);
1725 base_text.parsing_idle()
1726 });
1727 cx.spawn(async move |this, cx| {
1728 fut.await;
1729 this.update(cx, |_, cx| {
1730 cx.emit(BufferDiffEvent::LanguageChanged);
1731 })
1732 .ok();
1733 })
1734 .detach();
1735 }
1736
1737 fn set_snapshot_with_secondary_inner(
1738 &mut self,
1739 update: BufferDiffUpdate,
1740 buffer: &text::BufferSnapshot,
1741 secondary_diff_change: Option<Range<Anchor>>,
1742 clear_pending_hunks: bool,
1743 cx: &mut Context<Self>,
1744 ) -> impl Future<Output = DiffChanged> + use<> {
1745 log::debug!("set snapshot with secondary {secondary_diff_change:?}");
1746
1747 let old_snapshot = self.snapshot(cx);
1748 let new_state = update.inner;
1749 let base_text_changed = update.base_text_changed;
1750
1751 let state = &mut self.inner;
1752 state.base_text_exists = new_state.base_text_exists;
1753 let should_compare_hunks = update.base_text_edits.is_some() || !base_text_changed;
1754 let parsing_idle = if let Some(diff) = update.base_text_edits {
1755 state.base_text.update(cx, |base_text, cx| {
1756 base_text.set_capability(Capability::ReadWrite, cx);
1757 base_text.apply_diff(diff, cx);
1758 base_text.set_capability(Capability::ReadOnly, cx);
1759 Some(base_text.parsing_idle())
1760 })
1761 } else if update.base_text_changed {
1762 state.base_text.update(cx, |base_text, cx| {
1763 base_text.set_capability(Capability::ReadWrite, cx);
1764 base_text.set_text(new_state.base_text.clone(), cx);
1765 base_text.set_capability(Capability::ReadOnly, cx);
1766 Some(base_text.parsing_idle())
1767 })
1768 } else {
1769 None
1770 };
1771
1772 let old_buffer_snapshot = &old_snapshot.inner.buffer_snapshot;
1773 let old_base_snapshot = &old_snapshot.inner.base_text;
1774 let new_base_snapshot = state.base_text.read(cx).snapshot();
1775 let DiffChanged {
1776 mut changed_range,
1777 mut base_text_changed_range,
1778 mut extended_range,
1779 } = match (state.base_text_exists, new_state.base_text_exists) {
1780 (false, false) => DiffChanged::default(),
1781 (true, true) if should_compare_hunks => compare_hunks(
1782 &new_state.hunks,
1783 &old_snapshot.inner.hunks,
1784 old_buffer_snapshot,
1785 buffer,
1786 old_base_snapshot,
1787 &new_base_snapshot,
1788 ),
1789 _ => {
1790 let full_range = text::Anchor::min_max_range_for_buffer(self.buffer_id);
1791 let full_base_range = 0..new_state.base_text.len();
1792 DiffChanged {
1793 changed_range: Some(full_range.clone()),
1794 base_text_changed_range: Some(full_base_range),
1795 extended_range: Some(full_range),
1796 }
1797 }
1798 };
1799 state.hunks = new_state.hunks;
1800 state.buffer_snapshot = update.buffer_snapshot;
1801
1802 if base_text_changed || clear_pending_hunks {
1803 if let Some((first, last)) = state.pending_hunks.first().zip(state.pending_hunks.last())
1804 {
1805 let pending_range = first.buffer_range.start..last.buffer_range.end;
1806 if let Some(range) = &mut changed_range {
1807 range.start = *range.start.min(&pending_range.start, buffer);
1808 range.end = *range.end.max(&pending_range.end, buffer);
1809 } else {
1810 changed_range = Some(pending_range.clone());
1811 }
1812
1813 if let Some(base_text_range) = base_text_changed_range.as_mut() {
1814 base_text_range.start =
1815 base_text_range.start.min(first.diff_base_byte_range.start);
1816 base_text_range.end = base_text_range.end.max(last.diff_base_byte_range.end);
1817 } else {
1818 base_text_changed_range =
1819 Some(first.diff_base_byte_range.start..last.diff_base_byte_range.end);
1820 }
1821
1822 if let Some(ext) = &mut extended_range {
1823 ext.start = *ext.start.min(&pending_range.start, buffer);
1824 ext.end = *ext.end.max(&pending_range.end, buffer);
1825 } else {
1826 extended_range = Some(pending_range);
1827 }
1828 }
1829 state.pending_hunks = SumTree::new(buffer);
1830 }
1831
1832 if let Some(secondary_changed_range) = secondary_diff_change
1833 && let (Some(secondary_hunk_range), Some(secondary_base_range)) =
1834 old_snapshot.range_to_hunk_range(secondary_changed_range, buffer)
1835 {
1836 if let Some(range) = &mut changed_range {
1837 range.start = *secondary_hunk_range.start.min(&range.start, buffer);
1838 range.end = *secondary_hunk_range.end.max(&range.end, buffer);
1839 } else {
1840 changed_range = Some(secondary_hunk_range.clone());
1841 }
1842
1843 if let Some(base_text_range) = base_text_changed_range.as_mut() {
1844 base_text_range.start = secondary_base_range.start.min(base_text_range.start);
1845 base_text_range.end = secondary_base_range.end.max(base_text_range.end);
1846 } else {
1847 base_text_changed_range = Some(secondary_base_range);
1848 }
1849
1850 if let Some(ext) = &mut extended_range {
1851 ext.start = *ext.start.min(&secondary_hunk_range.start, buffer);
1852 ext.end = *ext.end.max(&secondary_hunk_range.end, buffer);
1853 } else {
1854 extended_range = Some(secondary_hunk_range);
1855 }
1856 }
1857
1858 async move {
1859 if let Some(parsing_idle) = parsing_idle {
1860 parsing_idle.await;
1861 }
1862 DiffChanged {
1863 changed_range,
1864 base_text_changed_range,
1865 extended_range,
1866 }
1867 }
1868 }
1869
1870 pub fn set_snapshot(
1871 &mut self,
1872 new_state: BufferDiffUpdate,
1873 buffer: &text::BufferSnapshot,
1874 cx: &mut Context<Self>,
1875 ) -> Task<Option<Range<Anchor>>> {
1876 self.set_snapshot_with_secondary(new_state, buffer, None, false, cx)
1877 }
1878
1879 pub fn set_snapshot_with_secondary(
1880 &mut self,
1881 update: BufferDiffUpdate,
1882 buffer: &text::BufferSnapshot,
1883 secondary_diff_change: Option<Range<Anchor>>,
1884 clear_pending_hunks: bool,
1885 cx: &mut Context<Self>,
1886 ) -> Task<Option<Range<Anchor>>> {
1887 let fut = self.set_snapshot_with_secondary_inner(
1888 update,
1889 buffer,
1890 secondary_diff_change,
1891 clear_pending_hunks,
1892 cx,
1893 );
1894
1895 cx.spawn(async move |this, cx| {
1896 let change = fut.await;
1897 this.update(cx, |_, cx| {
1898 cx.emit(BufferDiffEvent::DiffChanged(change.clone()));
1899 })
1900 .ok();
1901 change.changed_range
1902 })
1903 }
1904
1905 pub fn base_text(&self, cx: &App) -> language::BufferSnapshot {
1906 self.inner.base_text.read(cx).snapshot()
1907 }
1908
1909 pub fn base_text_exists(&self) -> bool {
1910 self.inner.base_text_exists
1911 }
1912
1913 pub fn snapshot(&self, cx: &App) -> BufferDiffSnapshot {
1914 BufferDiffSnapshot {
1915 inner: BufferDiffInner {
1916 hunks: self.inner.hunks.clone(),
1917 pending_hunks: self.inner.pending_hunks.clone(),
1918 base_text: self.inner.base_text.read(cx).snapshot(),
1919 base_text_exists: self.inner.base_text_exists,
1920 buffer_snapshot: self.inner.buffer_snapshot.clone(),
1921 },
1922 secondary_diff: self.secondary_diff.as_ref().map(|diff| {
1923 debug_assert!(diff.read(cx).secondary_diff.is_none());
1924 Arc::new(diff.read(cx).snapshot(cx))
1925 }),
1926 }
1927 }
1928
1929 /// Used in cases where the change set isn't derived from git.
1930 pub fn set_base_text(
1931 &mut self,
1932 base_text: Option<Arc<str>>,
1933 language: Option<Arc<Language>>,
1934 buffer: text::BufferSnapshot,
1935 cx: &mut Context<Self>,
1936 ) -> oneshot::Receiver<()> {
1937 let (tx, rx) = oneshot::channel();
1938 let complete_on_drop = util::defer(|| {
1939 tx.send(()).ok();
1940 });
1941 cx.spawn(async move |this, cx| {
1942 let Some(state) = this
1943 .update(cx, |this, cx| {
1944 this.update_diff(buffer.clone(), base_text, Some(false), language, cx)
1945 })
1946 .log_err()
1947 else {
1948 return;
1949 };
1950 let state = state.await;
1951 if let Some(task) = this
1952 .update(cx, |this, cx| this.set_snapshot(state, &buffer, cx))
1953 .log_err()
1954 {
1955 task.await;
1956 }
1957 drop(complete_on_drop)
1958 })
1959 .detach();
1960 rx
1961 }
1962
1963 pub fn base_text_string(&self, cx: &App) -> Option<String> {
1964 self.inner
1965 .base_text_exists
1966 .then(|| self.inner.base_text.read(cx).text())
1967 }
1968
1969 #[cfg(any(test, feature = "test-support"))]
1970 pub fn recalculate_diff_sync(&mut self, buffer: &text::BufferSnapshot, cx: &mut Context<Self>) {
1971 let language = self.base_text(cx).language().cloned();
1972 let base_text = self.base_text_string(cx).map(|s| s.as_str().into());
1973 let fut = self.update_diff(buffer.clone(), base_text, None, language, cx);
1974 let fg_executor = cx.foreground_executor().clone();
1975 let snapshot = fg_executor.block_on(fut);
1976 let fut = self.set_snapshot_with_secondary_inner(snapshot, buffer, None, false, cx);
1977 let change = fg_executor.block_on(fut);
1978 cx.emit(BufferDiffEvent::DiffChanged(change));
1979 }
1980
1981 pub fn base_text_buffer(&self) -> &Entity<language::Buffer> {
1982 &self.inner.base_text
1983 }
1984}
1985
1986impl DiffHunk {
1987 pub fn is_created_file(&self) -> bool {
1988 self.diff_base_byte_range == (0..0)
1989 && self.buffer_range.start.is_min()
1990 && self.buffer_range.end.is_max()
1991 }
1992
1993 pub fn status(&self) -> DiffHunkStatus {
1994 let kind = if self.buffer_range.start == self.buffer_range.end {
1995 DiffHunkStatusKind::Deleted
1996 } else if self.diff_base_byte_range.is_empty() {
1997 DiffHunkStatusKind::Added
1998 } else {
1999 DiffHunkStatusKind::Modified
2000 };
2001 DiffHunkStatus {
2002 kind,
2003 secondary: self.secondary_status,
2004 }
2005 }
2006}
2007
2008impl DiffHunkStatus {
2009 pub fn has_secondary_hunk(&self) -> bool {
2010 matches!(
2011 self.secondary,
2012 DiffHunkSecondaryStatus::HasSecondaryHunk
2013 | DiffHunkSecondaryStatus::SecondaryHunkAdditionPending
2014 | DiffHunkSecondaryStatus::OverlapsWithSecondaryHunk
2015 )
2016 }
2017
2018 pub fn is_pending(&self) -> bool {
2019 matches!(
2020 self.secondary,
2021 DiffHunkSecondaryStatus::SecondaryHunkAdditionPending
2022 | DiffHunkSecondaryStatus::SecondaryHunkRemovalPending
2023 )
2024 }
2025
2026 pub fn is_deleted(&self) -> bool {
2027 self.kind == DiffHunkStatusKind::Deleted
2028 }
2029
2030 pub fn is_added(&self) -> bool {
2031 self.kind == DiffHunkStatusKind::Added
2032 }
2033
2034 pub fn is_modified(&self) -> bool {
2035 self.kind == DiffHunkStatusKind::Modified
2036 }
2037
2038 pub fn added(secondary: DiffHunkSecondaryStatus) -> Self {
2039 Self {
2040 kind: DiffHunkStatusKind::Added,
2041 secondary,
2042 }
2043 }
2044
2045 pub fn modified(secondary: DiffHunkSecondaryStatus) -> Self {
2046 Self {
2047 kind: DiffHunkStatusKind::Modified,
2048 secondary,
2049 }
2050 }
2051
2052 pub fn deleted(secondary: DiffHunkSecondaryStatus) -> Self {
2053 Self {
2054 kind: DiffHunkStatusKind::Deleted,
2055 secondary,
2056 }
2057 }
2058
2059 pub fn deleted_none() -> Self {
2060 Self {
2061 kind: DiffHunkStatusKind::Deleted,
2062 secondary: DiffHunkSecondaryStatus::NoSecondaryHunk,
2063 }
2064 }
2065
2066 pub fn added_none() -> Self {
2067 Self {
2068 kind: DiffHunkStatusKind::Added,
2069 secondary: DiffHunkSecondaryStatus::NoSecondaryHunk,
2070 }
2071 }
2072
2073 pub fn modified_none() -> Self {
2074 Self {
2075 kind: DiffHunkStatusKind::Modified,
2076 secondary: DiffHunkSecondaryStatus::NoSecondaryHunk,
2077 }
2078 }
2079}
2080
2081#[cfg(any(test, feature = "test-support"))]
2082#[track_caller]
2083pub fn assert_hunks<ExpectedText, HunkIter>(
2084 diff_hunks: HunkIter,
2085 buffer: &text::BufferSnapshot,
2086 diff_base: &str,
2087 // Line range, deleted, added, status
2088 expected_hunks: &[(Range<u32>, ExpectedText, ExpectedText, DiffHunkStatus)],
2089) where
2090 HunkIter: Iterator<Item = DiffHunk>,
2091 ExpectedText: AsRef<str>,
2092{
2093 let actual_hunks = diff_hunks
2094 .map(|hunk| {
2095 (
2096 hunk.range.clone(),
2097 &diff_base[hunk.diff_base_byte_range.clone()],
2098 buffer
2099 .text_for_range(hunk.range.clone())
2100 .collect::<String>(),
2101 hunk.status(),
2102 )
2103 })
2104 .collect::<Vec<_>>();
2105
2106 let expected_hunks: Vec<_> = expected_hunks
2107 .iter()
2108 .map(|(line_range, deleted_text, added_text, status)| {
2109 (
2110 Point::new(line_range.start, 0)..Point::new(line_range.end, 0),
2111 deleted_text.as_ref(),
2112 added_text.as_ref().to_string(),
2113 *status,
2114 )
2115 })
2116 .collect();
2117
2118 pretty_assertions::assert_eq!(actual_hunks, expected_hunks);
2119}
2120
2121#[cfg(test)]
2122mod tests {
2123 use std::{fmt::Write as _, sync::mpsc};
2124
2125 use super::*;
2126 use gpui::TestAppContext;
2127 use pretty_assertions::{assert_eq, assert_ne};
2128 use rand::{Rng as _, rngs::StdRng};
2129 use text::{Buffer, BufferId, ReplicaId, Rope};
2130 use unindent::Unindent as _;
2131 use util::test::marked_text_ranges;
2132
2133 #[ctor::ctor]
2134 fn init_logger() {
2135 zlog::init_test();
2136 }
2137
2138 #[gpui::test]
2139 async fn test_buffer_diff_simple(cx: &mut gpui::TestAppContext) {
2140 let diff_base = "
2141 one
2142 two
2143 three
2144 "
2145 .unindent();
2146
2147 let buffer_text = "
2148 one
2149 HELLO
2150 three
2151 "
2152 .unindent();
2153
2154 let mut buffer = Buffer::new(ReplicaId::LOCAL, BufferId::new(1).unwrap(), buffer_text);
2155 let mut diff = BufferDiffSnapshot::new_sync(&buffer, diff_base.clone(), cx);
2156 assert_hunks(
2157 diff.hunks_intersecting_range(
2158 Anchor::min_max_range_for_buffer(buffer.remote_id()),
2159 &buffer,
2160 ),
2161 &buffer,
2162 &diff_base,
2163 &[(1..2, "two\n", "HELLO\n", DiffHunkStatus::modified_none())],
2164 );
2165
2166 buffer.edit([(0..0, "point five\n")]);
2167 diff = BufferDiffSnapshot::new_sync(&buffer, diff_base.clone(), cx);
2168 assert_hunks(
2169 diff.hunks_intersecting_range(
2170 Anchor::min_max_range_for_buffer(buffer.remote_id()),
2171 &buffer,
2172 ),
2173 &buffer,
2174 &diff_base,
2175 &[
2176 (0..1, "", "point five\n", DiffHunkStatus::added_none()),
2177 (2..3, "two\n", "HELLO\n", DiffHunkStatus::modified_none()),
2178 ],
2179 );
2180
2181 diff = cx.update(|cx| BufferDiff::new(&buffer, cx).snapshot(cx));
2182 assert_hunks::<&str, _>(
2183 diff.hunks_intersecting_range(
2184 Anchor::min_max_range_for_buffer(buffer.remote_id()),
2185 &buffer,
2186 ),
2187 &buffer,
2188 &diff_base,
2189 &[],
2190 );
2191 }
2192
2193 #[gpui::test]
2194 async fn test_buffer_diff_with_secondary(cx: &mut gpui::TestAppContext) {
2195 let head_text = "
2196 zero
2197 one
2198 two
2199 three
2200 four
2201 five
2202 six
2203 seven
2204 eight
2205 nine
2206 "
2207 .unindent();
2208
2209 let index_text = "
2210 zero
2211 one
2212 TWO
2213 three
2214 FOUR
2215 five
2216 six
2217 seven
2218 eight
2219 NINE
2220 "
2221 .unindent();
2222
2223 let buffer_text = "
2224 zero
2225 one
2226 TWO
2227 three
2228 FOUR
2229 FIVE
2230 six
2231 SEVEN
2232 eight
2233 nine
2234 "
2235 .unindent();
2236
2237 let buffer = Buffer::new(ReplicaId::LOCAL, BufferId::new(1).unwrap(), buffer_text);
2238 let unstaged_diff = BufferDiffSnapshot::new_sync(&buffer, index_text, cx);
2239 let mut uncommitted_diff = BufferDiffSnapshot::new_sync(&buffer, head_text.clone(), cx);
2240 uncommitted_diff.secondary_diff = Some(Arc::new(unstaged_diff));
2241
2242 let expected_hunks = vec![
2243 (2..3, "two\n", "TWO\n", DiffHunkStatus::modified_none()),
2244 (
2245 4..6,
2246 "four\nfive\n",
2247 "FOUR\nFIVE\n",
2248 DiffHunkStatus::modified(DiffHunkSecondaryStatus::OverlapsWithSecondaryHunk),
2249 ),
2250 (
2251 7..8,
2252 "seven\n",
2253 "SEVEN\n",
2254 DiffHunkStatus::modified(DiffHunkSecondaryStatus::HasSecondaryHunk),
2255 ),
2256 ];
2257
2258 assert_hunks(
2259 uncommitted_diff.hunks_intersecting_range(
2260 Anchor::min_max_range_for_buffer(buffer.remote_id()),
2261 &buffer,
2262 ),
2263 &buffer,
2264 &head_text,
2265 &expected_hunks,
2266 );
2267 }
2268
2269 #[gpui::test]
2270 async fn test_buffer_diff_range(cx: &mut TestAppContext) {
2271 let diff_base = "
2272 one
2273 two
2274 three
2275 four
2276 five
2277 six
2278 seven
2279 eight
2280 nine
2281 ten
2282 "
2283 .unindent();
2284
2285 let buffer_text = "
2286 A
2287 one
2288 B
2289 two
2290 C
2291 three
2292 HELLO
2293 four
2294 five
2295 SIXTEEN
2296 seven
2297 eight
2298 WORLD
2299 nine
2300
2301 ten
2302
2303 "
2304 .unindent();
2305
2306 let buffer = Buffer::new(ReplicaId::LOCAL, BufferId::new(1).unwrap(), buffer_text);
2307 let diff = BufferDiffSnapshot::new_sync(buffer.snapshot(), diff_base.clone(), cx);
2308 assert_eq!(
2309 diff.hunks_intersecting_range(
2310 Anchor::min_max_range_for_buffer(buffer.remote_id()),
2311 &buffer
2312 )
2313 .count(),
2314 8
2315 );
2316
2317 assert_hunks(
2318 diff.hunks_intersecting_range(
2319 buffer.anchor_before(Point::new(7, 0))..buffer.anchor_before(Point::new(12, 0)),
2320 &buffer,
2321 ),
2322 &buffer,
2323 &diff_base,
2324 &[
2325 (6..7, "", "HELLO\n", DiffHunkStatus::added_none()),
2326 (9..10, "six\n", "SIXTEEN\n", DiffHunkStatus::modified_none()),
2327 (12..13, "", "WORLD\n", DiffHunkStatus::added_none()),
2328 ],
2329 );
2330 }
2331
2332 #[gpui::test]
2333 async fn test_stage_hunk(cx: &mut TestAppContext) {
2334 struct Example {
2335 name: &'static str,
2336 head_text: String,
2337 index_text: String,
2338 buffer_marked_text: String,
2339 final_index_text: String,
2340 }
2341
2342 let table = [
2343 Example {
2344 name: "uncommitted hunk straddles end of unstaged hunk",
2345 head_text: "
2346 one
2347 two
2348 three
2349 four
2350 five
2351 "
2352 .unindent(),
2353 index_text: "
2354 one
2355 TWO_HUNDRED
2356 three
2357 FOUR_HUNDRED
2358 five
2359 "
2360 .unindent(),
2361 buffer_marked_text: "
2362 ZERO
2363 one
2364 two
2365 «THREE_HUNDRED
2366 FOUR_HUNDRED»
2367 five
2368 SIX
2369 "
2370 .unindent(),
2371 final_index_text: "
2372 one
2373 two
2374 THREE_HUNDRED
2375 FOUR_HUNDRED
2376 five
2377 "
2378 .unindent(),
2379 },
2380 Example {
2381 name: "uncommitted hunk straddles start of unstaged hunk",
2382 head_text: "
2383 one
2384 two
2385 three
2386 four
2387 five
2388 "
2389 .unindent(),
2390 index_text: "
2391 one
2392 TWO_HUNDRED
2393 three
2394 FOUR_HUNDRED
2395 five
2396 "
2397 .unindent(),
2398 buffer_marked_text: "
2399 ZERO
2400 one
2401 «TWO_HUNDRED
2402 THREE_HUNDRED»
2403 four
2404 five
2405 SIX
2406 "
2407 .unindent(),
2408 final_index_text: "
2409 one
2410 TWO_HUNDRED
2411 THREE_HUNDRED
2412 four
2413 five
2414 "
2415 .unindent(),
2416 },
2417 Example {
2418 name: "uncommitted hunk strictly contains unstaged hunks",
2419 head_text: "
2420 one
2421 two
2422 three
2423 four
2424 five
2425 six
2426 seven
2427 "
2428 .unindent(),
2429 index_text: "
2430 one
2431 TWO
2432 THREE
2433 FOUR
2434 FIVE
2435 SIX
2436 seven
2437 "
2438 .unindent(),
2439 buffer_marked_text: "
2440 one
2441 TWO
2442 «THREE_HUNDRED
2443 FOUR
2444 FIVE_HUNDRED»
2445 SIX
2446 seven
2447 "
2448 .unindent(),
2449 final_index_text: "
2450 one
2451 TWO
2452 THREE_HUNDRED
2453 FOUR
2454 FIVE_HUNDRED
2455 SIX
2456 seven
2457 "
2458 .unindent(),
2459 },
2460 Example {
2461 name: "uncommitted deletion hunk",
2462 head_text: "
2463 one
2464 two
2465 three
2466 four
2467 five
2468 "
2469 .unindent(),
2470 index_text: "
2471 one
2472 two
2473 three
2474 four
2475 five
2476 "
2477 .unindent(),
2478 buffer_marked_text: "
2479 one
2480 ˇfive
2481 "
2482 .unindent(),
2483 final_index_text: "
2484 one
2485 five
2486 "
2487 .unindent(),
2488 },
2489 Example {
2490 name: "one unstaged hunk that contains two uncommitted hunks",
2491 head_text: "
2492 one
2493 two
2494
2495 three
2496 four
2497 "
2498 .unindent(),
2499 index_text: "
2500 one
2501 two
2502 three
2503 four
2504 "
2505 .unindent(),
2506 buffer_marked_text: "
2507 «one
2508
2509 three // modified
2510 four»
2511 "
2512 .unindent(),
2513 final_index_text: "
2514 one
2515
2516 three // modified
2517 four
2518 "
2519 .unindent(),
2520 },
2521 Example {
2522 name: "one uncommitted hunk that contains two unstaged hunks",
2523 head_text: "
2524 one
2525 two
2526 three
2527 four
2528 five
2529 "
2530 .unindent(),
2531 index_text: "
2532 ZERO
2533 one
2534 TWO
2535 THREE
2536 FOUR
2537 five
2538 "
2539 .unindent(),
2540 buffer_marked_text: "
2541 «one
2542 TWO_HUNDRED
2543 THREE
2544 FOUR_HUNDRED
2545 five»
2546 "
2547 .unindent(),
2548 final_index_text: "
2549 ZERO
2550 one
2551 TWO_HUNDRED
2552 THREE
2553 FOUR_HUNDRED
2554 five
2555 "
2556 .unindent(),
2557 },
2558 ];
2559
2560 for example in table {
2561 let (buffer_text, ranges) = marked_text_ranges(&example.buffer_marked_text, false);
2562 let buffer = Buffer::new(ReplicaId::LOCAL, BufferId::new(1).unwrap(), buffer_text);
2563 let hunk_range =
2564 buffer.anchor_before(ranges[0].start)..buffer.anchor_before(ranges[0].end);
2565
2566 let unstaged_diff =
2567 cx.new(|cx| BufferDiff::new_with_base_text(&example.index_text, &buffer, cx));
2568
2569 let uncommitted_diff = cx.new(|cx| {
2570 let mut diff = BufferDiff::new_with_base_text(&example.head_text, &buffer, cx);
2571 diff.set_secondary_diff(unstaged_diff);
2572 diff
2573 });
2574
2575 uncommitted_diff.update(cx, |diff, cx| {
2576 let hunks = diff
2577 .snapshot(cx)
2578 .hunks_intersecting_range(hunk_range.clone(), &buffer)
2579 .collect::<Vec<_>>();
2580 for hunk in &hunks {
2581 assert_ne!(
2582 hunk.secondary_status,
2583 DiffHunkSecondaryStatus::NoSecondaryHunk
2584 )
2585 }
2586
2587 let new_index_text = diff
2588 .stage_or_unstage_hunks(true, &hunks, &buffer, true, cx)
2589 .unwrap()
2590 .to_string();
2591
2592 let hunks = diff
2593 .snapshot(cx)
2594 .hunks_intersecting_range(hunk_range.clone(), &buffer)
2595 .collect::<Vec<_>>();
2596 for hunk in &hunks {
2597 assert_eq!(
2598 hunk.secondary_status,
2599 DiffHunkSecondaryStatus::SecondaryHunkRemovalPending
2600 )
2601 }
2602
2603 pretty_assertions::assert_eq!(
2604 new_index_text,
2605 example.final_index_text,
2606 "example: {}",
2607 example.name
2608 );
2609 });
2610 }
2611 }
2612
2613 #[gpui::test]
2614 async fn test_stage_all_with_nested_hunks(cx: &mut TestAppContext) {
2615 // This test reproduces a crash where staging all hunks would cause an underflow
2616 // when there's one large unstaged hunk containing multiple uncommitted hunks.
2617 let head_text = "
2618 aaa
2619 bbb
2620 ccc
2621 ddd
2622 eee
2623 fff
2624 ggg
2625 hhh
2626 iii
2627 jjj
2628 kkk
2629 lll
2630 "
2631 .unindent();
2632
2633 let index_text = "
2634 aaa
2635 bbb
2636 CCC-index
2637 DDD-index
2638 EEE-index
2639 FFF-index
2640 GGG-index
2641 HHH-index
2642 III-index
2643 JJJ-index
2644 kkk
2645 lll
2646 "
2647 .unindent();
2648
2649 let buffer_text = "
2650 aaa
2651 bbb
2652 ccc-modified
2653 ddd
2654 eee-modified
2655 fff
2656 ggg
2657 hhh-modified
2658 iii
2659 jjj
2660 kkk
2661 lll
2662 "
2663 .unindent();
2664
2665 let buffer = Buffer::new(ReplicaId::LOCAL, BufferId::new(1).unwrap(), buffer_text);
2666
2667 let unstaged_diff = cx.new(|cx| BufferDiff::new_with_base_text(&index_text, &buffer, cx));
2668 let uncommitted_diff = cx.new(|cx| {
2669 let mut diff = BufferDiff::new_with_base_text(&head_text, &buffer, cx);
2670 diff.set_secondary_diff(unstaged_diff);
2671 diff
2672 });
2673
2674 uncommitted_diff.update(cx, |diff, cx| {
2675 diff.stage_or_unstage_all_hunks(true, &buffer, true, cx);
2676 });
2677 }
2678
2679 #[gpui::test]
2680 async fn test_toggling_stage_and_unstage_same_hunk(cx: &mut TestAppContext) {
2681 let head_text = "
2682 one
2683 two
2684 three
2685 "
2686 .unindent();
2687 let index_text = head_text.clone();
2688 let buffer_text = "
2689 one
2690 three
2691 "
2692 .unindent();
2693
2694 let buffer = Buffer::new(
2695 ReplicaId::LOCAL,
2696 BufferId::new(1).unwrap(),
2697 buffer_text.clone(),
2698 );
2699 let unstaged_diff = cx.new(|cx| BufferDiff::new_with_base_text(&index_text, &buffer, cx));
2700 let uncommitted_diff = cx.new(|cx| {
2701 let mut diff = BufferDiff::new_with_base_text(&head_text, &buffer, cx);
2702 diff.set_secondary_diff(unstaged_diff.clone());
2703 diff
2704 });
2705
2706 uncommitted_diff.update(cx, |diff, cx| {
2707 let hunk = diff.snapshot(cx).hunks(&buffer).next().unwrap();
2708
2709 let new_index_text = diff
2710 .stage_or_unstage_hunks(true, std::slice::from_ref(&hunk), &buffer, true, cx)
2711 .unwrap()
2712 .to_string();
2713 assert_eq!(new_index_text, buffer_text);
2714
2715 let hunk = diff.snapshot(cx).hunks(&buffer).next().unwrap();
2716 assert_eq!(
2717 hunk.secondary_status,
2718 DiffHunkSecondaryStatus::SecondaryHunkRemovalPending
2719 );
2720
2721 let index_text = diff
2722 .stage_or_unstage_hunks(false, &[hunk], &buffer, true, cx)
2723 .unwrap()
2724 .to_string();
2725 assert_eq!(index_text, head_text);
2726
2727 let hunk = diff.snapshot(cx).hunks(&buffer).next().unwrap();
2728 // optimistically unstaged (fine, could also be HasSecondaryHunk)
2729 assert_eq!(
2730 hunk.secondary_status,
2731 DiffHunkSecondaryStatus::SecondaryHunkAdditionPending
2732 );
2733 });
2734 }
2735
2736 #[gpui::test]
2737 async fn test_buffer_diff_compare(cx: &mut TestAppContext) {
2738 let base_text = "
2739 zero
2740 one
2741 two
2742 three
2743 four
2744 five
2745 six
2746 seven
2747 eight
2748 nine
2749 "
2750 .unindent();
2751
2752 let buffer_text_1 = "
2753 one
2754 three
2755 four
2756 five
2757 SIX
2758 seven
2759 eight
2760 NINE
2761 "
2762 .unindent();
2763
2764 let mut buffer = Buffer::new(ReplicaId::LOCAL, BufferId::new(1).unwrap(), buffer_text_1);
2765
2766 let empty_diff = cx.update(|cx| BufferDiff::new(&buffer, cx).snapshot(cx));
2767 let diff_1 = BufferDiffSnapshot::new_sync(&buffer, base_text.clone(), cx);
2768 let DiffChanged {
2769 changed_range,
2770 base_text_changed_range,
2771 extended_range: _,
2772 } = compare_hunks(
2773 &diff_1.inner.hunks,
2774 &empty_diff.inner.hunks,
2775 &buffer,
2776 &buffer,
2777 &diff_1.base_text(),
2778 &diff_1.base_text(),
2779 );
2780 let range = changed_range.unwrap();
2781 assert_eq!(range.to_point(&buffer), Point::new(0, 0)..Point::new(8, 0));
2782 let base_text_range = base_text_changed_range.unwrap();
2783 assert_eq!(
2784 base_text_range.to_point(diff_1.base_text()),
2785 Point::new(0, 0)..Point::new(10, 0)
2786 );
2787
2788 // Edit does affects the diff because it recalculates word diffs.
2789 buffer.edit_via_marked_text(
2790 &"
2791 one
2792 three
2793 four
2794 five
2795 «SIX.5»
2796 seven
2797 eight
2798 NINE
2799 "
2800 .unindent(),
2801 );
2802 let diff_2 = BufferDiffSnapshot::new_sync(&buffer, base_text.clone(), cx);
2803 let DiffChanged {
2804 changed_range,
2805 base_text_changed_range,
2806 extended_range: _,
2807 } = compare_hunks(
2808 &diff_2.inner.hunks,
2809 &diff_1.inner.hunks,
2810 &buffer,
2811 &buffer,
2812 diff_2.base_text(),
2813 diff_2.base_text(),
2814 );
2815 assert_eq!(
2816 changed_range.unwrap().to_point(&buffer),
2817 Point::new(4, 0)..Point::new(5, 0),
2818 );
2819 assert_eq!(
2820 base_text_changed_range
2821 .unwrap()
2822 .to_point(diff_2.base_text()),
2823 Point::new(6, 0)..Point::new(7, 0),
2824 );
2825
2826 // Edit turns a deletion hunk into a modification.
2827 buffer.edit_via_marked_text(
2828 &"
2829 one
2830 «THREE»
2831 four
2832 five
2833 SIX.5
2834 seven
2835 eight
2836 NINE
2837 "
2838 .unindent(),
2839 );
2840 let diff_3 = BufferDiffSnapshot::new_sync(&buffer, base_text.clone(), cx);
2841 let DiffChanged {
2842 changed_range,
2843 base_text_changed_range,
2844 extended_range: _,
2845 } = compare_hunks(
2846 &diff_3.inner.hunks,
2847 &diff_2.inner.hunks,
2848 &buffer,
2849 &buffer,
2850 diff_3.base_text(),
2851 diff_3.base_text(),
2852 );
2853 let range = changed_range.unwrap();
2854 assert_eq!(range.to_point(&buffer), Point::new(1, 0)..Point::new(2, 0));
2855 let base_text_range = base_text_changed_range.unwrap();
2856 assert_eq!(
2857 base_text_range.to_point(diff_3.base_text()),
2858 Point::new(2, 0)..Point::new(4, 0)
2859 );
2860
2861 // Edit turns a modification hunk into a deletion.
2862 buffer.edit_via_marked_text(
2863 &"
2864 one
2865 THREE
2866 four
2867 five«»
2868 seven
2869 eight
2870 NINE
2871 "
2872 .unindent(),
2873 );
2874 let diff_4 = BufferDiffSnapshot::new_sync(&buffer, base_text.clone(), cx);
2875 let DiffChanged {
2876 changed_range,
2877 base_text_changed_range,
2878 extended_range: _,
2879 } = compare_hunks(
2880 &diff_4.inner.hunks,
2881 &diff_3.inner.hunks,
2882 &buffer,
2883 &buffer,
2884 diff_4.base_text(),
2885 diff_4.base_text(),
2886 );
2887 let range = changed_range.unwrap();
2888 assert_eq!(range.to_point(&buffer), Point::new(3, 4)..Point::new(4, 0));
2889 let base_text_range = base_text_changed_range.unwrap();
2890 assert_eq!(
2891 base_text_range.to_point(diff_4.base_text()),
2892 Point::new(6, 0)..Point::new(7, 0)
2893 );
2894
2895 // Edit introduces a new insertion hunk.
2896 buffer.edit_via_marked_text(
2897 &"
2898 one
2899 THREE
2900 four«
2901 FOUR.5
2902 »five
2903 seven
2904 eight
2905 NINE
2906 "
2907 .unindent(),
2908 );
2909 let diff_5 = BufferDiffSnapshot::new_sync(buffer.snapshot(), base_text.clone(), cx);
2910 let DiffChanged {
2911 changed_range,
2912 base_text_changed_range,
2913 extended_range: _,
2914 } = compare_hunks(
2915 &diff_5.inner.hunks,
2916 &diff_4.inner.hunks,
2917 &buffer,
2918 &buffer,
2919 diff_5.base_text(),
2920 diff_5.base_text(),
2921 );
2922 let range = changed_range.unwrap();
2923 assert_eq!(range.to_point(&buffer), Point::new(3, 0)..Point::new(4, 0));
2924 let base_text_range = base_text_changed_range.unwrap();
2925 assert_eq!(
2926 base_text_range.to_point(diff_5.base_text()),
2927 Point::new(5, 0)..Point::new(5, 0)
2928 );
2929
2930 // Edit removes a hunk.
2931 buffer.edit_via_marked_text(
2932 &"
2933 one
2934 THREE
2935 four
2936 FOUR.5
2937 five
2938 seven
2939 eight
2940 «nine»
2941 "
2942 .unindent(),
2943 );
2944 let diff_6 = BufferDiffSnapshot::new_sync(buffer.snapshot(), base_text.clone(), cx);
2945 let DiffChanged {
2946 changed_range,
2947 base_text_changed_range,
2948 extended_range: _,
2949 } = compare_hunks(
2950 &diff_6.inner.hunks,
2951 &diff_5.inner.hunks,
2952 &buffer,
2953 &buffer,
2954 diff_6.base_text(),
2955 diff_6.base_text(),
2956 );
2957 let range = changed_range.unwrap();
2958 assert_eq!(range.to_point(&buffer), Point::new(7, 0)..Point::new(8, 0));
2959 let base_text_range = base_text_changed_range.unwrap();
2960 assert_eq!(
2961 base_text_range.to_point(diff_6.base_text()),
2962 Point::new(9, 0)..Point::new(10, 0)
2963 );
2964
2965 buffer.edit_via_marked_text(
2966 &"
2967 one
2968 THREE
2969 four«»
2970 five
2971 seven
2972 eight
2973 «NINE»
2974 "
2975 .unindent(),
2976 );
2977
2978 let diff_7 = BufferDiffSnapshot::new_sync(buffer.snapshot(), base_text.clone(), cx);
2979 let DiffChanged {
2980 changed_range,
2981 base_text_changed_range,
2982 extended_range: _,
2983 } = compare_hunks(
2984 &diff_7.inner.hunks,
2985 &diff_6.inner.hunks,
2986 &buffer,
2987 &buffer,
2988 diff_7.base_text(),
2989 diff_7.base_text(),
2990 );
2991 let range = changed_range.unwrap();
2992 assert_eq!(range.to_point(&buffer), Point::new(2, 4)..Point::new(7, 0));
2993 let base_text_range = base_text_changed_range.unwrap();
2994 assert_eq!(
2995 base_text_range.to_point(diff_7.base_text()),
2996 Point::new(5, 0)..Point::new(10, 0)
2997 );
2998
2999 buffer.edit_via_marked_text(
3000 &"
3001 one
3002 THREE
3003 four
3004 five«»seven
3005 eight
3006 NINE
3007 "
3008 .unindent(),
3009 );
3010
3011 let diff_8 = BufferDiffSnapshot::new_sync(buffer.snapshot(), base_text, cx);
3012 let DiffChanged {
3013 changed_range,
3014 base_text_changed_range,
3015 extended_range: _,
3016 } = compare_hunks(
3017 &diff_8.inner.hunks,
3018 &diff_7.inner.hunks,
3019 &buffer,
3020 &buffer,
3021 diff_8.base_text(),
3022 diff_8.base_text(),
3023 );
3024 let range = changed_range.unwrap();
3025 assert_eq!(range.to_point(&buffer), Point::new(3, 0)..Point::new(3, 4));
3026 let base_text_range = base_text_changed_range.unwrap();
3027 assert_eq!(
3028 base_text_range.to_point(diff_8.base_text()),
3029 Point::new(5, 0)..Point::new(8, 0)
3030 );
3031 }
3032
3033 #[gpui::test(iterations = 100)]
3034 async fn test_staging_and_unstaging_hunks(cx: &mut TestAppContext, mut rng: StdRng) {
3035 fn gen_line(rng: &mut StdRng) -> String {
3036 if rng.random_bool(0.2) {
3037 "\n".to_owned()
3038 } else {
3039 let c = rng.random_range('A'..='Z');
3040 format!("{c}{c}{c}\n")
3041 }
3042 }
3043
3044 fn gen_working_copy(rng: &mut StdRng, head: &str) -> String {
3045 let mut old_lines = {
3046 let mut old_lines = Vec::new();
3047 let old_lines_iter = head.lines();
3048 for line in old_lines_iter {
3049 assert!(!line.ends_with("\n"));
3050 old_lines.push(line.to_owned());
3051 }
3052 if old_lines.last().is_some_and(|line| line.is_empty()) {
3053 old_lines.pop();
3054 }
3055 old_lines.into_iter()
3056 };
3057 let mut result = String::new();
3058 let unchanged_count = rng.random_range(0..=old_lines.len());
3059 result +=
3060 &old_lines
3061 .by_ref()
3062 .take(unchanged_count)
3063 .fold(String::new(), |mut s, line| {
3064 writeln!(&mut s, "{line}").unwrap();
3065 s
3066 });
3067 while old_lines.len() > 0 {
3068 let deleted_count = rng.random_range(0..=old_lines.len());
3069 let _advance = old_lines
3070 .by_ref()
3071 .take(deleted_count)
3072 .map(|line| line.len() + 1)
3073 .sum::<usize>();
3074 let minimum_added = if deleted_count == 0 { 1 } else { 0 };
3075 let added_count = rng.random_range(minimum_added..=5);
3076 let addition = (0..added_count).map(|_| gen_line(rng)).collect::<String>();
3077 result += &addition;
3078
3079 if old_lines.len() > 0 {
3080 let blank_lines = old_lines.clone().take_while(|line| line.is_empty()).count();
3081 if blank_lines == old_lines.len() {
3082 break;
3083 };
3084 let unchanged_count =
3085 rng.random_range((blank_lines + 1).max(1)..=old_lines.len());
3086 result += &old_lines.by_ref().take(unchanged_count).fold(
3087 String::new(),
3088 |mut s, line| {
3089 writeln!(&mut s, "{line}").unwrap();
3090 s
3091 },
3092 );
3093 }
3094 }
3095 result
3096 }
3097
3098 fn uncommitted_diff(
3099 working_copy: &language::BufferSnapshot,
3100 index_text: &Rope,
3101 head_text: String,
3102 cx: &mut TestAppContext,
3103 ) -> Entity<BufferDiff> {
3104 let secondary = cx.new(|cx| {
3105 BufferDiff::new_with_base_text(&index_text.to_string(), &working_copy.text, cx)
3106 });
3107 cx.new(|cx| {
3108 let mut diff = BufferDiff::new_with_base_text(&head_text, &working_copy.text, cx);
3109 diff.secondary_diff = Some(secondary);
3110 diff
3111 })
3112 }
3113
3114 let operations = std::env::var("OPERATIONS")
3115 .map(|i| i.parse().expect("invalid `OPERATIONS` variable"))
3116 .unwrap_or(10);
3117
3118 let rng = &mut rng;
3119 let head_text = ('a'..='z').fold(String::new(), |mut s, c| {
3120 writeln!(&mut s, "{c}{c}{c}").unwrap();
3121 s
3122 });
3123 let working_copy = gen_working_copy(rng, &head_text);
3124 let working_copy = cx.new(|cx| {
3125 language::Buffer::local_normalized(
3126 Rope::from(working_copy.as_str()),
3127 text::LineEnding::default(),
3128 cx,
3129 )
3130 });
3131 let working_copy = working_copy.read_with(cx, |working_copy, _| working_copy.snapshot());
3132 let mut index_text = if rng.random() {
3133 Rope::from(head_text.as_str())
3134 } else {
3135 working_copy.as_rope().clone()
3136 };
3137
3138 let mut diff = uncommitted_diff(&working_copy, &index_text, head_text.clone(), cx);
3139 let mut hunks = diff.update(cx, |diff, cx| {
3140 diff.snapshot(cx)
3141 .hunks_intersecting_range(
3142 Anchor::min_max_range_for_buffer(diff.buffer_id),
3143 &working_copy,
3144 )
3145 .collect::<Vec<_>>()
3146 });
3147 if hunks.is_empty() {
3148 return;
3149 }
3150
3151 for _ in 0..operations {
3152 let i = rng.random_range(0..hunks.len());
3153 let hunk = &mut hunks[i];
3154 let hunk_to_change = hunk.clone();
3155 let stage = match hunk.secondary_status {
3156 DiffHunkSecondaryStatus::HasSecondaryHunk => {
3157 hunk.secondary_status = DiffHunkSecondaryStatus::NoSecondaryHunk;
3158 true
3159 }
3160 DiffHunkSecondaryStatus::NoSecondaryHunk => {
3161 hunk.secondary_status = DiffHunkSecondaryStatus::HasSecondaryHunk;
3162 false
3163 }
3164 _ => unreachable!(),
3165 };
3166
3167 index_text = diff.update(cx, |diff, cx| {
3168 diff.stage_or_unstage_hunks(stage, &[hunk_to_change], &working_copy, true, cx)
3169 .unwrap()
3170 });
3171
3172 diff = uncommitted_diff(&working_copy, &index_text, head_text.clone(), cx);
3173 let found_hunks = diff.update(cx, |diff, cx| {
3174 diff.snapshot(cx)
3175 .hunks_intersecting_range(
3176 Anchor::min_max_range_for_buffer(diff.buffer_id),
3177 &working_copy,
3178 )
3179 .collect::<Vec<_>>()
3180 });
3181 assert_eq!(hunks.len(), found_hunks.len());
3182
3183 for (expected_hunk, found_hunk) in hunks.iter().zip(&found_hunks) {
3184 assert_eq!(
3185 expected_hunk.buffer_range.to_point(&working_copy),
3186 found_hunk.buffer_range.to_point(&working_copy)
3187 );
3188 assert_eq!(
3189 expected_hunk.diff_base_byte_range,
3190 found_hunk.diff_base_byte_range
3191 );
3192 assert_eq!(expected_hunk.secondary_status, found_hunk.secondary_status);
3193 }
3194 hunks = found_hunks;
3195 }
3196 }
3197
3198 #[gpui::test]
3199 async fn test_changed_ranges(cx: &mut gpui::TestAppContext) {
3200 let base_text = "
3201 one
3202 two
3203 three
3204 four
3205 five
3206 six
3207 "
3208 .unindent();
3209 let buffer_text = "
3210 one
3211 TWO
3212 three
3213 four
3214 FIVE
3215 six
3216 "
3217 .unindent();
3218 let buffer = cx.new(|cx| language::Buffer::local(buffer_text, cx));
3219 let diff = cx.new(|cx| {
3220 BufferDiff::new_with_base_text(&base_text, &buffer.read(cx).text_snapshot(), cx)
3221 });
3222 cx.run_until_parked();
3223 let (tx, rx) = mpsc::channel();
3224 let subscription =
3225 cx.update(|cx| cx.subscribe(&diff, move |_, event, _| tx.send(event.clone()).unwrap()));
3226
3227 let snapshot = buffer.update(cx, |buffer, cx| {
3228 buffer.set_text(
3229 "
3230 ONE
3231 TWO
3232 THREE
3233 FOUR
3234 FIVE
3235 SIX
3236 "
3237 .unindent(),
3238 cx,
3239 );
3240 buffer.text_snapshot()
3241 });
3242 let update = diff
3243 .update(cx, |diff, cx| {
3244 diff.update_diff(
3245 snapshot.clone(),
3246 Some(base_text.as_str().into()),
3247 None,
3248 None,
3249 cx,
3250 )
3251 })
3252 .await;
3253 diff.update(cx, |diff, cx| diff.set_snapshot(update, &snapshot, cx))
3254 .await;
3255 cx.run_until_parked();
3256 drop(subscription);
3257 let events = rx.into_iter().collect::<Vec<_>>();
3258 match events.as_slice() {
3259 [
3260 BufferDiffEvent::DiffChanged(DiffChanged {
3261 changed_range: _,
3262 base_text_changed_range,
3263 extended_range: _,
3264 }),
3265 ] => {
3266 // TODO(cole) this seems like it should pass but currently fails (see compare_hunks)
3267 // assert_eq!(
3268 // *changed_range,
3269 // Some(Anchor::min_max_range_for_buffer(
3270 // buffer.read_with(cx, |buffer, _| buffer.remote_id())
3271 // ))
3272 // );
3273 assert_eq!(*base_text_changed_range, Some(0..base_text.len()));
3274 }
3275 _ => panic!("unexpected events: {:?}", events),
3276 }
3277 }
3278
3279 #[gpui::test]
3280 async fn test_extended_range(cx: &mut TestAppContext) {
3281 let base_text = "
3282 aaa
3283 bbb
3284
3285
3286
3287
3288
3289 ccc
3290 ddd
3291 "
3292 .unindent();
3293
3294 let buffer_text = "
3295 aaa
3296 bbb
3297
3298
3299
3300
3301
3302 CCC
3303 ddd
3304 "
3305 .unindent();
3306
3307 let mut buffer = Buffer::new(ReplicaId::LOCAL, BufferId::new(1).unwrap(), buffer_text);
3308 let old_buffer = buffer.snapshot().clone();
3309 let diff_a = BufferDiffSnapshot::new_sync(&buffer, base_text.clone(), cx);
3310
3311 buffer.edit([(Point::new(1, 3)..Point::new(1, 3), "\n")]);
3312 let diff_b = BufferDiffSnapshot::new_sync(&buffer, base_text, cx);
3313
3314 let DiffChanged {
3315 changed_range,
3316 base_text_changed_range: _,
3317 extended_range,
3318 } = compare_hunks(
3319 &diff_b.inner.hunks,
3320 &diff_a.inner.hunks,
3321 &old_buffer,
3322 &buffer,
3323 &diff_a.base_text(),
3324 &diff_a.base_text(),
3325 );
3326
3327 let changed_range = changed_range.unwrap();
3328 assert_eq!(
3329 changed_range.to_point(&buffer),
3330 Point::new(7, 0)..Point::new(9, 0),
3331 "changed_range should span from old hunk position to new hunk end"
3332 );
3333
3334 let extended_range = extended_range.unwrap();
3335 assert_eq!(
3336 extended_range.start.to_point(&buffer),
3337 Point::new(1, 3),
3338 "extended_range.start should extend to include the edit outside changed_range"
3339 );
3340 assert_eq!(
3341 extended_range.end.to_point(&buffer),
3342 Point::new(9, 0),
3343 "extended_range.end should collapse to changed_range.end when no edits in end margin"
3344 );
3345
3346 let base_text_2 = "
3347 one
3348 two
3349 three
3350 four
3351 five
3352 six
3353 seven
3354 eight
3355 "
3356 .unindent();
3357
3358 let buffer_text_2 = "
3359 ONE
3360 two
3361 THREE
3362 four
3363 FIVE
3364 six
3365 SEVEN
3366 eight
3367 "
3368 .unindent();
3369
3370 let mut buffer_2 = Buffer::new(ReplicaId::LOCAL, BufferId::new(2).unwrap(), buffer_text_2);
3371 let old_buffer_2 = buffer_2.snapshot().clone();
3372 let diff_2a = BufferDiffSnapshot::new_sync(&buffer_2, base_text_2.clone(), cx);
3373
3374 buffer_2.edit([(Point::new(4, 0)..Point::new(4, 4), "FIVE_CHANGED")]);
3375 let diff_2b = BufferDiffSnapshot::new_sync(&buffer_2, base_text_2, cx);
3376
3377 let DiffChanged {
3378 changed_range,
3379 base_text_changed_range: _,
3380 extended_range,
3381 } = compare_hunks(
3382 &diff_2b.inner.hunks,
3383 &diff_2a.inner.hunks,
3384 &old_buffer_2,
3385 &buffer_2,
3386 &diff_2a.base_text(),
3387 &diff_2a.base_text(),
3388 );
3389
3390 let changed_range = changed_range.unwrap();
3391 assert_eq!(
3392 changed_range.to_point(&buffer_2),
3393 Point::new(4, 0)..Point::new(5, 0),
3394 "changed_range should be just the hunk that changed (FIVE)"
3395 );
3396
3397 let extended_range = extended_range.unwrap();
3398 assert_eq!(
3399 extended_range.to_point(&buffer_2),
3400 Point::new(4, 0)..Point::new(5, 0),
3401 "extended_range should equal changed_range when edit is within the hunk"
3402 );
3403 }
3404
3405 #[gpui::test]
3406 async fn test_buffer_diff_compare_with_base_text_change(_cx: &mut TestAppContext) {
3407 // Use a shared base text buffer so that anchors from old and new snapshots
3408 // share the same remote_id and resolve correctly across versions.
3409 let initial_base = "aaa\nbbb\nccc\nddd\neee\n";
3410 let mut base_text_buffer = Buffer::new(
3411 ReplicaId::LOCAL,
3412 BufferId::new(99).unwrap(),
3413 initial_base.to_string(),
3414 );
3415
3416 // --- Scenario 1: Base text gains a line, producing a new deletion hunk ---
3417 //
3418 // Buffer has a modification (ccc → CCC). When the base text gains
3419 // a new line "XXX" after "aaa", the diff now also contains a
3420 // deletion for that line, and the modification hunk shifts in the
3421 // base text.
3422 let buffer_text_1 = "aaa\nbbb\nCCC\nddd\neee\n";
3423 let buffer = Buffer::new(
3424 ReplicaId::LOCAL,
3425 BufferId::new(1).unwrap(),
3426 buffer_text_1.to_string(),
3427 );
3428
3429 let old_base_snapshot_1 = base_text_buffer.snapshot().clone();
3430 let old_hunks_1 = compute_hunks(
3431 Some((Arc::from(initial_base), Rope::from(initial_base))),
3432 buffer.snapshot(),
3433 None,
3434 );
3435
3436 // Insert "XXX\n" after "aaa\n" in the base text.
3437 base_text_buffer.edit([(4..4, "XXX\n")]);
3438 let new_base_str_1: Arc<str> = Arc::from(base_text_buffer.text().as_str());
3439 let new_base_snapshot_1 = base_text_buffer.snapshot();
3440
3441 let new_hunks_1 = compute_hunks(
3442 Some((new_base_str_1.clone(), Rope::from(new_base_str_1.as_ref()))),
3443 buffer.snapshot(),
3444 None,
3445 );
3446
3447 let DiffChanged {
3448 changed_range,
3449 base_text_changed_range,
3450 extended_range: _,
3451 } = compare_hunks(
3452 &new_hunks_1,
3453 &old_hunks_1,
3454 &buffer.snapshot(),
3455 &buffer.snapshot(),
3456 &old_base_snapshot_1,
3457 &new_base_snapshot_1,
3458 );
3459
3460 // The new deletion hunk (XXX) starts at buffer row 1 and the
3461 // modification hunk (ccc → CCC) now has a different
3462 // diff_base_byte_range, so the changed range spans both.
3463 let range = changed_range.unwrap();
3464 assert_eq!(range.to_point(&buffer), Point::new(1, 0)..Point::new(3, 0),);
3465 let base_range = base_text_changed_range.unwrap();
3466 assert_eq!(
3467 base_range.to_point(&new_base_snapshot_1),
3468 Point::new(1, 0)..Point::new(4, 0),
3469 );
3470
3471 // --- Scenario 2: Base text changes to match the buffer (hunk disappears) ---
3472 //
3473 // Start fresh with a simple base text.
3474 let simple_base = "one\ntwo\nthree\n";
3475 let mut base_buf_2 = Buffer::new(
3476 ReplicaId::LOCAL,
3477 BufferId::new(100).unwrap(),
3478 simple_base.to_string(),
3479 );
3480
3481 let buffer_text_2 = "one\nTWO\nthree\n";
3482 let buffer_2 = Buffer::new(
3483 ReplicaId::LOCAL,
3484 BufferId::new(2).unwrap(),
3485 buffer_text_2.to_string(),
3486 );
3487
3488 let old_base_snapshot_2 = base_buf_2.snapshot().clone();
3489 let old_hunks_2 = compute_hunks(
3490 Some((Arc::from(simple_base), Rope::from(simple_base))),
3491 buffer_2.snapshot(),
3492 None,
3493 );
3494
3495 // The base text is edited so "two" becomes "TWO", now matching the buffer.
3496 base_buf_2.edit([(4..7, "TWO")]);
3497 let new_base_str_2: Arc<str> = Arc::from(base_buf_2.text().as_str());
3498 let new_base_snapshot_2 = base_buf_2.snapshot();
3499
3500 let new_hunks_2 = compute_hunks(
3501 Some((new_base_str_2.clone(), Rope::from(new_base_str_2.as_ref()))),
3502 buffer_2.snapshot(),
3503 None,
3504 );
3505
3506 let DiffChanged {
3507 changed_range,
3508 base_text_changed_range,
3509 extended_range: _,
3510 } = compare_hunks(
3511 &new_hunks_2,
3512 &old_hunks_2,
3513 &buffer_2.snapshot(),
3514 &buffer_2.snapshot(),
3515 &old_base_snapshot_2,
3516 &new_base_snapshot_2,
3517 );
3518
3519 // The old modification hunk (two → TWO) is now gone because the
3520 // base text matches the buffer. The changed range covers where the
3521 // old hunk used to be.
3522 let range = changed_range.unwrap();
3523 assert_eq!(
3524 range.to_point(&buffer_2),
3525 Point::new(1, 0)..Point::new(2, 0),
3526 );
3527 let base_range = base_text_changed_range.unwrap();
3528 // The old hunk's diff_base_byte_range covered "two\n" (bytes 4..8).
3529 // anchor_after(4) is right-biased at the start of the deleted "two",
3530 // so after the edit replacing "two" with "TWO" it resolves past the
3531 // insertion to Point(1, 3).
3532 assert_eq!(
3533 base_range.to_point(&new_base_snapshot_2),
3534 Point::new(1, 3)..Point::new(2, 0),
3535 );
3536
3537 // --- Scenario 3: Base text edit changes one hunk but not another ---
3538 //
3539 // Two modification hunks exist. Only one of them is resolved by
3540 // the base text change; the other remains identical.
3541 let base_3 = "aaa\nbbb\nccc\nddd\neee\n";
3542 let mut base_buf_3 = Buffer::new(
3543 ReplicaId::LOCAL,
3544 BufferId::new(101).unwrap(),
3545 base_3.to_string(),
3546 );
3547
3548 let buffer_text_3 = "aaa\nBBB\nccc\nDDD\neee\n";
3549 let buffer_3 = Buffer::new(
3550 ReplicaId::LOCAL,
3551 BufferId::new(3).unwrap(),
3552 buffer_text_3.to_string(),
3553 );
3554
3555 let old_base_snapshot_3 = base_buf_3.snapshot().clone();
3556 let old_hunks_3 = compute_hunks(
3557 Some((Arc::from(base_3), Rope::from(base_3))),
3558 buffer_3.snapshot(),
3559 None,
3560 );
3561
3562 // Change "ddd" to "DDD" in the base text so that hunk disappears,
3563 // but "bbb" stays, so its hunk remains.
3564 base_buf_3.edit([(12..15, "DDD")]);
3565 let new_base_str_3: Arc<str> = Arc::from(base_buf_3.text().as_str());
3566 let new_base_snapshot_3 = base_buf_3.snapshot();
3567
3568 let new_hunks_3 = compute_hunks(
3569 Some((new_base_str_3.clone(), Rope::from(new_base_str_3.as_ref()))),
3570 buffer_3.snapshot(),
3571 None,
3572 );
3573
3574 let DiffChanged {
3575 changed_range,
3576 base_text_changed_range,
3577 extended_range: _,
3578 } = compare_hunks(
3579 &new_hunks_3,
3580 &old_hunks_3,
3581 &buffer_3.snapshot(),
3582 &buffer_3.snapshot(),
3583 &old_base_snapshot_3,
3584 &new_base_snapshot_3,
3585 );
3586
3587 // Only the second hunk (ddd → DDD) disappeared; the first hunk
3588 // (bbb → BBB) is unchanged, so the changed range covers only line 3.
3589 let range = changed_range.unwrap();
3590 assert_eq!(
3591 range.to_point(&buffer_3),
3592 Point::new(3, 0)..Point::new(4, 0),
3593 );
3594 let base_range = base_text_changed_range.unwrap();
3595 // anchor_after(12) is right-biased at the start of deleted "ddd",
3596 // so after the edit replacing "ddd" with "DDD" it resolves past
3597 // the insertion to Point(3, 3).
3598 assert_eq!(
3599 base_range.to_point(&new_base_snapshot_3),
3600 Point::new(3, 3)..Point::new(4, 0),
3601 );
3602
3603 // --- Scenario 4: Both buffer and base text change simultaneously ---
3604 //
3605 // The buffer gains an edit that introduces a new hunk while the
3606 // base text also changes.
3607 let base_4 = "alpha\nbeta\ngamma\ndelta\n";
3608 let mut base_buf_4 = Buffer::new(
3609 ReplicaId::LOCAL,
3610 BufferId::new(102).unwrap(),
3611 base_4.to_string(),
3612 );
3613
3614 let buffer_text_4 = "alpha\nBETA\ngamma\ndelta\n";
3615 let mut buffer_4 = Buffer::new(
3616 ReplicaId::LOCAL,
3617 BufferId::new(4).unwrap(),
3618 buffer_text_4.to_string(),
3619 );
3620
3621 let old_base_snapshot_4 = base_buf_4.snapshot().clone();
3622 let old_buffer_snapshot_4 = buffer_4.snapshot().clone();
3623 let old_hunks_4 = compute_hunks(
3624 Some((Arc::from(base_4), Rope::from(base_4))),
3625 buffer_4.snapshot(),
3626 None,
3627 );
3628
3629 // Edit the buffer: change "delta" to "DELTA" (new modification hunk).
3630 buffer_4.edit_via_marked_text(
3631 &"
3632 alpha
3633 BETA
3634 gamma
3635 «DELTA»
3636 "
3637 .unindent(),
3638 );
3639
3640 // Edit the base text: change "beta" to "BETA" (resolves that hunk).
3641 base_buf_4.edit([(6..10, "BETA")]);
3642 let new_base_str_4: Arc<str> = Arc::from(base_buf_4.text().as_str());
3643 let new_base_snapshot_4 = base_buf_4.snapshot();
3644
3645 let new_hunks_4 = compute_hunks(
3646 Some((new_base_str_4.clone(), Rope::from(new_base_str_4.as_ref()))),
3647 buffer_4.snapshot(),
3648 None,
3649 );
3650
3651 let DiffChanged {
3652 changed_range,
3653 base_text_changed_range,
3654 extended_range: _,
3655 } = compare_hunks(
3656 &new_hunks_4,
3657 &old_hunks_4,
3658 &old_buffer_snapshot_4,
3659 &buffer_4.snapshot(),
3660 &old_base_snapshot_4,
3661 &new_base_snapshot_4,
3662 );
3663
3664 // The old BETA hunk (line 1) is gone and a new DELTA hunk (line 3)
3665 // appeared, so the changed range spans from line 1 through line 4.
3666 let range = changed_range.unwrap();
3667 assert_eq!(
3668 range.to_point(&buffer_4),
3669 Point::new(1, 0)..Point::new(4, 0),
3670 );
3671 let base_range = base_text_changed_range.unwrap();
3672 // The old BETA hunk's base range started at byte 6 ("beta"). After
3673 // the base text edit replacing "beta" with "BETA", anchor_after(6)
3674 // resolves past the insertion to Point(1, 4).
3675 assert_eq!(
3676 base_range.to_point(&new_base_snapshot_4),
3677 Point::new(1, 4)..Point::new(4, 0),
3678 );
3679 }
3680
3681 #[gpui::test(iterations = 100)]
3682 async fn test_patch_for_range_random(cx: &mut TestAppContext, mut rng: StdRng) {
3683 fn gen_line(rng: &mut StdRng) -> String {
3684 if rng.random_bool(0.2) {
3685 "\n".to_owned()
3686 } else {
3687 let c = rng.random_range('A'..='Z');
3688 format!("{c}{c}{c}\n")
3689 }
3690 }
3691
3692 fn gen_text(rng: &mut StdRng, line_count: usize) -> String {
3693 (0..line_count).map(|_| gen_line(rng)).collect()
3694 }
3695
3696 fn gen_edits_from(rng: &mut StdRng, base: &str) -> String {
3697 let mut old_lines: Vec<&str> = base.lines().collect();
3698 let mut result = String::new();
3699
3700 while !old_lines.is_empty() {
3701 let unchanged_count = rng.random_range(0..=old_lines.len());
3702 for _ in 0..unchanged_count {
3703 if old_lines.is_empty() {
3704 break;
3705 }
3706 result.push_str(old_lines.remove(0));
3707 result.push('\n');
3708 }
3709
3710 if old_lines.is_empty() {
3711 break;
3712 }
3713
3714 let deleted_count = rng.random_range(0..=old_lines.len().min(3));
3715 for _ in 0..deleted_count {
3716 if old_lines.is_empty() {
3717 break;
3718 }
3719 old_lines.remove(0);
3720 }
3721
3722 let minimum_added = if deleted_count == 0 { 1 } else { 0 };
3723 let added_count = rng.random_range(minimum_added..=3);
3724 for _ in 0..added_count {
3725 result.push_str(&gen_line(rng));
3726 }
3727 }
3728
3729 result
3730 }
3731
3732 fn random_point_in_text(rng: &mut StdRng, lines: &[&str]) -> Point {
3733 if lines.is_empty() {
3734 return Point::zero();
3735 }
3736 let row = rng.random_range(0..lines.len() as u32);
3737 let line = lines[row as usize];
3738 let col = if line.is_empty() {
3739 0
3740 } else {
3741 rng.random_range(0..=line.len() as u32)
3742 };
3743 Point::new(row, col)
3744 }
3745
3746 fn random_range_in_text(rng: &mut StdRng, lines: &[&str]) -> RangeInclusive<Point> {
3747 let start = random_point_in_text(rng, lines);
3748 let end = random_point_in_text(rng, lines);
3749 if start <= end {
3750 start..=end
3751 } else {
3752 end..=start
3753 }
3754 }
3755
3756 fn points_in_range(range: &RangeInclusive<Point>, lines: &[&str]) -> Vec<Point> {
3757 let mut points = Vec::new();
3758 for row in range.start().row..=range.end().row {
3759 if row as usize >= lines.len() {
3760 points.push(Point::new(row, 0));
3761 continue;
3762 }
3763 let line = lines[row as usize];
3764 let start_col = if row == range.start().row {
3765 range.start().column
3766 } else {
3767 0
3768 };
3769 let end_col = if row == range.end().row {
3770 range.end().column
3771 } else {
3772 line.len() as u32
3773 };
3774 for col in start_col..=end_col {
3775 points.push(Point::new(row, col));
3776 }
3777 }
3778 points
3779 }
3780
3781 let rng = &mut rng;
3782
3783 let line_count = rng.random_range(5..20);
3784 let base_text = gen_text(rng, line_count);
3785 let initial_buffer_text = gen_edits_from(rng, &base_text);
3786
3787 let mut buffer = Buffer::new(
3788 ReplicaId::LOCAL,
3789 BufferId::new(1).unwrap(),
3790 initial_buffer_text.clone(),
3791 );
3792
3793 let diff = BufferDiffSnapshot::new_sync(&buffer, base_text.clone(), cx);
3794
3795 let edit_count = rng.random_range(1..=5);
3796 for _ in 0..edit_count {
3797 let buffer_text = buffer.text();
3798 if buffer_text.is_empty() {
3799 buffer.edit([(0..0, gen_line(rng))]);
3800 } else {
3801 let lines: Vec<&str> = buffer_text.lines().collect();
3802 let start_row = rng.random_range(0..lines.len());
3803 let end_row = rng.random_range(start_row..=lines.len().min(start_row + 3));
3804
3805 let start_col = if start_row < lines.len() {
3806 rng.random_range(0..=lines[start_row].len())
3807 } else {
3808 0
3809 };
3810 let end_col = if end_row < lines.len() {
3811 rng.random_range(0..=lines[end_row].len())
3812 } else {
3813 0
3814 };
3815
3816 let start_offset = buffer
3817 .point_to_offset(Point::new(start_row as u32, start_col as u32))
3818 .min(buffer.len());
3819 let end_offset = buffer
3820 .point_to_offset(Point::new(end_row as u32, end_col as u32))
3821 .min(buffer.len());
3822
3823 let (start, end) = if start_offset <= end_offset {
3824 (start_offset, end_offset)
3825 } else {
3826 (end_offset, start_offset)
3827 };
3828
3829 let new_text = if rng.random_bool(0.3) {
3830 String::new()
3831 } else {
3832 let line_count = rng.random_range(0..=2);
3833 gen_text(rng, line_count)
3834 };
3835
3836 buffer.edit([(start..end, new_text)]);
3837 }
3838 }
3839
3840 let buffer_snapshot = buffer.snapshot();
3841
3842 let buffer_text = buffer_snapshot.text();
3843 let buffer_lines: Vec<&str> = buffer_text.lines().collect();
3844 let base_lines: Vec<&str> = base_text.lines().collect();
3845
3846 let test_count = 10;
3847 for _ in 0..test_count {
3848 let range = random_range_in_text(rng, &buffer_lines);
3849 let points = points_in_range(&range, &buffer_lines);
3850
3851 let optimized_patch = diff.patch_for_buffer_range(range.clone(), &buffer_snapshot);
3852 let naive_patch = diff.patch_for_buffer_range_naive(&buffer_snapshot);
3853
3854 for point in points {
3855 let optimized_edit = optimized_patch.edit_for_old_position(point);
3856 let naive_edit = naive_patch.edit_for_old_position(point);
3857
3858 assert_eq!(
3859 optimized_edit,
3860 naive_edit,
3861 "patch_for_buffer_range mismatch at point {:?} in range {:?}\nbase_text: {:?}\ninitial_buffer: {:?}\ncurrent_buffer: {:?}",
3862 point,
3863 range,
3864 base_text,
3865 initial_buffer_text,
3866 buffer_snapshot.text()
3867 );
3868 }
3869 }
3870
3871 for _ in 0..test_count {
3872 let range = random_range_in_text(rng, &base_lines);
3873 let points = points_in_range(&range, &base_lines);
3874
3875 let optimized_patch = diff.patch_for_base_text_range(range.clone(), &buffer_snapshot);
3876 let naive_patch = diff.patch_for_base_text_range_naive(&buffer_snapshot);
3877
3878 for point in points {
3879 let optimized_edit = optimized_patch.edit_for_old_position(point);
3880 let naive_edit = naive_patch.edit_for_old_position(point);
3881
3882 assert_eq!(
3883 optimized_edit,
3884 naive_edit,
3885 "patch_for_base_text_range mismatch at point {:?} in range {:?}\nbase_text: {:?}\ninitial_buffer: {:?}\ncurrent_buffer: {:?}",
3886 point,
3887 range,
3888 base_text,
3889 initial_buffer_text,
3890 buffer_snapshot.text()
3891 );
3892 }
3893 }
3894 }
3895}