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

use proc_macro::TokenStream;
use syn::{parse_macro_input, DeriveInput};

#[macro_use]
mod error;
mod derive;

/// Proc. macro to derive the `EnumTag` trait for the given Rust `enum`.
///
/// This proc. macro only works on Rust `enum` types and creates a C-like
/// `enum` with the same variants as the input Rust `enum` without all the
/// associated data.
/// Also it derives an implementation of `EnumTag` for the Rust `enum` that
/// makes it possible to create instances of the generated C-like `enum` as
/// well as link to its identifier via `<RustEnum as EnumTag>::Tag`.
///
/// # Example
///
/// ```
/// use enum_tag::EnumTag;
///
/// #[derive(EnumTag)]
/// #[repr(u8)] // Rust needs this for `B = 42`
/// enum Foo {
///     A,
///     B = 42,
///     C(i32),
///     D(i32, i64),
///     E { a: i32 },
///     F { a: i32, b: i64 },
/// }
///
/// /// This is how we can access the generated C-like enum type and name it.
/// type FooTag = <Foo as EnumTag>::Tag;
///
/// assert_eq!(FooTag::A, Foo::A.tag());
/// assert_eq!(FooTag::B, Foo::B.tag());
/// assert_eq!(FooTag::C, Foo::C(1).tag());
/// assert_eq!(FooTag::D, Foo::D(2, 3).tag());
/// assert_eq!(FooTag::E, Foo::E { a: 4 }.tag());
/// assert_eq!(FooTag::F, Foo::F { a: 5, b: 6 }.tag());
///
/// assert_eq!(FooTag::B as u8, 42);
/// ```
///
/// The above `#[derive(EnumTag)]` proc. macro will expand to roughly the following Rust code:
///
/// ```
/// # #[repr(u8)] // Rust needs this for `B = 42`
/// # enum Foo {
/// #     A,
/// #     B = 42,
/// #     C(i32),
/// #     D(i32, i64),
/// #     E { a: i32 },
/// #     F { a: i32, b: i64 },
/// # }
/// #
/// const _: () = {
///     #[derive(
///         ::core::fmt::Debug,
///         ::core::clone::Clone,
///         ::core::marker::Copy,
///         ::core::cmp::PartialEq,
///         ::core::cmp::Eq,
///         ::core::cmp::PartialOrd,
///         ::core::cmp::Ord,
///         ::core::hash::Hash,
///     )]
///     pub enum FooTag {
///         A,
///         B = 42,
///         C,
///         D,
///         E,
///         F,
///     }
///
///     impl ::enum_tag::EnumTag for Foo {
///         type Tag = FooTag;
///
///         fn tag(&self) -> <Self as ::enum_tag::EnumTag>::Tag {
///             match self {
///                 Self::A { .. } => <Self as ::enum_tag::EnumTag>::Tag::A,
///                 Self::B { .. } => <Self as ::enum_tag::EnumTag>::Tag::B,
///                 Self::C { .. } => <Self as ::enum_tag::EnumTag>::Tag::C,
///                 Self::D { .. } => <Self as ::enum_tag::EnumTag>::Tag::D,
///                 Self::E { .. } => <Self as ::enum_tag::EnumTag>::Tag::E,
///                 Self::F { .. } => <Self as ::enum_tag::EnumTag>::Tag::F,
///             }
///         }
///     }
/// };
/// ```
#[proc_macro_derive(EnumTag)]
pub fn enum_tag(input: TokenStream) -> TokenStream {
    derive::enum_tag(parse_macro_input!(input as DeriveInput)).into()
}