1//! TextDiffView currently provides a UI for displaying differences between the clipboard and selected text.
2
3use anyhow::Result;
4use buffer_diff::{BufferDiff, BufferDiffSnapshot};
5use editor::{Editor, EditorEvent, MultiBuffer, ToPoint, actions::DiffClipboardWithSelectionData};
6use futures::{FutureExt, select_biased};
7use gpui::{
8 AnyElement, AnyView, App, AppContext as _, AsyncApp, Context, Entity, EventEmitter,
9 FocusHandle, Focusable, IntoElement, Render, Task, Window,
10};
11use language::{self, Buffer, Point};
12use project::Project;
13use std::{
14 any::{Any, TypeId},
15 cmp,
16 ops::Range,
17 pin::pin,
18 sync::Arc,
19 time::Duration,
20};
21use ui::{Color, Icon, IconName, Label, LabelCommon as _, SharedString};
22use util::paths::PathExt;
23
24use workspace::{
25 Item, ItemHandle as _, ItemNavHistory, ToolbarItemLocation, Workspace,
26 item::{BreadcrumbText, ItemEvent, SaveOptions, TabContentParams},
27 searchable::SearchableItemHandle,
28};
29
30pub struct TextDiffView {
31 diff_editor: Entity<Editor>,
32 title: SharedString,
33 path: Option<SharedString>,
34 buffer_changes_tx: watch::Sender<()>,
35 _recalculate_diff_task: Task<Result<()>>,
36}
37
38const RECALCULATE_DIFF_DEBOUNCE: Duration = Duration::from_millis(250);
39
40impl TextDiffView {
41 pub fn open(
42 diff_data: &DiffClipboardWithSelectionData,
43 workspace: &Workspace,
44 window: &mut Window,
45 cx: &mut App,
46 ) -> Option<Task<Result<Entity<Self>>>> {
47 let source_editor = diff_data.editor.clone();
48
49 let selection_data = source_editor.update(cx, |editor, cx| {
50 let multibuffer = editor.buffer().read(cx);
51 let source_buffer = multibuffer.as_singleton()?;
52 let selections = editor.selections.all::<Point>(cx);
53 let buffer_snapshot = source_buffer.read(cx);
54 let first_selection = selections.first()?;
55 let max_point = buffer_snapshot.max_point();
56
57 if first_selection.is_empty() {
58 let full_range = Point::new(0, 0)..max_point;
59 return Some((source_buffer, full_range));
60 }
61
62 let start = first_selection.start;
63 let end = first_selection.end;
64 let expanded_start = Point::new(start.row, 0);
65
66 let expanded_end = if end.column > 0 {
67 let next_row = end.row + 1;
68 cmp::min(max_point, Point::new(next_row, 0))
69 } else {
70 end
71 };
72 Some((source_buffer, expanded_start..expanded_end))
73 });
74
75 let Some((source_buffer, expanded_selection_range)) = selection_data else {
76 log::warn!("There should always be at least one selection in Zed. This is a bug.");
77 return None;
78 };
79
80 source_editor.update(cx, |source_editor, cx| {
81 source_editor.change_selections(Default::default(), window, cx, |s| {
82 s.select_ranges(vec![
83 expanded_selection_range.start..expanded_selection_range.end,
84 ]);
85 })
86 });
87
88 let source_buffer_snapshot = source_buffer.read(cx).snapshot();
89 let mut clipboard_text = diff_data.clipboard_text.clone();
90
91 if !clipboard_text.ends_with("\n") {
92 clipboard_text.push_str("\n");
93 }
94
95 let workspace = workspace.weak_handle();
96 let diff_buffer = cx.new(|cx| BufferDiff::new(&source_buffer_snapshot.text, cx));
97 let clipboard_buffer = build_clipboard_buffer(
98 clipboard_text,
99 &source_buffer,
100 expanded_selection_range.clone(),
101 cx,
102 );
103
104 let task = window.spawn(cx, async move |cx| {
105 let project = workspace.update(cx, |workspace, _| workspace.project().clone())?;
106
107 update_diff_buffer(&diff_buffer, &source_buffer, &clipboard_buffer, cx).await?;
108
109 workspace.update_in(cx, |workspace, window, cx| {
110 let diff_view = cx.new(|cx| {
111 TextDiffView::new(
112 clipboard_buffer,
113 source_editor,
114 source_buffer,
115 expanded_selection_range,
116 diff_buffer,
117 project,
118 window,
119 cx,
120 )
121 });
122
123 let pane = workspace.active_pane();
124 pane.update(cx, |pane, cx| {
125 pane.add_item(Box::new(diff_view.clone()), true, true, None, window, cx);
126 });
127
128 diff_view
129 })
130 });
131
132 Some(task)
133 }
134
135 pub fn new(
136 clipboard_buffer: Entity<Buffer>,
137 source_editor: Entity<Editor>,
138 source_buffer: Entity<Buffer>,
139 source_range: Range<Point>,
140 diff_buffer: Entity<BufferDiff>,
141 project: Entity<Project>,
142 window: &mut Window,
143 cx: &mut Context<Self>,
144 ) -> Self {
145 let multibuffer = cx.new(|cx| {
146 let mut multibuffer = MultiBuffer::new(language::Capability::ReadWrite);
147
148 multibuffer.push_excerpts(
149 source_buffer.clone(),
150 [editor::ExcerptRange::new(source_range)],
151 cx,
152 );
153
154 multibuffer.add_diff(diff_buffer.clone(), cx);
155 multibuffer
156 });
157 let diff_editor = cx.new(|cx| {
158 let mut editor = Editor::for_multibuffer(multibuffer, Some(project), window, cx);
159 editor.start_temporary_diff_override();
160 editor.disable_diagnostics(cx);
161 editor.set_expand_all_diff_hunks(cx);
162 editor.set_render_diff_hunk_controls(
163 Arc::new(|_, _, _, _, _, _, _, _| gpui::Empty.into_any_element()),
164 cx,
165 );
166 editor
167 });
168
169 let (buffer_changes_tx, mut buffer_changes_rx) = watch::channel(());
170
171 cx.subscribe(&source_buffer, move |this, _, event, _| match event {
172 language::BufferEvent::Edited
173 | language::BufferEvent::LanguageChanged
174 | language::BufferEvent::Reparsed => {
175 this.buffer_changes_tx.send(()).ok();
176 }
177 _ => {}
178 })
179 .detach();
180
181 let editor = source_editor.read(cx);
182 let title = editor.buffer().read(cx).title(cx).to_string();
183 let selection_location_text = selection_location_text(editor, cx);
184 let selection_location_title = selection_location_text
185 .as_ref()
186 .map(|text| format!("{} @ {}", title, text))
187 .unwrap_or(title);
188
189 let path = editor
190 .buffer()
191 .read(cx)
192 .as_singleton()
193 .and_then(|b| {
194 b.read(cx)
195 .file()
196 .map(|f| f.full_path(cx).compact().to_string_lossy().into_owned())
197 })
198 .unwrap_or("untitled".into());
199
200 let selection_location_path = selection_location_text
201 .map(|text| format!("{} @ {}", path, text))
202 .unwrap_or(path);
203
204 Self {
205 diff_editor,
206 title: format!("Clipboard ↔ {selection_location_title}").into(),
207 path: Some(format!("Clipboard ↔ {selection_location_path}").into()),
208 buffer_changes_tx,
209 _recalculate_diff_task: cx.spawn(async move |_, cx| {
210 while buffer_changes_rx.recv().await.is_ok() {
211 loop {
212 let mut timer = cx
213 .background_executor()
214 .timer(RECALCULATE_DIFF_DEBOUNCE)
215 .fuse();
216 let mut recv = pin!(buffer_changes_rx.recv().fuse());
217 select_biased! {
218 _ = timer => break,
219 _ = recv => continue,
220 }
221 }
222
223 log::trace!("start recalculating");
224 update_diff_buffer(&diff_buffer, &source_buffer, &clipboard_buffer, cx).await?;
225 log::trace!("finish recalculating");
226 }
227 Ok(())
228 }),
229 }
230 }
231}
232
233fn build_clipboard_buffer(
234 text: String,
235 source_buffer: &Entity<Buffer>,
236 replacement_range: Range<Point>,
237 cx: &mut App,
238) -> Entity<Buffer> {
239 let source_buffer_snapshot = source_buffer.read(cx).snapshot();
240 cx.new(|cx| {
241 let mut buffer = language::Buffer::local(source_buffer_snapshot.text(), cx);
242 let language = source_buffer.read(cx).language().cloned();
243 buffer.set_language(language, cx);
244
245 let range_start = source_buffer_snapshot.point_to_offset(replacement_range.start);
246 let range_end = source_buffer_snapshot.point_to_offset(replacement_range.end);
247 buffer.edit([(range_start..range_end, text)], None, cx);
248
249 buffer
250 })
251}
252
253async fn update_diff_buffer(
254 diff: &Entity<BufferDiff>,
255 source_buffer: &Entity<Buffer>,
256 clipboard_buffer: &Entity<Buffer>,
257 cx: &mut AsyncApp,
258) -> Result<()> {
259 let source_buffer_snapshot = source_buffer.read_with(cx, |buffer, _| buffer.snapshot())?;
260
261 let base_buffer_snapshot = clipboard_buffer.read_with(cx, |buffer, _| buffer.snapshot())?;
262 let base_text = base_buffer_snapshot.text();
263
264 let diff_snapshot = cx
265 .update(|cx| {
266 BufferDiffSnapshot::new_with_base_buffer(
267 source_buffer_snapshot.text.clone(),
268 Some(Arc::new(base_text)),
269 base_buffer_snapshot,
270 cx,
271 )
272 })?
273 .await;
274
275 diff.update(cx, |diff, cx| {
276 diff.set_snapshot(diff_snapshot, &source_buffer_snapshot.text, cx);
277 })?;
278 Ok(())
279}
280
281impl EventEmitter<EditorEvent> for TextDiffView {}
282
283impl Focusable for TextDiffView {
284 fn focus_handle(&self, cx: &App) -> FocusHandle {
285 self.diff_editor.focus_handle(cx)
286 }
287}
288
289impl Item for TextDiffView {
290 type Event = EditorEvent;
291
292 fn tab_icon(&self, _window: &Window, _cx: &App) -> Option<Icon> {
293 Some(Icon::new(IconName::Diff).color(Color::Muted))
294 }
295
296 fn tab_content(&self, params: TabContentParams, _window: &Window, cx: &App) -> AnyElement {
297 Label::new(self.tab_content_text(params.detail.unwrap_or_default(), cx))
298 .color(if params.selected {
299 Color::Default
300 } else {
301 Color::Muted
302 })
303 .into_any_element()
304 }
305
306 fn tab_content_text(&self, _detail: usize, _: &App) -> SharedString {
307 self.title.clone()
308 }
309
310 fn tab_tooltip_text(&self, _: &App) -> Option<SharedString> {
311 self.path.clone()
312 }
313
314 fn to_item_events(event: &EditorEvent, f: impl FnMut(ItemEvent)) {
315 Editor::to_item_events(event, f)
316 }
317
318 fn telemetry_event_text(&self) -> Option<&'static str> {
319 Some("Selection Diff View Opened")
320 }
321
322 fn deactivated(&mut self, window: &mut Window, cx: &mut Context<Self>) {
323 self.diff_editor
324 .update(cx, |editor, cx| editor.deactivated(window, cx));
325 }
326
327 fn act_as_type<'a>(
328 &'a self,
329 type_id: TypeId,
330 self_handle: &'a Entity<Self>,
331 _: &'a App,
332 ) -> Option<AnyView> {
333 if type_id == TypeId::of::<Self>() {
334 Some(self_handle.to_any())
335 } else if type_id == TypeId::of::<Editor>() {
336 Some(self.diff_editor.to_any())
337 } else {
338 None
339 }
340 }
341
342 fn as_searchable(&self, _: &Entity<Self>) -> Option<Box<dyn SearchableItemHandle>> {
343 Some(Box::new(self.diff_editor.clone()))
344 }
345
346 fn for_each_project_item(
347 &self,
348 cx: &App,
349 f: &mut dyn FnMut(gpui::EntityId, &dyn project::ProjectItem),
350 ) {
351 self.diff_editor.for_each_project_item(cx, f)
352 }
353
354 fn set_nav_history(
355 &mut self,
356 nav_history: ItemNavHistory,
357 _: &mut Window,
358 cx: &mut Context<Self>,
359 ) {
360 self.diff_editor.update(cx, |editor, _| {
361 editor.set_nav_history(Some(nav_history));
362 });
363 }
364
365 fn navigate(
366 &mut self,
367 data: Box<dyn Any>,
368 window: &mut Window,
369 cx: &mut Context<Self>,
370 ) -> bool {
371 self.diff_editor
372 .update(cx, |editor, cx| editor.navigate(data, window, cx))
373 }
374
375 fn breadcrumb_location(&self, _: &App) -> ToolbarItemLocation {
376 ToolbarItemLocation::PrimaryLeft
377 }
378
379 fn breadcrumbs(&self, theme: &theme::Theme, cx: &App) -> Option<Vec<BreadcrumbText>> {
380 self.diff_editor.breadcrumbs(theme, cx)
381 }
382
383 fn added_to_workspace(
384 &mut self,
385 workspace: &mut Workspace,
386 window: &mut Window,
387 cx: &mut Context<Self>,
388 ) {
389 self.diff_editor.update(cx, |editor, cx| {
390 editor.added_to_workspace(workspace, window, cx)
391 });
392 }
393
394 fn can_save(&self, cx: &App) -> bool {
395 // The editor handles the new buffer, so delegate to it
396 self.diff_editor.read(cx).can_save(cx)
397 }
398
399 fn save(
400 &mut self,
401 options: SaveOptions,
402 project: Entity<Project>,
403 window: &mut Window,
404 cx: &mut Context<Self>,
405 ) -> Task<Result<()>> {
406 // Delegate saving to the editor, which manages the new buffer
407 self.diff_editor
408 .update(cx, |editor, cx| editor.save(options, project, window, cx))
409 }
410}
411
412pub fn selection_location_text(editor: &Editor, cx: &App) -> Option<String> {
413 let buffer = editor.buffer().read(cx);
414 let buffer_snapshot = buffer.snapshot(cx);
415 let first_selection = editor.selections.disjoint_anchors().first()?;
416
417 let selection_start = first_selection.start.to_point(&buffer_snapshot);
418 let selection_end = first_selection.end.to_point(&buffer_snapshot);
419
420 let start_row = selection_start.row;
421 let start_column = selection_start.column;
422 let end_row = selection_end.row;
423 let end_column = selection_end.column;
424
425 let range_text = if start_row == end_row {
426 format!("L{}:{}-{}", start_row + 1, start_column + 1, end_column + 1)
427 } else {
428 format!(
429 "L{}:{}-L{}:{}",
430 start_row + 1,
431 start_column + 1,
432 end_row + 1,
433 end_column + 1
434 )
435 };
436
437 Some(range_text)
438}
439
440impl Render for TextDiffView {
441 fn render(&mut self, _: &mut Window, _: &mut Context<Self>) -> impl IntoElement {
442 self.diff_editor.clone()
443 }
444}
445
446#[cfg(test)]
447mod tests {
448 use super::*;
449 use editor::test::editor_test_context::assert_state_with_diff;
450 use gpui::{TestAppContext, VisualContext};
451 use project::{FakeFs, Project};
452 use serde_json::json;
453 use settings::{Settings, SettingsStore};
454 use unindent::unindent;
455 use util::{path, test::marked_text_ranges};
456
457 fn init_test(cx: &mut TestAppContext) {
458 cx.update(|cx| {
459 let settings_store = SettingsStore::test(cx);
460 cx.set_global(settings_store);
461 language::init(cx);
462 Project::init_settings(cx);
463 workspace::init_settings(cx);
464 editor::init_settings(cx);
465 theme::ThemeSettings::register(cx)
466 });
467 }
468
469 #[gpui::test]
470 async fn test_diffing_clipboard_against_empty_selection_uses_full_buffer_selection(
471 cx: &mut TestAppContext,
472 ) {
473 base_test(
474 path!("/test"),
475 path!("/test/text.txt"),
476 "def process_incoming_inventory(items, warehouse_id):\n pass\n",
477 "def process_outgoing_inventory(items, warehouse_id):\n passˇ\n",
478 &unindent(
479 "
480 - def process_incoming_inventory(items, warehouse_id):
481 + ˇdef process_outgoing_inventory(items, warehouse_id):
482 pass
483 ",
484 ),
485 "Clipboard ↔ text.txt @ L1:1-L3:1",
486 &format!("Clipboard ↔ {} @ L1:1-L3:1", path!("test/text.txt")),
487 cx,
488 )
489 .await;
490 }
491
492 #[gpui::test]
493 async fn test_diffing_clipboard_against_multiline_selection_expands_to_full_lines(
494 cx: &mut TestAppContext,
495 ) {
496 base_test(
497 path!("/test"),
498 path!("/test/text.txt"),
499 "def process_incoming_inventory(items, warehouse_id):\n pass\n",
500 "«def process_outgoing_inventory(items, warehouse_id):\n passˇ»\n",
501 &unindent(
502 "
503 - def process_incoming_inventory(items, warehouse_id):
504 + ˇdef process_outgoing_inventory(items, warehouse_id):
505 pass
506 ",
507 ),
508 "Clipboard ↔ text.txt @ L1:1-L3:1",
509 &format!("Clipboard ↔ {} @ L1:1-L3:1", path!("test/text.txt")),
510 cx,
511 )
512 .await;
513 }
514
515 #[gpui::test]
516 async fn test_diffing_clipboard_against_single_line_selection(cx: &mut TestAppContext) {
517 base_test(
518 path!("/test"),
519 path!("/test/text.txt"),
520 "a",
521 "«bbˇ»",
522 &unindent(
523 "
524 - a
525 + ˇbb",
526 ),
527 "Clipboard ↔ text.txt @ L1:1-3",
528 &format!("Clipboard ↔ {} @ L1:1-3", path!("test/text.txt")),
529 cx,
530 )
531 .await;
532 }
533
534 #[gpui::test]
535 async fn test_diffing_clipboard_with_leading_whitespace_against_line(cx: &mut TestAppContext) {
536 base_test(
537 path!("/test"),
538 path!("/test/text.txt"),
539 " a",
540 "«bbˇ»",
541 &unindent(
542 "
543 - a
544 + ˇbb",
545 ),
546 "Clipboard ↔ text.txt @ L1:1-3",
547 &format!("Clipboard ↔ {} @ L1:1-3", path!("test/text.txt")),
548 cx,
549 )
550 .await;
551 }
552
553 #[gpui::test]
554 async fn test_diffing_clipboard_against_line_with_leading_whitespace(cx: &mut TestAppContext) {
555 base_test(
556 path!("/test"),
557 path!("/test/text.txt"),
558 "a",
559 " «bbˇ»",
560 &unindent(
561 "
562 - a
563 + ˇ bb",
564 ),
565 "Clipboard ↔ text.txt @ L1:1-7",
566 &format!("Clipboard ↔ {} @ L1:1-7", path!("test/text.txt")),
567 cx,
568 )
569 .await;
570 }
571
572 #[gpui::test]
573 async fn test_diffing_clipboard_against_line_with_leading_whitespace_included_in_selection(
574 cx: &mut TestAppContext,
575 ) {
576 base_test(
577 path!("/test"),
578 path!("/test/text.txt"),
579 "a",
580 "« bbˇ»",
581 &unindent(
582 "
583 - a
584 + ˇ bb",
585 ),
586 "Clipboard ↔ text.txt @ L1:1-7",
587 &format!("Clipboard ↔ {} @ L1:1-7", path!("test/text.txt")),
588 cx,
589 )
590 .await;
591 }
592
593 #[gpui::test]
594 async fn test_diffing_clipboard_with_leading_whitespace_against_line_with_leading_whitespace(
595 cx: &mut TestAppContext,
596 ) {
597 base_test(
598 path!("/test"),
599 path!("/test/text.txt"),
600 " a",
601 " «bbˇ»",
602 &unindent(
603 "
604 - a
605 + ˇ bb",
606 ),
607 "Clipboard ↔ text.txt @ L1:1-7",
608 &format!("Clipboard ↔ {} @ L1:1-7", path!("test/text.txt")),
609 cx,
610 )
611 .await;
612 }
613
614 #[gpui::test]
615 async fn test_diffing_clipboard_with_leading_whitespace_against_line_with_leading_whitespace_included_in_selection(
616 cx: &mut TestAppContext,
617 ) {
618 base_test(
619 path!("/test"),
620 path!("/test/text.txt"),
621 " a",
622 "« bbˇ»",
623 &unindent(
624 "
625 - a
626 + ˇ bb",
627 ),
628 "Clipboard ↔ text.txt @ L1:1-7",
629 &format!("Clipboard ↔ {} @ L1:1-7", path!("test/text.txt")),
630 cx,
631 )
632 .await;
633 }
634
635 #[gpui::test]
636 async fn test_diffing_clipboard_against_partial_selection_expands_to_include_trailing_characters(
637 cx: &mut TestAppContext,
638 ) {
639 base_test(
640 path!("/test"),
641 path!("/test/text.txt"),
642 "a",
643 "«bˇ»b",
644 &unindent(
645 "
646 - a
647 + ˇbb",
648 ),
649 "Clipboard ↔ text.txt @ L1:1-3",
650 &format!("Clipboard ↔ {} @ L1:1-3", path!("test/text.txt")),
651 cx,
652 )
653 .await;
654 }
655
656 async fn base_test(
657 project_root: &str,
658 file_path: &str,
659 clipboard_text: &str,
660 editor_text: &str,
661 expected_diff: &str,
662 expected_tab_title: &str,
663 expected_tab_tooltip: &str,
664 cx: &mut TestAppContext,
665 ) {
666 init_test(cx);
667
668 let file_name = std::path::Path::new(file_path)
669 .file_name()
670 .unwrap()
671 .to_str()
672 .unwrap();
673
674 let fs = FakeFs::new(cx.executor());
675 fs.insert_tree(
676 project_root,
677 json!({
678 file_name: editor_text
679 }),
680 )
681 .await;
682
683 let project = Project::test(fs, [project_root.as_ref()], cx).await;
684
685 let (workspace, cx) =
686 cx.add_window_view(|window, cx| Workspace::test_new(project.clone(), window, cx));
687
688 let buffer = project
689 .update(cx, |project, cx| project.open_local_buffer(file_path, cx))
690 .await
691 .unwrap();
692
693 let editor = cx.new_window_entity(|window, cx| {
694 let mut editor = Editor::for_buffer(buffer, None, window, cx);
695 let (unmarked_text, selection_ranges) = marked_text_ranges(editor_text, false);
696 editor.set_text(unmarked_text, window, cx);
697 editor.change_selections(Default::default(), window, cx, |s| {
698 s.select_ranges(selection_ranges)
699 });
700
701 editor
702 });
703
704 let diff_view = workspace
705 .update_in(cx, |workspace, window, cx| {
706 TextDiffView::open(
707 &DiffClipboardWithSelectionData {
708 clipboard_text: clipboard_text.to_string(),
709 editor,
710 },
711 workspace,
712 window,
713 cx,
714 )
715 })
716 .unwrap()
717 .await
718 .unwrap();
719
720 cx.executor().run_until_parked();
721
722 assert_state_with_diff(
723 &diff_view.read_with(cx, |diff_view, _| diff_view.diff_editor.clone()),
724 cx,
725 expected_diff,
726 );
727
728 diff_view.read_with(cx, |diff_view, cx| {
729 assert_eq!(diff_view.tab_content_text(0, cx), expected_tab_title);
730 assert_eq!(
731 diff_view.tab_tooltip_text(cx).unwrap(),
732 expected_tab_tooltip
733 );
734 });
735 }
736}