blob: 904045da514ce5b2406065ca2b4bf7232c1a94e1 [file] [log] [blame]
<!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&nbsp;Page</span></a></li>
<li><a href="pages.html"><span>Related&nbsp;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&nbsp;List</span></a></li>
<li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<h1>ExtensionNSHandler.hpp</h1> </div>
</div>
<div class="contents">
<a href="ExtensionNSHandler_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 &quot;License&quot;);</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 &quot;AS IS&quot; 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(XALAN_EXTENSIONNSHANDLER_HEADER_GUARD)</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span><span class="preprocessor">#define XALAN_EXTENSIONNSHANDLER_HEADER_GUARD</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span>
<a name="l00021"></a>00021
<a name="l00022"></a>00022 <span class="comment">// Base include file. Must be first.</span>
<a name="l00023"></a>00023 <span class="preprocessor">#include &quot;<a class="code" href="XSLTDefinitions_8hpp.html">XSLTDefinitions.hpp</a>&quot;</span>
<a name="l00024"></a>00024
<a name="l00025"></a>00025
<a name="l00026"></a>00026
<a name="l00027"></a>00027 <span class="comment">// Base class</span>
<a name="l00028"></a>00028 <span class="preprocessor">#include &quot;<a class="code" href="ExtensionFunctionHandler_8hpp.html">ExtensionFunctionHandler.hpp</a>&quot;</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 &lt;<a class="code" href="XalanSet_8hpp.html">xalanc/Include/XalanSet.hpp</a>&gt;</span>
<a name="l00033"></a>00033
<a name="l00034"></a>00034
<a name="l00035"></a>00035
<a name="l00036"></a>00036 <span class="preprocessor">#include &lt;<a class="code" href="XalanDOMString_8hpp.html">xalanc/XalanDOM/XalanDOMString.hpp</a>&gt;</span>
<a name="l00037"></a>00037
<a name="l00038"></a>00038
<a name="l00039"></a>00039
<a name="l00040"></a>00040 <span class="preprocessor">#include &lt;<a class="code" href="DOMStringHelper_8hpp.html">xalanc/PlatformSupport/DOMStringHelper.hpp</a>&gt;</span>
<a name="l00041"></a>00041
<a name="l00042"></a>00042
<a name="l00043"></a>00043
<a name="l00044"></a>00044 XALAN_CPP_NAMESPACE_BEGIN
<a name="l00045"></a>00045
<a name="l00046"></a>00046
<a name="l00047"></a>00047
<a name="l00048"></a>00048 <span class="keyword">class </span><a class="code" href="classStylesheet.html" title="This class represents the base stylesheet or an &amp;quot;import&amp;quot; stylesheet.">Stylesheet</a>;
<a name="l00049"></a>00049 <span class="keyword">class </span><a class="code" href="classStylesheetExecutionContext.html">StylesheetExecutionContext</a>;
<a name="l00050"></a>00050 <span class="keyword">class </span><a class="code" href="classXalanElement.html">XalanElement</a>;
<a name="l00051"></a>00051 <span class="keyword">class </span><a class="code" href="classXalanNode.html">XalanNode</a>;
<a name="l00052"></a>00052 <span class="keyword">class </span><a class="code" href="classXalanQName.html" title="Class to represent a qualified name.">XalanQName</a>;
<a name="l00053"></a>00053
<a name="l00054"></a>00054
<a name="l00055"></a>00055
<a name="l00056"></a><a class="code" href="classExtensionNSHandler.html">00056</a> <span class="keyword">class </span><a class="code" href="XSLTDefinitions_8hpp.html#afe13e115e49db23eff1daccf7343935f">XALAN_XSLT_EXPORT</a> <a class="code" href="classExtensionNSHandler.html">ExtensionNSHandler</a> : <span class="keyword">public</span> <a class="code" href="classExtensionFunctionHandler.html" title="Class handling an extension namespace for XPath.">ExtensionFunctionHandler</a>
<a name="l00057"></a>00057 {
<a name="l00058"></a>00058 <span class="keyword">public</span>:
<a name="l00059"></a>00059 <span class="comment"></span>
<a name="l00060"></a>00060 <span class="comment"> /**</span>
<a name="l00061"></a>00061 <span class="comment"> * Construct a new extension namespace handler for a given extension NS.</span>
<a name="l00062"></a>00062 <span class="comment"> * This doesn&#39;t do anything - just hang on to the namespace URI.</span>
<a name="l00063"></a>00063 <span class="comment"> * </span>
<a name="l00064"></a>00064 <span class="comment"> * @param namespaceUri extension namespace URI being implemented</span>
<a name="l00065"></a>00065 <span class="comment"> */</span>
<a name="l00066"></a>00066 <a class="code" href="classExtensionNSHandler.html">ExtensionNSHandler</a>(
<a name="l00067"></a>00067 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; namespaceUri,
<a name="l00068"></a>00068 MemoryManager&amp; theManager);
<a name="l00069"></a>00069
<a name="l00070"></a>00070 <span class="keyword">static</span> <a class="code" href="classExtensionNSHandler.html">ExtensionNSHandler</a>*
<a name="l00071"></a>00071 create(
<a name="l00072"></a>00072 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; namespaceUri,
<a name="l00073"></a>00073 MemoryManager&amp; theManager);
<a name="l00074"></a>00074 <span class="comment"></span>
<a name="l00075"></a>00075 <span class="comment"> /**</span>
<a name="l00076"></a>00076 <span class="comment"> * Construct a new extension namespace handler given all the information</span>
<a name="l00077"></a>00077 <span class="comment"> * needed. </span>
<a name="l00078"></a>00078 <span class="comment"> * </span>
<a name="l00079"></a>00079 <span class="comment"> * @param namespaceUri extension namespace URI being implemented</span>
<a name="l00080"></a>00080 <span class="comment"> * @param elemNames string containing list of elements of extension NS</span>
<a name="l00081"></a>00081 <span class="comment"> * @param funcNames string containing list of functions of extension NS</span>
<a name="l00082"></a>00082 <span class="comment"> * @param lang language of code implementing the extension</span>
<a name="l00083"></a>00083 <span class="comment"> * @param srcURL value of src attribute (if any) - treated as a URL</span>
<a name="l00084"></a>00084 <span class="comment"> * or a classname depending on the value of lang. If</span>
<a name="l00085"></a>00085 <span class="comment"> * srcURL is not null, then scriptSrc is ignored.</span>
<a name="l00086"></a>00086 <span class="comment"> * @param scriptSrc the actual script code (if any)</span>
<a name="l00087"></a>00087 <span class="comment"> */</span>
<a name="l00088"></a>00088 <a class="code" href="classExtensionNSHandler.html">ExtensionNSHandler</a>(
<a name="l00089"></a>00089 MemoryManager&amp; theManager,
<a name="l00090"></a>00090 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; namespaceUri,
<a name="l00091"></a>00091 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; elemNames,
<a name="l00092"></a>00092 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; funcNames,
<a name="l00093"></a>00093 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; lang,
<a name="l00094"></a>00094 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; srcURL,
<a name="l00095"></a>00095 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; src);
<a name="l00096"></a>00096 <span class="comment"></span>
<a name="l00097"></a>00097 <span class="comment"> /**</span>
<a name="l00098"></a>00098 <span class="comment"> * Set function local parts of extension NS. Super does the work; I</span>
<a name="l00099"></a>00099 <span class="comment"> * just record that a component desc has been loaded.</span>
<a name="l00100"></a>00100 <span class="comment"> *</span>
<a name="l00101"></a>00101 <span class="comment"> * @param functions whitespace separated list of function names defined</span>
<a name="l00102"></a>00102 <span class="comment"> * by this extension namespace</span>
<a name="l00103"></a>00103 <span class="comment"> */</span>
<a name="l00104"></a>00104 <span class="keyword">virtual</span> <span class="keywordtype">void</span>
<a name="l00105"></a>00105 <a class="code" href="classExtensionFunctionHandler.html#a062f7ad8ba7c410056351029537d8bda" title="Set function local parts of extension NS.">setFunctions</a>(<span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; funcNames);
<a name="l00106"></a>00106 <span class="comment"></span>
<a name="l00107"></a>00107 <span class="comment"> /**</span>
<a name="l00108"></a>00108 <span class="comment"> * Set the script data for this extension NS. Deferred to super for</span>
<a name="l00109"></a>00109 <span class="comment"> * actual work - only record that a component desc has been loaded.</span>
<a name="l00110"></a>00110 <span class="comment"> *</span>
<a name="l00111"></a>00111 <span class="comment"> * @param lang language of the script</span>
<a name="l00112"></a>00112 <span class="comment"> * @param srcURL value of src attribute (if any) - treated as a URL</span>
<a name="l00113"></a>00113 <span class="comment"> * or a classname depending on the value of lang. If</span>
<a name="l00114"></a>00114 <span class="comment"> * srcURL is not null, then scriptSrc is ignored.</span>
<a name="l00115"></a>00115 <span class="comment"> * @param scriptSrc the actual script code (if any)</span>
<a name="l00116"></a>00116 <span class="comment"> */</span>
<a name="l00117"></a>00117 <span class="keyword">virtual</span> <span class="keywordtype">void</span>
<a name="l00118"></a>00118 <a class="code" href="classExtensionFunctionHandler.html#ab7cf4c9d751e1888e8e2d006244d18bc" title="Set the script data for this extension NS.">setScript</a>(
<a name="l00119"></a>00119 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; lang,
<a name="l00120"></a>00120 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; srcURL,
<a name="l00121"></a>00121 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; scriptSrc);
<a name="l00122"></a>00122 <span class="comment"></span>
<a name="l00123"></a>00123 <span class="comment"> /**</span>
<a name="l00124"></a>00124 <span class="comment"> * Set element local parts of extension NS.</span>
<a name="l00125"></a>00125 <span class="comment"> *</span>
<a name="l00126"></a>00126 <span class="comment"> * @param elemNames whitespace separated list of element names defined</span>
<a name="l00127"></a>00127 <span class="comment"> * by this extension namespace</span>
<a name="l00128"></a>00128 <span class="comment"> */</span>
<a name="l00129"></a>00129 <span class="keywordtype">void</span>
<a name="l00130"></a>00130 setElements(<span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; elemNames);
<a name="l00131"></a>00131 <span class="comment"></span>
<a name="l00132"></a>00132 <span class="comment"> /**</span>
<a name="l00133"></a>00133 <span class="comment"> * Tests whether a certain element name is known within this namespace.</span>
<a name="l00134"></a>00134 <span class="comment"> *</span>
<a name="l00135"></a>00135 <span class="comment"> * @param element name of the element being tested</span>
<a name="l00136"></a>00136 <span class="comment"> * @return true if known, false if not</span>
<a name="l00137"></a>00137 <span class="comment"> */</span>
<a name="l00138"></a>00138 <span class="keywordtype">bool</span>
<a name="l00139"></a>00139 isElementAvailable (<span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; element) <span class="keyword">const</span>;
<a name="l00140"></a>00140 <span class="comment"></span>
<a name="l00141"></a>00141 <span class="comment"> /**</span>
<a name="l00142"></a>00142 <span class="comment"> * Process a call to this extension namespace via an element. As a side</span>
<a name="l00143"></a>00143 <span class="comment"> * effect, the results are sent to the XSLTProcessor&#39;s result tree.</span>
<a name="l00144"></a>00144 <span class="comment"> *</span>
<a name="l00145"></a>00145 <span class="comment"> * @param localPart element name&#39;s local part</span>
<a name="l00146"></a>00146 <span class="comment"> * @param element extension element being processed</span>
<a name="l00147"></a>00147 <span class="comment"> * @param stylesheetTree compiled stylesheet tree</span>
<a name="l00148"></a>00148 <span class="comment"> * @param mode current mode</span>
<a name="l00149"></a>00149 <span class="comment"> * @param sourceTree root of the source tree (but don&#39;t assume it&#39;s a</span>
<a name="l00150"></a>00150 <span class="comment"> * document)</span>
<a name="l00151"></a>00151 <span class="comment"> * @param sourceNode current context node</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 <span class="keywordtype">void</span>
<a name="l00160"></a>00160 processElement (
<a name="l00161"></a>00161 <a class="code" href="classStylesheetExecutionContext.html">StylesheetExecutionContext</a>&amp; executionContext,
<a name="l00162"></a>00162 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; localPart,
<a name="l00163"></a>00163 <span class="keyword">const</span> <a class="code" href="classXalanElement.html">XalanElement</a>* element,
<a name="l00164"></a>00164 <a class="code" href="classStylesheet.html" title="This class represents the base stylesheet or an &amp;quot;import&amp;quot; stylesheet.">Stylesheet</a>&amp; stylesheetTree,
<a name="l00165"></a>00165 <span class="keyword">const</span> <a class="code" href="classXalanNode.html">XalanNode</a>* sourceTree,
<a name="l00166"></a>00166 <span class="keyword">const</span> <a class="code" href="classXalanNode.html">XalanNode</a>* sourceNode,
<a name="l00167"></a>00167 <span class="keyword">const</span> <a class="code" href="classXalanQName.html" title="Class to represent a qualified name.">XalanQName</a>&amp; mode);
<a name="l00168"></a>00168
<a name="l00169"></a>00169 <span class="keyword">protected</span>:
<a name="l00170"></a>00170 <span class="comment"></span>
<a name="l00171"></a>00171 <span class="comment"> /**</span>
<a name="l00172"></a>00172 <span class="comment"> * Start the component up by executing any script that needs to run</span>
<a name="l00173"></a>00173 <span class="comment"> * at startup time. This needs to happen before any functions can be</span>
<a name="l00174"></a>00174 <span class="comment"> * called on the component.</span>
<a name="l00175"></a>00175 <span class="comment"> * </span>
<a name="l00176"></a>00176 <span class="comment"> */</span>
<a name="l00177"></a>00177 <span class="keyword">virtual</span> <span class="keywordtype">void</span>
<a name="l00178"></a>00178 <a class="code" href="classExtensionFunctionHandler.html#ae0626e178e82ee800fb806496f85d0ec" title="Start the component up by executing any script that needs to run at startup time.">startupComponent</a>();
<a name="l00179"></a>00179
<a name="l00180"></a>00180 <span class="keyword">private</span>:
<a name="l00181"></a>00181
<a name="l00182"></a>00182 <span class="keyword">typedef</span> <a class="code" href="classXalanSet.html">XalanSet&lt;XalanDOMString&gt;</a> <a class="code" href="classXalanSet.html">ExtensionSetType</a>;
<a name="l00183"></a>00183
<a name="l00184"></a>00184 <span class="comment">// Extension elements of this namespace</span>
<a name="l00185"></a>00185 <a class="code" href="classXalanSet.html">ExtensionSetType</a> m_elements;
<a name="l00186"></a>00186
<a name="l00187"></a>00187 <span class="comment">// True when info from the component description has been loaded. This gets</span>
<a name="l00188"></a>00188 <span class="comment">// set as soon as any of the info has been specified. If this is false,</span>
<a name="l00189"></a>00189 <span class="comment">// when processElement or processFunction is called it will use the</span>
<a name="l00190"></a>00190 <span class="comment">// namespace URI as a URL and try to load that location as the component</span>
<a name="l00191"></a>00191 <span class="comment">// description</span>
<a name="l00192"></a>00192 <span class="keywordtype">bool</span> m_componentDescLoaded;
<a name="l00193"></a>00193 <span class="comment"></span>
<a name="l00194"></a>00194 <span class="comment"> /**</span>
<a name="l00195"></a>00195 <span class="comment"> * Load the component spec for this extension namespace taking the URI</span>
<a name="l00196"></a>00196 <span class="comment"> * of this namespace as the URL to read from.</span>
<a name="l00197"></a>00197 <span class="comment"> */</span>
<a name="l00198"></a>00198 <span class="keywordtype">void</span>
<a name="l00199"></a>00199 loadComponentDescription();
<a name="l00200"></a>00200 <span class="comment"></span>
<a name="l00201"></a>00201 <span class="comment"> /**</span>
<a name="l00202"></a>00202 <span class="comment"> * extract the text nodes and CDATA content children of the given</span>
<a name="l00203"></a>00203 <span class="comment"> * elem and return as a string. Any other types of node children</span>
<a name="l00204"></a>00204 <span class="comment"> * are ignored</span>
<a name="l00205"></a>00205 <span class="comment"> *</span>
<a name="l00206"></a>00206 <span class="comment"> * @param elem element whose text and cdata children are to be </span>
<a name="l00207"></a>00207 <span class="comment"> * concatenated together.</span>
<a name="l00208"></a>00208 <span class="comment"> *</span>
<a name="l00209"></a>00209 <span class="comment"> * @return string resulting from concatanating the text/cdata child</span>
<a name="l00210"></a>00210 <span class="comment"> * nodes&#39; values.</span>
<a name="l00211"></a>00211 <span class="comment"> */</span>
<a name="l00212"></a>00212 <span class="keyword">static</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;
<a name="l00213"></a>00213 getScriptString(<span class="keyword">const</span> <a class="code" href="classXalanElement.html">XalanElement</a>&amp; elem, <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; <a class="code" href="XalanDOMString_8hpp.html#ad0987a2085caff760532b7f16b5c6f2e">theResult</a>);
<a name="l00214"></a>00214 };
<a name="l00215"></a>00215
<a name="l00216"></a>00216
<a name="l00217"></a>00217
<a name="l00218"></a>00218 XALAN_CPP_NAMESPACE_END
<a name="l00219"></a>00219
<a name="l00220"></a>00220
<a name="l00221"></a>00221
<a name="l00222"></a>00222 <span class="preprocessor">#endif // XALAN_EXTENSIONNSHANDLER_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 &copy; 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>