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     struct StackEntry {
 126         subtree: tt::Subtree,
 127         idx: usize,
 128         open_range: TextRange,
 129     }
 130
 131     let entry = StackEntry {
 132         subtree: tt::Subtree { delimiter: None, ..Default::default() },
 133         // never used (delimiter is `None`)
 134         idx: !0,
 135         open_range: TextRange::empty(TextSize::of('.')),
 136     };
 137     let mut stack = vec![entry];
 138
 139     loop {
 140         let entry = stack.last_mut().unwrap();
 141         let result = &mut entry.subtree.token_trees;
 142         let (token, range) = match conv.bump() {
 143             None => break,
 144             Some(it) => it,
 145         };
 146
 147         let k: SyntaxKind = token.kind();
 148         if k == COMMENT {
 149             if let Some(tokens) = conv.convert_doc_comment(&token) {
 150                 result.extend(tokens);
 151             }
 152             continue;
 153         }
 154
 155         result.push(if k.is_punct() && k != UNDERSCORE {
 156             assert_eq!(range.len(), TextSize::of('.'));
 157
 158             if let Some(delim) = entry.subtree.delimiter {
 159                 let expected = match delim.kind {
 160                     tt::DelimiterKind::Parenthesis => T![')'],
 161                     tt::DelimiterKind::Brace => T!['}'],
 162                     tt::DelimiterKind::Bracket => T![']'],
 163                 };
 164
 165                 if k == expected {
 166                     let entry = stack.pop().unwrap();
 167                     conv.id_alloc().close_delim(entry.idx, Some(range));
 168                     stack.last_mut().unwrap().subtree.token_trees.push(entry.subtree.into());
 169                     continue;
 170                 }
 171             }
 172
 173             let delim = match k {
 174                 T!['('] => Some(tt::DelimiterKind::Parenthesis),
 175                 T!['{'] => Some(tt::DelimiterKind::Brace),
 176                 T!['['] => Some(tt::DelimiterKind::Bracket),
 177                 _ => None,
 178             };
 179
 180             if let Some(kind) = delim {
 181                 let mut subtree = tt::Subtree::default();
 182                 let (id, idx) = conv.id_alloc().open_delim(range);
 183                 subtree.delimiter = Some(tt::Delimiter { id, kind });
 184                 stack.push(StackEntry { subtree, idx, open_range: range });
 185                 continue;
 186             } else {
 187                 let spacing = match conv.peek() {
 188                     Some(next)
 189                         if next.kind().is_trivia()
 190                             || next.kind() == T!['[']
 191                             || next.kind() == T!['{']
 192                             || next.kind() == T!['('] =>
 193                     {
 194                         tt::Spacing::Alone
 195                     }
 196                     Some(next) if next.kind().is_punct() && next.kind() != UNDERSCORE => {
 197                         tt::Spacing::Joint
 198                     }
 199                     _ => tt::Spacing::Alone,
 200                 };
 201                 let char = match token.to_char() {
 202                     Some(c) => c,
 203                     None => {
 204                         panic!("Token from lexer must be single char: token = {:#?}", token);
 205                     }
 206                 };
 207                 tt::Leaf::from(tt::Punct { char, spacing, id: conv.id_alloc().alloc(range) }).into()
 208             }
 209         } else {
 210             macro_rules! make_leaf {
 211                 ($i:ident) => {
 212                     tt::$i { id: conv.id_alloc().alloc(range), text: token.to_text() }.into()
 213                 };
 214             }
 215             let leaf: tt::Leaf = match k {
 216                 T![true] | T![false] => make_leaf!(Ident),
 217                 IDENT => make_leaf!(Ident),
 218                 UNDERSCORE => make_leaf!(Ident),
 219                 k if k.is_keyword() => make_leaf!(Ident),
 220                 k if k.is_literal() => make_leaf!(Literal),
 221                 LIFETIME_IDENT => {
 222                     let char_unit = TextSize::of('\'');
 223                     let r = TextRange::at(range.start(), char_unit);
 224                     let apostrophe = tt::Leaf::from(tt::Punct {
 225                         char: '\'',
 226                         spacing: tt::Spacing::Joint,
 227                         id: conv.id_alloc().alloc(r),
 228                     });
 229                     result.push(apostrophe.into());
 230
 231                     let r = TextRange::at(range.start() + char_unit, range.len() - char_unit);
 232                     let ident = tt::Leaf::from(tt::Ident {
 233                         text: SmolStr::new(&token.to_text()[1..]),
 234                         id: conv.id_alloc().alloc(r),
 235                     });
 236                     result.push(ident.into());
 237                     continue;
 238                 }
 239                 _ => continue,
 240             };
 241
 242             leaf.into()
 243         });
 244     }
 245
 246     // If we get here, we've consumed all input tokens.
 247     // We might have more than one subtree in the stack, if the delimiters are improperly balanced.
 248     // Merge them so we're left with one.
 249     while stack.len() > 1 {
 250         let entry = stack.pop().unwrap();
 251         let parent = stack.last_mut().unwrap();
 252
 253         conv.id_alloc().close_delim(entry.idx, None);
 254         let leaf: tt::Leaf = tt::Punct {
 255             id: conv.id_alloc().alloc(entry.open_range),
 256             char: match entry.subtree.delimiter.unwrap().kind {
 257                 tt::DelimiterKind::Parenthesis => '(',
 258                 tt::DelimiterKind::Brace => '{',
 259                 tt::DelimiterKind::Bracket => '[',
 260             },
 261             spacing: tt::Spacing::Alone,
 262         }
 263         .into();
 264         parent.subtree.token_trees.push(leaf.into());
 265         parent.subtree.token_trees.extend(entry.subtree.token_trees);
 266     }
 267
 268     let subtree = stack.pop().unwrap().subtree;
 269     if subtree.token_trees.len() == 1 {
 270         if let tt::TokenTree::Subtree(first) = &subtree.token_trees[0] {
 271             return first.clone();
 272         }
 273     }
 274     subtree
 275 }
 276
 277 /// Returns the textual content of a doc comment block as a quoted string
 278 /// That is, strips leading `///` (or `/**`, etc)
 279 /// and strips the ending `*/`
 280 /// And then quote the string, which is needed to convert to `tt::Literal`
 281 fn doc_comment_text(comment: &ast::Comment) -> SmolStr {
 282     let prefix_len = comment.prefix().len();
 283     let mut text = &comment.text()[prefix_len..];
 284
 285     // Remove ending "*/"
 286     if comment.kind().shape == ast::CommentShape::Block {
 287         text = &text[0..text.len() - 2];
 288     }
 289
 290     // Quote the string
 291     // Note that `tt::Literal` expect an escaped string
 292     let text = format!("\"{}\"", text.escape_debug());
 293     text.into()
 294 }
 295
 296 fn convert_doc_comment(token: &syntax::SyntaxToken) -> Option<Vec<tt::TokenTree>> {
 297     let comment = ast::Comment::cast(token.clone())?;
 298     let doc = comment.kind().doc?;
 299
 300     // Make `doc="\" Comments\""
 301     let meta_tkns = vec![mk_ident("doc"), mk_punct('='), mk_doc_literal(&comment)];
 302
 303     // Make `#![]`
 304     let mut token_trees = vec![mk_punct('#')];
 305     if let ast::CommentPlacement::Inner = doc {
 306         token_trees.push(mk_punct('!'));
 307     }
 308     token_trees.push(tt::TokenTree::from(tt::Subtree {
 309         delimiter: Some(tt::Delimiter {
 310             kind: tt::DelimiterKind::Bracket,
 311             id: tt::TokenId::unspecified(),
 312         }),
 313         token_trees: meta_tkns,
 314     }));
 315
 316     return Some(token_trees);
 317
 318     // Helper functions
 319     fn mk_ident(s: &str) -> tt::TokenTree {
 320         tt::TokenTree::from(tt::Leaf::from(tt::Ident {
 321             text: s.into(),
 322             id: tt::TokenId::unspecified(),
 323         }))
 324     }
 325
 326     fn mk_punct(c: char) -> tt::TokenTree {
 327         tt::TokenTree::from(tt::Leaf::from(tt::Punct {
 328             char: c,
 329             spacing: tt::Spacing::Alone,
 330             id: tt::TokenId::unspecified(),
 331         }))
 332     }
 333
 334     fn mk_doc_literal(comment: &ast::Comment) -> tt::TokenTree {
 335         let lit = tt::Literal { text: doc_comment_text(comment), id: tt::TokenId::unspecified() };
 336
 337         tt::TokenTree::from(tt::Leaf::from(lit))
 338     }
 339 }
 340
 341 struct TokenIdAlloc {
 342     map: TokenMap,
 343     global_offset: TextSize,
 344     next_id: u32,
 345 }
 346
 347 impl TokenIdAlloc {
 348     fn alloc(&mut self, absolute_range: TextRange) -> tt::TokenId {
 349         let relative_range = absolute_range - self.global_offset;
 350         let token_id = tt::TokenId(self.next_id);
 351         self.next_id += 1;
 352         self.map.insert(token_id, relative_range);
 353         token_id
 354     }
 355
 356     fn open_delim(&mut self, open_abs_range: TextRange) -> (tt::TokenId, usize) {
 357         let token_id = tt::TokenId(self.next_id);
 358         self.next_id += 1;
 359         let idx = self.map.insert_delim(
 360             token_id,
 361             open_abs_range - self.global_offset,
 362             open_abs_range - self.global_offset,
 363         );
 364         (token_id, idx)
 365     }
 366
 367     fn close_delim(&mut self, idx: usize, close_abs_range: Option<TextRange>) {
 368         match close_abs_range {
 369             None => {
 370                 self.map.remove_delim(idx);
 371             }
 372             Some(close) => {
 373                 self.map.update_close_delim(idx, close - self.global_offset);
 374             }
 375         }
 376     }
 377 }
 378
 379 /// A Raw Token (straightly from lexer) convertor
 380 struct RawConvertor<'a> {
 381     text: &'a str,
 382     offset: TextSize,
 383     id_alloc: TokenIdAlloc,
 384     inner: std::slice::Iter<'a, RawToken>,
 385 }
 386
 387 trait SrcToken: std::fmt::Debug {
 388     fn kind(&self) -> SyntaxKind;
 389
 390     fn to_char(&self) -> Option<char>;
 391
 392     fn to_text(&self) -> SmolStr;
 393 }
 394
 395 trait TokenConvertor {
 396     type Token: SrcToken;
 397
 398     fn convert_doc_comment(&self, token: &Self::Token) -> Option<Vec<tt::TokenTree>>;
 399
 400     fn bump(&mut self) -> Option<(Self::Token, TextRange)>;
 401
 402     fn peek(&self) -> Option<Self::Token>;
 403
 404     fn id_alloc(&mut self) -> &mut TokenIdAlloc;
 405 }
 406
 407 impl<'a> SrcToken for (&'a RawToken, &'a str) {
 408     fn kind(&self) -> SyntaxKind {
 409         self.0.kind
 410     }
 411
 412     fn to_char(&self) -> Option<char> {
 413         self.1.chars().next()
 414     }
 415
 416     fn to_text(&self) -> SmolStr {
 417         self.1.into()
 418     }
 419 }
 420
 421 impl RawConvertor<'_> {}
 422
 423 impl<'a> TokenConvertor for RawConvertor<'a> {
 424     type Token = (&'a RawToken, &'a str);
 425
 426     fn convert_doc_comment(&self, token: &Self::Token) -> Option<Vec<tt::TokenTree>> {
 427         convert_doc_comment(&doc_comment(token.1))
 428     }
 429
 430     fn bump(&mut self) -> Option<(Self::Token, TextRange)> {
 431         let token = self.inner.next()?;
 432         let range = TextRange::at(self.offset, token.len);
 433         self.offset += token.len;
 434
 435         Some(((token, &self.text[range]), range))
 436     }
 437
 438     fn peek(&self) -> Option<Self::Token> {
 439         let token = self.inner.as_slice().get(0);
 440
 441         token.map(|it| {
 442             let range = TextRange::at(self.offset, it.len);
 443             (it, &self.text[range])
 444         })
 445     }
 446
 447     fn id_alloc(&mut self) -> &mut TokenIdAlloc {
 448         &mut self.id_alloc
 449     }
 450 }
 451
 452 struct Convertor {
 453     id_alloc: TokenIdAlloc,
 454     current: Option<SyntaxToken>,
 455     range: TextRange,
 456     punct_offset: Option<(SyntaxToken, TextSize)>,
 457 }
 458
 459 impl Convertor {
 460     fn new(node: &SyntaxNode, global_offset: TextSize) -> Convertor {
 461         Convertor {
 462             id_alloc: { TokenIdAlloc { map: TokenMap::default(), global_offset, next_id: 0 } },
 463             current: node.first_token(),
 464             range: node.text_range(),
 465             punct_offset: None,
 466         }
 467     }
 468 }
 469
 470 #[derive(Debug)]
 471 enum SynToken {
 472     Ordinary(SyntaxToken),
 473     Punch(SyntaxToken, TextSize),
 474 }
 475
 476 impl SynToken {
 477     fn token(&self) -> &SyntaxToken {
 478         match self {
 479             SynToken::Ordinary(it) => it,
 480             SynToken::Punch(it, _) => it,
 481         }
 482     }
 483 }
 484
 485 impl SrcToken for SynToken {
 486     fn kind(&self) -> SyntaxKind {
 487         self.token().kind()
 488     }
 489     fn to_char(&self) -> Option<char> {
 490         match self {
 491             SynToken::Ordinary(_) => None,
 492             SynToken::Punch(it, i) => it.text().chars().nth((*i).into()),
 493         }
 494     }
 495     fn to_text(&self) -> SmolStr {
 496         self.token().text().into()
 497     }
 498 }
 499
 500 impl TokenConvertor for Convertor {
 501     type Token = SynToken;
 502     fn convert_doc_comment(&self, token: &Self::Token) -> Option<Vec<tt::TokenTree>> {
 503         convert_doc_comment(token.token())
 504     }
 505
 506     fn bump(&mut self) -> Option<(Self::Token, TextRange)> {
 507         if let Some((punct, offset)) = self.punct_offset.clone() {
 508             if usize::from(offset) + 1 < punct.text().len() {
 509                 let offset = offset + TextSize::of('.');
 510                 let range = punct.text_range();
 511                 self.punct_offset = Some((punct.clone(), offset));
 512                 let range = TextRange::at(range.start() + offset, TextSize::of('.'));
 513                 return Some((SynToken::Punch(punct, offset), range));
 514             }
 515         }
 516
 517         let curr = self.current.clone()?;
 518         if !&self.range.contains_range(curr.text_range()) {
 519             return None;
 520         }
 521         self.current = curr.next_token();
 522
 523         let token = if curr.kind().is_punct() {
 524             let range = curr.text_range();
 525             let range = TextRange::at(range.start(), TextSize::of('.'));
 526             self.punct_offset = Some((curr.clone(), 0.into()));
 527             (SynToken::Punch(curr, 0.into()), range)
 528         } else {
 529             self.punct_offset = None;
 530             let range = curr.text_range();
 531             (SynToken::Ordinary(curr), range)
 532         };
 533
 534         Some(token)
 535     }
 536
 537     fn peek(&self) -> Option<Self::Token> {
 538         if let Some((punct, mut offset)) = self.punct_offset.clone() {
 539             offset += TextSize::of('.');
 540             if usize::from(offset) < punct.text().len() {
 541                 return Some(SynToken::Punch(punct, offset));
 542             }
 543         }
 544
 545         let curr = self.current.clone()?;
 546         if !self.range.contains_range(curr.text_range()) {
 547             return None;
 548         }
 549
 550         let token = if curr.kind().is_punct() {
 551             SynToken::Punch(curr, 0.into())
 552         } else {
 553             SynToken::Ordinary(curr)
 554         };
 555         Some(token)
 556     }
 557
 558     fn id_alloc(&mut self) -> &mut TokenIdAlloc {
 559         &mut self.id_alloc
 560     }
 561 }
 562
 563 struct TtTreeSink<'a> {
 564     buf: String,
 565     cursor: Cursor<'a>,
 566     open_delims: FxHashMap<tt::TokenId, TextSize>,
 567     text_pos: TextSize,
 568     inner: SyntaxTreeBuilder,
 569     token_map: TokenMap,
 570
 571     // Number of roots
 572     // Use for detect ill-form tree which is not single root
 573     roots: smallvec::SmallVec<[usize; 1]>,
 574 }
 575
 576 impl<'a> TtTreeSink<'a> {
 577     fn new(cursor: Cursor<'a>) -> Self {
 578         TtTreeSink {
 579             buf: String::new(),
 580             cursor,
 581             open_delims: FxHashMap::default(),
 582             text_pos: 0.into(),
 583             inner: SyntaxTreeBuilder::default(),
 584             roots: smallvec::SmallVec::new(),
 585             token_map: TokenMap::default(),
 586         }
 587     }
 588
 589     fn finish(mut self) -> (Parse<SyntaxNode>, TokenMap) {
 590         self.token_map.shrink_to_fit();
 591         (self.inner.finish(), self.token_map)
 592     }
 593 }
 594
 595 fn delim_to_str(d: Option<tt::DelimiterKind>, closing: bool) -> &'static str {
 596     let texts = match d {
 597         Some(tt::DelimiterKind::Parenthesis) => "()",
 598         Some(tt::DelimiterKind::Brace) => "{}",
 599         Some(tt::DelimiterKind::Bracket) => "[]",
 600         None => return "",
 601     };
 602
 603     let idx = closing as usize;
 604     &texts[idx..texts.len() - (1 - idx)]
 605 }
 606
 607 impl<'a> TreeSink for TtTreeSink<'a> {
 608     fn token(&mut self, kind: SyntaxKind, mut n_tokens: u8) {
 609         if kind == L_DOLLAR || kind == R_DOLLAR {
 610             self.cursor = self.cursor.bump_subtree();
 611             return;
 612         }
 613         if kind == LIFETIME_IDENT {
 614             n_tokens = 2;
 615         }
 616
 617         let mut last = self.cursor;
 618         for _ in 0..n_tokens {
 619             let tmp_str: SmolStr;
 620             if self.cursor.eof() {
 621                 break;
 622             }
 623             last = self.cursor;
 624             let text: &str = match self.cursor.token_tree() {
 625                 Some(tt::buffer::TokenTreeRef::Leaf(leaf, _)) => {
 626                     // Mark the range if needed
 627                     let (text, id) = match leaf {
 628                         tt::Leaf::Ident(ident) => (&ident.text, ident.id),
 629                         tt::Leaf::Punct(punct) => {
 630                             assert!(punct.char.is_ascii());
 631                             let char = &(punct.char as u8);
 632                             tmp_str = SmolStr::new_inline(
 633                                 std::str::from_utf8(std::slice::from_ref(char)).unwrap(),
 634                             );
 635                             (&tmp_str, punct.id)
 636                         }
 637                         tt::Leaf::Literal(lit) => (&lit.text, lit.id),
 638                     };
 639                     let range = TextRange::at(self.text_pos, TextSize::of(text.as_str()));
 640                     self.token_map.insert(id, range);
 641                     self.cursor = self.cursor.bump();
 642                     text
 643                 }
 644                 Some(tt::buffer::TokenTreeRef::Subtree(subtree, _)) => {
 645                     self.cursor = self.cursor.subtree().unwrap();
 646                     if let Some(id) = subtree.delimiter.map(|it| it.id) {
 647                         self.open_delims.insert(id, self.text_pos);
 648                     }
 649                     delim_to_str(subtree.delimiter_kind(), false)
 650                 }
 651                 None => {
 652                     if let Some(parent) = self.cursor.end() {
 653                         self.cursor = self.cursor.bump();
 654                         if let Some(id) = parent.delimiter.map(|it| it.id) {
 655                             if let Some(open_delim) = self.open_delims.get(&id) {
 656                                 let open_range = TextRange::at(*open_delim, TextSize::of('('));
 657                                 let close_range = TextRange::at(self.text_pos, TextSize::of('('));
 658                                 self.token_map.insert_delim(id, open_range, close_range);
 659                             }
 660                         }
 661                         delim_to_str(parent.delimiter_kind(), true)
 662                     } else {
 663                         continue;
 664                     }
 665                 }
 666             };
 667             self.buf += text;
 668             self.text_pos += TextSize::of(text);
 669         }
 670
 671         self.inner.token(kind, self.buf.as_str());
 672         self.buf.clear();
 673         // Add whitespace between adjoint puncts
 674         let next = last.bump();
 675         if let (
 676             Some(tt::buffer::TokenTreeRef::Leaf(tt::Leaf::Punct(curr), _)),
 677             Some(tt::buffer::TokenTreeRef::Leaf(tt::Leaf::Punct(_), _)),
 678         ) = (last.token_tree(), next.token_tree())
 679         {
 680             // Note: We always assume the semi-colon would be the last token in
 681             // other parts of RA such that we don't add whitespace here.
 682             if curr.spacing == tt::Spacing::Alone && curr.char != ';' {
 683                 self.inner.token(WHITESPACE, " ");
 684                 self.text_pos += TextSize::of(' ');
 685             }
 686         }
 687     }
 688
 689     fn start_node(&mut self, kind: SyntaxKind) {
 690         self.inner.start_node(kind);
 691
 692         match self.roots.last_mut() {
 693             None | Some(0) => self.roots.push(1),
 694             Some(ref mut n) => **n += 1,
 695         };
 696     }
 697
 698     fn finish_node(&mut self) {
 699         self.inner.finish_node();
 700         *self.roots.last_mut().unwrap() -= 1;
 701     }
 702
 703     fn error(&mut self, error: ParseError) {
 704         self.inner.error(error, self.text_pos)
 705     }
 706 }
 707
 708 #[cfg(test)]
 709 mod tests {
 710     use super::*;
 711     use crate::tests::parse_macro;
 712     use parser::TokenSource;
 713     use syntax::{
 714         algo::{insert_children, InsertPosition},
 715         ast::AstNode,
 716     };
 717     use test_utils::assert_eq_text;
 718
 719     #[test]
 720     fn convert_tt_token_source() {
 721         let expansion = parse_macro(
 722             r#"
 723             macro_rules! literals {
 724                 ($i:ident) => {
 725                     {
 726                         let a = 'c';
 727                         let c = 1000;
 728                         let f = 12E+99_f64;
 729                         let s = "rust1";
 730                     }
 731                 }
 732             }
 733             "#,
 734         )
 735         .expand_tt("literals!(foo);");
 736         let tts = &[expansion.into()];
 737         let buffer = tt::buffer::TokenBuffer::from_tokens(tts);
 738         let mut tt_src = SubtreeTokenSource::new(&buffer);
 739         let mut tokens = vec![];
 740         while tt_src.current().kind != EOF {
 741             tokens.push((tt_src.current().kind, tt_src.text()));
 742             tt_src.bump();
 743         }
 744
 745         // [${]
 746         // [let] [a] [=] ['c'] [;]
 747         assert_eq!(tokens[2 + 3].1, "'c'");
 748         assert_eq!(tokens[2 + 3].0, CHAR);
 749         // [let] [c] [=] [1000] [;]
 750         assert_eq!(tokens[2 + 5 + 3].1, "1000");
 751         assert_eq!(tokens[2 + 5 + 3].0, INT_NUMBER);
 752         // [let] [f] [=] [12E+99_f64] [;]
 753         assert_eq!(tokens[2 + 10 + 3].1, "12E+99_f64");
 754         assert_eq!(tokens[2 + 10 + 3].0, FLOAT_NUMBER);
 755
 756         // [let] [s] [=] ["rust1"] [;]
 757         assert_eq!(tokens[2 + 15 + 3].1, "\"rust1\"");
 758         assert_eq!(tokens[2 + 15 + 3].0, STRING);
 759     }
 760
 761     #[test]
 762     fn stmts_token_trees_to_expr_is_err() {
 763         let expansion = parse_macro(
 764             r#"
 765             macro_rules! stmts {
 766                 () => {
 767                     let a = 0;
 768                     let b = 0;
 769                     let c = 0;
 770                     let d = 0;
 771                 }
 772             }
 773             "#,
 774         )
 775         .expand_tt("stmts!();");
 776         assert!(token_tree_to_syntax_node(&expansion, FragmentKind::Expr).is_err());
 777     }
 778
 779     #[test]
 780     fn test_token_tree_last_child_is_white_space() {
 781         let source_file = ast::SourceFile::parse("f!({} );").ok().unwrap();
 782         let macro_call = source_file.syntax().descendants().find_map(ast::MacroCall::cast).unwrap();
 783         let token_tree = macro_call.token_tree().unwrap();
 784
 785         // Token Tree now is :
 786         // TokenTree
 787         // - T!['(']
 788         // - TokenTree
 789         //   - T!['{']
 790         //   - T!['}']
 791         // - WHITE_SPACE
 792         // - T![')']
 793
 794         let rbrace =
 795             token_tree.syntax().descendants_with_tokens().find(|it| it.kind() == T!['}']).unwrap();
 796         let space = token_tree
 797             .syntax()
 798             .descendants_with_tokens()
 799             .find(|it| it.kind() == SyntaxKind::WHITESPACE)
 800             .unwrap();
 801
 802         // reorder th white space, such that the white is inside the inner token-tree.
 803         let token_tree = insert_children(
 804             &rbrace.parent().unwrap(),
 805             InsertPosition::Last,
 806             std::iter::once(space),
 807         );
 808
 809         // Token Tree now is :
 810         // TokenTree
 811         // - T!['{']
 812         // - T!['}']
 813         // - WHITE_SPACE
 814         let token_tree = ast::TokenTree::cast(token_tree).unwrap();
 815         let tt = ast_to_token_tree(&token_tree).0;
 816
 817         assert_eq!(tt.delimiter_kind(), Some(tt::DelimiterKind::Brace));
 818     }
 819
 820     #[test]
 821     fn test_token_tree_multi_char_punct() {
 822         let source_file = ast::SourceFile::parse("struct Foo { a: x::Y }").ok().unwrap();
 823         let struct_def = source_file.syntax().descendants().find_map(ast::Struct::cast).unwrap();
 824         let tt = ast_to_token_tree(&struct_def).0;
 825         token_tree_to_syntax_node(&tt, FragmentKind::Item).unwrap();
 826     }
 827
 828     #[test]
 829     fn test_missing_closing_delim() {
 830         let source_file = ast::SourceFile::parse("m!(x").tree();
 831         let node = source_file.syntax().descendants().find_map(ast::TokenTree::cast).unwrap();
 832         let tt = ast_to_token_tree(&node).0.to_string();
 833         assert_eq_text!(&*tt, "( x");
 834     }
 835 }