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