src/librustc_parse/parser/mod.rs

   1 pub mod attr;
   2 mod expr;
   3 mod item;
   4 mod module;
   5 pub use module::{ModulePath, ModulePathSuccess};
   6 mod pat;
   7 mod path;
   8 mod ty;
   9 pub use path::PathStyle;
  10 mod diagnostics;
  11 mod generics;
  12 mod stmt;
  13 use diagnostics::Error;
  14
  15 use crate::lexer::UnmatchedBrace;
  16 use crate::{Directory, DirectoryOwnership};
  17
  18 use log::debug;
  19 use rustc_ast_pretty::pprust;
  20 use rustc_errors::{struct_span_err, Applicability, DiagnosticBuilder, FatalError, PResult};
  21 use rustc_session::parse::ParseSess;
  22 use rustc_span::source_map::respan;
  23 use rustc_span::symbol::{kw, sym, Symbol};
  24 use rustc_span::{FileName, Span, DUMMY_SP};
  25 use syntax::ast::DUMMY_NODE_ID;
  26 use syntax::ast::{self, AttrStyle, AttrVec, Const, CrateSugar, Extern, Ident, Unsafe};
  27 use syntax::ast::{Async, MacArgs, MacDelimiter, Mutability, StrLit, Visibility, VisibilityKind};
  28 use syntax::ptr::P;
  29 use syntax::token::{self, DelimToken, Token, TokenKind};
  30 use syntax::tokenstream::{self, DelimSpan, TokenStream, TokenTree, TreeAndJoint};
  31 use syntax::util::comments::{doc_comment_style, strip_doc_comment_decoration};
  32
  33 use std::path::PathBuf;
  34 use std::{cmp, mem, slice};
  35
  36 bitflags::bitflags! {
  37     struct Restrictions: u8 {
  38         const STMT_EXPR         = 1 << 0;
  39         const NO_STRUCT_LITERAL = 1 << 1;
  40     }
  41 }
  42
  43 #[derive(Clone, Copy, PartialEq, Debug)]
  44 enum SemiColonMode {
  45     Break,
  46     Ignore,
  47     Comma,
  48 }
  49
  50 #[derive(Clone, Copy, PartialEq, Debug)]
  51 enum BlockMode {
  52     Break,
  53     Ignore,
  54 }
  55
  56 /// Like `maybe_whole_expr`, but for things other than expressions.
  57 #[macro_export]
  58 macro_rules! maybe_whole {
  59     ($p:expr, $constructor:ident, |$x:ident| $e:expr) => {
  60         if let token::Interpolated(nt) = &$p.token.kind {
  61             if let token::$constructor(x) = &**nt {
  62                 let $x = x.clone();
  63                 $p.bump();
  64                 return Ok($e);
  65             }
  66         }
  67     };
  68 }
  69
  70 /// If the next tokens are ill-formed `$ty::` recover them as `<$ty>::`.
  71 #[macro_export]
  72 macro_rules! maybe_recover_from_interpolated_ty_qpath {
  73     ($self: expr, $allow_qpath_recovery: expr) => {
  74         if $allow_qpath_recovery && $self.look_ahead(1, |t| t == &token::ModSep) {
  75             if let token::Interpolated(nt) = &$self.token.kind {
  76                 if let token::NtTy(ty) = &**nt {
  77                     let ty = ty.clone();
  78                     $self.bump();
  79                     return $self.maybe_recover_from_bad_qpath_stage_2($self.prev_span, ty);
  80                 }
  81             }
  82         }
  83     };
  84 }
  85
  86 #[derive(Clone)]
  87 pub struct Parser<'a> {
  88     pub sess: &'a ParseSess,
  89     /// The current normalized token.
  90     /// "Normalized" means that some interpolated tokens
  91     /// (`$i: ident` and `$l: lifetime` meta-variables) are replaced
  92     /// with non-interpolated identifier and lifetime tokens they refer to.
  93     /// Use span from this token if you need an isolated span.
  94     pub token: Token,
  95     /// The current non-normalized token if it's different from `token`.
  96     /// Use span from this token if you need to concatenate it with some neighbouring spans.
  97     unnormalized_token: Token,
  98     /// The previous normalized token.
  99     /// Use span from this token if you need an isolated span.
 100     prev_token: Token,
 101     /// The previous non-normalized token if it's different from `prev_token`.
 102     /// Use span from this token if you need to concatenate it with some neighbouring spans.
 103     unnormalized_prev_token: Token,
 104     /// Equivalent to `unnormalized_prev_token.span`.
 105     /// FIXME: Remove in favor of `(unnormalized_)prev_token.span`.
 106     pub prev_span: Span,
 107     restrictions: Restrictions,
 108     /// Used to determine the path to externally loaded source files.
 109     pub(super) directory: Directory,
 110     /// `true` to parse sub-modules in other files.
 111     // Public for rustfmt usage.
 112     pub recurse_into_file_modules: bool,
 113     /// Name of the root module this parser originated from. If `None`, then the
 114     /// name is not known. This does not change while the parser is descending
 115     /// into modules, and sub-parsers have new values for this name.
 116     pub root_module_name: Option<String>,
 117     expected_tokens: Vec<TokenType>,
 118     token_cursor: TokenCursor,
 119     desugar_doc_comments: bool,
 120     /// `true` we should configure out of line modules as we parse.
 121     // Public for rustfmt usage.
 122     pub cfg_mods: bool,
 123     /// This field is used to keep track of how many left angle brackets we have seen. This is
 124     /// required in order to detect extra leading left angle brackets (`<` characters) and error
 125     /// appropriately.
 126     ///
 127     /// See the comments in the `parse_path_segment` function for more details.
 128     unmatched_angle_bracket_count: u32,
 129     max_angle_bracket_count: u32,
 130     /// A list of all unclosed delimiters found by the lexer. If an entry is used for error recovery
 131     /// it gets removed from here. Every entry left at the end gets emitted as an independent
 132     /// error.
 133     pub(super) unclosed_delims: Vec<UnmatchedBrace>,
 134     last_unexpected_token_span: Option<Span>,
 135     pub last_type_ascription: Option<(Span, bool /* likely path typo */)>,
 136     /// If present, this `Parser` is not parsing Rust code but rather a macro call.
 137     subparser_name: Option<&'static str>,
 138 }
 139
 140 impl<'a> Drop for Parser<'a> {
 141     fn drop(&mut self) {
 142         emit_unclosed_delims(&mut self.unclosed_delims, &self.sess);
 143     }
 144 }
 145
 146 #[derive(Clone)]
 147 struct TokenCursor {
 148     frame: TokenCursorFrame,
 149     stack: Vec<TokenCursorFrame>,
 150 }
 151
 152 #[derive(Clone)]
 153 struct TokenCursorFrame {
 154     delim: token::DelimToken,
 155     span: DelimSpan,
 156     open_delim: bool,
 157     tree_cursor: tokenstream::Cursor,
 158     close_delim: bool,
 159     last_token: LastToken,
 160 }
 161
 162 /// This is used in `TokenCursorFrame` above to track tokens that are consumed
 163 /// by the parser, and then that's transitively used to record the tokens that
 164 /// each parse AST item is created with.
 165 ///
 166 /// Right now this has two states, either collecting tokens or not collecting
 167 /// tokens. If we're collecting tokens we just save everything off into a local
 168 /// `Vec`. This should eventually though likely save tokens from the original
 169 /// token stream and just use slicing of token streams to avoid creation of a
 170 /// whole new vector.
 171 ///
 172 /// The second state is where we're passively not recording tokens, but the last
 173 /// token is still tracked for when we want to start recording tokens. This
 174 /// "last token" means that when we start recording tokens we'll want to ensure
 175 /// that this, the first token, is included in the output.
 176 ///
 177 /// You can find some more example usage of this in the `collect_tokens` method
 178 /// on the parser.
 179 #[derive(Clone)]
 180 enum LastToken {
 181     Collecting(Vec<TreeAndJoint>),
 182     Was(Option<TreeAndJoint>),
 183 }
 184
 185 impl TokenCursorFrame {
 186     fn new(span: DelimSpan, delim: DelimToken, tts: &TokenStream) -> Self {
 187         TokenCursorFrame {
 188             delim,
 189             span,
 190             open_delim: delim == token::NoDelim,
 191             tree_cursor: tts.clone().into_trees(),
 192             close_delim: delim == token::NoDelim,
 193             last_token: LastToken::Was(None),
 194         }
 195     }
 196 }
 197
 198 impl TokenCursor {
 199     fn next(&mut self) -> Token {
 200         loop {
 201             let tree = if !self.frame.open_delim {
 202                 self.frame.open_delim = true;
 203                 TokenTree::open_tt(self.frame.span, self.frame.delim)
 204             } else if let Some(tree) = self.frame.tree_cursor.next() {
 205                 tree
 206             } else if !self.frame.close_delim {
 207                 self.frame.close_delim = true;
 208                 TokenTree::close_tt(self.frame.span, self.frame.delim)
 209             } else if let Some(frame) = self.stack.pop() {
 210                 self.frame = frame;
 211                 continue;
 212             } else {
 213                 return Token::new(token::Eof, DUMMY_SP);
 214             };
 215
 216             match self.frame.last_token {
 217                 LastToken::Collecting(ref mut v) => v.push(tree.clone().into()),
 218                 LastToken::Was(ref mut t) => *t = Some(tree.clone().into()),
 219             }
 220
 221             match tree {
 222                 TokenTree::Token(token) => return token,
 223                 TokenTree::Delimited(sp, delim, tts) => {
 224                     let frame = TokenCursorFrame::new(sp, delim, &tts);
 225                     self.stack.push(mem::replace(&mut self.frame, frame));
 226                 }
 227             }
 228         }
 229     }
 230
 231     fn next_desugared(&mut self) -> Token {
 232         let (name, sp) = match self.next() {
 233             Token { kind: token::DocComment(name), span } => (name, span),
 234             tok => return tok,
 235         };
 236
 237         let stripped = strip_doc_comment_decoration(&name.as_str());
 238
 239         // Searches for the occurrences of `"#*` and returns the minimum number of `#`s
 240         // required to wrap the text.
 241         let mut num_of_hashes = 0;
 242         let mut count = 0;
 243         for ch in stripped.chars() {
 244             count = match ch {
 245                 '"' => 1,
 246                 '#' if count > 0 => count + 1,
 247                 _ => 0,
 248             };
 249             num_of_hashes = cmp::max(num_of_hashes, count);
 250         }
 251
 252         let delim_span = DelimSpan::from_single(sp);
 253         let body = TokenTree::Delimited(
 254             delim_span,
 255             token::Bracket,
 256             [
 257                 TokenTree::token(token::Ident(sym::doc, false), sp),
 258                 TokenTree::token(token::Eq, sp),
 259                 TokenTree::token(
 260                     TokenKind::lit(token::StrRaw(num_of_hashes), Symbol::intern(&stripped), None),
 261                     sp,
 262                 ),
 263             ]
 264             .iter()
 265             .cloned()
 266             .collect::<TokenStream>(),
 267         );
 268
 269         self.stack.push(mem::replace(
 270             &mut self.frame,
 271             TokenCursorFrame::new(
 272                 delim_span,
 273                 token::NoDelim,
 274                 &if doc_comment_style(&name.as_str()) == AttrStyle::Inner {
 275                     [TokenTree::token(token::Pound, sp), TokenTree::token(token::Not, sp), body]
 276                         .iter()
 277                         .cloned()
 278                         .collect::<TokenStream>()
 279                 } else {
 280                     [TokenTree::token(token::Pound, sp), body]
 281                         .iter()
 282                         .cloned()
 283                         .collect::<TokenStream>()
 284                 },
 285             ),
 286         ));
 287
 288         self.next()
 289     }
 290 }
 291
 292 #[derive(Clone, PartialEq)]
 293 enum TokenType {
 294     Token(TokenKind),
 295     Keyword(Symbol),
 296     Operator,
 297     Lifetime,
 298     Ident,
 299     Path,
 300     Type,
 301     Const,
 302 }
 303
 304 impl TokenType {
 305     fn to_string(&self) -> String {
 306         match *self {
 307             TokenType::Token(ref t) => format!("`{}`", pprust::token_kind_to_string(t)),
 308             TokenType::Keyword(kw) => format!("`{}`", kw),
 309             TokenType::Operator => "an operator".to_string(),
 310             TokenType::Lifetime => "lifetime".to_string(),
 311             TokenType::Ident => "identifier".to_string(),
 312             TokenType::Path => "path".to_string(),
 313             TokenType::Type => "type".to_string(),
 314             TokenType::Const => "const".to_string(),
 315         }
 316     }
 317 }
 318
 319 #[derive(Copy, Clone, Debug)]
 320 enum TokenExpectType {
 321     Expect,
 322     NoExpect,
 323 }
 324
 325 /// A sequence separator.
 326 struct SeqSep {
 327     /// The separator token.
 328     sep: Option<TokenKind>,
 329     /// `true` if a trailing separator is allowed.
 330     trailing_sep_allowed: bool,
 331 }
 332
 333 impl SeqSep {
 334     fn trailing_allowed(t: TokenKind) -> SeqSep {
 335         SeqSep { sep: Some(t), trailing_sep_allowed: true }
 336     }
 337
 338     fn none() -> SeqSep {
 339         SeqSep { sep: None, trailing_sep_allowed: false }
 340     }
 341 }
 342
 343 pub enum FollowedByType {
 344     Yes,
 345     No,
 346 }
 347
 348 fn token_descr_opt(token: &Token) -> Option<&'static str> {
 349     Some(match token.kind {
 350         _ if token.is_special_ident() => "reserved identifier",
 351         _ if token.is_used_keyword() => "keyword",
 352         _ if token.is_unused_keyword() => "reserved keyword",
 353         token::DocComment(..) => "doc comment",
 354         _ => return None,
 355     })
 356 }
 357
 358 pub(super) fn token_descr(token: &Token) -> String {
 359     let token_str = pprust::token_to_string(token);
 360     match token_descr_opt(token) {
 361         Some(prefix) => format!("{} `{}`", prefix, token_str),
 362         _ => format!("`{}`", token_str),
 363     }
 364 }
 365
 366 impl<'a> Parser<'a> {
 367     pub fn new(
 368         sess: &'a ParseSess,
 369         tokens: TokenStream,
 370         directory: Option<Directory>,
 371         recurse_into_file_modules: bool,
 372         desugar_doc_comments: bool,
 373         subparser_name: Option<&'static str>,
 374     ) -> Self {
 375         let mut parser = Parser {
 376             sess,
 377             token: Token::dummy(),
 378             unnormalized_token: Token::dummy(),
 379             prev_token: Token::dummy(),
 380             unnormalized_prev_token: Token::dummy(),
 381             prev_span: DUMMY_SP,
 382             restrictions: Restrictions::empty(),
 383             recurse_into_file_modules,
 384             directory: Directory {
 385                 path: PathBuf::new(),
 386                 ownership: DirectoryOwnership::Owned { relative: None },
 387             },
 388             root_module_name: None,
 389             expected_tokens: Vec::new(),
 390             token_cursor: TokenCursor {
 391                 frame: TokenCursorFrame::new(DelimSpan::dummy(), token::NoDelim, &tokens),
 392                 stack: Vec::new(),
 393             },
 394             desugar_doc_comments,
 395             cfg_mods: true,
 396             unmatched_angle_bracket_count: 0,
 397             max_angle_bracket_count: 0,
 398             unclosed_delims: Vec::new(),
 399             last_unexpected_token_span: None,
 400             last_type_ascription: None,
 401             subparser_name,
 402         };
 403
 404         // Make parser point to the first token.
 405         parser.bump();
 406
 407         if let Some(directory) = directory {
 408             parser.directory = directory;
 409         } else if !parser.token.span.is_dummy() {
 410             if let Some(FileName::Real(path)) =
 411                 &sess.source_map().lookup_char_pos(parser.token.span.lo()).file.unmapped_path
 412             {
 413                 if let Some(directory_path) = path.parent() {
 414                     parser.directory.path = directory_path.to_path_buf();
 415                 }
 416             }
 417         }
 418
 419         parser
 420     }
 421
 422     fn next_tok(&mut self, fallback_span: Span) -> Token {
 423         let mut next = if self.desugar_doc_comments {
 424             self.token_cursor.next_desugared()
 425         } else {
 426             self.token_cursor.next()
 427         };
 428         if next.span.is_dummy() {
 429             // Tweak the location for better diagnostics, but keep syntactic context intact.
 430             next.span = fallback_span.with_ctxt(next.span.ctxt());
 431         }
 432         next
 433     }
 434
 435     crate fn unexpected<T>(&mut self) -> PResult<'a, T> {
 436         match self.expect_one_of(&[], &[]) {
 437             Err(e) => Err(e),
 438             // We can get `Ok(true)` from `recover_closing_delimiter`
 439             // which is called in `expected_one_of_not_found`.
 440             Ok(_) => FatalError.raise(),
 441         }
 442     }
 443
 444     /// Expects and consumes the token `t`. Signals an error if the next token is not `t`.
 445     pub fn expect(&mut self, t: &TokenKind) -> PResult<'a, bool /* recovered */> {
 446         if self.expected_tokens.is_empty() {
 447             if self.token == *t {
 448                 self.bump();
 449                 Ok(false)
 450             } else {
 451                 self.unexpected_try_recover(t)
 452             }
 453         } else {
 454             self.expect_one_of(slice::from_ref(t), &[])
 455         }
 456     }
 457
 458     /// Expect next token to be edible or inedible token.  If edible,
 459     /// then consume it; if inedible, then return without consuming
 460     /// anything.  Signal a fatal error if next token is unexpected.
 461     pub fn expect_one_of(
 462         &mut self,
 463         edible: &[TokenKind],
 464         inedible: &[TokenKind],
 465     ) -> PResult<'a, bool /* recovered */> {
 466         if edible.contains(&self.token.kind) {
 467             self.bump();
 468             Ok(false)
 469         } else if inedible.contains(&self.token.kind) {
 470             // leave it in the input
 471             Ok(false)
 472         } else if self.last_unexpected_token_span == Some(self.token.span) {
 473             FatalError.raise();
 474         } else {
 475             self.expected_one_of_not_found(edible, inedible)
 476         }
 477     }
 478
 479     // Public for rustfmt usage.
 480     pub fn parse_ident(&mut self) -> PResult<'a, ast::Ident> {
 481         self.parse_ident_common(true)
 482     }
 483
 484     fn parse_ident_common(&mut self, recover: bool) -> PResult<'a, ast::Ident> {
 485         match self.token.kind {
 486             token::Ident(name, _) => {
 487                 if self.token.is_reserved_ident() {
 488                     let mut err = self.expected_ident_found();
 489                     if recover {
 490                         err.emit();
 491                     } else {
 492                         return Err(err);
 493                     }
 494                 }
 495                 let span = self.token.span;
 496                 self.bump();
 497                 Ok(Ident::new(name, span))
 498             }
 499             _ => Err(match self.prev_token.kind {
 500                 TokenKind::DocComment(..) => {
 501                     self.span_fatal_err(self.prev_span, Error::UselessDocComment)
 502                 }
 503                 _ => self.expected_ident_found(),
 504             }),
 505         }
 506     }
 507
 508     /// Checks if the next token is `tok`, and returns `true` if so.
 509     ///
 510     /// This method will automatically add `tok` to `expected_tokens` if `tok` is not
 511     /// encountered.
 512     fn check(&mut self, tok: &TokenKind) -> bool {
 513         let is_present = self.token == *tok;
 514         if !is_present {
 515             self.expected_tokens.push(TokenType::Token(tok.clone()));
 516         }
 517         is_present
 518     }
 519
 520     /// Consumes a token 'tok' if it exists. Returns whether the given token was present.
 521     pub fn eat(&mut self, tok: &TokenKind) -> bool {
 522         let is_present = self.check(tok);
 523         if is_present {
 524             self.bump()
 525         }
 526         is_present
 527     }
 528
 529     /// If the next token is the given keyword, returns `true` without eating it.
 530     /// An expectation is also added for diagnostics purposes.
 531     fn check_keyword(&mut self, kw: Symbol) -> bool {
 532         self.expected_tokens.push(TokenType::Keyword(kw));
 533         self.token.is_keyword(kw)
 534     }
 535
 536     /// If the next token is the given keyword, eats it and returns `true`.
 537     /// Otherwise, returns `false`. An expectation is also added for diagnostics purposes.
 538     // Public for rustfmt usage.
 539     pub fn eat_keyword(&mut self, kw: Symbol) -> bool {
 540         if self.check_keyword(kw) {
 541             self.bump();
 542             true
 543         } else {
 544             false
 545         }
 546     }
 547
 548     fn eat_keyword_noexpect(&mut self, kw: Symbol) -> bool {
 549         if self.token.is_keyword(kw) {
 550             self.bump();
 551             true
 552         } else {
 553             false
 554         }
 555     }
 556
 557     /// If the given word is not a keyword, signals an error.
 558     /// If the next token is not the given word, signals an error.
 559     /// Otherwise, eats it.
 560     fn expect_keyword(&mut self, kw: Symbol) -> PResult<'a, ()> {
 561         if !self.eat_keyword(kw) { self.unexpected() } else { Ok(()) }
 562     }
 563
 564     /// Is the given keyword `kw` followed by a non-reserved identifier?
 565     fn is_kw_followed_by_ident(&self, kw: Symbol) -> bool {
 566         self.token.is_keyword(kw) && self.look_ahead(1, |t| t.is_ident() && !t.is_reserved_ident())
 567     }
 568
 569     fn check_or_expected(&mut self, ok: bool, typ: TokenType) -> bool {
 570         if ok {
 571             true
 572         } else {
 573             self.expected_tokens.push(typ);
 574             false
 575         }
 576     }
 577
 578     fn check_ident(&mut self) -> bool {
 579         self.check_or_expected(self.token.is_ident(), TokenType::Ident)
 580     }
 581
 582     fn check_path(&mut self) -> bool {
 583         self.check_or_expected(self.token.is_path_start(), TokenType::Path)
 584     }
 585
 586     fn check_type(&mut self) -> bool {
 587         self.check_or_expected(self.token.can_begin_type(), TokenType::Type)
 588     }
 589
 590     fn check_const_arg(&mut self) -> bool {
 591         self.check_or_expected(self.token.can_begin_const_arg(), TokenType::Const)
 592     }
 593
 594     /// Checks to see if the next token is either `+` or `+=`.
 595     /// Otherwise returns `false`.
 596     fn check_plus(&mut self) -> bool {
 597         self.check_or_expected(
 598             self.token.is_like_plus(),
 599             TokenType::Token(token::BinOp(token::Plus)),
 600         )
 601     }
 602
 603     /// Eats the expected token if it's present possibly breaking
 604     /// compound tokens like multi-character operators in process.
 605     /// Returns `true` if the token was eaten.
 606     fn break_and_eat(&mut self, expected: TokenKind) -> bool {
 607         if self.token.kind == expected {
 608             self.bump();
 609             return true;
 610         }
 611         match self.token.kind.break_two_token_op() {
 612             Some((first, second)) if first == expected => {
 613                 let first_span = self.sess.source_map().start_point(self.token.span);
 614                 let second_span = self.token.span.with_lo(first_span.hi());
 615                 self.set_token(Token::new(first, first_span));
 616                 self.bump_with(Token::new(second, second_span));
 617                 true
 618             }
 619             _ => {
 620                 self.expected_tokens.push(TokenType::Token(expected));
 621                 false
 622             }
 623         }
 624     }
 625
 626     /// Eats `+` possibly breaking tokens like `+=` in process.
 627     fn eat_plus(&mut self) -> bool {
 628         self.break_and_eat(token::BinOp(token::Plus))
 629     }
 630
 631     /// Eats `&` possibly breaking tokens like `&&` in process.
 632     /// Signals an error if `&` is not eaten.
 633     fn expect_and(&mut self) -> PResult<'a, ()> {
 634         if self.break_and_eat(token::BinOp(token::And)) { Ok(()) } else { self.unexpected() }
 635     }
 636
 637     /// Eats `|` possibly breaking tokens like `||` in process.
 638     /// Signals an error if `|` was not eaten.
 639     fn expect_or(&mut self) -> PResult<'a, ()> {
 640         if self.break_and_eat(token::BinOp(token::Or)) { Ok(()) } else { self.unexpected() }
 641     }
 642
 643     /// Eats `<` possibly breaking tokens like `<<` in process.
 644     fn eat_lt(&mut self) -> bool {
 645         let ate = self.break_and_eat(token::Lt);
 646         if ate {
 647             // See doc comment for `unmatched_angle_bracket_count`.
 648             self.unmatched_angle_bracket_count += 1;
 649             self.max_angle_bracket_count += 1;
 650             debug!("eat_lt: (increment) count={:?}", self.unmatched_angle_bracket_count);
 651         }
 652         ate
 653     }
 654
 655     /// Eats `<` possibly breaking tokens like `<<` in process.
 656     /// Signals an error if `<` was not eaten.
 657     fn expect_lt(&mut self) -> PResult<'a, ()> {
 658         if self.eat_lt() { Ok(()) } else { self.unexpected() }
 659     }
 660
 661     /// Eats `>` possibly breaking tokens like `>>` in process.
 662     /// Signals an error if `>` was not eaten.
 663     fn expect_gt(&mut self) -> PResult<'a, ()> {
 664         if self.break_and_eat(token::Gt) {
 665             // See doc comment for `unmatched_angle_bracket_count`.
 666             if self.unmatched_angle_bracket_count > 0 {
 667                 self.unmatched_angle_bracket_count -= 1;
 668                 debug!("expect_gt: (decrement) count={:?}", self.unmatched_angle_bracket_count);
 669             }
 670             Ok(())
 671         } else {
 672             self.unexpected()
 673         }
 674     }
 675
 676     fn expect_any_with_type(&mut self, kets: &[&TokenKind], expect: TokenExpectType) -> bool {
 677         kets.iter().any(|k| match expect {
 678             TokenExpectType::Expect => self.check(k),
 679             TokenExpectType::NoExpect => self.token == **k,
 680         })
 681     }
 682
 683     fn parse_seq_to_before_tokens<T>(
 684         &mut self,
 685         kets: &[&TokenKind],
 686         sep: SeqSep,
 687         expect: TokenExpectType,
 688         mut f: impl FnMut(&mut Parser<'a>) -> PResult<'a, T>,
 689     ) -> PResult<'a, (Vec<T>, bool /* trailing */, bool /* recovered */)> {
 690         let mut first = true;
 691         let mut recovered = false;
 692         let mut trailing = false;
 693         let mut v = vec![];
 694         while !self.expect_any_with_type(kets, expect) {
 695             if let token::CloseDelim(..) | token::Eof = self.token.kind {
 696                 break;
 697             }
 698             if let Some(ref t) = sep.sep {
 699                 if first {
 700                     first = false;
 701                 } else {
 702                     match self.expect(t) {
 703                         Ok(false) => {}
 704                         Ok(true) => {
 705                             recovered = true;
 706                             break;
 707                         }
 708                         Err(mut expect_err) => {
 709                             let sp = self.prev_span.shrink_to_hi();
 710                             let token_str = pprust::token_kind_to_string(t);
 711
 712                             // Attempt to keep parsing if it was a similar separator.
 713                             if let Some(ref tokens) = t.similar_tokens() {
 714                                 if tokens.contains(&self.token.kind) {
 715                                     self.bump();
 716                                 }
 717                             }
 718
 719                             // Attempt to keep parsing if it was an omitted separator.
 720                             match f(self) {
 721                                 Ok(t) => {
 722                                     // Parsed successfully, therefore most probably the code only
 723                                     // misses a separator.
 724                                     expect_err
 725                                         .span_suggestion_short(
 726                                             sp,
 727                                             &format!("missing `{}`", token_str),
 728                                             token_str,
 729                                             Applicability::MaybeIncorrect,
 730                                         )
 731                                         .emit();
 732
 733                                     v.push(t);
 734                                     continue;
 735                                 }
 736                                 Err(mut e) => {
 737                                     // Parsing failed, therefore it must be something more serious
 738                                     // than just a missing separator.
 739                                     expect_err.emit();
 740
 741                                     e.cancel();
 742                                     break;
 743                                 }
 744                             }
 745                         }
 746                     }
 747                 }
 748             }
 749             if sep.trailing_sep_allowed && self.expect_any_with_type(kets, expect) {
 750                 trailing = true;
 751                 break;
 752             }
 753
 754             let t = f(self)?;
 755             v.push(t);
 756         }
 757
 758         Ok((v, trailing, recovered))
 759     }
 760
 761     /// Parses a sequence, not including the closing delimiter. The function
 762     /// `f` must consume tokens until reaching the next separator or
 763     /// closing bracket.
 764     fn parse_seq_to_before_end<T>(
 765         &mut self,
 766         ket: &TokenKind,
 767         sep: SeqSep,
 768         f: impl FnMut(&mut Parser<'a>) -> PResult<'a, T>,
 769     ) -> PResult<'a, (Vec<T>, bool, bool)> {
 770         self.parse_seq_to_before_tokens(&[ket], sep, TokenExpectType::Expect, f)
 771     }
 772
 773     /// Parses a sequence, including the closing delimiter. The function
 774     /// `f` must consume tokens until reaching the next separator or
 775     /// closing bracket.
 776     fn parse_seq_to_end<T>(
 777         &mut self,
 778         ket: &TokenKind,
 779         sep: SeqSep,
 780         f: impl FnMut(&mut Parser<'a>) -> PResult<'a, T>,
 781     ) -> PResult<'a, (Vec<T>, bool /* trailing */)> {
 782         let (val, trailing, recovered) = self.parse_seq_to_before_end(ket, sep, f)?;
 783         if !recovered {
 784             self.eat(ket);
 785         }
 786         Ok((val, trailing))
 787     }
 788
 789     /// Parses a sequence, including the closing delimiter. The function
 790     /// `f` must consume tokens until reaching the next separator or
 791     /// closing bracket.
 792     fn parse_unspanned_seq<T>(
 793         &mut self,
 794         bra: &TokenKind,
 795         ket: &TokenKind,
 796         sep: SeqSep,
 797         f: impl FnMut(&mut Parser<'a>) -> PResult<'a, T>,
 798     ) -> PResult<'a, (Vec<T>, bool)> {
 799         self.expect(bra)?;
 800         self.parse_seq_to_end(ket, sep, f)
 801     }
 802
 803     fn parse_delim_comma_seq<T>(
 804         &mut self,
 805         delim: DelimToken,
 806         f: impl FnMut(&mut Parser<'a>) -> PResult<'a, T>,
 807     ) -> PResult<'a, (Vec<T>, bool)> {
 808         self.parse_unspanned_seq(
 809             &token::OpenDelim(delim),
 810             &token::CloseDelim(delim),
 811             SeqSep::trailing_allowed(token::Comma),
 812             f,
 813         )
 814     }
 815
 816     fn parse_paren_comma_seq<T>(
 817         &mut self,
 818         f: impl FnMut(&mut Parser<'a>) -> PResult<'a, T>,
 819     ) -> PResult<'a, (Vec<T>, bool)> {
 820         self.parse_delim_comma_seq(token::Paren, f)
 821     }
 822
 823     // Interpolated identifier (`$i: ident`) and lifetime (`$l: lifetime`)
 824     // tokens are replaced with usual identifier and lifetime tokens,
 825     // so the former are never encountered during normal parsing.
 826     crate fn set_token(&mut self, token: Token) {
 827         self.unnormalized_token = token;
 828         self.token = match &self.unnormalized_token.kind {
 829             token::Interpolated(nt) => match **nt {
 830                 token::NtIdent(ident, is_raw) => {
 831                     Token::new(token::Ident(ident.name, is_raw), ident.span)
 832                 }
 833                 token::NtLifetime(ident) => Token::new(token::Lifetime(ident.name), ident.span),
 834                 _ => self.unnormalized_token.clone(),
 835             },
 836             _ => self.unnormalized_token.clone(),
 837         }
 838     }
 839
 840     /// Advance the parser by one token using provided token as the next one.
 841     fn bump_with(&mut self, next_token: Token) {
 842         // Bumping after EOF is a bad sign, usually an infinite loop.
 843         if self.prev_token.kind == TokenKind::Eof {
 844             let msg = "attempted to bump the parser past EOF (may be stuck in a loop)";
 845             self.span_bug(self.token.span, msg);
 846         }
 847
 848         // Update the current and previous tokens.
 849         self.prev_token = self.token.take();
 850         self.unnormalized_prev_token = self.unnormalized_token.take();
 851         self.set_token(next_token);
 852
 853         // Update fields derived from the previous token.
 854         self.prev_span = self.unnormalized_prev_token.span;
 855
 856         // Diagnostics.
 857         self.expected_tokens.clear();
 858     }
 859
 860     /// Advance the parser by one token.
 861     pub fn bump(&mut self) {
 862         let next_token = self.next_tok(self.unnormalized_token.span);
 863         self.bump_with(next_token);
 864     }
 865
 866     /// Look-ahead `dist` tokens of `self.token` and get access to that token there.
 867     /// When `dist == 0` then the current token is looked at.
 868     pub fn look_ahead<R>(&self, dist: usize, looker: impl FnOnce(&Token) -> R) -> R {
 869         if dist == 0 {
 870             return looker(&self.token);
 871         }
 872
 873         let frame = &self.token_cursor.frame;
 874         looker(&match frame.tree_cursor.look_ahead(dist - 1) {
 875             Some(tree) => match tree {
 876                 TokenTree::Token(token) => token,
 877                 TokenTree::Delimited(dspan, delim, _) => {
 878                     Token::new(token::OpenDelim(delim), dspan.open)
 879                 }
 880             },
 881             None => Token::new(token::CloseDelim(frame.delim), frame.span.close),
 882         })
 883     }
 884
 885     /// Returns whether any of the given keywords are `dist` tokens ahead of the current one.
 886     fn is_keyword_ahead(&self, dist: usize, kws: &[Symbol]) -> bool {
 887         self.look_ahead(dist, |t| kws.iter().any(|&kw| t.is_keyword(kw)))
 888     }
 889
 890     /// Parses asyncness: `async` or nothing.
 891     fn parse_asyncness(&mut self) -> Async {
 892         if self.eat_keyword(kw::Async) {
 893             let span = self.prev_span;
 894             Async::Yes { span, closure_id: DUMMY_NODE_ID, return_impl_trait_id: DUMMY_NODE_ID }
 895         } else {
 896             Async::No
 897         }
 898     }
 899
 900     /// Parses unsafety: `unsafe` or nothing.
 901     fn parse_unsafety(&mut self) -> Unsafe {
 902         if self.eat_keyword(kw::Unsafe) { Unsafe::Yes(self.prev_span) } else { Unsafe::No }
 903     }
 904
 905     /// Parses constness: `const` or nothing.
 906     fn parse_constness(&mut self) -> Const {
 907         if self.eat_keyword(kw::Const) { Const::Yes(self.prev_span) } else { Const::No }
 908     }
 909
 910     /// Parses mutability (`mut` or nothing).
 911     fn parse_mutability(&mut self) -> Mutability {
 912         if self.eat_keyword(kw::Mut) { Mutability::Mut } else { Mutability::Not }
 913     }
 914
 915     /// Possibly parses mutability (`const` or `mut`).
 916     fn parse_const_or_mut(&mut self) -> Option<Mutability> {
 917         if self.eat_keyword(kw::Mut) {
 918             Some(Mutability::Mut)
 919         } else if self.eat_keyword(kw::Const) {
 920             Some(Mutability::Not)
 921         } else {
 922             None
 923         }
 924     }
 925
 926     fn parse_field_name(&mut self) -> PResult<'a, Ident> {
 927         if let token::Literal(token::Lit { kind: token::Integer, symbol, suffix }) = self.token.kind
 928         {
 929             self.expect_no_suffix(self.token.span, "a tuple index", suffix);
 930             self.bump();
 931             Ok(Ident::new(symbol, self.prev_span))
 932         } else {
 933             self.parse_ident_common(false)
 934         }
 935     }
 936
 937     fn parse_mac_args(&mut self) -> PResult<'a, P<MacArgs>> {
 938         self.parse_mac_args_common(true).map(P)
 939     }
 940
 941     fn parse_attr_args(&mut self) -> PResult<'a, MacArgs> {
 942         self.parse_mac_args_common(false)
 943     }
 944
 945     fn parse_mac_args_common(&mut self, delimited_only: bool) -> PResult<'a, MacArgs> {
 946         Ok(
 947             if self.check(&token::OpenDelim(DelimToken::Paren))
 948                 || self.check(&token::OpenDelim(DelimToken::Bracket))
 949                 || self.check(&token::OpenDelim(DelimToken::Brace))
 950             {
 951                 match self.parse_token_tree() {
 952                     TokenTree::Delimited(dspan, delim, tokens) =>
 953                     // We've confirmed above that there is a delimiter so unwrapping is OK.
 954                     {
 955                         MacArgs::Delimited(dspan, MacDelimiter::from_token(delim).unwrap(), tokens)
 956                     }
 957                     _ => unreachable!(),
 958                 }
 959             } else if !delimited_only {
 960                 if self.eat(&token::Eq) {
 961                     let eq_span = self.prev_span;
 962                     let mut is_interpolated_expr = false;
 963                     if let token::Interpolated(nt) = &self.token.kind {
 964                         if let token::NtExpr(..) = **nt {
 965                             is_interpolated_expr = true;
 966                         }
 967                     }
 968                     let token_tree = if is_interpolated_expr {
 969                         // We need to accept arbitrary interpolated expressions to continue
 970                         // supporting things like `doc = $expr` that work on stable.
 971                         // Non-literal interpolated expressions are rejected after expansion.
 972                         self.parse_token_tree()
 973                     } else {
 974                         self.parse_unsuffixed_lit()?.token_tree()
 975                     };
 976
 977                     MacArgs::Eq(eq_span, token_tree.into())
 978                 } else {
 979                     MacArgs::Empty
 980                 }
 981             } else {
 982                 return self.unexpected();
 983             },
 984         )
 985     }
 986
 987     fn parse_or_use_outer_attributes(
 988         &mut self,
 989         already_parsed_attrs: Option<AttrVec>,
 990     ) -> PResult<'a, AttrVec> {
 991         if let Some(attrs) = already_parsed_attrs {
 992             Ok(attrs)
 993         } else {
 994             self.parse_outer_attributes().map(|a| a.into())
 995         }
 996     }
 997
 998     /// Parses a single token tree from the input.
 999     pub fn parse_token_tree(&mut self) -> TokenTree {
1000         match self.token.kind {
1001             token::OpenDelim(..) => {
1002                 let frame = mem::replace(
1003                     &mut self.token_cursor.frame,
1004                     self.token_cursor.stack.pop().unwrap(),
1005                 );
1006                 self.set_token(Token::new(TokenKind::CloseDelim(frame.delim), frame.span.close));
1007                 self.bump();
1008                 TokenTree::Delimited(frame.span, frame.delim, frame.tree_cursor.stream)
1009             }
1010             token::CloseDelim(_) | token::Eof => unreachable!(),
1011             _ => {
1012                 self.bump();
1013                 TokenTree::Token(self.prev_token.clone())
1014             }
1015         }
1016     }
1017
1018     /// Parses a stream of tokens into a list of `TokenTree`s, up to EOF.
1019     pub fn parse_all_token_trees(&mut self) -> PResult<'a, Vec<TokenTree>> {
1020         let mut tts = Vec::new();
1021         while self.token != token::Eof {
1022             tts.push(self.parse_token_tree());
1023         }
1024         Ok(tts)
1025     }
1026
1027     pub fn parse_tokens(&mut self) -> TokenStream {
1028         let mut result = Vec::new();
1029         loop {
1030             match self.token.kind {
1031                 token::Eof | token::CloseDelim(..) => break,
1032                 _ => result.push(self.parse_token_tree().into()),
1033             }
1034         }
1035         TokenStream::new(result)
1036     }
1037
1038     /// Evaluates the closure with restrictions in place.
1039     ///
1040     /// Afters the closure is evaluated, restrictions are reset.
1041     fn with_res<T>(&mut self, res: Restrictions, f: impl FnOnce(&mut Self) -> T) -> T {
1042         let old = self.restrictions;
1043         self.restrictions = res;
1044         let res = f(self);
1045         self.restrictions = old;
1046         res
1047     }
1048
1049     fn is_crate_vis(&self) -> bool {
1050         self.token.is_keyword(kw::Crate) && self.look_ahead(1, |t| t != &token::ModSep)
1051     }
1052
1053     /// Parses `pub`, `pub(crate)` and `pub(in path)` plus shortcuts `crate` for `pub(crate)`,
1054     /// `pub(self)` for `pub(in self)` and `pub(super)` for `pub(in super)`.
1055     /// If the following element can't be a tuple (i.e., it's a function definition), then
1056     /// it's not a tuple struct field), and the contents within the parentheses isn't valid,
1057     /// so emit a proper diagnostic.
1058     pub fn parse_visibility(&mut self, fbt: FollowedByType) -> PResult<'a, Visibility> {
1059         maybe_whole!(self, NtVis, |x| x);
1060
1061         self.expected_tokens.push(TokenType::Keyword(kw::Crate));
1062         if self.is_crate_vis() {
1063             self.bump(); // `crate`
1064             self.sess.gated_spans.gate(sym::crate_visibility_modifier, self.prev_span);
1065             return Ok(respan(self.prev_span, VisibilityKind::Crate(CrateSugar::JustCrate)));
1066         }
1067
1068         if !self.eat_keyword(kw::Pub) {
1069             // We need a span for our `Spanned<VisibilityKind>`, but there's inherently no
1070             // keyword to grab a span from for inherited visibility; an empty span at the
1071             // beginning of the current token would seem to be the "Schelling span".
1072             return Ok(respan(self.token.span.shrink_to_lo(), VisibilityKind::Inherited));
1073         }
1074         let lo = self.prev_span;
1075
1076         if self.check(&token::OpenDelim(token::Paren)) {
1077             // We don't `self.bump()` the `(` yet because this might be a struct definition where
1078             // `()` or a tuple might be allowed. For example, `struct Struct(pub (), pub (usize));`.
1079             // Because of this, we only `bump` the `(` if we're assured it is appropriate to do so
1080             // by the following tokens.
1081             if self.is_keyword_ahead(1, &[kw::Crate]) && self.look_ahead(2, |t| t != &token::ModSep)
1082             // account for `pub(crate::foo)`
1083             {
1084                 // Parse `pub(crate)`.
1085                 self.bump(); // `(`
1086                 self.bump(); // `crate`
1087                 self.expect(&token::CloseDelim(token::Paren))?; // `)`
1088                 let vis = VisibilityKind::Crate(CrateSugar::PubCrate);
1089                 return Ok(respan(lo.to(self.prev_span), vis));
1090             } else if self.is_keyword_ahead(1, &[kw::In]) {
1091                 // Parse `pub(in path)`.
1092                 self.bump(); // `(`
1093                 self.bump(); // `in`
1094                 let path = self.parse_path(PathStyle::Mod)?; // `path`
1095                 self.expect(&token::CloseDelim(token::Paren))?; // `)`
1096                 let vis = VisibilityKind::Restricted { path: P(path), id: ast::DUMMY_NODE_ID };
1097                 return Ok(respan(lo.to(self.prev_span), vis));
1098             } else if self.look_ahead(2, |t| t == &token::CloseDelim(token::Paren))
1099                 && self.is_keyword_ahead(1, &[kw::Super, kw::SelfLower])
1100             {
1101                 // Parse `pub(self)` or `pub(super)`.
1102                 self.bump(); // `(`
1103                 let path = self.parse_path(PathStyle::Mod)?; // `super`/`self`
1104                 self.expect(&token::CloseDelim(token::Paren))?; // `)`
1105                 let vis = VisibilityKind::Restricted { path: P(path), id: ast::DUMMY_NODE_ID };
1106                 return Ok(respan(lo.to(self.prev_span), vis));
1107             } else if let FollowedByType::No = fbt {
1108                 // Provide this diagnostic if a type cannot follow;
1109                 // in particular, if this is not a tuple struct.
1110                 self.recover_incorrect_vis_restriction()?;
1111                 // Emit diagnostic, but continue with public visibility.
1112             }
1113         }
1114
1115         Ok(respan(lo, VisibilityKind::Public))
1116     }
1117
1118     /// Recovery for e.g. `pub(something) fn ...` or `struct X { pub(something) y: Z }`
1119     fn recover_incorrect_vis_restriction(&mut self) -> PResult<'a, ()> {
1120         self.bump(); // `(`
1121         let path = self.parse_path(PathStyle::Mod)?;
1122         self.expect(&token::CloseDelim(token::Paren))?; // `)`
1123
1124         let msg = "incorrect visibility restriction";
1125         let suggestion = r##"some possible visibility restrictions are:
1126 `pub(crate)`: visible only on the current crate
1127 `pub(super)`: visible only in the current module's parent
1128 `pub(in path::to::module)`: visible only on the specified path"##;
1129
1130         let path_str = pprust::path_to_string(&path);
1131
1132         struct_span_err!(self.sess.span_diagnostic, path.span, E0704, "{}", msg)
1133             .help(suggestion)
1134             .span_suggestion(
1135                 path.span,
1136                 &format!("make this visible only to module `{}` with `in`", path_str),
1137                 format!("in {}", path_str),
1138                 Applicability::MachineApplicable,
1139             )
1140             .emit();
1141
1142         Ok(())
1143     }
1144
1145     /// Parses `extern string_literal?`.
1146     fn parse_extern(&mut self) -> PResult<'a, Extern> {
1147         Ok(if self.eat_keyword(kw::Extern) {
1148             Extern::from_abi(self.parse_abi())
1149         } else {
1150             Extern::None
1151         })
1152     }
1153
1154     /// Parses a string literal as an ABI spec.
1155     fn parse_abi(&mut self) -> Option<StrLit> {
1156         match self.parse_str_lit() {
1157             Ok(str_lit) => Some(str_lit),
1158             Err(Some(lit)) => match lit.kind {
1159                 ast::LitKind::Err(_) => None,
1160                 _ => {
1161                     self.struct_span_err(lit.span, "non-string ABI literal")
1162                         .span_suggestion(
1163                             lit.span,
1164                             "specify the ABI with a string literal",
1165                             "\"C\"".to_string(),
1166                             Applicability::MaybeIncorrect,
1167                         )
1168                         .emit();
1169                     None
1170                 }
1171             },
1172             Err(None) => None,
1173         }
1174     }
1175
1176     fn collect_tokens<R>(
1177         &mut self,
1178         f: impl FnOnce(&mut Self) -> PResult<'a, R>,
1179     ) -> PResult<'a, (R, TokenStream)> {
1180         // Record all tokens we parse when parsing this item.
1181         let mut tokens = Vec::new();
1182         let prev_collecting = match self.token_cursor.frame.last_token {
1183             LastToken::Collecting(ref mut list) => Some(mem::take(list)),
1184             LastToken::Was(ref mut last) => {
1185                 tokens.extend(last.take());
1186                 None
1187             }
1188         };
1189         self.token_cursor.frame.last_token = LastToken::Collecting(tokens);
1190         let prev = self.token_cursor.stack.len();
1191         let ret = f(self);
1192         let last_token = if self.token_cursor.stack.len() == prev {
1193             &mut self.token_cursor.frame.last_token
1194         } else if self.token_cursor.stack.get(prev).is_none() {
1195             // This can happen due to a bad interaction of two unrelated recovery mechanisms with
1196             // mismatched delimiters *and* recovery lookahead on the likely typo `pub ident(`
1197             // (#62881).
1198             return Ok((ret?, TokenStream::default()));
1199         } else {
1200             &mut self.token_cursor.stack[prev].last_token
1201         };
1202
1203         // Pull out the tokens that we've collected from the call to `f` above.
1204         let mut collected_tokens = match *last_token {
1205             LastToken::Collecting(ref mut v) => mem::take(v),
1206             LastToken::Was(ref was) => {
1207                 let msg = format!("our vector went away? - found Was({:?})", was);
1208                 debug!("collect_tokens: {}", msg);
1209                 self.sess.span_diagnostic.delay_span_bug(self.token.span, &msg);
1210                 // This can happen due to a bad interaction of two unrelated recovery mechanisms
1211                 // with mismatched delimiters *and* recovery lookahead on the likely typo
1212                 // `pub ident(` (#62895, different but similar to the case above).
1213                 return Ok((ret?, TokenStream::default()));
1214             }
1215         };
1216
1217         // If we're not at EOF our current token wasn't actually consumed by
1218         // `f`, but it'll still be in our list that we pulled out. In that case
1219         // put it back.
1220         let extra_token = if self.token != token::Eof { collected_tokens.pop() } else { None };
1221
1222         // If we were previously collecting tokens, then this was a recursive
1223         // call. In that case we need to record all the tokens we collected in
1224         // our parent list as well. To do that we push a clone of our stream
1225         // onto the previous list.
1226         match prev_collecting {
1227             Some(mut list) => {
1228                 list.extend(collected_tokens.iter().cloned());
1229                 list.extend(extra_token);
1230                 *last_token = LastToken::Collecting(list);
1231             }
1232             None => {
1233                 *last_token = LastToken::Was(extra_token);
1234             }
1235         }
1236
1237         Ok((ret?, TokenStream::new(collected_tokens)))
1238     }
1239
1240     /// `::{` or `::*`
1241     fn is_import_coupler(&mut self) -> bool {
1242         self.check(&token::ModSep)
1243             && self.look_ahead(1, |t| {
1244                 *t == token::OpenDelim(token::Brace) || *t == token::BinOp(token::Star)
1245             })
1246     }
1247 }
1248
1249 crate fn make_unclosed_delims_error(
1250     unmatched: UnmatchedBrace,
1251     sess: &ParseSess,
1252 ) -> Option<DiagnosticBuilder<'_>> {
1253     // `None` here means an `Eof` was found. We already emit those errors elsewhere, we add them to
1254     // `unmatched_braces` only for error recovery in the `Parser`.
1255     let found_delim = unmatched.found_delim?;
1256     let mut err = sess.span_diagnostic.struct_span_err(
1257         unmatched.found_span,
1258         &format!(
1259             "mismatched closing delimiter: `{}`",
1260             pprust::token_kind_to_string(&token::CloseDelim(found_delim)),
1261         ),
1262     );
1263     err.span_label(unmatched.found_span, "mismatched closing delimiter");
1264     if let Some(sp) = unmatched.candidate_span {
1265         err.span_label(sp, "closing delimiter possibly meant for this");
1266     }
1267     if let Some(sp) = unmatched.unclosed_span {
1268         err.span_label(sp, "unclosed delimiter");
1269     }
1270     Some(err)
1271 }
1272
1273 pub fn emit_unclosed_delims(unclosed_delims: &mut Vec<UnmatchedBrace>, sess: &ParseSess) {
1274     *sess.reached_eof.borrow_mut() |=
1275         unclosed_delims.iter().any(|unmatched_delim| unmatched_delim.found_delim.is_none());
1276     for unmatched in unclosed_delims.drain(..) {
1277         make_unclosed_delims_error(unmatched, sess).map(|mut e| {
1278             e.emit();
1279         });
1280     }
1281 }