DISTRHO Plugin Framework
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.

131 lines
6.7KB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>DISTRHO Plugin Framework: LeakedObjectDetector&lt; OwnerClass &gt; Class Template Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">DISTRHO Plugin Framework
  25. </div>
  26. </td>
  27. </tr>
  28. </tbody>
  29. </table>
  30. </div>
  31. <!-- end header part -->
  32. <!-- Generated by Doxygen 1.9.1 -->
  33. <script type="text/javascript">
  34. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
  36. /* @license-end */
  37. </script>
  38. <script type="text/javascript" src="menudata.js"></script>
  39. <script type="text/javascript" src="menu.js"></script>
  40. <script type="text/javascript">
  41. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  42. $(function() {
  43. initMenu('',true,false,'search.php','Search');
  44. $(document).ready(function() { init_search(); });
  45. });
  46. /* @license-end */</script>
  47. <div id="main-nav"></div>
  48. <!-- window showing the filter options -->
  49. <div id="MSearchSelectWindow"
  50. onmouseover="return searchBox.OnSearchSelectShow()"
  51. onmouseout="return searchBox.OnSearchSelectHide()"
  52. onkeydown="return searchBox.OnSearchSelectKey(event)">
  53. </div>
  54. <!-- iframe showing the search results (closed by default) -->
  55. <div id="MSearchResultsWindow">
  56. <iframe src="javascript:void(0)" frameborder="0"
  57. name="MSearchResults" id="MSearchResults">
  58. </iframe>
  59. </div>
  60. </div><!-- top -->
  61. <div class="header">
  62. <div class="summary">
  63. <a href="#nested-classes">Classes</a> &#124;
  64. <a href="#pub-methods">Public Member Functions</a> &#124;
  65. <a href="classLeakedObjectDetector-members.html">List of all members</a> </div>
  66. <div class="headertitle">
  67. <div class="title">LeakedObjectDetector&lt; OwnerClass &gt; Class Template Reference</div> </div>
  68. </div><!--header-->
  69. <div class="contents">
  70. <p><code>#include &lt;<a class="el" href="LeakDetector_8hpp_source.html">LeakDetector.hpp</a>&gt;</code></p>
  71. <table class="memberdecls">
  72. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  73. Public Member Functions</h2></td></tr>
  74. <tr class="memitem:ab474ac40a76a5d47b39d8a68b983767f"><td class="memItemLeft" align="right" valign="top"><a id="ab474ac40a76a5d47b39d8a68b983767f"></a>
  75. &#160;</td><td class="memItemRight" valign="bottom"><b>LeakedObjectDetector</b> (const <a class="el" href="classLeakedObjectDetector.html">LeakedObjectDetector</a> &amp;) noexcept</td></tr>
  76. <tr class="separator:ab474ac40a76a5d47b39d8a68b983767f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. <tr class="memitem:af4fd575fa5361ce5b01f65a635b1d6b3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLeakedObjectDetector.html#af4fd575fa5361ce5b01f65a635b1d6b3">~LeakedObjectDetector</a> () noexcept</td></tr>
  78. <tr class="separator:af4fd575fa5361ce5b01f65a635b1d6b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. </table>
  80. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  81. <div class="textblock"><h3>template&lt;class OwnerClass&gt;<br />
  82. class LeakedObjectDetector&lt; OwnerClass &gt;</h3>
  83. <p>Embedding an instance of this class inside another class can be used as a low-overhead way of detecting leaked instances.</p>
  84. <p>This class keeps an internal static count of the number of instances that are active, so that when the app is shutdown and the static destructors are called, it can check whether there are any left-over instances that may have been leaked.</p>
  85. <p>To use it, use the DISTRHO_LEAK_DETECTOR macro as a simple way to put one in your class declaration. </p>
  86. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  87. <a id="af4fd575fa5361ce5b01f65a635b1d6b3"></a>
  88. <h2 class="memtitle"><span class="permalink"><a href="#af4fd575fa5361ce5b01f65a635b1d6b3">&#9670;&nbsp;</a></span>~LeakedObjectDetector()</h2>
  89. <div class="memitem">
  90. <div class="memproto">
  91. <div class="memtemplate">
  92. template&lt;class OwnerClass &gt; </div>
  93. <table class="mlabels">
  94. <tr>
  95. <td class="mlabels-left">
  96. <table class="memname">
  97. <tr>
  98. <td class="memname"><a class="el" href="classLeakedObjectDetector.html">LeakedObjectDetector</a>&lt; OwnerClass &gt;::~<a class="el" href="classLeakedObjectDetector.html">LeakedObjectDetector</a> </td>
  99. <td>(</td>
  100. <td class="paramname"></td><td>)</td>
  101. <td></td>
  102. </tr>
  103. </table>
  104. </td>
  105. <td class="mlabels-right">
  106. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
  107. </tr>
  108. </table>
  109. </div><div class="memdoc">
  110. <p>If you hit this, then you've managed to delete more instances of this class than you've created.. That indicates that you're deleting some dangling pointers.</p>
  111. <p>Note that although this assertion will have been triggered during a destructor, it might not be this particular deletion that's at fault - the incorrect one may have happened at an earlier point in the program, and simply not been detected until now.</p>
  112. <p>Most errors like this are caused by using old-fashioned, non-RAII techniques for your object management. Tut, tut. Always, always use ScopedPointers, OwnedArrays, ReferenceCountedObjects, etc, and avoid the 'delete' operator at all costs!</p>
  113. </div>
  114. </div>
  115. <hr/>The documentation for this class was generated from the following file:<ul>
  116. <li>distrho/extra/<a class="el" href="LeakDetector_8hpp_source.html">LeakDetector.hpp</a></li>
  117. </ul>
  118. </div><!-- contents -->
  119. <!-- start footer part -->
  120. <hr class="footer"/><address class="footer"><small>
  121. Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
  122. </small></address>
  123. </body>
  124. </html>