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
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
use crate::field::*;
use crate::*;

#[cfg(feature = "alloc")]
use alloc::format;
use core::fmt;

/// An enum-like [`Valuable`] sub-type.
///
/// Implemented by [`Valuable`] types that have an enum-like shape. Fields may
/// be named or unnamed (tuple). Values that implement `Enumerable` must return
/// [`Value::Enumerable`] from their [`Valuable::as_value`] implementation.
///
/// # Inspecting
///
/// The [`variant()`] method returns the `Enumerable` instance's variant. The
/// `Enumerable` may also have unnamed fields (tuple) or named fields.
/// Inspecting the field values is done by visiting the enum. When visiting an
/// `Enumerable`, either the [`visit_named_fields()`] or the
/// [`visit_unnamed_fields()`] methods of [`Visit`] are called. Each method may
/// be called multiple times per `Enumerable`, but the two methods are never
/// mixed.
///
/// [`variant()`]: Enumerable::variant
/// [`visit_named_fields()`]: Visit::visit_named_fields
/// [`visit_unnamed_fields()`]: Visit::visit_unnamed_fields
///
/// ```
/// use valuable::{Valuable, Value, Visit};
///
/// #[derive(Valuable)]
/// enum MyEnum {
///     Foo,
///     Bar(u32),
/// }
///
/// struct PrintVariant;
///
/// impl Visit for PrintVariant {
///     fn visit_unnamed_fields(&mut self, values: &[Value<'_>]) {
///         for value in values {
///             println!(" - {:?}", value);
///         }
///     }
///
///     fn visit_value(&mut self, value: Value<'_>) {
///         match value {
///             Value::Enumerable(v) => {
///                 println!("{}", v.variant().name());
///                 v.visit(self)
///             }
///             _ => {}
///         }
///     }
/// }
///
/// let my_enum = MyEnum::Bar(123);
///
/// valuable::visit(&my_enum, &mut PrintVariant);
/// ```
///
/// If the enum is **statically** defined, then all variants, and variant fields
/// are known ahead of time and may be accessed via the [`EnumDef`] instance
/// returned by [`definition()`].
///
/// [`definition()`]: Enumerable::definition
///
/// # Implementing
///
/// Implementing `Enumerable` is usually done by adding `#[derive(Valuable)]` to
/// a Rust `enum` definition.
///
/// ```
/// use valuable::{Valuable, Enumerable, EnumDef};
///
/// #[derive(Valuable)]
/// enum MyEnum {
///     Foo,
///     Bar(u32),
/// }
///
/// let my_enum = MyEnum::Bar(123);
///
/// let variants = match my_enum.definition() {
///     EnumDef::Static { name, variants, .. } => {
///         assert_eq!("MyEnum", name);
///         variants
///     }
///     _ => unreachable!(),
/// };
///
/// assert_eq!(2, variants.len());
/// assert_eq!("Foo", variants[0].name());
/// assert!(variants[0].fields().is_unnamed());
/// ```
pub trait Enumerable: Valuable {
    /// Returns the enum's definition.
    ///
    /// See [`EnumDef`] documentation for more details.
    ///
    /// # Examples
    ///
    /// ```
    /// use valuable::{Enumerable, Valuable};
    ///
    /// #[derive(Valuable)]
    /// enum MyEnum {
    ///     Foo,
    ///     Bar(u32),
    /// }
    ///
    /// let my_enum = MyEnum::Bar(123);
    ///
    /// assert_eq!("MyEnum", my_enum.definition().name());
    /// ```
    fn definition(&self) -> EnumDef<'_>;

    /// Returns the `enum`'s current variant.
    ///
    /// # Examples
    ///
    /// ```
    /// use valuable::{Enumerable, Valuable};
    ///
    /// #[derive(Valuable)]
    /// enum MyEnum {
    ///     Foo,
    ///     Bar(u32),
    /// }
    ///
    /// let my_enum = MyEnum::Foo;
    /// assert_eq!("Foo", my_enum.variant().name());
    /// ```
    fn variant(&self) -> Variant<'_>;
}

