crates/mbe/src/syntax_bridge.rs

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