blob: 2122438717e2ac1f27c125e5bc8209fc52f24556 [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>XalanObjectStackCache.hpp</h1> </div>
</div>
<div class="contents">
<a href="XalanObjectStackCache_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_OBJECTSTACKCACHE_HEADER_GUARD)</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span><span class="preprocessor">#define XALAN_OBJECTSTACKCACHE_HEADER_GUARD</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="preprocessor">#include &lt;algorithm&gt;</span>
<a name="l00024"></a>00024
<a name="l00025"></a>00025
<a name="l00026"></a>00026
<a name="l00027"></a>00027 <span class="preprocessor">#include &lt;<a class="code" href="XalanVector_8hpp.html">xalanc/Include/XalanVector.hpp</a>&gt;</span>
<a name="l00028"></a>00028 <span class="preprocessor">#include &lt;<a class="code" href="STLHelper_8hpp.html">xalanc/Include/STLHelper.hpp</a>&gt;</span>
<a name="l00029"></a>00029 <span class="preprocessor">#include &lt;<a class="code" href="XalanAutoPtr_8hpp.html">xalanc/Include/XalanAutoPtr.hpp</a>&gt;</span>
<a name="l00030"></a>00030 <span class="preprocessor">#include &lt;<a class="code" href="XalanObjectCache_8hpp.html">xalanc/Include/XalanObjectCache.hpp</a>&gt;</span>
<a name="l00031"></a>00031
<a name="l00032"></a>00032
<a name="l00033"></a>00033
<a name="l00034"></a>00034 XALAN_CPP_NAMESPACE_BEGIN
<a name="l00035"></a>00035
<a name="l00036"></a>00036
<a name="l00037"></a>00037 <span class="keyword">template</span>&lt;
<a name="l00038"></a>00038 <span class="keyword">class </span>ObjectType,
<a name="l00039"></a>00039 <span class="preprocessor">#if defined(XALAN_NO_DEFAULT_TEMPLATE_ARGUMENTS)</span>
<a name="l00040"></a>00040 <span class="preprocessor"></span><span class="keyword">class </span>CreateFunctorType,
<a name="l00041"></a>00041 <span class="keyword">class </span>DeleteFunctorType,
<a name="l00042"></a>00042 <span class="keyword">class </span>ResetFunctorType&gt;
<a name="l00043"></a>00043 <span class="preprocessor">#else</span>
<a name="l00044"></a>00044 <span class="preprocessor"></span><span class="keyword">class </span>CreateFunctorType = <a class="code" href="classDefaultCacheCreateFunctor.html">DefaultCacheCreateFunctor&lt;ObjectType&gt;</a>,
<a name="l00045"></a>00045 <span class="keyword">class </span>DeleteFunctorType = <a class="code" href="structDeleteFunctor.html">DeleteFunctor&lt;ObjectType&gt;</a>,
<a name="l00046"></a>00046 <span class="keyword">class </span>ResetFunctorType = <a class="code" href="classDefaultCacheResetFunctor.html">DefaultCacheResetFunctor&lt;ObjectType&gt;</a> &gt;
<a name="l00047"></a>00047 <span class="preprocessor">#endif</span>
<a name="l00048"></a><a class="code" href="classXalanObjectStackCache.html">00048</a> <span class="preprocessor"></span><span class="keyword">class </span><a class="code" href="classXalanObjectStackCache.html">XalanObjectStackCache</a>
<a name="l00049"></a>00049 {
<a name="l00050"></a>00050 <span class="keyword">public</span>:
<a name="l00051"></a>00051
<a name="l00052"></a><a class="code" href="classXalanObjectStackCache.html#aea89e987ecf2698fbc644f1b325f2386">00052</a> <span class="keyword">typedef</span> <a class="code" href="classXalanVector.html">XalanVector&lt;ObjectType*&gt;</a> <a class="code" href="classXalanVector.html">VectorType</a>;
<a name="l00053"></a>00053
<a name="l00054"></a><a class="code" href="classXalanObjectStackCache.html#aeda3b02b11019f62c4b94c7e8efc91be">00054</a> <span class="keyword">typedef</span> ObjectType <a class="code" href="classXalanDOMString.html">CacheObjectType</a>;
<a name="l00055"></a>00055
<a name="l00056"></a>00056 <span class="keyword">explicit</span>
<a name="l00057"></a><a class="code" href="classXalanObjectStackCache.html#a682dc730f6a94fd771443b0b221ad7ab">00057</a> <a class="code" href="classXalanObjectStackCache.html#a682dc730f6a94fd771443b0b221ad7ab">XalanObjectStackCache</a>(
<a name="l00058"></a>00058 MemoryManager&amp; theManager,
<a name="l00059"></a>00059 XalanSize_t initialListSize = 0) :
<a name="l00060"></a>00060 <a class="code" href="classXalanObjectStackCache.html#a6fc32be180ede658d2f98cd591c1c184">m_createFunctor</a>(),
<a name="l00061"></a>00061 <a class="code" href="classXalanObjectStackCache.html#a65deaa0f7c54cbc8d6673d59287e9870">m_deleteFunctor</a>(theManager),
<a name="l00062"></a>00062 m_stack(theManager),
<a name="l00063"></a>00063 m_numObjectsOnStack(0)
<a name="l00064"></a>00064 {
<a name="l00065"></a>00065 m_stack.<a class="code" href="classXalanVector.html#a57a1a931ca7fa6d7755563d2321aa3c2">reserve</a>(initialListSize);
<a name="l00066"></a>00066 }
<a name="l00067"></a>00067
<a name="l00068"></a><a class="code" href="classXalanObjectStackCache.html#ae4eaca5c572fb1509b5784957acd0f66">00068</a> <a class="code" href="classXalanObjectStackCache.html#ae4eaca5c572fb1509b5784957acd0f66">~XalanObjectStackCache</a>()
<a name="l00069"></a>00069 {
<a name="l00070"></a>00070 <span class="preprocessor">#if !defined(XALAN_NO_STD_NAMESPACE)</span>
<a name="l00071"></a>00071 <span class="preprocessor"></span> <span class="keyword">using</span> std::for_each;
<a name="l00072"></a>00072 <span class="preprocessor">#endif</span>
<a name="l00073"></a>00073 <span class="preprocessor"></span> for_each(
<a name="l00074"></a>00074 m_stack.<a class="code" href="classXalanVector.html#acc3e16c7dbabe0e5990a1f24cf8fd996">begin</a>(),
<a name="l00075"></a>00075 m_stack.<a class="code" href="classXalanVector.html#a7e6c23b5cf7143a14f5ca335550c92c5">end</a>(),
<a name="l00076"></a>00076 <a class="code" href="classXalanObjectStackCache.html#a65deaa0f7c54cbc8d6673d59287e9870">m_deleteFunctor</a>);
<a name="l00077"></a>00077 }
<a name="l00078"></a>00078
<a name="l00079"></a>00079 ObjectType*
<a name="l00080"></a><a class="code" href="classXalanObjectStackCache.html#ac5d21ab88d73a2fdc477499b286f527d">00080</a> <span class="keyword">get</span>()
<a name="l00081"></a>00081 {
<a name="l00082"></a>00082
<a name="l00083"></a>00083 <span class="keywordflow">if</span> (m_stack.<a class="code" href="classXalanVector.html#a1fda39730a6d85ecfcd1f35b302ab7c0">size</a>() == m_numObjectsOnStack)
<a name="l00084"></a>00084 {
<a name="l00085"></a>00085 ObjectType* <span class="keyword">const</span> theNewObject = <a class="code" href="classXalanObjectStackCache.html#a6fc32be180ede658d2f98cd591c1c184">m_createFunctor</a>(m_stack.<a class="code" href="classXalanVector.html#a0c113909fec890afc028fb7790cf3345">getMemoryManager</a>());
<a name="l00086"></a>00086 m_stack.<a class="code" href="classXalanVector.html#ac0ad2b04516dcca6ce35b3425368307b">push_back</a>(theNewObject);
<a name="l00087"></a>00087 ++m_numObjectsOnStack;
<a name="l00088"></a>00088 <span class="keywordflow">return</span> theNewObject;
<a name="l00089"></a>00089 }
<a name="l00090"></a>00090 <span class="keywordflow">else</span>
<a name="l00091"></a>00091 {
<a name="l00092"></a>00092 <span class="keywordflow">return</span> m_stack[m_numObjectsOnStack++];
<a name="l00093"></a>00093 }
<a name="l00094"></a>00094 }
<a name="l00095"></a>00095
<a name="l00096"></a>00096 ObjectType*
<a name="l00097"></a><a class="code" href="classXalanObjectStackCache.html#afdcfbe80753eeb7488c2aea9cf32e5c9">00097</a> <a class="code" href="classXalanObjectStackCache.html#afdcfbe80753eeb7488c2aea9cf32e5c9">top</a>()
<a name="l00098"></a>00098 {
<a name="l00099"></a>00099 assert (m_numObjectsOnStack &gt; 0);
<a name="l00100"></a>00100
<a name="l00101"></a>00101 <span class="keywordflow">return</span> m_stack[m_numObjectsOnStack-1];
<a name="l00102"></a>00102 }
<a name="l00103"></a>00103
<a name="l00104"></a>00104 ObjectType*
<a name="l00105"></a><a class="code" href="classXalanObjectStackCache.html#a1a16905d7151faf3c00664151f75c640">00105</a> <a class="code" href="classXalanObjectStackCache.html#a1a16905d7151faf3c00664151f75c640">release</a>()
<a name="l00106"></a>00106 {
<a name="l00107"></a>00107 assert(m_numObjectsOnStack &gt; 0);
<a name="l00108"></a>00108
<a name="l00109"></a>00109 <span class="keywordflow">return</span> m_stack[--m_numObjectsOnStack];
<a name="l00110"></a>00110 }
<a name="l00111"></a>00111
<a name="l00112"></a>00112 <span class="keywordtype">void</span>
<a name="l00113"></a><a class="code" href="classXalanObjectStackCache.html#a7be6f0b0be32e59b561f3d90771084b9">00113</a> <a class="code" href="classXalanObjectStackCache.html#a7be6f0b0be32e59b561f3d90771084b9">reset</a>()
<a name="l00114"></a>00114 {
<a name="l00115"></a>00115 <span class="keyword">typename</span> <a class="code" href="classXalanVector.html#a70c358c6cf1e45ba03751d3b6f47392e">VectorType::iterator</a> iterator;
<a name="l00116"></a>00116
<a name="l00117"></a>00117 <span class="keywordflow">for</span> (iterator = m_stack.<a class="code" href="classXalanVector.html#acc3e16c7dbabe0e5990a1f24cf8fd996">begin</a>(); iterator &lt; m_stack.<a class="code" href="classXalanVector.html#a7e6c23b5cf7143a14f5ca335550c92c5">end</a>(); iterator++)
<a name="l00118"></a>00118 {
<a name="l00119"></a>00119 <a class="code" href="classXalanObjectStackCache.html#aa1767b6e5b5088b4863b4731e081290f">m_resetFunctor</a>(*iterator);
<a name="l00120"></a>00120 }
<a name="l00121"></a>00121 }
<a name="l00122"></a>00122
<a name="l00123"></a>00123 <span class="comment">// Functors for various operations...</span>
<a name="l00124"></a><a class="code" href="classXalanObjectStackCache.html#a6fc32be180ede658d2f98cd591c1c184">00124</a> CreateFunctorType <a class="code" href="classXalanObjectStackCache.html#a6fc32be180ede658d2f98cd591c1c184">m_createFunctor</a>;
<a name="l00125"></a>00125
<a name="l00126"></a><a class="code" href="classXalanObjectStackCache.html#a65deaa0f7c54cbc8d6673d59287e9870">00126</a> DeleteFunctorType <a class="code" href="classXalanObjectStackCache.html#a65deaa0f7c54cbc8d6673d59287e9870">m_deleteFunctor</a>;
<a name="l00127"></a>00127
<a name="l00128"></a><a class="code" href="classXalanObjectStackCache.html#aa1767b6e5b5088b4863b4731e081290f">00128</a> ResetFunctorType <a class="code" href="classXalanObjectStackCache.html#aa1767b6e5b5088b4863b4731e081290f">m_resetFunctor</a>;
<a name="l00129"></a>00129
<a name="l00130"></a>00130 <span class="keyword">private</span>:
<a name="l00131"></a>00131
<a name="l00132"></a>00132 <span class="comment">// There are not defined...</span>
<a name="l00133"></a>00133 <a class="code" href="classXalanObjectStackCache.html#a682dc730f6a94fd771443b0b221ad7ab">XalanObjectStackCache</a>(<span class="keyword">const</span> <a class="code" href="classXalanObjectCache.html">XalanObjectCache&lt;ObjectType, CreateFunctorType, DeleteFunctorType, ResetFunctorType&gt;</a>&amp; theRHS);
<a name="l00134"></a>00134
<a name="l00135"></a>00135 <a class="code" href="classXalanObjectStackCache.html">XalanObjectStackCache&lt;ObjectType, CreateFunctorType, DeleteFunctorType, ResetFunctorType&gt;</a>&amp;
<a name="l00136"></a>00136 operator=(<span class="keyword">const</span> <a class="code" href="classXalanObjectCache.html">XalanObjectCache&lt;ObjectType, CreateFunctorType, DeleteFunctorType, ResetFunctorType&gt;</a>&amp; theRHS);
<a name="l00137"></a>00137
<a name="l00138"></a>00138
<a name="l00139"></a>00139 <span class="comment">// Data members...</span>
<a name="l00140"></a>00140 <a class="code" href="classXalanVector.html">VectorType</a> m_stack;
<a name="l00141"></a>00141
<a name="l00142"></a>00142 <span class="keyword">typename</span> <a class="code" href="classXalanVector.html#ad6fb8b1165e71ac328cf6408c529548f">VectorType::size_type</a> m_numObjectsOnStack;
<a name="l00143"></a>00143
<a name="l00144"></a>00144 };
<a name="l00145"></a>00145
<a name="l00146"></a>00146
<a name="l00147"></a>00147
<a name="l00148"></a>00148
<a name="l00149"></a>00149 <span class="keyword">template</span>&lt;<span class="keyword">class</span> ObjectType&gt;
<a name="l00150"></a><a class="code" href="classXalanObjectStackCacheDefault.html">00150</a> <span class="keyword">class </span><a class="code" href="classXalanObjectStackCacheDefault.html">XalanObjectStackCacheDefault</a> : <span class="keyword">public</span> <a class="code" href="classXalanObjectStackCache.html">XalanObjectStackCache</a>&lt;ObjectType, DefaultCacheCreateFunctor&lt;ObjectType&gt;, DeleteFunctor&lt;ObjectType&gt;, DefaultCacheResetFunctor&lt;ObjectType&gt; &gt;
<a name="l00151"></a>00151 {
<a name="l00152"></a>00152 <span class="keyword">public</span>:
<a name="l00153"></a>00153
<a name="l00154"></a><a class="code" href="classXalanObjectStackCacheDefault.html#a013fce8606368e6d4242c934eaaae9f6">00154</a> <span class="keyword">typedef</span> <a class="code" href="classXalanObjectStackCache.html">XalanObjectStackCache&lt;ObjectType, DefaultCacheCreateFunctor&lt;ObjectType&gt;</a>, <a class="code" href="structDeleteFunctor.html">DeleteFunctor&lt;ObjectType&gt;</a>, <a class="code" href="classDefaultCacheResetFunctor.html">DefaultCacheResetFunctor&lt;ObjectType&gt;</a> &gt; <a class="code" href="classXalanObjectStackCache.html">BaseClassType</a>;
<a name="l00155"></a>00155
<a name="l00156"></a>00156 <span class="keyword">explicit</span>
<a name="l00157"></a><a class="code" href="classXalanObjectStackCacheDefault.html#aad4d5998d36fdf3d947886214ed5f05a">00157</a> <a class="code" href="classXalanObjectStackCacheDefault.html#aad4d5998d36fdf3d947886214ed5f05a">XalanObjectStackCacheDefault</a>(XalanSize_t initialListSize = 0) :
<a name="l00158"></a>00158 <a class="code" href="classXalanObjectStackCache.html">BaseClassType</a>(initialListSize)
<a name="l00159"></a>00159 {
<a name="l00160"></a>00160 }
<a name="l00161"></a>00161 };
<a name="l00162"></a>00162
<a name="l00163"></a>00163
<a name="l00164"></a>00164
<a name="l00165"></a>00165 XALAN_CPP_NAMESPACE_END
<a name="l00166"></a>00166
<a name="l00167"></a>00167
<a name="l00168"></a>00168
<a name="l00169"></a>00169 <span class="preprocessor">#endif</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>