prettyerr.c File Reference

#include <string.h>
#include <ctype.h>
#include <termcolor.h>
#include <prettyerr.h>

Go to the source code of this file.

Macros
#define	_PRINTF(...)   tcol_fprintf(printer->stream, __VA_ARGS__)
#define	_PUTCHR(...)   fputc(__VA_ARGS__, printer->stream)

Functions
void	perr_printer_init (perr_printer_t *printer, FILE *stream, const char *source, bool utf8, perr_runner_t style)
static void	perr_print_column (const perr_printer_t *printer, const char *color, const size_t column)
static void	_perr_print_filename (const perr_printer_t *printer, const perr_t *err, const size_t column)
static void	_perr_print_error (const perr_printer_t *printer, const perr_t *err, const char *color)
void	perr_print_line_number (const perr_printer_t *printer, const perr_t *err, const char *color)
static void	_perr_print_offending_line (const perr_printer_t *printer, const perr_t *err, const char *error_line, const char *color, const size_t column)
static void	_perr_print_highlight_error (const perr_printer_t *printer, const perr_t *err, const char *error_line, const char *color, const size_t column, const bool small)
static void	_perr_print_fix (const perr_printer_t *printer, const char *fix)
static void	lookup_color (char *color, enum libprettyerr_errtype type)
static void	perr_print_basic_style (const perr_printer_t *printer, const perr_t *err)
static void	perr_print_secondary_style (const perr_printer_t *printer, const perr_t *err)
void	perr_print_error (const perr_printer_t *printer, const perr_t *err)

Variables
static char const	_tcol_lookup [5] = {'G', 'R', 'M', 'B', 'Y'}
static char const *	_ascii_box_lookup [8] = {"|", "|", "+", "-", "+", "|"}
static char const *	_utf8_box_lookup [8]
static const char *	_errtype_lookup [5]
perr_runner_t	perr_runner_basic_style = perr_print_basic_style
perr_runner_t	perr_runner_secondary_style = perr_print_secondary_style

Macro Definition Documentation

_PRINTF

#define _PRINTF

(

...

)

tcol_fprintf(printer->stream, __VA_ARGS__)

Definition at line 29 of file prettyerr.c.

_PUTCHR

#define _PUTCHR

(

...

)

fputc(__VA_ARGS__, printer->stream)

Definition at line 30 of file prettyerr.c.

Function Documentation

_perr_print_error()

static void _perr_print_error ( const perr_printer_t * printer, const perr_t * err, const char * color )

static

Definition at line 79 of file prettyerr.c.

                                                 {
  _PRINTF("%s%s", color, _errtype_lookup[err->type]);
  if (err->error_code)
    _PRINTF("[%c%04d]", toupper(_errtype_lookup[err->type][0]),
            err->error_code);
  _PRINTF("{0}: ");
}

_perr_print_filename()

static void _perr_print_filename ( const perr_printer_t * printer, const perr_t * err, const size_t column )

inlinestatic

Definition at line 73 of file prettyerr.c.

                                                                      {
  _PRINTF("{0}{+}%s{0}:%zu:%zu: ", err->filename, err->primary.line, column);
}

_perr_print_fix()

static void _perr_print_fix ( const perr_printer_t * printer, const char * fix )

inlinestatic

Definition at line 142 of file prettyerr.c.

                                                              {
  _PRINTF("{-}");
  _PRINTF(fix);
  _PRINTF("{0}\n");
}

_perr_print_highlight_error()

static void _perr_print_highlight_error ( const perr_printer_t * printer, const perr_t * err, const char * error_line, const char * color, const size_t column, const bool small )

inlinestatic

Definition at line 110 of file prettyerr.c.

                                                                            {
  perr_print_column(printer, color, 0);
  char* line = (char*)error_line;
  size_t i = 0;
  while(i < column) {
    if(*line =='\t') _PRINTF("\t");
    else _PRINTF(" ");
    i++;
    line++;
  }
  const enum libprettyerr_boxtype type =
      (!small ? PERR_BOX_THIN_UL : PERR_BOX_THIN_BL) + printer->rounded;
  if (err->error_position.length > 1) {
    _PRINTF("%s{-}%s", color, printer->box_lookup[type]);
    {
      size_t i;
      for (i = 1; i < err->error_position.length; i++) {
        _PRINTF(printer->box_lookup[PERR_BOX_THIN_HORIZ]);
      }
    }
  } else
    _PRINTF("%s{-}%s", color, printer->box_lookup[PERR_BOX_THIN_VERT]);
  _PRINTF("{0}\n");
}

_perr_print_offending_line()

static void _perr_print_offending_line ( const perr_printer_t * printer, const perr_t * err, const char * error_line, const char * color, const size_t column )

static

Definition at line 96 of file prettyerr.c.

                                                                               {
  _PRINTF("%.*s", (int)column, error_line);
  const char *bug = error_line + column;
  _PRINTF("%s{-}%.*s{0}", color, (int)err->error_position.length, bug);
  const char *end      = bug + err->error_position.length;
  char *      nl       = strstr(end, "\n");
  ptrdiff_t   nl_index = nl ? nl - end : (ptrdiff_t)strlen(end) - 1;
  _PRINTF("%.*s\n", (int)nl_index, end);
}

lookup_color()

static void lookup_color ( char * color, enum libprettyerr_errtype type )

static

Definition at line 149 of file prettyerr.c.

                                                                      {
  char _color[16];
  sprintf(_color, "+%c", _tcol_lookup[type]);
  size_t    len;
  const int status = tcol_color_parse(color, 16, _color, 2, &len);
  if (status != TermColorErrorNone) {
    color[0] = 0;
    // error
  } else
    color[len] = 0;
}

