error.h

Go to the documentation of this file.

#ifndef REDUCT_ERROR_H
#define REDUCT_ERROR_H 1
 
#include <reduct/defs.h>
#include <reduct/module.h>
 
struct reduct;
struct reduct_item;
 
#include <assert.h>
#include <setjmp.h>
#include <stdio.h>
#include <stdlib.h>
 
/**
 * @file error.h
 * @brief Error handling and reporting.
 * @defgroup error Error
 *
 * @{
 */
 
#define REDUCT_ERROR_MAX_LEN 128     ///< Maximum length of an error string.
#define REDUCT_ERROR_BACKTRACE_MAX 8 ///< Maximum number of backtrace frames.
 
/**
 * @brief Error type enumeration.
 * @enum reduct_error_type_t
 */
typedef enum reduct_error_type
{
    REDUCT_ERROR_TYPE_NONE,
    REDUCT_ERROR_TYPE_SYNTAX,
    REDUCT_ERROR_TYPE_COMPILE,
    REDUCT_ERROR_TYPE_RUNTIME,
    REDUCT_ERROR_TYPE_INTERNAL,
} reduct_error_type_t;
 
/**
 * @brief Backtrace frame structure.
 * @struct reduct_error_frame_t
 *
 * Stores the source location for a single frame of the call stack at the time of a runtime error.
 */
typedef struct reduct_error_frame
{
    uint32_t modulePos;          ///< The position in the input buffer.
    reduct_module_id_t moduleId; ///< The ID of the module that caused the error.
} reduct_error_frame_t;
 
/**
 * @brief Error structure.
 * @struct reduct_error_t
 */
typedef struct reduct_error
{
    const char* input;   ///< The input buffer.
    size_t inputLength;  ///< The total length of the input buffer.
    const char* path;    ///< The path to the file that caused the error.
    size_t regionLength; ///< The length of the region that caused the error.
    size_t index;        ///< The index of the region in the input buffer that caused the error.
    jmp_buf jmp;
    reduct_error_type_t type; ///< The type of the error.
    char message[REDUCT_ERROR_MAX_LEN];
    struct reduct_error* prev;                               ///< Previous error handler in the stack.
    struct reduct* reduct;                                   ///< The owning Reduct structure.
    reduct_error_frame_t frames[REDUCT_ERROR_BACKTRACE_MAX]; ///< Backtrace frames for the error.
    uint8_t frameCount;                                      ///< The number of backtrace frames.
} reduct_error_t;
 
/**
 * @brief Create a Reduct error structure.
 *
 * @return A new Reduct error structure initialized to zero.
 */
#define REDUCT_ERROR() ((reduct_error_t){0})
 
/**
 * @brief Format and print the error to a file.
 *
 * @param error Pointer to the error structure.
 * @param file The file to print to.
 */
REDUCT_API void reduct_error_print(reduct_error_t* error, FILE* file);
 
/**
 * @brief Get the row and column by traversing the input buffer.
 *
 * @param error Pointer to the error structure.
 * @param row Pointer to the row variable.
 * @param column Pointer to the column variable.
 */
REDUCT_API void reduct_error_get_row_column(reduct_error_t* error, size_t* row, size_t* column);
 
/**
 * @brief Set the error information in the error structure.
 *
 * @param error Pointer to the error structure.
 * @param path The path to the file where the error occurred.
 * @param input The input buffer where the error occurred.
 * @param inputLength The total length of the input buffer.
 * @param regionLength The length of the token/region that caused the error.
 * @param position The position in the input buffer where the error occurred.
 * @param type The type of the error.
 * @param message The error message format string.
 * @param ... The arguments for the format string.
 */
REDUCT_API void reduct_error_set(reduct_error_t* error, const char* path, const char* input, size_t inputLength,
    size_t regionLength, size_t position, reduct_error_type_t type, const char* message, ...);
 
