GCObjectScopeGuard.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "UObject/GCObject.h"
 
template <typename ObjectType>
class TGCObjectScopeGuard : public FGCObject
{
    static_assert(TPointerIsConvertibleFromTo<ObjectType, const UObjectBase>::Value, "TGCObjectScopeGuard: ObjectType must be pointers to a type derived from UObject");
 
public:
    explicit TGCObjectScopeGuard(ObjectType* InObject)
        : Object(InObject)
    {
    }
 
    virtual ~TGCObjectScopeGuard()
    {
    }
 
    TGCObjectScopeGuard(const TGCObjectScopeGuard&) = delete;
    TGCObjectScopeGuard& operator=(const TGCObjectScopeGuard&) = delete;
 
    //~ FGCObject interface
    virtual void AddReferencedObjects(FReferenceCollector& Collector) override
    {
        Collector.AddReferencedObject(Object);
    }
 
    virtual FString GetReferencerName() const override
    {
        return TEXT("TGCObjectScopeGuard");
    }
 
    UE_FORCEINLINE_HINT ObjectType* Get() const
    {
        return Object;
    }
 
private:
    TObjectPtr<ObjectType> Object;
};
 
using FGCObjectScopeGuard = TGCObjectScopeGuard<const UObject>;
 
template <typename ObjectType>
class TGCObjectsScopeGuard : public FGCObject
{
    static_assert(TPointerIsConvertibleFromTo<ObjectType, const UObjectBase>::Value, "TGCObjectsScopeGuard: ObjectType must be pointers to a type derived from UObject");
 
public:
    explicit TGCObjectsScopeGuard(const TArray<ObjectType*>& InObjects)
        : Objects(InObjects)
    {
    }
 
    virtual ~TGCObjectsScopeGuard()
    {
    }
 
    TGCObjectsScopeGuard(const TGCObjectsScopeGuard&) = delete;
    TGCObjectsScopeGuard& operator=(const TGCObjectsScopeGuard&) = delete;
 
    //~ FGCObject interface
    virtual void AddReferencedObjects(FReferenceCollector& Collector) override
    {
        Collector.AddReferencedObjects(Objects);
    }
 
    virtual FString GetReferencerName() const override
    {
        return TEXT("TGCObjectsScopeGuard");
    }
 
    UE_FORCEINLINE_HINT const TArray<ObjectType*>& Get() const
    {
        return Objects;
    }
 
private:
    TArray<TObjectPtr<ObjectType>> Objects;
};