FileSystem.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
 
#include "Async/Async.h"
#include "Misc/EnumClassFlags.h"
#include "Templates/UniquePtr.h"
 
namespace BuildPatchServices
{
    enum class EAttributeFlags : uint32
    {
        // Value for no attributes.
        None        = 0,
        // Whether the file exists on the storage volume.
        Exists      = 1 << 0,
        // Whether the file is readonly.
        ReadOnly    = 1 << 1,
        // Whether the file is compressed.
        Compressed  = 1 << 2,
        // Whether the file is executable.
        Executable  = 1 << 3
    };
    ENUM_CLASS_FLAGS(EAttributeFlags);
 
    enum class EWriteFlags : uint32
    {
        None                = 0,
        NoFail              = 1 << 0,
        NoReplaceExisting   = 1 << 1,
        EvenIfReadOnly      = 1 << 2,
        Append              = 1 << 3,
        AllowRead           = 1 << 4
    };
    ENUM_CLASS_FLAGS(EWriteFlags);
 
    enum class EReadFlags : uint32
    {
        None                = 0,
        NoFail              = 1 << 0,
        Silent              = 1 << 1,
        AllowWrite          = 1 << 2
    };
    ENUM_CLASS_FLAGS(EReadFlags);
 
    class IFileSystem
    {
    public:
        virtual ~IFileSystem() {}
 
        virtual bool DirectoryExists(const TCHAR* DirectoryPath) const = 0;
 
        virtual bool MakeDirectory(const TCHAR* DirectoryPath) const = 0;
 
        virtual bool GetFileSize(const TCHAR* Filename, int64& FileSize) const = 0;
 
        virtual bool GetAttributes(const TCHAR* Filename, EAttributeFlags& Attributes) const = 0;
 
        virtual bool GetTimeStamp(const TCHAR* Filename, FDateTime& TimeStamp) const = 0;
 
        virtual bool SetReadOnly(const TCHAR* Filename, bool bIsReadOnly) const = 0;
 
        virtual bool SetCompressed(const TCHAR* Filename, bool bIsCompressed) const = 0;
 
        virtual bool SetExecutable(const TCHAR* Filename, bool bIsExecutable) const = 0;
 
        virtual TUniquePtr<FArchive> CreateFileReader(const TCHAR* Filename, EReadFlags ReadFlags = EReadFlags::None) const = 0;
 
        virtual TUniquePtr<FArchive> CreateFileWriter(const TCHAR* Filename, EWriteFlags WriteFlags = EWriteFlags::None) const = 0;
 
        virtual bool LoadFileToString(const TCHAR* Filename, FString& Contents) const = 0;
 
        virtual bool SaveStringToFile(const TCHAR* Filename, const FString& Contents) const = 0;
 
        virtual bool DeleteFile(const TCHAR* Filename) const = 0;
 
        virtual bool MoveFile(const TCHAR* FileDest, const TCHAR* FileSource) const = 0;
 
        virtual bool CopyFile(const TCHAR* FileDest, const TCHAR* FileSource) const = 0;
 
        virtual bool FileExists(const TCHAR* Filename) const = 0;
 
        virtual void FindFiles(TArray<FString>& FoundFiles, const TCHAR* Directory, const TCHAR* FileExtension = nullptr) const = 0;
 
        virtual void FindFilesRecursively(TArray<FString>& FoundFiles, const TCHAR* Directory, const TCHAR* FileExtension = nullptr) const = 0;
 
        virtual void ParallelFindFilesRecursively(TArray<FString>& FoundFiles, const TCHAR* Directory, const TCHAR* FileExtension = nullptr, EAsyncExecution AsyncExecution = EAsyncExecution::ThreadPool) const = 0;
 
        virtual int64 GetAllowedBytesToWriteThrottledStorage(const TCHAR* DestinationPath = nullptr) const = 0;
    };
 
    class FFileSystemFactory
    {
    public:
        static IFileSystem* Create();
    };
}