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().to_string())
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 is_singleton(&self, _: &App) -> bool {
328 false
329 }
330
331 fn act_as_type<'a>(
332 &'a self,
333 type_id: TypeId,
334 self_handle: &'a Entity<Self>,
335 _: &'a App,
336 ) -> Option<AnyView> {
337 if type_id == TypeId::of::<Self>() {
338 Some(self_handle.to_any())
339 } else if type_id == TypeId::of::<Editor>() {
340 Some(self.diff_editor.to_any())
341 } else {
342 None
343 }
344 }
345
346 fn as_searchable(&self, _: &Entity<Self>) -> Option<Box<dyn SearchableItemHandle>> {
347 Some(Box::new(self.diff_editor.clone()))
348 }
349
350 fn for_each_project_item(
351 &self,
352 cx: &App,
353 f: &mut dyn FnMut(gpui::EntityId, &dyn project::ProjectItem),
354 ) {
355 self.diff_editor.for_each_project_item(cx, f)
356 }
357
358 fn set_nav_history(
359 &mut self,
360 nav_history: ItemNavHistory,
361 _: &mut Window,
362 cx: &mut Context<Self>,
363 ) {
364 self.diff_editor.update(cx, |editor, _| {
365 editor.set_nav_history(Some(nav_history));
366 });
367 }
368
369 fn navigate(
370 &mut self,
371 data: Box<dyn Any>,
372 window: &mut Window,
373 cx: &mut Context<Self>,
374 ) -> bool {
375 self.diff_editor
376 .update(cx, |editor, cx| editor.navigate(data, window, cx))
377 }
378
379 fn breadcrumb_location(&self, _: &App) -> ToolbarItemLocation {
380 ToolbarItemLocation::PrimaryLeft
381 }
382
383 fn breadcrumbs(&self, theme: &theme::Theme, cx: &App) -> Option<Vec<BreadcrumbText>> {
384 self.diff_editor.breadcrumbs(theme, cx)
385 }
386
387 fn added_to_workspace(
388 &mut self,
389 workspace: &mut Workspace,
390 window: &mut Window,
391 cx: &mut Context<Self>,
392 ) {
393 self.diff_editor.update(cx, |editor, cx| {
394 editor.added_to_workspace(workspace, window, cx)
395 });
396 }
397
398 fn can_save(&self, cx: &App) -> bool {
399 // The editor handles the new buffer, so delegate to it
400 self.diff_editor.read(cx).can_save(cx)
401 }
402
403 fn save(
404 &mut self,
405 options: SaveOptions,
406 project: Entity<Project>,
407 window: &mut Window,
408 cx: &mut Context<Self>,
409 ) -> Task<Result<()>> {
410 // Delegate saving to the editor, which manages the new buffer
411 self.diff_editor
412 .update(cx, |editor, cx| editor.save(options, project, window, cx))
413 }
414}
415
416pub fn selection_location_text(editor: &Editor, cx: &App) -> Option<String> {
417 let buffer = editor.buffer().read(cx);
418 let buffer_snapshot = buffer.snapshot(cx);
419 let first_selection = editor.selections.disjoint.first()?;
420
421 let selection_start = first_selection.start.to_point(&buffer_snapshot);
422 let selection_end = first_selection.end.to_point(&buffer_snapshot);
423
424 let start_row = selection_start.row;
425 let start_column = selection_start.column;
426 let end_row = selection_end.row;
427 let end_column = selection_end.column;
428
429 let range_text = if start_row == end_row {
430 format!("L{}:{}-{}", start_row + 1, start_column + 1, end_column + 1)
431 } else {
432 format!(
433 "L{}:{}-L{}:{}",
434 start_row + 1,
435 start_column + 1,
436 end_row + 1,
437 end_column + 1
438 )
439 };
440
441 Some(range_text)
442}
443
444impl Render for TextDiffView {
445 fn render(&mut self, _: &mut Window, _: &mut Context<Self>) -> impl IntoElement {
446 self.diff_editor.clone()
447 }
448}
449
450#[cfg(test)]
451mod tests {
452 use super::*;
453 use editor::test::editor_test_context::assert_state_with_diff;
454 use gpui::{TestAppContext, VisualContext};
455 use project::{FakeFs, Project};
456 use serde_json::json;
457 use settings::{Settings, SettingsStore};
458 use unindent::unindent;
459 use util::{path, test::marked_text_ranges};
460
461 fn init_test(cx: &mut TestAppContext) {
462 cx.update(|cx| {
463 let settings_store = SettingsStore::test(cx);
464 cx.set_global(settings_store);
465 language::init(cx);
466 Project::init_settings(cx);
467 workspace::init_settings(cx);
468 editor::init_settings(cx);
469 theme::ThemeSettings::register(cx)
470 });
471 }
472
473 #[gpui::test]
474 async fn test_diffing_clipboard_against_empty_selection_uses_full_buffer_selection(
475 cx: &mut TestAppContext,
476 ) {
477 base_test(
478 path!("/test"),
479 path!("/test/text.txt"),
480 "def process_incoming_inventory(items, warehouse_id):\n pass\n",
481 "def process_outgoing_inventory(items, warehouse_id):\n passˇ\n",
482 &unindent(
483 "
484 - def process_incoming_inventory(items, warehouse_id):
485 + ˇdef process_outgoing_inventory(items, warehouse_id):
486 pass
487 ",
488 ),
489 "Clipboard ↔ text.txt @ L1:1-L3:1",
490 &format!("Clipboard ↔ {} @ L1:1-L3:1", path!("test/text.txt")),
491 cx,
492 )
493 .await;
494 }
495
496 #[gpui::test]
497 async fn test_diffing_clipboard_against_multiline_selection_expands_to_full_lines(
498 cx: &mut TestAppContext,
499 ) {
500 base_test(
501 path!("/test"),
502 path!("/test/text.txt"),
503 "def process_incoming_inventory(items, warehouse_id):\n pass\n",
504 "«def process_outgoing_inventory(items, warehouse_id):\n passˇ»\n",
505 &unindent(
506 "
507 - def process_incoming_inventory(items, warehouse_id):
508 + ˇdef process_outgoing_inventory(items, warehouse_id):
509 pass
510 ",
511 ),
512 "Clipboard ↔ text.txt @ L1:1-L3:1",
513 &format!("Clipboard ↔ {} @ L1:1-L3:1", path!("test/text.txt")),
514 cx,
515 )
516 .await;
517 }
518
519 #[gpui::test]
520 async fn test_diffing_clipboard_against_single_line_selection(cx: &mut TestAppContext) {
521 base_test(
522 path!("/test"),
523 path!("/test/text.txt"),
524 "a",
525 "«bbˇ»",
526 &unindent(
527 "
528 - a
529 + ˇbb",
530 ),
531 "Clipboard ↔ text.txt @ L1:1-3",
532 &format!("Clipboard ↔ {} @ L1:1-3", path!("test/text.txt")),
533 cx,
534 )
535 .await;
536 }
537
538 #[gpui::test]
539 async fn test_diffing_clipboard_with_leading_whitespace_against_line(cx: &mut TestAppContext) {
540 base_test(
541 path!("/test"),
542 path!("/test/text.txt"),
543 " a",
544 "«bbˇ»",
545 &unindent(
546 "
547 - a
548 + ˇbb",
549 ),
550 "Clipboard ↔ text.txt @ L1:1-3",
551 &format!("Clipboard ↔ {} @ L1:1-3", path!("test/text.txt")),
552 cx,
553 )
554 .await;
555 }
556
557 #[gpui::test]
558 async fn test_diffing_clipboard_against_line_with_leading_whitespace(cx: &mut TestAppContext) {
559 base_test(
560 path!("/test"),
561 path!("/test/text.txt"),
562 "a",
563 " «bbˇ»",
564 &unindent(
565 "
566 - a
567 + ˇ bb",
568 ),
569 "Clipboard ↔ text.txt @ L1:1-7",
570 &format!("Clipboard ↔ {} @ L1:1-7", path!("test/text.txt")),
571 cx,
572 )
573 .await;
574 }
575
576 #[gpui::test]
577 async fn test_diffing_clipboard_against_line_with_leading_whitespace_included_in_selection(
578 cx: &mut TestAppContext,
579 ) {
580 base_test(
581 path!("/test"),
582 path!("/test/text.txt"),
583 "a",
584 "« bbˇ»",
585 &unindent(
586 "
587 - a
588 + ˇ bb",
589 ),
590 "Clipboard ↔ text.txt @ L1:1-7",
591 &format!("Clipboard ↔ {} @ L1:1-7", path!("test/text.txt")),
592 cx,
593 )
594 .await;
595 }
596
597 #[gpui::test]
598 async fn test_diffing_clipboard_with_leading_whitespace_against_line_with_leading_whitespace(
599 cx: &mut TestAppContext,
600 ) {
601 base_test(
602 path!("/test"),
603 path!("/test/text.txt"),
604 " a",
605 " «bbˇ»",
606 &unindent(
607 "
608 - a
609 + ˇ bb",
610 ),
611 "Clipboard ↔ text.txt @ L1:1-7",
612 &format!("Clipboard ↔ {} @ L1:1-7", path!("test/text.txt")),
613 cx,
614 )
615 .await;
616 }
617
618 #[gpui::test]
619 async fn test_diffing_clipboard_with_leading_whitespace_against_line_with_leading_whitespace_included_in_selection(
620 cx: &mut TestAppContext,
621 ) {
622 base_test(
623 path!("/test"),
624 path!("/test/text.txt"),
625 " a",
626 "« bbˇ»",
627 &unindent(
628 "
629 - a
630 + ˇ bb",
631 ),
632 "Clipboard ↔ text.txt @ L1:1-7",
633 &format!("Clipboard ↔ {} @ L1:1-7", path!("test/text.txt")),
634 cx,
635 )
636 .await;
637 }
638
639 #[gpui::test]
640 async fn test_diffing_clipboard_against_partial_selection_expands_to_include_trailing_characters(
641 cx: &mut TestAppContext,
642 ) {
643 base_test(
644 path!("/test"),
645 path!("/test/text.txt"),
646 "a",
647 "«bˇ»b",
648 &unindent(
649 "
650 - a
651 + ˇbb",
652 ),
653 "Clipboard ↔ text.txt @ L1:1-3",
654 &format!("Clipboard ↔ {} @ L1:1-3", path!("test/text.txt")),
655 cx,
656 )
657 .await;
658 }
659
660 async fn base_test(
661 project_root: &str,
662 file_path: &str,
663 clipboard_text: &str,
664 editor_text: &str,
665 expected_diff: &str,
666 expected_tab_title: &str,
667 expected_tab_tooltip: &str,
668 cx: &mut TestAppContext,
669 ) {
670 init_test(cx);
671
672 let file_name = std::path::Path::new(file_path)
673 .file_name()
674 .unwrap()
675 .to_str()
676 .unwrap();
677
678 let fs = FakeFs::new(cx.executor());
679 fs.insert_tree(
680 project_root,
681 json!({
682 file_name: editor_text
683 }),
684 )
685 .await;
686
687 let project = Project::test(fs, [project_root.as_ref()], cx).await;
688
689 let (workspace, cx) =
690 cx.add_window_view(|window, cx| Workspace::test_new(project.clone(), window, cx));
691
692 let buffer = project
693 .update(cx, |project, cx| project.open_local_buffer(file_path, cx))
694 .await
695 .unwrap();
696
697 let editor = cx.new_window_entity(|window, cx| {
698 let mut editor = Editor::for_buffer(buffer, None, window, cx);
699 let (unmarked_text, selection_ranges) = marked_text_ranges(editor_text, false);
700 editor.set_text(unmarked_text, window, cx);
701 editor.change_selections(Default::default(), window, cx, |s| {
702 s.select_ranges(selection_ranges)
703 });
704
705 editor
706 });
707
708 let diff_view = workspace
709 .update_in(cx, |workspace, window, cx| {
710 TextDiffView::open(
711 &DiffClipboardWithSelectionData {
712 clipboard_text: clipboard_text.to_string(),
713 editor,
714 },
715 workspace,
716 window,
717 cx,
718 )
719 })
720 .unwrap()
721 .await
722 .unwrap();
723
724 cx.executor().run_until_parked();
725
726 assert_state_with_diff(
727 &diff_view.read_with(cx, |diff_view, _| diff_view.diff_editor.clone()),
728 cx,
729 expected_diff,
730 );
731
732 diff_view.read_with(cx, |diff_view, cx| {
733 assert_eq!(diff_view.tab_content_text(0, cx), expected_tab_title);
734 assert_eq!(
735 diff_view.tab_tooltip_text(cx).unwrap(),
736 expected_tab_tooltip
737 );
738 });
739 }
740}