/// Quasi-quotation macro that accepts input like the [`quote!`] macro but uses /// type inference to figure out a return type for those tokens. /// /// [`quote!`]: https://docs.rs/quote/1.0/quote/index.html /// /// The return type can be any syntax tree node that implements the [`Parse`] /// trait. /// /// [`Parse`]: crate::parse::Parse /// /// ``` /// use quote::quote; /// use syn::{parse_quote, Stmt}; /// /// fn main() { /// let name = quote!(v); /// let ty = quote!(u8); /// /// let stmt: Stmt = parse_quote! { /// let #name: #ty = Default::default(); /// }; /// /// println!("{:#?}", stmt); /// } /// ``` /// /// *This macro is available only if Syn is built with the `"parsing"` feature, /// although interpolation of syntax tree nodes into the quoted tokens is only /// supported if Syn is built with the `"printing"` feature as well.* /// /// # Example /// /// The following helper function adds a bound `T: HeapSize` to every type /// parameter `T` in the input generics. /// /// ``` /// use syn::{parse_quote, Generics, GenericParam}; /// /// // Add a bound `T: HeapSize` to every type parameter T. /// fn add_trait_bounds(mut generics: Generics) -> Generics { /// for param in &mut generics.params { /// if let GenericParam::Type(type_param) = param { /// type_param.bounds.push(parse_quote!(HeapSize)); /// } /// } /// generics /// } /// ``` /// /// # Special cases /// /// This macro can parse the following additional types as a special case even /// though they do not implement the `Parse` trait. /// /// - [`Attribute`] — parses one attribute, allowing either outer like `#[...]` /// or inner like `#![...]` /// - [`Punctuated`] — parses zero or more `T` separated by punctuation /// `P` with optional trailing punctuation /// - [`Vec`] — parses the same as `Block::parse_within` /// /// [`Vec`]: Block::parse_within /// /// # Panics /// /// Panics if the tokens fail to parse as the expected syntax tree type. The /// caller is responsible for ensuring that the input tokens are syntactically /// valid. #[cfg_attr(doc_cfg, doc(cfg(all(feature = "parsing", feature = "printing"))))] #[macro_export] macro_rules! parse_quote { ($($tt:tt)*) => { $crate::parse_quote::parse($crate::__private::quote::quote!($($tt)*)) }; } /// This macro is [`parse_quote!`] + [`quote_spanned!`][quote::quote_spanned]. /// /// Please refer to each of their documentation. /// /// # Example /// /// ``` /// use quote::{quote, quote_spanned}; /// use syn::spanned::Spanned; /// use syn::{parse_quote_spanned, ReturnType, Signature}; /// /// // Changes `fn()` to `fn() -> Pin>>`, /// // and `fn() -> T` to `fn() -> Pin>>`, /// // without introducing any call_site() spans. /// fn make_ret_pinned_future(sig: &mut Signature) { /// let ret = match &sig.output { /// ReturnType::Default => quote_spanned!(sig.paren_token.span=> ()), /// ReturnType::Type(_, ret) => quote!(#ret), /// }; /// sig.output = parse_quote_spanned! {ret.span()=> /// -> ::std::pin::Pin<::std::boxed::Box>> /// }; /// } /// ``` #[cfg_attr(doc_cfg, doc(cfg(all(feature = "parsing", feature = "printing"))))] #[macro_export] macro_rules! parse_quote_spanned { ($span:expr=> $($tt:tt)*) => { $crate::parse_quote::parse($crate::__private::quote::quote_spanned!($span=> $($tt)*)) }; } //////////////////////////////////////////////////////////////////////////////// // Can parse any type that implements Parse. use crate::parse::{Parse, ParseStream, Parser, Result}; use proc_macro2::TokenStream; // Not public API. #[doc(hidden)] pub fn parse(token_stream: TokenStream) -> T { let parser = T::parse; match parser.parse2(token_stream) { Ok(t) => t, Err(err) => panic!("{}", err), } } // Not public API. #[doc(hidden)] pub trait ParseQuote: Sized { fn parse(input: ParseStream) -> Result; } impl ParseQuote for T { fn parse(input: ParseStream) -> Result { ::parse(input) } } //////////////////////////////////////////////////////////////////////////////// // Any other types that we want `parse_quote!` to be able to parse. use crate::punctuated::Punctuated; #[cfg(any(feature = "full", feature = "derive"))] use crate::{attr, Attribute}; #[cfg(feature = "full")] use crate::{Block, Stmt}; #[cfg(any(feature = "full", feature = "derive"))] impl ParseQuote for Attribute { fn parse(input: ParseStream) -> Result { if input.peek(Token![#]) && input.peek2(Token![!]) { attr::parsing::single_parse_inner(input) } else { attr::parsing::single_parse_outer(input) } } } impl ParseQuote for Punctuated { fn parse(input: ParseStream) -> Result { Self::parse_terminated(input) } } #[cfg(feature = "full")] impl ParseQuote for Vec { fn parse(input: ParseStream) -> Result { Block::parse_within(input) } }