1 //! The main parser interface.
3 #![feature(array_windows)]
4 #![feature(box_patterns)]
5 #![feature(if_let_guard)]
6 #![feature(iter_intersperse)]
7 #![feature(let_chains)]
8 #![feature(never_type)]
9 #![feature(rustc_attrs)]
10 #![recursion_limit = "256"]
17 use rustc_ast::tokenstream::TokenStream;
18 use rustc_ast::Attribute;
19 use rustc_ast::{AttrItem, MetaItem};
20 use rustc_ast_pretty::pprust;
21 use rustc_data_structures::sync::Lrc;
22 use rustc_errors::{Applicability, Diagnostic, FatalError, Level, PResult};
23 use rustc_session::parse::ParseSess;
24 use rustc_span::{FileName, SourceFile, Span};
28 pub const MACRO_ARGUMENTS: Option<&str> = Some("macro arguments");
32 use parser::{emit_unclosed_delims, make_unclosed_delims_error, Parser};
34 pub mod validate_attr;
38 // A bunch of utility functions of the form `parse_<thing>_from_<source>`
39 // where <thing> includes crate, expr, item, stmt, tts, and one that
40 // uses a HOF to parse anything, and <source> includes file and
43 /// A variant of 'panictry!' that works on a `Vec<Diagnostic>` instead of a single
44 /// `DiagnosticBuilder`.
45 macro_rules! panictry_buffer {
46 ($handler:expr, $e:expr) => {{
47 use rustc_errors::FatalError;
48 use std::result::Result::{Err, Ok};
53 $handler.emit_diagnostic(&mut e);
61 pub fn parse_crate_from_file<'a>(input: &Path, sess: &'a ParseSess) -> PResult<'a, ast::Crate> {
62 let mut parser = new_parser_from_file(sess, input, None);
63 parser.parse_crate_mod()
66 pub fn parse_crate_attrs_from_file<'a>(
69 ) -> PResult<'a, ast::AttrVec> {
70 let mut parser = new_parser_from_file(sess, input, None);
71 parser.parse_inner_attributes()
74 pub fn parse_crate_from_source_str(
78 ) -> PResult<'_, ast::Crate> {
79 new_parser_from_source_str(sess, name, source).parse_crate_mod()
82 pub fn parse_crate_attrs_from_source_str(
86 ) -> PResult<'_, ast::AttrVec> {
87 new_parser_from_source_str(sess, name, source).parse_inner_attributes()
90 pub fn parse_stream_from_source_str(
94 override_span: Option<Span>,
96 let (stream, mut errors) =
97 source_file_to_stream(sess, sess.source_map().new_source_file(name, source), override_span);
98 emit_unclosed_delims(&mut errors, &sess);
102 /// Creates a new parser from a source string.
103 pub fn new_parser_from_source_str(sess: &ParseSess, name: FileName, source: String) -> Parser<'_> {
104 panictry_buffer!(&sess.span_diagnostic, maybe_new_parser_from_source_str(sess, name, source))
107 /// Creates a new parser from a source string. Returns any buffered errors from lexing the initial
109 pub fn maybe_new_parser_from_source_str(
113 ) -> Result<Parser<'_>, Vec<Diagnostic>> {
114 maybe_source_file_to_parser(sess, sess.source_map().new_source_file(name, source))
117 /// Creates a new parser, handling errors as appropriate if the file doesn't exist.
118 /// If a span is given, that is used on an error as the source of the problem.
119 pub fn new_parser_from_file<'a>(sess: &'a ParseSess, path: &Path, sp: Option<Span>) -> Parser<'a> {
120 source_file_to_parser(sess, file_to_source_file(sess, path, sp))
123 /// Given a session and a `source_file`, returns a parser.
124 fn source_file_to_parser(sess: &ParseSess, source_file: Lrc<SourceFile>) -> Parser<'_> {
125 panictry_buffer!(&sess.span_diagnostic, maybe_source_file_to_parser(sess, source_file))
128 /// Given a session and a `source_file`, return a parser. Returns any buffered errors from lexing the
129 /// initial token stream.
130 fn maybe_source_file_to_parser(
132 source_file: Lrc<SourceFile>,
133 ) -> Result<Parser<'_>, Vec<Diagnostic>> {
134 let end_pos = source_file.end_pos;
135 let (stream, unclosed_delims) = maybe_file_to_stream(sess, source_file, None)?;
136 let mut parser = stream_to_parser(sess, stream, None);
137 parser.unclosed_delims = unclosed_delims;
138 if parser.token == token::Eof {
139 parser.token.span = Span::new(end_pos, end_pos, parser.token.span.ctxt(), None);
147 /// Given a session and a path and an optional span (for error reporting),
148 /// add the path to the session's source_map and return the new source_file or
149 /// error when a file can't be read.
150 fn try_file_to_source_file(
153 spanopt: Option<Span>,
154 ) -> Result<Lrc<SourceFile>, Diagnostic> {
155 sess.source_map().load_file(path).map_err(|e| {
156 let msg = format!("couldn't read {}: {}", path.display(), e);
157 let mut diag = Diagnostic::new(Level::Fatal, &msg);
158 if let Some(sp) = spanopt {
165 /// Given a session and a path and an optional span (for error reporting),
166 /// adds the path to the session's `source_map` and returns the new `source_file`.
167 fn file_to_source_file(sess: &ParseSess, path: &Path, spanopt: Option<Span>) -> Lrc<SourceFile> {
168 match try_file_to_source_file(sess, path, spanopt) {
169 Ok(source_file) => source_file,
171 sess.span_diagnostic.emit_diagnostic(&mut d);
177 /// Given a `source_file`, produces a sequence of token trees.
178 pub fn source_file_to_stream(
180 source_file: Lrc<SourceFile>,
181 override_span: Option<Span>,
182 ) -> (TokenStream, Vec<lexer::UnmatchedBrace>) {
183 panictry_buffer!(&sess.span_diagnostic, maybe_file_to_stream(sess, source_file, override_span))
186 /// Given a source file, produces a sequence of token trees. Returns any buffered errors from
187 /// parsing the token stream.
188 pub fn maybe_file_to_stream(
190 source_file: Lrc<SourceFile>,
191 override_span: Option<Span>,
192 ) -> Result<(TokenStream, Vec<lexer::UnmatchedBrace>), Vec<Diagnostic>> {
193 let src = source_file.src.as_ref().unwrap_or_else(|| {
194 sess.span_diagnostic.bug(&format!(
195 "cannot lex `source_file` without source: {}",
196 sess.source_map().filename_for_diagnostics(&source_file.name)
200 let (token_trees, unmatched_braces) =
201 lexer::parse_token_trees(sess, src.as_str(), source_file.start_pos, override_span);
204 Ok(stream) => Ok((stream, unmatched_braces)),
206 let mut buffer = Vec::with_capacity(1);
207 err.buffer(&mut buffer);
208 // Not using `emit_unclosed_delims` to use `db.buffer`
209 for unmatched in unmatched_braces {
210 if let Some(err) = make_unclosed_delims_error(unmatched, &sess) {
211 err.buffer(&mut buffer);
219 /// Given a stream and the `ParseSess`, produces a parser.
220 pub fn stream_to_parser<'a>(
223 subparser_name: Option<&'static str>,
225 Parser::new(sess, stream, false, subparser_name)
228 /// Runs the given subparser `f` on the tokens of the given `attr`'s item.
229 pub fn parse_in<'a, T>(
233 mut f: impl FnMut(&mut Parser<'a>) -> PResult<'a, T>,
234 ) -> PResult<'a, T> {
235 let mut parser = Parser::new(sess, tts, false, Some(name));
236 let result = f(&mut parser)?;
237 if parser.token != token::Eof {
238 parser.unexpected()?;
243 pub fn fake_token_stream_for_item(sess: &ParseSess, item: &ast::Item) -> TokenStream {
244 let source = pprust::item_to_string(item);
245 let filename = FileName::macro_expansion_source_code(&source);
246 parse_stream_from_source_str(filename, source, sess, Some(item.span))
249 pub fn fake_token_stream_for_crate(sess: &ParseSess, krate: &ast::Crate) -> TokenStream {
250 let source = pprust::crate_to_string_for_macros(krate);
251 let filename = FileName::macro_expansion_source_code(&source);
252 parse_stream_from_source_str(filename, source, sess, Some(krate.spans.inner_span))
255 pub fn parse_cfg_attr(
257 parse_sess: &ParseSess,
258 ) -> Option<(MetaItem, Vec<(AttrItem, Span)>)> {
259 match attr.get_normal_item().args {
260 ast::MacArgs::Delimited(dspan, delim, ref tts) if !tts.is_empty() => {
261 let msg = "wrong `cfg_attr` delimiters";
262 crate::validate_attr::check_meta_bad_delim(parse_sess, dspan, delim, msg);
263 match parse_in(parse_sess, tts.clone(), "`cfg_attr` input", |p| p.parse_cfg_attr()) {
264 Ok(r) => return Some(r),
266 e.help(&format!("the valid syntax is `{}`", CFG_ATTR_GRAMMAR_HELP))
267 .note(CFG_ATTR_NOTE_REF)
272 _ => error_malformed_cfg_attr_missing(attr.span, parse_sess),
277 const CFG_ATTR_GRAMMAR_HELP: &str = "#[cfg_attr(condition, attribute, other_attribute, ...)]";
278 const CFG_ATTR_NOTE_REF: &str = "for more information, visit \
279 <https://doc.rust-lang.org/reference/conditional-compilation.html\
280 #the-cfg_attr-attribute>";
282 fn error_malformed_cfg_attr_missing(span: Span, parse_sess: &ParseSess) {
285 .struct_span_err(span, "malformed `cfg_attr` attribute input")
288 "missing condition and attribute",
289 CFG_ATTR_GRAMMAR_HELP,
290 Applicability::HasPlaceholders,
292 .note(CFG_ATTR_NOTE_REF)