CRTP wrapper that stores an unsigned enum as a flag set. More...

#include <StormByte/bitmask.hxx>

Collaboration diagram for StormByte::Bitmask< Derived, E >:

Public Member Functions
constexpr	Bitmask () noexcept
	Empty mask (`static_cast<E>(0)`).

constexpr	Bitmask (E value) noexcept
	Mask from a single enumerator (or already combined value).

constexpr	Bitmask (const Bitmask &other) noexcept=default
	Copy constructor.

constexpr	Bitmask (Bitmask &&other) noexcept=default
	Move constructor.

virtual constexpr	~Bitmask () noexcept=default
	Destructor.

constexpr Bitmask &	operator= (const Bitmask &other) noexcept=default
	Copy assignment.

constexpr Bitmask &	operator= (Bitmask &&other) noexcept=default
	Move assignment.

constexpr bool	operator== (const Bitmask &other) const noexcept
	Equality.

constexpr bool	operator!= (const Bitmask &other) const noexcept
	Inequality.

constexpr Derived	operator\| (const Bitmask &other) const noexcept
	Bitwise OR; returns `Derived`.

constexpr Derived	operator& (const Bitmask &other) const noexcept
	Bitwise AND; returns `Derived`.

constexpr Derived	operator^ (const Bitmask &other) const noexcept
	Bitwise XOR; returns `Derived`.

constexpr Derived	operator~ () const noexcept
	Bitwise NOT; returns `Derived`.

constexpr Bitmask &	operator\|= (const Bitmask &other) noexcept
	OR-assign.

constexpr Bitmask &	operator&= (const Bitmask &other) noexcept
	AND-assign.

constexpr Bitmask &	operator^= (const Bitmask &other) noexcept
	XOR-assign.

constexpr void	Add (E value) noexcept
	Sets every bit in `value`.

constexpr void	Remove (E value) noexcept
	Clears every bit in `value`.

constexpr E	Value () const noexcept
	Stored enumerators.

constexpr bool	Has (E value) const noexcept
	`true` when every bit in `value` is set.

constexpr bool	Has (const Bitmask &other) const noexcept
	`true` when every bit in `other` is set.

constexpr bool	HasAny (E value) const noexcept
	`true` when any bit in `value` is set.

constexpr bool	HasAny (const Bitmask &other) const noexcept
	`true` when any bit in `other` is set.

constexpr bool	HasNone (E value) const noexcept
	`true` when no bit in `value` is set.

constexpr bool	HasNone (const Bitmask &other) const noexcept
	`true` when no bit in `other` is set.

Protected Attributes
E	m_value
	Packed flags.

Detailed Description

template<typename Derived, Type::UnsignedEnum E>
class StormByte::Bitmask< Derived, E >

CRTP wrapper that stores an unsigned enum as a flag set.

Template Parameters

Derived	Concrete bitmask type.
E	Flag enumeration (`Type::UnsignedEnum`).

enum class MyFlags : uint8_t { FlagA = 0x01, FlagB = 0x02 };
class MyBitmask : public Bitmask<MyBitmask, MyFlags> {
public:
    using Bitmask<MyBitmask, MyFlags>::Bitmask;
};
MyBitmask mask(MyFlags::FlagA);
mask |= MyBitmask(MyFlags::FlagB);

Constructor & Destructor Documentation

◆ Bitmask() [1/4]

template<typename Derived , Type::UnsignedEnum E>

constexpr StormByte::Bitmask< Derived, E >::Bitmask ( )

inlineconstexprnoexcept

Empty mask (static_cast<E>(0)).

◆ Bitmask() [2/4]

template<typename Derived , Type::UnsignedEnum E>

constexpr StormByte::Bitmask< Derived, E >::Bitmask ( E value )

inlineconstexprnoexcept

Mask from a single enumerator (or already combined value).

Parameters

value Initial flags.

◆ Bitmask() [3/4]

template<typename Derived , Type::UnsignedEnum E>

constexpr StormByte::Bitmask< Derived, E >::Bitmask ( const Bitmask< Derived, E > & other )

constexprdefaultnoexcept

Copy constructor.

Parameters

other Source mask.

◆ Bitmask() [4/4]

template<typename Derived , Type::UnsignedEnum E>

constexpr StormByte::Bitmask< Derived, E >::Bitmask ( Bitmask< Derived, E > && other )

constexprdefaultnoexcept

Move constructor.

Parameters

other Source mask.

◆ ~Bitmask()

template<typename Derived , Type::UnsignedEnum E>

virtual constexpr StormByte::Bitmask< Derived, E >::~Bitmask ( )

constexprvirtualdefaultnoexcept

Destructor.

Member Function Documentation

◆ Add()

template<typename Derived , Type::UnsignedEnum E>

constexpr void StormByte::Bitmask< Derived, E >::Add ( E value )

constexprnoexcept

Sets every bit in value.

Parameters

value Flags to add.

◆ Has() [1/2]

template<typename Derived , Type::UnsignedEnum E>

constexpr bool StormByte::Bitmask< Derived, E >::Has ( const Bitmask< Derived, E > & other ) const

constexprnoexcept

true when every bit in other is set.

Parameters

other Other mask.

◆ Has() [2/2]

template<typename Derived , Type::UnsignedEnum E>

constexpr bool StormByte::Bitmask< Derived, E >::Has ( E value ) const

constexprnoexcept

true when every bit in value is set.

Parameters

value Flags to test.

◆ HasAny() [1/2]

template<typename Derived , Type::UnsignedEnum E>

constexpr bool StormByte::Bitmask< Derived, E >::HasAny ( const Bitmask< Derived, E > & other ) const

