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::{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, EditorSettings, 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 cx,
198 );
199 }
200 editor.remove_blocks(blocks_to_remove, None, cx);
201 for hunk in hunks_to_expand {
202 editor.expand_diff_hunk(None, &hunk, cx);
203 }
204 cx.notify();
205 })
206 .ok();
207 });
208
209 self.expanded_hunks
210 .hunk_update_tasks
211 .insert(None, cx.background_executor().spawn(new_toggle_task));
212 }
213
214 pub(super) fn expand_diff_hunk(
215 &mut self,
216 diff_base_buffer: Option<Model<Buffer>>,
217 hunk: &HunkToExpand,
218 cx: &mut ViewContext<'_, Editor>,
219 ) -> Option<()> {
220 let multi_buffer_snapshot = self.buffer().read(cx).snapshot(cx);
221 let multi_buffer_row_range = hunk
222 .multi_buffer_range
223 .start
224 .to_point(&multi_buffer_snapshot)
225 ..hunk.multi_buffer_range.end.to_point(&multi_buffer_snapshot);
226 let hunk_start = hunk.multi_buffer_range.start;
227 let hunk_end = hunk.multi_buffer_range.end;
228
229 let buffer = self.buffer().clone();
230 let snapshot = self.snapshot(cx);
231 let (diff_base_buffer, deleted_text_lines) = buffer.update(cx, |buffer, cx| {
232 let hunk = buffer_diff_hunk(&snapshot.buffer_snapshot, multi_buffer_row_range.clone())?;
233 let mut buffer_ranges = buffer.range_to_buffer_ranges(multi_buffer_row_range, cx);
234 if buffer_ranges.len() == 1 {
235 let (buffer, _, _) = buffer_ranges.pop()?;
236 let diff_base_buffer = diff_base_buffer
237 .or_else(|| self.current_diff_base_buffer(&buffer, cx))
238 .or_else(|| create_diff_base_buffer(&buffer, cx))?;
239 let buffer = buffer.read(cx);
240 let deleted_text_lines = buffer.diff_base().map(|diff_base| {
241 let diff_start_row = diff_base
242 .offset_to_point(hunk.diff_base_byte_range.start)
243 .row;
244 let diff_end_row = diff_base.offset_to_point(hunk.diff_base_byte_range.end).row;
245 let line_count = diff_end_row - diff_start_row;
246 line_count as u8
247 })?;
248 Some((diff_base_buffer, deleted_text_lines))
249 } else {
250 None
251 }
252 })?;
253
254 let block_insert_index = match self.expanded_hunks.hunks.binary_search_by(|probe| {
255 probe
256 .hunk_range
257 .start
258 .cmp(&hunk_start, &multi_buffer_snapshot)
259 }) {
260 Ok(_already_present) => return None,
261 Err(ix) => ix,
262 };
263
264 let block = match hunk.status {
265 DiffHunkStatus::Removed => {
266 self.insert_deleted_text_block(diff_base_buffer, deleted_text_lines, &hunk, cx)
267 }
268 DiffHunkStatus::Added => {
269 self.highlight_rows::<DiffRowHighlight>(
270 to_inclusive_row_range(hunk_start..hunk_end, &snapshot),
271 Some(added_hunk_color(cx)),
272 cx,
273 );
274 None
275 }
276 DiffHunkStatus::Modified => {
277 self.highlight_rows::<DiffRowHighlight>(
278 to_inclusive_row_range(hunk_start..hunk_end, &snapshot),
279 Some(added_hunk_color(cx)),
280 cx,
281 );
282 self.insert_deleted_text_block(diff_base_buffer, deleted_text_lines, &hunk, cx)
283 }
284 };
285 self.expanded_hunks.hunks.insert(
286 block_insert_index,
287 ExpandedHunk {
288 block,
289 hunk_range: hunk_start..hunk_end,
290 status: hunk.status,
291 folded: false,
292 diff_base_byte_range: hunk.diff_base_byte_range.clone(),
293 },
294 );
295
296 Some(())
297 }
298
299 fn insert_deleted_text_block(
300 &mut self,
301 diff_base_buffer: Model<Buffer>,
302 deleted_text_height: u8,
303 hunk: &HunkToExpand,
304 cx: &mut ViewContext<'_, Self>,
305 ) -> Option<BlockId> {
306 let deleted_hunk_color = deleted_hunk_color(cx);
307 let (editor_height, editor_with_deleted_text) =
308 editor_with_deleted_text(diff_base_buffer, deleted_hunk_color, hunk, cx);
309 let parent_gutter_offset = self.gutter_dimensions.width + self.gutter_dimensions.margin;
310 let mut new_block_ids = self.insert_blocks(
311 Some(BlockProperties {
312 position: hunk.multi_buffer_range.start,
313 height: editor_height.max(deleted_text_height),
314 style: BlockStyle::Flex,
315 render: Box::new(move |_| {
316 div()
317 .bg(deleted_hunk_color)
318 .size_full()
319 .pl(parent_gutter_offset)
320 .child(editor_with_deleted_text.clone())
321 .into_any_element()
322 }),
323 disposition: BlockDisposition::Above,
324 }),
325 None,
326 cx,
327 );
328 if new_block_ids.len() == 1 {
329 new_block_ids.pop()
330 } else {
331 debug_panic!(
332 "Inserted one editor block but did not receive exactly one block id: {new_block_ids:?}"
333 );
334 None
335 }
336 }
337
338 pub(super) fn clear_expanded_diff_hunks(&mut self, cx: &mut ViewContext<'_, Editor>) {
339 self.expanded_hunks.hunk_update_tasks.clear();
340 let to_remove = self
341 .expanded_hunks
342 .hunks
343 .drain(..)
344 .filter_map(|expanded_hunk| expanded_hunk.block)
345 .collect();
346 self.clear_row_highlights::<DiffRowHighlight>();
347 self.remove_blocks(to_remove, None, cx);
348 }
349
350 pub(super) fn sync_expanded_diff_hunks(
351 &mut self,
352 buffer: Model<Buffer>,
353 cx: &mut ViewContext<'_, Self>,
354 ) {
355 let buffer_id = buffer.read(cx).remote_id();
356 let buffer_diff_base_version = buffer.read(cx).diff_base_version();
357 self.expanded_hunks
358 .hunk_update_tasks
359 .remove(&Some(buffer_id));
360 let diff_base_buffer = self.current_diff_base_buffer(&buffer, cx);
361 let new_sync_task = cx.spawn(move |editor, mut cx| async move {
362 let diff_base_buffer_unchanged = diff_base_buffer.is_some();
363 let Ok(diff_base_buffer) =
364 cx.update(|cx| diff_base_buffer.or_else(|| create_diff_base_buffer(&buffer, cx)))
365 else {
366 return;
367 };
368 editor
369 .update(&mut cx, |editor, cx| {
370 if let Some(diff_base_buffer) = &diff_base_buffer {
371 editor.expanded_hunks.diff_base.insert(
372 buffer_id,
373 DiffBaseBuffer {
374 buffer: diff_base_buffer.clone(),
375 diff_base_version: buffer_diff_base_version,
376 },
377 );
378 }
379
380 let snapshot = editor.snapshot(cx);
381 let mut recalculated_hunks = snapshot
382 .buffer_snapshot
383 .git_diff_hunks_in_range(MultiBufferRow::MIN..MultiBufferRow::MAX)
384 .filter(|hunk| hunk.buffer_id == buffer_id)
385 .fuse()
386 .peekable();
387 let mut highlights_to_remove =
388 Vec::with_capacity(editor.expanded_hunks.hunks.len());
389 let mut blocks_to_remove = HashSet::default();
390 let mut hunks_to_reexpand =
391 Vec::with_capacity(editor.expanded_hunks.hunks.len());
392 editor.expanded_hunks.hunks.retain_mut(|expanded_hunk| {
393 if expanded_hunk.hunk_range.start.buffer_id != Some(buffer_id) {
394 return true;
395 };
396
397 let mut retain = false;
398 if diff_base_buffer_unchanged {
399 let expanded_hunk_display_range = expanded_hunk
400 .hunk_range
401 .start
402 .to_display_point(&snapshot)
403 .row()
404 ..expanded_hunk
405 .hunk_range
406 .end
407 .to_display_point(&snapshot)
408 .row();
409 while let Some(buffer_hunk) = recalculated_hunks.peek() {
410 match diff_hunk_to_display(&buffer_hunk, &snapshot) {
411 DisplayDiffHunk::Folded { display_row } => {
412 recalculated_hunks.next();
413 if !expanded_hunk.folded
414 && expanded_hunk_display_range
415 .to_inclusive()
416 .contains(&display_row)
417 {
418 retain = true;
419 expanded_hunk.folded = true;
420 highlights_to_remove
421 .push(expanded_hunk.hunk_range.clone());
422 if let Some(block) = expanded_hunk.block.take() {
423 blocks_to_remove.insert(block);
424 }
425 break;
426 } else {
427 continue;
428 }
429 }
430 DisplayDiffHunk::Unfolded {
431 diff_base_byte_range,
432 display_row_range,
433 multi_buffer_range,
434 status,
435 } => {
436 let hunk_display_range = display_row_range;
437 if expanded_hunk_display_range.start
438 > hunk_display_range.end
439 {
440 recalculated_hunks.next();
441 continue;
442 } else if expanded_hunk_display_range.end
443 < hunk_display_range.start
444 {
445 break;
446 } else {
447 if !expanded_hunk.folded
448 && expanded_hunk_display_range == hunk_display_range
449 && expanded_hunk.status == hunk_status(buffer_hunk)
450 && expanded_hunk.diff_base_byte_range
451 == buffer_hunk.diff_base_byte_range
452 {
453 recalculated_hunks.next();
454 retain = true;
455 } else {
456 hunks_to_reexpand.push(HunkToExpand {
457 status,
458 multi_buffer_range,
459 diff_base_byte_range,
460 });
461 }
462 break;
463 }
464 }
465 }
466 }
467 }
468 if !retain {
469 blocks_to_remove.extend(expanded_hunk.block);
470 highlights_to_remove.push(expanded_hunk.hunk_range.clone());
471 }
472 retain
473 });
474
475 for removed_rows in highlights_to_remove {
476 editor.highlight_rows::<DiffRowHighlight>(
477 to_inclusive_row_range(removed_rows, &snapshot),
478 None,
479 cx,
480 );
481 }
482 editor.remove_blocks(blocks_to_remove, None, cx);
483
484 if let Some(diff_base_buffer) = &diff_base_buffer {
485 for hunk in hunks_to_reexpand {
486 editor.expand_diff_hunk(Some(diff_base_buffer.clone()), &hunk, cx);
487 }
488 }
489 })
490 .ok();
491 });
492
493 self.expanded_hunks.hunk_update_tasks.insert(
494 Some(buffer_id),
495 cx.background_executor().spawn(new_sync_task),
496 );
497 }
498
499 fn current_diff_base_buffer(
500 &mut self,
501 buffer: &Model<Buffer>,
502 cx: &mut AppContext,
503 ) -> Option<Model<Buffer>> {
504 buffer.update(cx, |buffer, _| {
505 match self.expanded_hunks.diff_base.entry(buffer.remote_id()) {
506 hash_map::Entry::Occupied(o) => {
507 if o.get().diff_base_version != buffer.diff_base_version() {
508 o.remove();
509 None
510 } else {
511 Some(o.get().buffer.clone())
512 }
513 }
514 hash_map::Entry::Vacant(_) => None,
515 }
516 })
517 }
518}
519
520fn create_diff_base_buffer(buffer: &Model<Buffer>, cx: &mut AppContext) -> Option<Model<Buffer>> {
521 buffer
522 .update(cx, |buffer, _| {
523 let language = buffer.language().cloned();
524 let diff_base = buffer.diff_base()?.clone();
525 Some((buffer.line_ending(), diff_base, language))
526 })
527 .map(|(line_ending, diff_base, language)| {
528 cx.new_model(|cx| {
529 let buffer = Buffer::local_normalized(diff_base, line_ending, cx);
530 match language {
531 Some(language) => buffer.with_language(language, cx),
532 None => buffer,
533 }
534 })
535 })
536}
537
538fn added_hunk_color(cx: &AppContext) -> Hsla {
539 let mut created_color = cx.theme().status().git().created;
540 created_color.fade_out(0.7);
541 created_color
542}
543
544fn deleted_hunk_color(cx: &AppContext) -> Hsla {
545 let mut deleted_color = cx.theme().status().git().deleted;
546 deleted_color.fade_out(0.7);
547 deleted_color
548}
549
550fn editor_with_deleted_text(
551 diff_base_buffer: Model<Buffer>,
552 deleted_color: Hsla,
553 hunk: &HunkToExpand,
554 cx: &mut ViewContext<'_, Editor>,
555) -> (u8, View<Editor>) {
556 let parent_editor = cx.view().downgrade();
557 let editor = cx.new_view(|cx| {
558 let multi_buffer =
559 cx.new_model(|_| MultiBuffer::without_headers(0, language::Capability::ReadOnly));
560 multi_buffer.update(cx, |multi_buffer, cx| {
561 multi_buffer.push_excerpts(
562 diff_base_buffer,
563 Some(ExcerptRange {
564 context: hunk.diff_base_byte_range.clone(),
565 primary: None,
566 }),
567 cx,
568 );
569 });
570
571 let mut editor = Editor::for_multibuffer(multi_buffer, None, cx);
572 editor.soft_wrap_mode_override = Some(language::language_settings::SoftWrap::None);
573 editor.show_wrap_guides = Some(false);
574 editor.show_gutter = false;
575 editor.scroll_manager.set_forbid_vertical_scroll(true);
576 editor.set_read_only(true);
577
578 let editor_snapshot = editor.snapshot(cx);
579 let start = editor_snapshot.buffer_snapshot.anchor_before(0);
580 let end = editor_snapshot
581 .buffer_snapshot
582 .anchor_after(editor.buffer.read(cx).len(cx));
583
584 editor.highlight_rows::<DiffRowHighlight>(start..=end, Some(deleted_color), cx);
585
586 let subscription_editor = parent_editor.clone();
587 editor._subscriptions.extend([
588 cx.on_blur(&editor.focus_handle, |editor, cx| {
589 editor.set_current_line_highlight(CurrentLineHighlight::None);
590 editor.change_selections(None, cx, |s| {
591 s.try_cancel();
592 });
593 cx.notify();
594 }),
595 cx.on_focus(&editor.focus_handle, move |editor, cx| {
596 let restored_highlight = if let Some(parent_editor) = subscription_editor.upgrade()
597 {
598 parent_editor.read(cx).current_line_highlight
599 } else {
600 EditorSettings::get_global(cx).current_line_highlight
601 };
602 editor.set_current_line_highlight(restored_highlight);
603 cx.notify();
604 }),
605 cx.observe_global::<SettingsStore>(|editor, cx| {
606 if !editor.is_focused(cx) {
607 editor.set_current_line_highlight(CurrentLineHighlight::None);
608 }
609 }),
610 ]);
611 let original_multi_buffer_range = hunk.multi_buffer_range.clone();
612 let diff_base_range = hunk.diff_base_byte_range.clone();
613 editor.register_action::<RevertSelectedHunks>(move |_, cx| {
614 parent_editor
615 .update(cx, |editor, cx| {
616 let Some((buffer, original_text)) = editor.buffer().update(cx, |buffer, cx| {
617 let (_, buffer, _) =
618 buffer.excerpt_containing(original_multi_buffer_range.start, cx)?;
619 let original_text =
620 buffer.read(cx).diff_base()?.slice(diff_base_range.clone());
621 Some((buffer, Arc::from(original_text.to_string())))
622 }) else {
623 return;
624 };
625 buffer.update(cx, |buffer, cx| {
626 buffer.edit(
627 Some((
628 original_multi_buffer_range.start.text_anchor
629 ..original_multi_buffer_range.end.text_anchor,
630 original_text,
631 )),
632 None,
633 cx,
634 )
635 });
636 })
637 .ok();
638 });
639 editor
640 });
641
642 let editor_height = editor.update(cx, |editor, cx| editor.max_point(cx).row().0 as u8);
643 (editor_height, editor)
644}
645
646fn buffer_diff_hunk(
647 buffer_snapshot: &MultiBufferSnapshot,
648 row_range: Range<Point>,
649) -> Option<DiffHunk<MultiBufferRow>> {
650 let mut hunks = buffer_snapshot.git_diff_hunks_in_range(
651 MultiBufferRow(row_range.start.row)..MultiBufferRow(row_range.end.row),
652 );
653 let hunk = hunks.next()?;
654 let second_hunk = hunks.next();
655 if second_hunk.is_none() {
656 return Some(hunk);
657 }
658 None
659}
660
661fn to_inclusive_row_range(
662 row_range: Range<Anchor>,
663 snapshot: &EditorSnapshot,
664) -> RangeInclusive<Anchor> {
665 let mut display_row_range =
666 row_range.start.to_display_point(snapshot)..row_range.end.to_display_point(snapshot);
667 if display_row_range.end.row() > display_row_range.start.row() {
668 *display_row_range.end.row_mut() -= 1;
669 }
670 let point_range = display_row_range.start.to_point(&snapshot.display_snapshot)
671 ..display_row_range.end.to_point(&snapshot.display_snapshot);
672 let new_range = point_range.to_anchors(&snapshot.buffer_snapshot);
673 new_range.start..=new_range.end
674}