forked from Tencent/rapidjson
/
memorystream_8h_source.html
179 lines (177 loc) · 19.4 KB
/
memorystream_8h_source.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
<!-- 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.16"/>
<title>RapidJSON: include/rapidjson/memorystream.h 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="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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</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/Tencent/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="Search" 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 -->
<!-- Generated by Doxygen 1.8.16 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('memorystream_8h_source.html','');});
/* @license-end */
</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="headertitle">
<div class="title">memorystream.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// Tencent is pleased to support the open source community by making RapidJSON available.</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// </span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// Copyright (C) 2015 THL A29 Limited, a Tencent company, and Milo Yip.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">//</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// Licensed under the MIT License (the "License"); you may not use this file except</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// in compliance with the License. You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">//</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">// http://opensource.org/licenses/MIT</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">//</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// Unless required by applicable law or agreed to in writing, software distributed </span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR </span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// CONDITIONS OF ANY KIND, either express or implied. See the License for the </span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// specific language governing permissions and limitations under the License.</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>  </div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#ifndef RAPIDJSON_MEMORYSTREAM_H_</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#define RAPIDJSON_MEMORYSTREAM_H_</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  </div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include "stream.h"</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifdef __clang__</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> RAPIDJSON_DIAG_PUSH</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> RAPIDJSON_DIAG_OFF(unreachable-code)</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> RAPIDJSON_DIAG_OFF(missing-noreturn)</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> RAPIDJSON_NAMESPACE_BEGIN</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"></span> </div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">//! Represents an in-memory input byte stream.</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"></span><span class="comment">/*!</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> This class is mainly for being wrapped by EncodedInputStream or AutoUTFInputStream.</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"></span> </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> It is similar to FileReadBuffer but the source is an in-memory buffer instead of a file.</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"></span> </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> Differences between MemoryStream and StringStream:</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> 1. StringStream has encoding but MemoryStream is a byte stream.</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> 2. MemoryStream needs size of the source buffer and the buffer don't need to be null terminated. StringStream assume null-terminated string as source.</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> 3. MemoryStream supports Peek4() for encoding detection. StringStream is specified with an encoding so it should not have Peek4().</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> \note implements Stream concept</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="structrapidjson_1_1_memory_stream.html"> 40</a></span> <span class="keyword">struct </span><a class="code" href="structrapidjson_1_1_memory_stream.html">MemoryStream</a> {</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">typedef</span> <span class="keywordtype">char</span> Ch; <span class="comment">// byte</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <a class="code" href="structrapidjson_1_1_memory_stream.html">MemoryStream</a>(<span class="keyword">const</span> Ch *src, <span class="keywordtype">size_t</span> size) : src_(src), begin_(src), end_(src + size), size_(size) {}</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  Ch Peek()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="group___r_a_p_i_d_j_s_o_n___c_o_n_f_i_g.html#ga6a2b1695c13e77ae425e3cbac980ccb5">RAPIDJSON_UNLIKELY</a>(src_ == end_) ? <span class="charliteral">'\0'</span> : *src_; }</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  Ch Take() { <span class="keywordflow">return</span> <a class="code" href="group___r_a_p_i_d_j_s_o_n___c_o_n_f_i_g.html#ga6a2b1695c13e77ae425e3cbac980ccb5">RAPIDJSON_UNLIKELY</a>(src_ == end_) ? <span class="charliteral">'\0'</span> : *src_++; }</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordtype">size_t</span> Tell()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> static_cast<size_t>(src_ - begin_); }</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  </div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  Ch* PutBegin() { <a class="code" href="group___r_a_p_i_d_j_s_o_n___c_o_n_f_i_g.html#gabeba18d612187bad2ac62aed9276d47c">RAPIDJSON_ASSERT</a>(<span class="keyword">false</span>); <span class="keywordflow">return</span> 0; }</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordtype">void</span> Put(Ch) { <a class="code" href="group___r_a_p_i_d_j_s_o_n___c_o_n_f_i_g.html#gabeba18d612187bad2ac62aed9276d47c">RAPIDJSON_ASSERT</a>(<span class="keyword">false</span>); }</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keywordtype">void</span> Flush() { <a class="code" href="group___r_a_p_i_d_j_s_o_n___c_o_n_f_i_g.html#gabeba18d612187bad2ac62aed9276d47c">RAPIDJSON_ASSERT</a>(<span class="keyword">false</span>); }</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordtype">size_t</span> PutEnd(Ch*) { <a class="code" href="group___r_a_p_i_d_j_s_o_n___c_o_n_f_i_g.html#gabeba18d612187bad2ac62aed9276d47c">RAPIDJSON_ASSERT</a>(<span class="keyword">false</span>); <span class="keywordflow">return</span> 0; }</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="comment">// For encoding detection only.</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">const</span> Ch* Peek4()<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordflow">return</span> Tell() + 4 <= size_ ? src_ : 0;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  }</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  </div>
<div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="structrapidjson_1_1_memory_stream.html#ac0b4da6016e5ba6241604fd4258fb722"> 59</a></span>  <span class="keyword">const</span> Ch* <a class="code" href="structrapidjson_1_1_memory_stream.html#ac0b4da6016e5ba6241604fd4258fb722">src_</a>; <span class="comment">//!< Current read position.</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="structrapidjson_1_1_memory_stream.html#a1cc586e50fbfc0bd5994977b42243b93"> 60</a></span> <span class="comment"></span> <span class="keyword">const</span> Ch* <a class="code" href="structrapidjson_1_1_memory_stream.html#a1cc586e50fbfc0bd5994977b42243b93">begin_</a>; <span class="comment">//!< Original head of the string.</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="structrapidjson_1_1_memory_stream.html#a47f45298891e8156121b4017954fabe8"> 61</a></span> <span class="comment"></span> <span class="keyword">const</span> Ch* <a class="code" href="structrapidjson_1_1_memory_stream.html#a47f45298891e8156121b4017954fabe8">end_</a>; <span class="comment">//!< End of stream.</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="structrapidjson_1_1_memory_stream.html#a8c8437d59c32168a74226312d9e96ace"> 62</a></span> <span class="comment"></span> <span class="keywordtype">size_t</span> <a class="code" href="structrapidjson_1_1_memory_stream.html#a8c8437d59c32168a74226312d9e96ace">size_</a>; <span class="comment">//!< Size of the stream.</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"></span>};</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  </div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> RAPIDJSON_NAMESPACE_END</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  </div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="preprocessor">#ifdef __clang__</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> RAPIDJSON_DIAG_POP</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  </div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="preprocessor">#endif // RAPIDJSON_MEMORYBUFFER_H_</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="astructrapidjson_1_1_memory_stream_html_a8c8437d59c32168a74226312d9e96ace"><div class="ttname"><a href="structrapidjson_1_1_memory_stream.html#a8c8437d59c32168a74226312d9e96ace">rapidjson::MemoryStream::size_</a></div><div class="ttdeci">size_t size_</div><div class="ttdoc">Size of the stream.</div><div class="ttdef"><b>Definition:</b> memorystream.h:62</div></div>
<div class="ttc" id="astructrapidjson_1_1_memory_stream_html"><div class="ttname"><a href="structrapidjson_1_1_memory_stream.html">rapidjson::MemoryStream</a></div><div class="ttdoc">Represents an in-memory input byte stream.</div><div class="ttdef"><b>Definition:</b> memorystream.h:40</div></div>
<div class="ttc" id="astructrapidjson_1_1_memory_stream_html_a47f45298891e8156121b4017954fabe8"><div class="ttname"><a href="structrapidjson_1_1_memory_stream.html#a47f45298891e8156121b4017954fabe8">rapidjson::MemoryStream::end_</a></div><div class="ttdeci">const Ch * end_</div><div class="ttdoc">End of stream.</div><div class="ttdef"><b>Definition:</b> memorystream.h:61</div></div>
<div class="ttc" id="agroup___r_a_p_i_d_j_s_o_n___c_o_n_f_i_g_html_gabeba18d612187bad2ac62aed9276d47c"><div class="ttname"><a href="group___r_a_p_i_d_j_s_o_n___c_o_n_f_i_g.html#gabeba18d612187bad2ac62aed9276d47c">RAPIDJSON_ASSERT</a></div><div class="ttdeci">#define RAPIDJSON_ASSERT(x)</div><div class="ttdoc">Assertion.</div><div class="ttdef"><b>Definition:</b> rapidjson.h:437</div></div>
<div class="ttc" id="astructrapidjson_1_1_memory_stream_html_a1cc586e50fbfc0bd5994977b42243b93"><div class="ttname"><a href="structrapidjson_1_1_memory_stream.html#a1cc586e50fbfc0bd5994977b42243b93">rapidjson::MemoryStream::begin_</a></div><div class="ttdeci">const Ch * begin_</div><div class="ttdoc">Original head of the string.</div><div class="ttdef"><b>Definition:</b> memorystream.h:60</div></div>
<div class="ttc" id="astructrapidjson_1_1_memory_stream_html_ac0b4da6016e5ba6241604fd4258fb722"><div class="ttname"><a href="structrapidjson_1_1_memory_stream.html#ac0b4da6016e5ba6241604fd4258fb722">rapidjson::MemoryStream::src_</a></div><div class="ttdeci">const Ch * src_</div><div class="ttdoc">Current read position.</div><div class="ttdef"><b>Definition:</b> memorystream.h:59</div></div>
<div class="ttc" id="agroup___r_a_p_i_d_j_s_o_n___c_o_n_f_i_g_html_ga6a2b1695c13e77ae425e3cbac980ccb5"><div class="ttname"><a href="group___r_a_p_i_d_j_s_o_n___c_o_n_f_i_g.html#ga6a2b1695c13e77ae425e3cbac980ccb5">RAPIDJSON_UNLIKELY</a></div><div class="ttdeci">#define RAPIDJSON_UNLIKELY(x)</div><div class="ttdoc">Compiler branching hint for expression with low probability to be true.</div><div class="ttdef"><b>Definition:</b> rapidjson.h:507</div></div>
<!-- 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="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_32fb88e4d38e67d524aa70efbc36f66b.html">rapidjson</a></li><li class="navelem"><b>memorystream.h</b></li>
</ul>
</div>
</body>
</html>