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