aboutsummaryrefslogtreecommitdiff
path: root/crates/ra_mbe
diff options
context:
space:
mode:
Diffstat (limited to 'crates/ra_mbe')
-rw-r--r--crates/ra_mbe/src/lib.rs86
-rw-r--r--crates/ra_mbe/src/syntax_bridge.rs66
2 files changed, 142 insertions, 10 deletions
diff --git a/crates/ra_mbe/src/lib.rs b/crates/ra_mbe/src/lib.rs
index 8d5008d20..9d4744838 100644
--- a/crates/ra_mbe/src/lib.rs
+++ b/crates/ra_mbe/src/lib.rs
@@ -37,9 +37,19 @@ pub enum ExpandError {
37 NoMatchingRule, 37 NoMatchingRule,
38 UnexpectedToken, 38 UnexpectedToken,
39 BindingError(String), 39 BindingError(String),
40 ConversionError,
40} 41}
41 42
42pub use crate::syntax_bridge::{ast_to_token_tree, token_tree_to_ast_item_list, syntax_node_to_token_tree}; 43pub use crate::syntax_bridge::{
44 ast_to_token_tree,
45 token_tree_to_ast_item_list,
46 syntax_node_to_token_tree,
47 token_tree_to_expr,
48 token_tree_to_pat,
49 token_tree_to_ty,
50 token_tree_to_macro_items,
51 token_tree_to_macro_stmts,
52};
43 53
44/// This struct contains AST for a single `macro_rules` definition. What might 54/// This struct contains AST for a single `macro_rules` definition. What might
45/// be very confusing is that AST has almost exactly the same shape as 55/// be very confusing is that AST has almost exactly the same shape as
@@ -192,23 +202,26 @@ impl_froms!(TokenTree: Leaf, Subtree);
192 pub(crate) fn expand_to_syntax( 202 pub(crate) fn expand_to_syntax(
193 rules: &MacroRules, 203 rules: &MacroRules,
194 invocation: &str, 204 invocation: &str,
195 ) -> ra_syntax::TreeArc<ast::SourceFile> { 205 ) -> ra_syntax::TreeArc<ast::MacroItems> {
196 let expanded = expand(rules, invocation); 206 let expanded = expand(rules, invocation);
197 token_tree_to_ast_item_list(&expanded) 207 token_tree_to_macro_items(&expanded).unwrap()
198 } 208 }
199 209
200 pub(crate) fn assert_expansion(rules: &MacroRules, invocation: &str, expansion: &str) { 210 pub(crate) fn assert_expansion(rules: &MacroRules, invocation: &str, expansion: &str) {
201 let expanded = expand(rules, invocation); 211 let expanded = expand(rules, invocation);
202 assert_eq!(expanded.to_string(), expansion); 212 assert_eq!(expanded.to_string(), expansion);
203 213
204 let tree = token_tree_to_ast_item_list(&expanded); 214 let tree = token_tree_to_macro_items(&expanded);
205 215
206 // Eat all white space by parse it back and forth 216 // Eat all white space by parse it back and forth
207 let expansion = ast::SourceFile::parse(expansion); 217 let expansion = ast::SourceFile::parse(expansion);
208 let expansion = syntax_node_to_token_tree(expansion.syntax()).unwrap().0; 218 let expansion = syntax_node_to_token_tree(expansion.syntax()).unwrap().0;
209 let file = token_tree_to_ast_item_list(&expansion); 219 let file = token_tree_to_macro_items(&expansion);
210 220
211 assert_eq!(tree.syntax().debug_dump().trim(), file.syntax().debug_dump().trim()); 221 assert_eq!(
222 tree.unwrap().syntax().debug_dump().trim(),
223 file.unwrap().syntax().debug_dump().trim()
224 );
212 } 225 }
213 226
214 #[test] 227 #[test]
@@ -346,11 +359,11 @@ impl_froms!(TokenTree: Leaf, Subtree);
346 ", 359 ",
347 ); 360 );
348 let expansion = expand(&rules, "structs!(Foo, Bar)"); 361 let expansion = expand(&rules, "structs!(Foo, Bar)");
349 let tree = token_tree_to_ast_item_list(&expansion); 362 let tree = token_tree_to_macro_items(&expansion);
350 assert_eq!( 363 assert_eq!(
351 tree.syntax().debug_dump().trim(), 364 tree.unwrap().syntax().debug_dump().trim(),
352 r#" 365 r#"
353SOURCE_FILE@[0; 40) 366MACRO_ITEMS@[0; 40)
354 STRUCT_DEF@[0; 20) 367 STRUCT_DEF@[0; 20)
355 STRUCT_KW@[0; 6) "struct" 368 STRUCT_KW@[0; 6) "struct"
356 NAME@[6; 9) 369 NAME@[6; 9)
@@ -444,6 +457,59 @@ SOURCE_FILE@[0; 40)
444 assert_expansion(&rules, "foo! { foo, bar }", "fn foo () {let a = foo ; let b = bar ;}"); 457 assert_expansion(&rules, "foo! { foo, bar }", "fn foo () {let a = foo ; let b = bar ;}");
445 } 458 }
446 459
460 #[test]
461 fn test_tt_to_stmts() {
462 let rules = create_rules(
463 r#"
464 macro_rules! foo {
465 () => {
466 let a = 0;
467 a = 10 + 1;
468 a
469 }
470 }
471"#,
472 );
473
474 let expanded = expand(&rules, "foo!{}");
475 let stmts = token_tree_to_macro_stmts(&expanded);
476
477 assert_eq!(
478 stmts.unwrap().syntax().debug_dump().trim(),
479 r#"MACRO_STMTS@[0; 15)
480 LET_STMT@[0; 7)
481 LET_KW@[0; 3) "let"
482 BIND_PAT@[3; 4)
483 NAME@[3; 4)
484 IDENT@[3; 4) "a"
485 EQ@[4; 5) "="
486 LITERAL@[5; 6)
487 INT_NUMBER@[5; 6) "0"
488 SEMI@[6; 7) ";"
489 EXPR_STMT@[7; 14)
490 BIN_EXPR@[7; 13)
491 PATH_EXPR@[7; 8)
492 PATH@[7; 8)
493 PATH_SEGMENT@[7; 8)
494 NAME_REF@[7; 8)
495 IDENT@[7; 8) "a"
496 EQ@[8; 9) "="
497 BIN_EXPR@[9; 13)
498 LITERAL@[9; 11)
499 INT_NUMBER@[9; 11) "10"
500 PLUS@[11; 12) "+"
501 LITERAL@[12; 13)
502 INT_NUMBER@[12; 13) "1"
503 SEMI@[13; 14) ";"
504 EXPR_STMT@[14; 15)
505 PATH_EXPR@[14; 15)
506 PATH@[14; 15)
507 PATH_SEGMENT@[14; 15)
508 NAME_REF@[14; 15)
509 IDENT@[14; 15) "a""#,
510 );
511 }
512
447 // The following tests are port from intellij-rust directly 513 // The following tests are port from intellij-rust directly
448 // https://github.com/intellij-rust/intellij-rust/blob/c4e9feee4ad46e7953b1948c112533360b6087bb/src/test/kotlin/org/rust/lang/core/macros/RsMacroExpansionTest.kt 514 // https://github.com/intellij-rust/intellij-rust/blob/c4e9feee4ad46e7953b1948c112533360b6087bb/src/test/kotlin/org/rust/lang/core/macros/RsMacroExpansionTest.kt
449 515
@@ -527,7 +593,7 @@ SOURCE_FILE@[0; 40)
527 593
528 assert_eq!( 594 assert_eq!(
529 expand_to_syntax(&rules, "foo! { 1 + 1 }").syntax().debug_dump().trim(), 595 expand_to_syntax(&rules, "foo! { 1 + 1 }").syntax().debug_dump().trim(),
530 r#"SOURCE_FILE@[0; 15) 596 r#"MACRO_ITEMS@[0; 15)
531 FN_DEF@[0; 15) 597 FN_DEF@[0; 15)
532 FN_KW@[0; 2) "fn" 598 FN_KW@[0; 2) "fn"
533 NAME@[2; 5) 599 NAME@[2; 5)
diff --git a/crates/ra_mbe/src/syntax_bridge.rs b/crates/ra_mbe/src/syntax_bridge.rs
index 28ded7870..5844d3f12 100644
--- a/crates/ra_mbe/src/syntax_bridge.rs
+++ b/crates/ra_mbe/src/syntax_bridge.rs
@@ -5,6 +5,7 @@ use ra_syntax::{
5}; 5};
6 6
7use crate::subtree_source::{SubtreeTokenSource, Querier}; 7use crate::subtree_source::{SubtreeTokenSource, Querier};
8use crate::ExpandError;
8 9
9/// Maps `tt::TokenId` to the relative range of the original token. 10/// Maps `tt::TokenId` to the relative range of the original token.
10#[derive(Default)] 11#[derive(Default)]
@@ -30,6 +31,71 @@ pub fn syntax_node_to_token_tree(node: &SyntaxNode) -> Option<(tt::Subtree, Toke
30 Some((tt, token_map)) 31 Some((tt, token_map))
31} 32}
32 33
34// The following items are what `rustc` macro can be parsed into :
35// link: https://github.com/rust-lang/rust/blob/9ebf47851a357faa4cd97f4b1dc7835f6376e639/src/libsyntax/ext/expand.rs#L141
36// * Expr(P<ast::Expr>) -> token_tree_to_expr
37// * Pat(P<ast::Pat>) -> token_tree_to_pat
38// * Ty(P<ast::Ty>) -> token_tree_to_ty
39// * Stmts(SmallVec<[ast::Stmt; 1]>) -> token_tree_to_stmts
40// * Items(SmallVec<[P<ast::Item>; 1]>) -> token_tree_to_items
41//
42// * TraitItems(SmallVec<[ast::TraitItem; 1]>)
43// * ImplItems(SmallVec<[ast::ImplItem; 1]>)
44// * ForeignItems(SmallVec<[ast::ForeignItem; 1]>
45//
46//
47
48/// Parses the token tree (result of macro expansion) to an expression
49pub fn token_tree_to_expr(tt: &tt::Subtree) -> Result<TreeArc<ast::Expr>, ExpandError> {
50 let token_source = SubtreeTokenSource::new(tt);
51 let mut tree_sink = TtTreeSink::new(token_source.querier());
52 ra_parser::parse_expr(&token_source, &mut tree_sink);
53 let syntax = tree_sink.inner.finish();
54 ast::Expr::cast(&syntax)
55 .map(|m| m.to_owned())
56 .ok_or_else(|| crate::ExpandError::ConversionError)
57}
58
59/// Parses the token tree (result of macro expansion) to a Pattern
60pub fn token_tree_to_pat(tt: &tt::Subtree) -> Result<TreeArc<ast::Pat>, ExpandError> {
61 let token_source = SubtreeTokenSource::new(tt);
62 let mut tree_sink = TtTreeSink::new(token_source.querier());
63 ra_parser::parse_pat(&token_source, &mut tree_sink);
64 let syntax = tree_sink.inner.finish();
65 ast::Pat::cast(&syntax).map(|m| m.to_owned()).ok_or_else(|| ExpandError::ConversionError)
66}
67
68/// Parses the token tree (result of macro expansion) to a Type
69pub fn token_tree_to_ty(tt: &tt::Subtree) -> Result<TreeArc<ast::TypeRef>, ExpandError> {
70 let token_source = SubtreeTokenSource::new(tt);
71 let mut tree_sink = TtTreeSink::new(token_source.querier());
72 ra_parser::parse_ty(&token_source, &mut tree_sink);
73 let syntax = tree_sink.inner.finish();
74 ast::TypeRef::cast(&syntax).map(|m| m.to_owned()).ok_or_else(|| ExpandError::ConversionError)
75}
76
77/// Parses the token tree (result of macro expansion) as a sequence of stmts
78pub fn token_tree_to_macro_stmts(
79 tt: &tt::Subtree,
80) -> Result<TreeArc<ast::MacroStmts>, ExpandError> {
81 let token_source = SubtreeTokenSource::new(tt);
82 let mut tree_sink = TtTreeSink::new(token_source.querier());
83 ra_parser::parse_macro_stmts(&token_source, &mut tree_sink);
84 let syntax = tree_sink.inner.finish();
85 ast::MacroStmts::cast(&syntax).map(|m| m.to_owned()).ok_or_else(|| ExpandError::ConversionError)
86}
87
88/// Parses the token tree (result of macro expansion) as a sequence of items
89pub fn token_tree_to_macro_items(
90 tt: &tt::Subtree,
91) -> Result<TreeArc<ast::MacroItems>, ExpandError> {
92 let token_source = SubtreeTokenSource::new(tt);
93 let mut tree_sink = TtTreeSink::new(token_source.querier());
94 ra_parser::parse_macro_items(&token_source, &mut tree_sink);
95 let syntax = tree_sink.inner.finish();
96 ast::MacroItems::cast(&syntax).map(|m| m.to_owned()).ok_or_else(|| ExpandError::ConversionError)
97}
98
33/// Parses the token tree (result of macro expansion) as a sequence of items 99/// Parses the token tree (result of macro expansion) as a sequence of items
34pub fn token_tree_to_ast_item_list(tt: &tt::Subtree) -> TreeArc<ast::SourceFile> { 100pub fn token_tree_to_ast_item_list(tt: &tt::Subtree) -> TreeArc<ast::SourceFile> {
35 let token_source = SubtreeTokenSource::new(tt); 101 let token_source = SubtreeTokenSource::new(tt);