1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230
//! A procedural macro helper for easily writing [derives macros][proc-macro-derive] for enums.
//!
//! # Examples
//!
//! [`quick_derive!`] macro make easy to write [`proc_macro_derive`][proc-macro-derive]
//! like deriving trait to enum so long as all variants are implemented that trait.
//!
//! ```rust
//! # extern crate proc_macro;
//! #
//! use derive_utils::quick_derive;
//! use proc_macro::TokenStream;
//!
//! # #[cfg(any())]
//! #[proc_macro_derive(Iterator)]
//! # pub fn _derive_iterator(_: TokenStream) -> TokenStream { unimplemented!() }
//! pub fn derive_iterator(input: TokenStream) -> TokenStream {
//! quick_derive! {
//! input,
//! // trait path
//! std::iter::Iterator,
//! // trait definition
//! trait Iterator {
//! type Item;
//! fn next(&mut self) -> Option<Self::Item>;
//! fn size_hint(&self) -> (usize, Option<usize>);
//! }
//! }
//! }
//!
//! # #[cfg(any())]
//! #[proc_macro_derive(ExactSizeIterator)]
//! # pub fn _derive_exact_size_iterator(_: TokenStream) -> TokenStream { unimplemented!() }
//! pub fn derive_exact_size_iterator(input: TokenStream) -> TokenStream {
//! quick_derive! {
//! input,
//! // trait path
//! std::iter::ExactSizeIterator,
//! // super trait's associated types
//! <Item>,
//! // trait definition
//! trait ExactSizeIterator: Iterator {
//! fn len(&self) -> usize;
//! }
//! }
//! }
//!
//! # #[cfg(any())]
//! #[proc_macro_derive(Future)]
//! # pub fn _derive_future(_: TokenStream) -> TokenStream { unimplemented!() }
//! pub fn derive_future(input: TokenStream) -> TokenStream {
//! quick_derive! {
//! input,
//! // trait path
//! std::future::Future,
//! // trait definition
//! trait Future {
//! type Output;
//! fn poll(
//! self: std::pin::Pin<&mut Self>,
//! cx: &mut std::task::Context<'_>,
//! ) -> std::task::Poll<Self::Output>;
//! }
//! }
//! }
//! ```
//!
//! ### Generated code
//!
//! When deriving for enum like the following:
//!
//! ```rust
//! # #[cfg(any())]
//! #[derive(Iterator, ExactSizeIterator, Future)]
//! # struct _Enum<A>(A);
//! enum Enum<A, B> {
//! A(A),
//! B(B),
//! }
//! ```
//!
//! Code like this will be generated:
//!
//! ```rust
//! enum Enum<A, B> {
//! A(A),
//! B(B),
//! }
//!
//! impl<A, B> std::iter::Iterator for Enum<A, B>
//! where
//! A: std::iter::Iterator,
//! B: std::iter::Iterator<Item = <A as std::iter::Iterator>::Item>,
//! {
//! type Item = <A as std::iter::Iterator>::Item;
//! fn next(&mut self) -> Option<Self::Item> {
//! match self {
//! Enum::A(x) => x.next(),
//! Enum::B(x) => x.next(),
//! }
//! }
//! fn size_hint(&self) -> (usize, Option<usize>) {
//! match self {
//! Enum::A(x) => x.size_hint(),
//! Enum::B(x) => x.size_hint(),
//! }
//! }
//! }
//!
//! impl<A, B> std::iter::ExactSizeIterator for Enum<A, B>
//! where
//! A: std::iter::ExactSizeIterator,
//! B: std::iter::ExactSizeIterator<Item = <A as Iterator>::Item>,
//! {
//! fn len(&self) -> usize {
//! match self {
//! Enum::A(x) => x.len(),
//! Enum::B(x) => x.len(),
//! }
//! }
//! }
//!
//! impl<A, B> std::future::Future for Enum<A, B>
//! where
//! A: std::future::Future,
//! B: std::future::Future<Output = <A as std::future::Future>::Output>,
//! {
//! type Output = <A as std::future::Future>::Output;
//! fn poll(
//! self: std::pin::Pin<&mut Self>,
//! cx: &mut std::task::Context<'_>,
//! ) -> std::task::Poll<Self::Output> {
//! unsafe {
//! match self.get_unchecked_mut() {
//! Enum::A(x) => std::pin::Pin::new_unchecked(x).poll(cx),
//! Enum::B(x) => std::pin::Pin::new_unchecked(x).poll(cx),
//! }
//! }
//! }
//! }
//! ```
//!
//! [proc-macro-derive]: https://doc.rust-lang.org/reference/procedural-macros.html#derive-macros
#![doc(test(
no_crate_inject,
attr(
deny(warnings, rust_2018_idioms, single_use_lifetimes),
allow(dead_code, unused_variables)
)
))]
#![forbid(unsafe_code)]
#![warn(future_incompatible, rust_2018_idioms, single_use_lifetimes, unreachable_pub)]
#![warn(clippy::all, clippy::default_trait_access)]
#[macro_use]
mod utils;
mod ast;
mod parse;
pub use crate::{
ast::EnumData,
parse::{derive_trait, EnumImpl},
};
/// A macro for making easy to write `proc_macro_derive` like deriving trait to
/// enum so long as all variants are implemented that trait.
///
/// See crate level documentation for details.
#[macro_export]
macro_rules! quick_derive {
($input:expr, $trait_path:expr, <$super:ident>, $trait_def:item $(,)*) => {
$crate::__private::parse_input($input, |data| {
$crate::derive_trait(
&data,
$crate::__private::parse_quote!($trait_path),
$crate::__private::Some($crate::__private::format_ident!(stringify!($super))),
$crate::__private::parse_quote!($trait_def),
)
})
.into()
};
// TODO: $(,)? requires Rust 1.32.
($input:expr, $trait_path:expr, <$($super:ident),+ $(,)*>, $trait_def:item $(,)*) => {
$crate::__private::parse_input($input, |data| {
$crate::derive_trait(
&data,
$crate::__private::parse_quote!($trait_path),
vec![$( $crate::__private::format_ident!(stringify!($super)) ),+],
$crate::__private::parse_quote!($trait_def),
)
})
.into()
};
($input:expr, $trait_path:expr, $trait_def:item $(,)*) => {
$crate::__private::parse_input($input, |data| {
$crate::derive_trait(
&data,
$crate::__private::parse_quote!($trait_path),
$crate::__private::None,
$crate::__private::parse_quote!($trait_def),
)
})
.into()
};
}
// Not public API.
#[doc(hidden)]
pub mod __private {
#[doc(hidden)]
pub use quote::{format_ident, quote};
#[doc(hidden)]
pub use std::option::Option::{None, Some};
#[doc(hidden)]
pub use syn::{parse2, parse_quote, ItemTrait, Path};
use proc_macro2::TokenStream;
use crate::EnumData;
#[doc(hidden)]
pub fn parse_input(
input: impl Into<TokenStream>,
f: fn(EnumData) -> TokenStream,
) -> TokenStream {
parse2::<EnumData>(input.into()).map(f).unwrap_or_else(|e| e.to_compile_error())
}
}