prism/c/errors__format_8h_source.html

#ifndef PRISM_ERRORS_FORMAT_H

#define PRISM_ERRORS_FORMAT_H


#include "prism/compiler/exported.h"

#include "prism/compiler/nodiscard.h"

#include "prism/compiler/nonnull.h"


#include "prism/buffer.h"

#include "prism/diagnostic.h"

#include "prism/parser.h"


typedef enum {

    PM_ERRORS_FORMAT_PLAIN = 1,


    PM_ERRORS_FORMAT_STYLE = 2,


    PM_ERRORS_FORMAT_COLOR = 3

} pm_errors_format_type_t;


PRISM_EXPORTED_FUNCTION pm_error_level_t pm_errors_format(const pm_parser_t *parser, pm_buffer_t *buffer, pm_errors_format_type_t format_type) PRISM_NONNULL(1, 2);


#endif

buffer.h
A wrapper around a contiguous block of allocated memory.

pm_buffer_t
struct pm_buffer_t pm_buffer_t
A wrapper around a contiguous block of allocated memory.
Definition buffer.h:18

diagnostic.h
A list of diagnostics generated during parsing.

pm_error_level_t
pm_error_level_t
The levels of errors generated during parsing.
Definition diagnostic.h:23

pm_errors_format
PRISM_EXPORTED_FUNCTION pm_error_level_t pm_errors_format(const pm_parser_t *parser, pm_buffer_t *buffer, pm_errors_format_type_t format_type) PRISM_NONNULL(1
Format the errors in a parser into a buffer.

pm_errors_format_type_t
pm_errors_format_type_t
The type of formatting to use when formatting errors.
Definition errors_format.h:18

PM_ERRORS_FORMAT_PLAIN
@ PM_ERRORS_FORMAT_PLAIN
Format errors in a plain format with no colors or styles.
Definition errors_format.h:22

PM_ERRORS_FORMAT_COLOR
@ PM_ERRORS_FORMAT_COLOR
Format errors in a color format with bold and colors.
Definition errors_format.h:32

PM_ERRORS_FORMAT_STYLE
@ PM_ERRORS_FORMAT_STYLE
Format errors in a style format with bold only.
Definition errors_format.h:27

parser.h
The parser used to parse Ruby source.

pm_parser_t
struct pm_parser_t pm_parser_t
The parser used to parse Ruby source.
Definition parser.h:22