crates/mbe/src/syntax_bridge.rs

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