BuildPatchUtil.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
/*=============================================================================
    BuildPatchUtil.h: Declares miscellaneous utility functions.
=============================================================================*/
 
#pragma once
 
#include "CoreMinimal.h"
#include "BuildPatchManifest.h"
 
namespace BuildPatchServices
{
    struct FChunkHeader;
    class IFileSystem;
    struct FManifestMeta;
    class IBuildManifestSet;
}
 
enum class EBuildPatchDataType
{
    // Represents data produced by the chunked patch generation mode.
    ChunkData   = 0,
    // Represents data produced by the nochunks patch generation mode, which has deprecated.
    FileData    = 1,
};
 
 
// A delegate taking a float. Used to receive progress.
DECLARE_DELEGATE_OneParam(FBuildPatchFloatDelegate, float);
 
// A delegate returning a bool. Used to pass a paused state.
DECLARE_DELEGATE_RetVal(bool, FBuildPatchBoolRetDelegate);
 
struct FBuildPatchUtils
{
    static FString GetChunkNewFilename(BuildPatchServices::EFeatureLevel FeatureLevel, const FGuid& ChunkGUID, const uint64& ChunkHash);
 
    static FString GetFileNewFilename(BuildPatchServices::EFeatureLevel FeatureLevel, const FGuid& FileGUID, const FSHAHash& FileHash);
    static FString GetFileNewFilename(BuildPatchServices::EFeatureLevel FeatureLevel, const FGuid& FileGUID, const uint64& FilePartHash);
 
    static void GetChunkDetailFromNewFilename(const FString& ChunkNewFilename, FGuid& ChunkGUID, uint64& ChunkHash);
 
    static void GetFileDetailFromNewFilename(const FString& FileNewFilename, FGuid& FileGUID, FSHAHash& FileHash);
 
    static FString GetChunkOldFilename(const FGuid& ChunkGUID);
 
    static FString GetFileOldFilename(const FGuid& FileGUID);
 
    static FString GetDataTypeOldFilename(EBuildPatchDataType DataType, const FGuid& Guid);
 
    static FString GetDataFilename(const FBuildPatchAppManifestRef& Manifest, const FGuid& DataGUID);
    static FString GetDataFilename(const FBuildPatchAppManifest&    Manifest, const FGuid& DataGUID);
 
    static bool GetGUIDFromFilename(const FString& DataFilename, FGuid& DataGUID);
 
    static FString GenerateNewBuildId();
 
    static FString GetBackwardsCompatibleBuildId(const BuildPatchServices::FManifestMeta& ManifestMeta);
 
    static FString GetChunkDeltaDirectory(const FBuildPatchAppManifest& DestinationManifest);
 
    static FString GetChunkDeltaFilename(const FBuildPatchAppManifest& SourceManifest, const FBuildPatchAppManifest& DestinationManifest);
 
    static uint8 VerifyFile(BuildPatchServices::IFileSystem* FileSystem, const FString& FileToVerify, const FSHAHash& Hash1, const FSHAHash& Hash2, FBuildPatchFloatDelegate ProgressDelegate, FBuildPatchBoolRetDelegate ShouldPauseDelegate, FBuildPatchBoolRetDelegate ShouldAbortDelegate);
 
    static uint8 VerifyFile(BuildPatchServices::IFileSystem* FileSystem, const FString& FileToVerify, const FSHAHash& Hash1, const FSHAHash& Hash2);
 
    static uint64 CalculateDiskSpaceRequirementsWithDeleteDuringInstall(
        const TArray<FString>& InFilesToConstruct, 
        int32 InCompletedFileCount, 
        BuildPatchServices::IBuildManifestSet* InManifestSet, 
        const TArray<uint64>& InChunkDbSizesAtPosition, 
        uint64 InTotalChunkDbSize);
};