Error

Detailed Description

Data Structures
struct	reduct_error_t
	Error structure. More...

Macros
#define	REDUCT_ERROR_MAX_LEN   512
	Maximum length of an error string.
#define	REDUCT_ERROR()   ((reduct_error_t){0})
	Create a Reduct error structure.
#define	REDUCT_ERROR_CATCH(_error)   (REDUCT_SETJMP((_error)->jmp))
	Catch an error using the jump buffer in the error structure.
#define	REDUCT_ERROR_THROW(_error, _item, _type, ...)
	Throw an error using the jump buffer in the error structure.
#define	REDUCT_ERROR_SYNTAX(_error, _input, _ptr, ...)
	Throw a syntax error using the jump buffer in the error structure.
#define	REDUCT_ERROR_COMPILE(_compiler, _item, ...)
	Throw a compile error using the jump buffer in the error structure.
#define	REDUCT_ERROR_RUNTIME(_reduct, ...)   reduct_error_throw_runtime((_reduct), __VA_ARGS__)
	Throw a runtime error using the jump buffer in the error structure.
#define	REDUCT_ERROR_INTERNAL(_reduct, ...)   REDUCT_ERROR_THROW((_reduct)->error, REDUCT_NULL, INTERNAL, __VA_ARGS__)
	Throw an internal error using the jump buffer in the error structure.
#define	REDUCT_ERROR_CHECK_TYPE(_reduct, _name, _handle, _expected)
	Report a type error for a handle.
#define	REDUCT_ERROR_CHECK_LIST(_reduct, _handle, _name)
	Assert that a handle is a list.
#define	REDUCT_ERROR_CHECK_CALLABLE(_reduct, _handle, _name)
	Assert that a handle is a callable.
#define	REDUCT_ERROR_CHECK_SEQUENCE(_reduct, _handle, _name)
	Assert that a handle is a sequence (list or atom).

Enumerations
enum	reduct_error_type_t {   REDUCT_ERROR_TYPE_NONE , REDUCT_ERROR_TYPE_SYNTAX , REDUCT_ERROR_TYPE_COMPILE , REDUCT_ERROR_TYPE_RUNTIME ,   REDUCT_ERROR_TYPE_INTERNAL }
	Error type enumeration. More...

Functions
REDUCT_API void	reduct_error_print (reduct_error_t *error, reduct_file_t file)
	Format and print the error to a file.
REDUCT_API void	reduct_error_get_row_column (reduct_error_t *error, reduct_size_t *row, reduct_size_t *column)
	Get the row and column by traversing the input buffer.
REDUCT_API void	reduct_error_set (reduct_error_t *error, const char *path, const char *input, reduct_size_t inputLength, reduct_size_t regionLength, reduct_size_t position, reduct_error_type_t type, const char *message,...)
	Set the error information in the error structure.
REDUCT_API void	reduct_error_get_item_params (struct reduct_item *item, const char **path, const char **input, reduct_size_t *inputLength, reduct_size_t *regionLength, reduct_size_t *position)
	Get the error parameters from a Reduct item.
REDUCT_API REDUCT_NORETURN void	reduct_error_throw_runtime (struct reduct *reduct, const char *message,...)
	Throw a runtime error utilizing the evaluation state to determine the context.
REDUCT_API void	reduct_error_check_arity (struct reduct *reduct, reduct_size_t argc, reduct_size_t expected, const char *name)
	Check the arity of a native function call.
REDUCT_API void	reduct_error_check_min_arity (struct reduct *reduct, reduct_size_t argc, reduct_size_t min, const char *name)
REDUCT_API void	reduct_error_check_arity_range (struct reduct *reduct, reduct_size_t argc, reduct_size_t min, reduct_size_t max, const char *name)

Macro Definition Documentation

REDUCT_ERROR_MAX_LEN

#define REDUCT_ERROR_MAX_LEN   512

Maximum length of an error string.

Definition at line 17 of file error.h.

REDUCT_ERROR

#define REDUCT_ERROR

(

)

((reduct_error_t){0})

Create a Reduct error structure.

Returns

A new Reduct error structure initialized to zero.

Definition at line 53 of file error.h.

REDUCT_ERROR_CATCH

#define REDUCT_ERROR_CATCH

(

_error

)

(REDUCT_SETJMP((_error)->jmp))

Catch an error using the jump buffer in the error structure.

Parameters

_error

Pointer to the error structure.

Definition at line 115 of file error.h.

REDUCT_ERROR_THROW

#define REDUCT_ERROR_THROW	(		_error,
			_item,
			_type,
			...
	)

