bits.h

Go to the documentation of this file.

//   Copyright 2016-2023 Jean-Francois Poilpret
//
//   Licensed under the Apache License, Version 2.0 (the "License");
//   you may not use this file except in compliance with the License.
//   You may obtain a copy of the License at
//
//       http://www.apache.org/licenses/LICENSE-2.0
//
//   Unless required by applicable law or agreed to in writing, software
//   distributed under the License is distributed on an "AS IS" BASIS,
//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//   See the License for the specific language governing permissions and
//   limitations under the License.
 
 
#ifndef BITS_HH
#define BITS_HH
 
#include <stdint.h>
 
namespace bits
{
    static constexpr uint8_t BV8(uint8_t bit)
    {
        return uint8_t(1 << bit);
    }
 
    static constexpr uint8_t BV8(uint8_t bit1, uint8_t bit2)
    {
        return uint8_t(BV8(bit1) | BV8(bit2));
    }
 
    static constexpr uint8_t BV8(uint8_t bit1, uint8_t bit2, uint8_t bit3)
    {
        return uint8_t(BV8(bit1, bit2) | BV8(bit3));
    }
 
    static constexpr uint8_t BV8(uint8_t bit1, uint8_t bit2, uint8_t bit3, uint8_t bit4)
    {
        return uint8_t(BV8(bit1, bit2) | BV8(bit3, bit4));
    }
 
    static constexpr uint8_t BV8(uint8_t bit1, uint8_t bit2, uint8_t bit3, uint8_t bit4, uint8_t bit5)
    {
        return uint8_t(BV8(bit1, bit2, bit3) | BV8(bit4, bit5));
    }
 
    static constexpr uint8_t BV8(uint8_t bit1, uint8_t bit2, uint8_t bit3, uint8_t bit4, uint8_t bit5, uint8_t bit6)
    {
        return uint8_t(BV8(bit1, bit2, bit3) | BV8(bit4, bit5, bit6));
    }
 
    static constexpr uint8_t CBV8(uint8_t bit)
    {
        return uint8_t(~BV8(bit));
    }
 
    static constexpr uint16_t BV16(uint8_t bit)
    {
        return uint16_t(1 << bit);
    }
 
    static constexpr uint16_t BV16(uint8_t bit1, uint8_t bit2)
    {
        return uint16_t(BV16(bit1) | BV16(bit2));
    }
 
    static constexpr uint16_t BV16(uint8_t bit1, uint8_t bit2, uint8_t bit3)
    {
        return uint16_t(BV16(bit1, bit2) | BV16(bit3));
    }
 
    static constexpr uint16_t BV16(uint8_t bit1, uint8_t bit2, uint8_t bit3, uint8_t bit4)
    {
        return uint16_t(BV16(bit1, bit2) | BV16(bit3, bit4));
    }
 
    static constexpr uint16_t BV16(uint8_t bit1, uint8_t bit2, uint8_t bit3, uint8_t bit4, uint8_t bit5)
    {
        return uint16_t(BV16(bit1, bit2, bit3) | BV16(bit4, bit5));
    }
 
    static constexpr uint16_t BV16(uint8_t bit1, uint8_t bit2, uint8_t bit3, uint8_t bit4, uint8_t bit5, uint8_t bit6)
    {
        return uint16_t(BV16(bit1, bit2, bit3) | BV16(bit4, bit5, bit6));
    }
 
    static constexpr uint16_t CBV16(uint8_t bit)
    {
        return uint16_t(~BV16(bit));
    }
 
    static constexpr uint8_t COMPL(uint8_t value)
    {
        return uint8_t(~value);
    }
 
    static constexpr uint8_t LOW_BYTE(uint16_t value)
    {
        return uint8_t(value & uint16_t(UINT8_MAX));
    }
 
    static constexpr uint8_t HIGH_BYTE(uint16_t value)
    {
        return uint8_t(value >> 8);
    }
 
    static constexpr uint8_t OR8(uint8_t val1, uint8_t val2)
    {
        return uint8_t(val1 | val2);
    }
 
    static constexpr uint8_t OR8(uint8_t val1, uint8_t val2, uint8_t val3)
    {
        return uint8_t(val1 | OR8(val2, val3));
    }
 
    static constexpr uint8_t OR8(uint8_t val1, uint8_t val2, uint8_t val3, uint8_t val4)
    {
        return uint8_t(OR8(val1, val2) | OR8(val3, val4));
    }
 
    static constexpr uint8_t OR8(uint8_t val1, uint8_t val2, uint8_t val3, uint8_t val4, uint8_t val5)
    {
        return uint8_t(val1 | OR8(val2, val3, val4, val5));
    }
 
    static constexpr uint8_t OR8(uint8_t val1, uint8_t val2, uint8_t val3, uint8_t val4, uint8_t val5, uint8_t val6)
    {
        return uint8_t(OR8(val1, val2, val3) | OR8(val4, val5, val6));
    }
 
    static constexpr uint8_t IF8(bool flag, uint8_t val)
    {
        return uint8_t(flag ? val : 0U);
    }
 
    static constexpr uint8_t ORIF8(bool flag1, uint8_t val1, bool flag2, uint8_t val2)
    {
        return OR8(IF8(flag1, val1), IF8(flag2, val2));
    }
 
    static constexpr uint8_t ORIF8(bool flag1, uint8_t val1, bool flag2, uint8_t val2, bool flag3, uint8_t val3)
    {
        return OR8(IF8(flag1, val1), IF8(flag2, val2), IF8(flag3, val3));
    }
 
    static constexpr uint8_t ORIF8(
        bool flag1, uint8_t val1, bool flag2, uint8_t val2, bool flag3, uint8_t val3, bool flag4, uint8_t val4)
    {
        return OR8(IF8(flag1, val1), IF8(flag2, val2), IF8(flag3, val3), IF8(flag4, val4));
    }
 
    static constexpr uint8_t ORIF8(bool flag1, uint8_t val1, bool flag2, uint8_t val2, bool flag3, uint8_t val3, 
        bool flag4, uint8_t val4, bool flag5, uint8_t val5)
    {
        return OR8(IF8(flag1, val1), IF8(flag2, val2), IF8(flag3, val3), IF8(flag4, val4), IF8(flag5, val5));
    }
 
    static constexpr uint8_t ORIF8(bool flag1, uint8_t val1, bool flag2, uint8_t val2, bool flag3, uint8_t val3, 
        bool flag4, uint8_t val4, bool flag5, uint8_t val5, bool flag6, uint8_t val6)
    {
        return OR8(IF8(flag1, val1), IF8(flag2, val2), IF8(flag3, val3), 
            IF8(flag4, val4), IF8(flag5, val5), IF8(flag6, val6));
    }
}
 
#endif /* BITS_HH */