BitArray.hpp

Go to the documentation of this file.

/* ✔ */
 
#pragma once
 
#include <AH/Settings/Warnings.hpp>
 
AH_DIAGNOSTIC_WERROR() // Enable errors on warnings
 
#include <AH/Error/Error.hpp>
#include <AH/Settings/NamespaceSettings.hpp>
#include <stdint.h>
 
BEGIN_AH_NAMESPACE
 
 
template <uint16_t N>
class BitArray {
  public:
    bool get(uint16_t bitIndex) const {
        return buffer[getBufferIndex(bitIndex)] & getBufferMask(bitIndex);
    }
 
    void set(uint16_t bitIndex) {
        buffer[getBufferIndex(bitIndex)] |= getBufferMask(bitIndex);
    }
 
    void clear(uint16_t bitIndex) {
        buffer[getBufferIndex(bitIndex)] &= ~getBufferMask(bitIndex);
    }
 
    void set(uint16_t bitIndex, bool state) {
        state ? set(bitIndex) : clear(bitIndex);
    }
 
    uint16_t safeIndex(uint16_t byteIndex) const {
        if (byteIndex >= getBufferLength()) {
            ERROR(F("Error: index out of bounds (")
                      << byteIndex << F(", length is ") << getBufferLength()
                      << ')',
                  0xFFFF);
            return getBufferLength() - 1; // LCOV_EXCL_LINE
        }
        return byteIndex;
    }
 
    const uint8_t &getByte(uint16_t byteIndex) const {
        return buffer[byteIndex];
        // return buffer[safeIndex(byteIndex)];
    }
    uint8_t &getByte(uint16_t byteIndex) {
        return buffer[byteIndex];
        // return buffer[safeIndex(byteIndex)];
    }
 
    void setByte(uint16_t byteIndex, uint8_t value) {
        buffer[byteIndex] = value;
    }
 
    uint16_t getBufferLength() const { return bufferLength; }
 
  private:
    uint16_t getBufferIndex(uint16_t bitIndex) const {
        return safeIndex(bitIndex / 8);
    }
    uint8_t getBufferBit(uint16_t bitIndex) const { return bitIndex % 8; }
    uint8_t getBufferMask(uint16_t bitIndex) const {
        return 1 << getBufferBit(bitIndex);
    }
 
    constexpr static uint16_t bufferLength = (uint16_t)((N + 7) / 8);
    uint8_t buffer[bufferLength] = {};
};
 
 
END_AH_NAMESPACE
 
AH_DIAGNOSTIC_POP()