ManifestBuilder.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
 
#include "CoreMinimal.h"
#include "Misc/Variant.h"
#include "BuildPatchManifest.h"
#include "Core/BlockStructure.h"
#include "Core/FileSpan.h"
#include "Generation/FileAttributesParser.h"
 
namespace BuildPatchServices
{
    struct FManifestDetails
    {
    public:
        // The feature level support the manifest should be serialised as.
        EFeatureLevel FeatureLevel;
        // The ID of the app of this build
        uint32 AppId;
        // The name of the app of this build
        FString AppName;
        // The version string for this build
        FString BuildVersion;
        // The local exe path that would launch this build
        FString LaunchExe;
        // The command line that would launch this build
        FString LaunchCommand;
        // The set of identifiers which the prerequisites satisfy
        TSet<FString> PrereqIds;
        // The display name of the prerequisites installer
        FString PrereqName;
        // The path to the prerequisites installer
        FString PrereqPath;
        // The command line arguments for the prerequisites installer
        FString PrereqArgs;
        // Map of custom fields to add to the manifest
        TMap<FString, FVariant> CustomFields;
        // Map of file attributes
        TMap<FString, FFileAttributes> FileAttributesMap;
    };
 
    struct FManifestBuilderConfig
    {
    public:
        FManifestBuilderConfig();
 
    public:
        // Whether or not we should allow build manifests with no data.
        bool bAllowEmptyBuilds;
    };
 
    class IManifestBuilder
    {
    public:
        virtual ~IManifestBuilder() {}
        virtual void AddChunkMatch(const FGuid& ChunkGuid, const FBlockStructure& Structure) = 0;
        virtual bool FinalizeData(const TArray<FFileSpan>& FileSpans, TArray<FChunkInfo> ChunkInfo) = 0;
        virtual bool SaveToFile(const FString& Filename) = 0;
    };
 
    typedef TSharedRef<IManifestBuilder> IManifestBuilderRef;
    typedef TSharedPtr<IManifestBuilder> IManifestBuilderPtr;
 
    class FManifestBuilderFactory
    {
    public:
        static IManifestBuilderRef Create(IFileSystem* FileSystem, const FManifestBuilderConfig& Config, const FManifestDetails& Details);
    };
}