blob: 62036e278c9e8820359319e059eab50f0d7ba843 [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>XPathEnvSupportDefault.hpp</h1><a href="XPathEnvSupportDefault_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(XPATHENVSUPPORTDEFAULT_HEADER_GUARD_1357924680)</font>
<a name="l00017"></a><a class="code" href="XPathEnvSupportDefault_8hpp.html#a0">00017</a> <font class="preprocessor"></font><font class="preprocessor">#define XPATHENVSUPPORTDEFAULT_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="XPathDefinitions_8hpp.html">xalanc/XPath/XPathDefinitions.hpp</a>&gt;</font>
00023 <font class="preprocessor">#include &lt;<a class="code" href="XPathEnvSupport_8hpp.html">xalanc/XPath/XPathEnvSupport.hpp</a>&gt;</font>
00024
00025
00026 <font class="preprocessor">#include&lt;<a class="code" href="DOMStringHelper_8hpp.html">xalanc/PlatformSupport/DOMStringHelper.hpp</a>&gt;</font>
00027
00028
00029 <font class="preprocessor">#include&lt;<a class="code" href="XalanMap_8hpp.html">xalanc/Include/XalanMap.hpp</a>&gt;</font>
00030
00031
00032 XALAN_CPP_NAMESPACE_BEGIN
00033
<a name="l00034"></a><a class="code" href="XPathEnvSupportDefault_8hpp.html#a1">00034</a> <font class="keyword">typedef</font> <a class="code" href="classXalanMap.html">XalanMap&lt;XalanDOMString, const Function*&gt;</a> FunctionTableTypeDefinition;
<a name="l00035"></a><a class="code" href="XPathEnvSupportDefault_8hpp.html#a2">00035</a> <a class="code" href="XalanMemoryManagement_8hpp.html#a4">XALAN_USES_MEMORY_MANAGER</a>(FunctionTableTypeDefinition)
00036
00037
00043 <font class="keyword">class </font>XALAN_XPATH_EXPORT XPathEnvSupportDefault : <font class="keyword">public</font> <a class="code" href="classXPathEnvSupport.html">XPathEnvSupport</a>
00044 {
00045 <font class="keyword">public</font>:
00046
00047 <font class="keyword">typedef</font> <a class="code" href="classXalanMap.html">XalanMap&lt;XalanDOMString, XalanDocument*&gt;</a> SourceDocsTableType;
00048 <font class="keyword">typedef</font> FunctionTableTypeDefinition <a class="code" href="classXPathFunctionTable.html">FunctionTableType</a>;
00049 <font class="keyword">typedef</font> <a class="code" href="classXalanMap.html">XalanMap&lt;XalanDOMString, FunctionTableType&gt;</a> NamespaceFunctionTablesType;
00050
00055 <font class="keyword">static</font> <font class="keywordtype">void</font>
00056 initialize(MemoryManagerType&amp; theManager);
00057
00061 <font class="keyword">static</font> <font class="keywordtype">void</font>
00062 terminate();
00063
00064
00065 XPathEnvSupportDefault(MemoryManagerType&amp; theManager XALAN_DEFAULT_MEMMGR);
00066
00067 <font class="keyword">virtual</font>
00068 ~XPathEnvSupportDefault();
00069
00070 MemoryManagerType&amp;
00071 getMemoryManager()<font class="keyword"></font>
00072 <font class="keyword"> </font>{
00073 <font class="keywordflow">return</font> m_sourceDocs.getMemoryManager();
00074 }
00075
00076 <font class="comment">// Interfaces to install and uninstall external functions globally.</font>
00077 <font class="comment">// These calls are not thread-safe, and should happen during</font>
00078 <font class="comment">// processing.</font>
00079
00087 <font class="keyword">static</font> <font class="keywordtype">void</font>
00088 installExternalFunctionGlobal(
00089 <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; theNamespace,
00090 <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; functionName,
00091 <font class="keyword">const</font> <a class="code" href="classFunction.html">Function</a>&amp; function);
00092
00099 <font class="keyword">static</font> <font class="keywordtype">void</font>
00100 uninstallExternalFunctionGlobal(
00101 <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; theNamespace,
00102 <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; functionName);
00103
00104 <font class="comment">// Interfaces to install and uninstall external functions in this instance.</font>
00105
00113 <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00114 installExternalFunctionLocal(
00115 <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; theNamespace,
00116 <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; functionName,
00117 <font class="keyword">const</font> <a class="code" href="classFunction.html">Function</a>&amp; function);
00118
00125 <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00126 uninstallExternalFunctionLocal(
00127 <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; theNamespace,
00128 <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; functionName);
00129
00130
00131 <font class="comment">// These interfaces are inherited from XPathEnvSupport...</font>
00132
00133 <font class="keyword">virtual</font> <a class="code" href="classXalanDocument.html">XalanDocument</a>*
00134 <a class="code" href="classXPathEnvSupport.html#a2">parseXML</a>(
00135 MemoryManagerType&amp; theManager,
00136 <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; urlString,
00137 <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; base);
00138
00139 <font class="keyword">virtual</font> <a class="code" href="classXalanDocument.html">XalanDocument</a>*
00140 <a class="code" href="classXPathEnvSupport.html#a3">getSourceDocument</a>(<font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; theURI) <font class="keyword">const</font>;
00141
00142 <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00143 <a class="code" href="classXPathEnvSupport.html#a4">setSourceDocument</a>(
00144 <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; theURI,
00145 <a class="code" href="classXalanDocument.html">XalanDocument</a>* theDocument);
00146
00147 <font class="keyword">virtual</font> <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;
00148 <a class="code" href="classXPathEnvSupport.html#a5">findURIFromDoc</a>(<font class="keyword">const</font> <a class="code" href="classXalanDocument.html">XalanDocument</a>* owner) <font class="keyword">const</font>;
00149
00150 <font class="keyword">virtual</font> <font class="keywordtype">bool</font>
00151 <a class="code" href="classXPathEnvSupport.html#a6">elementAvailable</a>(
00152 <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; theNamespace,
00153 <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; elementName) <font class="keyword">const</font>;
00154
00155 <font class="keyword">virtual</font> <font class="keywordtype">bool</font>
00156 <a class="code" href="classXPathEnvSupport.html#a7">functionAvailable</a>(
00157 <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; theNamespace,
00158 <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; functionName) <font class="keyword">const</font>;
00159
00160 <font class="keyword">virtual</font> <a class="code" href="classXObjectPtr.html">XObjectPtr</a>
00161 <a class="code" href="classXPathEnvSupport.html#a8">extFunction</a>(
00162 <a class="code" href="classXPathExecutionContext.html">XPathExecutionContext</a>&amp; executionContext,
00163 <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; theNamespace,
00164 <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; functionName,
00165 <a class="code" href="classXalanNode.html">XalanNode</a>* context,
00166 <font class="keyword">const</font> XObjectArgVectorType&amp; argVec,
00167 <font class="keyword">const</font> LocatorType* locator) <font class="keyword">const</font>;
00168
00169 <font class="keyword">virtual</font> <font class="keywordtype">bool</font>
00170 <a class="code" href="classXPathEnvSupport.html#a9">problem</a>(
00171 eSource where,
00172 eClassification classification,
00173 <font class="keyword">const</font> <a class="code" href="classPrefixResolver.html">PrefixResolver</a>* resolver,
00174 <font class="keyword">const</font> <a class="code" href="classXalanNode.html">XalanNode</a>* sourceNode,
00175 <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; msg,
00176 <font class="keyword">const</font> XalanDOMChar* uri,
00177 <font class="keywordtype">int</font> lineNo,
00178 <font class="keywordtype">int</font> charOffset) <font class="keyword">const</font>;
00179
00180 <font class="comment">// These interfaces are inherited from Resettable...</font>
00181
00182 <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00183 <a class="code" href="classXPathEnvSupport.html#a10">reset</a>();
00184
00185 <font class="comment">// Delete functor for table cleanup...</font>
00186 <font class="keyword">struct </font>NamespaceFunctionTableDeleteFunctor
00187 {
00188 <font class="keyword">typedef</font> <a class="code" href="classXPathFunctionTable.html">FunctionTableType</a> FunctionTableInnerType;
00189 <font class="keyword">typedef</font> NamespaceFunctionTablesType NamespaceFunctionTablesInnerType;
00190
00191 NamespaceFunctionTableDeleteFunctor(MemoryManagerType&amp; theManager);
00198 <font class="keywordtype">void</font>
00199 operator()(<font class="keyword">const</font> NamespaceFunctionTablesInnerType::value_type&amp; thePair) <font class="keyword">const</font>;
00200 <font class="keyword">private</font>:
00201 MemoryManagerType&amp; m_memMgr;
00202 };
00203
00204 <font class="keyword">protected</font>:
00205
00213 <font class="keyword">const</font> <a class="code" href="classFunction.html">Function</a>*
00214 findFunction(
00215 <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; theNamespace,
00216 <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; functionName) <font class="keyword">const</font>;
00217
00218 <font class="keyword">private</font>:
00219
00220 <font class="comment">// These are not implemented...</font>
00221 XPathEnvSupportDefault(<font class="keyword">const</font> XPathEnvSupportDefault&amp;);
00222
00223 XPathEnvSupportDefault&amp;
00224 operator=(<font class="keyword">const</font> XPathEnvSupportDefault&amp;);
00225
00226 <font class="keywordtype">bool</font>
00227 <a class="code" href="ElemAttributeSet_8hpp.html#a1">operator==</a>(<font class="keyword">const</font> XPathEnvSupportDefault&amp;) <font class="keyword">const</font>;
00228
00242 <font class="keyword">static</font> <font class="keywordtype">void</font>
00243 updateFunctionTable(
00244 NamespaceFunctionTablesType&amp; theTable,
00245 <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; theNamespace,
00246 <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; functionName,
00247 <font class="keyword">const</font> <a class="code" href="classFunction.html">Function</a>* function);
00248
00257 <font class="keyword">const</font> <a class="code" href="classFunction.html">Function</a>*
00258 findFunction(
00259 <font class="keyword">const</font> NamespaceFunctionTablesType&amp; theTable,
00260 <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; theNamespace,
00261 <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; functionName) <font class="keyword">const</font>;
00262
00263 <font class="comment">// Data members...</font>
00264
00265 SourceDocsTableType m_sourceDocs;
00266
00267 NamespaceFunctionTablesType m_externalFunctions;
00268
00269 <font class="keyword">static</font> NamespaceFunctionTablesType s_externalFunctions;
00270
00271 <font class="keyword">static</font> <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a> s_emptyString;
00272 };
00273
00274 XALAN_CPP_NAMESPACE_END
00275
00276
00277
00278 <font class="preprocessor">#endif // XPATHENVSUPPORTDEFAULT_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>