Flags.h

Go to the documentation of this file.

 
// ###########################################################################################################################################################################################################################################################################################################################
 
#pragma once
 
// OpenTwin header
#include "OTSystem/ArchitectureInfo.h"
#include "OTCore/CoreAPIExport.h"
 
// std header
#include <type_traits>
 
#define OT_ADD_FLAG_FUNCTIONS_IMPL(___prefix, ___castType, ___enumName) ___prefix constexpr ___enumName operator | (___enumName _lhv, ___enumName _rhv) { return static_cast<___enumName>(static_cast<___castType>(_lhv) | static_cast<___castType>(_rhv)); }; \
___prefix constexpr ___enumName operator & (___enumName _lhv, ___enumName _rhv) { return static_cast<___enumName>(static_cast<___castType>(_lhv) & static_cast<___castType>(_rhv)); };  \
___prefix constexpr ___enumName operator ~ (___enumName _lhv) { return static_cast<___enumName>(~(static_cast<___castType>(_lhv))); };
 
#ifdef OT_OS_64Bit
 
#define OT_ADD_FLAG_FUNCTIONS(___enumName) OT_ADD_FLAG_FUNCTIONS_IMPL(, long long, ___enumName)
 
#define OT_ADD_FRIEND_FLAG_FUNCTIONS(___enumName) OT_ADD_FLAG_FUNCTIONS_IMPL(friend , long long, ___enumName)
 
#else
 
#define OT_ADD_FLAG_FUNCTIONS(___enumName) OT_ADD_FLAG_FUNCTIONS_IMPL(, long, ___enumName)
 
#define OT_ADD_FRIEND_FLAG_FUNCTIONS(___enumName) OT_ADD_FLAG_FUNCTIONS_IMPL(friend , long, ___enumName)
 
#endif
 
namespace ot {
 
    template<typename T> class OT_CORE_API_EXPORTONLY Flags {
    private:
#ifdef OT_OS_64Bit
        typedef long long FlagCastType;
#else
        typedef long FlagCastType;
#endif // _WIN64
 
        static_assert((sizeof(T) <= sizeof(FlagCastType)), "Flags type may overflow.");
        static_assert((std::is_enum<T>::value), "Flags accept only enumeration types.");
 
        T m_data; 
 
    public:
        inline Flags() : m_data{ static_cast<T>(0) } {};
 
        inline Flags(T _initialData) : m_data{ _initialData } {}
 
        inline Flags(const Flags<T>& _other) : m_data{ _other.data() } {};
        
        inline Flags(Flags&& _other) noexcept : m_data(std::move(_other.m_data)) {};
 
        inline T data(void) const { return m_data; };
 
        inline void set(T _data) { m_data = _data; };
 
        inline void setFlag(T _flag) { m_data = m_data | _flag; };
 
        inline void setFlag(T _flag, bool _flagIsSet) {
            if (_flagIsSet) { m_data = m_data | _flag; }
            else { m_data = m_data & (~_flag); }
        };
 
        inline void removeFlag(T _flag) { m_data = m_data & (~_flag); };
 
        inline bool flagIsSet(T _flag) const { return (m_data & _flag); };
 
        inline operator T(void) const { return m_data; };
 
        inline operator bool(void) const { return (bool)m_data; };
 
        inline Flags<T>& operator = (T _flag) { m_data = _flag; return *this; };
        inline Flags<T>& operator = (const Flags<T>& _other) { m_data = _other.m_data; return *this; };
        inline Flags<T>& operator = (Flags<T>&& _other) { m_data = std::move(_other.m_data); return *this; };
 
        inline Flags<T> operator | (T _flag) const { return Flags<T>{ m_data | _flag }; };
        inline Flags<T> operator | (const Flags<T>& _other) const { return Flags<T>{ _other.m_data | m_data }; };
 
        inline Flags<T> operator & (T _flag) const { return Flags<T>{ m_data& _flag }; };
        inline Flags<T> operator & (const Flags<T>& _other) const { return Flags<T>{ _other.m_data& m_data }; };
 
        inline Flags<T>& operator |= (T _flag) { m_data = m_data | _flag; return *this; };
        inline Flags<T>& operator |= (const Flags<T>& _other) { m_data = m_data | _other.m_data; return *this; };
 
        inline Flags<T>& operator &= (T _flag) { m_data = m_data & _flag; return *this; };
        inline Flags<T>& operator &= (const Flags<T>& _other) { m_data = m_data & _other.m_data; return *this; };
 
        inline Flags<T> operator ~(void) const { return Flags<T>{ ~m_data }; };
 
        inline bool operator == (T _flag) const { return m_data == _flag; };
        inline bool operator == (const Flags<T>& _other) const { return m_data == _other.m_data; };
 
        inline bool operator != (T _flag) const { return m_data != _flag; };
        inline bool operator != (const Flags<T>& _other) const { return m_data != _other.m_data; };
    };
 
}