big_enum_set 0.3.0

#![allow(dead_code)]

use big_enum_set::*;
use core::mem;
use std::collections::{BTreeSet, HashSet};

#[derive(BigEnumSetType, Debug)]
pub enum EmptyEnum {}

#[test]
fn test_empty_enum() {
    let set = BigEnumSet::<EmptyEnum>::new();
    assert_eq!(set.len(), 0);
    assert!(set.is_empty());
    assert_eq!(mem::size_of::<BigEnumSet<EmptyEnum>>(), 0);
}

#[derive(BigEnumSetType, Debug)]
pub enum Enum1 {
    A,
}

#[test]
fn test_enum1() {
    let mut set = BigEnumSet::new();
    assert_eq!(set.len(), 0);
    assert!(set.is_empty());
    assert!(!set.contains(Enum1::A));
    set.insert(Enum1::A);
    assert_eq!(set.len(), 1);
    assert!(!set.is_empty());
    assert!(set.contains(Enum1::A));
    assert_eq!(Enum1::A, Enum1::A);
    assert_eq!(mem::size_of::<BigEnumSet<Enum1>>(), mem::size_of::<usize>());
}

#[derive(BigEnumSetType, Debug)]
pub enum SmallEnum {
    A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z,
}
#[derive(BigEnumSetType, Debug)]
pub enum LargeEnum {
    _00,  _01,  _02,  _03,  _04,  _05,  _06,  _07,
    _10,  _11,  _12,  _13,  _14,  _15,  _16,  _17,
    _20,  _21,  _22,  _23,  _24,  _25,  _26,  _27,
    _30,  _31,  _32,  _33,  _34,  _35,  _36,  _37,
    _40,  _41,  _42,  _43,  _44,  _45,  _46,  _47,
    _50,  _51,  _52,  _53,  _54,  _55,  _56,  _57,
    _60,  _61,  _62,  _63,  _64,  _65,  _66,  _67,
    _70,  _71,  _72,  _73,  _74,  _75,  _76,  _77,
    A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z,
}
#[derive(BigEnumSetType, Debug)]
pub enum Enum8 {
    A, B, C, D, E, F, G, H,
}
#[derive(BigEnumSetType, Debug)]
pub enum Enum128 {
    A, B, C, D, E, F, G, H, _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,
}
#[derive(BigEnumSetType, Debug)]
pub enum SparseEnum {
    A = 0xA, B = 20, C = 30, D = 40, E = 50, F = 60, G = 70, H = 80,
}
#[derive(BigEnumSetType, Debug)]
pub enum LargeSparseEnum {
    A = 0, B = 20, C = 128, D = 140, E = 150, F = 160, G = 170, H = 180, I = 190, J = 255,
}

#[repr(u32)]
#[derive(BigEnumSetType, Debug)]
pub enum ReprEnum {
    A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z,
}
#[repr(i16)]
#[derive(BigEnumSetType, Debug)]
pub enum ReprEnum2 {
    A, B, C, D, E, F, G, H, I, J, K, L, M, N = 0x100, O, P, Q, R, S, T, U, V, W, X, Y, Z,
}
#[repr(isize)]
#[derive(BigEnumSetType, Debug)]
pub enum ReprEnum3 {
    A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z,
}
#[repr(C)]
#[derive(BigEnumSetType, Debug)]
pub enum ReprEnum4 {
    A, B, C, D, E, F, G, H, I, J, K, L, M, N = 22, O, P, Q, R, S, T, U, V, W, X, Y, Z,
}


