Crate proc_macro_hack
source ·Expand description
As of Rust 1.30, the language supports user-defined function-like procedural macros. However these can only be invoked in item position, not in statements or expressions.
This crate implements an alternative type of procedural macro that can be invoked in statement or expression position.
Defining procedural macros
Two crates are required to define a procedural macro.
The implementation crate
This crate must contain nothing but procedural macros. Private helper functions and private modules are fine but nothing can be public.
> example of an implementation crate
Just like you would use a #[proc_macro] attribute to define a natively supported procedural macro, use proc-macro-hack’s #[proc_macro_hack] attribute to define a procedural macro that works in expression position. The function signature is the same as for ordinary function-like procedural macros.
extern crate proc_macro;
extern crate proc_macro_hack;
extern crate quote;
extern crate syn;
use proc_macro::TokenStream;
use proc_macro_hack::proc_macro_hack;
use quote::quote;
use syn::{parse_macro_input, Expr};
/// Add one to an expression.
#[proc_macro_hack]
pub fn add_one(input: TokenStream) -> TokenStream {
let expr = parse_macro_input!(input as Expr);
TokenStream::from(quote! {
1 + (#expr)
})
}
The declaration crate
This crate is allowed to contain other public things if you need, for example traits or functions or ordinary macros.
> example of a declaration crate
Within the declaration crate there needs to be a re-export of your procedural macro from the implementation crate. The re-export also carries a #[proc_macro_hack] attribute.
extern crate demo_hack_impl;
extern crate proc_macro_hack;
use proc_macro_hack::proc_macro_hack;
/// Add one to an expression.
#[proc_macro_hack]
pub use demo_hack_impl::add_one;
Both crates depend on proc-macro-hack
:
[dependencies]
proc-macro-hack = "0.5"
Additionally, your implementation crate (but not your declaration crate) is a proc macro crate:
[lib]
proc-macro = true
Using procedural macros
Users of your crate depend on your declaration crate (not your implementation crate), then use your procedural macros as usual.
> example of a downstream crate
extern crate demo_hack;
use demo_hack::add_one;
fn main() {
let two = 2;
let nine = add_one!(two) + add_one!(2 + 3);
println!("nine = {}", nine);
}