X-Git-Url: http://andersk.mit.edu/gitweb/libyaml.git/blobdiff_plain/0044e680dc24577d2b91cbbf287a2183461e9b80..c45550e5cf265bf6877cad127faa9854851e291e:/doc/html/structyaml__emitter__s.html?ds=sidebyside diff --git a/doc/html/structyaml__emitter__s.html b/doc/html/structyaml__emitter__s.html index f227523..84a4714 100644 --- a/doc/html/structyaml__emitter__s.html +++ b/doc/html/structyaml__emitter__s.html @@ -3,7 +3,8 @@ - + + yaml: yaml_emitter_s Struct Reference @@ -16,9 +17,9 @@ - @@ -26,21 +27,16 @@
+
yaml -  0.1.7 +  0.2.1
- - - + + + + +
@@ -56,437 +52,439 @@

Data Fields

unsigned char * buffer - The buffer pointer. More...
+ The buffer pointer. More...
  size_t size - The buffer size. More...
+ The buffer size. More...
  size_t * size_written - The number of written bytes. More...
+ The number of written bytes. More...
  struct {    unsigned char *   buffer - The buffer pointer. More...
+ The buffer pointer. More...
     size_t   size - The buffer size. More...
+ The buffer size. More...
     size_t *   size_written - The number of written bytes. More...
+ The number of written bytes. More...
  } string - String output data. More...
+ String output data. More...
  FILE * file - File output data. More...
+ File output data. More...
  yaml_char_t * start - The beginning of the buffer. More...
+ The beginning of the buffer. More...
  yaml_char_t * end - The end of the buffer. More...
+ The end of the buffer. More...
  yaml_char_t * pointer - The current position of the buffer. More...
+ The current position of the buffer. More...
  yaml_char_t * last - The last filled position of the buffer. More...
+ The last filled position of the buffer. More...
  unsigned char * start - The beginning of the buffer. More...
+ The beginning of the buffer. More...
  unsigned char * end - The end of the buffer. More...
+ The end of the buffer. More...
  unsigned char * pointer - The current position of the buffer. More...
+ The current position of the buffer. More...
  unsigned char * last - The last filled position of the buffer. More...
+ The last filled position of the buffer. More...
  yaml_emitter_state_t * start - The beginning of the stack. More...
+ The beginning of the stack. More...
  yaml_emitter_state_t * end - The end of the stack. More...
+ The end of the stack. More...
  yaml_emitter_state_t * top - The top of the stack. More...
+ The top of the stack. More...
  yaml_event_t * start - The beginning of the event queue. More...
+ The beginning of the event queue. More...
  yaml_event_t * end - The end of the event queue. More...
+ The end of the event queue. More...
  yaml_event_t * head - The head of the event queue. More...
+ The head of the event queue. More...
  yaml_event_t * tail - The tail of the event queue. More...
+ The tail of the event queue. More...
  int * start - The beginning of the stack. More...
+ The beginning of the stack. More...
  int * end - The end of the stack. More...
+ The end of the stack. More...
  int * top - The top of the stack. More...
+ The top of the stack. More...
  yaml_tag_directive_t * start - The beginning of the list. More...
+ The beginning of the list. More...
  yaml_tag_directive_t * end - The end of the list. More...
+ The end of the list. More...
  yaml_tag_directive_t * top - The top of the list. More...
+ The top of the list. More...
  yaml_char_t * anchor - The anchor value. More...
+ The anchor value. More...
  size_t anchor_length - The anchor length. More...
+ The anchor length. More...
  - + int alias - Is it an alias?
+ Is it an alias?
  yaml_char_t * handle - The tag handle. More...
+ The tag handle. More...
  size_t handle_length - The tag handle length. More...
+ The tag handle length. More...
  yaml_char_t * suffix - The tag suffix. More...
+ The tag suffix. More...
  size_t suffix_length - The tag suffix length. More...
+ The tag suffix length. More...
  yaml_char_t * value - The scalar value. More...
+ The scalar value. More...
  size_t length - The scalar length. More...
+ The scalar length. More...
  - + int multiline - Does the scalar contain line breaks?
+ Does the scalar contain line breaks?
  - + int flow_plain_allowed - Can the scalar be expessed in the flow plain style?
+ Can the scalar be expessed in the flow plain style?
  - + int block_plain_allowed - Can the scalar be expressed in the block plain style?
+ Can the scalar be expressed in the block plain style?
  - + int single_quoted_allowed - Can the scalar be expressed in the single quoted style?
