| <!-- 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/filewritestream.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('filewritestream_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">filewritestream.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_FILEWRITESTREAM_H_</span></div> |
| <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#define RAPIDJSON_FILEWRITESTREAM_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> <span class="preprocessor">#include <cstdio></span></div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  </div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#ifdef __clang__</span></div> |
| <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> RAPIDJSON_DIAG_PUSH</div> |
| <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> RAPIDJSON_DIAG_OFF(unreachable-code)</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">//! Wrapper of C file stream for output using fwrite().</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"> \note implements Stream concept</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"><a class="line" href="classrapidjson_1_1_file_write_stream.html"> 32</a></span> <span class="keyword">class </span><a class="code" href="classrapidjson_1_1_file_write_stream.html">FileWriteStream</a> {</div> |
| <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classrapidjson_1_1_file_write_stream.html#afc606cc81f6c3709d81bf99b30566330"> 34</a></span>  <span class="keyword">typedef</span> <span class="keywordtype">char</span> <a class="code" href="classrapidjson_1_1_file_write_stream.html#afc606cc81f6c3709d81bf99b30566330">Ch</a>; <span class="comment">//!< Character type. Only support char.</span></div> |
| <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"></span> </div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <a class="code" href="classrapidjson_1_1_file_write_stream.html">FileWriteStream</a>(std::FILE* fp, <span class="keywordtype">char</span>* buffer, <span class="keywordtype">size_t</span> bufferSize) : fp_(fp), buffer_(buffer), bufferEnd_(buffer + bufferSize), current_(buffer_) { </div> |
| <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <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>(fp_ != 0);</div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  }</div> |
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  </div> |
| <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordtype">void</span> Put(<span class="keywordtype">char</span> c) { </div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordflow">if</span> (current_ >= bufferEnd_)</div> |
| <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  Flush();</div> |
| <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  </div> |
| <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  *current_++ = c;</div> |
| <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  }</div> |
| <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  </div> |
| <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordtype">void</span> PutN(<span class="keywordtype">char</span> c, <span class="keywordtype">size_t</span> n) {</div> |
| <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordtype">size_t</span> avail = static_cast<size_t>(bufferEnd_ - current_);</div> |
| <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordflow">while</span> (n > avail) {</div> |
| <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  std::memset(current_, c, avail);</div> |
| <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  current_ += avail;</div> |
| <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  Flush();</div> |
| <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  n -= avail;</div> |
| <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  avail = static_cast<size_t>(bufferEnd_ - current_);</div> |
| <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  }</div> |
| <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  </div> |
| <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordflow">if</span> (n > 0) {</div> |
| <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  std::memset(current_, c, n);</div> |
| <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  current_ += n;</div> |
| <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  }</div> |
| <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  }</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>  <span class="keywordtype">void</span> Flush() {</div> |
| <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordflow">if</span> (current_ != buffer_) {</div> |
| <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordtype">size_t</span> result = std::fwrite(buffer_, 1, static_cast<size_t>(current_ - buffer_), fp_);</div> |
| <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordflow">if</span> (result < static_cast<size_t>(current_ - buffer_)) {</div> |
| <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="comment">// failure deliberately ignored at this time</span></div> |
| <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="comment">// added to avoid warn_unused_result build errors</span></div> |
| <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  }</div> |
| <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  current_ = buffer_;</div> |
| <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  }</div> |
| <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  }</div> |
| <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  </div> |
| <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="comment">// Not implemented</span></div> |
| <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordtype">char</span> Peek()<span class="keyword"> const </span>{ <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="l00076"></a><span class="lineno"> 76</span>  <span class="keywordtype">char</span> Take() { <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="l00077"></a><span class="lineno"> 77</span>  <span class="keywordtype">size_t</span> Tell()<span class="keyword"> const </span>{ <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="l00078"></a><span class="lineno"> 78</span>  <span class="keywordtype">char</span>* 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="l00079"></a><span class="lineno"> 79</span>  <span class="keywordtype">size_t</span> PutEnd(<span class="keywordtype">char</span>*) { <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="l00080"></a><span class="lineno"> 80</span>  </div> |
| <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="keyword">private</span>:</div> |
| <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="comment">// Prohibit copy constructor & assignment operator.</span></div> |
| <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  FileWriteStream(<span class="keyword">const</span> FileWriteStream&);</div> |
| <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  FileWriteStream& operator=(<span class="keyword">const</span> FileWriteStream&);</div> |
| <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  </div> |
| <div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  std::FILE* fp_;</div> |
| <div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordtype">char</span> *buffer_;</div> |
| <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordtype">char</span> *bufferEnd_;</div> |
| <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordtype">char</span> *current_;</div> |
| <div class="line"><a name="l00090"></a><span class="lineno"> 90</span> };</div> |
| <div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"></span> </div> |
| <div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment">//! Implement specialized version of PutN() with memset() for better performance.</span></div> |
| <div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"></span><span class="keyword">template</span><></div> |
| <div class="line"><a name="l00094"></a><span class="lineno"><a class="line" href="namespacerapidjson.html#a1ac13bac5976fc06587e00fc0bcfb32a"> 94</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_file_write_stream.html">FileWriteStream</a>& stream, <span class="keywordtype">char</span> c, <span class="keywordtype">size_t</span> n) {</div> |
| <div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  stream.PutN(c, n);</div> |
| <div class="line"><a name="l00096"></a><span class="lineno"> 96</span> }</div> |
| <div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  </div> |
| <div class="line"><a name="l00098"></a><span class="lineno"> 98</span> RAPIDJSON_NAMESPACE_END</div> |
| <div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  </div> |
| <div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="preprocessor">#ifdef __clang__</span></div> |
| <div class="line"><a name="l00101"></a><span class="lineno"> 101</span> RAPIDJSON_DIAG_POP</div> |
| <div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="preprocessor">#endif</span></div> |
| <div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  </div> |
| <div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="preprocessor">#endif // RAPIDJSON_FILESTREAM_H_</span></div> |
| </div><!-- fragment --></div><!-- contents --> |
| </div><!-- doc-content --> |
| <div class="ttc" id="aclassrapidjson_1_1_file_write_stream_html"><div class="ttname"><a href="classrapidjson_1_1_file_write_stream.html">rapidjson::FileWriteStream</a></div><div class="ttdoc">Wrapper of C file stream for output using fwrite().</div><div class="ttdef"><b>Definition:</b> filewritestream.h:32</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="aclassrapidjson_1_1_file_write_stream_html_afc606cc81f6c3709d81bf99b30566330"><div class="ttname"><a href="classrapidjson_1_1_file_write_stream.html#afc606cc81f6c3709d81bf99b30566330">rapidjson::FileWriteStream::Ch</a></div><div class="ttdeci">char Ch</div><div class="ttdoc">Character type. Only support char.</div><div class="ttdef"><b>Definition:</b> filewritestream.h:34</div></div> |
| <div class="ttc" id="anamespacerapidjson_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> |
| <!-- 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>filewritestream.h</b></li> |
| </ul> |
| </div> |
| </body> |
| </html> |
