rust-analyzer/crates/ide/src/hover.rs

5052 lines
125 KiB
Rust
Raw Normal View History

2021-09-22 08:07:26 +00:00
use std::{collections::HashSet, iter, ops::ControlFlow};
use either::Either;
2021-08-02 18:42:25 +00:00
use hir::{AsAssocItem, HasAttrs, HasSource, HirDisplay, Semantics, TypeInfo};
2020-08-13 14:39:16 +00:00
use ide_db::{
2021-07-25 01:54:48 +00:00
base_db::{FileRange, SourceDatabase},
2020-10-15 15:27:50 +00:00
defs::{Definition, NameClass, NameRefClass},
2021-06-04 16:35:19 +00:00
helpers::{
generated_lints::{CLIPPY_LINTS, DEFAULT_LINTS, FEATURES},
pick_best_token, try_resolve_derive_input_at, FamousDefs,
2021-06-04 16:35:19 +00:00
},
RootDatabase,
};
2020-08-13 14:39:16 +00:00
use itertools::Itertools;
2020-07-09 08:19:37 +00:00
use stdx::format_to;
use syntax::{
algo, ast, display::fn_as_proc_macro_label, match_ast, AstNode, Direction, SyntaxKind::*,
SyntaxNode, SyntaxToken, TextRange, TextSize, T,
};
2019-01-08 19:33:36 +00:00
2019-05-30 17:46:43 +00:00
use crate::{
2021-03-15 16:05:03 +00:00
display::{macro_label, TryToNav},
doc_links::{
doc_attributes, extract_definitions_from_docs, remove_links, resolve_doc_path_for_def,
rewrite_links,
},
2020-10-08 02:44:52 +00:00
markdown_remove::remove_markdown,
2020-07-08 20:37:35 +00:00
markup::Markup,
2021-01-10 11:24:01 +00:00
runnables::{runnable_fn, runnable_mod},
2020-06-06 11:30:29 +00:00
FileId, FilePosition, NavigationTarget, RangeInfo, Runnable,
2019-05-30 17:46:43 +00:00
};
2019-01-08 19:33:36 +00:00
2020-06-03 11:15:54 +00:00
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct HoverConfig {
pub links_in_hover: bool,
pub documentation: Option<HoverDocFormat>,
}
impl HoverConfig {
fn markdown(&self) -> bool {
matches!(self.documentation, Some(HoverDocFormat::Markdown))
}
}
#[derive(Clone, Debug, PartialEq, Eq)]
pub enum HoverDocFormat {
Markdown,
PlainText,
2020-06-03 11:15:54 +00:00
}
#[derive(Debug, Clone)]
pub enum HoverAction {
2020-06-06 11:30:29 +00:00
Runnable(Runnable),
2021-01-04 13:24:37 +00:00
Implementation(FilePosition),
2021-06-04 13:49:43 +00:00
Reference(FilePosition),
GoToType(Vec<HoverGotoTypeData>),
}
2021-08-11 11:39:36 +00:00
impl HoverAction {
fn goto_type_from_targets(db: &RootDatabase, targets: Vec<hir::ModuleDef>) -> Self {
let targets = targets
.into_iter()
.filter_map(|it| {
Some(HoverGotoTypeData {
mod_path: render_path(
db,
it.module(db)?,
it.name(db).map(|name| name.to_string()),
),
nav: it.try_to_nav(db)?,
})
})
.collect();
HoverAction::GoToType(targets)
}
}
#[derive(Debug, Clone, Eq, PartialEq)]
pub struct HoverGotoTypeData {
pub mod_path: String,
pub nav: NavigationTarget,
2020-06-03 11:15:54 +00:00
}
/// Contains the results when hovering over an item
#[derive(Debug, Default)]
pub struct HoverResult {
2020-07-08 20:37:35 +00:00
pub markup: Markup,
pub actions: Vec<HoverAction>,
}
2021-07-27 21:50:26 +00:00
// Feature: Hover
//
// Shows additional information, like the type of an expression or the documentation for a definition when "focusing" code.
// Focusing is usually hovering with a mouse, but can also be triggered with a shortcut.
//
// image::https://user-images.githubusercontent.com/48062697/113020658-b5f98b80-917a-11eb-9f88-3dbc27320c95.gif[]
pub(crate) fn hover(
db: &RootDatabase,
2021-08-02 15:10:36 +00:00
FileRange { file_id, range }: FileRange,
config: &HoverConfig,
) -> Option<RangeInfo<HoverResult>> {
let sema = hir::Semantics::new(db);
2021-08-02 15:10:36 +00:00
let file = sema.parse(file_id).syntax().clone();
2021-07-27 21:50:26 +00:00
2021-08-11 11:39:36 +00:00
if !range.is_empty() {
return hover_ranged(&file, range, &sema, config);
}
let offset = range.start();
2021-07-27 21:50:26 +00:00
2021-08-02 15:10:36 +00:00
let token = pick_best_token(file.token_at_offset(offset), |kind| match kind {
IDENT | INT_NUMBER | LIFETIME_IDENT | T![self] | T![super] | T![crate] => 3,
T!['('] | T![')'] => 2,
kind if kind.is_trivia() => 0,
_ => 1,
})?;
let mut seen = HashSet::default();
let mut fallback = None;
// attributes, require special machinery as they are mere ident tokens
2021-09-21 15:25:57 +00:00
let descend_macros = sema.descend_into_macros_many(token.clone());
for token in &descend_macros {
if token.kind() != COMMENT {
if let Some(attr) = token.ancestors().find_map(ast::Attr::cast) {
// lints
if let Some(res) = try_hover_for_lint(&attr, &token) {
return Some(res);
// derives
} else {
let def =
try_resolve_derive_input_at(&sema, &attr, &token).map(Definition::Macro);
if let Some(def) = def {
if let Some(hover) = hover_for_definition(
&sema,
file_id,
def,
&token.parent().unwrap(),
config,
) {
return Some(RangeInfo::new(token.text_range(), hover));
}
}
}
}
}
}
2021-09-21 15:25:57 +00:00
descend_macros
.iter()
.filter_map(|token| match token.parent() {
Some(node) => {
match find_hover_result(&sema, file_id, offset, config, token, &node, &mut seen) {
Some(res) => match res {
ControlFlow::Break(inner) => Some(inner),
ControlFlow::Continue(_) => {
if fallback.is_none() {
// FIXME we're only taking the first fallback into account that's not `None`
2021-09-15 16:05:48 +00:00
fallback = hover_for_keyword(&sema, config, &token)
.or(type_hover(&sema, config, &token));
}
None
}
},
None => None,
}
}
None => None,
})
// reduce all descends into a single `RangeInfo`
// that spans from the earliest start to the latest end (fishy/FIXME),
// concatenates all `Markup`s with `\n---\n`,
// and accumulates all actions into its `actions` vector.
.reduce(|mut acc, RangeInfo { range, mut info }| {
let start = acc.range.start().min(range.start());
let end = acc.range.end().max(range.end());
acc.range = TextRange::new(start, end);
acc.info.actions.append(&mut info.actions);
acc.info.markup = Markup::from(format!("{}\n---\n{}", acc.info.markup, info.markup));
acc
})
.or(fallback)
}
fn find_hover_result(
sema: &Semantics<RootDatabase>,
file_id: FileId,
offset: TextSize,
config: &HoverConfig,
token: &SyntaxToken,
node: &SyntaxNode,
seen: &mut HashSet<Definition>,
) -> Option<ControlFlow<RangeInfo<HoverResult>>> {
let mut range_override = None;
// intra-doc links and attributes are special cased
// so don't add them to the `seen` duplicate check
let mut add_to_seen_definitions = true;
2021-09-22 08:07:26 +00:00
let definition = find_definition(sema, node).next().or_else(|| {
// intra-doc links
// FIXME: move comment + attribute special cases somewhere else to simplify control flow,
// hopefully simplifying the return type of this function in the process
// (the `Break`/`Continue` distinction is needed to decide whether to use fallback hovers)
//
// FIXME: hovering the intra doc link to `Foo` not working:
//
// #[identity]
// trait Foo {
// /// [`Foo`]
// fn foo() {}
if token.kind() == COMMENT {
add_to_seen_definitions = false;
cov_mark::hit!(no_highlight_on_comment_hover);
let (attributes, def) = doc_attributes(sema, node)?;
let (docs, doc_mapping) = attributes.docs_with_rangemap(sema.db)?;
let (idl_range, link, ns) = extract_definitions_from_docs(&docs).into_iter().find_map(
|(range, link, ns)| {
let mapped = doc_mapping.map(range)?;
(mapped.file_id == file_id.into() && mapped.value.contains(offset))
.then(|| (mapped.value, link, ns))
2021-08-11 11:39:36 +00:00
},
)?;
range_override = Some(idl_range);
Some(match resolve_doc_path_for_def(sema.db, def, &link, ns)? {
Either::Left(it) => Definition::ModuleDef(it),
Either::Right(it) => Definition::Macro(it),
})
} else {
None
}
});
2020-07-08 18:26:20 +00:00
if let Some(definition) = definition {
// skip duplicates
if seen.contains(&definition) {
return None;
}
if add_to_seen_definitions {
seen.insert(definition);
}
if let Some(res) = hover_for_definition(sema, file_id, definition, &node, config) {
2021-08-11 11:39:36 +00:00
let range = range_override.unwrap_or_else(|| sema.original_range(&node).range);
return Some(ControlFlow::Break(RangeInfo::new(range, res)));
}
}
Some(ControlFlow::Continue(()))
}
2021-08-11 11:39:36 +00:00
fn type_hover(
sema: &Semantics<RootDatabase>,
config: &HoverConfig,
token: &SyntaxToken,
) -> Option<RangeInfo<HoverResult>> {
if token.kind() == COMMENT {
return None;
}
let node = token
.ancestors()
.take_while(|it| !ast::Item::can_cast(it.kind()))
.find(|n| ast::Expr::can_cast(n.kind()) || ast::Pat::can_cast(n.kind()))?;
2021-08-02 15:10:36 +00:00
let expr_or_pat = match_ast! {
match node {
2021-08-02 15:10:36 +00:00
ast::Expr(it) => Either::Left(it),
ast::Pat(it) => Either::Right(it),
// If this node is a MACRO_CALL, it means that `descend_into_macros_many` failed to resolve.
2020-07-09 07:39:53 +00:00
// (e.g expanding a builtin macro). So we give up here.
ast::MacroCall(_it) => return None,
_ => return None,
}
2020-07-09 07:39:53 +00:00
};
2021-08-02 16:15:55 +00:00
let res = hover_type_info(&sema, config, &expr_or_pat)?;
let range = sema.original_range(&node).range;
Some(RangeInfo::new(range, res))
}
2021-08-11 11:39:36 +00:00
fn hover_ranged(
file: &SyntaxNode,
range: syntax::TextRange,
sema: &Semantics<RootDatabase>,
config: &HoverConfig,
) -> Option<RangeInfo<HoverResult>> {
let expr_or_pat = file.covering_element(range).ancestors().find_map(|it| {
2021-08-11 11:39:36 +00:00
match_ast! {
match it {
ast::Expr(expr) => Some(Either::Left(expr)),
ast::Pat(pat) => Some(Either::Right(pat)),
_ => None,
}
}
})?;
let res = match &expr_or_pat {
Either::Left(ast::Expr::TryExpr(try_expr)) => hover_try_expr(sema, config, try_expr),
Either::Left(ast::Expr::PrefixExpr(prefix_expr))
if prefix_expr.op_kind() == Some(ast::UnaryOp::Deref) =>
{
hover_deref_expr(sema, config, prefix_expr)
}
_ => None,
};
let res = res.or_else(|| hover_type_info(sema, config, &expr_or_pat));
res.map(|it| {
let range = match expr_or_pat {
2021-08-11 11:39:36 +00:00
Either::Left(it) => it.syntax().text_range(),
Either::Right(it) => it.syntax().text_range(),
};
RangeInfo::new(range, it)
})
}
fn hover_try_expr(
sema: &Semantics<RootDatabase>,
config: &HoverConfig,
try_expr: &ast::TryExpr,
) -> Option<HoverResult> {
let inner_ty = sema.type_of_expr(&try_expr.expr()?)?.original;
let mut ancestors = try_expr.syntax().ancestors();
let mut body_ty = loop {
let next = ancestors.next()?;
break match_ast! {
match next {
ast::Fn(fn_) => sema.to_def(&fn_)?.ret_type(sema.db),
ast::Item(__) => return None,
ast::ClosureExpr(closure) => sema.type_of_expr(&closure.body()?)?.original,
ast::EffectExpr(effect) => if matches!(effect.effect(), ast::Effect::Async(_) | ast::Effect::Try(_)| ast::Effect::Const(_)) {
sema.type_of_expr(&effect.block_expr()?.into())?.original
} else {
continue;
},
_ => continue,
}
};
};
if inner_ty == body_ty {
return None;
}
let mut inner_ty = inner_ty;
let mut s = "Try Target".to_owned();
let adts = inner_ty.as_adt().zip(body_ty.as_adt());
if let Some((hir::Adt::Enum(inner), hir::Adt::Enum(body))) = adts {
let famous_defs = FamousDefs(sema, sema.scope(&try_expr.syntax()).krate());
// special case for two options, there is no value in showing them
if let Some(option_enum) = famous_defs.core_option_Option() {
if inner == option_enum && body == option_enum {
2021-09-01 09:25:42 +00:00
cov_mark::hit!(hover_try_expr_opt_opt);
return None;
}
}
// special case two results to show the error variants only
if let Some(result_enum) = famous_defs.core_result_Result() {
if inner == result_enum && body == result_enum {
let error_type_args =
inner_ty.type_arguments().nth(1).zip(body_ty.type_arguments().nth(1));
if let Some((inner, body)) = error_type_args {
inner_ty = inner;
body_ty = body;
s = "Try Error".to_owned();
}
}
}
}
let mut res = HoverResult::default();
let mut targets: Vec<hir::ModuleDef> = Vec::new();
let mut push_new_def = |item: hir::ModuleDef| {
if !targets.contains(&item) {
targets.push(item);
}
};
walk_and_push_ty(sema.db, &inner_ty, &mut push_new_def);
walk_and_push_ty(sema.db, &body_ty, &mut push_new_def);
res.actions.push(HoverAction::goto_type_from_targets(sema.db, targets));
let inner_ty = inner_ty.display(sema.db).to_string();
let body_ty = body_ty.display(sema.db).to_string();
let ty_len_max = inner_ty.len().max(body_ty.len());
2021-09-01 09:25:42 +00:00
let l = "Propagated as: ".len() - " Type: ".len();
let static_text_len_diff = l as isize - s.len() as isize;
let tpad = static_text_len_diff.max(0) as usize;
let ppad = static_text_len_diff.min(0).abs() as usize;
res.markup = format!(
"{bt_start}{} Type: {:>pad0$}\nPropagated as: {:>pad1$}\n{bt_end}",
s,
inner_ty,
body_ty,
pad0 = ty_len_max + tpad,
pad1 = ty_len_max + ppad,
bt_start = if config.markdown() { "```text\n" } else { "" },
bt_end = if config.markdown() { "```\n" } else { "" }
)
.into();
Some(res)
}
fn hover_deref_expr(
sema: &Semantics<RootDatabase>,
config: &HoverConfig,
deref_expr: &ast::PrefixExpr,
) -> Option<HoverResult> {
let inner_ty = sema.type_of_expr(&deref_expr.expr()?)?.original;
let TypeInfo { original, adjusted } =
sema.type_of_expr(&ast::Expr::from(deref_expr.clone()))?;
let mut res = HoverResult::default();
let mut targets: Vec<hir::ModuleDef> = Vec::new();
let mut push_new_def = |item: hir::ModuleDef| {
if !targets.contains(&item) {
targets.push(item);
}
};
walk_and_push_ty(sema.db, &inner_ty, &mut push_new_def);
walk_and_push_ty(sema.db, &original, &mut push_new_def);
res.markup = if let Some(adjusted_ty) = adjusted {
walk_and_push_ty(sema.db, &adjusted_ty, &mut push_new_def);
let original = original.display(sema.db).to_string();
let adjusted = adjusted_ty.display(sema.db).to_string();
let inner = inner_ty.display(sema.db).to_string();
2021-09-14 00:19:30 +00:00
let type_len = "To type: ".len();
let coerced_len = "Coerced to: ".len();
2021-09-13 23:16:10 +00:00
let deref_len = "Dereferenced from: ".len();
let max_len = (original.len() + type_len)
.max(adjusted.len() + coerced_len)
.max(inner.len() + deref_len);
format!(
2021-09-14 00:19:30 +00:00
"{bt_start}Dereferenced from: {:>ipad$}\nTo type: {:>apad$}\nCoerced to: {:>opad$}\n{bt_end}",
inner,
original,
adjusted,
2021-09-14 00:19:30 +00:00
ipad = max_len - deref_len,
apad = max_len - type_len,
opad = max_len - coerced_len,
bt_start = if config.markdown() { "```text\n" } else { "" },
bt_end = if config.markdown() { "```\n" } else { "" }
)
.into()
} else {
let original = original.display(sema.db).to_string();
let inner = inner_ty.display(sema.db).to_string();
2021-09-14 00:19:30 +00:00
let type_len = "To type: ".len();
2021-09-13 23:16:10 +00:00
let deref_len = "Dereferenced from: ".len();
let max_len = (original.len() + type_len).max(inner.len() + deref_len);
format!(
2021-09-14 00:19:30 +00:00
"{bt_start}Dereferenced from: {:>ipad$}\nTo type: {:>apad$}\n{bt_end}",
inner,
2021-09-14 00:19:30 +00:00
original,
ipad = max_len - deref_len,
2021-09-14 00:19:30 +00:00
apad = max_len - type_len,
bt_start = if config.markdown() { "```text\n" } else { "" },
bt_end = if config.markdown() { "```\n" } else { "" }
)
.into()
};
res.actions.push(HoverAction::goto_type_from_targets(sema.db, targets));
Some(res)
}
2021-08-02 15:10:36 +00:00
fn hover_type_info(
sema: &Semantics<RootDatabase>,
config: &HoverConfig,
2021-08-02 16:15:55 +00:00
expr_or_pat: &Either<ast::Expr, ast::Pat>,
2021-08-02 15:10:36 +00:00
) -> Option<HoverResult> {
let TypeInfo { original, adjusted } = match expr_or_pat {
2021-08-02 18:42:25 +00:00
Either::Left(expr) => sema.type_of_expr(expr)?,
Either::Right(pat) => sema.type_of_pat(pat)?,
2021-08-02 15:10:36 +00:00
};
let mut res = HoverResult::default();
2021-08-11 11:39:36 +00:00
let mut targets: Vec<hir::ModuleDef> = Vec::new();
let mut push_new_def = |item: hir::ModuleDef| {
if !targets.contains(&item) {
targets.push(item);
}
};
walk_and_push_ty(sema.db, &original, &mut push_new_def);
res.markup = if let Some(adjusted_ty) = adjusted {
2021-08-11 11:39:36 +00:00
walk_and_push_ty(sema.db, &adjusted_ty, &mut push_new_def);
let original = original.display(sema.db).to_string();
let adjusted = adjusted_ty.display(sema.db).to_string();
2021-09-01 09:25:42 +00:00
let static_text_diff_len = "Coerced to: ".len() - "Type: ".len();
2021-08-02 15:10:36 +00:00
format!(
"{bt_start}Type: {:>apad$}\nCoerced to: {:>opad$}\n{bt_end}",
original,
adjusted,
2021-09-01 09:25:42 +00:00
apad = static_text_diff_len + adjusted.len().max(original.len()),
opad = original.len(),
bt_start = if config.markdown() { "```text\n" } else { "" },
bt_end = if config.markdown() { "```\n" } else { "" }
2021-08-02 15:10:36 +00:00
)
.into()
} else {
if config.markdown() {
Markup::fenced_block(&original.display(sema.db))
2021-08-02 15:10:36 +00:00
} else {
original.display(sema.db).to_string().into()
2021-08-02 15:10:36 +00:00
}
};
2021-08-11 11:39:36 +00:00
res.actions.push(HoverAction::goto_type_from_targets(sema.db, targets));
2021-08-02 15:10:36 +00:00
Some(res)
}
fn try_hover_for_lint(attr: &ast::Attr, token: &SyntaxToken) -> Option<RangeInfo<HoverResult>> {
2021-06-04 15:03:18 +00:00
let (path, tt) = attr.as_simple_call()?;
if !tt.syntax().text_range().contains(token.text_range().start()) {
return None;
}
2021-06-04 16:35:19 +00:00
let (is_clippy, lints) = match &*path {
"feature" => (false, FEATURES),
"allow" | "deny" | "forbid" | "warn" => {
let is_clippy = algo::non_trivia_sibling(token.clone().into(), Direction::Prev)
.filter(|t| t.kind() == T![:])
.and_then(|t| algo::non_trivia_sibling(t, Direction::Prev))
.filter(|t| t.kind() == T![:])
.and_then(|t| algo::non_trivia_sibling(t, Direction::Prev))
.map_or(false, |t| {
t.kind() == T![ident] && t.into_token().map_or(false, |t| t.text() == "clippy")
});
2021-06-04 15:03:18 +00:00
if is_clippy {
2021-06-04 16:35:19 +00:00
(true, CLIPPY_LINTS)
2021-06-04 15:03:18 +00:00
} else {
2021-06-04 16:35:19 +00:00
(false, DEFAULT_LINTS)
2021-06-04 15:03:18 +00:00
}
}
_ => return None,
};
2021-06-04 16:35:19 +00:00
let tmp;
let needle = if is_clippy {
tmp = format!("clippy::{}", token.text());
&tmp
} else {
&*token.text()
};
let lint =
lints.binary_search_by_key(&needle, |lint| lint.label).ok().map(|idx| &lints[idx])?;
2021-06-04 15:03:18 +00:00
Some(RangeInfo::new(
token.text_range(),
HoverResult {
markup: Markup::from(format!("```\n{}\n```\n___\n\n{}", lint.label, lint.description)),
..Default::default()
},
))
}
2020-06-03 11:15:54 +00:00
fn show_implementations_action(db: &RootDatabase, def: Definition) -> Option<HoverAction> {
fn to_action(nav_target: NavigationTarget) -> HoverAction {
2021-01-04 13:24:37 +00:00
HoverAction::Implementation(FilePosition {
2020-07-17 10:42:48 +00:00
file_id: nav_target.file_id,
offset: nav_target.focus_or_full_range().start(),
2020-06-03 11:15:54 +00:00
})
}
let adt = match def {
Definition::ModuleDef(hir::ModuleDef::Trait(it)) => {
return it.try_to_nav(db).map(to_action)
}
Definition::ModuleDef(hir::ModuleDef::Adt(it)) => Some(it),
2021-03-29 15:46:33 +00:00
Definition::SelfType(it) => it.self_ty(db).as_adt(),
2020-06-03 11:15:54 +00:00
_ => None,
}?;
2021-01-09 15:59:00 +00:00
adt.try_to_nav(db).map(to_action)
2020-06-03 11:15:54 +00:00
}
2021-06-04 13:49:43 +00:00
fn show_fn_references_action(db: &RootDatabase, def: Definition) -> Option<HoverAction> {
match def {
Definition::ModuleDef(hir::ModuleDef::Function(it)) => {
it.try_to_nav(db).map(|nav_target| {
HoverAction::Reference(FilePosition {
file_id: nav_target.file_id,
offset: nav_target.focus_or_full_range().start(),
})
2021-06-04 13:49:43 +00:00
})
}
2021-06-04 13:49:43 +00:00
_ => None,
}
}
2020-06-06 11:30:29 +00:00
fn runnable_action(
sema: &hir::Semantics<RootDatabase>,
2020-06-06 11:30:29 +00:00
def: Definition,
file_id: FileId,
) -> Option<HoverAction> {
match def {
Definition::ModuleDef(it) => match it {
hir::ModuleDef::Module(it) => runnable_mod(sema, it).map(HoverAction::Runnable),
hir::ModuleDef::Function(func) => {
let src = func.source(sema.db)?;
if src.file_id != file_id.into() {
2021-03-08 20:19:44 +00:00
cov_mark::hit!(hover_macro_generated_struct_fn_doc_comment);
cov_mark::hit!(hover_macro_generated_struct_fn_doc_attr);
return None;
}
2021-06-13 03:54:16 +00:00
runnable_fn(sema, func).map(HoverAction::Runnable)
2020-06-06 11:30:29 +00:00
}
_ => None,
},
_ => None,
}
}
2021-08-11 11:39:36 +00:00
fn goto_type_action_for_def(db: &RootDatabase, def: Definition) -> Option<HoverAction> {
let mut targets: Vec<hir::ModuleDef> = Vec::new();
let mut push_new_def = |item: hir::ModuleDef| {
2021-01-04 14:19:09 +00:00
if !targets.contains(&item) {
targets.push(item);
}
};
2020-06-11 17:17:32 +00:00
if let Definition::GenericParam(hir::GenericParam::TypeParam(it)) = def {
2021-01-04 14:44:19 +00:00
it.trait_bounds(db).into_iter().for_each(|it| push_new_def(it.into()));
} else {
let ty = match def {
Definition::Local(it) => it.ty(db),
Definition::GenericParam(hir::GenericParam::ConstParam(it)) => it.ty(db),
Definition::Field(field) => field.ty(db),
2021-01-04 14:44:19 +00:00
_ => return None,
};
2021-08-11 11:39:36 +00:00
walk_and_push_ty(db, &ty, &mut push_new_def);
2021-01-04 14:44:19 +00:00
}
2021-01-04 14:19:09 +00:00
2021-08-11 11:39:36 +00:00
Some(HoverAction::goto_type_from_targets(db, targets))
}
2021-01-04 14:19:09 +00:00
2021-08-11 11:39:36 +00:00
fn walk_and_push_ty(
db: &RootDatabase,
ty: &hir::Type,
push_new_def: &mut dyn FnMut(hir::ModuleDef),
) {
ty.walk(db, |t| {
if let Some(adt) = t.as_adt() {
push_new_def(adt.into());
} else if let Some(trait_) = t.as_dyn_trait() {
push_new_def(trait_.into());
} else if let Some(traits) = t.as_impl_traits(db) {
traits.into_iter().for_each(|it| push_new_def(it.into()));
} else if let Some(trait_) = t.as_associated_type_parent_trait(db) {
push_new_def(trait_.into());
}
});
}
fn hover_markup(docs: Option<String>, desc: String, mod_path: Option<String>) -> Option<Markup> {
let mut buf = String::new();
2020-07-09 08:19:37 +00:00
if let Some(mod_path) = mod_path {
if !mod_path.is_empty() {
format_to!(buf, "```rust\n{}\n```\n\n", mod_path);
2020-07-09 08:19:37 +00:00
}
2019-06-10 16:34:43 +00:00
}
format_to!(buf, "```rust\n{}\n```", desc);
if let Some(doc) = docs {
format_to!(buf, "\n___\n\n{}", doc);
}
Some(buf.into())
2019-06-10 16:34:43 +00:00
}
fn process_markup(
db: &RootDatabase,
def: Definition,
markup: &Markup,
config: &HoverConfig,
) -> Markup {
let markup = markup.as_str();
let markup = if !config.markdown() {
remove_markdown(markup)
} else if config.links_in_hover {
rewrite_links(db, markup, def)
} else {
remove_links(markup)
};
Markup::from(markup)
}
2020-03-05 23:02:14 +00:00
fn definition_owner_name(db: &RootDatabase, def: &Definition) -> Option<String> {
match def {
2020-04-25 12:23:34 +00:00
Definition::Field(f) => Some(f.parent_def(db).name(db)),
2020-03-05 23:02:14 +00:00
Definition::Local(l) => l.parent(db).name(db),
Definition::ModuleDef(md) => match md {
hir::ModuleDef::Function(f) => match f.as_assoc_item(db)?.container(db) {
hir::AssocItemContainer::Trait(t) => Some(t.name(db)),
hir::AssocItemContainer::Impl(i) => i.self_ty(db).as_adt().map(|adt| adt.name(db)),
2020-03-05 23:02:14 +00:00
},
hir::ModuleDef::Variant(e) => Some(e.parent_enum(db).name(db)),
2020-03-05 23:02:14 +00:00
_ => None,
},
_ => None,
}
.map(|name| name.to_string())
}
fn render_path(db: &RootDatabase, module: hir::Module, item_name: Option<String>) -> String {
2020-07-09 07:56:15 +00:00
let crate_name =
db.crate_graph()[module.krate().into()].display_name.as_ref().map(|it| it.to_string());
2020-07-09 07:56:15 +00:00
let module_path = module
.path_to_root(db)
.into_iter()
.rev()
.flat_map(|it| it.name(db).map(|name| name.to_string()));
crate_name.into_iter().chain(module_path).chain(item_name).join("::")
}
fn definition_mod_path(db: &RootDatabase, def: &Definition) -> Option<String> {
if let Definition::GenericParam(_) = def {
return None;
}
2020-07-09 07:56:15 +00:00
def.module(db).map(|module| render_path(db, module, definition_owner_name(db, def)))
2020-03-05 23:02:14 +00:00
}
2021-09-22 08:07:26 +00:00
pub(crate) fn find_definition<'a>(
sema: &'a Semantics<RootDatabase>,
node: &SyntaxNode,
2021-09-22 08:07:26 +00:00
) -> impl Iterator<Item = Definition> + 'a {
iter::once(node.clone()).flat_map(move |node| {
match_ast! {
match node {
ast::Name(name) => {
let class = if let Some(x) = NameClass::classify(&sema, &name) {
x
} else {
return vec![];
};
match class {
NameClass::Definition(it) | NameClass::ConstReference(it) => vec![it],
NameClass::PatFieldShorthand { local_def, field_ref } => vec![Definition::Local(local_def), Definition::Field(field_ref)],
}
},
2021-09-22 08:07:26 +00:00
ast::NameRef(name_ref) => {
let class = if let Some(x) = NameRefClass::classify(sema, &name_ref) {
x
} else {
return vec![];
};
match class {
NameRefClass::Definition(def) => vec![def],
NameRefClass::FieldShorthand { local_ref, field_ref } => {
vec![Definition::Field(field_ref), Definition::Local(local_ref)]
}
}
},
ast::Lifetime(lifetime) => {
(if let Some(x) = NameClass::classify_lifetime(&sema, &lifetime) {
NameClass::defined(x)
} else {
NameRefClass::classify_lifetime(&sema, &lifetime).and_then(|class| match class {
NameRefClass::Definition(it) => Some(it),
_ => None,
})
}).into_iter().collect()
},
_ => vec![],
}
}
2021-09-22 08:07:26 +00:00
})
}
pub(crate) fn hover_for_definition(
sema: &Semantics<RootDatabase>,
file_id: FileId,
definition: Definition,
node: &SyntaxNode,
config: &HoverConfig,
) -> Option<HoverResult> {
let famous_defs = match &definition {
Definition::ModuleDef(hir::ModuleDef::BuiltinType(_)) => {
Some(FamousDefs(&sema, sema.scope(&node).krate()))
}
_ => None,
};
if let Some(markup) = markup_for_definition(sema.db, definition, famous_defs.as_ref(), config) {
let mut res = HoverResult::default();
res.markup = process_markup(sema.db, definition, &markup, config);
if let Some(action) = show_implementations_action(sema.db, definition) {
res.actions.push(action);
}
if let Some(action) = show_fn_references_action(sema.db, definition) {
res.actions.push(action);
}
if let Some(action) = runnable_action(&sema, definition, file_id) {
res.actions.push(action);
}
if let Some(action) = goto_type_action_for_def(sema.db, definition) {
res.actions.push(action);
}
return Some(res);
}
None
}
fn markup_for_definition(
db: &RootDatabase,
def: Definition,
famous_defs: Option<&FamousDefs>,
config: &HoverConfig,
) -> Option<Markup> {
let mod_path = definition_mod_path(db, &def);
let (label, docs) = match def {
Definition::Macro(it) => (
match &it.source(db)?.value {
Either::Left(mac) => macro_label(mac),
Either::Right(mac_fn) => fn_as_proc_macro_label(mac_fn),
},
it.attrs(db).docs(),
),
Definition::Field(def) => label_and_docs(db, def),
2020-03-03 17:36:39 +00:00
Definition::ModuleDef(it) => match it {
hir::ModuleDef::Module(it) => label_and_docs(db, it),
hir::ModuleDef::Function(it) => label_and_docs(db, it),
hir::ModuleDef::Adt(it) => label_and_docs(db, it),
hir::ModuleDef::Variant(it) => label_and_docs(db, it),
hir::ModuleDef::Const(it) => label_and_docs(db, it),
hir::ModuleDef::Static(it) => label_and_docs(db, it),
hir::ModuleDef::Trait(it) => label_and_docs(db, it),
hir::ModuleDef::TypeAlias(it) => label_and_docs(db, it),
hir::ModuleDef::BuiltinType(it) => {
return famous_defs
.and_then(|fd| hover_for_builtin(fd, it))
.or_else(|| Some(Markup::fenced_block(&it.name())))
}
},
Definition::Local(it) => return hover_for_local(it, db),
2020-11-29 21:49:07 +00:00
Definition::SelfType(impl_def) => {
impl_def.self_ty(db).as_adt().map(|adt| label_and_docs(db, adt))?
2020-11-29 21:49:07 +00:00
}
Definition::GenericParam(it) => label_and_docs(db, it),
Definition::Label(it) => return Some(Markup::fenced_block(&it.name(db))),
};
return hover_markup(
docs.filter(|_| config.documentation.is_some()).map(Into::into),
label,
mod_path,
);
fn label_and_docs<D>(db: &RootDatabase, def: D) -> (String, Option<hir::Documentation>)
where
D: HasAttrs + HirDisplay,
{
let label = def.display(db).to_string();
let docs = def.attrs(db).docs();
(label, docs)
}
}
fn hover_for_local(it: hir::Local, db: &RootDatabase) -> Option<Markup> {
let ty = it.ty(db);
let ty = ty.display(db);
let is_mut = if it.is_mut(db) { "mut " } else { "" };
let desc = match it.source(db).value {
Either::Left(ident) => {
let name = it.name(db).unwrap();
let let_kw = if ident
.syntax()
.parent()
.map_or(false, |p| p.kind() == LET_STMT || p.kind() == CONDITION)
{
"let "
} else {
""
};
format!("{}{}{}: {}", let_kw, is_mut, name, ty)
}
Either::Right(_) => format!("{}self: {}", is_mut, ty),
};
hover_markup(None, desc, None)
}
fn hover_for_keyword(
sema: &Semantics<RootDatabase>,
config: &HoverConfig,
token: &SyntaxToken,
) -> Option<RangeInfo<HoverResult>> {
if !token.kind().is_keyword() || !config.documentation.is_some() {
return None;
}
2021-06-13 03:54:16 +00:00
let famous_defs = FamousDefs(sema, sema.scope(&token.parent()?).krate());
// std exposes {}_keyword modules with docstrings on the root to document keywords
let keyword_mod = format!("{}_keyword", token.text());
let doc_owner = find_std_module(&famous_defs, &keyword_mod)?;
let docs = doc_owner.attrs(sema.db).docs()?;
let markup = process_markup(
sema.db,
Definition::ModuleDef(doc_owner.into()),
&hover_markup(Some(docs.into()), token.text().into(), None)?,
config,
);
Some(RangeInfo::new(token.text_range(), HoverResult { markup, actions: Default::default() }))
}
fn hover_for_builtin(famous_defs: &FamousDefs, builtin: hir::BuiltinType) -> Option<Markup> {
// std exposes prim_{} modules with docstrings on the root to document the builtins
let primitive_mod = format!("prim_{}", builtin.name());
let doc_owner = find_std_module(famous_defs, &primitive_mod)?;
let docs = doc_owner.attrs(famous_defs.0.db).docs()?;
hover_markup(Some(docs.into()), builtin.name().to_string(), None)
}
fn find_std_module(famous_defs: &FamousDefs, name: &str) -> Option<hir::Module> {
let db = famous_defs.0.db;
let std_crate = famous_defs.std()?;
let std_root_module = std_crate.root_module(db);
std_root_module
.children(db)
.find(|module| module.name(db).map_or(false, |module| module.to_string() == name))
}
2019-01-08 19:33:36 +00:00
#[cfg(test)]
mod tests {
2020-08-21 11:19:31 +00:00
use expect_test::{expect, Expect};
2021-07-27 21:50:26 +00:00
use ide_db::base_db::{FileLoader, FileRange};
use syntax::TextRange;
use crate::{fixture, hover::HoverDocFormat, HoverConfig};
2020-07-08 22:07:32 +00:00
fn check_hover_no_result(ra_fixture: &str) {
2020-10-02 15:34:31 +00:00
let (analysis, position) = fixture::position(ra_fixture);
let hover = analysis
.hover(
&HoverConfig {
links_in_hover: true,
documentation: Some(HoverDocFormat::Markdown),
},
2021-07-27 21:50:26 +00:00
FileRange { file_id: position.file_id, range: TextRange::empty(position.offset) },
)
.unwrap();
assert!(hover.is_none(), "hover not expected but found: {:?}", hover.unwrap());
2020-06-03 11:15:54 +00:00
}
2020-07-08 22:07:32 +00:00
fn check(ra_fixture: &str, expect: Expect) {
2020-10-02 15:34:31 +00:00
let (analysis, position) = fixture::position(ra_fixture);
let hover = analysis
.hover(
&HoverConfig {
links_in_hover: true,
documentation: Some(HoverDocFormat::Markdown),
},
2021-07-27 21:50:26 +00:00
FileRange { file_id: position.file_id, range: TextRange::empty(position.offset) },
)
.unwrap()
.unwrap();
let content = analysis.db.file_text(position.file_id);
let hovered_element = &content[hover.range];
let actual = format!("*{}*\n{}\n", hovered_element, hover.info.markup);
expect.assert_eq(&actual)
}
fn check_hover_no_links(ra_fixture: &str, expect: Expect) {
2020-10-02 15:34:31 +00:00
let (analysis, position) = fixture::position(ra_fixture);
let hover = analysis
.hover(
&HoverConfig {
links_in_hover: false,
documentation: Some(HoverDocFormat::Markdown),
},
2021-07-27 21:50:26 +00:00
FileRange { file_id: position.file_id, range: TextRange::empty(position.offset) },
)
.unwrap()
.unwrap();
let content = analysis.db.file_text(position.file_id);
let hovered_element = &content[hover.range];
let actual = format!("*{}*\n{}\n", hovered_element, hover.info.markup);
expect.assert_eq(&actual)
}
fn check_hover_no_markdown(ra_fixture: &str, expect: Expect) {
let (analysis, position) = fixture::position(ra_fixture);
let hover = analysis
.hover(
&HoverConfig {
links_in_hover: true,
documentation: Some(HoverDocFormat::PlainText),
},
2021-07-27 21:50:26 +00:00
FileRange { file_id: position.file_id, range: TextRange::empty(position.offset) },
)
.unwrap()
.unwrap();
let content = analysis.db.file_text(position.file_id);
2020-07-08 22:07:32 +00:00
let hovered_element = &content[hover.range];
2020-07-09 08:30:47 +00:00
let actual = format!("*{}*\n{}\n", hovered_element, hover.info.markup);
2020-07-08 22:07:32 +00:00
expect.assert_eq(&actual)
}
2019-01-08 19:33:36 +00:00
2020-07-08 22:07:32 +00:00
fn check_actions(ra_fixture: &str, expect: Expect) {
2021-08-11 11:39:36 +00:00
let (analysis, file_id, position) = fixture::range_or_position(ra_fixture);
let hover = analysis
.hover(
&HoverConfig {
links_in_hover: true,
documentation: Some(HoverDocFormat::Markdown),
},
2021-08-11 11:39:36 +00:00
FileRange { file_id, range: position.range_or_empty() },
)
.unwrap()
.unwrap();
2020-07-08 22:07:32 +00:00
expect.assert_debug_eq(&hover.info.actions)
2020-02-26 16:12:26 +00:00
}
2021-07-26 19:34:44 +00:00
fn check_hover_range(ra_fixture: &str, expect: Expect) {
let (analysis, range) = fixture::range(ra_fixture);
let hover = analysis
2021-07-27 21:50:26 +00:00
.hover(
2021-07-26 19:34:44 +00:00
&HoverConfig {
links_in_hover: false,
documentation: Some(HoverDocFormat::Markdown),
},
range,
)
.unwrap()
.unwrap();
expect.assert_eq(hover.info.markup.as_str())
}
fn check_hover_range_no_results(ra_fixture: &str) {
let (analysis, range) = fixture::range(ra_fixture);
let hover = analysis
2021-07-27 21:50:26 +00:00
.hover(
&HoverConfig {
links_in_hover: false,
documentation: Some(HoverDocFormat::Markdown),
},
range,
)
.unwrap();
assert!(hover.is_none());
}
#[test]
fn hover_descend_macros_avoids_duplicates() {
check(
r#"
macro_rules! dupe_use {
($local:ident) => {
{
$local;
$local;
}
}
}
fn foo() {
let local = 0;
dupe_use!(local$0);
}
"#,
expect![[r#"
*local*
```rust
let local: i32
```
"#]],
);
}
#[test]
fn hover_shows_all_macro_descends() {
check(
r#"
macro_rules! m {
($name:ident) => {
/// Outer
fn $name() {}
mod module {
/// Inner
fn $name() {}
}
};
}
m!(ab$0c);
"#,
expect![[r#"
*abc*
```rust
test::module
```
```rust
fn abc()
```
---
Inner
---
```rust
test
```
```rust
fn abc()
```
---
Outer
"#]],
);
}
2019-01-08 19:33:36 +00:00
#[test]
fn hover_shows_type_of_an_expression() {
2020-07-08 22:07:32 +00:00
check(
2020-06-24 09:29:43 +00:00
r#"
pub fn foo() -> u32 { 1 }
2019-01-08 19:33:36 +00:00
2020-06-24 09:29:43 +00:00
fn main() {
2021-01-06 20:15:48 +00:00
let foo_test = foo()$0;
2020-06-24 09:29:43 +00:00
}
"#,
2020-07-08 22:07:32 +00:00
expect![[r#"
2020-07-09 08:30:47 +00:00
*foo()*
2020-07-08 22:07:32 +00:00
```rust
u32
```
"#]],
2019-01-08 19:33:36 +00:00
);
}
#[test]
fn hover_remove_markdown_if_configured() {
check_hover_no_markdown(
r#"
pub fn foo() -> u32 { 1 }
fn main() {
2021-01-06 20:15:48 +00:00
let foo_test = foo()$0;
}
"#,
expect![[r#"
*foo()*
u32
"#]],
);
}
#[test]
fn hover_shows_long_type_of_an_expression() {
2020-07-08 22:07:32 +00:00
check(
r#"
2020-07-08 22:07:32 +00:00
struct Scan<A, B, C> { a: A, b: B, c: C }
struct Iter<I> { inner: I }
enum Option<T> { Some(T), None }
2020-07-08 22:07:32 +00:00
struct OtherStruct<T> { i: T }
2020-07-08 22:07:32 +00:00
fn scan<A, B, C>(a: A, b: B, c: C) -> Iter<Scan<OtherStruct<A>, B, C>> {
Iter { inner: Scan { a, b, c } }
}
2020-07-08 22:07:32 +00:00
fn main() {
let num: i32 = 55;
let closure = |memo: &mut u32, value: &u32, _another: &mut u32| -> Option<u32> {
Option::Some(*memo + value)
};
let number = 5u32;
2021-01-06 20:15:48 +00:00
let mut iter$0 = scan(OtherStruct { i: num }, closure, number);
2020-07-08 22:07:32 +00:00
}
"#,
expect![[r#"
2020-07-09 08:30:47 +00:00
*iter*
2020-07-31 02:34:49 +00:00
```rust
let mut iter: Iter<Scan<OtherStruct<OtherStruct<i32>>, |&mut u32, &u32, &mut u32| -> Option<u32>, u32>>
```
2020-07-08 22:07:32 +00:00
"#]],
);
}
#[test]
fn hover_shows_fn_signature() {
// Single file with result
2020-07-08 22:07:32 +00:00
check(
r#"
2020-07-08 22:07:32 +00:00
pub fn foo() -> u32 { 1 }
2021-01-06 20:15:48 +00:00
fn main() { let foo_test = fo$0o(); }
2020-07-08 22:07:32 +00:00
"#,
expect![[r#"
2020-07-09 08:30:47 +00:00
*foo*
2020-07-31 02:34:49 +00:00
```rust
2020-07-31 02:34:49 +00:00
test
```
2020-07-31 02:34:49 +00:00
```rust
2020-07-08 22:07:32 +00:00
pub fn foo() -> u32
```
2020-07-08 22:07:32 +00:00
"#]],
);
// Multiple candidates but results are ambiguous.
2020-07-08 22:07:32 +00:00
check(
r#"
2020-07-08 22:07:32 +00:00
//- /a.rs
pub fn foo() -> u32 { 1 }
2020-07-08 22:07:32 +00:00
//- /b.rs
pub fn foo() -> &str { "" }
2020-07-08 22:07:32 +00:00
//- /c.rs
pub fn foo(a: u32, b: u32) {}
2020-07-08 22:07:32 +00:00
//- /main.rs
mod a;
mod b;
mod c;
2021-01-06 20:15:48 +00:00
fn main() { let foo_test = fo$0o(); }
"#,
2020-07-08 22:07:32 +00:00
expect![[r#"
2020-07-09 08:30:47 +00:00
*foo*
2020-07-08 22:07:32 +00:00
```rust
{unknown}
```
"#]],
);
2021-09-07 09:49:46 +00:00
// Use literal `crate` in path
2021-09-07 06:50:33 +00:00
check(
r#"
pub struct X;
fn foo() -> crate::X { X }
fn main() { f$0oo(); }
2021-09-07 06:50:33 +00:00
"#,
expect![[r#"
*foo*
```rust
test
```
```rust
fn foo() -> crate::X
```
2021-09-07 06:50:33 +00:00
"#]],
);
2021-09-07 09:49:46 +00:00
// Check `super` in path
check(
r#"
pub struct X;
mod m { pub fn foo() -> super::X { super::X } }
fn main() { m::f$0oo(); }
"#,
expect![[r#"
*foo*
```rust
test::m
```
```rust
pub fn foo() -> super::X
```
"#]],
);
}
#[test]
fn hover_shows_fn_signature_with_type_params() {
2020-07-08 22:07:32 +00:00
check(
r#"
2020-07-08 22:07:32 +00:00
pub fn foo<'a, T: AsRef<str>>(b: &'a T) -> &'a str { }
2021-01-06 20:15:48 +00:00
fn main() { let foo_test = fo$0o(); }
"#,
2020-07-08 22:07:32 +00:00
expect![[r#"
2020-07-09 08:30:47 +00:00
*foo*
2020-07-31 02:34:49 +00:00
```rust
2020-07-31 02:34:49 +00:00
test
```
2020-07-31 02:34:49 +00:00
```rust
2021-03-15 17:24:26 +00:00
pub fn foo<'a, T>(b: &'a T) -> &'a str
where
T: AsRef<str>,
```
2020-07-08 22:07:32 +00:00
"#]],
);
2019-01-08 19:33:36 +00:00
}
#[test]
fn hover_shows_fn_signature_on_fn_name() {
2020-07-08 22:07:32 +00:00
check(
r#"
2021-01-06 20:15:48 +00:00
pub fn foo$0(a: u32, b: u32) -> u32 {}
2020-07-08 22:07:32 +00:00
fn main() { }
"#,
expect![[r#"
2020-07-09 08:30:47 +00:00
*foo*
2020-07-31 02:34:49 +00:00
```rust
2020-07-31 02:34:49 +00:00
test
```
2020-07-31 02:34:49 +00:00
```rust
2020-07-08 22:07:32 +00:00
pub fn foo(a: u32, b: u32) -> u32
```
2020-07-08 22:07:32 +00:00
"#]],
);
}
#[test]
fn hover_shows_fn_doc() {
check(
r#"
/// # Example
/// ```
/// # use std::path::Path;
/// #
/// foo(Path::new("hello, world!"))
/// ```
2021-01-06 20:15:48 +00:00
pub fn foo$0(_: &Path) {}
fn main() { }
"#,
expect![[r##"
*foo*
```rust
test
```
```rust
pub fn foo(_: &Path)
```
---
# Example
```
# use std::path::Path;
#
foo(Path::new("hello, world!"))
```
"##]],
);
}
#[test]
fn hover_shows_fn_doc_attr_raw_string() {
check(
r##"
#[doc = r#"Raw string doc attr"#]
2021-01-06 20:15:48 +00:00
pub fn foo$0(_: &Path) {}
fn main() { }
"##,
expect![[r##"
*foo*
```rust
test
```
```rust
pub fn foo(_: &Path)
```
---
Raw string doc attr
"##]],
);
}
#[test]
fn hover_shows_struct_field_info() {
// Hovering over the field when instantiating
2020-07-08 22:07:32 +00:00
check(
r#"
2020-07-08 22:07:32 +00:00
struct Foo { field_a: u32 }
2020-07-08 22:07:32 +00:00
fn main() {
2021-01-06 20:15:48 +00:00
let foo = Foo { field_a$0: 0, };
2020-07-08 22:07:32 +00:00
}
"#,
expect![[r#"
2020-07-09 08:30:47 +00:00
*field_a*
2020-07-08 22:07:32 +00:00
```rust
2020-07-31 02:34:49 +00:00
test::Foo
```
2020-07-31 02:34:49 +00:00
```rust
2020-07-08 22:07:32 +00:00
field_a: u32
```
2020-07-08 22:07:32 +00:00
"#]],
);
// Hovering over the field in the definition
2020-07-08 22:07:32 +00:00
check(
r#"
2021-01-06 20:15:48 +00:00
struct Foo { field_a$0: u32 }
2020-07-08 22:07:32 +00:00
fn main() {
let foo = Foo { field_a: 0 };
}
"#,
expect![[r#"
2020-07-09 08:30:47 +00:00
*field_a*
2020-07-08 22:07:32 +00:00
```rust
2020-07-31 02:34:49 +00:00
test::Foo
```
2020-07-31 02:34:49 +00:00
```rust
2020-07-08 22:07:32 +00:00
field_a: u32
```
2020-07-08 22:07:32 +00:00
"#]],
);
}
#[test]
fn hover_const_static() {
2020-07-08 22:07:32 +00:00
check(
2021-01-06 20:15:48 +00:00
r#"const foo$0: u32 = 123;"#,
2020-07-08 22:07:32 +00:00
expect![[r#"
2020-07-09 08:30:47 +00:00
*foo*
2020-07-31 02:34:49 +00:00
```rust
2020-07-31 02:34:49 +00:00
test
```
2020-07-31 02:34:49 +00:00
```rust
const foo: u32
```
2020-07-08 22:07:32 +00:00
"#]],
);
2020-07-08 22:07:32 +00:00
check(
2021-01-06 20:15:48 +00:00
r#"static foo$0: u32 = 456;"#,
2020-07-08 22:07:32 +00:00
expect![[r#"
2020-07-09 08:30:47 +00:00
*foo*
2020-07-31 02:34:49 +00:00
```rust
2020-07-31 02:34:49 +00:00
test
```
2020-07-31 02:34:49 +00:00
```rust
2020-07-08 22:07:32 +00:00
static foo: u32
```
2020-07-08 22:07:32 +00:00
"#]],
);
}
#[test]
fn hover_default_generic_types() {
2020-07-08 22:07:32 +00:00
check(
r#"
2020-07-08 22:07:32 +00:00
struct Test<K, T = u8> { k: K, t: T }
fn main() {
2021-01-06 20:15:48 +00:00
let zz$0 = Test { t: 23u8, k: 33 };
}"#,
2020-07-08 22:07:32 +00:00
expect![[r#"
2020-07-09 08:30:47 +00:00
*zz*
2020-07-31 02:34:49 +00:00
```rust
let zz: Test<i32, u8>
```
2020-07-08 22:07:32 +00:00
"#]],
);
}
#[test]
fn hover_some() {
2020-07-08 22:07:32 +00:00
check(
r#"
enum Option<T> { Some(T) }
use Option::Some;
2021-01-06 20:15:48 +00:00
fn main() { So$0me(12); }
2020-07-08 22:07:32 +00:00
"#,
expect![[r#"
2020-07-09 08:30:47 +00:00
*Some*
2020-07-08 22:07:32 +00:00
```rust
2020-07-31 02:34:49 +00:00
test::Option
```
2020-07-31 02:34:49 +00:00
```rust
2021-03-15 17:24:26 +00:00
Some(T)
```
2020-07-08 22:07:32 +00:00
"#]],
2020-06-15 02:47:33 +00:00
);
2020-07-08 22:07:32 +00:00
check(
r#"
enum Option<T> { Some(T) }
use Option::Some;
2021-01-06 20:15:48 +00:00
fn main() { let b$0ar = Some(12); }
2020-07-08 22:07:32 +00:00
"#,
expect![[r#"
2020-07-09 08:30:47 +00:00
*bar*
2020-07-31 02:34:49 +00:00
```rust
let bar: Option<i32>
```
2020-07-08 22:07:32 +00:00
"#]],
);
}
#[test]
fn hover_enum_variant() {
2020-07-08 22:07:32 +00:00
check(
r#"
2020-07-08 22:07:32 +00:00
enum Option<T> {
/// The None variant
2021-01-06 20:15:48 +00:00
Non$0e
2020-07-08 22:07:32 +00:00
}
"#,
expect![[r#"
2020-07-09 08:30:47 +00:00
*None*
```rust
2020-07-31 02:34:49 +00:00
test::Option
```
2020-07-31 02:34:49 +00:00
```rust
2020-07-08 22:07:32 +00:00
None
```
2020-07-31 02:34:49 +00:00
---
2020-07-08 22:07:32 +00:00
The None variant
"#]],
);
2020-07-08 22:07:32 +00:00
check(
r#"
2020-07-08 22:07:32 +00:00
enum Option<T> {
/// The Some variant
Some(T)
}
fn main() {
2021-01-06 20:15:48 +00:00
let s = Option::Som$0e(12);
2020-07-08 22:07:32 +00:00
}
"#,
expect![[r#"
2020-07-09 08:30:47 +00:00
*Some*
```rust
2020-07-31 02:34:49 +00:00
test::Option
```
2020-07-31 02:34:49 +00:00
```rust
2021-03-15 17:24:26 +00:00
Some(T)
```
2020-07-31 02:34:49 +00:00
---
2020-07-08 22:07:32 +00:00
The Some variant
"#]],
);
}
2019-01-08 19:33:36 +00:00
#[test]
fn hover_for_local_variable() {
2020-07-08 22:07:32 +00:00
check(
2021-01-06 20:15:48 +00:00
r#"fn func(foo: i32) { fo$0o; }"#,
2020-07-08 22:07:32 +00:00
expect![[r#"
2020-07-09 08:30:47 +00:00
*foo*
2020-07-31 02:34:49 +00:00
```rust
foo: i32
```
2020-07-08 22:07:32 +00:00
"#]],
)
2019-01-08 19:33:36 +00:00
}
#[test]
fn hover_for_local_variable_pat() {
2020-07-08 22:07:32 +00:00
check(
2021-01-06 20:15:48 +00:00
r#"fn func(fo$0o: i32) {}"#,
2020-07-08 22:07:32 +00:00
expect![[r#"
2020-07-09 08:30:47 +00:00
*foo*
2020-07-31 02:34:49 +00:00
```rust
foo: i32
```
2020-07-08 22:07:32 +00:00
"#]],
)
2019-01-08 19:33:36 +00:00
}
#[test]
fn hover_local_var_edge() {
2020-07-08 22:07:32 +00:00
check(
2021-01-06 20:15:48 +00:00
r#"fn func(foo: i32) { if true { $0foo; }; }"#,
2020-07-08 22:07:32 +00:00
expect![[r#"
2020-07-09 08:30:47 +00:00
*foo*
2020-07-31 02:34:49 +00:00
```rust
foo: i32
```
2020-07-08 22:07:32 +00:00
"#]],
)
}
2019-12-13 18:54:07 +00:00
#[test]
fn hover_for_param_edge() {
2020-07-08 22:07:32 +00:00
check(
2021-01-06 20:15:48 +00:00
r#"fn func($0foo: i32) {}"#,
2020-07-08 22:07:32 +00:00
expect![[r#"
2020-07-09 08:30:47 +00:00
*foo*
2020-07-31 02:34:49 +00:00
```rust
foo: i32
```
2020-07-08 22:07:32 +00:00
"#]],
)
2019-12-13 18:54:07 +00:00
}
#[test]
fn hover_for_param_with_multiple_traits() {
check(
2021-06-15 22:23:04 +00:00
r#"
//- minicore: sized
trait Deref {
type Target: ?Sized;
}
trait DerefMut {
type Target: ?Sized;
}
2021-01-06 20:15:48 +00:00
fn f(_x$0: impl Deref<Target=u8> + DerefMut<Target=u8>) {}"#,
expect![[r#"
*_x*
```rust
_x: impl Deref<Target = u8> + DerefMut<Target = u8>
```
"#]],
)
}
#[test]
fn test_hover_infer_associated_method_result() {
2020-07-08 22:07:32 +00:00
check(
r#"
struct Thing { x: u32 }
2020-07-08 22:07:32 +00:00
impl Thing {
fn new() -> Thing { Thing { x: 0 } }
}
2021-01-06 20:15:48 +00:00
fn main() { let foo_$0test = Thing::new(); }
2021-08-02 15:10:36 +00:00
"#,
2020-07-08 22:07:32 +00:00
expect![[r#"
2020-07-09 08:30:47 +00:00
*foo_test*
2020-07-31 02:34:49 +00:00
```rust
let foo_test: Thing
```
2020-07-08 22:07:32 +00:00
"#]],
)
}
#[test]
fn test_hover_infer_associated_method_exact() {
2020-07-08 22:07:32 +00:00
check(
r#"
mod wrapper {
struct Thing { x: u32 }
2020-07-08 22:07:32 +00:00
impl Thing {
fn new() -> Thing { Thing { x: 0 } }
}
}
2021-01-06 20:15:48 +00:00
fn main() { let foo_test = wrapper::Thing::new$0(); }
2020-07-08 22:07:32 +00:00
"#,
expect![[r#"
2020-07-09 08:30:47 +00:00
*new*
2020-07-08 22:07:32 +00:00
```rust
2020-07-31 02:34:49 +00:00
test::wrapper::Thing
```
2020-07-31 02:34:49 +00:00
```rust
2020-07-08 22:07:32 +00:00
fn new() -> Thing
```
2020-07-08 22:07:32 +00:00
"#]],
)
}
2019-03-06 16:39:11 +00:00
#[test]
fn test_hover_infer_associated_const_in_pattern() {
2020-07-08 22:07:32 +00:00
check(
r#"
struct X;
impl X {
const C: u32 = 1;
}
2019-03-06 16:39:11 +00:00
2020-07-08 22:07:32 +00:00
fn main() {
match 1 {
2021-01-06 20:15:48 +00:00
X::C$0 => {},
2020-07-08 22:07:32 +00:00
2 => {},
_ => {}
};
}
"#,
expect![[r#"
2020-07-09 08:30:47 +00:00
*C*
2020-07-31 02:34:49 +00:00
```rust
2020-07-31 02:34:49 +00:00
test
```
2020-07-31 02:34:49 +00:00
```rust
const C: u32
```
2020-07-08 22:07:32 +00:00
"#]],
)
2019-03-06 16:39:11 +00:00
}
#[test]
fn test_hover_self() {
2020-07-08 22:07:32 +00:00
check(
r#"
struct Thing { x: u32 }
impl Thing {
2021-01-06 20:15:48 +00:00
fn new() -> Self { Self$0 { x: 0 } }
2020-07-08 22:07:32 +00:00
}
"#,
expect![[r#"
2020-11-29 21:49:07 +00:00
*Self*
2020-07-08 22:07:32 +00:00
```rust
2020-11-29 21:49:07 +00:00
test
```
```rust
struct Thing
2020-07-08 22:07:32 +00:00
```
"#]],
2020-11-29 21:49:07 +00:00
);
check(
r#"
struct Thing { x: u32 }
impl Thing {
2021-01-06 20:15:48 +00:00
fn new() -> Self$0 { Self { x: 0 } }
2020-11-29 21:49:07 +00:00
}
"#,
expect![[r#"
*Self*
```rust
test
```
```rust
struct Thing
```
"#]],
);
check(
r#"
enum Thing { A }
impl Thing {
2021-01-06 20:15:48 +00:00
pub fn new() -> Self$0 { Thing::A }
2020-11-29 21:49:07 +00:00
}
"#,
expect![[r#"
*Self*
```rust
test
```
```rust
enum Thing
```
"#]],
);
check(
r#"
enum Thing { A }
impl Thing {
2021-01-06 20:15:48 +00:00
pub fn thing(a: Self$0) {}
2020-11-29 21:49:07 +00:00
}
"#,
expect![[r#"
*Self*
```rust
test
```
```rust
enum Thing
```
"#]],
);
}
2019-06-11 14:32:33 +00:00
#[test]
fn test_hover_shadowing_pat() {
2020-07-08 22:07:32 +00:00
check(
r#"
fn x() {}
2019-06-11 14:32:33 +00:00
2020-07-08 22:07:32 +00:00
fn y() {
let x = 0i32;
2021-01-06 20:15:48 +00:00
x$0;
2020-07-08 22:07:32 +00:00
}
"#,
expect![[r#"
2020-07-09 08:30:47 +00:00
*x*
2020-07-31 02:34:49 +00:00
```rust
let x: i32
```
2020-07-08 22:07:32 +00:00
"#]],
)
2019-06-11 14:32:33 +00:00
}
2019-09-10 05:33:02 +00:00
#[test]
fn test_hover_macro_invocation() {
2020-07-08 22:07:32 +00:00
check(
r#"
macro_rules! foo { () => {} }
2019-09-10 05:33:02 +00:00
2021-01-06 20:15:48 +00:00
fn f() { fo$0o!(); }
2020-07-08 22:07:32 +00:00
"#,
expect![[r#"
2020-07-09 08:30:47 +00:00
*foo*
2020-07-31 02:34:49 +00:00
```rust
2020-07-31 02:34:49 +00:00
test
```
2020-07-31 02:34:49 +00:00
```rust
2020-07-08 22:07:32 +00:00
macro_rules! foo
```
2020-07-08 22:07:32 +00:00
"#]],
)
2019-09-10 05:33:02 +00:00
}
2019-11-10 18:59:39 +00:00
#[test]
fn test_hover_macro2_invocation() {
check(
r#"
/// foo bar
///
/// foo bar baz
macro foo() {}
fn f() { fo$0o!(); }
"#,
expect![[r#"
*foo*
```rust
test
```
```rust
macro foo
```
---
foo bar
foo bar baz
"#]],
)
}
2019-11-10 18:59:39 +00:00
#[test]
fn test_hover_tuple_field() {
2020-07-08 22:07:32 +00:00
check(
2021-01-06 20:15:48 +00:00
r#"struct TS(String, i32$0);"#,
2020-07-08 22:07:32 +00:00
expect![[r#"
2020-07-09 08:30:47 +00:00
*i32*
2021-01-01 14:07:41 +00:00
```rust
2020-07-08 22:07:32 +00:00
i32
2021-01-01 14:07:41 +00:00
```
2020-07-08 22:07:32 +00:00
"#]],
)
2019-11-10 18:59:39 +00:00
}
2019-11-18 16:58:42 +00:00
#[test]
fn test_hover_through_macro() {
2020-07-08 22:07:32 +00:00
check(
r#"
macro_rules! id { ($($tt:tt)*) => { $($tt)* } }
fn foo() {}
id! {
2021-01-06 20:15:48 +00:00
fn bar() { fo$0o(); }
2020-07-08 22:07:32 +00:00
}
"#,
expect![[r#"
2020-07-09 08:30:47 +00:00
*foo*
2020-07-31 02:34:49 +00:00
```rust
2020-07-31 02:34:49 +00:00
test
```
2020-07-31 02:34:49 +00:00
```rust
2020-07-08 22:07:32 +00:00
fn foo()
```
2020-07-08 22:07:32 +00:00
"#]],
2019-11-18 16:58:42 +00:00
);
}
2020-01-10 17:51:08 +00:00
2021-09-14 01:00:53 +00:00
#[test]
fn test_hover_through_attr() {
check(
r#"
//- proc_macros: identity
#[proc_macros::identity]
fn foo$0() {}
"#,
expect![[r#"
*foo*
```rust
test
```
2020-07-31 02:34:49 +00:00
```rust
2020-07-08 22:07:32 +00:00
fn foo()
```
2020-07-08 22:07:32 +00:00
"#]],
2019-11-18 16:58:42 +00:00
);
}
2020-01-10 17:51:08 +00:00
#[test]
fn test_hover_through_expr_in_macro() {
2020-07-08 22:07:32 +00:00
check(
r#"
macro_rules! id { ($($tt:tt)*) => { $($tt)* } }
2021-01-06 20:15:48 +00:00
fn foo(bar:u32) { let a = id!(ba$0r); }
2020-07-08 22:07:32 +00:00
"#,
expect![[r#"
2020-07-09 08:30:47 +00:00
*bar*
2020-07-31 02:34:49 +00:00
```rust
bar: u32
```
2020-07-08 22:07:32 +00:00
"#]],
2020-01-10 17:51:08 +00:00
);
}
#[test]
fn test_hover_through_expr_in_macro_recursive() {
2020-07-08 22:07:32 +00:00
check(
r#"
macro_rules! id_deep { ($($tt:tt)*) => { $($tt)* } }
macro_rules! id { ($($tt:tt)*) => { id_deep!($($tt)*) } }
2021-01-06 20:15:48 +00:00
fn foo(bar:u32) { let a = id!(ba$0r); }
2020-07-08 22:07:32 +00:00
"#,
expect![[r#"
2020-07-09 08:30:47 +00:00
*bar*
2020-07-31 02:34:49 +00:00
```rust
bar: u32
```
2020-07-08 22:07:32 +00:00
"#]],
);
}
2020-02-28 14:53:59 +00:00
#[test]
fn test_hover_through_func_in_macro_recursive() {
2020-07-08 22:07:32 +00:00
check(
r#"
macro_rules! id_deep { ($($tt:tt)*) => { $($tt)* } }
macro_rules! id { ($($tt:tt)*) => { id_deep!($($tt)*) } }
fn bar() -> u32 { 0 }
2021-01-06 20:15:48 +00:00
fn foo() { let a = id!([0u32, bar($0)] ); }
2020-07-08 22:07:32 +00:00
"#,
expect![[r#"
2020-07-09 08:30:47 +00:00
*bar()*
2020-07-08 22:07:32 +00:00
```rust
u32
```
"#]],
2020-02-28 14:53:59 +00:00
);
}
2020-02-26 16:12:26 +00:00
#[test]
fn test_hover_through_literal_string_in_macro() {
2020-07-08 22:07:32 +00:00
check(
2020-02-26 16:12:26 +00:00
r#"
2020-07-08 22:07:32 +00:00
macro_rules! arr { ($($tt:tt)*) => { [$($tt)*)] } }
fn foo() {
let mastered_for_itunes = "";
2021-01-06 20:15:48 +00:00
let _ = arr!("Tr$0acks", &mastered_for_itunes);
2020-07-08 22:07:32 +00:00
}
"#,
expect![[r#"
2020-07-09 08:30:47 +00:00
*"Tracks"*
2020-07-08 22:07:32 +00:00
```rust
&str
```
"#]],
2020-02-26 16:12:26 +00:00
);
}
2020-03-11 15:14:15 +00:00
#[test]
fn test_hover_through_assert_macro() {
2020-07-08 22:07:32 +00:00
check(
2020-03-11 15:14:15 +00:00
r#"
2020-07-08 22:07:32 +00:00
#[rustc_builtin_macro]
macro_rules! assert {}
2020-03-11 15:14:15 +00:00
2020-07-08 22:07:32 +00:00
fn bar() -> bool { true }
fn foo() {
2021-01-06 20:15:48 +00:00
assert!(ba$0r());
2020-07-08 22:07:32 +00:00
}
"#,
expect![[r#"
2020-07-09 08:30:47 +00:00
*bar*
2020-07-31 02:34:49 +00:00
```rust
2020-07-31 02:34:49 +00:00
test
```
2020-07-31 02:34:49 +00:00
```rust
2020-07-08 22:07:32 +00:00
fn bar() -> bool
```
2020-07-08 22:07:32 +00:00
"#]],
2020-03-11 15:14:15 +00:00
);
}
2020-02-27 15:03:18 +00:00
#[test]
fn test_hover_through_literal_string_in_builtin_macro() {
check_hover_no_result(
r#"
#[rustc_builtin_macro]
2020-03-11 15:08:12 +00:00
macro_rules! format {}
2020-02-27 15:03:18 +00:00
fn foo() {
2021-01-06 20:15:48 +00:00
format!("hel$0lo {}", 0);
2020-02-27 15:03:18 +00:00
}
2021-08-02 15:10:36 +00:00
"#,
2020-02-27 15:03:18 +00:00
);
}
#[test]
fn test_hover_non_ascii_space_doc() {
2020-07-08 22:07:32 +00:00
check(
"
2020-07-08 22:07:32 +00:00
/// <- `\u{3000}` here
fn foo() { }
2021-01-06 20:15:48 +00:00
fn bar() { fo$0o(); }
2020-07-08 22:07:32 +00:00
",
expect![[r#"
2020-07-09 08:30:47 +00:00
*foo*
2020-07-31 02:34:49 +00:00
```rust
2020-07-31 02:34:49 +00:00
test
```
2020-07-31 02:34:49 +00:00
```rust
2020-07-08 22:07:32 +00:00
fn foo()
```
2020-07-31 02:34:49 +00:00
---
2020-07-08 22:07:32 +00:00
2020-07-31 02:34:49 +00:00
\<- ` ` here
2020-07-08 22:07:32 +00:00
"#]],
);
}
#[test]
fn test_hover_function_show_qualifiers() {
2020-07-08 22:07:32 +00:00
check(
2021-01-06 20:15:48 +00:00
r#"async fn foo$0() {}"#,
2020-07-08 22:07:32 +00:00
expect![[r#"
2020-07-09 08:30:47 +00:00
*foo*
2020-07-31 02:34:49 +00:00
```rust
2020-07-31 02:34:49 +00:00
test
```
2020-07-31 02:34:49 +00:00
```rust
2020-07-08 22:07:32 +00:00
async fn foo()
```
2020-07-08 22:07:32 +00:00
"#]],
);
2020-07-08 22:07:32 +00:00
check(
2021-01-06 20:15:48 +00:00
r#"pub const unsafe fn foo$0() {}"#,
2020-07-08 22:07:32 +00:00
expect![[r#"
2020-07-09 08:30:47 +00:00
*foo*
2020-07-31 02:34:49 +00:00
```rust
2020-07-31 02:34:49 +00:00
test
```
2020-07-31 02:34:49 +00:00
```rust
2020-07-08 22:07:32 +00:00
pub const unsafe fn foo()
```
2020-07-08 22:07:32 +00:00
"#]],
);
2021-03-15 17:24:26 +00:00
// Top level `pub(crate)` will be displayed as no visibility.
2020-07-08 22:07:32 +00:00
check(
2021-03-15 17:24:26 +00:00
r#"mod m { pub(crate) async unsafe extern "C" fn foo$0() {} }"#,
2020-07-08 22:07:32 +00:00
expect![[r#"
2020-07-09 08:30:47 +00:00
*foo*
2020-07-31 02:34:49 +00:00
```rust
2021-03-15 17:24:26 +00:00
test::m
```
2020-07-31 02:34:49 +00:00
```rust
2020-07-08 22:07:32 +00:00
pub(crate) async unsafe extern "C" fn foo()
```
2020-07-08 22:07:32 +00:00
"#]],
);
}
2020-05-01 15:49:51 +00:00
#[test]
fn test_hover_trait_show_qualifiers() {
2020-07-08 22:07:32 +00:00
check_actions(
2021-01-06 20:15:48 +00:00
r"unsafe trait foo$0() {}",
2020-07-08 22:07:32 +00:00
expect![[r#"
[
2021-01-04 13:24:37 +00:00
Implementation(
2020-07-08 22:07:32 +00:00
FilePosition {
file_id: FileId(
2020-10-02 14:13:48 +00:00
0,
2020-07-08 22:07:32 +00:00
),
offset: 13,
},
),
]
"#]],
2020-05-01 15:49:51 +00:00
);
}
#[test]
fn test_hover_extern_crate() {
check(
r#"
2020-10-02 14:13:48 +00:00
//- /main.rs crate:main deps:std
2021-01-06 20:15:48 +00:00
extern crate st$0d;
2020-10-02 14:13:48 +00:00
//- /std/lib.rs crate:std
//! Standard library for this test
//!
//! Printed?
//! abc123
2021-08-02 15:10:36 +00:00
"#,
expect![[r#"
2021-03-15 17:24:26 +00:00
*std*
```rust
extern crate std
```
2021-03-15 17:24:26 +00:00
---
Standard library for this test
Printed?
abc123
"#]],
);
check(
r#"
2020-10-02 14:13:48 +00:00
//- /main.rs crate:main deps:std
2021-01-06 20:15:48 +00:00
extern crate std as ab$0c;
2020-10-02 14:13:48 +00:00
//- /std/lib.rs crate:std
//! Standard library for this test
//!
//! Printed?
//! abc123
2021-08-02 15:10:36 +00:00
"#,
expect![[r#"
2021-03-15 17:24:26 +00:00
*abc*
2021-03-15 17:24:26 +00:00
```rust
extern crate std
```
---
Standard library for this test
Printed?
abc123
"#]],
);
}
#[test]
fn test_hover_mod_with_same_name_as_function() {
2020-07-08 22:07:32 +00:00
check(
r#"
2021-01-06 20:15:48 +00:00
use self::m$0y::Bar;
2020-07-08 22:07:32 +00:00
mod my { pub struct Bar; }
2020-07-08 22:07:32 +00:00
fn my() {}
"#,
expect![[r#"
2020-07-09 08:30:47 +00:00
*my*
2020-07-31 02:34:49 +00:00
```rust
2020-07-31 02:34:49 +00:00
test
```
2020-07-31 02:34:49 +00:00
```rust
2020-07-08 22:07:32 +00:00
mod my
```
2020-07-08 22:07:32 +00:00
"#]],
);
}
#[test]
fn test_hover_struct_doc_comment() {
2020-07-08 22:07:32 +00:00
check(
r#"
/// This is an example
/// multiline doc
///
/// # Example
///
/// ```
/// let five = 5;
///
/// assert_eq!(6, my_crate::add_one(5));
/// ```
2020-07-08 22:07:32 +00:00
struct Bar;
2021-01-06 20:15:48 +00:00
fn foo() { let bar = Ba$0r; }
2020-07-08 22:07:32 +00:00
"#,
expect![[r##"
2020-07-09 08:30:47 +00:00
*Bar*
2020-07-31 02:34:49 +00:00
```rust
2020-07-31 02:34:49 +00:00
test
```
2020-07-31 02:34:49 +00:00
```rust
2020-07-08 22:07:32 +00:00
struct Bar
```
2020-07-31 02:34:49 +00:00
---
2020-07-08 22:07:32 +00:00
This is an example
multiline doc
# Example
```
let five = 5;
assert_eq!(6, my_crate::add_one(5));
```
"##]],
);
}
#[test]
fn test_hover_struct_doc_attr() {
2020-07-08 22:07:32 +00:00
check(
r#"
2020-07-08 22:07:32 +00:00
#[doc = "bar docs"]
struct Bar;
2021-01-06 20:15:48 +00:00
fn foo() { let bar = Ba$0r; }
2020-07-08 22:07:32 +00:00
"#,
expect![[r#"
2020-07-09 08:30:47 +00:00
*Bar*
2020-07-31 02:34:49 +00:00
```rust
2020-07-31 02:34:49 +00:00
test
```
2020-07-31 02:34:49 +00:00
```rust
2020-07-08 22:07:32 +00:00
struct Bar
```
2020-07-31 02:34:49 +00:00
---
2020-07-08 22:07:32 +00:00
bar docs
"#]],
);
}
#[test]
fn test_hover_struct_doc_attr_multiple_and_mixed() {
2020-07-08 22:07:32 +00:00
check(
r#"
2020-07-08 22:07:32 +00:00
/// bar docs 0
#[doc = "bar docs 1"]
#[doc = "bar docs 2"]
struct Bar;
2021-01-06 20:15:48 +00:00
fn foo() { let bar = Ba$0r; }
2020-07-08 22:07:32 +00:00
"#,
expect![[r#"
2020-07-09 08:30:47 +00:00
*Bar*
2020-07-31 02:34:49 +00:00
```rust
2020-07-31 02:34:49 +00:00
test
```
2020-07-31 02:34:49 +00:00
```rust
2020-07-08 22:07:32 +00:00
struct Bar
```
2020-07-31 02:34:49 +00:00
---
2020-07-08 22:07:32 +00:00
bar docs 0
bar docs 1
bar docs 2
"#]],
);
}
2020-06-15 02:47:33 +00:00
#[test]
fn test_hover_external_url() {
2020-07-31 02:28:33 +00:00
check(
2020-08-26 16:36:16 +00:00
r#"
pub struct Foo;
/// [external](https://www.google.com)
2021-01-06 20:15:48 +00:00
pub struct B$0ar
2020-08-26 16:36:16 +00:00
"#,
2020-07-31 02:34:49 +00:00
expect![[r#"
*Bar*
```rust
2020-07-31 02:34:49 +00:00
test
```
2020-07-31 02:34:49 +00:00
```rust
2020-07-31 02:34:49 +00:00
pub struct Bar
```
2020-07-31 02:34:49 +00:00
---
[external](https://www.google.com)
"#]],
2020-06-15 02:47:33 +00:00
);
}
// Check that we don't rewrite links which we can't identify
#[test]
fn test_hover_unknown_target() {
2020-07-31 02:28:33 +00:00
check(
2020-08-26 16:36:16 +00:00
r#"
pub struct Foo;
/// [baz](Baz)
2021-01-06 20:15:48 +00:00
pub struct B$0ar
2020-08-26 16:36:16 +00:00
"#,
2020-07-31 02:34:49 +00:00
expect![[r#"
*Bar*
```rust
2020-07-31 02:34:49 +00:00
test
```
2020-07-31 02:34:49 +00:00
```rust
2020-07-31 02:34:49 +00:00
pub struct Bar
```
2020-07-31 02:34:49 +00:00
---
[baz](Baz)
"#]],
);
}
#[test]
fn test_hover_no_links() {
check_hover_no_links(
r#"
/// Test cases:
/// case 1. bare URL: https://www.example.com/
/// case 2. inline URL with title: [example](https://www.example.com/)
2021-01-08 14:46:48 +00:00
/// case 3. code reference: [`Result`]
/// case 4. code reference but miss footnote: [`String`]
/// case 5. autolink: <http://www.example.com/>
/// case 6. email address: <test@example.com>
2021-01-08 14:46:48 +00:00
/// case 7. reference: [example][example]
/// case 8. collapsed link: [example][]
/// case 9. shortcut link: [example]
/// case 10. inline without URL: [example]()
2021-01-08 14:46:48 +00:00
/// case 11. reference: [foo][foo]
/// case 12. reference: [foo][bar]
/// case 13. collapsed link: [foo][]
/// case 14. shortcut link: [foo]
/// case 15. inline without URL: [foo]()
/// case 16. just escaped text: \[foo]
/// case 17. inline link: [Foo](foo::Foo)
///
/// [`Result`]: ../../std/result/enum.Result.html
/// [^example]: https://www.example.com/
2021-01-06 20:15:48 +00:00
pub fn fo$0o() {}
"#,
expect![[r#"
*foo*
```rust
test
```
```rust
pub fn foo()
```
---
Test cases:
case 1. bare URL: https://www.example.com/
case 2. inline URL with title: [example](https://www.example.com/)
2021-01-08 14:46:48 +00:00
case 3. code reference: `Result`
case 4. code reference but miss footnote: `String`
case 5. autolink: http://www.example.com/
case 6. email address: test@example.com
2021-01-08 14:46:48 +00:00
case 7. reference: example
case 8. collapsed link: example
case 9. shortcut link: example
case 10. inline without URL: example
2021-01-08 14:46:48 +00:00
case 11. reference: foo
case 12. reference: foo
case 13. collapsed link: foo
case 14. shortcut link: foo
case 15. inline without URL: foo
2021-06-18 18:36:12 +00:00
case 16. just escaped text: \[foo\]
case 17. inline link: Foo
[^example]: https://www.example.com/
"#]],
);
}
#[test]
fn test_hover_macro_generated_struct_fn_doc_comment() {
2021-03-08 20:19:44 +00:00
cov_mark::check!(hover_macro_generated_struct_fn_doc_comment);
2020-06-08 10:56:31 +00:00
2020-07-08 22:07:32 +00:00
check(
r#"
2020-07-08 22:07:32 +00:00
macro_rules! bar {
() => {
struct Bar;
impl Bar {
/// Do the foo
fn foo(&self) {}
}
}
}
2020-07-08 22:07:32 +00:00
bar!();
2021-01-06 20:15:48 +00:00
fn foo() { let bar = Bar; bar.fo$0o(); }
2020-07-08 22:07:32 +00:00
"#,
expect![[r#"
2020-07-09 08:30:47 +00:00
*foo*
2020-07-08 22:07:32 +00:00
```rust
2020-07-31 02:34:49 +00:00
test::Bar
```
2020-07-31 02:34:49 +00:00
```rust
2020-07-08 22:07:32 +00:00
fn foo(&self)
```
2020-07-31 02:34:49 +00:00
---
2020-07-08 22:07:32 +00:00
2020-07-31 02:34:49 +00:00
Do the foo
2020-07-08 22:07:32 +00:00
"#]],
);
}
#[test]
fn test_hover_macro_generated_struct_fn_doc_attr() {
2021-03-08 20:19:44 +00:00
cov_mark::check!(hover_macro_generated_struct_fn_doc_attr);
2020-06-08 10:56:31 +00:00
2020-07-08 22:07:32 +00:00
check(
r#"
2020-07-08 22:07:32 +00:00
macro_rules! bar {
() => {
struct Bar;
impl Bar {
#[doc = "Do the foo"]
fn foo(&self) {}
}
}
}
2020-07-08 22:07:32 +00:00
bar!();
2021-01-06 20:15:48 +00:00
fn foo() { let bar = Bar; bar.fo$0o(); }
2020-07-08 22:07:32 +00:00
"#,
expect![[r#"
2020-07-09 08:30:47 +00:00
*foo*
2020-07-08 22:07:32 +00:00
```rust
2020-07-31 02:34:49 +00:00
test::Bar
```
2020-07-31 02:34:49 +00:00
```rust
2020-07-08 22:07:32 +00:00
fn foo(&self)
```
2020-07-31 02:34:49 +00:00
---
2020-07-08 22:07:32 +00:00
Do the foo
"#]],
);
}
2020-06-03 11:15:54 +00:00
#[test]
2020-06-03 12:13:26 +00:00
fn test_hover_trait_has_impl_action() {
2020-07-08 22:07:32 +00:00
check_actions(
2021-01-06 20:15:48 +00:00
r#"trait foo$0() {}"#,
2020-07-08 22:07:32 +00:00
expect![[r#"
[
2021-01-04 13:24:37 +00:00
Implementation(
2020-07-08 22:07:32 +00:00
FilePosition {
file_id: FileId(
2020-10-02 14:13:48 +00:00
0,
2020-07-08 22:07:32 +00:00
),
offset: 6,
},
),
]
"#]],
2020-06-03 11:15:54 +00:00
);
}
#[test]
2020-06-03 12:13:26 +00:00
fn test_hover_struct_has_impl_action() {
2020-07-08 22:07:32 +00:00
check_actions(
2021-01-06 20:15:48 +00:00
r"struct foo$0() {}",
2020-07-08 22:07:32 +00:00
expect![[r#"
[
2021-01-04 13:24:37 +00:00
Implementation(
2020-07-08 22:07:32 +00:00
FilePosition {
file_id: FileId(
2020-10-02 14:13:48 +00:00
0,
2020-07-08 22:07:32 +00:00
),
offset: 7,
},
),
]
"#]],
2020-06-03 11:15:54 +00:00
);
}
#[test]
2020-06-03 12:13:26 +00:00
fn test_hover_union_has_impl_action() {
2020-07-08 22:07:32 +00:00
check_actions(
2021-01-06 20:15:48 +00:00
r#"union foo$0() {}"#,
2020-07-08 22:07:32 +00:00
expect![[r#"
[
2021-01-04 13:24:37 +00:00
Implementation(
2020-07-08 22:07:32 +00:00
FilePosition {
2020-06-06 11:30:29 +00:00
file_id: FileId(
2020-10-02 14:13:48 +00:00
0,
2020-06-06 11:30:29 +00:00
),
2020-07-08 22:07:32 +00:00
offset: 6,
2020-06-06 11:30:29 +00:00
},
2020-07-08 22:07:32 +00:00
),
]
"#]],
2020-06-03 11:15:54 +00:00
);
}
2020-06-03 12:29:03 +00:00
#[test]
fn test_hover_enum_has_impl_action() {
2020-07-08 22:07:32 +00:00
check_actions(
2021-01-06 20:15:48 +00:00
r"enum foo$0() { A, B }",
2020-07-08 22:07:32 +00:00
expect![[r#"
[
2021-01-04 13:24:37 +00:00
Implementation(
2020-07-08 22:07:32 +00:00
FilePosition {
2020-06-06 11:30:29 +00:00
file_id: FileId(
2020-10-02 14:13:48 +00:00
0,
2020-06-06 11:30:29 +00:00
),
2020-07-08 22:07:32 +00:00
offset: 5,
2020-06-06 11:30:29 +00:00
},
2020-07-08 22:07:32 +00:00
),
]
"#]],
2020-06-03 12:29:03 +00:00
);
}
2020-06-06 11:30:29 +00:00
#[test]
fn test_hover_self_has_impl_action() {
check_actions(
2021-01-06 20:15:48 +00:00
r#"struct foo where Self$0:;"#,
expect![[r#"
[
Implementation(
FilePosition {
file_id: FileId(
0,
),
offset: 7,
},
),
]
"#]],
);
}
2020-06-06 11:30:29 +00:00
#[test]
fn test_hover_test_has_action() {
2020-07-08 22:07:32 +00:00
check_actions(
r#"
#[test]
2021-01-06 20:15:48 +00:00
fn foo_$0test() {}
2020-07-08 22:07:32 +00:00
"#,
expect![[r#"
[
2021-06-04 13:49:43 +00:00
Reference(
FilePosition {
file_id: FileId(
0,
),
offset: 11,
},
),
2020-07-08 22:07:32 +00:00
Runnable(
Runnable {
use_name_in_title: false,
nav: NavigationTarget {
file_id: FileId(
2020-10-02 14:13:48 +00:00
0,
),
2020-07-08 22:07:32 +00:00
full_range: 0..24,
2020-12-18 18:26:47 +00:00
focus_range: 11..19,
2020-07-17 10:42:48 +00:00
name: "foo_test",
2020-12-18 18:26:47 +00:00
kind: Function,
},
2020-07-08 22:07:32 +00:00
kind: Test {
test_id: Path(
"foo_test",
),
attr: TestAttr {
ignore: false,
},
2020-06-06 11:30:29 +00:00
},
2020-10-22 17:19:18 +00:00
cfg: None,
2020-06-06 11:30:29 +00:00
},
2020-07-08 22:07:32 +00:00
),
]
"#]],
);
2020-06-06 11:30:29 +00:00
}
#[test]
fn test_hover_test_mod_has_action() {
2020-07-08 22:07:32 +00:00
check_actions(
r#"
2021-01-06 20:15:48 +00:00
mod tests$0 {
2020-07-08 22:07:32 +00:00
#[test]
fn foo_test() {}
}
"#,
expect![[r#"
[
Runnable(
Runnable {
use_name_in_title: false,
nav: NavigationTarget {
file_id: FileId(
2020-10-02 14:13:48 +00:00
0,
),
2020-07-08 22:07:32 +00:00
full_range: 0..46,
2020-12-18 18:26:47 +00:00
focus_range: 4..9,
2020-07-17 10:42:48 +00:00
name: "tests",
2020-12-18 18:26:47 +00:00
kind: Module,
description: "mod tests",
},
2020-07-08 22:07:32 +00:00
kind: TestMod {
path: "tests",
},
2020-10-22 17:19:18 +00:00
cfg: None,
2020-06-06 11:30:29 +00:00
},
2020-07-08 22:07:32 +00:00
),
]
"#]],
);
2020-06-06 11:30:29 +00:00
}
#[test]
fn test_hover_struct_has_goto_type_action() {
2020-07-08 22:07:32 +00:00
check_actions(
r#"
struct S{ f1: u32 }
2021-01-06 20:15:48 +00:00
fn main() { let s$0t = S{ f1:0 }; }
2021-08-02 15:10:36 +00:00
"#,
2020-07-08 22:07:32 +00:00
expect![[r#"
2020-06-30 08:23:06 +00:00
[
2020-07-08 22:07:32 +00:00
GoToType(
[
HoverGotoTypeData {
2020-07-31 02:34:49 +00:00
mod_path: "test::S",
2020-07-08 22:07:32 +00:00
nav: NavigationTarget {
file_id: FileId(
2020-10-02 14:13:48 +00:00
0,
2020-07-08 22:07:32 +00:00
),
full_range: 0..19,
2020-12-18 18:26:47 +00:00
focus_range: 7..8,
2020-07-17 10:42:48 +00:00
name: "S",
2020-12-18 18:26:47 +00:00
kind: Struct,
description: "struct S",
2020-07-08 22:07:32 +00:00
},
},
],
),
]
"#]],
);
}
#[test]
fn test_hover_generic_struct_has_goto_type_actions() {
2020-07-08 22:07:32 +00:00
check_actions(
r#"
struct Arg(u32);
struct S<T>{ f1: T }
2021-01-06 20:15:48 +00:00
fn main() { let s$0t = S{ f1:Arg(0) }; }
2020-07-08 22:07:32 +00:00
"#,
expect![[r#"
2020-06-30 08:23:06 +00:00
[
2020-07-08 22:07:32 +00:00
GoToType(
[
HoverGotoTypeData {
2020-07-31 02:34:49 +00:00
mod_path: "test::S",
2020-07-08 22:07:32 +00:00
nav: NavigationTarget {
file_id: FileId(
2020-10-02 14:13:48 +00:00
0,
2020-07-08 22:07:32 +00:00
),
full_range: 17..37,
2020-12-18 18:26:47 +00:00
focus_range: 24..25,
2020-07-17 10:42:48 +00:00
name: "S",
2020-12-18 18:26:47 +00:00
kind: Struct,
2021-03-15 17:24:26 +00:00
description: "struct S<T>",
2020-07-08 22:07:32 +00:00
},
},
2020-07-08 22:07:32 +00:00
HoverGotoTypeData {
2020-07-31 02:34:49 +00:00
mod_path: "test::Arg",
2020-07-08 22:07:32 +00:00
nav: NavigationTarget {
file_id: FileId(
2020-10-02 14:13:48 +00:00
0,
2020-07-08 22:07:32 +00:00
),
full_range: 0..16,
2020-12-18 18:26:47 +00:00
focus_range: 7..10,
2020-07-17 10:42:48 +00:00
name: "Arg",
2020-12-18 18:26:47 +00:00
kind: Struct,
description: "struct Arg",
2020-07-08 22:07:32 +00:00
},
},
2020-07-08 22:07:32 +00:00
],
),
]
"#]],
);
}
#[test]
fn test_hover_generic_struct_has_flattened_goto_type_actions() {
2020-07-08 22:07:32 +00:00
check_actions(
r#"
struct Arg(u32);
struct S<T>{ f1: T }
2021-01-06 20:15:48 +00:00
fn main() { let s$0t = S{ f1: S{ f1: Arg(0) } }; }
2021-08-02 15:10:36 +00:00
"#,
2020-07-08 22:07:32 +00:00
expect![[r#"
2020-06-30 08:23:06 +00:00
[
2020-07-08 22:07:32 +00:00
GoToType(
[
HoverGotoTypeData {
2020-07-31 02:34:49 +00:00
mod_path: "test::S",
2020-07-08 22:07:32 +00:00
nav: NavigationTarget {
file_id: FileId(
2020-10-02 14:13:48 +00:00
0,
2020-07-08 22:07:32 +00:00
),
full_range: 17..37,
2020-12-18 18:26:47 +00:00
focus_range: 24..25,
2020-07-17 10:42:48 +00:00
name: "S",
2020-12-18 18:26:47 +00:00
kind: Struct,
2021-03-15 17:24:26 +00:00
description: "struct S<T>",
2020-07-08 22:07:32 +00:00
},
},
HoverGotoTypeData {
2020-07-31 02:34:49 +00:00
mod_path: "test::Arg",
2020-07-08 22:07:32 +00:00
nav: NavigationTarget {
file_id: FileId(
2020-10-02 14:13:48 +00:00
0,
2020-07-08 22:07:32 +00:00
),
full_range: 0..16,
2020-12-18 18:26:47 +00:00
focus_range: 7..10,
2020-07-17 10:42:48 +00:00
name: "Arg",
2020-12-18 18:26:47 +00:00
kind: Struct,
description: "struct Arg",
2020-07-08 22:07:32 +00:00
},
},
],
),
]
"#]],
);
}
#[test]
fn test_hover_tuple_has_goto_type_actions() {
2020-07-08 22:07:32 +00:00
check_actions(
r#"
struct A(u32);
struct B(u32);
mod M {
pub struct C(u32);
}
2021-01-06 20:15:48 +00:00
fn main() { let s$0t = (A(1), B(2), M::C(3) ); }
2020-07-08 22:07:32 +00:00
"#,
expect![[r#"
[
GoToType(
[
HoverGotoTypeData {
2020-07-31 02:34:49 +00:00
mod_path: "test::A",
2020-07-08 22:07:32 +00:00
nav: NavigationTarget {
file_id: FileId(
2020-10-02 14:13:48 +00:00
0,
2020-07-08 22:07:32 +00:00
),
full_range: 0..14,
2020-12-18 18:26:47 +00:00
focus_range: 7..8,
2020-07-17 10:42:48 +00:00
name: "A",
2020-12-18 18:26:47 +00:00
kind: Struct,
description: "struct A",
2020-07-08 22:07:32 +00:00
},
},
2020-07-08 22:07:32 +00:00
HoverGotoTypeData {
2020-07-31 02:34:49 +00:00
mod_path: "test::B",
2020-07-08 22:07:32 +00:00
nav: NavigationTarget {
file_id: FileId(
2020-10-02 14:13:48 +00:00
0,
2020-07-08 22:07:32 +00:00
),
full_range: 15..29,
2020-12-18 18:26:47 +00:00
focus_range: 22..23,
2020-07-17 10:42:48 +00:00
name: "B",
2020-12-18 18:26:47 +00:00
kind: Struct,
description: "struct B",
2020-07-08 22:07:32 +00:00
},
},
2020-07-08 22:07:32 +00:00
HoverGotoTypeData {
2020-07-31 02:34:49 +00:00
mod_path: "test::M::C",
2020-07-08 22:07:32 +00:00
nav: NavigationTarget {
file_id: FileId(
2020-10-02 14:13:48 +00:00
0,
2020-07-08 22:07:32 +00:00
),
full_range: 42..60,
2020-12-18 18:26:47 +00:00
focus_range: 53..54,
2020-07-17 10:42:48 +00:00
name: "C",
2020-12-18 18:26:47 +00:00
kind: Struct,
description: "pub struct C",
2020-07-08 22:07:32 +00:00
},
},
2020-07-08 22:07:32 +00:00
],
),
]
"#]],
);
}
#[test]
fn test_hover_return_impl_trait_has_goto_type_action() {
2020-07-08 22:07:32 +00:00
check_actions(
r#"
trait Foo {}
fn foo() -> impl Foo {}
2021-01-06 20:15:48 +00:00
fn main() { let s$0t = foo(); }
2020-07-08 22:07:32 +00:00
"#,
expect![[r#"
2020-06-30 08:23:06 +00:00
[
2020-07-08 22:07:32 +00:00
GoToType(
[
HoverGotoTypeData {
2020-07-31 02:34:49 +00:00
mod_path: "test::Foo",
2020-07-08 22:07:32 +00:00
nav: NavigationTarget {
file_id: FileId(
2020-10-02 14:13:48 +00:00
0,
2020-07-08 22:07:32 +00:00
),
full_range: 0..12,
2020-12-18 18:26:47 +00:00
focus_range: 6..9,
2020-07-17 10:42:48 +00:00
name: "Foo",
2020-12-18 18:26:47 +00:00
kind: Trait,
description: "trait Foo",
2020-07-08 22:07:32 +00:00
},
},
2020-07-08 22:07:32 +00:00
],
),
]
"#]],
);
}
#[test]
fn test_hover_generic_return_impl_trait_has_goto_type_action() {
2020-07-08 22:07:32 +00:00
check_actions(
r#"
trait Foo<T> {}
struct S;
fn foo() -> impl Foo<S> {}
2021-01-06 20:15:48 +00:00
fn main() { let s$0t = foo(); }
2020-07-08 22:07:32 +00:00
"#,
expect![[r#"
2020-06-30 08:23:06 +00:00
[
2020-07-08 22:07:32 +00:00
GoToType(
[
HoverGotoTypeData {
2020-07-31 02:34:49 +00:00
mod_path: "test::Foo",
2020-07-08 22:07:32 +00:00
nav: NavigationTarget {
file_id: FileId(
2020-10-02 14:13:48 +00:00
0,
2020-07-08 22:07:32 +00:00
),
full_range: 0..15,
2020-12-18 18:26:47 +00:00
focus_range: 6..9,
2020-07-17 10:42:48 +00:00
name: "Foo",
2020-12-18 18:26:47 +00:00
kind: Trait,
2021-03-15 17:24:26 +00:00
description: "trait Foo<T>",
2020-07-08 22:07:32 +00:00
},
},
2020-07-08 22:07:32 +00:00
HoverGotoTypeData {
2020-07-31 02:34:49 +00:00
mod_path: "test::S",
2020-07-08 22:07:32 +00:00
nav: NavigationTarget {
file_id: FileId(
2020-10-02 14:13:48 +00:00
0,
2020-07-08 22:07:32 +00:00
),
full_range: 16..25,
2020-12-18 18:26:47 +00:00
focus_range: 23..24,
2020-07-17 10:42:48 +00:00
name: "S",
2020-12-18 18:26:47 +00:00
kind: Struct,
description: "struct S",
2020-07-08 22:07:32 +00:00
},
},
2020-07-08 22:07:32 +00:00
],
),
]
"#]],
);
}
2020-06-11 20:06:58 +00:00
#[test]
fn test_hover_return_impl_traits_has_goto_type_action() {
2020-07-08 22:07:32 +00:00
check_actions(
r#"
trait Foo {}
trait Bar {}
fn foo() -> impl Foo + Bar {}
2020-06-11 20:06:58 +00:00
2021-01-06 20:15:48 +00:00
fn main() { let s$0t = foo(); }
2021-08-02 15:10:36 +00:00
"#,
2020-07-08 22:07:32 +00:00
expect![[r#"
2020-06-30 08:23:06 +00:00
[
2020-07-08 22:07:32 +00:00
GoToType(
[
HoverGotoTypeData {
2020-07-31 02:34:49 +00:00
mod_path: "test::Foo",
2020-07-08 22:07:32 +00:00
nav: NavigationTarget {
file_id: FileId(
2020-10-02 14:13:48 +00:00
0,
2020-07-08 22:07:32 +00:00
),
full_range: 0..12,
2020-12-18 18:26:47 +00:00
focus_range: 6..9,
2020-07-17 10:42:48 +00:00
name: "Foo",
2020-12-18 18:26:47 +00:00
kind: Trait,
description: "trait Foo",
2020-07-08 22:07:32 +00:00
},
2020-06-11 20:06:58 +00:00
},
2020-07-08 22:07:32 +00:00
HoverGotoTypeData {
2020-07-31 02:34:49 +00:00
mod_path: "test::Bar",
2020-07-08 22:07:32 +00:00
nav: NavigationTarget {
file_id: FileId(
2020-10-02 14:13:48 +00:00
0,
2020-07-08 22:07:32 +00:00
),
full_range: 13..25,
2020-12-18 18:26:47 +00:00
focus_range: 19..22,
2020-07-17 10:42:48 +00:00
name: "Bar",
2020-12-18 18:26:47 +00:00
kind: Trait,
description: "trait Bar",
2020-07-08 22:07:32 +00:00
},
2020-06-11 20:06:58 +00:00
},
2020-07-08 22:07:32 +00:00
],
),
]
"#]],
);
2020-06-11 20:06:58 +00:00
}
#[test]
fn test_hover_generic_return_impl_traits_has_goto_type_action() {
2020-07-08 22:07:32 +00:00
check_actions(
r#"
trait Foo<T> {}
trait Bar<T> {}
struct S1 {}
struct S2 {}
2020-06-11 20:06:58 +00:00
2020-07-08 22:07:32 +00:00
fn foo() -> impl Foo<S1> + Bar<S2> {}
2020-06-11 20:06:58 +00:00
2021-01-06 20:15:48 +00:00
fn main() { let s$0t = foo(); }
2020-07-08 22:07:32 +00:00
"#,
expect![[r#"
2020-06-30 08:23:06 +00:00
[
2020-07-08 22:07:32 +00:00
GoToType(
[
HoverGotoTypeData {
2020-07-31 02:34:49 +00:00
mod_path: "test::Foo",
2020-07-08 22:07:32 +00:00
nav: NavigationTarget {
file_id: FileId(
2020-10-02 14:13:48 +00:00
0,
2020-07-08 22:07:32 +00:00
),
full_range: 0..15,
2020-12-18 18:26:47 +00:00
focus_range: 6..9,
2020-07-17 10:42:48 +00:00
name: "Foo",
2020-12-18 18:26:47 +00:00
kind: Trait,
2021-03-15 17:24:26 +00:00
description: "trait Foo<T>",
2020-07-08 22:07:32 +00:00
},
2020-06-11 20:06:58 +00:00
},
2020-07-08 22:07:32 +00:00
HoverGotoTypeData {
2020-07-31 02:34:49 +00:00
mod_path: "test::Bar",
2020-07-08 22:07:32 +00:00
nav: NavigationTarget {
file_id: FileId(
2020-10-02 14:13:48 +00:00
0,
2020-07-08 22:07:32 +00:00
),
full_range: 16..31,
2020-12-18 18:26:47 +00:00
focus_range: 22..25,
2020-07-17 10:42:48 +00:00
name: "Bar",
2020-12-18 18:26:47 +00:00
kind: Trait,
2021-03-15 17:24:26 +00:00
description: "trait Bar<T>",
2020-07-08 22:07:32 +00:00
},
2020-06-11 20:06:58 +00:00
},
2020-07-08 22:07:32 +00:00
HoverGotoTypeData {
2020-07-31 02:34:49 +00:00
mod_path: "test::S1",
2020-07-08 22:07:32 +00:00
nav: NavigationTarget {
file_id: FileId(
2020-10-02 14:13:48 +00:00
0,
2020-07-08 22:07:32 +00:00
),
full_range: 32..44,
2020-12-18 18:26:47 +00:00
focus_range: 39..41,
2020-07-17 10:42:48 +00:00
name: "S1",
2020-12-18 18:26:47 +00:00
kind: Struct,
description: "struct S1",
2020-07-08 22:07:32 +00:00
},
2020-06-11 20:06:58 +00:00
},
2020-07-08 22:07:32 +00:00
HoverGotoTypeData {
2020-07-31 02:34:49 +00:00
mod_path: "test::S2",
2020-07-08 22:07:32 +00:00
nav: NavigationTarget {
file_id: FileId(
2020-10-02 14:13:48 +00:00
0,
2020-07-08 22:07:32 +00:00
),
full_range: 45..57,
2020-12-18 18:26:47 +00:00
focus_range: 52..54,
2020-07-17 10:42:48 +00:00
name: "S2",
2020-12-18 18:26:47 +00:00
kind: Struct,
description: "struct S2",
2020-07-08 22:07:32 +00:00
},
2020-06-11 20:06:58 +00:00
},
2020-07-08 22:07:32 +00:00
],
),
]
"#]],
);
2020-06-11 20:06:58 +00:00
}
#[test]
fn test_hover_arg_impl_trait_has_goto_type_action() {
2020-07-08 22:07:32 +00:00
check_actions(
r#"
trait Foo {}
2021-01-06 20:15:48 +00:00
fn foo(ar$0g: &impl Foo) {}
2020-07-08 22:07:32 +00:00
"#,
expect![[r#"
2020-06-30 08:23:06 +00:00
[
2020-07-08 22:07:32 +00:00
GoToType(
[
HoverGotoTypeData {
2020-07-31 02:34:49 +00:00
mod_path: "test::Foo",
2020-07-08 22:07:32 +00:00
nav: NavigationTarget {
file_id: FileId(
2020-10-02 14:13:48 +00:00
0,
2020-07-08 22:07:32 +00:00
),
full_range: 0..12,
2020-12-18 18:26:47 +00:00
focus_range: 6..9,
2020-07-17 10:42:48 +00:00
name: "Foo",
2020-12-18 18:26:47 +00:00
kind: Trait,
description: "trait Foo",
2020-07-08 22:07:32 +00:00
},
},
2020-07-08 22:07:32 +00:00
],
),
]
"#]],
);
}
2020-06-11 20:06:58 +00:00
#[test]
fn test_hover_arg_impl_traits_has_goto_type_action() {
2020-07-08 22:07:32 +00:00
check_actions(
r#"
trait Foo {}
trait Bar<T> {}
struct S{}
2020-06-11 20:06:58 +00:00
2021-01-06 20:15:48 +00:00
fn foo(ar$0g: &impl Foo + Bar<S>) {}
2020-07-08 22:07:32 +00:00
"#,
expect![[r#"
2020-06-30 08:23:06 +00:00
[
2020-07-08 22:07:32 +00:00
GoToType(
[
HoverGotoTypeData {
2020-07-31 02:34:49 +00:00
mod_path: "test::Foo",
2020-07-08 22:07:32 +00:00
nav: NavigationTarget {
file_id: FileId(
2020-10-02 14:13:48 +00:00
0,
2020-07-08 22:07:32 +00:00
),
full_range: 0..12,
2020-12-18 18:26:47 +00:00
focus_range: 6..9,
2020-07-17 10:42:48 +00:00
name: "Foo",
2020-12-18 18:26:47 +00:00
kind: Trait,
description: "trait Foo",
2020-07-08 22:07:32 +00:00
},
2020-06-11 20:06:58 +00:00
},
2020-07-08 22:07:32 +00:00
HoverGotoTypeData {
2020-07-31 02:34:49 +00:00
mod_path: "test::Bar",
2020-07-08 22:07:32 +00:00
nav: NavigationTarget {
file_id: FileId(
2020-10-02 14:13:48 +00:00
0,
2020-07-08 22:07:32 +00:00
),
full_range: 13..28,
2020-12-18 18:26:47 +00:00
focus_range: 19..22,
2020-07-17 10:42:48 +00:00
name: "Bar",
2020-12-18 18:26:47 +00:00
kind: Trait,
2021-03-15 17:24:26 +00:00
description: "trait Bar<T>",
2020-07-08 22:07:32 +00:00
},
2020-06-11 20:06:58 +00:00
},
2020-07-08 22:07:32 +00:00
HoverGotoTypeData {
2020-07-31 02:34:49 +00:00
mod_path: "test::S",
2020-07-08 22:07:32 +00:00
nav: NavigationTarget {
file_id: FileId(
2020-10-02 14:13:48 +00:00
0,
2020-07-08 22:07:32 +00:00
),
full_range: 29..39,
2020-12-18 18:26:47 +00:00
focus_range: 36..37,
2020-07-17 10:42:48 +00:00
name: "S",
2020-12-18 18:26:47 +00:00
kind: Struct,
description: "struct S",
2020-07-08 22:07:32 +00:00
},
2020-06-11 20:06:58 +00:00
},
2020-07-08 22:07:32 +00:00
],
),
]
"#]],
);
2020-06-11 20:06:58 +00:00
}
#[test]
fn test_hover_async_block_impl_trait_has_goto_type_action() {
check_actions(
r#"
//- minicore: future
struct S;
fn foo() {
2021-01-06 20:15:48 +00:00
let fo$0o = async { S };
}
"#,
expect![[r#"
[
GoToType(
[
HoverGotoTypeData {
mod_path: "core::future::Future",
nav: NavigationTarget {
file_id: FileId(
1,
),
full_range: 254..436,
focus_range: 293..299,
name: "Future",
2020-12-18 18:26:47 +00:00
kind: Trait,
description: "pub trait Future",
},
},
HoverGotoTypeData {
mod_path: "test::S",
nav: NavigationTarget {
file_id: FileId(
2020-10-02 14:13:48 +00:00
0,
),
full_range: 0..9,
2020-12-18 18:26:47 +00:00
focus_range: 7..8,
name: "S",
2020-12-18 18:26:47 +00:00
kind: Struct,
description: "struct S",
},
},
],
),
]
"#]],
);
}
#[test]
fn test_hover_arg_generic_impl_trait_has_goto_type_action() {
2020-07-08 22:07:32 +00:00
check_actions(
r#"
trait Foo<T> {}
struct S {}
2021-01-06 20:15:48 +00:00
fn foo(ar$0g: &impl Foo<S>) {}
2020-07-08 22:07:32 +00:00
"#,
expect![[r#"
2020-06-30 08:23:06 +00:00
[
2020-07-08 22:07:32 +00:00
GoToType(
[
HoverGotoTypeData {
2020-07-31 02:34:49 +00:00
mod_path: "test::Foo",
2020-07-08 22:07:32 +00:00
nav: NavigationTarget {
file_id: FileId(
2020-10-02 14:13:48 +00:00
0,
2020-07-08 22:07:32 +00:00
),
full_range: 0..15,
2020-12-18 18:26:47 +00:00
focus_range: 6..9,
2020-07-17 10:42:48 +00:00
name: "Foo",
2020-12-18 18:26:47 +00:00
kind: Trait,
2021-03-15 17:24:26 +00:00
description: "trait Foo<T>",
2020-07-08 22:07:32 +00:00
},
},
2020-07-08 22:07:32 +00:00
HoverGotoTypeData {
2020-07-31 02:34:49 +00:00
mod_path: "test::S",
2020-07-08 22:07:32 +00:00
nav: NavigationTarget {
file_id: FileId(
2020-10-02 14:13:48 +00:00
0,
2020-07-08 22:07:32 +00:00
),
full_range: 16..27,
2020-12-18 18:26:47 +00:00
focus_range: 23..24,
2020-07-17 10:42:48 +00:00
name: "S",
2020-12-18 18:26:47 +00:00
kind: Struct,
description: "struct S",
2020-07-08 22:07:32 +00:00
},
},
2020-07-08 22:07:32 +00:00
],
),
]
"#]],
);
}
#[test]
fn test_hover_dyn_return_has_goto_type_action() {
2020-07-08 22:07:32 +00:00
check_actions(
r#"
trait Foo {}
struct S;
impl Foo for S {}
2020-07-08 22:07:32 +00:00
struct B<T>{}
fn foo() -> B<dyn Foo> {}
2021-01-06 20:15:48 +00:00
fn main() { let s$0t = foo(); }
2020-07-08 22:07:32 +00:00
"#,
expect![[r#"
[
2020-07-08 22:07:32 +00:00
GoToType(
[
HoverGotoTypeData {
2020-07-31 02:34:49 +00:00
mod_path: "test::B",
2020-07-08 22:07:32 +00:00
nav: NavigationTarget {
file_id: FileId(
2020-10-02 14:13:48 +00:00
0,
2020-07-08 22:07:32 +00:00
),
full_range: 42..55,
2020-12-18 18:26:47 +00:00
focus_range: 49..50,
2020-07-17 10:42:48 +00:00
name: "B",
2020-12-18 18:26:47 +00:00
kind: Struct,
2021-03-15 17:24:26 +00:00
description: "struct B<T>",
2020-07-08 22:07:32 +00:00
},
},
HoverGotoTypeData {
2020-07-31 02:34:49 +00:00
mod_path: "test::Foo",
2020-07-08 22:07:32 +00:00
nav: NavigationTarget {
file_id: FileId(
2020-10-02 14:13:48 +00:00
0,
2020-07-08 22:07:32 +00:00
),
full_range: 0..12,
2020-12-18 18:26:47 +00:00
focus_range: 6..9,
2020-07-17 10:42:48 +00:00
name: "Foo",
2020-12-18 18:26:47 +00:00
kind: Trait,
description: "trait Foo",
2020-07-08 22:07:32 +00:00
},
},
],
),
]
"#]],
);
}
#[test]
fn test_hover_dyn_arg_has_goto_type_action() {
2020-07-08 22:07:32 +00:00
check_actions(
r#"
trait Foo {}
2021-01-06 20:15:48 +00:00
fn foo(ar$0g: &dyn Foo) {}
2020-07-08 22:07:32 +00:00
"#,
expect![[r#"
2020-06-30 08:23:06 +00:00
[
2020-07-08 22:07:32 +00:00
GoToType(
[
HoverGotoTypeData {
2020-07-31 02:34:49 +00:00
mod_path: "test::Foo",
2020-07-08 22:07:32 +00:00
nav: NavigationTarget {
file_id: FileId(
2020-10-02 14:13:48 +00:00
0,
2020-07-08 22:07:32 +00:00
),
full_range: 0..12,
2020-12-18 18:26:47 +00:00
focus_range: 6..9,
2020-07-17 10:42:48 +00:00
name: "Foo",
2020-12-18 18:26:47 +00:00
kind: Trait,
description: "trait Foo",
2020-07-08 22:07:32 +00:00
},
},
2020-07-08 22:07:32 +00:00
],
),
]
"#]],
);
}
#[test]
fn test_hover_generic_dyn_arg_has_goto_type_action() {
2020-07-08 22:07:32 +00:00
check_actions(
r#"
trait Foo<T> {}
struct S {}
2021-01-06 20:15:48 +00:00
fn foo(ar$0g: &dyn Foo<S>) {}
2020-07-08 22:07:32 +00:00
"#,
expect![[r#"
2020-06-30 08:23:06 +00:00
[
2020-07-08 22:07:32 +00:00
GoToType(
[
HoverGotoTypeData {
2020-07-31 02:34:49 +00:00
mod_path: "test::Foo",
2020-07-08 22:07:32 +00:00
nav: NavigationTarget {
file_id: FileId(
2020-10-02 14:13:48 +00:00
0,
2020-07-08 22:07:32 +00:00
),
full_range: 0..15,
2020-12-18 18:26:47 +00:00
focus_range: 6..9,
2020-07-17 10:42:48 +00:00
name: "Foo",
2020-12-18 18:26:47 +00:00
kind: Trait,
2021-03-15 17:24:26 +00:00
description: "trait Foo<T>",
2020-07-08 22:07:32 +00:00
},
},
2020-07-08 22:07:32 +00:00
HoverGotoTypeData {
2020-07-31 02:34:49 +00:00
mod_path: "test::S",
2020-07-08 22:07:32 +00:00
nav: NavigationTarget {
file_id: FileId(
2020-10-02 14:13:48 +00:00
0,
2020-07-08 22:07:32 +00:00
),
full_range: 16..27,
2020-12-18 18:26:47 +00:00
focus_range: 23..24,
2020-07-17 10:42:48 +00:00
name: "S",
2020-12-18 18:26:47 +00:00
kind: Struct,
description: "struct S",
2020-07-08 22:07:32 +00:00
},
},
2020-07-08 22:07:32 +00:00
],
),
]
"#]],
);
}
#[test]
2020-06-10 19:56:49 +00:00
fn test_hover_goto_type_action_links_order() {
2020-07-08 22:07:32 +00:00
check_actions(
r#"
trait ImplTrait<T> {}
trait DynTrait<T> {}
struct B<T> {}
struct S {}
2020-06-10 19:56:49 +00:00
2021-01-06 20:15:48 +00:00
fn foo(a$0rg: &impl ImplTrait<B<dyn DynTrait<B<S>>>>) {}
2021-08-02 15:10:36 +00:00
"#,
2020-07-08 22:07:32 +00:00
expect![[r#"
2020-06-30 08:23:06 +00:00
[
2020-07-08 22:07:32 +00:00
GoToType(
[
HoverGotoTypeData {
2020-07-31 02:34:49 +00:00
mod_path: "test::ImplTrait",
2020-07-08 22:07:32 +00:00
nav: NavigationTarget {
file_id: FileId(
2020-10-02 14:13:48 +00:00
0,
2020-07-08 22:07:32 +00:00
),
full_range: 0..21,
2020-12-18 18:26:47 +00:00
focus_range: 6..15,
2020-07-17 10:42:48 +00:00
name: "ImplTrait",
2020-12-18 18:26:47 +00:00
kind: Trait,
2021-03-15 17:24:26 +00:00
description: "trait ImplTrait<T>",
2020-07-08 22:07:32 +00:00
},
},
2020-07-08 22:07:32 +00:00
HoverGotoTypeData {
2020-07-31 02:34:49 +00:00
mod_path: "test::B",
2020-07-08 22:07:32 +00:00
nav: NavigationTarget {
file_id: FileId(
2020-10-02 14:13:48 +00:00
0,
2020-07-08 22:07:32 +00:00
),
full_range: 43..57,
2020-12-18 18:26:47 +00:00
focus_range: 50..51,
2020-07-17 10:42:48 +00:00
name: "B",
2020-12-18 18:26:47 +00:00
kind: Struct,
2021-03-15 17:24:26 +00:00
description: "struct B<T>",
2020-07-08 22:07:32 +00:00
},
},
2020-07-08 22:07:32 +00:00
HoverGotoTypeData {
2020-07-31 02:34:49 +00:00
mod_path: "test::DynTrait",
2020-07-08 22:07:32 +00:00
nav: NavigationTarget {
file_id: FileId(
2020-10-02 14:13:48 +00:00
0,
2020-07-08 22:07:32 +00:00
),
full_range: 22..42,
2020-12-18 18:26:47 +00:00
focus_range: 28..36,
2020-07-17 10:42:48 +00:00
name: "DynTrait",
2020-12-18 18:26:47 +00:00
kind: Trait,
2021-03-15 17:24:26 +00:00
description: "trait DynTrait<T>",
2020-07-08 22:07:32 +00:00
},
},
2020-07-08 22:07:32 +00:00
HoverGotoTypeData {
2020-07-31 02:34:49 +00:00
mod_path: "test::S",
2020-07-08 22:07:32 +00:00
nav: NavigationTarget {
file_id: FileId(
2020-10-02 14:13:48 +00:00
0,
2020-07-08 22:07:32 +00:00
),
full_range: 58..69,
2020-12-18 18:26:47 +00:00
focus_range: 65..66,
2020-07-17 10:42:48 +00:00
name: "S",
2020-12-18 18:26:47 +00:00
kind: Struct,
description: "struct S",
2020-07-08 22:07:32 +00:00
},
},
2020-07-08 22:07:32 +00:00
],
),
]
"#]],
);
}
2020-06-10 19:58:25 +00:00
#[test]
fn test_hover_associated_type_has_goto_type_action() {
2020-07-08 22:07:32 +00:00
check_actions(
r#"
trait Foo {
type Item;
fn get(self) -> Self::Item {}
}
2020-06-10 19:58:25 +00:00
2020-07-08 22:07:32 +00:00
struct Bar{}
struct S{}
2020-06-10 19:58:25 +00:00
2020-07-08 22:07:32 +00:00
impl Foo for S { type Item = Bar; }
2020-06-10 19:58:25 +00:00
2020-07-08 22:07:32 +00:00
fn test() -> impl Foo { S {} }
2020-06-10 19:58:25 +00:00
2021-01-06 20:15:48 +00:00
fn main() { let s$0t = test().get(); }
2020-07-08 22:07:32 +00:00
"#,
expect![[r#"
2020-06-30 08:23:06 +00:00
[
2020-07-08 22:07:32 +00:00
GoToType(
[
HoverGotoTypeData {
2020-07-31 02:34:49 +00:00
mod_path: "test::Foo",
2020-07-08 22:07:32 +00:00
nav: NavigationTarget {
file_id: FileId(
2020-10-02 14:13:48 +00:00
0,
2020-07-08 22:07:32 +00:00
),
full_range: 0..62,
2020-12-18 18:26:47 +00:00
focus_range: 6..9,
2020-07-17 10:42:48 +00:00
name: "Foo",
2020-12-18 18:26:47 +00:00
kind: Trait,
description: "trait Foo",
2020-07-08 22:07:32 +00:00
},
2020-06-10 19:58:25 +00:00
},
2020-07-08 22:07:32 +00:00
],
),
]
"#]],
);
2020-06-10 19:58:25 +00:00
}
2020-10-02 17:59:32 +00:00
2021-01-04 14:19:09 +00:00
#[test]
fn test_hover_const_param_has_goto_type_action() {
check_actions(
r#"
struct Bar;
struct Foo<const BAR: Bar>;
2021-01-06 20:15:48 +00:00
impl<const BAR: Bar> Foo<BAR$0> {}
2021-01-04 14:19:09 +00:00
"#,
expect![[r#"
[
GoToType(
[
HoverGotoTypeData {
mod_path: "test::Bar",
nav: NavigationTarget {
file_id: FileId(
0,
),
full_range: 0..11,
focus_range: 7..10,
name: "Bar",
kind: Struct,
description: "struct Bar",
},
},
],
),
]
"#]],
);
}
2021-01-04 14:44:19 +00:00
#[test]
fn test_hover_type_param_has_goto_type_action() {
check_actions(
r#"
trait Foo {}
2021-01-06 20:15:48 +00:00
fn foo<T: Foo>(t: T$0){}
2021-01-04 14:44:19 +00:00
"#,
expect![[r#"
[
GoToType(
[
HoverGotoTypeData {
mod_path: "test::Foo",
nav: NavigationTarget {
file_id: FileId(
0,
),
full_range: 0..12,
focus_range: 6..9,
name: "Foo",
kind: Trait,
description: "trait Foo",
},
},
],
),
]
"#]],
);
}
#[test]
fn test_hover_self_has_go_to_type() {
check_actions(
r#"
struct Foo;
impl Foo {
fn foo(&self$0) {}
}
"#,
expect![[r#"
[
GoToType(
[
HoverGotoTypeData {
mod_path: "test::Foo",
nav: NavigationTarget {
file_id: FileId(
0,
),
full_range: 0..11,
focus_range: 7..10,
name: "Foo",
kind: Struct,
description: "struct Foo",
},
},
],
),
]
"#]],
);
}
2020-10-02 17:59:32 +00:00
#[test]
fn hover_displays_normalized_crate_names() {
check(
r#"
//- /lib.rs crate:name-with-dashes
pub mod wrapper {
pub struct Thing { x: u32 }
impl Thing {
pub fn new() -> Thing { Thing { x: 0 } }
}
}
//- /main.rs crate:main deps:name-with-dashes
2021-01-06 20:15:48 +00:00
fn main() { let foo_test = name_with_dashes::wrapper::Thing::new$0(); }
2020-10-02 17:59:32 +00:00
"#,
expect![[r#"
*new*
```rust
name_with_dashes::wrapper::Thing
```
```rust
pub fn new() -> Thing
```
"#]],
)
}
#[test]
fn hover_field_pat_shorthand_ref_match_ergonomics() {
check(
r#"
struct S {
f: i32,
}
fn main() {
let s = S { f: 0 };
2021-01-06 20:15:48 +00:00
let S { f$0 } = &s;
}
"#,
expect![[r#"
*f*
```rust
f: &i32
```
"#]],
);
}
2020-11-28 21:46:25 +00:00
#[test]
fn hover_self_param_shows_type() {
check(
r#"
struct Foo {}
impl Foo {
2021-01-06 20:15:48 +00:00
fn bar(&sel$0f) {}
2020-11-28 21:46:25 +00:00
}
"#,
expect![[r#"
*self*
2020-11-28 21:46:25 +00:00
```rust
self: &Foo
2020-11-28 21:46:25 +00:00
```
"#]],
);
}
#[test]
fn hover_self_param_shows_type_for_arbitrary_self_type() {
check(
r#"
struct Arc<T>(T);
struct Foo {}
impl Foo {
2021-01-06 20:15:48 +00:00
fn bar(sel$0f: Arc<Foo>) {}
2020-11-28 21:46:25 +00:00
}
"#,
expect![[r#"
*self*
2020-11-28 21:46:25 +00:00
```rust
self: Arc<Foo>
2020-11-28 21:46:25 +00:00
```
"#]],
);
}
#[test]
fn hover_doc_outer_inner() {
check(
r#"
/// Be quick;
2021-01-06 20:15:48 +00:00
mod Foo$0 {
//! time is mana
/// This comment belongs to the function
fn foo() {}
}
"#,
expect![[r#"
*Foo*
```rust
test
```
```rust
mod Foo
```
---
Be quick;
time is mana
"#]],
);
}
#[test]
fn hover_doc_outer_inner_attribue() {
check(
r#"
#[doc = "Be quick;"]
2021-01-06 20:15:48 +00:00
mod Foo$0 {
#![doc = "time is mana"]
#[doc = "This comment belongs to the function"]
fn foo() {}
}
"#,
expect![[r#"
*Foo*
```rust
test
```
```rust
mod Foo
```
---
Be quick;
time is mana
"#]],
);
}
2021-03-17 13:38:11 +00:00
#[test]
fn hover_doc_block_style_indentend() {
check(
r#"
/**
foo
```rust
let x = 3;
```
*/
fn foo$0() {}
"#,
expect![[r#"
*foo*
```rust
test
```
```rust
fn foo()
```
---
foo
```rust
let x = 3;
```
"#]],
);
}
#[test]
fn hover_comments_dont_highlight_parent() {
cov_mark::check!(no_highlight_on_comment_hover);
check_hover_no_result(
r#"
fn no_hover() {
2021-01-06 20:15:48 +00:00
// no$0hover
}
"#,
);
}
2021-01-01 14:07:41 +00:00
#[test]
fn hover_label() {
check(
r#"
fn foo() {
2021-01-06 20:15:48 +00:00
'label$0: loop {}
2021-01-01 14:07:41 +00:00
}
"#,
expect![[r#"
*'label*
```rust
'label
```
"#]],
);
}
#[test]
fn hover_lifetime() {
check(
2021-01-06 20:15:48 +00:00
r#"fn foo<'lifetime>(_: &'lifetime$0 ()) {}"#,
2021-01-01 14:07:41 +00:00
expect![[r#"
*'lifetime*
```rust
'lifetime
```
"#]],
);
}
2021-01-01 23:05:51 +00:00
#[test]
fn hover_type_param() {
check(
r#"
2021-06-15 22:23:04 +00:00
//- minicore: sized
2021-01-01 23:05:51 +00:00
struct Foo<T>(T);
trait TraitA {}
trait TraitB {}
impl<T: TraitA + TraitB> Foo<T$0> where T: Sized {}
2021-01-01 23:05:51 +00:00
"#,
expect![[r#"
*T*
```rust
T: TraitA + TraitB
2021-01-01 23:05:51 +00:00
```
"#]],
);
check(
r#"
2021-09-10 18:02:37 +00:00
//- minicore: sized
2021-01-01 23:05:51 +00:00
struct Foo<T>(T);
2021-01-06 20:15:48 +00:00
impl<T> Foo<T$0> {}
2021-01-01 23:05:51 +00:00
"#,
expect![[r#"
*T*
```rust
T
```
"#]],
);
// lifetimes bounds arent being tracked yet
2021-01-01 23:05:51 +00:00
check(
r#"
2021-09-10 18:02:37 +00:00
//- minicore: sized
2021-01-01 23:05:51 +00:00
struct Foo<T>(T);
2021-01-06 20:15:48 +00:00
impl<T: 'static> Foo<T$0> {}
2021-01-01 23:05:51 +00:00
"#,
expect![[r#"
*T*
```rust
T
2021-01-01 23:05:51 +00:00
```
"#]],
);
}
2021-01-04 13:18:31 +00:00
2021-06-15 22:23:04 +00:00
#[test]
fn hover_type_param_sized_bounds() {
// implicit `: Sized` bound
2021-06-15 22:23:04 +00:00
check(
r#"
//- minicore: sized
trait Trait {}
2021-06-15 22:23:04 +00:00
struct Foo<T>(T);
impl<T: Trait> Foo<T$0> {}
2021-06-15 22:23:04 +00:00
"#,
expect![[r#"
*T*
```rust
T: Trait
```
"#]],
);
2021-06-15 22:23:04 +00:00
check(
r#"
//- minicore: sized
trait Trait {}
2021-06-15 22:23:04 +00:00
struct Foo<T>(T);
impl<T: Trait + ?Sized> Foo<T$0> {}
2021-06-15 22:23:04 +00:00
"#,
expect![[r#"
*T*
```rust
T: Trait + ?Sized
2021-06-15 22:23:04 +00:00
```
"#]],
);
}
mod type_param_sized_bounds {
use super::*;
#[test]
fn single_implicit() {
check(
r#"
//- minicore: sized
fn foo<T$0>() {}
"#,
expect![[r#"
*T*
```rust
T
```
"#]],
);
}
#[test]
fn single_explicit() {
check(
r#"
//- minicore: sized
fn foo<T$0: Sized>() {}
"#,
expect![[r#"
*T*
```rust
T
```
"#]],
);
}
#[test]
fn single_relaxed() {
check(
r#"
//- minicore: sized
fn foo<T$0: ?Sized>() {}
"#,
expect![[r#"
*T*
```rust
T: ?Sized
```
"#]],
);
}
#[test]
fn multiple_implicit() {
check(
r#"
//- minicore: sized
trait Trait {}
fn foo<T$0: Trait>() {}
"#,
expect![[r#"
*T*
```rust
T: Trait
```
"#]],
);
}
#[test]
fn multiple_explicit() {
check(
r#"
//- minicore: sized
trait Trait {}
fn foo<T$0: Trait + Sized>() {}
"#,
expect![[r#"
*T*
```rust
T: Trait
```
"#]],
);
}
#[test]
fn multiple_relaxed() {
check(
r#"
//- minicore: sized
trait Trait {}
fn foo<T$0: Trait + ?Sized>() {}
"#,
expect![[r#"
*T*
```rust
T: Trait + ?Sized
```
"#]],
);
}
#[test]
fn mixed() {
check(
r#"
//- minicore: sized
fn foo<T$0: ?Sized + Sized + Sized>() {}
"#,
expect![[r#"
*T*
```rust
T
```
"#]],
);
check(
r#"
//- minicore: sized
trait Trait {}
fn foo<T$0: Sized + ?Sized + Sized + Trait>() {}
"#,
expect![[r#"
*T*
```rust
T: Trait
```
"#]],
);
}
}
2021-01-04 13:18:31 +00:00
#[test]
fn hover_const_param() {
check(
r#"
struct Foo<const LEN: usize>;
2021-01-06 20:15:48 +00:00
impl<const LEN: usize> Foo<LEN$0> {}
2021-01-04 13:18:31 +00:00
"#,
expect![[r#"
*LEN*
```rust
const LEN: usize
```
"#]],
);
}
#[test]
fn hover_const_pat() {
check(
r#"
/// This is a doc
const FOO: usize = 3;
fn foo() {
match 5 {
FOO$0 => (),
_ => ()
}
}
"#,
expect![[r#"
*FOO*
```rust
test
```
```rust
const FOO: usize
```
---
This is a doc
"#]],
);
}
#[test]
fn hover_mod_def() {
check(
r#"
//- /main.rs
mod foo$0;
//- /foo.rs
//! For the horde!
"#,
expect![[r#"
*foo*
2021-03-15 17:24:26 +00:00
```rust
test
```
```rust
mod foo
```
---
For the horde!
"#]],
);
}
#[test]
fn hover_self_in_use() {
check(
r#"
//! This should not appear
mod foo {
/// But this should appear
pub mod bar {}
}
use foo::bar::{self$0};
"#,
expect![[r#"
*self*
```rust
test::foo
```
```rust
2021-03-15 17:24:26 +00:00
mod bar
```
---
But this should appear
"#]],
)
}
#[test]
fn hover_keyword() {
check(
r#"
//- /main.rs crate:main deps:std
fn f() { retur$0n; }
//- /libstd.rs crate:std
/// Docs for return_keyword
mod return_keyword {}
"#,
expect![[r#"
*return*
```rust
return
```
---
Docs for return_keyword
"#]],
);
}
#[test]
fn hover_builtin() {
check(
r#"
//- /main.rs crate:main deps:std
cosnt _: &str$0 = ""; }
//- /libstd.rs crate:std
/// Docs for prim_str
mod prim_str {}
"#,
expect![[r#"
*str*
```rust
str
```
---
Docs for prim_str
"#]],
);
}
#[test]
fn hover_macro_expanded_function() {
check(
r#"
struct S<'a, T>(&'a T);
trait Clone {}
macro_rules! foo {
() => {
fn bar<'t, T: Clone + 't>(s: &mut S<'t, T>, t: u32) -> *mut u32 where
't: 't + 't,
for<'a> T: Clone + 'a
{ 0 as _ }
};
}
foo!();
fn main() {
bar$0;
}
"#,
expect![[r#"
*bar*
```rust
test
```
```rust
2021-03-15 17:24:26 +00:00
fn bar<'t, T>(s: &mut S<'t, T>, t: u32) -> *mut u32
where
2021-03-15 17:24:26 +00:00
T: Clone + 't,
't: 't + 't,
for<'a> T: Clone + 'a,
```
"#]],
)
}
#[test]
fn hover_intra_doc_links() {
check(
r#"
pub mod theitem {
/// This is the item. Cool!
pub struct TheItem;
}
/// Gives you a [`TheItem$0`].
///
/// [`TheItem`]: theitem::TheItem
pub fn gimme() -> theitem::TheItem {
theitem::TheItem
}
"#,
expect![[r#"
*[`TheItem`]*
```rust
test::theitem
```
```rust
pub struct TheItem
```
---
This is the item. Cool!
"#]],
);
}
2021-04-01 16:01:18 +00:00
#[test]
fn hover_generic_assoc() {
check(
r#"
fn foo<T: A>() where T::Assoc$0: {}
trait A {
type Assoc;
}"#,
expect![[r#"
*Assoc*
```rust
test
```
```rust
type Assoc
```
"#]],
);
check(
r#"
fn foo<T: A>() {
let _: <T>::Assoc$0;
}
2021-04-01 16:01:18 +00:00
trait A {
type Assoc;
}"#,
expect![[r#"
*Assoc*
```rust
test
```
```rust
type Assoc
```
"#]],
);
check(
r#"
trait A where
Self::Assoc$0: ,
{
type Assoc;
}"#,
expect![[r#"
*Assoc*
```rust
test
```
```rust
type Assoc
```
"#]],
);
2021-04-01 16:01:18 +00:00
}
#[test]
fn string_shadowed_with_inner_items() {
check(
r#"
//- /main.rs crate:main deps:alloc
/// Custom `String` type.
struct String;
fn f() {
let _: String$0;
fn inner() {}
}
//- /alloc.rs crate:alloc
#[prelude_import]
pub use string::*;
mod string {
/// This is `alloc::String`.
pub struct String;
}
2021-08-02 15:10:36 +00:00
"#,
expect![[r#"
*String*
```rust
main
```
```rust
struct String
```
---
Custom `String` type.
"#]],
)
}
#[test]
fn function_doesnt_shadow_crate_in_use_tree() {
check(
r#"
//- /main.rs crate:main deps:foo
use foo$0::{foo};
//- /foo.rs crate:foo
pub fn foo() {}
"#,
expect![[r#"
*foo*
```rust
extern crate foo
```
"#]],
)
}
2021-06-04 15:03:18 +00:00
#[test]
fn hover_feature() {
check(
r#"#![feature(box_syntax$0)]"#,
expect![[r##"
*box_syntax*
```
box_syntax
```
___
# `box_syntax`
The tracking issue for this feature is: [#49733]
[#49733]: https://github.com/rust-lang/rust/issues/49733
See also [`box_patterns`](box-patterns.md)
------------------------
Currently the only stable way to create a `Box` is via the `Box::new` method.
Also it is not possible in stable Rust to destructure a `Box` in a match
pattern. The unstable `box` keyword can be used to create a `Box`. An example
usage would be:
```rust
#![feature(box_syntax)]
fn main() {
let b = box 5;
}
```
"##]],
)
}
2021-06-04 16:35:19 +00:00
#[test]
fn hover_lint() {
check(
r#"#![allow(arithmetic_overflow$0)]"#,
expect![[r#"
*arithmetic_overflow*
```
arithmetic_overflow
```
___
arithmetic operation overflows
"#]],
)
}
#[test]
fn hover_clippy_lint() {
check(
r#"#![allow(clippy::almost_swapped$0)]"#,
expect![[r#"
*almost_swapped*
```
clippy::almost_swapped
```
___
Checks for `foo = bar; bar = foo` sequences.
"#]],
)
}
#[test]
fn hover_attr_path_qualifier() {
2021-07-02 17:34:49 +00:00
cov_mark::check!(name_ref_classify_attr_path_qualifier);
check(
r#"
//- /foo.rs crate:foo
//- /lib.rs crate:main.rs deps:foo
#[fo$0o::bar()]
struct Foo;
2021-08-02 15:10:36 +00:00
"#,
expect![[r#"
*foo*
```rust
extern crate foo
```
"#]],
)
}
2021-07-23 00:14:59 +00:00
#[test]
fn hover_rename() {
check(
r#"
use self as foo$0;
2021-08-02 15:10:36 +00:00
"#,
2021-07-23 00:14:59 +00:00
expect![[r#"
*foo*
```rust
extern crate test
```
"#]],
);
check(
r#"
mod bar {}
use bar::{self as foo$0};
2021-08-02 15:10:36 +00:00
"#,
2021-07-23 00:14:59 +00:00
expect![[r#"
*foo*
```rust
test
```
```rust
mod bar
```
"#]],
);
check(
r#"
mod bar {
use super as foo$0;
}
2021-08-02 15:10:36 +00:00
"#,
2021-07-23 00:14:59 +00:00
expect![[r#"
*foo*
```rust
extern crate test
```
"#]],
);
check(
r#"
use crate as foo$0;
2021-08-02 15:10:36 +00:00
"#,
2021-07-23 00:14:59 +00:00
expect![[r#"
*foo*
```rust
extern crate test
```
"#]],
);
}
2021-09-21 15:25:57 +00:00
// FIXME: wrong range in macros. `es! ` should be `Copy`
#[test]
fn hover_attribute_in_macro() {
check(
r#"
macro_rules! identity {
($struct:item) => {
$struct
};
}
#[rustc_builtin_macro]
pub macro Copy {}
identity!{
#[derive(Copy$0)]
struct Foo;
}
"#,
expect![[r#"
*es! *
```rust
test
```
```rust
pub macro Copy
```
"#]],
);
}
#[test]
fn hover_derive_input() {
check(
r#"
#[rustc_builtin_macro]
pub macro Copy {}
#[derive(Copy$0)]
struct Foo;
2021-08-02 15:10:36 +00:00
"#,
expect![[r#"
2021-07-31 12:47:44 +00:00
*Copy*
```rust
test
```
```rust
pub macro Copy
```
"#]],
);
check(
r#"
mod foo {
#[rustc_builtin_macro]
pub macro Copy {}
}
#[derive(foo::Copy$0)]
struct Foo;
2021-08-02 15:10:36 +00:00
"#,
expect![[r#"
2021-07-31 12:47:44 +00:00
*Copy*
```rust
test
```
```rust
pub macro Copy
```
"#]],
);
}
2021-07-26 19:34:44 +00:00
#[test]
fn hover_range_math() {
check_hover_range(
r#"
fn f() { let expr = $01 + 2 * 3$0 }
2021-08-02 15:10:36 +00:00
"#,
2021-07-26 19:34:44 +00:00
expect![[r#"
```rust
i32
```"#]],
);
check_hover_range(
r#"
fn f() { let expr = 1 $0+ 2 * $03 }
2021-08-02 15:10:36 +00:00
"#,
2021-07-26 19:34:44 +00:00
expect![[r#"
```rust
i32
```"#]],
);
check_hover_range(
r#"
fn f() { let expr = 1 + $02 * 3$0 }
2021-08-02 15:10:36 +00:00
"#,
2021-07-26 19:34:44 +00:00
expect![[r#"
```rust
i32
```"#]],
);
}
#[test]
fn hover_range_arrays() {
check_hover_range(
r#"
fn f() { let expr = $0[1, 2, 3, 4]$0 }
2021-08-02 15:10:36 +00:00
"#,
2021-07-26 19:34:44 +00:00
expect![[r#"
```rust
[i32; 4]
```"#]],
);
check_hover_range(
r#"
fn f() { let expr = [1, 2, $03, 4]$0 }
2021-08-02 15:10:36 +00:00
"#,
2021-07-26 19:34:44 +00:00
expect![[r#"
```rust
[i32; 4]
```"#]],
);
check_hover_range(
r#"
fn f() { let expr = [1, 2, $03$0, 4] }
2021-08-02 15:10:36 +00:00
"#,
2021-07-26 19:34:44 +00:00
expect![[r#"
```rust
i32
```"#]],
);
}
#[test]
fn hover_range_functions() {
check_hover_range(
r#"
fn f<T>(a: &[T]) { }
fn b() { $0f$0(&[1, 2, 3, 4, 5]); }
2021-08-02 15:10:36 +00:00
"#,
2021-07-26 19:34:44 +00:00
expect![[r#"
```rust
fn f<i32>(&[i32])
```"#]],
);
check_hover_range(
r#"
fn f<T>(a: &[T]) { }
fn b() { f($0&[1, 2, 3, 4, 5]$0); }
2021-08-02 15:10:36 +00:00
"#,
2021-07-26 19:34:44 +00:00
expect![[r#"
```rust
&[i32; 5]
```"#]],
);
}
#[test]
fn hover_range_shows_nothing_when_invalid() {
check_hover_range_no_results(
r#"
fn f<T>(a: &[T]) { }
fn b()$0 { f(&[1, 2, 3, 4, 5]); }$0
2021-08-02 15:10:36 +00:00
"#,
);
check_hover_range_no_results(
r#"
fn f<T>$0(a: &[T]) { }
fn b() { f(&[1, 2, 3,$0 4, 5]); }
2021-08-02 15:10:36 +00:00
"#,
);
check_hover_range_no_results(
r#"
fn $0f() { let expr = [1, 2, 3, 4]$0 }
2021-08-02 15:10:36 +00:00
"#,
);
}
#[test]
fn hover_range_shows_unit_for_statements() {
check_hover_range(
r#"
fn f<T>(a: &[T]) { }
fn b() { $0f(&[1, 2, 3, 4, 5]); }$0
2021-08-02 15:10:36 +00:00
"#,
expect![[r#"
```rust
()
```"#]],
);
check_hover_range(
r#"
fn f() { let expr$0 = $0[1, 2, 3, 4] }
2021-08-02 15:10:36 +00:00
"#,
expect![[r#"
```rust
()
```"#]],
);
}
2021-08-02 15:10:36 +00:00
#[test]
fn hover_range_for_pat() {
check_hover_range(
r#"
fn foo() {
let $0x$0 = 0;
}
"#,
expect![[r#"
```rust
i32
```"#]],
);
check_hover_range(
r#"
fn foo() {
let $0x$0 = "";
}
"#,
expect![[r#"
```rust
&str
```"#]],
);
}
#[test]
fn hover_range_shows_coercions_if_applicable_expr() {
2021-08-02 15:10:36 +00:00
check_hover_range(
r#"
fn foo() {
let x: &u32 = $0&&&&&0$0;
}
"#,
expect![[r#"
```text
2021-08-02 15:10:36 +00:00
Type: &&&&&u32
Coerced to: &u32
```
"#]],
);
check_hover_range(
r#"
fn foo() {
let x: *const u32 = $0&0$0;
}
"#,
expect![[r#"
```text
2021-08-02 15:10:36 +00:00
Type: &u32
Coerced to: *const u32
```
"#]],
);
}
2021-08-11 11:39:36 +00:00
#[test]
fn hover_range_shows_type_actions() {
check_actions(
r#"
struct Foo;
fn foo() {
let x: &Foo = $0&&&&&Foo$0;
}
"#,
expect![[r#"
[
GoToType(
[
HoverGotoTypeData {
mod_path: "test::Foo",
nav: NavigationTarget {
file_id: FileId(
0,
),
full_range: 0..11,
focus_range: 7..10,
name: "Foo",
kind: Struct,
description: "struct Foo",
},
},
],
),
]
"#]],
);
}
#[test]
fn hover_try_expr_res() {
check_hover_range(
r#"
//- minicore:result
struct FooError;
fn foo() -> Result<(), FooError> {
Ok($0Result::<(), FooError>::Ok(())?$0)
}
"#,
expect![[r#"
```rust
()
```"#]],
);
check_hover_range(
r#"
//- minicore:result
struct FooError;
struct BarError;
fn foo() -> Result<(), FooError> {
Ok($0Result::<(), BarError>::Ok(())?$0)
}
"#,
expect![[r#"
```text
Try Error Type: BarError
Propagated as: FooError
```
"#]],
);
}
#[test]
fn hover_try_expr() {
check_hover_range(
r#"
struct NotResult<T, U>(T, U);
struct Short;
struct Looooong;
fn foo() -> NotResult<(), Looooong> {
$0NotResult((), Short)?$0;
}
"#,
expect![[r#"
```text
Try Target Type: NotResult<(), Short>
Propagated as: NotResult<(), Looooong>
```
"#]],
);
check_hover_range(
r#"
struct NotResult<T, U>(T, U);
struct Short;
struct Looooong;
fn foo() -> NotResult<(), Short> {
$0NotResult((), Looooong)?$0;
}
"#,
expect![[r#"
```text
Try Target Type: NotResult<(), Looooong>
Propagated as: NotResult<(), Short>
```
"#]],
);
}
#[test]
fn hover_try_expr_option() {
2021-09-01 09:25:42 +00:00
cov_mark::check!(hover_try_expr_opt_opt);
check_hover_range(
r#"
//- minicore: option, try
fn foo() -> Option<()> {
$0Some(0)?$0;
None
}
"#,
expect![[r#"
```rust
<Option<i32> as Try>::Output
```"#]],
);
}
#[test]
fn hover_deref_expr() {
check_hover_range(
r#"
//- minicore: deref
use core::ops::Deref;
struct DerefExample<T> {
value: T
}
impl<T> Deref for DerefExample<T> {
type Target = T;
fn deref(&self) -> &Self::Target {
&self.value
}
}
fn foo() {
let x = DerefExample { value: 0 };
let y: i32 = $0*x$0;
}
"#,
expect![[r#"
```text
2021-09-13 23:16:10 +00:00
Dereferenced from: DerefExample<i32>
2021-09-14 00:19:30 +00:00
To type: i32
```
"#]],
);
}
#[test]
fn hover_deref_expr_with_coercion() {
check_hover_range(
r#"
//- minicore: deref
use core::ops::Deref;
struct DerefExample<T> {
value: T
}
impl<T> Deref for DerefExample<T> {
type Target = T;
fn deref(&self) -> &Self::Target {
&self.value
}
}
fn foo() {
let x = DerefExample { value: &&&&&0 };
let y: &i32 = $0*x$0;
}
"#,
expect![[r#"
```text
2021-09-13 23:16:10 +00:00
Dereferenced from: DerefExample<&&&&&i32>
2021-09-14 00:19:30 +00:00
To type: &&&&&i32
Coerced to: &i32
```
"#]],
);
}
2019-01-08 19:33:36 +00:00
}