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