Data Structures
struct	yaml_node_pair_s
	An element of a mapping node. More...

struct	yaml_node_s
	The node structure. More...

struct	yaml_document_s
	The document structure. More...

Macros
#define	YAML_NULL_TAG "tag:yaml.org,2002:null"
	The tag `!!null` with the only possible value: `null`. More...

#define	YAML_BOOL_TAG "tag:yaml.org,2002:bool"
	The tag `!!bool` with the values: `true` and `false`. More...

#define	YAML_STR_TAG "tag:yaml.org,2002:str"
	The tag `!!str` for string values. More...

#define	YAML_INT_TAG "tag:yaml.org,2002:int"
	The tag `!!int` for integer values. More...

#define	YAML_FLOAT_TAG "tag:yaml.org,2002:float"
	The tag `!!float` for float values. More...

#define	YAML_TIMESTAMP_TAG "tag:yaml.org,2002:timestamp"
	The tag `!!timestamp` for date and time values. More...

#define	YAML_SEQ_TAG "tag:yaml.org,2002:seq"
	The tag `!!seq` is used to denote sequences. More...

#define	YAML_MAP_TAG "tag:yaml.org,2002:map"
	The tag `!!map` is used to denote mapping. More...

#define	YAML_DEFAULT_SCALAR_TAG YAML_STR_TAG
	The default scalar tag is `!!str`. More...

#define	YAML_DEFAULT_SEQUENCE_TAG YAML_SEQ_TAG
	The default sequence tag is `!!seq`. More...

#define	YAML_DEFAULT_MAPPING_TAG YAML_MAP_TAG
	The default mapping tag is `!!map`. More...

Typedefs
typedef enum yaml_node_type_e	yaml_node_type_t
	Node types. More...

typedef struct yaml_node_s	yaml_node_t
	The forward definition of a document node structure. More...

typedef int	yaml_node_item_t
	An element of a sequence node. More...

typedef struct yaml_node_pair_s	yaml_node_pair_t
	An element of a mapping node. More...

typedef struct yaml_document_s	yaml_document_t
	The document structure. More...

Enumerations
enum	yaml_node_type_e { YAML_NO_NODE, YAML_SCALAR_NODE, YAML_SEQUENCE_NODE, YAML_MAPPING_NODE }
	Node types. More...

Functions
	yaml_document_initialize (yaml_document_t document, yaml_version_directive_t version_directive, yaml_tag_directive_t tag_directives_start, yaml_tag_directive_t tag_directives_end, int start_implicit, int end_implicit)
	Create a YAML document. More...

	yaml_document_delete (yaml_document_t *document)
	Delete a YAML document and all its nodes. More...

	yaml_document_get_node (yaml_document_t *document, int index)
	Get a node of a YAML document. More...

	yaml_document_get_root_node (yaml_document_t *document)
	Get the root of a YAML document node. More...

	yaml_document_add_scalar (yaml_document_t document, const yaml_char_t tag, const yaml_char_t *value, int length, yaml_scalar_style_t style)
	Create a SCALAR node and attach it to the document. More...

	yaml_document_add_sequence (yaml_document_t document, const yaml_char_t tag, yaml_sequence_style_t style)
	Create a SEQUENCE node and attach it to the document. More...

	yaml_document_add_mapping (yaml_document_t document, const yaml_char_t tag, yaml_mapping_style_t style)
	Create a MAPPING node and attach it to the document. More...

	yaml_document_append_sequence_item (yaml_document_t *document, int sequence, int item)
	Add an item to a SEQUENCE node. More...

	yaml_document_append_mapping_pair (yaml_document_t *document, int mapping, int key, int value)
	Add a pair of a key and a value to a MAPPING node. More...

Detailed Description

Macro Definition Documentation

◆ YAML_NULL_TAG

#define YAML_NULL_TAG "tag:yaml.org,2002:null"

The tag !!null with the only possible value: null.

Definition at line 667 of file yaml.h.

◆ YAML_BOOL_TAG

#define YAML_BOOL_TAG "tag:yaml.org,2002:bool"

The tag !!bool with the values: true and false.

Definition at line 669 of file yaml.h.

◆ YAML_STR_TAG

