blob: 1b2d2021e7e8b08444717f09caa9496a146fe253 [file] [log] [blame]
<HTML><HEAD><TITLE>Xalan-C++ API Documentation</TITLE></HEAD>
<BODY>
<h2 align="center">Xalan-C++ API Documentation</h2>
<h3 align="center">The Xalan C++ XSLT Processor Version 1.10</h3>
</BODY>
<!-- Generated by Doxygen 1.2.8.1 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>FormatterToSourceTree.hpp</h1><a href="FormatterToSourceTree_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <font class="comment">/*</font>
00002 <font class="comment"> * Copyright 1999-2004 The Apache Software Foundation.</font>
00003 <font class="comment"> *</font>
00004 <font class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</font>
00005 <font class="comment"> * you may not use this file except in compliance with the License.</font>
00006 <font class="comment"> * You may obtain a copy of the License at</font>
00007 <font class="comment"> *</font>
00008 <font class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</font>
00009 <font class="comment"> *</font>
00010 <font class="comment"> * Unless required by applicable law or agreed to in writing, software</font>
00011 <font class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</font>
00012 <font class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</font>
00013 <font class="comment"> * See the License for the specific language governing permissions and</font>
00014 <font class="comment"> * limitations under the License.</font>
00015 <font class="comment"> */</font>
00016 <font class="preprocessor">#if !defined(FORMATTERTOSOURCETREE_HEADER_GUARD_1357924680)</font>
<a name="l00017"></a><a class="code" href="FormatterToSourceTree_8hpp.html#a0">00017</a> <font class="preprocessor"></font><font class="preprocessor">#define FORMATTERTOSOURCETREE_HEADER_GUARD_1357924680</font>
00018 <font class="preprocessor"></font>
00019
00020
00021 <font class="comment">// Base include file. Must be first.</font>
00022 <font class="preprocessor">#include &lt;<a class="code" href="XalanSourceTreeDefinitions_8hpp.html">xalanc/XalanSourceTree/XalanSourceTreeDefinitions.hpp</a>&gt;</font>
00023
00024
00025
00026 <font class="preprocessor">#include &lt;<a class="code" href="XalanVector_8hpp.html">xalanc/Include/XalanVector.hpp</a>&gt;</font>
00027
00028
00029
00030 <font class="comment">// Base class header file.</font>
00031 <font class="preprocessor">#include &lt;<a class="code" href="FormatterListener_8hpp.html">xalanc/PlatformSupport/FormatterListener.hpp</a>&gt;</font>
00032
00033
00034
00035 <font class="preprocessor">#include &lt;<a class="code" href="XalanDOMString_8hpp.html">xalanc/XalanDOM/XalanDOMString.hpp</a>&gt;</font>
00036
00037
00038
00039 XALAN_CPP_NAMESPACE_BEGIN
00040
00041
00042
<a name="l00043"></a><a class="code" href="FormatterToSourceTree_8hpp.html#a1">00043</a> <font class="keyword">class </font><a class="code" href="classPrefixResolver.html">PrefixResolver</a>;
00044 <font class="keyword">class </font><a class="code" href="classXalanNode.html">XalanNode</a>;
00045 <font class="keyword">class </font><a class="code" href="classXalanSourceTreeDocument.html">XalanSourceTreeDocument</a>;
00046 <font class="keyword">class </font><a class="code" href="classXalanSourceTreeDocumentFragment.html">XalanSourceTreeDocumentFragment</a>;
00047 <font class="keyword">class </font><a class="code" href="classXalanSourceTreeElement.html">XalanSourceTreeElement</a>;
00048
00049
00050
<a name="l00055"></a><a class="code" href="classFormatterToSourceTree.html">00055</a> <font class="keyword">class </font>XALAN_XALANSOURCETREE_EXPORT <a class="code" href="classFormatterToSourceTree.html">FormatterToSourceTree</a> : <font class="keyword">public</font> <a class="code" href="classFormatterListener.html">FormatterListener</a>
00056 {
00057 <font class="keyword">public</font>:
00058
<a name="l00059"></a><a class="code" href="classFormatterToSourceTree.html#s0">00059</a> <font class="keyword">typedef</font> XalanVector&lt;XalanSourceTreeElement*&gt; ElementStackType;
<a name="l00060"></a><a class="code" href="classFormatterToSourceTree.html#s1">00060</a> <font class="keyword">typedef</font> XalanVector&lt;XalanNode*&gt; LastChildStackType;
00061
00062 <font class="keyword">enum</font> { eDefaultStackSize = 50, eDefaultTextBufferSize = 100 };
00063
00067 <font class="keyword">static</font> <font class="keywordtype">void</font>
00068 <a class="code" href="classFormatterToSourceTree.html#d0">initialize</a>(MemoryManagerType&amp; theManager);
00069
00073 <font class="keyword">static</font> <font class="keywordtype">void</font>
00074 <a class="code" href="classFormatterToSourceTree.html#d1">terminate</a>();
00075
00076
00083 <font class="keyword">explicit</font>
00084 <a class="code" href="classFormatterToSourceTree.html#a0">FormatterToSourceTree</a>( MemoryManagerType&amp; theManager XALAN_DEFAULT_CONSTRACTOR_MEMORY_MGR,
00085 <a class="code" href="classXalanSourceTreeDocument.html">XalanSourceTreeDocument</a>* theDocument = 0);
00086
00094 <a class="code" href="classFormatterToSourceTree.html#a0">FormatterToSourceTree</a>(
00095 <a class="code" href="classXalanSourceTreeDocument.html">XalanSourceTreeDocument</a>* theDocument,
00096 <a class="code" href="classXalanSourceTreeDocumentFragment.html">XalanSourceTreeDocumentFragment</a>* theDocumentFragment,
00097 MemoryManagerType&amp; theManager XALAN_DEFAULT_MEMMGR);
00098
00099 <font class="keyword">virtual</font>
00100 <a class="code" href="classFormatterToSourceTree.html#a2">~FormatterToSourceTree</a>();
00101
00102
00103 <a class="code" href="classXalanSourceTreeDocument.html">XalanSourceTreeDocument</a>*
<a name="l00104"></a><a class="code" href="classFormatterToSourceTree.html#a3">00104</a> <a class="code" href="classFormatterToSourceTree.html#a3">getDocument</a>()<font class="keyword"> const</font>
00105 <font class="keyword"> </font>{
00106 <font class="keywordflow">return</font> m_document;
00107 }
00108
00109 <font class="keywordtype">void</font>
<a name="l00110"></a><a class="code" href="classFormatterToSourceTree.html#a4">00110</a> <a class="code" href="classFormatterToSourceTree.html#a4">setDocument</a>(<a class="code" href="classXalanSourceTreeDocument.html">XalanSourceTreeDocument</a>* theDocument)<font class="keyword"></font>
00111 <font class="keyword"> </font>{
00112 m_document = theDocument;
00113 }
00114
00115 <a class="code" href="classXalanSourceTreeDocumentFragment.html">XalanSourceTreeDocumentFragment</a>*
<a name="l00116"></a><a class="code" href="classFormatterToSourceTree.html#a5">00116</a> <a class="code" href="classFormatterToSourceTree.html#a5">getDocumentFragment</a>()<font class="keyword"> const</font>
00117 <font class="keyword"> </font>{
00118 <font class="keywordflow">return</font> m_documentFragment;
00119 }
00120
00121 <font class="keywordtype">void</font>
<a name="l00122"></a><a class="code" href="classFormatterToSourceTree.html#a6">00122</a> <a class="code" href="classFormatterToSourceTree.html#a6">setDocumentFragment</a>(<a class="code" href="classXalanSourceTreeDocumentFragment.html">XalanSourceTreeDocumentFragment</a>* theDocumentFragment)<font class="keyword"></font>
00123 <font class="keyword"> </font>{
00124 m_documentFragment = theDocumentFragment;
00125 }
00126
00127 <a class="code" href="classXalanSourceTreeElement.html">XalanSourceTreeElement</a>*
<a name="l00128"></a><a class="code" href="classFormatterToSourceTree.html#a7">00128</a> <a class="code" href="classFormatterToSourceTree.html#a7">getCurrentElement</a>()<font class="keyword"> const</font>
00129 <font class="keyword"> </font>{
00130 <font class="keywordflow">return</font> m_currentElement;
00131 }
00132
00133 <font class="keywordtype">void</font>
<a name="l00134"></a><a class="code" href="classFormatterToSourceTree.html#a8">00134</a> <a class="code" href="classFormatterToSourceTree.html#a8">setCurrentElement</a>(<a class="code" href="classXalanSourceTreeElement.html">XalanSourceTreeElement</a>* theElement)<font class="keyword"></font>
00135 <font class="keyword"> </font>{
00136 m_currentElement = theElement;
00137 }
00138
00139 <font class="comment">// These methods are inherited from DocumentHandler ...</font>
00140
00141 <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00142 <a class="code" href="classFormatterToSourceTree.html#a9">charactersRaw</a>(
00143 <font class="keyword">const</font> XMLCh* <font class="keyword">const</font> chars,
00144 <font class="keyword">const</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> length);
00145
00146 <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00147 <a class="code" href="classFormatterToSourceTree.html#a10">comment</a>(<font class="keyword">const</font> XMLCh* <font class="keyword">const</font> data);
00148
00149 <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00150 <a class="code" href="classFormatterToSourceTree.html#a11">cdata</a>(
00151 <font class="keyword">const</font> XMLCh* <font class="keyword">const</font> ch,
00152 <font class="keyword">const</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> length);
00153
00154 <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00155 <a class="code" href="classFormatterToSourceTree.html#a12">entityReference</a>(<font class="keyword">const</font> XMLCh* <font class="keyword">const</font> name);
00156
00157 <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00158 <a class="code" href="classFormatterToSourceTree.html#a13">setDocumentLocator</a>(<font class="keyword">const</font> LocatorType* <font class="keyword">const</font> locator);
00159
00160 <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00161 <a class="code" href="classFormatterToSourceTree.html#a14">startDocument</a>();
00162
00163 <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00164 <a class="code" href="classFormatterToSourceTree.html#a15">endDocument</a>();
00165
00166 <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00167 <a class="code" href="classFormatterToSourceTree.html#a16">startElement</a>(
00168 <font class="keyword">const</font> XMLCh* <font class="keyword">const</font> name,
00169 AttributeListType&amp; attrs);
00170
00171 <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00172 <a class="code" href="classFormatterToSourceTree.html#a17">endElement</a>(<font class="keyword">const</font> XMLCh* <font class="keyword">const</font> name);
00173
00174 <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00175 <a class="code" href="classFormatterToSourceTree.html#a18">characters</a>(
00176 <font class="keyword">const</font> XMLCh* <font class="keyword">const</font> chars,
00177 <font class="keyword">const</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> length);
00178
00179 <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00180 <a class="code" href="classFormatterToSourceTree.html#a19">ignorableWhitespace</a>(
00181 <font class="keyword">const</font> XMLCh* <font class="keyword">const</font> chars,
00182 <font class="keyword">const</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> length);
00183
00184 <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00185 <a class="code" href="classFormatterToSourceTree.html#a20">processingInstruction</a>(
00186 <font class="keyword">const</font> XMLCh* <font class="keyword">const</font> target,
00187 <font class="keyword">const</font> XMLCh* <font class="keyword">const</font> data);
00188
00189 <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00190 <a class="code" href="classFormatterToSourceTree.html#a21">resetDocument</a>();
00191
00192 <font class="keyword">private</font>:
00193
00194 <font class="comment">// Some utility functions...</font>
00195 <font class="keywordtype">void</font>
00196 processAccumulatedText();
00197
00198 <a class="code" href="classXalanSourceTreeElement.html">XalanSourceTreeElement</a>*
00199 createElementNode(
00200 <font class="keyword">const</font> XalanDOMChar* name,
00201 AttributeListType&amp; attrs,
00202 <a class="code" href="classXalanSourceTreeElement.html">XalanSourceTreeElement</a>* theParentElement);
00203
00204 <font class="keywordtype">void</font>
00205 doCharacters(
00206 <font class="keyword">const</font> XalanDOMChar* chars,
00207 XalanDOMString::size_type length);
00208
00209 <font class="keywordtype">void</font>
00210 doProcessingInstruction(
00211 <font class="keyword">const</font> XalanDOMChar* target,
00212 <font class="keyword">const</font> XalanDOMChar* data);
00213
00214
00215 <font class="comment">// Data members...</font>
00216 <a class="code" href="classXalanSourceTreeDocument.html">XalanSourceTreeDocument</a>* m_document;
00217
00218 <a class="code" href="classXalanSourceTreeDocumentFragment.html">XalanSourceTreeDocumentFragment</a>* m_documentFragment;
00219
00220 <a class="code" href="classXalanSourceTreeElement.html">XalanSourceTreeElement</a>* m_currentElement;
00221
00222 ElementStackType m_elementStack;
00223
00224 <font class="comment">// The last child appended to the current element. This is</font>
00225 <font class="comment">// an important optimization, because XalanSourceTreeElement</font>
00226 <font class="comment">// does not have a pointer to it's last child. Without this,</font>
00227 <font class="comment">// appending a child becomes a linear search.</font>
00228 <a class="code" href="classXalanNode.html">XalanNode</a>* m_lastChild;
00229
00230 <font class="comment">// Stack of last children appended. There is a one-to-one</font>
00231 <font class="comment">// correspondance to the entries in m_elementStack.</font>
00232 LastChildStackType m_lastChildStack;
00233
00234 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> m_textBuffer;
00235 };
00236
00237
00238
00239 XALAN_CPP_NAMESPACE_END
00240
00241
00242
00243 <font class="preprocessor">#endif // FORMATTERTOSOURCETREE_HEADER_GUARD_1357924680</font>
</font></pre></div><p align="center"><a href="diagramnotes.html">Interpreting class diagrams</a></p>
<p><FONT color="#000000" face="arial,helvetica,sanserif" size="-1">
<i><A href="http://www.stack.nl/~dimitri/doxygen/">Doxygen</A> and
<A href="http://www.research.att.com/sw/tools/graphviz/">GraphViz</A> are used to generate this API documentation from the Xalan-C header files.</I></FONT></p>
<TABLE border="0" cellpadding="0" cellspacing="0" width="820"><TR><TD bgcolor="#0086b2"><IMG height="1" src="../resources/dot.gif" width="1" alt="dot"></TD></TR></TABLE>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" WIDTH="80%">
<TR>
<TD WIDTH="80%" VALIGN="TOP">
<P ALIGN="CENTER"><B>Xalan-C++ XSLT Processor Version 1.10</B><BR>
Copyright &copy; 1999-2004 The Apache Software Foundation. All Rights Reserved.</i></p>
</TD>
</TR>
<TR>
<TD WIDTH="100%">
<P ALIGN="CENTER"><IMG SRC="ApacheLogo.jpg" WIDTH="387" HEIGHT="100" ALIGN="BOTTOM" BORDER="0" ALT="Apache Logo">
</TD>
</TR>
</TABLE>