InstallerError.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
 
#include "CoreMinimal.h"
 
enum class EBuildPatchInstallError;
 
namespace BuildPatchServices
{
    namespace InitializationErrorCodes
    {
        static const TCHAR* MissingStageDirectory = TEXT("01");
        static const TCHAR* MissingInstallDirectory = TEXT("02");
        static const TCHAR* MissingCompleteDelegate = TEXT("03");
        static const TCHAR* InvalidInstallTags = TEXT("04");
        static const TCHAR* ChunkReferenceTracking = TEXT("05");
        static const TCHAR* MissingPrereqForPrereqOnlyInstall = TEXT("06");
        static const TCHAR* InvalidDataInManifest = TEXT("07");
        static const TCHAR* InvalidInstallToMemory = TEXT("08");
        static const TCHAR* InvalidMemoryConstructionConfig = TEXT("09");
    }
 
    namespace DiskSpaceErrorCodes
    {
        static const TCHAR* InitialSpaceCheck = TEXT("01");
        static const TCHAR* DuringInstallation = TEXT("02");
    }
 
    namespace PathLengthErrorCodes
    {
        static const TCHAR* StagingDirectory = TEXT("01");
        static const TCHAR* InstallDirectory = TEXT("02");
    }
 
    namespace DownloadErrorCodes
    {
        static const TCHAR* OutOfChunkRetries = TEXT("01");
        static const TCHAR* MissingDeltaFile = TEXT("02");
        static const TCHAR* UnserialisableDeltaFile = TEXT("03");
        static const TCHAR* RejectedDeltaFile = TEXT("04");
        static const TCHAR* FailedUriRequest = TEXT("05");
    }
 
    namespace ConstructionErrorCodes
    {
        static const TCHAR* UnknownFail = TEXT("01");
        static const TCHAR* FileCreateFail = TEXT("02");
        static const TCHAR* MissingChunkData = TEXT("03");
        static const TCHAR* MissingFileInfo = TEXT("04");
        static const TCHAR* OutboundCorrupt = TEXT("05");
        static const TCHAR* SerializationError = TEXT("06");
        static const TCHAR* TrackingError = TEXT("07");
        static const TCHAR* InternalConsistencyFailure = TEXT("08");
        static const TCHAR* CloseFileError = TEXT("09");
    }
 
    namespace MoveErrorCodes
    {
        static const TCHAR* StageToInstall = TEXT("01");
        static const TCHAR* DeletePrevFileFailed = TEXT("02");
        static const TCHAR* DeleteOldFileFailed = TEXT("03");
    }
 
    namespace VerifyErrorCodes
    {
        static const TCHAR* UnknownFail = TEXT("00");
        static const TCHAR* FinalCheck = TEXT("01");
        static const TCHAR* FileMissing = TEXT("02");
        static const TCHAR* OpenFileFailed = TEXT("03");
        static const TCHAR* HashCheckFailed = TEXT("04");
        static const TCHAR* FileSizeFailed = TEXT("05");
    }
 
    namespace UserCancelErrorCodes
    {
        static const TCHAR* UserRequested = TEXT("01");
    }
 
    namespace ApplicationClosedErrorCodes
    {
        static const TCHAR* ApplicationClosed = TEXT("01");
    }
 
    namespace PrerequisiteErrorPrefixes
    {
        static const TCHAR* ExecuteCode = TEXT("E");
        static const TCHAR* ReturnCode = TEXT("R");
        static const TCHAR* NotFoundCode = TEXT("01");
    }
 
    FText GetStandardErrorText(EBuildPatchInstallError ErrorType);
 
    FText GetDiskSpaceMessage(const FString& Location, uint64 RequiredBytes, uint64 AvailableBytes, const FNumberFormattingOptions* FormatOptions = nullptr);
 
    class IInstallerError
    {
    public:
        typedef TFunction<void()> FOnErrorDelegate;
 
    public:
        virtual ~IInstallerError() {}
 
        virtual bool HasError() const = 0;
 
        virtual bool IsCancelled() const = 0;
 
        virtual bool CanRetry() const = 0;
 
        virtual EBuildPatchInstallError GetErrorType() const = 0;
 
        virtual FString GetErrorCode() const = 0;
 
        virtual FText GetErrorText() const = 0;
 
        virtual void SetError(EBuildPatchInstallError ErrorType, const TCHAR* ErrorSubType, uint32 ErrorCode = 0, FText ErrorText = FText::GetEmpty()) = 0;
 
        virtual int32 RegisterForErrors(FOnErrorDelegate Delegate) = 0;
 
        virtual void UnregisterForErrors(int32 Handle) = 0;
 
        virtual void Reset() = 0;
    };
 
    class FInstallerErrorFactory
    {
    public:
 
        static IInstallerError* Create();
    };
    
    FString EnumToString(const EBuildPatchInstallError& ErrorType);
}