XQuilla/docs/simple-api/MemBufInputSource_8hpp_source.html
2020-02-17 22:19:57 +01:00

155 lines
14 KiB
HTML

<!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>XQilla Simple API Documentation</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<a style="float:right;" href="http://sourceforge.net/projects/xqilla"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=152021&amp;type=2" border="0" alt="SourceForge.net Logo" /></a>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
<h1>MemBufInputSource.hpp</h1><a href="MemBufInputSource_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</span>
<a name="l00003"></a>00003 <span class="comment"> * contributor license agreements. See the NOTICE file distributed with</span>
<a name="l00004"></a>00004 <span class="comment"> * this work for additional information regarding copyright ownership.</span>
<a name="l00005"></a>00005 <span class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</span>
<a name="l00006"></a>00006 <span class="comment"> * (the &quot;License&quot;); you may not use this file except in compliance with</span>
<a name="l00007"></a>00007 <span class="comment"> * the License. You may obtain a copy of the License at</span>
<a name="l00008"></a>00008 <span class="comment"> * </span>
<a name="l00009"></a>00009 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<a name="l00010"></a>00010 <span class="comment"> * </span>
<a name="l00011"></a>00011 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span>
<a name="l00012"></a>00012 <span class="comment"> * distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span>
<a name="l00013"></a>00013 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<a name="l00014"></a>00014 <span class="comment"> * See the License for the specific language governing permissions and</span>
<a name="l00015"></a>00015 <span class="comment"> * limitations under the License.</span>
<a name="l00016"></a>00016 <span class="comment"> */</span>
<a name="l00017"></a>00017
<a name="l00018"></a>00018 <span class="comment">/*</span>
<a name="l00019"></a>00019 <span class="comment"> * $Id: MemBufInputSource.hpp 553941 2007-07-06 16:14:22Z amassari $</span>
<a name="l00020"></a>00020 <span class="comment"> */</span>
<a name="l00021"></a>00021
<a name="l00022"></a>00022
<a name="l00023"></a>00023 <span class="preprocessor">#if !defined(XERCESC_INCLUDE_GUARD_MEMBUFINPUTSOURCE_HPP)</span>
<a name="l00024"></a><a class="code" href="MemBufInputSource_8hpp.html#a8d027368c2ff026463ed6450c329e158">00024</a> <span class="preprocessor"></span><span class="preprocessor">#define XERCESC_INCLUDE_GUARD_MEMBUFINPUTSOURCE_HPP</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include &lt;<a class="code" href="InputSource_8hpp.html">xercesc/sax/InputSource.hpp</a>&gt;</span>
<a name="l00027"></a>00027
<a name="l00028"></a>00028 XERCES_CPP_NAMESPACE_BEGIN
<a name="l00029"></a>00029
<a name="l00030"></a>00030 <span class="keyword">class </span>BinInputStream;
<a name="l00031"></a>00031
<a name="l00032"></a>00032
<a name="l00061"></a><a class="code" href="classxercesc_1_1MemBufInputSource.html">00061</a> <span class="keyword">class </span>XMLPARSER_EXPORT <a class="code" href="classxercesc_1_1MemBufInputSource.html" title="This class is a derivative of the standard InputSource class.">MemBufInputSource</a> : <span class="keyword">public</span> <a class="code" href="classxercesc_1_1InputSource.html" title="A single input source for an XML entity.">InputSource</a>
<a name="l00062"></a>00062 {
<a name="l00063"></a>00063 <span class="keyword">public</span> :
<a name="l00064"></a>00064 <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00065"></a>00065 <span class="comment">// Constructors and Destructor</span>
<a name="l00066"></a>00066 <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00067"></a>00067
<a name="l00070"></a>00070
<a name="l00093"></a>00093 <a class="code" href="classxercesc_1_1MemBufInputSource.html" title="This class is a derivative of the standard InputSource class.">MemBufInputSource</a>
<a name="l00094"></a>00094 (
<a name="l00095"></a>00095 <span class="keyword">const</span> XMLByte* <span class="keyword">const</span> srcDocBytes
<a name="l00096"></a>00096 , <span class="keyword">const</span> XMLSize_t byteCount
<a name="l00097"></a>00097 , <span class="keyword">const</span> XMLCh* <span class="keyword">const</span> bufId
<a name="l00098"></a>00098 , <span class="keyword">const</span> <span class="keywordtype">bool</span> adoptBuffer = <span class="keyword">false</span>
<a name="l00099"></a>00099 , <a class="code" href="classxercesc_1_1MemoryManager.html" title="Configurable memory manager.">MemoryManager</a>* <span class="keyword">const</span> manager = XMLPlatformUtils::fgMemoryManager
<a name="l00100"></a>00100 );
<a name="l00101"></a>00101
<a name="l00106"></a>00106 <a class="code" href="classxercesc_1_1MemBufInputSource.html" title="This class is a derivative of the standard InputSource class.">MemBufInputSource</a>
<a name="l00107"></a>00107 (
<a name="l00108"></a>00108 <span class="keyword">const</span> XMLByte* <span class="keyword">const</span> srcDocBytes
<a name="l00109"></a>00109 , <span class="keyword">const</span> XMLSize_t byteCount
<a name="l00110"></a>00110 , <span class="keyword">const</span> <span class="keywordtype">char</span>* <span class="keyword">const</span> bufId
<a name="l00111"></a>00111 , <span class="keyword">const</span> <span class="keywordtype">bool</span> adoptBuffer = <span class="keyword">false</span>
<a name="l00112"></a>00112 , <a class="code" href="classxercesc_1_1MemoryManager.html" title="Configurable memory manager.">MemoryManager</a>* <span class="keyword">const</span> manager = XMLPlatformUtils::fgMemoryManager
<a name="l00113"></a>00113 );
<a name="l00115"></a>00115
<a name="l00122"></a>00122 ~<a class="code" href="classxercesc_1_1MemBufInputSource.html" title="This class is a derivative of the standard InputSource class.">MemBufInputSource</a>();
<a name="l00124"></a>00124
<a name="l00125"></a>00125
<a name="l00126"></a>00126 <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00127"></a>00127 <span class="comment">// Virtual input source interface</span>
<a name="l00128"></a>00128 <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00129"></a>00129
<a name="l00132"></a>00132
<a name="l00143"></a>00143 BinInputStream* <a class="code" href="classxercesc_1_1InputSource.html#a9d3101df0ae8a72045f81a7028bc36d8" title="Makes the byte stream for this input source.">makeStream</a>() <span class="keyword">const</span>;
<a name="l00144"></a>00144
<a name="l00146"></a>00146
<a name="l00147"></a>00147
<a name="l00148"></a>00148 <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00149"></a>00149 <span class="comment">// Setter methods</span>
<a name="l00150"></a>00150 <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00151"></a>00151
<a name="l00155"></a>00155
<a name="l00171"></a>00171 <span class="keywordtype">void</span> setCopyBufToStream(<span class="keyword">const</span> <span class="keywordtype">bool</span> newState);
<a name="l00172"></a>00172
<a name="l00182"></a>00182 <span class="keywordtype">void</span> resetMemBufInputSource(<span class="keyword">const</span> XMLByte* <span class="keyword">const</span> srcDocBytes
<a name="l00183"></a>00183 , <span class="keyword">const</span> XMLSize_t byteCount);
<a name="l00185"></a>00185
<a name="l00186"></a>00186
<a name="l00187"></a>00187 <span class="keyword">private</span> :
<a name="l00188"></a>00188 <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00189"></a>00189 <span class="comment">// Unimplemented constructors and operators</span>
<a name="l00190"></a>00190 <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00191"></a>00191 <a class="code" href="classxercesc_1_1MemBufInputSource.html" title="This class is a derivative of the standard InputSource class.">MemBufInputSource</a>(<span class="keyword">const</span> <a class="code" href="classxercesc_1_1MemBufInputSource.html" title="This class is a derivative of the standard InputSource class.">MemBufInputSource</a>&amp;);
<a name="l00192"></a>00192 <a class="code" href="classxercesc_1_1MemBufInputSource.html" title="This class is a derivative of the standard InputSource class.">MemBufInputSource</a>&amp; operator=(<span class="keyword">const</span> <a class="code" href="classxercesc_1_1MemBufInputSource.html" title="This class is a derivative of the standard InputSource class.">MemBufInputSource</a>&amp;);
<a name="l00193"></a>00193
<a name="l00194"></a>00194 <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00195"></a>00195 <span class="comment">// Private data members</span>
<a name="l00196"></a>00196 <span class="comment">//</span>
<a name="l00197"></a>00197 <span class="comment">// fAdopted</span>
<a name="l00198"></a>00198 <span class="comment">// Indicates whether the buffer is adopted or not. If so, then it</span>
<a name="l00199"></a>00199 <span class="comment">// is destroyed when the input source is destroyed.</span>
<a name="l00200"></a>00200 <span class="comment">//</span>
<a name="l00201"></a>00201 <span class="comment">// fByteCount</span>
<a name="l00202"></a>00202 <span class="comment">// The size of the source document.</span>
<a name="l00203"></a>00203 <span class="comment">//</span>
<a name="l00204"></a>00204 <span class="comment">// fCopyBufToStream</span>
<a name="l00205"></a>00205 <span class="comment">// This defaults to true (the safe option), which causes it to</span>
<a name="l00206"></a>00206 <span class="comment">// give a copy of the buffer to any streams it creates. If you set</span>
<a name="l00207"></a>00207 <span class="comment">// it to false, it will allow the streams to just reference the</span>
<a name="l00208"></a>00208 <span class="comment">// buffer (in which case this input source must stay alive as long</span>
<a name="l00209"></a>00209 <span class="comment">// as the buffer is in use by the stream.)</span>
<a name="l00210"></a>00210 <span class="comment">//</span>
<a name="l00211"></a>00211 <span class="comment">// fSrcBytes</span>
<a name="l00212"></a>00212 <span class="comment">// The source memory buffer that is being spooled from. Whether it</span>
<a name="l00213"></a>00213 <span class="comment">// belongs to the this input source or not is controlled by the</span>
<a name="l00214"></a>00214 <span class="comment">// fAdopted flag.</span>
<a name="l00215"></a>00215 <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00216"></a>00216 <span class="keywordtype">bool</span> fAdopted;
<a name="l00217"></a>00217 XMLSize_t fByteCount;
<a name="l00218"></a>00218 <span class="keywordtype">bool</span> fCopyBufToStream;
<a name="l00219"></a>00219 <span class="keyword">const</span> XMLByte* fSrcBytes;
<a name="l00220"></a>00220 };
<a name="l00221"></a>00221
<a name="l00222"></a>00222
<a name="l00223"></a><a class="code" href="classxercesc_1_1MemBufInputSource.html#a9efbedc3d265c066bc6fa65530ab7e75">00223</a> <span class="keyword">inline</span> <span class="keywordtype">void</span> MemBufInputSource::setCopyBufToStream(<span class="keyword">const</span> <span class="keywordtype">bool</span> newState)
<a name="l00224"></a>00224 {
<a name="l00225"></a>00225 fCopyBufToStream = newState;
<a name="l00226"></a>00226 }
<a name="l00227"></a>00227
<a name="l00228"></a>00228 XERCES_CPP_NAMESPACE_END
<a name="l00229"></a>00229
<a name="l00230"></a>00230 <span class="preprocessor">#endif</span>
</pre></div></div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Fri Nov 13 14:59:31 2009 for XQilla Simple API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>