yaml: Parser Definitions

@@ -50,124 +52,126 @@

Data Structures

struct yaml_simple_key_s - This structure holds information about a potential simple key. More...
+ This structure holds information about a potential simple key. More...
struct yaml_alias_data_s - This structure holds aliases data. More...
+ This structure holds aliases data. More...
struct yaml_parser_s - The parser structure. More...
+ The parser structure. More...
- - + + - - + - - + - - + - +

Typedefs
typedef int	yaml_read_handler_t (void data, unsigned char buffer, size_t size, size_t *size_read)
	The prototype of a read handler. More...
typedef int	yaml_read_handler_t(void data, unsigned char buffer, size_t size, size_t *size_read)
	The prototype of a read handler. More...

+
typedef struct yaml_simple_key_s	yaml_simple_key_t
	This structure holds information about a potential simple key.
	This structure holds information about a potential simple key.

+
typedef enum yaml_parser_state_e	yaml_parser_state_t
	The states of the parser.
	The states of the parser.

+
typedef struct yaml_alias_data_s	yaml_alias_data_t
	This structure holds aliases data.
	This structure holds aliases data.

typedef struct yaml_parser_s	yaml_parser_t
	The parser structure. More...
	The parser structure. More...

- - +

Enumerations
enum	yaml_parser_state_e { +
enum	yaml_parser_state_e { YAML_PARSE_STREAM_START_STATE, - + YAML_PARSE_IMPLICIT_DOCUMENT_START_STATE, - + YAML_PARSE_DOCUMENT_START_STATE, - + YAML_PARSE_DOCUMENT_CONTENT_STATE, - + YAML_PARSE_DOCUMENT_END_STATE, - + YAML_PARSE_BLOCK_NODE_STATE, - + YAML_PARSE_BLOCK_NODE_OR_INDENTLESS_SEQUENCE_STATE, - + YAML_PARSE_FLOW_NODE_STATE, - + YAML_PARSE_BLOCK_SEQUENCE_FIRST_ENTRY_STATE, - + YAML_PARSE_BLOCK_SEQUENCE_ENTRY_STATE, - + YAML_PARSE_INDENTLESS_SEQUENCE_ENTRY_STATE, - + YAML_PARSE_BLOCK_MAPPING_FIRST_KEY_STATE, - + YAML_PARSE_BLOCK_MAPPING_KEY_STATE, - + YAML_PARSE_BLOCK_MAPPING_VALUE_STATE, - + YAML_PARSE_FLOW_SEQUENCE_FIRST_ENTRY_STATE, - + YAML_PARSE_FLOW_SEQUENCE_ENTRY_STATE, - + YAML_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_KEY_STATE, - + YAML_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_VALUE_STATE, - + YAML_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_END_STATE, - + YAML_PARSE_FLOW_MAPPING_FIRST_KEY_STATE, - + YAML_PARSE_FLOW_MAPPING_KEY_STATE, - + YAML_PARSE_FLOW_MAPPING_VALUE_STATE, - + YAML_PARSE_FLOW_MAPPING_EMPTY_VALUE_STATE, - + YAML_PARSE_END_STATE - + }
	The states of the parser. More...
	The states of the parser. More...

- + - + - + - + - + - + - + - + - +

Functions
int	yaml_parser_initialize (yaml_parser_t *parser)
	Initialize a parser. More...
	Initialize a parser. More...

void	yaml_parser_delete (yaml_parser_t *parser)
	Destroy a parser. More...
	Destroy a parser. More...

void	yaml_parser_set_input_string (yaml_parser_t parser, const unsigned char input, size_t size)
	Set a string input. More...
	Set a string input. More...

void	yaml_parser_set_input_file (yaml_parser_t parser, FILE file)
	Set a file input. More...
	Set a file input. More...

void	yaml_parser_set_input (yaml_parser_t parser, yaml_read_handler_t handler, void *data)
	Set a generic input handler. More...
	Set a generic input handler. More...

void	yaml_parser_set_encoding (yaml_parser_t *parser, yaml_encoding_t encoding)
	Set the source encoding. More...
	Set the source encoding. More...

int	yaml_parser_scan (yaml_parser_t parser, yaml_token_t token)
	Scan the input stream and produce the next token. More...
	Scan the input stream and produce the next token. More...

int	yaml_parser_parse (yaml_parser_t parser, yaml_event_t event)
	Parse the input stream and produce the next parsing event. More...
	Parse the input stream and produce the next parsing event. More...

int	yaml_parser_load (yaml_parser_t parser, yaml_document_t document)
	Parse the input stream and produce the next YAML document. More...
	Parse the input stream and produce the next YAML document. More...

Detailed Description

Typedef Documentation

- + +

◆ yaml_read_handler_t

@@ -192,7 +196,9 @@ Functions - + +

◆ yaml_parser_t

@@ -208,7 +214,9 @@ Functions

Enumeration Type Documentation

- + +

◆ yaml_parser_state_e

@@ -220,84 +228,62 @@ Functions

The states of the parser.

- - - - - - - - - - - - - - - - - - - - - - - -

Enumerator
YAML_PARSE_STREAM_START_STATE	- Expect STREAM-START. +
Enumerator
YAML_PARSE_STREAM_START_STATE	Expect STREAM-START.
YAML_PARSE_IMPLICIT_DOCUMENT_START_STATE	- Expect the beginning of an implicit document. +
YAML_PARSE_IMPLICIT_DOCUMENT_START_STATE	Expect the beginning of an implicit document.
YAML_PARSE_DOCUMENT_START_STATE	- Expect DOCUMENT-START. +
YAML_PARSE_DOCUMENT_START_STATE	Expect DOCUMENT-START.
YAML_PARSE_DOCUMENT_CONTENT_STATE	- Expect the content of a document. +
YAML_PARSE_DOCUMENT_CONTENT_STATE	Expect the content of a document.
YAML_PARSE_DOCUMENT_END_STATE	- Expect DOCUMENT-END. +
YAML_PARSE_DOCUMENT_END_STATE	Expect DOCUMENT-END.
YAML_PARSE_BLOCK_NODE_STATE	- Expect a block node. +
YAML_PARSE_BLOCK_NODE_STATE	Expect a block node.
YAML_PARSE_BLOCK_NODE_OR_INDENTLESS_SEQUENCE_STATE	- Expect a block node or indentless sequence. +
YAML_PARSE_BLOCK_NODE_OR_INDENTLESS_SEQUENCE_STATE	Expect a block node or indentless sequence.
YAML_PARSE_FLOW_NODE_STATE	- Expect a flow node. +
YAML_PARSE_FLOW_NODE_STATE	Expect a flow node.
YAML_PARSE_BLOCK_SEQUENCE_FIRST_ENTRY_STATE	- Expect the first entry of a block sequence. +
YAML_PARSE_BLOCK_SEQUENCE_FIRST_ENTRY_STATE	Expect the first entry of a block sequence.
YAML_PARSE_BLOCK_SEQUENCE_ENTRY_STATE	- Expect an entry of a block sequence. +
YAML_PARSE_BLOCK_SEQUENCE_ENTRY_STATE	Expect an entry of a block sequence.
YAML_PARSE_INDENTLESS_SEQUENCE_ENTRY_STATE	- Expect an entry of an indentless sequence. +
YAML_PARSE_INDENTLESS_SEQUENCE_ENTRY_STATE	Expect an entry of an indentless sequence.
YAML_PARSE_BLOCK_MAPPING_FIRST_KEY_STATE	- Expect the first key of a block mapping. +
YAML_PARSE_BLOCK_MAPPING_FIRST_KEY_STATE	Expect the first key of a block mapping.
YAML_PARSE_BLOCK_MAPPING_KEY_STATE	- Expect a block mapping key. +
YAML_PARSE_BLOCK_MAPPING_KEY_STATE	Expect a block mapping key.
YAML_PARSE_BLOCK_MAPPING_VALUE_STATE	- Expect a block mapping value. +
YAML_PARSE_BLOCK_MAPPING_VALUE_STATE	Expect a block mapping value.
YAML_PARSE_FLOW_SEQUENCE_FIRST_ENTRY_STATE	- Expect the first entry of a flow sequence. +
YAML_PARSE_FLOW_SEQUENCE_FIRST_ENTRY_STATE	Expect the first entry of a flow sequence.
YAML_PARSE_FLOW_SEQUENCE_ENTRY_STATE	- Expect an entry of a flow sequence. +
YAML_PARSE_FLOW_SEQUENCE_ENTRY_STATE	Expect an entry of a flow sequence.
YAML_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_KEY_STATE	- Expect a key of an ordered mapping. +
YAML_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_KEY_STATE	Expect a key of an ordered mapping.
YAML_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_VALUE_STATE	- Expect a value of an ordered mapping. +
YAML_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_VALUE_STATE	Expect a value of an ordered mapping.
YAML_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_END_STATE	- Expect the and of an ordered mapping entry. +
YAML_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_END_STATE	Expect the and of an ordered mapping entry.
YAML_PARSE_FLOW_MAPPING_FIRST_KEY_STATE	- Expect the first key of a flow mapping. +
YAML_PARSE_FLOW_MAPPING_FIRST_KEY_STATE	Expect the first key of a flow mapping.
YAML_PARSE_FLOW_MAPPING_KEY_STATE	- Expect a key of a flow mapping. +
YAML_PARSE_FLOW_MAPPING_KEY_STATE	Expect a key of a flow mapping.
YAML_PARSE_FLOW_MAPPING_VALUE_STATE	- Expect a value of a flow mapping. +
YAML_PARSE_FLOW_MAPPING_VALUE_STATE	Expect a value of a flow mapping.
YAML_PARSE_FLOW_MAPPING_EMPTY_VALUE_STATE	- Expect an empty value of a flow mapping. +
YAML_PARSE_FLOW_MAPPING_EMPTY_VALUE_STATE	Expect an empty value of a flow mapping.
YAML_PARSE_END_STATE	- Expect nothing. +
YAML_PARSE_END_STATE	Expect nothing.

Function Documentation

- + +

◆ yaml_parser_initialize()

@@ -323,7 +309,9 @@ Functions - + +

◆ yaml_parser_delete()

@@ -347,7 +335,9 @@ Functions - + +

◆ yaml_parser_set_input_string()

@@ -390,7 +380,9 @@ Functions - + +

◆ yaml_parser_set_input_file()

@@ -426,7 +418,9 @@ Functions - + +

◆ yaml_parser_set_input()

@@ -468,7 +462,9 @@ Functions - + +

◆ yaml_parser_set_encoding()

@@ -503,7 +499,9 @@ Functions - + +

◆ yaml_parser_scan()

@@ -542,7 +540,9 @@ Functions - + +

◆ yaml_parser_parse()

@@ -581,7 +581,9 @@ Functions - + +

◆ yaml_parser_load()

@@ -624,9 +626,9 @@ Functions

Data Structures

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ yaml_read_handler_t

◆ yaml_parser_t

Enumeration Type Documentation

◆ yaml_parser_state_e

Function Documentation

◆ yaml_parser_initialize()

◆ yaml_parser_delete()

◆ yaml_parser_set_input_string()

◆ yaml_parser_set_input_file()

◆ yaml_parser_set_input()

◆ yaml_parser_set_encoding()

◆ yaml_parser_scan()

◆ yaml_parser_parse()

◆ yaml_parser_load()