diff options
Diffstat (limited to 'stream_8h_source.html')
-rw-r--r-- | stream_8h_source.html | 305 |
1 files changed, 305 insertions, 0 deletions
diff --git a/stream_8h_source.html b/stream_8h_source.html new file mode 100644 index 00000000..1329abcc --- /dev/null +++ b/stream_8h_source.html @@ -0,0 +1,305 @@ +<!-- 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.7"/> +<title>RapidJSON: include/rapidjson/stream.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="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); + $(window).load(resizeHeight); +</script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +<link href="doxygenextra.css" rel="stylesheet" type="text/css"/> +</head> +<script> + (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ + (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), + m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) + })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); + ga('create', 'UA-63929386-1', 'auto'); + ga('send', 'pageview'); +</script> +<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="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.7 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</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('stream_8h_source.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)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(12)"><span class="SelectionMark"> </span>Pages</a></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">stream.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. All rights reserved.</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">#include "<a class="code" href="rapidjson_8h.html">rapidjson.h</a>"</span></div> +<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div> +<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#ifndef RAPIDJSON_STREAM_H_</span></div> +<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#define RAPIDJSON_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">#include "encodings.h"</span></div> +<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div> +<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> RAPIDJSON_NAMESPACE_BEGIN</div> +<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"></span></div> +<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">///////////////////////////////////////////////////////////////////////////////</span></div> +<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"></span><span class="comment">// Stream</span></div> +<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"></span></div> +<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">/*! \class rapidjson::Stream</span></div> +<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> \brief Concept for reading and writing characters.</span></div> +<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"></span></div> +<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> For read-only stream, no need to implement PutBegin(), Put(), Flush() and PutEnd().</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"> For write-only stream, only need to implement Put() and Flush().</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">\code</span></div> +<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">concept Stream {</span></div> +<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> typename Ch; //!< Character type of the stream.</span></div> +<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"></span><span class="comment"></span></div> +<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> //! Read the current character from stream without moving the read cursor.</span></div> +<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"></span> Ch Peek() const;</div> +<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"></span></div> +<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> //! Read the current character from stream and moving the read cursor to next character.</span></div> +<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"></span> Ch Take();</div> +<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"></span></div> +<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> //! Get the current read cursor.</span></div> +<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> //! \return Number of characters read from start.</span></div> +<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"></span> size_t Tell();</div> +<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"></span></div> +<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> //! Begin writing operation at the current read pointer.</span></div> +<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> //! \return The begin writer pointer.</span></div> +<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"></span> Ch* PutBegin();</div> +<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"></span></div> +<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> //! Write a character.</span></div> +<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"></span> void Put(Ch c);</div> +<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"></span></div> +<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> //! Flush the buffer.</span></div> +<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"></span> void Flush();</div> +<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"></span></div> +<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> //! End the writing operation.</span></div> +<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> //! \param begin The begin write pointer returned by PutBegin().</span></div> +<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> //! \return Number of characters written.</span></div> +<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"></span> size_t PutEnd(Ch* begin);</div> +<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> }</div> +<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> \endcode</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> <span class="comment"></span></div> +<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment">//! Provides additional information for stream.</span></div> +<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"></span><span class="comment">/*!</span></div> +<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> By using traits pattern, this type provides a default configuration for stream.</span></div> +<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> For custom stream, this type can be specialized for other configuration.</span></div> +<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> See TEST(Reader, CustomStringStream) in readertest.cpp for example.</span></div> +<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment">*/</span></div> +<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="keyword">template</span><<span class="keyword">typename</span> Stream></div> +<div class="line"><a name="l00073"></a><span class="lineno"><a class="line" href="structrapidjson_1_1_stream_traits.html"> 73</a></span> <span class="keyword">struct </span><a class="code" href="structrapidjson_1_1_stream_traits.html">StreamTraits</a> {<span class="comment"></span></div> +<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> //! Whether to make local copy of stream for optimization during parsing.</span></div> +<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"></span><span class="comment"> /*!</span></div> +<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> By default, for safety, streams do not use local copy optimization.</span></div> +<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> Stream that can be copied fast should specialize this, like StreamTraits<StringStream>.</span></div> +<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> */</span></div> +<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keyword">enum</span> { copyOptimization = 0 };</div> +<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> };</div> +<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"></span></div> +<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment">//! Reserve n characters for writing to a stream.</span></div> +<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"></span><span class="keyword">template</span><<span class="keyword">typename</span> Stream></div> +<div class="line"><a name="l00084"></a><span class="lineno"><a class="line" href="namespacerapidjson.html#a820f77efccfbb749bd15fe4822d2c740"> 84</a></span> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="namespacerapidjson.html#a820f77efccfbb749bd15fe4822d2c740">PutReserve</a>(<a class="code" href="classrapidjson_1_1_stream.html">Stream</a>& stream, <span class="keywordtype">size_t</span> count) {</div> +<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  (void)stream;</div> +<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  (void)count;</div> +<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> }</div> +<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"></span></div> +<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment">//! Write character to a stream, presuming buffer is reserved.</span></div> +<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"></span><span class="keyword">template</span><<span class="keyword">typename</span> Stream></div> +<div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="namespacerapidjson.html#a0a774dcffe8ae07686f459ae017d2f20"> 91</a></span> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="namespacerapidjson.html#a0a774dcffe8ae07686f459ae017d2f20">PutUnsafe</a>(<a class="code" href="classrapidjson_1_1_stream.html">Stream</a>& stream, <span class="keyword">typename</span> Stream::Ch c) {</div> +<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  stream.Put(c);</div> +<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> }</div> +<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"></span></div> +<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment">//! Put N copies of a character to a stream.</span></div> +<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"></span><span class="keyword">template</span><<span class="keyword">typename</span> Stream, <span class="keyword">typename</span> Ch></div> +<div class="line"><a name="l00097"></a><span class="lineno"><a class="line" href="namespacerapidjson.html#a1d49d2cab617858b53a1db23b1759f43"> 97</a></span> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="namespacerapidjson.html#a1ac13bac5976fc06587e00fc0bcfb32a">PutN</a>(<a class="code" href="classrapidjson_1_1_stream.html">Stream</a>& stream, Ch c, <span class="keywordtype">size_t</span> n) {</div> +<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  PutReserve<Stream>(stream, n);</div> +<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> i = 0; i < n; i++)</div> +<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <a class="code" href="namespacerapidjson.html#a0a774dcffe8ae07686f459ae017d2f20">PutUnsafe</a>(stream, c);</div> +<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> }</div> +<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"></span></div> +<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment">///////////////////////////////////////////////////////////////////////////////</span></div> +<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"></span><span class="comment">// StringStream</span></div> +<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"></span></div> +<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment">//! Read-only string stream.</span></div> +<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"></span><span class="comment">/*! \note implements Stream concept</span></div> +<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment">*/</span></div> +<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="keyword">template</span> <<span class="keyword">typename</span> Encoding></div> +<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="keyword">struct </span>GenericStringStream {</div> +<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keyword">typedef</span> <span class="keyword">typename</span> Encoding::Ch Ch;</div> +<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div> +<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  GenericStringStream(<span class="keyword">const</span> Ch *src) : src_(src), head_(src) {}</div> +<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </div> +<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  Ch Peek()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> *src_; }</div> +<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  Ch Take() { <span class="keywordflow">return</span> *src_++; }</div> +<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keywordtype">size_t</span> Tell()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">static_cast<</span><span class="keywordtype">size_t</span><span class="keyword">></span>(src_ - head_); }</div> +<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> </div> +<div class="line"><a name="l00119"></a><span class="lineno"> 119</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="l00120"></a><span class="lineno"> 120</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="l00121"></a><span class="lineno"> 121</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="l00122"></a><span class="lineno"> 122</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="l00123"></a><span class="lineno"> 123</span> </div> +<div class="line"><a name="l00124"></a><span class="lineno"><a class="line" href="structrapidjson_1_1_generic_string_stream.html#a9a38a9d5b1ce782cacd4ec1bdf87fc2d"> 124</a></span>  <span class="keyword">const</span> Ch* <a class="code" href="structrapidjson_1_1_generic_string_stream.html#a9a38a9d5b1ce782cacd4ec1bdf87fc2d">src_</a>; <span class="comment">//!< Current read position.</span></div> +<div class="line"><a name="l00125"></a><span class="lineno"><a class="line" href="structrapidjson_1_1_generic_string_stream.html#a2556705b0a0fd6393862efe6db025b32"> 125</a></span> <span class="comment"></span> <span class="keyword">const</span> Ch* <a class="code" href="structrapidjson_1_1_generic_string_stream.html#a2556705b0a0fd6393862efe6db025b32">head_</a>; <span class="comment">//!< Original head of the string.</span></div> +<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"></span>};</div> +<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div> +<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="keyword">template</span> <<span class="keyword">typename</span> Encoding></div> +<div class="line"><a name="l00129"></a><span class="lineno"><a class="line" href="structrapidjson_1_1_stream_traits_3_01_generic_string_stream_3_01_encoding_01_4_01_4.html"> 129</a></span> <span class="keyword">struct </span><a class="code" href="structrapidjson_1_1_stream_traits.html">StreamTraits</a><<a class="code" href="structrapidjson_1_1_generic_string_stream.html">GenericStringStream</a><<a class="code" href="classrapidjson_1_1_encoding.html">Encoding</a>> > {</div> +<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  <span class="keyword">enum</span> { copyOptimization = 1 };</div> +<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> };</div> +<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment"></span></div> +<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment">//! String stream with UTF8 encoding.</span></div> +<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment"></span><span class="keyword">typedef</span> <a class="code" href="structrapidjson_1_1_generic_string_stream.html">GenericStringStream<UTF8<></a> > <a class="code" href="structrapidjson_1_1_generic_string_stream.html">StringStream</a>;</div> +<div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment"></span></div> +<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment">///////////////////////////////////////////////////////////////////////////////</span></div> +<div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment"></span><span class="comment">// InsituStringStream</span></div> +<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment"></span></div> +<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment">//! A read-write string stream.</span></div> +<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment"></span><span class="comment">/*! This string stream is particularly designed for in-situ parsing.</span></div> +<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment"> \note implements Stream concept</span></div> +<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment">*/</span></div> +<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="keyword">template</span> <<span class="keyword">typename</span> Encoding></div> +<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="keyword">struct </span><a class="code" href="structrapidjson_1_1_generic_insitu_string_stream.html">GenericInsituStringStream</a> {</div> +<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  <span class="keyword">typedef</span> <span class="keyword">typename</span> Encoding::Ch Ch;</div> +<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> </div> +<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  <a class="code" href="structrapidjson_1_1_generic_insitu_string_stream.html">GenericInsituStringStream</a>(Ch *src) : src_(src), dst_(0), head_(src) {}</div> +<div class="line"><a name="l00148"></a><span class="lineno"> 148</span> </div> +<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <span class="comment">// Read</span></div> +<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  Ch Peek() { <span class="keywordflow">return</span> *src_; }</div> +<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  Ch Take() { <span class="keywordflow">return</span> *src_++; }</div> +<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  <span class="keywordtype">size_t</span> Tell() { <span class="keywordflow">return</span> <span class="keyword">static_cast<</span><span class="keywordtype">size_t</span><span class="keyword">></span>(src_ - head_); }</div> +<div class="line"><a name="l00153"></a><span class="lineno"> 153</span> </div> +<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  <span class="comment">// Write</span></div> +<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  <span class="keywordtype">void</span> Put(Ch c) { <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>(dst_ != 0); *dst_++ = c; }</div> +<div class="line"><a name="l00156"></a><span class="lineno"> 156</span> </div> +<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  Ch* PutBegin() { <span class="keywordflow">return</span> dst_ = src_; }</div> +<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  <span class="keywordtype">size_t</span> PutEnd(Ch* begin) { <span class="keywordflow">return</span> <span class="keyword">static_cast<</span><span class="keywordtype">size_t</span><span class="keyword">></span>(dst_ - begin); }</div> +<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  <span class="keywordtype">void</span> Flush() {}</div> +<div class="line"><a name="l00160"></a><span class="lineno"> 160</span> </div> +<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  Ch* Push(<span class="keywordtype">size_t</span> count) { Ch* begin = dst_; dst_ += count; <span class="keywordflow">return</span> begin; }</div> +<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  <span class="keywordtype">void</span> Pop(<span class="keywordtype">size_t</span> count) { dst_ -= count; }</div> +<div class="line"><a name="l00163"></a><span class="lineno"> 163</span> </div> +<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  Ch* src_;</div> +<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  Ch* dst_;</div> +<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  Ch* head_;</div> +<div class="line"><a name="l00167"></a><span class="lineno"> 167</span> };</div> +<div class="line"><a name="l00168"></a><span class="lineno"> 168</span> </div> +<div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="keyword">template</span> <<span class="keyword">typename</span> Encoding></div> +<div class="line"><a name="l00170"></a><span class="lineno"><a class="line" href="structrapidjson_1_1_stream_traits_3_01_generic_insitu_string_stream_3_01_encoding_01_4_01_4.html"> 170</a></span> <span class="keyword">struct </span><a class="code" href="structrapidjson_1_1_stream_traits.html">StreamTraits</a><<a class="code" href="structrapidjson_1_1_generic_insitu_string_stream.html">GenericInsituStringStream</a><<a class="code" href="classrapidjson_1_1_encoding.html">Encoding</a>> > {</div> +<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  <span class="keyword">enum</span> { copyOptimization = 1 };</div> +<div class="line"><a name="l00172"></a><span class="lineno"> 172</span> };</div> +<div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment"></span></div> +<div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="comment">//! Insitu string stream with UTF8 encoding.</span></div> +<div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment"></span><span class="keyword">typedef</span> <a class="code" href="structrapidjson_1_1_generic_insitu_string_stream.html">GenericInsituStringStream<UTF8<></a> > <a class="code" href="structrapidjson_1_1_generic_insitu_string_stream.html">InsituStringStream</a>;</div> +<div class="line"><a name="l00176"></a><span class="lineno"> 176</span> </div> +<div class="line"><a name="l00177"></a><span class="lineno"> 177</span> RAPIDJSON_NAMESPACE_END</div> +<div class="line"><a name="l00178"></a><span class="lineno"> 178</span> </div> +<div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="preprocessor">#endif // RAPIDJSON_STREAM_H_</span></div> +<div class="ttc" id="structrapidjson_1_1_generic_string_stream_html"><div class="ttname"><a href="structrapidjson_1_1_generic_string_stream.html">rapidjson::GenericStringStream</a></div><div class="ttdoc">Read-only string stream. </div><div class="ttdef"><b>Definition:</b> fwd.h:47</div></div> +<div class="ttc" id="namespacerapidjson_html_a820f77efccfbb749bd15fe4822d2c740"><div class="ttname"><a href="namespacerapidjson.html#a820f77efccfbb749bd15fe4822d2c740">rapidjson::PutReserve</a></div><div class="ttdeci">void PutReserve(Stream &stream, size_t count)</div><div class="ttdoc">Reserve n characters for writing to a stream. </div><div class="ttdef"><b>Definition:</b> stream.h:84</div></div> +<div class="ttc" id="structrapidjson_1_1_generic_string_stream_html_a2556705b0a0fd6393862efe6db025b32"><div class="ttname"><a href="structrapidjson_1_1_generic_string_stream.html#a2556705b0a0fd6393862efe6db025b32">rapidjson::GenericStringStream::head_</a></div><div class="ttdeci">const Ch * head_</div><div class="ttdoc">Original head of the string. </div><div class="ttdef"><b>Definition:</b> stream.h:125</div></div> +<div class="ttc" id="structrapidjson_1_1_generic_string_stream_html_a9a38a9d5b1ce782cacd4ec1bdf87fc2d"><div class="ttname"><a href="structrapidjson_1_1_generic_string_stream.html#a9a38a9d5b1ce782cacd4ec1bdf87fc2d">rapidjson::GenericStringStream::src_</a></div><div class="ttdeci">const Ch * src_</div><div class="ttdoc">Current read position. </div><div class="ttdef"><b>Definition:</b> stream.h:124</div></div> +<div class="ttc" id="classrapidjson_1_1_encoding_html"><div class="ttname"><a href="classrapidjson_1_1_encoding.html">rapidjson::Encoding</a></div><div class="ttdoc">Concept for encoding of Unicode characters. </div></div> +<div class="ttc" id="namespacerapidjson_html_a1ac13bac5976fc06587e00fc0bcfb32a"><div class="ttname"><a href="namespacerapidjson.html#a1ac13bac5976fc06587e00fc0bcfb32a">rapidjson::PutN</a></div><div class="ttdeci">void PutN(FileWriteStream &stream, char c, size_t n)</div><div class="ttdoc">Implement specialized version of PutN() with memset() for better performance. </div><div class="ttdef"><b>Definition:</b> filewritestream.h:94</div></div> +<div class="ttc" id="classrapidjson_1_1_stream_html"><div class="ttname"><a href="classrapidjson_1_1_stream.html">rapidjson::Stream</a></div><div class="ttdoc">Concept for reading and writing characters. </div></div> +<div class="ttc" id="rapidjson_8h_html"><div class="ttname"><a href="rapidjson_8h.html">rapidjson.h</a></div><div class="ttdoc">common definitions and configuration </div></div> +<div class="ttc" id="namespacerapidjson_html_a0a774dcffe8ae07686f459ae017d2f20"><div class="ttname"><a href="namespacerapidjson.html#a0a774dcffe8ae07686f459ae017d2f20">rapidjson::PutUnsafe</a></div><div class="ttdeci">void PutUnsafe(Stream &stream, typename Stream::Ch c)</div><div class="ttdoc">Write character to a stream, presuming buffer is reserved. </div><div class="ttdef"><b>Definition:</b> stream.h:91</div></div> +<div class="ttc" id="group___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:371</div></div> +<div class="ttc" id="structrapidjson_1_1_stream_traits_html"><div class="ttname"><a href="structrapidjson_1_1_stream_traits.html">rapidjson::StreamTraits</a></div><div class="ttdoc">Provides additional information for stream. </div><div class="ttdef"><b>Definition:</b> stream.h:73</div></div> +<div class="ttc" id="structrapidjson_1_1_generic_insitu_string_stream_html"><div class="ttname"><a href="structrapidjson_1_1_generic_insitu_string_stream.html">rapidjson::GenericInsituStringStream</a></div><div class="ttdoc">A read-write string stream. </div><div class="ttdef"><b>Definition:</b> fwd.h:52</div></div> +</div><!-- fragment --></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="dir_2e777bb85672ca91d8484c1593fb1d89.html">include</a></li><li class="navelem"><a class="el" href="dir_0b07344794a20f8375311f92e90cd9a3.html">rapidjson</a></li><li class="navelem"><b>stream.h</b></li> + </ul> +</div> +<script type="text/javascript"> + /* * * CONFIGURATION VARIABLES * * */ + var disqus_shortname = 'rapidjson-doc'; + /* * * DON'T EDIT BELOW THIS LINE * * */ + (function() { + var dt = document.createElement('div'); + dt.id = "disqus_thread"; + (document.getElementsByClassName('contents')[0]).appendChild(dt); + var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true; + dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js'; + (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq); + })(); +</script> +</body> +</html> |