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