michael@0: /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
michael@0: /* vim: set ts=8 sts=2 et sw=2 tw=80: */
michael@0: /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0:  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: 
michael@0: /* MOZ_MAKE_ENUM_CLASS_BITWISE_OPERATORS allows using a typed enum as bit flags. */
michael@0: 
michael@0: #ifndef mozilla_TypedEnumBits_h
michael@0: #define mozilla_TypedEnumBits_h
michael@0: 
michael@0: #include "mozilla/IntegerTypeTraits.h"
michael@0: #include "mozilla/TypedEnumInternal.h"
michael@0: 
michael@0: namespace mozilla {
michael@0: 
michael@0: #define MOZ_CASTABLETYPEDENUMRESULT_BINOP(Op, OtherType, ReturnType) \
michael@0: template<typename E> \
michael@0: MOZ_CONSTEXPR ReturnType \
michael@0: operator Op(const OtherType& e, const CastableTypedEnumResult<E>& r) \
michael@0: { \
michael@0:   return ReturnType(e Op OtherType(r)); \
michael@0: } \
michael@0: template<typename E> \
michael@0: MOZ_CONSTEXPR ReturnType \
michael@0: operator Op(const CastableTypedEnumResult<E>& r, const OtherType& e) \
michael@0: { \
michael@0:   return ReturnType(OtherType(r) Op e); \
michael@0: } \
michael@0: template<typename E> \
michael@0: MOZ_CONSTEXPR ReturnType \
michael@0: operator Op(const CastableTypedEnumResult<E>& r1, \
michael@0:             const CastableTypedEnumResult<E>& r2) \
michael@0: { \
michael@0:   return ReturnType(OtherType(r1) Op OtherType(r2)); \
michael@0: }
michael@0: 
michael@0: MOZ_CASTABLETYPEDENUMRESULT_BINOP(|, E, CastableTypedEnumResult<E>)
michael@0: MOZ_CASTABLETYPEDENUMRESULT_BINOP(&, E, CastableTypedEnumResult<E>)
michael@0: MOZ_CASTABLETYPEDENUMRESULT_BINOP(^, E, CastableTypedEnumResult<E>)
michael@0: MOZ_CASTABLETYPEDENUMRESULT_BINOP(==, E, bool)
michael@0: MOZ_CASTABLETYPEDENUMRESULT_BINOP(!=, E, bool)
michael@0: MOZ_CASTABLETYPEDENUMRESULT_BINOP(||, bool, bool)
michael@0: MOZ_CASTABLETYPEDENUMRESULT_BINOP(&&, bool, bool)
michael@0: 
michael@0: template <typename E>
michael@0: MOZ_CONSTEXPR CastableTypedEnumResult<E>
michael@0: operator ~(const CastableTypedEnumResult<E>& r)
michael@0: {
michael@0:   return CastableTypedEnumResult<E>(~(E(r)));
michael@0: }
michael@0: 
michael@0: #define MOZ_CASTABLETYPEDENUMRESULT_COMPOUND_ASSIGN_OP(Op) \
michael@0: template<typename E> \
michael@0: E& \
michael@0: operator Op(E& r1, \
michael@0:             const CastableTypedEnumResult<E>& r2) \
michael@0: { \
michael@0:   return r1 Op E(r2); \
michael@0: }
michael@0: 
michael@0: MOZ_CASTABLETYPEDENUMRESULT_COMPOUND_ASSIGN_OP(&=)
michael@0: MOZ_CASTABLETYPEDENUMRESULT_COMPOUND_ASSIGN_OP(|=)
michael@0: MOZ_CASTABLETYPEDENUMRESULT_COMPOUND_ASSIGN_OP(^=)
michael@0: 
michael@0: #undef MOZ_CASTABLETYPEDENUMRESULT_COMPOUND_ASSIGN_OP
michael@0: 
michael@0: #undef MOZ_CASTABLETYPEDENUMRESULT_BINOP
michael@0: 
michael@0: #ifndef MOZ_HAVE_CXX11_STRONG_ENUMS
michael@0: 
michael@0: #define MOZ_CASTABLETYPEDENUMRESULT_BINOP_EXTRA_NON_CXX11(Op, ReturnType) \
michael@0: template<typename E> \
michael@0: MOZ_CONSTEXPR ReturnType \
michael@0: operator Op(typename E::Enum e, const CastableTypedEnumResult<E>& r) \
michael@0: { \
michael@0:   return ReturnType(e Op E(r)); \
michael@0: } \
michael@0: template<typename E> \
michael@0: MOZ_CONSTEXPR ReturnType \
michael@0: operator Op(const CastableTypedEnumResult<E>& r, typename E::Enum e) \
michael@0: { \
michael@0:   return ReturnType(E(r) Op e); \
michael@0: }
michael@0: 
michael@0: MOZ_CASTABLETYPEDENUMRESULT_BINOP_EXTRA_NON_CXX11(|, CastableTypedEnumResult<E>)
michael@0: MOZ_CASTABLETYPEDENUMRESULT_BINOP_EXTRA_NON_CXX11(&, CastableTypedEnumResult<E>)
michael@0: MOZ_CASTABLETYPEDENUMRESULT_BINOP_EXTRA_NON_CXX11(^, CastableTypedEnumResult<E>)
michael@0: MOZ_CASTABLETYPEDENUMRESULT_BINOP_EXTRA_NON_CXX11(==, bool)
michael@0: MOZ_CASTABLETYPEDENUMRESULT_BINOP_EXTRA_NON_CXX11(!=, bool)
michael@0: 
michael@0: #undef MOZ_CASTABLETYPEDENUMRESULT_BINOP_EXTRA_NON_CXX11
michael@0: 
michael@0: #endif // not MOZ_HAVE_CXX11_STRONG_ENUMS
michael@0: 
michael@0: namespace detail {
michael@0: template<typename E>
michael@0: struct UnsignedIntegerTypeForEnum
michael@0:   : UnsignedStdintTypeForSize<sizeof(E)>
michael@0: {};
michael@0: }
michael@0: 
michael@0: } // namespace mozilla
michael@0: 
michael@0: #define MOZ_MAKE_ENUM_CLASS_BINOP_IMPL(Name, Op) \
michael@0:    inline MOZ_CONSTEXPR mozilla::CastableTypedEnumResult<Name> \
michael@0:    operator Op(Name a, Name b) \
michael@0:    { \
michael@0:      typedef mozilla::CastableTypedEnumResult<Name> Result; \
michael@0:      typedef mozilla::detail::UnsignedIntegerTypeForEnum<Name>::Type U; \
michael@0:      return Result(Name(U(a) Op U(b))); \
michael@0:    } \
michael@0:  \
michael@0:    inline Name& \
michael@0:    operator Op##=(Name& a, Name b) \
michael@0:    { \
michael@0:      return a = a Op b; \
michael@0:    }
michael@0: 
michael@0: #define MOZ_MAKE_ENUM_CLASS_OPS_IMPL(Name) \
michael@0:    MOZ_MAKE_ENUM_CLASS_BINOP_IMPL(Name, |) \
michael@0:    MOZ_MAKE_ENUM_CLASS_BINOP_IMPL(Name, &) \
michael@0:    MOZ_MAKE_ENUM_CLASS_BINOP_IMPL(Name, ^) \
michael@0:    inline MOZ_CONSTEXPR mozilla::CastableTypedEnumResult<Name> \
michael@0:    operator~(Name a) \
michael@0:    { \
michael@0:      typedef mozilla::CastableTypedEnumResult<Name> Result; \
michael@0:      typedef mozilla::detail::UnsignedIntegerTypeForEnum<Name>::Type U; \
michael@0:      return Result(Name(~(U(a)))); \
michael@0:    }
michael@0: 
michael@0: #ifndef MOZ_HAVE_CXX11_STRONG_ENUMS
michael@0: #  define MOZ_MAKE_ENUM_CLASS_BITWISE_BINOP_EXTRA_NON_CXX11(Name, Op) \
michael@0:      inline MOZ_CONSTEXPR mozilla::CastableTypedEnumResult<Name> \
michael@0:      operator Op(Name a, Name::Enum b) \
michael@0:      { \
michael@0:        return a Op Name(b); \
michael@0:      } \
michael@0:  \
michael@0:      inline MOZ_CONSTEXPR mozilla::CastableTypedEnumResult<Name> \
michael@0:      operator Op(Name::Enum a, Name b) \
michael@0:      { \
michael@0:        return Name(a) Op b; \
michael@0:      } \
michael@0:  \
michael@0:      inline MOZ_CONSTEXPR mozilla::CastableTypedEnumResult<Name> \
michael@0:      operator Op(Name::Enum a, Name::Enum b) \
michael@0:      { \
michael@0:        return Name(a) Op Name(b); \
michael@0:      } \
michael@0:  \
michael@0:      inline Name& \
michael@0:      operator Op##=(Name& a, Name::Enum b) \
michael@0:      { \
michael@0:        return a = a Op Name(b); \
michael@0:     }
michael@0: 
michael@0: #  define MOZ_MAKE_ENUM_CLASS_OPS_EXTRA_NON_CXX11(Name) \
michael@0:      MOZ_MAKE_ENUM_CLASS_BITWISE_BINOP_EXTRA_NON_CXX11(Name, |) \
michael@0:      MOZ_MAKE_ENUM_CLASS_BITWISE_BINOP_EXTRA_NON_CXX11(Name, &) \
michael@0:      MOZ_MAKE_ENUM_CLASS_BITWISE_BINOP_EXTRA_NON_CXX11(Name, ^) \
michael@0:      inline MOZ_CONSTEXPR mozilla::CastableTypedEnumResult<Name> \
michael@0:      operator~(Name::Enum a) \
michael@0:      { \
michael@0:        return ~(Name(a)); \
michael@0:      }
michael@0: #endif
michael@0: 
michael@0: /**
michael@0:  * MOZ_MAKE_ENUM_CLASS_BITWISE_OPERATORS generates standard bitwise operators
michael@0:  * for the given enum type. Use this to enable using an enum type as bit-field.
michael@0:  */
michael@0: #ifdef MOZ_HAVE_CXX11_STRONG_ENUMS
michael@0: #  define MOZ_MAKE_ENUM_CLASS_BITWISE_OPERATORS(Name) \
michael@0:      MOZ_MAKE_ENUM_CLASS_OPS_IMPL(Name)
michael@0: #else
michael@0: #  define MOZ_MAKE_ENUM_CLASS_BITWISE_OPERATORS(Name) \
michael@0:      MOZ_MAKE_ENUM_CLASS_OPS_IMPL(Name) \
michael@0:      MOZ_MAKE_ENUM_CLASS_OPS_EXTRA_NON_CXX11(Name)
michael@0: #endif
michael@0: 
michael@0: #endif // mozilla_TypedEnumBits_h