Value:

    do \
    { \
        const char* __path; \
        const char* __input; \
        reduct_size_t __input_length; \
        reduct_size_t __region_length; \
        reduct_size_t __position; \
        reduct_error_get_item_params((_item), &__path, &__input, &__input_length, &__region_length, &__position); \
        reduct_error_set((_error), __path, __input, __input_length, __region_length, __position, \
            REDUCT_ERROR_TYPE_##_type, __VA_ARGS__); \
        REDUCT_LONGJMP((_error)->jmp, REDUCT_TRUE); \
    } while (0)

Throw an error using the jump buffer in the error structure.

Parameters

_error	Pointer to the error structure.
_item	Pointer to the item that caused the error.
_type	The suffix of the error type (e.g., INTERNAL, RUNTIME, etc.).
...	The error message format string and any optional arguments.

Definition at line 125 of file error.h.

REDUCT_ERROR_SYNTAX

#define REDUCT_ERROR_SYNTAX	(		_error,
			_input,
			_ptr,
			...
	)

Value:

    do \
    { \
        reduct_error_set((_error), (_input)->path, (_input)->buffer, (_input)->end - (_input)->buffer, 1, \
            (reduct_size_t)((_ptr) - (_input)->buffer), REDUCT_ERROR_TYPE_SYNTAX, __VA_ARGS__); \
        REDUCT_LONGJMP((_error)->jmp, REDUCT_TRUE); \
    } while (0)

Throw a syntax error using the jump buffer in the error structure.

Parameters

_error	Pointer to the error structure.
_input	Pointer to the input structure being parsed.
_ptr	Pointer to the current position in the input buffer.
...	The error message format string and any optional arguments.

Definition at line 147 of file error.h.

REDUCT_ERROR_COMPILE

#define REDUCT_ERROR_COMPILE	(		_compiler,
			_item,
			...
	)

Value:

    REDUCT_ERROR_THROW((_compiler)->reduct->error, \
        (((_item) != REDUCT_NULL && (_item)->input != REDUCT_NULL) \
                ? (_item) \
                : ((_compiler)->lastItem != REDUCT_NULL ? (_compiler)->lastItem : (_item))), \
        COMPILE, __VA_ARGS__)

Throw a compile error using the jump buffer in the error structure.

Parameters

_compiler	The compiler instance.
_item	Pointer to the item that caused the error.
...	The error message format string and any optional arguments.

Definition at line 162 of file error.h.

REDUCT_ERROR_RUNTIME

#define REDUCT_ERROR_RUNTIME	(		_reduct,
			...
	)		reduct_error_throw_runtime((_reduct), __VA_ARGS__)

Throw a runtime error using the jump buffer in the error structure.

Parameters

_reduct	Pointer to the reduct instance.
...	The error message format string and any optional arguments.

Definition at line 175 of file error.h.

REDUCT_ERROR_INTERNAL

#define REDUCT_ERROR_INTERNAL	(		_reduct,
			...
	)		REDUCT_ERROR_THROW((_reduct)->error, REDUCT_NULL, INTERNAL, __VA_ARGS__)

Throw an internal error using the jump buffer in the error structure.

Parameters

_reduct	Pointer to the reduct instance.
...	The error message format string and any optional arguments.

Definition at line 183 of file error.h.

REDUCT_ERROR_CHECK_TYPE

#define REDUCT_ERROR_CHECK_TYPE	(		_reduct,
			_name,
			_handle,
			_expected
	)

Value:

    do \
    { \
        REDUCT_ERROR_RUNTIME(_reduct, "%s expects %s, got %s", _name, _expected, \
            reduct_item_type_str(REDUCT_HANDLE_GET_TYPE(_handle))); \
    } while (0)

Report a type error for a handle.

Definition at line 188 of file error.h.

REDUCT_ERROR_CHECK_LIST

#define REDUCT_ERROR_CHECK_LIST	(		_reduct,
			_handle,
			_name
	)

Value:

    do \
    { \
        if (!REDUCT_HANDLE_IS_LIST(_handle)) \
        { \
            REDUCT_ERROR_CHECK_TYPE(_reduct, _name, _handle, "a list"); \
        } \
    } while (0)

Assert that a handle is a list.

Definition at line 198 of file error.h.

REDUCT_ERROR_CHECK_CALLABLE

#define REDUCT_ERROR_CHECK_CALLABLE	(		_reduct,
			_handle,
			_name
	)