/// An enum's variants, variant fields, and other enum-level information.
///
/// Returned by [`Enumerable::definition()`], `EnumDef` provides the caller with
/// information about the enum's definition.
#[non_exhaustive]
#[derive(Debug)]
pub enum EnumDef<'a> {
    /// The enum is statically-defined, all variants and variant-level fields
    /// are known ahead of time.
    ///
    /// Most `Enumerable` definitions for Rust enum types will be
    /// `EnumDef::Static`.
    ///
    /// # Examples
    ///
    /// A statically defined enum
    ///
    /// ```
    /// use valuable::{Valuable, Enumerable, EnumDef};
    ///
    /// #[derive(Valuable)]
    /// enum MyEnum {
    ///     Foo,
    ///     Bar(u32),
    /// }
    ///
    /// let my_enum = MyEnum::Bar(123);
    ///
    /// let variants = match my_enum.definition() {
    ///     EnumDef::Static { name, variants, .. } => {
    ///         assert_eq!("MyEnum", name);
    ///         variants
    ///     }
    ///     _ => unreachable!(),
    /// };
    ///
    /// assert_eq!(2, variants.len());
    /// assert_eq!("Foo", variants[0].name());
    /// assert_eq!("Bar", variants[1].name());
    /// ```
    #[non_exhaustive]
    Static {
        /// The enum's name
        name: &'static str,

        /// The enum's variants
        variants: &'static [VariantDef<'static>],
    },

    /// The enum is dynamically-defined, not all variants and fields are known
    /// ahead of time.
    ///
    /// # Examples
    ///
    /// The enum variant is tracked as a string
    ///
    /// ```
    /// use valuable::{Enumerable, EnumDef, Fields, VariantDef, Valuable, Value, Variant, Visit};
    ///
    /// /// A dynamic enum
    /// struct DynEnum {
    ///     // The enum name
    ///     name: String,
    ///
    ///     // The current variant
    ///     variant: String,
    /// }
    ///
    /// impl Valuable for DynEnum {
    ///     fn as_value(&self) -> Value<'_> {
    ///         Value::Enumerable(self)
    ///     }
    ///
    ///     fn visit(&self, _visit: &mut dyn Visit) {
    ///         // No variant fields, so there is nothing to call here.
    ///     }
    /// }
    ///
    /// impl Enumerable for DynEnum {
    ///     fn definition(&self) -> EnumDef<'_> {
    ///         EnumDef::new_dynamic(&self.name, &[])
    ///     }
    ///
    ///     fn variant(&self) -> Variant<'_> {
    ///         Variant::Dynamic(VariantDef::new(&self.variant, Fields::Unnamed(0)))
    ///     }
    /// }
    /// ```
    #[non_exhaustive]
    Dynamic {
        /// The enum's name
        name: &'a str,

        /// The enum's variants
        variants: &'a [VariantDef<'a>],
    },
}

/// An enum variant definition.
///
/// Included with [`EnumDef`] returned by [`Enumerable::definition()`],
/// `VariantDef` provides the caller with information about a specific variant.
#[derive(Debug)]
pub struct VariantDef<'a> {
    /// Variant name
    name: &'a str,

    /// Variant fields
    fields: Fields<'a>,
}

/// An enum variant
///
/// Returned by [`Enumerable::variant()`], `Variant` represents a single enum
/// variant.
#[derive(Debug)]
pub enum Variant<'a> {
    /// The variant is statically defined by the associated enum.
    Static(&'static VariantDef<'static>),

    /// The variant is dynamically defined and not included as part of
    /// [`Enumerable::definition()`].
    Dynamic(VariantDef<'a>),
}

