PackageReload.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Array.h"
#include "Containers/ArrayView.h"
#include "Containers/Map.h"
#include "Containers/SparseArray.h"
#include "CoreMinimal.h"
#include "HAL/Platform.h"
#include "HAL/PlatformCrt.h"
#include "Templates/PointerIsConvertibleFromTo.h"
#include "Templates/UnrealTemplate.h"
#include "UObject/Object.h"
#include "UObject/ObjectPtr.h"
#include "UObject/ObjectMacros.h"
#include "UObject/UObjectGlobals.h"
#include "UObject/WeakObjectPtr.h"
#include "UObject/WeakObjectPtrTemplates.h"
 
class IAssetRegistryInterface;
class UPackage;
 
struct FReloadPackageData
{
    FReloadPackageData()
        : PackageToReload(nullptr)
        , LoadFlags(LOAD_None)
    {
    }
 
    FReloadPackageData(UPackage* InPackageToReload, const uint32 InLoadFlags)
        : PackageToReload(InPackageToReload)
        , LoadFlags(InLoadFlags)
    {
    }
 
    UPackage* PackageToReload;
 
    uint32 LoadFlags;
};
 
enum class EPackageReloadPhase : uint8
{
    PrePackageLoad,
    PrePackageFixup,
    OnPackageFixup,
    PostPackageFixup,
    PreBatch,
    PostBatchPreGC,
    PostBatchPostGC,
};
 
class FPackageReloadedEvent
{
public:
    FPackageReloadedEvent(const UPackage* InOldPackage, const UPackage* InNewPackage, TMap<UObject*, UObject*> InRepointedObjects)
        : OldPackage(InOldPackage)
        , NewPackage(InNewPackage)
        , RepointedObjects(ObjectPtrWrap(MoveTemp(InRepointedObjects)))
        , ObjectReferencers()
    {
    }
 
    UE_FORCEINLINE_HINT const UPackage* GetOldPackage() const
    {
        return OldPackage;
    }
 
    UE_FORCEINLINE_HINT const UPackage* GetNewPackage() const
    {
        return NewPackage;
    }
 
    UE_FORCEINLINE_HINT const TMap<UObject*, UObject*>& GetRepointedObjects() const
    {
        return ObjectPtrDecay(RepointedObjects);
    }
 
    template <typename InObjectType, typename OutObjectType>
    inline bool GetRepointedObject(InObjectType* InObject, OutObjectType*& OutRepointedObject) const
    {
        static_assert(TPointerIsConvertibleFromTo<InObjectType, const volatile UObject>::Value && TPointerIsConvertibleFromTo<OutObjectType, const volatile UObject>::Value, "FPackageReloadedEvent::GetRepointedObject can only be used with UObject types");
        return GetRepointedObjectInternal((const UObject*)InObject, (const UObject*&)OutRepointedObject);
    }
 
    template <typename ObjectType>
    inline bool RepointObject(ObjectType*& Object) const
    {
        static_assert(TPointerIsConvertibleFromTo<ObjectType, const volatile UObject>::Value, "FPackageReloadedEvent::RepointObject can only be used with UObject types");
        return GetRepointedObjectInternal((const UObject*)Object, (const UObject*&)Object);
    }
 
    UE_FORCEINLINE_HINT const TArray<TWeakObjectPtr<UObject>>& GetObjectReferencers() const
    {
        return ObjectReferencers;
    }
 
    UE_FORCEINLINE_HINT void AddObjectReferencer(UObject* InObject)
    {
        ObjectReferencers.AddUnique(InObject);
    }
 
    void AddReferencedObjects(FReferenceCollector& Collector)
    {
        Collector.AddReferencedObjects(RepointedObjects);
    }
 
private:
    bool GetRepointedObjectInternal(const UObject* InObject, const UObject*& OutRepointedObject) const
    {
        if (InObject && RepointedObjects.Contains(InObject))
        {
            OutRepointedObject = RepointedObjects[InObject];
            return true;
        }
        return false;
    }
 
    const UPackage* OldPackage;
    const UPackage* NewPackage;
    TMap<TObjectPtr<UObject>, TObjectPtr<UObject>> RepointedObjects;
    TArray<TWeakObjectPtr<UObject>> ObjectReferencers;
};
 
COREUOBJECT_API void SortPackagesForReload(TArray<UPackage*>& PackagesToReload);
 
COREUOBJECT_API UPackage* ReloadPackage(UPackage* InPackageToReload, const uint32 InLoadFlags);
 
COREUOBJECT_API void ReloadPackages(const TArrayView<FReloadPackageData>& InPackagesToReload, TArray<UPackage*>& OutReloadedPackages, const int32 InNumPackagesPerBatch = 1);