From 58daab21cd043e1dc37024a7f99b396788372918 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sat, 9 Mar 2024 14:19:48 +0100 Subject: Merging upstream version 1.44.3. Signed-off-by: Daniel Baumann --- .../libh2o/deps/yaml/doc/html/group__nodes.html | 824 +++++++++++++++++++++ 1 file changed, 824 insertions(+) create mode 100644 web/server/h2o/libh2o/deps/yaml/doc/html/group__nodes.html (limited to 'web/server/h2o/libh2o/deps/yaml/doc/html/group__nodes.html') diff --git a/web/server/h2o/libh2o/deps/yaml/doc/html/group__nodes.html b/web/server/h2o/libh2o/deps/yaml/doc/html/group__nodes.html new file mode 100644 index 000000000..092ab87c2 --- /dev/null +++ b/web/server/h2o/libh2o/deps/yaml/doc/html/group__nodes.html @@ -0,0 +1,824 @@ + + + + + +yaml: Nodes + + + + + + + + +
+ + +
+ + + + + + + + + + + +
+
yaml +  0.1.6 +
+ +
+
+ + + +
+
+
+Data Structures | +Defines | +Typedefs | +Enumerations | +Functions
+
+
Nodes
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

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

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

+Enumerations

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

Define Documentation

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

+ +
+
+

Typedef Documentation

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

+ +
+
+

Enumeration Type Documentation

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

+
+
+
+ +
+
+

Function Documentation

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

+
Parameters:
+ + + + + + + +
[out]documentAn empty document object.
[in]version_directiveThe YAML directive value or NULL.
[in]tag_directives_startThe beginning of the TAG directives list.
[in]tag_directives_endThe end of the TAG directives list.
[in]start_implicitIf the document start indicator is implicit.
[in]end_implicitIf the document end indicator is implicit.
+
+
+
Returns:
1 if the function succeeded, 0 on error.
+ +
+
+ +
+
+ + + + + + + + +
void yaml_document_delete (yaml_document_t * document)
+
+
+ +

Delete a YAML document and all its nodes.

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

+

The style argument may be ignored by the emitter.

+
Parameters:
+ + + + + + +
[in,out]documentA document object.
[in]tagThe scalar tag.
[in]valueThe scalar value.
[in]lengthThe length of the scalar value.
[in]styleThe scalar style.
+
+
+
Returns:
the node id or 0 on error.
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
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.

+

The style argument may be ignored by the emitter.

+
Parameters:
+ + + + +
[in,out]documentA document object.
[in]tagThe sequence tag.
[in]styleThe sequence style.
+
+
+
Returns:
the node id or 0 on error.
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
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.

+

The style argument may be ignored by the emitter.

+
Parameters:
+ + + + +
[in,out]documentA document object.
[in]tagThe sequence tag.
[in]styleThe sequence style.
+
+
+
Returns:
the node id or 0 on error.
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
int yaml_document_append_sequence_item (yaml_document_t * document,
int sequence,
int item 
)
+
+
+ +

Add an item to a SEQUENCE node.

+
Parameters:
+ + + + +
[in,out]documentA document object.
[in]sequenceThe sequence node id.
[in]itemThe item node id.
+
+
+
Returns:
1 if the function succeeded, 0 on error.
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
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.

+
Parameters:
+ + + + + +
[in,out]documentA document object.
[in]mappingThe mapping node id.
[in]keyThe key node id.
[in]valueThe value node id.
+
+
+
Returns:
1 if the function succeeded, 0 on error.
+ +
+
+
+ + +
+Generated on Wed Mar 26 2014 13:55:01 for yaml by   +doxygen + 1.7.6.1 +
+ + + -- cgit v1.2.3