serialize.h File Reference

The functions related to serializing the AST to a binary format. More...

#include "prism/excludes.h"
#include "prism/compiler/exported.h"
#include "prism/compiler/nonnull.h"
#include "prism/buffer.h"
#include "prism/errors_format.h"
#include "prism/parser.h"
#include "prism/source.h"
#include "prism/stream.h"

Include dependency graph for serialize.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
PRISM_EXPORTED_FUNCTION void	pm_serialize (pm_parser_t *parser, pm_node_t *node, pm_buffer_t *buffer) PRISM_NONNULL(1
	Serialize the AST represented by the given node to the given buffer.
PRISM_EXPORTED_FUNCTION void PRISM_EXPORTED_FUNCTION void	pm_serialize_parse (pm_buffer_t *buffer, const uint8_t *source, size_t size, const char *data) PRISM_NONNULL(1
	Parse the given source to the AST and dump the AST to the given buffer.
PRISM_EXPORTED_FUNCTION void PRISM_EXPORTED_FUNCTION void PRISM_EXPORTED_FUNCTION void	pm_serialize_parse_stream (pm_buffer_t *buffer, pm_source_t *source, const char *data) PRISM_NONNULL(1
	Parse and serialize the AST represented by the given source into the given buffer.
PRISM_EXPORTED_FUNCTION void PRISM_EXPORTED_FUNCTION void PRISM_EXPORTED_FUNCTION void PRISM_EXPORTED_FUNCTION void	pm_serialize_parse_comments (pm_buffer_t *buffer, const uint8_t *source, size_t size, const char *data) PRISM_NONNULL(1
	Parse and serialize the comments in the given source to the given buffer.
PRISM_EXPORTED_FUNCTION void PRISM_EXPORTED_FUNCTION void PRISM_EXPORTED_FUNCTION void PRISM_EXPORTED_FUNCTION void PRISM_EXPORTED_FUNCTION void	pm_serialize_lex (pm_buffer_t *buffer, const uint8_t *source, size_t size, const char *data) PRISM_NONNULL(1
	Lex the given source and serialize to the given buffer.
PRISM_EXPORTED_FUNCTION void PRISM_EXPORTED_FUNCTION void PRISM_EXPORTED_FUNCTION void PRISM_EXPORTED_FUNCTION void PRISM_EXPORTED_FUNCTION void PRISM_EXPORTED_FUNCTION void	pm_serialize_parse_lex (pm_buffer_t *buffer, const uint8_t *source, size_t size, const char *data) PRISM_NONNULL(1
	Parse and serialize both the AST and the tokens represented by the given source to the given buffer.
PRISM_EXPORTED_FUNCTION void PRISM_EXPORTED_FUNCTION void PRISM_EXPORTED_FUNCTION void PRISM_EXPORTED_FUNCTION void PRISM_EXPORTED_FUNCTION void PRISM_EXPORTED_FUNCTION void PRISM_EXPORTED_FUNCTION bool	pm_serialize_parse_success_p (const uint8_t *source, size_t size, const char *data) PRISM_NONNULL(1)
	Parse the source and return true if it parses without errors or warnings.
PRISM_EXPORTED_FUNCTION int8_t	pm_serialize_parse_errors_format (pm_buffer_t *buffer, const uint8_t *source, size_t size, const char *data, pm_errors_format_type_t format_type) PRISM_NONNULL(1
	Parse the given source and format any errors that are encountered into the given buffer using the given format type.

Detailed Description

The functions related to serializing the AST to a binary format.

Function Documentation

pm_serialize()

PRISM_EXPORTED_FUNCTION void pm_serialize	(	pm_parser_t *	parser,
		pm_node_t *	node,
		pm_buffer_t *	buffer
	)

Serialize the AST represented by the given node to the given buffer.

Parameters

parser	The parser to serialize.
node	The node to serialize.
buffer	The buffer to serialize to.

pm_serialize_parse()

PRISM_EXPORTED_FUNCTION void PRISM_EXPORTED_FUNCTION void pm_serialize_parse	(	pm_buffer_t *	buffer,
		const uint8_t *	source,
		size_t	size,
		const char *	data
	)

Parse the given source to the AST and dump the AST to the given buffer.

Parameters

buffer	The buffer to serialize to.
source	The source to parse.
size	The size of the source.
data	The optional data to pass to the parser.

pm_serialize_parse_stream()

PRISM_EXPORTED_FUNCTION void PRISM_EXPORTED_FUNCTION void PRISM_EXPORTED_FUNCTION void pm_serialize_parse_stream	(	pm_buffer_t *	buffer,
		pm_source_t *	source,
		const char *	data
	)

Parse and serialize the AST represented by the given source into the given buffer.

Parameters

buffer	The buffer to serialize to.
source	The source to parse.
data	The optional data to pass to the parser.

pm_serialize_parse_comments()

PRISM_EXPORTED_FUNCTION void PRISM_EXPORTED_FUNCTION void PRISM_EXPORTED_FUNCTION void PRISM_EXPORTED_FUNCTION void pm_serialize_parse_comments	(	pm_buffer_t *	buffer,
		const uint8_t *	source,
		size_t	size,
		const char *	data
	)

Parse and serialize the comments in the given source to the given buffer.

Parameters

buffer	The buffer to serialize to.
source	The source to parse.
size	The size of the source.
data	The optional data to pass to the parser.

pm_serialize_lex()

PRISM_EXPORTED_FUNCTION void PRISM_EXPORTED_FUNCTION void PRISM_EXPORTED_FUNCTION void PRISM_EXPORTED_FUNCTION void PRISM_EXPORTED_FUNCTION void pm_serialize_lex	(	pm_buffer_t *	buffer,
		const uint8_t *	source,
		size_t	size,
		const char *	data
	)

Lex the given source and serialize to the given buffer.

Parameters

source	The source to lex.
size	The size of the source.
buffer	The buffer to serialize to.
data	The optional data to pass to the lexer.

pm_serialize_parse_lex()

PRISM_EXPORTED_FUNCTION void PRISM_EXPORTED_FUNCTION void PRISM_EXPORTED_FUNCTION void PRISM_EXPORTED_FUNCTION void PRISM_EXPORTED_FUNCTION void PRISM_EXPORTED_FUNCTION void pm_serialize_parse_lex	(	pm_buffer_t *	buffer,
		const uint8_t *	source,
		size_t	size,
		const char *	data
	)

Parse and serialize both the AST and the tokens represented by the given source to the given buffer.

Parameters

buffer	The buffer to serialize to.
source	The source to parse.
size	The size of the source.
data	The optional data to pass to the parser.

pm_serialize_parse_success_p()

PRISM_EXPORTED_FUNCTION void PRISM_EXPORTED_FUNCTION void PRISM_EXPORTED_FUNCTION void PRISM_EXPORTED_FUNCTION void PRISM_EXPORTED_FUNCTION void PRISM_EXPORTED_FUNCTION void PRISM_EXPORTED_FUNCTION bool pm_serialize_parse_success_p	(	const uint8_t *	source,
		size_t	size,
		const char *	data
	)

Parse the source and return true if it parses without errors or warnings.

Parameters

source	The source to parse.
size	The size of the source.
data	The optional data to pass to the parser.

Returns

True if the source parses without errors or warnings.

pm_serialize_parse_errors_format()

PRISM_EXPORTED_FUNCTION int8_t pm_serialize_parse_errors_format	(	pm_buffer_t *	buffer,
		const uint8_t *	source,
		size_t	size,
		const char *	data,
		pm_errors_format_type_t	format_type
	)

Parse the given source and format any errors that are encountered into the given buffer using the given format type.

If the source parses without any errors, then -1 is returned and the buffer is left empty. Otherwise, the name of the encoding of the source is written to the buffer, followed by a null byte, followed by the formatted errors, and the error level of the error with the highest precedence is returned.

Parameters

buffer	The buffer to write the encoding name and formatted errors to.
source	The source to parse.
size	The size of the source.
data	The optional data to pass to the parser.
format_type	The type of formatting to use when formatting the errors.

Returns

The error level of the error with the highest precedence, or -1 if the source parsed without errors.