+ Can the scalar be expressed in the single quoted style?
  - + int block_allowed - Can the scalar be expressed in the literal or folded styles?
+ Can the scalar be expressed in the literal or folded styles?
  yaml_scalar_style_t style - The output style. More...
+ The output style. More...
  int references - The number of references. More...
+ The number of references. More...
  int anchor - The anchor id. More...
+ The anchor id. More...
  - + int serialized - If the node has been emitted?
+ If the node has been emitted?
 
Error handling
yaml_error_type_t error - Error type. More...
+ Error type. More...
  const char * problem - Error description. More...
+ Error description. More...
 
Writer stuff
yaml_write_handler_t * write_handler - Write handler. More...
+ Write handler. More...
  void * write_handler_data - A pointer for passing to the white handler. More...
+ A pointer for passing to the white handler. More...
  union {    struct {       unsigned char *   buffer - The buffer pointer. More...
+ The buffer pointer. More...
        size_t   size - The buffer size. More...
+ The buffer size. More...
        size_t *   size_written - The number of written bytes. More...
+ The number of written bytes. More...
     }   string - String output data. More...
+ String output data. More...
     FILE *   file - File output data. More...
+ File output data. More...
  } output - Standard (string or file) output data. More...
+ Standard (string or file) output data. More...
  struct {    yaml_char_t *   start - The beginning of the buffer. More...
+ The beginning of the buffer. More...
     yaml_char_t *   end - The end of the buffer. More...
+ The end of the buffer. More...
     yaml_char_t *   pointer - The current position of the buffer. More...
+ The current position of the buffer. More...
     yaml_char_t *   last - The last filled position of the buffer. More...
+ The last filled position of the buffer. More...
  } buffer - The working buffer. More...
+ The working buffer. More...
  struct {    unsigned char *   start - The beginning of the buffer. More...
+ The beginning of the buffer. More...
     unsigned char *   end - The end of the buffer. More...
+ The end of the buffer. More...
     unsigned char *   pointer - The current position of the buffer. More...
+ The current position of the buffer. More...
     unsigned char *   last - The last filled position of the buffer. More...
+ The last filled position of the buffer. More...
  } raw_buffer - The raw buffer. More...
+ The raw buffer. More...
  yaml_encoding_t encoding - The stream encoding. More...
+ The stream encoding. More...
 
Emitter stuff
- + int canonical - If the output is in the canonical style?
+ If the output is in the canonical style?
  int best_indent - The number of indentation spaces. More...
+ The number of indentation spaces. More...
  int best_width - The preferred width of the output lines. More...
+ The preferred width of the output lines. More...
  - + int unicode - Allow unescaped non-ASCII characters?
+ Allow unescaped non-ASCII characters?
  yaml_break_t line_break - The preferred line break. More...
+ The preferred line break. More...
  struct {    yaml_emitter_state_t *   start - The beginning of the stack. More...
+ The beginning of the stack. More...
     yaml_emitter_state_t *   end - The end of the stack. More...
+ The end of the stack. More...
     yaml_emitter_state_t *   top - The top of the stack. More...
+ The top of the stack. More...
  } states - The stack of states. More...
+ The stack of states. More...
  yaml_emitter_state_t state - The current emitter state. More...
+ The current emitter state. More...
  struct {    yaml_event_t *   start - The beginning of the event queue. More...
+ The beginning of the event queue. More...
     yaml_event_t *   end - The end of the event queue. More...
+ The end of the event queue. More...
     yaml_event_t *   head - The head of the event queue. More...
+ The head of the event queue. More...
     yaml_event_t *   tail - The tail of the event queue. More...
+ The tail of the event queue. More...
  } events - The event queue. More...
+ The event queue. More...
  struct {    int *   start - The beginning of the stack. More...
+ The beginning of the stack. More...
     int *   end - The end of the stack. More...
+ The end of the stack. More...
     int *   top - The top of the stack. More...
+ The top of the stack. More...
  } indents - The stack of indentation levels. More...
+ The stack of indentation levels. More...
  struct {    yaml_tag_directive_t *   start - The beginning of the list. More...
+ The beginning of the list. More...
     yaml_tag_directive_t *   end - The end of the list. More...
+ The end of the list. More...
     yaml_tag_directive_t *   top - The top of the list. More...
+ The top of the list. More...
  } tag_directives - The list of tag directives. More...
+ The list of tag directives. More...
  int indent - The current indentation level. More...
