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
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
#![allow(unknown_lints)]
#![warn(bare_trait_objects)]
#![warn(clippy)]

#![cfg_attr(not(feature = "std"), no_std)]

//! Generate your Yes/No enum with gen_boolean_enum!:
//! ```
//! # #[macro_use] extern crate boolean_enums;
//! #
//! gen_boolean_enum!(MyEnum);
//! #
//! # fn main() {}
//! ```
//!
//! It's From<bool> and Into<bool> and Not:
//! ```
//! # #[macro_use] extern crate boolean_enums;
//! #
//! # gen_boolean_enum!(MyEnum);
//! #
//! # fn main() {
//! let flag = MyEnum::Yes;
//! let oflag = true.into();
//! assert_eq!(flag, oflag);
//!
//! if (!flag).into() {
//!     unreachable!()
//! }
//! # }
//! ```
//!
//! To generate a public enum, you need to append **pub** to
//! the macro arguments:
//! ```
//! # #[macro_use] extern crate boolean_enums;
//! #
//! gen_boolean_enum!(pub MyEnum);
//! #
//! # fn main() {}
//! ```
//!
//! You can serialize and deserialize it with serde like a normal bool
//! (enabled by the "serde" feature).  For that, specify **serde**
//! before the enum name in gen_boolean_enum!:
//! ```rust
//! #[macro_use] extern crate boolean_enums;
//!
//! # #[cfg(feature = "serde")]
//! # {
//! extern crate toml; // as an example serde format
//!
//! gen_boolean_enum!(serde MyEnum);
//! // or gen_boolean_enum!(pub serde MyEnum);
//!
//! #[derive(Debug, Deserialize, Eq, PartialEq, Serialize)]
//! struct SomeStruct {
//!     flag: MyEnum
//! }
//!
//! // …
//!
//! let first = SomeStruct {
//!     flag: MyEnum::Yes
//! };
//! let string = toml::ser::to_string(&first).unwrap();
//! let second: SomeStruct = toml::de::from_str(&string).unwrap();
//!
//! assert_eq!(first, second);
//! # }
//! ```
//!
//! You can use boolean-enums in no_std crates by disabling the default "std"
//! feature:
//! ```toml,ignore
//! [dependencies.boolean-enums]
//! version = "^0.3.0"
//! default-features = false
//! ```
//!
//! # Examples
//! ```
//! #[macro_use] extern crate boolean_enums;
//!
//! gen_boolean_enum!(First);
//! gen_boolean_enum!(Second);
//! gen_boolean_enum!(Third);
//!
//! fn do_smth(flag1: First, flag2: Second, flag3: Third) {
//!     // …
//! }
//!
//! fn main() {
//!     let first = First::Yes;
//!     let second = Second::No;
//!     let third = Third::Yes;
//!
//!     do_smth(first, second, third);
//! }
//! ```
//! That compiles perfectly, but
//! ```rust,compile_fail
//! # #[macro_use] extern crate boolean_enums;
//! #
//! # gen_boolean_enum!(First);
//! # gen_boolean_enum!(Second);
//! # gen_boolean_enum!(Third);
//! #
//! # fn do_smth(flag1: First, flag2: Second, flag3: Third) {
//! #     // …
//! # }
//! #
//! # fn main() {
//! #     let first = First::Yes;
//! #     let second = Second::No;
//! #     let third = Third::Yes;
//! #
//! do_smth(first, third, second);
//! # }
//! ```
//! fails to compile.

#[cfg(feature = "serde")]
extern crate serde;

#[cfg(feature = "std")]
pub mod lstd {
    pub use std::*;
}

#[cfg(not(feature = "std"))]
pub mod lstd {
    pub use core::*;
}

#[cfg(feature = "serde")]
#[doc(hidden)]
pub use serde::*;

