indexedfile.h

Go to the documentation of this file.

 
#ifndef _INDEXEDFILE_CLASS_HEADER_
#define _INDEXEDFILE_CLASS_HEADER_
 
namespace A_UTILS_NS
{
 
//*************************************************************************************************
/*
 
    FILE LAYOUT:
 
    +------------------------------------------------------------------------------------+
    |HDR|         DATA         |        EXTENSIONS         |    EXTENSION-HEADER TABLE   |
    +------------------------------------------------------------------------------------+
 
*/
 
//*************************************************************************************************
class cIndexedFile;
 
#define IDX_EXT_INDEX "index"
#define IDX_EXT_INDEX_0 IDX_EXT_INDEX "0"
#define IDX_EXT_INDEX_ADDITONAL "index_add"
#define IDX_EXT_INDEX_ADDITONAL_0 IDX_EXT_INDEX_ADDITONAL "0"
 
//*************************************************************************************************
class DOEXPORT cIndexedFile : public IIndexedFile
{
    A_UTILS_D(cIndexedFile)
 
    protected:
        static const tUInt32 m_nFileId;
        static const tUInt32 m_nVersionId;
        static const tUInt32 m_nVersionIdWithHistory;
        static const tUInt32 m_nVersionIdWithHistoryEndOffset;
        static const tUInt32 m_nVersionADTF3;
        static const tUInt8 m_ui8ByteOrder;
        static tInt64 m_nDefaultBlockSize;
        static tInt64 m_nDefaultCacheSize;
        tInt64 m_nSectorSize;
        tBool m_bSystemCacheDisabled;
 
        cFile m_oFile;
        tFilePos m_nFilePos;
 
        tUInt8* m_pBuffer;
        tInt64 m_nBufferSize;
        tFileHeader* m_psFileHeader;
 
        tBool m_bWriteGUID;
 
        typedef struct
        {
            tFileExtension sFileExtension; 
            tVoid* pExtensionPage; 
        } tFileExtensionStruct;
 
        typedef std::list<tFileExtensionStruct*> tFileExtensionList;
 
        tFileExtensionList m_lstExtensions;
 
        tVoid* m_pCache;
        tInt64 m_nCacheSize;
 
        tBool m_bWriteMode;
 
    public:
        cIndexedFile();
        virtual ~cIndexedFile();
 
        virtual tResult Close();
 
        tResult SetDescription(const tChar* strDescription);
        const tChar* GetDescription() const;
 
        tResult GetGUID(cString& strGUID);
 
        tResult SetDateTime(const tDateTime* psDateTime);
 
        tResult GetDateTime(tDateTime* psDateTime);
 
        tUInt8 GetByteOrder();
 
        tInt GetExtensionCount();
 
        tResult FindExtension(const tChar* strIdentifier, tFileExtension** ppsExtensionInfo, tVoid** ppData);
 
        tResult GetExtension(tInt nIndex, tFileExtension** ppsExtensionInfo, tVoid** ppData);
 
        tResult AppendExtension(const tChar* strIdentifier,
                                const tVoid* pData,
                                tInt nDataSize,
                                tUInt32 ui32TypeId=0,
                                tUInt32 ui32VersionId=0,
                                tUInt16 ui16StreamId=0,
                                tUInt32 ui32UserId=0);
 
        tResult AppendExtension(const tVoid* pData, const tFileExtension* psExtensionInfo);
 
        tResult FreeExtension(const tChar* strIdentifier);
 
        tResult FreeExtensions();
 
        tResult GetHeader(tFileHeader** ppsFileHeader);
 
    protected:
        virtual tResult Initialize();
 
        tResult AllocBuffer(tInt64 nSize);
 
        tResult FreeBuffer();
 
        tResult AllocHeader();
 
        tResult FreeHeader();
 
        tResult AllocExtensionPage(tFileSize nSize, tVoid** ppData);
 
        tResult SetGUID();
        
        tResult GenerateNewGUID(cString& strGeneratedGUID);
 
    protected:
 
        tResult AllocCache(tInt64 nSize);
 
        tResult FreeCache();
 
        tVoid* GetCacheAddr();
 
        tInt GetSectorSize(const tChar* strFilename) const;
 
        tFileSize GetSizeOnDisk(tFileSize nSize, tBool bUseSegmentSize);
 
        tVoid* InternalMalloc(tInt64 nSize, tBool bUseSegmentSize);
 
        tVoid InternalFree(tVoid* pMemory);
};
 
} // namespace
 
//*************************************************************************************************
#endif // _INDEXEDFILE_CLASS_HEADER_