blob: c361bac7055634eaa228466988402b6d54b18867 [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>ArenaBlock.hpp</h1> </div>
</div>
<div class="contents">
<a href="ArenaBlock_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
<a name="l00019"></a>00019 <span class="preprocessor">#if !defined(ARENABLOCK_INCLUDE_GUARD_1357924680)</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define ARENABLOCK_INCLUDE_GUARD_1357924680</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="preprocessor">#include &lt;<a class="code" href="ArenaBlockBase_8hpp.html">xalanc/PlatformSupport/ArenaBlockBase.hpp</a>&gt;</span>
<a name="l00025"></a>00025
<a name="l00026"></a>00026
<a name="l00027"></a>00027
<a name="l00028"></a>00028
<a name="l00029"></a>00029 XALAN_CPP_NAMESPACE_BEGIN
<a name="l00030"></a>00030
<a name="l00031"></a>00031
<a name="l00032"></a>00032 <span class="keyword">template</span>&lt;<span class="keyword">class </span>ObjectType,
<a name="l00033"></a>00033 <span class="preprocessor">#if defined(XALAN_NO_DEFAULT_TEMPLATE_ARGUMENTS)</span>
<a name="l00034"></a>00034 <span class="preprocessor"></span> <span class="keyword">class </span>SizeType&gt;
<a name="l00035"></a>00035 <span class="preprocessor">#else</span>
<a name="l00036"></a>00036 <span class="preprocessor"></span> <span class="keyword">class </span>SizeType = <span class="keywordtype">size_t</span>&gt;
<a name="l00037"></a>00037 <span class="preprocessor">#endif</span>
<a name="l00038"></a><a class="code" href="classArenaBlock.html">00038</a> <span class="preprocessor"></span><span class="keyword">class </span><a class="code" href="classArenaBlock.html">ArenaBlock</a> : <span class="keyword">public</span> <a class="code" href="classArenaBlockBase.html">ArenaBlockBase</a>&lt;ObjectType, SizeType&gt;
<a name="l00039"></a>00039 {
<a name="l00040"></a>00040 <span class="keyword">public</span>:
<a name="l00041"></a>00041
<a name="l00042"></a><a class="code" href="classArenaBlock.html#a53edbd6207b109d12f203513ec01da33">00042</a> <span class="keyword">typedef</span> <a class="code" href="classArenaBlockBase.html">ArenaBlockBase&lt;ObjectType, SizeType&gt;</a> <a class="code" href="classArenaBlockBase.html">BaseClassType</a>;
<a name="l00043"></a>00043
<a name="l00044"></a><a class="code" href="classArenaBlock.html#a77ca247921ea2a811795ddfcaab5c056">00044</a> <span class="keyword">typedef</span> <a class="code" href="classArenaBlock.html">ArenaBlock&lt;ObjectType, SizeType&gt;</a> <a class="code" href="classArenaBlock.html">ThisType</a>;
<a name="l00045"></a>00045
<a name="l00046"></a><a class="code" href="classArenaBlock.html#af4c742d624235e0637a33a1487cb0e79">00046</a> <span class="keyword">typedef</span> <span class="keyword">typename</span> <a class="code" href="classArenaBlockBase.html#ab169c115e200754ddb8aecf983b9180f">BaseClassType::size_type</a> size_type;
<a name="l00047"></a>00047
<a name="l00048"></a>00048 <span class="comment">/*</span>
<a name="l00049"></a>00049 <span class="comment"> * Construct an ArenaBlock of the specified size</span>
<a name="l00050"></a>00050 <span class="comment"> * of objects.</span>
<a name="l00051"></a>00051 <span class="comment"> *</span>
<a name="l00052"></a>00052 <span class="comment"> * @param theManager The memory manager instance for the block.</span>
<a name="l00053"></a>00053 <span class="comment"> * @param theBlockSize The size of the block (the number of objects it can contain).</span>
<a name="l00054"></a>00054 <span class="comment"> */</span>
<a name="l00055"></a><a class="code" href="classArenaBlock.html#aceb02bb694fd06abf181d97ff422553d">00055</a> <a class="code" href="classArenaBlock.html#aceb02bb694fd06abf181d97ff422553d">ArenaBlock</a>(
<a name="l00056"></a>00056 MemoryManager&amp; theManager,
<a name="l00057"></a>00057 <a class="code" href="classArenaBlock.html#af4c742d624235e0637a33a1487cb0e79">size_type</a> theBlockSize) :
<a name="l00058"></a>00058 <a class="code" href="classArenaBlockBase.html">BaseClassType</a>(theManager, theBlockSize)
<a name="l00059"></a>00059 {
<a name="l00060"></a>00060 }
<a name="l00061"></a>00061
<a name="l00062"></a><a class="code" href="classArenaBlock.html#a76f574f81ed37a69b70bd957ae30d355">00062</a> <a class="code" href="classArenaBlock.html#a76f574f81ed37a69b70bd957ae30d355">~ArenaBlock</a>()
<a name="l00063"></a>00063 {
<a name="l00064"></a>00064 assert( this-&gt;m_objectCount &lt;= this-&gt;<a class="code" href="classArenaBlockBase.html#aeb0c6d926123e7c2fa331c39c22292fa">m_blockSize</a> );
<a name="l00065"></a>00065
<a name="l00066"></a>00066 <span class="keywordflow">for</span> ( <a class="code" href="classArenaBlock.html#af4c742d624235e0637a33a1487cb0e79">size_type</a> i = 0; i &lt; this-&gt;<a class="code" href="classArenaBlockBase.html#a90a2645b46ee0030cfa8864870ac6613">m_objectCount</a> ; ++i )
<a name="l00067"></a>00067 {
<a name="l00068"></a>00068 <a class="code" href="XalanMemoryManagement_8hpp.html#abca431c9c1c0460a6b74d241a509147b">XalanDestroy</a>(this-&gt;<a class="code" href="classArenaBlockBase.html#a8ae6c2b10feec2cd16437bd1e8e41396">m_objectBlock</a>[i]);
<a name="l00069"></a>00069 }
<a name="l00070"></a>00070 }
<a name="l00071"></a>00071
<a name="l00072"></a>00072 <span class="keyword">static</span> <a class="code" href="classArenaBlock.html#a77ca247921ea2a811795ddfcaab5c056">ThisType</a>*
<a name="l00073"></a><a class="code" href="classArenaBlock.html#a4038dcf72f0b2273b8458f9ae028d961">00073</a> <a class="code" href="classArenaBlock.html#a4038dcf72f0b2273b8458f9ae028d961">create</a>(
<a name="l00074"></a>00074 MemoryManager&amp; theManager,
<a name="l00075"></a>00075 <a class="code" href="classArenaBlock.html#af4c742d624235e0637a33a1487cb0e79">size_type</a> theBlockSize)
<a name="l00076"></a>00076 {
<a name="l00077"></a>00077 <a class="code" href="classArenaBlock.html">ThisType</a>* theInstance;
<a name="l00078"></a>00078
<a name="l00079"></a>00079 <span class="keywordflow">return</span> <a class="code" href="XalanMemoryManagement_8hpp.html#a0227ffda90ae8912d4b468f63740d5a9">XalanConstruct</a>(
<a name="l00080"></a>00080 theManager,
<a name="l00081"></a>00081 theInstance,
<a name="l00082"></a>00082 theManager,
<a name="l00083"></a>00083 theBlockSize);
<a name="l00084"></a>00084 }
<a name="l00085"></a>00085
<a name="l00086"></a>00086 <span class="comment">/*</span>
<a name="l00087"></a>00087 <span class="comment"> * Allocate a block. Once the object is constructed, you must call</span>
<a name="l00088"></a>00088 <span class="comment"> * commitAllocation().</span>
<a name="l00089"></a>00089 <span class="comment"> *</span>
<a name="l00090"></a>00090 <span class="comment"> * @return a pointer to the new block.</span>
<a name="l00091"></a>00091 <span class="comment"> */</span>
<a name="l00092"></a>00092 ObjectType*
<a name="l00093"></a><a class="code" href="classArenaBlock.html#a4b7c4591043308721326d7127b44865c">00093</a> <a class="code" href="classArenaBlock.html#a4b7c4591043308721326d7127b44865c">allocateBlock</a>()
<a name="l00094"></a>00094 {
<a name="l00095"></a>00095 <span class="comment">// Any space left?</span>
<a name="l00096"></a>00096 <span class="keywordflow">if</span> (this-&gt;<a class="code" href="classArenaBlockBase.html#a90a2645b46ee0030cfa8864870ac6613">m_objectCount</a> == this-&gt;<a class="code" href="classArenaBlockBase.html#aeb0c6d926123e7c2fa331c39c22292fa">m_blockSize</a>)
<a name="l00097"></a>00097 {
<a name="l00098"></a>00098 <span class="keywordflow">return</span> 0;
<a name="l00099"></a>00099 }
<a name="l00100"></a>00100 <span class="keywordflow">else</span>
<a name="l00101"></a>00101 {
<a name="l00102"></a>00102 assert(this-&gt;<a class="code" href="classArenaBlockBase.html#a8ae6c2b10feec2cd16437bd1e8e41396">m_objectBlock</a> != 0);
<a name="l00103"></a>00103
<a name="l00104"></a>00104 <span class="keywordflow">return</span> this-&gt;<a class="code" href="classArenaBlockBase.html#a8ae6c2b10feec2cd16437bd1e8e41396">m_objectBlock</a> + this-&gt;<a class="code" href="classArenaBlockBase.html#a90a2645b46ee0030cfa8864870ac6613">m_objectCount</a>;
<a name="l00105"></a>00105 }
<a name="l00106"></a>00106 }
<a name="l00107"></a>00107
<a name="l00108"></a>00108 <span class="comment">/*</span>
<a name="l00109"></a>00109 <span class="comment"> * Commit the previous allocation.</span>
<a name="l00110"></a>00110 <span class="comment"> *</span>
<a name="l00111"></a>00111 <span class="comment"> * @param theBlock the address that was returned by allocateBlock()</span>
<a name="l00112"></a>00112 <span class="comment"> */</span>
<a name="l00113"></a>00113 <span class="keywordtype">void</span>
<a name="l00114"></a>00114 <span class="preprocessor">#if defined (NDEBUG)</span>
<a name="l00115"></a>00115 <span class="preprocessor"></span> <a class="code" href="classArenaBlock.html#adb50534df6a56feee95a63db22cbd7de">commitAllocation</a>(ObjectType* <span class="comment">/* theBlock */</span>)
<a name="l00116"></a>00116 <span class="preprocessor">#else</span>
<a name="l00117"></a><a class="code" href="classArenaBlock.html#adb50534df6a56feee95a63db22cbd7de">00117</a> <span class="preprocessor"></span> <a class="code" href="classArenaBlock.html#adb50534df6a56feee95a63db22cbd7de">commitAllocation</a>(ObjectType* theBlock)
<a name="l00118"></a>00118 <span class="preprocessor">#endif</span>
<a name="l00119"></a>00119 <span class="preprocessor"></span> {
<a name="l00120"></a>00120 assert(theBlock == this-&gt;<a class="code" href="classArenaBlockBase.html#a8ae6c2b10feec2cd16437bd1e8e41396">m_objectBlock</a> + this-&gt;<a class="code" href="classArenaBlockBase.html#a90a2645b46ee0030cfa8864870ac6613">m_objectCount</a>);
<a name="l00121"></a>00121 assert(this-&gt;m_objectCount &lt; this-&gt;<a class="code" href="classArenaBlockBase.html#aeb0c6d926123e7c2fa331c39c22292fa">m_blockSize</a>);
<a name="l00122"></a>00122
<a name="l00123"></a>00123 ++this-&gt;<a class="code" href="classArenaBlockBase.html#a90a2645b46ee0030cfa8864870ac6613">m_objectCount</a>;
<a name="l00124"></a>00124 }
<a name="l00125"></a>00125
<a name="l00126"></a>00126 <span class="comment">/*</span>
<a name="l00127"></a>00127 <span class="comment"> * Determine if this block owns the specified object. Note</span>
<a name="l00128"></a>00128 <span class="comment"> * that even if the object address is within our block, this</span>
<a name="l00129"></a>00129 <span class="comment"> * call will return false if no object currently occupies the</span>
<a name="l00130"></a>00130 <span class="comment"> * block. See also ownsBlock().</span>
<a name="l00131"></a>00131 <span class="comment"> *</span>
<a name="l00132"></a>00132 <span class="comment"> * @param theObject the address of the object.</span>
<a name="l00133"></a>00133 <span class="comment"> * @return true if we own the object, false if not.</span>
<a name="l00134"></a>00134 <span class="comment"> */</span>
<a name="l00135"></a>00135 <span class="keywordtype">bool</span>
<a name="l00136"></a><a class="code" href="classArenaBlock.html#a95c2ee3d9651ca87131d2c05651fdd38">00136</a> <a class="code" href="classArenaBlock.html#a95c2ee3d9651ca87131d2c05651fdd38">ownsObject</a>(<span class="keyword">const</span> ObjectType* theObject)<span class="keyword"> const</span>
<a name="l00137"></a>00137 <span class="keyword"> </span>{
<a name="l00138"></a>00138 <span class="keywordflow">return</span> this-&gt;<a class="code" href="classArenaBlockBase.html#a7805a8a8ca3f73391dbab7408dd08b7e">isInBorders</a>(theObject, this-&gt;<a class="code" href="classArenaBlockBase.html#a90a2645b46ee0030cfa8864870ac6613">m_objectCount</a>);
<a name="l00139"></a>00139 }
<a name="l00140"></a>00140
<a name="l00141"></a>00141 <span class="keyword">private</span>:
<a name="l00142"></a>00142
<a name="l00143"></a>00143 <span class="comment">// Not implemented...</span>
<a name="l00144"></a>00144 <a class="code" href="classArenaBlock.html#aceb02bb694fd06abf181d97ff422553d">ArenaBlock</a>(<span class="keyword">const</span> <a class="code" href="classArenaBlock.html">ArenaBlock&lt;ObjectType, SizeType&gt;</a>&amp;);
<a name="l00145"></a>00145
<a name="l00146"></a>00146 <a class="code" href="classArenaBlock.html">ArenaBlock&lt;ObjectType, SizeType&gt;</a>&amp;
<a name="l00147"></a>00147 operator=(<span class="keyword">const</span> <a class="code" href="classArenaBlock.html">ArenaBlock&lt;ObjectType, SizeType&gt;</a>&amp;);
<a name="l00148"></a>00148
<a name="l00149"></a>00149 <span class="keywordtype">bool</span>
<a name="l00150"></a>00150 operator==(<span class="keyword">const</span> <a class="code" href="classArenaBlock.html">ArenaBlock&lt;ObjectType, SizeType&gt;</a>&amp;) <span class="keyword">const</span>;
<a name="l00151"></a>00151 };
<a name="l00152"></a>00152
<a name="l00153"></a>00153
<a name="l00154"></a>00154
<a name="l00155"></a>00155 XALAN_CPP_NAMESPACE_END
<a name="l00156"></a>00156
<a name="l00157"></a>00157
<a name="l00158"></a>00158
<a name="l00159"></a>00159 <span class="preprocessor">#endif // !defined(ARENABLOCK_INCLUDE_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>