Skip to main content

prns_macros/
lib.rs

1#![no_std]
2#![forbid(unsafe_code)]
3#![doc = "Dependency-free macros shared across the project"]
4
5/// Declares a unit-only enum whose declaration is also the source of its complete `ALL` inventory.
6///
7/// `ALL` inherits the enum's visibility unless a trailing declaration overrides it or attaches
8/// attributes.
9///
10/// ```
11/// prns_macros::iterable_enum! {
12///     #[derive(Debug, Clone, Copy, PartialEq, Eq)]
13///     enum State {
14///         Waiting,
15///         Running,
16///     }
17/// }
18///
19/// assert_eq!(State::ALL, [State::Waiting, State::Running]);
20/// ```
21///
22/// ```
23/// prns_macros::iterable_enum! {
24///     pub enum TestState {
25///         Waiting,
26///         Running,
27///     }
28///     #[cfg(test)]
29///     pub(crate) const ALL;
30/// }
31/// ```
32#[macro_export]
33macro_rules! iterable_enum {
34    (
35        @emit
36        $(#[$enum_attribute:meta])*
37        $enum_visibility:vis enum $name:ident {
38            $(
39                $(#[$variant_attribute:meta])*
40                $variant:ident $(= $discriminant:expr)?
41            ),+ $(,)?
42        }
43        $(#[$all_attribute:meta])*
44        $all_visibility:vis const ALL;
45    ) => {
46        $(#[$enum_attribute])*
47        $enum_visibility enum $name {
48            $(
49                $(#[$variant_attribute])*
50                $variant $(= $discriminant)?,
51            )+
52        }
53
54        impl $name {
55            $(#[$all_attribute])*
56            $all_visibility const ALL: [Self; $crate::iterable_enum!(@count $($variant),+)] =
57                [$(Self::$variant),+];
58        }
59    };
60    (
61        $(#[$enum_attribute:meta])*
62        $enum_visibility:vis enum $name:ident {
63            $(
64                $(#[$variant_attribute:meta])*
65                $variant:ident $(= $discriminant:expr)?
66            ),+ $(,)?
67        }
68        $(#[$all_attribute:meta])*
69        $all_visibility:vis const ALL;
70    ) => {
71        $crate::iterable_enum! {
72            @emit
73            $(#[$enum_attribute])*
74            $enum_visibility enum $name {
75                $(
76                    $(#[$variant_attribute])*
77                    $variant $(= $discriminant)?,
78                )+
79            }
80            $(#[$all_attribute])*
81            $all_visibility const ALL;
82        }
83    };
84    (
85        $(#[$enum_attribute:meta])*
86        $enum_visibility:vis enum $name:ident {
87            $(
88                $(#[$variant_attribute:meta])*
89                $variant:ident $(= $discriminant:expr)?
90            ),+ $(,)?
91        }
92    ) => {
93        $crate::iterable_enum! {
94            @emit
95            $(#[$enum_attribute])*
96            $enum_visibility enum $name {
97                $(
98                    $(#[$variant_attribute])*
99                    $variant $(= $discriminant)?,
100                )+
101            }
102            $enum_visibility const ALL;
103        }
104    };
105    (@count $($variant:ident),+) => {
106        <[()]>::len(&[$($crate::iterable_enum!(@unit $variant)),+])
107    };
108    (@unit $variant:ident) => { () };
109}