X-Git-Url: http://andersk.mit.edu/gitweb/libyaml.git/blobdiff_plain/0044e680dc24577d2b91cbbf287a2183461e9b80..c45550e5cf265bf6877cad127faa9854851e291e:/doc/html/yaml_8h.html diff --git a/doc/html/yaml_8h.html b/doc/html/yaml_8h.html index 95276c3..540473f 100644 --- a/doc/html/yaml_8h.html +++ b/doc/html/yaml_8h.html @@ -3,7 +3,8 @@
- + ++ |
yaml
- 0.1.7
+ 0.2.1
|
Public interface for libyaml. More...
-#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
Data Structures | |
struct | yaml_version_directive_s |
The version directive data. More... | |
The version directive data. More... | |
struct | yaml_tag_directive_s |
The tag directive data. More... | |
The tag directive data. More... | |
struct | yaml_mark_s |
The pointer position. More... | |
The pointer position. More... | |
struct | yaml_token_s |
The token structure. More... | |
The token structure. More... | |
struct | yaml_event_s |
The event structure. More... | |
The event structure. More... | |
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... | |
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... | |
struct | yaml_emitter_s |
The emitter structure. More... | |
The emitter structure. More... | |
Macros | |
#define | YAML_DECLARE(type) type |
The public API declaration. More... | |
The public API declaration. More... | |
#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 unsigned char | yaml_char_t |
The character type (UTF-8 octet). More... | |
The character type (UTF-8 octet). More... | |
typedef struct -yaml_version_directive_s | yaml_version_directive_t |
The version directive data. More... | |
typedef struct yaml_version_directive_s | yaml_version_directive_t |
The version directive data. More... | |
typedef struct yaml_tag_directive_s | yaml_tag_directive_t |
The tag directive data. More... | |
The tag directive data. More... | |
typedef enum yaml_encoding_e | yaml_encoding_t |
The stream encoding. More... | |
The stream encoding. More... | |
typedef enum yaml_break_e | yaml_break_t |
Line break types. More... | |
Line break types. More... | |
typedef enum yaml_error_type_e | yaml_error_type_t |
Many bad things could happen with the parser and emitter. More... | |
Many bad things could happen with the parser and emitter. More... | |
typedef struct yaml_mark_s | yaml_mark_t |
The pointer position. More... | |
The pointer position. More... | |
typedef enum yaml_scalar_style_e | yaml_scalar_style_t |
Scalar styles. More... | |
Scalar styles. More... | |
typedef enum yaml_sequence_style_e | yaml_sequence_style_t |
Sequence styles. More... | |
Sequence styles. More... | |
typedef enum yaml_mapping_style_e | yaml_mapping_style_t |
Mapping styles. More... | |
Mapping styles. More... | |
typedef enum yaml_token_type_e | yaml_token_type_t |
Token types. More... | |
Token types. More... | |
typedef struct yaml_token_s | yaml_token_t |
The token structure. More... | |
The token structure. More... | |
typedef enum yaml_event_type_e | yaml_event_type_t |
Event types. More... | |
Event types. More... | |
typedef struct yaml_event_s | yaml_event_t |
The event structure. More... | |
The event structure. More... | |
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... | |
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... | |
typedef int | yaml_write_handler_t (void *data, unsigned char *buffer, size_t size) |
The prototype of a write handler. More... | |
typedef int | yaml_write_handler_t(void *data, unsigned char *buffer, size_t size) |
The prototype of a write handler. More... | |
typedef enum yaml_emitter_state_e | yaml_emitter_state_t |
The emitter states. More... | |
The emitter states. More... | |
typedef struct yaml_emitter_s | yaml_emitter_t |
The emitter structure. More... | |
The emitter structure. More... | |
Functions | |
const char * | yaml_get_version_string (void) |
Get the library version as a string. More... | |
Get the library version as a string. More... | |
void | yaml_get_version (int *major, int *minor, int *patch) |
Get the library version numbers. More... | |
Get the library version numbers. More... | |
void | yaml_token_delete (yaml_token_t *token) |
Free any memory allocated for a token object. More... | |
Free any memory allocated for a token object. More... | |
int | yaml_stream_start_event_initialize (yaml_event_t *event, yaml_encoding_t encoding) |
Create the STREAM-START event. More... | |
Create the STREAM-START event. More... | |
int | yaml_stream_end_event_initialize (yaml_event_t *event) |
Create the STREAM-END event. More... | |
Create the STREAM-END event. More... | |
int | yaml_document_start_event_initialize (yaml_event_t *event, yaml_version_directive_t *version_directive, yaml_tag_directive_t *tag_directives_start, yaml_tag_directive_t *tag_directives_end, int implicit) |
Create the DOCUMENT-START event. More... | |
Create the DOCUMENT-START event. More... | |
int | yaml_document_end_event_initialize (yaml_event_t *event, int implicit) |
Create the DOCUMENT-END event. More... | |
Create the DOCUMENT-END event. More... | |
int | yaml_alias_event_initialize (yaml_event_t *event, yaml_char_t *anchor) |
Create an ALIAS event. More... | |
Create an ALIAS event. More... | |
int | yaml_scalar_event_initialize (yaml_event_t *event, yaml_char_t *anchor, yaml_char_t *tag, yaml_char_t *value, int length, int plain_implicit, int quoted_implicit, yaml_scalar_style_t style) |
Create a SCALAR event. More... | |
Create a SCALAR event. More... | |
int | yaml_sequence_start_event_initialize (yaml_event_t *event, yaml_char_t *anchor, yaml_char_t *tag, int implicit, yaml_sequence_style_t style) |
Create a SEQUENCE-START event. More... | |
Create a SEQUENCE-START event. More... | |
int | yaml_sequence_end_event_initialize (yaml_event_t *event) |
Create a SEQUENCE-END event. More... | |
Create a SEQUENCE-END event. More... | |
int | yaml_mapping_start_event_initialize (yaml_event_t *event, yaml_char_t *anchor, yaml_char_t *tag, int implicit, yaml_mapping_style_t style) |
Create a MAPPING-START event. More... | |
Create a MAPPING-START event. More... | |
int | yaml_mapping_end_event_initialize (yaml_event_t *event) |
Create a MAPPING-END event. More... | |
Create a MAPPING-END event. More... | |
void | yaml_event_delete (yaml_event_t *event) |
Free any memory allocated for an event object. More... | |
Free any memory allocated for an event object. More... | |
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_t * | yaml_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_t * | yaml_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... | |
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... | |
int | yaml_emitter_initialize (yaml_emitter_t *emitter) |
Initialize an emitter. More... | |
Initialize an emitter. More... | |
void | yaml_emitter_delete (yaml_emitter_t *emitter) |
Destroy an emitter. More... | |
Destroy an emitter. More... | |
void | yaml_emitter_set_output_string (yaml_emitter_t *emitter, unsigned char *output, size_t size, size_t *size_written) |
Set a string output. More... | |
Set a string output. More... | |
void | yaml_emitter_set_output_file (yaml_emitter_t *emitter, FILE *file) |
Set a file output. More... | |
Set a file output. More... | |
void | yaml_emitter_set_output (yaml_emitter_t *emitter, yaml_write_handler_t *handler, void *data) |
Set a generic output handler. More... | |
Set a generic output handler. More... | |
void | yaml_emitter_set_encoding (yaml_emitter_t *emitter, yaml_encoding_t encoding) |
Set the output encoding. More... | |
Set the output encoding. More... | |
void | yaml_emitter_set_canonical (yaml_emitter_t *emitter, int canonical) |
Set if the output should be in the "canonical" format as in the YAML specification. More... | |
Set if the output should be in the "canonical" format as in the YAML specification. More... | |
void | yaml_emitter_set_indent (yaml_emitter_t *emitter, int indent) |
Set the intendation increment. More... | |
Set the intendation increment. More... | |
void | yaml_emitter_set_width (yaml_emitter_t *emitter, int width) |
Set the preferred line width. More... | |
Set the preferred line width. More... | |
void | yaml_emitter_set_unicode (yaml_emitter_t *emitter, int unicode) |
Set if unescaped non-ASCII characters are allowed. More... | |
Set if unescaped non-ASCII characters are allowed. More... | |
void | yaml_emitter_set_break (yaml_emitter_t *emitter, yaml_break_t line_break) |
Set the preferred line break. More... | |
Set the preferred line break. More... | |
int | yaml_emitter_emit (yaml_emitter_t *emitter, yaml_event_t *event) |
Emit an event. More... | |
Emit an event. More... | |
int | yaml_emitter_open (yaml_emitter_t *emitter) |
Start a YAML stream. More... | |
Start a YAML stream. More... | |
int | yaml_emitter_close (yaml_emitter_t *emitter) |
Finish a YAML stream. More... | |
Finish a YAML stream. More... | |
int | yaml_emitter_dump (yaml_emitter_t *emitter, yaml_document_t *document) |
Emit a YAML document. More... | |
Emit a YAML document. More... | |
int | yaml_emitter_flush (yaml_emitter_t *emitter) |
Flush the accumulated characters to the output. More... | |
Flush the accumulated characters to the output. More... | |
Include the header file with the code: