#include <BitFlag.hh>

Description

template<typename T, typename E>
requires (std::is_enum_v<E> && std::is_integral_v<T>)
struct EGG::TBitFlag< T, E >

Wrapper around an integral type with an enum corresponding to its bits.

Template Parameters

T	The underlying integral type.
E	The enum to correspond to.

Definition at line 16 of file BitFlag.hh.

Public Member Functions
constexpr	TBitFlag ()
	Default constructor, initializes all flags to off.

constexpr	TBitFlag (T mask)
	Constructor that initializes the bit flags with a given mask.

constexpr	TBitFlag (E e)
	Constructor that initializes the bit flags with a given enum.

constexpr	operator T () const
	Conversion operator to the underlying integral type.

constexpr TBitFlag< T, E > &	operator= (const TBitFlag< T, E > &rhs)
	Assignment operator.

template<typename... Es> requires (std::is_same_v<Es, E> && ...)
constexpr TBitFlag< T, E > &	setBit (Es... es)
	Sets the corresponding bits for the provided enum values.

template<typename... Es> requires (std::is_same_v<Es, E> && ...)
constexpr TBitFlag< T, E > &	resetBit (Es... es)
	Resets the corresponding bits for the provided enum values.

template<typename... Es> requires (std::is_same_v<Es, E> && ...)
constexpr TBitFlag< T, E > &	changeBit (bool on, Es... es)
	Changes the state of the corresponding bits for the provided enum values.

template<typename... Es> requires (std::is_same_v<Es, E> && ...)
constexpr TBitFlag< T, E > &	toggleBit (Es... es)
	Toggles the corresponding bits for the provided enum values.

template<typename... Es> requires (std::is_same_v<Es, E> && ...)
constexpr bool	onBit (Es... es) const
	Checks if any of the corresponding bits for the provided enum values are on.

template<typename... Es> requires (std::is_same_v<Es, E> && ...)
constexpr bool	offBit (Es... es) const
	Checks if all of the corresponding bits for the provided enum values are off.

template<typename... Es> requires (std::is_same_v<Es, E> && ...)
constexpr T	maskBit (Es... es) const
	Creates an applied mask of the corresponding bits for the provided enum values.

template<typename... Es> requires (std::is_same_v<Es, E> && ...)
constexpr T	makeMask (Es... es) const
	Creates a mask of the corresponding bits for the provided enum values.

constexpr TBitFlag< T, E > &	set (T mask)
	Sets the bits using a direct mask.

constexpr TBitFlag< T, E > &	reset (T mask)
	Resets the bits using a direct mask.

constexpr TBitFlag< T, E > &	change (bool on, T mask)
	Changes the bits using a direct mask.

constexpr bool	on (T mask) const
	Checks if any bits are on in the specified mask.

constexpr bool	onAll (T mask) const
	Checks if all bits are on in the specified mask.

constexpr bool	off (T mask) const
	Checks if all bits are off in the specified mask.

constexpr void	makeAllZero ()
	Resets all the bits to zero.

constexpr T	getDirect () const
	Gets the current bit mask.

constexpr void	setDirect (T mask)
	Sets the bits using a direct mask.

Private Types
typedef std::underlying_type_t< E >	EI

Private Member Functions
constexpr void	setBit_ (E e)
	Internal. Sets a specific bit.

constexpr void	resetBit_ (E e)
	Internal. Resets a specific bit.

constexpr void	changeBit_ (bool on, E e)
	Internal. Changes a specific bit.

constexpr void	toggleBit_ (E e)
	Internal. Toggles a specific bit.

constexpr bool	onBit_ (E e) const
	Checks if a specific bit is on.

constexpr bool	offBit_ (E e) const
	Checks if a specific bit is off.

constexpr T	makeMask_ (E e) const
	Creates a mask for a specific bit.

Private Attributes
T	bits
	The bit mask representing the flags.

Static Private Attributes
static constexpr size_t	MAX_CAPACITY = std::numeric_limits<T>::digits

Member Typedef Documentation

◆ EI

template<typename T , typename E >

std::underlying_type_t<E> EGG::TBitFlag< T, E >::EI

private

