CookDependencyContext.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/UnrealString.h"
#include "HAL/Platform.h"
#include "Templates/Function.h"
#include "UObject/NameTypes.h"
 
#if WITH_EDITOR
 
namespace UE::Cook
{
struct FCookDependencyContext
{
public:
    UE_DEPRECATED(5.7, "OnInvalidated doesn't exist anymore. Use the new constructor instead.")
    COREUOBJECT_API explicit FCookDependencyContext(void* InHasher,
        TUniqueFunction<void(ELogVerbosity::Type, FString&&)>&& InOnLog,
        TUniqueFunction<void(ELogVerbosity::Type)>&& InOnInvalidated,
        FName InPackageName);
 
    COREUOBJECT_API explicit FCookDependencyContext(void* InHasher,
        TUniqueFunction<void(ELogVerbosity::Type, FString&&, bool)>&& InOnLog,
        FName InPackageName);
 
    COREUOBJECT_API void Update(const void* Data, uint64 Size);
 
    UE_DEPRECATED(5.7, "Use function LogInvalidated instead.")
    COREUOBJECT_API void ReportInvalidated();
 
    UE_DEPRECATED(5.7, "Use function LogError instead.")
    COREUOBJECT_API void ReportError();
 
    COREUOBJECT_API void Log(ELogVerbosity::Type, FString Message, bool bInvalidated = false);
 
    COREUOBJECT_API void LogError(FString Message);
 
    COREUOBJECT_API void LogInvalidated(FString Message);
 
    struct FErrorHandlerScope
    {
    public:
        COREUOBJECT_API ~FErrorHandlerScope();
    private:
        COREUOBJECT_API FErrorHandlerScope(FCookDependencyContext& InContext);
        friend FCookDependencyContext;
        FCookDependencyContext& Context;
    };
 
    [[nodiscard]] COREUOBJECT_API FErrorHandlerScope ErrorHandlerScope(
        TUniqueFunction<FString(FString&&)>&& ErrorHandler);
 
    FName GetPackageName() const { return PackageName; }
 
    void* SetHasher(void* NewHasher);
 
private:
    TUniqueFunction<void(ELogVerbosity::Type, FString&&, bool)> OnLog;
    TArray<TUniqueFunction<FString(FString&&)>, TInlineAllocator<1>> ErrorHandlers;
    FName PackageName;
    void* Hasher; // Type is void* to mask the implementation detail
};
}
 
#endif //#if WITH_EDITOR