X-Git-Url: http://andersk.mit.edu/gitweb/libyaml.git/blobdiff_plain/9886d41b959a87c1564cd269a30c17e2444a305c..aa6f0e8a0a8257181e428c8af720d98e964f69d9:/doc/html/structyaml__emitter__s.html diff --git a/doc/html/structyaml__emitter__s.html b/doc/html/structyaml__emitter__s.html index 54f03bb..50e36ee 100644 --- a/doc/html/structyaml__emitter__s.html +++ b/doc/html/structyaml__emitter__s.html @@ -1,1551 +1,1451 @@ - -
+ + + + + + +
+ yaml
+ 0.2.2
+
+ |
+
-#include <yaml.h>
-
-
Data Fields | |
unsigned char * | buffer |
The buffer pointer. | |
size_t | size |
The buffer size. | |
size_t * | size_written |
The number of written bytes. | |
struct { | |
unsigned char * buffer | |
The buffer pointer. | |
size_t size | |
The buffer size. | |
size_t * size_written | |
The number of written bytes. | |
} | string |
String output data. | |
FILE * | file |
File output data. | |
yaml_char_t * | start |
The beginning of the buffer. | |
yaml_char_t * | end |
The end of the buffer. | |
yaml_char_t * | pointer |
The current position of the buffer. | |
yaml_char_t * | last |
The last filled position of the buffer. | |
unsigned char * | start |
The beginning of the buffer. | |
unsigned char * | end |
The end of the buffer. | |
unsigned char * | pointer |
The current position of the buffer. | |
unsigned char * | last |
The last filled position of the buffer. | |
yaml_emitter_state_t * | start |
The beginning of the stack. | |
yaml_emitter_state_t * | end |
The end of the stack. | |
yaml_emitter_state_t * | top |
The top of the stack. | |
yaml_event_t * | start |
The beginning of the event queue. | |
yaml_event_t * | end |
The end of the event queue. | |
yaml_event_t * | head |
The head of the event queue. | |
yaml_event_t * | tail |
The tail of the event queue. | |
int * | start |
The beginning of the stack. | |
int * | end |
The end of the stack. | |
int * | top |
The top of the stack. | |
yaml_tag_directive_t * | start |
The beginning of the list. | |
yaml_tag_directive_t * | end |
The end of the list. | |
yaml_tag_directive_t * | top |
The top of the list. | |
yaml_char_t * | anchor |
The anchor value. | |
size_t | anchor_length |
The anchor length. | |
-int | alias |
Is it an alias? | |
yaml_char_t * | handle |
The tag handle. | |
size_t | handle_length |
The tag handle length. | |
yaml_char_t * | suffix |
The tag suffix. | |
size_t | suffix_length |
The tag suffix length. | |
yaml_char_t * | value |
The scalar value. | |
size_t | length |
The scalar length. | |
-int | multiline |
Does the scalar contain line breaks? | |
-int | flow_plain_allowed |
Can the scalar be expessed in the flow plain style? | |
-int | block_plain_allowed |
Can the scalar be expressed in the block plain style? | |
-int | single_quoted_allowed |
Can the scalar be expressed in the single quoted style? | |
-int | block_allowed |
Can the scalar be expressed in the literal or folded styles? | |
yaml_scalar_style_t | style |
The output style. | |
int | references |
The number of references. | |
int | anchor |
The anchor id. | |
-int | serialized |
If the node has been emitted? |
+Data Fields | |
unsigned char * | buffer |
The buffer pointer. More... | |
size_t | size |
The buffer size. More... | |
size_t * | size_written |
The number of written bytes. More... | |
struct { | |
unsigned char * buffer | |
The buffer pointer. More... | |
size_t size | |
The buffer size. More... | |
size_t * size_written | |
The number of written bytes. More... | |
} | string |
String output data. More... | |
FILE * | file |
File output data. More... | |
yaml_char_t * | start |
The beginning of the buffer. More... | |
yaml_char_t * | end |
The end of the buffer. More... | |
yaml_char_t * | pointer |
The current position of the buffer. More... | |
yaml_char_t * | last |
The last filled position of the buffer. More... | |
unsigned char * | start |
The beginning of the buffer. More... | |
unsigned char * | end |
The end of the buffer. More... | |
unsigned char * | pointer |
The current position of the buffer. More... | |
unsigned char * | last |
The last filled position of the buffer. More... | |
yaml_emitter_state_t * | start |
The beginning of the stack. More... | |
yaml_emitter_state_t * | end |
The end of the stack. More... | |
yaml_emitter_state_t * | top |
The top of the stack. More... | |
yaml_event_t * | start |
The beginning of the event queue. More... | |
yaml_event_t * | end |
The end of the event queue. More... | |
yaml_event_t * | head |
The head of the event queue. More... | |
yaml_event_t * | tail |
The tail of the event queue. More... | |
int * | start |
The beginning of the stack. More... | |
int * | end |
The end of the stack. More... | |
int * | top |
The top of the stack. More... | |
yaml_tag_directive_t * | start |
The beginning of the list. More... | |
yaml_tag_directive_t * | end |
The end of the list. More... | |
yaml_tag_directive_t * | top |
The top of the list. More... | |
yaml_char_t * | anchor |
The anchor value. More... | |
size_t | anchor_length |
The anchor length. More... | |
+int | alias |
Is it an alias? | |
yaml_char_t * | handle |
The tag handle. More... | |
size_t | handle_length |
The tag handle length. More... | |
yaml_char_t * | suffix |
The tag suffix. More... | |
size_t | suffix_length |
The tag suffix length. More... | |
yaml_char_t * | value |
The scalar value. More... | |
size_t | length |
The scalar length. More... | |
+int | multiline |
Does the scalar contain line breaks? | |
+int | flow_plain_allowed |
Can the scalar be expessed in the flow plain style? | |
+int | block_plain_allowed |
Can the scalar be expressed in the block plain style? | |
+int | single_quoted_allowed |
Can the scalar be expressed in the single quoted style? | |
+int | block_allowed |
Can the scalar be expressed in the literal or folded styles? | |
yaml_scalar_style_t | style |
The output style. More... | |
Error handling | |
yaml_error_type_t | error |
Error type. | |
const char * | problem |
Error description. | |
yaml_error_type_t | error |
Error type. More... | |
const char * | problem |
Error description. More... | |
Writer stuff | |
yaml_write_handler_t * | write_handler |
Write handler. | |
void * | write_handler_data |
A pointer for passing to the white handler. | |
union { | |
struct { | |
unsigned char * buffer | |
The buffer pointer. | |
size_t size | |
The buffer size. | |
size_t * size_written | |
The number of written bytes. | |
} string | |
String output data. | |
FILE * file | |
File output data. | |
} | output |
Standard (string or file) output data. | |
struct { | |
yaml_char_t * start | |
The beginning of the buffer. | |
yaml_char_t * end | |
The end of the buffer. | |
yaml_char_t * pointer | |
The current position of the buffer. | |
yaml_char_t * last | |
The last filled position of the buffer. | |
} | buffer |
The working buffer. | |
struct { | |
unsigned char * start | |
The beginning of the buffer. | |
unsigned char * end | |
The end of the buffer. | |
unsigned char * pointer | |
The current position of the buffer. | |
unsigned char * last | |
The last filled position of the buffer. | |
} | raw_buffer |
The raw buffer. | |
yaml_encoding_t | encoding |
The stream encoding. | |
yaml_write_handler_t * | write_handler |
Write handler. More... | |
void * | write_handler_data |
A pointer for passing to the white handler. More... | |
union { | |
struct { | |
unsigned char * buffer | |
The buffer pointer. More... | |
size_t size | |
The buffer size. More... | |
size_t * size_written | |
The number of written bytes. More... | |
} string | |
String output data. More... | |
FILE * file | |
File output data. More... | |
} | output |
Standard (string or file) output data. More... | |
struct { | |
yaml_char_t * start | |
The beginning of the buffer. More... | |
yaml_char_t * end | |
The end of the buffer. More... | |
yaml_char_t * pointer | |
The current position of the buffer. More... | |
yaml_char_t * last | |
The last filled position of the buffer. More... | |
} | buffer |
The working buffer. More... | |
struct { | |
unsigned char * start | |
The beginning of the buffer. More... | |
unsigned char * end | |
The end of the buffer. More... | |
unsigned char * pointer | |
The current position of the buffer. More... | |
unsigned char * last | |
The last filled position of the buffer. More... | |
} | raw_buffer |
The raw buffer. More... | |
yaml_encoding_t | encoding |
The stream encoding. More... | |
Emitter stuff | |
-int | canonical |
If the output is in the canonical style? | |
int | best_indent |
The number of indentation spaces. | |
int | best_width |
The preferred width of the output lines. | |
-int | unicode |
Allow unescaped non-ASCII characters? | |
yaml_break_t | line_break |
The preferred line break. | |
struct { | |
yaml_emitter_state_t * start | |
The beginning of the stack. | |
yaml_emitter_state_t * end | |
The end of the stack. | |
yaml_emitter_state_t * top | |
The top of the stack. | |
} | states |
The stack of states. | |
yaml_emitter_state_t | state |
The current emitter state. | |
struct { | |
yaml_event_t * start | |
The beginning of the event queue. | |
yaml_event_t * end | |
The end of the event queue. | |
yaml_event_t * head | |
The head of the event queue. | |
yaml_event_t * tail | |
The tail of the event queue. | |
} | events |
The event queue. | |
struct { | |
int * start | |
The beginning of the stack. | |
int * end | |
The end of the stack. | |
int * top | |
The top of the stack. | |
} | indents |
The stack of indentation levels. | |
struct { | |
yaml_tag_directive_t * start | |
The beginning of the list. | |
yaml_tag_directive_t * end | |
The end of the list. | |
yaml_tag_directive_t * top | |
The top of the list. | |
} | tag_directives |
The list of tag directives. | |
int | indent |
The current indentation level. | |
int | flow_level |
The current flow level. | |
-int | root_context |
Is it the document root context? | |
-int | sequence_context |
Is it a sequence context? | |
-int | mapping_context |
Is it a mapping context? | |
-int | simple_key_context |
Is it a simple mapping key context? | |
int | line |
The current line. | |
int | column |
The current column. | |
-int | whitespace |
If the last character was a whitespace? | |
-int | indention |
If the last character was an indentation character (' ', '-', '?', ':')? | |
-int | open_ended |
If an explicit document end is required? | |
struct { | |
yaml_char_t * anchor | |
The anchor value. | |
size_t anchor_length | |
The anchor length. | |
int alias | |
Is it an alias? | |
} | anchor_data |
Anchor analysis. | |
struct { | |
yaml_char_t * handle | |
The tag handle. | |
size_t handle_length | |
The tag handle length. | |
yaml_char_t * suffix | |
The tag suffix. | |
size_t suffix_length | |
The tag suffix length. | |
} | tag_data |
Tag analysis. | |
struct { | |
yaml_char_t * value | |
The scalar value. | |
size_t length | |
The scalar length. | |
int multiline | |
Does the scalar contain line breaks? | |
int flow_plain_allowed | |
Can the scalar be expessed in the flow plain style? | |
int block_plain_allowed | |
Can the scalar be expressed in the block plain style? | |
int single_quoted_allowed | |
Can the scalar be expressed in the single quoted style? | |
int block_allowed | |
Can the scalar be expressed in the literal or folded styles? | |
yaml_scalar_style_t style | |
The output style. | |
} | scalar_data |
Scalar analysis. | |
+int | canonical |
If the output is in the canonical style? | |
int | best_indent |
The number of indentation spaces. More... | |
int | best_width |
The preferred width of the output lines. More... | |
+int | unicode |
Allow unescaped non-ASCII characters? | |
yaml_break_t | line_break |
The preferred line break. More... | |
struct { | |
yaml_emitter_state_t * start | |
The beginning of the stack. More... | |
yaml_emitter_state_t * end | |
The end of the stack. More... | |
yaml_emitter_state_t * top | |
The top of the stack. More... | |
} | states |
The stack of states. More... | |
yaml_emitter_state_t | state |
The current emitter state. More... | |
struct { | |
yaml_event_t * start | |
The beginning of the event queue. More... | |
yaml_event_t * end | |
The end of the event queue. More... | |
yaml_event_t * head | |
The head of the event queue. More... | |
yaml_event_t * tail | |
The tail of the event queue. More... | |
} | events |
The event queue. More... | |
struct { | |
int * start | |
The beginning of the stack. More... | |
int * end | |
The end of the stack. More... | |
int * top | |
The top of the stack. More... | |
} | indents |
The stack of indentation levels. More... | |
struct { | |
yaml_tag_directive_t * start | |
The beginning of the list. More... | |
yaml_tag_directive_t * end | |
The end of the list. More... | |
yaml_tag_directive_t * top | |
The top of the list. More... | |
} | tag_directives |
The list of tag directives. More... | |
int | indent |
The current indentation level. More... | |
int | flow_level |
The current flow level. More... | |
+int | root_context |
Is it the document root context? | |
+int | sequence_context |
Is it a sequence context? | |
+int | mapping_context |
Is it a mapping context? | |
+int | simple_key_context |
Is it a simple mapping key context? | |
int | line |
The current line. More... | |
int | column |
The current column. More... | |
+int | whitespace |
If the last character was a whitespace? | |
+int | indention |
If the last character was an indentation character (' ', '-', '?', ':')? | |
+int | open_ended |
If an explicit document end is required? | |
struct { | |
yaml_char_t * anchor | |
The anchor value. More... | |
size_t anchor_length | |
The anchor length. More... | |
+ int alias | |
Is it an alias? | |
} | anchor_data |
Anchor analysis. More... | |
struct { | |
yaml_char_t * handle | |
The tag handle. More... | |
size_t handle_length | |
The tag handle length. More... | |
yaml_char_t * suffix | |
The tag suffix. More... | |
size_t suffix_length | |
The tag suffix length. More... | |
} | tag_data |
Tag analysis. More... | |
struct { | |
yaml_char_t * value | |
The scalar value. More... | |
size_t length | |
The scalar length. More... | |
+ int multiline | |
Does the scalar contain line breaks? | |
+ int flow_plain_allowed | |
Can the scalar be expessed in the flow plain style? | |
+ int block_plain_allowed | |
Can the scalar be expressed in the block plain style? | |
+ int single_quoted_allowed | |
Can the scalar be expressed in the single quoted style? | |
+ int block_allowed | |
Can the scalar be expressed in the literal or folded styles? | |
yaml_scalar_style_t style | |
The output style. More... | |
} | scalar_data |
Scalar analysis. More... | |
Dumper stuff | |
-int | opened |
If the stream was already opened? | |
-int | closed |
If the stream was already closed? | |
struct { | |
int references | |
The number of references. | |
int anchor | |
The anchor id. | |
int serialized | |
If the node has been emitted? | |
} | anchors |
The information associated with the document nodes. | |
int | last_anchor_id |
The last assigned anchor id. | |
yaml_document_t * | document |
The currently emitted document. | |
+int | opened |
If the stream was already opened? | |
+int | closed |
If the stream was already closed? | |
yaml_anchors_t * | anchors |
The information associated with the document nodes. More... | |
int | last_anchor_id |
The last assigned anchor id. More... | |
yaml_document_t * | document |
The currently emitted document. More... | |
-All members are internal. Manage the structure using the yaml_emitter_
family of functions.
The emitter structure.
+All members are internal. Manage the structure using the yaml_emitter_
family of functions.
yaml_error_type_t yaml_emitter_s::error | +yaml_error_type_t yaml_emitter_s::error |
-Error type. -
+
Error type.
const char* yaml_emitter_s::problem | -
yaml_write_handler_t* yaml_emitter_s::write_handler | +const char* yaml_emitter_s::problem |
-Write handler. -
+
Error description.
void* yaml_emitter_s::write_handler_data | -
unsigned char* yaml_emitter_s::buffer | +yaml_write_handler_t* yaml_emitter_s::write_handler |
-The buffer pointer. -
+
Write handler.
size_t yaml_emitter_s::size | +void* yaml_emitter_s::write_handler_data |
-The buffer size. -
+
A pointer for passing to the white handler.
size_t* yaml_emitter_s::size_written | +unsigned char* yaml_emitter_s::buffer |
-The number of written bytes. -
+
The buffer pointer.
struct { ... } yaml_emitter_s::string | +size_t yaml_emitter_s::size |
-String output data. -
+
The buffer size.
FILE* yaml_emitter_s::file | +size_t* yaml_emitter_s::size_written |
-File output data. -
+
The number of written bytes.
union { ... } yaml_emitter_s::output | +struct { ... } yaml_emitter_s::string |
-Standard (string or file) output data. -
+
String output data.
yaml_char_t* yaml_emitter_s::start | +FILE* yaml_emitter_s::file |
-The beginning of the buffer. -
+
File output data.
yaml_char_t* yaml_emitter_s::end | +union { ... } yaml_emitter_s::output |
-The end of the buffer. -
+
Standard (string or file) output data.
yaml_char_t* yaml_emitter_s::pointer | +yaml_char_t* yaml_emitter_s::start |
-The current position of the buffer. -
+
The beginning of the buffer.
yaml_char_t* yaml_emitter_s::last | +yaml_char_t* yaml_emitter_s::end |
-The last filled position of the buffer. -
+
The end of the buffer.
struct { ... } yaml_emitter_s::buffer | +yaml_char_t* yaml_emitter_s::pointer |
-The working buffer. -
+
The current position of the buffer.
unsigned char* yaml_emitter_s::start | +yaml_char_t* yaml_emitter_s::last |
-The beginning of the buffer. -
+
The last filled position of the buffer.
unsigned char* yaml_emitter_s::end | +struct { ... } yaml_emitter_s::buffer |
-The end of the buffer. -
+
The working buffer.
unsigned char* yaml_emitter_s::pointer | +unsigned char* yaml_emitter_s::start |
-The current position of the buffer. -
+
The beginning of the buffer.
unsigned char* yaml_emitter_s::last | +unsigned char* yaml_emitter_s::end |
-The last filled position of the buffer. -
+
The end of the buffer.
struct { ... } yaml_emitter_s::raw_buffer | +unsigned char* yaml_emitter_s::pointer |
-The raw buffer. -
+
The current position of the buffer.
yaml_encoding_t yaml_emitter_s::encoding | +unsigned char* yaml_emitter_s::last |
-The stream encoding. -
+
The last filled position of the buffer.
int yaml_emitter_s::best_indent | +struct { ... } yaml_emitter_s::raw_buffer |
-The number of indentation spaces. -
+
The raw buffer.
int yaml_emitter_s::best_width | +yaml_encoding_t yaml_emitter_s::encoding |
-The preferred width of the output lines. -
+
The stream encoding.
yaml_break_t yaml_emitter_s::line_break | +int yaml_emitter_s::best_indent |
-The preferred line break. -
+
The number of indentation spaces.
yaml_emitter_state_t* yaml_emitter_s::start | +int yaml_emitter_s::best_width |
-The beginning of the stack. -
+
The preferred width of the output lines.
yaml_emitter_state_t* yaml_emitter_s::end | +yaml_break_t yaml_emitter_s::line_break |
-The end of the stack. -
+
The preferred line break.
yaml_emitter_state_t* yaml_emitter_s::top | +yaml_emitter_state_t* yaml_emitter_s::start |
-The top of the stack. -
+
The beginning of the stack.
struct { ... } yaml_emitter_s::states | +yaml_emitter_state_t* yaml_emitter_s::end |
-The stack of states. -
+
The end of the stack.
yaml_emitter_state_t yaml_emitter_s::state | +yaml_emitter_state_t* yaml_emitter_s::top |
-The current emitter state. -
+
The top of the stack.
yaml_event_t* yaml_emitter_s::start | +struct { ... } yaml_emitter_s::states |
-The beginning of the event queue. -
+
The stack of states.
yaml_event_t* yaml_emitter_s::end | +yaml_emitter_state_t yaml_emitter_s::state |
-The end of the event queue. -
+
The current emitter state.
yaml_event_t* yaml_emitter_s::head | +yaml_event_t* yaml_emitter_s::start |
-The head of the event queue. -
+
The beginning of the event queue.
yaml_event_t* yaml_emitter_s::tail | +yaml_event_t* yaml_emitter_s::end |
-The tail of the event queue. -
+
The end of the event queue.
struct { ... } yaml_emitter_s::events | +yaml_event_t* yaml_emitter_s::head |
-The event queue. -
+
The head of the event queue.
int* yaml_emitter_s::start | +yaml_event_t* yaml_emitter_s::tail |
-The beginning of the stack. -
+
The tail of the event queue.
int* yaml_emitter_s::end | +struct { ... } yaml_emitter_s::events |
-The end of the stack. -
+
The event queue.
int* yaml_emitter_s::top | +int* yaml_emitter_s::start |
-The top of the stack. -
+
The beginning of the stack.
struct { ... } yaml_emitter_s::indents | +int* yaml_emitter_s::end |
-The stack of indentation levels. -
+
The end of the stack.
yaml_tag_directive_t* yaml_emitter_s::start | +int* yaml_emitter_s::top |
-The beginning of the list. -
+
The top of the stack.
yaml_tag_directive_t* yaml_emitter_s::end | +struct { ... } yaml_emitter_s::indents |
-The end of the list. -
+
The stack of indentation levels.
yaml_tag_directive_t* yaml_emitter_s::top | +yaml_tag_directive_t* yaml_emitter_s::start |
-The top of the list. -
+
The beginning of the list.
struct { ... } yaml_emitter_s::tag_directives | +yaml_tag_directive_t* yaml_emitter_s::end |
-The list of tag directives. -
+
The end of the list.
int yaml_emitter_s::indent | +yaml_tag_directive_t* yaml_emitter_s::top |
-The current indentation level. -
+
The top of the list.
int yaml_emitter_s::flow_level | +struct { ... } yaml_emitter_s::tag_directives |
-The current flow level. -
+
The list of tag directives.
int yaml_emitter_s::line | +int yaml_emitter_s::indent |
-The current line. -
+
The current indentation level.
int yaml_emitter_s::column | +int yaml_emitter_s::flow_level |
-The current column. -
+
The current flow level.
yaml_char_t* yaml_emitter_s::anchor | +int yaml_emitter_s::line |
-The anchor value. -
+
The current line.
size_t yaml_emitter_s::anchor_length | +int yaml_emitter_s::column |
-The anchor length. -
+
The current column.
struct { ... } yaml_emitter_s::anchor_data | +yaml_char_t* yaml_emitter_s::anchor |
-Anchor analysis. -
+
The anchor value.
yaml_char_t* yaml_emitter_s::handle | +size_t yaml_emitter_s::anchor_length |
-The tag handle. -
+
The anchor length.
size_t yaml_emitter_s::handle_length | +struct { ... } yaml_emitter_s::anchor_data |
-The tag handle length. -
+
Anchor analysis.
yaml_char_t* yaml_emitter_s::suffix | +yaml_char_t* yaml_emitter_s::handle |
-The tag suffix. -
+
The tag handle.
size_t yaml_emitter_s::suffix_length | +size_t yaml_emitter_s::handle_length |
-The tag suffix length. -
+
The tag handle length.
struct { ... } yaml_emitter_s::tag_data | +yaml_char_t* yaml_emitter_s::suffix |
-Tag analysis. -
+
The tag suffix.
yaml_char_t* yaml_emitter_s::value | +size_t yaml_emitter_s::suffix_length |
-The scalar value. -
+
The tag suffix length.
size_t yaml_emitter_s::length | +struct { ... } yaml_emitter_s::tag_data |
-The scalar length. -
+
Tag analysis.
yaml_scalar_style_t yaml_emitter_s::style | +yaml_char_t* yaml_emitter_s::value |
-The output style. -
+
The scalar value.
struct { ... } yaml_emitter_s::scalar_data | +size_t yaml_emitter_s::length |
-Scalar analysis. -
+
The scalar length.
int yaml_emitter_s::references | +yaml_scalar_style_t yaml_emitter_s::style |
-The number of references. -
+
The output style.
int yaml_emitter_s::anchor | +struct { ... } yaml_emitter_s::scalar_data |
-The anchor id. -
+
Scalar analysis.
struct { ... } * yaml_emitter_s::anchors | +yaml_anchors_t* yaml_emitter_s::anchors |
-The information associated with the document nodes. -
+
The information associated with the document nodes.
int yaml_emitter_s::last_anchor_id | +int yaml_emitter_s::last_anchor_id |
-The last assigned anchor id. -
+
The last assigned anchor id.
yaml_document_t* yaml_emitter_s::document | +yaml_document_t* yaml_emitter_s::document |
-The currently emitted document. -
+
The currently emitted document.
-