enso-shapely 0.1.4

//! This module defines helpers for defining singletons and associated enum types. A singleton is
//! a type with one possible value. It is used mainly for a type level programming purposes.

/// Defines singleton types. For the following input:
/// ```compile_fail
/// define_singletons!{
///     /// A Foo!
///     Foo,
///     /// A Bar!
///     Bar,
/// }
/// ```
///
/// It expands to:
///
/// ```
/// #[allow(missing_docs)]
/// #[derive(Copy, Clone, Debug)]
/// #[doc = r###"A Foo!"###]
/// pub struct Foo;
/// impl Default for Foo {
///     fn default() -> Self {
///         Self
///     }
/// }
/// #[allow(missing_docs)]
/// #[derive(Copy, Clone, Debug)]
/// #[doc = r###"A Bar!"###]
/// pub struct Bar;
/// impl Default for Bar {
///     fn default() -> Self {
///         Self
///     }
/// }
///
/// ```
#[macro_export]
macro_rules! define_singletons {
    ( $( $(#$meta:tt)* $name:ident ),* $(,)? ) => {$(
        #[allow(missing_docs)]
        #[derive(Copy,Clone,Debug,PartialEq,Eq)]
        $(#$meta)*
        pub struct $name;

        impl Default for $name {
            fn default() -> Self {
                Self
            }
        }
    )*}
}

/// Defines an associated enum type for predefined singletons.
///
/// For the following input:
/// ```compile_fail
/// define_singleton_enum!{
///     MyEnum {
///         /// A Foo!
///         Foo,
///         /// A Bar!
///         Bar,
///     }
/// }
/// ```
///
/// It expands to:
///
/// ```compile_fail
/// #[allow(missing_docs)]
/// #[derive(Copy, Clone, Debug)]
/// pub enum MyEnum {
///     #[doc = r###"A Foo!"###]
///     Foo,
///     #[doc = r###"A Bar!"###]
///     Bar,
/// }
/// impl From<Foo> for MyEnum {
///     fn from(_: Foo) -> Self {
///         Self::Foo
///     }
/// }
/// impl From<PhantomData<Foo>> for MyEnum {
///     fn from(_: PhantomData<Foo>) -> Self {
///         Self::Foo
///     }
/// }
/// impl From<Bar> for MyEnum {
///     fn from(_: Bar) -> Self {
///         Self::Bar
///     }
/// }
/// impl From<PhantomData<Bar>> for MyEnum {
///     fn from(_: PhantomData<Bar>) -> Self {
///         Self::Bar
///     }
/// }
/// ```
#[macro_export]
macro_rules! define_singleton_enum_from {
    (
        $(#$meta:tt)*
        $name:ident {
            $( $(#$field_meta:tt)* $field:ident ),* $(,)?
        }
    ) => {
        #[allow(missing_docs)]
        #[derive(Copy,Clone,Debug,PartialEq,Eq)]
        $(#$meta)*
        pub enum $name {
            $( $(#$field_meta)* $field ),*
        }

        $(
            impl From<$field> for $name {
                fn from(_:$field) -> Self {
                    Self::$field
                }
            }

            impl From<PhantomData<$field>> for $name {
                fn from(_:PhantomData<$field>) -> Self {
                    Self::$field
                }
            }
        )*
    }
}

/// Defines singletons and an associated enum type.
/// It expands to the same as `define_singletons` and `define_singleton_enum_from`.
#[macro_export]
macro_rules! define_singleton_enum {
    (
        $(#$meta:tt)*
        $name:ident {
            $( $(#$field_meta:tt)* $field:ident ),* $(,)?
        }
    ) => {
        $crate::define_singletons!          { $($(#$field_meta)* $field),* }
        $crate::define_singleton_enum_from! { $(#$meta)* $name {$($(#$field_meta)* $field),*}}
    }
}