Definition at line 202 of file BitFlag.hh.

Constructor & Destructor Documentation

◆ TBitFlag() [1/3]

template<typename T , typename E >

EGG::TBitFlag< T, E >::TBitFlag ( )

inlineconstexpr

Default constructor, initializes all flags to off.

Matches the expression bits = 0.

Definition at line 19 of file BitFlag.hh.

◆ TBitFlag() [2/3]

template<typename T , typename E >

EGG::TBitFlag< T, E >::TBitFlag ( T mask )

inlineconstexpr

Constructor that initializes the bit flags with a given mask.

Matches the expression bits = mask.

Parameters

mask	The initial bit mask.

Definition at line 26 of file BitFlag.hh.

◆ TBitFlag() [3/3]

template<typename T , typename E >

EGG::TBitFlag< T, E >::TBitFlag ( E e )

inlineconstexpr

Constructor that initializes the bit flags with a given enum.

Matches the expression bits = eEnum::val.

Parameters

e	The initial enum.

Definition at line 33 of file BitFlag.hh.

Member Function Documentation

◆ change()

template<typename T , typename E >

TBitFlag< T, E > & EGG::TBitFlag< T, E >::change	(	bool	on,
		T	mask )

inlineconstexpr

Changes the bits using a direct mask.

Parameters

on	Determines whether to set or reset the bits.
mask	The bit mask to change.

Returns: Reference for chaining.

Definition at line 159 of file BitFlag.hh.

◆ changeBit()

template<typename T , typename E >

template<typename... Es>
requires (std::is_same_v<Es, E> && ...)

TBitFlag< T, E > & EGG::TBitFlag< T, E >::changeBit	(	bool	on,
		Es...	es )

inlineconstexpr

Changes the state of the corresponding bits for the provided enum values.

Template Parameters

...Es Variadic template for packing.

Parameters

on	Determines whether to set or reset the bits.
...es	Enum values representing the bits to change.

Returns: Reference for chaining.

Definition at line 80 of file BitFlag.hh.

◆ changeBit_()

template<typename T , typename E >

void EGG::TBitFlag< T, E >::changeBit_	(	bool	on,
		E	e )

inlineconstexprprivate

Internal. Changes a specific bit.

Validates that e is in the range of T.

Parameters

on	Determines whether to set or reset the bit.
e	Enum value respresenting the bit to change.

Definition at line 225 of file BitFlag.hh.

◆ getDirect()

template<typename T , typename E >

T EGG::TBitFlag< T, E >::getDirect ( ) const

inlinenodiscardconstexpr

Gets the current bit mask.

Returns: The current bit mask.

Definition at line 191 of file BitFlag.hh.

◆ makeAllZero()

template<typename T , typename E >

void EGG::TBitFlag< T, E >::makeAllZero ( )

inlineconstexpr

Resets all the bits to zero.

Definition at line 185 of file BitFlag.hh.

◆ makeMask()

template<typename T , typename E >

template<typename... Es>
requires (std::is_same_v<Es, E> && ...)

T EGG::TBitFlag< T, E >::makeMask ( Es... es ) const

inlinenodiscardconstexpr

Creates a mask of the corresponding bits for the provided enum values.

Template Parameters

...Es Variadic template for packing.

Parameters

...es Enum values representing the bits to check.

Returns: The mask for the specified bits.

Definition at line 135 of file BitFlag.hh.

◆ makeMask_()

template<typename T , typename E >

T EGG::TBitFlag< T, E >::makeMask_ ( E e ) const

inlinenodiscardconstexprprivate

Creates a mask for a specific bit.

Matches the expression (1 << e). Validates that e is in the range of T.

Parameters

e

Returns: The mask for the specified bit.

Definition at line 260 of file BitFlag.hh.

◆ maskBit()

template<typename T , typename E >

template<typename... Es>
requires (std::is_same_v<Es, E> && ...)

T EGG::TBitFlag< T, E >::maskBit ( Es... es ) const

inlinenodiscardconstexpr

Creates an applied mask of the corresponding bits for the provided enum values.

Matches the expression (bits & mask).

Template Parameters

...Es Variadic template for packing.

Parameters

