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