ms_tinycdb.hpp

/*
##############################################################################
# file: ms_tinycdb.hpp                                                      #
# 'msparser' toolkit                                                         #
# Used internally in Mascot Parser as well as being available externally     #
#                                                                            #
##############################################################################
# COPYRIGHT NOTICE                                                           #
# Copyright 1998-2009 Matrix Science Limited  All Rights Reserved.           #
#                                                                            #
##############################################################################
#    $Archive:: /MowseBranches/ms_mascotresfile_1.2/include/ms_mascotresfi $ #
#     $Author: villek@matrixscience.com $ #
#       $Date: 2018-07-30 16:23:53 +0100 $ #
#   $Revision: 1b450440f9c97e1e41d0fc6016a27d68951d4532 | MSPARSER_REL_2_8_1-0-gea32989045 $ #
# $NoKeywords::                                                            $ #
##############################################################################
*/

#ifndef MS_TINYCDB_HPP
#define MS_TINYCDB_HPP



// Includes from the standard template library
#include <string>
#include <vector>

// These values are the key names for special cases
// User defined keys must not begin with "=0."
#define CDBIDX_DUPE_ACCESSION   "=0.1"
#define CDBIDX_VERSION          "=0.2"
#define CDBIDX_FILE_TOO_LARGE   "=0.3"
#define CDBIDX_SRC_FILE_SIZE    "=0.4"
#define CDBIDX_SRC_FILE_DATE    "=0.5"
#define CDBIDX_BUGFIX_10627     "=0.6"


// Need to be a bit less than 2Gb / 4Gb so that we can write the error strings...
#define MAX_CDB_SIZE                 (OFFSET64_C(0xFFFFFFFFFFFF) - OFFSET64_C(0x1000000)) // 281,474,959,933,439 = 256 TB
#define MAX_CDB_SIZE_STR             "256TB"
#define OLD_MAX_CDB_SIZE_STR_4GB     "4Gb"
#define OLD_MAX_32_BIT_CDB_SIZE      (0x7FFFFFFF - 0x1000000)
#define OLD_MAX_32_BIT_CDB_SIZE_STR  "2Gb"


// Forward declarations, so no need to include cdb.h
struct cdb;
struct cdb_make;


namespace matrix_science {



    class MS_MASCOTRESFILE_API ms_tinycdb : public ms_errors
    {
        public:
            ms_tinycdb(const char * indexFileName,
                       const char * versionNumber, 
                       const char * sourceFileName);

            ~ms_tinycdb();


            std::string getIndexFileName() const;

            void setIndexFileName(const char * filename);

            bool openIndexFile(const bool mayRetryBuilding);

            void closeIndexFile();

            bool isPossibleToCreate() const;

            bool isOpenForReading() const;

            bool isCreating() const;

            bool prepareToCreate();

            bool saveValueForKey(const char * keyName, 
                                 const char * value,
                                 const unsigned int keyNameLen = 0,
                                 const unsigned int valueLen = 0);

            bool finishCreate();

            std::string getValueFromKey(const std::string & keyName, const int count = 0);

            std::vector<std::string> getAllValuesFromKey(const std::string & keyName);

            OFFSET64_T getFileOffsetFromKey(const std::string & keyName);

            bool saveFileOffsetForKey(const std::string & keyName, OFFSET64_T offset);

            int getIntFromKey(const std::string & keyName);

            int getIntFromKey(const std::string & keyName, bool & found);

            bool saveIntForKey(const std::string & keyName, int value);

            int makeExists(const char * key) const;


        protected:  
            // Not safe to copy or assign this object.
            ms_tinycdb(const ms_tinycdb & rhs);
#ifndef SWIG
            ms_tinycdb & operator=(const ms_tinycdb & rhs);
#endif
        private:
            std::string  indexFileName_;
            std::string  versionNumber_;
            std::string  sourceFileName_;
            bool         isPossibleToCreate_;
            int          fdCDB_;
            struct cdb      * cdb_;
            struct cdb_make * cdbm_;
            bool         creatingCDB_;
            OFFSET64_T   calcFileSize_;
            bool         addKeyErrorReported_;
            bool         tooLargeErrorReported_;
            bool         cdbInitOK_;

            bool lockFile(int hFile);
            bool unlockFile(int hFile);
    }; // end of tools_group
} // matrix_science

#endif // MS_TINYCDB_HPP

/*------------------------------- End of File -------------------------------*/