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