X-Git-Url: http://andersk.mit.edu/gitweb/libyaml.git/blobdiff_plain/a6e1047a1a721331032e81dcb3597f2217f32e6a..0f400264da7f8230f00688a666132c861939906e:/doc/html/group__nodes.html diff --git a/doc/html/group__nodes.html b/doc/html/group__nodes.html index 41a47eb..dfae245 100644 --- a/doc/html/group__nodes.html +++ b/doc/html/group__nodes.html @@ -3,7 +3,8 @@ - + + yaml: Nodes @@ -16,9 +17,9 @@ - @@ -26,15 +27,16 @@
+
yaml -  0.1.7 +  0.2.1
- - + + + + +
@@ -51,117 +53,119 @@

Data Structures

struct  yaml_node_pair_s - An element of a mapping node. More...
+ An element of a mapping node. More...
  struct  yaml_node_s - The node structure. More...
+ The node structure. More...
  struct  yaml_document_s - The document structure. More...
+ The document structure. More...
  - + - + - + - + - + - + - + - + - + - + - +

Macros

#define YAML_NULL_TAG   "tag:yaml.org,2002:null"
 The tag !!null with the only possible value: null. More...
 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 falce. More...
 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...
 The tag !!str for string values. More...
 
#define YAML_INT_TAG   "tag:yaml.org,2002:int"
 The tag !!int for integer values. More...
 The tag !!int for integer values. More...
 
#define YAML_FLOAT_TAG   "tag:yaml.org,2002:float"
 The tag !!float for float values. More...
 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...
 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...
 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...
 The tag !!map is used to denote mapping. More...
 
#define YAML_DEFAULT_SCALAR_TAG   YAML_STR_TAG
 The default scalar tag is !!str. More...
 The default scalar tag is !!str. More...
 
#define YAML_DEFAULT_SEQUENCE_TAG   YAML_SEQ_TAG
 The default sequence tag is !!seq. More...
 The default sequence tag is !!seq. More...
 
#define YAML_DEFAULT_MAPPING_TAG   YAML_MAP_TAG
 The default mapping tag is !!map. More...
 The default mapping tag is !!map. More...
 
- + - + - + - + - +

Typedefs

typedef enum yaml_node_type_e yaml_node_type_t
 Node types. More...
 Node types. More...
 
typedef struct yaml_node_s yaml_node_t
 The forward definition of a document node structure. More...
 The forward definition of a document node structure. More...
 
typedef int yaml_node_item_t
 An element of a sequence node. More...
 An element of a sequence node. More...
 
typedef struct yaml_node_pair_s yaml_node_pair_t
 An element of a mapping node. More...
 An element of a mapping node. More...
 
typedef struct yaml_document_s yaml_document_t
 The document structure. More...
 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. More...
 Create a YAML document. More...
 
void yaml_document_delete (yaml_document_t *document)
 Delete a YAML document and all its nodes. More...
 Delete a YAML document and all its nodes. More...
 
yaml_node_tyaml_document_get_node (yaml_document_t *document, int index)
 Get a node of a YAML document. More...
 Get a node of a YAML document. More...
 
yaml_node_tyaml_document_get_root_node (yaml_document_t *document)
 Get the root of a YAML document node. More...
 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...
 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...
 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...
 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...
 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...
 Add a pair of a key and a value to a MAPPING node. More...
 

Detailed Description

Macro Definition Documentation

- + +

◆ YAML_NULL_TAG

+
@@ -175,7 +179,9 @@ Functions - + +

◆ YAML_BOOL_TAG

+
@@ -185,11 +191,13 @@ Functions
-

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

+

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

- + +

◆ YAML_STR_TAG

+
@@ -203,7 +211,9 @@ Functions - + +

◆ YAML_INT_TAG

+
@@ -217,7 +227,9 @@ Functions - + +

◆ YAML_FLOAT_TAG

+
@@ -231,7 +243,9 @@ Functions - + +

◆ YAML_TIMESTAMP_TAG

+
@@ -245,7 +259,9 @@ Functions - + +

◆ YAML_SEQ_TAG

+
@@ -259,7 +275,9 @@ Functions - + +

◆ YAML_MAP_TAG

+
@@ -273,7 +291,9 @@ Functions - + +

◆ YAML_DEFAULT_SCALAR_TAG

+
@@ -287,7 +307,9 @@ Functions - + +

◆ YAML_DEFAULT_SEQUENCE_TAG

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

◆ YAML_DEFAULT_MAPPING_TAG

+
@@ -316,7 +340,9 @@ Functions

Typedef Documentation

- + +

◆ yaml_node_type_t

+
@@ -330,7 +356,9 @@ Functions - + +

◆ yaml_node_t

+
@@ -344,7 +372,9 @@ Functions - + +

◆ yaml_node_item_t

+
@@ -358,7 +388,9 @@ Functions - + +

◆ yaml_node_pair_t

+
@@ -372,7 +404,9 @@ Functions - + +

◆ yaml_document_t

+
@@ -387,7 +421,9 @@ Functions

Enumeration Type Documentation

- + +

◆ yaml_node_type_e

+
@@ -399,24 +435,22 @@ Functions

Node types.

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

- + +

◆ yaml_document_initialize()

+
@@ -480,7 +514,9 @@ Functions - + +

◆ yaml_document_delete()

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

◆ yaml_document_get_node()

+
@@ -541,7 +579,9 @@ Functions - + +

◆ yaml_document_get_root_node()

+
@@ -569,7 +609,9 @@ Functions - + +

◆ yaml_document_add_scalar()

+
@@ -627,7 +669,9 @@ Functions - + +

◆ yaml_document_add_sequence()

+
@@ -671,7 +715,9 @@ Functions - + +

◆ yaml_document_add_mapping()

+
@@ -715,7 +761,9 @@ Functions - + +

◆ yaml_document_append_sequence_item()

+
@@ -758,7 +806,9 @@ Functions - + +

◆ yaml_document_append_mapping_pair()

+
@@ -811,9 +861,9 @@ Functions