...es Enum values representing the bits to check.

Returns: The applied mask for the specified bits.

Definition at line 125 of file BitFlag.hh.

◆ off()

template<typename T , typename E >

bool EGG::TBitFlag< T, E >::off ( T mask ) const

inlinenodiscardconstexpr

Checks if all bits are off in the specified mask.

Parameters

mask	The bit mask to check.

Returns: True if all bits in the mask are off, otherwise false.

Definition at line 180 of file BitFlag.hh.

◆ offBit()

template<typename T , typename E >

template<typename... Es>
requires (std::is_same_v<Es, E> && ...)

bool EGG::TBitFlag< T, E >::offBit ( Es... es ) const

inlinenodiscardconstexpr

Checks if all of the corresponding bits for the provided enum values are off.

Matches the expression (bits & mask) == 0.

Template Parameters

...Es Variadic template for packing.

Parameters

...es Enum values representing the bits to check.

Returns: True if all of the specified bits are off, otherwise false.

Definition at line 114 of file BitFlag.hh.

◆ offBit_()

template<typename T , typename E >

bool EGG::TBitFlag< T, E >::offBit_ ( E e ) const

inlinenodiscardconstexprprivate

Checks if a specific bit is off.

Validates that e is in the range of T.

Parameters

e	Enum value representing the bit to change.

Returns: True if the specified bit is off, otherwise false.

Definition at line 251 of file BitFlag.hh.

◆ on()

template<typename T , typename E >

bool EGG::TBitFlag< T, E >::on ( T mask ) const

inlinenodiscardconstexpr

Checks if any bits are on in the specified mask.

Parameters

mask	The bit mask to check.

Returns: True if any bits in the mask are on, otherwise false.

Definition at line 166 of file BitFlag.hh.

◆ onAll()

template<typename T , typename E >

bool EGG::TBitFlag< T, E >::onAll ( T mask ) const

inlinenodiscardconstexpr

Checks if all bits are on in the specified mask.

Parameters

mask	The bit mask to check.

Returns: True if all bits in the mask are on, otherwise false.

Definition at line 173 of file BitFlag.hh.

◆ onBit()

template<typename T , typename E >

template<typename... Es>
requires (std::is_same_v<Es, E> && ...)

bool EGG::TBitFlag< T, E >::onBit ( Es... es ) const

inlinenodiscardconstexpr

Checks if any of the corresponding bits for the provided enum values are on.

Matches the expression (bits & mask) != 0.

Template Parameters

...Es Variadic template for packing.

Parameters

...es Enum values representing the bits to check.

Returns: True if one of the specified bits are on, otherwise false.

Definition at line 103 of file BitFlag.hh.

◆ onBit_()

template<typename T , typename E >

bool EGG::TBitFlag< T, E >::onBit_ ( E e ) const

inlinenodiscardconstexprprivate

Checks if a specific bit is on.

Validates that e is in the range of T.

Parameters

e	Enum value representing the bit to change.

Returns: True if the specified bit is on, otherwise false.

Definition at line 242 of file BitFlag.hh.

◆ operator T()

template<typename T , typename E >

EGG::TBitFlag< T, E >::operator T ( ) const

inlinenodiscardconstexpr

Conversion operator to the underlying integral type.

Definition at line 38 of file BitFlag.hh.

◆ operator=()

template<typename T , typename E >

TBitFlag< T, E > & EGG::TBitFlag< T, E >::operator= ( const TBitFlag< T, E > & rhs )

inlineconstexpr

Assignment operator.

Parameters

rhs Source.

Returns: Reference for chaining.

Definition at line 45 of file BitFlag.hh.

◆ reset()

template<typename T , typename E >

TBitFlag< T, E > & EGG::TBitFlag< T, E >::reset ( T mask )

inlineconstexpr

Resets the bits using a direct mask.

Parameters

mask	The bit mask to reset.

Returns: Reference for chaining.

Definition at line 150 of file BitFlag.hh.

◆ resetBit()

template<typename T , typename E >

template<typename... Es>
requires (std::is_same_v<Es, E> && ...)

TBitFlag< T, E > & EGG::TBitFlag< T, E >::resetBit ( Es... es )