#define YAML_STR_TAG "tag:yaml.org,2002:str"

The tag !!str for string values.

Definition at line 671 of file yaml.h.

◆ YAML_INT_TAG

#define YAML_INT_TAG "tag:yaml.org,2002:int"

The tag !!int for integer values.

Definition at line 673 of file yaml.h.

◆ YAML_FLOAT_TAG

#define YAML_FLOAT_TAG "tag:yaml.org,2002:float"

The tag !!float for float values.

Definition at line 675 of file yaml.h.

◆ YAML_TIMESTAMP_TAG

#define YAML_TIMESTAMP_TAG "tag:yaml.org,2002:timestamp"

The tag !!timestamp for date and time values.

Definition at line 677 of file yaml.h.

◆ YAML_SEQ_TAG

#define YAML_SEQ_TAG "tag:yaml.org,2002:seq"

The tag !!seq is used to denote sequences.

Definition at line 680 of file yaml.h.

◆ YAML_MAP_TAG

#define YAML_MAP_TAG "tag:yaml.org,2002:map"

The tag !!map is used to denote mapping.

Definition at line 682 of file yaml.h.

◆ YAML_DEFAULT_SCALAR_TAG

#define YAML_DEFAULT_SCALAR_TAG YAML_STR_TAG

The default scalar tag is !!str.

Definition at line 685 of file yaml.h.

◆ YAML_DEFAULT_SEQUENCE_TAG

#define YAML_DEFAULT_SEQUENCE_TAG YAML_SEQ_TAG

The default sequence tag is !!seq.

Definition at line 687 of file yaml.h.

◆ YAML_DEFAULT_MAPPING_TAG

#define YAML_DEFAULT_MAPPING_TAG YAML_MAP_TAG

The default mapping tag is !!map.

Definition at line 689 of file yaml.h.

Typedef Documentation

◆ yaml_node_type_t

typedef enum yaml_node_type_e yaml_node_type_t

Node types.

◆ yaml_node_t

typedef struct yaml_node_s yaml_node_t

The forward definition of a document node structure.

Definition at line 705 of file yaml.h.

◆ yaml_node_item_t

typedef int yaml_node_item_t

An element of a sequence node.

Definition at line 708 of file yaml.h.

◆ yaml_node_pair_t

typedef struct yaml_node_pair_s yaml_node_pair_t

An element of a mapping node.

◆ yaml_document_t

typedef struct yaml_document_s yaml_document_t

The document structure.

Enumeration Type Documentation

◆ yaml_node_type_e

enum yaml_node_type_e

Node types.

Enumerator
YAML_NO_NODE	An empty node.
YAML_SCALAR_NODE	A scalar node.
YAML_SEQUENCE_NODE	A sequence node.
YAML_MAPPING_NODE	A mapping node.

Definition at line 692 of file yaml.h.

Function Documentation

◆ yaml_document_initialize()

yaml_document_initialize	(	yaml_document_t *	document,
		yaml_version_directive_t *	version_directive,
		yaml_tag_directive_t *	tag_directives_start,
		yaml_tag_directive_t *	tag_directives_end,
		int	start_implicit,
		int	end_implicit
	)

Create a YAML document.

Parameters

[out]	document	An empty document object.
[in]	version_directive	The YAML directive value or `NULL`.
[in]	tag_directives_start	The beginning of the TAG directives list.
[in]	tag_directives_end	The end of the TAG directives list.
[in]	start_implicit	If the document start indicator is implicit.
[in]	end_implicit	If the document end indicator is implicit.

Returns: 1 if the function succeeded, 0 on error.

Definition at line 1036 of file ymlApi.c.

◆ yaml_document_delete()

yaml_document_delete ( yaml_document_t * document )

Delete a YAML document and all its nodes.

Parameters

[in,out] document A document object.

Definition at line 1123 of file ymlApi.c.

Here is the call graph for this function:

◆ yaml_document_get_node()

yaml_document_get_node	(	yaml_document_t *	document,
		int	index
	)

Get a node of a YAML document.

The pointer returned by this function is valid until any of the functions modifying the documents are called.

Parameters

[in]	document	A document object.
[in]	index	The node id.

