indexedfile_v201_v301.h

Go to the documentation of this file.

 
#ifndef INDEXEDFILE_V201_V301_CLASS_HEADER
#define INDEXEDFILE_V201_V301_CLASS_HEADER
 
#include <ifhd/v201_v301/indexedfile_types_v201_v301.h>
 
#include <set>
#include <list>
 
namespace ifhd
{
namespace v201_v301
{

 
//*************************************************************************************************
/*
 
    FILE LAYOUT:
 
    +------------------------------------------------------------------------------------+
    |HDR|         DATA         |        EXTENSIONS         |    EXTENSION-HEADER TABLE   |
    +------------------------------------------------------------------------------------+
 
*/

 
//*************************************************************************************************
class IndexedFile;
 
 
 
//*************************************************************************************************
 
class IndexedFile
{
    protected:

        static const uint8_t byte_order;
        static int64_t default_block_size;
        static int64_t default_cache_size;

        utils5ext::File _file;
        FilePos _file_pos;

        uint8_t* _buffer;
        int64_t _buffer_size;
        FileHeader* _file_header;

        bool _write_guid;

        typedef struct
        {
            FileExtension file_extension; 
            std::vector<std::byte> extension_page; 
        } FileExtensionStruct;

        typedef std::list<FileExtensionStruct> FileExtensionList;

        FileExtensionList _extensions;

        void* _cache;
        uint64_t _cache_size;

        bool _write_mode;
 
    public:
        IndexedFile();
        virtual ~IndexedFile();
 

        virtual void close();

        virtual std::set<uint32_t> getSupportedVersions() const;

        void setDescription(const std::string& description);
        std::string getDescription() const;

        std::string getGUID() const;

        a_util::datetime::DateTime getDateTime() const;

        uint8_t getByteOrder() const;

        size_t getExtensionCount() const;

        bool findExtension(const char* identifier, FileExtension** extension_info, void** data) const;

        void getExtension(size_t index, FileExtension** extension_info, void** data) const;

        void appendExtension(const char* identifier,
                             const void* data,
                             size_t data_size,
                             uint32_t type_id=0,
                             uint32_t file_version_id =0,
                             uint16_t stream_id=0,
                             uint32_t user_id=0);

        void appendExtension(const void* data, const FileExtension* extension_info);

        void freeExtensions();

        void getHeaderRef(FileHeader** file_header) const;
 
    protected:
        void setDateTime(const a_util::datetime::DateTime& date_time);
        virtual void initialize();

        void allocBuffer(uint64_t size);

        void freeBuffer();

        void allocHeader();

        void freeHeader();

        void allocExtensionPage(utils5ext::FileSize size, void** data) const;

        void setGUID();

        void generateNewGUID(std::string& generated_guid);
 
    protected:

        void allocCache(int64_t size);

        void freeCache();

        void* getCacheAddr() const;

        void* internalMalloc(size_t size) const;

        void internalFree(void* memory) const;
};
 
} // namespace v400
} // namespace ifhd
 
//*************************************************************************************************
#endif // _INDEXEDFILE_V201_V301_CLASS_HEADER_