XQuilla/docs/dom3-api/classxercesc_1_1DOMMemoryManager.html
2020-02-17 22:19:08 +01:00

418 lines
20 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>XQilla DOM3 API Documentation</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<a style="float:right;" href="http://sourceforge.net/projects/xqilla"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=152021&amp;type=2" border="0" alt="SourceForge.net Logo" /></a>
<!-- Generated by Doxygen 1.3.9.1 -->
<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="examples.html">Examples</a></div>
<h1>xercesc::DOMMemoryManager Class Reference</h1>The <code><a class="el" href="classxercesc_1_1DOMMemoryManager.html">DOMMemoryManager</a></code> interface exposes the memory allocation-related functionalities of a <code><a class="el" href="classxercesc_1_1DOMDocument.html">DOMDocument</a></code>.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="DOMMemoryManager_8hpp-source.html">DOMMemoryManager.hpp</a>&gt;</code>
<p>
<a href="classxercesc_1_1DOMMemoryManager-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMMemoryManager.html#w13">NodeObjectType</a> { <br>
&nbsp;&nbsp;<a class="el" href="classxercesc_1_1DOMMemoryManager.html#w13w0">ATTR_OBJECT</a> = 0,
<a class="el" href="classxercesc_1_1DOMMemoryManager.html#w13w1">ATTR_NS_OBJECT</a> = 1,
<a class="el" href="classxercesc_1_1DOMMemoryManager.html#w13w2">CDATA_SECTION_OBJECT</a> = 2,
<a class="el" href="classxercesc_1_1DOMMemoryManager.html#w13w3">COMMENT_OBJECT</a> = 3,
<br>
&nbsp;&nbsp;<a class="el" href="classxercesc_1_1DOMMemoryManager.html#w13w4">DOCUMENT_FRAGMENT_OBJECT</a> = 4,
<a class="el" href="classxercesc_1_1DOMMemoryManager.html#w13w5">DOCUMENT_TYPE_OBJECT</a> = 5,
<a class="el" href="classxercesc_1_1DOMMemoryManager.html#w13w6">ELEMENT_OBJECT</a> = 6,
<a class="el" href="classxercesc_1_1DOMMemoryManager.html#w13w7">ELEMENT_NS_OBJECT</a> = 7,
<br>
&nbsp;&nbsp;<a class="el" href="classxercesc_1_1DOMMemoryManager.html#w13w8">ENTITY_OBJECT</a> = 8,
<a class="el" href="classxercesc_1_1DOMMemoryManager.html#w13w9">ENTITY_REFERENCE_OBJECT</a> = 9,
<a class="el" href="classxercesc_1_1DOMMemoryManager.html#w13w10">NOTATION_OBJECT</a> = 10,
<a class="el" href="classxercesc_1_1DOMMemoryManager.html#w13w11">PROCESSING_INSTRUCTION_OBJECT</a> = 11,
<br>
&nbsp;&nbsp;<a class="el" href="classxercesc_1_1DOMMemoryManager.html#w13w12">TEXT_OBJECT</a> = 12
<br>
}</td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Destructor</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMMemoryManager.html#z317_0">~DOMMemoryManager</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <a href="#z317_0"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual XMLSize_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMMemoryManager.html#z318_0">getMemoryAllocationBlockSize</a> () const =0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the size of the chunks of memory allocated by the memory manager. <a href="#z318_0"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMMemoryManager.html#z319_0">setMemoryAllocationBlockSize</a> (XMLSize_t size)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the size of the chunks of memory allocated by the memory manager. <a href="#z319_0"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMMemoryManager.html#z320_0">allocate</a> (XMLSize_t amount)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Allocate a memory block of the requested size from the managed pool. <a href="#z320_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMMemoryManager.html#z320_1">allocate</a> (XMLSize_t amount, <a class="el" href="classxercesc_1_1DOMMemoryManager.html#w13">DOMMemoryManager::NodeObjectType</a> type)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Allocate a memory block of the requested size from the managed pool of DOM objects. <a href="#z320_1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMMemoryManager.html#z320_2">release</a> (<a class="el" href="classxercesc_1_1DOMNode.html">DOMNode</a> *object, <a class="el" href="classxercesc_1_1DOMMemoryManager.html#w13">DOMMemoryManager::NodeObjectType</a> type)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Release a DOM object and place its memory back in the pool. <a href="#z320_2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual XMLCh *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMMemoryManager.html#z320_3">cloneString</a> (const XMLCh *src)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Allocate a memory block from the mnaged pool and copy the provided string. <a href="#z320_3"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Hidden constructors</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMMemoryManager.html#z313_0">DOMMemoryManager</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The <code><a class="el" href="classxercesc_1_1DOMMemoryManager.html">DOMMemoryManager</a></code> interface exposes the memory allocation-related functionalities of a <code><a class="el" href="classxercesc_1_1DOMDocument.html">DOMDocument</a></code>.
<p>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="w13" doxytag="xercesc::DOMMemoryManager::NodeObjectType"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">enum <a class="el" href="classxercesc_1_1DOMMemoryManager.html#w13">xercesc::DOMMemoryManager::NodeObjectType</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<dl compact><dt><b>Enumeration values: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="w13w0" doxytag="ATTR_OBJECT"></a>ATTR_OBJECT</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w13w1" doxytag="ATTR_NS_OBJECT"></a>ATTR_NS_OBJECT</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w13w2" doxytag="CDATA_SECTION_OBJECT"></a>CDATA_SECTION_OBJECT</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w13w3" doxytag="COMMENT_OBJECT"></a>COMMENT_OBJECT</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w13w4" doxytag="DOCUMENT_FRAGMENT_OBJECT"></a>DOCUMENT_FRAGMENT_OBJECT</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w13w5" doxytag="DOCUMENT_TYPE_OBJECT"></a>DOCUMENT_TYPE_OBJECT</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w13w6" doxytag="ELEMENT_OBJECT"></a>ELEMENT_OBJECT</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w13w7" doxytag="ELEMENT_NS_OBJECT"></a>ELEMENT_NS_OBJECT</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w13w8" doxytag="ENTITY_OBJECT"></a>ENTITY_OBJECT</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w13w9" doxytag="ENTITY_REFERENCE_OBJECT"></a>ENTITY_REFERENCE_OBJECT</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w13w10" doxytag="NOTATION_OBJECT"></a>NOTATION_OBJECT</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w13w11" doxytag="PROCESSING_INSTRUCTION_OBJECT"></a>PROCESSING_INSTRUCTION_OBJECT</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w13w12" doxytag="TEXT_OBJECT"></a>TEXT_OBJECT</em>&nbsp;</td><td>
</td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="z313_0" doxytag="xercesc::DOMMemoryManager::DOMMemoryManager"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">xercesc::DOMMemoryManager::DOMMemoryManager </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [inline, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="z317_0" doxytag="xercesc::DOMMemoryManager::~DOMMemoryManager"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual xercesc::DOMMemoryManager::~<a class="el" href="classxercesc_1_1DOMMemoryManager.html">DOMMemoryManager</a> </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Destructor.
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z320_1" doxytag="xercesc::DOMMemoryManager::allocate"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void* xercesc::DOMMemoryManager::allocate </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">XMLSize_t&nbsp;</td>
<td class="mdname" nowrap> <em>amount</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="classxercesc_1_1DOMMemoryManager.html#w13">DOMMemoryManager::NodeObjectType</a>&nbsp;</td>
<td class="mdname" nowrap> <em>type</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Allocate a memory block of the requested size from the managed pool of DOM objects.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>amount</em>&nbsp;</td><td>the size of the new memory block </td></tr>
<tr><td valign="top"></td><td valign="top"><em>type</em>&nbsp;</td><td>the type of the DOM object that will be stored in the block</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>the pointer to the newly allocated block </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z320_0" doxytag="xercesc::DOMMemoryManager::allocate"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void* xercesc::DOMMemoryManager::allocate </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">XMLSize_t&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>amount</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Allocate a memory block of the requested size from the managed pool.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>amount</em>&nbsp;</td><td>the size of the new memory block</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>the pointer to the newly allocated block </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z320_3" doxytag="xercesc::DOMMemoryManager::cloneString"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual XMLCh* xercesc::DOMMemoryManager::cloneString </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const XMLCh *&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>src</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Allocate a memory block from the mnaged pool and copy the provided string.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>src</em>&nbsp;</td><td>the string to be copied</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>the pointer to the newly allocated block </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z318_0" doxytag="xercesc::DOMMemoryManager::getMemoryAllocationBlockSize"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual XMLSize_t xercesc::DOMMemoryManager::getMemoryAllocationBlockSize </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap> const<code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Returns the size of the chunks of memory allocated by the memory manager.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>the dimension of the chunks of memory allocated by the memory manager </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z320_2" doxytag="xercesc::DOMMemoryManager::release"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void xercesc::DOMMemoryManager::release </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="classxercesc_1_1DOMNode.html">DOMNode</a> *&nbsp;</td>
<td class="mdname" nowrap> <em>object</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="classxercesc_1_1DOMMemoryManager.html#w13">DOMMemoryManager::NodeObjectType</a>&nbsp;</td>
<td class="mdname" nowrap> <em>type</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Release a DOM object and place its memory back in the pool.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>object</em>&nbsp;</td><td>the pointer to the DOM node </td></tr>
<tr><td valign="top"></td><td valign="top"><em>type</em>&nbsp;</td><td>the type of the DOM object </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z319_0" doxytag="xercesc::DOMMemoryManager::setMemoryAllocationBlockSize"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void xercesc::DOMMemoryManager::setMemoryAllocationBlockSize </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">XMLSize_t&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>size</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Set the size of the chunks of memory allocated by the memory manager.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>size</em>&nbsp;</td><td>the new size of the chunks; it must be greater than 4KB </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="DOMMemoryManager_8hpp-source.html">DOMMemoryManager.hpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Fri Sep 25 06:55:55 2009 for XQilla DOM Level 3 API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.3.9.1 </small></address>
</body>
</html>