/**
 * @brief Get the error parameters from a Reduct item.
 *
 * @param reduct Pointer to the Reduct structure.
 * @param item Pointer to the item.
 * @param path Pointer to the path variable.
 * @param input Pointer to the input variable.
 * @param inputLength Pointer to the input length variable.
 * @param regionLength Pointer to the region length variable.
 * @param position Pointer to the position variable.
 */
REDUCT_API void reduct_error_get_item_params(struct reduct* reduct, struct reduct_item* item, const char** path,
    const char** input, size_t* inputLength, size_t* regionLength, size_t* position);
 
/**
 * @brief Throw a runtime error utilizing the evaluation state to determine the context.
 *
 * @param reduct Pointer to the Reduct structure.
 * @param message The error message format string.
 * @param ... Additional arguments.
 */
REDUCT_API REDUCT_NORETURN void reduct_error_throw_runtime(struct reduct* reduct, const char* message, ...);
 
/**
 * @brief Push a new error handler onto the stack.
 *
 * This will cause the provided error handler to be called when an error occurs instead of the previous one.
 *
 * @param reduct Pointer to the Reduct structure.
 * @param error Pointer to the error structure to push.
 */
REDUCT_API void reduct_error_push(struct reduct* reduct, reduct_error_t* error);
 
/**
 * @brief Pop the current error handler from the stack.
 *
 * @param reduct Pointer to the Reduct structure.
 */
REDUCT_API void reduct_error_pop(struct reduct* reduct);
 
/**
 * @brief Throw an error using the jump buffer in the error structure.
 *
 * @param _reduct Pointer to the Reduct structure.
 * @param _error Pointer to the error structure.
 * @param _item Pointer to the item that caused the error.
 * @param _type The suffix of the error type (e.g., INTERNAL, RUNTIME, etc.).
 * @param ... The error message format string and any optional arguments.
 */
