use std::iter; use hir::Semantics; use ide_db::{helpers::pick_best_token, RootDatabase}; use itertools::Itertools; use syntax::{ast, ted, AstNode, NodeOrToken, SyntaxKind, SyntaxNode, WalkEvent, T}; use crate::FilePosition; pub struct ExpandedMacro { pub name: String, pub expansion: String, } // Feature: Expand Macro Recursively // // Shows the full macro expansion of the macro at current cursor. // // |=== // | Editor | Action Name // // | VS Code | **Rust Analyzer: Expand macro recursively** // |=== // // image::https://user-images.githubusercontent.com/48062697/113020648-b3973180-917a-11eb-84a9-ecb921293dc5.gif[] pub(crate) fn expand_macro(db: &RootDatabase, position: FilePosition) -> Option { let sema = Semantics::new(db); let file = sema.parse(position.file_id); let tok = pick_best_token(file.syntax().token_at_offset(position.offset), |kind| match kind { SyntaxKind::IDENT => 1, _ => 0, })?; // due to how Rust Analyzer works internally, we need to special case derive attributes, // otherwise they might not get found, e.g. here with the cursor at $0 `#[attr]` would expand: // ``` // #[attr] // #[derive($0Foo)] // struct Bar; // ``` let derive = sema.descend_into_macros(tok.clone()).iter().find_map(|descended| { let attr = descended.ancestors().find_map(ast::Attr::cast)?; let (path, tt) = attr.as_simple_call()?; if path == "derive" { let mut tt = tt.syntax().children_with_tokens().skip(1).join(""); tt.pop(); let expansions = sema.expand_derive_macro(&attr)?; return Some(ExpandedMacro { name: tt, expansion: expansions.into_iter().map(insert_whitespaces).join(""), }); } else { None } }); if derive.is_some() { return derive; } // FIXME: Intermix attribute and bang! expansions // currently we only recursively expand one of the two types let mut expanded = None; let mut name = None; for node in tok.ancestors() { if let Some(item) = ast::Item::cast(node.clone()) { if let Some(def) = sema.resolve_attr_macro_call(&item) { name = def.name(db).map(|name| name.to_string()); expanded = expand_attr_macro_recur(&sema, &item); break; } } if let Some(mac) = ast::MacroCall::cast(node) { name = Some(mac.path()?.segment()?.name_ref()?.to_string()); expanded = expand_macro_recur(&sema, &mac); break; } } // FIXME: // macro expansion may lose all white space information // But we hope someday we can use ra_fmt for that let expansion = insert_whitespaces(expanded?); Some(ExpandedMacro { name: name.unwrap_or_else(|| "???".to_owned()), expansion }) } fn expand_macro_recur( sema: &Semantics, macro_call: &ast::MacroCall, ) -> Option { let expanded = sema.expand(macro_call)?.clone_for_update(); expand(sema, expanded, ast::MacroCall::cast, expand_macro_recur) } fn expand_attr_macro_recur(sema: &Semantics, item: &ast::Item) -> Option { let expanded = sema.expand_attr_macro(item)?.clone_for_update(); expand(sema, expanded, ast::Item::cast, expand_attr_macro_recur) } fn expand( sema: &Semantics, expanded: SyntaxNode, f: impl FnMut(SyntaxNode) -> Option, exp: impl Fn(&Semantics, &T) -> Option, ) -> Option { let children = expanded.descendants().filter_map(f); let mut replacements = Vec::new(); for child in children { if let Some(new_node) = exp(sema, &child) { // check if the whole original syntax is replaced if expanded == *child.syntax() { return Some(new_node); } replacements.push((child, new_node)); } } replacements.into_iter().rev().for_each(|(old, new)| ted::replace(old.syntax(), new)); Some(expanded) } // FIXME: It would also be cool to share logic here and in the mbe tests, // which are pretty unreadable at the moment. fn insert_whitespaces(syn: SyntaxNode) -> String { use SyntaxKind::*; let mut res = String::new(); let mut indent = 0; let mut last: Option = None; for event in syn.preorder_with_tokens() { let token = match event { WalkEvent::Enter(NodeOrToken::Token(token)) => token, WalkEvent::Leave(NodeOrToken::Node(node)) if matches!(node.kind(), ATTR | MATCH_ARM | STRUCT | ENUM | UNION | FN | IMPL) => { res.push('\n'); res.extend(iter::repeat(" ").take(2 * indent)); continue; } _ => continue, }; let is_next = |f: fn(SyntaxKind) -> bool, default| -> bool { token.next_token().map(|it| f(it.kind())).unwrap_or(default) }; let is_last = |f: fn(SyntaxKind) -> bool, default| -> bool { last.map(f).unwrap_or(default) }; match token.kind() { k if is_text(k) && is_next(|it| !it.is_punct(), true) => { res.push_str(token.text()); res.push(' '); } L_CURLY if is_next(|it| it != R_CURLY, true) => { indent += 1; if is_last(is_text, false) { res.push(' '); } res.push_str("{\n"); res.extend(iter::repeat(" ").take(2 * indent)); } R_CURLY if is_last(|it| it != L_CURLY, true) => { indent = indent.saturating_sub(1); res.push('\n'); res.extend(iter::repeat(" ").take(2 * indent)); res.push_str("}"); } R_CURLY => { res.push_str("}\n"); res.extend(iter::repeat(" ").take(2 * indent)); } LIFETIME_IDENT if is_next(|it| it == IDENT || it == MUT_KW, true) => { res.push_str(token.text()); res.push(' '); } T![;] => { res.push_str(";\n"); res.extend(iter::repeat(" ").take(2 * indent)); } T![->] => res.push_str(" -> "), T![=] => res.push_str(" = "), T![=>] => res.push_str(" => "), _ => res.push_str(token.text()), } last = Some(token.kind()); } return res; fn is_text(k: SyntaxKind) -> bool { k.is_keyword() || k.is_literal() || k == IDENT } } #[cfg(test)] mod tests { use expect_test::{expect, Expect}; use crate::fixture; #[track_caller] fn check(ra_fixture: &str, expect: Expect) { let (analysis, pos) = fixture::position(ra_fixture); let expansion = analysis.expand_macro(pos).unwrap().unwrap(); let actual = format!("{}\n{}", expansion.name, expansion.expansion); expect.assert_eq(&actual); } #[test] fn macro_expand_recursive_expansion() { check( r#" macro_rules! bar { () => { fn b() {} } } macro_rules! foo { () => { bar!(); } } macro_rules! baz { () => { foo!(); } } f$0oo!(); "#, expect![[r#" foo fn b(){} "#]], ); } #[test] fn macro_expand_multiple_lines() { check( r#" macro_rules! foo { () => { fn some_thing() -> u32 { let a = 0; a + 10 } } } f$0oo!(); "#, expect![[r#" foo fn some_thing() -> u32 { let a = 0; a+10 } "#]], ); } #[test] fn macro_expand_match_ast() { check( r#" macro_rules! match_ast { (match $node:ident { $($tt:tt)* }) => { match_ast!(match ($node) { $($tt)* }) }; (match ($node:expr) { $( ast::$ast:ident($it:ident) => $res:block, )* _ => $catch_all:expr $(,)? }) => {{ $( if let Some($it) = ast::$ast::cast($node.clone()) $res else )* { $catch_all } }}; } fn main() { mat$0ch_ast! { match container { ast::TraitDef(it) => {}, ast::ImplDef(it) => {}, _ => { continue }, } } } "#, expect![[r#" match_ast { if let Some(it) = ast::TraitDef::cast(container.clone()){} else if let Some(it) = ast::ImplDef::cast(container.clone()){} else { { continue } } }"#]], ); } #[test] fn macro_expand_match_ast_inside_let_statement() { check( r#" macro_rules! match_ast { (match $node:ident { $($tt:tt)* }) => { match_ast!(match ($node) { $($tt)* }) }; (match ($node:expr) {}) => {{}}; } fn main() { let p = f(|it| { let res = mat$0ch_ast! { match c {}}; Some(res) })?; } "#, expect![[r#" match_ast {} "#]], ); } #[test] fn macro_expand_inner_macro_fail_to_expand() { check( r#" macro_rules! bar { (BAD) => {}; } macro_rules! foo { () => {bar!()}; } fn main() { let res = fo$0o!(); } "#, expect![[r#" foo "#]], ); } #[test] fn macro_expand_with_dollar_crate() { check( r#" #[macro_export] macro_rules! bar { () => {0}; } macro_rules! foo { () => {$crate::bar!()}; } fn main() { let res = fo$0o!(); } "#, expect![[r#" foo 0 "#]], ); } #[test] fn macro_expand_derive() { check( r#" #[rustc_builtin_macro] pub macro Clone {} #[doc = ""] #[derive(C$0lone)] struct Foo {} "#, expect![[r#" Clone impl< >crate::clone::Clone for Foo< >{} "#]], ); } #[test] fn macro_expand_derive2() { check( r#" #[rustc_builtin_macro] pub macro Clone {} #[rustc_builtin_macro] pub macro Copy {} #[derive(Cop$0y)] #[derive(Clone)] struct Foo {} "#, expect![[r#" Copy impl< >crate::marker::Copy for Foo< >{} "#]], ); } #[test] fn macro_expand_derive_multi() { check( r#" #[rustc_builtin_macro] pub macro Clone {} #[rustc_builtin_macro] pub macro Copy {} #[derive(Cop$0y, Clone)] struct Foo {} "#, expect![[r#" Copy, Clone impl< >crate::marker::Copy for Foo< >{} impl< >crate::clone::Clone for Foo< >{} "#]], ); } }