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

   1 mod render;
   2
   3 #[cfg(test)]
   4 mod tests;
   5
   6 use std::iter;
   7
   8 use either::Either;
   9 use hir::{HasSource, Semantics};
  10 use ide_db::{
  11     base_db::FileRange,
  12     defs::{Definition, IdentClass},
  13     famous_defs::FamousDefs,
  14     helpers::pick_best_token,
  15     FxIndexSet, RootDatabase,
  16 };
  17 use itertools::Itertools;
  18 use syntax::{ast, match_ast, AstNode, SyntaxKind::*, SyntaxNode, SyntaxToken, T};
  19
  20 use crate::{
  21     doc_links::token_as_doc_comment,
  22     markup::Markup,
  23     runnables::{runnable_fn, runnable_mod},
  24     FileId, FilePosition, NavigationTarget, RangeInfo, Runnable, TryToNav,
  25 };
  26 #[derive(Clone, Debug, PartialEq, Eq)]
  27 pub struct HoverConfig {
  28     pub links_in_hover: bool,
  29     pub documentation: Option<HoverDocFormat>,
  30 }
  31
  32 impl HoverConfig {
  33     fn markdown(&self) -> bool {
  34         matches!(self.documentation, Some(HoverDocFormat::Markdown))
  35     }
  36 }
  37
  38 #[derive(Clone, Debug, PartialEq, Eq)]
  39 pub enum HoverDocFormat {
  40     Markdown,
  41     PlainText,
  42 }
  43
  44 #[derive(Debug, Clone)]
  45 pub enum HoverAction {
  46     Runnable(Runnable),
  47     Implementation(FilePosition),
  48     Reference(FilePosition),
  49     GoToType(Vec<HoverGotoTypeData>),
  50 }
  51
  52 impl HoverAction {
  53     fn goto_type_from_targets(db: &RootDatabase, targets: Vec<hir::ModuleDef>) -> Self {
  54         let targets = targets
  55             .into_iter()
  56             .filter_map(|it| {
  57                 Some(HoverGotoTypeData {
  58                     mod_path: render::path(
  59                         db,
  60                         it.module(db)?,
  61                         it.name(db).map(|name| name.to_string()),
  62                     ),
  63                     nav: it.try_to_nav(db)?,
  64                 })
  65             })
  66             .collect();
  67         HoverAction::GoToType(targets)
  68     }
  69 }
  70
  71 #[derive(Debug, Clone, Eq, PartialEq, Hash)]
  72 pub struct HoverGotoTypeData {
  73     pub mod_path: String,
  74     pub nav: NavigationTarget,
  75 }
  76
  77 /// Contains the results when hovering over an item
  78 #[derive(Debug, Default)]
  79 pub struct HoverResult {
  80     pub markup: Markup,
  81     pub actions: Vec<HoverAction>,
  82 }
  83
  84 // Feature: Hover
  85 //
  86 // Shows additional information, like the type of an expression or the documentation for a definition when "focusing" code.
  87 // Focusing is usually hovering with a mouse, but can also be triggered with a shortcut.
  88 //
  89 // image::https://user-images.githubusercontent.com/48062697/113020658-b5f98b80-917a-11eb-9f88-3dbc27320c95.gif[]
  90 pub(crate) fn hover(
  91     db: &RootDatabase,
  92     FileRange { file_id, range }: FileRange,
  93     config: &HoverConfig,
  94 ) -> Option<RangeInfo<HoverResult>> {
  95     let sema = &hir::Semantics::new(db);
  96     let file = sema.parse(file_id).syntax().clone();
  97
  98     if !range.is_empty() {
  99         return hover_ranged(&file, range, sema, config);
 100     }
 101     let offset = range.start();
 102
 103     let original_token = pick_best_token(file.token_at_offset(offset), |kind| match kind {
 104         IDENT | INT_NUMBER | LIFETIME_IDENT | T![self] | T![super] | T![crate] | T![Self] => 3,
 105         T!['('] | T![')'] => 2,
 106         kind if kind.is_trivia() => 0,
 107         _ => 1,
 108     })?;
 109
 110     if let Some(doc_comment) = token_as_doc_comment(&original_token) {
 111         cov_mark::hit!(no_highlight_on_comment_hover);
 112         return doc_comment.get_definition_with_descend_at(sema, offset, |def, node, range| {
 113             let res = hover_for_definition(sema, file_id, def, &node, config)?;
 114             Some(RangeInfo::new(range, res))
 115         });
 116     }
 117
 118     let in_attr = matches!(original_token.parent().and_then(ast::TokenTree::cast), Some(tt) if tt.syntax().ancestors().any(|it| ast::Meta::can_cast(it.kind())));
 119     let descended = if in_attr {
 120         [sema.descend_into_macros_with_kind_preference(original_token.clone())].into()
 121     } else {
 122         sema.descend_into_macros_with_same_text(original_token.clone())
 123     };
 124
 125     // FIXME: Definition should include known lints and the like instead of having this special case here
 126     let hovered_lint = descended.iter().find_map(|token| {
 127         let attr = token.parent_ancestors().find_map(ast::Attr::cast)?;
 128         render::try_for_lint(&attr, token)
 129     });
 130     if let Some(res) = hovered_lint {
 131         return Some(RangeInfo::new(original_token.text_range(), res));
 132     }
 133
 134     let result = descended
 135         .iter()
 136         .filter_map(|token| {
 137             let node = token.parent()?;
 138             let class = IdentClass::classify_token(sema, token)?;
 139             Some(class.definitions().into_iter().zip(iter::once(node).cycle()))
 140         })
 141         .flatten()
 142         .unique_by(|&(def, _)| def)
 143         .filter_map(|(def, node)| hover_for_definition(sema, file_id, def, &node, config))
 144         .reduce(|mut acc: HoverResult, HoverResult { markup, actions }| {
 145             acc.actions.extend(actions);
 146             acc.markup = Markup::from(format!("{}\n---\n{}", acc.markup, markup));
 147             acc
 148         });
 149
 150     if result.is_none() {
 151         // fallbacks, show keywords or types
 152
 153         let res = descended.iter().find_map(|token| render::keyword(sema, config, token));
 154         if let Some(res) = res {
 155             return Some(RangeInfo::new(original_token.text_range(), res));
 156         }
 157         let res = descended
 158             .iter()
 159             .find_map(|token| hover_type_fallback(sema, config, token, &original_token));
 160         if let Some(_) = res {
 161             return res;
 162         }
 163     }
 164     result.map(|mut res: HoverResult| {
 165         res.actions = dedupe_or_merge_hover_actions(res.actions);
 166         RangeInfo::new(original_token.text_range(), res)
 167     })
 168 }
 169
 170 pub(crate) fn hover_for_definition(
 171     sema: &Semantics<'_, RootDatabase>,
 172     file_id: FileId,
 173     definition: Definition,
 174     node: &SyntaxNode,
 175     config: &HoverConfig,
 176 ) -> Option<HoverResult> {
 177     let famous_defs = match &definition {
 178         Definition::BuiltinType(_) => Some(FamousDefs(sema, sema.scope(node)?.krate())),
 179         _ => None,
 180     };
 181     render::definition(sema.db, definition, famous_defs.as_ref(), config).map(|markup| {
 182         HoverResult {
 183             markup: render::process_markup(sema.db, definition, &markup, config),
 184             actions: show_implementations_action(sema.db, definition)
 185                 .into_iter()
 186                 .chain(show_fn_references_action(sema.db, definition))
 187                 .chain(runnable_action(sema, definition, file_id))
 188                 .chain(goto_type_action_for_def(sema.db, definition))
 189                 .collect(),
 190         }
 191     })
 192 }
 193
 194 fn hover_ranged(
 195     file: &SyntaxNode,
 196     range: syntax::TextRange,
 197     sema: &Semantics<'_, RootDatabase>,
 198     config: &HoverConfig,
 199 ) -> Option<RangeInfo<HoverResult>> {
 200     // FIXME: make this work in attributes
 201     let expr_or_pat = file.covering_element(range).ancestors().find_map(|it| {
 202         match_ast! {
 203             match it {
 204                 ast::Expr(expr) => Some(Either::Left(expr)),
 205                 ast::Pat(pat) => Some(Either::Right(pat)),
 206                 _ => None,
 207             }
 208         }
 209     })?;
 210     let res = match &expr_or_pat {
 211         Either::Left(ast::Expr::TryExpr(try_expr)) => render::try_expr(sema, config, try_expr),
 212         Either::Left(ast::Expr::PrefixExpr(prefix_expr))
 213             if prefix_expr.op_kind() == Some(ast::UnaryOp::Deref) =>
 214         {
 215             render::deref_expr(sema, config, prefix_expr)
 216         }
 217         _ => None,
 218     };
 219     let res = res.or_else(|| render::type_info(sema, config, &expr_or_pat));
 220     res.map(|it| {
 221         let range = match expr_or_pat {
 222             Either::Left(it) => it.syntax().text_range(),
 223             Either::Right(it) => it.syntax().text_range(),
 224         };
 225         RangeInfo::new(range, it)
 226     })
 227 }
 228
 229 fn hover_type_fallback(
 230     sema: &Semantics<'_, RootDatabase>,
 231     config: &HoverConfig,
 232     token: &SyntaxToken,
 233     original_token: &SyntaxToken,
 234 ) -> Option<RangeInfo<HoverResult>> {
 235     let node = token
 236         .parent_ancestors()
 237         .take_while(|it| !ast::Item::can_cast(it.kind()))
 238         .find(|n| ast::Expr::can_cast(n.kind()) || ast::Pat::can_cast(n.kind()))?;
 239
 240     let expr_or_pat = match_ast! {
 241         match node {
 242             ast::Expr(it) => Either::Left(it),
 243             ast::Pat(it) => Either::Right(it),
 244             // If this node is a MACRO_CALL, it means that `descend_into_macros_many` failed to resolve.
 245             // (e.g expanding a builtin macro). So we give up here.
 246             ast::MacroCall(_it) => return None,
 247             _ => return None,
 248         }
 249     };
 250
 251     let res = render::type_info(sema, config, &expr_or_pat)?;
 252     let range = sema
 253         .original_range_opt(&node)
 254         .map(|frange| frange.range)
 255         .unwrap_or_else(|| original_token.text_range());
 256     Some(RangeInfo::new(range, res))
 257 }
 258
 259 fn show_implementations_action(db: &RootDatabase, def: Definition) -> Option<HoverAction> {
 260     fn to_action(nav_target: NavigationTarget) -> HoverAction {
 261         HoverAction::Implementation(FilePosition {
 262             file_id: nav_target.file_id,
 263             offset: nav_target.focus_or_full_range().start(),
 264         })
 265     }
 266
 267     let adt = match def {
 268         Definition::Trait(it) => return it.try_to_nav(db).map(to_action),
 269         Definition::Adt(it) => Some(it),
 270         Definition::SelfType(it) => it.self_ty(db).as_adt(),
 271         _ => None,
 272     }?;
 273     adt.try_to_nav(db).map(to_action)
 274 }
 275
 276 fn show_fn_references_action(db: &RootDatabase, def: Definition) -> Option<HoverAction> {
 277     match def {
 278         Definition::Function(it) => it.try_to_nav(db).map(|nav_target| {
 279             HoverAction::Reference(FilePosition {
 280                 file_id: nav_target.file_id,
 281                 offset: nav_target.focus_or_full_range().start(),
 282             })
 283         }),
 284         _ => None,
 285     }
 286 }
 287
 288 fn runnable_action(
 289     sema: &hir::Semantics<'_, RootDatabase>,
 290     def: Definition,
 291     file_id: FileId,
 292 ) -> Option<HoverAction> {
 293     match def {
 294         Definition::Module(it) => runnable_mod(sema, it).map(HoverAction::Runnable),
 295         Definition::Function(func) => {
 296             let src = func.source(sema.db)?;
 297             if src.file_id != file_id.into() {
 298                 cov_mark::hit!(hover_macro_generated_struct_fn_doc_comment);
 299                 cov_mark::hit!(hover_macro_generated_struct_fn_doc_attr);
 300                 return None;
 301             }
 302
 303             runnable_fn(sema, func).map(HoverAction::Runnable)
 304         }
 305         _ => None,
 306     }
 307 }
 308
 309 fn goto_type_action_for_def(db: &RootDatabase, def: Definition) -> Option<HoverAction> {
 310     let mut targets: Vec<hir::ModuleDef> = Vec::new();
 311     let mut push_new_def = |item: hir::ModuleDef| {
 312         if !targets.contains(&item) {
 313             targets.push(item);
 314         }
 315     };
 316
 317     if let Definition::GenericParam(hir::GenericParam::TypeParam(it)) = def {
 318         it.trait_bounds(db).into_iter().for_each(|it| push_new_def(it.into()));
 319     } else {
 320         let ty = match def {
 321             Definition::Local(it) => it.ty(db),
 322             Definition::GenericParam(hir::GenericParam::ConstParam(it)) => it.ty(db),
 323             Definition::Field(field) => field.ty(db),
 324             Definition::Function(function) => function.ret_type(db),
 325             _ => return None,
 326         };
 327
 328         walk_and_push_ty(db, &ty, &mut push_new_def);
 329     }
 330
 331     Some(HoverAction::goto_type_from_targets(db, targets))
 332 }
 333
 334 fn walk_and_push_ty(
 335     db: &RootDatabase,
 336     ty: &hir::Type,
 337     push_new_def: &mut dyn FnMut(hir::ModuleDef),
 338 ) {
 339     ty.walk(db, |t| {
 340         if let Some(adt) = t.as_adt() {
 341             push_new_def(adt.into());
 342         } else if let Some(trait_) = t.as_dyn_trait() {
 343             push_new_def(trait_.into());
 344         } else if let Some(traits) = t.as_impl_traits(db) {
 345             traits.for_each(|it| push_new_def(it.into()));
 346         } else if let Some(trait_) = t.as_associated_type_parent_trait(db) {
 347             push_new_def(trait_.into());
 348         }
 349     });
 350 }
 351
 352 fn dedupe_or_merge_hover_actions(actions: Vec<HoverAction>) -> Vec<HoverAction> {
 353     let mut deduped_actions = Vec::with_capacity(actions.len());
 354     let mut go_to_type_targets = FxIndexSet::default();
 355
 356     let mut seen_implementation = false;
 357     let mut seen_reference = false;
 358     let mut seen_runnable = false;
 359     for action in actions {
 360         match action {
 361             HoverAction::GoToType(targets) => {
 362                 go_to_type_targets.extend(targets);
 363             }
 364             HoverAction::Implementation(..) => {
 365                 if !seen_implementation {
 366                     seen_implementation = true;
 367                     deduped_actions.push(action);
 368                 }
 369             }
 370             HoverAction::Reference(..) => {
 371                 if !seen_reference {
 372                     seen_reference = true;
 373                     deduped_actions.push(action);
 374                 }
 375             }
 376             HoverAction::Runnable(..) => {
 377                 if !seen_runnable {
 378                     seen_runnable = true;
 379                     deduped_actions.push(action);
 380                 }
 381             }
 382         };
 383     }
 384
 385     if !go_to_type_targets.is_empty() {
 386         deduped_actions.push(HoverAction::GoToType(go_to_type_targets.into_iter().collect()));
 387     }
 388
 389     deduped_actions
 390 }