| <!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>ExtensionFunctionHandler.hpp</h1> </div> |
| </div> |
| <div class="contents"> |
| <a href="ExtensionFunctionHandler_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 |
| <a name="l00019"></a>00019 <span class="preprocessor">#if !defined(XALAN_EXTENSIONFUNCTIONHANDLER_HEADER_GUARD)</span> |
| <a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define XALAN_EXTENSIONFUNCTIONHANDLER_HEADER_GUARD</span> |
| <a name="l00021"></a>00021 <span class="preprocessor"></span> |
| <a name="l00022"></a>00022 |
| <a name="l00023"></a>00023 |
| <a name="l00024"></a>00024 <span class="comment">// Base include file. Must be first.</span> |
| <a name="l00025"></a>00025 <span class="preprocessor">#include <<a class="code" href="XSLTDefinitions_8hpp.html">xalanc/XSLT/XSLTDefinitions.hpp</a>></span> |
| <a name="l00026"></a>00026 |
| <a name="l00027"></a>00027 |
| <a name="l00028"></a>00028 |
| <a name="l00029"></a>00029 <span class="preprocessor">#include <<a class="code" href="XalanDOMString_8hpp.html">xalanc/XalanDOM/XalanDOMString.hpp</a>></span> |
| <a name="l00030"></a>00030 |
| <a name="l00031"></a>00031 |
| <a name="l00032"></a>00032 |
| <a name="l00033"></a>00033 <span class="preprocessor">#include <<a class="code" href="XalanVector_8hpp.html">xalanc/Include/XalanVector.hpp</a>></span> |
| <a name="l00034"></a>00034 <span class="preprocessor">#include <<a class="code" href="XalanSet_8hpp.html">xalanc/Include/XalanSet.hpp</a>></span> |
| <a name="l00035"></a>00035 |
| <a name="l00036"></a>00036 |
| <a name="l00037"></a>00037 |
| <a name="l00038"></a>00038 <span class="preprocessor">#include <<a class="code" href="DOMStringHelper_8hpp.html">xalanc/PlatformSupport/DOMStringHelper.hpp</a>></span> |
| <a name="l00039"></a>00039 |
| <a name="l00040"></a>00040 |
| <a name="l00041"></a>00041 |
| <a name="l00042"></a>00042 <span class="preprocessor">#include <<a class="code" href="XObject_8hpp.html">xalanc/XPath/XObject.hpp</a>></span> |
| <a name="l00043"></a>00043 |
| <a name="l00044"></a>00044 |
| <a name="l00045"></a>00045 |
| <a name="l00046"></a>00046 XALAN_CPP_NAMESPACE_BEGIN |
| <a name="l00047"></a>00047 |
| <a name="l00048"></a>00048 |
| <a name="l00049"></a>00049 |
| <a name="l00050"></a>00050 <span class="keyword">class </span><a class="code" href="classXObjectPtr.html" title="Class to hold XObjectPtr return types.">XObjectPtr</a>; |
| <a name="l00051"></a>00051 |
| <a name="l00052"></a>00052 |
| <a name="l00053"></a>00053 <span class="comment"></span> |
| <a name="l00054"></a>00054 <span class="comment">/**</span> |
| <a name="l00055"></a>00055 <span class="comment"> * Class handling an extension namespace for XPath. Provides functions</span> |
| <a name="l00056"></a>00056 <span class="comment"> * to test a function's existence and call a function</span> |
| <a name="l00057"></a>00057 <span class="comment"> */</span> |
| <a name="l00058"></a><a class="code" href="classExtensionFunctionHandler.html">00058</a> <span class="keyword">class </span><a class="code" href="XSLTDefinitions_8hpp.html#afe13e115e49db23eff1daccf7343935f">XALAN_XSLT_EXPORT</a> <a class="code" href="classExtensionFunctionHandler.html" title="Class handling an extension namespace for XPath.">ExtensionFunctionHandler</a> |
| <a name="l00059"></a>00059 { |
| <a name="l00060"></a>00060 |
| <a name="l00061"></a>00061 <span class="keyword">public</span>: |
| <a name="l00062"></a>00062 <span class="comment"></span> |
| <a name="l00063"></a>00063 <span class="comment"> /**</span> |
| <a name="l00064"></a>00064 <span class="comment"> * Construct a new extension namespace handler for a given extension NS.</span> |
| <a name="l00065"></a>00065 <span class="comment"> * This doesn't do anything - just hang on to the namespace URI.</span> |
| <a name="l00066"></a>00066 <span class="comment"> * </span> |
| <a name="l00067"></a>00067 <span class="comment"> * @param namespaceUri the extension namespace URI that I'm implementing</span> |
| <a name="l00068"></a>00068 <span class="comment"> */</span> |
| <a name="l00069"></a>00069 <a class="code" href="classExtensionFunctionHandler.html" title="Class handling an extension namespace for XPath.">ExtensionFunctionHandler</a>(<span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& namespaceUri, |
| <a name="l00070"></a>00070 MemoryManager& theManager); |
| <a name="l00071"></a>00071 <span class="comment"></span> |
| <a name="l00072"></a>00072 <span class="comment"> /**</span> |
| <a name="l00073"></a>00073 <span class="comment"> * Construct a new extension namespace handler given all the information</span> |
| <a name="l00074"></a>00074 <span class="comment"> * needed. </span> |
| <a name="l00075"></a>00075 <span class="comment"> * </span> |
| <a name="l00076"></a>00076 <span class="comment"> * @param namespaceUri the extension namespace URI that I'm implementing</span> |
| <a name="l00077"></a>00077 <span class="comment"> * @param funcNames string containing list of functions of extension NS</span> |
| <a name="l00078"></a>00078 <span class="comment"> * @param lang language of code implementing the extension</span> |
| <a name="l00079"></a>00079 <span class="comment"> * @param srcURL value of src attribute (if any) - treated as a URL</span> |
| <a name="l00080"></a>00080 <span class="comment"> * or a classname depending on the value of lang. If</span> |
| <a name="l00081"></a>00081 <span class="comment"> * srcURL is not null, then scriptSrc is ignored.</span> |
| <a name="l00082"></a>00082 <span class="comment"> * @param scriptSrc the actual script code (if any)</span> |
| <a name="l00083"></a>00083 <span class="comment"> */</span> |
| <a name="l00084"></a>00084 <a class="code" href="classExtensionFunctionHandler.html" title="Class handling an extension namespace for XPath.">ExtensionFunctionHandler</a>( |
| <a name="l00085"></a>00085 MemoryManager& theManager, |
| <a name="l00086"></a>00086 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& namespaceUri, |
| <a name="l00087"></a>00087 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& funcNames, |
| <a name="l00088"></a>00088 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& lang, |
| <a name="l00089"></a>00089 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& srcURL, |
| <a name="l00090"></a>00090 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& scriptSrc); |
| <a name="l00091"></a>00091 |
| <a name="l00092"></a>00092 |
| <a name="l00093"></a>00093 <span class="keyword">virtual</span> |
| <a name="l00094"></a>00094 ~<a class="code" href="classExtensionFunctionHandler.html" title="Class handling an extension namespace for XPath.">ExtensionFunctionHandler</a>(); |
| <a name="l00095"></a>00095 |
| <a name="l00096"></a>00096 MemoryManager& |
| <a name="l00097"></a><a class="code" href="classExtensionFunctionHandler.html#ab1e43d3773814c57aa65096ca29cca5e">00097</a> getMemoryManager() |
| <a name="l00098"></a>00098 { |
| <a name="l00099"></a>00099 <span class="keywordflow">return</span> m_namespaceUri.getMemoryManager(); |
| <a name="l00100"></a>00100 } |
| <a name="l00101"></a>00101 <span class="comment"></span> |
| <a name="l00102"></a>00102 <span class="comment"> /**</span> |
| <a name="l00103"></a>00103 <span class="comment"> * Set function local parts of extension NS.</span> |
| <a name="l00104"></a>00104 <span class="comment"> *</span> |
| <a name="l00105"></a>00105 <span class="comment"> * @param functions whitespace separated list of function names defined</span> |
| <a name="l00106"></a>00106 <span class="comment"> * by this extension namespace.</span> |
| <a name="l00107"></a>00107 <span class="comment"> */</span> |
| <a name="l00108"></a>00108 <span class="keyword">virtual</span> <span class="keywordtype">void</span> |
| <a name="l00109"></a>00109 setFunctions(<span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& funcNames); |
| <a name="l00110"></a>00110 <span class="comment"></span> |
| <a name="l00111"></a>00111 <span class="comment"> /**</span> |
| <a name="l00112"></a>00112 <span class="comment"> * Set the script data for this extension NS. If srcURL is !null then</span> |
| <a name="l00113"></a>00113 <span class="comment"> * the script body is read from that URL. If not the scriptSrc is used</span> |
| <a name="l00114"></a>00114 <span class="comment"> * as the src. This method does not actually execute anything - that's</span> |
| <a name="l00115"></a>00115 <span class="comment"> * done when the component is first hit by the user by an element or </span> |
| <a name="l00116"></a>00116 <span class="comment"> * a function call.</span> |
| <a name="l00117"></a>00117 <span class="comment"> *</span> |
| <a name="l00118"></a>00118 <span class="comment"> * @param lang language of the script.</span> |
| <a name="l00119"></a>00119 <span class="comment"> * @param srcURL value of src attribute (if any) - treated as a URL</span> |
| <a name="l00120"></a>00120 <span class="comment"> * or a classname depending on the value of lang. If</span> |
| <a name="l00121"></a>00121 <span class="comment"> * srcURL is not null, then scriptSrc is ignored.</span> |
| <a name="l00122"></a>00122 <span class="comment"> * @param scriptSrc the actual script code (if any)</span> |
| <a name="l00123"></a>00123 <span class="comment"> */</span> |
| <a name="l00124"></a>00124 <span class="keyword">virtual</span> <span class="keywordtype">void</span> |
| <a name="l00125"></a>00125 setScript( |
| <a name="l00126"></a>00126 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& lang, |
| <a name="l00127"></a>00127 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& srcURL, |
| <a name="l00128"></a>00128 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& scriptSrc); |
| <a name="l00129"></a>00129 <span class="comment"></span> |
| <a name="l00130"></a>00130 <span class="comment"> /**</span> |
| <a name="l00131"></a>00131 <span class="comment"> * Tests whether a certain function name is known within this namespace.</span> |
| <a name="l00132"></a>00132 <span class="comment"> *</span> |
| <a name="l00133"></a>00133 <span class="comment"> * @param function name of the function being tested</span> |
| <a name="l00134"></a>00134 <span class="comment"> * @return true if its known, false if not.</span> |
| <a name="l00135"></a>00135 <span class="comment"> */</span> |
| <a name="l00136"></a>00136 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> |
| <a name="l00137"></a>00137 isFunctionAvailable(<span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& function) <span class="keyword">const</span>; |
| <a name="l00138"></a>00138 <span class="comment"></span> |
| <a name="l00139"></a>00139 <span class="comment"> /// Vector of pointers to function arguments</span> |
| <a name="l00140"></a><a class="code" href="classExtensionFunctionHandler.html#a14e8c99bc1c7b475edca470a5db9998a">00140</a> <span class="comment"></span> <span class="keyword">typedef</span> <a class="code" href="classXalanVector.html">XalanVector<void*></a> <a class="code" href="classXalanVector.html">ArgVectorType</a>; |
| <a name="l00141"></a>00141 |
| <a name="l00142"></a><a class="code" href="classExtensionFunctionHandler.html#a0f1e37643c9084d39639da952675f189">00142</a> <span class="keyword">typedef</span> <a class="code" href="classXalanSet.html">XalanSet<XalanDOMString></a> <a class="code" href="classXalanSet.html">StringSetType</a>; |
| <a name="l00143"></a>00143 <span class="comment"></span> |
| <a name="l00144"></a>00144 <span class="comment"> /**</span> |
| <a name="l00145"></a>00145 <span class="comment"> * Process a call to a function.</span> |
| <a name="l00146"></a>00146 <span class="comment"> *</span> |
| <a name="l00147"></a>00147 <span class="comment"> * @param funcName Function name.</span> |
| <a name="l00148"></a>00148 <span class="comment"> * @param args The arguments of the function call.</span> |
| <a name="l00149"></a>00149 <span class="comment"> *</span> |
| <a name="l00150"></a>00150 <span class="comment"> * @return the return value of the function evaluation.</span> |
| <a name="l00151"></a>00151 <span class="comment"> *</span> |
| <a name="l00152"></a>00152 <span class="comment"> * @exception XSLProcessorException thrown if something goes wrong </span> |
| <a name="l00153"></a>00153 <span class="comment"> * while running the extension handler.</span> |
| <a name="l00154"></a>00154 <span class="comment"> * @exception MalformedURLException if loading trouble</span> |
| <a name="l00155"></a>00155 <span class="comment"> * @exception FileNotFoundException if loading trouble</span> |
| <a name="l00156"></a>00156 <span class="comment"> * @exception IOException if loading trouble</span> |
| <a name="l00157"></a>00157 <span class="comment"> * @exception SAXException if parsing trouble</span> |
| <a name="l00158"></a>00158 <span class="comment"> */</span> |
| <a name="l00159"></a>00159 |
| <a name="l00160"></a>00160 <span class="keyword">virtual</span> <a class="code" href="classXObjectPtr.html" title="Class to hold XObjectPtr return types.">XObjectPtr</a> |
| <a name="l00161"></a>00161 callFunction( |
| <a name="l00162"></a>00162 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& funcName, |
| <a name="l00163"></a>00163 <span class="keyword">const</span> <a class="code" href="classXalanVector.html">ArgVectorType</a>& args); |
| <a name="l00164"></a>00164 |
| <a name="l00165"></a>00165 <span class="keyword">protected</span>: |
| <a name="l00166"></a>00166 |
| <a name="l00167"></a><a class="code" href="classExtensionFunctionHandler.html#aee94f7649f761a6157624061d2cb40b6">00167</a> <a class="code" href="classXalanDOMString.html">XalanDOMString</a> m_namespaceUri; <span class="comment">// uri of the extension namespace</span> |
| <a name="l00168"></a><a class="code" href="classExtensionFunctionHandler.html#afae55e6fa111c2f06b7836a134e9dbcc">00168</a> <a class="code" href="classXalanDOMString.html">XalanDOMString</a> m_scriptLang; <span class="comment">// scripting language of implementation</span> |
| <a name="l00169"></a><a class="code" href="classExtensionFunctionHandler.html#a35eff8465eb82928378056c6562687ba">00169</a> <a class="code" href="classXalanDOMString.html">XalanDOMString</a> m_scriptSrc; <span class="comment">// script source to run (if any)</span> |
| <a name="l00170"></a><a class="code" href="classExtensionFunctionHandler.html#a3a06b9f151168ed2f6cdcd5328575e3c">00170</a> <a class="code" href="classXalanDOMString.html">XalanDOMString</a> m_scriptSrcURL; <span class="comment">// URL of source of script (if any)</span> |
| <a name="l00171"></a>00171 |
| <a name="l00172"></a><a class="code" href="classExtensionFunctionHandler.html#a93fb9cbc6e43272d6c5e5b16c10979e1">00172</a> <span class="keywordtype">void</span>* m_javaObject; <span class="comment">// object for javaclass engine</span> |
| <a name="l00173"></a>00173 |
| <a name="l00174"></a><a class="code" href="classExtensionFunctionHandler.html#a26c9fcedf4bc686750b9ef073ede9e58">00174</a> <a class="code" href="classXalanSet.html">StringSetType</a> m_functions; <span class="comment">// functions of namespace</span> |
| <a name="l00175"></a>00175 |
| <a name="l00176"></a>00176 <span class="comment">// BSFManager mgr = new BSFManager (); // mgr used to run scripts</span> |
| <a name="l00177"></a>00177 |
| <a name="l00178"></a><a class="code" href="classExtensionFunctionHandler.html#acb065555e17ceae31d19c6562ed82196">00178</a> <span class="keywordtype">bool</span> m_componentStarted; <span class="comment">// true when the scripts in a</span> |
| <a name="l00179"></a>00179 |
| <a name="l00180"></a>00180 <span class="comment">// component description (if any) have been run</span> |
| <a name="l00181"></a>00181 <span class="comment"></span> |
| <a name="l00182"></a>00182 <span class="comment"> /**</span> |
| <a name="l00183"></a>00183 <span class="comment"> * Start the component up by executing any script that needs to run</span> |
| <a name="l00184"></a>00184 <span class="comment"> * at startup time. This needs to happen before any functions can be</span> |
| <a name="l00185"></a>00185 <span class="comment"> * called on the component. </span> |
| <a name="l00186"></a>00186 <span class="comment"> * </span> |
| <a name="l00187"></a>00187 <span class="comment"> * @exception XPathProcessorException if something bad happens.</span> |
| <a name="l00188"></a>00188 <span class="comment"> */</span> |
| <a name="l00189"></a>00189 <span class="keyword">virtual</span> <span class="keywordtype">void</span> |
| <a name="l00190"></a>00190 startupComponent(); |
| <a name="l00191"></a>00191 |
| <a name="l00192"></a><a class="code" href="classExtensionFunctionHandler.html#abd7db2c00769103c58556fec7eeb3f0a">00192</a> <span class="keyword">static</span> <span class="keyword">const</span> XalanDOMChar s_tokenDelimiterCharacters[]; |
| <a name="l00193"></a>00193 }; |
| <a name="l00194"></a>00194 |
| <a name="l00195"></a>00195 |
| <a name="l00196"></a>00196 |
| <a name="l00197"></a>00197 XALAN_CPP_NAMESPACE_END |
| <a name="l00198"></a>00198 |
| <a name="l00199"></a>00199 |
| <a name="l00200"></a>00200 |
| <a name="l00201"></a>00201 <span class="preprocessor">#endif // XALAN_EXTENSIONFUNCTIONHANDLER_HEADER_GUARD</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> |
