prettyerr.h File Reference

#include <stddef.h>
#include <stdbool.h>
#include <stdio.h>

Go to the source code of this file.

Data Structures
struct	libprettyerr_str
struct	libprettyerr_pos
struct	libprettyerr_error
struct	libprettyerr_printer

Macros
#define	PERR_Str(line_, start_)
#define	PERR_Str_None()
#define	PERR_Pos(index_, length_)
#define	PERR_Error(type_, primary_, error_position_, main_, explain_, error_code_, filename_)
#define	PERR_Secondary(type_, primary_, error_position_, main_, filename_)
#define	PRETTYERR_EXPORT

Typedefs
typedef void(*	libprettyerr_runner_t) (const struct libprettyerr_printer *, const struct libprettyerr_error *)
typedef struct libprettyerr_error	perr_t
typedef struct libprettyerr_printer	perr_printer_t
typedef libprettyerr_runner_t	perr_runner_t

Enumerations
enum	libprettyerr_errtype {   PERR_SUCCESS , PERR_ERROR , PERR_WARNING , PERR_INFO ,   PERR_HINT }
enum	libprettyerr_boxtype {   PERR_BOX_THICK_VERT , PERR_BOX_THIN_HIGH , PERR_BOX_THIN_UL , PERR_BOX_THIN_UL_ROUNDED ,   PERR_BOX_THIN_HORIZ , PERR_BOX_THIN_BL , PERR_BOX_THIN_BL_ROUNDED , PERR_BOX_THIN_VERT ,   PERR_BOX_MAX }

Functions
PRETTYERR_EXPORT void	perr_printer_init (struct libprettyerr_printer *printer, FILE *stream, const char *source, bool utf8, libprettyerr_runner_t style)
PRETTYERR_EXPORT void	perr_print_error (const struct libprettyerr_printer *printer, const struct libprettyerr_error *err)
PRETTYERR_EXPORT void	perr_print_line_number (const struct libprettyerr_printer *printer, const struct libprettyerr_error *err, const char *color)

Variables
PRETTYERR_EXPORT perr_runner_t	perr_runner_basic_style
PRETTYERR_EXPORT perr_runner_t	perr_runner_secondary_style

Macro Definition Documentation

PERR_Error

#define PERR_Error	(		type_,
			primary_,
			error_position_,
			main_,
			explain_,
			error_code_,
			filename_ )

Value:

    (struct libprettyerr_error){ \
        .type = type_, .primary = primary_, .error_position = error_position_, \
        .main = main_, .explain = explain_, .error_code = error_code_, \
        .filename = filename_ \
    }

Definition at line 74 of file prettyerr.h.

#define PERR_Error(type_, primary_, error_position_, main_, explain_, error_code_, filename_) \
    (struct libprettyerr_error){ \
        .type = type_, .primary = primary_, .error_position = error_position_, \
        .main = main_, .explain = explain_, .error_code = error_code_, \
        .filename = filename_ \
    }

PERR_Pos

#define PERR_Pos	(		index_,
			length_ )

Value:

    (struct libprettyerr_pos){ .index = index_, .length = length_ }

Definition at line 38 of file prettyerr.h.

#define PERR_Pos(index_, length_) \
    (struct libprettyerr_pos){ .index = index_, .length = length_ }

PERR_Secondary

#define PERR_Secondary	(		type_,
			primary_,
			error_position_,
			main_,
			filename_ )

Value:

    (struct libprettyerr_error){ \
        .type = type_, .primary = primary_, .error_position = error_position_, \
        .main = main_, .filename = filename_ \
    }

Definition at line 81 of file prettyerr.h.

#define PERR_Secondary(type_, primary_, error_position_, main_, filename_) \
    (struct libprettyerr_error){ \
        .type = type_, .primary = primary_, .error_position = error_position_, \
        .main = main_, .filename = filename_ \
    }

PERR_Str

#define PERR_Str	(		line_,
			start_ )

Value:

    (struct libprettyerr_str){ .line = line_, .start = start_ }

Definition at line 28 of file prettyerr.h.

