IBuildManifest.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
/*=============================================================================
    IBuildManifest.h: Declares the IBuildManifest and IManifestField interfaces.
    This defines the functionality provided by a Build Manifest of a specific
    App, and also the interface to creating and reading custom fields.
=============================================================================*/
 
#pragma once
 
#include "CoreMinimal.h"
 
class IBuildManifest;
class IManifestField;
 
typedef TSharedPtr< class IManifestField, ESPMode::ThreadSafe > IManifestFieldPtr;
typedef TSharedRef< class IManifestField, ESPMode::ThreadSafe > IManifestFieldRef;
typedef TSharedPtr< class IBuildManifest, ESPMode::ThreadSafe > IBuildManifestPtr;
typedef TSharedRef< class IBuildManifest, ESPMode::ThreadSafe > IBuildManifestRef;
 
class IManifestField
{
public:
    virtual ~IManifestField() { }
    
    virtual FString AsString() const = 0;
    
    virtual double AsDouble() const = 0;
    
    virtual int64 AsInteger() const = 0;
};
 
class IBuildManifest
{
public:
    virtual ~IBuildManifest() { }
    
    virtual uint32 GetAppID() const = 0;
    
    virtual const FString& GetAppName() const = 0;
    
    virtual const FString& GetVersionString() const = 0;
    
    virtual const FString& GetLaunchExe() const = 0;
    
    virtual const FString& GetLaunchCommand() const = 0;
 
    virtual const TSet<FString>& GetPrereqIds() const = 0;
 
    virtual const FString& GetPrereqName() const = 0;
    
    virtual const FString& GetPrereqPath() const = 0;
    
    virtual const FString& GetPrereqArgs() const = 0;
 
    virtual int64 GetDownloadSize() const = 0;
 
    virtual int64 GetDownloadSize(const TSet<FString>& Tags) const = 0;
 
    virtual int64 GetDeltaDownloadSize(const TSet<FString>& Tags, const IBuildManifestRef& PreviousVersion) const = 0;
 
    virtual int64 GetDeltaDownloadSize(const TSet<FString>& Tags, const IBuildManifestRef& PreviousVersion, const TSet<FString>& PreviousTags) const = 0;
 
    virtual int64 GetBuildSize() const = 0;
 
    virtual int64 GetBuildSize(const TSet<FString>& Tags) const = 0;
 
    virtual TArray<FString> GetBuildFileList() const = 0;
 
    virtual TArray<FStringView> GetBuildFileListView() const = 0;
 
    virtual TArray<FString> GetBuildFileList(const TSet<FString>& Tags) const = 0;
 
    virtual TArray<FStringView> GetBuildFileListView(const TSet<FString>& Tags) const = 0;
 
    virtual int64 GetFileSize(FStringView Filename) const = 0;
 
    virtual int64 GetFileSize(const TArray<FString>& Filenames) const = 0;
 
    virtual int64 GetFileSize(const TSet<FString>& Filenames) const = 0;
 
    virtual bool GetFileHash(const FString& Filename, FSHAHash& OutHash) const = 0;
    
    virtual TSet<FString> GetFileTagList() const = 0;
 
    virtual void GetFileTagList(TSet<FString>& Tags) const = 0;
 
    virtual void GetOutdatedFiles(const IBuildManifestRef& OldManifest, TSet<FString>& OutdatedFiles) const = 0;
 
    virtual void GetRemovableFiles(const IBuildManifestRef& OldManifest, TArray<FString>& RemovableFiles) const = 0;
 
    virtual void GetRemovableFiles(const TCHAR* InstallPath, TArray<FString>& RemovableFiles) const = 0;
 
    virtual bool NeedsResaving() const = 0;
 
    virtual void CopyCustomFields(const IBuildManifestRef& Other, bool bClobber) = 0;
 
    virtual const IManifestFieldPtr GetCustomField(const FString& FieldName) const = 0;
 
    virtual const IManifestFieldPtr SetCustomField(const FString& FieldName, const FString& Value) = 0;
    virtual const IManifestFieldPtr SetCustomField(const FString& FieldName, const double& Value) = 0;
    virtual const IManifestFieldPtr SetCustomField(const FString& FieldName, const int64& Value) = 0;
 
    virtual void RemoveCustomField(const FString& FieldName) = 0;
    
    virtual IBuildManifestRef Duplicate() const = 0;
};