| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <title>Xalan-C++ API : Main Page</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <link href="doxygen.css" rel="stylesheet" type="text/css"/> |
| </head> |
| <!-- The head section is copied from Doxygen 1.7.1 generated default output --> |
| <body> |
| <h2 align="center">Xalan-C++ API Documentation</h2> |
| <h3 align="center"><a href="../index.html">The Xalan C++ XSLT Processor Version 1.11</a></h3> |
| <hr/> |
| <!-- Generated by Doxygen 1.7.1 --> |
| <div class="navigation" id="top"> |
| <div class="tabs"> |
| <ul class="tablist"> |
| <li><a href="index.html"><span>Main Page</span></a></li> |
| <li><a href="pages.html"><span>Related Pages</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> |
| </ul> |
| </div> |
| <div class="tabs2"> |
| <ul class="tablist"> |
| <li><a href="files.html"><span>File List</span></a></li> |
| <li><a href="globals.html"><span>File Members</span></a></li> |
| </ul> |
| </div> |
| <div class="header"> |
| <div class="headertitle"> |
| <h1>XPathEnvSupport.hpp</h1> </div> |
| </div> |
| <div class="contents"> |
| <a href="XPathEnvSupport_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</span> |
| <a name="l00003"></a>00003 <span class="comment"> * or more contributor license agreements. See the NOTICE file</span> |
| <a name="l00004"></a>00004 <span class="comment"> * distributed with this work for additional information</span> |
| <a name="l00005"></a>00005 <span class="comment"> * regarding copyright ownership. The ASF licenses this file</span> |
| <a name="l00006"></a>00006 <span class="comment"> * to you under the Apache License, Version 2.0 (the "License");</span> |
| <a name="l00007"></a>00007 <span class="comment"> * you may not use this file except in compliance with the License.</span> |
| <a name="l00008"></a>00008 <span class="comment"> * You may obtain a copy of the License at</span> |
| <a name="l00009"></a>00009 <span class="comment"> *</span> |
| <a name="l00010"></a>00010 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span> |
| <a name="l00011"></a>00011 <span class="comment"> *</span> |
| <a name="l00012"></a>00012 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span> |
| <a name="l00013"></a>00013 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span> |
| <a name="l00014"></a>00014 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> |
| <a name="l00015"></a>00015 <span class="comment"> * See the License for the specific language governing permissions and</span> |
| <a name="l00016"></a>00016 <span class="comment"> * limitations under the License.</span> |
| <a name="l00017"></a>00017 <span class="comment"> */</span> |
| <a name="l00018"></a>00018 <span class="preprocessor">#if !defined(XPATHENVSUPPORT_HEADER_GUARD_1357924680)</span> |
| <a name="l00019"></a>00019 <span class="preprocessor"></span><span class="preprocessor">#define XPATHENVSUPPORT_HEADER_GUARD_1357924680</span> |
| <a name="l00020"></a>00020 <span class="preprocessor"></span> |
| <a name="l00021"></a>00021 |
| <a name="l00022"></a>00022 |
| <a name="l00023"></a>00023 <span class="comment">// Base include file. Must be first.</span> |
| <a name="l00024"></a>00024 <span class="preprocessor">#include <<a class="code" href="XPathDefinitions_8hpp.html">xalanc/XPath/XPathDefinitions.hpp</a>></span> |
| <a name="l00025"></a>00025 |
| <a name="l00026"></a>00026 |
| <a name="l00027"></a>00027 |
| <a name="l00028"></a>00028 <span class="preprocessor">#include "<a class="code" href="ProblemListenerBase_8hpp.html">xalanc/PlatformSupport/ProblemListenerBase.hpp</a>"</span> |
| <a name="l00029"></a>00029 |
| <a name="l00030"></a>00030 |
| <a name="l00031"></a>00031 |
| <a name="l00032"></a>00032 <span class="preprocessor">#include <<a class="code" href="Function_8hpp.html">xalanc/XPath/Function.hpp</a>></span> |
| <a name="l00033"></a>00033 |
| <a name="l00034"></a>00034 |
| <a name="l00035"></a>00035 |
| <a name="l00036"></a>00036 XALAN_DECLARE_XERCES_CLASS(Locator) |
| <a name="l00037"></a>00037 |
| <a name="l00038"></a>00038 |
| <a name="l00039"></a>00039 |
| <a name="l00040"></a>00040 XALAN_CPP_NAMESPACE_BEGIN |
| <a name="l00041"></a>00041 |
| <a name="l00042"></a>00042 |
| <a name="l00043"></a>00043 |
| <a name="l00044"></a>00044 class <a class="code" href="classNodeRefListBase.html" title="Local implementation of NodeRefList.">NodeRefListBase</a>; |
| <a name="l00045"></a>00045 class <a class="code" href="classPrefixResolver.html" title="This class defines an interface for classes that resolve namespace prefixes to their URIs...">PrefixResolver</a>; |
| <a name="l00046"></a>00046 class <a class="code" href="classXObject.html" title="Class to hold XPath return types.">XObject</a>; |
| <a name="l00047"></a>00047 class <a class="code" href="classXPathExecutionContext.html">XPathExecutionContext</a>; |
| <a name="l00048"></a>00048 class <a class="code" href="classXObjectFactory.html" title="This class handles the creation of XObjects and manages their lifetime.">XObjectFactory</a>; |
| <a name="l00049"></a>00049 class <a class="code" href="classXalanDocument.html">XalanDocument</a>; |
| <a name="l00050"></a>00050 class <a class="code" href="classXalanDOMString.html">XalanDOMString</a>; |
| <a name="l00051"></a>00051 class <a class="code" href="classXalanElement.html">XalanElement</a>; |
| <a name="l00052"></a>00052 class <a class="code" href="classXalanNode.html">XalanNode</a>; |
| <a name="l00053"></a>00053 class <a class="code" href="classXalanQName.html" title="Class to represent a qualified name.">XalanQName</a>; |
| <a name="l00054"></a>00054 |
| <a name="l00055"></a>00055 |
| <a name="l00056"></a>00056 |
| <a name="l00057"></a><a class="code" href="classXPathEnvSupport.html">00057</a> class <a class="code" href="XPathDefinitions_8hpp.html#aa9c15f77ef5ab2dc518733b0fd07c141">XALAN_XPATH_EXPORT</a> <a class="code" href="classXPathEnvSupport.html">XPathEnvSupport</a> : public <a class="code" href="classProblemListenerBase.html" title="This is the abstract class that is used when reporting a problem some kind, that requires a message...">ProblemListenerBase</a> |
| <a name="l00058"></a>00058 { |
| <a name="l00059"></a>00059 <span class="keyword">public</span>: |
| <a name="l00060"></a>00060 |
| <a name="l00061"></a><a class="code" href="classXPathEnvSupport.html#a8ac945c49708a3d319fcca50c71c7faa">00061</a> <span class="keyword">typedef</span> XERCES_CPP_NAMESPACE_QUALIFIER Locator LocatorType; |
| <a name="l00062"></a>00062 |
| <a name="l00063"></a><a class="code" href="classXPathEnvSupport.html#a9b8ffb8e84ac8e443d81e6a346a90418">00063</a> <span class="keyword">typedef</span> <a class="code" href="classXalanVector.html">Function::XObjectArgVectorType</a> <a class="code" href="classXalanVector.html">XObjectArgVectorType</a>; |
| <a name="l00064"></a>00064 |
| <a name="l00065"></a>00065 <a class="code" href="classXPathEnvSupport.html">XPathEnvSupport</a>(); |
| <a name="l00066"></a>00066 |
| <a name="l00067"></a>00067 <span class="keyword">virtual</span> |
| <a name="l00068"></a>00068 ~<a class="code" href="classXPathEnvSupport.html">XPathEnvSupport</a>(); |
| <a name="l00069"></a>00069 |
| <a name="l00070"></a>00070 |
| <a name="l00071"></a>00071 <span class="comment">// These methods are inherited from ProblemListener ...</span> |
| <a name="l00072"></a>00072 <span class="keyword">virtual</span> <span class="keywordtype">void</span> |
| <a name="l00073"></a>00073 problem( |
| <a name="l00074"></a>00074 <a class="code" href="classProblemListenerBase.html#ae363b5e4919bbe4e41f6b2c1b322ee7c">eSource</a> source, |
| <a name="l00075"></a>00075 <a class="code" href="classProblemListenerBase.html#a1fec6cce6cc3429e200355330a41152a">eClassification</a> classification, |
| <a name="l00076"></a>00076 <span class="keyword">const</span> XalanDOMString& msg, |
| <a name="l00077"></a>00077 <span class="keyword">const</span> Locator* locator, |
| <a name="l00078"></a>00078 <span class="keyword">const</span> XalanNode* sourceNode) = 0; |
| <a name="l00079"></a>00079 |
| <a name="l00080"></a>00080 <span class="keyword">virtual</span> <span class="keywordtype">void</span> |
| <a name="l00081"></a>00081 problem( |
| <a name="l00082"></a>00082 <a class="code" href="classProblemListenerBase.html#ae363b5e4919bbe4e41f6b2c1b322ee7c">eSource</a> source, |
| <a name="l00083"></a>00083 <a class="code" href="classProblemListenerBase.html#a1fec6cce6cc3429e200355330a41152a">eClassification</a> classification, |
| <a name="l00084"></a>00084 <span class="keyword">const</span> XalanDOMString& msg, |
| <a name="l00085"></a>00085 <span class="keyword">const</span> XalanNode* sourceNode) = 0; |
| <a name="l00086"></a>00086 |
| <a name="l00087"></a>00087 |
| <a name="l00088"></a>00088 <span class="comment">// These interfaces are new to XPathEnvSupport</span><span class="comment"></span> |
| <a name="l00089"></a>00089 <span class="comment"> /**</span> |
| <a name="l00090"></a>00090 <span class="comment"> * Provides support for XML parsing service.</span> |
| <a name="l00091"></a>00091 <span class="comment"> *</span> |
| <a name="l00092"></a>00092 <span class="comment"> * @param theManager The MemoryManager instance to use.</span> |
| <a name="l00093"></a>00093 <span class="comment"> * @param urlString location of the XML</span> |
| <a name="l00094"></a>00094 <span class="comment"> * @param base base location for URI</span> |
| <a name="l00095"></a>00095 <span class="comment"> * @param theErrorHandler An optional ErrorHandler instance for error reporting.</span> |
| <a name="l00096"></a>00096 <span class="comment"> * @return parsed document</span> |
| <a name="l00097"></a>00097 <span class="comment"> */</span> |
| <a name="l00098"></a>00098 <span class="keyword">virtual</span> XalanDocument* |
| <a name="l00099"></a>00099 parseXML( |
| <a name="l00100"></a>00100 MemoryManager& theManager, |
| <a name="l00101"></a>00101 <span class="keyword">const</span> XalanDOMString& urlString, |
| <a name="l00102"></a>00102 <span class="keyword">const</span> XalanDOMString& base, |
| <a name="l00103"></a>00103 ErrorHandler* theErrorHandler = 0) = 0; |
| <a name="l00104"></a>00104 <span class="comment"></span> |
| <a name="l00105"></a>00105 <span class="comment"> /**</span> |
| <a name="l00106"></a>00106 <span class="comment"> * Get the source document for the given URI.</span> |
| <a name="l00107"></a>00107 <span class="comment"> *</span> |
| <a name="l00108"></a>00108 <span class="comment"> * @param theURI document URI</span> |
| <a name="l00109"></a>00109 <span class="comment"> * @return source document</span> |
| <a name="l00110"></a>00110 <span class="comment"> */</span> |
| <a name="l00111"></a>00111 <span class="keyword">virtual</span> XalanDocument* |
| <a name="l00112"></a>00112 getSourceDocument(<span class="keyword">const</span> XalanDOMString& theURI) <span class="keyword">const</span> = 0; |
| <a name="l00113"></a>00113 <span class="comment"></span> |
| <a name="l00114"></a>00114 <span class="comment"> /**</span> |
| <a name="l00115"></a>00115 <span class="comment"> * Associate a document with a given URI.</span> |
| <a name="l00116"></a>00116 <span class="comment"> *</span> |
| <a name="l00117"></a>00117 <span class="comment"> * @param theURI document URI</span> |
| <a name="l00118"></a>00118 <span class="comment"> * @param theDocument source document</span> |
| <a name="l00119"></a>00119 <span class="comment"> */</span> |
| <a name="l00120"></a>00120 <span class="keyword">virtual</span> <span class="keywordtype">void</span> |
| <a name="l00121"></a>00121 setSourceDocument( |
| <a name="l00122"></a>00122 <span class="keyword">const</span> XalanDOMString& theURI, |
| <a name="l00123"></a>00123 XalanDocument* theDocument) = 0; |
| <a name="l00124"></a>00124 <span class="comment"></span> |
| <a name="l00125"></a>00125 <span class="comment"> /**</span> |
| <a name="l00126"></a>00126 <span class="comment"> * Given a DOM Document, tell what URI was used to parse it. Needed for</span> |
| <a name="l00127"></a>00127 <span class="comment"> * relative resolution.</span> |
| <a name="l00128"></a>00128 <span class="comment"> *</span> |
| <a name="l00129"></a>00129 <span class="comment"> * @param owner source document</span> |
| <a name="l00130"></a>00130 <span class="comment"> * @return document URI</span> |
| <a name="l00131"></a>00131 <span class="comment"> */</span> |
| <a name="l00132"></a>00132 <span class="keyword">virtual</span> <span class="keyword">const</span> XalanDOMString& |
| <a name="l00133"></a>00133 findURIFromDoc(<span class="keyword">const</span> XalanDocument* owner) <span class="keyword">const</span> = 0; |
| <a name="l00134"></a>00134 <span class="comment"></span> |
| <a name="l00135"></a>00135 <span class="comment"> /**</span> |
| <a name="l00136"></a>00136 <span class="comment"> * Determine if an external element is available.</span> |
| <a name="l00137"></a>00137 <span class="comment"> *</span> |
| <a name="l00138"></a>00138 <span class="comment"> * @param theNamespace namespace for the element</span> |
| <a name="l00139"></a>00139 <span class="comment"> * @param elementName name of extension element</span> |
| <a name="l00140"></a>00140 <span class="comment"> * @return whether the element is available or not</span> |
| <a name="l00141"></a>00141 <span class="comment"> */</span> |
| <a name="l00142"></a>00142 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> |
| <a name="l00143"></a>00143 elementAvailable( |
| <a name="l00144"></a>00144 <span class="keyword">const</span> XalanDOMString& theNamespace, |
| <a name="l00145"></a>00145 <span class="keyword">const</span> XalanDOMString& elementName) <span class="keyword">const</span> = 0; |
| <a name="l00146"></a>00146 <span class="comment"></span> |
| <a name="l00147"></a>00147 <span class="comment"> /**</span> |
| <a name="l00148"></a>00148 <span class="comment"> * Determine if a function is available. For standard</span> |
| <a name="l00149"></a>00149 <span class="comment"> * function availability, theNamespace should be an</span> |
| <a name="l00150"></a>00150 <span class="comment"> * empty string.</span> |
| <a name="l00151"></a>00151 <span class="comment"> *</span> |
| <a name="l00152"></a>00152 <span class="comment"> * @param theNamespace namespace for the function</span> |
| <a name="l00153"></a>00153 <span class="comment"> * @param functionName name of the function</span> |
| <a name="l00154"></a>00154 <span class="comment"> * @return whether the function is available or not</span> |
| <a name="l00155"></a>00155 <span class="comment"> */</span> |
| <a name="l00156"></a>00156 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> |
| <a name="l00157"></a>00157 functionAvailable( |
| <a name="l00158"></a>00158 <span class="keyword">const</span> XalanDOMString& theNamespace, |
| <a name="l00159"></a>00159 <span class="keyword">const</span> XalanDOMString& functionName) <span class="keyword">const</span> = 0; |
| <a name="l00160"></a>00160 <span class="comment"></span> |
| <a name="l00161"></a>00161 <span class="comment"> /**</span> |
| <a name="l00162"></a>00162 <span class="comment"> * Handle an extension function.</span> |
| <a name="l00163"></a>00163 <span class="comment"> * </span> |
| <a name="l00164"></a>00164 <span class="comment"> * @param executionContext current execution context</span> |
| <a name="l00165"></a>00165 <span class="comment"> * @param theNamespace namespace of function </span> |
| <a name="l00166"></a>00166 <span class="comment"> * @param functionName extension function name</span> |
| <a name="l00167"></a>00167 <span class="comment"> * @param argVec vector of arguments to function</span> |
| <a name="l00168"></a>00168 <span class="comment"> * @param locator A Locator instance for error reporting.</span> |
| <a name="l00169"></a>00169 <span class="comment"> * @return pointer to XObject result</span> |
| <a name="l00170"></a>00170 <span class="comment"> */</span> |
| <a name="l00171"></a>00171 <span class="keyword">virtual</span> <a class="code" href="classXObjectPtr.html" title="Class to hold XObjectPtr return types.">XObjectPtr</a> |
| <a name="l00172"></a>00172 extFunction( |
| <a name="l00173"></a>00173 XPathExecutionContext& executionContext, |
| <a name="l00174"></a>00174 <span class="keyword">const</span> XalanDOMString& theNamespace, |
| <a name="l00175"></a>00175 <span class="keyword">const</span> XalanDOMString& functionName, |
| <a name="l00176"></a>00176 XalanNode* context, |
| <a name="l00177"></a>00177 <span class="keyword">const</span> XObjectArgVectorType& argVec, |
| <a name="l00178"></a>00178 <span class="keyword">const</span> Locator* locator) <span class="keyword">const</span> = 0; |
| <a name="l00179"></a>00179 <span class="comment"></span> |
| <a name="l00180"></a>00180 <span class="comment"> /**</span> |
| <a name="l00181"></a>00181 <span class="comment"> * Reset the instance.</span> |
| <a name="l00182"></a>00182 <span class="comment"> */</span> |
| <a name="l00183"></a>00183 <span class="keyword">virtual</span> <span class="keywordtype">void</span> |
| <a name="l00184"></a>00184 reset() = 0; |
| <a name="l00185"></a>00185 |
| <a name="l00186"></a>00186 <span class="keyword">private</span>: |
| <a name="l00187"></a>00187 |
| <a name="l00188"></a>00188 <span class="comment">// These are not implemented...</span> |
| <a name="l00189"></a>00189 <a class="code" href="classXPathEnvSupport.html">XPathEnvSupport</a>(<span class="keyword">const</span> <a class="code" href="classXPathEnvSupport.html">XPathEnvSupport</a>&); |
| <a name="l00190"></a>00190 |
| <a name="l00191"></a>00191 <a class="code" href="classXPathEnvSupport.html">XPathEnvSupport</a>& |
| <a name="l00192"></a>00192 operator=(<span class="keyword">const</span> <a class="code" href="classXPathEnvSupport.html">XPathEnvSupport</a>&); |
| <a name="l00193"></a>00193 |
| <a name="l00194"></a>00194 <span class="keywordtype">bool</span> |
| <a name="l00195"></a>00195 <a class="code" href="ElemAttributeSet_8hpp.html#ae199bc16afddda1065706543e752d292">operator==</a>(<span class="keyword">const</span> <a class="code" href="classXPathEnvSupport.html">XPathEnvSupport</a>&) <span class="keyword">const</span>; |
| <a name="l00196"></a>00196 }; |
| <a name="l00197"></a>00197 |
| <a name="l00198"></a>00198 |
| <a name="l00199"></a>00199 |
| <a name="l00200"></a>00200 XALAN_CPP_NAMESPACE_END |
| <a name="l00201"></a>00201 |
| <a name="l00202"></a>00202 |
| <a name="l00203"></a>00203 |
| <a name="l00204"></a>00204 <span class="preprocessor">#endif // XPATHENVSUPPORT_HEADER_GUARD_1357924680</span> |
| </pre></div></div> |
| </div> |
| <p align="center"><a href="graph_legend.html">Interpreting class diagrams</a></p> |
| <p><font color="#000000" face="arial,helvetica,sanserif" size="-1"> |
| <i><a href="http://www.doxygen.org/">Doxygen</a> and |
| <a href="http://www.graphviz.org/">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="80%"> |
| <tr> |
| <td width="80%" valign="top"> |
| <p align="center"><b>Xalan-C++ XSLT Processor Version 1.11</b><br/> |
| Copyright © 1999-2012 The Apache Software Foundation.<br/> |
| All Rights Reserved.</p> |
| </td> |
| </tr> |
| <tr> |
| <td width="100%"> |
| <p align="center"><img src="asf_logo_wide.gif" width="268" height="25" align="bottom" border="0" alt="Apache Logo"> |
| </td> |
| </tr> |
| </table> |
| </body> |
| </html> |
