darrenmothersele/LeakDetector

Leak Detector

A simple memory leak detector. Based on:

• A Cross-Platform Memory Leak Detector
• juce::LeakedObjectDetector

Usage

Add directory to your project's libs (as a git submodule maybe?) and then include in your main CMake file:

add_subdirectory(lib/LeakDetector)
target_link_libraries(YourApp LeakDetector)

Then add include file and LEAK_DETECTOR() macro to your class in the private section.

Example

#include <iostream>

#include <LeakDetector.h>

class Person {
public:
    Person() {
        p1 = new int;
        p2 = new char[10];
    };

private:
    int* p1;
    char* p2;

    LEAK_DETECTOR(Person)
};

int main() {
    auto p = new Person();
    return 0;
}

Results in this output:

!!!! LEAKED 1 INSTANCES OF Person
Leaked object at 0x7fb4b8405870 (size 24, /Users/example/Project/main:20)
Leaked object at 0x7fb4b84058f0 (size 4, /Users/example/Project/main:8)
Leaked object at 0x7fb4b8405960 (size 10, /Users/example/Project/main:9)
*** 3 leaks found

Notes

The include checks if NDEBUG is defined. This is automatically added to release builds by CMAKE so this ensures the leak detector code is only added to debug builds.