macro_rules! test_variants {
    ($enum_name:ident $all_empty_test:ident $($variant:ident,)*) => {
        #[test]
        fn $all_empty_test() {
            let all = BigEnumSet::<$enum_name>::all();
            let empty = BigEnumSet::<$enum_name>::empty();

            $(
                assert!(!empty.contains($enum_name::$variant));
                assert!(all.contains($enum_name::$variant));
            )*
        }
    }
}
test_variants! { SmallEnum small_enum_all_empty
    A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z,
}
test_variants! { LargeEnum large_enum_all_empty
    _00,  _01,  _02,  _03,  _04,  _05,  _06,  _07,
    _10,  _11,  _12,  _13,  _14,  _15,  _16,  _17,
    _20,  _21,  _22,  _23,  _24,  _25,  _26,  _27,
    _30,  _31,  _32,  _33,  _34,  _35,  _36,  _37,
    _40,  _41,  _42,  _43,  _44,  _45,  _46,  _47,
    _50,  _51,  _52,  _53,  _54,  _55,  _56,  _57,
    _60,  _61,  _62,  _63,  _64,  _65,  _66,  _67,
    _70,  _71,  _72,  _73,  _74,  _75,  _76,  _77,
    A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z,
}
test_variants! { SparseEnum sparse_enum_all_empty
    A, B, C, D, E, F, G,
}
test_variants! { LargeSparseEnum large_sparse_enum_all_empty
    A, B, C, D, E, F, G, H, I, J,
}