perr_print_basic_style()

static void perr_print_basic_style ( const perr_printer_t * printer, const perr_t * err )

inlinestatic

Definition at line 161 of file prettyerr.c.

                                                                     {
  // Normal errors:
  //
  // $filename:$line:$col: $type: $msg
  //  $line | <long line here>
  //        |       ^^^^
 
  // Here we scan backwards until we reach the start of the line (or the
  // start of the source code). This allows us to retrieve the line that has
  // the error.
  size_t idx_cpy = err->error_position.index;
  while (idx_cpy > 0 && printer->source[idx_cpy - 1] != '\n') { idx_cpy--; }
  const char *error_line = (printer->source + idx_cpy);
  error_line += (printer->source[idx_cpy] == '\n') ? 1 : 0;
 
  // The column is how far the error's index is from the start-of-line's
  // index.
  const size_t column = err->error_position.index - idx_cpy;
 
  char color[17];
  lookup_color(color, err->type);
 
  // Here we print the first row of the error message which provides general
  // information such as filename, line, column, error type and a message.
  _perr_print_filename(printer, err, column);
  _perr_print_error(printer, err, color);
  _PRINTF(err->main);
  _PUTCHR('\n');
 
  perr_print_line_number(printer, err, color);
  _perr_print_offending_line(printer, err, error_line, color, column);
  _perr_print_highlight_error(printer, err, error_line, color, column, !err->explain);
 
  // Adds a subsidiary error note, if applicable
  if (err->explain) {
    perr_print_column(printer, color, column);
    _PRINTF("{-}%s%s{0}\n", color, printer->box_lookup[PERR_BOX_THIN_HIGH]);
    perr_print_column(printer, color, column);
    _PRINTF(err->explain);
    _PUTCHR('\n');
  }
}

perr_print_column()

static void perr_print_column ( const perr_printer_t * printer, const char * color, const size_t column )

static

Definition at line 67 of file prettyerr.c.

                                                   {
  _PRINTF("      %s%s{0} %*s", color, printer->box_lookup[PERR_BOX_THICK_VERT],
          (int)column, "");
}

perr_print_error()

void perr_print_error	(	const perr_printer_t *	printer,
		const perr_t *	err )

Definition at line 241 of file prettyerr.c.

                                                                        {
  printer->runner(printer, err);
}

perr_print_line_number()

void perr_print_line_number	(	const perr_printer_t *	printer,
		const perr_t *	err,
		const char *	color )

Definition at line 89 of file prettyerr.c.

                                               {
  _PRINTF("{-}%5zu{0} %s%s{0} ", err->primary.line, color,
          printer->box_lookup[PERR_BOX_THICK_VERT]);
}

perr_print_secondary_style()

static void perr_print_secondary_style ( const perr_printer_t * printer, const perr_t * err )

inlinestatic

Definition at line 212 of file prettyerr.c.

                                                                         {
  size_t idx_cpy = err->error_position.index;
  while (idx_cpy > 0 && printer->source[idx_cpy - 1] != '\n') { idx_cpy--; }
  const char *error_line = (printer->source + idx_cpy);
  error_line += (printer->source[idx_cpy] == '\n') ? 1 : 0;
 
  // The column is how far the error's index is from the start-of-line's
  // index.
  const size_t column = err->error_position.index - idx_cpy;
 
  char color[17];
  lookup_color(color, err->type);
 
  _perr_print_filename(printer, err, column);
  _PUTCHR('\n');
 
  perr_print_line_number(printer, err, color);
  _perr_print_offending_line(printer, err, error_line, color, column);
  _perr_print_highlight_error(printer, err, error_line, color, column, false);
 
  perr_print_column(printer, color, column);
  _PRINTF("{-}%s%s%.*s{0} ", color,
          printer->box_lookup[PERR_BOX_THIN_BL + printer->rounded], 3,
          printer->box_lookup[PERR_BOX_THIN_HORIZ]);
  _PRINTF(err->main);
  _PUTCHR('\n');
}

perr_printer_init()

void perr_printer_init	(	perr_printer_t *	printer,
		FILE *	stream,
		const char *	source,
		bool	utf8,
		perr_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

_ascii_box_lookup

char const* _ascii_box_lookup[8] = {"|", "|", "+", "-", "+", "|"}

static

Definition at line 34 of file prettyerr.c.

{"|", "|", "+", "-", "+", "|"};

_errtype_lookup

const char* _errtype_lookup[5]

static

Initial value:

= {"succes", "error", "warning", "info",
                                         "hint"}

Definition at line 39 of file prettyerr.c.

                                        {"succes", "error", "warning", "info",
                                         "hint"};

_tcol_lookup

char const _tcol_lookup[5] = {'G', 'R', 'M', 'B', 'Y'}

static

Definition at line 32 of file prettyerr.c.

{'G', 'R', 'M', 'B', 'Y'};

_utf8_box_lookup

char const* _utf8_box_lookup[8]

static

Initial value:

= {"┃", "╵", "┌", "╭",
                                          "─", "└", "╰", "│"}

Definition at line 36 of file prettyerr.c.

                                         {"┃", "╵", "┌", "╭",
                                          "─", "└", "╰", "│"};

perr_runner_basic_style

perr_runner_t perr_runner_basic_style = perr_print_basic_style

Definition at line 245 of file prettyerr.c.

perr_runner_secondary_style

perr_runner_t perr_runner_secondary_style = perr_print_secondary_style

Definition at line 246 of file prettyerr.c.