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