impl<'a> EnumDef<'a> {
    /// Create a new [`EnumDef::Static`] instance.
    ///
    /// This should be used when an enum's variants are fixed and known ahead of
    /// time.
    ///
    /// # Examples
    ///
    /// ```
    /// use valuable::{EnumDef, Fields, VariantDef};
    ///
    /// static VARIANTS: &[VariantDef<'static>] = &[
    ///     VariantDef::new("Bar", Fields::Unnamed(1)),
    /// ];
    ///
    /// let def = EnumDef::new_static( "Foo", VARIANTS);
    /// ```
    pub const fn new_static(
        name: &'static str,
        variants: &'static [VariantDef<'static>],
    ) -> EnumDef<'a> {
        EnumDef::Static { name, variants }
    }

    /// Create a new [`EnumDef::Dynamic`] instance.
    ///
    /// This is used when the enum's variants may vary at runtime.
    ///
    /// # Examples
    ///
    /// ```
    /// use valuable::{EnumDef, Fields, VariantDef};
    ///
    /// let def = EnumDef::new_dynamic(
    ///     "Foo",
    ///     &[VariantDef::new("Bar", Fields::Unnamed(1))]
    /// );
    /// ```
    pub const fn new_dynamic(name: &'a str, variants: &'a [VariantDef<'a>]) -> EnumDef<'a> {
        EnumDef::Dynamic { name, variants }
    }

    /// Returns the enum's name
    ///
    /// # Examples
    ///
    /// ```
    /// use valuable::{Enumerable, Valuable};
    ///
    /// #[derive(Valuable)]
    /// enum Foo {
    ///     Bar,
    ///     Baz,
    /// }
    ///
    /// let def = Foo::Bar.definition();
    /// assert_eq!("Foo", def.name());
    /// ```
    pub fn name(&self) -> &str {
        match self {
            EnumDef::Static { name, .. } => name,
            EnumDef::Dynamic { name, .. } => name,
        }
    }

    /// Returns the enum's variants
    ///
    /// # Examples
    ///
    /// ```
    /// use valuable::{Enumerable, Valuable};
    ///
    /// #[derive(Valuable)]
    /// enum Foo {
    ///     Bar,
    ///     Baz,
    /// }
    ///
    /// let def = Foo::Bar.definition();
    /// let variants = def.variants();
    ///
    /// assert_eq!(2, variants.len());
    /// assert_eq!("Bar", variants[0].name());
    /// ```
    pub fn variants(&self) -> &[VariantDef<'_>] {
        match self {
            EnumDef::Static { variants, .. } => variants,
            EnumDef::Dynamic { variants, .. } => variants,
        }
    }

    /// Returns `true` if the enum is [statically defined](EnumDef::Static).
    ///
    /// # Examples
    ///
    /// With a static enum
    ///
    /// ```
    /// use valuable::{Enumerable, Valuable};
    ///
    /// #[derive(Valuable)]
    /// enum Foo {
    ///     Bar,
    ///     Baz,
    /// }
    ///
    /// let def = Foo::Bar.definition();
    /// assert!(def.is_static());
    /// ```
    ///
    /// With a dynamic enum
    ///
    /// ```
    /// use valuable::{EnumDef, Fields, VariantDef};
    ///
    /// let def = EnumDef::new_dynamic("Foo", &[]);
    /// assert!(!def.is_static());
    /// ```
    pub fn is_static(&self) -> bool {
        matches!(self, EnumDef::Static { .. })
    }

    /// Returns `true` if the enum is [dynamically defined](EnumDef::Dynamic).
    ///
    /// # Examples
    ///
    /// With a static enum
    ///
    /// ```
    /// use valuable::{Enumerable, Valuable};
    ///
    /// #[derive(Valuable)]
    /// enum Foo {
    ///     Bar,
    ///     Baz,
    /// }
    ///
    /// let def = Foo::Bar.definition();
    /// assert!(!def.is_dynamic());
    /// ```
    ///
    /// With a dynamic enum
    ///
    /// ```
    /// use valuable::{EnumDef, Fields, VariantDef};
    ///
    /// let def = EnumDef::new_dynamic("Foo", &[]);
    /// assert!(def.is_dynamic());
    /// ```
    pub fn is_dynamic(&self) -> bool {
        matches!(self, EnumDef::Dynamic { .. })
    }
}

impl<'a> VariantDef<'a> {
    /// Creates a new `VariantDef` instance.
    ///
    /// # Examples
    ///
    /// ```
    /// use valuable::{Fields, VariantDef};
    ///
    /// let def = VariantDef::new("Foo", Fields::Unnamed(2));
    /// ```
    pub const fn new(name: &'a str, fields: Fields<'a>) -> VariantDef<'a> {
        VariantDef { name, fields }
    }

    /// Returns the variant's name
    ///
    /// # Examples
    ///
    /// ```
    /// use valuable::{Fields, VariantDef};
    ///
    /// let def = VariantDef::new("Foo", Fields::Unnamed(2));
    /// assert_eq!("Foo", def.name());
    /// ```
    pub fn name(&self) -> &str {
        self.name
    }

    /// Returns the variant's fields
    ///
    /// # Examples
    ///
    /// ```
    /// use valuable::{Fields, VariantDef};
    ///
    /// let def = VariantDef::new("Foo", Fields::Unnamed(3));
    /// assert!(matches!(def.fields(), Fields::Unnamed(_)));
    /// ```
    pub fn fields(&self) -> &Fields<'_> {
        &self.fields
    }
}

