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