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 table_columns_min_size: true,
660 ..Default::default()
661 }
662}
663
664pub fn diagnostics_markdown_style(window: &Window, cx: &App) -> MarkdownStyle {
665 let settings = ThemeSettings::get_global(cx);
666 let ui_font_family = settings.ui_font.family.clone();
667 let ui_font_fallbacks = settings.ui_font.fallbacks.clone();
668 let ui_font_features = settings.ui_font.features.clone();
669 let buffer_font_family = settings.buffer_font.family.clone();
670 let buffer_font_features = settings.buffer_font.features.clone();
671 let buffer_font_fallbacks = settings.buffer_font.fallbacks.clone();
672
673 let mut base_text_style = window.text_style();
674 base_text_style.refine(&TextStyleRefinement {
675 font_family: Some(ui_font_family),
676 font_features: Some(ui_font_features),
677 font_fallbacks: ui_font_fallbacks,
678 color: Some(cx.theme().colors().editor_foreground),
679 ..Default::default()
680 });
681 MarkdownStyle {
682 base_text_style,
683 code_block: StyleRefinement::default().my(rems(1.)).font_buffer(cx),
684 inline_code: TextStyleRefinement {
685 background_color: Some(cx.theme().colors().editor_background.opacity(0.5)),
686 font_family: Some(buffer_font_family),
687 font_features: Some(buffer_font_features),
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 table_columns_min_size: true,
714 ..Default::default()
715 }
716}
717
718pub fn open_markdown_url(link: SharedString, window: &mut Window, cx: &mut App) {
719 if let Ok(uri) = Url::parse(&link)
720 && uri.scheme() == "file"
721 && let Some(workspace) = window.root::<Workspace>().flatten()
722 {
723 workspace.update(cx, |workspace, cx| {
724 let task = workspace.open_abs_path(
725 PathBuf::from(uri.path()),
726 OpenOptions {
727 visible: Some(OpenVisible::None),
728 ..Default::default()
729 },
730 window,
731 cx,
732 );
733
734 cx.spawn_in(window, async move |_, cx| {
735 let item = task.await?;
736 // Ruby LSP uses URLs with #L1,1-4,4
737 // we'll just take the first number and assume it's a line number
738 let Some(fragment) = uri.fragment() else {
739 return anyhow::Ok(());
740 };
741 let mut accum = 0u32;
742 for c in fragment.chars() {
743 if c >= '0' && c <= '9' && accum < u32::MAX / 2 {
744 accum *= 10;
745 accum += c as u32 - '0' as u32;
746 } else if accum > 0 {
747 break;
748 }
749 }
750 if accum == 0 {
751 return Ok(());
752 }
753 let Some(editor) = cx.update(|_, cx| item.act_as::<Editor>(cx))? else {
754 return Ok(());
755 };
756 editor.update_in(cx, |editor, window, cx| {
757 editor.change_selections(Default::default(), window, cx, |selections| {
758 selections.select_ranges([
759 text::Point::new(accum - 1, 0)..text::Point::new(accum - 1, 0)
760 ]);
761 });
762 })
763 })
764 .detach_and_log_err(cx);
765 });
766 return;
767 }
768 cx.open_url(&link);
769}
770
771#[derive(Default)]
772pub struct HoverState {
773 pub info_popovers: Vec<InfoPopover>,
774 pub diagnostic_popover: Option<DiagnosticPopover>,
775 pub triggered_from: Option<Anchor>,
776 pub info_task: Option<Task<Option<()>>>,
777}
778
779impl HoverState {
780 pub fn visible(&self) -> bool {
781 !self.info_popovers.is_empty() || self.diagnostic_popover.is_some()
782 }
783
784 pub(crate) fn render(
785 &mut self,
786 snapshot: &EditorSnapshot,
787 visible_rows: Range<DisplayRow>,
788 max_size: Size<Pixels>,
789 text_layout_details: &TextLayoutDetails,
790 window: &mut Window,
791 cx: &mut Context<Editor>,
792 ) -> Option<(DisplayPoint, Vec<AnyElement>)> {
793 if !self.visible() {
794 return None;
795 }
796 // If there is a diagnostic, position the popovers based on that.
797 // Otherwise use the start of the hover range
798 let anchor = self
799 .diagnostic_popover
800 .as_ref()
801 .map(|diagnostic_popover| &diagnostic_popover.local_diagnostic.range.start)
802 .or_else(|| {
803 self.info_popovers.iter().find_map(|info_popover| {
804 match &info_popover.symbol_range {
805 RangeInEditor::Text(range) => Some(&range.start),
806 RangeInEditor::Inlay(_) => None,
807 }
808 })
809 })
810 .or_else(|| {
811 self.info_popovers.iter().find_map(|info_popover| {
812 match &info_popover.symbol_range {
813 RangeInEditor::Text(_) => None,
814 RangeInEditor::Inlay(range) => Some(&range.inlay_position),
815 }
816 })
817 })?;
818 let mut point = anchor.to_display_point(&snapshot.display_snapshot);
819 // Clamp the point within the visible rows in case the popup source spans multiple lines
820 if visible_rows.end <= point.row() {
821 point = crate::movement::up_by_rows(
822 &snapshot.display_snapshot,
823 point,
824 1 + (point.row() - visible_rows.end).0,
825 text::SelectionGoal::None,
826 true,
827 text_layout_details,
828 )
829 .0;
830 } else if point.row() < visible_rows.start {
831 point = crate::movement::down_by_rows(
832 &snapshot.display_snapshot,
833 point,
834 (visible_rows.start - point.row()).0,
835 text::SelectionGoal::None,
836 true,
837 text_layout_details,
838 )
839 .0;
840 }
841
842 if !visible_rows.contains(&point.row()) {
843 log::error!("Hover popover point out of bounds after moving");
844 return None;
845 }
846
847 let mut elements = Vec::new();
848
849 if let Some(diagnostic_popover) = self.diagnostic_popover.as_ref() {
850 elements.push(diagnostic_popover.render(max_size, window, cx));
851 }
852 for info_popover in &mut self.info_popovers {
853 elements.push(info_popover.render(max_size, window, cx));
854 }
855
856 Some((point, elements))
857 }
858
859 pub fn focused(&self, window: &mut Window, cx: &mut Context<Editor>) -> bool {
860 let mut hover_popover_is_focused = false;
861 for info_popover in &self.info_popovers {
862 if let Some(markdown_view) = &info_popover.parsed_content
863 && markdown_view.focus_handle(cx).is_focused(window)
864 {
865 hover_popover_is_focused = true;
866 }
867 }
868 if let Some(diagnostic_popover) = &self.diagnostic_popover
869 && diagnostic_popover
870 .markdown
871 .focus_handle(cx)
872 .is_focused(window)
873 {
874 hover_popover_is_focused = true;
875 }
876 hover_popover_is_focused
877 }
878}
879
880pub struct InfoPopover {
881 pub symbol_range: RangeInEditor,
882 pub parsed_content: Option<Entity<Markdown>>,
883 pub scroll_handle: ScrollHandle,
884 pub keyboard_grace: Rc<RefCell<bool>>,
885 pub anchor: Option<Anchor>,
886 _subscription: Option<Subscription>,
887}
888
889impl InfoPopover {
890 pub(crate) fn render(
891 &mut self,
892 max_size: Size<Pixels>,
893 window: &mut Window,
894 cx: &mut Context<Editor>,
895 ) -> AnyElement {
896 let keyboard_grace = Rc::clone(&self.keyboard_grace);
897 div()
898 .id("info_popover")
899 .occlude()
900 .elevation_2(cx)
901 // Prevent a mouse down/move on the popover from being propagated to the editor,
902 // because that would dismiss the popover.
903 .on_mouse_move(|_, _, cx| cx.stop_propagation())
904 .on_mouse_down(MouseButton::Left, move |_, _, cx| {
905 let mut keyboard_grace = keyboard_grace.borrow_mut();
906 *keyboard_grace = false;
907 cx.stop_propagation();
908 })
909 .when_some(self.parsed_content.clone(), |this, markdown| {
910 this.child(
911 div()
912 .id("info-md-container")
913 .overflow_y_scroll()
914 .max_w(max_size.width)
915 .max_h(max_size.height)
916 .track_scroll(&self.scroll_handle)
917 .child(
918 MarkdownElement::new(markdown, hover_markdown_style(window, cx))
919 .code_block_renderer(markdown::CodeBlockRenderer::Default {
920 copy_button: false,
921 copy_button_on_hover: false,
922 border: false,
923 })
924 .on_url_click(open_markdown_url)
925 .p_2(),
926 ),
927 )
928 .custom_scrollbars(
929 Scrollbars::for_settings::<EditorSettings>()
930 .tracked_scroll_handle(&self.scroll_handle),
931 window,
932 cx,
933 )
934 })
935 .into_any_element()
936 }
937
938 pub fn scroll(&self, amount: ScrollAmount, window: &mut Window, cx: &mut Context<Editor>) {
939 let mut current = self.scroll_handle.offset();
940 current.y -= amount.pixels(
941 window.line_height(),
942 self.scroll_handle.bounds().size.height - px(16.),
943 ) / 2.0;
944 cx.notify();
945 self.scroll_handle.set_offset(current);
946 }
947}
948
949pub struct DiagnosticPopover {
950 pub(crate) local_diagnostic: DiagnosticEntry<Anchor>,
951 markdown: Entity<Markdown>,
952 border_color: Hsla,
953 background_color: Hsla,
954 pub keyboard_grace: Rc<RefCell<bool>>,
955 pub anchor: Anchor,
956 _subscription: Subscription,
957 pub scroll_handle: ScrollHandle,
958}
959
960impl DiagnosticPopover {
961 pub fn render(
962 &self,
963 max_size: Size<Pixels>,
964 window: &mut Window,
965 cx: &mut Context<Editor>,
966 ) -> AnyElement {
967 let keyboard_grace = Rc::clone(&self.keyboard_grace);
968 let this = cx.entity().downgrade();
969 div()
970 .id("diagnostic")
971 .occlude()
972 .elevation_2_borderless(cx)
973 // Don't draw the background color if the theme
974 // allows transparent surfaces.
975 .when(theme_is_transparent(cx), |this| {
976 this.bg(gpui::transparent_black())
977 })
978 // Prevent a mouse move on the popover from being propagated to the editor,
979 // because that would dismiss the popover.
980 .on_mouse_move(|_, _, cx| cx.stop_propagation())
981 // Prevent a mouse down on the popover from being propagated to the editor,
982 // because that would move the cursor.
983 .on_mouse_down(MouseButton::Left, move |_, _, cx| {
984 let mut keyboard_grace = keyboard_grace.borrow_mut();
985 *keyboard_grace = false;
986 cx.stop_propagation();
987 })
988 .child(
989 div()
990 .py_1()
991 .px_2()
992 .bg(self.background_color)
993 .border_1()
994 .border_color(self.border_color)
995 .rounded_lg()
996 .child(
997 div()
998 .id("diagnostic-content-container")
999 .overflow_y_scroll()
1000 .max_w(max_size.width)
1001 .max_h(max_size.height)
1002 .track_scroll(&self.scroll_handle)
1003 .child(
1004 MarkdownElement::new(
1005 self.markdown.clone(),
1006 diagnostics_markdown_style(window, cx),
1007 )
1008 .code_block_renderer(markdown::CodeBlockRenderer::Default {
1009 copy_button: false,
1010 copy_button_on_hover: false,
1011 border: false,
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 .custom_scrollbars(
1027 Scrollbars::for_settings::<EditorSettings>()
1028 .tracked_scroll_handle(&self.scroll_handle),
1029 window,
1030 cx,
1031 ),
1032 )
1033 .into_any_element()
1034 }
1035}
1036
1037#[cfg(test)]
1038mod tests {
1039 use super::*;
1040 use crate::{
1041 PointForPosition,
1042 actions::ConfirmCompletion,
1043 editor_tests::{handle_completion_request, init_test},
1044 inlays::inlay_hints::tests::{cached_hint_labels, visible_hint_labels},
1045 test::editor_lsp_test_context::EditorLspTestContext,
1046 };
1047 use collections::BTreeSet;
1048 use gpui::App;
1049 use indoc::indoc;
1050 use markdown::parser::MarkdownEvent;
1051 use project::InlayId;
1052 use settings::InlayHintSettingsContent;
1053 use smol::stream::StreamExt;
1054 use std::sync::atomic;
1055 use std::sync::atomic::AtomicUsize;
1056 use text::Bias;
1057
1058 fn get_hover_popover_delay(cx: &gpui::TestAppContext) -> u64 {
1059 cx.read(|cx: &App| -> u64 { EditorSettings::get_global(cx).hover_popover_delay.0 })
1060 }
1061
1062 impl InfoPopover {
1063 fn get_rendered_text(&self, cx: &gpui::App) -> String {
1064 let mut rendered_text = String::new();
1065 if let Some(parsed_content) = self.parsed_content.clone() {
1066 let markdown = parsed_content.read(cx);
1067 let text = markdown.parsed_markdown().source().to_string();
1068 let data = markdown.parsed_markdown().events();
1069 let slice = data;
1070
1071 for (range, event) in slice.iter() {
1072 match event {
1073 MarkdownEvent::SubstitutedText(parsed) => {
1074 rendered_text.push_str(parsed.as_str())
1075 }
1076 MarkdownEvent::Text | MarkdownEvent::Code => {
1077 rendered_text.push_str(&text[range.clone()])
1078 }
1079 _ => {}
1080 }
1081 }
1082 }
1083 rendered_text
1084 }
1085 }
1086
1087 #[gpui::test]
1088 async fn test_mouse_hover_info_popover_with_autocomplete_popover(
1089 cx: &mut gpui::TestAppContext,
1090 ) {
1091 init_test(cx, |_| {});
1092
1093 let mut cx = EditorLspTestContext::new_rust(
1094 lsp::ServerCapabilities {
1095 hover_provider: Some(lsp::HoverProviderCapability::Simple(true)),
1096 completion_provider: Some(lsp::CompletionOptions {
1097 trigger_characters: Some(vec![".".to_string(), ":".to_string()]),
1098 resolve_provider: Some(true),
1099 ..Default::default()
1100 }),
1101 ..Default::default()
1102 },
1103 cx,
1104 )
1105 .await;
1106 let counter = Arc::new(AtomicUsize::new(0));
1107 // Basic hover delays and then pops without moving the mouse
1108 cx.set_state(indoc! {"
1109 oneˇ
1110 two
1111 three
1112 fn test() { println!(); }
1113 "});
1114
1115 //prompt autocompletion menu
1116 cx.simulate_keystroke(".");
1117 handle_completion_request(
1118 indoc! {"
1119 one.|<>
1120 two
1121 three
1122 "},
1123 vec!["first_completion", "second_completion"],
1124 true,
1125 counter.clone(),
1126 &mut cx,
1127 )
1128 .await;
1129 cx.condition(|editor, _| editor.context_menu_visible()) // wait until completion menu is visible
1130 .await;
1131 assert_eq!(counter.load(atomic::Ordering::Acquire), 1); // 1 completion request
1132
1133 let hover_point = cx.display_point(indoc! {"
1134 one.
1135 two
1136 three
1137 fn test() { printˇln!(); }
1138 "});
1139 cx.update_editor(|editor, window, cx| {
1140 let snapshot = editor.snapshot(window, cx);
1141 let anchor = snapshot
1142 .buffer_snapshot()
1143 .anchor_before(hover_point.to_offset(&snapshot, Bias::Left));
1144 hover_at(editor, Some(anchor), window, cx)
1145 });
1146 assert!(!cx.editor(|editor, _window, _cx| editor.hover_state.visible()));
1147
1148 // After delay, hover should be visible.
1149 let symbol_range = cx.lsp_range(indoc! {"
1150 one.
1151 two
1152 three
1153 fn test() { «println!»(); }
1154 "});
1155 let mut requests =
1156 cx.set_request_handler::<lsp::request::HoverRequest, _, _>(move |_, _, _| async move {
1157 Ok(Some(lsp::Hover {
1158 contents: lsp::HoverContents::Markup(lsp::MarkupContent {
1159 kind: lsp::MarkupKind::Markdown,
1160 value: "some basic docs".to_string(),
1161 }),
1162 range: Some(symbol_range),
1163 }))
1164 });
1165 cx.background_executor
1166 .advance_clock(Duration::from_millis(get_hover_popover_delay(&cx) + 100));
1167 requests.next().await;
1168
1169 cx.editor(|editor, _window, cx| {
1170 assert!(editor.hover_state.visible());
1171 assert_eq!(
1172 editor.hover_state.info_popovers.len(),
1173 1,
1174 "Expected exactly one hover but got: {:?}",
1175 editor.hover_state.info_popovers.len()
1176 );
1177 let rendered_text = editor
1178 .hover_state
1179 .info_popovers
1180 .first()
1181 .unwrap()
1182 .get_rendered_text(cx);
1183 assert_eq!(rendered_text, "some basic docs".to_string())
1184 });
1185
1186 // check that the completion menu is still visible and that there still has only been 1 completion request
1187 cx.editor(|editor, _, _| assert!(editor.context_menu_visible()));
1188 assert_eq!(counter.load(atomic::Ordering::Acquire), 1);
1189
1190 //apply a completion and check it was successfully applied
1191 let _apply_additional_edits = cx.update_editor(|editor, window, cx| {
1192 editor.context_menu_next(&Default::default(), window, cx);
1193 editor
1194 .confirm_completion(&ConfirmCompletion::default(), window, cx)
1195 .unwrap()
1196 });
1197 cx.assert_editor_state(indoc! {"
1198 one.second_completionˇ
1199 two
1200 three
1201 fn test() { println!(); }
1202 "});
1203
1204 // check that the completion menu is no longer visible and that there still has only been 1 completion request
1205 cx.editor(|editor, _, _| assert!(!editor.context_menu_visible()));
1206 assert_eq!(counter.load(atomic::Ordering::Acquire), 1);
1207
1208 //verify the information popover is still visible and unchanged
1209 cx.editor(|editor, _, cx| {
1210 assert!(editor.hover_state.visible());
1211 assert_eq!(
1212 editor.hover_state.info_popovers.len(),
1213 1,
1214 "Expected exactly one hover but got: {:?}",
1215 editor.hover_state.info_popovers.len()
1216 );
1217 let rendered_text = editor
1218 .hover_state
1219 .info_popovers
1220 .first()
1221 .unwrap()
1222 .get_rendered_text(cx);
1223
1224 assert_eq!(rendered_text, "some basic docs".to_string())
1225 });
1226
1227 // Mouse moved with no hover response dismisses
1228 let hover_point = cx.display_point(indoc! {"
1229 one.second_completionˇ
1230 two
1231 three
1232 fn teˇst() { println!(); }
1233 "});
1234 let mut request = cx
1235 .lsp
1236 .set_request_handler::<lsp::request::HoverRequest, _, _>(
1237 |_, _| async move { Ok(None) },
1238 );
1239 cx.update_editor(|editor, window, cx| {
1240 let snapshot = editor.snapshot(window, cx);
1241 let anchor = snapshot
1242 .buffer_snapshot()
1243 .anchor_before(hover_point.to_offset(&snapshot, Bias::Left));
1244 hover_at(editor, Some(anchor), window, cx)
1245 });
1246 cx.background_executor
1247 .advance_clock(Duration::from_millis(get_hover_popover_delay(&cx) + 100));
1248 request.next().await;
1249
1250 // verify that the information popover is no longer visible
1251 cx.editor(|editor, _, _| {
1252 assert!(!editor.hover_state.visible());
1253 });
1254 }
1255
1256 #[gpui::test]
1257 async fn test_mouse_hover_info_popover(cx: &mut gpui::TestAppContext) {
1258 init_test(cx, |_| {});
1259
1260 let mut cx = EditorLspTestContext::new_rust(
1261 lsp::ServerCapabilities {
1262 hover_provider: Some(lsp::HoverProviderCapability::Simple(true)),
1263 ..Default::default()
1264 },
1265 cx,
1266 )
1267 .await;
1268
1269 // Basic hover delays and then pops without moving the mouse
1270 cx.set_state(indoc! {"
1271 fn ˇtest() { println!(); }
1272 "});
1273 let hover_point = cx.display_point(indoc! {"
1274 fn test() { printˇln!(); }
1275 "});
1276
1277 cx.update_editor(|editor, window, cx| {
1278 let snapshot = editor.snapshot(window, cx);
1279 let anchor = snapshot
1280 .buffer_snapshot()
1281 .anchor_before(hover_point.to_offset(&snapshot, Bias::Left));
1282 hover_at(editor, Some(anchor), window, cx)
1283 });
1284 assert!(!cx.editor(|editor, _window, _cx| editor.hover_state.visible()));
1285
1286 // After delay, hover should be visible.
1287 let symbol_range = cx.lsp_range(indoc! {"
1288 fn test() { «println!»(); }
1289 "});
1290 let mut requests =
1291 cx.set_request_handler::<lsp::request::HoverRequest, _, _>(move |_, _, _| async move {
1292 Ok(Some(lsp::Hover {
1293 contents: lsp::HoverContents::Markup(lsp::MarkupContent {
1294 kind: lsp::MarkupKind::Markdown,
1295 value: "some basic docs".to_string(),
1296 }),
1297 range: Some(symbol_range),
1298 }))
1299 });
1300 cx.background_executor
1301 .advance_clock(Duration::from_millis(get_hover_popover_delay(&cx) + 100));
1302 requests.next().await;
1303
1304 cx.editor(|editor, _, cx| {
1305 assert!(editor.hover_state.visible());
1306 assert_eq!(
1307 editor.hover_state.info_popovers.len(),
1308 1,
1309 "Expected exactly one hover but got: {:?}",
1310 editor.hover_state.info_popovers.len()
1311 );
1312 let rendered_text = editor
1313 .hover_state
1314 .info_popovers
1315 .first()
1316 .unwrap()
1317 .get_rendered_text(cx);
1318
1319 assert_eq!(rendered_text, "some basic docs".to_string())
1320 });
1321
1322 // Mouse moved with no hover response dismisses
1323 let hover_point = cx.display_point(indoc! {"
1324 fn teˇst() { println!(); }
1325 "});
1326 let mut request = cx
1327 .lsp
1328 .set_request_handler::<lsp::request::HoverRequest, _, _>(
1329 |_, _| async move { Ok(None) },
1330 );
1331 cx.update_editor(|editor, window, cx| {
1332 let snapshot = editor.snapshot(window, cx);
1333 let anchor = snapshot
1334 .buffer_snapshot()
1335 .anchor_before(hover_point.to_offset(&snapshot, Bias::Left));
1336 hover_at(editor, Some(anchor), window, cx)
1337 });
1338 cx.background_executor
1339 .advance_clock(Duration::from_millis(get_hover_popover_delay(&cx) + 100));
1340 request.next().await;
1341 cx.editor(|editor, _, _| {
1342 assert!(!editor.hover_state.visible());
1343 });
1344 }
1345
1346 #[gpui::test]
1347 async fn test_keyboard_hover_info_popover(cx: &mut gpui::TestAppContext) {
1348 init_test(cx, |_| {});
1349
1350 let mut cx = EditorLspTestContext::new_rust(
1351 lsp::ServerCapabilities {
1352 hover_provider: Some(lsp::HoverProviderCapability::Simple(true)),
1353 ..Default::default()
1354 },
1355 cx,
1356 )
1357 .await;
1358
1359 // Hover with keyboard has no delay
1360 cx.set_state(indoc! {"
1361 fˇn test() { println!(); }
1362 "});
1363 cx.update_editor(|editor, window, cx| hover(editor, &Hover, window, cx));
1364 let symbol_range = cx.lsp_range(indoc! {"
1365 «fn» test() { println!(); }
1366 "});
1367
1368 cx.editor(|editor, _window, _cx| {
1369 assert!(!editor.hover_state.visible());
1370
1371 assert_eq!(
1372 editor.hover_state.info_popovers.len(),
1373 0,
1374 "Expected no hovers but got but got: {:?}",
1375 editor.hover_state.info_popovers.len()
1376 );
1377 });
1378
1379 let mut requests =
1380 cx.set_request_handler::<lsp::request::HoverRequest, _, _>(move |_, _, _| async move {
1381 Ok(Some(lsp::Hover {
1382 contents: lsp::HoverContents::Markup(lsp::MarkupContent {
1383 kind: lsp::MarkupKind::Markdown,
1384 value: "some other basic docs".to_string(),
1385 }),
1386 range: Some(symbol_range),
1387 }))
1388 });
1389
1390 requests.next().await;
1391 cx.dispatch_action(Hover);
1392
1393 cx.condition(|editor, _| editor.hover_state.visible()).await;
1394 cx.editor(|editor, _, cx| {
1395 assert_eq!(
1396 editor.hover_state.info_popovers.len(),
1397 1,
1398 "Expected exactly one hover but got: {:?}",
1399 editor.hover_state.info_popovers.len()
1400 );
1401
1402 let rendered_text = editor
1403 .hover_state
1404 .info_popovers
1405 .first()
1406 .unwrap()
1407 .get_rendered_text(cx);
1408
1409 assert_eq!(rendered_text, "some other basic docs".to_string())
1410 });
1411 }
1412
1413 #[gpui::test]
1414 async fn test_empty_hovers_filtered(cx: &mut gpui::TestAppContext) {
1415 init_test(cx, |_| {});
1416
1417 let mut cx = EditorLspTestContext::new_rust(
1418 lsp::ServerCapabilities {
1419 hover_provider: Some(lsp::HoverProviderCapability::Simple(true)),
1420 ..Default::default()
1421 },
1422 cx,
1423 )
1424 .await;
1425
1426 // Hover with keyboard has no delay
1427 cx.set_state(indoc! {"
1428 fˇn test() { println!(); }
1429 "});
1430 cx.update_editor(|editor, window, cx| hover(editor, &Hover, window, cx));
1431 let symbol_range = cx.lsp_range(indoc! {"
1432 «fn» test() { println!(); }
1433 "});
1434 cx.set_request_handler::<lsp::request::HoverRequest, _, _>(move |_, _, _| async move {
1435 Ok(Some(lsp::Hover {
1436 contents: lsp::HoverContents::Array(vec![
1437 lsp::MarkedString::String("regular text for hover to show".to_string()),
1438 lsp::MarkedString::String("".to_string()),
1439 lsp::MarkedString::LanguageString(lsp::LanguageString {
1440 language: "Rust".to_string(),
1441 value: "".to_string(),
1442 }),
1443 ]),
1444 range: Some(symbol_range),
1445 }))
1446 })
1447 .next()
1448 .await;
1449 cx.dispatch_action(Hover);
1450
1451 cx.condition(|editor, _| editor.hover_state.visible()).await;
1452 cx.editor(|editor, _, cx| {
1453 assert_eq!(
1454 editor.hover_state.info_popovers.len(),
1455 1,
1456 "Expected exactly one hover but got: {:?}",
1457 editor.hover_state.info_popovers.len()
1458 );
1459 let rendered_text = editor
1460 .hover_state
1461 .info_popovers
1462 .first()
1463 .unwrap()
1464 .get_rendered_text(cx);
1465
1466 assert_eq!(
1467 rendered_text,
1468 "regular text for hover to show".to_string(),
1469 "No empty string hovers should be shown"
1470 );
1471 });
1472 }
1473
1474 #[gpui::test]
1475 async fn test_line_ends_trimmed(cx: &mut gpui::TestAppContext) {
1476 init_test(cx, |_| {});
1477
1478 let mut cx = EditorLspTestContext::new_rust(
1479 lsp::ServerCapabilities {
1480 hover_provider: Some(lsp::HoverProviderCapability::Simple(true)),
1481 ..Default::default()
1482 },
1483 cx,
1484 )
1485 .await;
1486
1487 // Hover with keyboard has no delay
1488 cx.set_state(indoc! {"
1489 fˇn test() { println!(); }
1490 "});
1491 cx.update_editor(|editor, window, cx| hover(editor, &Hover, window, cx));
1492 let symbol_range = cx.lsp_range(indoc! {"
1493 «fn» test() { println!(); }
1494 "});
1495
1496 let code_str = "\nlet hovered_point: Vector2F // size = 8, align = 0x4\n";
1497 let markdown_string = format!("\n```rust\n{code_str}```");
1498
1499 let closure_markdown_string = markdown_string.clone();
1500 cx.set_request_handler::<lsp::request::HoverRequest, _, _>(move |_, _, _| {
1501 let future_markdown_string = closure_markdown_string.clone();
1502 async move {
1503 Ok(Some(lsp::Hover {
1504 contents: lsp::HoverContents::Markup(lsp::MarkupContent {
1505 kind: lsp::MarkupKind::Markdown,
1506 value: future_markdown_string,
1507 }),
1508 range: Some(symbol_range),
1509 }))
1510 }
1511 })
1512 .next()
1513 .await;
1514
1515 cx.dispatch_action(Hover);
1516
1517 cx.condition(|editor, _| editor.hover_state.visible()).await;
1518 cx.editor(|editor, _, cx| {
1519 assert_eq!(
1520 editor.hover_state.info_popovers.len(),
1521 1,
1522 "Expected exactly one hover but got: {:?}",
1523 editor.hover_state.info_popovers.len()
1524 );
1525 let rendered_text = editor
1526 .hover_state
1527 .info_popovers
1528 .first()
1529 .unwrap()
1530 .get_rendered_text(cx);
1531
1532 assert_eq!(
1533 rendered_text, code_str,
1534 "Should not have extra line breaks at end of rendered hover"
1535 );
1536 });
1537 }
1538
1539 #[gpui::test]
1540 // https://github.com/zed-industries/zed/issues/15498
1541 async fn test_info_hover_with_hrs(cx: &mut gpui::TestAppContext) {
1542 init_test(cx, |_| {});
1543
1544 let mut cx = EditorLspTestContext::new_rust(
1545 lsp::ServerCapabilities {
1546 hover_provider: Some(lsp::HoverProviderCapability::Simple(true)),
1547 ..Default::default()
1548 },
1549 cx,
1550 )
1551 .await;
1552
1553 cx.set_state(indoc! {"
1554 fn fuˇnc(abc def: i32) -> u32 {
1555 }
1556 "});
1557
1558 cx.lsp
1559 .set_request_handler::<lsp::request::HoverRequest, _, _>({
1560 |_, _| async move {
1561 Ok(Some(lsp::Hover {
1562 contents: lsp::HoverContents::Markup(lsp::MarkupContent {
1563 kind: lsp::MarkupKind::Markdown,
1564 value: indoc!(
1565 r#"
1566 ### function `errands_data_read`
1567
1568 ---
1569 → `char *`
1570 Function to read a file into a string
1571
1572 ---
1573 ```cpp
1574 static char *errands_data_read()
1575 ```
1576 "#
1577 )
1578 .to_string(),
1579 }),
1580 range: None,
1581 }))
1582 }
1583 });
1584 cx.update_editor(|editor, window, cx| hover(editor, &Default::default(), window, cx));
1585 cx.run_until_parked();
1586
1587 cx.update_editor(|editor, _, cx| {
1588 let popover = editor.hover_state.info_popovers.first().unwrap();
1589 let content = popover.get_rendered_text(cx);
1590
1591 assert!(content.contains("Function to read a file"));
1592 });
1593 }
1594
1595 #[gpui::test]
1596 async fn test_hover_inlay_label_parts(cx: &mut gpui::TestAppContext) {
1597 init_test(cx, |settings| {
1598 settings.defaults.inlay_hints = Some(InlayHintSettingsContent {
1599 show_value_hints: Some(true),
1600 enabled: Some(true),
1601 edit_debounce_ms: Some(0),
1602 scroll_debounce_ms: Some(0),
1603 show_type_hints: Some(true),
1604 show_parameter_hints: Some(true),
1605 show_other_hints: Some(true),
1606 show_background: Some(false),
1607 toggle_on_modifiers_press: None,
1608 })
1609 });
1610
1611 let mut cx = EditorLspTestContext::new_rust(
1612 lsp::ServerCapabilities {
1613 inlay_hint_provider: Some(lsp::OneOf::Right(
1614 lsp::InlayHintServerCapabilities::Options(lsp::InlayHintOptions {
1615 resolve_provider: Some(true),
1616 ..Default::default()
1617 }),
1618 )),
1619 ..Default::default()
1620 },
1621 cx,
1622 )
1623 .await;
1624
1625 cx.set_state(indoc! {"
1626 struct TestStruct;
1627
1628 // ==================
1629
1630 struct TestNewType<T>(T);
1631
1632 fn main() {
1633 let variableˇ = TestNewType(TestStruct);
1634 }
1635 "});
1636
1637 let hint_start_offset = cx.ranges(indoc! {"
1638 struct TestStruct;
1639
1640 // ==================
1641
1642 struct TestNewType<T>(T);
1643
1644 fn main() {
1645 let variableˇ = TestNewType(TestStruct);
1646 }
1647 "})[0]
1648 .start;
1649 let hint_position = cx.to_lsp(MultiBufferOffset(hint_start_offset));
1650 let new_type_target_range = cx.lsp_range(indoc! {"
1651 struct TestStruct;
1652
1653 // ==================
1654
1655 struct «TestNewType»<T>(T);
1656
1657 fn main() {
1658 let variable = TestNewType(TestStruct);
1659 }
1660 "});
1661 let struct_target_range = cx.lsp_range(indoc! {"
1662 struct «TestStruct»;
1663
1664 // ==================
1665
1666 struct TestNewType<T>(T);
1667
1668 fn main() {
1669 let variable = TestNewType(TestStruct);
1670 }
1671 "});
1672
1673 let uri = cx.buffer_lsp_url.clone();
1674 let new_type_label = "TestNewType";
1675 let struct_label = "TestStruct";
1676 let entire_hint_label = ": TestNewType<TestStruct>";
1677 let closure_uri = uri.clone();
1678 cx.lsp
1679 .set_request_handler::<lsp::request::InlayHintRequest, _, _>(move |params, _| {
1680 let task_uri = closure_uri.clone();
1681 async move {
1682 assert_eq!(params.text_document.uri, task_uri);
1683 Ok(Some(vec![lsp::InlayHint {
1684 position: hint_position,
1685 label: lsp::InlayHintLabel::LabelParts(vec![lsp::InlayHintLabelPart {
1686 value: entire_hint_label.to_string(),
1687 ..Default::default()
1688 }]),
1689 kind: Some(lsp::InlayHintKind::TYPE),
1690 text_edits: None,
1691 tooltip: None,
1692 padding_left: Some(false),
1693 padding_right: Some(false),
1694 data: None,
1695 }]))
1696 }
1697 })
1698 .next()
1699 .await;
1700 cx.background_executor.run_until_parked();
1701 cx.update_editor(|editor, _, cx| {
1702 let expected_layers = vec![entire_hint_label.to_string()];
1703 assert_eq!(expected_layers, cached_hint_labels(editor, cx));
1704 assert_eq!(expected_layers, visible_hint_labels(editor, cx));
1705 });
1706
1707 let inlay_range = cx
1708 .ranges(indoc! {"
1709 struct TestStruct;
1710
1711 // ==================
1712
1713 struct TestNewType<T>(T);
1714
1715 fn main() {
1716 let variable« »= TestNewType(TestStruct);
1717 }
1718 "})
1719 .first()
1720 .cloned()
1721 .unwrap();
1722 let new_type_hint_part_hover_position = cx.update_editor(|editor, window, cx| {
1723 let snapshot = editor.snapshot(window, cx);
1724 let previous_valid = MultiBufferOffset(inlay_range.start).to_display_point(&snapshot);
1725 let next_valid = MultiBufferOffset(inlay_range.end).to_display_point(&snapshot);
1726 assert_eq!(previous_valid.row(), next_valid.row());
1727 assert!(previous_valid.column() < next_valid.column());
1728 let exact_unclipped = DisplayPoint::new(
1729 previous_valid.row(),
1730 previous_valid.column()
1731 + (entire_hint_label.find(new_type_label).unwrap() + new_type_label.len() / 2)
1732 as u32,
1733 );
1734 PointForPosition {
1735 previous_valid,
1736 next_valid,
1737 exact_unclipped,
1738 column_overshoot_after_line_end: 0,
1739 }
1740 });
1741 cx.update_editor(|editor, window, cx| {
1742 editor.update_inlay_link_and_hover_points(
1743 &editor.snapshot(window, cx),
1744 new_type_hint_part_hover_position,
1745 true,
1746 false,
1747 window,
1748 cx,
1749 );
1750 });
1751
1752 let resolve_closure_uri = uri.clone();
1753 cx.lsp
1754 .set_request_handler::<lsp::request::InlayHintResolveRequest, _, _>(
1755 move |mut hint_to_resolve, _| {
1756 let mut resolved_hint_positions = BTreeSet::new();
1757 let task_uri = resolve_closure_uri.clone();
1758 async move {
1759 let inserted = resolved_hint_positions.insert(hint_to_resolve.position);
1760 assert!(inserted, "Hint {hint_to_resolve:?} was resolved twice");
1761
1762 // `: TestNewType<TestStruct>`
1763 hint_to_resolve.label = lsp::InlayHintLabel::LabelParts(vec![
1764 lsp::InlayHintLabelPart {
1765 value: ": ".to_string(),
1766 ..Default::default()
1767 },
1768 lsp::InlayHintLabelPart {
1769 value: new_type_label.to_string(),
1770 location: Some(lsp::Location {
1771 uri: task_uri.clone(),
1772 range: new_type_target_range,
1773 }),
1774 tooltip: Some(lsp::InlayHintLabelPartTooltip::String(format!(
1775 "A tooltip for `{new_type_label}`"
1776 ))),
1777 ..Default::default()
1778 },
1779 lsp::InlayHintLabelPart {
1780 value: "<".to_string(),
1781 ..Default::default()
1782 },
1783 lsp::InlayHintLabelPart {
1784 value: struct_label.to_string(),
1785 location: Some(lsp::Location {
1786 uri: task_uri,
1787 range: struct_target_range,
1788 }),
1789 tooltip: Some(lsp::InlayHintLabelPartTooltip::MarkupContent(
1790 lsp::MarkupContent {
1791 kind: lsp::MarkupKind::Markdown,
1792 value: format!("A tooltip for `{struct_label}`"),
1793 },
1794 )),
1795 ..Default::default()
1796 },
1797 lsp::InlayHintLabelPart {
1798 value: ">".to_string(),
1799 ..Default::default()
1800 },
1801 ]);
1802
1803 Ok(hint_to_resolve)
1804 }
1805 },
1806 )
1807 .next()
1808 .await;
1809 cx.background_executor.run_until_parked();
1810
1811 cx.update_editor(|editor, window, cx| {
1812 editor.update_inlay_link_and_hover_points(
1813 &editor.snapshot(window, cx),
1814 new_type_hint_part_hover_position,
1815 true,
1816 false,
1817 window,
1818 cx,
1819 );
1820 });
1821 cx.background_executor
1822 .advance_clock(Duration::from_millis(get_hover_popover_delay(&cx) + 100));
1823 cx.background_executor.run_until_parked();
1824 cx.update_editor(|editor, _, cx| {
1825 let hover_state = &editor.hover_state;
1826 assert!(
1827 hover_state.diagnostic_popover.is_none() && hover_state.info_popovers.len() == 1
1828 );
1829 let popover = hover_state.info_popovers.first().unwrap();
1830 let buffer_snapshot = editor.buffer().update(cx, |buffer, cx| buffer.snapshot(cx));
1831 assert_eq!(
1832 popover.symbol_range,
1833 RangeInEditor::Inlay(InlayHighlight {
1834 inlay: InlayId::Hint(0),
1835 inlay_position: buffer_snapshot
1836 .anchor_after(MultiBufferOffset(inlay_range.start)),
1837 range: ": ".len()..": ".len() + new_type_label.len(),
1838 }),
1839 "Popover range should match the new type label part"
1840 );
1841 assert_eq!(
1842 popover.get_rendered_text(cx),
1843 format!("A tooltip for {new_type_label}"),
1844 );
1845 });
1846
1847 let struct_hint_part_hover_position = cx.update_editor(|editor, window, cx| {
1848 let snapshot = editor.snapshot(window, cx);
1849 let previous_valid = MultiBufferOffset(inlay_range.start).to_display_point(&snapshot);
1850 let next_valid = MultiBufferOffset(inlay_range.end).to_display_point(&snapshot);
1851 assert_eq!(previous_valid.row(), next_valid.row());
1852 assert!(previous_valid.column() < next_valid.column());
1853 let exact_unclipped = DisplayPoint::new(
1854 previous_valid.row(),
1855 previous_valid.column()
1856 + (entire_hint_label.find(struct_label).unwrap() + struct_label.len() / 2)
1857 as u32,
1858 );
1859 PointForPosition {
1860 previous_valid,
1861 next_valid,
1862 exact_unclipped,
1863 column_overshoot_after_line_end: 0,
1864 }
1865 });
1866 cx.update_editor(|editor, window, cx| {
1867 editor.update_inlay_link_and_hover_points(
1868 &editor.snapshot(window, cx),
1869 struct_hint_part_hover_position,
1870 true,
1871 false,
1872 window,
1873 cx,
1874 );
1875 });
1876 cx.background_executor
1877 .advance_clock(Duration::from_millis(get_hover_popover_delay(&cx) + 100));
1878 cx.background_executor.run_until_parked();
1879 cx.update_editor(|editor, _, cx| {
1880 let hover_state = &editor.hover_state;
1881 assert!(
1882 hover_state.diagnostic_popover.is_none() && hover_state.info_popovers.len() == 1
1883 );
1884 let popover = hover_state.info_popovers.first().unwrap();
1885 let buffer_snapshot = editor.buffer().update(cx, |buffer, cx| buffer.snapshot(cx));
1886 assert_eq!(
1887 popover.symbol_range,
1888 RangeInEditor::Inlay(InlayHighlight {
1889 inlay: InlayId::Hint(0),
1890 inlay_position: buffer_snapshot
1891 .anchor_after(MultiBufferOffset(inlay_range.start)),
1892 range: ": ".len() + new_type_label.len() + "<".len()
1893 ..": ".len() + new_type_label.len() + "<".len() + struct_label.len(),
1894 }),
1895 "Popover range should match the struct label part"
1896 );
1897 assert_eq!(
1898 popover.get_rendered_text(cx),
1899 format!("A tooltip for {struct_label}"),
1900 "Rendered markdown element should remove backticks from text"
1901 );
1902 });
1903 }
1904}