You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

245 lines
13 KiB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.9.1"/>
  7. <title>Xerces-C++: MemoryManager Class Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12. </head>
  13. <body>
  14. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  15. <div id="titlearea">
  16. <table cellspacing="0" cellpadding="0">
  17. <tbody>
  18. <tr style="height: 56px;">
  19. <td style="padding-left: 0.5em;">
  20. <div id="projectname">Xerces-C++
  21. &#160;<span id="projectnumber">3.1.2</span>
  22. </div>
  23. </td>
  24. </tr>
  25. </tbody>
  26. </table>
  27. </div>
  28. <!-- end header part -->
  29. <!-- Generated by Doxygen 1.8.9.1 -->
  30. <div id="navrow1" class="tabs">
  31. <ul class="tablist">
  32. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  33. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  34. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  35. <li><a href="files.html"><span>Files</span></a></li>
  36. </ul>
  37. </div>
  38. <div id="navrow2" class="tabs2">
  39. <ul class="tablist">
  40. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  41. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  42. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  43. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  44. </ul>
  45. </div>
  46. </div><!-- top -->
  47. <div class="header">
  48. <div class="summary">
  49. <a href="#pub-methods">Public Member Functions</a> &#124;
  50. <a href="classMemoryManager-members.html">List of all members</a> </div>
  51. <div class="headertitle">
  52. <div class="title">MemoryManager Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
  53. </div><!--header-->
  54. <div class="contents">
  55. <p>Configurable memory manager.
  56. <a href="classMemoryManager.html#details">More...</a></p>
  57. <table class="memberdecls">
  58. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  59. Public Member Functions</h2></td></tr>
  60. <tr class="memitem:a6587b83bc36e193c35b33d8f45836a54"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classMemoryManager.html">MemoryManager</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMemoryManager.html#a6587b83bc36e193c35b33d8f45836a54">getExceptionMemoryManager</a> ()=0</td></tr>
  61. <tr class="memdesc:a6587b83bc36e193c35b33d8f45836a54"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method is called to obtain the memory manager that should be used to allocate memory used in exceptions. <a href="#a6587b83bc36e193c35b33d8f45836a54">More...</a><br /></td></tr>
  62. <tr class="separator:a6587b83bc36e193c35b33d8f45836a54"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63. <tr><td colspan="2"><div class="groupHeader">Destructor</div></td></tr>
  64. <tr class="memitem:a069aa716f72688713e925ddcfd712b83"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMemoryManager.html#a069aa716f72688713e925ddcfd712b83">~MemoryManager</a> ()</td></tr>
  65. <tr class="memdesc:a069aa716f72688713e925ddcfd712b83"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor. <a href="#a069aa716f72688713e925ddcfd712b83">More...</a><br /></td></tr>
  66. <tr class="separator:a069aa716f72688713e925ddcfd712b83"><td class="memSeparator" colspan="2">&#160;</td></tr>
  67. <tr><td colspan="2"><div class="groupHeader">The pure virtual methods in this interface.</div></td></tr>
  68. <tr class="memitem:a4955a5c169b701c6106c1541bbb96f17"><td class="memItemLeft" align="right" valign="top">virtual void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMemoryManager.html#a4955a5c169b701c6106c1541bbb96f17">allocate</a> (<a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#ac0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> size)=0</td></tr>
  69. <tr class="memdesc:a4955a5c169b701c6106c1541bbb96f17"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method allocates requested memory. <a href="#a4955a5c169b701c6106c1541bbb96f17">More...</a><br /></td></tr>
  70. <tr class="separator:a4955a5c169b701c6106c1541bbb96f17"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71. <tr class="memitem:af7dce9eab3a2a41e5b887ba735180e67"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMemoryManager.html#af7dce9eab3a2a41e5b887ba735180e67">deallocate</a> (void *p)=0</td></tr>
  72. <tr class="memdesc:af7dce9eab3a2a41e5b887ba735180e67"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method deallocates memory. <a href="#af7dce9eab3a2a41e5b887ba735180e67">More...</a><br /></td></tr>
  73. <tr class="separator:af7dce9eab3a2a41e5b887ba735180e67"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. </table><table class="memberdecls">
  75. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
  76. Protected Member Functions</h2></td></tr>
  77. <tr><td colspan="2"><div class="groupHeader">Constructor</div></td></tr>
  78. <tr class="memitem:ae925e8ad4d8fe6f0565e9d5729f59593"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMemoryManager.html#ae925e8ad4d8fe6f0565e9d5729f59593">MemoryManager</a> ()</td></tr>
  79. <tr class="memdesc:ae925e8ad4d8fe6f0565e9d5729f59593"><td class="mdescLeft">&#160;</td><td class="mdescRight">Protected default constructor. <a href="#ae925e8ad4d8fe6f0565e9d5729f59593">More...</a><br /></td></tr>
  80. <tr class="separator:ae925e8ad4d8fe6f0565e9d5729f59593"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. </table>
  82. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  83. <div class="textblock"><p>Configurable memory manager. </p>
  84. <p>This interface allows outside applications to plug in their own memory manager to be used by Xerces for memory allocation/deallocation.</p>
  85. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  86. <a class="anchor" id="a069aa716f72688713e925ddcfd712b83"></a>
  87. <div class="memitem">
  88. <div class="memproto">
  89. <table class="mlabels">
  90. <tr>
  91. <td class="mlabels-left">
  92. <table class="memname">
  93. <tr>
  94. <td class="memname">virtual MemoryManager::~MemoryManager </td>
  95. <td>(</td>
  96. <td class="paramname"></td><td>)</td>
  97. <td></td>
  98. </tr>
  99. </table>
  100. </td>
  101. <td class="mlabels-right">
  102. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  103. </tr>
  104. </table>
  105. </div><div class="memdoc">
  106. <p>Default destructor. </p>
  107. </div>
  108. </div>
  109. <a class="anchor" id="ae925e8ad4d8fe6f0565e9d5729f59593"></a>
  110. <div class="memitem">
  111. <div class="memproto">
  112. <table class="mlabels">
  113. <tr>
  114. <td class="mlabels-left">
  115. <table class="memname">
  116. <tr>
  117. <td class="memname">MemoryManager::MemoryManager </td>
  118. <td>(</td>
  119. <td class="paramname"></td><td>)</td>
  120. <td></td>
  121. </tr>
  122. </table>
  123. </td>
  124. <td class="mlabels-right">
  125. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  126. </tr>
  127. </table>
  128. </div><div class="memdoc">
  129. <p>Protected default constructor. </p>
  130. </div>
  131. </div>
  132. <h2 class="groupheader">Member Function Documentation</h2>
  133. <a class="anchor" id="a4955a5c169b701c6106c1541bbb96f17"></a>
  134. <div class="memitem">
  135. <div class="memproto">
  136. <table class="mlabels">
  137. <tr>
  138. <td class="mlabels-left">
  139. <table class="memname">
  140. <tr>
  141. <td class="memname">virtual void* MemoryManager::allocate </td>
  142. <td>(</td>
  143. <td class="paramtype"><a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#ac0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a>&#160;</td>
  144. <td class="paramname"><em>size</em></td><td>)</td>
  145. <td></td>
  146. </tr>
  147. </table>
  148. </td>
  149. <td class="mlabels-right">
  150. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  151. </tr>
  152. </table>
  153. </div><div class="memdoc">
  154. <p>This method allocates requested memory. </p>
  155. <dl class="params"><dt>Parameters</dt><dd>
  156. <table class="params">
  157. <tr><td class="paramname">size</td><td>The requested memory size</td></tr>
  158. </table>
  159. </dd>
  160. </dl>
  161. <dl class="section return"><dt>Returns</dt><dd>A pointer to the allocated memory </dd></dl>
  162. <p>Referenced by <a class="el" href="classXMLString.html#ae53122c8ed75c1c59976b0554bf0515b">XMLString::replicate()</a>, and <a class="el" href="classXMLDateTime.html#a79db81ad75eeb4e77753c973a76d4df8">XMLDateTime::setBuffer()</a>.</p>
  163. </div>
  164. </div>
  165. <a class="anchor" id="af7dce9eab3a2a41e5b887ba735180e67"></a>
  166. <div class="memitem">
  167. <div class="memproto">
  168. <table class="mlabels">
  169. <tr>
  170. <td class="mlabels-left">
  171. <table class="memname">
  172. <tr>
  173. <td class="memname">virtual void MemoryManager::deallocate </td>
  174. <td>(</td>
  175. <td class="paramtype">void *&#160;</td>
  176. <td class="paramname"><em>p</em></td><td>)</td>
  177. <td></td>
  178. </tr>
  179. </table>
  180. </td>
  181. <td class="mlabels-right">
  182. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  183. </tr>
  184. </table>
  185. </div><div class="memdoc">
  186. <p>This method deallocates memory. </p>
  187. <dl class="params"><dt>Parameters</dt><dd>
  188. <table class="params">
  189. <tr><td class="paramname">p</td><td>The pointer to the allocated memory to be deleted </td></tr>
  190. </table>
  191. </dd>
  192. </dl>
  193. <p>Referenced by <a class="el" href="classXMLNotationDecl.html#afa084135cb99a692ae4354f14a02fb9d">XMLNotationDecl::setBaseURI()</a>, <a class="el" href="classXMLEntityDecl.html#aa452395af27f5786026d7fe817f80c56">XMLEntityDecl::setBaseURI()</a>, <a class="el" href="classXMLDateTime.html#a79db81ad75eeb4e77753c973a76d4df8">XMLDateTime::setBuffer()</a>, <a class="el" href="classXMLEntityDecl.html#a99b264254c9e3dfa96936f06cd903233">XMLEntityDecl::setNotationName()</a>, <a class="el" href="classXMLNotationDecl.html#a149194ac235a4ba43577faeeb341e0ec">XMLNotationDecl::setPublicId()</a>, <a class="el" href="classXMLEntityDecl.html#a358e1c34ad0ffd22dc699f7aba8d833c">XMLEntityDecl::setPublicId()</a>, <a class="el" href="classXMLNotationDecl.html#ae05b88c8c4d7a8d46a794e7d180cff9a">XMLNotationDecl::setSystemId()</a>, <a class="el" href="classXMLEntityDecl.html#ac8f4fc94cac11ad5a9f8dbf0d3ae86fb">XMLEntityDecl::setSystemId()</a>, <a class="el" href="classXMLEntityDecl.html#ad4e0af0e1b309b00f78aa45d6373dc13">XMLEntityDecl::setValue()</a>, <a class="el" href="classAbstractDOMParser.html#a5f62285b535e3b52051d2a17c420200f">AbstractDOMParser::useImplementation()</a>, and <a class="el" href="classPSVIAttribute.html#a20adb671b19d89a5cc6f0f39c402087c">PSVIAttribute::~PSVIAttribute()</a>.</p>
  194. </div>
  195. </div>
  196. <a class="anchor" id="a6587b83bc36e193c35b33d8f45836a54"></a>
  197. <div class="memitem">
  198. <div class="memproto">
  199. <table class="mlabels">
  200. <tr>
  201. <td class="mlabels-left">
  202. <table class="memname">
  203. <tr>
  204. <td class="memname">virtual <a class="el" href="classMemoryManager.html">MemoryManager</a>* MemoryManager::getExceptionMemoryManager </td>
  205. <td>(</td>
  206. <td class="paramname"></td><td>)</td>
  207. <td></td>
  208. </tr>
  209. </table>
  210. </td>
  211. <td class="mlabels-right">
  212. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  213. </tr>
  214. </table>
  215. </div><div class="memdoc">
  216. <p>This method is called to obtain the memory manager that should be used to allocate memory used in exceptions. </p>
  217. <p>If the same memory manager can be used, simply return 'this' from this function. Note, however, that if there is a possibility that an exception thrown can outlive the memory manager (for example, because the memory manager object is allocated on the stack or is managed by a stack-bound object), it is recommended that you return <a class="el" href="classXMLPlatformUtils.html#a97eff0d9fff3567bea3acd3ca4d95252" title="The configurable memory manager. ">XMLPlatformUtils::fgMemoryManager</a>.</p>
  218. <dl class="section return"><dt>Returns</dt><dd>A pointer to the memory manager </dd></dl>
  219. </div>
  220. </div>
  221. <hr/>The documentation for this class was generated from the following file:<ul>
  222. <li><a class="el" href="MemoryManager_8hpp_source.html">MemoryManager.hpp</a></li>
  223. </ul>
  224. </div><!-- contents -->
  225. <!-- start footer part -->
  226. <hr class="footer"/><address class="footer"><small>
  227. Generated on Wed Mar 18 2015 10:43:38 for Xerces-C++ by &#160;<a href="http://www.doxygen.org/index.html">
  228. <img class="footer" src="doxygen.png" alt="doxygen"/>
  229. </a> 1.8.9.1
  230. </small></address>
  231. </body>
  232. </html>