<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>MWAWStringStream.hxx Source File documentation</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.8.15 --> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('',false,false,'search.php','Search'); }); /* @license-end */</script> <div id="main-nav"></div> </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('MWAWStringStream_8hxx_source.html','');}); /* @license-end */ </script> <div id="doc-content"> <div class="header"> <div class="headertitle"> <div class="title">MWAWStringStream.hxx</div> </div> </div><!--header--> <div class="contents"> <a href="MWAWStringStream_8hxx.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* -*- Mode: C++; c-default-style: "k&r"; indent-tabs-mode: nil; tab-width: 2; c-basic-offset: 2 -*- */</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> </div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">/* libmwaw</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">* Version: MPL 2.0 / LGPLv2+</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">*</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">* The contents of this file are subject to the Mozilla Public License Version</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">* 2.0 (the "License"); you may not use this file except in compliance with</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">* the License or as specified alternatively below. You may obtain a copy of</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">* the License at http://www.mozilla.org/MPL/</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">*</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">* Software distributed under the License is distributed on an "AS IS" basis,</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">* for the specific language governing rights and limitations under the</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">* License.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">*</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">* Alternatively, the contents of this file may be used under the terms of</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">* the GNU Lesser General Public License Version 2 or later (the "LGPLv2+"),</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">* in which case the provisions of the LGPLv2+ are applicable</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">* instead of those above.</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">*/</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> <span class="preprocessor">#ifndef MWAW_STRING_STREAM_HXX</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#define MWAW_STRING_STREAM_HXX</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <memory></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <librevenge-stream/librevenge-stream.h></span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">class </span><a class="code" href="classMWAWStringStreamPrivate.html">MWAWStringStreamPrivate</a>;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classMWAWStringStream.html"> 36</a></span> <span class="keyword">class </span><a class="code" href="classMWAWStringStream.html">MWAWStringStream</a> final : <span class="keyword">public</span> librevenge::RVNGInputStream</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> {</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <a class="code" href="classMWAWStringStream.html#aaf13b98f03e2c7e56544431ae30b05f4">MWAWStringStream</a>(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *data, <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> dataSize);</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <a class="code" href="classMWAWStringStream.html#afdc0cf3f090b8a7da05bd013a0c96942">~MWAWStringStream</a>() <span class="keyword">final</span>;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keywordtype">void</span> <a class="code" href="classMWAWStringStream.html#a77f8f1800d763cfa4ec7f153c0421004">append</a>(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *data, <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> dataSize);</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *<a class="code" href="classMWAWStringStream.html#ac014b2701fe5eb1322d964f0163ebade">read</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> numBytes, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> &numBytesRead) <span class="keyword">final</span>;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordtype">long</span> <a class="code" href="classMWAWStringStream.html#a598dbf4e01562fc14d729b3fae9ed86b">tell</a>() <span class="keyword">final</span>;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordtype">int</span> <a class="code" href="classMWAWStringStream.html#acf97b7634e96b7d9a1e69a049aa4de72">seek</a>(<span class="keywordtype">long</span> offset, librevenge::RVNG_SEEK_TYPE seekType) <span class="keyword">final</span>;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordtype">bool</span> <a class="code" href="classMWAWStringStream.html#aeec028d89f64b2560f8ce39d3b3f0044">isEnd</a>() <span class="keyword">final</span>;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordtype">bool</span> <a class="code" href="classMWAWStringStream.html#a93ffec17cfc8f8d0d52028112de4a7a3">isStructured</a>() <span class="keyword">final</span>;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordtype">unsigned</span> <a class="code" href="classMWAWStringStream.html#aec8dae97eb727289852790a33c57532e">subStreamCount</a>() <span class="keyword">final</span>;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="classMWAWStringStream.html#a010660ffa6cd5fdb1dc4a97ce04da9ad">subStreamName</a>(<span class="keywordtype">unsigned</span>) <span class="keyword">final</span>;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordtype">bool</span> <a class="code" href="classMWAWStringStream.html#a3023f708692549a6da731e914a8bd5ca">existsSubStream</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *name) <span class="keyword">final</span>;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  librevenge::RVNGInputStream *<a class="code" href="classMWAWStringStream.html#a4b9f59e0d41a0558993f3202ffca600f">getSubStreamByName</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *name) <span class="keyword">final</span>;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  librevenge::RVNGInputStream *<a class="code" href="classMWAWStringStream.html#afe51fe948ce8e4ed039d50c3324d2d6e">getSubStreamById</a>(<span class="keywordtype">unsigned</span>) <span class="keyword">final</span>;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00087"></a><span class="lineno"><a class="line" href="classMWAWStringStream.html#aa7d899e1c8501b9d85946dfbcb234744"> 87</a></span>  std::shared_ptr<MWAWStringStreamPrivate> <a class="code" href="classMWAWStringStream.html#aa7d899e1c8501b9d85946dfbcb234744">m_data</a>;</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <a class="code" href="classMWAWStringStream.html#aaf13b98f03e2c7e56544431ae30b05f4">MWAWStringStream</a>(<span class="keyword">const</span> <a class="code" href="classMWAWStringStream.html">MWAWStringStream</a> &) = <span class="keyword">delete</span>; <span class="comment">// copy is not allowed</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <a class="code" href="classMWAWStringStream.html">MWAWStringStream</a> &<a class="code" href="classMWAWStringStream.html#a535f6210977f39ca9436e927c2e793a6">operator=</a>(<span class="keyword">const</span> <a class="code" href="classMWAWStringStream.html">MWAWStringStream</a> &) = <span class="keyword">delete</span>; <span class="comment">// assignment is not allowed</span></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> </div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="preprocessor">#endif</span></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">// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:</span></div><div class="ttc" id="classMWAWStringStreamPrivate_html"><div class="ttname"><a href="classMWAWStringStreamPrivate.html">MWAWStringStreamPrivate</a></div><div class="ttdoc">internal data of a MWAWStringStream</div><div class="ttdef"><b>Definition:</b> MWAWStringStream.cxx:30</div></div> <div class="ttc" id="classMWAWStringStream_html_afe51fe948ce8e4ed039d50c3324d2d6e"><div class="ttname"><a href="classMWAWStringStream.html#afe51fe948ce8e4ed039d50c3324d2d6e">MWAWStringStream::getSubStreamById</a></div><div class="ttdeci">librevenge::RVNGInputStream * getSubStreamById(unsigned) final</div><div class="ttdoc">return a new stream for a ole zone</div><div class="ttdef"><b>Definition:</b> MWAWStringStream.cxx:166</div></div> <div class="ttc" id="classMWAWStringStream_html_afdc0cf3f090b8a7da05bd013a0c96942"><div class="ttname"><a href="classMWAWStringStream.html#afdc0cf3f090b8a7da05bd013a0c96942">MWAWStringStream::~MWAWStringStream</a></div><div class="ttdeci">~MWAWStringStream() final</div><div class="ttdoc">destructor</div><div class="ttdef"><b>Definition:</b> MWAWStringStream.cxx:76</div></div> <div class="ttc" id="classMWAWStringStream_html_ac014b2701fe5eb1322d964f0163ebade"><div class="ttname"><a href="classMWAWStringStream.html#ac014b2701fe5eb1322d964f0163ebade">MWAWStringStream::read</a></div><div class="ttdeci">const unsigned char * read(unsigned long numBytes, unsigned long &numBytesRead) final</div><div class="ttdoc">! reads numbytes data.</div><div class="ttdef"><b>Definition:</b> MWAWStringStream.cxx:85</div></div> <div class="ttc" id="classMWAWStringStream_html_acf97b7634e96b7d9a1e69a049aa4de72"><div class="ttname"><a href="classMWAWStringStream.html#acf97b7634e96b7d9a1e69a049aa4de72">MWAWStringStream::seek</a></div><div class="ttdeci">int seek(long offset, librevenge::RVNG_SEEK_TYPE seekType) final</div><div class="ttdoc">seeks to a offset position, from actual, beginning or ending position</div><div class="ttdef"><b>Definition:</b> MWAWStringStream.cxx:116</div></div> <div class="ttc" id="classMWAWStringStream_html_aeec028d89f64b2560f8ce39d3b3f0044"><div class="ttname"><a href="classMWAWStringStream.html#aeec028d89f64b2560f8ce39d3b3f0044">MWAWStringStream::isEnd</a></div><div class="ttdeci">bool isEnd() final</div><div class="ttdoc">returns true if we are at the end of the section/file</div><div class="ttdef"><b>Definition:</b> MWAWStringStream.cxx:138</div></div> <div class="ttc" id="classMWAWStringStream_html_a77f8f1800d763cfa4ec7f153c0421004"><div class="ttname"><a href="classMWAWStringStream.html#a77f8f1800d763cfa4ec7f153c0421004">MWAWStringStream::append</a></div><div class="ttdeci">void append(const unsigned char *data, const unsigned int dataSize)</div><div class="ttdoc">append some data at the end of the string</div><div class="ttdef"><b>Definition:</b> MWAWStringStream.cxx:80</div></div> <div class="ttc" id="classMWAWStringStream_html_aec8dae97eb727289852790a33c57532e"><div class="ttname"><a href="classMWAWStringStream.html#aec8dae97eb727289852790a33c57532e">MWAWStringStream::subStreamCount</a></div><div class="ttdeci">unsigned subStreamCount() final</div><div class="ttdoc">returns the number of sub streams.</div><div class="ttdef"><b>Definition:</b> MWAWStringStream.cxx:151</div></div> <div class="ttc" id="classMWAWStringStream_html_a010660ffa6cd5fdb1dc4a97ce04da9ad"><div class="ttname"><a href="classMWAWStringStream.html#a010660ffa6cd5fdb1dc4a97ce04da9ad">MWAWStringStream::subStreamName</a></div><div class="ttdeci">const char * subStreamName(unsigned) final</div><div class="ttdoc">returns the ith sub streams name</div><div class="ttdef"><b>Definition:</b> MWAWStringStream.cxx:156</div></div> <div class="ttc" id="classMWAWStringStream_html_a3023f708692549a6da731e914a8bd5ca"><div class="ttname"><a href="classMWAWStringStream.html#a3023f708692549a6da731e914a8bd5ca">MWAWStringStream::existsSubStream</a></div><div class="ttdeci">bool existsSubStream(const char *name) final</div><div class="ttdoc">returns true if a substream with name exists</div><div class="ttdef"><b>Definition:</b> MWAWStringStream.cxx:161</div></div> <div class="ttc" id="classMWAWStringStream_html"><div class="ttname"><a href="classMWAWStringStream.html">MWAWStringStream</a></div><div class="ttdoc">internal class used to create a RVNGInputStream from a unsigned char's pointer</div><div class="ttdef"><b>Definition:</b> MWAWStringStream.hxx:36</div></div> <div class="ttc" id="classMWAWStringStream_html_a535f6210977f39ca9436e927c2e793a6"><div class="ttname"><a href="classMWAWStringStream.html#a535f6210977f39ca9436e927c2e793a6">MWAWStringStream::operator=</a></div><div class="ttdeci">MWAWStringStream & operator=(const MWAWStringStream &)=delete</div></div> <div class="ttc" id="classMWAWStringStream_html_a4b9f59e0d41a0558993f3202ffca600f"><div class="ttname"><a href="classMWAWStringStream.html#a4b9f59e0d41a0558993f3202ffca600f">MWAWStringStream::getSubStreamByName</a></div><div class="ttdeci">librevenge::RVNGInputStream * getSubStreamByName(const char *name) final</div><div class="ttdoc">return a new stream for a ole zone</div><div class="ttdef"><b>Definition:</b> MWAWStringStream.cxx:171</div></div> <div class="ttc" id="classMWAWStringStream_html_aaf13b98f03e2c7e56544431ae30b05f4"><div class="ttname"><a href="classMWAWStringStream.html#aaf13b98f03e2c7e56544431ae30b05f4">MWAWStringStream::MWAWStringStream</a></div><div class="ttdeci">MWAWStringStream(const unsigned char *data, const unsigned int dataSize)</div><div class="ttdoc">constructor</div><div class="ttdef"><b>Definition:</b> MWAWStringStream.cxx:70</div></div> <div class="ttc" id="classMWAWStringStream_html_aa7d899e1c8501b9d85946dfbcb234744"><div class="ttname"><a href="classMWAWStringStream.html#aa7d899e1c8501b9d85946dfbcb234744">MWAWStringStream::m_data</a></div><div class="ttdeci">std::shared_ptr< MWAWStringStreamPrivate > m_data</div><div class="ttdoc">the string stream data</div><div class="ttdef"><b>Definition:</b> MWAWStringStream.hxx:87</div></div> <div class="ttc" id="classMWAWStringStream_html_a598dbf4e01562fc14d729b3fae9ed86b"><div class="ttname"><a href="classMWAWStringStream.html#a598dbf4e01562fc14d729b3fae9ed86b">MWAWStringStream::tell</a></div><div class="ttdeci">long tell() final</div><div class="ttdoc">returns actual offset position</div><div class="ttdef"><b>Definition:</b> MWAWStringStream.cxx:111</div></div> <div class="ttc" id="classMWAWStringStream_html_a93ffec17cfc8f8d0d52028112de4a7a3"><div class="ttname"><a href="classMWAWStringStream.html#a93ffec17cfc8f8d0d52028112de4a7a3">MWAWStringStream::isStructured</a></div><div class="ttdeci">bool isStructured() final</div><div class="ttdoc">returns true if the stream is ole</div><div class="ttdef"><b>Definition:</b> MWAWStringStream.cxx:146</div></div> </div><!-- fragment --></div><!-- contents --> </div><!-- doc-content --> <hr size="1"><address style="align: right;"><small> Generated on Wed May 20 2020 10:14:02 for libmwaw by <a href="http://www.doxygen.org/index.html"> doxygen</a> 1.8.15</small></address> </body> </html>