crates/mbe/src/syntax_bridge.rs

   1 //! Conversions between [`SyntaxNode`] and [`tt::TokenTree`].
   2
   3 use parser::{FragmentKind, ParseError, TreeSink};
   4 use rustc_hash::FxHashMap;
   5 use syntax::{
   6     ast::{self, make::tokens::doc_comment},
   7     tokenize, AstToken, Parse, SmolStr, SyntaxKind,
   8     SyntaxKind::*,
   9     SyntaxNode, SyntaxToken, SyntaxTreeBuilder, TextRange, TextSize, Token as RawToken, T,
  10 };
  11 use tt::buffer::{Cursor, TokenBuffer};
  12
  13 use crate::{subtree_source::SubtreeTokenSource, tt_iter::TtIter};
  14 use crate::{ExpandError, TokenMap};
  15
  16 /// Convert the syntax tree (what user has written) to a `TokenTree` (what macro
  17 /// will consume).
  18 pub fn ast_to_token_tree(ast: &impl ast::AstNode) -> (tt::Subtree, TokenMap) {
  19     syntax_node_to_token_tree(ast.syntax())
  20 }
  21
  22 /// Convert the syntax node to a `TokenTree` (what macro
  23 /// will consume).
  24 pub fn syntax_node_to_token_tree(node: &SyntaxNode) -> (tt::Subtree, TokenMap) {
  25     let global_offset = node.text_range().start();
  26     let mut c = Convertor::new(node, global_offset);
  27     let subtree = convert_tokens(&mut c);
  28     c.id_alloc.map.shrink_to_fit();
  29     (subtree, c.id_alloc.map)
  30 }
  31
  32 // The following items are what `rustc` macro can be parsed into :
  33 // link: https://github.com/rust-lang/rust/blob/9ebf47851a357faa4cd97f4b1dc7835f6376e639/src/libsyntax/ext/expand.rs#L141
  34 // * Expr(P<ast::Expr>)                     -> token_tree_to_expr
  35 // * Pat(P<ast::Pat>)                       -> token_tree_to_pat
  36 // * Ty(P<ast::Ty>)                         -> token_tree_to_ty
  37 // * Stmts(SmallVec<[ast::Stmt; 1]>)        -> token_tree_to_stmts
  38 // * Items(SmallVec<[P<ast::Item>; 1]>)     -> token_tree_to_items
  39 //
  40 // * TraitItems(SmallVec<[ast::TraitItem; 1]>)
  41 // * AssocItems(SmallVec<[ast::AssocItem; 1]>)
  42 // * ForeignItems(SmallVec<[ast::ForeignItem; 1]>
  43
  44 pub fn token_tree_to_syntax_node(
  45     tt: &tt::Subtree,
  46     fragment_kind: FragmentKind,
  47 ) -> Result<(Parse<SyntaxNode>, TokenMap), ExpandError> {
  48     let buffer = match tt {
  49         tt::Subtree { delimiter: None, token_trees } => {
  50             TokenBuffer::from_tokens(token_trees.as_slice())
  51         }
  52         _ => TokenBuffer::from_subtree(tt),
  53     };
  54     let mut token_source = SubtreeTokenSource::new(&buffer);
  55     let mut tree_sink = TtTreeSink::new(buffer.begin());
  56     parser::parse_fragment(&mut token_source, &mut tree_sink, fragment_kind);
  57     if tree_sink.roots.len() != 1 {
  58         return Err(ExpandError::ConversionError);
  59     }
  60     //FIXME: would be cool to report errors
  61     let (parse, range_map) = tree_sink.finish();
  62     Ok((parse, range_map))
  63 }
  64
  65 /// Convert a string to a `TokenTree`
  66 pub fn parse_to_token_tree(text: &str) -> Option<(tt::Subtree, TokenMap)> {
  67     let (tokens, errors) = tokenize(text);
  68     if !errors.is_empty() {
  69         return None;
  70     }
  71
  72     let mut conv = RawConvertor {
  73         text,
  74         offset: TextSize::default(),
  75         inner: tokens.iter(),
  76         id_alloc: TokenIdAlloc {
  77             map: Default::default(),
  78             global_offset: TextSize::default(),
  79             next_id: 0,
  80         },
  81     };
  82
  83     let subtree = convert_tokens(&mut conv);
  84     Some((subtree, conv.id_alloc.map))
  85 }
  86
  87 /// Split token tree with seperate expr: $($e:expr)SEP*
  88 pub fn parse_exprs_with_sep(tt: &tt::Subtree, sep: char) -> Vec<tt::Subtree> {
  89     if tt.token_trees.is_empty() {
  90         return Vec::new();
  91     }
  92
  93     let mut iter = TtIter::new(tt);
  94     let mut res = Vec::new();
  95
  96     while iter.peek_n(0).is_some() {
  97         let expanded = iter.expect_fragment(FragmentKind::Expr);
  98         if expanded.err.is_some() {
  99             break;
 100         }
 101
 102         res.push(match expanded.value {
 103             None => break,
 104             Some(tt @ tt::TokenTree::Leaf(_)) => {
 105                 tt::Subtree { delimiter: None, token_trees: vec![tt] }
 106             }
 107             Some(tt::TokenTree::Subtree(tt)) => tt,
 108         });
 109
 110         let mut fork = iter.clone();
 111         if fork.expect_char(sep).is_err() {
 112             break;
 113         }
 114         iter = fork;
 115     }
 116
 117     if iter.peek_n(0).is_some() {
 118         res.push(tt::Subtree { delimiter: None, token_trees: iter.into_iter().cloned().collect() });
 119     }
 120
 121     res
 122 }
 123
 124 fn convert_tokens<C: TokenConvertor>(conv: &mut C) -> tt::Subtree {
 125     let mut subtree = tt::Subtree { delimiter: None, ..Default::default() };
 126     while conv.peek().is_some() {
 127         collect_leaf(conv, &mut subtree.token_trees);
 128     }
 129     if subtree.token_trees.len() == 1 {
 130         if let tt::TokenTree::Subtree(first) = &subtree.token_trees[0] {
 131             return first.clone();
 132         }
 133     }
 134     return subtree;
 135
 136     fn collect_leaf<C: TokenConvertor>(conv: &mut C, result: &mut Vec<tt::TokenTree>) {
 137         let (token, range) = match conv.bump() {
 138             None => return,
 139             Some(it) => it,
 140         };
 141
 142         let k: SyntaxKind = token.kind();
 143         if k == COMMENT {
 144             if let Some(tokens) = conv.convert_doc_comment(&token) {
 145                 result.extend(tokens);
 146             }
 147             return;
 148         }
 149
 150         result.push(if k.is_punct() && k != UNDERSCORE {
 151             assert_eq!(range.len(), TextSize::of('.'));
 152             let delim = match k {
 153                 T!['('] => Some((tt::DelimiterKind::Parenthesis, T![')'])),
 154                 T!['{'] => Some((tt::DelimiterKind::Brace, T!['}'])),
 155                 T!['['] => Some((tt::DelimiterKind::Bracket, T![']'])),
 156                 _ => None,
 157             };
 158
 159             if let Some((kind, closed)) = delim {
 160                 let mut subtree = tt::Subtree::default();
 161                 let (id, idx) = conv.id_alloc().open_delim(range);
 162                 subtree.delimiter = Some(tt::Delimiter { id, kind });
 163
 164                 while conv.peek().map_or(false, |it| it.kind() != closed) {
 165                     collect_leaf(conv, &mut subtree.token_trees);
 166                 }
 167                 let last_range = match conv.bump() {
 168                     None => {
 169                         // For error resilience, we insert an char punct for the opening delim here
 170                         conv.id_alloc().close_delim(idx, None);
 171                         let leaf: tt::Leaf = tt::Punct {
 172                             id: conv.id_alloc().alloc(range),
 173                             char: token.to_char().unwrap(),
 174                             spacing: tt::Spacing::Alone,
 175                         }
 176                         .into();
 177                         result.push(leaf.into());
 178                         result.extend(subtree.token_trees);
 179                         return;
 180                     }
 181                     Some(it) => it.1,
 182                 };
 183                 conv.id_alloc().close_delim(idx, Some(last_range));
 184                 subtree.into()
 185             } else {
 186                 let spacing = match conv.peek() {
 187                     Some(next)
 188                         if next.kind().is_trivia()
 189                             || next.kind() == T!['[']
 190                             || next.kind() == T!['{']
 191                             || next.kind() == T!['('] =>
 192                     {
 193                         tt::Spacing::Alone
 194                     }
 195                     Some(next) if next.kind().is_punct() && next.kind() != UNDERSCORE => {
 196                         tt::Spacing::Joint
 197                     }
 198                     _ => tt::Spacing::Alone,
 199                 };
 200                 let char = match token.to_char() {
 201                     Some(c) => c,
 202                     None => {
 203                         panic!("Token from lexer must be single char: token = {:#?}", token);
 204                     }
 205                 };
 206                 tt::Leaf::from(tt::Punct { char, spacing, id: conv.id_alloc().alloc(range) }).into()
 207             }
 208         } else {
 209             macro_rules! make_leaf {
 210                 ($i:ident) => {
 211                     tt::$i { id: conv.id_alloc().alloc(range), text: token.to_text() }.into()
 212                 };
 213             }
 214             let leaf: tt::Leaf = match k {
 215                 T![true] | T![false] => make_leaf!(Ident),
 216                 IDENT => make_leaf!(Ident),
 217                 UNDERSCORE => make_leaf!(Ident),
 218                 k if k.is_keyword() => make_leaf!(Ident),
 219                 k if k.is_literal() => make_leaf!(Literal),
 220                 LIFETIME_IDENT => {
 221                     let char_unit = TextSize::of('\'');
 222                     let r = TextRange::at(range.start(), char_unit);
 223                     let apostrophe = tt::Leaf::from(tt::Punct {
 224                         char: '\'',
 225                         spacing: tt::Spacing::Joint,
 226                         id: conv.id_alloc().alloc(r),
 227                     });
 228                     result.push(apostrophe.into());
 229
 230                     let r = TextRange::at(range.start() + char_unit, range.len() - char_unit);
 231                     let ident = tt::Leaf::from(tt::Ident {
 232                         text: SmolStr::new(&token.to_text()[1..]),
 233                         id: conv.id_alloc().alloc(r),
 234                     });
 235                     result.push(ident.into());
 236                     return;
 237                 }
 238                 _ => return,
 239             };
 240
 241             leaf.into()
 242         });
 243     }
 244 }
 245
 246 /// Returns the textual content of a doc comment block as a quoted string
 247 /// That is, strips leading `///` (or `/**`, etc)
 248 /// and strips the ending `*/`
 249 /// And then quote the string, which is needed to convert to `tt::Literal`
 250 fn doc_comment_text(comment: &ast::Comment) -> SmolStr {
 251     let prefix_len = comment.prefix().len();
 252     let mut text = &comment.text()[prefix_len..];
 253
 254     // Remove ending "*/"
 255     if comment.kind().shape == ast::CommentShape::Block {
 256         text = &text[0..text.len() - 2];
 257     }
 258
 259     // Quote the string
 260     // Note that `tt::Literal` expect an escaped string
 261     let text = format!("\"{}\"", text.escape_debug());
 262     text.into()
 263 }
 264
 265 fn convert_doc_comment(token: &syntax::SyntaxToken) -> Option<Vec<tt::TokenTree>> {
 266     let comment = ast::Comment::cast(token.clone())?;
 267     let doc = comment.kind().doc?;
 268
 269     // Make `doc="\" Comments\""
 270     let meta_tkns = vec![mk_ident("doc"), mk_punct('='), mk_doc_literal(&comment)];
 271
 272     // Make `#![]`
 273     let mut token_trees = vec![mk_punct('#')];
 274     if let ast::CommentPlacement::Inner = doc {
 275         token_trees.push(mk_punct('!'));
 276     }
 277     token_trees.push(tt::TokenTree::from(tt::Subtree {
 278         delimiter: Some(tt::Delimiter {
 279             kind: tt::DelimiterKind::Bracket,
 280             id: tt::TokenId::unspecified(),
 281         }),
 282         token_trees: meta_tkns,
 283     }));
 284
 285     return Some(token_trees);
 286
 287     // Helper functions
 288     fn mk_ident(s: &str) -> tt::TokenTree {
 289         tt::TokenTree::from(tt::Leaf::from(tt::Ident {
 290             text: s.into(),
 291             id: tt::TokenId::unspecified(),
 292         }))
 293     }
 294
 295     fn mk_punct(c: char) -> tt::TokenTree {
 296         tt::TokenTree::from(tt::Leaf::from(tt::Punct {
 297             char: c,
 298             spacing: tt::Spacing::Alone,
 299             id: tt::TokenId::unspecified(),
 300         }))
 301     }
 302
 303     fn mk_doc_literal(comment: &ast::Comment) -> tt::TokenTree {
 304         let lit = tt::Literal { text: doc_comment_text(comment), id: tt::TokenId::unspecified() };
 305
 306         tt::TokenTree::from(tt::Leaf::from(lit))
 307     }
 308 }
 309
 310 struct TokenIdAlloc {
 311     map: TokenMap,
 312     global_offset: TextSize,
 313     next_id: u32,
 314 }
 315
 316 impl TokenIdAlloc {
 317     fn alloc(&mut self, absolute_range: TextRange) -> tt::TokenId {
 318         let relative_range = absolute_range - self.global_offset;
 319         let token_id = tt::TokenId(self.next_id);
 320         self.next_id += 1;
 321         self.map.insert(token_id, relative_range);
 322         token_id
 323     }
 324
 325     fn open_delim(&mut self, open_abs_range: TextRange) -> (tt::TokenId, usize) {
 326         let token_id = tt::TokenId(self.next_id);
 327         self.next_id += 1;
 328         let idx = self.map.insert_delim(
 329             token_id,
 330             open_abs_range - self.global_offset,
 331             open_abs_range - self.global_offset,
 332         );
 333         (token_id, idx)
 334     }
 335
 336     fn close_delim(&mut self, idx: usize, close_abs_range: Option<TextRange>) {
 337         match close_abs_range {
 338             None => {
 339                 self.map.remove_delim(idx);
 340             }
 341             Some(close) => {
 342                 self.map.update_close_delim(idx, close - self.global_offset);
 343             }
 344         }
 345     }
 346 }
 347
 348 /// A Raw Token (straightly from lexer) convertor
 349 struct RawConvertor<'a> {
 350     text: &'a str,
 351     offset: TextSize,
 352     id_alloc: TokenIdAlloc,
 353     inner: std::slice::Iter<'a, RawToken>,
 354 }
 355
 356 trait SrcToken: std::fmt::Debug {
 357     fn kind(&self) -> SyntaxKind;
 358
 359     fn to_char(&self) -> Option<char>;
 360
 361     fn to_text(&self) -> SmolStr;
 362 }
 363
 364 trait TokenConvertor {
 365     type Token: SrcToken;
 366
 367     fn convert_doc_comment(&self, token: &Self::Token) -> Option<Vec<tt::TokenTree>>;
 368
 369     fn bump(&mut self) -> Option<(Self::Token, TextRange)>;
 370
 371     fn peek(&self) -> Option<Self::Token>;
 372
 373     fn id_alloc(&mut self) -> &mut TokenIdAlloc;
 374 }
 375
 376 impl<'a> SrcToken for (&'a RawToken, &'a str) {
 377     fn kind(&self) -> SyntaxKind {
 378         self.0.kind
 379     }
 380
 381     fn to_char(&self) -> Option<char> {
 382         self.1.chars().next()
 383     }
 384
 385     fn to_text(&self) -> SmolStr {
 386         self.1.into()
 387     }
 388 }
 389
 390 impl RawConvertor<'_> {}
 391
 392 impl<'a> TokenConvertor for RawConvertor<'a> {
 393     type Token = (&'a RawToken, &'a str);
 394
 395     fn convert_doc_comment(&self, token: &Self::Token) -> Option<Vec<tt::TokenTree>> {
 396         convert_doc_comment(&doc_comment(token.1))
 397     }
 398
 399     fn bump(&mut self) -> Option<(Self::Token, TextRange)> {
 400         let token = self.inner.next()?;
 401         let range = TextRange::at(self.offset, token.len);
 402         self.offset += token.len;
 403
 404         Some(((token, &self.text[range]), range))
 405     }
 406
 407     fn peek(&self) -> Option<Self::Token> {
 408         let token = self.inner.as_slice().get(0);
 409
 410         token.map(|it| {
 411             let range = TextRange::at(self.offset, it.len);
 412             (it, &self.text[range])
 413         })
 414     }
 415
 416     fn id_alloc(&mut self) -> &mut TokenIdAlloc {
 417         &mut self.id_alloc
 418     }
 419 }
 420
 421 struct Convertor {
 422     id_alloc: TokenIdAlloc,
 423     current: Option<SyntaxToken>,
 424     range: TextRange,
 425     punct_offset: Option<(SyntaxToken, TextSize)>,
 426 }
 427
 428 impl Convertor {
 429     fn new(node: &SyntaxNode, global_offset: TextSize) -> Convertor {
 430         Convertor {
 431             id_alloc: { TokenIdAlloc { map: TokenMap::default(), global_offset, next_id: 0 } },
 432             current: node.first_token(),
 433             range: node.text_range(),
 434             punct_offset: None,
 435         }
 436     }
 437 }
 438
 439 #[derive(Debug)]
 440 enum SynToken {
 441     Ordinary(SyntaxToken),
 442     Punch(SyntaxToken, TextSize),
 443 }
 444
 445 impl SynToken {
 446     fn token(&self) -> &SyntaxToken {
 447         match self {
 448             SynToken::Ordinary(it) => it,
 449             SynToken::Punch(it, _) => it,
 450         }
 451     }
 452 }
 453
 454 impl SrcToken for SynToken {
 455     fn kind(&self) -> SyntaxKind {
 456         self.token().kind()
 457     }
 458     fn to_char(&self) -> Option<char> {
 459         match self {
 460             SynToken::Ordinary(_) => None,
 461             SynToken::Punch(it, i) => it.text().chars().nth((*i).into()),
 462         }
 463     }
 464     fn to_text(&self) -> SmolStr {
 465         self.token().text().into()
 466     }
 467 }
 468
 469 impl TokenConvertor for Convertor {
 470     type Token = SynToken;
 471     fn convert_doc_comment(&self, token: &Self::Token) -> Option<Vec<tt::TokenTree>> {
 472         convert_doc_comment(token.token())
 473     }
 474
 475     fn bump(&mut self) -> Option<(Self::Token, TextRange)> {
 476         if let Some((punct, offset)) = self.punct_offset.clone() {
 477             if usize::from(offset) + 1 < punct.text().len() {
 478                 let offset = offset + TextSize::of('.');
 479                 let range = punct.text_range();
 480                 self.punct_offset = Some((punct.clone(), offset));
 481                 let range = TextRange::at(range.start() + offset, TextSize::of('.'));
 482                 return Some((SynToken::Punch(punct, offset), range));
 483             }
 484         }
 485
 486         let curr = self.current.clone()?;
 487         if !&self.range.contains_range(curr.text_range()) {
 488             return None;
 489         }
 490         self.current = curr.next_token();
 491
 492         let token = if curr.kind().is_punct() {
 493             let range = curr.text_range();
 494             let range = TextRange::at(range.start(), TextSize::of('.'));
 495             self.punct_offset = Some((curr.clone(), 0.into()));
 496             (SynToken::Punch(curr, 0.into()), range)
 497         } else {
 498             self.punct_offset = None;
 499             let range = curr.text_range();
 500             (SynToken::Ordinary(curr), range)
 501         };
 502
 503         Some(token)
 504     }
 505
 506     fn peek(&self) -> Option<Self::Token> {
 507         if let Some((punct, mut offset)) = self.punct_offset.clone() {
 508             offset += TextSize::of('.');
 509             if usize::from(offset) < punct.text().len() {
 510                 return Some(SynToken::Punch(punct, offset));
 511             }
 512         }
 513
 514         let curr = self.current.clone()?;
 515         if !self.range.contains_range(curr.text_range()) {
 516             return None;
 517         }
 518
 519         let token = if curr.kind().is_punct() {
 520             SynToken::Punch(curr, 0.into())
 521         } else {
 522             SynToken::Ordinary(curr)
 523         };
 524         Some(token)
 525     }
 526
 527     fn id_alloc(&mut self) -> &mut TokenIdAlloc {
 528         &mut self.id_alloc
 529     }
 530 }
 531
 532 struct TtTreeSink<'a> {
 533     buf: String,
 534     cursor: Cursor<'a>,
 535     open_delims: FxHashMap<tt::TokenId, TextSize>,
 536     text_pos: TextSize,
 537     inner: SyntaxTreeBuilder,
 538     token_map: TokenMap,
 539
 540     // Number of roots
 541     // Use for detect ill-form tree which is not single root
 542     roots: smallvec::SmallVec<[usize; 1]>,
 543 }
 544
 545 impl<'a> TtTreeSink<'a> {
 546     fn new(cursor: Cursor<'a>) -> Self {
 547         TtTreeSink {
 548             buf: String::new(),
 549             cursor,
 550             open_delims: FxHashMap::default(),
 551             text_pos: 0.into(),
 552             inner: SyntaxTreeBuilder::default(),
 553             roots: smallvec::SmallVec::new(),
 554             token_map: TokenMap::default(),
 555         }
 556     }
 557
 558     fn finish(mut self) -> (Parse<SyntaxNode>, TokenMap) {
 559         self.token_map.shrink_to_fit();
 560         (self.inner.finish(), self.token_map)
 561     }
 562 }
 563
 564 fn delim_to_str(d: Option<tt::DelimiterKind>, closing: bool) -> &'static str {
 565     let texts = match d {
 566         Some(tt::DelimiterKind::Parenthesis) => "()",
 567         Some(tt::DelimiterKind::Brace) => "{}",
 568         Some(tt::DelimiterKind::Bracket) => "[]",
 569         None => return "",
 570     };
 571
 572     let idx = closing as usize;
 573     &texts[idx..texts.len() - (1 - idx)]
 574 }
 575
 576 impl<'a> TreeSink for TtTreeSink<'a> {
 577     fn token(&mut self, kind: SyntaxKind, mut n_tokens: u8) {
 578         if kind == L_DOLLAR || kind == R_DOLLAR {
 579             self.cursor = self.cursor.bump_subtree();
 580             return;
 581         }
 582         if kind == LIFETIME_IDENT {
 583             n_tokens = 2;
 584         }
 585
 586         let mut last = self.cursor;
 587         for _ in 0..n_tokens {
 588             let tmp_str: SmolStr;
 589             if self.cursor.eof() {
 590                 break;
 591             }
 592             last = self.cursor;
 593             let text: &str = match self.cursor.token_tree() {
 594                 Some(tt::buffer::TokenTreeRef::Leaf(leaf, _)) => {
 595                     // Mark the range if needed
 596                     let (text, id) = match leaf {
 597                         tt::Leaf::Ident(ident) => (&ident.text, ident.id),
 598                         tt::Leaf::Punct(punct) => {
 599                             assert!(punct.char.is_ascii());
 600                             let char = &(punct.char as u8);
 601                             tmp_str = SmolStr::new_inline(
 602                                 std::str::from_utf8(std::slice::from_ref(char)).unwrap(),
 603                             );
 604                             (&tmp_str, punct.id)
 605                         }
 606                         tt::Leaf::Literal(lit) => (&lit.text, lit.id),
 607                     };
 608                     let range = TextRange::at(self.text_pos, TextSize::of(text.as_str()));
 609                     self.token_map.insert(id, range);
 610                     self.cursor = self.cursor.bump();
 611                     text
 612                 }
 613                 Some(tt::buffer::TokenTreeRef::Subtree(subtree, _)) => {
 614                     self.cursor = self.cursor.subtree().unwrap();
 615                     if let Some(id) = subtree.delimiter.map(|it| it.id) {
 616                         self.open_delims.insert(id, self.text_pos);
 617                     }
 618                     delim_to_str(subtree.delimiter_kind(), false)
 619                 }
 620                 None => {
 621                     if let Some(parent) = self.cursor.end() {
 622                         self.cursor = self.cursor.bump();
 623                         if let Some(id) = parent.delimiter.map(|it| it.id) {
 624                             if let Some(open_delim) = self.open_delims.get(&id) {
 625                                 let open_range = TextRange::at(*open_delim, TextSize::of('('));
 626                                 let close_range = TextRange::at(self.text_pos, TextSize::of('('));
 627                                 self.token_map.insert_delim(id, open_range, close_range);
 628                             }
 629                         }
 630                         delim_to_str(parent.delimiter_kind(), true)
 631                     } else {
 632                         continue;
 633                     }
 634                 }
 635             };
 636             self.buf += text;
 637             self.text_pos += TextSize::of(text);
 638         }
 639
 640         self.inner.token(kind, self.buf.as_str());
 641         self.buf.clear();
 642         // Add whitespace between adjoint puncts
 643         let next = last.bump();
 644         if let (
 645             Some(tt::buffer::TokenTreeRef::Leaf(tt::Leaf::Punct(curr), _)),
 646             Some(tt::buffer::TokenTreeRef::Leaf(tt::Leaf::Punct(_), _)),
 647         ) = (last.token_tree(), next.token_tree())
 648         {
 649             // Note: We always assume the semi-colon would be the last token in
 650             // other parts of RA such that we don't add whitespace here.
 651             if curr.spacing == tt::Spacing::Alone && curr.char != ';' {
 652                 self.inner.token(WHITESPACE, " ");
 653                 self.text_pos += TextSize::of(' ');
 654             }
 655         }
 656     }
 657
 658     fn start_node(&mut self, kind: SyntaxKind) {
 659         self.inner.start_node(kind);
 660
 661         match self.roots.last_mut() {
 662             None | Some(0) => self.roots.push(1),
 663             Some(ref mut n) => **n += 1,
 664         };
 665     }
 666
 667     fn finish_node(&mut self) {
 668         self.inner.finish_node();
 669         *self.roots.last_mut().unwrap() -= 1;
 670     }
 671
 672     fn error(&mut self, error: ParseError) {
 673         self.inner.error(error, self.text_pos)
 674     }
 675 }
 676
 677 #[cfg(test)]
 678 mod tests {
 679     use super::*;
 680     use crate::tests::parse_macro;
 681     use parser::TokenSource;
 682     use syntax::{
 683         algo::{insert_children, InsertPosition},
 684         ast::AstNode,
 685     };
 686
 687     #[test]
 688     fn convert_tt_token_source() {
 689         let expansion = parse_macro(
 690             r#"
 691             macro_rules! literals {
 692                 ($i:ident) => {
 693                     {
 694                         let a = 'c';
 695                         let c = 1000;
 696                         let f = 12E+99_f64;
 697                         let s = "rust1";
 698                     }
 699                 }
 700             }
 701             "#,
 702         )
 703         .expand_tt("literals!(foo);");
 704         let tts = &[expansion.into()];
 705         let buffer = tt::buffer::TokenBuffer::from_tokens(tts);
 706         let mut tt_src = SubtreeTokenSource::new(&buffer);
 707         let mut tokens = vec![];
 708         while tt_src.current().kind != EOF {
 709             tokens.push((tt_src.current().kind, tt_src.text()));
 710             tt_src.bump();
 711         }
 712
 713         // [${]
 714         // [let] [a] [=] ['c'] [;]
 715         assert_eq!(tokens[2 + 3].1, "'c'");
 716         assert_eq!(tokens[2 + 3].0, CHAR);
 717         // [let] [c] [=] [1000] [;]
 718         assert_eq!(tokens[2 + 5 + 3].1, "1000");
 719         assert_eq!(tokens[2 + 5 + 3].0, INT_NUMBER);
 720         // [let] [f] [=] [12E+99_f64] [;]
 721         assert_eq!(tokens[2 + 10 + 3].1, "12E+99_f64");
 722         assert_eq!(tokens[2 + 10 + 3].0, FLOAT_NUMBER);
 723
 724         // [let] [s] [=] ["rust1"] [;]
 725         assert_eq!(tokens[2 + 15 + 3].1, "\"rust1\"");
 726         assert_eq!(tokens[2 + 15 + 3].0, STRING);
 727     }
 728
 729     #[test]
 730     fn stmts_token_trees_to_expr_is_err() {
 731         let expansion = parse_macro(
 732             r#"
 733             macro_rules! stmts {
 734                 () => {
 735                     let a = 0;
 736                     let b = 0;
 737                     let c = 0;
 738                     let d = 0;
 739                 }
 740             }
 741             "#,
 742         )
 743         .expand_tt("stmts!();");
 744         assert!(token_tree_to_syntax_node(&expansion, FragmentKind::Expr).is_err());
 745     }
 746
 747     #[test]
 748     fn test_token_tree_last_child_is_white_space() {
 749         let source_file = ast::SourceFile::parse("f!({} );").ok().unwrap();
 750         let macro_call = source_file.syntax().descendants().find_map(ast::MacroCall::cast).unwrap();
 751         let token_tree = macro_call.token_tree().unwrap();
 752
 753         // Token Tree now is :
 754         // TokenTree
 755         // - T!['(']
 756         // - TokenTree
 757         //   - T!['{']
 758         //   - T!['}']
 759         // - WHITE_SPACE
 760         // - T![')']
 761
 762         let rbrace =
 763             token_tree.syntax().descendants_with_tokens().find(|it| it.kind() == T!['}']).unwrap();
 764         let space = token_tree
 765             .syntax()
 766             .descendants_with_tokens()
 767             .find(|it| it.kind() == SyntaxKind::WHITESPACE)
 768             .unwrap();
 769
 770         // reorder th white space, such that the white is inside the inner token-tree.
 771         let token_tree = insert_children(
 772             &rbrace.parent().unwrap(),
 773             InsertPosition::Last,
 774             std::iter::once(space),
 775         );
 776
 777         // Token Tree now is :
 778         // TokenTree
 779         // - T!['{']
 780         // - T!['}']
 781         // - WHITE_SPACE
 782         let token_tree = ast::TokenTree::cast(token_tree).unwrap();
 783         let tt = ast_to_token_tree(&token_tree).0;
 784
 785         assert_eq!(tt.delimiter_kind(), Some(tt::DelimiterKind::Brace));
 786     }
 787
 788     #[test]
 789     fn test_token_tree_multi_char_punct() {
 790         let source_file = ast::SourceFile::parse("struct Foo { a: x::Y }").ok().unwrap();
 791         let struct_def = source_file.syntax().descendants().find_map(ast::Struct::cast).unwrap();
 792         let tt = ast_to_token_tree(&struct_def).0;
 793         token_tree_to_syntax_node(&tt, FragmentKind::Item).unwrap();
 794     }
 795 }