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