5 pub use module::{ModulePath, ModulePathSuccess};
9 pub use path::PathStyle;
13 use diagnostics::Error;
15 use crate::lexer::UnmatchedBrace;
16 use crate::{Directory, DirectoryOwnership};
19 use rustc_ast::ast::DUMMY_NODE_ID;
20 use rustc_ast::ast::{self, AttrStyle, AttrVec, Const, CrateSugar, Extern, Ident, Unsafe};
22 Async, MacArgs, MacDelimiter, Mutability, StrLit, Visibility, VisibilityKind,
24 use rustc_ast::ptr::P;
25 use rustc_ast::token::{self, DelimToken, Token, TokenKind};
26 use rustc_ast::tokenstream::{self, DelimSpan, TokenStream, TokenTree, TreeAndJoint};
27 use rustc_ast::util::comments::{doc_comment_style, strip_doc_comment_decoration};
28 use rustc_ast_pretty::pprust;
29 use rustc_errors::{struct_span_err, Applicability, DiagnosticBuilder, FatalError, PResult};
30 use rustc_session::parse::ParseSess;
31 use rustc_span::source_map::respan;
32 use rustc_span::symbol::{kw, sym, Symbol};
33 use rustc_span::{FileName, Span, DUMMY_SP};
35 use std::path::PathBuf;
36 use std::{cmp, mem, slice};
39 struct Restrictions: u8 {
40 const STMT_EXPR = 1 << 0;
41 const NO_STRUCT_LITERAL = 1 << 1;
45 #[derive(Clone, Copy, PartialEq, Debug)]
52 #[derive(Clone, Copy, PartialEq, Debug)]
58 /// Like `maybe_whole_expr`, but for things other than expressions.
60 macro_rules! maybe_whole {
61 ($p:expr, $constructor:ident, |$x:ident| $e:expr) => {
62 if let token::Interpolated(nt) = &$p.token.kind {
63 if let token::$constructor(x) = &**nt {
72 /// If the next tokens are ill-formed `$ty::` recover them as `<$ty>::`.
74 macro_rules! maybe_recover_from_interpolated_ty_qpath {
75 ($self: expr, $allow_qpath_recovery: expr) => {
76 if $allow_qpath_recovery && $self.look_ahead(1, |t| t == &token::ModSep) {
77 if let token::Interpolated(nt) = &$self.token.kind {
78 if let token::NtTy(ty) = &**nt {
81 return $self.maybe_recover_from_bad_qpath_stage_2($self.prev_token.span, ty);
89 pub struct Parser<'a> {
90 pub sess: &'a ParseSess,
91 /// The current non-normalized token.
93 /// The current normalized token.
94 /// "Normalized" means that some interpolated tokens
95 /// (`$i: ident` and `$l: lifetime` meta-variables) are replaced
96 /// with non-interpolated identifier and lifetime tokens they refer to.
97 /// Use this if you need to check for `token::Ident` or `token::Lifetime` specifically,
98 /// this also includes edition checks for edition-specific keyword identifiers.
99 pub normalized_token: Token,
100 /// The previous non-normalized token.
101 pub prev_token: Token,
102 /// The previous normalized token.
103 /// Use this if you need to check for `token::Ident` or `token::Lifetime` specifically,
104 /// this also includes edition checks for edition-specific keyword identifiers.
105 pub normalized_prev_token: Token,
106 restrictions: Restrictions,
107 /// Used to determine the path to externally loaded source files.
108 pub(super) directory: Directory,
109 /// `true` to parse sub-modules in other files.
110 // Public for rustfmt usage.
111 pub recurse_into_file_modules: bool,
112 /// Name of the root module this parser originated from. If `None`, then the
113 /// name is not known. This does not change while the parser is descending
114 /// into modules, and sub-parsers have new values for this name.
115 pub root_module_name: Option<String>,
116 expected_tokens: Vec<TokenType>,
117 token_cursor: TokenCursor,
118 desugar_doc_comments: bool,
119 /// `true` we should configure out of line modules as we parse.
120 // Public for rustfmt usage.
122 /// This field is used to keep track of how many left angle brackets we have seen. This is
123 /// required in order to detect extra leading left angle brackets (`<` characters) and error
126 /// See the comments in the `parse_path_segment` function for more details.
127 unmatched_angle_bracket_count: u32,
128 max_angle_bracket_count: u32,
129 /// A list of all unclosed delimiters found by the lexer. If an entry is used for error recovery
130 /// it gets removed from here. Every entry left at the end gets emitted as an independent
132 pub(super) unclosed_delims: Vec<UnmatchedBrace>,
133 last_unexpected_token_span: Option<Span>,
134 pub last_type_ascription: Option<(Span, bool /* likely path typo */)>,
135 /// If present, this `Parser` is not parsing Rust code but rather a macro call.
136 subparser_name: Option<&'static str>,
139 impl<'a> Drop for Parser<'a> {
141 emit_unclosed_delims(&mut self.unclosed_delims, &self.sess);
147 frame: TokenCursorFrame,
148 stack: Vec<TokenCursorFrame>,
152 struct TokenCursorFrame {
153 delim: token::DelimToken,
156 tree_cursor: tokenstream::Cursor,
158 last_token: LastToken,
161 /// This is used in `TokenCursorFrame` above to track tokens that are consumed
162 /// by the parser, and then that's transitively used to record the tokens that
163 /// each parse AST item is created with.
165 /// Right now this has two states, either collecting tokens or not collecting
166 /// tokens. If we're collecting tokens we just save everything off into a local
167 /// `Vec`. This should eventually though likely save tokens from the original
168 /// token stream and just use slicing of token streams to avoid creation of a
169 /// whole new vector.
171 /// The second state is where we're passively not recording tokens, but the last
172 /// token is still tracked for when we want to start recording tokens. This
173 /// "last token" means that when we start recording tokens we'll want to ensure
174 /// that this, the first token, is included in the output.
176 /// You can find some more example usage of this in the `collect_tokens` method
180 Collecting(Vec<TreeAndJoint>),
181 Was(Option<TreeAndJoint>),
184 impl TokenCursorFrame {
185 fn new(span: DelimSpan, delim: DelimToken, tts: &TokenStream) -> Self {
189 open_delim: delim == token::NoDelim,
190 tree_cursor: tts.clone().into_trees(),
191 close_delim: delim == token::NoDelim,
192 last_token: LastToken::Was(None),
198 fn next(&mut self) -> Token {
200 let tree = if !self.frame.open_delim {
201 self.frame.open_delim = true;
202 TokenTree::open_tt(self.frame.span, self.frame.delim)
203 } else if let Some(tree) = self.frame.tree_cursor.next() {
205 } else if !self.frame.close_delim {
206 self.frame.close_delim = true;
207 TokenTree::close_tt(self.frame.span, self.frame.delim)
208 } else if let Some(frame) = self.stack.pop() {
212 return Token::new(token::Eof, DUMMY_SP);
215 match self.frame.last_token {
216 LastToken::Collecting(ref mut v) => v.push(tree.clone().into()),
217 LastToken::Was(ref mut t) => *t = Some(tree.clone().into()),
221 TokenTree::Token(token) => return token,
222 TokenTree::Delimited(sp, delim, tts) => {
223 let frame = TokenCursorFrame::new(sp, delim, &tts);
224 self.stack.push(mem::replace(&mut self.frame, frame));
230 fn next_desugared(&mut self) -> Token {
231 let (name, sp) = match self.next() {
232 Token { kind: token::DocComment(name), span } => (name, span),
236 let stripped = strip_doc_comment_decoration(&name.as_str());
238 // Searches for the occurrences of `"#*` and returns the minimum number of `#`s
239 // required to wrap the text.
240 let mut num_of_hashes = 0;
242 for ch in stripped.chars() {
245 '#' if count > 0 => count + 1,
248 num_of_hashes = cmp::max(num_of_hashes, count);
251 let delim_span = DelimSpan::from_single(sp);
252 let body = TokenTree::Delimited(
256 TokenTree::token(token::Ident(sym::doc, false), sp),
257 TokenTree::token(token::Eq, sp),
259 TokenKind::lit(token::StrRaw(num_of_hashes), Symbol::intern(&stripped), None),
265 .collect::<TokenStream>(),
268 self.stack.push(mem::replace(
270 TokenCursorFrame::new(
273 &if doc_comment_style(&name.as_str()) == AttrStyle::Inner {
274 [TokenTree::token(token::Pound, sp), TokenTree::token(token::Not, sp), body]
277 .collect::<TokenStream>()
279 [TokenTree::token(token::Pound, sp), body]
282 .collect::<TokenStream>()
291 #[derive(Clone, PartialEq)]
304 fn to_string(&self) -> String {
306 TokenType::Token(ref t) => format!("`{}`", pprust::token_kind_to_string(t)),
307 TokenType::Keyword(kw) => format!("`{}`", kw),
308 TokenType::Operator => "an operator".to_string(),
309 TokenType::Lifetime => "lifetime".to_string(),
310 TokenType::Ident => "identifier".to_string(),
311 TokenType::Path => "path".to_string(),
312 TokenType::Type => "type".to_string(),
313 TokenType::Const => "const".to_string(),
318 #[derive(Copy, Clone, Debug)]
319 enum TokenExpectType {
324 /// A sequence separator.
326 /// The separator token.
327 sep: Option<TokenKind>,
328 /// `true` if a trailing separator is allowed.
329 trailing_sep_allowed: bool,
333 fn trailing_allowed(t: TokenKind) -> SeqSep {
334 SeqSep { sep: Some(t), trailing_sep_allowed: true }
337 fn none() -> SeqSep {
338 SeqSep { sep: None, trailing_sep_allowed: false }
342 pub enum FollowedByType {
347 fn token_descr_opt(token: &Token) -> Option<&'static str> {
348 Some(match token.kind {
349 _ if token.is_special_ident() => "reserved identifier",
350 _ if token.is_used_keyword() => "keyword",
351 _ if token.is_unused_keyword() => "reserved keyword",
352 token::DocComment(..) => "doc comment",
357 pub(super) fn token_descr(token: &Token) -> String {
358 let token_str = pprust::token_to_string(token);
359 match token_descr_opt(token) {
360 Some(prefix) => format!("{} `{}`", prefix, token_str),
361 _ => format!("`{}`", token_str),
365 impl<'a> Parser<'a> {
369 directory: Option<Directory>,
370 recurse_into_file_modules: bool,
371 desugar_doc_comments: bool,
372 subparser_name: Option<&'static str>,
374 let mut parser = Parser {
376 token: Token::dummy(),
377 normalized_token: Token::dummy(),
378 prev_token: Token::dummy(),
379 normalized_prev_token: Token::dummy(),
380 restrictions: Restrictions::empty(),
381 recurse_into_file_modules,
382 directory: Directory {
383 path: PathBuf::new(),
384 ownership: DirectoryOwnership::Owned { relative: None },
386 root_module_name: None,
387 expected_tokens: Vec::new(),
388 token_cursor: TokenCursor {
389 frame: TokenCursorFrame::new(DelimSpan::dummy(), token::NoDelim, &tokens),
392 desugar_doc_comments,
394 unmatched_angle_bracket_count: 0,
395 max_angle_bracket_count: 0,
396 unclosed_delims: Vec::new(),
397 last_unexpected_token_span: None,
398 last_type_ascription: None,
402 // Make parser point to the first token.
405 if let Some(directory) = directory {
406 parser.directory = directory;
407 } else if !parser.token.span.is_dummy() {
408 if let Some(FileName::Real(path)) =
409 &sess.source_map().lookup_char_pos(parser.token.span.lo()).file.unmapped_path
411 if let Some(directory_path) = path.parent() {
412 parser.directory.path = directory_path.to_path_buf();
420 fn next_tok(&mut self, fallback_span: Span) -> Token {
421 let mut next = if self.desugar_doc_comments {
422 self.token_cursor.next_desugared()
424 self.token_cursor.next()
426 if next.span.is_dummy() {
427 // Tweak the location for better diagnostics, but keep syntactic context intact.
428 next.span = fallback_span.with_ctxt(next.span.ctxt());
433 crate fn unexpected<T>(&mut self) -> PResult<'a, T> {
434 match self.expect_one_of(&[], &[]) {
436 // We can get `Ok(true)` from `recover_closing_delimiter`
437 // which is called in `expected_one_of_not_found`.
438 Ok(_) => FatalError.raise(),
442 /// Expects and consumes the token `t`. Signals an error if the next token is not `t`.
443 pub fn expect(&mut self, t: &TokenKind) -> PResult<'a, bool /* recovered */> {
444 if self.expected_tokens.is_empty() {
445 if self.token == *t {
449 self.unexpected_try_recover(t)
452 self.expect_one_of(slice::from_ref(t), &[])
456 /// Expect next token to be edible or inedible token. If edible,
457 /// then consume it; if inedible, then return without consuming
458 /// anything. Signal a fatal error if next token is unexpected.
459 pub fn expect_one_of(
461 edible: &[TokenKind],
462 inedible: &[TokenKind],
463 ) -> PResult<'a, bool /* recovered */> {
464 if edible.contains(&self.token.kind) {
467 } else if inedible.contains(&self.token.kind) {
468 // leave it in the input
470 } else if self.last_unexpected_token_span == Some(self.token.span) {
473 self.expected_one_of_not_found(edible, inedible)
477 // Public for rustfmt usage.
478 pub fn parse_ident(&mut self) -> PResult<'a, ast::Ident> {
479 self.parse_ident_common(true)
482 fn parse_ident_common(&mut self, recover: bool) -> PResult<'a, ast::Ident> {
483 match self.normalized_token.kind {
484 token::Ident(name, _) => {
485 if self.token.is_reserved_ident() {
486 let mut err = self.expected_ident_found();
494 Ok(Ident::new(name, self.normalized_prev_token.span))
496 _ => Err(match self.prev_token.kind {
497 TokenKind::DocComment(..) => {
498 self.span_fatal_err(self.prev_token.span, Error::UselessDocComment)
500 _ => self.expected_ident_found(),
505 /// Checks if the next token is `tok`, and returns `true` if so.
507 /// This method will automatically add `tok` to `expected_tokens` if `tok` is not
509 fn check(&mut self, tok: &TokenKind) -> bool {
510 let is_present = self.token == *tok;
512 self.expected_tokens.push(TokenType::Token(tok.clone()));
517 /// Consumes a token 'tok' if it exists. Returns whether the given token was present.
518 pub fn eat(&mut self, tok: &TokenKind) -> bool {
519 let is_present = self.check(tok);
526 /// If the next token is the given keyword, returns `true` without eating it.
527 /// An expectation is also added for diagnostics purposes.
528 fn check_keyword(&mut self, kw: Symbol) -> bool {
529 self.expected_tokens.push(TokenType::Keyword(kw));
530 self.token.is_keyword(kw)
533 /// If the next token is the given keyword, eats it and returns `true`.
534 /// Otherwise, returns `false`. An expectation is also added for diagnostics purposes.
535 // Public for rustfmt usage.
536 pub fn eat_keyword(&mut self, kw: Symbol) -> bool {
537 if self.check_keyword(kw) {
545 fn eat_keyword_noexpect(&mut self, kw: Symbol) -> bool {
546 if self.token.is_keyword(kw) {
554 /// If the given word is not a keyword, signals an error.
555 /// If the next token is not the given word, signals an error.
556 /// Otherwise, eats it.
557 fn expect_keyword(&mut self, kw: Symbol) -> PResult<'a, ()> {
558 if !self.eat_keyword(kw) { self.unexpected() } else { Ok(()) }
561 /// Is the given keyword `kw` followed by a non-reserved identifier?
562 fn is_kw_followed_by_ident(&self, kw: Symbol) -> bool {
563 self.token.is_keyword(kw) && self.look_ahead(1, |t| t.is_ident() && !t.is_reserved_ident())
566 fn check_or_expected(&mut self, ok: bool, typ: TokenType) -> bool {
570 self.expected_tokens.push(typ);
575 fn check_ident(&mut self) -> bool {
576 self.check_or_expected(self.token.is_ident(), TokenType::Ident)
579 fn check_path(&mut self) -> bool {
580 self.check_or_expected(self.token.is_path_start(), TokenType::Path)
583 fn check_type(&mut self) -> bool {
584 self.check_or_expected(self.token.can_begin_type(), TokenType::Type)
587 fn check_const_arg(&mut self) -> bool {
588 self.check_or_expected(self.token.can_begin_const_arg(), TokenType::Const)
591 /// Checks to see if the next token is either `+` or `+=`.
592 /// Otherwise returns `false`.
593 fn check_plus(&mut self) -> bool {
594 self.check_or_expected(
595 self.token.is_like_plus(),
596 TokenType::Token(token::BinOp(token::Plus)),
600 /// Eats the expected token if it's present possibly breaking
601 /// compound tokens like multi-character operators in process.
602 /// Returns `true` if the token was eaten.
603 fn break_and_eat(&mut self, expected: TokenKind) -> bool {
604 if self.token.kind == expected {
608 match self.token.kind.break_two_token_op() {
609 Some((first, second)) if first == expected => {
610 let first_span = self.sess.source_map().start_point(self.token.span);
611 let second_span = self.token.span.with_lo(first_span.hi());
612 self.set_token(Token::new(first, first_span));
613 self.bump_with(Token::new(second, second_span));
617 self.expected_tokens.push(TokenType::Token(expected));
623 /// Eats `+` possibly breaking tokens like `+=` in process.
624 fn eat_plus(&mut self) -> bool {
625 self.break_and_eat(token::BinOp(token::Plus))
628 /// Eats `&` possibly breaking tokens like `&&` in process.
629 /// Signals an error if `&` is not eaten.
630 fn expect_and(&mut self) -> PResult<'a, ()> {
631 if self.break_and_eat(token::BinOp(token::And)) { Ok(()) } else { self.unexpected() }
634 /// Eats `|` possibly breaking tokens like `||` in process.
635 /// Signals an error if `|` was not eaten.
636 fn expect_or(&mut self) -> PResult<'a, ()> {
637 if self.break_and_eat(token::BinOp(token::Or)) { Ok(()) } else { self.unexpected() }
640 /// Eats `<` possibly breaking tokens like `<<` in process.
641 fn eat_lt(&mut self) -> bool {
642 let ate = self.break_and_eat(token::Lt);
644 // See doc comment for `unmatched_angle_bracket_count`.
645 self.unmatched_angle_bracket_count += 1;
646 self.max_angle_bracket_count += 1;
647 debug!("eat_lt: (increment) count={:?}", self.unmatched_angle_bracket_count);
652 /// Eats `<` possibly breaking tokens like `<<` in process.
653 /// Signals an error if `<` was not eaten.
654 fn expect_lt(&mut self) -> PResult<'a, ()> {
655 if self.eat_lt() { Ok(()) } else { self.unexpected() }
658 /// Eats `>` possibly breaking tokens like `>>` in process.
659 /// Signals an error if `>` was not eaten.
660 fn expect_gt(&mut self) -> PResult<'a, ()> {
661 if self.break_and_eat(token::Gt) {
662 // See doc comment for `unmatched_angle_bracket_count`.
663 if self.unmatched_angle_bracket_count > 0 {
664 self.unmatched_angle_bracket_count -= 1;
665 debug!("expect_gt: (decrement) count={:?}", self.unmatched_angle_bracket_count);
673 fn expect_any_with_type(&mut self, kets: &[&TokenKind], expect: TokenExpectType) -> bool {
674 kets.iter().any(|k| match expect {
675 TokenExpectType::Expect => self.check(k),
676 TokenExpectType::NoExpect => self.token == **k,
680 fn parse_seq_to_before_tokens<T>(
684 expect: TokenExpectType,
685 mut f: impl FnMut(&mut Parser<'a>) -> PResult<'a, T>,
686 ) -> PResult<'a, (Vec<T>, bool /* trailing */, bool /* recovered */)> {
687 let mut first = true;
688 let mut recovered = false;
689 let mut trailing = false;
691 while !self.expect_any_with_type(kets, expect) {
692 if let token::CloseDelim(..) | token::Eof = self.token.kind {
695 if let Some(ref t) = sep.sep {
699 match self.expect(t) {
705 Err(mut expect_err) => {
706 let sp = self.prev_token.span.shrink_to_hi();
707 let token_str = pprust::token_kind_to_string(t);
709 // Attempt to keep parsing if it was a similar separator.
710 if let Some(ref tokens) = t.similar_tokens() {
711 if tokens.contains(&self.token.kind) {
716 // Attempt to keep parsing if it was an omitted separator.
719 // Parsed successfully, therefore most probably the code only
720 // misses a separator.
722 .span_suggestion_short(
724 &format!("missing `{}`", token_str),
726 Applicability::MaybeIncorrect,
734 // Parsing failed, therefore it must be something more serious
735 // than just a missing separator.
746 if sep.trailing_sep_allowed && self.expect_any_with_type(kets, expect) {
755 Ok((v, trailing, recovered))
758 /// Parses a sequence, not including the closing delimiter. The function
759 /// `f` must consume tokens until reaching the next separator or
761 fn parse_seq_to_before_end<T>(
765 f: impl FnMut(&mut Parser<'a>) -> PResult<'a, T>,
766 ) -> PResult<'a, (Vec<T>, bool, bool)> {
767 self.parse_seq_to_before_tokens(&[ket], sep, TokenExpectType::Expect, f)
770 /// Parses a sequence, including the closing delimiter. The function
771 /// `f` must consume tokens until reaching the next separator or
773 fn parse_seq_to_end<T>(
777 f: impl FnMut(&mut Parser<'a>) -> PResult<'a, T>,
778 ) -> PResult<'a, (Vec<T>, bool /* trailing */)> {
779 let (val, trailing, recovered) = self.parse_seq_to_before_end(ket, sep, f)?;
786 /// Parses a sequence, including the closing delimiter. The function
787 /// `f` must consume tokens until reaching the next separator or
789 fn parse_unspanned_seq<T>(
794 f: impl FnMut(&mut Parser<'a>) -> PResult<'a, T>,
795 ) -> PResult<'a, (Vec<T>, bool)> {
797 self.parse_seq_to_end(ket, sep, f)
800 fn parse_delim_comma_seq<T>(
803 f: impl FnMut(&mut Parser<'a>) -> PResult<'a, T>,
804 ) -> PResult<'a, (Vec<T>, bool)> {
805 self.parse_unspanned_seq(
806 &token::OpenDelim(delim),
807 &token::CloseDelim(delim),
808 SeqSep::trailing_allowed(token::Comma),
813 fn parse_paren_comma_seq<T>(
815 f: impl FnMut(&mut Parser<'a>) -> PResult<'a, T>,
816 ) -> PResult<'a, (Vec<T>, bool)> {
817 self.parse_delim_comma_seq(token::Paren, f)
820 // Interpolated identifier (`$i: ident`) and lifetime (`$l: lifetime`)
821 // tokens are replaced with usual identifier and lifetime tokens,
822 // so the former are never encountered during normal parsing.
823 crate fn set_token(&mut self, token: Token) {
825 self.normalized_token = match &self.token.kind {
826 token::Interpolated(nt) => match **nt {
827 token::NtIdent(ident, is_raw) => {
828 Token::new(token::Ident(ident.name, is_raw), ident.span)
830 token::NtLifetime(ident) => Token::new(token::Lifetime(ident.name), ident.span),
831 _ => self.token.clone(),
833 _ => self.token.clone(),
837 /// Advance the parser by one token using provided token as the next one.
838 fn bump_with(&mut self, next_token: Token) {
839 // Bumping after EOF is a bad sign, usually an infinite loop.
840 if self.prev_token.kind == TokenKind::Eof {
841 let msg = "attempted to bump the parser past EOF (may be stuck in a loop)";
842 self.span_bug(self.token.span, msg);
845 // Update the current and previous tokens.
846 self.prev_token = self.token.take();
847 self.normalized_prev_token = self.normalized_token.take();
848 self.set_token(next_token);
851 self.expected_tokens.clear();
854 /// Advance the parser by one token.
855 pub fn bump(&mut self) {
856 let next_token = self.next_tok(self.token.span);
857 self.bump_with(next_token);
860 /// Look-ahead `dist` tokens of `self.token` and get access to that token there.
861 /// When `dist == 0` then the current token is looked at.
862 pub fn look_ahead<R>(&self, dist: usize, looker: impl FnOnce(&Token) -> R) -> R {
864 return looker(&self.token);
867 let frame = &self.token_cursor.frame;
868 looker(&match frame.tree_cursor.look_ahead(dist - 1) {
869 Some(tree) => match tree {
870 TokenTree::Token(token) => token,
871 TokenTree::Delimited(dspan, delim, _) => {
872 Token::new(token::OpenDelim(delim), dspan.open)
875 None => Token::new(token::CloseDelim(frame.delim), frame.span.close),
879 /// Returns whether any of the given keywords are `dist` tokens ahead of the current one.
880 fn is_keyword_ahead(&self, dist: usize, kws: &[Symbol]) -> bool {
881 self.look_ahead(dist, |t| kws.iter().any(|&kw| t.is_keyword(kw)))
884 /// Parses asyncness: `async` or nothing.
885 fn parse_asyncness(&mut self) -> Async {
886 if self.eat_keyword(kw::Async) {
887 let span = self.normalized_prev_token.span;
888 Async::Yes { span, closure_id: DUMMY_NODE_ID, return_impl_trait_id: DUMMY_NODE_ID }
894 /// Parses unsafety: `unsafe` or nothing.
895 fn parse_unsafety(&mut self) -> Unsafe {
896 if self.eat_keyword(kw::Unsafe) {
897 Unsafe::Yes(self.normalized_prev_token.span)
903 /// Parses constness: `const` or nothing.
904 fn parse_constness(&mut self) -> Const {
905 if self.eat_keyword(kw::Const) {
906 Const::Yes(self.normalized_prev_token.span)
912 /// Parses mutability (`mut` or nothing).
913 fn parse_mutability(&mut self) -> Mutability {
914 if self.eat_keyword(kw::Mut) { Mutability::Mut } else { Mutability::Not }
917 /// Possibly parses mutability (`const` or `mut`).
918 fn parse_const_or_mut(&mut self) -> Option<Mutability> {
919 if self.eat_keyword(kw::Mut) {
920 Some(Mutability::Mut)
921 } else if self.eat_keyword(kw::Const) {
922 Some(Mutability::Not)
928 fn parse_field_name(&mut self) -> PResult<'a, Ident> {
929 if let token::Literal(token::Lit { kind: token::Integer, symbol, suffix }) = self.token.kind
931 self.expect_no_suffix(self.token.span, "a tuple index", suffix);
933 Ok(Ident::new(symbol, self.prev_token.span))
935 self.parse_ident_common(false)
939 fn parse_mac_args(&mut self) -> PResult<'a, P<MacArgs>> {
940 self.parse_mac_args_common(true).map(P)
943 fn parse_attr_args(&mut self) -> PResult<'a, MacArgs> {
944 self.parse_mac_args_common(false)
947 fn parse_mac_args_common(&mut self, delimited_only: bool) -> PResult<'a, MacArgs> {
949 if self.check(&token::OpenDelim(DelimToken::Paren))
950 || self.check(&token::OpenDelim(DelimToken::Bracket))
951 || self.check(&token::OpenDelim(DelimToken::Brace))
953 match self.parse_token_tree() {
954 TokenTree::Delimited(dspan, delim, tokens) =>
955 // We've confirmed above that there is a delimiter so unwrapping is OK.
957 MacArgs::Delimited(dspan, MacDelimiter::from_token(delim).unwrap(), tokens)
961 } else if !delimited_only {
962 if self.eat(&token::Eq) {
963 let eq_span = self.prev_token.span;
964 let mut is_interpolated_expr = false;
965 if let token::Interpolated(nt) = &self.token.kind {
966 if let token::NtExpr(..) = **nt {
967 is_interpolated_expr = true;
970 let token_tree = if is_interpolated_expr {
971 // We need to accept arbitrary interpolated expressions to continue
972 // supporting things like `doc = $expr` that work on stable.
973 // Non-literal interpolated expressions are rejected after expansion.
974 self.parse_token_tree()
976 self.parse_unsuffixed_lit()?.token_tree()
979 MacArgs::Eq(eq_span, token_tree.into())
984 return self.unexpected();
989 fn parse_or_use_outer_attributes(
991 already_parsed_attrs: Option<AttrVec>,
992 ) -> PResult<'a, AttrVec> {
993 if let Some(attrs) = already_parsed_attrs {
996 self.parse_outer_attributes().map(|a| a.into())
1000 /// Parses a single token tree from the input.
1001 pub fn parse_token_tree(&mut self) -> TokenTree {
1002 match self.token.kind {
1003 token::OpenDelim(..) => {
1004 let frame = mem::replace(
1005 &mut self.token_cursor.frame,
1006 self.token_cursor.stack.pop().unwrap(),
1008 self.set_token(Token::new(TokenKind::CloseDelim(frame.delim), frame.span.close));
1010 TokenTree::Delimited(frame.span, frame.delim, frame.tree_cursor.stream)
1012 token::CloseDelim(_) | token::Eof => unreachable!(),
1015 TokenTree::Token(self.prev_token.clone())
1020 /// Parses a stream of tokens into a list of `TokenTree`s, up to EOF.
1021 pub fn parse_all_token_trees(&mut self) -> PResult<'a, Vec<TokenTree>> {
1022 let mut tts = Vec::new();
1023 while self.token != token::Eof {
1024 tts.push(self.parse_token_tree());
1029 pub fn parse_tokens(&mut self) -> TokenStream {
1030 let mut result = Vec::new();
1032 match self.token.kind {
1033 token::Eof | token::CloseDelim(..) => break,
1034 _ => result.push(self.parse_token_tree().into()),
1037 TokenStream::new(result)
1040 /// Evaluates the closure with restrictions in place.
1042 /// Afters the closure is evaluated, restrictions are reset.
1043 fn with_res<T>(&mut self, res: Restrictions, f: impl FnOnce(&mut Self) -> T) -> T {
1044 let old = self.restrictions;
1045 self.restrictions = res;
1047 self.restrictions = old;
1051 fn is_crate_vis(&self) -> bool {
1052 self.token.is_keyword(kw::Crate) && self.look_ahead(1, |t| t != &token::ModSep)
1055 /// Parses `pub`, `pub(crate)` and `pub(in path)` plus shortcuts `crate` for `pub(crate)`,
1056 /// `pub(self)` for `pub(in self)` and `pub(super)` for `pub(in super)`.
1057 /// If the following element can't be a tuple (i.e., it's a function definition), then
1058 /// it's not a tuple struct field), and the contents within the parentheses isn't valid,
1059 /// so emit a proper diagnostic.
1060 pub fn parse_visibility(&mut self, fbt: FollowedByType) -> PResult<'a, Visibility> {
1061 maybe_whole!(self, NtVis, |x| x);
1063 self.expected_tokens.push(TokenType::Keyword(kw::Crate));
1064 if self.is_crate_vis() {
1065 self.bump(); // `crate`
1066 self.sess.gated_spans.gate(sym::crate_visibility_modifier, self.prev_token.span);
1067 return Ok(respan(self.prev_token.span, VisibilityKind::Crate(CrateSugar::JustCrate)));
1070 if !self.eat_keyword(kw::Pub) {
1071 // We need a span for our `Spanned<VisibilityKind>`, but there's inherently no
1072 // keyword to grab a span from for inherited visibility; an empty span at the
1073 // beginning of the current token would seem to be the "Schelling span".
1074 return Ok(respan(self.token.span.shrink_to_lo(), VisibilityKind::Inherited));
1076 let lo = self.prev_token.span;
1078 if self.check(&token::OpenDelim(token::Paren)) {
1079 // We don't `self.bump()` the `(` yet because this might be a struct definition where
1080 // `()` or a tuple might be allowed. For example, `struct Struct(pub (), pub (usize));`.
1081 // Because of this, we only `bump` the `(` if we're assured it is appropriate to do so
1082 // by the following tokens.
1083 if self.is_keyword_ahead(1, &[kw::Crate]) && self.look_ahead(2, |t| t != &token::ModSep)
1084 // account for `pub(crate::foo)`
1086 // Parse `pub(crate)`.
1088 self.bump(); // `crate`
1089 self.expect(&token::CloseDelim(token::Paren))?; // `)`
1090 let vis = VisibilityKind::Crate(CrateSugar::PubCrate);
1091 return Ok(respan(lo.to(self.prev_token.span), vis));
1092 } else if self.is_keyword_ahead(1, &[kw::In]) {
1093 // Parse `pub(in path)`.
1095 self.bump(); // `in`
1096 let path = self.parse_path(PathStyle::Mod)?; // `path`
1097 self.expect(&token::CloseDelim(token::Paren))?; // `)`
1098 let vis = VisibilityKind::Restricted { path: P(path), id: ast::DUMMY_NODE_ID };
1099 return Ok(respan(lo.to(self.prev_token.span), vis));
1100 } else if self.look_ahead(2, |t| t == &token::CloseDelim(token::Paren))
1101 && self.is_keyword_ahead(1, &[kw::Super, kw::SelfLower])
1103 // Parse `pub(self)` or `pub(super)`.
1105 let path = self.parse_path(PathStyle::Mod)?; // `super`/`self`
1106 self.expect(&token::CloseDelim(token::Paren))?; // `)`
1107 let vis = VisibilityKind::Restricted { path: P(path), id: ast::DUMMY_NODE_ID };
1108 return Ok(respan(lo.to(self.prev_token.span), vis));
1109 } else if let FollowedByType::No = fbt {
1110 // Provide this diagnostic if a type cannot follow;
1111 // in particular, if this is not a tuple struct.
1112 self.recover_incorrect_vis_restriction()?;
1113 // Emit diagnostic, but continue with public visibility.
1117 Ok(respan(lo, VisibilityKind::Public))
1120 /// Recovery for e.g. `pub(something) fn ...` or `struct X { pub(something) y: Z }`
1121 fn recover_incorrect_vis_restriction(&mut self) -> PResult<'a, ()> {
1123 let path = self.parse_path(PathStyle::Mod)?;
1124 self.expect(&token::CloseDelim(token::Paren))?; // `)`
1126 let msg = "incorrect visibility restriction";
1127 let suggestion = r##"some possible visibility restrictions are:
1128 `pub(crate)`: visible only on the current crate
1129 `pub(super)`: visible only in the current module's parent
1130 `pub(in path::to::module)`: visible only on the specified path"##;
1132 let path_str = pprust::path_to_string(&path);
1134 struct_span_err!(self.sess.span_diagnostic, path.span, E0704, "{}", msg)
1138 &format!("make this visible only to module `{}` with `in`", path_str),
1139 format!("in {}", path_str),
1140 Applicability::MachineApplicable,
1147 /// Parses `extern string_literal?`.
1148 fn parse_extern(&mut self) -> PResult<'a, Extern> {
1149 Ok(if self.eat_keyword(kw::Extern) {
1150 Extern::from_abi(self.parse_abi())
1156 /// Parses a string literal as an ABI spec.
1157 fn parse_abi(&mut self) -> Option<StrLit> {
1158 match self.parse_str_lit() {
1159 Ok(str_lit) => Some(str_lit),
1160 Err(Some(lit)) => match lit.kind {
1161 ast::LitKind::Err(_) => None,
1163 self.struct_span_err(lit.span, "non-string ABI literal")
1166 "specify the ABI with a string literal",
1167 "\"C\"".to_string(),
1168 Applicability::MaybeIncorrect,
1178 fn collect_tokens<R>(
1180 f: impl FnOnce(&mut Self) -> PResult<'a, R>,
1181 ) -> PResult<'a, (R, TokenStream)> {
1182 // Record all tokens we parse when parsing this item.
1183 let mut tokens = Vec::new();
1184 let prev_collecting = match self.token_cursor.frame.last_token {
1185 LastToken::Collecting(ref mut list) => Some(mem::take(list)),
1186 LastToken::Was(ref mut last) => {
1187 tokens.extend(last.take());
1191 self.token_cursor.frame.last_token = LastToken::Collecting(tokens);
1192 let prev = self.token_cursor.stack.len();
1194 let last_token = if self.token_cursor.stack.len() == prev {
1195 &mut self.token_cursor.frame.last_token
1196 } else if self.token_cursor.stack.get(prev).is_none() {
1197 // This can happen due to a bad interaction of two unrelated recovery mechanisms with
1198 // mismatched delimiters *and* recovery lookahead on the likely typo `pub ident(`
1200 return Ok((ret?, TokenStream::default()));
1202 &mut self.token_cursor.stack[prev].last_token
1205 // Pull out the tokens that we've collected from the call to `f` above.
1206 let mut collected_tokens = match *last_token {
1207 LastToken::Collecting(ref mut v) => mem::take(v),
1208 LastToken::Was(ref was) => {
1209 let msg = format!("our vector went away? - found Was({:?})", was);
1210 debug!("collect_tokens: {}", msg);
1211 self.sess.span_diagnostic.delay_span_bug(self.token.span, &msg);
1212 // This can happen due to a bad interaction of two unrelated recovery mechanisms
1213 // with mismatched delimiters *and* recovery lookahead on the likely typo
1214 // `pub ident(` (#62895, different but similar to the case above).
1215 return Ok((ret?, TokenStream::default()));
1219 // If we're not at EOF our current token wasn't actually consumed by
1220 // `f`, but it'll still be in our list that we pulled out. In that case
1222 let extra_token = if self.token != token::Eof { collected_tokens.pop() } else { None };
1224 // If we were previously collecting tokens, then this was a recursive
1225 // call. In that case we need to record all the tokens we collected in
1226 // our parent list as well. To do that we push a clone of our stream
1227 // onto the previous list.
1228 match prev_collecting {
1230 list.extend(collected_tokens.iter().cloned());
1231 list.extend(extra_token);
1232 *last_token = LastToken::Collecting(list);
1235 *last_token = LastToken::Was(extra_token);
1239 Ok((ret?, TokenStream::new(collected_tokens)))
1243 fn is_import_coupler(&mut self) -> bool {
1244 self.check(&token::ModSep)
1245 && self.look_ahead(1, |t| {
1246 *t == token::OpenDelim(token::Brace) || *t == token::BinOp(token::Star)
1251 crate fn make_unclosed_delims_error(
1252 unmatched: UnmatchedBrace,
1254 ) -> Option<DiagnosticBuilder<'_>> {
1255 // `None` here means an `Eof` was found. We already emit those errors elsewhere, we add them to
1256 // `unmatched_braces` only for error recovery in the `Parser`.
1257 let found_delim = unmatched.found_delim?;
1258 let mut err = sess.span_diagnostic.struct_span_err(
1259 unmatched.found_span,
1261 "mismatched closing delimiter: `{}`",
1262 pprust::token_kind_to_string(&token::CloseDelim(found_delim)),
1265 err.span_label(unmatched.found_span, "mismatched closing delimiter");
1266 if let Some(sp) = unmatched.candidate_span {
1267 err.span_label(sp, "closing delimiter possibly meant for this");
1269 if let Some(sp) = unmatched.unclosed_span {
1270 err.span_label(sp, "unclosed delimiter");
1275 pub fn emit_unclosed_delims(unclosed_delims: &mut Vec<UnmatchedBrace>, sess: &ParseSess) {
1276 *sess.reached_eof.borrow_mut() |=
1277 unclosed_delims.iter().any(|unmatched_delim| unmatched_delim.found_delim.is_none());
1278 for unmatched in unclosed_delims.drain(..) {
1279 make_unclosed_delims_error(unmatched, sess).map(|mut e| {