XQuilla/docs/simple-api/classxercesc_1_1XMemory.html

309 lines
18 KiB
HTML
Raw Normal View History

2020-02-17 22:05:20 +01:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
2020-02-17 22:11:31 +01:00
<title>XQilla Simple API Documentation</title>
2020-02-17 22:05:20 +01:00
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
2020-02-17 22:11:31 +01:00
<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>
2020-02-17 22:17:06 +01:00
<!-- Generated by Doxygen 1.5.5 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
<li><a href="annotated.html"><span>Class&nbsp;List</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 class="navpath"><a class="el" href="namespacexercesc.html">xercesc</a>::<a class="el" href="classxercesc_1_1XMemory.html">XMemory</a>
</div>
</div>
<div class="contents">
2020-02-17 22:05:20 +01:00
<h1>xercesc::XMemory Class Reference</h1><!-- doxytag: class="xercesc::XMemory" -->This class makes it possible to override the C++ memory management by adding new/delete operators to this base class.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="XMemory_8hpp-source.html">XMemory.hpp</a>&gt;</code>
<p>
2020-02-17 22:17:06 +01:00
<div class="dynheader">
Inheritance diagram for xercesc::XMemory:</div>
<div class="dynsection">
<p><center><img src="classxercesc_1_1XMemory__inherit__graph.png" border="0" usemap="#xercesc_1_1XMemory__inherit__map" alt="Inheritance graph"></center>
2020-02-17 22:05:20 +01:00
<map name="xercesc_1_1XMemory__inherit__map">
2020-02-17 22:17:06 +01:00
<area shape="rect" href="classDocumentCache.html" title="Expression Context is a storage for contexts." alt="" coords="219,6,336,30"><area shape="rect" href="classItemFactory.html" title="ItemFactory" alt="" coords="232,54,323,78"><area shape="rect" href="classScope.html" title="used inside VariableStore to implement variable scoping" alt="" coords="219,102,336,126"><area shape="rect" href="classSequence.html" title="An eagerly evaluated result of a query execution." alt="" coords="237,150,317,174"><area shape="rect" href="classSequenceBuilder.html" title="SequenceBuilder" alt="" coords="217,198,337,222"><area shape="rect" href="classStaticContext.html" title="The parse time static context interface." alt="" coords="228,246,327,270"><area shape="rect" href="classStaticType.html" title="Class that represents the static type of an expression." alt="" coords="236,294,319,318"><area shape="rect" href="classUpdateFactory.html" title="UpdateFactory" alt="" coords="224,342,331,366"><area shape="rect" href="classURIResolver.html" title="This is an abstract class used to resolve URIs in different ways." alt="" coords="231,390,324,414"><area shape="rect" href="classVarHashEntry.html" title="The class that stores the values of the variables." alt="" coords="197,438,357,462"><area shape="rect" href="classVariableTypeStore.html" title="This is the wrapper class for the variable store, which implements the lookup and..." alt="" coords="215,486,340,510"><area shape="rect" href="classxercesc_1_1InputSource.html" title="A single input source for an XML entity." alt="" coords="205,534,349,558"><area shape="rect" href="classxercesc_1_1XMLFormatTarget.html" title="xercesc::XMLFormatTarget" alt="" coords="188,582,367,606"><area shape="rect" href="classxercesc_1_1XMLFormatter.html" title="This class provides the basic formatting capabilities that are required to turn the..." alt="" coords="199,630,356,654"><area shape="rect" href="classXQilla.html" title="Provides factory methods for creating XQQuery and DynamicContext objects." alt="" coords="249,678,305,702"><area shape="rect" href="classXQillaConfiguration.html" title="XQillaConfiguration" alt="" coords="212,726,343,750"><area shape="rect" href="classXQQuery.html" title="Encapsulates a query expression." alt="" coords="240,774,315,798"><area shape="rect" href="classDynamicContext.html" title="The execution time dynamic context interface." alt="" coords="460,246,577,270"><area shape="rect" href="classxercesc_1_1LocalFileInputSource.html" title="This class is a derivative of the standard InputSource class." alt="" coords="420,390,617,414"><area shape="rect" href="classxercesc_1_1MemBufInputSource.html" title="This class is a derivative of the standard InputSource class." alt="" coords="421,438,616,462"><area shape="rect" href="classxercesc_1_1StdInInputSource.html" title="This class is a derivative of the standard InputSource class." alt="" coords="431,486,607,510"><area shape="rect" href="classxercesc_1_1URLInputSource.html" title="This class is a derivative of the standard InputSource class." alt="" coords="433,534,604,558"><area shape="rect" href="classxercesc_1_1LocalFileFormatTarget.html" title="xercesc::LocalFileFormatTarget" alt="" coords="417,582,620,606"><area shape="rect" href="classxercesc_1_1MemBufFormatTarget.html" title="xercesc::MemBufFormatTarget" alt="" coords="419,630,619,654"><area shape="rect" href="classxercesc_1_1StdOutFormatTarget.html" title="xercesc::StdOutFormatTarget" alt="" coords="423,678,615,702"><area shape="rect" href="classFastXDMConfiguration.html" title="FastXDMConfiguration" alt="" coords="443,726,595,750"><area shape="rect" href="classXercesConfiguration.html" title="XercesConfiguration" alt="" coords="449,774,588,798"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classxercesc_1_1XMemory-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
2020-02-17 22:05:20 +01:00
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">The C++ memory management</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMemory.html#6f187594d0fb37d1472dacc1a3aad3d9">operator new</a> (size_t size)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method overrides operator new. <a href="#6f187594d0fb37d1472dacc1a3aad3d9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMemory.html#7f41eef0d509e5eff717599647942a0f">operator new</a> (size_t size, <a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *memMgr)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method defines a custom operator new, that will use the provided memory manager to perform the allocation. <a href="#7f41eef0d509e5eff717599647942a0f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMemory.html#6beea8ceedc7e13c15c3a9f8a784396a">operator new</a> (size_t size, void *ptr)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method overrides placement operator new. <a href="#6beea8ceedc7e13c15c3a9f8a784396a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMemory.html#95212a8b8a0e3778c7bf3cf0f0a59aed">operator delete</a> (void *p)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method overrides operator delete. <a href="#95212a8b8a0e3778c7bf3cf0f0a59aed"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMemory.html#f2335addd6a2bb6cc7bb1df630d05eeb">operator delete</a> (void *p, <a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *memMgr)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method provides a matching delete for the custom operator new. <a href="#f2335addd6a2bb6cc7bb1df630d05eeb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMemory.html#47791b65820d24581920532a88c37e75">operator delete</a> (void *p, void *ptr)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method provides a matching delete for the placement new. <a href="#47791b65820d24581920532a88c37e75"></a><br></td></tr>
2020-02-17 22:17:06 +01:00
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Constructor</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_1XMemory.html#c0d26f65a82ff229bc1e4dbaaac79e84">XMemory</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Protected default constructor. <a href="#c0d26f65a82ff229bc1e4dbaaac79e84"></a><br></td></tr>
2020-02-17 22:05:20 +01:00
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This class makes it possible to override the C++ memory management by adding new/delete operators to this base class.
<p>
2020-02-17 22:17:06 +01:00
This class is used in conjuction with the pluggable memory manager. It allows applications to control Xerces memory management. <hr><h2>Constructor &amp; Destructor Documentation</h2>
2020-02-17 22:10:06 +01:00
<a class="anchor" name="c0d26f65a82ff229bc1e4dbaaac79e84"></a><!-- doxytag: member="xercesc::XMemory::XMemory" ref="c0d26f65a82ff229bc1e4dbaaac79e84" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:10:06 +01:00
<td class="memname">xercesc::XMemory::XMemory </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [inline, protected]</code></td>
2020-02-17 22:05:20 +01:00
</tr>
2020-02-17 22:10:06 +01:00
</table>
</div>
<div class="memdoc">
<p>
Protected default constructor.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="6f187594d0fb37d1472dacc1a3aad3d9"></a><!-- doxytag: member="xercesc::XMemory::operator new" ref="6f187594d0fb37d1472dacc1a3aad3d9" args="(size_t size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:10:06 +01:00
<td class="memname">void* xercesc::XMemory::operator new </td>
<td>(</td>
<td class="paramtype">size_t&nbsp;</td>
<td class="paramname"> <em>size</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:10:06 +01:00
</div>
<div class="memdoc">
2020-02-17 22:05:20 +01:00
<p>
2020-02-17 22:10:06 +01:00
This method overrides operator new.
2020-02-17 22:05:20 +01:00
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
2020-02-17 22:10:06 +01:00
<tr><td valign="top"></td><td valign="top"><em>size</em>&nbsp;</td><td>The requested memory size </td></tr>
2020-02-17 22:05:20 +01:00
</table>
</dl>
2020-02-17 22:10:06 +01:00
</div>
</div><p>
<a class="anchor" name="7f41eef0d509e5eff717599647942a0f"></a><!-- doxytag: member="xercesc::XMemory::operator new" ref="7f41eef0d509e5eff717599647942a0f" args="(size_t size, MemoryManager *memMgr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:10:06 +01:00
<td class="memname">void* xercesc::XMemory::operator new </td>
<td>(</td>
<td class="paramtype">size_t&nbsp;</td>
<td class="paramname"> <em>size</em>, </td>
2020-02-17 22:05:20 +01:00
</tr>
<tr>
2020-02-17 22:10:06 +01:00
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *&nbsp;</td>
<td class="paramname"> <em>memMgr</em></td><td>&nbsp;</td>
2020-02-17 22:05:20 +01:00
</tr>
<tr>
2020-02-17 22:10:06 +01:00
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:10:06 +01:00
</div>
<div class="memdoc">
2020-02-17 22:05:20 +01:00
<p>
2020-02-17 22:10:06 +01:00
This method defines a custom operator new, that will use the provided memory manager to perform the allocation.
2020-02-17 22:05:20 +01:00
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
2020-02-17 22:10:06 +01:00
<tr><td valign="top"></td><td valign="top"><em>size</em>&nbsp;</td><td>The requested memory size </td></tr>
2020-02-17 22:05:20 +01:00
<tr><td valign="top"></td><td valign="top"><em>memMgr</em>&nbsp;</td><td>An application's memory manager </td></tr>
</table>
</dl>
2020-02-17 22:10:06 +01:00
</div>
</div><p>
<a class="anchor" name="6beea8ceedc7e13c15c3a9f8a784396a"></a><!-- doxytag: member="xercesc::XMemory::operator new" ref="6beea8ceedc7e13c15c3a9f8a784396a" args="(size_t size, void *ptr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:10:06 +01:00
<td class="memname">void* xercesc::XMemory::operator new </td>
<td>(</td>
<td class="paramtype">size_t&nbsp;</td>
<td class="paramname"> <em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&nbsp;</td>
<td class="paramname"> <em>ptr</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:10:06 +01:00
</div>
<div class="memdoc">
2020-02-17 22:05:20 +01:00
<p>
2020-02-17 22:10:06 +01:00
This method overrides placement operator new.
2020-02-17 22:05:20 +01:00
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
2020-02-17 22:10:06 +01:00
<tr><td valign="top"></td><td valign="top"><em>size</em>&nbsp;</td><td>The requested memory size </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ptr</em>&nbsp;</td><td>The memory location where the object should be allocated </td></tr>
2020-02-17 22:05:20 +01:00
</table>
</dl>
2020-02-17 22:10:06 +01:00
</div>
</div><p>
<a class="anchor" name="95212a8b8a0e3778c7bf3cf0f0a59aed"></a><!-- doxytag: member="xercesc::XMemory::operator delete" ref="95212a8b8a0e3778c7bf3cf0f0a59aed" args="(void *p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:10:06 +01:00
<td class="memname">void xercesc::XMemory::operator delete </td>
<td>(</td>
<td class="paramtype">void *&nbsp;</td>
<td class="paramname"> <em>p</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:10:06 +01:00
</div>
<div class="memdoc">
2020-02-17 22:05:20 +01:00
<p>
2020-02-17 22:10:06 +01:00
This method overrides operator delete.
2020-02-17 22:05:20 +01:00
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
2020-02-17 22:10:06 +01:00
<tr><td valign="top"></td><td valign="top"><em>p</em>&nbsp;</td><td>The pointer to the allocated memory </td></tr>
2020-02-17 22:05:20 +01:00
</table>
</dl>
2020-02-17 22:10:06 +01:00
</div>
</div><p>
<a class="anchor" name="f2335addd6a2bb6cc7bb1df630d05eeb"></a><!-- doxytag: member="xercesc::XMemory::operator delete" ref="f2335addd6a2bb6cc7bb1df630d05eeb" args="(void *p, MemoryManager *memMgr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:10:06 +01:00
<td class="memname">void xercesc::XMemory::operator delete </td>
<td>(</td>
<td class="paramtype">void *&nbsp;</td>
<td class="paramname"> <em>p</em>, </td>
2020-02-17 22:05:20 +01:00
</tr>
<tr>
2020-02-17 22:10:06 +01:00
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *&nbsp;</td>
<td class="paramname"> <em>memMgr</em></td><td>&nbsp;</td>
2020-02-17 22:05:20 +01:00
</tr>
<tr>
2020-02-17 22:10:06 +01:00
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:10:06 +01:00
</div>
<div class="memdoc">
2020-02-17 22:05:20 +01:00
<p>
2020-02-17 22:10:06 +01:00
This method provides a matching delete for the custom operator new.
2020-02-17 22:05:20 +01:00
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
2020-02-17 22:10:06 +01:00
<tr><td valign="top"></td><td valign="top"><em>p</em>&nbsp;</td><td>The pointer to the allocated memory </td></tr>
2020-02-17 22:05:20 +01:00
<tr><td valign="top"></td><td valign="top"><em>memMgr</em>&nbsp;</td><td>An application's memory manager </td></tr>
</table>
</dl>
2020-02-17 22:10:06 +01:00
</div>
</div><p>
<a class="anchor" name="47791b65820d24581920532a88c37e75"></a><!-- doxytag: member="xercesc::XMemory::operator delete" ref="47791b65820d24581920532a88c37e75" args="(void *p, void *ptr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void xercesc::XMemory::operator delete </td>
<td>(</td>
<td class="paramtype">void *&nbsp;</td>
<td class="paramname"> <em>p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&nbsp;</td>
<td class="paramname"> <em>ptr</em></td><td>&nbsp;</td>
</tr>
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:10:06 +01:00
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:10:06 +01:00
</div>
<div class="memdoc">
2020-02-17 22:05:20 +01:00
<p>
2020-02-17 22:10:06 +01:00
This method provides a matching delete for the placement new.
2020-02-17 22:05:20 +01:00
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
2020-02-17 22:10:06 +01:00
<tr><td valign="top"></td><td valign="top"><em>p</em>&nbsp;</td><td>The pointer to the allocated memory </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ptr</em>&nbsp;</td><td>The memory location where the object had to be allocated </td></tr>
2020-02-17 22:05:20 +01:00
</table>
</dl>
2020-02-17 22:10:06 +01:00
</div>
</div><p>
2020-02-17 22:05:20 +01:00
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XMemory_8hpp-source.html">XMemory.hpp</a></ul>
2020-02-17 22:17:06 +01:00
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jan 5 19:54:31 2009 for XQilla Simple API by&nbsp;
2020-02-17 22:05:20 +01:00
<a href="http://www.doxygen.org/index.html">
2020-02-17 22:17:06 +01:00
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
2020-02-17 22:05:20 +01:00
</body>
</html>