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