JUCE  v5.4.1-191-g0ab5e696f
JUCE API
Looking for a senior C++ dev?
I'm looking for work. Hire me!
juce::LeakedObjectDetector< OwnerClass > Class Template Reference

Embedding an instance of this class inside another class can be used as a low-overhead way of detecting leaked instances. More...

#include <juce_LeakedObjectDetector.h>

Classes

class  LeakCounter
 

Public Member Functions

 LeakedObjectDetector () noexcept
 
 LeakedObjectDetector (const LeakedObjectDetector &) noexcept
 
 ~LeakedObjectDetector ()
 

Static Private Member Functions

static LeakCountergetCounter () noexcept
 
static const char * getLeakedObjectClassName ()
 

Detailed Description

template<class OwnerClass>
class juce::LeakedObjectDetector< OwnerClass >

Embedding an instance of this class inside another class can be used as a low-overhead way of detecting leaked instances.

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.

To use it, use the JUCE_LEAK_DETECTOR macro as a simple way to put one in your class declaration. Have a look through the juce codebase for examples, it's used in most of the classes.

{Core}

Constructor & Destructor Documentation

◆ LeakedObjectDetector() [1/2]

◆ LeakedObjectDetector() [2/2]

◆ ~LeakedObjectDetector()

template<class OwnerClass >
juce::LeakedObjectDetector< OwnerClass >::~LeakedObjectDetector ( )
inline

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.

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.

Most errors like this are caused by using old-fashioned, non-RAII techniques for your object management. Tut, tut. Always, always use std::unique_ptrs, OwnedArrays, ReferenceCountedObjects, etc, and avoid the 'delete' operator at all costs!

References DBG, juce::LeakedObjectDetector< OwnerClass >::getCounter(), juce::LeakedObjectDetector< OwnerClass >::getLeakedObjectClassName(), and jassertfalse.

Member Function Documentation

◆ getCounter()

template<class OwnerClass >
static LeakCounter& juce::LeakedObjectDetector< OwnerClass >::getCounter ( )
inlinestaticprivatenoexcept

◆ getLeakedObjectClassName()

template<class OwnerClass >
static const char* juce::LeakedObjectDetector< OwnerClass >::getLeakedObjectClassName ( )
inlinestaticprivate

The documentation for this class was generated from the following file: