compiler/rustc_parse/src/lib.rs

   1 //! The main parser interface.
   2
   3 #![feature(array_windows)]
   4 #![feature(box_patterns)]
   5 #![feature(if_let_guard)]
   6 #![feature(let_chains)]
   7 #![feature(never_type)]
   8 #![feature(rustc_attrs)]
   9 #![recursion_limit = "256"]
  10
  11 #[macro_use]
  12 extern crate tracing;
  13
  14 use rustc_ast as ast;
  15 use rustc_ast::token;
  16 use rustc_ast::tokenstream::TokenStream;
  17 use rustc_ast::Attribute;
  18 use rustc_ast::{AttrItem, MetaItem};
  19 use rustc_ast_pretty::pprust;
  20 use rustc_data_structures::sync::Lrc;
  21 use rustc_errors::{Applicability, Diagnostic, FatalError, Level, PResult};
  22 use rustc_session::parse::ParseSess;
  23 use rustc_span::{FileName, SourceFile, Span};
  24
  25 use std::path::Path;
  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 mod errors;
  36
  37 // A bunch of utility functions of the form `parse_<thing>_from_<source>`
  38 // where <thing> includes crate, expr, item, stmt, tts, and one that
  39 // uses a HOF to parse anything, and <source> includes file and
  40 // `source_str`.
  41
  42 /// A variant of 'panictry!' that works on a `Vec<Diagnostic>` instead of a single
  43 /// `DiagnosticBuilder`.
  44 macro_rules! panictry_buffer {
  45     ($handler:expr, $e:expr) => {{
  46         use rustc_errors::FatalError;
  47         use std::result::Result::{Err, Ok};
  48         match $e {
  49             Ok(e) => e,
  50             Err(errs) => {
  51                 for mut e in errs {
  52                     $handler.emit_diagnostic(&mut e);
  53                 }
  54                 FatalError.raise()
  55             }
  56         }
  57     }};
  58 }
  59
  60 pub fn parse_crate_from_file<'a>(input: &Path, sess: &'a ParseSess) -> PResult<'a, ast::Crate> {
  61     let mut parser = new_parser_from_file(sess, input, None);
  62     parser.parse_crate_mod()
  63 }
  64
  65 pub fn parse_crate_attrs_from_file<'a>(
  66     input: &Path,
  67     sess: &'a ParseSess,
  68 ) -> PResult<'a, ast::AttrVec> {
  69     let mut parser = new_parser_from_file(sess, input, None);
  70     parser.parse_inner_attributes()
  71 }
  72
  73 pub fn parse_crate_from_source_str(
  74     name: FileName,
  75     source: String,
  76     sess: &ParseSess,
  77 ) -> PResult<'_, ast::Crate> {
  78     new_parser_from_source_str(sess, name, source).parse_crate_mod()
  79 }
  80
  81 pub fn parse_crate_attrs_from_source_str(
  82     name: FileName,
  83     source: String,
  84     sess: &ParseSess,
  85 ) -> PResult<'_, ast::AttrVec> {
  86     new_parser_from_source_str(sess, name, source).parse_inner_attributes()
  87 }
  88
  89 pub fn parse_stream_from_source_str(
  90     name: FileName,
  91     source: String,
  92     sess: &ParseSess,
  93     override_span: Option<Span>,
  94 ) -> TokenStream {
  95     let (stream, mut errors) =
  96         source_file_to_stream(sess, sess.source_map().new_source_file(name, source), override_span);
  97     emit_unclosed_delims(&mut errors, &sess);
  98     stream
  99 }
 100
 101 /// Creates a new parser from a source string.
 102 pub fn new_parser_from_source_str(sess: &ParseSess, name: FileName, source: String) -> Parser<'_> {
 103     panictry_buffer!(&sess.span_diagnostic, maybe_new_parser_from_source_str(sess, name, source))
 104 }
 105
 106 /// Creates a new parser from a source string. Returns any buffered errors from lexing the initial
 107 /// token stream.
 108 pub fn maybe_new_parser_from_source_str(
 109     sess: &ParseSess,
 110     name: FileName,
 111     source: String,
 112 ) -> Result<Parser<'_>, Vec<Diagnostic>> {
 113     maybe_source_file_to_parser(sess, sess.source_map().new_source_file(name, source))
 114 }
 115
 116 /// Creates a new parser, handling errors as appropriate if the file doesn't exist.
 117 /// If a span is given, that is used on an error as the source of the problem.
 118 pub fn new_parser_from_file<'a>(sess: &'a ParseSess, path: &Path, sp: Option<Span>) -> Parser<'a> {
 119     source_file_to_parser(sess, file_to_source_file(sess, path, sp))
 120 }
 121
 122 /// Given a session and a `source_file`, returns a parser.
 123 fn source_file_to_parser(sess: &ParseSess, source_file: Lrc<SourceFile>) -> Parser<'_> {
 124     panictry_buffer!(&sess.span_diagnostic, maybe_source_file_to_parser(sess, source_file))
 125 }
 126
 127 /// Given a session and a `source_file`, return a parser. Returns any buffered errors from lexing the
 128 /// initial token stream.
 129 fn maybe_source_file_to_parser(
 130     sess: &ParseSess,
 131     source_file: Lrc<SourceFile>,
 132 ) -> Result<Parser<'_>, Vec<Diagnostic>> {
 133     let end_pos = source_file.end_pos;
 134     let (stream, unclosed_delims) = maybe_file_to_stream(sess, source_file, None)?;
 135     let mut parser = stream_to_parser(sess, stream, None);
 136     parser.unclosed_delims = unclosed_delims;
 137     if parser.token == token::Eof {
 138         parser.token.span = Span::new(end_pos, end_pos, parser.token.span.ctxt(), None);
 139     }
 140
 141     Ok(parser)
 142 }
 143
 144 // Base abstractions
 145
 146 /// Given a session and a path and an optional span (for error reporting),
 147 /// add the path to the session's source_map and return the new source_file or
 148 /// error when a file can't be read.
 149 fn try_file_to_source_file(
 150     sess: &ParseSess,
 151     path: &Path,
 152     spanopt: Option<Span>,
 153 ) -> Result<Lrc<SourceFile>, Diagnostic> {
 154     sess.source_map().load_file(path).map_err(|e| {
 155         let msg = format!("couldn't read {}: {}", path.display(), e);
 156         let mut diag = Diagnostic::new(Level::Fatal, &msg);
 157         if let Some(sp) = spanopt {
 158             diag.set_span(sp);
 159         }
 160         diag
 161     })
 162 }
 163
 164 /// Given a session and a path and an optional span (for error reporting),
 165 /// adds the path to the session's `source_map` and returns the new `source_file`.
 166 fn file_to_source_file(sess: &ParseSess, path: &Path, spanopt: Option<Span>) -> Lrc<SourceFile> {
 167     match try_file_to_source_file(sess, path, spanopt) {
 168         Ok(source_file) => source_file,
 169         Err(mut d) => {
 170             sess.span_diagnostic.emit_diagnostic(&mut d);
 171             FatalError.raise();
 172         }
 173     }
 174 }
 175
 176 /// Given a `source_file`, produces a sequence of token trees.
 177 pub fn source_file_to_stream(
 178     sess: &ParseSess,
 179     source_file: Lrc<SourceFile>,
 180     override_span: Option<Span>,
 181 ) -> (TokenStream, Vec<lexer::UnmatchedBrace>) {
 182     panictry_buffer!(&sess.span_diagnostic, maybe_file_to_stream(sess, source_file, override_span))
 183 }
 184
 185 /// Given a source file, produces a sequence of token trees. Returns any buffered errors from
 186 /// parsing the token stream.
 187 pub fn maybe_file_to_stream(
 188     sess: &ParseSess,
 189     source_file: Lrc<SourceFile>,
 190     override_span: Option<Span>,
 191 ) -> Result<(TokenStream, Vec<lexer::UnmatchedBrace>), Vec<Diagnostic>> {
 192     let src = source_file.src.as_ref().unwrap_or_else(|| {
 193         sess.span_diagnostic.bug(&format!(
 194             "cannot lex `source_file` without source: {}",
 195             sess.source_map().filename_for_diagnostics(&source_file.name)
 196         ));
 197     });
 198
 199     let (token_trees, unmatched_braces) =
 200         lexer::parse_token_trees(sess, src.as_str(), source_file.start_pos, override_span);
 201
 202     match token_trees {
 203         Ok(stream) => Ok((stream, unmatched_braces)),
 204         Err(err) => {
 205             let mut buffer = Vec::with_capacity(1);
 206             err.buffer(&mut buffer);
 207             // Not using `emit_unclosed_delims` to use `db.buffer`
 208             for unmatched in unmatched_braces {
 209                 if let Some(err) = make_unclosed_delims_error(unmatched, &sess) {
 210                     err.buffer(&mut buffer);
 211                 }
 212             }
 213             Err(buffer)
 214         }
 215     }
 216 }
 217
 218 /// Given a stream and the `ParseSess`, produces a parser.
 219 pub fn stream_to_parser<'a>(
 220     sess: &'a ParseSess,
 221     stream: TokenStream,
 222     subparser_name: Option<&'static str>,
 223 ) -> Parser<'a> {
 224     Parser::new(sess, stream, false, subparser_name)
 225 }
 226
 227 /// Runs the given subparser `f` on the tokens of the given `attr`'s item.
 228 pub fn parse_in<'a, T>(
 229     sess: &'a ParseSess,
 230     tts: TokenStream,
 231     name: &'static str,
 232     mut f: impl FnMut(&mut Parser<'a>) -> PResult<'a, T>,
 233 ) -> PResult<'a, T> {
 234     let mut parser = Parser::new(sess, tts, false, Some(name));
 235     let result = f(&mut parser)?;
 236     if parser.token != token::Eof {
 237         parser.unexpected()?;
 238     }
 239     Ok(result)
 240 }
 241
 242 pub fn fake_token_stream_for_item(sess: &ParseSess, item: &ast::Item) -> TokenStream {
 243     let source = pprust::item_to_string(item);
 244     let filename = FileName::macro_expansion_source_code(&source);
 245     parse_stream_from_source_str(filename, source, sess, Some(item.span))
 246 }
 247
 248 pub fn fake_token_stream_for_crate(sess: &ParseSess, krate: &ast::Crate) -> TokenStream {
 249     let source = pprust::crate_to_string_for_macros(krate);
 250     let filename = FileName::macro_expansion_source_code(&source);
 251     parse_stream_from_source_str(filename, source, sess, Some(krate.spans.inner_span))
 252 }
 253
 254 pub fn parse_cfg_attr(
 255     attr: &Attribute,
 256     parse_sess: &ParseSess,
 257 ) -> Option<(MetaItem, Vec<(AttrItem, Span)>)> {
 258     match attr.get_normal_item().args {
 259         ast::MacArgs::Delimited(dspan, delim, ref tts) if !tts.is_empty() => {
 260             let msg = "wrong `cfg_attr` delimiters";
 261             crate::validate_attr::check_meta_bad_delim(parse_sess, dspan, delim, msg);
 262             match parse_in(parse_sess, tts.clone(), "`cfg_attr` input", |p| p.parse_cfg_attr()) {
 263                 Ok(r) => return Some(r),
 264                 Err(mut e) => {
 265                     e.help(&format!("the valid syntax is `{}`", CFG_ATTR_GRAMMAR_HELP))
 266                         .note(CFG_ATTR_NOTE_REF)
 267                         .emit();
 268                 }
 269             }
 270         }
 271         _ => error_malformed_cfg_attr_missing(attr.span, parse_sess),
 272     }
 273     None
 274 }
 275
 276 const CFG_ATTR_GRAMMAR_HELP: &str = "#[cfg_attr(condition, attribute, other_attribute, ...)]";
 277 const CFG_ATTR_NOTE_REF: &str = "for more information, visit \
 278     <https://doc.rust-lang.org/reference/conditional-compilation.html\
 279     #the-cfg_attr-attribute>";
 280
 281 fn error_malformed_cfg_attr_missing(span: Span, parse_sess: &ParseSess) {
 282     parse_sess
 283         .span_diagnostic
 284         .struct_span_err(span, "malformed `cfg_attr` attribute input")
 285         .span_suggestion(
 286             span,
 287             "missing condition and attribute",
 288             CFG_ATTR_GRAMMAR_HELP,
 289             Applicability::HasPlaceholders,
 290         )
 291         .note(CFG_ATTR_NOTE_REF)
 292         .emit();
 293 }