Errors.hpp File Reference

Defines Error, UserError, and EngineError classes, along with macros for error handling. More...

#include <source_location>
#include <string>
#include <utility>
#include <format>

Include dependency graph for Errors.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	engine::util::Error
	Base class for all errors. More...
class	engine::util::EngineError
	Represents an error that occurred in the engine. More...
class	engine::util::UserError
	Represents an error that occurred in the user's code. More...

Namespaces
	engine
	engine::util

Macros
#define	RG_GUARANTEE(expr, msg, ...)
	Guarantees that an expression is true. If it is not, an engine::util::EngineError is thrown. More...
#define	RG_SHOULD_NOT_REACH_HERE(msg, ...)
	Guarantees that a path should not be reached. If it is reached, an engine::util::EngineError is thrown. More...
#define	RG_UNIMPLEMENTED(msg, ...)
	Path is not implemented. If it is implemented, an engine::util::EngineError is thrown. More...
#define	RG_ENGINE_ERROR(type, msg, ...)
	Throws an engine::util::EngineError. More...

Detailed Description

Defines Error, UserError, and EngineError classes, along with macros for error handling.

Macro Definition Documentation

RG_GUARANTEE

#define RG_GUARANTEE	(		expr,
			msg,
			...
	)

Value:

    do {                                                                                                               \
        if (!(expr)) {                                                                                                 \
            throw engine::util::EngineError(engine::util::EngineError::Type::GuaranteeViolation, std::format(msg, ##__VA_ARGS__), std::source_location::current());            \
        }                                                                                                              \
    } while (0)

Guarantees that an expression is true. If it is not, an engine::util::EngineError is thrown.

Parameters

expr	The expression to guarantee.
msg	The error message.
...	The arguments to the error message.

RG_SHOULD_NOT_REACH_HERE

#define RG_SHOULD_NOT_REACH_HERE	(		msg,
			...
	)

Value:

    do {                                                                                                               \
        throw engine::util::EngineError(engine::util::EngineError::Type::ShouldNotReachHere, std::format(msg, ##__VA_ARGS__), std::source_location::current());                \
    } while (0)

Guarantees that a path should not be reached. If it is reached, an engine::util::EngineError is thrown.

Parameters

msg	The error message.
...	The arguments to the error message.

RG_UNIMPLEMENTED

#define RG_UNIMPLEMENTED	(		msg,
			...
	)

Value:

    do {                                                                                                               \
        throw engine::util::EngineError(engine::util::EngineError::Type::Unimplemented, std::format(msg, ##__VA_ARGS__), std::source_location::current());                     \
    } while (0)

Path is not implemented. If it is implemented, an engine::util::EngineError is thrown.

Parameters

msg	The error message.
...	The arguments to the error message.

RG_ENGINE_ERROR

#define RG_ENGINE_ERROR	(		type,
			msg,
			...
	)

Value:

    do {                                                                                                               \
        throw engine::util::EngineError(type, std::format(msg, ##__VA_ARGS__), std::source_location::current()); \
    } while(0)

Throws an engine::util::EngineError.

Parameters

type	The type of the engine error.
msg	The error message.
...	The arguments to the error message.