constexprnoexcept

true when any bit in other is set.

Parameters

other Other mask.

◆ HasAny() [2/2]

template<typename Derived , Type::UnsignedEnum E>

constexpr bool StormByte::Bitmask< Derived, E >::HasAny ( E value ) const

constexprnoexcept

true when any bit in value is set.

Parameters

value Flags to test.

◆ HasNone() [1/2]

template<typename Derived , Type::UnsignedEnum E>

constexpr bool StormByte::Bitmask< Derived, E >::HasNone ( const Bitmask< Derived, E > & other ) const

constexprnoexcept

true when no bit in other is set.

Parameters

other Other mask.

◆ HasNone() [2/2]

template<typename Derived , Type::UnsignedEnum E>

constexpr bool StormByte::Bitmask< Derived, E >::HasNone ( E value ) const

constexprnoexcept

true when no bit in value is set.

Parameters

value Flags to test.

◆ operator!=()

template<typename Derived , Type::UnsignedEnum E>

constexpr bool StormByte::Bitmask< Derived, E >::operator!= ( const Bitmask< Derived, E > & other ) const

constexprnoexcept

Inequality.

Parameters

other Other mask.

Returns: true when the stored E differs.

◆ operator&()

template<typename Derived , Type::UnsignedEnum E>

constexpr Derived StormByte::Bitmask< Derived, E >::operator& ( const Bitmask< Derived, E > & other ) const

constexprnoexcept

Bitwise AND; returns Derived.

Parameters

other Other mask.

Returns: New Derived with intersection of flags.

◆ operator&=()

template<typename Derived , Type::UnsignedEnum E>

constexpr Bitmask & StormByte::Bitmask< Derived, E >::operator&= ( const Bitmask< Derived, E > & other )

constexprnoexcept

AND-assign.

Parameters

other Other mask.

Returns: *this.

◆ operator=() [1/2]

template<typename Derived , Type::UnsignedEnum E>

constexpr Bitmask & StormByte::Bitmask< Derived, E >::operator= ( Bitmask< Derived, E > && other )

constexprdefaultnoexcept

Move assignment.

Parameters

other Source mask.

Returns: *this.

◆ operator=() [2/2]

template<typename Derived , Type::UnsignedEnum E>

constexpr Bitmask & StormByte::Bitmask< Derived, E >::operator= ( const Bitmask< Derived, E > & other )

constexprdefaultnoexcept

Copy assignment.

Parameters

other Source mask.

Returns: *this.

◆ operator==()

template<typename Derived , Type::UnsignedEnum E>

constexpr bool StormByte::Bitmask< Derived, E >::operator== ( const Bitmask< Derived, E > & other ) const

constexprnoexcept

Equality.

Parameters

other Other mask.

Returns: true when both store the same E.

◆ operator^()

template<typename Derived , Type::UnsignedEnum E>

constexpr Derived StormByte::Bitmask< Derived, E >::operator^ ( const Bitmask< Derived, E > & other ) const

constexprnoexcept

Bitwise XOR; returns Derived.

Parameters

other Other mask.

Returns: New Derived with toggled flags.

◆ operator^=()

template<typename Derived , Type::UnsignedEnum E>

constexpr Bitmask & StormByte::Bitmask< Derived, E >::operator^= ( const Bitmask< Derived, E > & other )

constexprnoexcept

XOR-assign.

Parameters

other Other mask.

Returns: *this.

◆ operator|()

template<typename Derived , Type::UnsignedEnum E>

constexpr Derived StormByte::Bitmask< Derived, E >::operator| ( const Bitmask< Derived, E > & other ) const

constexprnoexcept

Bitwise OR; returns Derived.

Parameters

other Other mask.

Returns: New Derived with union of flags.

◆ operator|=()

template<typename Derived , Type::UnsignedEnum E>

constexpr Bitmask & StormByte::Bitmask< Derived, E >::operator|= ( const Bitmask< Derived, E > & other )

constexprnoexcept

OR-assign.

Parameters

other Other mask.

Returns: *this.

◆ operator~()

template<typename Derived , Type::UnsignedEnum E>

constexpr Derived StormByte::Bitmask< Derived, E >::operator~ ( ) const

constexprnoexcept

Bitwise NOT; returns Derived.

Returns: New Derived with inverted flags.

◆ Remove()

template<typename Derived , Type::UnsignedEnum E>

constexpr void StormByte::Bitmask< Derived, E >::Remove ( E value )

constexprnoexcept

Clears every bit in value.

Parameters

value Flags to remove.

◆ Value()

template<typename Derived , Type::UnsignedEnum E>

constexpr E StormByte::Bitmask< Derived, E >::Value ( ) const

constexprnoexcept

Stored enumerators.

Returns: Current E.

Member Data Documentation

◆ m_value

template<typename Derived , Type::UnsignedEnum E>

E StormByte::Bitmask< Derived, E >::m_value

protected

Packed flags.

The documentation for this class was generated from the following file:

lib/public/StormByte/bitmask.hxx

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Bitmask() [1/4]

◆ Bitmask() [2/4]

◆ Bitmask() [3/4]

◆ Bitmask() [4/4]

◆ ~Bitmask()

Member Function Documentation

◆ Add()

◆ Has() [1/2]

◆ Has() [2/2]

◆ HasAny() [1/2]

◆ HasAny() [2/2]

◆ HasNone() [1/2]

◆ HasNone() [2/2]

◆ operator!=()

◆ operator&()

◆ operator&=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ operator^()

◆ operator^=()

◆ operator|()

◆ operator|=()

◆ operator~()

◆ Remove()

◆ Value()

Member Data Documentation

◆ m_value