blob: 161c29cbacf328d5ba82f088274847d67ecff0fd [file] [log] [blame]
miloyip28df04d2014-08-08 13:48:11 +00001<!-- HTML header for doxygen 1.8.7-->
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml">
4<head>
5<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6<meta http-equiv="X-UA-Compatible" content="IE=9"/>
7<meta name="generator" content="Doxygen 1.8.7"/>
8<title>RapidJSON: include/rapidjson/stringbuffer.h Source File</title>
9<link href="tabs.css" rel="stylesheet" type="text/css"/>
10<script type="text/javascript" src="jquery.js"></script>
11<script type="text/javascript" src="dynsections.js"></script>
12<link href="navtree.css" rel="stylesheet" type="text/css"/>
13<script type="text/javascript" src="resize.js"></script>
14<script type="text/javascript" src="navtree.js"></script>
15<script type="text/javascript">
16 $(document).ready(initResizable);
17 $(window).load(resizeHeight);
18</script>
19<link href="search/search.css" rel="stylesheet" type="text/css"/>
20<script type="text/javascript" src="search/search.js"></script>
21<script type="text/javascript">
22 $(document).ready(function() { searchBox.OnSelectItem(0); });
23</script>
24<link href="doxygen.css" rel="stylesheet" type="text/css" />
25<link href="doxygenextra.css" rel="stylesheet" type="text/css"/>
26</head>
27<body>
28<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
29<div id="topbanner"><a href="https://github.com/miloyip/rapidjson" title="RapidJSON GitHub"><i class="githublogo"></i></a></div>
30 <div id="MSearchBox" class="MSearchBoxInactive">
31 <span class="left">
32 <img id="MSearchSelect" src="search/mag_sel.png"
33 onmouseover="return searchBox.OnSearchSelectShow()"
34 onmouseout="return searchBox.OnSearchSelectHide()"
35 alt=""/>
36 <input type="text" id="MSearchField" value="Search" accesskey="S"
37 onfocus="searchBox.OnSearchFieldFocus(true)"
38 onblur="searchBox.OnSearchFieldFocus(false)"
39 onkeyup="searchBox.OnSearchFieldChange(event)"/>
40 </span><span class="right">
41 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
42 </span>
43 </div>
44<!-- end header part -->
45<!-- Generated by Doxygen 1.8.7 -->
46<script type="text/javascript">
47var searchBox = new SearchBox("searchBox", "search",false,'Search');
48</script>
49</div><!-- top -->
50<div id="side-nav" class="ui-resizable side-nav-resizable">
51 <div id="nav-tree">
52 <div id="nav-tree-contents">
53 <div id="nav-sync" class="sync"></div>
54 </div>
55 </div>
56 <div id="splitbar" style="-moz-user-select:none;"
57 class="ui-resizable-handle">
58 </div>
59</div>
60<script type="text/javascript">
61$(document).ready(function(){initNavTree('stringbuffer_8h_source.html','');});
62</script>
63<div id="doc-content">
64<!-- window showing the filter options -->
65<div id="MSearchSelectWindow"
66 onmouseover="return searchBox.OnSearchSelectShow()"
67 onmouseout="return searchBox.OnSearchSelectHide()"
68 onkeydown="return searchBox.OnSearchSelectKey(event)">
miloyip22ee6ef2014-08-20 01:22:05 +000069<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(12)"><span class="SelectionMark">&#160;</span>Pages</a></div>
miloyip28df04d2014-08-08 13:48:11 +000070
71<!-- iframe showing the search results (closed by default) -->
72<div id="MSearchResultsWindow">
73<iframe src="javascript:void(0)" frameborder="0"
74 name="MSearchResults" id="MSearchResults">
75</iframe>
76</div>
77
78<div class="header">
79 <div class="headertitle">
80<div class="title">stringbuffer.h</div> </div>
81</div><!--header-->
82<div class="contents">
miloyip00767cc2014-08-11 14:34:20 +000083<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">// Copyright (C) 2011 Milo Yip</span></div>
84<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">//</span></div>
85<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// Permission is hereby granted, free of charge, to any person obtaining a copy</span></div>
86<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">// of this software and associated documentation files (the &quot;Software&quot;), to deal</span></div>
87<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">// in the Software without restriction, including without limitation the rights</span></div>
88<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span></div>
89<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">// copies of the Software, and to permit persons to whom the Software is</span></div>
90<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">// furnished to do so, subject to the following conditions:</span></div>
91<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">//</span></div>
92<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">// The above copyright notice and this permission notice shall be included in</span></div>
93<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// all copies or substantial portions of the Software.</span></div>
94<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">//</span></div>
95<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">// THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div>
96<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment">// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div>
97<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment">// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span></div>
98<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment">// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div>
99<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment">// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span></div>
100<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment">// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN</span></div>
101<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment">// THE SOFTWARE.</span></div>
miloyip28df04d2014-08-08 13:48:11 +0000102<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;</div>
miloyip00767cc2014-08-11 14:34:20 +0000103<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#ifndef RAPIDJSON_STRINGBUFFER_H_</span></div>
104<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#define RAPIDJSON_STRINGBUFFER_H_</span></div>
miloyip28df04d2014-08-08 13:48:11 +0000105<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;</div>
miloyip00767cc2014-08-11 14:34:20 +0000106<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="rapidjson_8h.html">rapidjson.h</a>&quot;</span></div>
107<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &quot;internal/stack.h&quot;</span></div>
108<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;</div>
109<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="keyword">namespace </span>rapidjson {</div>
110<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="comment"></span></div>
111<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="comment">//! Represents an in-memory output stream.</span></div>
112<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="comment"></span><span class="comment">/*!</span></div>
113<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="comment"> \tparam Encoding Encoding of the stream.</span></div>
114<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="comment"> \tparam Allocator type for allocating memory buffer.</span></div>
115<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="comment"> \note implements Stream concept</span></div>
116<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="comment">*/</span></div>
117<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> Encoding, <span class="keyword">typename</span> Allocator = CrtAllocator&gt;</div>
118<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="structrapidjson_1_1_generic_string_buffer.html"> 36</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structrapidjson_1_1_generic_string_buffer.html">GenericStringBuffer</a> {</div>
119<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keyword">typedef</span> <span class="keyword">typename</span> Encoding::Ch Ch;</div>
120<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;</div>
121<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <a class="code" href="structrapidjson_1_1_generic_string_buffer.html">GenericStringBuffer</a>(<a class="code" href="classrapidjson_1_1_allocator.html">Allocator</a>* allocator = 0, <span class="keywordtype">size_t</span> capacity = kDefaultCapacity) : stack_(allocator, capacity) {}</div>
122<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;</div>
123<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keywordtype">void</span> Put(Ch c) { *stack_.template Push&lt;Ch&gt;() = c; }</div>
124<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keywordtype">void</span> Flush() {}</div>
125<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;</div>
126<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keywordtype">void</span> Clear() { stack_.Clear(); }</div>
miloyip00af78c2014-08-18 16:15:53 +0000127<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keywordtype">void</span> ShrinkToFit() {</div>
128<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="comment">// Push and pop a null terminator. This is safe.</span></div>
129<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; *stack_.template Push&lt;Ch&gt;() = <span class="charliteral">&#39;\0&#39;</span>;</div>
130<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; stack_.ShrinkToFit();</div>
131<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; stack_.template Pop&lt;Ch&gt;(1);</div>
132<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; }</div>
133<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; Ch* Push(<span class="keywordtype">size_t</span> count) { <span class="keywordflow">return</span> stack_.template Push&lt;Ch&gt;(count); }</div>
134<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keywordtype">void</span> Pop(<span class="keywordtype">size_t</span> count) { stack_.template Pop&lt;Ch&gt;(count); }</div>
135<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;</div>
136<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keyword">const</span> Ch* GetString()<span class="keyword"> const </span>{</div>
137<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="comment">// Push and pop a null terminator. This is safe.</span></div>
138<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; *stack_.template Push&lt;Ch&gt;() = <span class="charliteral">&#39;\0&#39;</span>;</div>
139<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; stack_.template Pop&lt;Ch&gt;(1);</div>
140<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;</div>
141<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keywordflow">return</span> stack_.template Bottom&lt;Ch&gt;();</div>
142<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; }</div>
143<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;</div>
144<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keywordtype">size_t</span> GetSize()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> stack_.GetSize(); }</div>
145<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;</div>
146<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">size_t</span> kDefaultCapacity = 256;</div>
147<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keyword">mutable</span> internal::Stack&lt;Allocator&gt; stack_;</div>
148<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;};</div>
149<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;<span class="comment"></span></div>
150<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;<span class="comment">//! String buffer with UTF8 encoding</span></div>
151<div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="namespacerapidjson.html#a51a6c35028b76e354bbb9e25d7125641"> 69</a></span>&#160;<span class="comment"></span><span class="keyword">typedef</span> <a class="code" href="structrapidjson_1_1_generic_string_buffer.html">GenericStringBuffer&lt;UTF8&lt;&gt;</a> &gt; <a class="code" href="namespacerapidjson.html#a51a6c35028b76e354bbb9e25d7125641">StringBuffer</a>;</div>
152<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;<span class="comment"></span></div>
153<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;<span class="comment">//! Implement specialized version of PutN() with memset() for better performance.</span></div>
154<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;<span class="comment"></span><span class="keyword">template</span>&lt;&gt;</div>
miloyip22ee6ef2014-08-20 01:22:05 +0000155<div class="line"><a name="l00073"></a><span class="lineno"><a class="line" href="namespacerapidjson.html#a9d43be9c033dc49738b713fe6fbafecf"> 73</a></span>&#160;<span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="namespacerapidjson.html#a1d49d2cab617858b53a1db23b1759f43">PutN</a>(<a class="code" href="structrapidjson_1_1_generic_string_buffer.html">GenericStringBuffer</a>&lt;<a class="code" href="structrapidjson_1_1_u_t_f8.html">UTF8&lt;&gt;</a> &gt;&amp; stream, <span class="keywordtype">char</span> c, <span class="keywordtype">size_t</span> n) {</div>
miloyip26488c02014-09-16 10:44:57 +0000156<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; std::memset(stream.stack_.Push&lt;<span class="keywordtype">char</span>&gt;(n), c, n * <span class="keyword">sizeof</span>(c));</div>
miloyip00af78c2014-08-18 16:15:53 +0000157<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;}</div>
158<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;</div>
159<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;} <span class="comment">// namespace rapidjson</span></div>
160<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;</div>
161<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;<span class="preprocessor">#endif // RAPIDJSON_STRINGBUFFER_H_</span></div>
miloyip00767cc2014-08-11 14:34:20 +0000162<div class="ttc" id="structrapidjson_1_1_generic_string_buffer_html"><div class="ttname"><a href="structrapidjson_1_1_generic_string_buffer.html">rapidjson::GenericStringBuffer</a></div><div class="ttdoc">Represents an in-memory output stream. </div><div class="ttdef"><b>Definition:</b> stringbuffer.h:36</div></div>
miloyip28df04d2014-08-08 13:48:11 +0000163<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>
miloyip00767cc2014-08-11 14:34:20 +0000164<div class="ttc" id="structrapidjson_1_1_u_t_f8_html"><div class="ttname"><a href="structrapidjson_1_1_u_t_f8.html">rapidjson::UTF8</a></div><div class="ttdoc">UTF-8 encoding. </div><div class="ttdef"><b>Definition:</b> encodings.h:101</div></div>
miloyip28df04d2014-08-08 13:48:11 +0000165<div class="ttc" id="classrapidjson_1_1_allocator_html"><div class="ttname"><a href="classrapidjson_1_1_allocator.html">rapidjson::Allocator</a></div><div class="ttdoc">Concept for allocating, resizing and freeing memory block. </div></div>
miloyip00af78c2014-08-18 16:15:53 +0000166<div class="ttc" id="namespacerapidjson_html_a51a6c35028b76e354bbb9e25d7125641"><div class="ttname"><a href="namespacerapidjson.html#a51a6c35028b76e354bbb9e25d7125641">rapidjson::StringBuffer</a></div><div class="ttdeci">GenericStringBuffer&lt; UTF8&lt;&gt; &gt; StringBuffer</div><div class="ttdoc">String buffer with UTF8 encoding. </div><div class="ttdef"><b>Definition:</b> stringbuffer.h:69</div></div>
miloyipeac02092014-10-30 14:07:14 +0000167<div class="ttc" id="namespacerapidjson_html_a1d49d2cab617858b53a1db23b1759f43"><div class="ttname"><a href="namespacerapidjson.html#a1d49d2cab617858b53a1db23b1759f43">rapidjson::PutN</a></div><div class="ttdeci">void PutN(Stream &amp;stream, Ch c, size_t n)</div><div class="ttdoc">Put N copies of a character to a stream. </div><div class="ttdef"><b>Definition:</b> rapidjson.h:484</div></div>
miloyip28df04d2014-08-08 13:48:11 +0000168</div><!-- fragment --></div><!-- contents -->
169</div><!-- doc-content -->
170<!-- HTML footer for doxygen 1.8.7-->
171<!-- start footer part -->
172<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
173 <ul>
174 <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>stringbuffer.h</b></li>
175 </ul>
176</div>