`error.h`#

Error management interface.

Authors#

TheSilvered

Macros#

`Nst_set_error`#

Synopsis:

#define Nst_set_error(name, msg)

Description:

Alias for _Nst_set_error that casts name and msg to Nst_StrObj *.

`Nst_set_syntax_error`#

Synopsis:

#define Nst_set_syntax_error(msg)

Description:

Alias for _Nst_set_syntax_error that casts msg to Nst_StrObj *.

`Nst_set_memory_error`#

Synopsis:

#define Nst_set_memory_error(msg)

Description:

Alias for _Nst_set_memory_error that casts msg to Nst_StrObj *.

`Nst_set_type_error`#

Synopsis:

#define Nst_set_type_error(msg)

Description:

Alias for _Nst_set_type_error that casts msg to Nst_StrObj *.

`Nst_set_value_error`#

Synopsis:

#define Nst_set_value_error(msg)

Description:

Alias for _Nst_set_value_error that casts msg to Nst_StrObj *.

`Nst_set_math_error`#

Synopsis:

#define Nst_set_math_error(msg)

Description:

Alias for _Nst_set_math_error that casts msg to Nst_StrObj *.

`Nst_set_call_error`#

Synopsis:

#define Nst_set_call_error(msg)

Description:

Alias for _Nst_set_call_error that casts msg to Nst_StrObj *.

`Nst_set_import_error`#

Synopsis:

#define Nst_set_import_error(msg)

Description:

Alias for _Nst_set_import_error that casts msg to Nst_StrObj *.

`Nst_set_errorf`#

Synopsis:

#define Nst_set_errorf(name, fmt, ...)

Description:

Alias for _Nst_set_error that casts name to Nst_StrObj * and builds a formatted string with fmt.

`Nst_set_syntax_errorf`#

Synopsis:

#define Nst_set_syntax_errorf(fmt, ...)

Description:

Alias for _Nst_set_syntax_error that builds a formatted string with fmt.

`Nst_set_memory_errorf`#

Synopsis:

#define Nst_set_memory_errorf(fmt, ...)

Description:

Alias for _Nst_set_memory_error that builds a formatted string with fmt.

`Nst_set_type_errorf`#

Synopsis:

#define Nst_set_type_errorf(fmt, ...)

Description:

Alias for _Nst_set_type_error that builds a formatted string with fmt.

`Nst_set_value_errorf`#

Synopsis:

#define Nst_set_value_errorf(fmt, ...)

Description:

Alias for _Nst_set_value_error that builds a formatted string with fmt.

`Nst_set_math_errorf`#

Synopsis:

#define Nst_set_math_errorf(fmt, ...)

Description:

Alias for _Nst_set_math_error that builds a formatted string with fmt.

`Nst_set_call_errorf`#

Synopsis:

#define Nst_set_call_errorf(fmt, ...)

Description:

Alias for _Nst_set_call_error that builds a formatted string with fmt.

`Nst_set_import_errorf`#

Synopsis:

#define Nst_set_import_errorf(fmt, ...)

Description:

Alias for _Nst_set_import_error that builds a formatted string with fmt.

Structs#

`Nst_SourceText`#

Synopsis:

typedef struct _Nst_SourceText {
    i8 *text;
    i8 *path;
    i8 **lines;
    usize text_len;
    usize lines_len;
} Nst_SourceText

Description:

The structure where the source text of a Nest file is kept.

Fields:

text: the UTF-8 text of the file
path: the path of the file
lines: the beginning of each line of the file
len: the length in bytes of text
lines_len: the number of lines in the file

`Nst_Pos`#

Synopsis:

typedef struct _Nst_Pos {
    i32 line;
    i32 col;
    Nst_SourceText *text;
} Nst_Pos

Description:

The structure representing a position inside a source file.

Fields:

line: the line of the position, the first is line 0
col: the column of the position, the first is 0
text: the text this position refers to

`Nst_Error`#

Synopsis:

typedef struct _Nst_Error {
    bool occurred;
    Nst_Pos start;
    Nst_Pos end;
    Nst_StrObj *name;
    Nst_StrObj *message;
} Nst_Error

Description:

The structure representing an error with a determined position.

Fields:

occurred: whether the struct contains a valid error
start: the start position of the error
end: the end position of the error
name: the name of the error (e.g. Value Error, Type Error etc.)
message: the message of the error

`Nst_OpErr`#

Synopsis:

typedef struct _Nst_OpErr {
    Nst_StrObj *name;
    Nst_StrObj *message;
} Nst_OpErr

Description:

The structure representing an error occurred during an operation and that does not yet have a position.

Fields:

name: the name of the error (e.g. Value Error, Type Error etc.)
message: the message of the error

`Nst_Traceback`#

Synopsis:

typedef struct _Nst_Traceback {
    Nst_Error error;
    Nst_LList *positions;
} Nst_Traceback

Description:

The structure containing the full traceback of the error.

Fields:

error: the error of the traceback
positions: the list of positions that led to the error

Functions#

`Nst_set_color`#

Synopsis:

void Nst_set_color(bool color)

Description:

Sets how the error message is printed (with or without ANSI escapes).

`Nst_copy_pos`#

Synopsis:

Nst_Pos Nst_copy_pos(Nst_Pos pos)

Description:

Forces a copy of the position.

`Nst_no_pos`#

Synopsis:

Nst_Pos Nst_no_pos(void)

Description:

Creates an empty position, with no valid text.

`Nst_print_error`#

Synopsis:

void Nst_print_error(Nst_Error err)

Description:

Prints a formatted Nst_Error.

`Nst_print_traceback`#

Synopsis:

void Nst_print_traceback(Nst_Traceback tb)

Description:

Prints a formatted Nst_Traceback.

`Nst_free_src_text`#

Synopsis:

void Nst_free_src_text(Nst_SourceText *text)

Description:

Frees a heap allocated text source, text can be NULL. No error is set.

`_Nst_set_error`#

Synopsis:

void _Nst_set_error(Nst_StrObj *name, Nst_StrObj *msg)

Description:

Sets the global operation error with the given name and message.

It takes a reference of both name and message.

`_Nst_set_syntax_error`#

Synopsis:

void _Nst_set_syntax_error(Nst_StrObj *msg)

Description:

Sets the global operation error with the given message and "Syntax Error" as the name.