#define PERR_Str(line_, start_) \
    (struct libprettyerr_str){ .line = line_, .start = start_ }

PERR_Str_None

#define PERR_Str_None

(

)

Value:

    PERR_Str(0, NULL)

Definition at line 30 of file prettyerr.h.

#define PERR_Str_None() \
    PERR_Str(0, NULL)

PRETTYERR_EXPORT

#define PRETTYERR_EXPORT

Definition at line 100 of file prettyerr.h.

Typedef Documentation

libprettyerr_runner_t

typedef void(* libprettyerr_runner_t) (const struct libprettyerr_printer *, const struct libprettyerr_error *)

Definition at line 89 of file prettyerr.h.

perr_printer_t

typedef struct libprettyerr_printer perr_printer_t

Definition at line 119 of file prettyerr.h.

perr_runner_t

typedef libprettyerr_runner_t perr_runner_t

Definition at line 120 of file prettyerr.h.

perr_t

typedef struct libprettyerr_error perr_t

Definition at line 118 of file prettyerr.h.

Enumeration Type Documentation

libprettyerr_boxtype

enum libprettyerr_boxtype

Enumerator
PERR_BOX_THICK_VERT
PERR_BOX_THIN_HIGH
PERR_BOX_THIN_UL
PERR_BOX_THIN_UL_ROUNDED
PERR_BOX_THIN_HORIZ
PERR_BOX_THIN_BL
PERR_BOX_THIN_BL_ROUNDED
PERR_BOX_THIN_VERT
PERR_BOX_MAX

Definition at line 49 of file prettyerr.h.

                          {
    PERR_BOX_THICK_VERT,
    PERR_BOX_THIN_HIGH,
    PERR_BOX_THIN_UL,
    PERR_BOX_THIN_UL_ROUNDED,
    PERR_BOX_THIN_HORIZ,
    PERR_BOX_THIN_BL,
    PERR_BOX_THIN_BL_ROUNDED,
    PERR_BOX_THIN_VERT,
    PERR_BOX_MAX,
};

libprettyerr_errtype

enum libprettyerr_errtype

Enumerator
PERR_SUCCESS
PERR_ERROR
PERR_WARNING
PERR_INFO
PERR_HINT

Definition at line 41 of file prettyerr.h.

                          {
    PERR_SUCCESS,  // bold green
    PERR_ERROR,   // bold red
    PERR_WARNING, // red
    PERR_INFO,    // bold white
    PERR_HINT    // bold yellow
};

Function Documentation

perr_print_error()

PRETTYERR_EXPORT void perr_print_error	(	const struct libprettyerr_printer *	printer,
		const struct libprettyerr_error *	err )

perr_print_line_number()

PRETTYERR_EXPORT void perr_print_line_number	(	const struct libprettyerr_printer *	printer,
		const struct libprettyerr_error *	err,
		const char *	color )

perr_printer_init()

PRETTYERR_EXPORT void perr_printer_init	(	struct libprettyerr_printer *	printer,
		FILE *	stream,
		const char *	source,
		bool	utf8,
		libprettyerr_runner_t	style )

Definition at line 42 of file prettyerr.c.

                                                                           {
  printer->source = source;
  printer->stream = stream;
 
// Enables ANSI colors only in Unix terminals. False by default on Windows.
#if defined(__unix__) || defined(__unix) ||                                    \
    (defined(__APPLE__) && defined(__MACH__))
  const int fd = fileno(stream);
  // if (fd < 0) {
  //     perror("fileno");
  // }
  printer->color = isatty(fd);
#else
  printer->color = false;
#endif
 
  if ((printer->utf8 = utf8)) {
    printer->box_lookup = _utf8_box_lookup;
  } else {
    printer->box_lookup = _ascii_box_lookup;
  }
  printer->runner = style;
}

Variable Documentation

perr_runner_basic_style

PRETTYERR_EXPORT perr_runner_t perr_runner_basic_style

extern

Definition at line 245 of file prettyerr.c.

perr_runner_secondary_style

PRETTYERR_EXPORT perr_runner_t perr_runner_secondary_style

extern

Definition at line 246 of file prettyerr.c.