X-Git-Url: http://andersk.mit.edu/gitweb/libyaml.git/blobdiff_plain/b46834b37908d8052738f5b150970b56dc629fd5..0f400264da7f8230f00688a666132c861939906e:/doc/html/group__nodes.html diff --git a/doc/html/group__nodes.html b/doc/html/group__nodes.html index 092ab87..dfae245 100644 --- a/doc/html/group__nodes.html +++ b/doc/html/group__nodes.html @@ -3,52 +3,45 @@ + + yaml: Nodes - + + - - - -
- - +
- - - - - -
+
yaml -  0.1.6 +  0.2.1
-
- - - -
+ + + + + + +
Data Structures | -Defines | +Macros | Typedefs | Enumerations | Functions
@@ -57,252 +50,299 @@
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + +

+

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...

-Defines

#define YAML_NULL_TAG   "tag:yaml.org,2002:null"
 The tag !!null with the only possible value: null.
#define YAML_BOOL_TAG   "tag:yaml.org,2002:bool"
 The tag !!bool with the values: true and falce.
#define YAML_STR_TAG   "tag:yaml.org,2002:str"
 The tag !!str for string values.
#define YAML_INT_TAG   "tag:yaml.org,2002:int"
 The tag !!int for integer values.
#define YAML_FLOAT_TAG   "tag:yaml.org,2002:float"
 The tag !!float for float values.
#define YAML_TIMESTAMP_TAG   "tag:yaml.org,2002:timestamp"
 The tag !!timestamp for date and time values.
#define YAML_SEQ_TAG   "tag:yaml.org,2002:seq"
 The tag !!seq is used to denote sequences.
#define YAML_MAP_TAG   "tag:yaml.org,2002:map"
 The tag !!map is used to denote mapping.
#define YAML_DEFAULT_SCALAR_TAG   YAML_STR_TAG
 The default scalar tag is !!str.
#define YAML_DEFAULT_SEQUENCE_TAG   YAML_SEQ_TAG
 The default sequence tag is !!seq.
#define YAML_DEFAULT_MAPPING_TAG   YAML_MAP_TAG
 The default mapping tag is !!map.

+

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.
typedef struct yaml_node_s yaml_node_t
 The forward definition of a document node structure.
typedef int yaml_node_item_t
 An element of a sequence node.
typedef struct yaml_node_pair_s yaml_node_pair_t
 An element of a mapping node.
typedef struct yaml_document_s yaml_document_t
 The document structure.