inlineconstexpr

Resets the corresponding bits for the provided enum values.

Template Parameters

...Es Variadic template for packing.

Parameters

...es Enum values representing the bits to reset.

Returns: Reference for chaining.

Definition at line 68 of file BitFlag.hh.

◆ resetBit_()

template<typename T , typename E >

void EGG::TBitFlag< T, E >::resetBit_ ( E e )

inlineconstexprprivate

Internal. Resets a specific bit.

Validates that e is in the range of T.

Parameters

e	Enum value representing the bit to reset.

Definition at line 216 of file BitFlag.hh.

◆ set()

template<typename T , typename E >

TBitFlag< T, E > & EGG::TBitFlag< T, E >::set ( T mask )

inlineconstexpr

Sets the bits using a direct mask.

Parameters

mask	The bit mask to set.

Returns: Reference for chaining.

Definition at line 142 of file BitFlag.hh.

◆ setBit()

template<typename T , typename E >

template<typename... Es>
requires (std::is_same_v<Es, E> && ...)

TBitFlag< T, E > & EGG::TBitFlag< T, E >::setBit ( Es... es )

inlineconstexpr

Sets the corresponding bits for the provided enum values.

Matches the expression bits |= mask.

Template Parameters

...Es Variadic template for packing.

Parameters

...es Enum values representing the bits to set.

Returns: Reference for chaining.

Definition at line 57 of file BitFlag.hh.

◆ setBit_()

template<typename T , typename E >

void EGG::TBitFlag< T, E >::setBit_ ( E e )

inlineconstexprprivate

Internal. Sets a specific bit.

Validates that e is in the range of T.

Parameters

e	Enum value representing the bit to set.

Definition at line 208 of file BitFlag.hh.

◆ setDirect()

template<typename T , typename E >

void EGG::TBitFlag< T, E >::setDirect ( T mask )

inlineconstexpr

Sets the bits using a direct mask.

Parameters

mask	The bit mask to set.

Definition at line 197 of file BitFlag.hh.

◆ toggleBit()

template<typename T , typename E >

template<typename... Es>
requires (std::is_same_v<Es, E> && ...)

TBitFlag< T, E > & EGG::TBitFlag< T, E >::toggleBit ( Es... es )

inlineconstexpr

Toggles the corresponding bits for the provided enum values.

Template Parameters

...Es Variadic template for packing.

Parameters

...es Enum values representing the bits to toggle.

Returns: Reference for chaining.

Definition at line 91 of file BitFlag.hh.

◆ toggleBit_()

template<typename T , typename E >

void EGG::TBitFlag< T, E >::toggleBit_ ( E e )

inlineconstexprprivate

Internal. Toggles a specific bit.

Validates that e is in the range of T.

Parameters

e	Enum value representing the bit to change.

Definition at line 233 of file BitFlag.hh.

Member Data Documentation

◆ bits

template<typename T , typename E >

T EGG::TBitFlag< T, E >::bits

private

The bit mask representing the flags.

Definition at line 265 of file BitFlag.hh.

◆ MAX_CAPACITY

template<typename T , typename E >

size_t EGG::TBitFlag< T, E >::MAX_CAPACITY = std::numeric_limits<T>::digits

staticconstexprprivate

Definition at line 203 of file BitFlag.hh.

Description

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Member Typedef Documentation

◆ EI

Constructor & Destructor Documentation

◆ TBitFlag() [1/3]

◆ TBitFlag() [2/3]

◆ TBitFlag() [3/3]

Member Function Documentation

◆ change()

◆ changeBit()

◆ changeBit_()

◆ getDirect()

◆ makeAllZero()

◆ makeMask()

◆ makeMask_()

◆ maskBit()

◆ off()

◆ offBit()

◆ offBit_()

◆ on()

◆ onAll()

◆ onBit()

◆ onBit_()

◆ operator T()

◆ operator=()

◆ reset()

◆ resetBit()

◆ resetBit_()

◆ set()

◆ setBit()

◆ setBit_()

◆ setDirect()

◆ toggleBit()

◆ toggleBit_()

Member Data Documentation

◆ bits

◆ MAX_CAPACITY