CookDeterminismHelper.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#if WITH_EDITOR
 
#include "Containers/Map.h"
#include "Containers/Set.h"
#include "Containers/StringView.h"
#include "Containers/UnrealString.h"
#include "Containers/Utf8String.h"
#include "Templates/RefCounting.h"
#include "Serialization/CompactBinary.h"
 
class ITargetPlatform;
class UObject;
 
namespace UE::Cook
{
 
struct IDeterminismModifiedPackageContext;
 
struct IDeterminismConstructDiagnosticsContext
{
    virtual ~IDeterminismConstructDiagnosticsContext()
    {
    }
 
    virtual const ITargetPlatform* GetTargetPlatform() = 0;
 
    virtual void AddDiagnostic(FUtf8StringView DiagnosticName, const FCbField& Value) = 0;
 
    virtual bool FullDDCKeysRequested() const = 0;
};
 
struct IDeterminismModifiedExportContext
{
    virtual ~IDeterminismModifiedExportContext()
    {
    }
 
    virtual bool IsModified() = 0;
    virtual bool IsPrimaryAsset() = 0;
    virtual const ITargetPlatform* GetTargetPlatform() = 0;
    virtual const TMap<FUtf8String, FCbField>& GetOldDiagnostics() = 0;
    virtual const TMap<FUtf8String, FCbField>& GetNewDiagnostics() = 0;
    virtual IDeterminismModifiedPackageContext& GetPackageContext() = 0;
    virtual FString GetCompareText() = 0;
 
    virtual void AppendLog(FStringView LogText) = 0;
    virtual void AppendDiagnostics() = 0;
};
 
struct IDeterminismModifiedPackageContext
{
    virtual ~IDeterminismModifiedPackageContext()
    {
    }
 
    virtual const ITargetPlatform* GetTargetPlatform() = 0;
    virtual const TSet<UObject*>& GetModifiedExports() = 0;
    virtual UObject* GetPrimaryAsset() = 0;
    virtual const IDeterminismModifiedExportContext& GetExportContext(UObject* Export) = 0;
};
 
class IDeterminismHelper : public FRefCountBase
{
public:
    virtual void ConstructDiagnostics(IDeterminismConstructDiagnosticsContext& Context)
    {
    }
 
    virtual void OnPackageModified(IDeterminismModifiedExportContext& ExportContext)
    {
        if (ExportContext.IsModified() || ExportContext.IsPrimaryAsset())
        {
            ExportContext.AppendDiagnostics();
        }
    }
};
 
} // namespace UE::Cook
 
#endif // WITH_EDITOR