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