XQuilla/docs/simple-api/classxercesc_1_1XMemory.html
2020-02-17 22:24:47 +01:00

309 lines
19 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 Simple 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.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</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>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacexercesc.html">xercesc</a></li><li class="navelem"><a class="el" href="classxercesc_1_1XMemory.html">XMemory</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="classxercesc_1_1XMemory-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">xercesc::XMemory Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This class makes it possible to override the C++ memory management by adding new/delete operators to this base class.
<a href="classxercesc_1_1XMemory.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="XMemory_8hpp_source.html">XMemory.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for xercesc::XMemory:</div>
<div class="dyncontent">
<div class="center"><img src="classxercesc_1_1XMemory__inherit__graph.png" border="0" usemap="#xercesc_1_1XMemory_inherit__map" alt="Inheritance graph"/></div>
<map name="xercesc_1_1XMemory_inherit__map" id="xercesc_1_1XMemory_inherit__map">
<area shape="rect" id="node2" href="classDocumentCache.html" title="Expression Context is a storage for contexts. " alt="" coords="217,5,337,32"/><area shape="rect" id="node3" href="classItemFactory.html" title="ItemFactory" alt="" coords="231,56,323,83"/><area shape="rect" id="node4" href="classModuleCache.html" title="ModuleCache" alt="" coords="226,107,329,133"/><area shape="rect" id="node5" href="classScope.html" title="used inside VariableStore to implement variable scoping " alt="" coords="218,157,337,184"/><area shape="rect" id="node6" href="classSequence.html" title="An eagerly evaluated result of a query execution. " alt="" coords="237,208,317,235"/><area shape="rect" id="node7" href="classSequenceBuilder.html" title="SequenceBuilder" alt="" coords="217,259,337,285"/><area shape="rect" id="node8" href="classStaticContext.html" title="The parse time static context interface. " alt="" coords="226,309,329,336"/><area shape="rect" id="node10" href="classStaticType.html" title="Class that represents the static type of an expression. " alt="" coords="235,360,320,387"/><area shape="rect" id="node11" href="classUpdateFactory.html" title="UpdateFactory" alt="" coords="223,411,331,437"/><area shape="rect" id="node12" href="classURIResolver.html" title="This is an abstract class used to resolve URIs in different ways. " alt="" coords="228,461,327,488"/><area shape="rect" id="node13" href="classVarHashEntry.html" title="The class that stores the values of the variables. " alt="" coords="196,512,359,539"/><area shape="rect" id="node14" href="classVariableTypeStore.html" title="This is the wrapper class for the variable store, which implements the lookup and scoping of simple v..." alt="" coords="213,563,342,589"/><area shape="rect" id="node15" href="classxercesc_1_1InputSource.html" title="A single input source for an XML entity. " alt="" coords="204,613,351,640"/><area shape="rect" id="node20" href="classxercesc_1_1XMLFormatTarget.html" title="xercesc::XMLFormatTarget" alt="" coords="187,664,368,691"/><area shape="rect" id="node24" href="classxercesc_1_1XMLFormatter.html" title="This class provides the basic formatting capabilities that are required to turn the Unicode based XML..." alt="" coords="198,715,357,741"/><area shape="rect" id="node25" href="classXQilla.html" title="Provides factory methods for creating XQQuery and DynamicContext objects. " alt="" coords="249,765,306,792"/><area shape="rect" id="node26" href="classXQillaConfiguration.html" title="XQillaConfiguration" alt="" coords="210,820,345,847"/><area shape="rect" id="node29" href="classXQQuery.html" title="Encapsulates a query expression. " alt="" coords="239,871,315,897"/><area shape="rect" id="node9" href="classDynamicContext.html" title="The execution time dynamic context interface. " alt="" coords="457,309,577,336"/><area shape="rect" id="node16" href="classxercesc_1_1LocalFileInputSource.html" title="This class is a derivative of the standard InputSource class. " alt="" coords="418,453,617,480"/><area shape="rect" id="node17" href="classxercesc_1_1MemBufInputSource.html" title="This class is a derivative of the standard InputSource class. " alt="" coords="420,504,615,531"/><area shape="rect" id="node18" href="classxercesc_1_1StdInInputSource.html" title="This class is a derivative of the standard InputSource class. " alt="" coords="429,555,606,581"/><area shape="rect" id="node19" href="classxercesc_1_1URLInputSource.html" title="This class is a derivative of the standard InputSource class. " alt="" coords="431,605,604,632"/><area shape="rect" id="node21" href="classxercesc_1_1LocalFileFormatTarget.html" title="xercesc::LocalFileFormat\lTarget" alt="" coords="433,657,602,698"/><area shape="rect" id="node22" href="classxercesc_1_1MemBufFormatTarget.html" title="xercesc::MemBufFormatTarget" alt="" coords="416,723,619,749"/><area shape="rect" id="node23" href="classxercesc_1_1StdOutFormatTarget.html" title="xercesc::StdOutFormatTarget" alt="" coords="420,773,615,800"/><area shape="rect" id="node27" href="classFastXDMConfiguration.html" title="FastXDMConfiguration" alt="" coords="440,824,595,851"/><area shape="rect" id="node28" href="classXercesConfiguration.html" title="XercesConfiguration" alt="" coords="447,875,587,901"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">The C++ memory management</div></td></tr>
<tr class="memitem:a6f187594d0fb37d1472dacc1a3aad3d9"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMemory.html#a6f187594d0fb37d1472dacc1a3aad3d9">operator new</a> (size_t size)</td></tr>
<tr class="memdesc:a6f187594d0fb37d1472dacc1a3aad3d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method overrides operator new. <a href="#a6f187594d0fb37d1472dacc1a3aad3d9">More...</a><br/></td></tr>
<tr class="separator:a6f187594d0fb37d1472dacc1a3aad3d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7f41eef0d509e5eff717599647942a0f"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMemory.html#a7f41eef0d509e5eff717599647942a0f">operator new</a> (size_t size, <a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *memMgr)</td></tr>
<tr class="memdesc:a7f41eef0d509e5eff717599647942a0f"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method defines a custom operator new, that will use the provided memory manager to perform the allocation. <a href="#a7f41eef0d509e5eff717599647942a0f">More...</a><br/></td></tr>
<tr class="separator:a7f41eef0d509e5eff717599647942a0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6beea8ceedc7e13c15c3a9f8a784396a"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMemory.html#a6beea8ceedc7e13c15c3a9f8a784396a">operator new</a> (size_t size, void *ptr)</td></tr>
<tr class="memdesc:a6beea8ceedc7e13c15c3a9f8a784396a"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method overrides placement operator new. <a href="#a6beea8ceedc7e13c15c3a9f8a784396a">More...</a><br/></td></tr>
<tr class="separator:a6beea8ceedc7e13c15c3a9f8a784396a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a95212a8b8a0e3778c7bf3cf0f0a59aed"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMemory.html#a95212a8b8a0e3778c7bf3cf0f0a59aed">operator delete</a> (void *p)</td></tr>
<tr class="memdesc:a95212a8b8a0e3778c7bf3cf0f0a59aed"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method overrides operator delete. <a href="#a95212a8b8a0e3778c7bf3cf0f0a59aed">More...</a><br/></td></tr>
<tr class="separator:a95212a8b8a0e3778c7bf3cf0f0a59aed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af2335addd6a2bb6cc7bb1df630d05eeb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMemory.html#af2335addd6a2bb6cc7bb1df630d05eeb">operator delete</a> (void *p, <a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *memMgr)</td></tr>
<tr class="memdesc:af2335addd6a2bb6cc7bb1df630d05eeb"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method provides a matching delete for the custom operator new. <a href="#af2335addd6a2bb6cc7bb1df630d05eeb">More...</a><br/></td></tr>
<tr class="separator:af2335addd6a2bb6cc7bb1df630d05eeb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a47791b65820d24581920532a88c37e75"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMemory.html#a47791b65820d24581920532a88c37e75">operator delete</a> (void *p, void *ptr)</td></tr>
<tr class="memdesc:a47791b65820d24581920532a88c37e75"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method provides a matching delete for the placement new. <a href="#a47791b65820d24581920532a88c37e75">More...</a><br/></td></tr>
<tr class="separator:a47791b65820d24581920532a88c37e75"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Constructor</div></td></tr>
<tr class="memitem:ac0d26f65a82ff229bc1e4dbaaac79e84"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMemory.html#ac0d26f65a82ff229bc1e4dbaaac79e84">XMemory</a> ()</td></tr>
<tr class="memdesc:ac0d26f65a82ff229bc1e4dbaaac79e84"><td class="mdescLeft">&#160;</td><td class="mdescRight">Protected default constructor. <a href="#ac0d26f65a82ff229bc1e4dbaaac79e84">More...</a><br/></td></tr>
<tr class="separator:ac0d26f65a82ff229bc1e4dbaaac79e84"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This class makes it possible to override the C++ memory management by adding new/delete operators to this base class. </p>
<p>This class is used in conjunction with the pluggable memory manager. It allows applications to control Xerces memory management. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ac0d26f65a82ff229bc1e4dbaaac79e84"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">xercesc::XMemory::XMemory </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Protected default constructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a95212a8b8a0e3778c7bf3cf0f0a59aed"></a>
<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 *&#160;</td>
<td class="paramname"><em>p</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This method overrides operator delete. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">p</td><td>The pointer to the allocated memory </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="af2335addd6a2bb6cc7bb1df630d05eeb"></a>
<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 *&#160;</td>
<td class="paramname"><em>p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *&#160;</td>
<td class="paramname"><em>memMgr</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This method provides a matching delete for the custom operator new. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">p</td><td>The pointer to the allocated memory </td></tr>
<tr><td class="paramname">memMgr</td><td>An application's memory manager </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a47791b65820d24581920532a88c37e75"></a>
<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 *&#160;</td>
<td class="paramname"><em>p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>ptr</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This method provides a matching delete for the placement new. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">p</td><td>The pointer to the allocated memory </td></tr>
<tr><td class="paramname">ptr</td><td>The memory location where the object had to be allocated </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a6f187594d0fb37d1472dacc1a3aad3d9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* xercesc::XMemory::operator new </td>
<td>(</td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>size</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This method overrides operator new. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td>The requested memory size </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a7f41eef0d509e5eff717599647942a0f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* xercesc::XMemory::operator new </td>
<td>(</td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *&#160;</td>
<td class="paramname"><em>memMgr</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This method defines a custom operator new, that will use the provided memory manager to perform the allocation. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td>The requested memory size </td></tr>
<tr><td class="paramname">memMgr</td><td>An application's memory manager </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a6beea8ceedc7e13c15c3a9f8a784396a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* xercesc::XMemory::operator new </td>
<td>(</td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>ptr</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This method overrides placement operator new. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td>The requested memory size </td></tr>
<tr><td class="paramname">ptr</td><td>The memory location where the object should be allocated </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<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></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>