error.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/safe/string.hxx>
#include <StormByte/visibility.h>
 
#include <concepts>
#include <string>
#include <system_error>
#include <type_traits>
 
namespace StormByte {
    namespace Error {
        template<typename Enum>
        struct Domain;
 
        template<typename Enum>
        concept Described = std::is_enum_v<Enum>
            && requires(Enum e) {
                { Domain<Enum>::Name } -> std::convertible_to<const char*>;
                { Domain<Enum>::Message(e) } -> std::convertible_to<std::string>;
            };
 
        template<Described Enum>
        class Category final: public std::error_category {
            public:
                const char* name() const noexcept override;
 
                std::string message(int ev) const override;
        };
 
        enum class Code {
            Success = 0,    
            Unknown         
        };
 
        template<>
        struct Domain<Code> {
            static constexpr const char* Name = "StormByte";    
 
            static std::string Message(Code e) {
                switch (e) {
                    case Code::Success:
                        return "Success";
                    case Code::Unknown:
                        return "Unknown StormByte error";
                }
                return "Unknown StormByte error";
            }
        };
 
        STORMBYTE_PUBLIC const Category<Code>& category() noexcept;
 
        STORMBYTE_PUBLIC std::error_code make_error_code(Code e) noexcept;
 
        class STORMBYTE_PUBLIC Fault {
            public:
                Fault() noexcept;
 
                explicit Fault(const std::error_code& code);
 
                template<Described Enum>
                explicit Fault(Enum e): Fault(make_error_code(e)) {}
 
                Fault(const Fault& other) = default;
 
                Fault(Fault&& other) noexcept = default;
 
                ~Fault() noexcept = default;
 
                Fault& operator=(const Fault& other) = default;
 
                Fault& operator=(Fault&& other) noexcept = default;
 
                const std::error_code& code() const noexcept;
 
                const char* what() const noexcept;
 
                explicit operator bool() const noexcept;
 
            private:
                std::error_code m_code; 
                Safe::String m_what;            
        };
    }
}
 
namespace std {
    template<>
    struct is_error_code_enum<StormByte::Error::Code>: true_type {};
}