blob: b85dc9cf22575c26526b1786ea0167f65bad424c [file] [log] [blame]
David Tolnay80a914f2018-08-30 23:49:53 -07001// Copyright 2018 Syn Developers
2//
3// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
4// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
5// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
6// option. This file may not be copied, modified, or distributed
7// except according to those terms.
8
David Tolnay18c754c2018-08-21 23:26:58 -04009//! Parsing interface for parsing a token stream into a syntax tree node.
David Tolnay80a914f2018-08-30 23:49:53 -070010//!
David Tolnaye0c51762018-08-31 11:05:22 -070011//! Parsing in Syn is built on parser functions that take in a [`ParseStream`]
12//! and produce a [`Result<T>`] where `T` is some syntax tree node. Underlying
13//! these parser functions is a lower level mechanism built around the
14//! [`Cursor`] type. `Cursor` is a cheaply copyable cursor over a range of
15//! tokens in a token stream.
David Tolnay80a914f2018-08-30 23:49:53 -070016//!
David Tolnaye0c51762018-08-31 11:05:22 -070017//! [`ParseStream`]: type.ParseStream.html
18//! [`Result<T>`]: type.Result.html
David Tolnay80a914f2018-08-30 23:49:53 -070019//! [`Cursor`]: ../buffer/index.html
David Tolnay80a914f2018-08-30 23:49:53 -070020//!
David Tolnaye0c51762018-08-31 11:05:22 -070021//! The `ParseStream`-based interface is convenient for parser implementations,
22//! but not necessarily when you just have some tokens that you want to parse.
23//! For that we expose the following two entry points.
David Tolnay80a914f2018-08-30 23:49:53 -070024//!
25//! ## The `syn::parse*` functions
26//!
27//! The [`syn::parse`], [`syn::parse2`], and [`syn::parse_str`] functions serve
28//! as an entry point for parsing syntax tree nodes that can be parsed in an
29//! obvious default way. These functions can return any syntax tree node that
David Tolnay8aacee12018-08-31 09:15:15 -070030//! implements the [`Parse`] trait, which includes most types in Syn.
David Tolnay80a914f2018-08-30 23:49:53 -070031//!
32//! [`syn::parse`]: ../fn.parse.html
33//! [`syn::parse2`]: ../fn.parse2.html
34//! [`syn::parse_str`]: ../fn.parse_str.html
David Tolnay8aacee12018-08-31 09:15:15 -070035//! [`Parse`]: trait.Parse.html
David Tolnay80a914f2018-08-30 23:49:53 -070036//!
37//! ```
38//! use syn::Type;
39//!
David Tolnay8aacee12018-08-31 09:15:15 -070040//! # fn run_parser() -> Result<(), syn::parse::Error> {
David Tolnay80a914f2018-08-30 23:49:53 -070041//! let t: Type = syn::parse_str("std::collections::HashMap<String, Value>")?;
42//! # Ok(())
43//! # }
44//! #
45//! # fn main() {
46//! # run_parser().unwrap();
47//! # }
48//! ```
49//!
50//! The [`parse_quote!`] macro also uses this approach.
51//!
52//! [`parse_quote!`]: ../macro.parse_quote.html
53//!
54//! ## The `Parser` trait
55//!
56//! Some types can be parsed in several ways depending on context. For example
57//! an [`Attribute`] can be either "outer" like `#[...]` or "inner" like
58//! `#![...]` and parsing the wrong one would be a bug. Similarly [`Punctuated`]
59//! may or may not allow trailing punctuation, and parsing it the wrong way
60//! would either reject valid input or accept invalid input.
61//!
62//! [`Attribute`]: ../struct.Attribute.html
63//! [`Punctuated`]: ../punctuated/index.html
64//!
David Tolnaye0c51762018-08-31 11:05:22 -070065//! The `Parse` trait is not implemented in these cases because there is no good
David Tolnay80a914f2018-08-30 23:49:53 -070066//! behavior to consider the default.
67//!
68//! ```ignore
69//! // Can't parse `Punctuated` without knowing whether trailing punctuation
70//! // should be allowed in this context.
71//! let path: Punctuated<PathSegment, Token![::]> = syn::parse(tokens)?;
72//! ```
73//!
74//! In these cases the types provide a choice of parser functions rather than a
David Tolnaye0c51762018-08-31 11:05:22 -070075//! single `Parse` implementation, and those parser functions can be invoked
David Tolnay80a914f2018-08-30 23:49:53 -070076//! through the [`Parser`] trait.
77//!
78//! [`Parser`]: trait.Parser.html
79//!
80//! ```
David Tolnay80a914f2018-08-30 23:49:53 -070081//! # extern crate syn;
82//! #
83//! # extern crate proc_macro2;
84//! # use proc_macro2::TokenStream;
85//! #
David Tolnay3e3f7752018-08-31 09:33:59 -070086//! use syn::parse::Parser;
David Tolnay80a914f2018-08-30 23:49:53 -070087//! use syn::punctuated::Punctuated;
David Tolnay9b00f652018-09-01 10:31:02 -070088//! use syn::{Attribute, Expr, PathSegment, Token};
David Tolnay80a914f2018-08-30 23:49:53 -070089//!
David Tolnay3e3f7752018-08-31 09:33:59 -070090//! # fn run_parsers() -> Result<(), syn::parse::Error> {
David Tolnay80a914f2018-08-30 23:49:53 -070091//! # let tokens = TokenStream::new().into();
92//! // Parse a nonempty sequence of path segments separated by `::` punctuation
93//! // with no trailing punctuation.
94//! let parser = Punctuated::<PathSegment, Token![::]>::parse_separated_nonempty;
95//! let path = parser.parse(tokens)?;
96//!
97//! # let tokens = TokenStream::new().into();
98//! // Parse a possibly empty sequence of expressions terminated by commas with
99//! // an optional trailing punctuation.
100//! let parser = Punctuated::<Expr, Token![,]>::parse_terminated;
101//! let args = parser.parse(tokens)?;
102//!
103//! # let tokens = TokenStream::new().into();
104//! // Parse zero or more outer attributes but not inner attributes.
David Tolnay3e3f7752018-08-31 09:33:59 -0700105//! let parser = Attribute::parse_outer;
106//! let attrs = parser.parse(tokens)?;
David Tolnay80a914f2018-08-30 23:49:53 -0700107//! #
108//! # Ok(())
109//! # }
110//! #
111//! # fn main() {}
112//! ```
113//!
David Tolnaye0c51762018-08-31 11:05:22 -0700114//! ---
David Tolnay80a914f2018-08-30 23:49:53 -0700115//!
116//! *This module is available if Syn is built with the `"parsing"` feature.*
David Tolnay18c754c2018-08-21 23:26:58 -0400117
118use std::cell::Cell;
119use std::fmt::Display;
120use std::marker::PhantomData;
121use std::mem;
122use std::ops::Deref;
David Tolnayeafc8052018-08-25 16:33:53 -0400123use std::rc::Rc;
David Tolnay80a914f2018-08-30 23:49:53 -0700124use std::str::FromStr;
David Tolnayeafc8052018-08-25 16:33:53 -0400125
David Tolnay80a914f2018-08-30 23:49:53 -0700126#[cfg(all(
127 not(all(target_arch = "wasm32", target_os = "unknown")),
128 feature = "proc-macro"
129))]
130use proc_macro;
David Tolnayf07b3342018-09-01 11:58:11 -0700131use proc_macro2::{self, Delimiter, Group, Literal, Punct, Span, TokenStream, TokenTree};
David Tolnay18c754c2018-08-21 23:26:58 -0400132
David Tolnay80a914f2018-08-30 23:49:53 -0700133use buffer::{Cursor, TokenBuffer};
David Tolnayb6254182018-08-25 08:44:54 -0400134use error;
David Tolnay94f06632018-08-31 10:17:17 -0700135use lookahead;
136use private;
David Tolnay577d0332018-08-25 21:45:24 -0400137use punctuated::Punctuated;
David Tolnay4fb71232018-08-25 23:14:50 -0400138use token::Token;
David Tolnay18c754c2018-08-21 23:26:58 -0400139
David Tolnayb6254182018-08-25 08:44:54 -0400140pub use error::{Error, Result};
141pub use lookahead::{Lookahead1, Peek};
David Tolnay18c754c2018-08-21 23:26:58 -0400142
143/// Parsing interface implemented by all types that can be parsed in a default
144/// way from a token stream.
145pub trait Parse: Sized {
146 fn parse(input: ParseStream) -> Result<Self>;
147}
148
149/// Input to a Syn parser function.
David Tolnaya0daa482018-09-01 02:09:40 -0700150///
151/// See the methods of this type under the documentation of [`ParseBuffer`]. For
152/// an overview of parsing in Syn, refer to the [module documentation].
153///
154/// [module documentation]: index.html
David Tolnay18c754c2018-08-21 23:26:58 -0400155pub type ParseStream<'a> = &'a ParseBuffer<'a>;
156
157/// Cursor position within a buffered token stream.
David Tolnay18c754c2018-08-21 23:26:58 -0400158pub struct ParseBuffer<'a> {
159 scope: Span,
160 cell: Cell<Cursor<'static>>,
161 marker: PhantomData<Cursor<'a>>,
David Tolnayeafc8052018-08-25 16:33:53 -0400162 unexpected: Rc<Cell<Option<Span>>>,
163}
164
165impl<'a> Drop for ParseBuffer<'a> {
166 fn drop(&mut self) {
167 if !self.is_empty() && self.unexpected.get().is_none() {
168 self.unexpected.set(Some(self.cursor().span()));
169 }
170 }
David Tolnay18c754c2018-08-21 23:26:58 -0400171}
172
David Tolnay642832f2018-09-01 13:08:10 -0700173/// Cursor state associated with speculative parsing.
174///
175/// This type is the input of the closure provided to [`ParseStream::step`].
176///
177/// [`ParseStream::step`]: struct.ParseBuffer.html#method.step
David Tolnay9bd34392018-09-01 13:19:53 -0700178///
179/// # Example
180///
181/// ```
182/// # extern crate proc_macro2;
183/// # extern crate syn;
184/// #
185/// use proc_macro2::TokenTree;
186/// use syn::parse::{ParseStream, Result};
187///
188/// // This function advances the stream past the next occurrence of `@`. If
189/// // no `@` is present in the stream, the stream position is unchanged and
190/// // an error is returned.
191/// fn skip_past_next_at(input: ParseStream) -> Result<()> {
192/// input.step(|cursor| {
193/// let mut rest = *cursor;
194/// while let Some((tt, next)) = cursor.token_tree() {
195/// match tt {
196/// TokenTree::Punct(ref punct) if punct.as_char() == '@' => {
197/// return Ok(((), next));
198/// }
199/// _ => rest = next,
200/// }
201/// }
202/// Err(cursor.error("no `@` was found after this point"))
203/// })
204/// }
205/// #
206/// # fn main() {}
207/// ```
David Tolnay18c754c2018-08-21 23:26:58 -0400208#[derive(Copy, Clone)]
209pub struct StepCursor<'c, 'a> {
210 scope: Span,
211 cursor: Cursor<'c>,
212 marker: PhantomData<fn(Cursor<'c>) -> Cursor<'a>>,
213}
214
215impl<'c, 'a> Deref for StepCursor<'c, 'a> {
216 type Target = Cursor<'c>;
217
218 fn deref(&self) -> &Self::Target {
219 &self.cursor
220 }
221}
222
223impl<'c, 'a> StepCursor<'c, 'a> {
David Tolnay642832f2018-09-01 13:08:10 -0700224 /// Triggers an error at the current position of the parse stream.
225 ///
226 /// The `ParseStream::step` invocation will return this same error without
227 /// advancing the stream state.
David Tolnay18c754c2018-08-21 23:26:58 -0400228 pub fn error<T: Display>(self, message: T) -> Error {
229 error::new_at(self.scope, self.cursor, message)
230 }
231}
232
David Tolnay6ea3fdc2018-09-01 13:30:53 -0700233impl private {
234 pub fn advance_step_cursor<'c, 'a>(proof: StepCursor<'c, 'a>, to: Cursor<'c>) -> Cursor<'a> {
235 let _ = proof;
236 unsafe { mem::transmute::<Cursor<'c>, Cursor<'a>>(to) }
237 }
238}
239
David Tolnay66cb0c42018-08-31 09:01:30 -0700240fn skip(input: ParseStream) -> bool {
David Tolnay4ac232d2018-08-31 10:18:03 -0700241 input
242 .step(|cursor| {
243 if let Some((_lifetime, rest)) = cursor.lifetime() {
244 Ok((true, rest))
245 } else if let Some((_token, rest)) = cursor.token_tree() {
246 Ok((true, rest))
247 } else {
248 Ok((false, *cursor))
249 }
250 }).unwrap()
David Tolnay66cb0c42018-08-31 09:01:30 -0700251}
252
David Tolnay10951d52018-08-31 10:27:39 -0700253impl private {
David Tolnay70f30e92018-09-01 02:04:17 -0700254 pub fn new_parse_buffer(
255 scope: Span,
256 cursor: Cursor,
257 unexpected: Rc<Cell<Option<Span>>>,
258 ) -> ParseBuffer {
David Tolnay94f06632018-08-31 10:17:17 -0700259 let extend = unsafe { mem::transmute::<Cursor, Cursor<'static>>(cursor) };
David Tolnay18c754c2018-08-21 23:26:58 -0400260 ParseBuffer {
261 scope: scope,
262 cell: Cell::new(extend),
263 marker: PhantomData,
David Tolnayeafc8052018-08-25 16:33:53 -0400264 unexpected: unexpected,
David Tolnay18c754c2018-08-21 23:26:58 -0400265 }
266 }
267
David Tolnay94f06632018-08-31 10:17:17 -0700268 pub fn get_unexpected(buffer: &ParseBuffer) -> Rc<Cell<Option<Span>>> {
269 buffer.unexpected.clone()
270 }
271}
272
273impl<'a> ParseBuffer<'a> {
David Tolnay725e1c62018-09-01 12:07:25 -0700274 /// Parses a syntax tree node of type `T`, advancing the position of our
275 /// parse stream past it.
David Tolnay18c754c2018-08-21 23:26:58 -0400276 pub fn parse<T: Parse>(&self) -> Result<T> {
277 T::parse(self)
278 }
279
David Tolnay725e1c62018-09-01 12:07:25 -0700280 /// Calls the given parser function to parse a syntax tree node of type `T`
281 /// from this stream.
David Tolnay3a515a02018-08-25 21:08:27 -0400282 pub fn call<T>(&self, function: fn(ParseStream) -> Result<T>) -> Result<T> {
283 function(self)
284 }
285
David Tolnay725e1c62018-09-01 12:07:25 -0700286 /// Looks at the next token in the parse stream to determine whether it
287 /// matches the requested type of token.
288 ///
289 /// Does not advance the position of the parse stream.
David Tolnayb77c8b62018-08-25 16:39:41 -0400290 pub fn peek<T: Peek>(&self, token: T) -> bool {
David Tolnay576779a2018-09-01 11:54:12 -0700291 let _ = token;
292 T::Token::peek(self.cursor())
David Tolnayb77c8b62018-08-25 16:39:41 -0400293 }
294
David Tolnay725e1c62018-09-01 12:07:25 -0700295 /// Looks at the second-next token in the parse stream.
David Tolnay4fb71232018-08-25 23:14:50 -0400296 pub fn peek2<T: Peek>(&self, token: T) -> bool {
David Tolnay4fb71232018-08-25 23:14:50 -0400297 let ahead = self.fork();
David Tolnay66cb0c42018-08-31 09:01:30 -0700298 skip(&ahead) && ahead.peek(token)
David Tolnay4fb71232018-08-25 23:14:50 -0400299 }
300
David Tolnay725e1c62018-09-01 12:07:25 -0700301 /// Looks at the third-next token in the parse stream.
David Tolnay4fb71232018-08-25 23:14:50 -0400302 pub fn peek3<T: Peek>(&self, token: T) -> bool {
David Tolnay4fb71232018-08-25 23:14:50 -0400303 let ahead = self.fork();
David Tolnay66cb0c42018-08-31 09:01:30 -0700304 skip(&ahead) && skip(&ahead) && ahead.peek(token)
David Tolnay4fb71232018-08-25 23:14:50 -0400305 }
306
David Tolnay725e1c62018-09-01 12:07:25 -0700307 /// Parses zero or more occurrences of `T` separated by punctuation of type
308 /// `P`, with optional trailing punctuation.
309 ///
310 /// Parsing continues until the end of this parse stream. The entire content
311 /// of this parse stream must consist of `T` and `P`.
David Tolnay577d0332018-08-25 21:45:24 -0400312 pub fn parse_terminated<T, P: Parse>(
313 &self,
314 parser: fn(ParseStream) -> Result<T>,
315 ) -> Result<Punctuated<T, P>> {
David Tolnayd0f80212018-08-30 18:32:14 -0700316 Punctuated::parse_terminated_with(self, parser)
David Tolnay577d0332018-08-25 21:45:24 -0400317 }
318
David Tolnay725e1c62018-09-01 12:07:25 -0700319 /// Returns whether there are tokens remaining in this stream.
320 ///
321 /// This method returns true at the end of the content of a set of
322 /// delimiters, as well as at the very end of the complete macro input.
David Tolnaycce6b5f2018-09-01 14:24:46 -0700323 ///
324 /// # Example
325 ///
326 /// ```rust
327 /// # extern crate syn;
328 /// #
329 /// use syn::{braced, token, Ident, Item, Token};
330 /// use syn::parse::{Parse, ParseStream, Result};
331 ///
332 /// // Parses a Rust `mod m { ... }` containing zero or more items.
333 /// struct Mod {
334 /// mod_token: Token![mod],
335 /// name: Ident,
336 /// brace_token: token::Brace,
337 /// items: Vec<Item>,
338 /// }
339 ///
340 /// impl Parse for Mod {
341 /// fn parse(input: ParseStream) -> Result<Self> {
342 /// let content;
343 /// Ok(Mod {
344 /// mod_token: input.parse()?,
345 /// name: input.parse()?,
346 /// brace_token: braced!(content in input),
347 /// items: {
348 /// let mut items = Vec::new();
349 /// while !content.is_empty() {
350 /// items.push(content.parse()?);
351 /// }
352 /// items
353 /// },
354 /// })
355 /// }
356 /// }
357 /// #
358 /// # fn main() {}
David Tolnayf5d30452018-09-01 02:29:04 -0700359 pub fn is_empty(&self) -> bool {
360 self.cursor().eof()
361 }
362
David Tolnay725e1c62018-09-01 12:07:25 -0700363 /// Constructs a helper for peeking at the next token in this stream and
364 /// building an error message if it is not one of a set of expected tokens.
David Tolnay2c77e772018-09-01 14:18:46 -0700365 ///
366 /// # Example
367 ///
368 /// ```
369 /// # extern crate syn;
370 /// #
371 /// use syn::{ConstParam, Ident, Lifetime, LifetimeDef, Token, TypeParam};
372 /// use syn::parse::{Parse, ParseStream, Result};
373 ///
374 /// // A generic parameter, a single one of the comma-separated elements inside
375 /// // angle brackets in:
376 /// //
377 /// // fn f<T: Clone, 'a, 'b: 'a, const N: usize>() { ... }
378 /// //
379 /// // On invalid input, lookahead gives us a reasonable error message.
380 /// //
381 /// // error: expected one of: identifier, lifetime, `const`
382 /// // |
383 /// // 5 | fn f<!Sized>() {}
384 /// // | ^
385 /// enum GenericParam {
386 /// Type(TypeParam),
387 /// Lifetime(LifetimeDef),
388 /// Const(ConstParam),
389 /// }
390 ///
391 /// impl Parse for GenericParam {
392 /// fn parse(input: ParseStream) -> Result<Self> {
393 /// let lookahead = input.lookahead1();
394 /// if lookahead.peek(Ident) {
395 /// input.parse().map(GenericParam::Type)
396 /// } else if lookahead.peek(Lifetime) {
397 /// input.parse().map(GenericParam::Lifetime)
398 /// } else if lookahead.peek(Token![const]) {
399 /// input.parse().map(GenericParam::Const)
400 /// } else {
401 /// Err(lookahead.error())
402 /// }
403 /// }
404 /// }
405 /// #
406 /// # fn main() {}
407 /// ```
David Tolnayf5d30452018-09-01 02:29:04 -0700408 pub fn lookahead1(&self) -> Lookahead1<'a> {
409 lookahead::new(self.scope, self.cursor())
410 }
411
David Tolnay725e1c62018-09-01 12:07:25 -0700412 /// Forks a parse stream so that parsing tokens out of either the original
413 /// or the fork does not advance the position of the other.
414 ///
415 /// # Performance
416 ///
417 /// Forking a parse stream is a cheap fixed amount of work and does not
418 /// involve copying token buffers. Where you might hit performance problems
419 /// is if your macro ends up parsing a large amount of content more than
420 /// once.
421 ///
422 /// ```
423 /// # use syn::Expr;
424 /// # use syn::parse::{ParseStream, Result};
425 /// #
426 /// # fn bad(input: ParseStream) -> Result<Expr> {
427 /// // Do not do this.
428 /// if input.fork().parse::<Expr>().is_ok() {
429 /// return input.parse::<Expr>();
430 /// }
431 /// # unimplemented!()
432 /// # }
433 /// ```
434 ///
435 /// As a rule, avoid parsing an unbounded amount of tokens out of a forked
436 /// parse stream. Only use a fork when the amount of work performed against
437 /// the fork is small and bounded.
438 ///
David Tolnayec149b02018-09-01 14:17:28 -0700439 /// For a lower level but occasionally more performant way to perform
David Tolnay725e1c62018-09-01 12:07:25 -0700440 /// speculative parsing, consider using [`ParseStream::step`] instead.
441 ///
442 /// [`ParseStream::step`]: #method.step
David Tolnayec149b02018-09-01 14:17:28 -0700443 ///
444 /// # Example
445 ///
446 /// The parse implementation shown here parses possibly restricted `pub`
447 /// visibilities.
448 ///
449 /// - `pub`
450 /// - `pub(crate)`
451 /// - `pub(self)`
452 /// - `pub(super)`
453 /// - `pub(in some::path)`
454 ///
455 /// To handle the case of visibilities inside of tuple structs, the parser
456 /// needs to distinguish parentheses that specify visibility restrictions
457 /// from parentheses that form part of a tuple type.
458 ///
459 /// ```
460 /// # struct A;
461 /// # struct B;
462 /// # struct C;
463 /// #
464 /// struct S(pub(crate) A, pub (B, C));
465 /// ```
466 ///
467 /// In this example input the first tuple struct element of `S` has
468 /// `pub(crate)` visibility while the second tuple struct element has `pub`
469 /// visibility; the parentheses around `(B, C)` are part of the type rather
470 /// than part of a visibility restriction.
471 ///
472 /// The parser uses a forked parse stream to check the first token inside of
473 /// parentheses after the `pub` keyword. This is a small bounded amount of
474 /// work performed against the forked parse stream.
475 ///
476 /// ```
477 /// # extern crate syn;
478 /// #
479 /// use syn::{parenthesized, token, Ident, Path, Token};
480 /// use syn::ext::IdentExt;
481 /// use syn::parse::{Parse, ParseStream, Result};
482 ///
483 /// struct PubVisibility {
484 /// pub_token: Token![pub],
485 /// restricted: Option<Restricted>,
486 /// }
487 ///
488 /// struct Restricted {
489 /// paren_token: token::Paren,
490 /// in_token: Option<Token![in]>,
491 /// path: Path,
492 /// }
493 ///
494 /// impl Parse for PubVisibility {
495 /// fn parse(input: ParseStream) -> Result<Self> {
496 /// let pub_token: Token![pub] = input.parse()?;
497 ///
498 /// if input.peek(token::Paren) {
499 /// let ahead = input.fork();
500 /// let mut content;
501 /// parenthesized!(content in ahead);
502 ///
503 /// if content.peek(Token![crate])
504 /// || content.peek(Token![self])
505 /// || content.peek(Token![super])
506 /// {
507 /// return Ok(PubVisibility {
508 /// pub_token: pub_token,
509 /// restricted: Some(Restricted {
510 /// paren_token: parenthesized!(content in input),
511 /// in_token: None,
512 /// path: Path::from(content.call(Ident::parse_any)?),
513 /// }),
514 /// });
515 /// } else if content.peek(Token![in]) {
516 /// return Ok(PubVisibility {
517 /// pub_token: pub_token,
518 /// restricted: Some(Restricted {
519 /// paren_token: parenthesized!(content in input),
520 /// in_token: Some(content.parse()?),
521 /// path: content.call(Path::parse_mod_style)?,
522 /// }),
523 /// });
524 /// }
525 /// }
526 ///
527 /// Ok(PubVisibility {
528 /// pub_token: pub_token,
529 /// restricted: None,
530 /// })
531 /// }
532 /// }
533 /// #
534 /// # fn main() {}
535 /// ```
David Tolnayb77c8b62018-08-25 16:39:41 -0400536 pub fn fork(&self) -> Self {
David Tolnay6456a9d2018-08-26 08:11:18 -0400537 ParseBuffer {
538 scope: self.scope,
539 cell: self.cell.clone(),
540 marker: PhantomData,
541 // Not the parent's unexpected. Nothing cares whether the clone
542 // parses all the way.
543 unexpected: Rc::new(Cell::new(None)),
544 }
David Tolnayb77c8b62018-08-25 16:39:41 -0400545 }
546
David Tolnay725e1c62018-09-01 12:07:25 -0700547 /// Triggers an error at the current position of the parse stream.
David Tolnay23fce0b2018-09-01 13:50:31 -0700548 ///
549 /// # Example
550 ///
551 /// ```
552 /// # extern crate syn;
553 /// #
554 /// use syn::{Expr, Token};
555 /// use syn::parse::{Parse, ParseStream, Result};
556 ///
557 /// // Some kind of loop: `while` or `for` or `loop`.
558 /// struct Loop {
559 /// expr: Expr,
560 /// }
561 ///
562 /// impl Parse for Loop {
563 /// fn parse(input: ParseStream) -> Result<Self> {
564 /// if input.peek(Token![while])
565 /// || input.peek(Token![for])
566 /// || input.peek(Token![loop])
567 /// {
568 /// Ok(Loop {
569 /// expr: input.parse()?,
570 /// })
571 /// } else {
572 /// Err(input.error("expected some kind of loop"))
573 /// }
574 /// }
575 /// }
576 /// ```
David Tolnay4fb71232018-08-25 23:14:50 -0400577 pub fn error<T: Display>(&self, message: T) -> Error {
578 error::new_at(self.scope, self.cursor(), message)
579 }
580
David Tolnay725e1c62018-09-01 12:07:25 -0700581 /// Speculatively parses tokens from this parse stream, advancing the
582 /// position of this stream only if parsing succeeds.
David Tolnay9bd34392018-09-01 13:19:53 -0700583 ///
David Tolnayad1d1d22018-09-01 13:34:43 -0700584 /// This is a powerful low-level API used for defining the `Parse` impls of
585 /// the basic built-in token types. It is not something that will be used
586 /// widely outside of the Syn codebase.
587 ///
David Tolnay9bd34392018-09-01 13:19:53 -0700588 /// # Example
589 ///
590 /// ```
591 /// # extern crate proc_macro2;
592 /// # extern crate syn;
593 /// #
594 /// use proc_macro2::TokenTree;
595 /// use syn::parse::{ParseStream, Result};
596 ///
597 /// // This function advances the stream past the next occurrence of `@`. If
598 /// // no `@` is present in the stream, the stream position is unchanged and
599 /// // an error is returned.
600 /// fn skip_past_next_at(input: ParseStream) -> Result<()> {
601 /// input.step(|cursor| {
602 /// let mut rest = *cursor;
603 /// while let Some((tt, next)) = cursor.token_tree() {
604 /// match tt {
605 /// TokenTree::Punct(ref punct) if punct.as_char() == '@' => {
606 /// return Ok(((), next));
607 /// }
608 /// _ => rest = next,
609 /// }
610 /// }
611 /// Err(cursor.error("no `@` was found after this point"))
612 /// })
613 /// }
614 /// #
615 /// # fn main() {}
616 /// ```
David Tolnayb50c65a2018-08-30 21:14:57 -0700617 pub fn step<F, R>(&self, function: F) -> Result<R>
David Tolnay18c754c2018-08-21 23:26:58 -0400618 where
619 F: for<'c> FnOnce(StepCursor<'c, 'a>) -> Result<(R, Cursor<'c>)>,
620 {
David Tolnay6b65f852018-09-01 11:56:25 -0700621 let (node, rest) = function(StepCursor {
David Tolnay18c754c2018-08-21 23:26:58 -0400622 scope: self.scope,
623 cursor: self.cell.get(),
624 marker: PhantomData,
David Tolnay6b65f852018-09-01 11:56:25 -0700625 })?;
626 self.cell.set(rest);
627 Ok(node)
David Tolnay18c754c2018-08-21 23:26:58 -0400628 }
David Tolnayeafc8052018-08-25 16:33:53 -0400629
David Tolnay725e1c62018-09-01 12:07:25 -0700630 /// Provides low-level access to the token representation underlying this
631 /// parse stream.
632 ///
633 /// Cursors are immutable so no operations you perform against the cursor
634 /// will affect the state of this parse stream.
David Tolnayf5d30452018-09-01 02:29:04 -0700635 pub fn cursor(&self) -> Cursor<'a> {
636 self.cell.get()
637 }
638
David Tolnay94f06632018-08-31 10:17:17 -0700639 fn check_unexpected(&self) -> Result<()> {
David Tolnayeafc8052018-08-25 16:33:53 -0400640 match self.unexpected.get() {
641 Some(span) => Err(Error::new(span, "unexpected token")),
642 None => Ok(()),
643 }
644 }
David Tolnay18c754c2018-08-21 23:26:58 -0400645}
646
David Tolnaya7d69fc2018-08-26 13:30:24 -0400647impl<T: Parse> Parse for Box<T> {
648 fn parse(input: ParseStream) -> Result<Self> {
649 input.parse().map(Box::new)
650 }
651}
652
David Tolnay4fb71232018-08-25 23:14:50 -0400653impl<T: Parse + Token> Parse for Option<T> {
David Tolnay18c754c2018-08-21 23:26:58 -0400654 fn parse(input: ParseStream) -> Result<Self> {
David Tolnay00f81fd2018-09-01 10:50:12 -0700655 if T::peek(input.cursor()) {
David Tolnay4fb71232018-08-25 23:14:50 -0400656 Ok(Some(input.parse()?))
657 } else {
658 Ok(None)
David Tolnay18c754c2018-08-21 23:26:58 -0400659 }
David Tolnay18c754c2018-08-21 23:26:58 -0400660 }
661}
David Tolnay4ac232d2018-08-31 10:18:03 -0700662
David Tolnay80a914f2018-08-30 23:49:53 -0700663impl Parse for TokenStream {
664 fn parse(input: ParseStream) -> Result<Self> {
665 input.step(|cursor| Ok((cursor.token_stream(), Cursor::empty())))
666 }
667}
668
669impl Parse for TokenTree {
670 fn parse(input: ParseStream) -> Result<Self> {
671 input.step(|cursor| match cursor.token_tree() {
672 Some((tt, rest)) => Ok((tt, rest)),
673 None => Err(cursor.error("expected token tree")),
674 })
675 }
676}
677
678impl Parse for Group {
679 fn parse(input: ParseStream) -> Result<Self> {
680 input.step(|cursor| {
681 for delim in &[Delimiter::Parenthesis, Delimiter::Brace, Delimiter::Bracket] {
682 if let Some((inside, span, rest)) = cursor.group(*delim) {
683 let mut group = Group::new(*delim, inside.token_stream());
684 group.set_span(span);
685 return Ok((group, rest));
686 }
687 }
688 Err(cursor.error("expected group token"))
689 })
690 }
691}
692
693impl Parse for Punct {
694 fn parse(input: ParseStream) -> Result<Self> {
695 input.step(|cursor| match cursor.punct() {
696 Some((punct, rest)) => Ok((punct, rest)),
697 None => Err(cursor.error("expected punctuation token")),
698 })
699 }
700}
701
702impl Parse for Literal {
703 fn parse(input: ParseStream) -> Result<Self> {
704 input.step(|cursor| match cursor.literal() {
705 Some((literal, rest)) => Ok((literal, rest)),
706 None => Err(cursor.error("expected literal token")),
707 })
708 }
709}
710
711/// Parser that can parse Rust tokens into a particular syntax tree node.
712///
713/// Refer to the [module documentation] for details about parsing in Syn.
714///
715/// [module documentation]: index.html
716///
717/// *This trait is available if Syn is built with the `"parsing"` feature.*
718pub trait Parser: Sized {
719 type Output;
720
721 /// Parse a proc-macro2 token stream into the chosen syntax tree node.
722 fn parse2(self, tokens: TokenStream) -> Result<Self::Output>;
723
724 /// Parse tokens of source code into the chosen syntax tree node.
725 ///
726 /// *This method is available if Syn is built with both the `"parsing"` and
727 /// `"proc-macro"` features.*
728 #[cfg(all(
729 not(all(target_arch = "wasm32", target_os = "unknown")),
730 feature = "proc-macro"
731 ))]
732 fn parse(self, tokens: proc_macro::TokenStream) -> Result<Self::Output> {
733 self.parse2(proc_macro2::TokenStream::from(tokens))
734 }
735
736 /// Parse a string of Rust code into the chosen syntax tree node.
737 ///
738 /// # Hygiene
739 ///
740 /// Every span in the resulting syntax tree will be set to resolve at the
741 /// macro call site.
742 fn parse_str(self, s: &str) -> Result<Self::Output> {
743 self.parse2(proc_macro2::TokenStream::from_str(s)?)
744 }
745}
746
David Tolnay7b07aa12018-09-01 11:41:12 -0700747fn tokens_to_parse_buffer(tokens: &TokenBuffer) -> ParseBuffer {
748 let scope = Span::call_site();
749 let cursor = tokens.begin();
750 let unexpected = Rc::new(Cell::new(None));
751 private::new_parse_buffer(scope, cursor, unexpected)
752}
753
David Tolnay80a914f2018-08-30 23:49:53 -0700754impl<F, T> Parser for F
755where
756 F: FnOnce(ParseStream) -> Result<T>,
757{
758 type Output = T;
759
760 fn parse2(self, tokens: TokenStream) -> Result<T> {
761 let buf = TokenBuffer::new2(tokens);
David Tolnay7b07aa12018-09-01 11:41:12 -0700762 let state = tokens_to_parse_buffer(&buf);
David Tolnay80a914f2018-08-30 23:49:53 -0700763 let node = self(&state)?;
764 state.check_unexpected()?;
765 if state.is_empty() {
766 Ok(node)
767 } else {
768 Err(state.error("unexpected token"))
769 }
770 }
771}