/// Generates enum with Yes and No variants.
///
/// # Examples
///
/// ```
/// # #[macro_use] extern crate boolean_enums;
/// #
/// gen_boolean_enum!(DoX);
///
/// // …
///
/// # fn main() {
/// let flag = DoX::Yes;
/// let mut other_flag = DoX::No;
///
/// if flag.into() {
///     other_flag = true.into();
/// }
///
/// assert_eq!(other_flag, DoX::Yes);
/// # }
/// ```
#[macro_export]
macro_rules! gen_boolean_enum {
    ($name:ident) => (
        _gen_boolean_enum_gen_enum!($name);
        _gen_boolean_enum_common!($name);
    );

    (pub $name:ident) => (
        _gen_boolean_enum_gen_enum!(pub $name);
        _gen_boolean_enum_common!($name);
    );

    (serde $name:ident) => (
        _gen_boolean_enum_gen_enum!(pub $name);
        _gen_boolean_enum_common!($name);
        _gen_boolean_enum_serde!($name);
    );

    (pub serde $name:ident) => (
        _gen_boolean_enum_gen_enum!(pub $name);
        _gen_boolean_enum_common!($name);
        _gen_boolean_enum_serde!($name);
    );

    (serde pub $name:ident) => (
        gen_boolean_enum!(pub serde $name);
    )
}

#[doc(hidden)]
#[macro_export]
macro_rules! _gen_boolean_enum_common {
    ($name:ident) => (
        impl From<bool> for $name {
            fn from(x: bool) -> Self {
                if x {
                    $name::Yes
                } else {
                    $name::No
                }
            }
        }

        impl Into<bool> for $name {
            fn into(self) -> bool {
                match self {
                    $name::Yes => true,
                    $name::No => false
                }
            }
        }

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

        impl $crate::lstd::ops::Not for $name {
            type Output = Self;
            fn not(self) -> Self::Output {
                if self.into() {
                    $name::No
                } else {
                    $name::Yes
                }
            }
        }
    )
}

#[doc(hidden)]
#[macro_export]
macro_rules! _gen_boolean_enum_gen_enum {
    ($name:ident) => (
        #[derive(Clone, Copy, Debug, Eq, PartialEq)]
        enum $name {
            Yes,
            No
        }
    );
    (pub $name:ident) => (
        #[derive(Clone, Copy, Debug, Eq, PartialEq)]
        pub enum $name {
            Yes,
            No
        }
    );
}

#[cfg(not(feature = "serde"))]
#[doc(hidden)]
#[macro_export]
macro_rules! _gen_boolean_enum_serde {
    ( $( $t:tt )* ) => (
        compile_error!("the \"serde\" feature is not enabled");
    )
}

#[cfg(feature = "serde")]
#[doc(hidden)]
#[macro_export]
macro_rules! _gen_boolean_enum_serde {
    ($name:ident) => (
        impl $crate::Serialize for $name {
            fn serialize<S>(
                &self,
                serializer: S
            ) -> $crate::lstd::result::Result<S::Ok, S::Error>
            where S: $crate::Serializer {
                serializer.serialize_bool((*self).into())
            }
        }

        impl<'de> $crate::Deserialize<'de> for $name {
            fn deserialize<D>(
                deserializer: D
            ) -> $crate::lstd::result::Result<$name, D::Error>
            where D: $crate::Deserializer<'de> {
                struct BooleanEnumVisitor;

                impl<'de> $crate::de::Visitor<'de>
                        for BooleanEnumVisitor {
                    type Value = $name;

                    fn expecting(
                        &self,
                        formatter: &mut $crate::lstd::fmt::Formatter
                    ) -> $crate::lstd::fmt::Result {
                        formatter.write_str("a boolean value")
                    }

                    fn visit_bool<E>(
                        self,
                        value: bool
                    ) -> $crate::lstd::result::Result<Self::Value, E>
                    where E: $crate::de::Error {
                        Ok($name::from(value))
                    }
                }

                deserializer.deserialize_bool(BooleanEnumVisitor)
            }
        }
    )
}