enums.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/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);
        }
 
    }
}