Add bitset utility functions

Implement utility functions to set, clear, toggle, and query a bitset
for more concise code.

Author: falbrechtskirchinger

libs/common/include/s25util/enumUtils.h

@@ -4,6 +4,7 @@
 
 #pragma once
 
+#include <boost/config.hpp>
 #include <type_traits>
 
 template<typename Enum>
@@ -31,17 +32,45 @@ constexpr auto operator|(Enum lhs, Enum rhs) noexcept
 }
 
 template<typename Enum, typename = require_validBitset<Enum>>
-constexpr auto operator&=(Enum& lhs, Enum rhs) noexcept
+constexpr Enum& operator&=(Enum& lhs, Enum rhs) noexcept
 {
     return lhs = lhs & rhs;
 }
 
 template<typename Enum, typename = require_validBitset<Enum>>
-constexpr auto operator|=(Enum& lhs, Enum rhs) noexcept
+constexpr Enum& operator|=(Enum& lhs, Enum rhs) noexcept
 {
     return lhs = lhs | rhs;
 }
 
+namespace bitset {
+template<typename Enum, typename = require_validBitset<Enum>>
+BOOST_ATTRIBUTE_NODISCARD constexpr Enum clear(const Enum val, const Enum flag)
+{
+    using Int = std::underlying_type_t<Enum>;
+    return val & Enum(~static_cast<const Int>(flag));
+}
+
+template<typename Enum, typename = require_validBitset<Enum>>
+BOOST_ATTRIBUTE_NODISCARD constexpr Enum set(const Enum val, const Enum flag, const bool state = true)
+{
+    return state ? (val | flag) : clear(val, flag);
+}
+
+template<typename Enum, typename = require_validBitset<Enum>>
+BOOST_ATTRIBUTE_NODISCARD constexpr Enum toggle(const Enum val, const Enum flag)
+{
+    using Int = std::underlying_type_t<Enum>;
+    return Enum(static_cast<const Int>(val) ^ static_cast<const Int>(flag));
+}
+
+template<typename Enum, typename = require_validBitset<Enum>>
+BOOST_ATTRIBUTE_NODISCARD constexpr bool isSet(const Enum val, const Enum flag)
+{
+    return (val & flag) == flag;
+}
+} // namespace bitset
+
 /// Makes a strongly typed enum usable as a bitset
 #define MAKE_BITSET_STRONG(Type)                                         \
     template<>                                                           \