Google Git
Sign in
apache / xalan-site / 1b0c6dd5447f3bc951dcdd0e155aae8fc8efd4de / . / xalan-c / apiDocs / classXStringReferenceAllocator.html
blob: a42ec6d417fd5d45a4775d5d9bbb292c2811512e [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>XStringReferenceAllocator Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="XStringReferenceAllocator" -->
<p><code>#include &lt;<a class="el" href="XStringReferenceAllocator_8hpp_source.html">XStringReferenceAllocator.hpp</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for XStringReferenceAllocator:</div>
<div class="dyncontent">
<div class="center"><img src="classXStringReferenceAllocator__coll__graph.png" border="0" usemap="#XStringReferenceAllocator_coll__map" alt="Collaboration graph"/></div>
<map name="XStringReferenceAllocator_coll__map" id="XStringReferenceAllocator_coll__map">
<area shape="rect" id="node2" href="classReusableArenaAllocator.html" title="ReusableArenaAllocator\&lt; string_type \&gt;" alt="" coords="3928,428,4203,457"/><area shape="rect" id="node4" href="classArenaAllocator.html" title="ArenaAllocator\&lt; string_type, ReusableArenaBlock\&lt; string_type \&gt; \&gt;" alt="" coords="3421,428,3877,457"/><area shape="rect" id="node6" href="classReusableArenaBlock.html" title="ReusableArenaBlock\&lt; string_type \&gt;" alt="" coords="2987,400,3240,429"/><area shape="rect" id="node8" href="classArenaBlockBase.html" title="ArenaBlockBase\&lt; string_type, unsigned short \&gt;" alt="" coords="2437,381,2768,411"/><area shape="rect" id="node10" href="classXStringAdapter.html" title="XStringAdapter" alt="" coords="2128,355,2248,384"/><area shape="rect" id="node12" href="classXStringBase.html" title="XStringBase" alt="" coords="1927,329,2028,359"/><area shape="rect" id="node14" href="classXObject.html" title="Class to hold XPath return types." alt="" coords="860,381,932,411"/><area shape="rect" id="node33" href="classXObjectResultTreeFragProxyText.html" title="XObjectResultTreeFragProxyText" alt="" coords="1196,172,1423,201"/><area shape="rect" id="node49" href="classXObjectPtr.html" title="Class to hold XObjectPtr return types." alt="" coords="1448,381,1539,411"/><area shape="rect" id="node16" href="classXalanReferenceCountedObject.html" title="Class to hold reference count information." alt="" coords="333,415,552,444"/><area shape="rect" id="node18" href="classXObjectFactory.html" title="This class handles the creation of XObjects and manages their lifetime." alt="" coords="384,468,501,497"/><area shape="rect" id="node42" href="classXPathExecutionContext.html" title="XPathExecutionContext" alt="" coords="809,328,983,357"/><area shape="rect" id="node20" href="classXalanDOMString.html" title="XalanDOMString" alt="" coords="379,135,507,164"/><area shape="rect" id="node26" href="classXObjectResultTreeFragProxyBase.html" title="XObjectResultTreeFragProxyBase" alt="" coords="779,25,1013,55"/><area shape="rect" id="node22" href="classXalanVector.html" title="XalanVector\&lt; XalanDOMChar \&gt;" alt="" coords="7,135,233,164"/><area shape="rect" id="node24" href="classXObjectResultTreeFragProxy.html" title="XObjectResultTreeFragProxy" alt="" coords="1563,172,1765,201"/><area shape="rect" id="node28" href="classXalanDocumentFragment.html" title="XalanDocumentFragment" alt="" coords="349,5,536,35"/><area shape="rect" id="node30" href="classXalanNode.html" title="XalanNode" alt="" coords="73,37,167,67"/><area shape="rect" id="node37" href="classXalanCharacterData.html" title="XalanCharacterData" alt="" coords="367,59,519,88"/><area shape="rect" id="node35" href="classXalanText.html" title="XalanText" alt="" coords="853,79,939,108"/><area shape="rect" id="node44" href="classExecutionContext.html" title="ExecutionContext" alt="" coords="376,337,509,367"/><area shape="rect" id="node46" href="classProblemListenerBase.html" title="This is the abstract class that is used when reporting a problem some kind, that requires a message..." alt="" coords="41,337,199,367"/><area shape="rect" id="node52" href="classXalanAllocator.html" title="XalanAllocator\&lt; string_type \&gt;" alt="" coords="2080,408,2296,437"/><area shape="rect" id="node54" href="classXalanList.html" title="XalanList\&lt; ReusableArenaBlock\&lt; string_type \&gt; * \&gt;" alt="" coords="2937,457,3289,487"/><area shape="rect" id="node56" href="structXalanList_1_1Node.html" title="XalanList\&lt; Type \&gt;::Node" alt="" coords="2512,493,2693,523"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classXStringReferenceAllocator-members.html">List of all members.</a></p>
<h2><a name="pub-types"></a>
Public Types</h2>
<ul>
<li>typedef <a class="el" href="classXStringReference.html">XStringReference</a> <a class="el" href="classXStringReferenceAllocator.html#a28b14443d0f693936c950fb99c0f85da">string_type</a>
<li>typedef <a class="el" href="classReusableArenaAllocator.html">ReusableArenaAllocator</a><br class="typebreak"/>
&lt; <a class="el" href="classXStringReference.html">string_type</a> &gt; <a class="el" href="classXStringReferenceAllocator.html#a8ce1abea87251766184f04da90f30725">ArenaAllocatorType</a>
<li>typedef <br class="typebreak"/>
<a class="el" href="classReusableArenaAllocator.html#acf80af42a3e56e0f51dfc8b490944b8b">ArenaAllocatorType::size_type</a> <a class="el" href="classXStringReferenceAllocator.html#ad09771779f05c177bad1457d9e4b61e8">size_type</a>
</ul>
<h2><a name="pub-methods"></a>
Public Member Functions</h2>
<ul>
<li><a class="el" href="classXStringReferenceAllocator.html#a278129a22ae3c5173e14767fec980825">XStringReferenceAllocator</a> (MemoryManager &amp;theManager, <a class="el" href="classXStringReferenceAllocator.html#ad09771779f05c177bad1457d9e4b61e8">size_type</a> theBlockCount)
<dl class="el"><dd class="mdescRight">Construct an instance that will allocate blocks of the specified size. <a href="#a278129a22ae3c5173e14767fec980825"></a><br/></dl><li><a class="el" href="classXStringReferenceAllocator.html#a4f9ff9b3c9eda93a04c48a598c0fe8d2">~XStringReferenceAllocator</a> ()
<li><a class="el" href="classXStringReference.html">string_type</a> * <a class="el" href="classXStringReferenceAllocator.html#a9ac52afdb69697a35ffe64a2b1e9b502">createString</a> (const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;theString)
<dl class="el"><dd class="mdescRight">Create an <a class="el" href="classXStringReference.html">XStringReference</a> object from a string. <a href="#a9ac52afdb69697a35ffe64a2b1e9b502"></a><br/></dl><li>bool <a class="el" href="classXStringReferenceAllocator.html#abf5e720bece6a84c864b06dd8062e632">destroy</a> (<a class="el" href="classXStringReference.html">string_type</a> *theString)
<dl class="el"><dd class="mdescRight">Delete an <a class="el" href="classXStringReference.html">XStringReference</a> object from allocator. <a href="#abf5e720bece6a84c864b06dd8062e632"></a><br/></dl><li>bool <a class="el" href="classXStringReferenceAllocator.html#aa8eb2068dd7dcf1bed63e4891456f6b0">ownsObject</a> (const <a class="el" href="classXStringReference.html">string_type</a> *theObject)
<dl class="el"><dd class="mdescRight">Determine if an object is owned by the allocator... <a href="#aa8eb2068dd7dcf1bed63e4891456f6b0"></a><br/></dl><li>void <a class="el" href="classXStringReferenceAllocator.html#aab9c5d1e99ae24bb56db5bf68f0bbf1a">reset</a> ()
<dl class="el"><dd class="mdescRight">Delete all <a class="el" href="classXStringReference.html">XStringReference</a> objects from allocator. <a href="#aab9c5d1e99ae24bb56db5bf68f0bbf1a"></a><br/></dl><li><a class="el" href="classXStringReferenceAllocator.html#ad09771779f05c177bad1457d9e4b61e8">size_type</a> <a class="el" href="classXStringReferenceAllocator.html#aa00e26205a2f9cb39b2884774f6c8c00">getBlockCount</a> () const
<dl class="el"><dd class="mdescRight">Get size of an <a class="el" href="classArenaBlock.html">ArenaBlock</a>, that is, the number of objects in each block. <a href="#aa00e26205a2f9cb39b2884774f6c8c00"></a><br/></dl><li><a class="el" href="classXStringReferenceAllocator.html#ad09771779f05c177bad1457d9e4b61e8">size_type</a> <a class="el" href="classXStringReferenceAllocator.html#ab574539c658ce316d10bdee810460e75">getBlockSize</a> () const
<dl class="el"><dd class="mdescRight">Get the number of ArenaBlocks currently allocated. <a href="#ab574539c658ce316d10bdee810460e75"></a><br/></dl></ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Definition at line <a class="el" href="XStringReferenceAllocator_8hpp_source.html#l00041">41</a> of file <a class="el" href="XStringReferenceAllocator_8hpp_source.html">XStringReferenceAllocator.hpp</a>.</p>
<hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="a8ce1abea87251766184f04da90f30725"></a><!-- doxytag: member="XStringReferenceAllocator::ArenaAllocatorType" ref="a8ce1abea87251766184f04da90f30725" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classReusableArenaAllocator.html">ReusableArenaAllocator</a>&lt;<a class="el" href="classXStringReference.html">string_type</a>&gt; <a class="el" href="classReusableArenaAllocator.html">XStringReferenceAllocator::ArenaAllocatorType</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="XStringReferenceAllocator_8hpp_source.html#l00047">47</a> of file <a class="el" href="XStringReferenceAllocator_8hpp_source.html">XStringReferenceAllocator.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="ad09771779f05c177bad1457d9e4b61e8"></a><!-- doxytag: member="XStringReferenceAllocator::size_type" ref="ad09771779f05c177bad1457d9e4b61e8" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classReusableArenaAllocator.html#acf80af42a3e56e0f51dfc8b490944b8b">ArenaAllocatorType::size_type</a> <a class="el" href="classXStringReferenceAllocator.html#ad09771779f05c177bad1457d9e4b61e8">XStringReferenceAllocator::size_type</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="XStringReferenceAllocator_8hpp_source.html#l00048">48</a> of file <a class="el" href="XStringReferenceAllocator_8hpp_source.html">XStringReferenceAllocator.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a28b14443d0f693936c950fb99c0f85da"></a><!-- doxytag: member="XStringReferenceAllocator::string_type" ref="a28b14443d0f693936c950fb99c0f85da" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classXStringReference.html">XStringReference</a> <a class="el" href="classXStringReference.html">XStringReferenceAllocator::string_type</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="XStringReferenceAllocator_8hpp_source.html#l00045">45</a> of file <a class="el" href="XStringReferenceAllocator_8hpp_source.html">XStringReferenceAllocator.hpp</a>.</p>
</div>
</div>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a278129a22ae3c5173e14767fec980825"></a><!-- doxytag: member="XStringReferenceAllocator::XStringReferenceAllocator" ref="a278129a22ae3c5173e14767fec980825" args="(MemoryManager &amp;theManager, size_type theBlockCount)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XStringReferenceAllocator::XStringReferenceAllocator </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="classXStringReferenceAllocator.html#ad09771779f05c177bad1457d9e4b61e8">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="a4f9ff9b3c9eda93a04c48a598c0fe8d2"></a><!-- doxytag: member="XStringReferenceAllocator::~XStringReferenceAllocator" ref="a4f9ff9b3c9eda93a04c48a598c0fe8d2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XStringReferenceAllocator::~XStringReferenceAllocator </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="a9ac52afdb69697a35ffe64a2b1e9b502"></a><!-- doxytag: member="XStringReferenceAllocator::createString" ref="a9ac52afdb69697a35ffe64a2b1e9b502" args="(const XalanDOMString &amp;theString)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXStringReference.html">string_type</a>* XStringReferenceAllocator::createString </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;&nbsp;</td>
<td class="paramname"> <em>theString</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create an <a class="el" href="classXStringReference.html">XStringReference</a> object from a string. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>theString</em>&nbsp;</td><td>source string</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to string </dd></dl>
</div>
</div>
<a class="anchor" id="abf5e720bece6a84c864b06dd8062e632"></a><!-- doxytag: member="XStringReferenceAllocator::destroy" ref="abf5e720bece6a84c864b06dd8062e632" args="(string_type *theString)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool XStringReferenceAllocator::destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classXStringReference.html">string_type</a> *&nbsp;</td>
<td class="paramname"> <em>theString</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Delete an <a class="el" href="classXStringReference.html">XStringReference</a> object from allocator. </p>
</div>
</div>
<a class="anchor" id="aa00e26205a2f9cb39b2884774f6c8c00"></a><!-- doxytag: member="XStringReferenceAllocator::getBlockCount" ref="aa00e26205a2f9cb39b2884774f6c8c00" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXStringReferenceAllocator.html#ad09771779f05c177bad1457d9e4b61e8">size_type</a> XStringReferenceAllocator::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 size of an <a class="el" href="classArenaBlock.html">ArenaBlock</a>, that is, 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="XStringReferenceAllocator_8hpp_source.html#l00100">100</a> of file <a class="el" href="XStringReferenceAllocator_8hpp_source.html">XStringReferenceAllocator.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="ab574539c658ce316d10bdee810460e75"></a><!-- doxytag: member="XStringReferenceAllocator::getBlockSize" ref="ab574539c658ce316d10bdee810460e75" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXStringReferenceAllocator.html#ad09771779f05c177bad1457d9e4b61e8">size_type</a> XStringReferenceAllocator::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 ArenaBlocks 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="XStringReferenceAllocator_8hpp_source.html#l00111">111</a> of file <a class="el" href="XStringReferenceAllocator_8hpp_source.html">XStringReferenceAllocator.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="aa8eb2068dd7dcf1bed63e4891456f6b0"></a><!-- doxytag: member="XStringReferenceAllocator::ownsObject" ref="aa8eb2068dd7dcf1bed63e4891456f6b0" args="(const string_type *theObject)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool XStringReferenceAllocator::ownsObject </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXStringReference.html">string_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="XStringReferenceAllocator_8hpp_source.html#l00082">82</a> of file <a class="el" href="XStringReferenceAllocator_8hpp_source.html">XStringReferenceAllocator.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="aab9c5d1e99ae24bb56db5bf68f0bbf1a"></a><!-- doxytag: member="XStringReferenceAllocator::reset" ref="aab9c5d1e99ae24bb56db5bf68f0bbf1a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XStringReferenceAllocator::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="classXStringReference.html">XStringReference</a> objects from allocator. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XStringReferenceAllocator_8hpp_source.html">XStringReferenceAllocator.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>