exception.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 <format>
#include <string>
#include <string_view>
#include <utility>
 
namespace StormByte {
    class STORMBYTE_PUBLIC Exception {
        public:
            explicit Exception(std::string_view message);
 
            explicit Exception(const Safe::String& message);
 
        protected:
            struct Path {
                std::string_view text;  
 
                explicit constexpr Path(std::string_view text = {}) noexcept: text(text) {}
            };
 
        public:
            template <typename... Args>
            Exception(std::format_string<Args...> fmt, Args&&... args)
                : Exception(Path{}, fmt, std::forward<Args>(args)...) {}
 
            Exception(const Exception& e) = default;
 
            Exception(Exception&& e) noexcept = default;
 
            virtual ~Exception() noexcept;
 
            Exception& operator=(const Exception& e) = default;
 
            Exception& operator=(Exception&& e) noexcept = default;
 
            virtual const char* what() const noexcept;
 
        protected:
            template <typename... Args>
            Exception(Path path, std::format_string<Args...> fmt, Args&&... args) {
                const std::string body = sizeof...(Args) == 0
                    ? std::string(fmt.get())
                    : std::format(fmt, std::forward<Args>(args)...);
                if (path.text.empty())
                    Assign("StormByte", body);
                else {
                    const std::string full = std::string("StormByte.") + std::string(path.text);
                    Assign(full, body);
                }
            }
 
        private:
            void Assign(std::string_view path, std::string_view body) {
                std::string full;
                full.reserve(path.size() + 2 + body.size());
                full.append(path);
                full.append(": ");
                full.append(body);
                m_what = Safe::String(std::string_view(full));
            }
 
            Safe::String m_what;    
    };
 
    class STORMBYTE_PUBLIC DeserializeError: public Exception {
        public:
            using Exception::Exception;
 
            ~DeserializeError() noexcept override;
    };
 
    class STORMBYTE_PUBLIC OutOfBoundsError: public Exception {
        public:
            using Exception::Exception;
 
            ~OutOfBoundsError() noexcept override;
    };
 
    class STORMBYTE_PUBLIC Base64Error: public Exception {
        public:
            using Exception::Exception;
 
            ~Base64Error() noexcept override;
    };
}