mirror
/
OpenTTD
mirror of https://github.com/OpenTTD/OpenTTD
1
0
Fork 0
Code Issues

Codechange: Allow masking invalid values passed to EnumBitSet.

pull/13490/head
Peter Nelson 2025-02-06 02:51:33 +00:00 committed by Peter Nelson
parent bb43d60064
commit 965a45812a
1 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
src/core/enum_type.hpp
View File

@ -111,18 +111,21 @@ debug_inline constexpr void ToggleFlag(T &x, const T y)
/**
* Enum-as-bit-set wrapper.
* Allows wrapping enum values as a bit set. Methods are loosely modelled on std::bitset.
* @note Only set Tend_value if the bitset needs to be automatically masked to valid values.
* @tparam Tenum Enum values to wrap.
* @tparam Tsorage Storage type required to hold eenum values.
* @tparam Tstorage Storage type required to hold eenum values.
* @tparam Tend_value Last valid value + 1.
*/
template <typename Tenum, typename Tstorage>
template <typename Tenum, typename Tstorage, Tenum Tend_value = Tenum{std::numeric_limits<Tstorage>::digits}>
class EnumBitSet {
public:
using EnumType = Tenum; ///< Enum type of this EnumBitSet.
using BaseType = Tstorage; ///< Storage type of this EnumBitSet, be ConvertibleThroughBase
static constexpr Tstorage MASK = std::numeric_limits<Tstorage>::max() >> (std::numeric_limits<Tstorage>::digits - to_underlying(Tend_value)); ///< Mask of valid values.
constexpr EnumBitSet() : data(0) {}
constexpr EnumBitSet(Tenum value) : data(0) { this->Set(value); }
explicit constexpr EnumBitSet(Tstorage data) : data(data) {}
explicit constexpr EnumBitSet(Tstorage data) : data(data & MASK) {}
/**
* Construct an EnumBitSet from a list of enum values.
@ -213,6 +216,15 @@ public:
return EnumBitSet{static_cast<Tstorage>(this->data & other.data)};
}
/**
* Test that the raw value of this EnumBitSet is valid.
* @returns true iff the no bits outside the masked value are set.
*/
inline constexpr bool IsValid() const
{
return (this->data & MASK) == this->data;
}
/**
* Retrieve the raw value behind this EnumBitSet.
* @returns the raw value.