doc/html/group__parser.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   6 <meta name="generator" content="Doxygen 1.8.6"/>
   7 <title>yaml: Parser Definitions</title>
   8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   9 <script type="text/javascript" src="jquery.js"></script>
  10 <script type="text/javascript" src="dynsections.js"></script>
  11 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12 </head>
  13 <body>
  14 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  15 <div id="titlearea">
  16 <table cellspacing="0" cellpadding="0">
  17  <tbody>
  18  <tr style="height: 56px;">
  19   <td style="padding-left: 0.5em;">
  20    <div id="projectname">yaml
  21    &#160;<span id="projectnumber">0.1.7</span>
  22    </div>
  23   </td>
  24  </tr>
  25  </tbody>
  26 </table>
  27 </div>
  28 <!-- end header part -->
  29 <!-- Generated by Doxygen 1.8.6 -->
  30   <div id="navrow1" class="tabs">
  31     <ul class="tablist">
  32       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  33       <li><a href="modules.html"><span>Modules</span></a></li>
  34       <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  35       <li><a href="files.html"><span>Files</span></a></li>
  36     </ul>
  37   </div>
  38 </div><!-- top -->
  39 <div class="header">
  40   <div class="summary">
  41 <a href="#nested-classes">Data Structures</a> &#124;
  42 <a href="#typedef-members">Typedefs</a> &#124;
  43 <a href="#enum-members">Enumerations</a> &#124;
  44 <a href="#func-members">Functions</a>  </div>
  45   <div class="headertitle">
  46 <div class="title">Parser Definitions</div>  </div>
  47 </div><!--header-->
  48 <div class="contents">
  49 <table class="memberdecls">
  50 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  51 Data Structures</h2></td></tr>
  52 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__simple__key__s.html">yaml_simple_key_s</a></td></tr>
  53 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">This structure holds information about a potential simple key.  <a href="structyaml__simple__key__s.html#details">More...</a><br/></td></tr>
  54 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  55 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__alias__data__s.html">yaml_alias_data_s</a></td></tr>
  56 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">This structure holds aliases data.  <a href="structyaml__alias__data__s.html#details">More...</a><br/></td></tr>
  57 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  58 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__parser__s.html">yaml_parser_s</a></td></tr>
  59 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The parser structure.  <a href="structyaml__parser__s.html#details">More...</a><br/></td></tr>
  60 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  61 </table><table class="memberdecls">
  62 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
  63 Typedefs</h2></td></tr>
  64 <tr class="memitem:ga4982f7e4e001ddb47d2819f38f0cd9d6"><td class="memItemLeft" align="right" valign="top">typedef int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__parser.html#ga4982f7e4e001ddb47d2819f38f0cd9d6">yaml_read_handler_t</a> (void *data, unsigned char *buffer, size_t size, size_t *size_read)</td></tr>
  65 <tr class="memdesc:ga4982f7e4e001ddb47d2819f38f0cd9d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">The prototype of a read handler.  <a href="#ga4982f7e4e001ddb47d2819f38f0cd9d6">More...</a><br/></td></tr>
  66 <tr class="separator:ga4982f7e4e001ddb47d2819f38f0cd9d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  67 <tr class="memitem:gae5570fbb7ab7c8332cd666f3a9c26591"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae5570fbb7ab7c8332cd666f3a9c26591"></a>
  68 typedef struct <a class="el" href="structyaml__simple__key__s.html">yaml_simple_key_s</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__parser.html#gae5570fbb7ab7c8332cd666f3a9c26591">yaml_simple_key_t</a></td></tr>
  69 <tr class="memdesc:gae5570fbb7ab7c8332cd666f3a9c26591"><td class="mdescLeft">&#160;</td><td class="mdescRight">This structure holds information about a potential simple key. <br/></td></tr>
  70 <tr class="separator:gae5570fbb7ab7c8332cd666f3a9c26591"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71 <tr class="memitem:ga52b56d3e3cee0f9ba460978802a8c83b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga52b56d3e3cee0f9ba460978802a8c83b"></a>
  72 typedef enum <a class="el" href="group__parser.html#gad39c19e7b0df6f542ca97806535b57c5">yaml_parser_state_e</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__parser.html#ga52b56d3e3cee0f9ba460978802a8c83b">yaml_parser_state_t</a></td></tr>
  73 <tr class="memdesc:ga52b56d3e3cee0f9ba460978802a8c83b"><td class="mdescLeft">&#160;</td><td class="mdescRight">The states of the parser. <br/></td></tr>
  74 <tr class="separator:ga52b56d3e3cee0f9ba460978802a8c83b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75 <tr class="memitem:ga1434228b82f5f90d3c8ccda816e9ca9d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga1434228b82f5f90d3c8ccda816e9ca9d"></a>
  76 typedef struct <a class="el" href="structyaml__alias__data__s.html">yaml_alias_data_s</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__parser.html#ga1434228b82f5f90d3c8ccda816e9ca9d">yaml_alias_data_t</a></td></tr>
  77 <tr class="memdesc:ga1434228b82f5f90d3c8ccda816e9ca9d"><td class="mdescLeft">&#160;</td><td class="mdescRight">This structure holds aliases data. <br/></td></tr>
  78 <tr class="separator:ga1434228b82f5f90d3c8ccda816e9ca9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79 <tr class="memitem:gafdc6319cb28a8b8034542b29be85b0c4"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structyaml__parser__s.html">yaml_parser_s</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__parser.html#gafdc6319cb28a8b8034542b29be85b0c4">yaml_parser_t</a></td></tr>
  80 <tr class="memdesc:gafdc6319cb28a8b8034542b29be85b0c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">The parser structure.  <a href="#gafdc6319cb28a8b8034542b29be85b0c4">More...</a><br/></td></tr>
  81 <tr class="separator:gafdc6319cb28a8b8034542b29be85b0c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82 </table><table class="memberdecls">
  83 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
  84 Enumerations</h2></td></tr>
  85 <tr class="memitem:gad39c19e7b0df6f542ca97806535b57c5"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__parser.html#gad39c19e7b0df6f542ca97806535b57c5">yaml_parser_state_e</a> { <br/>
  86 &#160;&#160;<a class="el" href="group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5ae7b52e16bf002db5cf2944596d8c880e">YAML_PARSE_STREAM_START_STATE</a>,
  87 <br/>
  88 &#160;&#160;<a class="el" href="group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5a8255725d67d5bd3574fc7df4db1c6c84">YAML_PARSE_IMPLICIT_DOCUMENT_START_STATE</a>,
  89 <br/>
  90 &#160;&#160;<a class="el" href="group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5aa06d10f700d245caecfc6074a6c52fde">YAML_PARSE_DOCUMENT_START_STATE</a>,
  91 <br/>
  92 &#160;&#160;<a class="el" href="group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5ae444c7652c8029b0ef80068eaaaa3d4d">YAML_PARSE_DOCUMENT_CONTENT_STATE</a>,
  93 <br/>
  94 &#160;&#160;<a class="el" href="group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5aeef06d7f13fa4501146a5b9876c98239">YAML_PARSE_DOCUMENT_END_STATE</a>,
  95 <br/>
  96 &#160;&#160;<a class="el" href="group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5ae1893c0835bacf05cdc21ed181fb75f1">YAML_PARSE_BLOCK_NODE_STATE</a>,
  97 <br/>
  98 &#160;&#160;<a class="el" href="group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5acbd390af0d3919fe0382d03c284ff3b5">YAML_PARSE_BLOCK_NODE_OR_INDENTLESS_SEQUENCE_STATE</a>,
  99 <br/>
 100 &#160;&#160;<a class="el" href="group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5a5bb321f9d18c5b208a71c04bbcbd1d01">YAML_PARSE_FLOW_NODE_STATE</a>,
 101 <br/>
 102 &#160;&#160;<a class="el" href="group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5a5bb5f95fc5f1a258ee8e9db0ed25b2d9">YAML_PARSE_BLOCK_SEQUENCE_FIRST_ENTRY_STATE</a>,
 103 <br/>
 104 &#160;&#160;<a class="el" href="group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5a8a6cb1f12fe08eee7fc2fa854dbd5b1a">YAML_PARSE_BLOCK_SEQUENCE_ENTRY_STATE</a>,
 105 <br/>
 106 &#160;&#160;<a class="el" href="group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5af7095f2141cf9887489e832f0ec61fbd">YAML_PARSE_INDENTLESS_SEQUENCE_ENTRY_STATE</a>,
 107 <br/>
 108 &#160;&#160;<a class="el" href="group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5afebcb5bbd67d112d9ecfa633155f0644">YAML_PARSE_BLOCK_MAPPING_FIRST_KEY_STATE</a>,
 109 <br/>
 110 &#160;&#160;<a class="el" href="group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5a2df81c86e90b874b415ecb19e72efe45">YAML_PARSE_BLOCK_MAPPING_KEY_STATE</a>,
 111 <br/>
 112 &#160;&#160;<a class="el" href="group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5ae94acf5685fa1538b225413f154465c2">YAML_PARSE_BLOCK_MAPPING_VALUE_STATE</a>,
 113 <br/>
 114 &#160;&#160;<a class="el" href="group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5a3f54830989c12cc4a63494df792eeb08">YAML_PARSE_FLOW_SEQUENCE_FIRST_ENTRY_STATE</a>,
 115 <br/>
 116 &#160;&#160;<a class="el" href="group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5a0e50f3841eb0d37ad159e64c4a9a1171">YAML_PARSE_FLOW_SEQUENCE_ENTRY_STATE</a>,
 117 <br/>
 118 &#160;&#160;<a class="el" href="group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5a563e11601cf3a1d2a3efc1feb1b696a3">YAML_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_KEY_STATE</a>,
 119 <br/>
 120 &#160;&#160;<a class="el" href="group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5a9e5ebb4bee4541e7a7025689c7fc66eb">YAML_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_VALUE_STATE</a>,
 121 <br/>
 122 &#160;&#160;<a class="el" href="group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5a397fd87de9227c64e5308481930b5eeb">YAML_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_END_STATE</a>,
 123 <br/>
 124 &#160;&#160;<a class="el" href="group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5a91ac4bbb6629e2b768a3305fb707b7cd">YAML_PARSE_FLOW_MAPPING_FIRST_KEY_STATE</a>,
 125 <br/>
 126 &#160;&#160;<a class="el" href="group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5a924f8eb891dc7527bf4db594a0b1bff8">YAML_PARSE_FLOW_MAPPING_KEY_STATE</a>,
 127 <br/>
 128 &#160;&#160;<a class="el" href="group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5a3ba351f6cfba029248ada2c0720246d4">YAML_PARSE_FLOW_MAPPING_VALUE_STATE</a>,
 129 <br/>
 130 &#160;&#160;<a class="el" href="group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5a5a8ec0af5c3314c1ad5e0569b6a5d6d2">YAML_PARSE_FLOW_MAPPING_EMPTY_VALUE_STATE</a>,
 131 <br/>
 132 &#160;&#160;<a class="el" href="group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5a51fd3d45693e2240251996def375a2a2">YAML_PARSE_END_STATE</a>
 133 <br/>
 134  }</td></tr>
 135 <tr class="memdesc:gad39c19e7b0df6f542ca97806535b57c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">The states of the parser.  <a href="group__parser.html#gad39c19e7b0df6f542ca97806535b57c5">More...</a><br/></td></tr>
 136 <tr class="separator:gad39c19e7b0df6f542ca97806535b57c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 137 </table><table class="memberdecls">
 138 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
 139 Functions</h2></td></tr>
 140 <tr class="memitem:gacc37ceeb5847e38a3fe24eb0c9b53965"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__parser.html#gacc37ceeb5847e38a3fe24eb0c9b53965">yaml_parser_initialize</a> (<a class="el" href="group__parser.html#gafdc6319cb28a8b8034542b29be85b0c4">yaml_parser_t</a> *parser)</td></tr>
 141 <tr class="memdesc:gacc37ceeb5847e38a3fe24eb0c9b53965"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize a parser.  <a href="#gacc37ceeb5847e38a3fe24eb0c9b53965">More...</a><br/></td></tr>
 142 <tr class="separator:gacc37ceeb5847e38a3fe24eb0c9b53965"><td class="memSeparator" colspan="2">&#160;</td></tr>
 143 <tr class="memitem:gaa27150107c4667c1024ec0651e2ac26b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__parser.html#gaa27150107c4667c1024ec0651e2ac26b">yaml_parser_delete</a> (<a class="el" href="group__parser.html#gafdc6319cb28a8b8034542b29be85b0c4">yaml_parser_t</a> *parser)</td></tr>
 144 <tr class="memdesc:gaa27150107c4667c1024ec0651e2ac26b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy a parser.  <a href="#gaa27150107c4667c1024ec0651e2ac26b">More...</a><br/></td></tr>
 145 <tr class="separator:gaa27150107c4667c1024ec0651e2ac26b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 146 <tr class="memitem:ga08a94762bf5f4c61f72c1da0a407df0d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__parser.html#ga08a94762bf5f4c61f72c1da0a407df0d">yaml_parser_set_input_string</a> (<a class="el" href="group__parser.html#gafdc6319cb28a8b8034542b29be85b0c4">yaml_parser_t</a> *parser, const unsigned char *input, size_t size)</td></tr>
 147 <tr class="memdesc:ga08a94762bf5f4c61f72c1da0a407df0d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a string input.  <a href="#ga08a94762bf5f4c61f72c1da0a407df0d">More...</a><br/></td></tr>
 148 <tr class="separator:ga08a94762bf5f4c61f72c1da0a407df0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 149 <tr class="memitem:gac3f00f8beb2365b1e4569692d64696b6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__parser.html#gac3f00f8beb2365b1e4569692d64696b6">yaml_parser_set_input_file</a> (<a class="el" href="group__parser.html#gafdc6319cb28a8b8034542b29be85b0c4">yaml_parser_t</a> *parser, FILE *file)</td></tr>
 150 <tr class="memdesc:gac3f00f8beb2365b1e4569692d64696b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a file input.  <a href="#gac3f00f8beb2365b1e4569692d64696b6">More...</a><br/></td></tr>
 151 <tr class="separator:gac3f00f8beb2365b1e4569692d64696b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 152 <tr class="memitem:gabc67581bfa771a3e787d907d6914b8d9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__parser.html#gabc67581bfa771a3e787d907d6914b8d9">yaml_parser_set_input</a> (<a class="el" href="group__parser.html#gafdc6319cb28a8b8034542b29be85b0c4">yaml_parser_t</a> *parser, <a class="el" href="group__parser.html#ga4982f7e4e001ddb47d2819f38f0cd9d6">yaml_read_handler_t</a> *handler, void *data)</td></tr>
 153 <tr class="memdesc:gabc67581bfa771a3e787d907d6914b8d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a generic input handler.  <a href="#gabc67581bfa771a3e787d907d6914b8d9">More...</a><br/></td></tr>
 154 <tr class="separator:gabc67581bfa771a3e787d907d6914b8d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 155 <tr class="memitem:ga9565b64975570ed34612a19adf02ae6a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__parser.html#ga9565b64975570ed34612a19adf02ae6a">yaml_parser_set_encoding</a> (<a class="el" href="group__parser.html#gafdc6319cb28a8b8034542b29be85b0c4">yaml_parser_t</a> *parser, <a class="el" href="group__basic.html#ga2170996d7e636397b5e6bc0c1b7df7c6">yaml_encoding_t</a> encoding)</td></tr>
 156 <tr class="memdesc:ga9565b64975570ed34612a19adf02ae6a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the source encoding.  <a href="#ga9565b64975570ed34612a19adf02ae6a">More...</a><br/></td></tr>
 157 <tr class="separator:ga9565b64975570ed34612a19adf02ae6a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 158 <tr class="memitem:ga6c2144f131ebd600a075d4ba654540f7"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__parser.html#ga6c2144f131ebd600a075d4ba654540f7">yaml_parser_scan</a> (<a class="el" href="group__parser.html#gafdc6319cb28a8b8034542b29be85b0c4">yaml_parser_t</a> *parser, <a class="el" href="group__tokens.html#ga1ed3dc460e62aee8270c5d63d5734bbb">yaml_token_t</a> *token)</td></tr>
 159 <tr class="memdesc:ga6c2144f131ebd600a075d4ba654540f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Scan the input stream and produce the next token.  <a href="#ga6c2144f131ebd600a075d4ba654540f7">More...</a><br/></td></tr>
 160 <tr class="separator:ga6c2144f131ebd600a075d4ba654540f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 161 <tr class="memitem:ga559312fb137533d8b7e07f224fe0ec8f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__parser.html#ga559312fb137533d8b7e07f224fe0ec8f">yaml_parser_parse</a> (<a class="el" href="group__parser.html#gafdc6319cb28a8b8034542b29be85b0c4">yaml_parser_t</a> *parser, <a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *event)</td></tr>
 162 <tr class="memdesc:ga559312fb137533d8b7e07f224fe0ec8f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parse the input stream and produce the next parsing event.  <a href="#ga559312fb137533d8b7e07f224fe0ec8f">More...</a><br/></td></tr>
 163 <tr class="separator:ga559312fb137533d8b7e07f224fe0ec8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 164 <tr class="memitem:ga9ef7d6e9494766b5880c389bc431d138"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__parser.html#ga9ef7d6e9494766b5880c389bc431d138">yaml_parser_load</a> (<a class="el" href="group__parser.html#gafdc6319cb28a8b8034542b29be85b0c4">yaml_parser_t</a> *parser, <a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> *document)</td></tr>
 165 <tr class="memdesc:ga9ef7d6e9494766b5880c389bc431d138"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parse the input stream and produce the next YAML document.  <a href="#ga9ef7d6e9494766b5880c389bc431d138">More...</a><br/></td></tr>
 166 <tr class="separator:ga9ef7d6e9494766b5880c389bc431d138"><td class="memSeparator" colspan="2">&#160;</td></tr>
 167 </table>
 168 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 169 <h2 class="groupheader">Typedef Documentation</h2>
 170 <a class="anchor" id="ga4982f7e4e001ddb47d2819f38f0cd9d6"></a>
 171 <div class="memitem">
 172 <div class="memproto">
 173       <table class="memname">
 174         <tr>
 175           <td class="memname">typedef int yaml_read_handler_t(void *data, unsigned char *buffer, size_t size, size_t *size_read)</td>
 176         </tr>
 177       </table>
 178 </div><div class="memdoc">
 179
 180 <p>The prototype of a read handler. </p>
 181 <p>The read handler is called when the parser needs to read more bytes from the source. The handler should write not more than <em>size</em> bytes to the <em>buffer</em>. The number of written bytes should be set to the <em>length</em> variable.</p>
 182 <dl class="params"><dt>Parameters</dt><dd>
 183   <table class="params">
 184     <tr><td class="paramdir">[in,out]</td><td class="paramname">data</td><td>A pointer to an application data specified by <a class="el" href="group__parser.html#gabc67581bfa771a3e787d907d6914b8d9" title="Set a generic input handler. ">yaml_parser_set_input()</a>. </td></tr>
 185     <tr><td class="paramdir">[out]</td><td class="paramname">buffer</td><td>The buffer to write the data from the source. </td></tr>
 186     <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The size of the buffer. </td></tr>
 187     <tr><td class="paramdir">[out]</td><td class="paramname">size_read</td><td>The actual number of bytes read from the source.</td></tr>
 188   </table>
 189   </dd>
 190 </dl>
 191 <dl class="section return"><dt>Returns</dt><dd>On success, the handler should return <code>1</code>. If the handler failed, the returned value should be <code>0</code>. On EOF, the handler should set the <em>size_read</em> to <code>0</code> and return <code>1</code>. </dd></dl>
 192
 193 </div>
 194 </div>
 195 <a class="anchor" id="gafdc6319cb28a8b8034542b29be85b0c4"></a>
 196 <div class="memitem">
 197 <div class="memproto">
 198       <table class="memname">
 199         <tr>
 200           <td class="memname">typedef struct <a class="el" href="structyaml__parser__s.html">yaml_parser_s</a>  <a class="el" href="group__parser.html#gafdc6319cb28a8b8034542b29be85b0c4">yaml_parser_t</a></td>
 201         </tr>
 202       </table>
 203 </div><div class="memdoc">
 204
 205 <p>The parser structure. </p>
 206 <p>All members are internal. Manage the structure using the <code>yaml_parser_</code> family of functions. </p>
 207
 208 </div>
 209 </div>
 210 <h2 class="groupheader">Enumeration Type Documentation</h2>
 211 <a class="anchor" id="gad39c19e7b0df6f542ca97806535b57c5"></a>
 212 <div class="memitem">
 213 <div class="memproto">
 214       <table class="memname">
 215         <tr>
 216           <td class="memname">enum <a class="el" href="group__parser.html#gad39c19e7b0df6f542ca97806535b57c5">yaml_parser_state_e</a></td>
 217         </tr>
 218       </table>
 219 </div><div class="memdoc">
 220
 221 <p>The states of the parser. </p>
 222 <table class="fieldtable">
 223 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ggad39c19e7b0df6f542ca97806535b57c5ae7b52e16bf002db5cf2944596d8c880e"></a>YAML_PARSE_STREAM_START_STATE</em>&#160;</td><td class="fielddoc">
 224 <p>Expect STREAM-START. </p>
 225 </td></tr>
 226 <tr><td class="fieldname"><em><a class="anchor" id="ggad39c19e7b0df6f542ca97806535b57c5a8255725d67d5bd3574fc7df4db1c6c84"></a>YAML_PARSE_IMPLICIT_DOCUMENT_START_STATE</em>&#160;</td><td class="fielddoc">
 227 <p>Expect the beginning of an implicit document. </p>
 228 </td></tr>
 229 <tr><td class="fieldname"><em><a class="anchor" id="ggad39c19e7b0df6f542ca97806535b57c5aa06d10f700d245caecfc6074a6c52fde"></a>YAML_PARSE_DOCUMENT_START_STATE</em>&#160;</td><td class="fielddoc">
 230 <p>Expect DOCUMENT-START. </p>
 231 </td></tr>
 232 <tr><td class="fieldname"><em><a class="anchor" id="ggad39c19e7b0df6f542ca97806535b57c5ae444c7652c8029b0ef80068eaaaa3d4d"></a>YAML_PARSE_DOCUMENT_CONTENT_STATE</em>&#160;</td><td class="fielddoc">
 233 <p>Expect the content of a document. </p>
 234 </td></tr>
 235 <tr><td class="fieldname"><em><a class="anchor" id="ggad39c19e7b0df6f542ca97806535b57c5aeef06d7f13fa4501146a5b9876c98239"></a>YAML_PARSE_DOCUMENT_END_STATE</em>&#160;</td><td class="fielddoc">
 236 <p>Expect DOCUMENT-END. </p>
 237 </td></tr>
 238 <tr><td class="fieldname"><em><a class="anchor" id="ggad39c19e7b0df6f542ca97806535b57c5ae1893c0835bacf05cdc21ed181fb75f1"></a>YAML_PARSE_BLOCK_NODE_STATE</em>&#160;</td><td class="fielddoc">
 239 <p>Expect a block node. </p>
 240 </td></tr>
 241 <tr><td class="fieldname"><em><a class="anchor" id="ggad39c19e7b0df6f542ca97806535b57c5acbd390af0d3919fe0382d03c284ff3b5"></a>YAML_PARSE_BLOCK_NODE_OR_INDENTLESS_SEQUENCE_STATE</em>&#160;</td><td class="fielddoc">
 242 <p>Expect a block node or indentless sequence. </p>
 243 </td></tr>
 244 <tr><td class="fieldname"><em><a class="anchor" id="ggad39c19e7b0df6f542ca97806535b57c5a5bb321f9d18c5b208a71c04bbcbd1d01"></a>YAML_PARSE_FLOW_NODE_STATE</em>&#160;</td><td class="fielddoc">
 245 <p>Expect a flow node. </p>
 246 </td></tr>
 247 <tr><td class="fieldname"><em><a class="anchor" id="ggad39c19e7b0df6f542ca97806535b57c5a5bb5f95fc5f1a258ee8e9db0ed25b2d9"></a>YAML_PARSE_BLOCK_SEQUENCE_FIRST_ENTRY_STATE</em>&#160;</td><td class="fielddoc">
 248 <p>Expect the first entry of a block sequence. </p>
 249 </td></tr>
 250 <tr><td class="fieldname"><em><a class="anchor" id="ggad39c19e7b0df6f542ca97806535b57c5a8a6cb1f12fe08eee7fc2fa854dbd5b1a"></a>YAML_PARSE_BLOCK_SEQUENCE_ENTRY_STATE</em>&#160;</td><td class="fielddoc">
 251 <p>Expect an entry of a block sequence. </p>
 252 </td></tr>
 253 <tr><td class="fieldname"><em><a class="anchor" id="ggad39c19e7b0df6f542ca97806535b57c5af7095f2141cf9887489e832f0ec61fbd"></a>YAML_PARSE_INDENTLESS_SEQUENCE_ENTRY_STATE</em>&#160;</td><td class="fielddoc">
 254 <p>Expect an entry of an indentless sequence. </p>
 255 </td></tr>
 256 <tr><td class="fieldname"><em><a class="anchor" id="ggad39c19e7b0df6f542ca97806535b57c5afebcb5bbd67d112d9ecfa633155f0644"></a>YAML_PARSE_BLOCK_MAPPING_FIRST_KEY_STATE</em>&#160;</td><td class="fielddoc">
 257 <p>Expect the first key of a block mapping. </p>
 258 </td></tr>
 259 <tr><td class="fieldname"><em><a class="anchor" id="ggad39c19e7b0df6f542ca97806535b57c5a2df81c86e90b874b415ecb19e72efe45"></a>YAML_PARSE_BLOCK_MAPPING_KEY_STATE</em>&#160;</td><td class="fielddoc">
 260 <p>Expect a block mapping key. </p>
 261 </td></tr>
 262 <tr><td class="fieldname"><em><a class="anchor" id="ggad39c19e7b0df6f542ca97806535b57c5ae94acf5685fa1538b225413f154465c2"></a>YAML_PARSE_BLOCK_MAPPING_VALUE_STATE</em>&#160;</td><td class="fielddoc">
 263 <p>Expect a block mapping value. </p>
 264 </td></tr>
 265 <tr><td class="fieldname"><em><a class="anchor" id="ggad39c19e7b0df6f542ca97806535b57c5a3f54830989c12cc4a63494df792eeb08"></a>YAML_PARSE_FLOW_SEQUENCE_FIRST_ENTRY_STATE</em>&#160;</td><td class="fielddoc">
 266 <p>Expect the first entry of a flow sequence. </p>
 267 </td></tr>
 268 <tr><td class="fieldname"><em><a class="anchor" id="ggad39c19e7b0df6f542ca97806535b57c5a0e50f3841eb0d37ad159e64c4a9a1171"></a>YAML_PARSE_FLOW_SEQUENCE_ENTRY_STATE</em>&#160;</td><td class="fielddoc">
 269 <p>Expect an entry of a flow sequence. </p>
 270 </td></tr>
 271 <tr><td class="fieldname"><em><a class="anchor" id="ggad39c19e7b0df6f542ca97806535b57c5a563e11601cf3a1d2a3efc1feb1b696a3"></a>YAML_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_KEY_STATE</em>&#160;</td><td class="fielddoc">
 272 <p>Expect a key of an ordered mapping. </p>
 273 </td></tr>
 274 <tr><td class="fieldname"><em><a class="anchor" id="ggad39c19e7b0df6f542ca97806535b57c5a9e5ebb4bee4541e7a7025689c7fc66eb"></a>YAML_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_VALUE_STATE</em>&#160;</td><td class="fielddoc">
 275 <p>Expect a value of an ordered mapping. </p>
 276 </td></tr>
 277 <tr><td class="fieldname"><em><a class="anchor" id="ggad39c19e7b0df6f542ca97806535b57c5a397fd87de9227c64e5308481930b5eeb"></a>YAML_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_END_STATE</em>&#160;</td><td class="fielddoc">
 278 <p>Expect the and of an ordered mapping entry. </p>
 279 </td></tr>
 280 <tr><td class="fieldname"><em><a class="anchor" id="ggad39c19e7b0df6f542ca97806535b57c5a91ac4bbb6629e2b768a3305fb707b7cd"></a>YAML_PARSE_FLOW_MAPPING_FIRST_KEY_STATE</em>&#160;</td><td class="fielddoc">
 281 <p>Expect the first key of a flow mapping. </p>
 282 </td></tr>
 283 <tr><td class="fieldname"><em><a class="anchor" id="ggad39c19e7b0df6f542ca97806535b57c5a924f8eb891dc7527bf4db594a0b1bff8"></a>YAML_PARSE_FLOW_MAPPING_KEY_STATE</em>&#160;</td><td class="fielddoc">
 284 <p>Expect a key of a flow mapping. </p>
 285 </td></tr>
 286 <tr><td class="fieldname"><em><a class="anchor" id="ggad39c19e7b0df6f542ca97806535b57c5a3ba351f6cfba029248ada2c0720246d4"></a>YAML_PARSE_FLOW_MAPPING_VALUE_STATE</em>&#160;</td><td class="fielddoc">
 287 <p>Expect a value of a flow mapping. </p>
 288 </td></tr>
 289 <tr><td class="fieldname"><em><a class="anchor" id="ggad39c19e7b0df6f542ca97806535b57c5a5a8ec0af5c3314c1ad5e0569b6a5d6d2"></a>YAML_PARSE_FLOW_MAPPING_EMPTY_VALUE_STATE</em>&#160;</td><td class="fielddoc">
 290 <p>Expect an empty value of a flow mapping. </p>
 291 </td></tr>
 292 <tr><td class="fieldname"><em><a class="anchor" id="ggad39c19e7b0df6f542ca97806535b57c5a51fd3d45693e2240251996def375a2a2"></a>YAML_PARSE_END_STATE</em>&#160;</td><td class="fielddoc">
 293 <p>Expect nothing. </p>
 294 </td></tr>
 295 </table>
 296
 297 </div>
 298 </div>
 299 <h2 class="groupheader">Function Documentation</h2>
 300 <a class="anchor" id="gacc37ceeb5847e38a3fe24eb0c9b53965"></a>
 301 <div class="memitem">
 302 <div class="memproto">
 303       <table class="memname">
 304         <tr>
 305           <td class="memname">int yaml_parser_initialize </td>
 306           <td>(</td>
 307           <td class="paramtype"><a class="el" href="group__parser.html#gafdc6319cb28a8b8034542b29be85b0c4">yaml_parser_t</a> *&#160;</td>
 308           <td class="paramname"><em>parser</em></td><td>)</td>
 309           <td></td>
 310         </tr>
 311       </table>
 312 </div><div class="memdoc">
 313
 314 <p>Initialize a parser. </p>
 315 <p>This function creates a new parser object. An application is responsible for destroying the object using the <a class="el" href="group__parser.html#gaa27150107c4667c1024ec0651e2ac26b" title="Destroy a parser. ">yaml_parser_delete()</a> function.</p>
 316 <dl class="params"><dt>Parameters</dt><dd>
 317   <table class="params">
 318     <tr><td class="paramdir">[out]</td><td class="paramname">parser</td><td>An empty parser object.</td></tr>
 319   </table>
 320   </dd>
 321 </dl>
 322 <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl>
 323
 324 </div>
 325 </div>
 326 <a class="anchor" id="gaa27150107c4667c1024ec0651e2ac26b"></a>
 327 <div class="memitem">
 328 <div class="memproto">
 329       <table class="memname">
 330         <tr>
 331           <td class="memname">void yaml_parser_delete </td>
 332           <td>(</td>
 333           <td class="paramtype"><a class="el" href="group__parser.html#gafdc6319cb28a8b8034542b29be85b0c4">yaml_parser_t</a> *&#160;</td>
 334           <td class="paramname"><em>parser</em></td><td>)</td>
 335           <td></td>
 336         </tr>
 337       </table>
 338 </div><div class="memdoc">
 339
 340 <p>Destroy a parser. </p>
 341 <dl class="params"><dt>Parameters</dt><dd>
 342   <table class="params">
 343     <tr><td class="paramdir">[in,out]</td><td class="paramname">parser</td><td>A parser object. </td></tr>
 344   </table>
 345   </dd>
 346 </dl>
 347
 348 </div>
 349 </div>
 350 <a class="anchor" id="ga08a94762bf5f4c61f72c1da0a407df0d"></a>
 351 <div class="memitem">
 352 <div class="memproto">
 353       <table class="memname">
 354         <tr>
 355           <td class="memname">void yaml_parser_set_input_string </td>
 356           <td>(</td>
 357           <td class="paramtype"><a class="el" href="group__parser.html#gafdc6319cb28a8b8034542b29be85b0c4">yaml_parser_t</a> *&#160;</td>
 358           <td class="paramname"><em>parser</em>, </td>
 359         </tr>
 360         <tr>
 361           <td class="paramkey"></td>
 362           <td></td>
 363           <td class="paramtype">const unsigned char *&#160;</td>
 364           <td class="paramname"><em>input</em>, </td>
 365         </tr>
 366         <tr>
 367           <td class="paramkey"></td>
 368           <td></td>
 369           <td class="paramtype">size_t&#160;</td>
 370           <td class="paramname"><em>size</em>&#160;</td>
 371         </tr>
 372         <tr>
 373           <td></td>
 374           <td>)</td>
 375           <td></td><td></td>
 376         </tr>
 377       </table>
 378 </div><div class="memdoc">
 379
 380 <p>Set a string input. </p>
 381 <p>Note that the <em>input</em> pointer must be valid while the <em>parser</em> object exists. The application is responsible for destroing <em>input</em> after destroying the <em>parser</em>.</p>
 382 <dl class="params"><dt>Parameters</dt><dd>
 383   <table class="params">
 384     <tr><td class="paramdir">[in,out]</td><td class="paramname">parser</td><td>A parser object. </td></tr>
 385     <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>A source data. </td></tr>
 386     <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The length of the source data in bytes. </td></tr>
 387   </table>
 388   </dd>
 389 </dl>
 390
 391 </div>
 392 </div>
 393 <a class="anchor" id="gac3f00f8beb2365b1e4569692d64696b6"></a>
 394 <div class="memitem">
 395 <div class="memproto">
 396       <table class="memname">
 397         <tr>
 398           <td class="memname">void yaml_parser_set_input_file </td>
 399           <td>(</td>
 400           <td class="paramtype"><a class="el" href="group__parser.html#gafdc6319cb28a8b8034542b29be85b0c4">yaml_parser_t</a> *&#160;</td>
 401           <td class="paramname"><em>parser</em>, </td>
 402         </tr>
 403         <tr>
 404           <td class="paramkey"></td>
 405           <td></td>
 406           <td class="paramtype">FILE *&#160;</td>
 407           <td class="paramname"><em>file</em>&#160;</td>
 408         </tr>
 409         <tr>
 410           <td></td>
 411           <td>)</td>
 412           <td></td><td></td>
 413         </tr>
 414       </table>
 415 </div><div class="memdoc">
 416
 417 <p>Set a file input. </p>
 418 <p><em>file</em> should be a file object open for reading. The application is responsible for closing the <em>file</em>.</p>
 419 <dl class="params"><dt>Parameters</dt><dd>
 420   <table class="params">
 421     <tr><td class="paramdir">[in,out]</td><td class="paramname">parser</td><td>A parser object. </td></tr>
 422     <tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>An open file. </td></tr>
 423   </table>
 424   </dd>
 425 </dl>
 426
 427 </div>
 428 </div>
 429 <a class="anchor" id="gabc67581bfa771a3e787d907d6914b8d9"></a>
 430 <div class="memitem">
 431 <div class="memproto">
 432       <table class="memname">
 433         <tr>
 434           <td class="memname">void yaml_parser_set_input </td>
 435           <td>(</td>
 436           <td class="paramtype"><a class="el" href="group__parser.html#gafdc6319cb28a8b8034542b29be85b0c4">yaml_parser_t</a> *&#160;</td>
 437           <td class="paramname"><em>parser</em>, </td>
 438         </tr>
 439         <tr>
 440           <td class="paramkey"></td>
 441           <td></td>
 442           <td class="paramtype"><a class="el" href="group__parser.html#ga4982f7e4e001ddb47d2819f38f0cd9d6">yaml_read_handler_t</a> *&#160;</td>
 443           <td class="paramname"><em>handler</em>, </td>
 444         </tr>
 445         <tr>
 446           <td class="paramkey"></td>
 447           <td></td>
 448           <td class="paramtype">void *&#160;</td>
 449           <td class="paramname"><em>data</em>&#160;</td>
 450         </tr>
 451         <tr>
 452           <td></td>
 453           <td>)</td>
 454           <td></td><td></td>
 455         </tr>
 456       </table>
 457 </div><div class="memdoc">
 458
 459 <p>Set a generic input handler. </p>
 460 <dl class="params"><dt>Parameters</dt><dd>
 461   <table class="params">
 462     <tr><td class="paramdir">[in,out]</td><td class="paramname">parser</td><td>A parser object. </td></tr>
 463     <tr><td class="paramdir">[in]</td><td class="paramname">handler</td><td>A read handler. </td></tr>
 464     <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Any application data for passing to the read handler. </td></tr>
 465   </table>
 466   </dd>
 467 </dl>
 468
 469 </div>
 470 </div>
 471 <a class="anchor" id="ga9565b64975570ed34612a19adf02ae6a"></a>
 472 <div class="memitem">
 473 <div class="memproto">
 474       <table class="memname">
 475         <tr>
 476           <td class="memname">void yaml_parser_set_encoding </td>
 477           <td>(</td>
 478           <td class="paramtype"><a class="el" href="group__parser.html#gafdc6319cb28a8b8034542b29be85b0c4">yaml_parser_t</a> *&#160;</td>
 479           <td class="paramname"><em>parser</em>, </td>
 480         </tr>
 481         <tr>
 482           <td class="paramkey"></td>
 483           <td></td>
 484           <td class="paramtype"><a class="el" href="group__basic.html#ga2170996d7e636397b5e6bc0c1b7df7c6">yaml_encoding_t</a>&#160;</td>
 485           <td class="paramname"><em>encoding</em>&#160;</td>
 486         </tr>
 487         <tr>
 488           <td></td>
 489           <td>)</td>
 490           <td></td><td></td>
 491         </tr>
 492       </table>
 493 </div><div class="memdoc">
 494
 495 <p>Set the source encoding. </p>
 496 <dl class="params"><dt>Parameters</dt><dd>
 497   <table class="params">
 498     <tr><td class="paramdir">[in,out]</td><td class="paramname">parser</td><td>A parser object. </td></tr>
 499     <tr><td class="paramdir">[in]</td><td class="paramname">encoding</td><td>The source encoding. </td></tr>
 500   </table>
 501   </dd>
 502 </dl>
 503
 504 </div>
 505 </div>
 506 <a class="anchor" id="ga6c2144f131ebd600a075d4ba654540f7"></a>
 507 <div class="memitem">
 508 <div class="memproto">
 509       <table class="memname">
 510         <tr>
 511           <td class="memname">int yaml_parser_scan </td>
 512           <td>(</td>
 513           <td class="paramtype"><a class="el" href="group__parser.html#gafdc6319cb28a8b8034542b29be85b0c4">yaml_parser_t</a> *&#160;</td>
 514           <td class="paramname"><em>parser</em>, </td>
 515         </tr>
 516         <tr>
 517           <td class="paramkey"></td>
 518           <td></td>
 519           <td class="paramtype"><a class="el" href="group__tokens.html#ga1ed3dc460e62aee8270c5d63d5734bbb">yaml_token_t</a> *&#160;</td>
 520           <td class="paramname"><em>token</em>&#160;</td>
 521         </tr>
 522         <tr>
 523           <td></td>
 524           <td>)</td>
 525           <td></td><td></td>
 526         </tr>
 527       </table>
 528 </div><div class="memdoc">
 529
 530 <p>Scan the input stream and produce the next token. </p>
 531 <p>Call the function subsequently to produce a sequence of tokens corresponding to the input stream. The initial token has the type <code>YAML_STREAM_START_TOKEN</code> while the ending token has the type <code>YAML_STREAM_END_TOKEN</code>.</p>
 532 <p>An application is responsible for freeing any buffers associated with the produced token object using the <code>yaml_token_delete</code> function.</p>
 533 <p>An application must not alternate the calls of <a class="el" href="group__parser.html#ga6c2144f131ebd600a075d4ba654540f7" title="Scan the input stream and produce the next token. ">yaml_parser_scan()</a> with the calls of <a class="el" href="group__parser.html#ga559312fb137533d8b7e07f224fe0ec8f" title="Parse the input stream and produce the next parsing event. ">yaml_parser_parse()</a> or <a class="el" href="group__parser.html#ga9ef7d6e9494766b5880c389bc431d138" title="Parse the input stream and produce the next YAML document. ">yaml_parser_load()</a>. Doing this will break the parser.</p>
 534 <dl class="params"><dt>Parameters</dt><dd>
 535   <table class="params">
 536     <tr><td class="paramdir">[in,out]</td><td class="paramname">parser</td><td>A parser object. </td></tr>
 537     <tr><td class="paramdir">[out]</td><td class="paramname">token</td><td>An empty token object.</td></tr>
 538   </table>
 539   </dd>
 540 </dl>
 541 <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl>
 542
 543 </div>
 544 </div>
 545 <a class="anchor" id="ga559312fb137533d8b7e07f224fe0ec8f"></a>
 546 <div class="memitem">
 547 <div class="memproto">
 548       <table class="memname">
 549         <tr>
 550           <td class="memname">int yaml_parser_parse </td>
 551           <td>(</td>
 552           <td class="paramtype"><a class="el" href="group__parser.html#gafdc6319cb28a8b8034542b29be85b0c4">yaml_parser_t</a> *&#160;</td>
 553           <td class="paramname"><em>parser</em>, </td>
 554         </tr>
 555         <tr>
 556           <td class="paramkey"></td>
 557           <td></td>
 558           <td class="paramtype"><a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *&#160;</td>
 559           <td class="paramname"><em>event</em>&#160;</td>
 560         </tr>
 561         <tr>
 562           <td></td>
 563           <td>)</td>
 564           <td></td><td></td>
 565         </tr>
 566       </table>
 567 </div><div class="memdoc">
 568
 569 <p>Parse the input stream and produce the next parsing event. </p>
 570 <p>Call the function subsequently to produce a sequence of events corresponding to the input stream. The initial event has the type <code>YAML_STREAM_START_EVENT</code> while the ending event has the type <code>YAML_STREAM_END_EVENT</code>.</p>
 571 <p>An application is responsible for freeing any buffers associated with the produced event object using the <a class="el" href="group__events.html#ga5330d62ef52856aa53188137cb93a6a1" title="Free any memory allocated for an event object. ">yaml_event_delete()</a> function.</p>
 572 <p>An application must not alternate the calls of <a class="el" href="group__parser.html#ga559312fb137533d8b7e07f224fe0ec8f" title="Parse the input stream and produce the next parsing event. ">yaml_parser_parse()</a> with the calls of <a class="el" href="group__parser.html#ga6c2144f131ebd600a075d4ba654540f7" title="Scan the input stream and produce the next token. ">yaml_parser_scan()</a> or <a class="el" href="group__parser.html#ga9ef7d6e9494766b5880c389bc431d138" title="Parse the input stream and produce the next YAML document. ">yaml_parser_load()</a>. Doing this will break the parser.</p>
 573 <dl class="params"><dt>Parameters</dt><dd>
 574   <table class="params">
 575     <tr><td class="paramdir">[in,out]</td><td class="paramname">parser</td><td>A parser object. </td></tr>
 576     <tr><td class="paramdir">[out]</td><td class="paramname">event</td><td>An empty event object.</td></tr>
 577   </table>
 578   </dd>
 579 </dl>
 580 <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl>
 581
 582 </div>
 583 </div>
 584 <a class="anchor" id="ga9ef7d6e9494766b5880c389bc431d138"></a>
 585 <div class="memitem">
 586 <div class="memproto">
 587       <table class="memname">
 588         <tr>
 589           <td class="memname">int yaml_parser_load </td>
 590           <td>(</td>
 591           <td class="paramtype"><a class="el" href="group__parser.html#gafdc6319cb28a8b8034542b29be85b0c4">yaml_parser_t</a> *&#160;</td>
 592           <td class="paramname"><em>parser</em>, </td>
 593         </tr>
 594         <tr>
 595           <td class="paramkey"></td>
 596           <td></td>
 597           <td class="paramtype"><a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> *&#160;</td>
 598           <td class="paramname"><em>document</em>&#160;</td>
 599         </tr>
 600         <tr>
 601           <td></td>
 602           <td>)</td>
 603           <td></td><td></td>
 604         </tr>
 605       </table>
 606 </div><div class="memdoc">
 607
 608 <p>Parse the input stream and produce the next YAML document. </p>
 609 <p>Call this function subsequently to produce a sequence of documents constituting the input stream.</p>
 610 <p>If the produced document has no root node, it means that the document end has been reached.</p>
 611 <p>An application is responsible for freeing any data associated with the produced document object using the <a class="el" href="group__nodes.html#ga2754b1544fb4e110e83fafbc708b0672" title="Delete a YAML document and all its nodes. ">yaml_document_delete()</a> function.</p>
 612 <p>An application must not alternate the calls of <a class="el" href="group__parser.html#ga9ef7d6e9494766b5880c389bc431d138" title="Parse the input stream and produce the next YAML document. ">yaml_parser_load()</a> with the calls of <a class="el" href="group__parser.html#ga6c2144f131ebd600a075d4ba654540f7" title="Scan the input stream and produce the next token. ">yaml_parser_scan()</a> or <a class="el" href="group__parser.html#ga559312fb137533d8b7e07f224fe0ec8f" title="Parse the input stream and produce the next parsing event. ">yaml_parser_parse()</a>. Doing this will break the parser.</p>
 613 <dl class="params"><dt>Parameters</dt><dd>
 614   <table class="params">
 615     <tr><td class="paramdir">[in,out]</td><td class="paramname">parser</td><td>A parser object. </td></tr>
 616     <tr><td class="paramdir">[out]</td><td class="paramname">document</td><td>An empty document object.</td></tr>
 617   </table>
 618   </dd>
 619 </dl>
 620 <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl>
 621
 622 </div>
 623 </div>
 624 </div><!-- contents -->
 625 <!-- start footer part -->
 626 <hr class="footer"/><address class="footer"><small>
 627 Generated on Sun Aug 28 2016 23:56:54 for yaml by &#160;<a href="http://www.doxygen.org/index.html">
 628 <img class="footer" src="doxygen.png" alt="doxygen"/>
 629 </a> 1.8.6
 630 </small></address>
 631 </body>
 632 </html>