+ The current indentation level. More...
  int flow_level - The current flow level. More...
+ The current flow level. More...
  - + int root_context - Is it the document root context?
+ Is it the document root context?
  - + int sequence_context - Is it a sequence context?
+ Is it a sequence context?
  - + int mapping_context - Is it a mapping context?
+ Is it a mapping context?
  - + int simple_key_context - Is it a simple mapping key context?
+ Is it a simple mapping key context?
  int line - The current line. More...
+ The current line. More...
  int column - The current column. More...
+ The current column. More...
  - + int whitespace - If the last character was a whitespace?
+ If the last character was a whitespace?
  - + int indention - If the last character was an indentation character (' ', '-', '?', ':')?
+ If the last character was an indentation character (' ', '-', '?', ':')?
  - + int open_ended - If an explicit document end is required?
+ If an explicit document end is required?
  struct {    yaml_char_t *   anchor - The anchor value. More...
+ The anchor value. More...
     size_t   anchor_length - The anchor length. More...
+ The anchor length. More...
  - +    int   alias - Is it an alias?
+ Is it an alias?
  } anchor_data - Anchor analysis. More...
+ Anchor analysis. More...
  struct {    yaml_char_t *   handle - The tag handle. More...
+ The tag handle. More...
     size_t   handle_length - The tag handle length. More...
+ The tag handle length. More...
     yaml_char_t *   suffix - The tag suffix. More...
+ The tag suffix. More...
     size_t   suffix_length - The tag suffix length. More...
+ The tag suffix length. More...
  } tag_data - Tag analysis. More...
+ Tag analysis. More...
  struct {    yaml_char_t *   value - The scalar value. More...
+ The scalar value. More...
     size_t   length - The scalar length. More...
+ The scalar length. More...
  - +    int   multiline - Does the scalar contain line breaks?
+ Does the scalar contain line breaks?
  - +    int   flow_plain_allowed - Can the scalar be expessed in the flow plain style?
+ Can the scalar be expessed in the flow plain style?
  - +    int   block_plain_allowed - Can the scalar be expressed in the block plain style?
+ Can the scalar be expressed in the block plain style?
  - +    int   single_quoted_allowed - Can the scalar be expressed in the single quoted style?
+ Can the scalar be expressed in the single quoted style?
  - +    int   block_allowed - Can the scalar be expressed in the literal or folded styles?
+ Can the scalar be expressed in the literal or folded styles?
     yaml_scalar_style_t   style - The output style. More...
+ The output style. More...
  } scalar_data - Scalar analysis. More...
+ Scalar analysis. More...
 
Dumper stuff
- + int opened - If the stream was already opened?
+ If the stream was already opened?
  - + int closed - If the stream was already closed?
+ If the stream was already closed?
  struct {    int   references - The number of references. More...
+ The number of references. More...
     int   anchor - The anchor id. More...
+ The anchor id. More...
  - +    int   serialized - If the node has been emitted?
+ If the node has been emitted?
  -} anchors - The information associated with the document nodes. More...
+} * anchors + The information associated with the document nodes. More...
  int last_anchor_id - The last assigned anchor id. More...
+ The last assigned anchor id. More...
  yaml_document_t * document - The currently emitted document. More...
+ The currently emitted document. More...
 

Detailed Description

The emitter structure.

All members are internal. Manage the structure using the yaml_emitter_ family of functions.

Field Documentation

- + +

◆ error

+
@@ -500,7 +498,9 @@ int 
+ +

◆ problem

+
@@ -514,7 +514,9 @@ int 
+ +

◆ write_handler

+
@@ -528,7 +530,9 @@ int 
+ +

◆ write_handler_data

+
@@ -542,7 +546,9 @@ int 
+ +

◆ buffer [1/2]

+
@@ -556,7 +562,9 @@ int 
+ +

◆ size

+
@@ -570,7 +578,9 @@ int 
+ +

◆ size_written

+
@@ -584,7 +594,9 @@ int 
+ +

◆ string

+
@@ -598,7 +610,9 @@ int 
+ +

◆ file

+
@@ -612,7 +626,9 @@ int 
+ +

◆ output

+
@@ -626,7 +642,9 @@ int 
+ +

◆ start [1/6]

+
@@ -640,7 +658,9 @@ int 
+ +

◆ end [1/6]

+
@@ -654,7 +674,9 @@ int 
+ +

◆ pointer [1/2]

+
@@ -668,7 +690,9 @@ int 
+ +

