content/old/xalan-c/apiDocs/XalanDOMStringCache_8hpp-source.html - xalan-site - Git at Google

 <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>XalanDOMStringCache.hpp</h1><a href="XalanDOMStringCache_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(XALAN_DOMSTRINGCACHE_HEADER_GUARD)</font>
 <a name="l00017"></a><a class="code" href="XalanDOMStringCache_8hpp.html#a0">00017</a> <font class="preprocessor"></font><font class="preprocessor">#define XALAN_DOMSTRINGCACHE_HEADER_GUARD</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="PlatformSupportDefinitions_8hpp.html">xalanc/PlatformSupport/PlatformSupportDefinitions.hpp</a>&gt;</font>
 00023
 00024
 00025
 00026 <font class="preprocessor">#include &lt;<a class="code" href="XalanVector_8hpp.html">xalanc/Include/XalanVector.hpp</a>&gt;</font>
 00027
 00028
 00029
 00030 <font class="preprocessor">#include &lt;<a class="code" href="XalanDOMString_8hpp.html">xalanc/XalanDOM/XalanDOMString.hpp</a>&gt;</font>
 00031
 00032
 00033
 00034 <font class="preprocessor">#include &lt;<a class="code" href="XalanDOMStringReusableAllocator_8hpp.html">xalanc/PlatformSupport/XalanDOMStringReusableAllocator.hpp</a>&gt;</font>
 00035
 00036
 00037
 00038 XALAN_CPP_NAMESPACE_BEGIN
 00039
 00040
 00041
 <a name="l00042"></a><a class="code" href="classXalanDOMStringCache.html">00042</a> <font class="keyword">class </font>XALAN_PLATFORMSUPPORT_EXPORT <a class="code" href="classXalanDOMStringCache.html">XalanDOMStringCache</a>
 00043 {
 00044 <font class="keyword">public</font>:
 00045
 00046     <font class="keyword">enum</font> { eDefaultMaximumSize = 100 };
 00047
 <a name="l00048"></a><a class="code" href="classXalanDOMStringCache.html#s0">00048</a>     <font class="keyword">typedef</font> XalanVector&lt;XalanDOMString*&gt;    StringListType;
 00049
 00050     <font class="keyword">explicit</font>
 00051     <a class="code" href="classXalanDOMStringCache.html#a0">XalanDOMStringCache</a>(MemoryManagerType&amp;     theManager,
 00052                         <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font>    theMaximumSize = eDefaultMaximumSize);
 00053
 00054     <a class="code" href="classXalanDOMStringCache.html#a1">~XalanDOMStringCache</a>();
 00055
 00056     <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font>
 <a name="l00057"></a><a class="code" href="classXalanDOMStringCache.html#a2">00057</a>     <a class="code" href="classXalanDOMStringCache.html#a2">getMaximumSize</a>()<font class="keyword"> const</font>
 00058 <font class="keyword">    </font>{
 00059         <font class="keywordflow">return</font> m_maximumSize;
 00060     }
 00061
 00062     <font class="keywordtype">void</font>
 <a name="l00063"></a><a class="code" href="classXalanDOMStringCache.html#a3">00063</a>     <a class="code" href="classXalanDOMStringCache.html#a3">setMaximumSize</a>(<font class="keywordtype">unsigned</font> <font class="keywordtype">int</font>     theSize)<font class="keyword"></font>
 00064 <font class="keyword">    </font>{
 00065         m_maximumSize = theSize;
 00066     }
 00067
 00068     <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;
 00069     <a class="code" href="classXalanDOMStringCache.html#a4">get</a>();
 00070
 00071     <font class="keywordtype">bool</font>
 00072     <a class="code" href="classXalanDOMStringCache.html#a5">release</a>(<a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;     theString);
 00073
 00074     <font class="comment">/*</font>
 00075 <font class="comment">     * Clear all of the strings in the cache.  This</font>
 00076 <font class="comment">     * destroys all of the strings.</font>
 00077 <font class="comment">     *</font>
 00078 <font class="comment">     */</font>
 00079     <font class="keywordtype">void</font>
 00080     <a class="code" href="classXalanDOMStringCache.html#a6">clear</a>();
 00081
 00082     <font class="comment">/*</font>
 00083 <font class="comment">     * Reset the cache so that all strings that are</font>
 00084 <font class="comment">     * currently in use are available.</font>
 00085 <font class="comment">     */</font>
 00086     <font class="keywordtype">void</font>
 00087     <a class="code" href="classXalanDOMStringCache.html#a7">reset</a>();
 00088
 <a name="l00089"></a><a class="code" href="classXalanDOMStringCache_1_1GetAndRelease.html">00089</a>     <font class="keyword">class </font>GetAndRelease
 00090     {
 00091     <font class="keyword">public</font>:
 00092
 <a name="l00093"></a><a class="code" href="classXalanDOMStringCache_1_1GetAndRelease.html#a0">00093</a>         <a class="code" href="classXalanDOMStringCache_1_1GetAndRelease.html#a0">GetAndRelease</a>(<a class="code" href="classXalanDOMStringCache.html">XalanDOMStringCache</a>&amp;  theCache) :
 00094             m_cache(theCache),
 00095             m_string(&amp;theCache.get())
 00096         {
 00097         }
 00098
 <a name="l00099"></a><a class="code" href="classXalanDOMStringCache_1_1GetAndRelease.html#a1">00099</a>         <a class="code" href="classXalanDOMStringCache_1_1GetAndRelease.html#a1">~GetAndRelease</a>()<font class="keyword"></font>
 00100 <font class="keyword">        </font>{
 00101             m_cache.<a class="code" href="classXalanDOMStringCache.html#a5">release</a>(*m_string);
 00102         }
 00103
 00104         <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;
 <a name="l00105"></a><a class="code" href="classXalanDOMStringCache_1_1GetAndRelease.html#a2">00105</a>         <a class="code" href="classXalanDOMStringCache_1_1GetAndRelease.html#a2">get</a>()<font class="keyword"> const</font>
 00106 <font class="keyword">        </font>{
 00107             <font class="keywordflow">return</font> *m_string;
 00108         }
 00109
 00110     <font class="keyword">private</font>:
 00111
 00112         <a class="code" href="classXalanDOMStringCache.html">XalanDOMStringCache</a>&amp;    m_cache;
 00113
 00114         <a class="code" href="classXalanDOMString.html">XalanDOMString</a>* <font class="keyword">const</font>   m_string;
 00115     };
 00116
 00117 <font class="keyword">private</font>:
 00118
 00119     <font class="comment">// not implemented</font>
 00120     <a class="code" href="classXalanDOMStringCache.html#a0">XalanDOMStringCache</a>(<font class="keyword">const</font> <a class="code" href="classXalanDOMStringCache.html">XalanDOMStringCache</a>&amp;);
 00121
 00122     <font class="keywordtype">bool</font>
 00123     <a class="code" href="ElemAttributeSet_8hpp.html#a1">operator==</a>(<font class="keyword">const</font> <a class="code" href="classXalanDOMStringCache.html">XalanDOMStringCache</a>&amp;) <font class="keyword">const</font>;
 00124
 00125     <a class="code" href="classXalanDOMStringCache.html">XalanDOMStringCache</a>&amp;
 00126     operator=(<font class="keyword">const</font> <a class="code" href="classXalanDOMStringCache.html">XalanDOMStringCache</a>&amp;);
 00127
 00131     StringListType                      m_availableList;
 00132
 00136     StringListType                      m_busyList;
 00137
 00138     <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font>                        m_maximumSize;
 00139
 00140     <a class="code" href="classXalanDOMStringReusableAllocator.html">XalanDOMStringReusableAllocator</a>     m_allocator;
 00141 };
 00142
 00143
 00144
 00145 XALAN_CPP_NAMESPACE_END
 00146
 00147
 00148
 00149 <font class="preprocessor">#endif  // XALAN_RESULTNAMESPACESSTACK_HEADER_GUARD</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>
	<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>   <a class="qindex" href="hierarchy.html">Class Hierarchy</a>   <a class="qindex" href="classes.html">Alphabetical List</a>   <a class="qindex" href="annotated.html">Compound List</a>   <a class="qindex" href="files.html">File List</a>   <a class="qindex" href="functions.html">Compound Members</a>   <a class="qindex" href="globals.html">File Members</a>   </center>
	<hr><h1>XalanDOMStringCache.hpp</h1><a href="XalanDOMStringCache_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(XALAN_DOMSTRINGCACHE_HEADER_GUARD)</font>
	<a name="l00017"></a><a class="code" href="XalanDOMStringCache_8hpp.html#a0">00017</a> <font class="preprocessor"></font><font class="preprocessor">#define XALAN_DOMSTRINGCACHE_HEADER_GUARD</font>
	00018 <font class="preprocessor"></font>
	00019
	00020
	00021 <font class="comment">// Base include file. Must be first.</font>
	00022 <font class="preprocessor">#include <<a class="code" href="PlatformSupportDefinitions_8hpp.html">xalanc/PlatformSupport/PlatformSupportDefinitions.hpp</a>></font>
	00023
	00024
	00025
	00026 <font class="preprocessor">#include <<a class="code" href="XalanVector_8hpp.html">xalanc/Include/XalanVector.hpp</a>></font>
	00027
	00028
	00029
	00030 <font class="preprocessor">#include <<a class="code" href="XalanDOMString_8hpp.html">xalanc/XalanDOM/XalanDOMString.hpp</a>></font>
	00031
	00032
	00033
	00034 <font class="preprocessor">#include <<a class="code" href="XalanDOMStringReusableAllocator_8hpp.html">xalanc/PlatformSupport/XalanDOMStringReusableAllocator.hpp</a>></font>
	00035
	00036
	00037
	00038 XALAN_CPP_NAMESPACE_BEGIN
	00039
	00040
	00041
	<a name="l00042"></a><a class="code" href="classXalanDOMStringCache.html">00042</a> <font class="keyword">class </font>XALAN_PLATFORMSUPPORT_EXPORT <a class="code" href="classXalanDOMStringCache.html">XalanDOMStringCache</a>
	00043 {
	00044 <font class="keyword">public</font>:
	00045
	00046 <font class="keyword">enum</font> { eDefaultMaximumSize = 100 };
	00047
	<a name="l00048"></a><a class="code" href="classXalanDOMStringCache.html#s0">00048</a> <font class="keyword">typedef</font> XalanVector<XalanDOMString*> StringListType;
	00049
	00050 <font class="keyword">explicit</font>
	00051 <a class="code" href="classXalanDOMStringCache.html#a0">XalanDOMStringCache</a>(MemoryManagerType& theManager,
	00052 <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> theMaximumSize = eDefaultMaximumSize);
	00053
	00054 <a class="code" href="classXalanDOMStringCache.html#a1">~XalanDOMStringCache</a>();
	00055
	00056 <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font>
	<a name="l00057"></a><a class="code" href="classXalanDOMStringCache.html#a2">00057</a> <a class="code" href="classXalanDOMStringCache.html#a2">getMaximumSize</a>()<font class="keyword"> const</font>
	00058 <font class="keyword"> </font>{
	00059 <font class="keywordflow">return</font> m_maximumSize;
	00060 }
	00061
	00062 <font class="keywordtype">void</font>
	<a name="l00063"></a><a class="code" href="classXalanDOMStringCache.html#a3">00063</a> <a class="code" href="classXalanDOMStringCache.html#a3">setMaximumSize</a>(<font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> theSize)<font class="keyword"></font>
	00064 <font class="keyword"> </font>{
	00065 m_maximumSize = theSize;
	00066 }
	00067
	00068 <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&
	00069 <a class="code" href="classXalanDOMStringCache.html#a4">get</a>();
	00070
	00071 <font class="keywordtype">bool</font>
	00072 <a class="code" href="classXalanDOMStringCache.html#a5">release</a>(<a class="code" href="classXalanDOMString.html">XalanDOMString</a>& theString);
	00073
	00074 <font class="comment">/*</font>
	00075 <font class="comment"> * Clear all of the strings in the cache. This</font>
	00076 <font class="comment"> * destroys all of the strings.</font>
	00077 <font class="comment"> *</font>
	00078 <font class="comment"> */</font>
	00079 <font class="keywordtype">void</font>
	00080 <a class="code" href="classXalanDOMStringCache.html#a6">clear</a>();
	00081
	00082 <font class="comment">/*</font>
	00083 <font class="comment"> * Reset the cache so that all strings that are</font>
	00084 <font class="comment"> * currently in use are available.</font>
	00085 <font class="comment"> */</font>
	00086 <font class="keywordtype">void</font>
	00087 <a class="code" href="classXalanDOMStringCache.html#a7">reset</a>();
	00088
	<a name="l00089"></a><a class="code" href="classXalanDOMStringCache_1_1GetAndRelease.html">00089</a> <font class="keyword">class </font>GetAndRelease
	00090 {
	00091 <font class="keyword">public</font>:
	00092
	<a name="l00093"></a><a class="code" href="classXalanDOMStringCache_1_1GetAndRelease.html#a0">00093</a> <a class="code" href="classXalanDOMStringCache_1_1GetAndRelease.html#a0">GetAndRelease</a>(<a class="code" href="classXalanDOMStringCache.html">XalanDOMStringCache</a>& theCache) :
	00094 m_cache(theCache),
	00095 m_string(&theCache.get())
	00096 {
	00097 }
	00098
	<a name="l00099"></a><a class="code" href="classXalanDOMStringCache_1_1GetAndRelease.html#a1">00099</a> <a class="code" href="classXalanDOMStringCache_1_1GetAndRelease.html#a1">~GetAndRelease</a>()<font class="keyword"></font>
	00100 <font class="keyword"> </font>{
	00101 m_cache.<a class="code" href="classXalanDOMStringCache.html#a5">release</a>(*m_string);
	00102 }
	00103
	00104 <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&
	<a name="l00105"></a><a class="code" href="classXalanDOMStringCache_1_1GetAndRelease.html#a2">00105</a> <a class="code" href="classXalanDOMStringCache_1_1GetAndRelease.html#a2">get</a>()<font class="keyword"> const</font>
	00106 <font class="keyword"> </font>{
	00107 <font class="keywordflow">return</font> *m_string;
	00108 }
	00109
	00110 <font class="keyword">private</font>:
	00111
	00112 <a class="code" href="classXalanDOMStringCache.html">XalanDOMStringCache</a>& m_cache;
	00113
	00114 <a class="code" href="classXalanDOMString.html">XalanDOMString</a>* <font class="keyword">const</font> m_string;
	00115 };
	00116
	00117 <font class="keyword">private</font>:
	00118
	00119 <font class="comment">// not implemented</font>
	00120 <a class="code" href="classXalanDOMStringCache.html#a0">XalanDOMStringCache</a>(<font class="keyword">const</font> <a class="code" href="classXalanDOMStringCache.html">XalanDOMStringCache</a>&);
	00121
	00122 <font class="keywordtype">bool</font>
	00123 <a class="code" href="ElemAttributeSet_8hpp.html#a1">operator==</a>(<font class="keyword">const</font> <a class="code" href="classXalanDOMStringCache.html">XalanDOMStringCache</a>&) <font class="keyword">const</font>;
	00124
	00125 <a class="code" href="classXalanDOMStringCache.html">XalanDOMStringCache</a>&
	00126 operator=(<font class="keyword">const</font> <a class="code" href="classXalanDOMStringCache.html">XalanDOMStringCache</a>&);
	00127
	00131 StringListType m_availableList;
	00132
	00136 StringListType m_busyList;
	00137
	00138 <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> m_maximumSize;
	00139
	00140 <a class="code" href="classXalanDOMStringReusableAllocator.html">XalanDOMStringReusableAllocator</a> m_allocator;
	00141 };
	00142
	00143
	00144
	00145 XALAN_CPP_NAMESPACE_END
	00146
	00147
	00148
	00149 <font class="preprocessor">#endif // XALAN_RESULTNAMESPACESSTACK_HEADER_GUARD</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 © 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>