jens/xerces-c-3.0.0
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
master
xerces-c-3.0.0/doc/html/apiDocs-3/classXMemory.html
T
jens adea0d681b Initial import 
git-svn-id: http://moon:8086/svn/software/trunk/libsrc/xerces-c-3.0.0@1 b431acfa-c32f-4a4a-93f1-934dc6c82436
2014-07-19 07:44:42 +00:00

343 lines
17 KiB
HTML
Executable File
Raw Permalink Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Xerces-C++: XMemory Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.4 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</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="pages.html"><span>Related&nbsp;Pages</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>
<h1>XMemory Class Reference</h1><!-- doxytag: class="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>
<div class="dynheader">
Inheritance diagram for XMemory:</div>
<div class="dynsection">
<p><center><img src="classXMemory.png" usemap="#XMemory_map" border="0" alt=""></center>
<map name="XMemory_map">
<area href="classAbstractDOMParser.html" alt="AbstractDOMParser" shape="rect" coords="164,56,318,80">
<area href="classBinInputStream.html" alt="BinInputStream" shape="rect" coords="164,112,318,136">
<area href="classBinOutputStream.html" alt="BinOutputStream" shape="rect" coords="164,168,318,192">
<area href="classDefaultPanicHandler.html" alt="DefaultPanicHandler" shape="rect" coords="164,224,318,248">
<area href="classInputSource.html" alt="InputSource" shape="rect" coords="164,280,318,304">
<area href="classOutOfMemoryException.html" alt="OutOfMemoryException" shape="rect" coords="164,336,318,360">
<area href="classPSVIAttributeList.html" alt="PSVIAttributeList" shape="rect" coords="164,392,318,416">
<area href="classPSVIAttributeStorage.html" alt="PSVIAttributeStorage" shape="rect" coords="164,448,318,472">
<area href="classPSVIItem.html" alt="PSVIItem" shape="rect" coords="164,504,318,528">
<area href="classQName.html" alt="QName" shape="rect" coords="164,560,318,584">
<area href="classSAXException.html" alt="SAXException" shape="rect" coords="164,616,318,640">
<area href="classSAXParser.html" alt="SAXParser" shape="rect" coords="164,672,318,696">
<area href="classValidationContext.html" alt="ValidationContext" shape="rect" coords="164,728,318,752">
<area href="classXMLAttDef.html" alt="XMLAttDef" shape="rect" coords="164,784,318,808">
<area href="classXMLAttDefList.html" alt="XMLAttDefList" shape="rect" coords="164,840,318,864">
<area href="classXMLAttr.html" alt="XMLAttr" shape="rect" coords="164,896,318,920">
<area href="classXMLBigInteger.html" alt="XMLBigInteger" shape="rect" coords="164,952,318,976">
<area href="classXMLContentModel.html" alt="XMLContentModel" shape="rect" coords="164,1008,318,1032">
<area href="classXMLElementDecl.html" alt="XMLElementDecl" shape="rect" coords="164,1064,318,1088">
<area href="classXMLEntityDecl.html" alt="XMLEntityDecl" shape="rect" coords="164,1120,318,1144">
<area href="classXMLException.html" alt="XMLException" shape="rect" coords="164,1176,318,1200">
<area href="classXMLFileMgr.html" alt="XMLFileMgr" shape="rect" coords="164,1232,318,1256">
<area href="classXMLFormatTarget.html" alt="XMLFormatTarget" shape="rect" coords="164,1288,318,1312">
<area href="classXMLFormatter.html" alt="XMLFormatter" shape="rect" coords="164,1344,318,1368">
<area href="classXMLGrammarDescription.html" alt="XMLGrammarDescription" shape="rect" coords="164,1400,318,1424">
<area href="classXMLGrammarPool.html" alt="XMLGrammarPool" shape="rect" coords="164,1456,318,1480">
<area href="classXMLInteger.html" alt="XMLInteger" shape="rect" coords="164,1512,318,1536">
<area href="classXMLLCPTranscoder.html" alt="XMLLCPTranscoder" shape="rect" coords="164,1568,318,1592">
<area href="classXMLMutexMgr.html" alt="XMLMutexMgr" shape="rect" coords="164,1624,318,1648">
<area href="classXMLNetAccessor.html" alt="XMLNetAccessor" shape="rect" coords="164,1680,318,1704">
<area href="classXMLNotationDecl.html" alt="XMLNotationDecl" shape="rect" coords="164,1736,318,1760">
<area href="classXMLNumber.html" alt="XMLNumber" shape="rect" coords="164,1792,318,1816">
<area href="classXMLStringTokenizer.html" alt="XMLStringTokenizer" shape="rect" coords="164,1848,318,1872">
<area href="classXMLTranscoder.html" alt="XMLTranscoder" shape="rect" coords="164,1904,318,1928">
<area href="classXMLTransService.html" alt="XMLTransService" shape="rect" coords="164,1960,318,1984">
<area href="classXMLUri.html" alt="XMLUri" shape="rect" coords="164,2016,318,2040">
<area href="classXMLURL.html" alt="XMLURL" shape="rect" coords="164,2072,318,2096">
<area href="classXMLValidator.html" alt="XMLValidator" shape="rect" coords="164,2128,318,2152">
<area href="classXSModel.html" alt="XSModel" shape="rect" coords="164,2184,318,2208">
<area href="classXSNamedMap.html" alt="XSNamedMap< TVal >" shape="rect" coords="164,2240,318,2264">
<area href="classXSNamespaceItem.html" alt="XSNamespaceItem" shape="rect" coords="164,2296,318,2320">
<area href="classXSObject.html" alt="XSObject" shape="rect" coords="164,2352,318,2376">
<area href="classXSValue.html" alt="XSValue" shape="rect" coords="164,2408,318,2432">
</map>
</div>
<p>
<a href="classXMemory-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 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="classXMemory.html#717678d9deadc627a41fe0dddede9f7f">operator new</a> (size_t size)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method overrides operator new. <a href="#717678d9deadc627a41fe0dddede9f7f"></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="classXMemory.html#c3022fcc968c684a31c1e6a9ede83c10">operator new</a> (size_t size, <a class="el" href="classMemoryManager.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="#c3022fcc968c684a31c1e6a9ede83c10"></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="classXMemory.html#eaad885b799ac2188ffd28f76182339c">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="#eaad885b799ac2188ffd28f76182339c"></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="classXMemory.html#9da30f1601ea458908cbf150fc2f8f8b">operator delete</a> (void *p)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method overrides operator delete. <a href="#9da30f1601ea458908cbf150fc2f8f8b"></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="classXMemory.html#22efbc6459bdbe79f83b7791bba4d1f6">operator delete</a> (void *p, <a class="el" href="classMemoryManager.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="#22efbc6459bdbe79f83b7791bba4d1f6"></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="classXMemory.html#32ee38b70d412e12f669cfbd86adf623">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="#32ee38b70d412e12f669cfbd86adf623"></a><br></td></tr>
<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="classXMemory.html#e5b8adaa10d5d9276b42823f47e06858">XMemory</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Protected default constructor. <a href="#e5b8adaa10d5d9276b42823f47e06858"></a><br></td></tr>
</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>
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>
<a class="anchor" name="e5b8adaa10d5d9276b42823f47e06858"></a><!-- doxytag: member="XMemory::XMemory" ref="e5b8adaa10d5d9276b42823f47e06858" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XMemory::XMemory </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Protected default constructor.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="717678d9deadc627a41fe0dddede9f7f"></a><!-- doxytag: member="XMemory::operator new" ref="717678d9deadc627a41fe0dddede9f7f" args="(size_t size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* 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>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This method overrides operator new.
<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 requested memory size </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="c3022fcc968c684a31c1e6a9ede83c10"></a><!-- doxytag: member="XMemory::operator new" ref="c3022fcc968c684a31c1e6a9ede83c10" args="(size_t size, MemoryManager *memMgr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* 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"><a class="el" href="classMemoryManager.html">MemoryManager</a> *&nbsp;</td>
<td class="paramname"> <em>memMgr</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></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 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 requested memory size </td></tr>
<tr><td valign="top"></td><td valign="top"><em>memMgr</em>&nbsp;</td><td>An application's memory manager </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="eaad885b799ac2188ffd28f76182339c"></a><!-- doxytag: member="XMemory::operator new" ref="eaad885b799ac2188ffd28f76182339c" args="(size_t size, void *ptr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* 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>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This method overrides placement operator new.
<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 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>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="9da30f1601ea458908cbf150fc2f8f8b"></a><!-- doxytag: member="XMemory::operator delete" ref="9da30f1601ea458908cbf150fc2f8f8b" args="(void *p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void 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>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This method overrides operator delete.
<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>p</em>&nbsp;</td><td>The pointer to the allocated memory </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="22efbc6459bdbe79f83b7791bba4d1f6"></a><!-- doxytag: member="XMemory::operator delete" ref="22efbc6459bdbe79f83b7791bba4d1f6" args="(void *p, MemoryManager *memMgr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void 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"><a class="el" href="classMemoryManager.html">MemoryManager</a> *&nbsp;</td>
<td class="paramname"> <em>memMgr</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This method provides a matching delete for the custom operator new.
<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>p</em>&nbsp;</td><td>The pointer to the allocated memory </td></tr>
<tr><td valign="top"></td><td valign="top"><em>memMgr</em>&nbsp;</td><td>An application's memory manager </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="32ee38b70d412e12f669cfbd86adf623"></a><!-- doxytag: member="XMemory::operator delete" ref="32ee38b70d412e12f669cfbd86adf623" args="(void *p, void *ptr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void 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>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This method provides a matching delete for the placement new.
<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>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>
</table>
</dl>
</div>
</div><p>
<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>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Sep 24 16:36:35 2008 for Xerces-C++ by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.4 </small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink