Exception.hpp

Go to the documentation of this file.

//
//  CeresEngine - A game development framework
//
//  Created by Rogiel Sulzbach.
//  Copyright (c) 2018-2022 Rogiel Sulzbach. All rights reserved.
//
 
#pragma once
 
#include "CeresEngine/DataTypes.hpp"
 
#include "CeresEngine/Foundation/String.hpp"
#include "CeresEngine/Foundation/StringStream.hpp"
 
#include <stdexcept>
 
#if __has_include(<source_location>)
#include <source_location>
#endif
 
namespace CeresEngine {
 
#if defined(__cpp_lib_source_location)
    using SourceLocation = std::source_location;
#else
    struct SourceLocation {
        const char* filename = "";
        const char* function = "";
 
        static SourceLocation current(const char* const filename = __FILE__) {
            return SourceLocation{
                .filename = filename,
                .function = "",
            };
        }
        [[nodiscard]] constexpr std::uint_least32_t line() const noexcept { return 0; }
        [[nodiscard]] constexpr std::uint_least32_t column() const noexcept { return 0; }
        [[nodiscard]] constexpr const char* file_name() const noexcept { return filename; }
        [[nodiscard]] constexpr const char* function_name() const noexcept { return function; }
    };
#endif
 
    class Exception : public std::exception {
    private:
        StringView mTypeName;
        String mDescription;
        SourceLocation mSourceLocation;
        mutable String mFullDescription;
 
    public:
        explicit Exception(const char* typeName, const String& description = "", const SourceLocation& sourceLocation = SourceLocation::current())
                : mTypeName(typeName), mDescription(description), mSourceLocation(sourceLocation) {}
 
        template<typename S, typename... Args>
        explicit Exception(const char* typeName, const S& formatString, Args&&... args)
                : mTypeName(typeName), mDescription(String::fromFormat(formatString, std::forward<Args>(args)...)) {}
 
        Exception(const Exception& other) = default;
        Exception& operator=(const Exception& other) = default;
 
        Exception(Exception&& other) noexcept = default;
        Exception& operator=(Exception&& other) noexcept = default;
 
        ~Exception() noexcept override = default;
 
        [[nodiscard]] virtual const String& getFullDescription() const {
            if(mFullDescription.empty()) {
                StringStream desc;
 
                desc << "EXCEPTION(" << mTypeName << "): " << mDescription << " in " << getFile();
                if(getLine() > 0) {
                    desc << " at " << getFile() << " (line " << getLine() << ")";
                }
 
                mFullDescription = desc.str();
            }
 
            return mFullDescription;
        }
 
        [[nodiscard]] virtual StringView getSource() const noexcept { return mSourceLocation.function_name(); }
 
        [[nodiscard]] virtual StringView getFile() const noexcept { return mSourceLocation.file_name(); }
 
        [[nodiscard]] virtual UInt32 getLine() const noexcept { return mSourceLocation.line(); }
 
        [[nodiscard]] virtual StringView getDescription() const noexcept { return mDescription; }
 
        [[nodiscard]] const char* what() const noexcept override { return getFullDescription().c_str(); }
    };
 
#define CE_EXCEPTION_DECL2(Name, Parent)                                                                                   \
    class Name : public Parent {                                                                                           \
    public:                                                                                                                \
        template<typename S, typename... Args>                                                                             \
        explicit Name(const S& formatString, Args&&... args) : Parent(#Name, formatString, std::forward<Args>(args)...) {} \
    }
#define CE_EXCEPTION_DECL(Name) CE_EXCEPTION_DECL2(Name, Exception)
 
    CE_EXCEPTION_DECL(NotImplementedException);
    CE_EXCEPTION_DECL(FileNotFoundException);
    CE_EXCEPTION_DECL(IOException);
    CE_EXCEPTION_DECL(InvalidStateException);
    CE_EXCEPTION_DECL(InvalidParametersException);
    CE_EXCEPTION_DECL(InternalErrorException);
    CE_EXCEPTION_DECL(InvalidArgumentException);
    CE_EXCEPTION_DECL(RuntimeError);
 
} // namespace CeresEngine