blob: 1967dc8a39dc4c181331e32d1d1d32c97e0aeea1 [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>NameSpace.hpp</h1> </div>
</div>
<div class="contents">
<a href="NameSpace_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(NAMESPACE_HEADER_GUARD_1357924680)</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span><span class="preprocessor">#define NAMESPACE_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 header file. Must be first.</span>
<a name="l00024"></a>00024 <span class="preprocessor">#include &lt;<a class="code" href="XPathDefinitions_8hpp.html">xalanc/XPath/XPathDefinitions.hpp</a>&gt;</span>
<a name="l00025"></a>00025
<a name="l00026"></a>00026 <span class="preprocessor">#include &lt;<a class="code" href="XalanMemMgrAutoPtr_8hpp.html">xalanc/Include/XalanMemMgrAutoPtr.hpp</a>&gt;</span>
<a name="l00027"></a>00027
<a name="l00028"></a>00028 <span class="preprocessor">#include &lt;<a class="code" href="DOMStringHelper_8hpp.html">xalanc/PlatformSupport/DOMStringHelper.hpp</a>&gt;</span>
<a name="l00029"></a>00029
<a name="l00030"></a>00030
<a name="l00031"></a>00031
<a name="l00032"></a>00032 XALAN_CPP_NAMESPACE_BEGIN
<a name="l00033"></a>00033
<a name="l00034"></a>00034
<a name="l00035"></a>00035 <span class="comment"></span>
<a name="l00036"></a>00036 <span class="comment">/**</span>
<a name="l00037"></a>00037 <span class="comment"> * A representation of a namespace. One of these will be pushed on the</span>
<a name="l00038"></a>00038 <span class="comment"> * namespace stack for each element.</span>
<a name="l00039"></a>00039 <span class="comment"> */</span>
<a name="l00040"></a><a class="code" href="classNameSpace.html">00040</a> <span class="keyword">class </span><a class="code" href="XPathDefinitions_8hpp.html#aa9c15f77ef5ab2dc518733b0fd07c141">XALAN_XPATH_EXPORT</a> <a class="code" href="classNameSpace.html" title="A representation of a namespace.">NameSpace</a>
<a name="l00041"></a>00041 {
<a name="l00042"></a>00042 <span class="keyword">public</span>:
<a name="l00043"></a>00043
<a name="l00044"></a>00044 <span class="keyword">explicit</span>
<a name="l00045"></a><a class="code" href="classNameSpace.html#a0dbbc1e84f8b3cf0b2346983d1d22981">00045</a> <a class="code" href="classNameSpace.html" title="A representation of a namespace.">NameSpace</a>(MemoryManager&amp; theManager) :
<a name="l00046"></a>00046 m_prefix(theManager),
<a name="l00047"></a>00047 m_uri(theManager)
<a name="l00048"></a>00048 {
<a name="l00049"></a>00049 }
<a name="l00050"></a>00050 <span class="comment"></span>
<a name="l00051"></a>00051 <span class="comment"> /**</span>
<a name="l00052"></a>00052 <span class="comment"> * Construct a namespace for placement on the </span>
<a name="l00053"></a>00053 <span class="comment"> * result tree namespace stack.</span>
<a name="l00054"></a>00054 <span class="comment"> *</span>
<a name="l00055"></a>00055 <span class="comment"> * @param prefix namespace prefix</span>
<a name="l00056"></a>00056 <span class="comment"> * @param uri URI of namespace</span>
<a name="l00057"></a>00057 <span class="comment"> */</span>
<a name="l00058"></a><a class="code" href="classNameSpace.html#a5242428a101bff86ff18d00b68001f95">00058</a> <a class="code" href="classNameSpace.html" title="A representation of a namespace.">NameSpace</a>(
<a name="l00059"></a>00059 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; prefix,
<a name="l00060"></a>00060 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; uri,
<a name="l00061"></a>00061 MemoryManager&amp; theManager) :
<a name="l00062"></a>00062 m_prefix(prefix, theManager),
<a name="l00063"></a>00063 m_uri(uri, theManager)
<a name="l00064"></a>00064 {
<a name="l00065"></a>00065 }
<a name="l00066"></a>00066
<a name="l00067"></a>00067 <span class="keyword">static</span> <a class="code" href="classNameSpace.html" title="A representation of a namespace.">NameSpace</a>*
<a name="l00068"></a><a class="code" href="classNameSpace.html#abe03bdce94cea9c5ae9437df2523834c">00068</a> create(
<a name="l00069"></a>00069 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; prefix,
<a name="l00070"></a>00070 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; uri,
<a name="l00071"></a>00071 MemoryManager&amp; theManager)
<a name="l00072"></a>00072 {
<a name="l00073"></a>00073 <span class="keyword">typedef</span> <a class="code" href="classNameSpace.html" title="A representation of a namespace.">NameSpace</a> ThisType;
<a name="l00074"></a>00074
<a name="l00075"></a>00075 <a class="code" href="classXalanAllocationGuard.html">XalanAllocationGuard</a> theGuard(theManager, theManager.allocate(<span class="keyword">sizeof</span>(ThisType)));
<a name="l00076"></a>00076
<a name="l00077"></a>00077 ThisType* <span class="keyword">const</span> <a class="code" href="XalanDOMString_8hpp.html#ad0987a2085caff760532b7f16b5c6f2e">theResult</a> =
<a name="l00078"></a>00078 <span class="keyword">new</span> (theGuard.get()) ThisType(
<a name="l00079"></a>00079 prefix,
<a name="l00080"></a>00080 uri,
<a name="l00081"></a>00081 theManager);
<a name="l00082"></a>00082
<a name="l00083"></a>00083 theGuard.release();
<a name="l00084"></a>00084
<a name="l00085"></a>00085 <span class="keywordflow">return</span> theResult;
<a name="l00086"></a>00086 }
<a name="l00087"></a>00087
<a name="l00088"></a><a class="code" href="classNameSpace.html#a580855681f4734aacea92c8d59a1bb04">00088</a> <a class="code" href="classNameSpace.html" title="A representation of a namespace.">NameSpace</a>(
<a name="l00089"></a>00089 <span class="keyword">const</span> <a class="code" href="classNameSpace.html" title="A representation of a namespace.">NameSpace</a>&amp; other,
<a name="l00090"></a>00090 MemoryManager&amp; theManager) :
<a name="l00091"></a>00091 m_prefix(other.m_prefix, theManager),
<a name="l00092"></a>00092 m_uri(other.m_uri, theManager)
<a name="l00093"></a>00093 {
<a name="l00094"></a>00094 }
<a name="l00095"></a>00095
<a name="l00096"></a><a class="code" href="classNameSpace.html#a7512303b61b1be8458db2f30a236c9bb">00096</a> ~<a class="code" href="classNameSpace.html" title="A representation of a namespace.">NameSpace</a>()
<a name="l00097"></a>00097 {
<a name="l00098"></a>00098 }
<a name="l00099"></a>00099 <span class="comment"></span>
<a name="l00100"></a>00100 <span class="comment"> /**</span>
<a name="l00101"></a>00101 <span class="comment"> * Retrieve the prefix for namespace</span>
<a name="l00102"></a>00102 <span class="comment"> * </span>
<a name="l00103"></a>00103 <span class="comment"> * @return prefix string</span>
<a name="l00104"></a>00104 <span class="comment"> */</span>
<a name="l00105"></a>00105 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;
<a name="l00106"></a><a class="code" href="classNameSpace.html#aabdb10cdaf1308d17a4803e3c2d8b434">00106</a> getPrefix()<span class="keyword"> const</span>
<a name="l00107"></a>00107 <span class="keyword"> </span>{
<a name="l00108"></a>00108 <span class="keywordflow">return</span> m_prefix;
<a name="l00109"></a>00109 }
<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 prefix for namespace</span>
<a name="l00113"></a>00113 <span class="comment"> * </span>
<a name="l00114"></a>00114 <span class="comment"> * @param prefix The new prefix value</span>
<a name="l00115"></a>00115 <span class="comment"> */</span>
<a name="l00116"></a>00116 <span class="keywordtype">void</span>
<a name="l00117"></a><a class="code" href="classNameSpace.html#a003260f096c754910047f6832286da78">00117</a> setPrefix(<span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; prefix)
<a name="l00118"></a>00118 {
<a name="l00119"></a>00119 m_prefix = prefix;
<a name="l00120"></a>00120 }
<a name="l00121"></a>00121 <span class="comment"></span>
<a name="l00122"></a>00122 <span class="comment"> /**</span>
<a name="l00123"></a>00123 <span class="comment"> * Retrieve the URI for namespace</span>
<a name="l00124"></a>00124 <span class="comment"> * </span>
<a name="l00125"></a>00125 <span class="comment"> * @return URI string</span>
<a name="l00126"></a>00126 <span class="comment"> */</span>
<a name="l00127"></a>00127 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;
<a name="l00128"></a><a class="code" href="classNameSpace.html#a72eae8c8c87f088397e546da749e07d3">00128</a> getURI()<span class="keyword"> const</span>
<a name="l00129"></a>00129 <span class="keyword"> </span>{
<a name="l00130"></a>00130 <span class="keywordflow">return</span> m_uri;
<a name="l00131"></a>00131 }
<a name="l00132"></a>00132 <span class="comment"></span>
<a name="l00133"></a>00133 <span class="comment"> /**</span>
<a name="l00134"></a>00134 <span class="comment"> * Set the URI for namespace</span>
<a name="l00135"></a>00135 <span class="comment"> * </span>
<a name="l00136"></a>00136 <span class="comment"> * @param uri The new uri value</span>
<a name="l00137"></a>00137 <span class="comment"> */</span>
<a name="l00138"></a>00138 <span class="keywordtype">void</span>
<a name="l00139"></a><a class="code" href="classNameSpace.html#abe97c0d6a40286ae002f63a2843fd4bf">00139</a> setURI(<span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; uri)
<a name="l00140"></a>00140 {
<a name="l00141"></a>00141 m_uri = uri;
<a name="l00142"></a>00142 }
<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"> * Set the URI for namespace</span>
<a name="l00146"></a>00146 <span class="comment"> * </span>
<a name="l00147"></a>00147 <span class="comment"> * @param uri The new uri value</span>
<a name="l00148"></a>00148 <span class="comment"> */</span>
<a name="l00149"></a>00149 <span class="keywordtype">void</span>
<a name="l00150"></a><a class="code" href="classNameSpace.html#adb669df4068456b178f6f1f2a2da4d66">00150</a> setURI(<span class="keyword">const</span> XalanDOMChar* uri)
<a name="l00151"></a>00151 {
<a name="l00152"></a>00152 assert(uri != 0);
<a name="l00153"></a>00153
<a name="l00154"></a>00154 m_uri = uri;
<a name="l00155"></a>00155 }
<a name="l00156"></a>00156 <span class="comment"></span>
<a name="l00157"></a>00157 <span class="comment"> /**</span>
<a name="l00158"></a>00158 <span class="comment"> * Set the URI for namespace</span>
<a name="l00159"></a>00159 <span class="comment"> * </span>
<a name="l00160"></a>00160 <span class="comment"> * @param uri The new uri value</span>
<a name="l00161"></a>00161 <span class="comment"> * @param len The length of the uri</span>
<a name="l00162"></a>00162 <span class="comment"> */</span>
<a name="l00163"></a>00163 <span class="keywordtype">void</span>
<a name="l00164"></a><a class="code" href="classNameSpace.html#aefcde204424fca78214245b747b8794d">00164</a> setURI(
<a name="l00165"></a>00165 <span class="keyword">const</span> XalanDOMChar* uri,
<a name="l00166"></a>00166 <a class="code" href="classXalanDOMString.html#ab8b91a47f3335d6c54c49029dd1074f2">XalanDOMString::size_type</a> len)
<a name="l00167"></a>00167 {
<a name="l00168"></a>00168 assert(uri != 0);
<a name="l00169"></a>00169
<a name="l00170"></a>00170 m_uri.assign(uri, len);
<a name="l00171"></a>00171 }
<a name="l00172"></a>00172
<a name="l00173"></a>00173 <span class="keywordtype">bool</span>
<a name="l00174"></a><a class="code" href="classNameSpace.html#a9475c60b698bd00dbb13c4a8c6411fc0">00174</a> empty()<span class="keyword"> const</span>
<a name="l00175"></a>00175 <span class="keyword"> </span>{
<a name="l00176"></a>00176 <span class="keywordflow">return</span> m_prefix.empty() &amp;&amp; m_uri.empty();
<a name="l00177"></a>00177 }
<a name="l00178"></a>00178
<a name="l00179"></a>00179 <span class="keywordtype">void</span>
<a name="l00180"></a><a class="code" href="classNameSpace.html#ab5f0dd142431dc2e963ac95f4faa2468">00180</a> <a class="code" href="DOMStringHelper_8hpp.html#a3beaa7474ee8377a7de5fe4eceddcc94" title="Remove all elements from target string.">clear</a>()
<a name="l00181"></a>00181 {
<a name="l00182"></a>00182 m_prefix.clear();
<a name="l00183"></a>00183
<a name="l00184"></a>00184 m_uri.clear();
<a name="l00185"></a>00185 }
<a name="l00186"></a>00186 <span class="comment"></span>
<a name="l00187"></a>00187 <span class="comment"> /**</span>
<a name="l00188"></a>00188 <span class="comment"> * Equality operator</span>
<a name="l00189"></a>00189 <span class="comment"> *</span>
<a name="l00190"></a>00190 <span class="comment"> * @param theRHS namespace to compare</span>
<a name="l00191"></a>00191 <span class="comment"> */</span>
<a name="l00192"></a>00192 <span class="keywordtype">bool</span>
<a name="l00193"></a><a class="code" href="classNameSpace.html#a319335087f56ac0a8b49d5f0d5889a89">00193</a> <a class="code" href="ElemAttributeSet_8hpp.html#ae199bc16afddda1065706543e752d292">operator==</a>(<span class="keyword">const</span> <a class="code" href="classNameSpace.html" title="A representation of a namespace.">NameSpace</a>&amp; theRHS)<span class="keyword"> const</span>
<a name="l00194"></a>00194 <span class="keyword"> </span>{
<a name="l00195"></a>00195 <span class="keywordflow">return</span> <a class="code" href="DOMStringHelper_8hpp.html#affde9d545fd2e9ade2b7c5e03f383e79" title="Compare the contents of two arrays for equality.">equals</a>(m_prefix, theRHS.m_prefix) &amp;&amp;
<a name="l00196"></a>00196 <a class="code" href="DOMStringHelper_8hpp.html#affde9d545fd2e9ade2b7c5e03f383e79" title="Compare the contents of two arrays for equality.">equals</a>(m_uri, theRHS.m_uri);
<a name="l00197"></a>00197 }
<a name="l00198"></a>00198
<a name="l00199"></a>00199 <span class="keyword">private</span>:
<a name="l00200"></a>00200 <a class="code" href="classNameSpace.html" title="A representation of a namespace.">NameSpace</a>(<span class="keyword">const</span> <a class="code" href="classNameSpace.html" title="A representation of a namespace.">NameSpace</a>&amp;);
<a name="l00201"></a>00201
<a name="l00202"></a>00202 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> m_prefix;
<a name="l00203"></a>00203
<a name="l00204"></a>00204 <a class="code" href="classXalanDOMString.html">XalanDOMString</a> m_uri;
<a name="l00205"></a>00205 };
<a name="l00206"></a>00206
<a name="l00207"></a><a class="code" href="structMemoryManagedConstructionTraits_3_01NameSpace_01_4.html#a4df71279784db732598929f2fee4e420">00207</a> <a class="code" href="XalanMemoryManagement_8hpp.html#afe156dfb53fca069b4707b01bcfc1d0d">XALAN_USES_MEMORY_MANAGER</a>(<a class="code" href="classNameSpace.html" title="A representation of a namespace.">NameSpace</a>)
<a name="l00208"></a>00208
<a name="l00209"></a>00209 XALAN_CPP_NAMESPACE_END
<a name="l00210"></a>00210
<a name="l00211"></a>00211
<a name="l00212"></a>00212
<a name="l00213"></a>00213 <span class="preprocessor">#endif // NAMESPACE_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 &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>