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/Foundation/Container/Vector.hpp"
 
#include <stdexcept>
 
namespace CeresEngine::ShaderCompiler {
 
    struct AST;
 
    // Runtime error exception class with a reference to the AST node where the error occured.
    class ASTRuntimeError : public std::runtime_error {
    public:
        explicit ASTRuntimeError(const char* msg, const AST* ast);
        explicit ASTRuntimeError(const String& msg, const AST* ast);
        explicit ASTRuntimeError(const String& msg, const AST* ast, const Vector<const AST*>& astAppendices);
 
        // Returns the AST node which caused the error.
        [[nodiscard]] inline const AST* getAST() const { return mAST; }
 
        // Returns the secondary list of AST nodes.
        [[nodiscard]] inline const Vector<const AST*>& getASTAppendices() const { return mASTAppendices; }
 
    private:
        const AST* mAST = nullptr;
        Vector<const AST*> mASTAppendices;
    };
 
    // Throws an std::runtime_error exception.
    [[noreturn]] void runtimeErr(const char* msg);
 
    // Throws an std::runtime_error exception.
    [[noreturn]] void runtimeErr(const String& msg);
 
    // Throws an ASTRuntimeError exception if 'ast' is non-null, otherwise it std::runtime_error is thrown.
    [[noreturn]] void runtimeErr(const char* msg, const AST* ast);
 
    // Throws an ASTRuntimeError exception if 'ast' is non-null, otherwise it std::runtime_error is thrown.
    [[noreturn]] void runtimeErr(const String& msg, const AST* ast);
 
    // Throws an ASTRuntimeError exception if 'ast' is non-null, otherwise it std::runtime_error is thrown.
    [[noreturn]] void runtimeErr(const String& msg, const AST* ast, const Vector<const AST*>& astAppendices);
 
    // Throws an std::invalid_argument exception.
    [[noreturn]] void invalidArg(const char* msg);
 
    // Throws an std::invalid_argument exception.
    [[noreturn]] void invalidArg(const String& msg);
 
} // namespace CeresEngine::ShaderCompiler