From b2cc593381aa835b708dfc2df05809e7574be0d6 Mon Sep 17 00:00:00 2001 From: kjeremy Date: Mon, 18 Nov 2019 11:58:42 -0500 Subject: [PATCH 1/2] Support hover through macro --- crates/ra_ide_api/src/hover.rs | 108 ++++++++++++++++++++------------- 1 file changed, 66 insertions(+), 42 deletions(-) diff --git a/crates/ra_ide_api/src/hover.rs b/crates/ra_ide_api/src/hover.rs index c6d678c0c7d..78210b085fe 100644 --- a/crates/ra_ide_api/src/hover.rs +++ b/crates/ra_ide_api/src/hover.rs @@ -1,11 +1,11 @@ //! FIXME: write short doc here -use hir::{Adt, HasSource, HirDisplay, Source}; +use hir::{db::AstDatabase, Adt, HasSource, HirDisplay}; use ra_db::SourceDatabase; use ra_syntax::{ - algo::{ancestors_at_offset, find_covering_element, find_node_at_offset}, + algo::find_covering_element, ast::{self, DocCommentsOwner}, - AstNode, + match_ast, AstNode, }; use crate::{ @@ -14,6 +14,7 @@ description_from_symbol, docs_from_symbol, macro_label, rust_code_markup, rust_code_markup_with_doc, ShortLabel, }, + expand::descend_into_macros, references::{classify_name, classify_name_ref, NameKind, NameKind::*}, FilePosition, FileRange, RangeInfo, }; @@ -162,55 +163,56 @@ fn from_def_source(db: &RootDatabase, def: D) -> Option } pub(crate) fn hover(db: &RootDatabase, position: FilePosition) -> Option> { - let parse = db.parse(position.file_id); - let file = parse.tree(); + let file = db.parse_or_expand(position.file_id.into())?; + let token = file.token_at_offset(position.offset).filter(|it| !it.kind().is_trivia()).next()?; + let token = descend_into_macros(db, position.file_id, token); let mut res = HoverResult::new(); - let mut range = if let Some(name_ref) = - find_node_at_offset::(file.syntax(), position.offset) - { - let mut no_fallback = false; - if let Some(name_kind) = - classify_name_ref(db, Source::new(position.file_id.into(), &name_ref)).map(|d| d.kind) - { - res.extend(hover_text_from_name_kind(db, name_kind, &mut no_fallback)) - } + let mut range = match_ast! { + match (token.ast.parent()) { + ast::NameRef(name_ref) => { + let mut no_fallback = false; + if let Some(name_kind) = + classify_name_ref(db, token.with_ast(&name_ref)).map(|d| d.kind) + { + res.extend(hover_text_from_name_kind(db, name_kind, &mut no_fallback)) + } - if res.is_empty() && !no_fallback { - // Fallback index based approach: - let symbols = crate::symbol_index::index_resolve(db, &name_ref); - for sym in symbols { - let docs = docs_from_symbol(db, &sym); - let desc = description_from_symbol(db, &sym); - res.extend(hover_text(docs, desc)); - } - } + if res.is_empty() && !no_fallback { + // Fallback index based approach: + let symbols = crate::symbol_index::index_resolve(db, &name_ref); + for sym in symbols { + let docs = docs_from_symbol(db, &sym); + let desc = description_from_symbol(db, &sym); + res.extend(hover_text(docs, desc)); + } + } - if !res.is_empty() { - Some(name_ref.syntax().text_range()) - } else { - None - } - } else if let Some(name) = find_node_at_offset::(file.syntax(), position.offset) { - if let Some(name_kind) = - classify_name(db, Source::new(position.file_id.into(), &name)).map(|d| d.kind) - { - let mut _b: bool = true; - res.extend(hover_text_from_name_kind(db, name_kind, &mut _b)); - } + if !res.is_empty() { + Some(name_ref.syntax().text_range()) + } else { + None + } + }, + ast::Name(name) => { + if let Some(name_kind) = classify_name(db, token.with_ast(&name)).map(|d| d.kind) { + let mut _b: bool = true; + res.extend(hover_text_from_name_kind(db, name_kind, &mut _b)); + } - if !res.is_empty() { - Some(name.syntax().text_range()) - } else { - None + if !res.is_empty() { + Some(name.syntax().text_range()) + } else { + None + } + }, + _ => None, } - } else { - None }; if range.is_none() { - let node = ancestors_at_offset(file.syntax(), position.offset).find(|n| { + let node = token.ast.ancestors().find(|n| { ast::Expr::cast(n.clone()).is_some() || ast::Pat::cast(n.clone()).is_some() })?; let frange = FileRange { file_id: position.file_id, range: node.text_range() }; @@ -716,4 +718,26 @@ fn test_hover_tuple_field() { assert_eq!(trim_markup_opt(hover.info.first()), Some("i32")); assert_eq!(hover.info.is_exact(), true); } + + #[test] + fn test_hover_through_macro() { + let (analysis, position) = single_file_with_position( + " + macro_rules! id { + ($($tt:$tt)*) => { $($tt)* } + } + + fn foo() {} + + id! { + fn bar() { + foo<|>(); + } + } + ", + ); + let hover = analysis.hover(position).unwrap().unwrap(); + assert_eq!(trim_markup_opt(hover.info.first()), Some("fn foo()")); + assert_eq!(hover.info.is_exact(), true); + } } From 90f6f6080ea5f3f8588ed4a10056820e418e78d0 Mon Sep 17 00:00:00 2001 From: kjeremy Date: Mon, 18 Nov 2019 14:02:02 -0500 Subject: [PATCH 2/2] Fix test --- crates/ra_ide_api/src/hover.rs | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/crates/ra_ide_api/src/hover.rs b/crates/ra_ide_api/src/hover.rs index 78210b085fe..787b714b3ad 100644 --- a/crates/ra_ide_api/src/hover.rs +++ b/crates/ra_ide_api/src/hover.rs @@ -197,8 +197,7 @@ pub(crate) fn hover(db: &RootDatabase, position: FilePosition) -> Option { if let Some(name_kind) = classify_name(db, token.with_ast(&name)).map(|d| d.kind) { - let mut _b: bool = true; - res.extend(hover_text_from_name_kind(db, name_kind, &mut _b)); + res.extend(hover_text_from_name_kind(db, name_kind, &mut true)); } if !res.is_empty() { @@ -721,23 +720,20 @@ fn test_hover_tuple_field() { #[test] fn test_hover_through_macro() { - let (analysis, position) = single_file_with_position( + check_hover_result( " + //- /lib.rs macro_rules! id { - ($($tt:$tt)*) => { $($tt)* } + ($($tt:tt)*) => { $($tt)* } } - fn foo() {} - id! { fn bar() { - foo<|>(); + fo<|>o(); } } ", + &["fn foo()"], ); - let hover = analysis.hover(position).unwrap().unwrap(); - assert_eq!(trim_markup_opt(hover.info.first()), Some("fn foo()")); - assert_eq!(hover.info.is_exact(), true); } }