BulkDataRegistry.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Map.h"
#include "Delegates/Delegate.h"
#include "HAL/Platform.h"
#include "Logging/LogMacros.h"
#include "UObject/NameTypes.h"
 
#if WITH_EDITOR
 
#include "Async/Future.h"
#include "Compression/CompressedBuffer.h"
#include "Containers/Array.h"
#include "Containers/ArrayView.h"
#include "Containers/Set.h"
#include "Delegates/Delegate.h"
#include "HAL/CriticalSection.h"
#include "IO/IoHash.h"
#include "Misc/Optional.h"
 
class IBulkDataRegistry;
class UPackage;
namespace UE::Serialization { class FEditorBulkData; }
struct FEndLoadPackageContext;
struct FGuid;
 
COREUOBJECT_API DECLARE_LOG_CATEGORY_EXTERN(LogBulkDataRegistry, Log, All);
DECLARE_DELEGATE_RetVal(IBulkDataRegistry*, FSetBulkDataRegistry);
 
#endif
 
namespace UE::BulkDataRegistry
{
    // Define ERegisterResult even if !WITH_EDITOR to make it easier to use in EditorBulkData.cpp
    enum class ERegisterResult : uint8
    {
        Success,
        AlreadyExists,
        InvalidResultCode,
        // Update LexToString when adding new values
    };
}
 
#if WITH_EDITOR
const TCHAR* LexToString(UE::BulkDataRegistry::ERegisterResult Value);
 
namespace UE::BulkDataRegistry
{
    struct FMetaData
    {
        FIoHash RawHash;
        uint64 RawSize;
    };
 
    struct FData
    {
        FCompressedBuffer Buffer;
    };
}
 
class IBulkDataRegistry
{
public:
    COREUOBJECT_API static bool IsEnabled();
    COREUOBJECT_API static IBulkDataRegistry& Get();
    
    virtual UE::BulkDataRegistry::ERegisterResult
        TryRegister(UPackage* Owner, const UE::Serialization::FEditorBulkData& BulkData) = 0;
    virtual void UpdateRegistrationData(UPackage* Owner, const UE::Serialization::FEditorBulkData& BulkData) = 0;
    virtual void Unregister(const UE::Serialization::FEditorBulkData& BulkData) = 0;
    virtual void OnExitMemory(const UE::Serialization::FEditorBulkData& BulkData) = 0;
    virtual void UpdatePlaceholderPayloadId(const UE::Serialization::FEditorBulkData& BulkData) = 0;
 
    virtual TFuture<UE::BulkDataRegistry::FMetaData> GetMeta(const FGuid& BulkDataId) = 0;
 
    virtual TFuture<UE::BulkDataRegistry::FData> GetData(const FGuid& BulkDataId) = 0;
 
    virtual bool TryGetBulkData(const FGuid& BulkDataId, UE::Serialization::FEditorBulkData* OutBulk = nullptr,
        FName* OutOwner = nullptr) = 0;
 
    virtual uint64 GetBulkDataResaveSize(FName PackageName) = 0;
 
    COREUOBJECT_API static void Initialize();
    COREUOBJECT_API static void Shutdown();
    COREUOBJECT_API static FSetBulkDataRegistry& GetSetBulkDataRegistryDelegate();
 
protected:
    virtual ~IBulkDataRegistry() {};
};
 
namespace UE::BulkDataRegistry::Private
{
 
class FResaveSizeTracker
{
public:
    COREUOBJECT_API FResaveSizeTracker();
    COREUOBJECT_API ~FResaveSizeTracker();
 
    COREUOBJECT_API void Register(UPackage* Owner, const UE::Serialization::FEditorBulkData& BulkData);
    COREUOBJECT_API void UpdateRegistrationData(UPackage* Owner, const UE::Serialization::FEditorBulkData& BulkData);
    COREUOBJECT_API uint64 GetBulkDataResaveSize(FName PackageName);
 
private:
    void OnEndLoadPackage(const FEndLoadPackageContext& Context);
    void OnAllModuleLoadingPhasesComplete();
 
    FRWLock Lock;
    TMap<FName, uint64> PackageBulkResaveSize;
    TArray<FName> DeferredRemove;
    bool bPostEngineInitComplete = false;
};
 
}
 
 
// Temporary interface for tunneling the EditorBuildInputResolver into CoreUObject.
// In the future this will be implemented as part of the BuildAPI
namespace UE::DerivedData { class IBuildInputResolver; }
 
COREUOBJECT_API UE::DerivedData::IBuildInputResolver* GetGlobalBuildInputResolver();
COREUOBJECT_API void SetGlobalBuildInputResolver(UE::DerivedData::IBuildInputResolver* InResolver);
 
 
#endif // WITH_EDITOR