#define REDUCT_ERROR_GENERIC(_reduct, _error, _item, _type, ...) \
    do \
    { \
        const char* __path; \
        const char* __input; \
        size_t __inputLength; \
        size_t __regionLength; \
        size_t __position; \
        reduct_error_get_item_params((_reduct), (_item), &__path, &__input, &__inputLength, &__regionLength, \
            &__position); \
        reduct_error_set((_error), __path, __input, __inputLength, __regionLength, __position, \
            REDUCT_ERROR_TYPE_##_type, __VA_ARGS__); \
        longjmp((_error)->jmp, true); \
    } while (0)
 
/**
 * @brief Check if an error structure indicates a successful operation.
 *
 * @param _error Pointer to the error structure.
 */
#define REDUCT_ERROR_SUCCESS(_error) ((_error)->type == REDUCT_ERROR_TYPE_NONE)
 
/**
 * @brief Catch an error using the jump buffer in the error structure.
 *
 * @param _error Pointer to the error structure.
 */
#define REDUCT_ERROR_CATCH(_error) (setjmp((_error)->jmp))
 
/**
 * @brief Execute a block of code safely, catching any Reduct errors.
 *
 * @warning Do not use `return`, `break`, `continue`, or `goto` to exit the block, as it
 * will skip the necessary error stack cleanup. Use a status variable instead.
 *
 * @param _reduct Pointer to the Reduct structure.
 * @param _error Pointer to the error structure.
 */
#define REDUCT_ERROR_TRY(_reduct, _error) \
    for (int _once = (reduct_error_push((_reduct), (_error)), 0); _once < 1; (reduct_error_pop(_reduct), _once++)) \
        if (REDUCT_ERROR_CATCH(_error) == 0)
 
/**
 * @brief Throw a runtime error using the jump buffer in the error structure.
 *
 * @param _reduct Pointer to the Reduct structure.
 * @param ... The error message format string and any optional arguments.
 */
#define REDUCT_ERROR_THROW(_reduct, ...) reduct_error_throw_runtime((_reduct), __VA_ARGS__)
 
/**
 * @brief Rethrow an existing error.
 *
 * @param _reduct Pointer to the Reduct structure.
 * @param _error Pointer to the error structure.
 */
#define REDUCT_ERROR_RETHROW(_reduct, _error) REDUCT_ERROR_THROW(_reduct, "%s", (_error)->message)
 
/**
 * @brief Throw a runtime error if the expression is false.
 *
 * @param _reduct Pointer to the Reduct structure.
 * @param _expr The expression to check.
 * @param ... The error message format string and any optional arguments.
 */
#define REDUCT_ERROR_ASSERT(_reduct, _expr, ...) \
    do \
    { \
        if (REDUCT_UNLIKELY(!(_expr))) \
        { \
            REDUCT_ERROR_THROW(_reduct, __VA_ARGS__); \
        } \
    } while (0)
 
/**
 * @brief Throw a syntax error using the jump buffer in the error structure.
 *
 * @param _error Pointer to the error structure.
 * @param _input Pointer to the input structure being parsed.
 * @param _ptr Pointer to the current position in the input buffer.
 * @param ... The error message format string and any optional arguments.
 */
#define REDUCT_ERROR_SYNTAX(_error, _input, _ptr, ...) \
    do \
    { \
        reduct_error_set((_error), (_input)->path, (_input)->buffer, (_input)->end - (_input)->buffer, 1, \
            (size_t)((_ptr) - (_input)->buffer), REDUCT_ERROR_TYPE_SYNTAX, __VA_ARGS__); \
        longjmp((_error)->jmp, true); \
    } while (0)
 
/**
 * @brief Throw a compile error using the jump buffer in the error structure.
 *
 * @param _compiler The compiler instance.
 * @param _handle Pointer to the handle that caused the error.
 * @param ... The error message format string and any optional arguments.
 */
#define REDUCT_ERROR_COMPILE(_compiler, _handle, ...) \
    do \
    { \
        struct reduct_item* __item = REDUCT_HANDLE_TO_ITEM(_handle); \
        REDUCT_ERROR_GENERIC((_compiler)->reduct, (_compiler)->reduct->error, \
            (((__item) != NULL && (__item)->moduleId != REDUCT_MODULE_ID_NONE) \
                    ? (__item) \
                    : ((_compiler)->lastItem != NULL ? (_compiler)->lastItem : (__item))), \
            COMPILE, __VA_ARGS__); \
    } while (0)
 
/**
 * @brief Throw a compile error using the jump buffer in the error structure using the last item process by the
 * compiler.
 *
 * @param _compiler The compiler instance.
 * @param ... The error message format string and any optional arguments.
 */
#define REDUCT_ERROR_COMPILE_LAST(_compiler, ...) \
    do \
    { \
        reduct_handle_t __handle = REDUCT_HANDLE_FROM_ITEM((_compiler)->lastItem); \
        REDUCT_ERROR_COMPILE((_compiler), __handle, __VA_ARGS__); \
    } while (0)
 
/**
 * @brief Throw a compile error if the expression is false.
 *
 * @param _compiler The compiler instance.
 * @param _handle Pointer to the handle that caused the error.
 * @param _expr The expression to check.
 * @param ... The error message format string and any optional arguments.
 */
#define REDUCT_ERROR_COMPILE_ASSERT(_compiler, _expr, ...) \
    do \
    { \
        if (REDUCT_UNLIKELY(!(_expr))) \
        { \
            reduct_handle_t __handle = REDUCT_HANDLE_FROM_ITEM((_compiler)->lastItem); \
            REDUCT_ERROR_COMPILE((_compiler), __handle, __VA_ARGS__); \
        } \
    } while (0)
 
/**
 * @brief Throw an internal error using the jump buffer in the error structure.
 *
 * @param _reduct Pointer to the Reduct structure.
 * @param ... The error message format string and any optional arguments.
 */
#define REDUCT_ERROR_INTERNAL(_reduct, ...) REDUCT_ERROR_GENERIC(_reduct, (_reduct)->error, NULL, INTERNAL, __VA_ARGS__)
 
/** @} */
 
#endif