+

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 {
+
enum  yaml_node_type_e {
  YAML_NO_NODE, -
+
  YAML_SCALAR_NODE, -
+
  YAML_SEQUENCE_NODE, -
+
  YAML_MAPPING_NODE -
+
}
 Node types. More...

+

 Node types. More...
 
+ - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + +

Functions

int 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.
void yaml_document_delete (yaml_document_t *document)
 Delete a YAML document and all its nodes.
yaml_node_t * yaml_document_get_node (yaml_document_t *document, int index)
 Get a node of a YAML document.
yaml_node_t * yaml_document_get_root_node (yaml_document_t *document)
 Get the root of a YAML document node.
int yaml_document_add_scalar (yaml_document_t *document, yaml_char_t *tag, yaml_char_t *value, int length, yaml_scalar_style_t style)
 Create a SCALAR node and attach it to the document.
int yaml_document_add_sequence (yaml_document_t *document, yaml_char_t *tag, yaml_sequence_style_t style)
 Create a SEQUENCE node and attach it to the document.
int yaml_document_add_mapping (yaml_document_t *document, yaml_char_t *tag, yaml_mapping_style_t style)
 Create a MAPPING node and attach it to the document.
int yaml_document_append_sequence_item (yaml_document_t *document, int sequence, int item)
 Add an item to a SEQUENCE node.
int 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.
int 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...
 
void yaml_document_delete (yaml_document_t *document)
 Delete a YAML document and all its nodes. More...
 
yaml_node_t * yaml_document_get_node (yaml_document_t *document, int index)
 Get a node of a YAML document. More...
 
yaml_node_t * yaml_document_get_root_node (yaml_document_t *document)
 Get the root of a YAML document node. More...
 
int yaml_document_add_scalar (yaml_document_t *document, yaml_char_t *tag, yaml_char_t *value, int length, yaml_scalar_style_t style)
 Create a SCALAR node and attach it to the document. More...
 
int yaml_document_add_sequence (yaml_document_t *document, yaml_char_t *tag, yaml_sequence_style_t style)
 Create a SEQUENCE node and attach it to the document. More...
 
int yaml_document_add_mapping (yaml_document_t *document, yaml_char_t *tag, yaml_mapping_style_t style)
 Create a MAPPING node and attach it to the document. More...
 
int yaml_document_append_sequence_item (yaml_document_t *document, int sequence, int item)
 Add an item to a SEQUENCE node. More...
 
int 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...
 
-

Define Documentation

- +

Detailed Description

+

Macro Definition Documentation

+ +

◆ YAML_NULL_TAG

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

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

- + +

◆ YAML_BOOL_TAG

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

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

+

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

- + +

◆ YAML_STR_TAG

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

The tag !!str for string values.

- + +

◆ YAML_INT_TAG

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

The tag !!int for integer values.

- + +

◆ YAML_FLOAT_TAG

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

The tag !!float for float values.

- + +

◆ YAML_TIMESTAMP_TAG

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

The tag !!timestamp for date and time values.

- + +

◆ YAML_SEQ_TAG

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

The tag !!seq is used to denote sequences.

- + +

◆ YAML_MAP_TAG

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

The tag !!map is used to denote mapping.

- + +

◆ YAML_DEFAULT_SCALAR_TAG

+
- +
#define YAML_DEFAULT_SCALAR_TAG   YAML_STR_TAG#define YAML_DEFAULT_SCALAR_TAG   YAML_STR_TAG
-
-
+

The default scalar tag is !!str.

- + +

◆ YAML_DEFAULT_SEQUENCE_TAG

+
- +
#define YAML_DEFAULT_SEQUENCE_TAG   YAML_SEQ_TAG#define YAML_DEFAULT_SEQUENCE_TAG   YAML_SEQ_TAG
-
-
+

The default sequence tag is !!seq.

- + +

◆ YAML_DEFAULT_MAPPING_TAG

+
- +
#define YAML_DEFAULT_MAPPING_TAG   YAML_MAP_TAG#define YAML_DEFAULT_MAPPING_TAG   YAML_MAP_TAG
-
-
+

The default mapping tag is !!map.

-

Typedef Documentation

- +

Typedef Documentation

+ +

◆ yaml_node_type_t

+
@@ -310,14 +350,15 @@ Functions
typedef enum yaml_node_type_e yaml_node_type_t
-
-
+

Node types.

- + +

◆ yaml_node_t

+
@@ -325,14 +366,15 @@ Functions
typedef struct yaml_node_s yaml_node_t
-
-
+

The forward definition of a document node structure.

- + +

◆ yaml_node_item_t

+
@@ -340,14 +382,15 @@ Functions
typedef int yaml_node_item_t
-
-
+

An element of a sequence node.

- + +

◆ yaml_node_pair_t

+
@@ -355,14 +398,15 @@ Functions
typedef struct yaml_node_pair_s yaml_node_pair_t
-
-
+

An element of a mapping node.

- + +

◆ yaml_document_t

+
@@ -370,15 +414,16 @@ Functions
typedef struct yaml_document_s yaml_document_t
-
-
+

The document structure.

-

Enumeration Type Documentation

- +

Enumeration Type Documentation

+ +

◆ yaml_node_type_e

+
@@ -386,36 +431,31 @@ Functions
enum yaml_node_type_e
-
-
+

Node types.

-
Enumerator:
- - + +

◆ yaml_document_get_node()

+
YAML_NO_NODE  -

An empty node.

+ + - - -
Enumerator
YAML_NO_NODE 

An empty node.

YAML_SCALAR_NODE  -

A scalar node.

+
YAML_SCALAR_NODE 

A scalar node.

YAML_SEQUENCE_NODE  -

A sequence node.

+
YAML_SEQUENCE_NODE 

A sequence node.

YAML_MAPPING_NODE  -

A mapping node.

+
YAML_MAPPING_NODE 

A mapping node.

- - -

Function Documentation

- +

Function Documentation

+ +

◆ yaml_document_initialize()

+
- + @@ -456,11 +496,10 @@ Functions
int yaml_document_initialize int yaml_document_initialize ( yaml_document_t *  document,
-
-
+

Create a YAML document.

-
Parameters:
+
Parameters
@@ -471,27 +510,28 @@ Functions
[out]documentAn empty document object.
[in]version_directiveThe YAML directive value or NULL.
-
Returns:
1 if the function succeeded, 0 on error.
+
Returns
1 if the function succeeded, 0 on error.
- + +

◆ yaml_document_delete()

+
- +
void yaml_document_delete void yaml_document_delete ( yaml_document_t *  document)
-
-
+

Delete a YAML document and all its nodes.

-
Parameters:
+
Parameters
[in,out]documentA document object.
@@ -500,12 +540,14 @@ Functions
- + @@ -522,57 +564,59 @@ Functions
yaml_node_t* yaml_document_get_node yaml_node_t* yaml_document_get_node ( yaml_document_t *  document,
-
-
+

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:
+
Parameters
[in]documentA document object.
[in]indexThe node id.
-
Returns:
the node objct or NULL if node_id is out of range.
+
Returns
the node objct or NULL if node_id is out of range.
- + +

◆ yaml_document_get_root_node()

+
- +
yaml_node_t* yaml_document_get_root_node yaml_node_t* 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:
+
Parameters
[in]documentA document object.
-
Returns:
the node object or NULL if the document is empty.
+
Returns
the node object or NULL if the document is empty.
- + +

◆ yaml_document_add_scalar()

+
- + @@ -607,12 +651,11 @@ Functions
int yaml_document_add_scalar int yaml_document_add_scalar ( yaml_document_t *  document,
-
-
+

Create a SCALAR node and attach it to the document.

The style argument may be ignored by the emitter.

-
Parameters:
+
Parameters
@@ -622,16 +665,18 @@ Functions
[in,out]documentA document object.
[in]tagThe scalar tag.
-
Returns:
the node id or 0 on error.
+
Returns
the node id or 0 on error.
- + +

◆ yaml_document_add_sequence()

+
- + @@ -654,12 +699,11 @@ Functions
int yaml_document_add_sequence int yaml_document_add_sequence ( yaml_document_t *  document,
-
-
+

Create a SEQUENCE node and attach it to the document.

The style argument may be ignored by the emitter.

-
Parameters:
+
Parameters
@@ -667,16 +711,18 @@ Functions
[in,out]documentA document object.
[in]tagThe sequence tag.
-
Returns:
the node id or 0 on error.
+
Returns
the node id or 0 on error.
- + +

◆ yaml_document_add_mapping()

+
- + @@ -699,12 +745,11 @@ Functions
int yaml_document_add_mapping int yaml_document_add_mapping ( yaml_document_t *  document,
-
-
+

Create a MAPPING node and attach it to the document.

The style argument may be ignored by the emitter.

-
Parameters:
+
Parameters
@@ -712,16 +757,18 @@ Functions
[in,out]documentA document object.
[in]tagThe sequence tag.
-
Returns:
the node id or 0 on error.
+
Returns
the node id or 0 on error.
- + +

◆ yaml_document_append_sequence_item()

+
- + @@ -744,11 +791,10 @@ Functions
int yaml_document_append_sequence_item int yaml_document_append_sequence_item ( yaml_document_t *  document,
-
-
+

Add an item to a SEQUENCE node.

-
Parameters:
+
Parameters
@@ -756,16 +802,18 @@ Functions
[in,out]documentA document object.
[in]sequenceThe sequence node id.
-
Returns:
1 if the function succeeded, 0 on error.
+
Returns
1 if the function succeeded, 0 on error.
- + +

◆ yaml_document_append_mapping_pair()

+
- + @@ -794,11 +842,10 @@ Functions
int yaml_document_append_mapping_pair int yaml_document_append_mapping_pair ( yaml_document_t *  document,
-
-
+

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

-
Parameters:
+
Parameters
@@ -807,18 +854,16 @@ Functions
[in,out]documentA document object.
[in]mappingThe mapping node id.
-
Returns:
1 if the function succeeded, 0 on error.
+
Returns
1 if the function succeeded, 0 on error.
- - +
-Generated on Wed Mar 26 2014 13:55:01 for yaml by   +Generated by   doxygen - 1.7.6.1 + 1.8.14
-