Google Git
Sign in
apache/avro/refs/heads/asf-site/./docs/1.10.1/api/cpp/html/Parser_8hh_source.html
blob: aa73e4a37937dfeb705252b6f15a982d43049601 [file]
<!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>Avro C++: api/Parser.hh Source File</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">Avro C++
</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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_0188a3e6da905bc60aceb35bf790b8c9.html">api</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Parser.hh</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * distributed with this work for additional information</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * &quot;License&quot;); you may not use this file except in compliance</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * with the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * https://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> * See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> * limitations under the License.</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#ifndef avro_Parser_hh__</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#define avro_Parser_hh__</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#include &quot;Config.hh&quot;</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &quot;Reader.hh&quot;</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &lt;array&gt;</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceavro.html">avro</a> {</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">class</span> Reader&gt;</div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classavro_1_1Parser.html"> 35</a></span>&#160;<span class="keyword">class </span><a class="code" href="classavro_1_1Parser.html">Parser</a> : <span class="keyword">private</span> boost::noncopyable</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;{</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="comment">// Constructor only works with Writer</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keyword">explicit</span> <a class="code" href="classavro_1_1Parser.html">Parser</a>(<span class="keyword">const</span> InputBuffer &amp;in) :</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; reader_(in)</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; {}</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;</div><div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="classavro_1_1Parser.html#ab2114aaad86211245f156537ac1975d3"> 46</a></span>&#160; <a class="code" href="classavro_1_1Parser.html#ab2114aaad86211245f156537ac1975d3">Parser</a>(<span class="keyword">const</span> <a class="code" href="classavro_1_1ValidSchema.html">ValidSchema</a> &amp;schema, <span class="keyword">const</span> InputBuffer &amp;in) :</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; reader_(schema, in)</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; {}</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keywordtype">void</span> readNull() {</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <a class="code" href="structavro_1_1Null.html">Null</a> null;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; reader_.readValue(null);</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; }</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keywordtype">bool</span> readBool() {</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keywordtype">bool</span> val;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; reader_.readValue(val);</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keywordflow">return</span> val;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; }</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; int32_t readInt() {</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; int32_t val;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; reader_.readValue(val);</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="keywordflow">return</span> val;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; }</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; int64_t readLong() {</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; int64_t val;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; reader_.readValue(val);</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="keywordflow">return</span> val;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; }</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="keywordtype">float</span> readFloat() {</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keywordtype">float</span> val;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; reader_.readValue(val);</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <span class="keywordflow">return</span> val;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; }</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="keywordtype">double</span> readDouble() {</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="keywordtype">double</span> val;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; reader_.readValue(val);</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <span class="keywordflow">return</span> val;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; }</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="keywordtype">void</span> readString(std::string &amp;val) {</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; reader_.readValue(val);</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; }</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; <span class="keywordtype">void</span> readBytes(std::vector&lt;uint8_t&gt; &amp;val) {</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; reader_.readBytes(val);</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; }</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; <span class="keyword">template</span> &lt;<span class="keywordtype">size_t</span> N&gt;</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <span class="keywordtype">void</span> readFixed(uint8_t (&amp;val)[N]) {</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; reader_.readFixed(val);</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; }</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; <span class="keyword">template</span>&lt;<span class="keywordtype">size_t</span> N&gt;</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; <span class="keywordtype">void</span> readFixed(std::array&lt;uint8_t, N&gt; &amp;val) {</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; reader_.readFixed(val);</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; }</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160;</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; <span class="keywordtype">void</span> readRecord() {</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; reader_.readRecord();</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; }</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160;</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; <span class="keywordtype">void</span> readRecordEnd() {</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; reader_.readRecordEnd();</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; }</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; int64_t readArrayBlockSize() {</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; <span class="keywordflow">return</span> reader_.readArrayBlockSize();</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; }</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160;</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; int64_t readUnion() {</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; <span class="keywordflow">return</span> reader_.readUnion();</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; }</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160;</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; int64_t readEnum() {</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; <span class="keywordflow">return</span> reader_.readEnum();</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; }</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160;</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; int64_t readMapBlockSize() {</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; <span class="keywordflow">return</span> reader_.readMapBlockSize();</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; }</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160;</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; <span class="keyword">private</span>:</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160;</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; <span class="keyword">friend</span> <a class="code" href="namespaceavro.html#a29e528c3fe1cb5660067a02721fae0b7">Type</a> nextType(<a class="code" href="classavro_1_1Parser.html">Parser&lt;ValidatingReader&gt;</a> &amp;p);</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; <span class="keyword">friend</span> <span class="keywordtype">bool</span> currentRecordName(<a class="code" href="classavro_1_1Parser.html">Parser&lt;ValidatingReader&gt;</a> &amp;p, std::string &amp;name);</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; <span class="keyword">friend</span> <span class="keywordtype">bool</span> nextFieldName(<a class="code" href="classavro_1_1Parser.html">Parser&lt;ValidatingReader&gt;</a> &amp;p, std::string &amp;name);</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160;</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; <a class="code" href="classavro_1_1ReaderImpl.html">Reader</a> reader_;</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160;</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160;};</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160;</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160;<span class="keyword">inline</span> <a class="code" href="namespaceavro.html#a29e528c3fe1cb5660067a02721fae0b7">Type</a> nextType(<a class="code" href="classavro_1_1Parser.html">Parser&lt;ValidatingReader&gt;</a> &amp;p) {</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; <span class="keywordflow">return</span> p.reader_.nextType();</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160;}</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160;</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160;<span class="keyword">inline</span> <span class="keywordtype">bool</span> currentRecordName(<a class="code" href="classavro_1_1Parser.html">Parser&lt;ValidatingReader&gt;</a> &amp;p, std::string &amp;name) {</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; <span class="keywordflow">return</span> p.reader_.currentRecordName(name);</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160;}</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160;</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160;<span class="keyword">inline</span> <span class="keywordtype">bool</span> nextFieldName(<a class="code" href="classavro_1_1Parser.html">Parser&lt;ValidatingReader&gt;</a> &amp;p, std::string &amp;name) {</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160; <span class="keywordflow">return</span> p.reader_.nextFieldName(name);</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160;}</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160;</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160;} <span class="comment">// namespace avro</span></div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160;</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="namespaceavro_html_a29e528c3fe1cb5660067a02721fae0b7"><div class="ttname"><a href="namespaceavro.html#a29e528c3fe1cb5660067a02721fae0b7">avro::Type</a></div><div class="ttdeci">Type</div><div class="ttdoc">The &quot;type&quot; for the schema. </div><div class="ttdef"><b>Definition:</b> Types.hh:31</div></div>
<div class="ttc" id="namespaceavro_html"><div class="ttname"><a href="namespaceavro.html">avro</a></div><div class="ttdoc">A bunch of templates and specializations for encoding and decoding specific types. </div><div class="ttdef"><b>Definition:</b> AvroParse.hh:30</div></div>
<div class="ttc" id="classavro_1_1Parser_html"><div class="ttname"><a href="classavro_1_1Parser.html">avro::Parser</a></div><div class="ttdoc">Class that wraps a reader or ValidatingReade with an interface that uses explicit get* names instead ...</div><div class="ttdef"><b>Definition:</b> Parser.hh:35</div></div>
<div class="ttc" id="classavro_1_1ReaderImpl_html"><div class="ttname"><a href="classavro_1_1ReaderImpl.html">avro::ReaderImpl&lt; NullValidator &gt;</a></div></div>
<div class="ttc" id="structavro_1_1Null_html"><div class="ttname"><a href="structavro_1_1Null.html">avro::Null</a></div><div class="ttdoc">define a type to identify Null in template functions </div><div class="ttdef"><b>Definition:</b> Types.hh:102</div></div>
<div class="ttc" id="classavro_1_1ValidSchema_html"><div class="ttname"><a href="classavro_1_1ValidSchema.html">avro::ValidSchema</a></div><div class="ttdoc">A ValidSchema is basically a non-mutable Schema that has passed some minumum of sanity checks...</div><div class="ttdef"><b>Definition:</b> ValidSchema.hh:40</div></div>
<div class="ttc" id="classavro_1_1Parser_html_ab2114aaad86211245f156537ac1975d3"><div class="ttname"><a href="classavro_1_1Parser.html#ab2114aaad86211245f156537ac1975d3">avro::Parser::Parser</a></div><div class="ttdeci">Parser(const ValidSchema &amp;schema, const InputBuffer &amp;in)</div><div class="ttdoc">Constructor only works with ValidatingWriter. </div><div class="ttdef"><b>Definition:</b> Parser.hh:46</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>