compiler/rustc_parse/src/lib.rs

   1 //! The main parser interface.
   2
   3 #![feature(array_windows)]
   4 #![feature(crate_visibility_modifier)]
   5 #![feature(bindings_after_at)]
   6 #![feature(iter_order_by)]
   7 #![feature(box_syntax)]
   8 #![feature(box_patterns)]
   9 #![recursion_limit = "256"]
  10
  11 use rustc_ast as ast;
  12 use rustc_ast::token::{self, Nonterminal, Token, TokenKind};
  13 use rustc_ast::tokenstream::{self, AttributesData, CanSynthesizeMissingTokens, LazyTokenStream};
  14 use rustc_ast::tokenstream::{AttrAnnotatedTokenStream, AttrAnnotatedTokenTree};
  15 use rustc_ast::tokenstream::{Spacing, TokenStream};
  16 use rustc_ast::AstLike;
  17 use rustc_ast::Attribute;
  18 use rustc_ast_pretty::pprust;
  19 use rustc_data_structures::sync::Lrc;
  20 use rustc_errors::{Diagnostic, FatalError, Level, PResult};
  21 use rustc_session::parse::ParseSess;
  22 use rustc_span::{FileName, SourceFile, Span};
  23
  24 use std::path::Path;
  25 use std::str;
  26
  27 pub const MACRO_ARGUMENTS: Option<&str> = Some("macro arguments");
  28
  29 #[macro_use]
  30 pub mod parser;
  31 use parser::{emit_unclosed_delims, make_unclosed_delims_error, Parser};
  32 pub mod lexer;
  33 pub mod validate_attr;
  34
  35 // A bunch of utility functions of the form `parse_<thing>_from_<source>`
  36 // where <thing> includes crate, expr, item, stmt, tts, and one that
  37 // uses a HOF to parse anything, and <source> includes file and
  38 // `source_str`.
  39
  40 /// A variant of 'panictry!' that works on a Vec<Diagnostic> instead of a single DiagnosticBuilder.
  41 macro_rules! panictry_buffer {
  42     ($handler:expr, $e:expr) => {{
  43         use rustc_errors::FatalError;
  44         use std::result::Result::{Err, Ok};
  45         match $e {
  46             Ok(e) => e,
  47             Err(errs) => {
  48                 for e in errs {
  49                     $handler.emit_diagnostic(&e);
  50                 }
  51                 FatalError.raise()
  52             }
  53         }
  54     }};
  55 }
  56
  57 pub fn parse_crate_from_file<'a>(input: &Path, sess: &'a ParseSess) -> PResult<'a, ast::Crate> {
  58     let mut parser = new_parser_from_file(sess, input, None);
  59     parser.parse_crate_mod()
  60 }
  61
  62 pub fn parse_crate_attrs_from_file<'a>(
  63     input: &Path,
  64     sess: &'a ParseSess,
  65 ) -> PResult<'a, Vec<ast::Attribute>> {
  66     let mut parser = new_parser_from_file(sess, input, None);
  67     parser.parse_inner_attributes()
  68 }
  69
  70 pub fn parse_crate_from_source_str(
  71     name: FileName,
  72     source: String,
  73     sess: &ParseSess,
  74 ) -> PResult<'_, ast::Crate> {
  75     new_parser_from_source_str(sess, name, source).parse_crate_mod()
  76 }
  77
  78 pub fn parse_crate_attrs_from_source_str(
  79     name: FileName,
  80     source: String,
  81     sess: &ParseSess,
  82 ) -> PResult<'_, Vec<ast::Attribute>> {
  83     new_parser_from_source_str(sess, name, source).parse_inner_attributes()
  84 }
  85
  86 pub fn parse_stream_from_source_str(
  87     name: FileName,
  88     source: String,
  89     sess: &ParseSess,
  90     override_span: Option<Span>,
  91 ) -> TokenStream {
  92     let (stream, mut errors) =
  93         source_file_to_stream(sess, sess.source_map().new_source_file(name, source), override_span);
  94     emit_unclosed_delims(&mut errors, &sess);
  95     stream
  96 }
  97
  98 /// Creates a new parser from a source string.
  99 pub fn new_parser_from_source_str(sess: &ParseSess, name: FileName, source: String) -> Parser<'_> {
 100     panictry_buffer!(&sess.span_diagnostic, maybe_new_parser_from_source_str(sess, name, source))
 101 }
 102
 103 /// Creates a new parser from a source string. Returns any buffered errors from lexing the initial
 104 /// token stream.
 105 pub fn maybe_new_parser_from_source_str(
 106     sess: &ParseSess,
 107     name: FileName,
 108     source: String,
 109 ) -> Result<Parser<'_>, Vec<Diagnostic>> {
 110     maybe_source_file_to_parser(sess, sess.source_map().new_source_file(name, source))
 111 }
 112
 113 /// Creates a new parser, handling errors as appropriate if the file doesn't exist.
 114 /// If a span is given, that is used on an error as the source of the problem.
 115 pub fn new_parser_from_file<'a>(sess: &'a ParseSess, path: &Path, sp: Option<Span>) -> Parser<'a> {
 116     source_file_to_parser(sess, file_to_source_file(sess, path, sp))
 117 }
 118
 119 /// Given a `source_file` and config, returns a parser.
 120 fn source_file_to_parser(sess: &ParseSess, source_file: Lrc<SourceFile>) -> Parser<'_> {
 121     panictry_buffer!(&sess.span_diagnostic, maybe_source_file_to_parser(sess, source_file))
 122 }
 123
 124 /// Given a `source_file` and config, return a parser. Returns any buffered errors from lexing the
 125 /// initial token stream.
 126 fn maybe_source_file_to_parser(
 127     sess: &ParseSess,
 128     source_file: Lrc<SourceFile>,
 129 ) -> Result<Parser<'_>, Vec<Diagnostic>> {
 130     let end_pos = source_file.end_pos;
 131     let (stream, unclosed_delims) = maybe_file_to_stream(sess, source_file, None)?;
 132     let mut parser = stream_to_parser(sess, stream, None);
 133     parser.unclosed_delims = unclosed_delims;
 134     if parser.token == token::Eof {
 135         parser.token.span = Span::new(end_pos, end_pos, parser.token.span.ctxt());
 136     }
 137
 138     Ok(parser)
 139 }
 140
 141 // Base abstractions
 142
 143 /// Given a session and a path and an optional span (for error reporting),
 144 /// add the path to the session's source_map and return the new source_file or
 145 /// error when a file can't be read.
 146 fn try_file_to_source_file(
 147     sess: &ParseSess,
 148     path: &Path,
 149     spanopt: Option<Span>,
 150 ) -> Result<Lrc<SourceFile>, Diagnostic> {
 151     sess.source_map().load_file(path).map_err(|e| {
 152         let msg = format!("couldn't read {}: {}", path.display(), e);
 153         let mut diag = Diagnostic::new(Level::Fatal, &msg);
 154         if let Some(sp) = spanopt {
 155             diag.set_span(sp);
 156         }
 157         diag
 158     })
 159 }
 160
 161 /// Given a session and a path and an optional span (for error reporting),
 162 /// adds the path to the session's `source_map` and returns the new `source_file`.
 163 fn file_to_source_file(sess: &ParseSess, path: &Path, spanopt: Option<Span>) -> Lrc<SourceFile> {
 164     match try_file_to_source_file(sess, path, spanopt) {
 165         Ok(source_file) => source_file,
 166         Err(d) => {
 167             sess.span_diagnostic.emit_diagnostic(&d);
 168             FatalError.raise();
 169         }
 170     }
 171 }
 172
 173 /// Given a `source_file`, produces a sequence of token trees.
 174 pub fn source_file_to_stream(
 175     sess: &ParseSess,
 176     source_file: Lrc<SourceFile>,
 177     override_span: Option<Span>,
 178 ) -> (TokenStream, Vec<lexer::UnmatchedBrace>) {
 179     panictry_buffer!(&sess.span_diagnostic, maybe_file_to_stream(sess, source_file, override_span))
 180 }
 181
 182 /// Given a source file, produces a sequence of token trees. Returns any buffered errors from
 183 /// parsing the token stream.
 184 pub fn maybe_file_to_stream(
 185     sess: &ParseSess,
 186     source_file: Lrc<SourceFile>,
 187     override_span: Option<Span>,
 188 ) -> Result<(TokenStream, Vec<lexer::UnmatchedBrace>), Vec<Diagnostic>> {
 189     let src = source_file.src.as_ref().unwrap_or_else(|| {
 190         sess.span_diagnostic.bug(&format!(
 191             "cannot lex `source_file` without source: {}",
 192             source_file.name.prefer_local()
 193         ));
 194     });
 195
 196     let (token_trees, unmatched_braces) =
 197         lexer::parse_token_trees(sess, src.as_str(), source_file.start_pos, override_span);
 198
 199     match token_trees {
 200         Ok(stream) => Ok((stream, unmatched_braces)),
 201         Err(err) => {
 202             let mut buffer = Vec::with_capacity(1);
 203             err.buffer(&mut buffer);
 204             // Not using `emit_unclosed_delims` to use `db.buffer`
 205             for unmatched in unmatched_braces {
 206                 if let Some(err) = make_unclosed_delims_error(unmatched, &sess) {
 207                     err.buffer(&mut buffer);
 208                 }
 209             }
 210             Err(buffer)
 211         }
 212     }
 213 }
 214
 215 /// Given a stream and the `ParseSess`, produces a parser.
 216 pub fn stream_to_parser<'a>(
 217     sess: &'a ParseSess,
 218     stream: TokenStream,
 219     subparser_name: Option<&'static str>,
 220 ) -> Parser<'a> {
 221     Parser::new(sess, stream, false, subparser_name)
 222 }
 223
 224 /// Runs the given subparser `f` on the tokens of the given `attr`'s item.
 225 pub fn parse_in<'a, T>(
 226     sess: &'a ParseSess,
 227     tts: TokenStream,
 228     name: &'static str,
 229     mut f: impl FnMut(&mut Parser<'a>) -> PResult<'a, T>,
 230 ) -> PResult<'a, T> {
 231     let mut parser = Parser::new(sess, tts, false, Some(name));
 232     let result = f(&mut parser)?;
 233     if parser.token != token::Eof {
 234         parser.unexpected()?;
 235     }
 236     Ok(result)
 237 }
 238
 239 // NOTE(Centril): The following probably shouldn't be here but it acknowledges the
 240 // fact that architecturally, we are using parsing (read on below to understand why).
 241
 242 pub fn nt_to_tokenstream(
 243     nt: &Nonterminal,
 244     sess: &ParseSess,
 245     synthesize_tokens: CanSynthesizeMissingTokens,
 246 ) -> TokenStream {
 247     // A `Nonterminal` is often a parsed AST item. At this point we now
 248     // need to convert the parsed AST to an actual token stream, e.g.
 249     // un-parse it basically.
 250     //
 251     // Unfortunately there's not really a great way to do that in a
 252     // guaranteed lossless fashion right now. The fallback here is to just
 253     // stringify the AST node and reparse it, but this loses all span
 254     // information.
 255     //
 256     // As a result, some AST nodes are annotated with the token stream they
 257     // came from. Here we attempt to extract these lossless token streams
 258     // before we fall back to the stringification.
 259
 260     let convert_tokens =
 261         |tokens: Option<&LazyTokenStream>| Some(tokens?.create_token_stream().to_tokenstream());
 262
 263     let tokens = match *nt {
 264         Nonterminal::NtItem(ref item) => prepend_attrs(&item.attrs, item.tokens.as_ref()),
 265         Nonterminal::NtBlock(ref block) => convert_tokens(block.tokens.as_ref()),
 266         Nonterminal::NtStmt(ref stmt) => {
 267             if let ast::StmtKind::Empty = stmt.kind {
 268                 let tokens = AttrAnnotatedTokenStream::new(vec![(
 269                     tokenstream::AttrAnnotatedTokenTree::Token(Token::new(
 270                         TokenKind::Semi,
 271                         stmt.span,
 272                     )),
 273                     Spacing::Alone,
 274                 )]);
 275                 prepend_attrs(&stmt.attrs(), Some(&LazyTokenStream::new(tokens)))
 276             } else {
 277                 prepend_attrs(&stmt.attrs(), stmt.tokens())
 278             }
 279         }
 280         Nonterminal::NtPat(ref pat) => convert_tokens(pat.tokens.as_ref()),
 281         Nonterminal::NtTy(ref ty) => convert_tokens(ty.tokens.as_ref()),
 282         Nonterminal::NtIdent(ident, is_raw) => {
 283             Some(tokenstream::TokenTree::token(token::Ident(ident.name, is_raw), ident.span).into())
 284         }
 285         Nonterminal::NtLifetime(ident) => {
 286             Some(tokenstream::TokenTree::token(token::Lifetime(ident.name), ident.span).into())
 287         }
 288         Nonterminal::NtMeta(ref attr) => convert_tokens(attr.tokens.as_ref()),
 289         Nonterminal::NtPath(ref path) => convert_tokens(path.tokens.as_ref()),
 290         Nonterminal::NtVis(ref vis) => convert_tokens(vis.tokens.as_ref()),
 291         Nonterminal::NtTT(ref tt) => Some(tt.clone().into()),
 292         Nonterminal::NtExpr(ref expr) | Nonterminal::NtLiteral(ref expr) => {
 293             prepend_attrs(&expr.attrs, expr.tokens.as_ref())
 294         }
 295     };
 296
 297     if let Some(tokens) = tokens {
 298         return tokens;
 299     } else if matches!(synthesize_tokens, CanSynthesizeMissingTokens::Yes) {
 300         return fake_token_stream(sess, nt);
 301     } else {
 302         panic!(
 303             "Missing tokens for nt {:?} at {:?}: {:?}",
 304             nt,
 305             nt.span(),
 306             pprust::nonterminal_to_string(nt)
 307         );
 308     }
 309 }
 310
 311 fn prepend_attrs(attrs: &[Attribute], tokens: Option<&LazyTokenStream>) -> Option<TokenStream> {
 312     let tokens = tokens?;
 313     if attrs.is_empty() {
 314         return Some(tokens.create_token_stream().to_tokenstream());
 315     }
 316     let attr_data = AttributesData { attrs: attrs.to_vec().into(), tokens: tokens.clone() };
 317     let wrapped = AttrAnnotatedTokenStream::new(vec![(
 318         AttrAnnotatedTokenTree::Attributes(attr_data),
 319         Spacing::Alone,
 320     )]);
 321     Some(wrapped.to_tokenstream())
 322 }
 323
 324 pub fn fake_token_stream(sess: &ParseSess, nt: &Nonterminal) -> TokenStream {
 325     let source = pprust::nonterminal_to_string(nt);
 326     let filename = FileName::macro_expansion_source_code(&source);
 327     parse_stream_from_source_str(filename, source, sess, Some(nt.span()))
 328 }