impl Variant<'_> {
    /// Returns the variant's name
    ///
    /// # Examples
    ///
    /// ```
    /// use valuable::{Fields, Variant, VariantDef};
    ///
    /// static VARIANT: &VariantDef<'static> = &VariantDef::new(
    ///     "Foo", Fields::Unnamed(2));
    ///
    /// let variant = Variant::Static(VARIANT);
    /// assert_eq!("Foo", variant.name());
    /// ```
    pub fn name(&self) -> &str {
        match self {
            Variant::Static(v) => v.name(),
            Variant::Dynamic(v) => v.name(),
        }
    }

    /// Returns the variant's fields
    pub fn fields(&self) -> &Fields<'_> {
        match self {
            Variant::Static(v) => v.fields(),
            Variant::Dynamic(v) => v.fields(),
        }
    }

    /// Returns `true` if the variant has associated named fields.
    ///
    /// # Examples
    ///
    /// With named fields
    ///
    /// ```
    /// use valuable::{Fields, NamedField, Variant, VariantDef};
    ///
    /// static VARIANT: &VariantDef<'static> = &VariantDef::new(
    ///     "Foo", Fields::Named(&[NamedField::new("hello")]));
    ///
    /// let variant = Variant::Static(VARIANT);
    /// assert!(variant.is_named_fields());
    /// ```
    ///
    /// With unnamed fields
    ///
    /// ```
    /// use valuable::{Fields, Variant, VariantDef};
    ///
    /// static VARIANT: &VariantDef<'static> = &VariantDef::new(
    ///     "Foo", Fields::Unnamed(1));
    ///
    /// let variant = Variant::Static(VARIANT);
    /// assert!(!variant.is_named_fields());
    /// ```
    pub fn is_named_fields(&self) -> bool {
        self.fields().is_named()
    }

    /// Returns `true` if the variant has associated unnamed fields.
    ///
    /// # Examples
    ///
    /// With named fields
    ///
    /// ```
    /// use valuable::{Fields, NamedField, Variant, VariantDef};
    ///
    /// static VARIANT: &VariantDef<'static> = &VariantDef::new(
    ///     "Foo", Fields::Named(&[NamedField::new("hello")]));
    ///
    /// let variant = Variant::Static(VARIANT);
    /// assert!(!variant.is_unnamed_fields());
    /// ```
    ///
    /// With unnamed fields
    ///
    /// ```
    /// use valuable::{Fields, Variant, VariantDef};
    ///
    /// static VARIANT: &VariantDef<'static> = &VariantDef::new(
    ///     "Foo", Fields::Unnamed(1));
    ///
    /// let variant = Variant::Static(VARIANT);
    /// assert!(variant.is_unnamed_fields());
    /// ```
    pub fn is_unnamed_fields(&self) -> bool {
        !self.is_named_fields()
    }
}

