compiler/rustc_ast/src/tokenstream.rs

   1 //! # Token Streams
   2 //!
   3 //! `TokenStream`s represent syntactic objects before they are converted into ASTs.
   4 //! A `TokenStream` is, roughly speaking, a sequence of [`TokenTree`]s,
   5 //! which are themselves a single [`Token`] or a `Delimited` subsequence of tokens.
   6 //!
   7 //! ## Ownership
   8 //!
   9 //! `TokenStream`s are persistent data structures constructed as ropes with reference
  10 //! counted-children. In general, this means that calling an operation on a `TokenStream`
  11 //! (such as `slice`) produces an entirely new `TokenStream` from the borrowed reference to
  12 //! the original. This essentially coerces `TokenStream`s into "views" of their subparts,
  13 //! and a borrowed `TokenStream` is sufficient to build an owned `TokenStream` without taking
  14 //! ownership of the original.
  15
  16 use crate::token::{self, DelimToken, Token, TokenKind};
  17 use crate::AttrVec;
  18
  19 use rustc_data_structures::stable_hasher::{HashStable, StableHasher};
  20 use rustc_data_structures::sync::{self, Lrc};
  21 use rustc_macros::HashStable_Generic;
  22 use rustc_serialize::{Decodable, Decoder, Encodable, Encoder};
  23 use rustc_span::{Span, DUMMY_SP};
  24 use smallvec::{smallvec, SmallVec};
  25
  26 use std::{fmt, iter, mem};
  27
  28 /// When the main Rust parser encounters a syntax-extension invocation, it
  29 /// parses the arguments to the invocation as a token tree. This is a very
  30 /// loose structure, such that all sorts of different AST fragments can
  31 /// be passed to syntax extensions using a uniform type.
  32 ///
  33 /// If the syntax extension is an MBE macro, it will attempt to match its
  34 /// LHS token tree against the provided token tree, and if it finds a
  35 /// match, will transcribe the RHS token tree, splicing in any captured
  36 /// `macro_parser::matched_nonterminals` into the `SubstNt`s it finds.
  37 ///
  38 /// The RHS of an MBE macro is the only place `SubstNt`s are substituted.
  39 /// Nothing special happens to misnamed or misplaced `SubstNt`s.
  40 #[derive(Debug, Clone, PartialEq, Encodable, Decodable, HashStable_Generic)]
  41 pub enum TokenTree {
  42     /// A single token.
  43     Token(Token),
  44     /// A delimited sequence of token trees.
  45     Delimited(DelimSpan, DelimToken, TokenStream),
  46 }
  47
  48 #[derive(Copy, Clone)]
  49 pub enum CanSynthesizeMissingTokens {
  50     Yes,
  51     No,
  52 }
  53
  54 // Ensure all fields of `TokenTree` is `Send` and `Sync`.
  55 #[cfg(parallel_compiler)]
  56 fn _dummy()
  57 where
  58     Token: Send + Sync,
  59     DelimSpan: Send + Sync,
  60     DelimToken: Send + Sync,
  61     TokenStream: Send + Sync,
  62 {
  63 }
  64
  65 impl TokenTree {
  66     /// Checks if this `TokenTree` is equal to the other, regardless of span information.
  67     pub fn eq_unspanned(&self, other: &TokenTree) -> bool {
  68         match (self, other) {
  69             (TokenTree::Token(token), TokenTree::Token(token2)) => token.kind == token2.kind,
  70             (TokenTree::Delimited(_, delim, tts), TokenTree::Delimited(_, delim2, tts2)) => {
  71                 delim == delim2 && tts.eq_unspanned(&tts2)
  72             }
  73             _ => false,
  74         }
  75     }
  76
  77     /// Retrieves the `TokenTree`'s span.
  78     pub fn span(&self) -> Span {
  79         match self {
  80             TokenTree::Token(token) => token.span,
  81             TokenTree::Delimited(sp, ..) => sp.entire(),
  82         }
  83     }
  84
  85     /// Modify the `TokenTree`'s span in-place.
  86     pub fn set_span(&mut self, span: Span) {
  87         match self {
  88             TokenTree::Token(token) => token.span = span,
  89             TokenTree::Delimited(dspan, ..) => *dspan = DelimSpan::from_single(span),
  90         }
  91     }
  92
  93     pub fn token(kind: TokenKind, span: Span) -> TokenTree {
  94         TokenTree::Token(Token::new(kind, span))
  95     }
  96
  97     /// Returns the opening delimiter as a token tree.
  98     pub fn open_tt(span: DelimSpan, delim: DelimToken) -> TokenTree {
  99         TokenTree::token(token::OpenDelim(delim), span.open)
 100     }
 101
 102     /// Returns the closing delimiter as a token tree.
 103     pub fn close_tt(span: DelimSpan, delim: DelimToken) -> TokenTree {
 104         TokenTree::token(token::CloseDelim(delim), span.close)
 105     }
 106
 107     pub fn uninterpolate(self) -> TokenTree {
 108         match self {
 109             TokenTree::Token(token) => TokenTree::Token(token.uninterpolate().into_owned()),
 110             tt => tt,
 111         }
 112     }
 113 }
 114
 115 impl<CTX> HashStable<CTX> for TokenStream
 116 where
 117     CTX: crate::HashStableContext,
 118 {
 119     fn hash_stable(&self, hcx: &mut CTX, hasher: &mut StableHasher) {
 120         for sub_tt in self.trees() {
 121             sub_tt.hash_stable(hcx, hasher);
 122         }
 123     }
 124 }
 125
 126 pub trait CreateTokenStream: sync::Send + sync::Sync {
 127     fn create_token_stream(&self) -> AttrAnnotatedTokenStream;
 128 }
 129
 130 impl CreateTokenStream for AttrAnnotatedTokenStream {
 131     fn create_token_stream(&self) -> AttrAnnotatedTokenStream {
 132         self.clone()
 133     }
 134 }
 135
 136 /// A lazy version of [`TokenStream`], which defers creation
 137 /// of an actual `TokenStream` until it is needed.
 138 /// `Box` is here only to reduce the structure size.
 139 #[derive(Clone)]
 140 pub struct LazyTokenStream(Lrc<Box<dyn CreateTokenStream>>);
 141
 142 impl LazyTokenStream {
 143     pub fn new(inner: impl CreateTokenStream + 'static) -> LazyTokenStream {
 144         LazyTokenStream(Lrc::new(Box::new(inner)))
 145     }
 146
 147     pub fn create_token_stream(&self) -> AttrAnnotatedTokenStream {
 148         self.0.create_token_stream()
 149     }
 150 }
 151
 152 impl fmt::Debug for LazyTokenStream {
 153     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 154         write!(f, "LazyTokenStream({:?})", self.create_token_stream())
 155     }
 156 }
 157
 158 impl<S: Encoder> Encodable<S> for LazyTokenStream {
 159     fn encode(&self, s: &mut S) -> Result<(), S::Error> {
 160         // Used by AST json printing.
 161         Encodable::encode(&self.create_token_stream(), s)
 162     }
 163 }
 164
 165 impl<D: Decoder> Decodable<D> for LazyTokenStream {
 166     fn decode(_d: &mut D) -> Result<Self, D::Error> {
 167         panic!("Attempted to decode LazyTokenStream");
 168     }
 169 }
 170
 171 impl<CTX> HashStable<CTX> for LazyTokenStream {
 172     fn hash_stable(&self, _hcx: &mut CTX, _hasher: &mut StableHasher) {
 173         panic!("Attempted to compute stable hash for LazyTokenStream");
 174     }
 175 }
 176
 177 /// A `AttrAnnotatedTokenStream` is similar to a `TokenStream`, but with extra
 178 /// information about the tokens for attribute targets. This is used
 179 /// during expansion to perform early cfg-expansion, and to process attributes
 180 /// during proc-macro invocations.
 181 #[derive(Clone, Debug, Default, Encodable, Decodable)]
 182 pub struct AttrAnnotatedTokenStream(pub Lrc<Vec<(AttrAnnotatedTokenTree, Spacing)>>);
 183
 184 /// Like `TokenTree`, but for `AttrAnnotatedTokenStream`
 185 #[derive(Clone, Debug, Encodable, Decodable)]
 186 pub enum AttrAnnotatedTokenTree {
 187     Token(Token),
 188     Delimited(DelimSpan, DelimToken, AttrAnnotatedTokenStream),
 189     /// Stores the attributes for an attribute target,
 190     /// along with the tokens for that attribute target.
 191     /// See `AttributesData` for more information
 192     Attributes(AttributesData),
 193 }
 194
 195 impl AttrAnnotatedTokenStream {
 196     pub fn new(tokens: Vec<(AttrAnnotatedTokenTree, Spacing)>) -> AttrAnnotatedTokenStream {
 197         AttrAnnotatedTokenStream(Lrc::new(tokens))
 198     }
 199
 200     /// Converts this `AttrAnnotatedTokenStream` to a plain `TokenStream
 201     /// During conversion, `AttrAnnotatedTokenTree::Attributes` get 'flattened'
 202     /// back to a `TokenStream` of the form `outer_attr attr_target`.
 203     /// If there are inner attributes, they are inserted into the proper
 204     /// place in the attribute target tokens.
 205     pub fn to_tokenstream(&self) -> TokenStream {
 206         let trees: Vec<_> = self
 207             .0
 208             .iter()
 209             .flat_map(|tree| match &tree.0 {
 210                 AttrAnnotatedTokenTree::Token(inner) => {
 211                     smallvec![(TokenTree::Token(inner.clone()), tree.1)].into_iter()
 212                 }
 213                 AttrAnnotatedTokenTree::Delimited(span, delim, stream) => smallvec![(
 214                     TokenTree::Delimited(*span, *delim, stream.to_tokenstream()),
 215                     tree.1,
 216                 )]
 217                 .into_iter(),
 218                 AttrAnnotatedTokenTree::Attributes(data) => {
 219                     let mut outer_attrs = Vec::new();
 220                     let mut inner_attrs = Vec::new();
 221                     for attr in &data.attrs {
 222                         match attr.style {
 223                             crate::AttrStyle::Outer => {
 224                                 assert!(
 225                                     inner_attrs.len() == 0,
 226                                     "Found outer attribute {:?} after inner attrs {:?}",
 227                                     attr,
 228                                     inner_attrs
 229                                 );
 230                                 outer_attrs.push(attr);
 231                             }
 232                             crate::AttrStyle::Inner => {
 233                                 inner_attrs.push(attr);
 234                             }
 235                         }
 236                     }
 237
 238                     let mut target_tokens: Vec<_> = data
 239                         .tokens
 240                         .create_token_stream()
 241                         .to_tokenstream()
 242                         .0
 243                         .iter()
 244                         .cloned()
 245                         .collect();
 246                     if !inner_attrs.is_empty() {
 247                         let mut found = false;
 248                         // Check the last two trees (to account for a trailing semi)
 249                         for (tree, _) in target_tokens.iter_mut().rev().take(2) {
 250                             if let TokenTree::Delimited(span, delim, delim_tokens) = tree {
 251                                 // Inner attributes are only supported on extern blocks, functions, impls,
 252                                 // and modules. All of these have their inner attributes placed at
 253                                 // the beginning of the rightmost outermost braced group:
 254                                 // e.g. fn foo() { #![my_attr} }
 255                                 //
 256                                 // Therefore, we can insert them back into the right location
 257                                 // without needing to do any extra position tracking.
 258                                 //
 259                                 // Note: Outline modules are an exception - they can
 260                                 // have attributes like `#![my_attr]` at the start of a file.
 261                                 // Support for custom attributes in this position is not
 262                                 // properly implemented - we always synthesize fake tokens,
 263                                 // so we never reach this code.
 264
 265                                 let mut builder = TokenStreamBuilder::new();
 266                                 for inner_attr in inner_attrs {
 267                                     builder.push(inner_attr.tokens().to_tokenstream());
 268                                 }
 269                                 builder.push(delim_tokens.clone());
 270                                 *tree = TokenTree::Delimited(*span, *delim, builder.build());
 271                                 found = true;
 272                                 break;
 273                             }
 274                         }
 275
 276                         assert!(
 277                             found,
 278                             "Failed to find trailing delimited group in: {:?}",
 279                             target_tokens
 280                         );
 281                     }
 282                     let mut flat: SmallVec<[_; 1]> = SmallVec::new();
 283                     for attr in outer_attrs {
 284                         // FIXME: Make this more efficient
 285                         flat.extend(attr.tokens().to_tokenstream().0.clone().iter().cloned());
 286                     }
 287                     flat.extend(target_tokens);
 288                     flat.into_iter()
 289                 }
 290             })
 291             .collect();
 292         TokenStream::new(trees)
 293     }
 294 }
 295
 296 /// Stores the tokens for an attribute target, along
 297 /// with its attributes.
 298 ///
 299 /// This is constructed during parsing when we need to capture
 300 /// tokens.
 301 ///
 302 /// For example, `#[cfg(FALSE)] struct Foo {}` would
 303 /// have an `attrs` field containing the `#[cfg(FALSE)]` attr,
 304 /// and a `tokens` field storing the (unparesd) tokens `struct Foo {}`
 305 #[derive(Clone, Debug, Encodable, Decodable)]
 306 pub struct AttributesData {
 307     /// Attributes, both outer and inner.
 308     /// These are stored in the original order that they were parsed in.
 309     pub attrs: AttrVec,
 310     /// The underlying tokens for the attribute target that `attrs`
 311     /// are applied to
 312     pub tokens: LazyTokenStream,
 313 }
 314
 315 /// A `TokenStream` is an abstract sequence of tokens, organized into [`TokenTree`]s.
 316 ///
 317 /// The goal is for procedural macros to work with `TokenStream`s and `TokenTree`s
 318 /// instead of a representation of the abstract syntax tree.
 319 /// Today's `TokenTree`s can still contain AST via `token::Interpolated` for
 320 /// backwards compatibility.
 321 #[derive(Clone, Debug, Default, Encodable, Decodable)]
 322 pub struct TokenStream(pub(crate) Lrc<Vec<TreeAndSpacing>>);
 323
 324 pub type TreeAndSpacing = (TokenTree, Spacing);
 325
 326 // `TokenStream` is used a lot. Make sure it doesn't unintentionally get bigger.
 327 #[cfg(all(target_arch = "x86_64", target_pointer_width = "64"))]
 328 rustc_data_structures::static_assert_size!(TokenStream, 8);
 329
 330 #[derive(Clone, Copy, Debug, PartialEq, Encodable, Decodable)]
 331 pub enum Spacing {
 332     Alone,
 333     Joint,
 334 }
 335
 336 impl TokenStream {
 337     /// Given a `TokenStream` with a `Stream` of only two arguments, return a new `TokenStream`
 338     /// separating the two arguments with a comma for diagnostic suggestions.
 339     pub fn add_comma(&self) -> Option<(TokenStream, Span)> {
 340         // Used to suggest if a user writes `foo!(a b);`
 341         let mut suggestion = None;
 342         let mut iter = self.0.iter().enumerate().peekable();
 343         while let Some((pos, ts)) = iter.next() {
 344             if let Some((_, next)) = iter.peek() {
 345                 let sp = match (&ts, &next) {
 346                     (_, (TokenTree::Token(Token { kind: token::Comma, .. }), _)) => continue,
 347                     (
 348                         (TokenTree::Token(token_left), Spacing::Alone),
 349                         (TokenTree::Token(token_right), _),
 350                     ) if ((token_left.is_ident() && !token_left.is_reserved_ident())
 351                         || token_left.is_lit())
 352                         && ((token_right.is_ident() && !token_right.is_reserved_ident())
 353                             || token_right.is_lit()) =>
 354                     {
 355                         token_left.span
 356                     }
 357                     ((TokenTree::Delimited(sp, ..), Spacing::Alone), _) => sp.entire(),
 358                     _ => continue,
 359                 };
 360                 let sp = sp.shrink_to_hi();
 361                 let comma = (TokenTree::token(token::Comma, sp), Spacing::Alone);
 362                 suggestion = Some((pos, comma, sp));
 363             }
 364         }
 365         if let Some((pos, comma, sp)) = suggestion {
 366             let mut new_stream = Vec::with_capacity(self.0.len() + 1);
 367             let parts = self.0.split_at(pos + 1);
 368             new_stream.extend_from_slice(parts.0);
 369             new_stream.push(comma);
 370             new_stream.extend_from_slice(parts.1);
 371             return Some((TokenStream::new(new_stream), sp));
 372         }
 373         None
 374     }
 375 }
 376
 377 impl From<(AttrAnnotatedTokenTree, Spacing)> for AttrAnnotatedTokenStream {
 378     fn from((tree, spacing): (AttrAnnotatedTokenTree, Spacing)) -> AttrAnnotatedTokenStream {
 379         AttrAnnotatedTokenStream::new(vec![(tree, spacing)])
 380     }
 381 }
 382
 383 impl From<TokenTree> for TokenStream {
 384     fn from(tree: TokenTree) -> TokenStream {
 385         TokenStream::new(vec![(tree, Spacing::Alone)])
 386     }
 387 }
 388
 389 impl From<TokenTree> for TreeAndSpacing {
 390     fn from(tree: TokenTree) -> TreeAndSpacing {
 391         (tree, Spacing::Alone)
 392     }
 393 }
 394
 395 impl iter::FromIterator<TokenTree> for TokenStream {
 396     fn from_iter<I: IntoIterator<Item = TokenTree>>(iter: I) -> Self {
 397         TokenStream::new(iter.into_iter().map(Into::into).collect::<Vec<TreeAndSpacing>>())
 398     }
 399 }
 400
 401 impl Eq for TokenStream {}
 402
 403 impl PartialEq<TokenStream> for TokenStream {
 404     fn eq(&self, other: &TokenStream) -> bool {
 405         self.trees().eq(other.trees())
 406     }
 407 }
 408
 409 impl TokenStream {
 410     pub fn new(streams: Vec<TreeAndSpacing>) -> TokenStream {
 411         TokenStream(Lrc::new(streams))
 412     }
 413
 414     pub fn is_empty(&self) -> bool {
 415         self.0.is_empty()
 416     }
 417
 418     pub fn len(&self) -> usize {
 419         self.0.len()
 420     }
 421
 422     pub fn from_streams(mut streams: SmallVec<[TokenStream; 2]>) -> TokenStream {
 423         match streams.len() {
 424             0 => TokenStream::default(),
 425             1 => streams.pop().unwrap(),
 426             _ => {
 427                 // We are going to extend the first stream in `streams` with
 428                 // the elements from the subsequent streams. This requires
 429                 // using `make_mut()` on the first stream, and in practice this
 430                 // doesn't cause cloning 99.9% of the time.
 431                 //
 432                 // One very common use case is when `streams` has two elements,
 433                 // where the first stream has any number of elements within
 434                 // (often 1, but sometimes many more) and the second stream has
 435                 // a single element within.
 436
 437                 // Determine how much the first stream will be extended.
 438                 // Needed to avoid quadratic blow up from on-the-fly
 439                 // reallocations (#57735).
 440                 let num_appends = streams.iter().skip(1).map(|ts| ts.len()).sum();
 441
 442                 // Get the first stream. If it's `None`, create an empty
 443                 // stream.
 444                 let mut iter = streams.drain(..);
 445                 let mut first_stream_lrc = iter.next().unwrap().0;
 446
 447                 // Append the elements to the first stream, after reserving
 448                 // space for them.
 449                 let first_vec_mut = Lrc::make_mut(&mut first_stream_lrc);
 450                 first_vec_mut.reserve(num_appends);
 451                 for stream in iter {
 452                     first_vec_mut.extend(stream.0.iter().cloned());
 453                 }
 454
 455                 // Create the final `TokenStream`.
 456                 TokenStream(first_stream_lrc)
 457             }
 458         }
 459     }
 460
 461     pub fn trees(&self) -> Cursor {
 462         self.clone().into_trees()
 463     }
 464
 465     pub fn into_trees(self) -> Cursor {
 466         Cursor::new(self)
 467     }
 468
 469     /// Compares two `TokenStream`s, checking equality without regarding span information.
 470     pub fn eq_unspanned(&self, other: &TokenStream) -> bool {
 471         let mut t1 = self.trees();
 472         let mut t2 = other.trees();
 473         for (t1, t2) in iter::zip(&mut t1, &mut t2) {
 474             if !t1.eq_unspanned(&t2) {
 475                 return false;
 476             }
 477         }
 478         t1.next().is_none() && t2.next().is_none()
 479     }
 480
 481     pub fn map_enumerated<F: FnMut(usize, &TokenTree) -> TokenTree>(self, mut f: F) -> TokenStream {
 482         TokenStream(Lrc::new(
 483             self.0
 484                 .iter()
 485                 .enumerate()
 486                 .map(|(i, (tree, is_joint))| (f(i, tree), *is_joint))
 487                 .collect(),
 488         ))
 489     }
 490 }
 491
 492 // 99.5%+ of the time we have 1 or 2 elements in this vector.
 493 #[derive(Clone)]
 494 pub struct TokenStreamBuilder(SmallVec<[TokenStream; 2]>);
 495
 496 impl TokenStreamBuilder {
 497     pub fn new() -> TokenStreamBuilder {
 498         TokenStreamBuilder(SmallVec::new())
 499     }
 500
 501     pub fn push<T: Into<TokenStream>>(&mut self, stream: T) {
 502         let mut stream = stream.into();
 503
 504         // If `self` is not empty and the last tree within the last stream is a
 505         // token tree marked with `Joint`...
 506         if let Some(TokenStream(ref mut last_stream_lrc)) = self.0.last_mut() {
 507             if let Some((TokenTree::Token(last_token), Spacing::Joint)) = last_stream_lrc.last() {
 508                 // ...and `stream` is not empty and the first tree within it is
 509                 // a token tree...
 510                 let TokenStream(ref mut stream_lrc) = stream;
 511                 if let Some((TokenTree::Token(token), spacing)) = stream_lrc.first() {
 512                     // ...and the two tokens can be glued together...
 513                     if let Some(glued_tok) = last_token.glue(&token) {
 514                         // ...then do so, by overwriting the last token
 515                         // tree in `self` and removing the first token tree
 516                         // from `stream`. This requires using `make_mut()`
 517                         // on the last stream in `self` and on `stream`,
 518                         // and in practice this doesn't cause cloning 99.9%
 519                         // of the time.
 520
 521                         // Overwrite the last token tree with the merged
 522                         // token.
 523                         let last_vec_mut = Lrc::make_mut(last_stream_lrc);
 524                         *last_vec_mut.last_mut().unwrap() = (TokenTree::Token(glued_tok), *spacing);
 525
 526                         // Remove the first token tree from `stream`. (This
 527                         // is almost always the only tree in `stream`.)
 528                         let stream_vec_mut = Lrc::make_mut(stream_lrc);
 529                         stream_vec_mut.remove(0);
 530
 531                         // Don't push `stream` if it's empty -- that could
 532                         // block subsequent token gluing, by getting
 533                         // between two token trees that should be glued
 534                         // together.
 535                         if !stream.is_empty() {
 536                             self.0.push(stream);
 537                         }
 538                         return;
 539                     }
 540                 }
 541             }
 542         }
 543         self.0.push(stream);
 544     }
 545
 546     pub fn build(self) -> TokenStream {
 547         TokenStream::from_streams(self.0)
 548     }
 549 }
 550
 551 /// By-reference iterator over a [`TokenStream`].
 552 #[derive(Clone)]
 553 pub struct CursorRef<'t> {
 554     stream: &'t TokenStream,
 555     index: usize,
 556 }
 557
 558 impl<'t> CursorRef<'t> {
 559     fn next_with_spacing(&mut self) -> Option<&'t TreeAndSpacing> {
 560         self.stream.0.get(self.index).map(|tree| {
 561             self.index += 1;
 562             tree
 563         })
 564     }
 565 }
 566
 567 impl<'t> Iterator for CursorRef<'t> {
 568     type Item = &'t TokenTree;
 569
 570     fn next(&mut self) -> Option<&'t TokenTree> {
 571         self.next_with_spacing().map(|(tree, _)| tree)
 572     }
 573 }
 574
 575 /// Owning by-value iterator over a [`TokenStream`].
 576 // FIXME: Many uses of this can be replaced with by-reference iterator to avoid clones.
 577 #[derive(Clone)]
 578 pub struct Cursor {
 579     pub stream: TokenStream,
 580     index: usize,
 581 }
 582
 583 impl Iterator for Cursor {
 584     type Item = TokenTree;
 585
 586     fn next(&mut self) -> Option<TokenTree> {
 587         self.next_with_spacing().map(|(tree, _)| tree)
 588     }
 589 }
 590
 591 impl Cursor {
 592     fn new(stream: TokenStream) -> Self {
 593         Cursor { stream, index: 0 }
 594     }
 595
 596     pub fn next_with_spacing(&mut self) -> Option<TreeAndSpacing> {
 597         if self.index < self.stream.len() {
 598             self.index += 1;
 599             Some(self.stream.0[self.index - 1].clone())
 600         } else {
 601             None
 602         }
 603     }
 604
 605     pub fn index(&self) -> usize {
 606         self.index
 607     }
 608
 609     pub fn append(&mut self, new_stream: TokenStream) {
 610         if new_stream.is_empty() {
 611             return;
 612         }
 613         let index = self.index;
 614         let stream = mem::take(&mut self.stream);
 615         *self = TokenStream::from_streams(smallvec![stream, new_stream]).into_trees();
 616         self.index = index;
 617     }
 618
 619     pub fn look_ahead(&self, n: usize) -> Option<&TokenTree> {
 620         self.stream.0[self.index..].get(n).map(|(tree, _)| tree)
 621     }
 622 }
 623
 624 #[derive(Debug, Copy, Clone, PartialEq, Encodable, Decodable, HashStable_Generic)]
 625 pub struct DelimSpan {
 626     pub open: Span,
 627     pub close: Span,
 628 }
 629
 630 impl DelimSpan {
 631     pub fn from_single(sp: Span) -> Self {
 632         DelimSpan { open: sp, close: sp }
 633     }
 634
 635     pub fn from_pair(open: Span, close: Span) -> Self {
 636         DelimSpan { open, close }
 637     }
 638
 639     pub fn dummy() -> Self {
 640         Self::from_single(DUMMY_SP)
 641     }
 642
 643     pub fn entire(self) -> Span {
 644         self.open.with_hi(self.close.hi())
 645     }
 646 }