GCObjectInfo.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
/*=============================================================================
    GarbageCollectionHistory.h: Unreal realtime garbage collection history
=============================================================================*/
 
#pragma once
 
#include "Containers/Map.h"
#include "Containers/StringFwd.h"
#include "Containers/UnrealString.h"
#include "HAL/Platform.h"
#include "Misc/AssertionMacros.h"
#include "Templates/TypeHash.h"
#include "UObject/Class.h"
#include "UObject/GarbageCollection.h"
#include "UObject/NameTypes.h"
#include "UObject/Object.h"
#include "UObject/ObjectMacros.h"
#include "UObject/UObjectArray.h"
 
class FGCObjectInfo
{
public:
 
    FGCObjectInfo() = default;
    explicit FGCObjectInfo(const UObject* Obj)
        : Name(Obj->GetFName())
        , Flags(Obj->GetFlags())
        , InternalFlags(Obj->GetInternalFlags())
        , ClusterRootIndex(GUObjectArray.ObjectToObjectItem(Obj)->GetOwnerIndex())
        , bDisregardForGC(GUObjectArray.IsDisregardForGC(Obj))
        , RefCount(GUObjectArray.ObjectToObjectItem(Obj)->GetRefCount())
    {
 
    }
 
private:
 
    FName Name;
    FGCObjectInfo* Class = nullptr;
    FGCObjectInfo* Outer = nullptr;
    EObjectFlags Flags = RF_NoFlags;
    EInternalObjectFlags InternalFlags = EInternalObjectFlags::None;
    int32 ClusterRootIndex = -1;
    bool bDisregardForGC = false;
    int32 RefCount = 0;
 
public:
 
    COREUOBJECT_API UObject* TryResolveObject();
 
    FGCObjectInfo* GetClass() const
    {
        return Class;
    }
 
    FGCObjectInfo* GetOuter() const
    {
        return Outer;
    }
 
    inline bool IsIn(const FGCObjectInfo* MaybeOuter) const
    {       
        for (const FGCObjectInfo* Obj = this; Obj; Obj = Obj->Outer)
        {
            if (Obj == MaybeOuter)
            {
                return true;
            }
        }
        return false;
    }
 
    bool HasAnyFlags(EObjectFlags InFlags) const
    {
        return !!(Flags & InFlags);
    }
 
    bool HasAnyInternalFlags(EInternalObjectFlags InFlags) const
    {
        return !!(InternalFlags & InFlags);
    }
 
    bool IsRooted() const
    {
        return HasAnyInternalFlags(EInternalObjectFlags::RootSet);
    }
 
    bool IsNative() const
    {
        return HasAnyInternalFlags(EInternalObjectFlags::Native);
    }
 
    bool IsGarbage() const
    {
        return HasAnyInternalFlags(EInternalObjectFlags::Garbage);
    }
 
    int32 GetOwnerIndex() const
    {
        return ClusterRootIndex;
    }
 
    FString GetClassName() const
    {
        check(Class);
        return Class->Name.ToString();
    }
 
    int32 GetRefCount() const
    {
        return RefCount;
    }
 
    bool IsValid() const
    {
        return !HasAnyInternalFlags(EInternalObjectFlags::Garbage);
    }
 
    bool IsDisregardForGC() const
    {
        return bDisregardForGC;
    }
 
    COREUOBJECT_API void GetPathName(FStringBuilderBase& ResultString) const;
    COREUOBJECT_API FString GetPathName() const;
    COREUOBJECT_API FString GetFullName() const;
 
    friend uint32 GetTypeHash(const FGCObjectInfo& Info)
    {
        return HashCombine(GetTypeHash(Info.Outer), GetTypeHash(Info.Name));
    }
 
    static COREUOBJECT_API FGCObjectInfo* FindOrAddInfoHelper(const UObject* InObject, TMap<const UObject*, FGCObjectInfo*>& InOutObjectToInfoMap);
};