enums.hxx

Go to the documentation of this file.

/*
 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
 *
 * This file is part of StormByte.
 *
 * StormByte is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * or later, as published by the Free Software Foundation.
 *
 * 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
 * along with StormByte. If not, see
 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
 */
 
#pragma once
 
// UnsignedEnum reuses Unsigned on the enum's underlying type.
#include <StormByte/type_traits/categories.hxx>
 
#include <type_traits>
 
namespace StormByte {
    namespace Type {
        template<typename E>
        concept Enum = std::is_enum_v<std::remove_cv_t<E>>;
 
        template<typename E>
        concept UnsignedEnum =
            Enum<E> &&
            Unsigned<std::underlying_type_t<std::remove_cv_t<E>>>;
 
        template<typename E>
        concept ScopedEnum = std::is_scoped_enum_v<E>;
 
        template<typename E>
        requires Enum<E>
        using UnderlyingType = std::underlying_type_t<std::remove_cv_t<E>>;
 
        template<typename E>
        requires Enum<E>
        constexpr UnderlyingType<E> ToUnderlying(E e) noexcept {
            return static_cast<UnderlyingType<E>>(e);
        }
    }
}