Returns: the node objct or NULL if node_id is out of range.

Get a node of a YAML document.

Definition at line 1165 of file ymlApi.c.

◆ yaml_document_get_root_node()

yaml_document_get_root_node ( yaml_document_t * document )

Get the root of a YAML document node.

The root object is the first object added to the document.

The pointer returned by this function is valid until any of the functions modifying the documents are called.

An empty document produced by the parser signifies the end of a YAML stream.

Parameters

[in] document A document object.

Returns: the node object or NULL if the document is empty.

Get the root of a YAML document node.

Definition at line 1180 of file ymlApi.c.

◆ yaml_document_add_scalar()

yaml_document_add_scalar	(	yaml_document_t *	document,
		const yaml_char_t *	tag,
		const yaml_char_t *	value,
		int	length,
		yaml_scalar_style_t	style
	)

Create a SCALAR node and attach it to the document.

The style argument may be ignored by the emitter.

Parameters

[in,out]	document	A document object.
[in]	tag	The scalar tag.
[in]	value	The scalar value.
[in]	length	The length of the scalar value.
[in]	style	The scalar style.

Returns: the node id or 0 on error.

Definition at line 1195 of file ymlApi.c.

◆ yaml_document_add_sequence()

yaml_document_add_sequence	(	yaml_document_t *	document,
		const yaml_char_t *	tag,
		yaml_sequence_style_t	style
	)

Create a SEQUENCE node and attach it to the document.

The style argument may be ignored by the emitter.

Parameters

[in,out]	document	A document object.
[in]	tag	The sequence tag.
[in]	style	The sequence style.

Returns: the node id or 0 on error.

Definition at line 1245 of file ymlApi.c.

◆ yaml_document_add_mapping()

yaml_document_add_mapping	(	yaml_document_t *	document,
		const yaml_char_t *	tag,
		yaml_mapping_style_t	style
	)

Create a MAPPING node and attach it to the document.

The style argument may be ignored by the emitter.

Parameters

[in,out]	document	A document object.
[in]	tag	The sequence tag.
[in]	style	The sequence style.

Returns: the node id or 0 on error.

Definition at line 1290 of file ymlApi.c.

◆ yaml_document_append_sequence_item()

yaml_document_append_sequence_item	(	yaml_document_t *	document,
		int	sequence,
		int	item
	)

Add an item to a SEQUENCE node.

Parameters

[in,out]	document	A document object.
[in]	sequence	The sequence node id.
[in]	item	The item node id.

Returns: 1 if the function succeeded, 0 on error.

Definition at line 1335 of file ymlApi.c.

◆ yaml_document_append_mapping_pair()

yaml_document_append_mapping_pair	(	yaml_document_t *	document,
		int	mapping,
		int	key,
		int	value
	)

Add a pair of a key and a value to a MAPPING node.

Parameters

[in,out]	document	A document object.
[in]	mapping	The mapping node id.
[in]	key	The key node id.
[in]	value	The value node id.

Returns: 1 if the function succeeded, 0 on error.

Definition at line 1363 of file ymlApi.c.

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ YAML_NULL_TAG

◆ YAML_BOOL_TAG

◆ YAML_STR_TAG

◆ YAML_INT_TAG

◆ YAML_FLOAT_TAG

◆ YAML_TIMESTAMP_TAG

◆ YAML_SEQ_TAG

◆ YAML_MAP_TAG

◆ YAML_DEFAULT_SCALAR_TAG

◆ YAML_DEFAULT_SEQUENCE_TAG

◆ YAML_DEFAULT_MAPPING_TAG

Typedef Documentation

◆ yaml_node_type_t

◆ yaml_node_t

◆ yaml_node_item_t

◆ yaml_node_pair_t

◆ yaml_document_t

Enumeration Type Documentation

◆ yaml_node_type_e

Function Documentation

◆ yaml_document_initialize()

◆ yaml_document_delete()

◆ yaml_document_get_node()

◆ yaml_document_get_root_node()

◆ yaml_document_add_scalar()

◆ yaml_document_add_sequence()

◆ yaml_document_add_mapping()

◆ yaml_document_append_sequence_item()

◆ yaml_document_append_mapping_pair()