📁 File Manager Pro
v10.0.3 | PHP: 8.1.34
Server: Apache
2026-06-22 05:32:33
📂
/ (Root)
/
opt
/
alt
/
ruby20
/
share
/
doc
/
ruby
/
capi
/
html
/
dd
/
da8
📍 /opt/alt/ruby20/share/doc/ruby/capi/html/dd/da8
🔄 Refresh
✏️
Editing: group__parser.html
Read Only
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.14"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>Ruby: Parser Definitions</title> <link href="../../tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="../../jquery.js"></script> <script type="text/javascript" src="../../dynsections.js"></script> <link href="../../doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">Ruby  <span id="projectnumber">2.0.0p648(2015-12-16revision53162)</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.14 --> <script type="text/javascript" src="../../menudata.js"></script> <script type="text/javascript" src="../../menu.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('../../',false,false,'search.php','Search'); }); /* @license-end */</script> <div id="main-nav"></div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#nested-classes">Data Structures</a> | <a href="#typedef-members">Typedefs</a> | <a href="#enum-members">Enumerations</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">Parser Definitions</div> </div> </div><!--header--> <div class="contents"> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> Data Structures</h2></td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/d11/structyaml__simple__key__s.html">yaml_simple_key_s</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">This structure holds information about a potential simple key. <a href="../../d6/d11/structyaml__simple__key__s.html#details">More...</a><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d63/structyaml__alias__data__s.html">yaml_alias_data_s</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">This structure holds aliases data. <a href="../../d1/d63/structyaml__alias__data__s.html#details">More...</a><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/dd9/structyaml__parser__s.html">yaml_parser_s</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The parser structure. <a href="../../d1/dd9/structyaml__parser__s.html#details">More...</a><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> Typedefs</h2></td></tr> <tr class="memitem:ga4982f7e4e001ddb47d2819f38f0cd9d6"><td class="memItemLeft" align="right" valign="top">typedef int </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/da8/group__parser.html#ga4982f7e4e001ddb47d2819f38f0cd9d6">yaml_read_handler_t</a>(void *data, unsigned char *buffer, size_t <a class="el" href="../../d8/d36/signal_8c.html#a56fae156d59e6ee797fe8dc8389262c4">size</a>, size_t *size_read)</td></tr> <tr class="memdesc:ga4982f7e4e001ddb47d2819f38f0cd9d6"><td class="mdescLeft"> </td><td class="mdescRight">The prototype of a read handler. <a href="#ga4982f7e4e001ddb47d2819f38f0cd9d6">More...</a><br /></td></tr> <tr class="separator:ga4982f7e4e001ddb47d2819f38f0cd9d6"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gae5570fbb7ab7c8332cd666f3a9c26591"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="../../d6/d11/structyaml__simple__key__s.html">yaml_simple_key_s</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/da8/group__parser.html#gae5570fbb7ab7c8332cd666f3a9c26591">yaml_simple_key_t</a></td></tr> <tr class="memdesc:gae5570fbb7ab7c8332cd666f3a9c26591"><td class="mdescLeft"> </td><td class="mdescRight">This structure holds information about a potential simple key. <a href="#gae5570fbb7ab7c8332cd666f3a9c26591">More...</a><br /></td></tr> <tr class="separator:gae5570fbb7ab7c8332cd666f3a9c26591"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga52b56d3e3cee0f9ba460978802a8c83b"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="../../dd/da8/group__parser.html#gad39c19e7b0df6f542ca97806535b57c5">yaml_parser_state_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/da8/group__parser.html#ga52b56d3e3cee0f9ba460978802a8c83b">yaml_parser_state_t</a></td></tr> <tr class="memdesc:ga52b56d3e3cee0f9ba460978802a8c83b"><td class="mdescLeft"> </td><td class="mdescRight">The states of the parser. <a href="#ga52b56d3e3cee0f9ba460978802a8c83b">More...</a><br /></td></tr> <tr class="separator:ga52b56d3e3cee0f9ba460978802a8c83b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga1434228b82f5f90d3c8ccda816e9ca9d"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="../../d1/d63/structyaml__alias__data__s.html">yaml_alias_data_s</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/da8/group__parser.html#ga1434228b82f5f90d3c8ccda816e9ca9d">yaml_alias_data_t</a></td></tr> <tr class="memdesc:ga1434228b82f5f90d3c8ccda816e9ca9d"><td class="mdescLeft"> </td><td class="mdescRight">This structure holds aliases data. <a href="#ga1434228b82f5f90d3c8ccda816e9ca9d">More...</a><br /></td></tr> <tr class="separator:ga1434228b82f5f90d3c8ccda816e9ca9d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gafdc6319cb28a8b8034542b29be85b0c4"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="../../d1/dd9/structyaml__parser__s.html">yaml_parser_s</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/da8/group__parser.html#gafdc6319cb28a8b8034542b29be85b0c4">yaml_parser_t</a></td></tr> <tr class="memdesc:gafdc6319cb28a8b8034542b29be85b0c4"><td class="mdescLeft"> </td><td class="mdescRight">The parser structure. <a href="#gafdc6319cb28a8b8034542b29be85b0c4">More...</a><br /></td></tr> <tr class="separator:gafdc6319cb28a8b8034542b29be85b0c4"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> Enumerations</h2></td></tr> <tr class="memitem:gad39c19e7b0df6f542ca97806535b57c5"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/da8/group__parser.html#gad39c19e7b0df6f542ca97806535b57c5">yaml_parser_state_e</a> { <br />   <a class="el" href="../../dd/da8/group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5ae7b52e16bf002db5cf2944596d8c880e">YAML_PARSE_STREAM_START_STATE</a>, <a class="el" href="../../dd/da8/group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5a8255725d67d5bd3574fc7df4db1c6c84">YAML_PARSE_IMPLICIT_DOCUMENT_START_STATE</a>, <a class="el" href="../../dd/da8/group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5aa06d10f700d245caecfc6074a6c52fde">YAML_PARSE_DOCUMENT_START_STATE</a>, <a class="el" href="../../dd/da8/group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5ae444c7652c8029b0ef80068eaaaa3d4d">YAML_PARSE_DOCUMENT_CONTENT_STATE</a>, <br />   <a class="el" href="../../dd/da8/group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5aeef06d7f13fa4501146a5b9876c98239">YAML_PARSE_DOCUMENT_END_STATE</a>, <a class="el" href="../../dd/da8/group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5ae1893c0835bacf05cdc21ed181fb75f1">YAML_PARSE_BLOCK_NODE_STATE</a>, <a class="el" href="../../dd/da8/group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5acbd390af0d3919fe0382d03c284ff3b5">YAML_PARSE_BLOCK_NODE_OR_INDENTLESS_SEQUENCE_STATE</a>, <a class="el" href="../../dd/da8/group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5a5bb321f9d18c5b208a71c04bbcbd1d01">YAML_PARSE_FLOW_NODE_STATE</a>, <br />   <a class="el" href="../../dd/da8/group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5a5bb5f95fc5f1a258ee8e9db0ed25b2d9">YAML_PARSE_BLOCK_SEQUENCE_FIRST_ENTRY_STATE</a>, <a class="el" href="../../dd/da8/group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5a8a6cb1f12fe08eee7fc2fa854dbd5b1a">YAML_PARSE_BLOCK_SEQUENCE_ENTRY_STATE</a>, <a class="el" href="../../dd/da8/group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5af7095f2141cf9887489e832f0ec61fbd">YAML_PARSE_INDENTLESS_SEQUENCE_ENTRY_STATE</a>, <a class="el" href="../../dd/da8/group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5afebcb5bbd67d112d9ecfa633155f0644">YAML_PARSE_BLOCK_MAPPING_FIRST_KEY_STATE</a>, <br />   <a class="el" href="../../dd/da8/group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5a2df81c86e90b874b415ecb19e72efe45">YAML_PARSE_BLOCK_MAPPING_KEY_STATE</a>, <a class="el" href="../../dd/da8/group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5ae94acf5685fa1538b225413f154465c2">YAML_PARSE_BLOCK_MAPPING_VALUE_STATE</a>, <a class="el" href="../../dd/da8/group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5a3f54830989c12cc4a63494df792eeb08">YAML_PARSE_FLOW_SEQUENCE_FIRST_ENTRY_STATE</a>, <a class="el" href="../../dd/da8/group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5a0e50f3841eb0d37ad159e64c4a9a1171">YAML_PARSE_FLOW_SEQUENCE_ENTRY_STATE</a>, <br />   <a class="el" href="../../dd/da8/group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5a563e11601cf3a1d2a3efc1feb1b696a3">YAML_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_KEY_STATE</a>, <a class="el" href="../../dd/da8/group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5a9e5ebb4bee4541e7a7025689c7fc66eb">YAML_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_VALUE_STATE</a>, <a class="el" href="../../dd/da8/group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5a397fd87de9227c64e5308481930b5eeb">YAML_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_END_STATE</a>, <a class="el" href="../../dd/da8/group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5a91ac4bbb6629e2b768a3305fb707b7cd">YAML_PARSE_FLOW_MAPPING_FIRST_KEY_STATE</a>, <br />   <a class="el" href="../../dd/da8/group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5a924f8eb891dc7527bf4db594a0b1bff8">YAML_PARSE_FLOW_MAPPING_KEY_STATE</a>, <a class="el" href="../../dd/da8/group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5a3ba351f6cfba029248ada2c0720246d4">YAML_PARSE_FLOW_MAPPING_VALUE_STATE</a>, <a class="el" href="../../dd/da8/group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5a5a8ec0af5c3314c1ad5e0569b6a5d6d2">YAML_PARSE_FLOW_MAPPING_EMPTY_VALUE_STATE</a>, <a class="el" href="../../dd/da8/group__parser.html#ggad39c19e7b0df6f542ca97806535b57c5a51fd3d45693e2240251996def375a2a2">YAML_PARSE_END_STATE</a> <br /> }</td></tr> <tr class="memdesc:gad39c19e7b0df6f542ca97806535b57c5"><td class="mdescLeft"> </td><td class="mdescRight">The states of the parser. <a href="../../dd/da8/group__parser.html#gad39c19e7b0df6f542ca97806535b57c5">More...</a><br /></td></tr> <tr class="separator:gad39c19e7b0df6f542ca97806535b57c5"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> Functions</h2></td></tr> <tr class="memitem:gaa59a82bcf49fc934aa6d237d65bc9f6b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/da8/group__parser.html#gaa59a82bcf49fc934aa6d237d65bc9f6b">yaml_parser_initialize</a> (<a class="el" href="../../dd/da8/group__parser.html#gafdc6319cb28a8b8034542b29be85b0c4">yaml_parser_t</a> *parser)</td></tr> <tr class="memdesc:gaa59a82bcf49fc934aa6d237d65bc9f6b"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a parser. <a href="#gaa59a82bcf49fc934aa6d237d65bc9f6b">More...</a><br /></td></tr> <tr class="separator:gaa59a82bcf49fc934aa6d237d65bc9f6b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga2608bc65d6cf04799223cbb0084e84a5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/da8/group__parser.html#ga2608bc65d6cf04799223cbb0084e84a5">yaml_parser_delete</a> (<a class="el" href="../../dd/da8/group__parser.html#gafdc6319cb28a8b8034542b29be85b0c4">yaml_parser_t</a> *parser)</td></tr> <tr class="memdesc:ga2608bc65d6cf04799223cbb0084e84a5"><td class="mdescLeft"> </td><td class="mdescRight">Destroy a parser. <a href="#ga2608bc65d6cf04799223cbb0084e84a5">More...</a><br /></td></tr> <tr class="separator:ga2608bc65d6cf04799223cbb0084e84a5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gae75f4fb47ba2e8d480d59a43849dcfa5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/da8/group__parser.html#gae75f4fb47ba2e8d480d59a43849dcfa5">yaml_parser_set_input_string</a> (<a class="el" href="../../dd/da8/group__parser.html#gafdc6319cb28a8b8034542b29be85b0c4">yaml_parser_t</a> *parser, <a class="el" href="../../da/d50/vsnprintf_8c.html#a2c212835823e3c54a8ab6d95c652660e">const</a> unsigned char *<a class="el" href="../../d8/d90/nkf_8c.html#a94b5f026462e354d6ebebb1e9df4ef50">input</a>, size_t <a class="el" href="../../d8/d36/signal_8c.html#a56fae156d59e6ee797fe8dc8389262c4">size</a>)</td></tr> <tr class="memdesc:gae75f4fb47ba2e8d480d59a43849dcfa5"><td class="mdescLeft"> </td><td class="mdescRight">Set a string input. <a href="#gae75f4fb47ba2e8d480d59a43849dcfa5">More...</a><br /></td></tr> <tr class="separator:gae75f4fb47ba2e8d480d59a43849dcfa5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga389b2d0c663922e5a4db8eb94aede8f5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/da8/group__parser.html#ga389b2d0c663922e5a4db8eb94aede8f5">yaml_parser_set_input_file</a> (<a class="el" href="../../dd/da8/group__parser.html#gafdc6319cb28a8b8034542b29be85b0c4">yaml_parser_t</a> *parser, <a class="el" href="../../da/d50/vsnprintf_8c.html#a95742987b07c3bc61a7f376b0168410b">FILE</a> *file)</td></tr> <tr class="memdesc:ga389b2d0c663922e5a4db8eb94aede8f5"><td class="mdescLeft"> </td><td class="mdescRight">Set a file input. <a href="#ga389b2d0c663922e5a4db8eb94aede8f5">More...</a><br /></td></tr> <tr class="separator:ga389b2d0c663922e5a4db8eb94aede8f5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga9af477fa1721acb21a42f3341c45e6cf"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/da8/group__parser.html#ga9af477fa1721acb21a42f3341c45e6cf">yaml_parser_set_input</a> (<a class="el" href="../../dd/da8/group__parser.html#gafdc6319cb28a8b8034542b29be85b0c4">yaml_parser_t</a> *parser, <a class="el" href="../../dd/da8/group__parser.html#ga4982f7e4e001ddb47d2819f38f0cd9d6">yaml_read_handler_t</a> *handler, void *data)</td></tr> <tr class="memdesc:ga9af477fa1721acb21a42f3341c45e6cf"><td class="mdescLeft"> </td><td class="mdescRight">Set a generic input handler. <a href="#ga9af477fa1721acb21a42f3341c45e6cf">More...</a><br /></td></tr> <tr class="separator:ga9af477fa1721acb21a42f3341c45e6cf"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga6e3eabd71c844814ab7d4e9807c69cd8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/da8/group__parser.html#ga6e3eabd71c844814ab7d4e9807c69cd8">yaml_parser_set_encoding</a> (<a class="el" href="../../dd/da8/group__parser.html#gafdc6319cb28a8b8034542b29be85b0c4">yaml_parser_t</a> *parser, <a class="el" href="../../d0/df6/group__basic.html#ga2170996d7e636397b5e6bc0c1b7df7c6">yaml_encoding_t</a> encoding)</td></tr> <tr class="memdesc:ga6e3eabd71c844814ab7d4e9807c69cd8"><td class="mdescLeft"> </td><td class="mdescRight">Set the source encoding. <a href="#ga6e3eabd71c844814ab7d4e9807c69cd8">More...</a><br /></td></tr> <tr class="separator:ga6e3eabd71c844814ab7d4e9807c69cd8"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gae62b7861e6f260572cf25379088270c6"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/da8/group__parser.html#gae62b7861e6f260572cf25379088270c6">yaml_parser_scan</a> (<a class="el" href="../../dd/da8/group__parser.html#gafdc6319cb28a8b8034542b29be85b0c4">yaml_parser_t</a> *parser, <a class="el" href="../../d9/d9f/group__tokens.html#ga1ed3dc460e62aee8270c5d63d5734bbb">yaml_token_t</a> *<a class="el" href="../../db/d97/parse_8c.html#a762077f24f1e3564cc3b863ceafccf9b">token</a>)</td></tr> <tr class="memdesc:gae62b7861e6f260572cf25379088270c6"><td class="mdescLeft"> </td><td class="mdescRight">Scan the input stream and produce the next token. <a href="#gae62b7861e6f260572cf25379088270c6">More...</a><br /></td></tr> <tr class="separator:gae62b7861e6f260572cf25379088270c6"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gaa90105acba29cbf17b287e5c41c48dde"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/da8/group__parser.html#gaa90105acba29cbf17b287e5c41c48dde">yaml_parser_parse</a> (<a class="el" href="../../dd/da8/group__parser.html#gafdc6319cb28a8b8034542b29be85b0c4">yaml_parser_t</a> *parser, <a class="el" href="../../d1/ddf/group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *event)</td></tr> <tr class="memdesc:gaa90105acba29cbf17b287e5c41c48dde"><td class="mdescLeft"> </td><td class="mdescRight">Parse the input stream and produce the next parsing event. <a href="#gaa90105acba29cbf17b287e5c41c48dde">More...</a><br /></td></tr> <tr class="separator:gaa90105acba29cbf17b287e5c41c48dde"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gafe5381d911f9dab9683dd27676f50336"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/da8/group__parser.html#gafe5381d911f9dab9683dd27676f50336">yaml_parser_load</a> (<a class="el" href="../../dd/da8/group__parser.html#gafdc6319cb28a8b8034542b29be85b0c4">yaml_parser_t</a> *parser, <a class="el" href="../../dd/d58/group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> *document)</td></tr> <tr class="memdesc:gafe5381d911f9dab9683dd27676f50336"><td class="mdescLeft"> </td><td class="mdescRight">Parse the input stream and produce the next YAML document. <a href="#gafe5381d911f9dab9683dd27676f50336">More...</a><br /></td></tr> <tr class="separator:gafe5381d911f9dab9683dd27676f50336"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <h2 class="groupheader">Typedef Documentation</h2> <a id="ga1434228b82f5f90d3c8ccda816e9ca9d"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga1434228b82f5f90d3c8ccda816e9ca9d">◆ </a></span>yaml_alias_data_t</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef struct <a class="el" href="../../d1/d63/structyaml__alias__data__s.html">yaml_alias_data_s</a> <a class="el" href="../../dd/da8/group__parser.html#ga1434228b82f5f90d3c8ccda816e9ca9d">yaml_alias_data_t</a></td> </tr> </table> </div><div class="memdoc"> <p>This structure holds aliases data. </p> </div> </div> <a id="ga52b56d3e3cee0f9ba460978802a8c83b"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga52b56d3e3cee0f9ba460978802a8c83b">◆ </a></span>yaml_parser_state_t</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef enum <a class="el" href="../../dd/da8/group__parser.html#gad39c19e7b0df6f542ca97806535b57c5">yaml_parser_state_e</a> <a class="el" href="../../dd/da8/group__parser.html#ga52b56d3e3cee0f9ba460978802a8c83b">yaml_parser_state_t</a></td> </tr> </table> </div><div class="memdoc"> <p>The states of the parser. </p> </div> </div> <a id="gafdc6319cb28a8b8034542b29be85b0c4"></a> <h2 class="memtitle"><span class="permalink"><a href="#gafdc6319cb28a8b8034542b29be85b0c4">◆ </a></span>yaml_parser_t</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef struct <a class="el" href="../../d1/dd9/structyaml__parser__s.html">yaml_parser_s</a> <a class="el" href="../../dd/da8/group__parser.html#gafdc6319cb28a8b8034542b29be85b0c4">yaml_parser_t</a></td> </tr> </table> </div><div class="memdoc"> <p>The parser structure. </p> <p>All members are internal. Manage the structure using the <code>yaml_parser_</code> family of functions. </p> </div> </div> <a id="ga4982f7e4e001ddb47d2819f38f0cd9d6"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga4982f7e4e001ddb47d2819f38f0cd9d6">◆ </a></span>yaml_read_handler_t</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef int yaml_read_handler_t(void *data, unsigned char *buffer, size_t <a class="el" href="../../d8/d36/signal_8c.html#a56fae156d59e6ee797fe8dc8389262c4">size</a>, size_t *size_read)</td> </tr> </table> </div><div class="memdoc"> <p>The prototype of a read handler. </p> <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> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <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="../../dd/da8/group__parser.html#ga9af477fa1721acb21a42f3341c45e6cf" title="Set a generic input handler. ">yaml_parser_set_input()</a>. </td></tr> <tr><td class="paramdir">[out]</td><td class="paramname">buffer</td><td>The buffer to write the data from the source. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The size of the buffer. </td></tr> <tr><td class="paramdir">[out]</td><td class="paramname">size_read</td><td>The actual number of bytes read from the source.</td></tr> </table> </dd> </dl> <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> <p class="definition">Definition at line <a class="el" href="../../dc/dfe/yaml_8h_source.html#l00986">986</a> of file <a class="el" href="../../dc/dfe/yaml_8h_source.html">yaml.h</a>.</p> </div> </div> <a id="gae5570fbb7ab7c8332cd666f3a9c26591"></a> <h2 class="memtitle"><span class="permalink"><a href="#gae5570fbb7ab7c8332cd666f3a9c26591">◆ </a></span>yaml_simple_key_t</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef struct <a class="el" href="../../d6/d11/structyaml__simple__key__s.html">yaml_simple_key_s</a> <a class="el" href="../../dd/da8/group__parser.html#gae5570fbb7ab7c8332cd666f3a9c26591">yaml_simple_key_t</a></td> </tr> </table> </div><div class="memdoc"> <p>This structure holds information about a potential simple key. </p> </div> </div> <h2 class="groupheader">Enumeration Type Documentation</h2> <a id="gad39c19e7b0df6f542ca97806535b57c5"></a> <h2 class="memtitle"><span class="permalink"><a href="#gad39c19e7b0df6f542ca97806535b57c5">◆ </a></span>yaml_parser_state_e</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">enum <a class="el" href="../../dd/da8/group__parser.html#gad39c19e7b0df6f542ca97806535b57c5">yaml_parser_state_e</a></td> </tr> </table> </div><div class="memdoc"> <p>The states of the parser. </p> <table class="fieldtable"> <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggad39c19e7b0df6f542ca97806535b57c5ae7b52e16bf002db5cf2944596d8c880e"></a>YAML_PARSE_STREAM_START_STATE </td><td class="fielddoc"><p>Expect STREAM-START. </p> </td></tr> <tr><td class="fieldname"><a id="ggad39c19e7b0df6f542ca97806535b57c5a8255725d67d5bd3574fc7df4db1c6c84"></a>YAML_PARSE_IMPLICIT_DOCUMENT_START_STATE </td><td class="fielddoc"><p>Expect the beginning of an implicit document. </p> </td></tr> <tr><td class="fieldname"><a id="ggad39c19e7b0df6f542ca97806535b57c5aa06d10f700d245caecfc6074a6c52fde"></a>YAML_PARSE_DOCUMENT_START_STATE </td><td class="fielddoc"><p>Expect DOCUMENT-START. </p> </td></tr> <tr><td class="fieldname"><a id="ggad39c19e7b0df6f542ca97806535b57c5ae444c7652c8029b0ef80068eaaaa3d4d"></a>YAML_PARSE_DOCUMENT_CONTENT_STATE </td><td class="fielddoc"><p>Expect the content of a document. </p> </td></tr> <tr><td class="fieldname"><a id="ggad39c19e7b0df6f542ca97806535b57c5aeef06d7f13fa4501146a5b9876c98239"></a>YAML_PARSE_DOCUMENT_END_STATE </td><td class="fielddoc"><p>Expect DOCUMENT-END. </p> </td></tr> <tr><td class="fieldname"><a id="ggad39c19e7b0df6f542ca97806535b57c5ae1893c0835bacf05cdc21ed181fb75f1"></a>YAML_PARSE_BLOCK_NODE_STATE </td><td class="fielddoc"><p>Expect a block node. </p> </td></tr> <tr><td class="fieldname"><a id="ggad39c19e7b0df6f542ca97806535b57c5acbd390af0d3919fe0382d03c284ff3b5"></a>YAML_PARSE_BLOCK_NODE_OR_INDENTLESS_SEQUENCE_STATE </td><td class="fielddoc"><p>Expect a block node or indentless sequence. </p> </td></tr> <tr><td class="fieldname"><a id="ggad39c19e7b0df6f542ca97806535b57c5a5bb321f9d18c5b208a71c04bbcbd1d01"></a>YAML_PARSE_FLOW_NODE_STATE </td><td class="fielddoc"><p>Expect a flow node. </p> </td></tr> <tr><td class="fieldname"><a id="ggad39c19e7b0df6f542ca97806535b57c5a5bb5f95fc5f1a258ee8e9db0ed25b2d9"></a>YAML_PARSE_BLOCK_SEQUENCE_FIRST_ENTRY_STATE </td><td class="fielddoc"><p>Expect the first entry of a block sequence. </p> </td></tr> <tr><td class="fieldname"><a id="ggad39c19e7b0df6f542ca97806535b57c5a8a6cb1f12fe08eee7fc2fa854dbd5b1a"></a>YAML_PARSE_BLOCK_SEQUENCE_ENTRY_STATE </td><td class="fielddoc"><p>Expect an entry of a block sequence. </p> </td></tr> <tr><td class="fieldname"><a id="ggad39c19e7b0df6f542ca97806535b57c5af7095f2141cf9887489e832f0ec61fbd"></a>YAML_PARSE_INDENTLESS_SEQUENCE_ENTRY_STATE </td><td class="fielddoc"><p>Expect an entry of an indentless sequence. </p> </td></tr> <tr><td class="fieldname"><a id="ggad39c19e7b0df6f542ca97806535b57c5afebcb5bbd67d112d9ecfa633155f0644"></a>YAML_PARSE_BLOCK_MAPPING_FIRST_KEY_STATE </td><td class="fielddoc"><p>Expect the first key of a block mapping. </p> </td></tr> <tr><td class="fieldname"><a id="ggad39c19e7b0df6f542ca97806535b57c5a2df81c86e90b874b415ecb19e72efe45"></a>YAML_PARSE_BLOCK_MAPPING_KEY_STATE </td><td class="fielddoc"><p>Expect a block mapping key. </p> </td></tr> <tr><td class="fieldname"><a id="ggad39c19e7b0df6f542ca97806535b57c5ae94acf5685fa1538b225413f154465c2"></a>YAML_PARSE_BLOCK_MAPPING_VALUE_STATE </td><td class="fielddoc"><p>Expect a block mapping value. </p> </td></tr> <tr><td class="fieldname"><a id="ggad39c19e7b0df6f542ca97806535b57c5a3f54830989c12cc4a63494df792eeb08"></a>YAML_PARSE_FLOW_SEQUENCE_FIRST_ENTRY_STATE </td><td class="fielddoc"><p>Expect the first entry of a flow sequence. </p> </td></tr> <tr><td class="fieldname"><a id="ggad39c19e7b0df6f542ca97806535b57c5a0e50f3841eb0d37ad159e64c4a9a1171"></a>YAML_PARSE_FLOW_SEQUENCE_ENTRY_STATE </td><td class="fielddoc"><p>Expect an entry of a flow sequence. </p> </td></tr> <tr><td class="fieldname"><a id="ggad39c19e7b0df6f542ca97806535b57c5a563e11601cf3a1d2a3efc1feb1b696a3"></a>YAML_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_KEY_STATE </td><td class="fielddoc"><p>Expect a key of an ordered mapping. </p> </td></tr> <tr><td class="fieldname"><a id="ggad39c19e7b0df6f542ca97806535b57c5a9e5ebb4bee4541e7a7025689c7fc66eb"></a>YAML_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_VALUE_STATE </td><td class="fielddoc"><p>Expect a value of an ordered mapping. </p> </td></tr> <tr><td class="fieldname"><a id="ggad39c19e7b0df6f542ca97806535b57c5a397fd87de9227c64e5308481930b5eeb"></a>YAML_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_END_STATE </td><td class="fielddoc"><p>Expect the and of an ordered mapping entry. </p> </td></tr> <tr><td class="fieldname"><a id="ggad39c19e7b0df6f542ca97806535b57c5a91ac4bbb6629e2b768a3305fb707b7cd"></a>YAML_PARSE_FLOW_MAPPING_FIRST_KEY_STATE </td><td class="fielddoc"><p>Expect the first key of a flow mapping. </p> </td></tr> <tr><td class="fieldname"><a id="ggad39c19e7b0df6f542ca97806535b57c5a924f8eb891dc7527bf4db594a0b1bff8"></a>YAML_PARSE_FLOW_MAPPING_KEY_STATE </td><td class="fielddoc"><p>Expect a key of a flow mapping. </p> </td></tr> <tr><td class="fieldname"><a id="ggad39c19e7b0df6f542ca97806535b57c5a3ba351f6cfba029248ada2c0720246d4"></a>YAML_PARSE_FLOW_MAPPING_VALUE_STATE </td><td class="fielddoc"><p>Expect a value of a flow mapping. </p> </td></tr> <tr><td class="fieldname"><a id="ggad39c19e7b0df6f542ca97806535b57c5a5a8ec0af5c3314c1ad5e0569b6a5d6d2"></a>YAML_PARSE_FLOW_MAPPING_EMPTY_VALUE_STATE </td><td class="fielddoc"><p>Expect an empty value of a flow mapping. </p> </td></tr> <tr><td class="fieldname"><a id="ggad39c19e7b0df6f542ca97806535b57c5a51fd3d45693e2240251996def375a2a2"></a>YAML_PARSE_END_STATE </td><td class="fielddoc"><p>Expect nothing. </p> </td></tr> </table> <p class="definition">Definition at line <a class="el" href="../../dc/dfe/yaml_8h_source.html#l01010">1010</a> of file <a class="el" href="../../dc/dfe/yaml_8h_source.html">yaml.h</a>.</p> </div> </div> <h2 class="groupheader">Function Documentation</h2> <a id="ga2608bc65d6cf04799223cbb0084e84a5"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga2608bc65d6cf04799223cbb0084e84a5">◆ </a></span>yaml_parser_delete()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">yaml_parser_delete </td> <td>(</td> <td class="paramtype"><a class="el" href="../../dd/da8/group__parser.html#gafdc6319cb28a8b8034542b29be85b0c4">yaml_parser_t</a> * </td> <td class="paramname"><em>parser</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Destroy a parser. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in,out]</td><td class="paramname">parser</td><td>A parser object. </td></tr> </table> </dd> </dl> <p class="definition">Definition at line <a class="el" href="../../d3/de3/api_8c_source.html#l00214">214</a> of file <a class="el" href="../../d3/de3/api_8c_source.html">api.c</a>.</p> <p class="reference">References <a class="el" href="../../d5/dac/ossl_8h_source.html#l00045">assert</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00103">BUFFER_DEL</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00484">DEQUEUE</a>, <a class="el" href="../../dc/dfe/yaml_8h_source.html#l00091">yaml_tag_directive_s::handle</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00457">POP</a>, <a class="el" href="../../dc/dfe/yaml_8h_source.html#l00093">yaml_tag_directive_s::prefix</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00468">QUEUE_DEL</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00472">QUEUE_EMPTY</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00434">STACK_DEL</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00438">STACK_EMPTY</a>, <a class="el" href="../../d3/de3/api_8c_source.html#l00051">yaml_free()</a>, and <a class="el" href="../../d3/de3/api_8c_source.html#l00578">yaml_token_delete()</a>.</p> <p class="reference">Referenced by <a class="el" href="../../d4/d54/psych__parser_8c_source.html#l00043">dealloc()</a>, and <a class="el" href="../../d4/d54/psych__parser_8c_source.html#l00229">parse()</a>.</p> </div> </div> <a id="gaa59a82bcf49fc934aa6d237d65bc9f6b"></a> <h2 class="memtitle"><span class="permalink"><a href="#gaa59a82bcf49fc934aa6d237d65bc9f6b">◆ </a></span>yaml_parser_initialize()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">yaml_parser_initialize </td> <td>(</td> <td class="paramtype"><a class="el" href="../../dd/da8/group__parser.html#gafdc6319cb28a8b8034542b29be85b0c4">yaml_parser_t</a> * </td> <td class="paramname"><em>parser</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Initialize a parser. </p> <p>This function creates a new parser object. An application is responsible for destroying the object using the <a class="el" href="../../dd/da8/group__parser.html#ga2608bc65d6cf04799223cbb0084e84a5" title="Destroy a parser. ">yaml_parser_delete()</a> function.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[out]</td><td class="paramname">parser</td><td>An empty parser object.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> <p class="definition">Definition at line <a class="el" href="../../d3/de3/api_8c_source.html#l00171">171</a> of file <a class="el" href="../../d3/de3/api_8c_source.html">api.c</a>.</p> <p class="reference">References <a class="el" href="../../d5/dac/ossl_8h_source.html#l00045">assert</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00103">BUFFER_DEL</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00095">BUFFER_INIT</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00088">INITIAL_QUEUE_SIZE</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00087">INITIAL_STACK_SIZE</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00067">INPUT_BUFFER_SIZE</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00059">INPUT_RAW_BUFFER_SIZE</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00468">QUEUE_DEL</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00460">QUEUE_INIT</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00434">STACK_DEL</a>, and <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00426">STACK_INIT</a>.</p> <p class="reference">Referenced by <a class="el" href="../../d4/d54/psych__parser_8c_source.html#l00052">allocate()</a>, and <a class="el" href="../../d4/d54/psych__parser_8c_source.html#l00229">parse()</a>.</p> </div> </div> <a id="gafe5381d911f9dab9683dd27676f50336"></a> <h2 class="memtitle"><span class="permalink"><a href="#gafe5381d911f9dab9683dd27676f50336">◆ </a></span>yaml_parser_load()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">yaml_parser_load </td> <td>(</td> <td class="paramtype"><a class="el" href="../../dd/da8/group__parser.html#gafdc6319cb28a8b8034542b29be85b0c4">yaml_parser_t</a> * </td> <td class="paramname"><em>parser</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="../../dd/d58/group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> * </td> <td class="paramname"><em>document</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Parse the input stream and produce the next YAML document. </p> <p>Call this function subsequently to produce a sequence of documents constituting the input stream.</p> <p>If the produced document has no root node, it means that the document end has been reached.</p> <p>An application is responsible for freeing any data associated with the produced document object using the <a class="el" href="../../dd/d58/group__nodes.html#gab2e1fa6ea019b20f2508f1bc63218384" title="Delete a YAML document and all its nodes. ">yaml_document_delete()</a> function.</p> <p>An application must not alternate the calls of <a class="el" href="../../dd/da8/group__parser.html#gafe5381d911f9dab9683dd27676f50336" title="Parse the input stream and produce the next YAML document. ">yaml_parser_load()</a> with the calls of <a class="el" href="../../dd/da8/group__parser.html#gae62b7861e6f260572cf25379088270c6" title="Scan the input stream and produce the next token. ">yaml_parser_scan()</a> or <a class="el" href="../../dd/da8/group__parser.html#gaa90105acba29cbf17b287e5c41c48dde" title="Parse the input stream and produce the next parsing event. ">yaml_parser_parse()</a>. Doing this will break the parser.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in,out]</td><td class="paramname">parser</td><td>A parser object. </td></tr> <tr><td class="paramdir">[out]</td><td class="paramname">document</td><td>An empty document object.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> <p class="definition">Definition at line <a class="el" href="../../d3/d96/loader_8c_source.html#l00067">67</a> of file <a class="el" href="../../d3/d96/loader_8c_source.html">loader.c</a>.</p> <p class="reference">References <a class="el" href="../../d5/dac/ossl_8h_source.html#l00045">assert</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00087">INITIAL_STACK_SIZE</a>, <a class="el" href="../../d4/db0/__sdbm_8c_source.html#l00102">NULL</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00426">STACK_INIT</a>, <a class="el" href="../../dc/dfe/yaml_8h_source.html#l00387">yaml_event_s::type</a>, <a class="el" href="../../d3/de3/api_8c_source.html#l01121">yaml_document_delete()</a>, <a class="el" href="../../d3/d96/loader_8c_source.html#l00152">yaml_parser_delete_aliases()</a>, <a class="el" href="../../d3/d96/loader_8c_source.html#l00165">yaml_parser_load_document()</a>, <a class="el" href="../../dc/df1/psych_2yaml_2parser_8c_source.html#l00170">yaml_parser_parse()</a>, <a class="el" href="../../dc/dfe/yaml_8h_source.html#l00360">YAML_STREAM_END_EVENT</a>, and <a class="el" href="../../dc/dfe/yaml_8h_source.html#l00358">YAML_STREAM_START_EVENT</a>.</p> </div> </div> <a id="gaa90105acba29cbf17b287e5c41c48dde"></a> <h2 class="memtitle"><span class="permalink"><a href="#gaa90105acba29cbf17b287e5c41c48dde">◆ </a></span>yaml_parser_parse()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">yaml_parser_parse </td> <td>(</td> <td class="paramtype"><a class="el" href="../../dd/da8/group__parser.html#gafdc6319cb28a8b8034542b29be85b0c4">yaml_parser_t</a> * </td> <td class="paramname"><em>parser</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="../../d1/ddf/group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> * </td> <td class="paramname"><em>event</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Parse the input stream and produce the next parsing event. </p> <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> <p>An application is responsible for freeing any buffers associated with the produced event object using the <a class="el" href="../../d1/ddf/group__events.html#ga989c12ed4090ff45698068848d930d08" title="Free any memory allocated for an event object. ">yaml_event_delete()</a> function.</p> <p>An application must not alternate the calls of <a class="el" href="../../dd/da8/group__parser.html#gaa90105acba29cbf17b287e5c41c48dde" title="Parse the input stream and produce the next parsing event. ">yaml_parser_parse()</a> with the calls of <a class="el" href="../../dd/da8/group__parser.html#gae62b7861e6f260572cf25379088270c6" title="Scan the input stream and produce the next token. ">yaml_parser_scan()</a> or <a class="el" href="../../dd/da8/group__parser.html#gafe5381d911f9dab9683dd27676f50336" title="Parse the input stream and produce the next YAML document. ">yaml_parser_load()</a>. Doing this will break the parser.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in,out]</td><td class="paramname">parser</td><td>A parser object. </td></tr> <tr><td class="paramdir">[out]</td><td class="paramname">event</td><td>An empty event object.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> <p class="definition">Definition at line <a class="el" href="../../dc/df1/psych_2yaml_2parser_8c_source.html#l00170">170</a> of file <a class="el" href="../../dc/df1/psych_2yaml_2parser_8c_source.html">parser.c</a>.</p> <p class="reference">References <a class="el" href="../../d5/dac/ossl_8h_source.html#l00045">assert</a>, <a class="el" href="../../dc/dfe/yaml_8h_source.html#l01058">YAML_PARSE_END_STATE</a>, and <a class="el" href="../../dc/df1/psych_2yaml_2parser_8c_source.html#l00226">yaml_parser_state_machine()</a>.</p> <p class="reference">Referenced by <a class="el" href="../../d4/d54/psych__parser_8c_source.html#l00229">parse()</a>, <a class="el" href="../../d3/d96/loader_8c_source.html#l00067">yaml_parser_load()</a>, <a class="el" href="../../d3/d96/loader_8c_source.html#l00165">yaml_parser_load_document()</a>, <a class="el" href="../../d3/d96/loader_8c_source.html#l00394">yaml_parser_load_mapping()</a>, and <a class="el" href="../../d3/d96/loader_8c_source.html#l00327">yaml_parser_load_sequence()</a>.</p> </div> </div> <a id="gae62b7861e6f260572cf25379088270c6"></a> <h2 class="memtitle"><span class="permalink"><a href="#gae62b7861e6f260572cf25379088270c6">◆ </a></span>yaml_parser_scan()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">yaml_parser_scan </td> <td>(</td> <td class="paramtype"><a class="el" href="../../dd/da8/group__parser.html#gafdc6319cb28a8b8034542b29be85b0c4">yaml_parser_t</a> * </td> <td class="paramname"><em>parser</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="../../d9/d9f/group__tokens.html#ga1ed3dc460e62aee8270c5d63d5734bbb">yaml_token_t</a> * </td> <td class="paramname"><em>token</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Scan the input stream and produce the next token. </p> <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> <p>An application is responsible for freeing any buffers associated with the produced token object using the <code>yaml_token_delete</code> function.</p> <p>An application must not alternate the calls of <a class="el" href="../../dd/da8/group__parser.html#gae62b7861e6f260572cf25379088270c6" title="Scan the input stream and produce the next token. ">yaml_parser_scan()</a> with the calls of <a class="el" href="../../dd/da8/group__parser.html#gaa90105acba29cbf17b287e5c41c48dde" title="Parse the input stream and produce the next parsing event. ">yaml_parser_parse()</a> or <a class="el" href="../../dd/da8/group__parser.html#gafe5381d911f9dab9683dd27676f50336" title="Parse the input stream and produce the next YAML document. ">yaml_parser_load()</a>. Doing this will break the parser.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in,out]</td><td class="paramname">parser</td><td>A parser object. </td></tr> <tr><td class="paramdir">[out]</td><td class="paramname">token</td><td>An empty token object.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> <p class="definition">Definition at line <a class="el" href="../../d7/dce/scanner_8c_source.html#l00742">742</a> of file <a class="el" href="../../d7/dce/scanner_8c_source.html">scanner.c</a>.</p> <p class="reference">References <a class="el" href="../../d5/dac/ossl_8h_source.html#l00045">assert</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00484">DEQUEUE</a>, <a class="el" href="../../d5/d11/ripper_8c_source.html#l16487">token</a>, <a class="el" href="../../d7/dce/scanner_8c_source.html#l00800">yaml_parser_fetch_more_tokens()</a>, and <a class="el" href="../../dc/dfe/yaml_8h_source.html#l00220">YAML_STREAM_END_TOKEN</a>.</p> </div> </div> <a id="ga6e3eabd71c844814ab7d4e9807c69cd8"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga6e3eabd71c844814ab7d4e9807c69cd8">◆ </a></span>yaml_parser_set_encoding()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">yaml_parser_set_encoding </td> <td>(</td> <td class="paramtype"><a class="el" href="../../dd/da8/group__parser.html#gafdc6319cb28a8b8034542b29be85b0c4">yaml_parser_t</a> * </td> <td class="paramname"><em>parser</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="../../d0/df6/group__basic.html#ga2170996d7e636397b5e6bc0c1b7df7c6">yaml_encoding_t</a> </td> <td class="paramname"><em>encoding</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Set the source encoding. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in,out]</td><td class="paramname">parser</td><td>A parser object. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">encoding</td><td>The source encoding. </td></tr> </table> </dd> </dl> <p class="definition">Definition at line <a class="el" href="../../d3/de3/api_8c_source.html#l00336">336</a> of file <a class="el" href="../../d3/de3/api_8c_source.html">api.c</a>.</p> <p class="reference">References <a class="el" href="../../d5/dac/ossl_8h_source.html#l00045">assert</a>.</p> <p class="reference">Referenced by <a class="el" href="../../d4/d54/psych__parser_8c_source.html#l00229">parse()</a>.</p> </div> </div> <a id="ga9af477fa1721acb21a42f3341c45e6cf"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga9af477fa1721acb21a42f3341c45e6cf">◆ </a></span>yaml_parser_set_input()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">yaml_parser_set_input </td> <td>(</td> <td class="paramtype"><a class="el" href="../../dd/da8/group__parser.html#gafdc6319cb28a8b8034542b29be85b0c4">yaml_parser_t</a> * </td> <td class="paramname"><em>parser</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="../../dd/da8/group__parser.html#ga4982f7e4e001ddb47d2819f38f0cd9d6">yaml_read_handler_t</a> * </td> <td class="paramname"><em>handler</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">void * </td> <td class="paramname"><em>data</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Set a generic input handler. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in,out]</td><td class="paramname">parser</td><td>A parser object. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">handler</td><td>A read handler. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Any application data for passing to the read handler. </td></tr> </table> </dd> </dl> <p class="definition">Definition at line <a class="el" href="../../d3/de3/api_8c_source.html#l00320">320</a> of file <a class="el" href="../../d3/de3/api_8c_source.html">api.c</a>.</p> <p class="reference">References <a class="el" href="../../d5/dac/ossl_8h_source.html#l00045">assert</a>.</p> <p class="reference">Referenced by <a class="el" href="../../d4/d54/psych__parser_8c_source.html#l00229">parse()</a>.</p> </div> </div> <a id="ga389b2d0c663922e5a4db8eb94aede8f5"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga389b2d0c663922e5a4db8eb94aede8f5">◆ </a></span>yaml_parser_set_input_file()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">yaml_parser_set_input_file </td> <td>(</td> <td class="paramtype"><a class="el" href="../../dd/da8/group__parser.html#gafdc6319cb28a8b8034542b29be85b0c4">yaml_parser_t</a> * </td> <td class="paramname"><em>parser</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="../../da/d50/vsnprintf_8c.html#a95742987b07c3bc61a7f376b0168410b">FILE</a> * </td> <td class="paramname"><em>file</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Set a file input. </p> <p><em>file</em> should be a file object open for reading. The application is responsible for closing the <em>file</em>.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in,out]</td><td class="paramname">parser</td><td>A parser object. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>An open file. </td></tr> </table> </dd> </dl> <p class="definition">Definition at line <a class="el" href="../../d3/de3/api_8c_source.html#l00303">303</a> of file <a class="el" href="../../d3/de3/api_8c_source.html">api.c</a>.</p> <p class="reference">References <a class="el" href="../../d5/dac/ossl_8h_source.html#l00045">assert</a>, and <a class="el" href="../../d3/de3/api_8c_source.html#l00269">yaml_file_read_handler()</a>.</p> </div> </div> <a id="gae75f4fb47ba2e8d480d59a43849dcfa5"></a> <h2 class="memtitle"><span class="permalink"><a href="#gae75f4fb47ba2e8d480d59a43849dcfa5">◆ </a></span>yaml_parser_set_input_string()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">yaml_parser_set_input_string </td> <td>(</td> <td class="paramtype"><a class="el" href="../../dd/da8/group__parser.html#gafdc6319cb28a8b8034542b29be85b0c4">yaml_parser_t</a> * </td> <td class="paramname"><em>parser</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="../../da/d50/vsnprintf_8c.html#a2c212835823e3c54a8ab6d95c652660e">const</a> unsigned char * </td> <td class="paramname"><em>input</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">size_t </td> <td class="paramname"><em>size</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Set a string input. </p> <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> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in,out]</td><td class="paramname">parser</td><td>A parser object. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>A source data. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The length of the source data in bytes. </td></tr> </table> </dd> </dl> <p class="definition">Definition at line <a class="el" href="../../d3/de3/api_8c_source.html#l00283">283</a> of file <a class="el" href="../../d3/de3/api_8c_source.html">api.c</a>.</p> <p class="reference">References <a class="el" href="../../d5/dac/ossl_8h_source.html#l00045">assert</a>, <a class="el" href="../../d6/da0/nkf-utf8_2nkf_8c_source.html#l04311">input</a>, <a class="el" href="../../d5/db5/encoding_8c_source.html#l00052">size</a>, and <a class="el" href="../../d3/de3/api_8c_source.html#l00243">yaml_string_read_handler()</a>.</p> <p class="reference">Referenced by <a class="el" href="../../d4/d54/psych__parser_8c_source.html#l00229">parse()</a>.</p> </div> </div> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="../../doxygen.png" alt="doxygen"/> </a> 1.8.14 </small></address> </body> </html>
💾 Save Changes
❌ Cancel