mirror/XQuilla
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
XQuilla/docs/simple-api/MemBufFormatTarget_8hpp-source.html
King_DuckZ 4bc0157dcd v2.2.0
2020-02-17 22:17:06 +01:00

136 lines
12 KiB
HTML
Raw Blame History

<!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.5.5 -->
<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="classes.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>
<h1>MemBufFormatTarget.hpp</h1><a href="MemBufFormatTarget_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 "License"); 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 "AS IS" 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: MemBufFormatTarget.hpp 553937 2007-07-06 16:02:19Z amassari $</span>
<a name="l00020"></a>00020 <span class="comment"> */</span>
<a name="l00021"></a>00021
<a name="l00022"></a>00022 <span class="preprocessor">#if !defined(XERCESC_INCLUDE_GUARD_MEMBUFFORMATTARGET_HPP)</span>
<a name="l00023"></a><a class="code" href="MemBufFormatTarget_8hpp.html#44cac7f521e3c414fd6c21dcebfc459f">00023</a> <span class="preprocessor"></span><span class="preprocessor">#define XERCESC_INCLUDE_GUARD_MEMBUFFORMATTARGET_HPP</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include &lt;<a class="code" href="XMLFormatter_8hpp.html">xercesc/framework/XMLFormatter.hpp</a>&gt;</span>
<a name="l00026"></a>00026
<a name="l00027"></a>00027 XERCES_CPP_NAMESPACE_BEGIN
<a name="l00028"></a>00028
<a name="l00029"></a>00029 <span class="comment">/*</span>
<a name="l00030"></a>00030 <span class="comment"> * The MemBufFormatTarget is a derivative from XMLFormatTarget, which user code</span>
<a name="l00031"></a>00031 <span class="comment"> * may plug into DOMLSSerializer to retrieve the serialized XML stream (from DOM Tree)</span>
<a name="l00032"></a>00032 <span class="comment"> * in a memory buffer.</span>
<a name="l00033"></a>00033 <span class="comment"> *</span>
<a name="l00034"></a>00034 <span class="comment"> * The MemBufFormatTarget is initalized to have a memory buffer of 1023 upon</span>
<a name="l00035"></a>00035 <span class="comment"> * construction, which grows as needed. The buffer will be deleted when</span>
<a name="l00036"></a>00036 <span class="comment"> * MemBufFormatTarget is destructed; or will be reset when the reset() function</span>
<a name="l00037"></a>00037 <span class="comment"> * is called.</span>
<a name="l00038"></a>00038 <span class="comment"> *</span>
<a name="l00039"></a>00039 <span class="comment"> * The MemBufFormatTarget returns a NULL terminated XMLByte stream upon request,</span>
<a name="l00040"></a>00040 <span class="comment"> * through the method getRawBuffer(), and user should make its own copy of the</span>
<a name="l00041"></a>00041 <span class="comment"> * returned buffer if it intends to keep it independent on the state of the</span>
<a name="l00042"></a>00042 <span class="comment"> * MemBufFormatTarget.</span>
<a name="l00043"></a>00043 <span class="comment"> */</span>
<a name="l00044"></a>00044
<a name="l00045"></a><a class="code" href="classxercesc_1_1MemBufFormatTarget.html">00045</a> <span class="keyword">class </span>XMLPARSER_EXPORT <a class="code" href="classxercesc_1_1MemBufFormatTarget.html">MemBufFormatTarget</a> : <span class="keyword">public</span> <a class="code" href="classxercesc_1_1XMLFormatTarget.html">XMLFormatTarget</a> {
<a name="l00046"></a>00046 <span class="keyword">public</span>:
<a name="l00047"></a>00047
<a name="l00050"></a>00050 <a class="code" href="classxercesc_1_1MemBufFormatTarget.html">MemBufFormatTarget</a>
<a name="l00051"></a>00051 (
<a name="l00052"></a>00052 XMLSize_t initCapacity = 1023
<a name="l00053"></a>00053 , <a class="code" href="classxercesc_1_1MemoryManager.html" title="Configurable memory manager.">MemoryManager</a>* <span class="keyword">const</span> manager = XMLPlatformUtils::fgMemoryManager
<a name="l00054"></a>00054 ) ;
<a name="l00055"></a>00055 ~<a class="code" href="classxercesc_1_1MemBufFormatTarget.html">MemBufFormatTarget</a>();
<a name="l00057"></a>00057
<a name="l00058"></a>00058 <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00059"></a>00059 <span class="comment">// Implementations of the format target interface</span>
<a name="l00060"></a>00060 <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00061"></a>00061 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classxercesc_1_1XMLFormatTarget.html#bb3f9418f5a83b2f97d83855cde624d7">writeChars</a>(<span class="keyword">const</span> XMLByte* <span class="keyword">const</span> toWrite
<a name="l00062"></a>00062 , <span class="keyword">const</span> XMLSize_t count
<a name="l00063"></a>00063 , <a class="code" href="classxercesc_1_1XMLFormatter.html" title="This class provides the basic formatting capabilities that are required to turn the...">XMLFormatter</a>* <span class="keyword">const</span> formatter);
<a name="l00064"></a>00064
<a name="l00065"></a>00065 <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00066"></a>00066 <span class="comment">// Getter</span>
<a name="l00067"></a>00067 <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00075"></a>00075 <span class="comment"></span> <span class="keyword">const</span> XMLByte* getRawBuffer() <span class="keyword">const</span>;
<a name="l00076"></a>00076
<a name="l00084"></a><a class="code" href="classxercesc_1_1MemBufFormatTarget.html#5141eca18c075bd7545341640a818ea1">00084</a> XMLSize_t getLen()<span class="keyword"> const</span>
<a name="l00085"></a>00085 <span class="keyword"> </span>{
<a name="l00086"></a>00086 <span class="keywordflow">return</span> fIndex;
<a name="l00087"></a>00087 }
<a name="l00088"></a>00088
<a name="l00095"></a>00095 <span class="keywordtype">void</span> reset();
<a name="l00097"></a>00097
<a name="l00098"></a>00098 <span class="keyword">private</span>:
<a name="l00099"></a>00099 <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00100"></a>00100 <span class="comment">// Unimplemented methods.</span>
<a name="l00101"></a>00101 <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00102"></a>00102 <a class="code" href="classxercesc_1_1MemBufFormatTarget.html">MemBufFormatTarget</a>(<span class="keyword">const</span> <a class="code" href="classxercesc_1_1MemBufFormatTarget.html">MemBufFormatTarget</a>&amp;);
<a name="l00103"></a>00103 <a class="code" href="classxercesc_1_1MemBufFormatTarget.html">MemBufFormatTarget</a>&amp; operator=(<span class="keyword">const</span> <a class="code" href="classxercesc_1_1MemBufFormatTarget.html">MemBufFormatTarget</a>&amp;);
<a name="l00104"></a>00104
<a name="l00105"></a>00105 <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00106"></a>00106 <span class="comment">// Private helpers</span>
<a name="l00107"></a>00107 <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00108"></a>00108 <span class="keywordtype">void</span> insureCapacity(<span class="keyword">const</span> XMLSize_t extraNeeded);
<a name="l00109"></a>00109
<a name="l00110"></a>00110 <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00111"></a>00111 <span class="comment">// Private data members</span>
<a name="l00112"></a>00112 <span class="comment">//</span>
<a name="l00113"></a>00113 <span class="comment">// fDataBuf</span>
<a name="l00114"></a>00114 <span class="comment">// The pointer to the buffer data. Its grown as needed. Its always</span>
<a name="l00115"></a>00115 <span class="comment">// one larger than fCapacity, to leave room for the null terminator.</span>
<a name="l00116"></a>00116 <span class="comment">//</span>
<a name="l00117"></a>00117 <span class="comment">// fIndex</span>
<a name="l00118"></a>00118 <span class="comment">// The current index into the buffer, as characters are appended</span>
<a name="l00119"></a>00119 <span class="comment">// to it. If its zero, then the buffer is empty.</span>
<a name="l00120"></a>00120 <span class="comment">//</span>
<a name="l00121"></a>00121 <span class="comment">// fCapacity</span>
<a name="l00122"></a>00122 <span class="comment">// The current capacity of the buffer. Its actually always one</span>
<a name="l00123"></a>00123 <span class="comment">// larger, to leave room for the null terminator.</span>
<a name="l00124"></a>00124 <span class="comment">//</span>
<a name="l00125"></a>00125 <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00126"></a>00126 <a class="code" href="classxercesc_1_1MemoryManager.html" title="Configurable memory manager.">MemoryManager</a>* fMemoryManager;
<a name="l00127"></a>00127 XMLByte* fDataBuf;
<a name="l00128"></a>00128 XMLSize_t fIndex;
<a name="l00129"></a>00129 XMLSize_t fCapacity;
<a name="l00130"></a>00130
<a name="l00131"></a>00131 };
<a name="l00132"></a>00132
<a name="l00133"></a>00133 XERCES_CPP_NAMESPACE_END
<a name="l00134"></a>00134
<a name="l00135"></a>00135 <span class="preprocessor">#endif</span>
<a name="l00136"></a>00136 <span class="preprocessor"></span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jan 5 19:53:55 2009 for XQilla Simple API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink