blob: 7d6b82b20e3b566b966314cf5ad5b1c60903c651 [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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>XPathAllocator Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="XPathAllocator" -->
<p><code>#include &lt;<a class="el" href="XPathAllocator_8hpp_source.html">XPathAllocator.hpp</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for XPathAllocator:</div>
<div class="dyncontent">
<div class="center"><img src="classXPathAllocator__coll__graph.png" border="0" usemap="#XPathAllocator_coll__map" alt="Collaboration graph"/></div>
<map name="XPathAllocator_coll__map" id="XPathAllocator_coll__map">
<area shape="rect" id="node2" href="classArenaAllocator.html" title="ArenaAllocator\&lt; object_type \&gt;" alt="" coords="2369,287,2588,316"/><area shape="rect" id="node4" href="classArenaBlock.html" title="ArenaBlock\&lt; object_type \&gt;" alt="" coords="1989,259,2187,288"/><area shape="rect" id="node6" href="classArenaBlockBase.html" title="ArenaBlockBase\&lt; object_type, size_t \&gt;" alt="" coords="1496,240,1771,269"/><area shape="rect" id="node8" href="classXPath.html" title="XPath" alt="" coords="1215,213,1276,243"/><area shape="rect" id="node10" href="classXPathFunctionTable.html" title="Class defines a table of functions that can be called in XPath expresions." alt="" coords="849,83,996,112"/><area shape="rect" id="node12" href="classFunction.html" title="Function" alt="" coords="453,17,528,47"/><area shape="rect" id="node14" href="structXPathFunctionTable_1_1FunctionNameTableEntry.html" title="XPathFunctionTable::FunctionNameTableEntry" alt="" coords="333,83,648,112"/><area shape="rect" id="node16" href="classXPathExpression.html" title="XPathExpression" alt="" coords="857,213,988,243"/><area shape="rect" id="node18" href="classXalanVector.html" title="XalanVector\&lt; XToken \&gt;" alt="" coords="403,136,579,165"/><area shape="rect" id="node20" href="classXalanVector.html" title="XalanVector\&lt; int \&gt;" alt="" coords="417,189,564,219"/><area shape="rect" id="node22" href="classXalanVector.html" title="XalanVector\&lt; double \&gt;" alt="" coords="404,243,577,272"/><area shape="rect" id="node24" href="classXalanDOMString.html" title="XalanDOMString" alt="" coords="427,312,555,341"/><area shape="rect" id="node26" href="classXalanVector.html" title="XalanVector\&lt; XalanDOMChar \&gt;" alt="" coords="7,312,233,341"/><area shape="rect" id="node29" href="classXalanAllocator.html" title="XalanAllocator\&lt; object_type \&gt;" alt="" coords="1136,267,1355,296"/><area shape="rect" id="node31" href="classXalanList.html" title="XalanList\&lt; ArenaBlock\&lt; object_type \&gt; * \&gt;" alt="" coords="1939,316,2237,345"/><area shape="rect" id="node33" href="structXalanList_1_1Node.html" title="XalanList\&lt; Type \&gt;::Node" alt="" coords="1543,352,1724,381"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classXPathAllocator-members.html">List of all members.</a></p>
<h2><a name="pub-types"></a>
Public Types</h2>
<ul>
<li>typedef <a class="el" href="classXPath.html">XPath</a> <a class="el" href="classXPathAllocator.html#a6b62fd85505b0b0ff33edac3b5ef35f2">object_type</a>
<li>typedef <a class="el" href="classArenaAllocator.html">ArenaAllocator</a><br class="typebreak"/>
&lt; <a class="el" href="classXPath.html">object_type</a> &gt; <a class="el" href="classXPathAllocator.html#a74b6cd9df2c2c2da30dd203af5d325ae">ArenaAllocatorType</a>
<li>typedef <br class="typebreak"/>
<a class="el" href="classArenaAllocator.html#a68eaf7d03e3a4a9f35c035481f0acd67">ArenaAllocatorType::size_type</a> <a class="el" href="classXPathAllocator.html#a81592a28dd1c65065b81543b71fcad36">size_type</a>
</ul>
<h2><a name="pub-methods"></a>
Public Member Functions</h2>
<ul>
<li><a class="el" href="classXPathAllocator.html#abd69f581a59e97562b45f71dc0f02d66">XPathAllocator</a> (MemoryManager &amp;theManager, <a class="el" href="classXPathAllocator.html#a81592a28dd1c65065b81543b71fcad36">size_type</a> theBlockCount)
<dl class="el"><dd class="mdescRight">Construct an instance that will allocate blocks of the specified size. <a href="#abd69f581a59e97562b45f71dc0f02d66"></a><br/></dl><li><a class="el" href="classXPathAllocator.html#a6dd561c60053085a26ba8485b86407fc">~XPathAllocator</a> ()
<li><a class="el" href="classXPath.html">object_type</a> * <a class="el" href="classXPathAllocator.html#ad0e804f0f0b435c9b3b1fe346a0d458b">create</a> ()
<dl class="el"><dd class="mdescRight">Create an <a class="el" href="classXPath.html">XPath</a> object using the allocator. <a href="#ad0e804f0f0b435c9b3b1fe346a0d458b"></a><br/></dl><li>bool <a class="el" href="classXPathAllocator.html#a19216edd941a8b9e97858a4a20235f66">ownsObject</a> (const <a class="el" href="classXPath.html">object_type</a> *theObject)
<dl class="el"><dd class="mdescRight">Determine if an object is owned by the allocator... <a href="#a19216edd941a8b9e97858a4a20235f66"></a><br/></dl><li>void <a class="el" href="classXPathAllocator.html#a63df2b0667531d6435d7c498a078e782">reset</a> ()
<dl class="el"><dd class="mdescRight">Delete all <a class="el" href="classXPath.html">XPath</a> objects allocated. <a href="#a63df2b0667531d6435d7c498a078e782"></a><br/></dl><li><a class="el" href="classXPathAllocator.html#a81592a28dd1c65065b81543b71fcad36">size_type</a> <a class="el" href="classXPathAllocator.html#a3b86606d3f20d5faaee3f98706218b6f">getBlockCount</a> () const
<dl class="el"><dd class="mdescRight">Get the number of objects in each block. <a href="#a3b86606d3f20d5faaee3f98706218b6f"></a><br/></dl><li><a class="el" href="classXPathAllocator.html#a81592a28dd1c65065b81543b71fcad36">size_type</a> <a class="el" href="classXPathAllocator.html#a2318b3588beea514ac1ab5d558b45f49">getBlockSize</a> () const
<dl class="el"><dd class="mdescRight">Get the number of blocks currently allocated. <a href="#a2318b3588beea514ac1ab5d558b45f49"></a><br/></dl></ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Definition at line <a class="el" href="XPathAllocator_8hpp_source.html#l00041">41</a> of file <a class="el" href="XPathAllocator_8hpp_source.html">XPathAllocator.hpp</a>.</p>
<hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="a74b6cd9df2c2c2da30dd203af5d325ae"></a><!-- doxytag: member="XPathAllocator::ArenaAllocatorType" ref="a74b6cd9df2c2c2da30dd203af5d325ae" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classArenaAllocator.html">ArenaAllocator</a>&lt;<a class="el" href="classXPath.html">object_type</a>&gt; <a class="el" href="classArenaAllocator.html">XPathAllocator::ArenaAllocatorType</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="XPathAllocator_8hpp_source.html#l00053">53</a> of file <a class="el" href="XPathAllocator_8hpp_source.html">XPathAllocator.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a6b62fd85505b0b0ff33edac3b5ef35f2"></a><!-- doxytag: member="XPathAllocator::object_type" ref="a6b62fd85505b0b0ff33edac3b5ef35f2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classXPath.html">XPath</a> <a class="el" href="classXPath.html">XPathAllocator::object_type</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="XPathAllocator_8hpp_source.html#l00045">45</a> of file <a class="el" href="XPathAllocator_8hpp_source.html">XPathAllocator.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a81592a28dd1c65065b81543b71fcad36"></a><!-- doxytag: member="XPathAllocator::size_type" ref="a81592a28dd1c65065b81543b71fcad36" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classArenaAllocator.html#a68eaf7d03e3a4a9f35c035481f0acd67">ArenaAllocatorType::size_type</a> <a class="el" href="classXPathAllocator.html#a81592a28dd1c65065b81543b71fcad36">XPathAllocator::size_type</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="XPathAllocator_8hpp_source.html#l00056">56</a> of file <a class="el" href="XPathAllocator_8hpp_source.html">XPathAllocator.hpp</a>.</p>
</div>
</div>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="abd69f581a59e97562b45f71dc0f02d66"></a><!-- doxytag: member="XPathAllocator::XPathAllocator" ref="abd69f581a59e97562b45f71dc0f02d66" args="(MemoryManager &amp;theManager, size_type theBlockCount)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XPathAllocator::XPathAllocator </td>
<td>(</td>
<td class="paramtype">MemoryManager &amp;&nbsp;</td>
<td class="paramname"> <em>theManager</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classXPathAllocator.html#a81592a28dd1c65065b81543b71fcad36">size_type</a>&nbsp;</td>
<td class="paramname"> <em>theBlockCount</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct an instance that will allocate blocks of the specified size. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>theBlockSize</em>&nbsp;</td><td>The block size. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a6dd561c60053085a26ba8485b86407fc"></a><!-- doxytag: member="XPathAllocator::~XPathAllocator" ref="a6dd561c60053085a26ba8485b86407fc" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XPathAllocator::~XPathAllocator </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ad0e804f0f0b435c9b3b1fe346a0d458b"></a><!-- doxytag: member="XPathAllocator::create" ref="ad0e804f0f0b435c9b3b1fe346a0d458b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXPath.html">object_type</a>* XPathAllocator::create </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create an <a class="el" href="classXPath.html">XPath</a> object using the allocator. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to an <a class="el" href="classXPath.html">XPath</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a3b86606d3f20d5faaee3f98706218b6f"></a><!-- doxytag: member="XPathAllocator::getBlockCount" ref="a3b86606d3f20d5faaee3f98706218b6f" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXPathAllocator.html#a81592a28dd1c65065b81543b71fcad36">size_type</a> XPathAllocator::getBlockCount </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the number of objects in each block. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The size of the block </dd></dl>
<p>Definition at line <a class="el" href="XPathAllocator_8hpp_source.html#l00096">96</a> of file <a class="el" href="XPathAllocator_8hpp_source.html">XPathAllocator.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a2318b3588beea514ac1ab5d558b45f49"></a><!-- doxytag: member="XPathAllocator::getBlockSize" ref="a2318b3588beea514ac1ab5d558b45f49" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXPathAllocator.html#a81592a28dd1c65065b81543b71fcad36">size_type</a> XPathAllocator::getBlockSize </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the number of blocks currently allocated. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of blocks. </dd></dl>
<p>Definition at line <a class="el" href="XPathAllocator_8hpp_source.html#l00107">107</a> of file <a class="el" href="XPathAllocator_8hpp_source.html">XPathAllocator.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a19216edd941a8b9e97858a4a20235f66"></a><!-- doxytag: member="XPathAllocator::ownsObject" ref="a19216edd941a8b9e97858a4a20235f66" args="(const object_type *theObject)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool XPathAllocator::ownsObject </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXPath.html">object_type</a> *&nbsp;</td>
<td class="paramname"> <em>theObject</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Determine if an object is owned by the allocator... </p>
<p>Definition at line <a class="el" href="XPathAllocator_8hpp_source.html#l00079">79</a> of file <a class="el" href="XPathAllocator_8hpp_source.html">XPathAllocator.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a63df2b0667531d6435d7c498a078e782"></a><!-- doxytag: member="XPathAllocator::reset" ref="a63df2b0667531d6435d7c498a078e782" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XPathAllocator::reset </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Delete all <a class="el" href="classXPath.html">XPath</a> objects allocated. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XPathAllocator_8hpp_source.html">XPathAllocator.hpp</a></li>
</ul>
</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>