FileManager.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "Containers/UnrealString.h"
#include "Misc/DateTime.h"
#include "GenericPlatform/GenericPlatformFile.h"
 
// Maximum length of any filename.  For now, we have no restriction. We would probably use shortening rules if we have to.
#define MAX_UNREAL_FILENAME_LENGTH_DEPRECATED (PLATFORM_MAX_FILEPATH_LENGTH_DEPRECATED)
 
 
enum EFileWrite
{
    FILEWRITE_None              = 0x00,
    FILEWRITE_NoFail            = 0x01,
    FILEWRITE_NoReplaceExisting = 0x02,
    FILEWRITE_EvenIfReadOnly    = 0x04,
    FILEWRITE_Append            = 0x08,
    FILEWRITE_AllowRead         = 0x10,
    FILEWRITE_Silent            = 0x20
};
 
 
enum EFileRead
{
    FILEREAD_None               = 0x00,
    FILEREAD_NoFail             = 0x01,
    FILEREAD_Silent             = 0x02,
    FILEREAD_AllowWrite         = 0x04,
};
 
 
enum ECopyResult
{
    COPY_OK                     = 0x00,
    COPY_Fail                   = 0x01,
    COPY_Canceled               = 0x02,
};
 
 
struct FCopyProgress
{
    virtual bool Poll( float Fraction )=0;
};
 
 
enum EFileOpenFlags
{
    IO_READ         = 0x01,                 // Open for reading
    IO_WRITE        = 0x02,                 // Open for writing
    IO_APPEND       = 0x40,                 // When writing, keep the existing data, set the filepointer to the end of the existing data
};
 
class IFileManager
{
protected:
 
    IFileManager() {}
 
public:
 
    static CORE_API IFileManager& Get();
 
    virtual void ProcessCommandLineOptions() = 0;
 
    virtual void SetSandboxEnabled(bool bInEnabled) = 0;
    virtual bool IsSandboxEnabled() const = 0;
 
    virtual FArchive* CreateFileReader( const TCHAR* Filename, uint32 ReadFlags=0 )=0;
 
    virtual FArchive* CreateFileWriter( const TCHAR* Filename, uint32 WriteFlags=0 )=0;
 
    // If you're writing to a debug file, you should use CreateDebugFileWriter, and wrap the calling code in #if ALLOW_DEBUG_FILES.
#if ALLOW_DEBUG_FILES
    virtual FArchive* CreateDebugFileWriter(const TCHAR* Filename, uint32 WriteFlags=0 ) = 0;
#endif
 
    virtual bool IsReadOnly( const TCHAR* Filename )=0;
 
    virtual bool Delete( const TCHAR* Filename, bool RequireExists=0, bool EvenReadOnly=0, bool Quiet=0 )=0;
 
    virtual uint32 Copy( const TCHAR* Dest, const TCHAR* Src, bool Replace=1, bool EvenIfReadOnly=0, bool Attributes=0, FCopyProgress* Progress = nullptr, EFileRead ReadFlags=FILEREAD_None, EFileWrite WriteFlags=FILEWRITE_None)=0; // utility
 
    virtual bool Move( const TCHAR* Dest, const TCHAR* Src, bool Replace=1, bool EvenIfReadOnly=0, bool Attributes=0, bool bDoNotRetryOrError=0 )=0;
 
    virtual bool FileExists( const TCHAR* Filename )=0;
 
    virtual bool DirectoryExists( const TCHAR* InDirectory )=0;
 
    virtual bool MakeDirectory( const TCHAR* Path, bool Tree=0 )=0;
 
    virtual bool DeleteDirectory( const TCHAR* Path, bool RequireExists=0, bool Tree=0 )=0;
 
    virtual FFileStatData GetStatData(const TCHAR* FilenameOrDirectory) = 0;
 
    virtual void FindFiles( TArray<FString>& FileNames, const TCHAR* Filename, bool Files, bool Directories)=0;
 
    virtual void FindFiles(TArray<FString>& FoundFiles, const TCHAR* Directory, const TCHAR* FileExtension = nullptr) = 0;
 
    virtual void FindFilesRecursive( TArray<FString>& FileNames, const TCHAR* StartDirectory, const TCHAR* Filename, bool Files, bool Directories, bool bClearFileNames=true) = 0; // utility
 
    virtual bool IterateDirectory(const TCHAR* Directory, IPlatformFile::FDirectoryVisitor& Visitor) = 0;
 
    virtual bool IterateDirectory(const TCHAR* Directory, IPlatformFile::FDirectoryVisitorFunc Visitor) = 0;
 
    virtual bool IterateDirectoryRecursively(const TCHAR* Directory, IPlatformFile::FDirectoryVisitor& Visitor) = 0;
 
    virtual bool IterateDirectoryRecursively(const TCHAR* Directory, IPlatformFile::FDirectoryVisitorFunc Visitor) = 0;
 
    virtual bool IterateDirectoryStat(const TCHAR* Directory, IPlatformFile::FDirectoryStatVisitor& Visitor) = 0;
 
    virtual bool IterateDirectoryStat(const TCHAR* Directory, IPlatformFile::FDirectoryStatVisitorFunc Visitor) = 0;
 
    virtual bool IterateDirectoryStatRecursively(const TCHAR* Directory, IPlatformFile::FDirectoryStatVisitor& Visitor) = 0;
 
    virtual bool IterateDirectoryStatRecursively(const TCHAR* Directory, IPlatformFile::FDirectoryStatVisitorFunc Visitor) = 0;
 
    virtual double GetFileAgeSeconds( const TCHAR* Filename )=0;
 
    virtual FDateTime GetTimeStamp( const TCHAR* Path ) = 0;
 
    virtual void GetTimeStampPair(const TCHAR* PathA, const TCHAR* PathB, FDateTime& OutTimeStampA, FDateTime& OutTimeStampB) = 0;
 
    virtual bool SetTimeStamp( const TCHAR* Path, FDateTime TimeStamp ) = 0;
 
    virtual FDateTime GetAccessTimeStamp( const TCHAR* Filename ) = 0;
 
    virtual FString ConvertToRelativePath( const TCHAR* Filename ) = 0;
 
    virtual FString ConvertToAbsolutePathForExternalAppForRead( const TCHAR* Filename ) = 0;
 
    virtual FString ConvertToAbsolutePathForExternalAppForWrite( const TCHAR* Filename ) = 0;
 
    virtual int64 FileSize( const TCHAR* Filename )=0;
 
    virtual bool SendMessageToServer(const TCHAR* Message, IPlatformFile::IFileServerMessageHandler* Handler)=0;
 
    virtual FString GetFilenameOnDisk(const TCHAR* Filename) = 0;
};