1use crate::{
2 ActiveDiagnostic, Anchor, AnchorRangeExt, DisplayPoint, DisplayRow, Editor, EditorSettings,
3 EditorSnapshot, GlobalDiagnosticRenderer, 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::{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::{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 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 && 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 hide_hover(editor, cx);
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::<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::<usize>(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.len())
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::<HoverState>(cx);
517 } else {
518 // Highlight the selected symbol using a background highlight
519 editor.highlight_background::<HoverState>(
520 &hover_highlights,
521 |theme| theme.colors().element_hover, // todo update theme
522 cx,
523 );
524 }
525
526 editor.hover_state.info_popovers = info_popovers;
527 cx.notify();
528 window.refresh();
529 })?;
530
531 anyhow::Ok(())
532 }
533 .log_err()
534 .await
535 });
536
537 editor.hover_state.info_task = Some(task);
538 None
539}
540
541fn same_info_hover(editor: &Editor, snapshot: &EditorSnapshot, anchor: Anchor) -> bool {
542 editor
543 .hover_state
544 .info_popovers
545 .iter()
546 .any(|InfoPopover { symbol_range, .. }| {
547 symbol_range
548 .as_text_range()
549 .map(|range| {
550 let hover_range = range.to_offset(&snapshot.buffer_snapshot());
551 let offset = anchor.to_offset(&snapshot.buffer_snapshot());
552 // LSP returns a hover result for the end index of ranges that should be hovered, so we need to
553 // use an inclusive range here to check if we should dismiss the popover
554 (hover_range.start..=hover_range.end).contains(&offset)
555 })
556 .unwrap_or(false)
557 })
558}
559
560fn same_diagnostic_hover(editor: &Editor, snapshot: &EditorSnapshot, anchor: Anchor) -> bool {
561 editor
562 .hover_state
563 .diagnostic_popover
564 .as_ref()
565 .map(|diagnostic| {
566 let hover_range = diagnostic
567 .local_diagnostic
568 .range
569 .to_offset(&snapshot.buffer_snapshot());
570 let offset = anchor.to_offset(&snapshot.buffer_snapshot());
571
572 // Here we do basically the same as in `same_info_hover`, see comment there for an explanation
573 (hover_range.start..=hover_range.end).contains(&offset)
574 })
575 .unwrap_or(false)
576}
577
578async fn parse_blocks(
579 blocks: &[HoverBlock],
580 language_registry: Option<&Arc<LanguageRegistry>>,
581 language: Option<Arc<Language>>,
582 cx: &mut AsyncWindowContext,
583) -> Option<Entity<Markdown>> {
584 let combined_text = blocks
585 .iter()
586 .map(|block| match &block.kind {
587 project::HoverBlockKind::PlainText | project::HoverBlockKind::Markdown => {
588 Cow::Borrowed(block.text.trim())
589 }
590 project::HoverBlockKind::Code { language } => {
591 Cow::Owned(format!("```{}\n{}\n```", language, block.text.trim()))
592 }
593 })
594 .join("\n\n");
595
596 cx.new_window_entity(|_window, cx| {
597 Markdown::new(
598 combined_text.into(),
599 language_registry.cloned(),
600 language.map(|language| language.name()),
601 cx,
602 )
603 })
604 .ok()
605}
606
607pub fn hover_markdown_style(window: &Window, cx: &App) -> MarkdownStyle {
608 let settings = ThemeSettings::get_global(cx);
609 let ui_font_family = settings.ui_font.family.clone();
610 let ui_font_fallbacks = settings.ui_font.fallbacks.clone();
611 let buffer_font_family = settings.buffer_font.family.clone();
612 let buffer_font_fallbacks = settings.buffer_font.fallbacks.clone();
613
614 let mut base_text_style = window.text_style();
615 base_text_style.refine(&TextStyleRefinement {
616 font_family: Some(ui_font_family),
617 font_fallbacks: ui_font_fallbacks,
618 color: Some(cx.theme().colors().editor_foreground),
619 ..Default::default()
620 });
621 MarkdownStyle {
622 base_text_style,
623 code_block: StyleRefinement::default().my(rems(1.)).font_buffer(cx),
624 inline_code: TextStyleRefinement {
625 background_color: Some(cx.theme().colors().background),
626 font_family: Some(buffer_font_family),
627 font_fallbacks: buffer_font_fallbacks,
628 ..Default::default()
629 },
630 rule_color: cx.theme().colors().border,
631 block_quote_border_color: Color::Muted.color(cx),
632 block_quote: TextStyleRefinement {
633 color: Some(Color::Muted.color(cx)),
634 ..Default::default()
635 },
636 link: TextStyleRefinement {
637 color: Some(cx.theme().colors().editor_foreground),
638 underline: Some(gpui::UnderlineStyle {
639 thickness: px(1.),
640 color: Some(cx.theme().colors().editor_foreground),
641 wavy: false,
642 }),
643 ..Default::default()
644 },
645 syntax: cx.theme().syntax().clone(),
646 selection_background_color: cx.theme().colors().element_selection_background,
647 heading: StyleRefinement::default()
648 .font_weight(FontWeight::BOLD)
649 .text_base()
650 .mt(rems(1.))
651 .mb_0(),
652 ..Default::default()
653 }
654}
655
656pub fn diagnostics_markdown_style(window: &Window, cx: &App) -> MarkdownStyle {
657 let settings = ThemeSettings::get_global(cx);
658 let ui_font_family = settings.ui_font.family.clone();
659 let ui_font_fallbacks = settings.ui_font.fallbacks.clone();
660 let buffer_font_family = settings.buffer_font.family.clone();
661 let buffer_font_fallbacks = settings.buffer_font.fallbacks.clone();
662
663 let mut base_text_style = window.text_style();
664 base_text_style.refine(&TextStyleRefinement {
665 font_family: Some(ui_font_family),
666 font_fallbacks: ui_font_fallbacks,
667 color: Some(cx.theme().colors().editor_foreground),
668 ..Default::default()
669 });
670 MarkdownStyle {
671 base_text_style,
672 code_block: StyleRefinement::default().my(rems(1.)).font_buffer(cx),
673 inline_code: TextStyleRefinement {
674 background_color: Some(cx.theme().colors().editor_background.opacity(0.5)),
675 font_family: Some(buffer_font_family),
676 font_fallbacks: buffer_font_fallbacks,
677 ..Default::default()
678 },
679 rule_color: cx.theme().colors().border,
680 block_quote_border_color: Color::Muted.color(cx),
681 block_quote: TextStyleRefinement {
682 color: Some(Color::Muted.color(cx)),
683 ..Default::default()
684 },
685 link: TextStyleRefinement {
686 color: Some(cx.theme().colors().editor_foreground),
687 underline: Some(gpui::UnderlineStyle {
688 thickness: px(1.),
689 color: Some(cx.theme().colors().editor_foreground),
690 wavy: false,
691 }),
692 ..Default::default()
693 },
694 syntax: cx.theme().syntax().clone(),
695 selection_background_color: cx.theme().colors().element_selection_background,
696 height_is_multiple_of_line_height: true,
697 heading: StyleRefinement::default()
698 .font_weight(FontWeight::BOLD)
699 .text_base()
700 .mb_0(),
701 ..Default::default()
702 }
703}
704
705pub fn open_markdown_url(link: SharedString, window: &mut Window, cx: &mut App) {
706 if let Ok(uri) = Url::parse(&link)
707 && uri.scheme() == "file"
708 && let Some(workspace) = window.root::<Workspace>().flatten()
709 {
710 workspace.update(cx, |workspace, cx| {
711 let task = workspace.open_abs_path(
712 PathBuf::from(uri.path()),
713 OpenOptions {
714 visible: Some(OpenVisible::None),
715 ..Default::default()
716 },
717 window,
718 cx,
719 );
720
721 cx.spawn_in(window, async move |_, cx| {
722 let item = task.await?;
723 // Ruby LSP uses URLs with #L1,1-4,4
724 // we'll just take the first number and assume it's a line number
725 let Some(fragment) = uri.fragment() else {
726 return anyhow::Ok(());
727 };
728 let mut accum = 0u32;
729 for c in fragment.chars() {
730 if c >= '0' && c <= '9' && accum < u32::MAX / 2 {
731 accum *= 10;
732 accum += c as u32 - '0' as u32;
733 } else if accum > 0 {
734 break;
735 }
736 }
737 if accum == 0 {
738 return Ok(());
739 }
740 let Some(editor) = cx.update(|_, cx| item.act_as::<Editor>(cx))? else {
741 return Ok(());
742 };
743 editor.update_in(cx, |editor, window, cx| {
744 editor.change_selections(Default::default(), window, cx, |selections| {
745 selections.select_ranges([
746 text::Point::new(accum - 1, 0)..text::Point::new(accum - 1, 0)
747 ]);
748 });
749 })
750 })
751 .detach_and_log_err(cx);
752 });
753 return;
754 }
755 cx.open_url(&link);
756}
757
758#[derive(Default)]
759pub struct HoverState {
760 pub info_popovers: Vec<InfoPopover>,
761 pub diagnostic_popover: Option<DiagnosticPopover>,
762 pub triggered_from: Option<Anchor>,
763 pub info_task: Option<Task<Option<()>>>,
764}
765
766impl HoverState {
767 pub fn visible(&self) -> bool {
768 !self.info_popovers.is_empty() || self.diagnostic_popover.is_some()
769 }
770
771 pub(crate) fn render(
772 &mut self,
773 snapshot: &EditorSnapshot,
774 visible_rows: Range<DisplayRow>,
775 max_size: Size<Pixels>,
776 text_layout_details: &TextLayoutDetails,
777 window: &mut Window,
778 cx: &mut Context<Editor>,
779 ) -> Option<(DisplayPoint, Vec<AnyElement>)> {
780 if !self.visible() {
781 return None;
782 }
783 // If there is a diagnostic, position the popovers based on that.
784 // Otherwise use the start of the hover range
785 let anchor = self
786 .diagnostic_popover
787 .as_ref()
788 .map(|diagnostic_popover| &diagnostic_popover.local_diagnostic.range.start)
789 .or_else(|| {
790 self.info_popovers.iter().find_map(|info_popover| {
791 match &info_popover.symbol_range {
792 RangeInEditor::Text(range) => Some(&range.start),
793 RangeInEditor::Inlay(_) => None,
794 }
795 })
796 })
797 .or_else(|| {
798 self.info_popovers.iter().find_map(|info_popover| {
799 match &info_popover.symbol_range {
800 RangeInEditor::Text(_) => None,
801 RangeInEditor::Inlay(range) => Some(&range.inlay_position),
802 }
803 })
804 })?;
805 let mut point = anchor.to_display_point(&snapshot.display_snapshot);
806 // Clamp the point within the visible rows in case the popup source spans multiple lines
807 if visible_rows.end <= point.row() {
808 point = crate::movement::up_by_rows(
809 &snapshot.display_snapshot,
810 point,
811 1 + (point.row() - visible_rows.end).0,
812 text::SelectionGoal::None,
813 true,
814 text_layout_details,
815 )
816 .0;
817 } else if point.row() < visible_rows.start {
818 point = crate::movement::down_by_rows(
819 &snapshot.display_snapshot,
820 point,
821 (visible_rows.start - point.row()).0,
822 text::SelectionGoal::None,
823 true,
824 text_layout_details,
825 )
826 .0;
827 }
828
829 if !visible_rows.contains(&point.row()) {
830 log::error!("Hover popover point out of bounds after moving");
831 return None;
832 }
833
834 let mut elements = Vec::new();
835
836 if let Some(diagnostic_popover) = self.diagnostic_popover.as_ref() {
837 elements.push(diagnostic_popover.render(max_size, window, cx));
838 }
839 for info_popover in &mut self.info_popovers {
840 elements.push(info_popover.render(max_size, window, cx));
841 }
842
843 Some((point, elements))
844 }
845
846 pub fn focused(&self, window: &mut Window, cx: &mut Context<Editor>) -> bool {
847 let mut hover_popover_is_focused = false;
848 for info_popover in &self.info_popovers {
849 if let Some(markdown_view) = &info_popover.parsed_content
850 && markdown_view.focus_handle(cx).is_focused(window)
851 {
852 hover_popover_is_focused = true;
853 }
854 }
855 if let Some(diagnostic_popover) = &self.diagnostic_popover
856 && diagnostic_popover
857 .markdown
858 .focus_handle(cx)
859 .is_focused(window)
860 {
861 hover_popover_is_focused = true;
862 }
863 hover_popover_is_focused
864 }
865}
866
867pub struct InfoPopover {
868 pub symbol_range: RangeInEditor,
869 pub parsed_content: Option<Entity<Markdown>>,
870 pub scroll_handle: ScrollHandle,
871 pub keyboard_grace: Rc<RefCell<bool>>,
872 pub anchor: Option<Anchor>,
873 _subscription: Option<Subscription>,
874}
875
876impl InfoPopover {
877 pub(crate) fn render(
878 &mut self,
879 max_size: Size<Pixels>,
880 window: &mut Window,
881 cx: &mut Context<Editor>,
882 ) -> AnyElement {
883 let keyboard_grace = Rc::clone(&self.keyboard_grace);
884 div()
885 .id("info_popover")
886 .occlude()
887 .elevation_2(cx)
888 // Prevent a mouse down/move on the popover from being propagated to the editor,
889 // because that would dismiss the popover.
890 .on_mouse_move(|_, _, cx| cx.stop_propagation())
891 .on_mouse_down(MouseButton::Left, move |_, _, cx| {
892 let mut keyboard_grace = keyboard_grace.borrow_mut();
893 *keyboard_grace = false;
894 cx.stop_propagation();
895 })
896 .p_2()
897 .when_some(self.parsed_content.clone(), |this, markdown| {
898 this.child(
899 div()
900 .id("info-md-container")
901 .overflow_y_scroll()
902 .max_w(max_size.width)
903 .max_h(max_size.height)
904 .track_scroll(&self.scroll_handle)
905 .child(
906 MarkdownElement::new(markdown, hover_markdown_style(window, cx))
907 .code_block_renderer(markdown::CodeBlockRenderer::Default {
908 copy_button: false,
909 copy_button_on_hover: false,
910 border: false,
911 })
912 .on_url_click(open_markdown_url),
913 ),
914 )
915 .custom_scrollbars(
916 Scrollbars::for_settings::<EditorSettings>()
917 .tracked_scroll_handle(self.scroll_handle.clone()),
918 window,
919 cx,
920 )
921 })
922 .into_any_element()
923 }
924
925 pub fn scroll(&self, amount: ScrollAmount, window: &mut Window, cx: &mut Context<Editor>) {
926 let mut current = self.scroll_handle.offset();
927 current.y -= amount.pixels(
928 window.line_height(),
929 self.scroll_handle.bounds().size.height - px(16.),
930 ) / 2.0;
931 cx.notify();
932 self.scroll_handle.set_offset(current);
933 }
934}
935
936pub struct DiagnosticPopover {
937 pub(crate) local_diagnostic: DiagnosticEntry<Anchor>,
938 markdown: Entity<Markdown>,
939 border_color: Hsla,
940 background_color: Hsla,
941 pub keyboard_grace: Rc<RefCell<bool>>,
942 pub anchor: Anchor,
943 _subscription: Subscription,
944 pub scroll_handle: ScrollHandle,
945}
946
947impl DiagnosticPopover {
948 pub fn render(
949 &self,
950 max_size: Size<Pixels>,
951 window: &mut Window,
952 cx: &mut Context<Editor>,
953 ) -> AnyElement {
954 let keyboard_grace = Rc::clone(&self.keyboard_grace);
955 let this = cx.entity().downgrade();
956 div()
957 .id("diagnostic")
958 .occlude()
959 .elevation_2_borderless(cx)
960 // Don't draw the background color if the theme
961 // allows transparent surfaces.
962 .when(theme_is_transparent(cx), |this| {
963 this.bg(gpui::transparent_black())
964 })
965 // Prevent a mouse move on the popover from being propagated to the editor,
966 // because that would dismiss the popover.
967 .on_mouse_move(|_, _, cx| cx.stop_propagation())
968 // Prevent a mouse down on the popover from being propagated to the editor,
969 // because that would move the cursor.
970 .on_mouse_down(MouseButton::Left, move |_, _, cx| {
971 let mut keyboard_grace = keyboard_grace.borrow_mut();
972 *keyboard_grace = false;
973 cx.stop_propagation();
974 })
975 .child(
976 div()
977 .py_1()
978 .px_2()
979 .bg(self.background_color)
980 .border_1()
981 .border_color(self.border_color)
982 .rounded_lg()
983 .child(
984 div()
985 .id("diagnostic-content-container")
986 .overflow_y_scroll()
987 .max_w(max_size.width)
988 .max_h(max_size.height)
989 .track_scroll(&self.scroll_handle)
990 .child(
991 MarkdownElement::new(
992 self.markdown.clone(),
993 diagnostics_markdown_style(window, cx),
994 )
995 .code_block_renderer(markdown::CodeBlockRenderer::Default {
996 copy_button: false,
997 copy_button_on_hover: false,
998 border: false,
999 })
1000 .on_url_click(
1001 move |link, window, cx| {
1002 if let Some(renderer) = GlobalDiagnosticRenderer::global(cx)
1003 {
1004 this.update(cx, |this, cx| {
1005 renderer.as_ref().open_link(this, link, window, cx);
1006 })
1007 .ok();
1008 }
1009 },
1010 ),
1011 ),
1012 )
1013 .custom_scrollbars(
1014 Scrollbars::for_settings::<EditorSettings>()
1015 .tracked_scroll_handle(self.scroll_handle.clone()),
1016 window,
1017 cx,
1018 ),
1019 )
1020 .into_any_element()
1021 }
1022}
1023
1024#[cfg(test)]
1025mod tests {
1026 use super::*;
1027 use crate::{
1028 PointForPosition,
1029 actions::ConfirmCompletion,
1030 editor_tests::{handle_completion_request, init_test},
1031 inlays::inlay_hints::tests::{cached_hint_labels, visible_hint_labels},
1032 test::editor_lsp_test_context::EditorLspTestContext,
1033 };
1034 use collections::BTreeSet;
1035 use gpui::App;
1036 use indoc::indoc;
1037 use markdown::parser::MarkdownEvent;
1038 use project::InlayId;
1039 use settings::InlayHintSettingsContent;
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.0 })
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) => {
1061 rendered_text.push_str(parsed.as_str())
1062 }
1063 MarkdownEvent::Text | MarkdownEvent::Code => {
1064 rendered_text.push_str(&text[range.clone()])
1065 }
1066 _ => {}
1067 }
1068 }
1069 }
1070 rendered_text
1071 }
1072 }
1073
1074 #[gpui::test]
1075 async fn test_mouse_hover_info_popover_with_autocomplete_popover(
1076 cx: &mut gpui::TestAppContext,
1077 ) {
1078 init_test(cx, |_| {});
1079
1080 let mut cx = EditorLspTestContext::new_rust(
1081 lsp::ServerCapabilities {
1082 hover_provider: Some(lsp::HoverProviderCapability::Simple(true)),
1083 completion_provider: Some(lsp::CompletionOptions {
1084 trigger_characters: Some(vec![".".to_string(), ":".to_string()]),
1085 resolve_provider: Some(true),
1086 ..Default::default()
1087 }),
1088 ..Default::default()
1089 },
1090 cx,
1091 )
1092 .await;
1093 let counter = Arc::new(AtomicUsize::new(0));
1094 // Basic hover delays and then pops without moving the mouse
1095 cx.set_state(indoc! {"
1096 oneˇ
1097 two
1098 three
1099 fn test() { println!(); }
1100 "});
1101
1102 //prompt autocompletion menu
1103 cx.simulate_keystroke(".");
1104 handle_completion_request(
1105 indoc! {"
1106 one.|<>
1107 two
1108 three
1109 "},
1110 vec!["first_completion", "second_completion"],
1111 true,
1112 counter.clone(),
1113 &mut cx,
1114 )
1115 .await;
1116 cx.condition(|editor, _| editor.context_menu_visible()) // wait until completion menu is visible
1117 .await;
1118 assert_eq!(counter.load(atomic::Ordering::Acquire), 1); // 1 completion request
1119
1120 let hover_point = cx.display_point(indoc! {"
1121 one.
1122 two
1123 three
1124 fn test() { printˇln!(); }
1125 "});
1126 cx.update_editor(|editor, window, cx| {
1127 let snapshot = editor.snapshot(window, cx);
1128 let anchor = snapshot
1129 .buffer_snapshot()
1130 .anchor_before(hover_point.to_offset(&snapshot, Bias::Left));
1131 hover_at(editor, Some(anchor), window, cx)
1132 });
1133 assert!(!cx.editor(|editor, _window, _cx| editor.hover_state.visible()));
1134
1135 // After delay, hover should be visible.
1136 let symbol_range = cx.lsp_range(indoc! {"
1137 one.
1138 two
1139 three
1140 fn test() { «println!»(); }
1141 "});
1142 let mut requests =
1143 cx.set_request_handler::<lsp::request::HoverRequest, _, _>(move |_, _, _| async move {
1144 Ok(Some(lsp::Hover {
1145 contents: lsp::HoverContents::Markup(lsp::MarkupContent {
1146 kind: lsp::MarkupKind::Markdown,
1147 value: "some basic docs".to_string(),
1148 }),
1149 range: Some(symbol_range),
1150 }))
1151 });
1152 cx.background_executor
1153 .advance_clock(Duration::from_millis(get_hover_popover_delay(&cx) + 100));
1154 requests.next().await;
1155
1156 cx.editor(|editor, _window, cx| {
1157 assert!(editor.hover_state.visible());
1158 assert_eq!(
1159 editor.hover_state.info_popovers.len(),
1160 1,
1161 "Expected exactly one hover but got: {:?}",
1162 editor.hover_state.info_popovers.len()
1163 );
1164 let rendered_text = editor
1165 .hover_state
1166 .info_popovers
1167 .first()
1168 .unwrap()
1169 .get_rendered_text(cx);
1170 assert_eq!(rendered_text, "some basic docs".to_string())
1171 });
1172
1173 // check that the completion menu is still visible and that there still has only been 1 completion request
1174 cx.editor(|editor, _, _| assert!(editor.context_menu_visible()));
1175 assert_eq!(counter.load(atomic::Ordering::Acquire), 1);
1176
1177 //apply a completion and check it was successfully applied
1178 let _apply_additional_edits = cx.update_editor(|editor, window, cx| {
1179 editor.context_menu_next(&Default::default(), window, cx);
1180 editor
1181 .confirm_completion(&ConfirmCompletion::default(), window, cx)
1182 .unwrap()
1183 });
1184 cx.assert_editor_state(indoc! {"
1185 one.second_completionˇ
1186 two
1187 three
1188 fn test() { println!(); }
1189 "});
1190
1191 // check that the completion menu is no longer visible and that there still has only been 1 completion request
1192 cx.editor(|editor, _, _| assert!(!editor.context_menu_visible()));
1193 assert_eq!(counter.load(atomic::Ordering::Acquire), 1);
1194
1195 //verify the information popover is still visible and unchanged
1196 cx.editor(|editor, _, cx| {
1197 assert!(editor.hover_state.visible());
1198 assert_eq!(
1199 editor.hover_state.info_popovers.len(),
1200 1,
1201 "Expected exactly one hover but got: {:?}",
1202 editor.hover_state.info_popovers.len()
1203 );
1204 let rendered_text = editor
1205 .hover_state
1206 .info_popovers
1207 .first()
1208 .unwrap()
1209 .get_rendered_text(cx);
1210
1211 assert_eq!(rendered_text, "some basic docs".to_string())
1212 });
1213
1214 // Mouse moved with no hover response dismisses
1215 let hover_point = cx.display_point(indoc! {"
1216 one.second_completionˇ
1217 two
1218 three
1219 fn teˇst() { println!(); }
1220 "});
1221 let mut request = cx
1222 .lsp
1223 .set_request_handler::<lsp::request::HoverRequest, _, _>(
1224 |_, _| async move { Ok(None) },
1225 );
1226 cx.update_editor(|editor, window, cx| {
1227 let snapshot = editor.snapshot(window, cx);
1228 let anchor = snapshot
1229 .buffer_snapshot()
1230 .anchor_before(hover_point.to_offset(&snapshot, Bias::Left));
1231 hover_at(editor, Some(anchor), window, cx)
1232 });
1233 cx.background_executor
1234 .advance_clock(Duration::from_millis(get_hover_popover_delay(&cx) + 100));
1235 request.next().await;
1236
1237 // verify that the information popover is no longer visible
1238 cx.editor(|editor, _, _| {
1239 assert!(!editor.hover_state.visible());
1240 });
1241 }
1242
1243 #[gpui::test]
1244 async fn test_mouse_hover_info_popover(cx: &mut gpui::TestAppContext) {
1245 init_test(cx, |_| {});
1246
1247 let mut cx = EditorLspTestContext::new_rust(
1248 lsp::ServerCapabilities {
1249 hover_provider: Some(lsp::HoverProviderCapability::Simple(true)),
1250 ..Default::default()
1251 },
1252 cx,
1253 )
1254 .await;
1255
1256 // Basic hover delays and then pops without moving the mouse
1257 cx.set_state(indoc! {"
1258 fn ˇtest() { println!(); }
1259 "});
1260 let hover_point = cx.display_point(indoc! {"
1261 fn test() { printˇln!(); }
1262 "});
1263
1264 cx.update_editor(|editor, window, cx| {
1265 let snapshot = editor.snapshot(window, cx);
1266 let anchor = snapshot
1267 .buffer_snapshot()
1268 .anchor_before(hover_point.to_offset(&snapshot, Bias::Left));
1269 hover_at(editor, Some(anchor), window, cx)
1270 });
1271 assert!(!cx.editor(|editor, _window, _cx| editor.hover_state.visible()));
1272
1273 // After delay, hover should be visible.
1274 let symbol_range = cx.lsp_range(indoc! {"
1275 fn test() { «println!»(); }
1276 "});
1277 let mut requests =
1278 cx.set_request_handler::<lsp::request::HoverRequest, _, _>(move |_, _, _| async move {
1279 Ok(Some(lsp::Hover {
1280 contents: lsp::HoverContents::Markup(lsp::MarkupContent {
1281 kind: lsp::MarkupKind::Markdown,
1282 value: "some basic docs".to_string(),
1283 }),
1284 range: Some(symbol_range),
1285 }))
1286 });
1287 cx.background_executor
1288 .advance_clock(Duration::from_millis(get_hover_popover_delay(&cx) + 100));
1289 requests.next().await;
1290
1291 cx.editor(|editor, _, cx| {
1292 assert!(editor.hover_state.visible());
1293 assert_eq!(
1294 editor.hover_state.info_popovers.len(),
1295 1,
1296 "Expected exactly one hover but got: {:?}",
1297 editor.hover_state.info_popovers.len()
1298 );
1299 let rendered_text = editor
1300 .hover_state
1301 .info_popovers
1302 .first()
1303 .unwrap()
1304 .get_rendered_text(cx);
1305
1306 assert_eq!(rendered_text, "some basic docs".to_string())
1307 });
1308
1309 // Mouse moved with no hover response dismisses
1310 let hover_point = cx.display_point(indoc! {"
1311 fn teˇst() { println!(); }
1312 "});
1313 let mut request = cx
1314 .lsp
1315 .set_request_handler::<lsp::request::HoverRequest, _, _>(
1316 |_, _| async move { Ok(None) },
1317 );
1318 cx.update_editor(|editor, window, cx| {
1319 let snapshot = editor.snapshot(window, cx);
1320 let anchor = snapshot
1321 .buffer_snapshot()
1322 .anchor_before(hover_point.to_offset(&snapshot, Bias::Left));
1323 hover_at(editor, Some(anchor), window, cx)
1324 });
1325 cx.background_executor
1326 .advance_clock(Duration::from_millis(get_hover_popover_delay(&cx) + 100));
1327 request.next().await;
1328 cx.editor(|editor, _, _| {
1329 assert!(!editor.hover_state.visible());
1330 });
1331 }
1332
1333 #[gpui::test]
1334 async fn test_keyboard_hover_info_popover(cx: &mut gpui::TestAppContext) {
1335 init_test(cx, |_| {});
1336
1337 let mut cx = EditorLspTestContext::new_rust(
1338 lsp::ServerCapabilities {
1339 hover_provider: Some(lsp::HoverProviderCapability::Simple(true)),
1340 ..Default::default()
1341 },
1342 cx,
1343 )
1344 .await;
1345
1346 // Hover with keyboard has no delay
1347 cx.set_state(indoc! {"
1348 fˇn test() { println!(); }
1349 "});
1350 cx.update_editor(|editor, window, cx| hover(editor, &Hover, window, cx));
1351 let symbol_range = cx.lsp_range(indoc! {"
1352 «fn» test() { println!(); }
1353 "});
1354
1355 cx.editor(|editor, _window, _cx| {
1356 assert!(!editor.hover_state.visible());
1357
1358 assert_eq!(
1359 editor.hover_state.info_popovers.len(),
1360 0,
1361 "Expected no hovers but got but got: {:?}",
1362 editor.hover_state.info_popovers.len()
1363 );
1364 });
1365
1366 let mut requests =
1367 cx.set_request_handler::<lsp::request::HoverRequest, _, _>(move |_, _, _| async move {
1368 Ok(Some(lsp::Hover {
1369 contents: lsp::HoverContents::Markup(lsp::MarkupContent {
1370 kind: lsp::MarkupKind::Markdown,
1371 value: "some other basic docs".to_string(),
1372 }),
1373 range: Some(symbol_range),
1374 }))
1375 });
1376
1377 requests.next().await;
1378 cx.dispatch_action(Hover);
1379
1380 cx.condition(|editor, _| editor.hover_state.visible()).await;
1381 cx.editor(|editor, _, cx| {
1382 assert_eq!(
1383 editor.hover_state.info_popovers.len(),
1384 1,
1385 "Expected exactly one hover but got: {:?}",
1386 editor.hover_state.info_popovers.len()
1387 );
1388
1389 let rendered_text = editor
1390 .hover_state
1391 .info_popovers
1392 .first()
1393 .unwrap()
1394 .get_rendered_text(cx);
1395
1396 assert_eq!(rendered_text, "some other basic docs".to_string())
1397 });
1398 }
1399
1400 #[gpui::test]
1401 async fn test_empty_hovers_filtered(cx: &mut gpui::TestAppContext) {
1402 init_test(cx, |_| {});
1403
1404 let mut cx = EditorLspTestContext::new_rust(
1405 lsp::ServerCapabilities {
1406 hover_provider: Some(lsp::HoverProviderCapability::Simple(true)),
1407 ..Default::default()
1408 },
1409 cx,
1410 )
1411 .await;
1412
1413 // Hover with keyboard has no delay
1414 cx.set_state(indoc! {"
1415 fˇn test() { println!(); }
1416 "});
1417 cx.update_editor(|editor, window, cx| hover(editor, &Hover, window, cx));
1418 let symbol_range = cx.lsp_range(indoc! {"
1419 «fn» test() { println!(); }
1420 "});
1421 cx.set_request_handler::<lsp::request::HoverRequest, _, _>(move |_, _, _| async move {
1422 Ok(Some(lsp::Hover {
1423 contents: lsp::HoverContents::Array(vec![
1424 lsp::MarkedString::String("regular text for hover to show".to_string()),
1425 lsp::MarkedString::String("".to_string()),
1426 lsp::MarkedString::LanguageString(lsp::LanguageString {
1427 language: "Rust".to_string(),
1428 value: "".to_string(),
1429 }),
1430 ]),
1431 range: Some(symbol_range),
1432 }))
1433 })
1434 .next()
1435 .await;
1436 cx.dispatch_action(Hover);
1437
1438 cx.condition(|editor, _| editor.hover_state.visible()).await;
1439 cx.editor(|editor, _, cx| {
1440 assert_eq!(
1441 editor.hover_state.info_popovers.len(),
1442 1,
1443 "Expected exactly one hover but got: {:?}",
1444 editor.hover_state.info_popovers.len()
1445 );
1446 let rendered_text = editor
1447 .hover_state
1448 .info_popovers
1449 .first()
1450 .unwrap()
1451 .get_rendered_text(cx);
1452
1453 assert_eq!(
1454 rendered_text,
1455 "regular text for hover to show".to_string(),
1456 "No empty string hovers should be shown"
1457 );
1458 });
1459 }
1460
1461 #[gpui::test]
1462 async fn test_line_ends_trimmed(cx: &mut gpui::TestAppContext) {
1463 init_test(cx, |_| {});
1464
1465 let mut cx = EditorLspTestContext::new_rust(
1466 lsp::ServerCapabilities {
1467 hover_provider: Some(lsp::HoverProviderCapability::Simple(true)),
1468 ..Default::default()
1469 },
1470 cx,
1471 )
1472 .await;
1473
1474 // Hover with keyboard has no delay
1475 cx.set_state(indoc! {"
1476 fˇn test() { println!(); }
1477 "});
1478 cx.update_editor(|editor, window, cx| hover(editor, &Hover, window, cx));
1479 let symbol_range = cx.lsp_range(indoc! {"
1480 «fn» test() { println!(); }
1481 "});
1482
1483 let code_str = "\nlet hovered_point: Vector2F // size = 8, align = 0x4\n";
1484 let markdown_string = format!("\n```rust\n{code_str}```");
1485
1486 let closure_markdown_string = markdown_string.clone();
1487 cx.set_request_handler::<lsp::request::HoverRequest, _, _>(move |_, _, _| {
1488 let future_markdown_string = closure_markdown_string.clone();
1489 async move {
1490 Ok(Some(lsp::Hover {
1491 contents: lsp::HoverContents::Markup(lsp::MarkupContent {
1492 kind: lsp::MarkupKind::Markdown,
1493 value: future_markdown_string,
1494 }),
1495 range: Some(symbol_range),
1496 }))
1497 }
1498 })
1499 .next()
1500 .await;
1501
1502 cx.dispatch_action(Hover);
1503
1504 cx.condition(|editor, _| editor.hover_state.visible()).await;
1505 cx.editor(|editor, _, cx| {
1506 assert_eq!(
1507 editor.hover_state.info_popovers.len(),
1508 1,
1509 "Expected exactly one hover but got: {:?}",
1510 editor.hover_state.info_popovers.len()
1511 );
1512 let rendered_text = editor
1513 .hover_state
1514 .info_popovers
1515 .first()
1516 .unwrap()
1517 .get_rendered_text(cx);
1518
1519 assert_eq!(
1520 rendered_text, code_str,
1521 "Should not have extra line breaks at end of rendered hover"
1522 );
1523 });
1524 }
1525
1526 #[gpui::test]
1527 // https://github.com/zed-industries/zed/issues/15498
1528 async fn test_info_hover_with_hrs(cx: &mut gpui::TestAppContext) {
1529 init_test(cx, |_| {});
1530
1531 let mut cx = EditorLspTestContext::new_rust(
1532 lsp::ServerCapabilities {
1533 hover_provider: Some(lsp::HoverProviderCapability::Simple(true)),
1534 ..Default::default()
1535 },
1536 cx,
1537 )
1538 .await;
1539
1540 cx.set_state(indoc! {"
1541 fn fuˇnc(abc def: i32) -> u32 {
1542 }
1543 "});
1544
1545 cx.lsp
1546 .set_request_handler::<lsp::request::HoverRequest, _, _>({
1547 |_, _| async move {
1548 Ok(Some(lsp::Hover {
1549 contents: lsp::HoverContents::Markup(lsp::MarkupContent {
1550 kind: lsp::MarkupKind::Markdown,
1551 value: indoc!(
1552 r#"
1553 ### function `errands_data_read`
1554
1555 ---
1556 → `char *`
1557 Function to read a file into a string
1558
1559 ---
1560 ```cpp
1561 static char *errands_data_read()
1562 ```
1563 "#
1564 )
1565 .to_string(),
1566 }),
1567 range: None,
1568 }))
1569 }
1570 });
1571 cx.update_editor(|editor, window, cx| hover(editor, &Default::default(), window, cx));
1572 cx.run_until_parked();
1573
1574 cx.update_editor(|editor, _, cx| {
1575 let popover = editor.hover_state.info_popovers.first().unwrap();
1576 let content = popover.get_rendered_text(cx);
1577
1578 assert!(content.contains("Function to read a file"));
1579 });
1580 }
1581
1582 #[gpui::test]
1583 async fn test_hover_inlay_label_parts(cx: &mut gpui::TestAppContext) {
1584 init_test(cx, |settings| {
1585 settings.defaults.inlay_hints = Some(InlayHintSettingsContent {
1586 show_value_hints: Some(true),
1587 enabled: Some(true),
1588 edit_debounce_ms: Some(0),
1589 scroll_debounce_ms: Some(0),
1590 show_type_hints: Some(true),
1591 show_parameter_hints: Some(true),
1592 show_other_hints: Some(true),
1593 show_background: Some(false),
1594 toggle_on_modifiers_press: None,
1595 })
1596 });
1597
1598 let mut cx = EditorLspTestContext::new_rust(
1599 lsp::ServerCapabilities {
1600 inlay_hint_provider: Some(lsp::OneOf::Right(
1601 lsp::InlayHintServerCapabilities::Options(lsp::InlayHintOptions {
1602 resolve_provider: Some(true),
1603 ..Default::default()
1604 }),
1605 )),
1606 ..Default::default()
1607 },
1608 cx,
1609 )
1610 .await;
1611
1612 cx.set_state(indoc! {"
1613 struct TestStruct;
1614
1615 // ==================
1616
1617 struct TestNewType<T>(T);
1618
1619 fn main() {
1620 let variableˇ = TestNewType(TestStruct);
1621 }
1622 "});
1623
1624 let hint_start_offset = cx.ranges(indoc! {"
1625 struct TestStruct;
1626
1627 // ==================
1628
1629 struct TestNewType<T>(T);
1630
1631 fn main() {
1632 let variableˇ = TestNewType(TestStruct);
1633 }
1634 "})[0]
1635 .start;
1636 let hint_position = cx.to_lsp(hint_start_offset);
1637 let new_type_target_range = cx.lsp_range(indoc! {"
1638 struct TestStruct;
1639
1640 // ==================
1641
1642 struct «TestNewType»<T>(T);
1643
1644 fn main() {
1645 let variable = TestNewType(TestStruct);
1646 }
1647 "});
1648 let struct_target_range = cx.lsp_range(indoc! {"
1649 struct «TestStruct»;
1650
1651 // ==================
1652
1653 struct TestNewType<T>(T);
1654
1655 fn main() {
1656 let variable = TestNewType(TestStruct);
1657 }
1658 "});
1659
1660 let uri = cx.buffer_lsp_url.clone();
1661 let new_type_label = "TestNewType";
1662 let struct_label = "TestStruct";
1663 let entire_hint_label = ": TestNewType<TestStruct>";
1664 let closure_uri = uri.clone();
1665 cx.lsp
1666 .set_request_handler::<lsp::request::InlayHintRequest, _, _>(move |params, _| {
1667 let task_uri = closure_uri.clone();
1668 async move {
1669 assert_eq!(params.text_document.uri, task_uri);
1670 Ok(Some(vec![lsp::InlayHint {
1671 position: hint_position,
1672 label: lsp::InlayHintLabel::LabelParts(vec![lsp::InlayHintLabelPart {
1673 value: entire_hint_label.to_string(),
1674 ..Default::default()
1675 }]),
1676 kind: Some(lsp::InlayHintKind::TYPE),
1677 text_edits: None,
1678 tooltip: None,
1679 padding_left: Some(false),
1680 padding_right: Some(false),
1681 data: None,
1682 }]))
1683 }
1684 })
1685 .next()
1686 .await;
1687 cx.background_executor.run_until_parked();
1688 cx.update_editor(|editor, _, cx| {
1689 let expected_layers = vec![entire_hint_label.to_string()];
1690 assert_eq!(expected_layers, cached_hint_labels(editor, cx));
1691 assert_eq!(expected_layers, visible_hint_labels(editor, cx));
1692 });
1693
1694 let inlay_range = cx
1695 .ranges(indoc! {"
1696 struct TestStruct;
1697
1698 // ==================
1699
1700 struct TestNewType<T>(T);
1701
1702 fn main() {
1703 let variable« »= TestNewType(TestStruct);
1704 }
1705 "})
1706 .first()
1707 .cloned()
1708 .unwrap();
1709 let new_type_hint_part_hover_position = cx.update_editor(|editor, window, cx| {
1710 let snapshot = editor.snapshot(window, cx);
1711 let previous_valid = inlay_range.start.to_display_point(&snapshot);
1712 let next_valid = inlay_range.end.to_display_point(&snapshot);
1713 assert_eq!(previous_valid.row(), next_valid.row());
1714 assert!(previous_valid.column() < next_valid.column());
1715 let exact_unclipped = DisplayPoint::new(
1716 previous_valid.row(),
1717 previous_valid.column()
1718 + (entire_hint_label.find(new_type_label).unwrap() + new_type_label.len() / 2)
1719 as u32,
1720 );
1721 PointForPosition {
1722 previous_valid,
1723 next_valid,
1724 exact_unclipped,
1725 column_overshoot_after_line_end: 0,
1726 }
1727 });
1728 cx.update_editor(|editor, window, cx| {
1729 editor.update_inlay_link_and_hover_points(
1730 &editor.snapshot(window, cx),
1731 new_type_hint_part_hover_position,
1732 true,
1733 false,
1734 window,
1735 cx,
1736 );
1737 });
1738
1739 let resolve_closure_uri = uri.clone();
1740 cx.lsp
1741 .set_request_handler::<lsp::request::InlayHintResolveRequest, _, _>(
1742 move |mut hint_to_resolve, _| {
1743 let mut resolved_hint_positions = BTreeSet::new();
1744 let task_uri = resolve_closure_uri.clone();
1745 async move {
1746 let inserted = resolved_hint_positions.insert(hint_to_resolve.position);
1747 assert!(inserted, "Hint {hint_to_resolve:?} was resolved twice");
1748
1749 // `: TestNewType<TestStruct>`
1750 hint_to_resolve.label = lsp::InlayHintLabel::LabelParts(vec![
1751 lsp::InlayHintLabelPart {
1752 value: ": ".to_string(),
1753 ..Default::default()
1754 },
1755 lsp::InlayHintLabelPart {
1756 value: new_type_label.to_string(),
1757 location: Some(lsp::Location {
1758 uri: task_uri.clone(),
1759 range: new_type_target_range,
1760 }),
1761 tooltip: Some(lsp::InlayHintLabelPartTooltip::String(format!(
1762 "A tooltip for `{new_type_label}`"
1763 ))),
1764 ..Default::default()
1765 },
1766 lsp::InlayHintLabelPart {
1767 value: "<".to_string(),
1768 ..Default::default()
1769 },
1770 lsp::InlayHintLabelPart {
1771 value: struct_label.to_string(),
1772 location: Some(lsp::Location {
1773 uri: task_uri,
1774 range: struct_target_range,
1775 }),
1776 tooltip: Some(lsp::InlayHintLabelPartTooltip::MarkupContent(
1777 lsp::MarkupContent {
1778 kind: lsp::MarkupKind::Markdown,
1779 value: format!("A tooltip for `{struct_label}`"),
1780 },
1781 )),
1782 ..Default::default()
1783 },
1784 lsp::InlayHintLabelPart {
1785 value: ">".to_string(),
1786 ..Default::default()
1787 },
1788 ]);
1789
1790 Ok(hint_to_resolve)
1791 }
1792 },
1793 )
1794 .next()
1795 .await;
1796 cx.background_executor.run_until_parked();
1797
1798 cx.update_editor(|editor, window, cx| {
1799 editor.update_inlay_link_and_hover_points(
1800 &editor.snapshot(window, cx),
1801 new_type_hint_part_hover_position,
1802 true,
1803 false,
1804 window,
1805 cx,
1806 );
1807 });
1808 cx.background_executor
1809 .advance_clock(Duration::from_millis(get_hover_popover_delay(&cx) + 100));
1810 cx.background_executor.run_until_parked();
1811 cx.update_editor(|editor, _, cx| {
1812 let hover_state = &editor.hover_state;
1813 assert!(
1814 hover_state.diagnostic_popover.is_none() && hover_state.info_popovers.len() == 1
1815 );
1816 let popover = hover_state.info_popovers.first().unwrap();
1817 let buffer_snapshot = editor.buffer().update(cx, |buffer, cx| buffer.snapshot(cx));
1818 assert_eq!(
1819 popover.symbol_range,
1820 RangeInEditor::Inlay(InlayHighlight {
1821 inlay: InlayId::Hint(0),
1822 inlay_position: buffer_snapshot.anchor_after(inlay_range.start),
1823 range: ": ".len()..": ".len() + new_type_label.len(),
1824 }),
1825 "Popover range should match the new type label part"
1826 );
1827 assert_eq!(
1828 popover.get_rendered_text(cx),
1829 format!("A tooltip for {new_type_label}"),
1830 );
1831 });
1832
1833 let struct_hint_part_hover_position = cx.update_editor(|editor, window, cx| {
1834 let snapshot = editor.snapshot(window, cx);
1835 let previous_valid = inlay_range.start.to_display_point(&snapshot);
1836 let next_valid = inlay_range.end.to_display_point(&snapshot);
1837 assert_eq!(previous_valid.row(), next_valid.row());
1838 assert!(previous_valid.column() < next_valid.column());
1839 let exact_unclipped = DisplayPoint::new(
1840 previous_valid.row(),
1841 previous_valid.column()
1842 + (entire_hint_label.find(struct_label).unwrap() + struct_label.len() / 2)
1843 as u32,
1844 );
1845 PointForPosition {
1846 previous_valid,
1847 next_valid,
1848 exact_unclipped,
1849 column_overshoot_after_line_end: 0,
1850 }
1851 });
1852 cx.update_editor(|editor, window, cx| {
1853 editor.update_inlay_link_and_hover_points(
1854 &editor.snapshot(window, cx),
1855 struct_hint_part_hover_position,
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_after(inlay_range.start),
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}