denumic/lib.rs
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
use proc_macro::TokenStream;
use quote::quote;
use syn::{parse_macro_input, Error, Item, ItemEnum, ItemTrait, Path};
mod r#impl;
mod uid;
mod utils;
/// # Create enum-based runtime dispatched traits.
///
/// When applied to a `trait`, it exports the definition of the trait that would be passed to other `denumic` attributes on `enum`s.
///
/// When applied to an `enum`, it generates a macro that can be used to dispatch to the appropriate implementation of the trait for each variant of the `enum`.
///
/// `From` and `TryFrom` are also automatically implemented for the `enum`, as long as it does not break coherence rules, so that it can be converted to and from the variants.
///
/// # Example
///
/// ```rust
/// use denumic::denumic;
///
/// // Generic parameters of the trait and the enum could be finly merged matching by names.
/// #[denumic]
/// pub trait Trait {
/// const MY_CONST: i32;
/// type MyType;
/// fn foo(self) -> i32;
/// }
///
/// // Note that the identifiers `used` before the trait definition also have to be `use`d before the enum definition.
/// #[denumic(Trait)]
/// // Associated types and consts can be specified using attributes:
/// #[MY_CONST = 1]
/// // As for types that are not a valid `expr`, quote them instead of raw types:
/// #[MyType = "&'static str"]
/// pub enum Impl<Other = ()>
/// where
/// Other: Trait,
/// {
/// // `From` and `TryFrom` are only generated if the enum has only a single field.
/// A(A),
/// // If multiple fields are found, the one with `#[denumic]` otherwise the first one is dispatched.
/// Other(Other, String),
/// }
///
/// pub struct A;
///
/// impl Trait for A {
/// const MY_CONST: i32 = 2;
///
/// type MyType = ();
///
/// fn foo(self) -> i32 {
/// 10
/// }
/// }
///
/// impl Trait for () {
/// const MY_CONST: i32 = 0;
///
/// type MyType = String;
///
/// fn foo(self) -> i32 {
/// 20
/// }
/// }
///
/// fn call_foo(v: A) -> i32 {
/// let v: Impl = v.into();
/// v.foo()
/// }
///
/// ```
#[proc_macro_attribute]
pub fn denumic(attr: TokenStream, item: TokenStream) -> TokenStream {
let i = parse_macro_input!(item as Item);
match i {
Item::Trait(item) => on_trait(attr, item),
Item::Enum(item) => on_enum(attr, item),
_ => syn::Error::new_spanned(i, "`denumic` macro can only be applied to traits or enums")
.into_compile_error()
.into(),
}
}
fn on_trait(attr: TokenStream, i: ItemTrait) -> TokenStream {
if !attr.is_empty() {
return syn::Error::new_spanned(
proc_macro2::TokenStream::from(attr),
"Arguments are not allowed for denumic macro",
)
.into_compile_error()
.into();
}
let macro_id = uid::uid(&i);
let id = &i.ident;
let vis = &i.vis;
quote! {
#i
#[macro_export]
#[doc(hidden)]
macro_rules! #macro_id {
($tr:path,$($ty:tt)*) => {
#[::denumic::denumic_impl($tr #i)]
$($ty)*
};
}
#vis use #macro_id as #id;
}
.into()
}
fn on_enum(attr: TokenStream, i: ItemEnum) -> TokenStream {
let id = parse_macro_input!(attr as Path);
quote! {
#id!(#id, #i);
}
.into()
}
#[proc_macro_attribute]
#[doc(hidden)]
pub fn denumic_impl(args: TokenStream, item: TokenStream) -> TokenStream {
let tr = parse_macro_input!(args);
let ty = parse_macro_input!(item);
r#impl::handle(tr, ty)
.unwrap_or_else(Error::into_compile_error)
.into()
}