<!-- HTML header for doxygen 1.8.7--> <!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"/> <title>RapidJSON: rapidjson::GenericReader< SourceEncoding, TargetEncoding, StackAllocator > 模板类 参考</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="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtreedata.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> $(document).ready(initResizable); </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> <script type="text/javascript"> $(document).ready(function() { init_search(); }); </script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> <link href="doxygenextra.css" rel="stylesheet" type="text/css"/> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="topbanner"><a href="https://github.com/miloyip/rapidjson" title="RapidJSON GitHub"><i class="githublogo"></i></a></div> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="搜索" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> <!-- end header part --> <!-- 制作者 Doxygen 1.8.13 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'搜索'); </script> </div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> <div id="nav-sync" class="sync"></div> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> $(document).ready(function(){initNavTree('classrapidjson_1_1_generic_reader.html','');}); </script> <div id="doc-content"> <!-- 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 class="header"> <div class="summary"> <a href="#nested-classes">类</a> | <a href="#pub-types">Public 类型</a> | <a href="#pub-methods">Public 成员函数</a> | <a href="#pro-methods">Protected 成员函数</a> | <a href="classrapidjson_1_1_generic_reader-members.html">所有成员列表</a> </div> <div class="headertitle"> <div class="title">rapidjson::GenericReader< SourceEncoding, TargetEncoding, StackAllocator > 模板类 参考</div> </div> </div><!--header--> <div class="contents"> <p>SAX-style JSON parser. Use <a class="el" href="md_doc_sax_8zh-cn.html#Reader">Reader</a> for <a class="el" href="structrapidjson_1_1_u_t_f8.html" title="UTF-8 encoding. ">UTF8</a> encoding and default allocator. <a href="classrapidjson_1_1_generic_reader.html#details">更多...</a></p> <p><code>#include <<a class="el" href="reader_8h_source.html">reader.h</a>></code></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> Public 类型</h2></td></tr> <tr class="memitem:a0781d19e8c6bc044d9cc5f5d3dde287e"><td class="memItemLeft" align="right" valign="top"><a id="a0781d19e8c6bc044d9cc5f5d3dde287e"></a> typedef SourceEncoding::Ch </td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidjson_1_1_generic_reader.html#a0781d19e8c6bc044d9cc5f5d3dde287e">Ch</a></td></tr> <tr class="memdesc:a0781d19e8c6bc044d9cc5f5d3dde287e"><td class="mdescLeft"> </td><td class="mdescRight">SourceEncoding character type <br /></td></tr> <tr class="separator:a0781d19e8c6bc044d9cc5f5d3dde287e"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public 成员函数</h2></td></tr> <tr class="memitem:a56ab1065ea75167aeacb4802425bf57f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidjson_1_1_generic_reader.html#a56ab1065ea75167aeacb4802425bf57f">GenericReader</a> (StackAllocator *stackAllocator=0, size_t stackCapacity=kDefaultStackCapacity)</td></tr> <tr class="memdesc:a56ab1065ea75167aeacb4802425bf57f"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a56ab1065ea75167aeacb4802425bf57f">更多...</a><br /></td></tr> <tr class="separator:a56ab1065ea75167aeacb4802425bf57f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac9c540b77de19661f6f45e04b9b0937b"><td class="memTemplParams" colspan="2">template<unsigned parseFlags, typename InputStream , typename Handler > </td></tr> <tr class="memitem:ac9c540b77de19661f6f45e04b9b0937b"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="group___r_a_p_i_d_j_s_o_n___e_r_r_o_r_s.html#structrapidjson_1_1_parse_result">ParseResult</a> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classrapidjson_1_1_generic_reader.html#ac9c540b77de19661f6f45e04b9b0937b">Parse</a> (InputStream &is, <a class="el" href="classrapidjson_1_1_handler.html">Handler</a> &handler)</td></tr> <tr class="memdesc:ac9c540b77de19661f6f45e04b9b0937b"><td class="mdescLeft"> </td><td class="mdescRight">Parse JSON text. <a href="#ac9c540b77de19661f6f45e04b9b0937b">更多...</a><br /></td></tr> <tr class="separator:ac9c540b77de19661f6f45e04b9b0937b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2bac14d193873d661d79ad000473a908"><td class="memTemplParams" colspan="2">template<typename InputStream , typename Handler > </td></tr> <tr class="memitem:a2bac14d193873d661d79ad000473a908"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="group___r_a_p_i_d_j_s_o_n___e_r_r_o_r_s.html#structrapidjson_1_1_parse_result">ParseResult</a> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classrapidjson_1_1_generic_reader.html#a2bac14d193873d661d79ad000473a908">Parse</a> (InputStream &is, <a class="el" href="classrapidjson_1_1_handler.html">Handler</a> &handler)</td></tr> <tr class="memdesc:a2bac14d193873d661d79ad000473a908"><td class="mdescLeft"> </td><td class="mdescRight">Parse JSON text (with <a class="el" href="namespacerapidjson.html#a81379eb4e94a0386d71d15fda882ebc9a5640cb00db7814b7f22be3683dda9835">kParseDefaultFlags</a>) <a href="#a2bac14d193873d661d79ad000473a908">更多...</a><br /></td></tr> <tr class="separator:a2bac14d193873d661d79ad000473a908"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac42370c3497a0e2b6973110f298e3a59"><td class="memItemLeft" align="right" valign="top"><a id="ac42370c3497a0e2b6973110f298e3a59"></a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidjson_1_1_generic_reader.html#ac42370c3497a0e2b6973110f298e3a59">HasParseError</a> () const</td></tr> <tr class="memdesc:ac42370c3497a0e2b6973110f298e3a59"><td class="mdescLeft"> </td><td class="mdescRight">Whether a parse error has occured in the last parsing. <br /></td></tr> <tr class="separator:ac42370c3497a0e2b6973110f298e3a59"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a042c621cf745c5ed3a6f5ff9418dd05e"><td class="memItemLeft" align="right" valign="top"><a id="a042c621cf745c5ed3a6f5ff9418dd05e"></a> <a class="el" href="group___r_a_p_i_d_j_s_o_n___e_r_r_o_r_s.html#ga7d3acf640886b1f2552dc8c4cd6dea60">ParseErrorCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidjson_1_1_generic_reader.html#a042c621cf745c5ed3a6f5ff9418dd05e">GetParseErrorCode</a> () const</td></tr> <tr class="memdesc:a042c621cf745c5ed3a6f5ff9418dd05e"><td class="mdescLeft"> </td><td class="mdescRight">Get the <a class="el" href="group___r_a_p_i_d_j_s_o_n___e_r_r_o_r_s.html#ga7d3acf640886b1f2552dc8c4cd6dea60">ParseErrorCode</a> of last parsing. <br /></td></tr> <tr class="separator:a042c621cf745c5ed3a6f5ff9418dd05e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab50019e0a715320f83b7610b83dcef8f"><td class="memItemLeft" align="right" valign="top"><a id="ab50019e0a715320f83b7610b83dcef8f"></a> size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidjson_1_1_generic_reader.html#ab50019e0a715320f83b7610b83dcef8f">GetErrorOffset</a> () const</td></tr> <tr class="memdesc:ab50019e0a715320f83b7610b83dcef8f"><td class="mdescLeft"> </td><td class="mdescRight">Get the position of last parsing error in input, 0 otherwise. <br /></td></tr> <tr class="separator:ab50019e0a715320f83b7610b83dcef8f"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a> Protected 成员函数</h2></td></tr> <tr class="memitem:a544704abdce535d93ae0f45d0cf0bc0d"><td class="memItemLeft" align="right" valign="top"><a id="a544704abdce535d93ae0f45d0cf0bc0d"></a> void </td><td class="memItemRight" valign="bottom"><b>SetParseError</b> (<a class="el" href="group___r_a_p_i_d_j_s_o_n___e_r_r_o_r_s.html#ga7d3acf640886b1f2552dc8c4cd6dea60">ParseErrorCode</a> code, size_t offset)</td></tr> <tr class="separator:a544704abdce535d93ae0f45d0cf0bc0d"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">详细描述</h2> <div class="textblock"><h3>template<typename SourceEncoding, typename TargetEncoding, typename StackAllocator = CrtAllocator><br /> class rapidjson::GenericReader< SourceEncoding, TargetEncoding, StackAllocator ></h3> <p>SAX-style JSON parser. Use <a class="el" href="md_doc_sax_8zh-cn.html#Reader">Reader</a> for <a class="el" href="structrapidjson_1_1_u_t_f8.html" title="UTF-8 encoding. ">UTF8</a> encoding and default allocator. </p> <p><a class="el" href="classrapidjson_1_1_generic_reader.html" title="SAX-style JSON parser. Use Reader for UTF8 encoding and default allocator. ">GenericReader</a> parses JSON text from a stream, and send events synchronously to an object implementing <a class="el" href="classrapidjson_1_1_handler.html" title="Concept for receiving events from GenericReader upon parsing. The functions return true if no error o...">Handler</a> concept.</p> <p>It needs to allocate a stack for storing a single decoded string during non-destructive parsing.</p> <p>For in-situ parsing, the decoded string is directly written to the source text string, no temporary buffer is required.</p> <p>A <a class="el" href="classrapidjson_1_1_generic_reader.html" title="SAX-style JSON parser. Use Reader for UTF8 encoding and default allocator. ">GenericReader</a> object can be reused for parsing multiple JSON text.</p> <dl class="tparams"><dt>模板参数</dt><dd> <table class="tparams"> <tr><td class="paramname">SourceEncoding</td><td><a class="el" href="classrapidjson_1_1_encoding.html" title="Concept for encoding of Unicode characters. ">Encoding</a> of the input stream. </td></tr> <tr><td class="paramname">TargetEncoding</td><td><a class="el" href="classrapidjson_1_1_encoding.html" title="Concept for encoding of Unicode characters. ">Encoding</a> of the parse output. </td></tr> <tr><td class="paramname">StackAllocator</td><td><a class="el" href="classrapidjson_1_1_allocator.html" title="Concept for allocating, resizing and freeing memory block. ">Allocator</a> type for stack. </td></tr> </table> </dd> </dl> </div><h2 class="groupheader">构造及析构函数说明</h2> <a id="a56ab1065ea75167aeacb4802425bf57f"></a> <h2 class="memtitle"><span class="permalink"><a href="#a56ab1065ea75167aeacb4802425bf57f">◆ </a></span>GenericReader()</h2> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename SourceEncoding, typename TargetEncoding, typename StackAllocator = CrtAllocator> </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classrapidjson_1_1_generic_reader.html">rapidjson::GenericReader</a>< SourceEncoding, TargetEncoding, StackAllocator >::<a class="el" href="classrapidjson_1_1_generic_reader.html">GenericReader</a> </td> <td>(</td> <td class="paramtype">StackAllocator * </td> <td class="paramname"><em>stackAllocator</em> = <code>0</code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">size_t </td> <td class="paramname"><em>stackCapacity</em> = <code>kDefaultStackCapacity</code> </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>Constructor. </p> <dl class="params"><dt>参数</dt><dd> <table class="params"> <tr><td class="paramname">stackAllocator</td><td>Optional allocator for allocating stack memory. (Only use for non-destructive parsing) </td></tr> <tr><td class="paramname">stackCapacity</td><td>stack capacity in bytes for storing a single decoded string. (Only use for non-destructive parsing) </td></tr> </table> </dd> </dl> </div> </div> <h2 class="groupheader">成员函数说明</h2> <a id="ac9c540b77de19661f6f45e04b9b0937b"></a> <h2 class="memtitle"><span class="permalink"><a href="#ac9c540b77de19661f6f45e04b9b0937b">◆ </a></span>Parse() <span class="overload">[1/2]</span></h2> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename SourceEncoding, typename TargetEncoding, typename StackAllocator = CrtAllocator> </div> <div class="memtemplate"> template<unsigned parseFlags, typename InputStream , typename Handler > </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group___r_a_p_i_d_j_s_o_n___e_r_r_o_r_s.html#structrapidjson_1_1_parse_result">ParseResult</a> <a class="el" href="classrapidjson_1_1_generic_reader.html">rapidjson::GenericReader</a>< SourceEncoding, TargetEncoding, StackAllocator >::Parse </td> <td>(</td> <td class="paramtype">InputStream & </td> <td class="paramname"><em>is</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classrapidjson_1_1_handler.html">Handler</a> & </td> <td class="paramname"><em>handler</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>Parse JSON text. </p> <dl class="tparams"><dt>模板参数</dt><dd> <table class="tparams"> <tr><td class="paramname">parseFlags</td><td>Combination of <a class="el" href="namespacerapidjson.html#a81379eb4e94a0386d71d15fda882ebc9">ParseFlag</a>. </td></tr> <tr><td class="paramname">InputStream</td><td>Type of input stream, implementing <a class="el" href="classrapidjson_1_1_stream.html" title="Concept for reading and writing characters. ">Stream</a> concept. </td></tr> <tr><td class="paramname"><a class="el" href="classrapidjson_1_1_handler.html" title="Concept for receiving events from GenericReader upon parsing. The functions return true if no error o...">Handler</a></td><td>Type of handler, implementing <a class="el" href="classrapidjson_1_1_handler.html" title="Concept for receiving events from GenericReader upon parsing. The functions return true if no error o...">Handler</a> concept. </td></tr> </table> </dd> </dl> <dl class="params"><dt>参数</dt><dd> <table class="params"> <tr><td class="paramname">is</td><td>Input stream to be parsed. </td></tr> <tr><td class="paramname">handler</td><td>The handler to receive events. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>返回</dt><dd>Whether the parsing is successful. </dd></dl> </div> </div> <a id="a2bac14d193873d661d79ad000473a908"></a> <h2 class="memtitle"><span class="permalink"><a href="#a2bac14d193873d661d79ad000473a908">◆ </a></span>Parse() <span class="overload">[2/2]</span></h2> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename SourceEncoding, typename TargetEncoding, typename StackAllocator = CrtAllocator> </div> <div class="memtemplate"> template<typename InputStream , typename Handler > </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group___r_a_p_i_d_j_s_o_n___e_r_r_o_r_s.html#structrapidjson_1_1_parse_result">ParseResult</a> <a class="el" href="classrapidjson_1_1_generic_reader.html">rapidjson::GenericReader</a>< SourceEncoding, TargetEncoding, StackAllocator >::Parse </td> <td>(</td> <td class="paramtype">InputStream & </td> <td class="paramname"><em>is</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classrapidjson_1_1_handler.html">Handler</a> & </td> <td class="paramname"><em>handler</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>Parse JSON text (with <a class="el" href="namespacerapidjson.html#a81379eb4e94a0386d71d15fda882ebc9a5640cb00db7814b7f22be3683dda9835">kParseDefaultFlags</a>) </p> <dl class="tparams"><dt>模板参数</dt><dd> <table class="tparams"> <tr><td class="paramname">InputStream</td><td>Type of input stream, implementing <a class="el" href="classrapidjson_1_1_stream.html" title="Concept for reading and writing characters. ">Stream</a> concept </td></tr> <tr><td class="paramname"><a class="el" href="classrapidjson_1_1_handler.html" title="Concept for receiving events from GenericReader upon parsing. The functions return true if no error o...">Handler</a></td><td>Type of handler, implementing <a class="el" href="classrapidjson_1_1_handler.html" title="Concept for receiving events from GenericReader upon parsing. The functions return true if no error o...">Handler</a> concept. </td></tr> </table> </dd> </dl> <dl class="params"><dt>参数</dt><dd> <table class="params"> <tr><td class="paramname">is</td><td>Input stream to be parsed. </td></tr> <tr><td class="paramname">handler</td><td>The handler to receive events. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>返回</dt><dd>Whether the parsing is successful. </dd></dl> </div> </div> <hr/>该类的文档由以下文件生成:<ul> <li>include/rapidjson/<a class="el" href="fwd_8h_source.html">fwd.h</a></li> <li>include/rapidjson/<a class="el" href="reader_8h_source.html">reader.h</a></li> </ul> </div><!-- contents --> </div><!-- doc-content --> <!-- HTML footer for doxygen 1.8.7--> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="namespacerapidjson.html">rapidjson</a></li><li class="navelem"><a class="el" href="classrapidjson_1_1_generic_reader.html">GenericReader</a></li> </ul> </div> </body> </html>