bitmask.hxx

Go to the documentation of this file.

/*
 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
 *
 * This file is part of StormByte.
 *
 * StormByte original source is dual-licensed:
 *
 * 1. GNU Lesser General Public License v3.0 (or later)
 *    You may redistribute and/or modify this file under the terms of the
 *    GNU Lesser General Public License as published by the Free Software
 *    Foundation, either version 3 of the License, or (at your option)
 *    any later version.
 *
 * 2. Commercial license
 *    Alternatively, this file may be used under the terms of a commercial
 *    license agreement with the copyright holder
 *    (David C. Manuelda <StormByte@gmail.com>).
 *
 * Both licenses apply only to original StormByte source in this repository.
 * They do not cover other StormByte modules or any third-party material
 * shipped with this repository (including everything under thirdparty/),
 * which remains under its own license.
 *
 * Neither license grants any patent rights. Any patent licenses required
 * to use this software or third-party components must be obtained separately
 * from the patent holders.
 *
 * StormByte is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with StormByte. If not, see
 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
 *
 * SPDX-License-Identifier: LGPL-3.0-or-later OR LicenseRef-StormByte-Commercial
 */
 
#pragma once
 
#include <StormByte/type_traits.hxx>
 
using namespace StormByte;
 
template <Type::UnsignedEnum E>
constexpr E operator|(E a, E b) noexcept {
    return static_cast<E>(Type::ToUnderlying(a) | Type::ToUnderlying(b));
}
 
template <Type::UnsignedEnum E>
constexpr E operator&(E a, E b) noexcept {
    return static_cast<E>(Type::ToUnderlying(a) & Type::ToUnderlying(b));
}
 
template <Type::UnsignedEnum E>
constexpr E operator^(E a, E b) noexcept {
    return static_cast<E>(Type::ToUnderlying(a) ^ Type::ToUnderlying(b));
}
 
template <Type::UnsignedEnum E>
constexpr E operator~(E a) noexcept {
    return static_cast<E>(~Type::ToUnderlying(a));
}
 
namespace StormByte {
    template<typename Derived, Type::UnsignedEnum E>
    class Bitmask {
        public:
            constexpr Bitmask() noexcept: m_value(static_cast<E>(0)) {}
 
            constexpr Bitmask(E value) noexcept: m_value(value) {}
 
            constexpr Bitmask(const Bitmask& other) noexcept = default;
 
            constexpr Bitmask(Bitmask&& other) noexcept = default;
 
            constexpr virtual ~Bitmask() noexcept = default;
 
            constexpr Bitmask& operator=(const Bitmask& other) noexcept = default;
 
            constexpr Bitmask& operator=(Bitmask&& other) noexcept = default;
 
            constexpr bool operator==(const Bitmask& other) const noexcept;
 
            constexpr bool operator!=(const Bitmask& other) const noexcept;
 
            constexpr Derived operator|(const Bitmask& other) const noexcept;
 
            constexpr Derived operator&(const Bitmask& other) const noexcept;
 
            constexpr Derived operator^(const Bitmask& other) const noexcept;
 
            constexpr Derived operator~() const noexcept;
 
            constexpr Bitmask& operator|=(const Bitmask& other) noexcept;
 
            constexpr Bitmask& operator&=(const Bitmask& other) noexcept;
 
            constexpr Bitmask& operator^=(const Bitmask& other) noexcept;
 
            constexpr void Add(E value) noexcept;
 
            constexpr void Remove(E value) noexcept;
 
            constexpr E Value() const noexcept;
 
            constexpr bool Has(E value) const noexcept;
 
            constexpr bool Has(const Bitmask& other) const noexcept;
 
            constexpr bool HasAny(E value) const noexcept;
 
            constexpr bool HasAny(const Bitmask& other) const noexcept;
 
            constexpr bool HasNone(E value) const noexcept;
 
            constexpr bool HasNone(const Bitmask& other) const noexcept;
 
        protected:
            E m_value;  
    };
}
 
#include <StormByte/bitmask.txx>