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