impl fmt::Debug for dyn Enumerable + '_ {
    fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
        let variant = self.variant();
        #[cfg(feature = "alloc")]
        let name = format!("{}::{}", self.definition().name(), variant.name());
        #[cfg(not(feature = "alloc"))]
        let name = variant.name();

        if variant.is_named_fields() {
            struct DebugEnum<'a, 'b> {
                fmt: fmt::DebugStruct<'a, 'b>,
            }

            let mut debug = DebugEnum {
                fmt: fmt.debug_struct(&name),
            };

            impl Visit for DebugEnum<'_, '_> {
                fn visit_named_fields(&mut self, named_values: &NamedValues<'_>) {
                    for (field, value) in named_values {
                        self.fmt.field(field.name(), value);
                    }
                }

                fn visit_value(&mut self, _: Value<'_>) {
                    unreachable!();
                }
            }

            self.visit(&mut debug);

            debug.fmt.finish()
        } else {
            struct DebugEnum<'a, 'b> {
                fmt: fmt::DebugTuple<'a, 'b>,
            }

            let mut debug = DebugEnum {
                fmt: fmt.debug_tuple(&name),
            };

            impl Visit for DebugEnum<'_, '_> {
                fn visit_unnamed_fields(&mut self, values: &[Value<'_>]) {
                    for value in values {
                        self.fmt.field(value);
                    }
                }

                fn visit_value(&mut self, _: Value<'_>) {
                    unreachable!();
                }
            }

            self.visit(&mut debug);

            debug.fmt.finish()
        }
    }
}

macro_rules! deref {
    (
        $(
            $(#[$attrs:meta])*
            $ty:ty,
        )*
    ) => {
        $(
            $(#[$attrs])*
            impl<T: ?Sized + Enumerable> Enumerable for $ty {
                fn definition(&self) -> EnumDef<'_> {
                    T::definition(&**self)
                }

                fn variant(&self) -> Variant<'_> {
                    T::variant(&**self)
                }
            }
        )*
    };
}

deref! {
    &T,
    &mut T,
    #[cfg(feature = "alloc")]
    alloc::boxed::Box<T>,
    #[cfg(feature = "alloc")]
    alloc::rc::Rc<T>,
    #[cfg(not(valuable_no_atomic_cas))]
    #[cfg(feature = "alloc")]
    alloc::sync::Arc<T>,
}

static RESULT_VARIANTS: &[VariantDef<'static>] = &[
    VariantDef::new("Ok", Fields::Unnamed(1)),
    VariantDef::new("Err", Fields::Unnamed(1)),
];

impl<T, E> Enumerable for Result<T, E>
where
    T: Valuable,
    E: Valuable,
{
    fn definition(&self) -> EnumDef<'_> {
        EnumDef::new_static("Result", RESULT_VARIANTS)
    }

    fn variant(&self) -> Variant<'_> {
        match self {
            Ok(_) => Variant::Static(&RESULT_VARIANTS[0]),
            Err(_) => Variant::Static(&RESULT_VARIANTS[1]),
        }
    }
}

impl<T, E> Valuable for Result<T, E>
where
    T: Valuable,
    E: Valuable,
{
    fn as_value(&self) -> Value<'_> {
        Value::Enumerable(self)
    }

    fn visit(&self, visitor: &mut dyn Visit) {
        match self {
            Ok(val) => visitor.visit_unnamed_fields(&[val.as_value()]),
            Err(val) => visitor.visit_unnamed_fields(&[val.as_value()]),
        }
    }
}