◆ last [1/2]

+
@@ -682,7 +706,9 @@ int 
+ +

◆ buffer [2/2]

+
@@ -696,7 +722,9 @@ int 
+ +

◆ start [2/6]

+
@@ -710,7 +738,9 @@ int 
+ +

◆ end [2/6]

+
@@ -724,7 +754,9 @@ int 
+ +

◆ pointer [2/2]

+
@@ -738,7 +770,9 @@ int 
+ +

◆ last [2/2]

+
@@ -752,7 +786,9 @@ int 
+ +

◆ raw_buffer

+
@@ -766,7 +802,9 @@ int 
+ +

◆ encoding

+
@@ -780,7 +818,9 @@ int 
+ +

◆ best_indent

+
@@ -794,7 +834,9 @@ int 
+ +

◆ best_width

+
@@ -808,7 +850,9 @@ int 
+ +

◆ line_break

+
@@ -822,7 +866,9 @@ int 
+ +

◆ start [3/6]

+
@@ -836,7 +882,9 @@ int 
+ +

◆ end [3/6]

+
@@ -850,7 +898,9 @@ int 
+ +

◆ top [1/3]

+
@@ -864,7 +914,9 @@ int 
+ +

◆ states

+
@@ -878,7 +930,9 @@ int 
+ +

◆ state

+
@@ -892,7 +946,9 @@ int 
+ +

◆ start [4/6]

+
@@ -906,7 +962,9 @@ int 
+ +

◆ end [4/6]

+
@@ -920,7 +978,9 @@ int 
+ +

◆ head

+
@@ -934,7 +994,9 @@ int 
+ +

◆ tail

+
@@ -948,7 +1010,9 @@ int 
+ +

◆ events

+
@@ -962,7 +1026,9 @@ int 
+ +

◆ start [5/6]

+
@@ -976,7 +1042,9 @@ int 
+ +

◆ end [5/6]

+
@@ -990,7 +1058,9 @@ int 
+ +

◆ top [2/3]

+
@@ -1004,7 +1074,9 @@ int 
+ +

◆ indents

+
@@ -1018,7 +1090,9 @@ int 
+ +

◆ start [6/6]

+
@@ -1032,7 +1106,9 @@ int 
+ +

◆ end [6/6]

+
@@ -1046,7 +1122,9 @@ int 
+ +

◆ top [3/3]

+
@@ -1060,7 +1138,9 @@ int 
+ +

◆ tag_directives

+
@@ -1074,7 +1154,9 @@ int 
+ +

◆ indent

+
@@ -1088,7 +1170,9 @@ int 
+ +

◆ flow_level

+
@@ -1102,7 +1186,9 @@ int 
+ +

◆ line

+
@@ -1116,7 +1202,9 @@ int 
+ +

◆ column

+
@@ -1130,7 +1218,9 @@ int 
+ +

◆ anchor [1/2]

+
@@ -1144,7 +1234,9 @@ int 
+ +

◆ anchor_length

+
@@ -1158,7 +1250,9 @@ int 
+ +

◆ anchor_data

+
@@ -1172,7 +1266,9 @@ int 
+ +

◆ handle

+
@@ -1186,7 +1282,9 @@ int 
+ +

◆ handle_length

+
@@ -1200,7 +1298,9 @@ int 
+ +

◆ suffix

+
@@ -1214,7 +1314,9 @@ int 
+ +

◆ suffix_length

+
@@ -1228,7 +1330,9 @@ int 
+ +

◆ tag_data

+
@@ -1242,7 +1346,9 @@ int 
+ +

◆ value

+
@@ -1256,7 +1362,9 @@ int 
+ +

◆ length

+
@@ -1270,7 +1378,9 @@ int 
+ +

◆ style

+
@@ -1284,7 +1394,9 @@ int 
+ +

◆ scalar_data

+
@@ -1298,7 +1410,9 @@ int 
+ +

◆ references

+
@@ -1312,7 +1426,9 @@ int 
+ +

◆ anchor [2/2]

+
@@ -1326,7 +1442,9 @@ int 
+ +

◆ anchors

+
@@ -1340,7 +1458,9 @@ int 
+ +

◆ last_anchor_id

+
@@ -1354,7 +1474,9 @@ int 
+ +

◆ document

+
@@ -1374,9 +1496,9 @@ int 
-Generated on Sun Aug 28 2016 23:56:54 for yaml by   +Generated by   doxygen - 1.8.6 + 1.8.14