renderd7/classnlohmann_1_1detail_1_1parser.html
2022-04-13 18:07:13 +00:00

220 lines
12 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Renderd7-nightly: nlohmann::detail::parser&lt; BasicJsonType, InputAdapterType &gt; Class Template 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="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>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="docsn.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">Renderd7-nightly
&#160;<span id="projectnumber">v0.7.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
</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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classnlohmann_1_1detail_1_1parser.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classnlohmann_1_1detail_1_1parser-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">nlohmann::detail::parser&lt; BasicJsonType, InputAdapterType &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>syntax analysis
<a href="classnlohmann_1_1detail_1_1parser.html#details">More...</a></p>
<p><code>#include &lt;json.hpp&gt;</code></p>
<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:a33b852bf63cba58310d9c0d1242cfb12"><td class="memItemLeft" align="right" valign="top"><a id="a33b852bf63cba58310d9c0d1242cfb12"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1detail_1_1parser.html#a33b852bf63cba58310d9c0d1242cfb12">parser</a> (InputAdapterType &amp;&amp;adapter, const parser_callback_t&lt; BasicJsonType &gt; cb=nullptr, const bool allow_exceptions_=true, const bool skip_comments=false)</td></tr>
<tr class="memdesc:a33b852bf63cba58310d9c0d1242cfb12"><td class="mdescLeft">&#160;</td><td class="mdescRight">a parser reading from an input adapter <br /></td></tr>
<tr class="separator:a33b852bf63cba58310d9c0d1242cfb12"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a75fb9145ea85f1ad9cc14f61981e1111"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1detail_1_1parser.html#a75fb9145ea85f1ad9cc14f61981e1111">parse</a> (const bool strict, BasicJsonType &amp;result)</td></tr>
<tr class="memdesc:a75fb9145ea85f1ad9cc14f61981e1111"><td class="mdescLeft">&#160;</td><td class="mdescRight">public parser interface <a href="classnlohmann_1_1detail_1_1parser.html#a75fb9145ea85f1ad9cc14f61981e1111">More...</a><br /></td></tr>
<tr class="separator:a75fb9145ea85f1ad9cc14f61981e1111"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a39784a586867c05388cb0adca0fd72b5"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1detail_1_1parser.html#a39784a586867c05388cb0adca0fd72b5">accept</a> (const bool strict=true)</td></tr>
<tr class="memdesc:a39784a586867c05388cb0adca0fd72b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">public accept interface <a href="classnlohmann_1_1detail_1_1parser.html#a39784a586867c05388cb0adca0fd72b5">More...</a><br /></td></tr>
<tr class="separator:a39784a586867c05388cb0adca0fd72b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:a1212088ee1e23633a76b2ed80514de79"><td class="memItemLeft" align="right" valign="top"><a id="a1212088ee1e23633a76b2ed80514de79"></a>
token_type&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1detail_1_1parser.html#a1212088ee1e23633a76b2ed80514de79">get_token</a> ()</td></tr>
<tr class="memdesc:a1212088ee1e23633a76b2ed80514de79"><td class="mdescLeft">&#160;</td><td class="mdescRight">get next token from lexer <br /></td></tr>
<tr class="separator:a1212088ee1e23633a76b2ed80514de79"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a6bf70a72a1632ef55c0068557b1be37a"><td class="memItemLeft" align="right" valign="top"><a id="a6bf70a72a1632ef55c0068557b1be37a"></a>
const parser_callback_t&lt; BasicJsonType &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1detail_1_1parser.html#a6bf70a72a1632ef55c0068557b1be37a">callback</a> = nullptr</td></tr>
<tr class="memdesc:a6bf70a72a1632ef55c0068557b1be37a"><td class="mdescLeft">&#160;</td><td class="mdescRight">callback function <br /></td></tr>
<tr class="separator:a6bf70a72a1632ef55c0068557b1be37a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a307ed42d5f31a9c5bec991ceee87b0e7"><td class="memItemLeft" align="right" valign="top"><a id="a307ed42d5f31a9c5bec991ceee87b0e7"></a>
token_type&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1detail_1_1parser.html#a307ed42d5f31a9c5bec991ceee87b0e7">last_token</a> = token_type::uninitialized</td></tr>
<tr class="memdesc:a307ed42d5f31a9c5bec991ceee87b0e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">the type of the last read token <br /></td></tr>
<tr class="separator:a307ed42d5f31a9c5bec991ceee87b0e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a01a73810f794c239aaf123aa2af7371d"><td class="memItemLeft" align="right" valign="top"><a id="a01a73810f794c239aaf123aa2af7371d"></a>
lexer_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1detail_1_1parser.html#a01a73810f794c239aaf123aa2af7371d">m_lexer</a></td></tr>
<tr class="memdesc:a01a73810f794c239aaf123aa2af7371d"><td class="mdescLeft">&#160;</td><td class="mdescRight">the lexer <br /></td></tr>
<tr class="separator:a01a73810f794c239aaf123aa2af7371d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab0dbaeaa6df00631072f902068c57750"><td class="memItemLeft" align="right" valign="top"><a id="ab0dbaeaa6df00631072f902068c57750"></a>
const bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1detail_1_1parser.html#ab0dbaeaa6df00631072f902068c57750">allow_exceptions</a> = true</td></tr>
<tr class="memdesc:ab0dbaeaa6df00631072f902068c57750"><td class="mdescLeft">&#160;</td><td class="mdescRight">whether to throw exceptions in case of errors <br /></td></tr>
<tr class="separator:ab0dbaeaa6df00631072f902068c57750"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename BasicJsonType, typename InputAdapterType&gt;<br />
class nlohmann::detail::parser&lt; BasicJsonType, InputAdapterType &gt;</h3>
<p>syntax analysis </p>
<p>This class implements a recursive descent parser. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a75fb9145ea85f1ad9cc14f61981e1111"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a75fb9145ea85f1ad9cc14f61981e1111">&#9670;&nbsp;</a></span>parse()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename BasicJsonType , typename InputAdapterType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classnlohmann_1_1detail_1_1parser.html">nlohmann::detail::parser</a>&lt; BasicJsonType, InputAdapterType &gt;::parse </td>
<td>(</td>
<td class="paramtype">const bool&#160;</td>
<td class="paramname"><em>strict</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">BasicJsonType &amp;&#160;</td>
<td class="paramname"><em>result</em>&#160;</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>public parser interface </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">strict</td><td>whether to expect the last token to be EOF </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">result</td><td>parsed JSON value</td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">parse_error.101</td><td>in case of an unexpected token </td></tr>
<tr><td class="paramname">parse_error.102</td><td>if to_unicode fails or surrogate error </td></tr>
<tr><td class="paramname">parse_error.103</td><td>if to_unicode fails </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a39784a586867c05388cb0adca0fd72b5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a39784a586867c05388cb0adca0fd72b5">&#9670;&nbsp;</a></span>accept()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename BasicJsonType , typename InputAdapterType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classnlohmann_1_1detail_1_1parser.html">nlohmann::detail::parser</a>&lt; BasicJsonType, InputAdapterType &gt;::accept </td>
<td>(</td>
<td class="paramtype">const bool&#160;</td>
<td class="paramname"><em>strict</em> = <code>true</code></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>public accept interface </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">strict</td><td>whether to expect the last token to be EOF </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>whether the input is a proper JSON text </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespacenlohmann.html">nlohmann</a></li><li class="navelem"><a class="el" href="namespacenlohmann_1_1detail.html">detail</a></li><li class="navelem"><a class="el" href="classnlohmann_1_1detail_1_1parser.html">parser</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
</ul>
</div>
</body>
</html>