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