1use std::{
2 ops::{Range, RangeInclusive},
3 sync::Arc,
4};
5
6use collections::{hash_map, HashMap, HashSet};
7use git::diff::{DiffHunk, DiffHunkStatus};
8use gpui::{AppContext, Hsla, Model, Task, View};
9use language::Buffer;
10use multi_buffer::{
11 Anchor, ExcerptRange, MultiBuffer, MultiBufferRow, MultiBufferSnapshot, ToPoint,
12};
13use settings::SettingsStore;
14use text::{BufferId, Point};
15use ui::{
16 div, ActiveTheme, Context as _, IntoElement, ParentElement, Styled, ViewContext, VisualContext,
17};
18use util::{debug_panic, RangeExt};
19
20use crate::{
21 editor_settings::CurrentLineHighlight,
22 git::{diff_hunk_to_display, DisplayDiffHunk},
23 hunk_status, hunks_for_selections, BlockDisposition, BlockId, BlockProperties, BlockStyle,
24 DiffRowHighlight, Editor, EditorSnapshot, ExpandAllHunkDiffs, RangeToAnchorExt,
25 RevertSelectedHunks, ToDisplayPoint, ToggleHunkDiff,
26};
27
28#[derive(Debug, Clone)]
29pub(super) struct HunkToExpand {
30 pub multi_buffer_range: Range<Anchor>,
31 pub status: DiffHunkStatus,
32 pub diff_base_byte_range: Range<usize>,
33}
34
35#[derive(Debug, Default)]
36pub(super) struct ExpandedHunks {
37 hunks: Vec<ExpandedHunk>,
38 diff_base: HashMap<BufferId, DiffBaseBuffer>,
39 hunk_update_tasks: HashMap<Option<BufferId>, Task<()>>,
40}
41
42#[derive(Debug)]
43struct DiffBaseBuffer {
44 buffer: Model<Buffer>,
45 diff_base_version: usize,
46}
47
48impl ExpandedHunks {
49 pub fn hunks(&self, include_folded: bool) -> impl Iterator<Item = &ExpandedHunk> {
50 self.hunks
51 .iter()
52 .filter(move |hunk| include_folded || !hunk.folded)
53 }
54}
55
56#[derive(Debug, Clone)]
57pub(super) struct ExpandedHunk {
58 pub block: Option<BlockId>,
59 pub hunk_range: Range<Anchor>,
60 pub diff_base_byte_range: Range<usize>,
61 pub status: DiffHunkStatus,
62 pub folded: bool,
63}
64
65impl Editor {
66 pub fn toggle_hunk_diff(&mut self, _: &ToggleHunkDiff, cx: &mut ViewContext<Self>) {
67 let multi_buffer_snapshot = self.buffer().read(cx).snapshot(cx);
68 let selections = self.selections.disjoint_anchors();
69 self.toggle_hunks_expanded(
70 hunks_for_selections(&multi_buffer_snapshot, &selections),
71 cx,
72 );
73 }
74
75 pub fn expand_all_hunk_diffs(&mut self, _: &ExpandAllHunkDiffs, cx: &mut ViewContext<Self>) {
76 let snapshot = self.snapshot(cx);
77 let display_rows_with_expanded_hunks = self
78 .expanded_hunks
79 .hunks(false)
80 .map(|hunk| &hunk.hunk_range)
81 .map(|anchor_range| {
82 (
83 anchor_range
84 .start
85 .to_display_point(&snapshot.display_snapshot)
86 .row(),
87 anchor_range
88 .end
89 .to_display_point(&snapshot.display_snapshot)
90 .row(),
91 )
92 })
93 .collect::<HashMap<_, _>>();
94 let hunks = snapshot
95 .display_snapshot
96 .buffer_snapshot
97 .git_diff_hunks_in_range(MultiBufferRow::MIN..MultiBufferRow::MAX)
98 .filter(|hunk| {
99 let hunk_display_row_range = Point::new(hunk.associated_range.start.0, 0)
100 .to_display_point(&snapshot.display_snapshot)
101 ..Point::new(hunk.associated_range.end.0, 0)
102 .to_display_point(&snapshot.display_snapshot);
103 let row_range_end =
104 display_rows_with_expanded_hunks.get(&hunk_display_row_range.start.row());
105 row_range_end.is_none() || row_range_end != Some(&hunk_display_row_range.end.row())
106 });
107 self.toggle_hunks_expanded(hunks.collect(), cx);
108 }
109
110 fn toggle_hunks_expanded(
111 &mut self,
112 hunks_to_toggle: Vec<DiffHunk<MultiBufferRow>>,
113 cx: &mut ViewContext<Self>,
114 ) {
115 let previous_toggle_task = self.expanded_hunks.hunk_update_tasks.remove(&None);
116 let new_toggle_task = cx.spawn(move |editor, mut cx| async move {
117 if let Some(task) = previous_toggle_task {
118 task.await;
119 }
120
121 editor
122 .update(&mut cx, |editor, cx| {
123 let snapshot = editor.snapshot(cx);
124 let mut hunks_to_toggle = hunks_to_toggle.into_iter().fuse().peekable();
125 let mut highlights_to_remove =
126 Vec::with_capacity(editor.expanded_hunks.hunks.len());
127 let mut blocks_to_remove = HashSet::default();
128 let mut hunks_to_expand = Vec::new();
129 editor.expanded_hunks.hunks.retain(|expanded_hunk| {
130 if expanded_hunk.folded {
131 return true;
132 }
133 let expanded_hunk_row_range = expanded_hunk
134 .hunk_range
135 .start
136 .to_display_point(&snapshot)
137 .row()
138 ..expanded_hunk
139 .hunk_range
140 .end
141 .to_display_point(&snapshot)
142 .row();
143 let mut retain = true;
144 while let Some(hunk_to_toggle) = hunks_to_toggle.peek() {
145 match diff_hunk_to_display(hunk_to_toggle, &snapshot) {
146 DisplayDiffHunk::Folded { .. } => {
147 hunks_to_toggle.next();
148 continue;
149 }
150 DisplayDiffHunk::Unfolded {
151 diff_base_byte_range,
152 display_row_range,
153 multi_buffer_range,
154 status,
155 } => {
156 let hunk_to_toggle_row_range = display_row_range;
157 if hunk_to_toggle_row_range.start > expanded_hunk_row_range.end
158 {
159 break;
160 } else if expanded_hunk_row_range == hunk_to_toggle_row_range {
161 highlights_to_remove.push(expanded_hunk.hunk_range.clone());
162 blocks_to_remove.extend(expanded_hunk.block);
163 hunks_to_toggle.next();
164 retain = false;
165 break;
166 } else {
167 hunks_to_expand.push(HunkToExpand {
168 status,
169 multi_buffer_range,
170 diff_base_byte_range,
171 });
172 hunks_to_toggle.next();
173 continue;
174 }
175 }
176 }
177 }
178
179 retain
180 });
181 for remaining_hunk in hunks_to_toggle {
182 let remaining_hunk_point_range =
183 Point::new(remaining_hunk.associated_range.start.0, 0)
184 ..Point::new(remaining_hunk.associated_range.end.0, 0);
185 hunks_to_expand.push(HunkToExpand {
186 status: hunk_status(&remaining_hunk),
187 multi_buffer_range: remaining_hunk_point_range
188 .to_anchors(&snapshot.buffer_snapshot),
189 diff_base_byte_range: remaining_hunk.diff_base_byte_range.clone(),
190 });
191 }
192
193 for removed_rows in highlights_to_remove {
194 editor.highlight_rows::<DiffRowHighlight>(
195 to_inclusive_row_range(removed_rows, &snapshot),
196 None,
197 false,
198 cx,
199 );
200 }
201 editor.remove_blocks(blocks_to_remove, None, cx);
202 for hunk in hunks_to_expand {
203 editor.expand_diff_hunk(None, &hunk, cx);
204 }
205 cx.notify();
206 })
207 .ok();
208 });
209
210 self.expanded_hunks
211 .hunk_update_tasks
212 .insert(None, cx.background_executor().spawn(new_toggle_task));
213 }
214
215 pub(super) fn expand_diff_hunk(
216 &mut self,
217 diff_base_buffer: Option<Model<Buffer>>,
218 hunk: &HunkToExpand,
219 cx: &mut ViewContext<'_, Editor>,
220 ) -> Option<()> {
221 let multi_buffer_snapshot = self.buffer().read(cx).snapshot(cx);
222 let multi_buffer_row_range = hunk
223 .multi_buffer_range
224 .start
225 .to_point(&multi_buffer_snapshot)
226 ..hunk.multi_buffer_range.end.to_point(&multi_buffer_snapshot);
227 let hunk_start = hunk.multi_buffer_range.start;
228 let hunk_end = hunk.multi_buffer_range.end;
229
230 let buffer = self.buffer().clone();
231 let snapshot = self.snapshot(cx);
232 let (diff_base_buffer, deleted_text_lines) = buffer.update(cx, |buffer, cx| {
233 let hunk = buffer_diff_hunk(&snapshot.buffer_snapshot, multi_buffer_row_range.clone())?;
234 let mut buffer_ranges = buffer.range_to_buffer_ranges(multi_buffer_row_range, cx);
235 if buffer_ranges.len() == 1 {
236 let (buffer, _, _) = buffer_ranges.pop()?;
237 let diff_base_buffer = diff_base_buffer
238 .or_else(|| self.current_diff_base_buffer(&buffer, cx))
239 .or_else(|| create_diff_base_buffer(&buffer, cx))?;
240 let buffer = buffer.read(cx);
241 let deleted_text_lines = buffer.diff_base().map(|diff_base| {
242 let diff_start_row = diff_base
243 .offset_to_point(hunk.diff_base_byte_range.start)
244 .row;
245 let diff_end_row = diff_base.offset_to_point(hunk.diff_base_byte_range.end).row;
246 let line_count = diff_end_row - diff_start_row;
247 line_count as u8
248 })?;
249 Some((diff_base_buffer, deleted_text_lines))
250 } else {
251 None
252 }
253 })?;
254
255 let block_insert_index = match self.expanded_hunks.hunks.binary_search_by(|probe| {
256 probe
257 .hunk_range
258 .start
259 .cmp(&hunk_start, &multi_buffer_snapshot)
260 }) {
261 Ok(_already_present) => return None,
262 Err(ix) => ix,
263 };
264
265 let block = match hunk.status {
266 DiffHunkStatus::Removed => {
267 self.insert_deleted_text_block(diff_base_buffer, deleted_text_lines, &hunk, cx)
268 }
269 DiffHunkStatus::Added => {
270 self.highlight_rows::<DiffRowHighlight>(
271 to_inclusive_row_range(hunk_start..hunk_end, &snapshot),
272 Some(added_hunk_color(cx)),
273 false,
274 cx,
275 );
276 None
277 }
278 DiffHunkStatus::Modified => {
279 self.highlight_rows::<DiffRowHighlight>(
280 to_inclusive_row_range(hunk_start..hunk_end, &snapshot),
281 Some(added_hunk_color(cx)),
282 false,
283 cx,
284 );
285 self.insert_deleted_text_block(diff_base_buffer, deleted_text_lines, &hunk, cx)
286 }
287 };
288 self.expanded_hunks.hunks.insert(
289 block_insert_index,
290 ExpandedHunk {
291 block,
292 hunk_range: hunk_start..hunk_end,
293 status: hunk.status,
294 folded: false,
295 diff_base_byte_range: hunk.diff_base_byte_range.clone(),
296 },
297 );
298
299 Some(())
300 }
301
302 fn insert_deleted_text_block(
303 &mut self,
304 diff_base_buffer: Model<Buffer>,
305 deleted_text_height: u8,
306 hunk: &HunkToExpand,
307 cx: &mut ViewContext<'_, Self>,
308 ) -> Option<BlockId> {
309 let deleted_hunk_color = deleted_hunk_color(cx);
310 let (editor_height, editor_with_deleted_text) =
311 editor_with_deleted_text(diff_base_buffer, deleted_hunk_color, hunk, cx);
312 let editor_model = cx.model().clone();
313 let mut new_block_ids = self.insert_blocks(
314 Some(BlockProperties {
315 position: hunk.multi_buffer_range.start,
316 height: editor_height.max(deleted_text_height),
317 style: BlockStyle::Flex,
318 render: Box::new(move |cx| {
319 let gutter_dimensions = editor_model.read(cx).gutter_dimensions;
320 div()
321 .bg(deleted_hunk_color)
322 .size_full()
323 .pl(gutter_dimensions.full_width())
324 .child(editor_with_deleted_text.clone())
325 .into_any_element()
326 }),
327 disposition: BlockDisposition::Above,
328 }),
329 None,
330 cx,
331 );
332 if new_block_ids.len() == 1 {
333 new_block_ids.pop()
334 } else {
335 debug_panic!(
336 "Inserted one editor block but did not receive exactly one block id: {new_block_ids:?}"
337 );
338 None
339 }
340 }
341
342 pub(super) fn clear_expanded_diff_hunks(&mut self, cx: &mut ViewContext<'_, Editor>) {
343 self.expanded_hunks.hunk_update_tasks.clear();
344 let to_remove = self
345 .expanded_hunks
346 .hunks
347 .drain(..)
348 .filter_map(|expanded_hunk| expanded_hunk.block)
349 .collect();
350 self.clear_row_highlights::<DiffRowHighlight>();
351 self.remove_blocks(to_remove, None, cx);
352 }
353
354 pub(super) fn sync_expanded_diff_hunks(
355 &mut self,
356 buffer: Model<Buffer>,
357 cx: &mut ViewContext<'_, Self>,
358 ) {
359 let buffer_id = buffer.read(cx).remote_id();
360 let buffer_diff_base_version = buffer.read(cx).diff_base_version();
361 self.expanded_hunks
362 .hunk_update_tasks
363 .remove(&Some(buffer_id));
364 let diff_base_buffer = self.current_diff_base_buffer(&buffer, cx);
365 let new_sync_task = cx.spawn(move |editor, mut cx| async move {
366 let diff_base_buffer_unchanged = diff_base_buffer.is_some();
367 let Ok(diff_base_buffer) =
368 cx.update(|cx| diff_base_buffer.or_else(|| create_diff_base_buffer(&buffer, cx)))
369 else {
370 return;
371 };
372 editor
373 .update(&mut cx, |editor, cx| {
374 if let Some(diff_base_buffer) = &diff_base_buffer {
375 editor.expanded_hunks.diff_base.insert(
376 buffer_id,
377 DiffBaseBuffer {
378 buffer: diff_base_buffer.clone(),
379 diff_base_version: buffer_diff_base_version,
380 },
381 );
382 }
383
384 let snapshot = editor.snapshot(cx);
385 let mut recalculated_hunks = snapshot
386 .buffer_snapshot
387 .git_diff_hunks_in_range(MultiBufferRow::MIN..MultiBufferRow::MAX)
388 .filter(|hunk| hunk.buffer_id == buffer_id)
389 .fuse()
390 .peekable();
391 let mut highlights_to_remove =
392 Vec::with_capacity(editor.expanded_hunks.hunks.len());
393 let mut blocks_to_remove = HashSet::default();
394 let mut hunks_to_reexpand =
395 Vec::with_capacity(editor.expanded_hunks.hunks.len());
396 editor.expanded_hunks.hunks.retain_mut(|expanded_hunk| {
397 if expanded_hunk.hunk_range.start.buffer_id != Some(buffer_id) {
398 return true;
399 };
400
401 let mut retain = false;
402 if diff_base_buffer_unchanged {
403 let expanded_hunk_display_range = expanded_hunk
404 .hunk_range
405 .start
406 .to_display_point(&snapshot)
407 .row()
408 ..expanded_hunk
409 .hunk_range
410 .end
411 .to_display_point(&snapshot)
412 .row();
413 while let Some(buffer_hunk) = recalculated_hunks.peek() {
414 match diff_hunk_to_display(&buffer_hunk, &snapshot) {
415 DisplayDiffHunk::Folded { display_row } => {
416 recalculated_hunks.next();
417 if !expanded_hunk.folded
418 && expanded_hunk_display_range
419 .to_inclusive()
420 .contains(&display_row)
421 {
422 retain = true;
423 expanded_hunk.folded = true;
424 highlights_to_remove
425 .push(expanded_hunk.hunk_range.clone());
426 if let Some(block) = expanded_hunk.block.take() {
427 blocks_to_remove.insert(block);
428 }
429 break;
430 } else {
431 continue;
432 }
433 }
434 DisplayDiffHunk::Unfolded {
435 diff_base_byte_range,
436 display_row_range,
437 multi_buffer_range,
438 status,
439 } => {
440 let hunk_display_range = display_row_range;
441 if expanded_hunk_display_range.start
442 > hunk_display_range.end
443 {
444 recalculated_hunks.next();
445 continue;
446 } else if expanded_hunk_display_range.end
447 < hunk_display_range.start
448 {
449 break;
450 } else {
451 if !expanded_hunk.folded
452 && expanded_hunk_display_range == hunk_display_range
453 && expanded_hunk.status == hunk_status(buffer_hunk)
454 && expanded_hunk.diff_base_byte_range
455 == buffer_hunk.diff_base_byte_range
456 {
457 recalculated_hunks.next();
458 retain = true;
459 } else {
460 hunks_to_reexpand.push(HunkToExpand {
461 status,
462 multi_buffer_range,
463 diff_base_byte_range,
464 });
465 }
466 break;
467 }
468 }
469 }
470 }
471 }
472 if !retain {
473 blocks_to_remove.extend(expanded_hunk.block);
474 highlights_to_remove.push(expanded_hunk.hunk_range.clone());
475 }
476 retain
477 });
478
479 for removed_rows in highlights_to_remove {
480 editor.highlight_rows::<DiffRowHighlight>(
481 to_inclusive_row_range(removed_rows, &snapshot),
482 None,
483 false,
484 cx,
485 );
486 }
487 editor.remove_blocks(blocks_to_remove, None, cx);
488
489 if let Some(diff_base_buffer) = &diff_base_buffer {
490 for hunk in hunks_to_reexpand {
491 editor.expand_diff_hunk(Some(diff_base_buffer.clone()), &hunk, cx);
492 }
493 }
494 })
495 .ok();
496 });
497
498 self.expanded_hunks.hunk_update_tasks.insert(
499 Some(buffer_id),
500 cx.background_executor().spawn(new_sync_task),
501 );
502 }
503
504 fn current_diff_base_buffer(
505 &mut self,
506 buffer: &Model<Buffer>,
507 cx: &mut AppContext,
508 ) -> Option<Model<Buffer>> {
509 buffer.update(cx, |buffer, _| {
510 match self.expanded_hunks.diff_base.entry(buffer.remote_id()) {
511 hash_map::Entry::Occupied(o) => {
512 if o.get().diff_base_version != buffer.diff_base_version() {
513 o.remove();
514 None
515 } else {
516 Some(o.get().buffer.clone())
517 }
518 }
519 hash_map::Entry::Vacant(_) => None,
520 }
521 })
522 }
523}
524
525fn create_diff_base_buffer(buffer: &Model<Buffer>, cx: &mut AppContext) -> Option<Model<Buffer>> {
526 buffer
527 .update(cx, |buffer, _| {
528 let language = buffer.language().cloned();
529 let diff_base = buffer.diff_base()?.clone();
530 Some((buffer.line_ending(), diff_base, language))
531 })
532 .map(|(line_ending, diff_base, language)| {
533 cx.new_model(|cx| {
534 let buffer = Buffer::local_normalized(diff_base, line_ending, cx);
535 match language {
536 Some(language) => buffer.with_language(language, cx),
537 None => buffer,
538 }
539 })
540 })
541}
542
543fn added_hunk_color(cx: &AppContext) -> Hsla {
544 let mut created_color = cx.theme().status().git().created;
545 created_color.fade_out(0.7);
546 created_color
547}
548
549fn deleted_hunk_color(cx: &AppContext) -> Hsla {
550 let mut deleted_color = cx.theme().status().git().deleted;
551 deleted_color.fade_out(0.7);
552 deleted_color
553}
554
555fn editor_with_deleted_text(
556 diff_base_buffer: Model<Buffer>,
557 deleted_color: Hsla,
558 hunk: &HunkToExpand,
559 cx: &mut ViewContext<'_, Editor>,
560) -> (u8, View<Editor>) {
561 let parent_editor = cx.view().downgrade();
562 let editor = cx.new_view(|cx| {
563 let multi_buffer =
564 cx.new_model(|_| MultiBuffer::without_headers(0, language::Capability::ReadOnly));
565 multi_buffer.update(cx, |multi_buffer, cx| {
566 multi_buffer.push_excerpts(
567 diff_base_buffer,
568 Some(ExcerptRange {
569 context: hunk.diff_base_byte_range.clone(),
570 primary: None,
571 }),
572 cx,
573 );
574 });
575
576 let mut editor = Editor::for_multibuffer(multi_buffer, None, true, cx);
577 editor.soft_wrap_mode_override = Some(language::language_settings::SoftWrap::None);
578 editor.show_wrap_guides = Some(false);
579 editor.show_gutter = false;
580 editor.scroll_manager.set_forbid_vertical_scroll(true);
581 editor.set_read_only(true);
582
583 let editor_snapshot = editor.snapshot(cx);
584 let start = editor_snapshot.buffer_snapshot.anchor_before(0);
585 let end = editor_snapshot
586 .buffer_snapshot
587 .anchor_after(editor.buffer.read(cx).len(cx));
588
589 editor.highlight_rows::<DiffRowHighlight>(start..=end, Some(deleted_color), false, cx);
590
591 let subscription_editor = parent_editor.clone();
592 editor._subscriptions.extend([
593 cx.on_blur(&editor.focus_handle, |editor, cx| {
594 editor.set_current_line_highlight(Some(CurrentLineHighlight::None));
595 editor.change_selections(None, cx, |s| {
596 s.try_cancel();
597 });
598 cx.notify();
599 }),
600 cx.on_focus(&editor.focus_handle, move |editor, cx| {
601 let restored_highlight = if let Some(parent_editor) = subscription_editor.upgrade()
602 {
603 parent_editor.read(cx).current_line_highlight
604 } else {
605 None
606 };
607 editor.set_current_line_highlight(restored_highlight);
608 cx.notify();
609 }),
610 cx.observe_global::<SettingsStore>(|editor, cx| {
611 if !editor.is_focused(cx) {
612 editor.set_current_line_highlight(Some(CurrentLineHighlight::None));
613 }
614 }),
615 ]);
616 let original_multi_buffer_range = hunk.multi_buffer_range.clone();
617 let diff_base_range = hunk.diff_base_byte_range.clone();
618 editor.register_action::<RevertSelectedHunks>(move |_, cx| {
619 parent_editor
620 .update(cx, |editor, cx| {
621 let Some((buffer, original_text)) = editor.buffer().update(cx, |buffer, cx| {
622 let (_, buffer, _) =
623 buffer.excerpt_containing(original_multi_buffer_range.start, cx)?;
624 let original_text =
625 buffer.read(cx).diff_base()?.slice(diff_base_range.clone());
626 Some((buffer, Arc::from(original_text.to_string())))
627 }) else {
628 return;
629 };
630 buffer.update(cx, |buffer, cx| {
631 buffer.edit(
632 Some((
633 original_multi_buffer_range.start.text_anchor
634 ..original_multi_buffer_range.end.text_anchor,
635 original_text,
636 )),
637 None,
638 cx,
639 )
640 });
641 })
642 .ok();
643 });
644 editor
645 });
646
647 let editor_height = editor.update(cx, |editor, cx| editor.max_point(cx).row().0 as u8);
648 (editor_height, editor)
649}
650
651fn buffer_diff_hunk(
652 buffer_snapshot: &MultiBufferSnapshot,
653 row_range: Range<Point>,
654) -> Option<DiffHunk<MultiBufferRow>> {
655 let mut hunks = buffer_snapshot.git_diff_hunks_in_range(
656 MultiBufferRow(row_range.start.row)..MultiBufferRow(row_range.end.row),
657 );
658 let hunk = hunks.next()?;
659 let second_hunk = hunks.next();
660 if second_hunk.is_none() {
661 return Some(hunk);
662 }
663 None
664}
665
666fn to_inclusive_row_range(
667 row_range: Range<Anchor>,
668 snapshot: &EditorSnapshot,
669) -> RangeInclusive<Anchor> {
670 let mut display_row_range =
671 row_range.start.to_display_point(snapshot)..row_range.end.to_display_point(snapshot);
672 if display_row_range.end.row() > display_row_range.start.row() {
673 *display_row_range.end.row_mut() -= 1;
674 }
675 let point_range = display_row_range.start.to_point(&snapshot.display_snapshot)
676 ..display_row_range.end.to_point(&snapshot.display_snapshot);
677 let new_range = point_range.to_anchors(&snapshot.buffer_snapshot);
678 new_range.start..=new_range.end
679}