ms_cache_file.hpp

/*
##############################################################################
# file: ms_cache_file.hpp                                                  #
# 'msparser' toolkit                                                         #
# Used internally in Mascot Parser as well as being available externally     #
#                                                                            #
##############################################################################
# COPYRIGHT NOTICE                                                           #
# Copyright 1998-2013 Matrix Science Limited  All Rights Reserved.           #
#                                                                            #
##############################################################################
#    $Archive::  $
#     $Author: villek@matrixscience.com $
#       $Date: 2023-02-02 13:47:30 +0000 $
#   $Revision: a80892d71615baa5079d40d1461ed9c24e3bffff | MSPARSER_REL_3_0_0-2024-09-24-0-g93ebaeb4f4 $
# $NoKeywords:: $
##############################################################################
*/
 
#ifndef MS_CACHE_FILE_HPP
#define MS_CACHE_FILE_HPP
 
 
 
// Includes from the standard template library
#include <map>
#include <string>
 
#ifndef SWIG
    // Helper class - don't use from outside library
 
namespace matrix_science {
 
    class ms_cache_stream;
 
    // internal
    struct ms_cache_record
    {
        UINT64 position;
        unsigned length;
 
        inline ms_cache_record()
        {
            position = 0;
            length = 0;
        }
    };
 
    // internal
    class MS_MASCOTRESFILE_API ms_cache_file :
        public ms_errors
    {
        public:
            static const unsigned OPEN_FLAG_READ_ONLY = 1;
 
        public:
            ms_cache_file();
            ~ms_cache_file();
 
            bool open(const std::string & filename, unsigned flags = 0);
            void close();
            bool save();
 
            bool readStream(ms_cache_stream * stream);
            bool writeStream(ms_cache_stream * stream);
            bool deleteStream(ms_cache_stream * stream);
 
            std::string getFileName() const { return filename_; }
 
        private:
            //Do not copy this object
            ms_cache_file(const ms_cache_file & src);
            ms_cache_file& operator=(const ms_cache_file & right);
 
            UINT64 appendPos_;
            INT64 lastAssignedId_;
            unsigned flags_;
            std::string filename_;
            FILE * fileHandle_;
            unsigned version_;
            std::map<INT64, ms_cache_record> recordMap_;
            bool open_;
    }; // end of tools_group
} // matrix_science
 
#endif // SWIG
 
#endif // MS_CACHE_FILE_HPP
 
/*------------------------------- End of File -------------------------------*/