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 descended = sema.descend_into_macros_with_same_text(original_token.clone());
 119
 120     // FIXME: Definition should include known lints and the like instead of having this special case here
 121     let hovered_lint = descended.iter().find_map(|token| {
 122         let attr = token.parent_ancestors().find_map(ast::Attr::cast)?;
 123         render::try_for_lint(&attr, token)
 124     });
 125     if let Some(res) = hovered_lint {
 126         return Some(RangeInfo::new(original_token.text_range(), res));
 127     }
 128
 129     let result = descended
 130         .iter()
 131         .filter_map(|token| {
 132             let node = token.parent()?;
 133             let class = IdentClass::classify_token(sema, token)?;
 134             Some(class.definitions().into_iter().zip(iter::once(node).cycle()))
 135         })
 136         .flatten()
 137         .unique_by(|&(def, _)| def)
 138         .filter_map(|(def, node)| hover_for_definition(sema, file_id, def, &node, config))
 139         .reduce(|mut acc: HoverResult, HoverResult { markup, actions }| {
 140             acc.actions.extend(actions);
 141             acc.markup = Markup::from(format!("{}\n---\n{}", acc.markup, markup));
 142             acc
 143         });
 144
 145     if result.is_none() {
 146         // fallbacks, show keywords or types
 147
 148         let res = descended.iter().find_map(|token| render::keyword(sema, config, token));
 149         if let Some(res) = res {
 150             return Some(RangeInfo::new(original_token.text_range(), res));
 151         }
 152         let res = descended
 153             .iter()
 154             .find_map(|token| hover_type_fallback(sema, config, token, &original_token));
 155         if let Some(_) = res {
 156             return res;
 157         }
 158     }
 159     result.map(|mut res: HoverResult| {
 160         res.actions = dedupe_or_merge_hover_actions(res.actions);
 161         RangeInfo::new(original_token.text_range(), res)
 162     })
 163 }
 164
 165 pub(crate) fn hover_for_definition(
 166     sema: &Semantics<'_, RootDatabase>,
 167     file_id: FileId,
 168     definition: Definition,
 169     node: &SyntaxNode,
 170     config: &HoverConfig,
 171 ) -> Option<HoverResult> {
 172     let famous_defs = match &definition {
 173         Definition::BuiltinType(_) => Some(FamousDefs(sema, sema.scope(node)?.krate())),
 174         _ => None,
 175     };
 176     render::definition(sema.db, definition, famous_defs.as_ref(), config).map(|markup| {
 177         HoverResult {
 178             markup: render::process_markup(sema.db, definition, &markup, config),
 179             actions: show_implementations_action(sema.db, definition)
 180                 .into_iter()
 181                 .chain(show_fn_references_action(sema.db, definition))
 182                 .chain(runnable_action(sema, definition, file_id))
 183                 .chain(goto_type_action_for_def(sema.db, definition))
 184                 .collect(),
 185         }
 186     })
 187 }
 188
 189 fn hover_ranged(
 190     file: &SyntaxNode,
 191     range: syntax::TextRange,
 192     sema: &Semantics<'_, RootDatabase>,
 193     config: &HoverConfig,
 194 ) -> Option<RangeInfo<HoverResult>> {
 195     // FIXME: make this work in attributes
 196     let expr_or_pat = file.covering_element(range).ancestors().find_map(|it| {
 197         match_ast! {
 198             match it {
 199                 ast::Expr(expr) => Some(Either::Left(expr)),
 200                 ast::Pat(pat) => Some(Either::Right(pat)),
 201                 _ => None,
 202             }
 203         }
 204     })?;
 205     let res = match &expr_or_pat {
 206         Either::Left(ast::Expr::TryExpr(try_expr)) => render::try_expr(sema, config, try_expr),
 207         Either::Left(ast::Expr::PrefixExpr(prefix_expr))
 208             if prefix_expr.op_kind() == Some(ast::UnaryOp::Deref) =>
 209         {
 210             render::deref_expr(sema, config, prefix_expr)
 211         }
 212         _ => None,
 213     };
 214     let res = res.or_else(|| render::type_info(sema, config, &expr_or_pat));
 215     res.map(|it| {
 216         let range = match expr_or_pat {
 217             Either::Left(it) => it.syntax().text_range(),
 218             Either::Right(it) => it.syntax().text_range(),
 219         };
 220         RangeInfo::new(range, it)
 221     })
 222 }
 223
 224 fn hover_type_fallback(
 225     sema: &Semantics<'_, RootDatabase>,
 226     config: &HoverConfig,
 227     token: &SyntaxToken,
 228     original_token: &SyntaxToken,
 229 ) -> Option<RangeInfo<HoverResult>> {
 230     let node = token
 231         .parent_ancestors()
 232         .take_while(|it| !ast::Item::can_cast(it.kind()))
 233         .find(|n| ast::Expr::can_cast(n.kind()) || ast::Pat::can_cast(n.kind()))?;
 234
 235     let expr_or_pat = match_ast! {
 236         match node {
 237             ast::Expr(it) => Either::Left(it),
 238             ast::Pat(it) => Either::Right(it),
 239             // If this node is a MACRO_CALL, it means that `descend_into_macros_many` failed to resolve.
 240             // (e.g expanding a builtin macro). So we give up here.
 241             ast::MacroCall(_it) => return None,
 242             _ => return None,
 243         }
 244     };
 245
 246     let res = render::type_info(sema, config, &expr_or_pat)?;
 247     let range = sema
 248         .original_range_opt(&node)
 249         .map(|frange| frange.range)
 250         .unwrap_or_else(|| original_token.text_range());
 251     Some(RangeInfo::new(range, res))
 252 }
 253
 254 fn show_implementations_action(db: &RootDatabase, def: Definition) -> Option<HoverAction> {
 255     fn to_action(nav_target: NavigationTarget) -> HoverAction {
 256         HoverAction::Implementation(FilePosition {
 257             file_id: nav_target.file_id,
 258             offset: nav_target.focus_or_full_range().start(),
 259         })
 260     }
 261
 262     let adt = match def {
 263         Definition::Trait(it) => return it.try_to_nav(db).map(to_action),
 264         Definition::Adt(it) => Some(it),
 265         Definition::SelfType(it) => it.self_ty(db).as_adt(),
 266         _ => None,
 267     }?;
 268     adt.try_to_nav(db).map(to_action)
 269 }
 270
 271 fn show_fn_references_action(db: &RootDatabase, def: Definition) -> Option<HoverAction> {
 272     match def {
 273         Definition::Function(it) => it.try_to_nav(db).map(|nav_target| {
 274             HoverAction::Reference(FilePosition {
 275                 file_id: nav_target.file_id,
 276                 offset: nav_target.focus_or_full_range().start(),
 277             })
 278         }),
 279         _ => None,
 280     }
 281 }
 282
 283 fn runnable_action(
 284     sema: &hir::Semantics<'_, RootDatabase>,
 285     def: Definition,
 286     file_id: FileId,
 287 ) -> Option<HoverAction> {
 288     match def {
 289         Definition::Module(it) => runnable_mod(sema, it).map(HoverAction::Runnable),
 290         Definition::Function(func) => {
 291             let src = func.source(sema.db)?;
 292             if src.file_id != file_id.into() {
 293                 cov_mark::hit!(hover_macro_generated_struct_fn_doc_comment);
 294                 cov_mark::hit!(hover_macro_generated_struct_fn_doc_attr);
 295                 return None;
 296             }
 297
 298             runnable_fn(sema, func).map(HoverAction::Runnable)
 299         }
 300         _ => None,
 301     }
 302 }
 303
 304 fn goto_type_action_for_def(db: &RootDatabase, def: Definition) -> Option<HoverAction> {
 305     let mut targets: Vec<hir::ModuleDef> = Vec::new();
 306     let mut push_new_def = |item: hir::ModuleDef| {
 307         if !targets.contains(&item) {
 308             targets.push(item);
 309         }
 310     };
 311
 312     if let Definition::GenericParam(hir::GenericParam::TypeParam(it)) = def {
 313         it.trait_bounds(db).into_iter().for_each(|it| push_new_def(it.into()));
 314     } else {
 315         let ty = match def {
 316             Definition::Local(it) => it.ty(db),
 317             Definition::GenericParam(hir::GenericParam::ConstParam(it)) => it.ty(db),
 318             Definition::Field(field) => field.ty(db),
 319             Definition::Function(function) => function.ret_type(db),
 320             _ => return None,
 321         };
 322
 323         walk_and_push_ty(db, &ty, &mut push_new_def);
 324     }
 325
 326     Some(HoverAction::goto_type_from_targets(db, targets))
 327 }
 328
 329 fn walk_and_push_ty(
 330     db: &RootDatabase,
 331     ty: &hir::Type,
 332     push_new_def: &mut dyn FnMut(hir::ModuleDef),
 333 ) {
 334     ty.walk(db, |t| {
 335         if let Some(adt) = t.as_adt() {
 336             push_new_def(adt.into());
 337         } else if let Some(trait_) = t.as_dyn_trait() {
 338             push_new_def(trait_.into());
 339         } else if let Some(traits) = t.as_impl_traits(db) {
 340             traits.for_each(|it| push_new_def(it.into()));
 341         } else if let Some(trait_) = t.as_associated_type_parent_trait(db) {
 342             push_new_def(trait_.into());
 343         }
 344     });
 345 }
 346
 347 fn dedupe_or_merge_hover_actions(actions: Vec<HoverAction>) -> Vec<HoverAction> {
 348     let mut deduped_actions = Vec::with_capacity(actions.len());
 349     let mut go_to_type_targets = FxIndexSet::default();
 350
 351     let mut seen_implementation = false;
 352     let mut seen_reference = false;
 353     let mut seen_runnable = false;
 354     for action in actions {
 355         match action {
 356             HoverAction::GoToType(targets) => {
 357                 go_to_type_targets.extend(targets);
 358             }
 359             HoverAction::Implementation(..) => {
 360                 if !seen_implementation {
 361                     seen_implementation = true;
 362                     deduped_actions.push(action);
 363                 }
 364             }
 365             HoverAction::Reference(..) => {
 366                 if !seen_reference {
 367                     seen_reference = true;
 368                     deduped_actions.push(action);
 369                 }
 370             }
 371             HoverAction::Runnable(..) => {
 372                 if !seen_runnable {
 373                     seen_runnable = true;
 374                     deduped_actions.push(action);
 375                 }
 376             }
 377         };
 378     }
 379
 380     if !go_to_type_targets.is_empty() {
 381         deduped_actions.push(HoverAction::GoToType(go_to_type_targets.into_iter().collect()));
 382     }
 383
 384     deduped_actions
 385 }