macro_rules! test_enum {
    ($e:ident, $size:expr) => {
        const CONST_SET: BigEnumSet<$e> = big_enum_set!($e::A | $e::C);
        const CONST_1_SET: BigEnumSet<$e> = big_enum_set!($e::A);
        const EMPTY_SET: BigEnumSet<$e> = big_enum_set!();
        #[test]
        fn const_set() {
            assert_eq!(CONST_SET.len(), 2);
            assert_eq!(CONST_1_SET.len(), 1);
            assert!(CONST_SET.contains($e::A));
            assert!(CONST_SET.contains($e::C));
            assert!(EMPTY_SET.is_empty());
        }

        #[test]
        fn enum_ops() {
            for e in BigEnumSet::<$e>::all().iter() {
                assert!(e == e);
                assert_eq!(e.clone(), e);
            }
            assert!($e::A != $e::B);
            assert!($e::E != $e::F);

            assert_eq!($e::B | ($e::B | $e::C), $e::B | $e::C);
            assert_eq!($e::B & &($e::B | $e::C), $e::B);
            assert_eq!($e::B ^ &($e::B | $e::C), $e::C);
            assert_eq!($e::A ^ ($e::B | $e::C), $e::A | $e::B | $e::C);
            assert_eq!($e::B - ($e::B | $e::C), BigEnumSet::empty());
            assert_eq!($e::A - &($e::B | $e::C), $e::A);

            assert_eq!($e::B | $e::C, $e::B | $e::C);
            assert_eq!($e::B & $e::B, $e::B);
            assert_eq!($e::B ^ $e::B, BigEnumSet::empty());
            assert_eq!($e::A ^ $e::B, $e::A | $e::B);
            assert_eq!($e::B - $e::B, BigEnumSet::empty());
            assert_eq!($e::A - $e::B, $e::A);
            assert_eq!($e::A | !$e::A, BigEnumSet::<$e>::all());
            assert_eq!(!!$e::A, $e::A);

            assert!($e::A == BigEnumSet::only($e::A));
        }

        #[test]
        fn basic_add_remove() {
            let mut set = BigEnumSet::new();
            set.insert($e::A);
            set.insert($e::B);
            set.insert($e::C);
            assert_eq!(set, $e::A | $e::B | $e::C);
            set.remove($e::B);
            assert_eq!(set, $e::A | $e::C);
            set.insert($e::D);
            assert_eq!(set, $e::A | $e::C | $e::D);
            set.insert_all($e::F | $e::E | $e::G);
            assert_eq!(set, $e::A | $e::C | $e::D | $e::F | $e::E | $e::G);
            set.remove_all($e::A | $e::D | $e::G);
            assert_eq!(set, $e::C | $e::F | $e::E);
            assert!(!set.is_empty());
            set.clear();
            assert!(set.is_empty());
        }

        #[test]
        fn already_present_element() {
            let mut set = BigEnumSet::new();
            assert!(set.insert($e::A));
            assert!(!set.insert($e::A));
            set.remove($e::A);
            assert!(set.insert($e::A));
        }

        #[test]
        fn empty_is_empty() {
            assert_eq!(BigEnumSet::<$e>::empty().len(), 0)
        }

        #[test]
        fn all_len() {
            assert_eq!(BigEnumSet::<$e>::all().len(), BigEnumSet::<$e>::variant_count() as usize)
        }

        #[test]
        fn basic_iter_test() {
            let mut set = BigEnumSet::new();
            set.insert($e::A);
            set.insert($e::B);
            set.insert($e::C);
            set.insert($e::E);

            let mut set_2 = BigEnumSet::new();
            let vec: Vec<$e> = set.iter().collect();
            for val in vec {
                assert!(!set_2.contains(val));
                set_2.insert(val);
            }
            assert_eq!(set, set_2);

            let mut set_3 = BigEnumSet::new();
            for val in set.iter() {
                assert!(!set_3.contains(val));
                set_3.insert(val);
            }
            assert_eq!(set, set_3);

            let mut set_3 = BigEnumSet::new();
            for val in set.into_iter() {
                assert!(!set_3.contains(val));
                set_3.insert(val);
            }
            assert_eq!(set, set_3);
        }

        #[test]
        fn iter_ordering_test() {
            let set_a = $e::A | $e::B | $e::E;
            let vec_a: Vec<_> = set_a.iter().collect();
            assert_eq!(vec_a, &[$e::A, $e::B, $e::E]);

            let set_a = $e::B | $e::D | $e::G;
            let vec_a: Vec<_> = set_a.iter().collect();
            assert_eq!(vec_a, &[$e::B, $e::D, $e::G]);
        }

        #[test]
        fn test_iter_size_hint() {
            fn check_iter_size_hint(set: BigEnumSet<$e>) {
                let count = set.len();
                let mut itr = set.iter();
                for idx in 0 .. count {
                    assert_eq!(itr.size_hint(), (count-idx, Some(count-idx)));
                    assert_eq!(itr.len(), count-idx);
                    assert!(itr.next().is_some());
                }
                assert_eq!(itr.size_hint(), (0, Some(0)));
                assert_eq!(itr.len(), 0);
            }

            check_iter_size_hint(BigEnumSet::<$e>::all());
            let mut set = BigEnumSet::new();
            set.insert($e::A);
            set.insert($e::C);
            set.insert($e::E);
            check_iter_size_hint(set);
        }

        #[test]
        fn iter_ops_test() {
            let set = $e::A | $e::B | $e::C | $e::E;
            let set2 = set.iter().filter(|&v| v != $e::B).collect::<BigEnumSet<_>>();
            assert_eq!(set2, $e::A | $e::C | $e::E);
        }

        #[test]
        fn basic_methods_test() {
            assert_eq!(($e::A | $e::B).union(&($e::B | $e::C)), $e::A | $e::B | $e::C);
            assert_eq!(($e::A | $e::B).intersection($e::B | $e::C), $e::B);
            assert_eq!(($e::A | $e::B).symmetrical_difference(&($e::B | $e::C)), $e::A | $e::C);
            assert_eq!(($e::A | $e::B).difference($e::B | $e::C), $e::A);
            assert_eq!(BigEnumSet::from($e::A).union(!$e::A), BigEnumSet::<$e>::all());
        }

        #[test]
        fn basic_ops_test() {
            assert_eq!(($e::A | $e::B) | ($e::B | $e::C), $e::A | $e::B | $e::C);
            assert_eq!(($e::A | $e::B) & ($e::B | $e::C), $e::B);
            assert_eq!(($e::A | $e::B) ^ &($e::B | $e::C), $e::A | $e::C);
            assert_eq!(&($e::A | $e::B) - ($e::B | $e::C), $e::A);
            assert_eq!($e::A | !$e::A, BigEnumSet::<$e>::all());
        }

        #[test]
        fn set_enum_ops_test() {
            assert_eq!(($e::B | $e::C) | $e::A, $e::A | $e::B | $e::C);
            assert_eq!(&($e::A | $e::B) & $e::B, $e::B);
            assert_eq!(($e::B | $e::C) ^ $e::B, $e::C);
            assert_eq!(($e::A | $e::B) - $e::B, $e::A);
        }

        #[test]
        fn mutable_ops_test() {
            let mut set = $e::A | $e::B;
            assert_eq!(set, $e::A | $e::B);
            set |= $e::C | $e::D;
            assert_eq!(set, $e::A | $e::B | $e::C | $e::D);
            set |= $e::E;
            assert_eq!(set, $e::A | $e::B | $e::C | $e::D | $e::E);
            set -= $e::C;
            assert_eq!(set, $e::A | $e::B | $e::D | $e::E);
            set -= &($e::C | $e::E);
            assert_eq!(set, $e::A | $e::B | $e::D);
            set ^= $e::B | $e::E;
            assert_eq!(set, $e::A | $e::D | $e::E);
            set ^= $e::E;
            assert_eq!(set, $e::A | $e::D);
            set ^= $e::B;
            assert_eq!(set, $e::A | $e::B | $e::D);
            set &= &($e::A | $e::E | $e::F);
            assert_eq!(set, $e::A);
            set &= $e::F;
            assert_eq!(set, BigEnumSet::empty());
        }

        #[test]
        fn basic_set_status() {
            assert!(($e::A | $e::B | $e::C).is_disjoint($e::D | $e::E | $e::F));
            assert!(!($e::A | $e::B | $e::C | $e::D).is_disjoint($e::D | $e::E | $e::F));
            assert!(($e::A | $e::B).is_subset($e::A | $e::B | $e::C));
            assert!(!($e::A | $e::D).is_subset(&($e::A | $e::B | $e::C)));
            assert!(($e::A | $e::D | $e::C).is_superset(&$e::C.into()));
        }

        #[test]
        fn debug_impl() {
            assert_eq!(format!("{:?}", $e::A | $e::B | $e::D), "BigEnumSet(A | B | D)");
        }

        #[test]
        fn from_bits() {
            const MEM_SIZE: usize = mem_size($size);
            const WORDS: usize = MEM_SIZE / core::mem::size_of::<usize>();
            assert_eq!(BigEnumSet::try_from_bits(&[]).unwrap(), BigEnumSet::<$e>::empty());
            assert_eq!(BigEnumSet::try_from_bits(&[0]).unwrap(), BigEnumSet::<$e>::empty());
            assert_eq!(BigEnumSet::try_from_bits(&[0; WORDS]).unwrap(), BigEnumSet::<$e>::empty());
            assert_eq!(BigEnumSet::try_from_bits(&[0; WORDS + 1]).unwrap(), BigEnumSet::<$e>::empty());

            assert_eq!(BigEnumSet::from_bits_truncated(&[]), BigEnumSet::<$e>::empty());
            assert_eq!(BigEnumSet::from_bits_truncated(&[0]), BigEnumSet::<$e>::empty());
            assert_eq!(BigEnumSet::from_bits_truncated(&[0; WORDS]), BigEnumSet::<$e>::empty());
            assert_eq!(BigEnumSet::from_bits_truncated(&[0; WORDS + 1]), BigEnumSet::<$e>::empty());

            let value = $e::A | $e::C | $e::D | $e::F | $e::E | $e::G;
            assert_eq!(BigEnumSet::try_from_bits(value.as_bits()).unwrap(), value);
            assert_eq!(BigEnumSet::from_bits_truncated(value.as_bits()), value);

            assert_eq!(BigEnumSet::<$e>::from_bits_truncated(&[std::usize::MAX; WORDS]), BigEnumSet::all());
            assert_eq!(BigEnumSet::<$e>::from_bits_truncated(&[std::usize::MAX; WORDS+2]), BigEnumSet::all());

            if (BigEnumSet::<$e>::variant_count() as usize) < MEM_SIZE * 8 {
                let bits = &[std::usize::MAX; WORDS];
                assert!(BigEnumSet::<$e>::try_from_bits(bits).is_none());
            }
            let mut bits = [0_usize; WORDS + 1];
            bits[WORDS] = 0x2;
            assert!(BigEnumSet::<$e>::try_from_bits(&bits).is_none());
        }

        #[test]
        fn match_const_test() {
            match CONST_SET {
                CONST_SET => { /* ok */ }
                _ => panic!("match fell through?"),
            }
        }

        #[test]
        fn set_test() {
            const SET_TEST_A: BigEnumSet<$e> = big_enum_set!($e::A | $e::B | $e::C);
            const SET_TEST_B: BigEnumSet<$e> = big_enum_set!($e::A | $e::B | $e::D);
            const SET_TEST_C: BigEnumSet<$e> = big_enum_set!($e::A | $e::B | $e::E);
            const SET_TEST_D: BigEnumSet<$e> = big_enum_set!($e::A | $e::B | $e::F);
            const SET_TEST_E: BigEnumSet<$e> = big_enum_set!($e::A | $e::B | $e::G);
            macro_rules! test_set {
                ($set:ident) => {{
                    assert!(!$set.contains(&SET_TEST_A));
                    assert!(!$set.contains(&SET_TEST_B));
                    assert!(!$set.contains(&SET_TEST_C));
                    assert!(!$set.contains(&SET_TEST_D));
                    assert!(!$set.contains(&SET_TEST_E));
                    $set.insert(SET_TEST_A);
                    $set.insert(SET_TEST_C);
                    assert!($set.contains(&SET_TEST_A));
                    assert!(!$set.contains(&SET_TEST_B));
                    assert!($set.contains(&SET_TEST_C));
                    assert!(!$set.contains(&SET_TEST_D));
                    assert!(!$set.contains(&SET_TEST_E));
                    $set.remove(&SET_TEST_C);
                    $set.remove(&SET_TEST_D);
                    assert!($set.contains(&SET_TEST_A));
                    assert!(!$set.contains(&SET_TEST_B));
                    assert!(!$set.contains(&SET_TEST_C));
                    assert!(!$set.contains(&SET_TEST_D));
                    assert!(!$set.contains(&SET_TEST_E));
                    $set.insert(SET_TEST_A);
                    $set.insert(SET_TEST_D);
                    assert!($set.contains(&SET_TEST_A));
                    assert!(!$set.contains(&SET_TEST_B));
                    assert!(!$set.contains(&SET_TEST_C));
                    assert!($set.contains(&SET_TEST_D));
                    assert!(!$set.contains(&SET_TEST_E));
                }}
            }

            let mut hash_set = HashSet::new();
            test_set!(hash_set);

            let mut tree_set = BTreeSet::new();
            test_set!(tree_set);
        }

        #[test]
        fn sum_test() {
            let target = $e::A | $e::B | $e::D | $e::E | $e::G | $e::H;

            let list_a = [$e::A | $e::B, $e::D | $e::E, $e::G | $e::H];
            let sum_a: BigEnumSet<$e> = list_a.iter().map(|x| *x).sum();
            assert_eq!(target, sum_a);
            let sum_b: BigEnumSet<$e> = list_a.iter().sum();
            assert_eq!(target, sum_b);

            let list_b = [$e::A, $e::B, $e::D, $e::E, $e::G, $e::H];
            let sum_c: BigEnumSet<$e> = list_b.iter().map(|x| *x).sum();
            assert_eq!(target, sum_c);
            let sum_d: BigEnumSet<$e> = list_b.iter().sum();
            assert_eq!(target, sum_d);
        }

        #[test]
        fn check_size() {
            assert_eq!(mem::size_of::<BigEnumSet<$e>>(), mem_size($size));
        }

        // size rounded up to size_of::<usize>.
        const fn mem_size(size: usize) -> usize {
            let usize_len = mem::size_of::<usize>();
            (size + usize_len-1) / usize_len * usize_len
        }
    }
}
macro_rules! tests {
    ($m:ident, $($tt:tt)*) => { mod $m { use super::*; $($tt)*; } }
}

tests!(small_enum, test_enum!(SmallEnum, 4));
tests!(large_enum, test_enum!(LargeEnum, 16));
tests!(enum8, test_enum!(Enum8, 1));
tests!(enum128, test_enum!(Enum128, 16));
tests!(sparse_enum, test_enum!(SparseEnum, 16));
tests!(large_sparse_enum, test_enum!(LargeSparseEnum, 32));
tests!(repr_enum, test_enum!(ReprEnum, 4));
tests!(repr_enum2, test_enum!(ReprEnum2, 33));
tests!(repr_enum3, test_enum!(ReprEnum3, 4));
tests!(repr_enum4, test_enum!(ReprEnum4, 4));