TrackedActivity.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "Templates/Function.h"
#include "Templates/SharedPointer.h"
 
enum class ETrackedActivityLight : uint8
{
    None,
    Red,
    Yellow,
    Green,
    Inherit,
};
 
class FTrackedActivity : public TSharedFromThis<FTrackedActivity>
{
public:
    enum class EType
    {
        Activity,
        Info,
        Debug,
    };
 
    using ELight = ETrackedActivityLight;
 
    CORE_API FTrackedActivity(const TCHAR* Name, const TCHAR* Status = TEXT(""), ELight Light = ELight::None, EType Type = EType::Activity, int32 SortValue = 100);
 
    CORE_API ~FTrackedActivity();
 
 
    CORE_API uint32 Push(const TCHAR* Status, bool bShowParent = false, ELight Light = ELight::Inherit);
    CORE_API void   Pop();
 
    CORE_API void   Update(const TCHAR* Status, uint32 Index = ~0u);
    CORE_API void   Update(const TCHAR* Status, ELight Light, uint32 Index = ~0u);
    CORE_API void   Update(ELight Light, uint32 Index = ~0u);
 
 
    static CORE_API FTrackedActivity& GetEngineActivity();
 
    static CORE_API FTrackedActivity& GetIOActivity();
 
 
 
    struct FInfo
    {
        const TCHAR* Name;
        const TCHAR* Status;
        ELight Light; // Can not be "Inherit"
        EType Type;
        int32 SortValue;
        uint32 Id; // Unique Id for Activity (Is thread safe counter starting at 1)
    };
 
    static CORE_API void TraverseActivities(const TFunction<void(const FInfo& Info)>& Func);
 
 
 
    enum class EEvent : int32
    {
        Added = 1,
        Removed = 2,
        Changed = 3
    };
 
    static CORE_API void RegisterEventListener(TUniqueFunction<void(EEvent Event, const FInfo& Info)>&& Func, uint32 MaxDepth = ~0u);
    static CORE_API void UnregisterEventListener();
 
 
private:
    FTrackedActivity(const FTrackedActivity& O) = delete;
    FTrackedActivity& operator=(const FTrackedActivity& O) = delete;
 
    void* Internal;
};
 
 
class FTrackedActivityScope
{
public:
    CORE_API FTrackedActivityScope(FTrackedActivity& Activity, const TCHAR* Status, bool bShowParent = false, FTrackedActivity::ELight Light = FTrackedActivity::ELight::Inherit);
    CORE_API ~FTrackedActivityScope();
private:
    FTrackedActivity& Activity;
};
 
 
#ifndef UE_ENABLE_TRACKED_IO
    #if UE_BUILD_SHIPPING
        #define UE_ENABLE_TRACKED_IO 0
        #define UE_SCOPED_IO_ACTIVITY(...)
    #else
        #define UE_ENABLE_TRACKED_IO 1
        #define UE_SCOPED_IO_ACTIVITY(...) FTrackedActivityScope ANONYMOUS_VARIABLE(IOActivity_)(FTrackedActivity::GetIOActivity(), __VA_ARGS__);
    #endif
#endif