CookArtifact.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#if WITH_EDITOR
#include "Containers/UnrealString.h"
#include "Misc/ConfigCacheIni.h"
#include "Misc/Guid.h"
#include "Templates/RefCounting.h"
 
class ITargetPlatform;
class UCookOnTheFlyServer;
namespace UE::Cook { class ICookInfo; }
 
namespace UE::Cook::Artifact
{
 
struct FCompareSettingsContext
{
public:
    ICookInfo& GetCookInfo() const;
    const ITargetPlatform* GetTargetPlatform() const;
    const FConfigFile& GetPrevious() const;
    const FConfigFile& GetCurrent() const;
    const FString& GetPreviousFileName() const;
    bool IsRequestInvalidate() const;
    bool IsRequestFullRecook() const;
 
    void RequestInvalidate(bool bValue);
    void RequestFullRecook(bool bValue);
 
private:
    FCompareSettingsContext(ICookInfo& InCookInfo, const FConfigFile& InPrevious, const FConfigFile& InCurrent,
        const FString& InPreviousFileName);
 
    ICookInfo& CookInfo;
    const ITargetPlatform* TargetPlatform = nullptr;
    const FConfigFile& Previous;
    const FConfigFile& Current;
    const FString& PreviousFileName;
    bool bRequestInvalidate = false;
    bool bRequestFullRecook = false;
 
    friend UCookOnTheFlyServer;
};
 
} // namespace UE::Cook::Artifact
 
namespace UE::Cook
{
 
class ICookArtifact : public FRefCountBase
{
public:
    virtual ~ICookArtifact() {}
 
    virtual FString GetArtifactName() const = 0;
 
    virtual FConfigFile CalculateCurrentSettings(ICookInfo& CookInfo, const ITargetPlatform* TargetPlatform)
    {
        return FConfigFile();
    }
 
    virtual void CompareSettings(UE::Cook::Artifact::FCompareSettingsContext& Context)
    {
    }
 
    virtual void OnInvalidate(const ITargetPlatform* TargetPlatform)
    {
    }
 
    virtual void OnFullRecook(const ITargetPlatform* TargetPlatform)
    {
    }
};
 
 
} // namespace UE::Cook
 
 
// Inline implementations
 
 
namespace UE::Cook::Artifact
{
 
inline FCompareSettingsContext::FCompareSettingsContext(ICookInfo& InCookInfo,
    const FConfigFile& InPrevious, const FConfigFile& InCurrent, const FString& InPreviousFileName)
    : CookInfo(InCookInfo)
    , Previous(InPrevious)
    , Current(InCurrent)
    , PreviousFileName(InPreviousFileName)
{
}
 
inline ICookInfo& FCompareSettingsContext::GetCookInfo() const
{
    return CookInfo;
}
inline const ITargetPlatform* FCompareSettingsContext::GetTargetPlatform() const
{
    return TargetPlatform;
}
inline const FConfigFile& FCompareSettingsContext::GetPrevious() const
{
    return Previous;
}
inline const FConfigFile& FCompareSettingsContext::GetCurrent() const
{
    return Current;
}
inline const FString& FCompareSettingsContext::GetPreviousFileName() const
{
    return PreviousFileName;
}
inline bool FCompareSettingsContext::IsRequestInvalidate() const
{
    return bRequestInvalidate;
}
inline bool FCompareSettingsContext::IsRequestFullRecook() const
{
    return bRequestFullRecook;
}
inline void FCompareSettingsContext::RequestInvalidate(bool bValue)
{
    bRequestInvalidate = bValue;
}
inline void FCompareSettingsContext::RequestFullRecook(bool bValue)
{
    bRequestFullRecook = bValue;
}
 
} // namespace UE::Cook::Artifact
 
#endif // WITH_EDITOR