Value:

    do \
    { \
        if (!REDUCT_HANDLE_IS_CALLABLE(_handle)) \
        { \
            REDUCT_ERROR_CHECK_TYPE(_reduct, _name, _handle, "a callable"); \
        } \
    } while (0)

Assert that a handle is a callable.

Definition at line 210 of file error.h.

REDUCT_ERROR_CHECK_SEQUENCE

#define REDUCT_ERROR_CHECK_SEQUENCE	(		_reduct,
			_handle,
			_name
	)

Value:

    do \
    { \
        if (!REDUCT_HANDLE_IS_LIST(_handle) && !REDUCT_HANDLE_IS_ATOM(_handle)) \
        { \
            REDUCT_ERROR_CHECK_TYPE(_reduct, _name, _handle, "a list or atom"); \
        } \
    } while (0)

Assert that a handle is a sequence (list or atom).

Definition at line 222 of file error.h.

Enumeration Type Documentation

reduct_error_type_t

enum reduct_error_type_t

Error type enumeration.

Enumerator
REDUCT_ERROR_TYPE_NONE
REDUCT_ERROR_TYPE_SYNTAX
REDUCT_ERROR_TYPE_COMPILE
REDUCT_ERROR_TYPE_RUNTIME
REDUCT_ERROR_TYPE_INTERNAL

Definition at line 23 of file error.h.

Function Documentation

reduct_error_print()

REDUCT_API void reduct_error_print	(	reduct_error_t *	error,
		reduct_file_t	file
	)

Format and print the error to a file.

Parameters

error	Pointer to the error structure.
file	The file to print to.

Definition at line 99 of file error_impl.h.

Here is the call graph for this function:

reduct_error_get_row_column()

REDUCT_API void reduct_error_get_row_column	(	reduct_error_t *	error,
		reduct_size_t *	row,
		reduct_size_t *	column
	)

Get the row and column by traversing the input buffer.

Parameters

error	Pointer to the error structure.
row	Pointer to the row variable.
column	Pointer to the column variable.

Definition at line 153 of file error_impl.h.

Here is the caller graph for this function:

reduct_error_set()

REDUCT_API void reduct_error_set	(	reduct_error_t *	error,
		const char *	path,
		const char *	input,
		reduct_size_t	inputLength,
		reduct_size_t	regionLength,
		reduct_size_t	position,
		reduct_error_type_t	type,
		const char *	message,
			...
	)

Set the error information in the error structure.

Parameters

error	Pointer to the error structure.
path	The path to the file where the error occurred.
input	The input buffer where the error occurred.
inputLength	The total length of the input buffer.
regionLength	The length of the token/region that caused the error.
position	The position in the input buffer where the error occurred.
type	The type of the error.
message	The error message format string.
...	The arguments for the format string.

Definition at line 181 of file error_impl.h.

Here is the caller graph for this function:

reduct_error_get_item_params()

REDUCT_API void reduct_error_get_item_params	(	struct reduct_item *	item,
		const char **	path,
		const char **	input,
		reduct_size_t *	inputLength,
		reduct_size_t *	regionLength,
		reduct_size_t *	position
	)

Get the error parameters from a Reduct item.

Parameters

item	Pointer to the item.
path	Pointer to the path variable.
input	Pointer to the input variable.
inputLength	Pointer to the input length variable.
regionLength	Pointer to the region length variable.
position	Pointer to the position variable.

Definition at line 200 of file error_impl.h.

Here is the call graph for this function:

reduct_error_throw_runtime()

REDUCT_API REDUCT_NORETURN void reduct_error_throw_runtime	(	struct reduct *	reduct,
		const char *	message,
			...
	)

Throw a runtime error utilizing the evaluation state to determine the context.

Parameters

reduct	Pointer to the Reduct instance.
message	The error message format string.
...	Additional arguments.

Definition at line 226 of file error_impl.h.

Here is the call graph for this function:

reduct_error_check_arity()

REDUCT_API void reduct_error_check_arity	(	struct reduct *	reduct,
		reduct_size_t	argc,
		reduct_size_t	expected,
		const char *	name
	)

Check the arity of a native function call.

Here is the caller graph for this function:

reduct_error_check_min_arity()

REDUCT_API void reduct_error_check_min_arity	(	struct reduct *	reduct,
		reduct_size_t	argc,
		reduct_size_t	min,
		const char *	name
	)

reduct_error_check_arity_range()

REDUCT_API void reduct_error_check_arity_range	(	struct reduct *	reduct,
		reduct_size_t	argc,
		reduct_size_t	min,
		reduct_size_t	max,
		const char *	name
	)

Here is the caller graph for this function: