file.h

Go to the documentation of this file.

 
#ifndef _FILE_CLASS_HEADER_
#define _FILE_CLASS_HEADER_
 
namespace A_UTILS_NS
{
 
#ifdef WIN32
    typedef tHandle tFileHandle;
#else
    typedef int tFileHandle;
#endif
 
class DOEXPORT cFile
{
    A_UTILS_D(cFile)
 
    public:
        typedef enum
        {
            OM_Read                   = 0x0001,
 
            OM_Write                  = 0x0002,
 
            OM_Append                 = 0x0004,
 
            OM_ReadWrite              = 0x0008,
 
            OM_SharedRead             = 0x0100,
 
            OM_SharedWrite            = 0x0200,
 
            OM_SequentialAccess       = 0x0400,
 
            OM_TemporaryFile          = 0x0800,
 
            OM_ShortLived             = 0x1000,
 
            OM_TextMode               = 0x2000,
 
            OM_WriteThrough           = 0x4000,
 
            OM_DisableFileSystemCache = 0x8000
 
        } tOpenMode;
 
        typedef enum
        {
            FP_Begin   = 0,
 
            FP_Current = 1,
 
            FP_End     = 2
        } tFilePosRef;
 
    protected:
        tFileHandle m_hFile;                
        tUInt8*     m_pReadCache;           
        tInt        m_nFileCacheUsage;      
        tInt        m_nFileCacheOffset;     
        tInt        m_nFileCacheSize;       
        tBool       m_bReadCacheEnabled;    
        tBool       m_bReference;           
        tBool       m_bSystemCacheDisabled; 
        tInt        m_nSectorSize;          
        tFilePos    m_nSectorBytesToSkip;   
 
    public:
        cFile();
 
        virtual ~cFile();
 
        tResult Open(const cFilename& strFilename, tUInt32 ui32Mode);
 
        tResult Close();
 
        tResult Attach(cFile& oFile);
 
        tResult Detach();
 
        tBool SetReadCache(tInt nCacheSize);
 
        tInt Read(tVoid* pvBuffer, tInt nBufferSize);
 
        tResult ReadAll(tVoid* pvBuffer, tInt nBufferSize);
 
        tInt Skip(tInt nNumberOfBytes);
 
        tInt Write(const tVoid* pvBuffer, tInt nBufferSize);
 
        tResult WriteAll(const tVoid* pvBuffer, tInt nBufferSize);
 
        tInt Write(const cString& strString);
 
        tInt ReadLine(cString& strString);
 
        tInt WriteLine(const cString& strString);
 
        tFileSize GetSize() const;
 
        tFilePos GetFilePos() const;
 
        tFilePos SetFilePos(tFilePos nOffset, tFilePosRef MoveMode);
 
        static tResult GetTimeAccess(const cFilename filename, A_UTILS_NS::cDateTime &dt);
        static tResult GetTimeCreation(const cFilename filename, A_UTILS_NS::cDateTime &dt);
 
        static tResult GetTimeChange(const cFilename filename, A_UTILS_NS::cDateTime &dt);
 
        tBool IsEof();
 
        tBool IsValid() const;
 
        tResult Truncate(tFilePos nSize);
 
    protected:
        tVoid Initialize();
 
        tResult AllocReadCache(tInt nCacheSize);
 
        tResult FreeReadCache();
 
        tVoid* InternalMalloc(tInt nSize, tBool bUseSegmentSize=tFalse);
 
        tVoid InternalFree(tVoid* pMemory, tBool bUseSegmentSize=tFalse);
};
 
} // namespace A_UTILS_NS
 
#endif // _FILE_CLASS_HEADER_