<!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.13"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>Orcus: yaml_parser_handler Class Reference</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="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/searchdata.js"></script> <script type="text/javascript" src="search/search.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">Orcus </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.13 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> $(function() { initMenu('',true,false,'search.php','Search'); $(document).ready(function() { init_search(); }); }); </script> <div id="main-nav"></div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> </div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="classyaml__parser__handler-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">yaml_parser_handler Class Reference</div> </div> </div><!--header--> <div class="contents"> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:aec69f4405b4c5adaff4629f9953cb6da"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classyaml__parser__handler.html#aec69f4405b4c5adaff4629f9953cb6da">begin_parse</a> ()</td></tr> <tr class="separator:aec69f4405b4c5adaff4629f9953cb6da"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a967a055a4612ce8f2f9b258955e8e105"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classyaml__parser__handler.html#a967a055a4612ce8f2f9b258955e8e105">end_parse</a> ()</td></tr> <tr class="separator:a967a055a4612ce8f2f9b258955e8e105"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a30e8c89fb6afc53942133f3c15c4a290"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classyaml__parser__handler.html#a30e8c89fb6afc53942133f3c15c4a290">begin_document</a> ()</td></tr> <tr class="separator:a30e8c89fb6afc53942133f3c15c4a290"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af71964d690477998cbe9bbbfa7c96d6c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classyaml__parser__handler.html#af71964d690477998cbe9bbbfa7c96d6c">end_document</a> ()</td></tr> <tr class="separator:af71964d690477998cbe9bbbfa7c96d6c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2ba297d77e4b4f7f3e53db28f8e93957"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classyaml__parser__handler.html#a2ba297d77e4b4f7f3e53db28f8e93957">begin_sequence</a> ()</td></tr> <tr class="separator:a2ba297d77e4b4f7f3e53db28f8e93957"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a983438539a8825df29208b459289c81c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classyaml__parser__handler.html#a983438539a8825df29208b459289c81c">end_sequence</a> ()</td></tr> <tr class="separator:a983438539a8825df29208b459289c81c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a57ff21bf29ab2a029ca2fe521304fccf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classyaml__parser__handler.html#a57ff21bf29ab2a029ca2fe521304fccf">begin_map</a> ()</td></tr> <tr class="separator:a57ff21bf29ab2a029ca2fe521304fccf"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a347d86d0f8f89fae0b12b13ce1766c29"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classyaml__parser__handler.html#a347d86d0f8f89fae0b12b13ce1766c29">begin_map_key</a> ()</td></tr> <tr class="separator:a347d86d0f8f89fae0b12b13ce1766c29"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a968c9f663469dde0f774dff925f06f9c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classyaml__parser__handler.html#a968c9f663469dde0f774dff925f06f9c">end_map_key</a> ()</td></tr> <tr class="separator:a968c9f663469dde0f774dff925f06f9c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aec3d1998dbbc1b2ce4eb7c53ccd7fac9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classyaml__parser__handler.html#aec3d1998dbbc1b2ce4eb7c53ccd7fac9">end_map</a> ()</td></tr> <tr class="separator:aec3d1998dbbc1b2ce4eb7c53ccd7fac9"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a31d4e794fb4f94b563e8bd7a9a6d3e2b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classyaml__parser__handler.html#a31d4e794fb4f94b563e8bd7a9a6d3e2b">string</a> (const char *p, size_t n)</td></tr> <tr class="separator:a31d4e794fb4f94b563e8bd7a9a6d3e2b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a4ff6147bfb4079ef123d0a31ccb2b62c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classyaml__parser__handler.html#a4ff6147bfb4079ef123d0a31ccb2b62c">number</a> (double val)</td></tr> <tr class="separator:a4ff6147bfb4079ef123d0a31ccb2b62c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a0d1c6fe87c0c06217fed47d1bfaa1888"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classyaml__parser__handler.html#a0d1c6fe87c0c06217fed47d1bfaa1888">boolean_true</a> ()</td></tr> <tr class="separator:a0d1c6fe87c0c06217fed47d1bfaa1888"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af9e9a15a965cd47c5d869c002cc53b9a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classyaml__parser__handler.html#af9e9a15a965cd47c5d869c002cc53b9a">boolean_false</a> ()</td></tr> <tr class="separator:af9e9a15a965cd47c5d869c002cc53b9a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a34d85dc8b3c68139294070819ddca48b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classyaml__parser__handler.html#a34d85dc8b3c68139294070819ddca48b">null</a> ()</td></tr> <tr class="separator:a34d85dc8b3c68139294070819ddca48b"><td class="memSeparator" colspan="2"> </td></tr> </table> <h2 class="groupheader">Member Function Documentation</h2> <a id="a30e8c89fb6afc53942133f3c15c4a290"></a> <h2 class="memtitle"><span class="permalink"><a href="#a30e8c89fb6afc53942133f3c15c4a290">◆ </a></span>begin_document()</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void yaml_parser_handler::begin_document </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Called when a new document is encountered. </p> </div> </div> <a id="a57ff21bf29ab2a029ca2fe521304fccf"></a> <h2 class="memtitle"><span class="permalink"><a href="#a57ff21bf29ab2a029ca2fe521304fccf">◆ </a></span>begin_map()</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void yaml_parser_handler::begin_map </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Called when a map begins. </p> </div> </div> <a id="a347d86d0f8f89fae0b12b13ce1766c29"></a> <h2 class="memtitle"><span class="permalink"><a href="#a347d86d0f8f89fae0b12b13ce1766c29">◆ </a></span>begin_map_key()</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void yaml_parser_handler::begin_map_key </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Called when the parser starts parsing a map key. </p> </div> </div> <a id="aec69f4405b4c5adaff4629f9953cb6da"></a> <h2 class="memtitle"><span class="permalink"><a href="#aec69f4405b4c5adaff4629f9953cb6da">◆ </a></span>begin_parse()</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void yaml_parser_handler::begin_parse </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Called when the parser starts parsing a content. </p> </div> </div> <a id="a2ba297d77e4b4f7f3e53db28f8e93957"></a> <h2 class="memtitle"><span class="permalink"><a href="#a2ba297d77e4b4f7f3e53db28f8e93957">◆ </a></span>begin_sequence()</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void yaml_parser_handler::begin_sequence </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Called when a sequence begins. </p> </div> </div> <a id="af9e9a15a965cd47c5d869c002cc53b9a"></a> <h2 class="memtitle"><span class="permalink"><a href="#af9e9a15a965cd47c5d869c002cc53b9a">◆ </a></span>boolean_false()</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void yaml_parser_handler::boolean_false </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Called when a boolean 'false' keyword is encountered. </p> </div> </div> <a id="a0d1c6fe87c0c06217fed47d1bfaa1888"></a> <h2 class="memtitle"><span class="permalink"><a href="#a0d1c6fe87c0c06217fed47d1bfaa1888">◆ </a></span>boolean_true()</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void yaml_parser_handler::boolean_true </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Called when a boolean 'true' keyword is encountered. </p> </div> </div> <a id="af71964d690477998cbe9bbbfa7c96d6c"></a> <h2 class="memtitle"><span class="permalink"><a href="#af71964d690477998cbe9bbbfa7c96d6c">◆ </a></span>end_document()</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void yaml_parser_handler::end_document </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Called when the parser has finished parsing a document. </p> </div> </div> <a id="aec3d1998dbbc1b2ce4eb7c53ccd7fac9"></a> <h2 class="memtitle"><span class="permalink"><a href="#aec3d1998dbbc1b2ce4eb7c53ccd7fac9">◆ </a></span>end_map()</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void yaml_parser_handler::end_map </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Called when the parser finishes parsing an entire map. </p> </div> </div> <a id="a968c9f663469dde0f774dff925f06f9c"></a> <h2 class="memtitle"><span class="permalink"><a href="#a968c9f663469dde0f774dff925f06f9c">◆ </a></span>end_map_key()</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void yaml_parser_handler::end_map_key </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Called when the parser finishes parsing a map key. </p> </div> </div> <a id="a967a055a4612ce8f2f9b258955e8e105"></a> <h2 class="memtitle"><span class="permalink"><a href="#a967a055a4612ce8f2f9b258955e8e105">◆ </a></span>end_parse()</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void yaml_parser_handler::end_parse </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Called when the parser finishes parsing an entire content. </p> </div> </div> <a id="a983438539a8825df29208b459289c81c"></a> <h2 class="memtitle"><span class="permalink"><a href="#a983438539a8825df29208b459289c81c">◆ </a></span>end_sequence()</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void yaml_parser_handler::end_sequence </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Called when a sequence ends. </p> </div> </div> <a id="a34d85dc8b3c68139294070819ddca48b"></a> <h2 class="memtitle"><span class="permalink"><a href="#a34d85dc8b3c68139294070819ddca48b">◆ </a></span>null()</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void yaml_parser_handler::null </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Called when a 'null' keyword is encountered. </p> </div> </div> <a id="a4ff6147bfb4079ef123d0a31ccb2b62c"></a> <h2 class="memtitle"><span class="permalink"><a href="#a4ff6147bfb4079ef123d0a31ccb2b62c">◆ </a></span>number()</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void yaml_parser_handler::number </td> <td>(</td> <td class="paramtype">double </td> <td class="paramname"><em>val</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Called when a numeric value is encountered.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">val</td><td>numeric value. </td></tr> </table> </dd> </dl> </div> </div> <a id="a31d4e794fb4f94b563e8bd7a9a6d3e2b"></a> <h2 class="memtitle"><span class="permalink"><a href="#a31d4e794fb4f94b563e8bd7a9a6d3e2b">◆ </a></span>string()</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void yaml_parser_handler::string </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>p</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">size_t </td> <td class="paramname"><em>n</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Called when a string value is encountered.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">p</td><td>pointer to the first character of the string value. </td></tr> <tr><td class="paramname">len</td><td>length of the string value. </td></tr> </table> </dd> </dl> </div> </div> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Sat Feb 9 2019 16:54:03 for Orcus by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.13 </small></address> </body> </html>