File.h

Go to the documentation of this file.

 
// cFile.h
 
// Interfaces to the cFile class providing an OS-independent abstraction of a file.
 
/*
The object is optimized towards binary reads.
The object has no multithreading locks, don't use from multiple threads!
Usage:
1, Construct a cFile instance (no-param constructor)
2, Open a file using Open(), check return value for success
3, Read / write
4, Destroy the instance
 
-- OR --
 
1, Construct a cFile instance opening the file (filename-param constructor)
2, Check if the file was opened using IsOpen()
3, Read / write
4, Destroy the instance
 
For reading entire files into memory, just use the static cFile::ReadWholeFile()
*/
 
 
 
 
 
#pragma once
 
#include "StringUtils.h"
 
 
 
// tolua_begin
 
class cFile
{
public:
 
    // tolua_end
    inline static char PathSeparator()
    {
        #ifdef _WIN32
            return '\\';
        #else
            return '/';
        #endif
    }
 
    enum eMode
    {
        fmRead,       // Read-only. If the file doesn't exist, object will not be valid
        fmWrite,      // Write-only. If the file already exists, it will be overwritten
        fmReadWrite,  // Read / write. If the file already exists, it will be left intact; writing will overwrite the data from the beginning
        fmAppend      // Write-only. If the file already exists cursor will be moved to the end of the file
    } ;
 
    cFile(void);
 
    cFile(const AString & iFileName, eMode iMode);
 
    ~cFile();
 
    bool Open(const AString & iFileName, eMode iMode);
    void Close(void);
    bool IsOpen(void) const;
    bool IsEOF(void) const;
 
    int Read(void * a_Buffer, size_t a_NumBytes);
 
    std::basic_string<std::byte> Read(size_t a_NumBytes);
 
    int Write(const void * a_Buffer, size_t a_NumBytes);
 
    int Write(std::string_view a_String)
    {
        return Write(a_String.data(), a_String.size());
    }
 
    long Seek (int iPosition);
 
    long Tell (void) const;
 
    long GetSize(void) const;
 
    int ReadRestOfFile(AString & a_Contents);
 
    static bool Exists(const AString & a_FileName);  // Exported in ManualBindings.cpp
 
    static bool Delete(const AString & a_Path);  // Exported in ManualBindings.cpp
 
    static bool DeleteFile(const AString & a_FileName);  // Exported in ManualBindings.cpp
 
    static bool DeleteFolder(const AString & a_FolderName);  // Exported in ManualBindings.cpp
 
    static bool DeleteFolderContents(const AString & a_FolderName);  // Exported in ManualBindings.cpp
 
    static bool Rename(const AString & a_OrigPath, const AString & a_NewPath);  // Exported in ManualBindings.cpp
 
    static bool Copy(const AString & a_SrcFileName, const AString & a_DstFileName);  // Exported in ManualBindings.cpp
 
    static bool IsFolder(const AString & a_Path);  // Exported in ManualBindings.cpp
 
    static bool IsFile(const AString & a_Path);  // Exported in ManualBindings.cpp
 
    static long GetSize(const AString & a_FileName);  // Exported in ManualBindings.cpp
 
    static bool CreateFolder(const AString & a_FolderPath);  // Exported in ManualBindings.cpp
 
    static bool CreateFolderRecursive(const AString & a_FolderPath);  // Exported in ManualBindings.cpp
 
    static AString ReadWholeFile(const AString & a_FileName);  // Exported in ManualBindings.cpp
 
    static AString ChangeFileExt(const AString & a_FileName, const AString & a_NewExt);  // Exported in ManualBindings.cpp
 
    static unsigned GetLastModificationTime(const AString & a_FileName);  // Exported in ManualBindings.cpp
 
    // tolua_begin
 
    static AString GetPathSeparator();
 
    static AString GetExecutableExt();
 
    // tolua_end
 
    static AStringVector GetFolderContents(const AString & a_Folder);  // Exported in ManualBindings.cpp
 
    void Flush();
 
private:
    FILE * m_File;
} ;  // tolua_export
 
 
 
 
 
template <class StreamType>
class FileStream final : public StreamType
{
public:
 
    FileStream(const std::string & Path);
    FileStream(const std::string & Path, const typename FileStream::openmode Mode);
};
 
 
 
 
 
using InputFileStream = FileStream<std::ifstream>;
using OutputFileStream = FileStream<std::ofstream>;
 
#ifdef __clang__
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wweak-template-vtables"  // http://bugs.llvm.org/show_bug.cgi?id=18733
#endif
 
extern template class FileStream<std::ifstream>;
extern template class FileStream<std::ofstream>;
 
#ifdef __clang__
#pragma clang diagnostic pop
#endif