ms_cache_stream.hpp

/*
##############################################################################
# file: ms_cache_stream.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: 2018-07-30 16:23:53 +0100 $
#   $Revision: 1b450440f9c97e1e41d0fc6016a27d68951d4532 | MSPARSER_REL_3_0_0-2024-09-24-0-g93ebaeb4f4 $
# $NoKeywords:: $
##############################################################################
*/
 
#ifndef MS_CACHE_STREAM_HPP
#define MS_CACHE_STREAM_HPP
 
 
 
// Includes from the standard template library
#include <string>
#include <vector>
 
#ifndef SWIG
    // Helper class - don't use from outside library
 
namespace matrix_science
{
    class ms_cache_file;
    class ms_tinycdb;
 
    class MS_MASCOTRESFILE_API ms_cache_stream
    {
        public:
            ms_cache_stream();
            virtual ~ms_cache_stream();
 
            INT64 getId() const;
            void setId(INT64 id);
 
            void clear(); // clear the stream, free up storage
            void reserve(size_t byteCount); // pre-allocate space for copying data into
            unsigned getBytesAvailable() const; // number of bytes currently available for reading
            bool isOverExhausted() const; // true is attempt has been made to read more data than the stream has avaialble
 
            void add(int value); // 4 bytes
            void add(unsigned value); // 4 bytes
            void add(INT64 value); // 8 bytes
            void add(UINT64 value); // 8 bytes
            void add(bool value);  // 4 bytes (yes, really)
            void add(double value); // 8 bytes
            void add(const char * value, size_t length); // 4 byte unsigned length plus n x char (1 byte each), NOT null terminated
            void add(const char * value); // 4 byte unsigned length plus n x char (1 byte each), NOT null terminated
            void add(const std::string & value); // 4 byte unsigned length plus n x char (1 byte each), NOT null terminated
 
            int getInt32();
            unsigned getUnsigned32();
            INT64 getInt64();
            UINT64 getUnsigned64();
            bool getBool();
            double getDouble();
            std::string getString();
 
            void addBytes(const void * bytes, size_t size); // add bytes to the end of the stream
            void getBytes(void * bytes, size_t size); // copy bytes from the stream, extend read position
 
            const char * getBuffer() const;
            unsigned getBufferLength() const;
 
            bool save(matrix_science::ms_tinycdb & cdbFile, const std::string & streamName) const;
 
        private:
            INT64 id_;
            size_t readPosition_;
            std::vector<char> buffer_;
            bool isOverExhausted_;
 
        friend class ms_cache_file;
    };
 
} // matrix_science
 
#endif // SWIG
 
#endif // MS_CACHE_STREAM_HPP
 
/*------------------------------- End of File -------------------------------*/