BitUtil.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_BITUTIL_H
#define IMT_BASE_CORE_UTIL_BITUTIL_H
 
#include <Imt.Base.Core.Diagnostics/Diagnostics.h>
#include <Imt.Base.Core.Platform/Platform.h>
#include <Imt.Base.Core.Platform/StaticClass.h>
 
// Mask template arguments are of type unsigned because of the IAR/R8C compiler. Otherwise this code would not compile!
 
namespace imt {
namespace base {
namespace core {
namespace util {
 
class BitUtil final : private ::imt::base::core::platform::StaticClass {
 
public:
 
    template<uint8_t Bit, typename T>
    static bool isBitSet(T const data) noexcept {
        static_assert(Bit < (sizeof(T) * CHAR_BIT), "Bit index out of range");
        T const mask {static_cast<T>(0x01U) << Bit};
        return (data & mask) != 0;
    }
 
    template<typename T>
    static bool isBitSet(T const data, uint8_t const bit) noexcept {
        T mask {0};
        // Does Bit fit into the datatype T
        if (bit < (sizeof(T) * CHAR_BIT)) {
            mask = static_cast<T>(0x01U) << bit;
        }
        return (data & mask) != 0;
    }
 
    template<uint8_t Bit, typename T>
    static void setBit(T& data) noexcept {
        static_assert(Bit < (sizeof(T) * CHAR_BIT), "Bit index out of range");
        data |= static_cast<T>(0x01U) << Bit;
    }
 
    template<typename T>
    static void setBit(T& data, uint8_t const bit) noexcept {
        ASSERT_DEBUG(bit < (sizeof(T) * CHAR_BIT));
        data |= static_cast<T>(0x01U) << bit;
    }
 
    template<uint8_t Bit, typename T>
    static void clearBit(T& data) noexcept {
        static_assert(Bit < (sizeof(T) * CHAR_BIT), "Bit index out of range");
        T const bitSelection {static_cast<T>(0x01U) << Bit};
        data &= static_cast<T>(~bitSelection);
    }
 
    template<typename T>
    static void clearBit(T& data, uint8_t const bit) noexcept {
        ASSERT_DEBUG(bit < (sizeof(T) * CHAR_BIT));
        T const bitSelection {static_cast<T>(0x01U << bit)};
        data &= static_cast<T>(~bitSelection);
    }
 
    // AXIVION Next Line AutosarC++19_03-A3.9.1: Allowed usage, compatibility purposes
    template<unsigned Mask, typename T>
    static T filterBits(T const data) noexcept {
        return static_cast<T>(data & Mask);
    }
 
    // AXIVION Next Line AutosarC++19_03-A3.9.1: Allowed usage, compatibility purposes
    template<unsigned Mask, unsigned CheckValue, typename T>
    static bool matchBits(T const data) noexcept {
        // Value does not contain any bits which are not in the mask
        static_assert((~Mask & CheckValue) == 0, "Value does not contain any bits which are not in the mask");
        return filterBits<Mask, T>(data) == CheckValue;
    }
 
    // AXIVION Next Line AutosarC++19_03-A3.9.1: Allowed usage, compatibility purposes
    template<unsigned Mask, typename T>
    static void setBits(T& data, T const value) noexcept {
        data |= Mask & value;
    }
 
    // AXIVION Next Line AutosarC++19_03-A3.9.1: Allowed usage, compatibility purposes
    template<unsigned Mask, typename T>
    static void clearBits(T& data, T const value) noexcept {
        data &= ~(Mask & value);
    }
 
    // AXIVION Next Line AutosarC++19_03-A3.9.1: Allowed usage, compatibility purposes
    template<unsigned Mask, typename T>
    static void changeBits(T& data, T const value) noexcept {
        clearBits<Mask, T>(data, ~value);
        setBits<Mask, T>(data, value);
    }
 
    template<uint8_t Bit, typename T>
    static void changeBit(T& data, bool const value) noexcept {
        // Does Bit fit into the datatype T
        static_assert(Bit < (sizeof(T) * CHAR_BIT), "Bit index out of range");
        if (value) {
            setBit<Bit, T>(data);
        }
        else {
            clearBit<Bit, T>(data);
        }
    }
 
    template<typename T>
    static void changeBit(T& data, uint8_t const bit, bool const value) noexcept {
        // Does Bit fit into the datatype T
        ASSERT_DEBUG(bit < (sizeof(T) * CHAR_BIT));
        if (value) {
            setBit<T>(data, bit);
        }
        else {
            clearBit<T>(data, bit);
        }
    }
};
 
} // namespace util
} // namespace core
} // namespace base
} // namespace imt
 
#endif // IMT_BASE_CORE_UTIL_BITUTIL_H