MallocLeakReporter.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Engine/Engine.h"
#include "HAL/MallocLeakDetection.h"
#include "Delegates/Delegate.h"
#include "Delegates/DelegateCombinations.h"
#include "Containers/Ticker.h"
 
 
class FMallocLeakReporter
{
    DECLARE_MULTICAST_DELEGATE_TwoParams(FMallocLeakReportDelegate, const int32, const int32);
 
public:
    struct EReportOption
    {
        enum
        {
            ReportLeaks = (1 << 0),
            ReportAllocs = (1 << 1),
            ReportMemReport = (1 << 2),
 
            ReportAll = ReportLeaks | ReportAllocs | ReportMemReport,
        };
    };
 
    static ENGINE_API FMallocLeakReporter& Get();
 
 
    ENGINE_API void     Stop();
 
    ENGINE_API void     Clear();
 
    bool        IsEnabled() const { return Enabled; }
 
    ENGINE_API int32        WriteReports(const uint32 ReportFlags= EReportOption::ReportAll);
 
    ENGINE_API int32        WriteReport(const TCHAR* ReportName, const FMallocLeakReportOptions& Options);
 
    void SetDefaultLeakReportOptions(const FMallocLeakReportOptions& Options)
    {
        DefaultLeakReportOptions = Options;
    }
 
    void SetDefaultAllocReportOptions(const FMallocLeakReportOptions& Options)
    {
        DefaultAllocReportOptions = Options;
    }
 
protected:
 
    ENGINE_API FMallocLeakReporter();
 
    ENGINE_API void     Checkpoint();
 
    bool                        Enabled;
    int32                       ReportCount;
    FTSTicker::FDelegateHandle  CheckpointTicker;
    FTSTicker::FDelegateHandle  ReportTicker;
    FMallocLeakReportDelegate   ReportDelegate;
 
    // Report vars
    FMallocLeakReportOptions    DefaultLeakReportOptions;
    FMallocLeakReportOptions    DefaultAllocReportOptions;
};