1use crate::{
2 ActiveDiagnostic, Anchor, AnchorRangeExt, DisplayPoint, DisplayRow, Editor, EditorSettings,
3 EditorSnapshot, GlobalDiagnosticRenderer, HighlightKey, Hover,
4 display_map::{InlayOffset, ToDisplayPoint, is_invisible},
5 hover_links::{InlayHighlight, RangeInEditor},
6 movement::TextLayoutDetails,
7 scroll::ScrollAmount,
8};
9use anyhow::Context as _;
10use gpui::{
11 AnyElement, AsyncWindowContext, Context, Entity, Focusable as _, FontWeight, Hsla,
12 InteractiveElement, IntoElement, MouseButton, ParentElement, Pixels, ScrollHandle, Size,
13 StatefulInteractiveElement, StyleRefinement, Styled, Subscription, Task, TextStyleRefinement,
14 Window, div, px,
15};
16use itertools::Itertools;
17use language::{DiagnosticEntry, Language, LanguageRegistry};
18use lsp::DiagnosticSeverity;
19use markdown::{Markdown, MarkdownElement, MarkdownStyle};
20use multi_buffer::{MultiBufferOffset, ToOffset, ToPoint};
21use project::{HoverBlock, HoverBlockKind, InlayHintLabelPart};
22use settings::Settings;
23use std::{borrow::Cow, cell::RefCell};
24use std::{ops::Range, sync::Arc, time::Duration};
25use std::{path::PathBuf, rc::Rc};
26use theme::ThemeSettings;
27use ui::{CopyButton, Scrollbars, WithScrollbar, prelude::*, theme_is_transparent};
28use url::Url;
29use util::TryFutureExt;
30use workspace::{OpenOptions, OpenVisible, Workspace};
31
32pub const MIN_POPOVER_CHARACTER_WIDTH: f32 = 20.;
33pub const MIN_POPOVER_LINE_HEIGHT: f32 = 4.;
34pub const POPOVER_RIGHT_OFFSET: Pixels = px(8.0);
35pub const HOVER_POPOVER_GAP: Pixels = px(10.);
36
37/// Bindable action which uses the most recent selection head to trigger a hover
38pub fn hover(editor: &mut Editor, _: &Hover, window: &mut Window, cx: &mut Context<Editor>) {
39 let head = editor.selections.newest_anchor().head();
40 show_hover(editor, head, true, window, cx);
41}
42
43/// The internal hover action dispatches between `show_hover` or `hide_hover`
44/// depending on whether a point to hover over is provided.
45pub fn hover_at(
46 editor: &mut Editor,
47 anchor: Option<Anchor>,
48 window: &mut Window,
49 cx: &mut Context<Editor>,
50) {
51 if EditorSettings::get_global(cx).hover_popover_enabled {
52 if show_keyboard_hover(editor, window, cx) {
53 return;
54 }
55 if let Some(anchor) = anchor {
56 show_hover(editor, anchor, false, window, cx);
57 } else {
58 hide_hover(editor, cx);
59 }
60 }
61}
62
63pub fn show_keyboard_hover(
64 editor: &mut Editor,
65 window: &mut Window,
66 cx: &mut Context<Editor>,
67) -> bool {
68 if let Some(anchor) = editor.hover_state.info_popovers.iter().find_map(|p| {
69 if *p.keyboard_grace.borrow() {
70 p.anchor
71 } else {
72 None
73 }
74 }) {
75 show_hover(editor, anchor, false, window, cx);
76 return true;
77 }
78
79 if let Some(anchor) = editor
80 .hover_state
81 .diagnostic_popover
82 .as_ref()
83 .and_then(|d| {
84 if *d.keyboard_grace.borrow() {
85 Some(d.anchor)
86 } else {
87 None
88 }
89 })
90 {
91 show_hover(editor, anchor, false, window, cx);
92 return true;
93 }
94
95 false
96}
97
98pub struct InlayHover {
99 pub(crate) range: InlayHighlight,
100 pub tooltip: HoverBlock,
101}
102
103pub fn find_hovered_hint_part(
104 label_parts: Vec<InlayHintLabelPart>,
105 hint_start: InlayOffset,
106 hovered_offset: InlayOffset,
107) -> Option<(InlayHintLabelPart, Range<InlayOffset>)> {
108 if hovered_offset >= hint_start {
109 let mut offset_in_hint = hovered_offset - hint_start;
110 let mut part_start = hint_start;
111 for part in label_parts {
112 let part_len = part.value.len();
113 if offset_in_hint >= part_len {
114 offset_in_hint -= part_len;
115 part_start.0 += part_len;
116 } else {
117 let part_end = InlayOffset(part_start.0 + part_len);
118 return Some((part, part_start..part_end));
119 }
120 }
121 }
122 None
123}
124
125pub fn hover_at_inlay(
126 editor: &mut Editor,
127 inlay_hover: InlayHover,
128 window: &mut Window,
129 cx: &mut Context<Editor>,
130) {
131 if EditorSettings::get_global(cx).hover_popover_enabled {
132 if editor.pending_rename.is_some() {
133 return;
134 }
135
136 let Some(project) = editor.project.clone() else {
137 return;
138 };
139
140 if editor
141 .hover_state
142 .info_popovers
143 .iter()
144 .any(|InfoPopover { symbol_range, .. }| {
145 if let RangeInEditor::Inlay(range) = symbol_range
146 && range == &inlay_hover.range
147 {
148 // Hover triggered from same location as last time. Don't show again.
149 return true;
150 }
151 false
152 })
153 {
154 return;
155 }
156
157 let hover_popover_delay = EditorSettings::get_global(cx).hover_popover_delay.0;
158
159 let task = cx.spawn_in(window, async move |this, cx| {
160 async move {
161 cx.background_executor()
162 .timer(Duration::from_millis(hover_popover_delay))
163 .await;
164 this.update(cx, |this, _| {
165 this.hover_state.diagnostic_popover = None;
166 })?;
167
168 let language_registry = project.read_with(cx, |p, _| p.languages().clone());
169 let blocks = vec![inlay_hover.tooltip];
170 let parsed_content =
171 parse_blocks(&blocks, Some(&language_registry), None, cx).await;
172
173 let scroll_handle = ScrollHandle::new();
174
175 let subscription = this
176 .update(cx, |_, cx| {
177 parsed_content.as_ref().map(|parsed_content| {
178 cx.observe(parsed_content, |_, _, cx| cx.notify())
179 })
180 })
181 .ok()
182 .flatten();
183
184 let hover_popover = InfoPopover {
185 symbol_range: RangeInEditor::Inlay(inlay_hover.range.clone()),
186 parsed_content,
187 scroll_handle,
188 keyboard_grace: Rc::new(RefCell::new(false)),
189 anchor: None,
190 _subscription: subscription,
191 };
192
193 this.update(cx, |this, cx| {
194 // TODO: no background highlights happen for inlays currently
195 this.hover_state.info_popovers = vec![hover_popover];
196 cx.notify();
197 })?;
198
199 anyhow::Ok(())
200 }
201 .log_err()
202 .await
203 });
204
205 editor.hover_state.info_task = Some(task);
206 }
207}
208
209/// Hides the type information popup.
210/// Triggered by the `Hover` action when the cursor is not over a symbol or when the
211/// selections changed.
212pub fn hide_hover(editor: &mut Editor, cx: &mut Context<Editor>) -> bool {
213 let info_popovers = editor.hover_state.info_popovers.drain(..);
214 let diagnostics_popover = editor.hover_state.diagnostic_popover.take();
215 let did_hide = info_popovers.count() > 0 || diagnostics_popover.is_some();
216
217 editor.hover_state.info_task = None;
218 editor.hover_state.triggered_from = None;
219
220 editor.clear_background_highlights(HighlightKey::HoverState, cx);
221
222 if did_hide {
223 cx.notify();
224 }
225
226 did_hide
227}
228
229/// Queries the LSP and shows type info and documentation
230/// about the symbol the mouse is currently hovering over.
231/// Triggered by the `Hover` action when the cursor may be over a symbol.
232fn show_hover(
233 editor: &mut Editor,
234 anchor: Anchor,
235 ignore_timeout: bool,
236 window: &mut Window,
237 cx: &mut Context<Editor>,
238) -> Option<()> {
239 if editor.pending_rename.is_some() {
240 return None;
241 }
242
243 let snapshot = editor.snapshot(window, cx);
244
245 let (buffer, buffer_position) = editor
246 .buffer
247 .read(cx)
248 .text_anchor_for_position(anchor, cx)?;
249
250 let (excerpt_id, _, _) = editor.buffer().read(cx).excerpt_containing(anchor, cx)?;
251
252 let language_registry = editor
253 .project()
254 .map(|project| project.read(cx).languages().clone());
255 let provider = editor.semantics_provider.clone()?;
256
257 if !ignore_timeout {
258 if same_info_hover(editor, &snapshot, anchor)
259 || same_diagnostic_hover(editor, &snapshot, anchor)
260 || editor.hover_state.diagnostic_popover.is_some()
261 {
262 // Hover triggered from same location as last time. Don't show again.
263 return None;
264 } else {
265 hide_hover(editor, cx);
266 }
267 }
268
269 // Don't request again if the location is the same as the previous request
270 if let Some(triggered_from) = &editor.hover_state.triggered_from
271 && triggered_from
272 .cmp(&anchor, &snapshot.buffer_snapshot())
273 .is_eq()
274 {
275 return None;
276 }
277
278 let hover_popover_delay = EditorSettings::get_global(cx).hover_popover_delay.0;
279 let all_diagnostics_active = editor.active_diagnostics == ActiveDiagnostic::All;
280 let active_group_id = if let ActiveDiagnostic::Group(group) = &editor.active_diagnostics {
281 Some(group.group_id)
282 } else {
283 None
284 };
285
286 let renderer = GlobalDiagnosticRenderer::global(cx);
287 let task = cx.spawn_in(window, async move |this, cx| {
288 async move {
289 // If we need to delay, delay a set amount initially before making the lsp request
290 let delay = if ignore_timeout {
291 None
292 } else {
293 let lsp_request_early = hover_popover_delay / 2;
294 cx.background_executor()
295 .timer(Duration::from_millis(
296 hover_popover_delay - lsp_request_early,
297 ))
298 .await;
299
300 // Construct delay task to wait for later
301 let total_delay = Some(
302 cx.background_executor()
303 .timer(Duration::from_millis(lsp_request_early)),
304 );
305 total_delay
306 };
307
308 let hover_request = cx.update(|_, cx| provider.hover(&buffer, buffer_position, cx))?;
309
310 if let Some(delay) = delay {
311 delay.await;
312 }
313 let offset = anchor.to_offset(&snapshot.buffer_snapshot());
314 let local_diagnostic = if all_diagnostics_active {
315 None
316 } else {
317 snapshot
318 .buffer_snapshot()
319 .diagnostics_with_buffer_ids_in_range::<MultiBufferOffset>(offset..offset)
320 .filter(|(_, diagnostic)| {
321 Some(diagnostic.diagnostic.group_id) != active_group_id
322 })
323 // Find the entry with the most specific range
324 .min_by_key(|(_, entry)| entry.range.end - entry.range.start)
325 };
326
327 let diagnostic_popover = if let Some((buffer_id, local_diagnostic)) = local_diagnostic {
328 let group = snapshot
329 .buffer_snapshot()
330 .diagnostic_group(buffer_id, local_diagnostic.diagnostic.group_id)
331 .collect::<Vec<_>>();
332 let point_range = local_diagnostic
333 .range
334 .start
335 .to_point(&snapshot.buffer_snapshot())
336 ..local_diagnostic
337 .range
338 .end
339 .to_point(&snapshot.buffer_snapshot());
340 let markdown = cx.update(|_, cx| {
341 renderer
342 .as_ref()
343 .and_then(|renderer| {
344 renderer.render_hover(
345 group,
346 point_range,
347 buffer_id,
348 language_registry.clone(),
349 cx,
350 )
351 })
352 .context("no rendered diagnostic")
353 })??;
354
355 let (background_color, border_color) = cx.update(|_, cx| {
356 let status_colors = cx.theme().status();
357 match local_diagnostic.diagnostic.severity {
358 DiagnosticSeverity::ERROR => {
359 (status_colors.error_background, status_colors.error_border)
360 }
361 DiagnosticSeverity::WARNING => (
362 status_colors.warning_background,
363 status_colors.warning_border,
364 ),
365 DiagnosticSeverity::INFORMATION => {
366 (status_colors.info_background, status_colors.info_border)
367 }
368 DiagnosticSeverity::HINT => {
369 (status_colors.hint_background, status_colors.hint_border)
370 }
371 _ => (
372 status_colors.ignored_background,
373 status_colors.ignored_border,
374 ),
375 }
376 })?;
377
378 let subscription =
379 this.update(cx, |_, cx| cx.observe(&markdown, |_, _, cx| cx.notify()))?;
380
381 let local_diagnostic = DiagnosticEntry {
382 diagnostic: local_diagnostic.diagnostic.to_owned(),
383 range: snapshot
384 .buffer_snapshot()
385 .anchor_before(local_diagnostic.range.start)
386 ..snapshot
387 .buffer_snapshot()
388 .anchor_after(local_diagnostic.range.end),
389 };
390
391 let scroll_handle = ScrollHandle::new();
392
393 Some(DiagnosticPopover {
394 local_diagnostic,
395 markdown,
396 border_color,
397 scroll_handle,
398 background_color,
399 keyboard_grace: Rc::new(RefCell::new(ignore_timeout)),
400 anchor,
401 _subscription: subscription,
402 })
403 } else {
404 None
405 };
406
407 this.update(cx, |this, _| {
408 this.hover_state.diagnostic_popover = diagnostic_popover;
409 })?;
410
411 let invisible_char = if let Some(invisible) = snapshot
412 .buffer_snapshot()
413 .chars_at(anchor)
414 .next()
415 .filter(|&c| is_invisible(c))
416 {
417 let after = snapshot.buffer_snapshot().anchor_after(
418 anchor.to_offset(&snapshot.buffer_snapshot()) + invisible.len_utf8(),
419 );
420 Some((invisible, anchor..after))
421 } else if let Some(invisible) = snapshot
422 .buffer_snapshot()
423 .reversed_chars_at(anchor)
424 .next()
425 .filter(|&c| is_invisible(c))
426 {
427 let before = snapshot.buffer_snapshot().anchor_before(
428 anchor.to_offset(&snapshot.buffer_snapshot()) - invisible.len_utf8(),
429 );
430
431 Some((invisible, before..anchor))
432 } else {
433 None
434 };
435
436 let hovers_response = if let Some(hover_request) = hover_request {
437 hover_request.await.unwrap_or_default()
438 } else {
439 Vec::new()
440 };
441 let snapshot = this.update_in(cx, |this, window, cx| this.snapshot(window, cx))?;
442 let mut hover_highlights = Vec::with_capacity(hovers_response.len());
443 let mut info_popovers = Vec::with_capacity(
444 hovers_response.len() + if invisible_char.is_some() { 1 } else { 0 },
445 );
446
447 if let Some((invisible, range)) = invisible_char {
448 let blocks = vec![HoverBlock {
449 text: format!("Unicode character U+{:02X}", invisible as u32),
450 kind: HoverBlockKind::PlainText,
451 }];
452 let parsed_content =
453 parse_blocks(&blocks, language_registry.as_ref(), None, cx).await;
454 let scroll_handle = ScrollHandle::new();
455 let subscription = this
456 .update(cx, |_, cx| {
457 parsed_content.as_ref().map(|parsed_content| {
458 cx.observe(parsed_content, |_, _, cx| cx.notify())
459 })
460 })
461 .ok()
462 .flatten();
463 info_popovers.push(InfoPopover {
464 symbol_range: RangeInEditor::Text(range),
465 parsed_content,
466 scroll_handle,
467 keyboard_grace: Rc::new(RefCell::new(ignore_timeout)),
468 anchor: Some(anchor),
469 _subscription: subscription,
470 })
471 }
472
473 for hover_result in hovers_response {
474 // Create symbol range of anchors for highlighting and filtering of future requests.
475 let range = hover_result
476 .range
477 .and_then(|range| {
478 let range = snapshot
479 .buffer_snapshot()
480 .anchor_range_in_excerpt(excerpt_id, range)?;
481 Some(range)
482 })
483 .or_else(|| {
484 let snapshot = &snapshot.buffer_snapshot();
485 let range = snapshot.syntax_ancestor(anchor..anchor)?.1;
486 Some(snapshot.anchor_before(range.start)..snapshot.anchor_after(range.end))
487 })
488 .unwrap_or_else(|| anchor..anchor);
489
490 let blocks = hover_result.contents;
491 let language = hover_result.language;
492 let parsed_content =
493 parse_blocks(&blocks, language_registry.as_ref(), language, cx).await;
494 let scroll_handle = ScrollHandle::new();
495 hover_highlights.push(range.clone());
496 let subscription = this
497 .update(cx, |_, cx| {
498 parsed_content.as_ref().map(|parsed_content| {
499 cx.observe(parsed_content, |_, _, cx| cx.notify())
500 })
501 })
502 .ok()
503 .flatten();
504 info_popovers.push(InfoPopover {
505 symbol_range: RangeInEditor::Text(range),
506 parsed_content,
507 scroll_handle,
508 keyboard_grace: Rc::new(RefCell::new(ignore_timeout)),
509 anchor: Some(anchor),
510 _subscription: subscription,
511 });
512 }
513
514 this.update_in(cx, |editor, window, cx| {
515 if hover_highlights.is_empty() {
516 editor.clear_background_highlights(HighlightKey::HoverState, cx);
517 } else {
518 // Highlight the selected symbol using a background highlight
519 editor.highlight_background(
520 HighlightKey::HoverState,
521 &hover_highlights,
522 |_, theme| theme.colors().element_hover, // todo update theme
523 cx,
524 );
525 }
526
527 editor.hover_state.info_popovers = info_popovers;
528 cx.notify();
529 window.refresh();
530 })?;
531
532 anyhow::Ok(())
533 }
534 .log_err()
535 .await
536 });
537
538 editor.hover_state.info_task = Some(task);
539 None
540}
541
542fn same_info_hover(editor: &Editor, snapshot: &EditorSnapshot, anchor: Anchor) -> bool {
543 editor
544 .hover_state
545 .info_popovers
546 .iter()
547 .any(|InfoPopover { symbol_range, .. }| {
548 symbol_range
549 .as_text_range()
550 .map(|range| {
551 let hover_range = range.to_offset(&snapshot.buffer_snapshot());
552 let offset = anchor.to_offset(&snapshot.buffer_snapshot());
553 // LSP returns a hover result for the end index of ranges that should be hovered, so we need to
554 // use an inclusive range here to check if we should dismiss the popover
555 (hover_range.start..=hover_range.end).contains(&offset)
556 })
557 .unwrap_or(false)
558 })
559}
560
561fn same_diagnostic_hover(editor: &Editor, snapshot: &EditorSnapshot, anchor: Anchor) -> bool {
562 editor
563 .hover_state
564 .diagnostic_popover
565 .as_ref()
566 .map(|diagnostic| {
567 let hover_range = diagnostic
568 .local_diagnostic
569 .range
570 .to_offset(&snapshot.buffer_snapshot());
571 let offset = anchor.to_offset(&snapshot.buffer_snapshot());
572
573 // Here we do basically the same as in `same_info_hover`, see comment there for an explanation
574 (hover_range.start..=hover_range.end).contains(&offset)
575 })
576 .unwrap_or(false)
577}
578
579async fn parse_blocks(
580 blocks: &[HoverBlock],
581 language_registry: Option<&Arc<LanguageRegistry>>,
582 language: Option<Arc<Language>>,
583 cx: &mut AsyncWindowContext,
584) -> Option<Entity<Markdown>> {
585 let combined_text = blocks
586 .iter()
587 .map(|block| match &block.kind {
588 project::HoverBlockKind::PlainText | project::HoverBlockKind::Markdown => {
589 Cow::Borrowed(block.text.trim())
590 }
591 project::HoverBlockKind::Code { language } => {
592 Cow::Owned(format!("```{}\n{}\n```", language, block.text.trim()))
593 }
594 })
595 .join("\n\n");
596
597 cx.new_window_entity(|_window, cx| {
598 Markdown::new(
599 combined_text.into(),
600 language_registry.cloned(),
601 language.map(|language| language.name()),
602 cx,
603 )
604 })
605 .ok()
606}
607
608pub fn hover_markdown_style(window: &Window, cx: &App) -> MarkdownStyle {
609 let settings = ThemeSettings::get_global(cx);
610 let ui_font_family = settings.ui_font.family.clone();
611 let ui_font_features = settings.ui_font.features.clone();
612 let ui_font_fallbacks = settings.ui_font.fallbacks.clone();
613 let buffer_font_family = settings.buffer_font.family.clone();
614 let buffer_font_features = settings.buffer_font.features.clone();
615 let buffer_font_fallbacks = settings.buffer_font.fallbacks.clone();
616 let buffer_font_weight = settings.buffer_font.weight;
617
618 let mut base_text_style = window.text_style();
619 base_text_style.refine(&TextStyleRefinement {
620 font_family: Some(ui_font_family),
621 font_features: Some(ui_font_features),
622 font_fallbacks: ui_font_fallbacks,
623 color: Some(cx.theme().colors().editor_foreground),
624 ..Default::default()
625 });
626 MarkdownStyle {
627 base_text_style,
628 code_block: StyleRefinement::default()
629 .my(rems(1.))
630 .font_buffer(cx)
631 .font_features(buffer_font_features.clone())
632 .font_weight(buffer_font_weight),
633 inline_code: TextStyleRefinement {
634 background_color: Some(cx.theme().colors().background),
635 font_family: Some(buffer_font_family),
636 font_features: Some(buffer_font_features),
637 font_fallbacks: buffer_font_fallbacks,
638 font_weight: Some(buffer_font_weight),
639 ..Default::default()
640 },
641 rule_color: cx.theme().colors().border,
642 block_quote_border_color: Color::Muted.color(cx),
643 block_quote: TextStyleRefinement {
644 color: Some(Color::Muted.color(cx)),
645 ..Default::default()
646 },
647 link: TextStyleRefinement {
648 color: Some(cx.theme().colors().editor_foreground),
649 underline: Some(gpui::UnderlineStyle {
650 thickness: px(1.),
651 color: Some(cx.theme().colors().editor_foreground),
652 wavy: false,
653 }),
654 ..Default::default()
655 },
656 syntax: cx.theme().syntax().clone(),
657 selection_background_color: cx.theme().colors().element_selection_background,
658 heading: StyleRefinement::default()
659 .font_weight(FontWeight::BOLD)
660 .text_base()
661 .mt(rems(1.))
662 .mb_0(),
663 table_columns_min_size: true,
664 ..Default::default()
665 }
666}
667
668pub fn diagnostics_markdown_style(window: &Window, cx: &App) -> MarkdownStyle {
669 let settings = ThemeSettings::get_global(cx);
670 let ui_font_family = settings.ui_font.family.clone();
671 let ui_font_fallbacks = settings.ui_font.fallbacks.clone();
672 let ui_font_features = settings.ui_font.features.clone();
673 let buffer_font_family = settings.buffer_font.family.clone();
674 let buffer_font_features = settings.buffer_font.features.clone();
675 let buffer_font_fallbacks = settings.buffer_font.fallbacks.clone();
676
677 let mut base_text_style = window.text_style();
678 base_text_style.refine(&TextStyleRefinement {
679 font_family: Some(ui_font_family),
680 font_features: Some(ui_font_features),
681 font_fallbacks: ui_font_fallbacks,
682 color: Some(cx.theme().colors().editor_foreground),
683 ..Default::default()
684 });
685 MarkdownStyle {
686 base_text_style,
687 code_block: StyleRefinement::default().my(rems(1.)).font_buffer(cx),
688 inline_code: TextStyleRefinement {
689 background_color: Some(cx.theme().colors().editor_background.opacity(0.5)),
690 font_family: Some(buffer_font_family),
691 font_features: Some(buffer_font_features),
692 font_fallbacks: buffer_font_fallbacks,
693 ..Default::default()
694 },
695 rule_color: cx.theme().colors().border,
696 block_quote_border_color: Color::Muted.color(cx),
697 block_quote: TextStyleRefinement {
698 color: Some(Color::Muted.color(cx)),
699 ..Default::default()
700 },
701 link: TextStyleRefinement {
702 color: Some(cx.theme().colors().editor_foreground),
703 underline: Some(gpui::UnderlineStyle {
704 thickness: px(1.),
705 color: Some(cx.theme().colors().editor_foreground),
706 wavy: false,
707 }),
708 ..Default::default()
709 },
710 syntax: cx.theme().syntax().clone(),
711 selection_background_color: cx.theme().colors().element_selection_background,
712 height_is_multiple_of_line_height: true,
713 heading: StyleRefinement::default()
714 .font_weight(FontWeight::BOLD)
715 .text_base()
716 .mb_0(),
717 table_columns_min_size: true,
718 ..Default::default()
719 }
720}
721
722pub fn open_markdown_url(link: SharedString, window: &mut Window, cx: &mut App) {
723 if let Ok(uri) = Url::parse(&link)
724 && uri.scheme() == "file"
725 && let Some(workspace) = Workspace::for_window(window, cx)
726 {
727 workspace.update(cx, |workspace, cx| {
728 let task = workspace.open_abs_path(
729 PathBuf::from(uri.path()),
730 OpenOptions {
731 visible: Some(OpenVisible::None),
732 ..Default::default()
733 },
734 window,
735 cx,
736 );
737
738 cx.spawn_in(window, async move |_, cx| {
739 let item = task.await?;
740 // Ruby LSP uses URLs with #L1,1-4,4
741 // we'll just take the first number and assume it's a line number
742 let Some(fragment) = uri.fragment() else {
743 return anyhow::Ok(());
744 };
745 let mut accum = 0u32;
746 for c in fragment.chars() {
747 if c >= '0' && c <= '9' && accum < u32::MAX / 2 {
748 accum *= 10;
749 accum += c as u32 - '0' as u32;
750 } else if accum > 0 {
751 break;
752 }
753 }
754 if accum == 0 {
755 return Ok(());
756 }
757 let Some(editor) = cx.update(|_, cx| item.act_as::<Editor>(cx))? else {
758 return Ok(());
759 };
760 editor.update_in(cx, |editor, window, cx| {
761 editor.change_selections(Default::default(), window, cx, |selections| {
762 selections.select_ranges([
763 text::Point::new(accum - 1, 0)..text::Point::new(accum - 1, 0)
764 ]);
765 });
766 })
767 })
768 .detach_and_log_err(cx);
769 });
770 return;
771 }
772 cx.open_url(&link);
773}
774
775#[derive(Default)]
776pub struct HoverState {
777 pub info_popovers: Vec<InfoPopover>,
778 pub diagnostic_popover: Option<DiagnosticPopover>,
779 pub triggered_from: Option<Anchor>,
780 pub info_task: Option<Task<Option<()>>>,
781}
782
783impl HoverState {
784 pub fn visible(&self) -> bool {
785 !self.info_popovers.is_empty() || self.diagnostic_popover.is_some()
786 }
787
788 pub(crate) fn render(
789 &mut self,
790 snapshot: &EditorSnapshot,
791 visible_rows: Range<DisplayRow>,
792 max_size: Size<Pixels>,
793 text_layout_details: &TextLayoutDetails,
794 window: &mut Window,
795 cx: &mut Context<Editor>,
796 ) -> Option<(DisplayPoint, Vec<AnyElement>)> {
797 if !self.visible() {
798 return None;
799 }
800 // If there is a diagnostic, position the popovers based on that.
801 // Otherwise use the start of the hover range
802 let anchor = self
803 .diagnostic_popover
804 .as_ref()
805 .map(|diagnostic_popover| &diagnostic_popover.local_diagnostic.range.start)
806 .or_else(|| {
807 self.info_popovers.iter().find_map(|info_popover| {
808 match &info_popover.symbol_range {
809 RangeInEditor::Text(range) => Some(&range.start),
810 RangeInEditor::Inlay(_) => None,
811 }
812 })
813 })
814 .or_else(|| {
815 self.info_popovers.iter().find_map(|info_popover| {
816 match &info_popover.symbol_range {
817 RangeInEditor::Text(_) => None,
818 RangeInEditor::Inlay(range) => Some(&range.inlay_position),
819 }
820 })
821 })?;
822 let mut point = anchor.to_display_point(&snapshot.display_snapshot);
823 // Clamp the point within the visible rows in case the popup source spans multiple lines
824 if visible_rows.end <= point.row() {
825 point = crate::movement::up_by_rows(
826 &snapshot.display_snapshot,
827 point,
828 1 + (point.row() - visible_rows.end).0,
829 text::SelectionGoal::None,
830 true,
831 text_layout_details,
832 )
833 .0;
834 } else if point.row() < visible_rows.start {
835 point = crate::movement::down_by_rows(
836 &snapshot.display_snapshot,
837 point,
838 (visible_rows.start - point.row()).0,
839 text::SelectionGoal::None,
840 true,
841 text_layout_details,
842 )
843 .0;
844 }
845
846 if !visible_rows.contains(&point.row()) {
847 log::error!("Hover popover point out of bounds after moving");
848 return None;
849 }
850
851 let mut elements = Vec::new();
852
853 if let Some(diagnostic_popover) = self.diagnostic_popover.as_ref() {
854 elements.push(diagnostic_popover.render(max_size, window, cx));
855 }
856 for info_popover in &mut self.info_popovers {
857 elements.push(info_popover.render(max_size, window, cx));
858 }
859
860 Some((point, elements))
861 }
862
863 pub fn focused(&self, window: &mut Window, cx: &mut Context<Editor>) -> bool {
864 let mut hover_popover_is_focused = false;
865 for info_popover in &self.info_popovers {
866 if let Some(markdown_view) = &info_popover.parsed_content
867 && markdown_view.focus_handle(cx).is_focused(window)
868 {
869 hover_popover_is_focused = true;
870 }
871 }
872 if let Some(diagnostic_popover) = &self.diagnostic_popover
873 && diagnostic_popover
874 .markdown
875 .focus_handle(cx)
876 .is_focused(window)
877 {
878 hover_popover_is_focused = true;
879 }
880 hover_popover_is_focused
881 }
882}
883
884pub struct InfoPopover {
885 pub symbol_range: RangeInEditor,
886 pub parsed_content: Option<Entity<Markdown>>,
887 pub scroll_handle: ScrollHandle,
888 pub keyboard_grace: Rc<RefCell<bool>>,
889 pub anchor: Option<Anchor>,
890 _subscription: Option<Subscription>,
891}
892
893impl InfoPopover {
894 pub(crate) fn render(
895 &mut self,
896 max_size: Size<Pixels>,
897 window: &mut Window,
898 cx: &mut Context<Editor>,
899 ) -> AnyElement {
900 let keyboard_grace = Rc::clone(&self.keyboard_grace);
901 div()
902 .id("info_popover")
903 .occlude()
904 .elevation_2(cx)
905 // Prevent a mouse down/move on the popover from being propagated to the editor,
906 // because that would dismiss the popover.
907 .on_mouse_move(|_, _, cx| cx.stop_propagation())
908 .on_mouse_down(MouseButton::Left, move |_, _, cx| {
909 let mut keyboard_grace = keyboard_grace.borrow_mut();
910 *keyboard_grace = false;
911 cx.stop_propagation();
912 })
913 .when_some(self.parsed_content.clone(), |this, markdown| {
914 this.child(
915 div()
916 .id("info-md-container")
917 .overflow_y_scroll()
918 .max_w(max_size.width)
919 .max_h(max_size.height)
920 .track_scroll(&self.scroll_handle)
921 .child(
922 MarkdownElement::new(markdown, hover_markdown_style(window, cx))
923 .code_block_renderer(markdown::CodeBlockRenderer::Default {
924 copy_button: false,
925 copy_button_on_hover: false,
926 border: false,
927 })
928 .on_url_click(open_markdown_url)
929 .p_2(),
930 ),
931 )
932 .custom_scrollbars(
933 Scrollbars::for_settings::<EditorSettings>()
934 .tracked_scroll_handle(&self.scroll_handle),
935 window,
936 cx,
937 )
938 })
939 .into_any_element()
940 }
941
942 pub fn scroll(&self, amount: ScrollAmount, window: &mut Window, cx: &mut Context<Editor>) {
943 let mut current = self.scroll_handle.offset();
944 current.y -= amount.pixels(
945 window.line_height(),
946 self.scroll_handle.bounds().size.height - px(16.),
947 ) / 2.0;
948 cx.notify();
949 self.scroll_handle.set_offset(current);
950 }
951}
952
953pub struct DiagnosticPopover {
954 pub(crate) local_diagnostic: DiagnosticEntry<Anchor>,
955 markdown: Entity<Markdown>,
956 border_color: Hsla,
957 background_color: Hsla,
958 pub keyboard_grace: Rc<RefCell<bool>>,
959 pub anchor: Anchor,
960 _subscription: Subscription,
961 pub scroll_handle: ScrollHandle,
962}
963
964impl DiagnosticPopover {
965 pub fn render(
966 &self,
967 max_size: Size<Pixels>,
968 window: &mut Window,
969 cx: &mut Context<Editor>,
970 ) -> AnyElement {
971 let keyboard_grace = Rc::clone(&self.keyboard_grace);
972 let this = cx.entity().downgrade();
973 div()
974 .id("diagnostic")
975 .occlude()
976 .elevation_2_borderless(cx)
977 // Don't draw the background color if the theme
978 // allows transparent surfaces.
979 .when(theme_is_transparent(cx), |this| {
980 this.bg(gpui::transparent_black())
981 })
982 // Prevent a mouse move on the popover from being propagated to the editor,
983 // because that would dismiss the popover.
984 .on_mouse_move(|_, _, cx| cx.stop_propagation())
985 // Prevent a mouse down on the popover from being propagated to the editor,
986 // because that would move the cursor.
987 .on_mouse_down(MouseButton::Left, move |_, _, cx| {
988 let mut keyboard_grace = keyboard_grace.borrow_mut();
989 *keyboard_grace = false;
990 cx.stop_propagation();
991 })
992 .child(
993 div()
994 .relative()
995 .py_1()
996 .pl_2()
997 .pr_8()
998 .bg(self.background_color)
999 .border_1()
1000 .border_color(self.border_color)
1001 .rounded_lg()
1002 .child(
1003 div()
1004 .id("diagnostic-content-container")
1005 .max_w(max_size.width)
1006 .max_h(max_size.height)
1007 .overflow_y_scroll()
1008 .track_scroll(&self.scroll_handle)
1009 .child(
1010 MarkdownElement::new(
1011 self.markdown.clone(),
1012 diagnostics_markdown_style(window, cx),
1013 )
1014 .code_block_renderer(markdown::CodeBlockRenderer::Default {
1015 copy_button: false,
1016 copy_button_on_hover: false,
1017 border: false,
1018 })
1019 .on_url_click(
1020 move |link, window, cx| {
1021 if let Some(renderer) = GlobalDiagnosticRenderer::global(cx)
1022 {
1023 this.update(cx, |this, cx| {
1024 renderer.as_ref().open_link(this, link, window, cx);
1025 })
1026 .ok();
1027 }
1028 },
1029 ),
1030 ),
1031 )
1032 .child(div().absolute().top_1().right_1().child({
1033 let message = self.local_diagnostic.diagnostic.message.clone();
1034 CopyButton::new("copy-diagnostic", message).tooltip_label("Copy Diagnostic")
1035 }))
1036 .custom_scrollbars(
1037 Scrollbars::for_settings::<EditorSettings>()
1038 .tracked_scroll_handle(&self.scroll_handle),
1039 window,
1040 cx,
1041 ),
1042 )
1043 .into_any_element()
1044 }
1045}
1046
1047#[cfg(test)]
1048mod tests {
1049 use super::*;
1050 use crate::{
1051 PointForPosition,
1052 actions::ConfirmCompletion,
1053 editor_tests::{handle_completion_request, init_test},
1054 inlays::inlay_hints::tests::{cached_hint_labels, visible_hint_labels},
1055 test::editor_lsp_test_context::EditorLspTestContext,
1056 };
1057 use collections::BTreeSet;
1058 use gpui::App;
1059 use indoc::indoc;
1060 use markdown::parser::MarkdownEvent;
1061 use project::InlayId;
1062 use settings::InlayHintSettingsContent;
1063 use smol::stream::StreamExt;
1064 use std::sync::atomic;
1065 use std::sync::atomic::AtomicUsize;
1066 use text::Bias;
1067
1068 fn get_hover_popover_delay(cx: &gpui::TestAppContext) -> u64 {
1069 cx.read(|cx: &App| -> u64 { EditorSettings::get_global(cx).hover_popover_delay.0 })
1070 }
1071
1072 impl InfoPopover {
1073 fn get_rendered_text(&self, cx: &gpui::App) -> String {
1074 let mut rendered_text = String::new();
1075 if let Some(parsed_content) = self.parsed_content.clone() {
1076 let markdown = parsed_content.read(cx);
1077 let text = markdown.parsed_markdown().source().to_string();
1078 let data = markdown.parsed_markdown().events();
1079 let slice = data;
1080
1081 for (range, event) in slice.iter() {
1082 match event {
1083 MarkdownEvent::SubstitutedText(parsed) => {
1084 rendered_text.push_str(parsed.as_str())
1085 }
1086 MarkdownEvent::Text | MarkdownEvent::Code => {
1087 rendered_text.push_str(&text[range.clone()])
1088 }
1089 _ => {}
1090 }
1091 }
1092 }
1093 rendered_text
1094 }
1095 }
1096
1097 #[gpui::test]
1098 async fn test_mouse_hover_info_popover_with_autocomplete_popover(
1099 cx: &mut gpui::TestAppContext,
1100 ) {
1101 init_test(cx, |_| {});
1102
1103 let mut cx = EditorLspTestContext::new_rust(
1104 lsp::ServerCapabilities {
1105 hover_provider: Some(lsp::HoverProviderCapability::Simple(true)),
1106 completion_provider: Some(lsp::CompletionOptions {
1107 trigger_characters: Some(vec![".".to_string(), ":".to_string()]),
1108 resolve_provider: Some(true),
1109 ..Default::default()
1110 }),
1111 ..Default::default()
1112 },
1113 cx,
1114 )
1115 .await;
1116 let counter = Arc::new(AtomicUsize::new(0));
1117 // Basic hover delays and then pops without moving the mouse
1118 cx.set_state(indoc! {"
1119 oneˇ
1120 two
1121 three
1122 fn test() { println!(); }
1123 "});
1124
1125 //prompt autocompletion menu
1126 cx.simulate_keystroke(".");
1127 handle_completion_request(
1128 indoc! {"
1129 one.|<>
1130 two
1131 three
1132 "},
1133 vec!["first_completion", "second_completion"],
1134 true,
1135 counter.clone(),
1136 &mut cx,
1137 )
1138 .await;
1139 cx.condition(|editor, _| editor.context_menu_visible()) // wait until completion menu is visible
1140 .await;
1141 assert_eq!(counter.load(atomic::Ordering::Acquire), 1); // 1 completion request
1142
1143 let hover_point = cx.display_point(indoc! {"
1144 one.
1145 two
1146 three
1147 fn test() { printˇln!(); }
1148 "});
1149 cx.update_editor(|editor, window, cx| {
1150 let snapshot = editor.snapshot(window, cx);
1151 let anchor = snapshot
1152 .buffer_snapshot()
1153 .anchor_before(hover_point.to_offset(&snapshot, Bias::Left));
1154 hover_at(editor, Some(anchor), window, cx)
1155 });
1156 assert!(!cx.editor(|editor, _window, _cx| editor.hover_state.visible()));
1157
1158 // After delay, hover should be visible.
1159 let symbol_range = cx.lsp_range(indoc! {"
1160 one.
1161 two
1162 three
1163 fn test() { «println!»(); }
1164 "});
1165 let mut requests =
1166 cx.set_request_handler::<lsp::request::HoverRequest, _, _>(move |_, _, _| async move {
1167 Ok(Some(lsp::Hover {
1168 contents: lsp::HoverContents::Markup(lsp::MarkupContent {
1169 kind: lsp::MarkupKind::Markdown,
1170 value: "some basic docs".to_string(),
1171 }),
1172 range: Some(symbol_range),
1173 }))
1174 });
1175 cx.background_executor
1176 .advance_clock(Duration::from_millis(get_hover_popover_delay(&cx) + 100));
1177 requests.next().await;
1178
1179 cx.editor(|editor, _window, cx| {
1180 assert!(editor.hover_state.visible());
1181 assert_eq!(
1182 editor.hover_state.info_popovers.len(),
1183 1,
1184 "Expected exactly one hover but got: {:?}",
1185 editor.hover_state.info_popovers.len()
1186 );
1187 let rendered_text = editor
1188 .hover_state
1189 .info_popovers
1190 .first()
1191 .unwrap()
1192 .get_rendered_text(cx);
1193 assert_eq!(rendered_text, "some basic docs".to_string())
1194 });
1195
1196 // check that the completion menu is still visible and that there still has only been 1 completion request
1197 cx.editor(|editor, _, _| assert!(editor.context_menu_visible()));
1198 assert_eq!(counter.load(atomic::Ordering::Acquire), 1);
1199
1200 //apply a completion and check it was successfully applied
1201 let _apply_additional_edits = cx.update_editor(|editor, window, cx| {
1202 editor.context_menu_next(&Default::default(), window, cx);
1203 editor
1204 .confirm_completion(&ConfirmCompletion::default(), window, cx)
1205 .unwrap()
1206 });
1207 cx.assert_editor_state(indoc! {"
1208 one.second_completionˇ
1209 two
1210 three
1211 fn test() { println!(); }
1212 "});
1213
1214 // check that the completion menu is no longer visible and that there still has only been 1 completion request
1215 cx.editor(|editor, _, _| assert!(!editor.context_menu_visible()));
1216 assert_eq!(counter.load(atomic::Ordering::Acquire), 1);
1217
1218 //verify the information popover is still visible and unchanged
1219 cx.editor(|editor, _, cx| {
1220 assert!(editor.hover_state.visible());
1221 assert_eq!(
1222 editor.hover_state.info_popovers.len(),
1223 1,
1224 "Expected exactly one hover but got: {:?}",
1225 editor.hover_state.info_popovers.len()
1226 );
1227 let rendered_text = editor
1228 .hover_state
1229 .info_popovers
1230 .first()
1231 .unwrap()
1232 .get_rendered_text(cx);
1233
1234 assert_eq!(rendered_text, "some basic docs".to_string())
1235 });
1236
1237 // Mouse moved with no hover response dismisses
1238 let hover_point = cx.display_point(indoc! {"
1239 one.second_completionˇ
1240 two
1241 three
1242 fn teˇst() { println!(); }
1243 "});
1244 let mut request = cx
1245 .lsp
1246 .set_request_handler::<lsp::request::HoverRequest, _, _>(
1247 |_, _| async move { Ok(None) },
1248 );
1249 cx.update_editor(|editor, window, cx| {
1250 let snapshot = editor.snapshot(window, cx);
1251 let anchor = snapshot
1252 .buffer_snapshot()
1253 .anchor_before(hover_point.to_offset(&snapshot, Bias::Left));
1254 hover_at(editor, Some(anchor), window, cx)
1255 });
1256 cx.background_executor
1257 .advance_clock(Duration::from_millis(get_hover_popover_delay(&cx) + 100));
1258 request.next().await;
1259
1260 // verify that the information popover is no longer visible
1261 cx.editor(|editor, _, _| {
1262 assert!(!editor.hover_state.visible());
1263 });
1264 }
1265
1266 #[gpui::test]
1267 async fn test_mouse_hover_info_popover(cx: &mut gpui::TestAppContext) {
1268 init_test(cx, |_| {});
1269
1270 let mut cx = EditorLspTestContext::new_rust(
1271 lsp::ServerCapabilities {
1272 hover_provider: Some(lsp::HoverProviderCapability::Simple(true)),
1273 ..Default::default()
1274 },
1275 cx,
1276 )
1277 .await;
1278
1279 // Basic hover delays and then pops without moving the mouse
1280 cx.set_state(indoc! {"
1281 fn ˇtest() { println!(); }
1282 "});
1283 let hover_point = cx.display_point(indoc! {"
1284 fn test() { printˇln!(); }
1285 "});
1286
1287 cx.update_editor(|editor, window, cx| {
1288 let snapshot = editor.snapshot(window, cx);
1289 let anchor = snapshot
1290 .buffer_snapshot()
1291 .anchor_before(hover_point.to_offset(&snapshot, Bias::Left));
1292 hover_at(editor, Some(anchor), window, cx)
1293 });
1294 assert!(!cx.editor(|editor, _window, _cx| editor.hover_state.visible()));
1295
1296 // After delay, hover should be visible.
1297 let symbol_range = cx.lsp_range(indoc! {"
1298 fn test() { «println!»(); }
1299 "});
1300 let mut requests =
1301 cx.set_request_handler::<lsp::request::HoverRequest, _, _>(move |_, _, _| async move {
1302 Ok(Some(lsp::Hover {
1303 contents: lsp::HoverContents::Markup(lsp::MarkupContent {
1304 kind: lsp::MarkupKind::Markdown,
1305 value: "some basic docs".to_string(),
1306 }),
1307 range: Some(symbol_range),
1308 }))
1309 });
1310 cx.background_executor
1311 .advance_clock(Duration::from_millis(get_hover_popover_delay(&cx) + 100));
1312 requests.next().await;
1313
1314 cx.editor(|editor, _, cx| {
1315 assert!(editor.hover_state.visible());
1316 assert_eq!(
1317 editor.hover_state.info_popovers.len(),
1318 1,
1319 "Expected exactly one hover but got: {:?}",
1320 editor.hover_state.info_popovers.len()
1321 );
1322 let rendered_text = editor
1323 .hover_state
1324 .info_popovers
1325 .first()
1326 .unwrap()
1327 .get_rendered_text(cx);
1328
1329 assert_eq!(rendered_text, "some basic docs".to_string())
1330 });
1331
1332 // Mouse moved with no hover response dismisses
1333 let hover_point = cx.display_point(indoc! {"
1334 fn teˇst() { println!(); }
1335 "});
1336 let mut request = cx
1337 .lsp
1338 .set_request_handler::<lsp::request::HoverRequest, _, _>(
1339 |_, _| async move { Ok(None) },
1340 );
1341 cx.update_editor(|editor, window, cx| {
1342 let snapshot = editor.snapshot(window, cx);
1343 let anchor = snapshot
1344 .buffer_snapshot()
1345 .anchor_before(hover_point.to_offset(&snapshot, Bias::Left));
1346 hover_at(editor, Some(anchor), window, cx)
1347 });
1348 cx.background_executor
1349 .advance_clock(Duration::from_millis(get_hover_popover_delay(&cx) + 100));
1350 request.next().await;
1351 cx.editor(|editor, _, _| {
1352 assert!(!editor.hover_state.visible());
1353 });
1354 }
1355
1356 #[gpui::test]
1357 async fn test_keyboard_hover_info_popover(cx: &mut gpui::TestAppContext) {
1358 init_test(cx, |_| {});
1359
1360 let mut cx = EditorLspTestContext::new_rust(
1361 lsp::ServerCapabilities {
1362 hover_provider: Some(lsp::HoverProviderCapability::Simple(true)),
1363 ..Default::default()
1364 },
1365 cx,
1366 )
1367 .await;
1368
1369 // Hover with keyboard has no delay
1370 cx.set_state(indoc! {"
1371 fˇn test() { println!(); }
1372 "});
1373 cx.update_editor(|editor, window, cx| hover(editor, &Hover, window, cx));
1374 let symbol_range = cx.lsp_range(indoc! {"
1375 «fn» test() { println!(); }
1376 "});
1377
1378 cx.editor(|editor, _window, _cx| {
1379 assert!(!editor.hover_state.visible());
1380
1381 assert_eq!(
1382 editor.hover_state.info_popovers.len(),
1383 0,
1384 "Expected no hovers but got but got: {:?}",
1385 editor.hover_state.info_popovers.len()
1386 );
1387 });
1388
1389 let mut requests =
1390 cx.set_request_handler::<lsp::request::HoverRequest, _, _>(move |_, _, _| async move {
1391 Ok(Some(lsp::Hover {
1392 contents: lsp::HoverContents::Markup(lsp::MarkupContent {
1393 kind: lsp::MarkupKind::Markdown,
1394 value: "some other basic docs".to_string(),
1395 }),
1396 range: Some(symbol_range),
1397 }))
1398 });
1399
1400 requests.next().await;
1401 cx.dispatch_action(Hover);
1402
1403 cx.condition(|editor, _| editor.hover_state.visible()).await;
1404 cx.editor(|editor, _, cx| {
1405 assert_eq!(
1406 editor.hover_state.info_popovers.len(),
1407 1,
1408 "Expected exactly one hover but got: {:?}",
1409 editor.hover_state.info_popovers.len()
1410 );
1411
1412 let rendered_text = editor
1413 .hover_state
1414 .info_popovers
1415 .first()
1416 .unwrap()
1417 .get_rendered_text(cx);
1418
1419 assert_eq!(rendered_text, "some other basic docs".to_string())
1420 });
1421 }
1422
1423 #[gpui::test]
1424 async fn test_empty_hovers_filtered(cx: &mut gpui::TestAppContext) {
1425 init_test(cx, |_| {});
1426
1427 let mut cx = EditorLspTestContext::new_rust(
1428 lsp::ServerCapabilities {
1429 hover_provider: Some(lsp::HoverProviderCapability::Simple(true)),
1430 ..Default::default()
1431 },
1432 cx,
1433 )
1434 .await;
1435
1436 // Hover with keyboard has no delay
1437 cx.set_state(indoc! {"
1438 fˇn test() { println!(); }
1439 "});
1440 cx.update_editor(|editor, window, cx| hover(editor, &Hover, window, cx));
1441 let symbol_range = cx.lsp_range(indoc! {"
1442 «fn» test() { println!(); }
1443 "});
1444 cx.set_request_handler::<lsp::request::HoverRequest, _, _>(move |_, _, _| async move {
1445 Ok(Some(lsp::Hover {
1446 contents: lsp::HoverContents::Array(vec![
1447 lsp::MarkedString::String("regular text for hover to show".to_string()),
1448 lsp::MarkedString::String("".to_string()),
1449 lsp::MarkedString::LanguageString(lsp::LanguageString {
1450 language: "Rust".to_string(),
1451 value: "".to_string(),
1452 }),
1453 ]),
1454 range: Some(symbol_range),
1455 }))
1456 })
1457 .next()
1458 .await;
1459 cx.dispatch_action(Hover);
1460
1461 cx.condition(|editor, _| editor.hover_state.visible()).await;
1462 cx.editor(|editor, _, cx| {
1463 assert_eq!(
1464 editor.hover_state.info_popovers.len(),
1465 1,
1466 "Expected exactly one hover but got: {:?}",
1467 editor.hover_state.info_popovers.len()
1468 );
1469 let rendered_text = editor
1470 .hover_state
1471 .info_popovers
1472 .first()
1473 .unwrap()
1474 .get_rendered_text(cx);
1475
1476 assert_eq!(
1477 rendered_text,
1478 "regular text for hover to show".to_string(),
1479 "No empty string hovers should be shown"
1480 );
1481 });
1482 }
1483
1484 #[gpui::test]
1485 async fn test_line_ends_trimmed(cx: &mut gpui::TestAppContext) {
1486 init_test(cx, |_| {});
1487
1488 let mut cx = EditorLspTestContext::new_rust(
1489 lsp::ServerCapabilities {
1490 hover_provider: Some(lsp::HoverProviderCapability::Simple(true)),
1491 ..Default::default()
1492 },
1493 cx,
1494 )
1495 .await;
1496
1497 // Hover with keyboard has no delay
1498 cx.set_state(indoc! {"
1499 fˇn test() { println!(); }
1500 "});
1501 cx.update_editor(|editor, window, cx| hover(editor, &Hover, window, cx));
1502 let symbol_range = cx.lsp_range(indoc! {"
1503 «fn» test() { println!(); }
1504 "});
1505
1506 let code_str = "\nlet hovered_point: Vector2F // size = 8, align = 0x4\n";
1507 let markdown_string = format!("\n```rust\n{code_str}```");
1508
1509 let closure_markdown_string = markdown_string.clone();
1510 cx.set_request_handler::<lsp::request::HoverRequest, _, _>(move |_, _, _| {
1511 let future_markdown_string = closure_markdown_string.clone();
1512 async move {
1513 Ok(Some(lsp::Hover {
1514 contents: lsp::HoverContents::Markup(lsp::MarkupContent {
1515 kind: lsp::MarkupKind::Markdown,
1516 value: future_markdown_string,
1517 }),
1518 range: Some(symbol_range),
1519 }))
1520 }
1521 })
1522 .next()
1523 .await;
1524
1525 cx.dispatch_action(Hover);
1526
1527 cx.condition(|editor, _| editor.hover_state.visible()).await;
1528 cx.editor(|editor, _, cx| {
1529 assert_eq!(
1530 editor.hover_state.info_popovers.len(),
1531 1,
1532 "Expected exactly one hover but got: {:?}",
1533 editor.hover_state.info_popovers.len()
1534 );
1535 let rendered_text = editor
1536 .hover_state
1537 .info_popovers
1538 .first()
1539 .unwrap()
1540 .get_rendered_text(cx);
1541
1542 assert_eq!(
1543 rendered_text, code_str,
1544 "Should not have extra line breaks at end of rendered hover"
1545 );
1546 });
1547 }
1548
1549 #[gpui::test]
1550 // https://github.com/zed-industries/zed/issues/15498
1551 async fn test_info_hover_with_hrs(cx: &mut gpui::TestAppContext) {
1552 init_test(cx, |_| {});
1553
1554 let mut cx = EditorLspTestContext::new_rust(
1555 lsp::ServerCapabilities {
1556 hover_provider: Some(lsp::HoverProviderCapability::Simple(true)),
1557 ..Default::default()
1558 },
1559 cx,
1560 )
1561 .await;
1562
1563 cx.set_state(indoc! {"
1564 fn fuˇnc(abc def: i32) -> u32 {
1565 }
1566 "});
1567
1568 cx.lsp
1569 .set_request_handler::<lsp::request::HoverRequest, _, _>({
1570 |_, _| async move {
1571 Ok(Some(lsp::Hover {
1572 contents: lsp::HoverContents::Markup(lsp::MarkupContent {
1573 kind: lsp::MarkupKind::Markdown,
1574 value: indoc!(
1575 r#"
1576 ### function `errands_data_read`
1577
1578 ---
1579 → `char *`
1580 Function to read a file into a string
1581
1582 ---
1583 ```cpp
1584 static char *errands_data_read()
1585 ```
1586 "#
1587 )
1588 .to_string(),
1589 }),
1590 range: None,
1591 }))
1592 }
1593 });
1594 cx.update_editor(|editor, window, cx| hover(editor, &Default::default(), window, cx));
1595 cx.run_until_parked();
1596
1597 cx.update_editor(|editor, _, cx| {
1598 let popover = editor.hover_state.info_popovers.first().unwrap();
1599 let content = popover.get_rendered_text(cx);
1600
1601 assert!(content.contains("Function to read a file"));
1602 });
1603 }
1604
1605 #[gpui::test]
1606 async fn test_hover_inlay_label_parts(cx: &mut gpui::TestAppContext) {
1607 init_test(cx, |settings| {
1608 settings.defaults.inlay_hints = Some(InlayHintSettingsContent {
1609 show_value_hints: Some(true),
1610 enabled: Some(true),
1611 edit_debounce_ms: Some(0),
1612 scroll_debounce_ms: Some(0),
1613 show_type_hints: Some(true),
1614 show_parameter_hints: Some(true),
1615 show_other_hints: Some(true),
1616 show_background: Some(false),
1617 toggle_on_modifiers_press: None,
1618 })
1619 });
1620
1621 let mut cx = EditorLspTestContext::new_rust(
1622 lsp::ServerCapabilities {
1623 inlay_hint_provider: Some(lsp::OneOf::Right(
1624 lsp::InlayHintServerCapabilities::Options(lsp::InlayHintOptions {
1625 resolve_provider: Some(true),
1626 ..Default::default()
1627 }),
1628 )),
1629 ..Default::default()
1630 },
1631 cx,
1632 )
1633 .await;
1634
1635 cx.set_state(indoc! {"
1636 struct TestStruct;
1637
1638 // ==================
1639
1640 struct TestNewType<T>(T);
1641
1642 fn main() {
1643 let variableˇ = TestNewType(TestStruct);
1644 }
1645 "});
1646
1647 let hint_start_offset = cx.ranges(indoc! {"
1648 struct TestStruct;
1649
1650 // ==================
1651
1652 struct TestNewType<T>(T);
1653
1654 fn main() {
1655 let variableˇ = TestNewType(TestStruct);
1656 }
1657 "})[0]
1658 .start;
1659 let hint_position = cx.to_lsp(MultiBufferOffset(hint_start_offset));
1660 let new_type_target_range = cx.lsp_range(indoc! {"
1661 struct TestStruct;
1662
1663 // ==================
1664
1665 struct «TestNewType»<T>(T);
1666
1667 fn main() {
1668 let variable = TestNewType(TestStruct);
1669 }
1670 "});
1671 let struct_target_range = cx.lsp_range(indoc! {"
1672 struct «TestStruct»;
1673
1674 // ==================
1675
1676 struct TestNewType<T>(T);
1677
1678 fn main() {
1679 let variable = TestNewType(TestStruct);
1680 }
1681 "});
1682
1683 let uri = cx.buffer_lsp_url.clone();
1684 let new_type_label = "TestNewType";
1685 let struct_label = "TestStruct";
1686 let entire_hint_label = ": TestNewType<TestStruct>";
1687 let closure_uri = uri.clone();
1688 cx.lsp
1689 .set_request_handler::<lsp::request::InlayHintRequest, _, _>(move |params, _| {
1690 let task_uri = closure_uri.clone();
1691 async move {
1692 assert_eq!(params.text_document.uri, task_uri);
1693 Ok(Some(vec![lsp::InlayHint {
1694 position: hint_position,
1695 label: lsp::InlayHintLabel::LabelParts(vec![lsp::InlayHintLabelPart {
1696 value: entire_hint_label.to_string(),
1697 ..Default::default()
1698 }]),
1699 kind: Some(lsp::InlayHintKind::TYPE),
1700 text_edits: None,
1701 tooltip: None,
1702 padding_left: Some(false),
1703 padding_right: Some(false),
1704 data: None,
1705 }]))
1706 }
1707 })
1708 .next()
1709 .await;
1710 cx.background_executor.run_until_parked();
1711 cx.update_editor(|editor, _, cx| {
1712 let expected_layers = vec![entire_hint_label.to_string()];
1713 assert_eq!(expected_layers, cached_hint_labels(editor, cx));
1714 assert_eq!(expected_layers, visible_hint_labels(editor, cx));
1715 });
1716
1717 let inlay_range = cx
1718 .ranges(indoc! {"
1719 struct TestStruct;
1720
1721 // ==================
1722
1723 struct TestNewType<T>(T);
1724
1725 fn main() {
1726 let variable« »= TestNewType(TestStruct);
1727 }
1728 "})
1729 .first()
1730 .cloned()
1731 .unwrap();
1732 let new_type_hint_part_hover_position = cx.update_editor(|editor, window, cx| {
1733 let snapshot = editor.snapshot(window, cx);
1734 let previous_valid = MultiBufferOffset(inlay_range.start).to_display_point(&snapshot);
1735 let next_valid = MultiBufferOffset(inlay_range.end).to_display_point(&snapshot);
1736 assert_eq!(previous_valid.row(), next_valid.row());
1737 assert!(previous_valid.column() < next_valid.column());
1738 let exact_unclipped = DisplayPoint::new(
1739 previous_valid.row(),
1740 previous_valid.column()
1741 + (entire_hint_label.find(new_type_label).unwrap() + new_type_label.len() / 2)
1742 as u32,
1743 );
1744 PointForPosition {
1745 previous_valid,
1746 next_valid,
1747 exact_unclipped,
1748 column_overshoot_after_line_end: 0,
1749 }
1750 });
1751 cx.update_editor(|editor, window, cx| {
1752 editor.update_inlay_link_and_hover_points(
1753 &editor.snapshot(window, cx),
1754 new_type_hint_part_hover_position,
1755 true,
1756 false,
1757 window,
1758 cx,
1759 );
1760 });
1761
1762 let resolve_closure_uri = uri.clone();
1763 cx.lsp
1764 .set_request_handler::<lsp::request::InlayHintResolveRequest, _, _>(
1765 move |mut hint_to_resolve, _| {
1766 let mut resolved_hint_positions = BTreeSet::new();
1767 let task_uri = resolve_closure_uri.clone();
1768 async move {
1769 let inserted = resolved_hint_positions.insert(hint_to_resolve.position);
1770 assert!(inserted, "Hint {hint_to_resolve:?} was resolved twice");
1771
1772 // `: TestNewType<TestStruct>`
1773 hint_to_resolve.label = lsp::InlayHintLabel::LabelParts(vec![
1774 lsp::InlayHintLabelPart {
1775 value: ": ".to_string(),
1776 ..Default::default()
1777 },
1778 lsp::InlayHintLabelPart {
1779 value: new_type_label.to_string(),
1780 location: Some(lsp::Location {
1781 uri: task_uri.clone(),
1782 range: new_type_target_range,
1783 }),
1784 tooltip: Some(lsp::InlayHintLabelPartTooltip::String(format!(
1785 "A tooltip for `{new_type_label}`"
1786 ))),
1787 ..Default::default()
1788 },
1789 lsp::InlayHintLabelPart {
1790 value: "<".to_string(),
1791 ..Default::default()
1792 },
1793 lsp::InlayHintLabelPart {
1794 value: struct_label.to_string(),
1795 location: Some(lsp::Location {
1796 uri: task_uri,
1797 range: struct_target_range,
1798 }),
1799 tooltip: Some(lsp::InlayHintLabelPartTooltip::MarkupContent(
1800 lsp::MarkupContent {
1801 kind: lsp::MarkupKind::Markdown,
1802 value: format!("A tooltip for `{struct_label}`"),
1803 },
1804 )),
1805 ..Default::default()
1806 },
1807 lsp::InlayHintLabelPart {
1808 value: ">".to_string(),
1809 ..Default::default()
1810 },
1811 ]);
1812
1813 Ok(hint_to_resolve)
1814 }
1815 },
1816 )
1817 .next()
1818 .await;
1819 cx.background_executor.run_until_parked();
1820
1821 cx.update_editor(|editor, window, cx| {
1822 editor.update_inlay_link_and_hover_points(
1823 &editor.snapshot(window, cx),
1824 new_type_hint_part_hover_position,
1825 true,
1826 false,
1827 window,
1828 cx,
1829 );
1830 });
1831 cx.background_executor
1832 .advance_clock(Duration::from_millis(get_hover_popover_delay(&cx) + 100));
1833 cx.background_executor.run_until_parked();
1834 cx.update_editor(|editor, _, cx| {
1835 let hover_state = &editor.hover_state;
1836 assert!(
1837 hover_state.diagnostic_popover.is_none() && hover_state.info_popovers.len() == 1
1838 );
1839 let popover = hover_state.info_popovers.first().unwrap();
1840 let buffer_snapshot = editor.buffer().update(cx, |buffer, cx| buffer.snapshot(cx));
1841 assert_eq!(
1842 popover.symbol_range,
1843 RangeInEditor::Inlay(InlayHighlight {
1844 inlay: InlayId::Hint(0),
1845 inlay_position: buffer_snapshot
1846 .anchor_after(MultiBufferOffset(inlay_range.start)),
1847 range: ": ".len()..": ".len() + new_type_label.len(),
1848 }),
1849 "Popover range should match the new type label part"
1850 );
1851 assert_eq!(
1852 popover.get_rendered_text(cx),
1853 format!("A tooltip for {new_type_label}"),
1854 );
1855 });
1856
1857 let struct_hint_part_hover_position = cx.update_editor(|editor, window, cx| {
1858 let snapshot = editor.snapshot(window, cx);
1859 let previous_valid = MultiBufferOffset(inlay_range.start).to_display_point(&snapshot);
1860 let next_valid = MultiBufferOffset(inlay_range.end).to_display_point(&snapshot);
1861 assert_eq!(previous_valid.row(), next_valid.row());
1862 assert!(previous_valid.column() < next_valid.column());
1863 let exact_unclipped = DisplayPoint::new(
1864 previous_valid.row(),
1865 previous_valid.column()
1866 + (entire_hint_label.find(struct_label).unwrap() + struct_label.len() / 2)
1867 as u32,
1868 );
1869 PointForPosition {
1870 previous_valid,
1871 next_valid,
1872 exact_unclipped,
1873 column_overshoot_after_line_end: 0,
1874 }
1875 });
1876 cx.update_editor(|editor, window, cx| {
1877 editor.update_inlay_link_and_hover_points(
1878 &editor.snapshot(window, cx),
1879 struct_hint_part_hover_position,
1880 true,
1881 false,
1882 window,
1883 cx,
1884 );
1885 });
1886 cx.background_executor
1887 .advance_clock(Duration::from_millis(get_hover_popover_delay(&cx) + 100));
1888 cx.background_executor.run_until_parked();
1889 cx.update_editor(|editor, _, cx| {
1890 let hover_state = &editor.hover_state;
1891 assert!(
1892 hover_state.diagnostic_popover.is_none() && hover_state.info_popovers.len() == 1
1893 );
1894 let popover = hover_state.info_popovers.first().unwrap();
1895 let buffer_snapshot = editor.buffer().update(cx, |buffer, cx| buffer.snapshot(cx));
1896 assert_eq!(
1897 popover.symbol_range,
1898 RangeInEditor::Inlay(InlayHighlight {
1899 inlay: InlayId::Hint(0),
1900 inlay_position: buffer_snapshot
1901 .anchor_after(MultiBufferOffset(inlay_range.start)),
1902 range: ": ".len() + new_type_label.len() + "<".len()
1903 ..": ".len() + new_type_label.len() + "<".len() + struct_label.len(),
1904 }),
1905 "Popover range should match the struct label part"
1906 );
1907 assert_eq!(
1908 popover.get_rendered_text(cx),
1909 format!("A tooltip for {struct_label}"),
1910 "Rendered markdown element should remove backticks from text"
1911 );
1912 });
1913 }
1914
1915 #[test]
1916 fn test_find_hovered_hint_part_with_multibyte_characters() {
1917 use crate::display_map::InlayOffset;
1918 use multi_buffer::MultiBufferOffset;
1919 use project::InlayHintLabelPart;
1920
1921 // Test with multi-byte UTF-8 character "→" (3 bytes, 1 character)
1922 let label = "→ app/Livewire/UserProfile.php";
1923 let label_parts = vec![InlayHintLabelPart {
1924 value: label.to_string(),
1925 tooltip: None,
1926 location: None,
1927 }];
1928
1929 let hint_start = InlayOffset(MultiBufferOffset(100));
1930
1931 // Verify the label has more bytes than characters (due to "→")
1932 assert_eq!(label.len(), 32); // bytes
1933 assert_eq!(label.chars().count(), 30); // characters
1934
1935 // Test hovering at the last byte (should find the part)
1936 let last_byte_offset = InlayOffset(MultiBufferOffset(100 + label.len() - 1));
1937 let result = find_hovered_hint_part(label_parts.clone(), hint_start, last_byte_offset);
1938 assert!(
1939 result.is_some(),
1940 "Should find part when hovering at last byte"
1941 );
1942 let (part, range) = result.unwrap();
1943 assert_eq!(part.value, label);
1944 assert_eq!(range.start, hint_start);
1945 assert_eq!(range.end, InlayOffset(MultiBufferOffset(100 + label.len())));
1946
1947 // Test hovering at the first byte of "→" (byte 0)
1948 let first_byte_offset = InlayOffset(MultiBufferOffset(100));
1949 let result = find_hovered_hint_part(label_parts.clone(), hint_start, first_byte_offset);
1950 assert!(
1951 result.is_some(),
1952 "Should find part when hovering at first byte"
1953 );
1954
1955 // Test hovering in the middle of "→" (byte 1, still part of the arrow character)
1956 let mid_arrow_offset = InlayOffset(MultiBufferOffset(101));
1957 let result = find_hovered_hint_part(label_parts, hint_start, mid_arrow_offset);
1958 assert!(
1959 result.is_some(),
1960 "Should find part when hovering in middle of multi-byte char"
1961 );
1962
1963 // Test with multiple parts containing multi-byte characters
1964 // Part ranges are [start, end) - start inclusive, end exclusive
1965 // "→ " occupies bytes [0, 4), "path" occupies bytes [4, 8)
1966 let parts = vec![
1967 InlayHintLabelPart {
1968 value: "→ ".to_string(), // 4 bytes (3 + 1)
1969 tooltip: None,
1970 location: None,
1971 },
1972 InlayHintLabelPart {
1973 value: "path".to_string(), // 4 bytes
1974 tooltip: None,
1975 location: None,
1976 },
1977 ];
1978
1979 // Hover at byte 3 (last byte of "→ ", the space character)
1980 let arrow_last_byte = InlayOffset(MultiBufferOffset(100 + 3));
1981 let result = find_hovered_hint_part(parts.clone(), hint_start, arrow_last_byte);
1982 assert!(result.is_some(), "Should find first part at its last byte");
1983 let (part, range) = result.unwrap();
1984 assert_eq!(part.value, "→ ");
1985 assert_eq!(
1986 range,
1987 InlayOffset(MultiBufferOffset(100))..InlayOffset(MultiBufferOffset(104))
1988 );
1989
1990 // Hover at byte 4 (first byte of "path", at the boundary)
1991 let path_start_offset = InlayOffset(MultiBufferOffset(100 + 4));
1992 let result = find_hovered_hint_part(parts.clone(), hint_start, path_start_offset);
1993 assert!(result.is_some(), "Should find second part at boundary");
1994 let (part, _) = result.unwrap();
1995 assert_eq!(part.value, "path");
1996
1997 // Hover at byte 7 (last byte of "path")
1998 let path_end_offset = InlayOffset(MultiBufferOffset(100 + 7));
1999 let result = find_hovered_hint_part(parts, hint_start, path_end_offset);
2000 assert!(result.is_some(), "Should find second part at last byte");
2001 let (part, range) = result.unwrap();
2002 assert_eq!(part.value, "path");
2003 assert_eq!(
2004 range,
2005 InlayOffset(MultiBufferOffset(104))..InlayOffset(MultiBufferOffset(108))
2006 );
2007 }
2008}