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