Flags.h

Go to the documentation of this file.

// (c) IMT - Information Management Technology AG, CH-9470 Buchs, www.imt.ch.
//
// ActiveParts (AP) and the corresponding Data Flow Framework (DFF) is invented and designed by Jakob Daescher.
// ANY USE OF THIS CODE CONSTITUTES ACCEPTANCE OF THE TERMS OF THE COPYRIGHT NOTICE.
// ===================================================================================================
// COPYRIGHT NOTICE
// ===================================================================================================
// Copyright (C) 2005-2075, IMT Information Management Technology AG, 9470 Buchs, Switzerland
// All rights reserved.
// This code is proprietary software of IMT Information Management Technology AG (hereinafter: "IMT").
// Proprietary software is computer software licensed under exclusive legal right of IMT.
//
// The licensee is given the irrevocable, perpetual, worldwide, non-exclusive right and license to use,
// execute and reproduce the software in binary form within the licensed products.
//
// Redistribution and use in source forms, without modification, are permitted provided that the following conditions are met:
// (1) Copying of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
// (2) Copying of source code is only allowed for regulatory documentation and archiving purposes
// (3) Redistributions in binary form must reproduce the above copyright notice,
//     this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
//
// IMT provide no reassurances that the source code provided does not infringe
// any patent, copyright, or any other intellectual property rights of third parties.
// IMT disclaim any liability to any recipient for claims brought against
// recipient by any third party for infringement of that parties intellectual property rights.
//
// THIS SOFTWARE IS PROVIDED BY IMT AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
// IN NO EVENT SHALL IMT OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
// OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCURE-MENT OF SUBSTITUTE GOODS OR SERVICES;
// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
// IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// ===================================================================================================
 
#ifndef IMT_BASE_CORE_UTIL_FLAGS_H
#define IMT_BASE_CORE_UTIL_FLAGS_H
 
#include <Imt.Base.Core.Diagnostics/Diagnostics.h>
#include <Imt.Base.Core.Platform/Platform.h>
#include <type_traits>
 
namespace imt {
namespace base {
namespace core {
namespace util {
 
template<typename EnumType, typename LimitsType, typename BaseType>
class Flags final {
 
public:
 
    Flags() noexcept;
 
    explicit Flags(EnumType const flag) noexcept;
 
    explicit Flags(BaseType const flags) noexcept;
 
    void set(EnumType const flag);
 
    void clear(EnumType const flag);
 
    bool isSet(EnumType const flag) const;
 
    BaseType const& toInteger() const;
 
    Flags combine(Flags const& other) const;
 
    Flags intersect(Flags const& other) const;
 
private:
 
    BaseType toBase(EnumType const flag) const;
 
    BaseType m_flags;
};
 
// implementation must be here because of linker
 
template<typename EnumType, typename LimitsType, typename BaseType>
Flags<EnumType, LimitsType, BaseType>::Flags() noexcept :
    Flags {0} {
    // the base type must be capable of holding all the flag bits
    static_assert((sizeof(BaseType) * 8U) >= LimitsType::MAX, "Base type size to small");
    // The enum must start at 0
    static_assert(LimitsType::MIN == 0, "Enum does not start at 0");
    // The enum max value must be correct
    static_assert(LimitsType::MAX == (LimitsType::COUNT - 1), "Enum not sequentialy numbered");
}
 
template<typename EnumType, typename LimitsType, typename BaseType>
Flags<EnumType, LimitsType, BaseType>::Flags(EnumType const flag) noexcept :
    Flags {toBase(flag)} {
}
 
template<typename EnumType, typename LimitsType, typename BaseType>
Flags<EnumType, LimitsType, BaseType>::Flags(BaseType const flags) noexcept :
    m_flags(flags) {
}
 
template<typename EnumType, typename LimitsType, typename BaseType>
void Flags<EnumType, LimitsType, BaseType>::set(EnumType const flag) {
    this->m_flags |= toBase(flag);
}
 
template<typename EnumType, typename LimitsType, typename BaseType>
void Flags<EnumType, LimitsType, BaseType>::clear(EnumType const flag) {
    this->m_flags &= ~(toBase(flag));
}
 
template<typename EnumType, typename LimitsType, typename BaseType>
bool Flags<EnumType, LimitsType, BaseType>::isSet(EnumType const flag) const {
    BaseType const mask {toBase(flag)};
    return (this->m_flags & mask) != 0;
}
 
template<typename EnumType, typename LimitsType, typename BaseType>
BaseType const& Flags<EnumType, LimitsType, BaseType>::toInteger() const {
    return this->m_flags;
}
 
template<typename EnumType, typename LimitsType, typename BaseType>
Flags<EnumType, LimitsType, BaseType> Flags<EnumType, LimitsType, BaseType>::combine(Flags const& other) const {
    return Flags(this->m_flags | other.m_flags);
}
 
template<typename EnumType, typename LimitsType, typename BaseType>
Flags<EnumType, LimitsType, BaseType> Flags<EnumType, LimitsType, BaseType>::intersect(Flags const& other) const {
    return Flags(this->m_flags & other.m_flags);
}
 
template<typename EnumType, typename LimitsType, typename BaseType>
BaseType Flags<EnumType, LimitsType, BaseType>::toBase(EnumType const flag) const {
    return static_cast<BaseType>(1U << static_cast<size_t>(flag));
}
 
template<typename EnumType, typename LimitsType, typename BaseType>
bool operator==(Flags<EnumType, LimitsType, BaseType> const& left, Flags<EnumType, LimitsType, BaseType> const& right) noexcept {
    return left.toInteger() == right.toInteger();
}
 
template<typename EnumType, typename LimitsType, typename BaseType>
bool operator!=(Flags<EnumType, LimitsType, BaseType> const& left, Flags<EnumType, LimitsType, BaseType> const& right) noexcept {
    return !(left == right);
}
 
} // namespace util
} // namespace core
} // namespace base
} // namespace imt
 
#endif // IMT_BASE_CORE_UTIL_FLAGS_H