File: MemBufFormatTarget_8hpp-source.html

package info (click to toggle)
xerces-c 3.1.1-3%2Bdeb7u2
  • links: PTS
  • area: main
  • in suites: wheezy
  • size: 39,584 kB
  • sloc: cpp: 166,988; xml: 12,028; sh: 10,236; ansic: 3,984; makefile: 1,290; perl: 500
file content (134 lines) | stat: -rw-r--r-- 13,410 bytes parent folder | download | duplicates (5) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Xerces-C++: MemBufFormatTarget.hpp Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</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>
    </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 932887 2010-04-11 13:04:59Z borisk $</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 <a class="code" href="XercesDefs_8hpp.html#43d74fa53d868d978f3e97cbb78b194d">XERCES_CPP_NAMESPACE_BEGIN</a>
<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 initialized 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="classMemBufFormatTarget.html">00045</a> <span class="keyword">class </span><a class="code" href="XercesDefs_8hpp.html#13df5a01e63e51f62a1467b588b59054">XMLPARSER_EXPORT</a> <a class="code" href="classMemBufFormatTarget.html">MemBufFormatTarget</a> : <span class="keyword">public</span> <a class="code" href="classXMLFormatTarget.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="classMemBufFormatTarget.html">MemBufFormatTarget</a>
<a name="l00051"></a>00051     (
<a name="l00052"></a>00052           <a class="code" href="Xerces__autoconf__config_8borland_8hpp.html#c0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a>            initCapacity = 1023
<a name="l00053"></a>00053         , <a class="code" href="classMemoryManager.html" title="Configurable memory manager.">MemoryManager</a>* <span class="keyword">const</span> manager = <a class="code" href="classXMLPlatformUtils.html#97eff0d9fff3567bea3acd3ca4d95252" title="The configurable memory manager.">XMLPlatformUtils::fgMemoryManager</a>
<a name="l00054"></a>00054     ) ;
<a name="l00055"></a>00055     ~<a class="code" href="classMemBufFormatTarget.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="classXMLFormatTarget.html#8bef26717f930800ad2da0a356f62ef8">writeChars</a>(<span class="keyword">const</span> <a class="code" href="XercesDefs_8hpp.html#7470c7a32c59355685ebcd878a33f126">XMLByte</a>* <span class="keyword">const</span> toWrite
<a name="l00062"></a>00062                           , <span class="keyword">const</span> <a class="code" href="Xerces__autoconf__config_8borland_8hpp.html#c0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a>      count
<a name="l00063"></a>00063                           , <a class="code" href="classXMLFormatter.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> <a class="code" href="XercesDefs_8hpp.html#7470c7a32c59355685ebcd878a33f126">XMLByte</a>* getRawBuffer() <span class="keyword">const</span>;
<a name="l00076"></a>00076 
<a name="l00084"></a><a class="code" href="classMemBufFormatTarget.html#7d929cb36397ca0ec4b82a2b86eeb968">00084</a>     <a class="code" href="Xerces__autoconf__config_8borland_8hpp.html#c0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> 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="classMemBufFormatTarget.html">MemBufFormatTarget</a>(<span class="keyword">const</span> <a class="code" href="classMemBufFormatTarget.html">MemBufFormatTarget</a>&amp;);
<a name="l00103"></a>00103     <a class="code" href="classMemBufFormatTarget.html">MemBufFormatTarget</a>&amp; operator=(<span class="keyword">const</span> <a class="code" href="classMemBufFormatTarget.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> ensureCapacity(<span class="keyword">const</span> <a class="code" href="Xerces__autoconf__config_8borland_8hpp.html#c0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> 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="classMemoryManager.html" title="Configurable memory manager.">MemoryManager</a>*  fMemoryManager;
<a name="l00127"></a>00127     <a class="code" href="XercesDefs_8hpp.html#7470c7a32c59355685ebcd878a33f126">XMLByte</a>*        fDataBuf;
<a name="l00128"></a>00128     <a class="code" href="Xerces__autoconf__config_8borland_8hpp.html#c0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a>       fIndex;
<a name="l00129"></a>00129     <a class="code" href="Xerces__autoconf__config_8borland_8hpp.html#c0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a>       fCapacity;
<a name="l00130"></a>00130 
<a name="l00131"></a>00131 };
<a name="l00132"></a>00132 
<a name="l00133"></a>00133 <a class="code" href="XercesDefs_8hpp.html#f03d5cb905763ef7a7bd22ab82718285">XERCES_CPP_NAMESPACE_END</a>
<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 Wed Apr 21 17:55:48 2010 for Xerces-C++ by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>