MHO_BinaryFileStreamer.hh

Go to the documentation of this file.

#ifndef MHO_BinaryFileStreamer_HH__
#define MHO_BinaryFileStreamer_HH__
 
#include <complex>
#include <cstddef>
#include <fstream>
#include <iostream>
#include <stdint.h>
#include <stdio.h>
#include <string>
#include <vector>
 
#include "MHO_FileStreamer.hh"
#include "MHO_JSONHeaderWrapper.hh"
#include "MHO_Types.hh"
 
namespace hops
{
 
//forward declare our binary data streamer (for plain old data types ((POD))
class MHO_BinaryFileStreamer;
 
template< typename XValueType > class MHO_BinaryFileStreamerSingleType
{
    public:
        MHO_BinaryFileStreamerSingleType(){};
        virtual ~MHO_BinaryFileStreamerSingleType(){};
 
        friend inline MHO_BinaryFileStreamer& operator>>(MHO_BinaryFileStreamerSingleType< XValueType >& s, XValueType& obj)
        {
            //TODO flag this for big-endian machines
            s.GetStream().read(reinterpret_cast< char* >(&obj), sizeof(XValueType));
            return s.Self();
        }
 
        friend inline MHO_BinaryFileStreamer& operator<<(MHO_BinaryFileStreamerSingleType< XValueType >& s,
                                                         const XValueType& obj)
        {
            //TODO flag this for big-endian machines
            s.GetStream().write(reinterpret_cast< const char* >(&obj), sizeof(XValueType));
            s.AddBytesWritten(sizeof(XValueType));
            return s.Self();
        }
 
        virtual std::fstream& GetStream() = 0;
 
        virtual void ResetByteCount() = 0;
 
        virtual void AddBytesWritten(uint64_t) = 0;
 
        virtual uint64_t GetNBytesWritten() const = 0;
 
    protected:
        virtual MHO_BinaryFileStreamer& Self() = 0;
};
 
template<> class MHO_BinaryFileStreamerSingleType< std::string >
{
    public:
        MHO_BinaryFileStreamerSingleType(){};
        virtual ~MHO_BinaryFileStreamerSingleType(){};
 
        //read in
        friend inline MHO_BinaryFileStreamer& operator>>(MHO_BinaryFileStreamerSingleType< std::string >& s, std::string& obj)
        {
            uint64_t size;
            s.GetStream().read(reinterpret_cast< char* >(&size), sizeof(uint64_t));
            obj.resize(size);
            s.GetStream().read(&obj[0], size);
            return s.Self();
        }
 
        //write out
        friend inline MHO_BinaryFileStreamer& operator<<(MHO_BinaryFileStreamerSingleType< std::string >& s,
                                                         const std::string& obj)
        {
            uint64_t size = obj.size();
            s.GetStream().write(reinterpret_cast< const char* >(&size), sizeof(uint64_t));
            s.GetStream().write(obj.c_str(), size);
 
            s.AddBytesWritten(sizeof(uint64_t));
            s.AddBytesWritten(size);
            return s.Self();
        }
 
        virtual std::fstream& GetStream() = 0;
 
        virtual void ResetByteCount() = 0;
        virtual void AddBytesWritten(uint64_t) = 0;
        virtual uint64_t GetNBytesWritten() const = 0;
 
    protected:
        virtual MHO_BinaryFileStreamer& Self() = 0;
};
 
template<> class MHO_BinaryFileStreamerSingleType< mho_json >
{
    public:
        MHO_BinaryFileStreamerSingleType(){};
        virtual ~MHO_BinaryFileStreamerSingleType(){};
 
        //read in
        friend inline MHO_BinaryFileStreamer& operator>>(MHO_BinaryFileStreamerSingleType< mho_json >& s, mho_json& obj)
        {
            uint64_t size;
            uint64_t encoding;
            s.GetStream().read(reinterpret_cast< char* >(&size), sizeof(uint64_t));
            s.GetStream().read(reinterpret_cast< char* >(&encoding), sizeof(uint64_t));
            std::vector< std::uint8_t > data;
            data.resize(size);
            s.GetStream().read(reinterpret_cast< char* >(&(data[0])), size);
            //TODO FIXME - Add the ability to support other JSON encodings besides CBOR
            //now decode from CBOR
            if(encoding == 0)
            {
                obj = mho_json::from_cbor(data);
            }
            return s.Self();
        }
 
        //write out
        friend inline MHO_BinaryFileStreamer& operator<<(MHO_BinaryFileStreamerSingleType< mho_json >& s, const mho_json& obj)
        {
 
            std::vector< std::uint8_t > data = mho_json::to_cbor(obj);
            uint64_t size = data.size();
            //must encode to CBOR
            //TODO FIXME - Add the ability to support other JSON encodings
            uint64_t encoding = 0; //CBOR is 0
            s.GetStream().write(reinterpret_cast< const char* >(&size), sizeof(uint64_t));
            s.GetStream().write(reinterpret_cast< const char* >(&encoding), sizeof(uint64_t));
            s.GetStream().write(reinterpret_cast< const char* >(&(data[0])), size);
            s.AddBytesWritten(sizeof(uint64_t));
            s.AddBytesWritten(sizeof(uint64_t));
            s.AddBytesWritten(size);
            return s.Self();
        }
 
        virtual std::fstream& GetStream() = 0;
 
        virtual void ResetByteCount() = 0;
        virtual void AddBytesWritten(uint64_t) = 0;
        virtual uint64_t GetNBytesWritten() const = 0;
 
    protected:
        virtual MHO_BinaryFileStreamer& Self() = 0;
};
 
template< typename... XValueTypeS > class MHO_BinaryFileStreamerMultiType;
 
template< typename XValueType >
class MHO_BinaryFileStreamerMultiType< XValueType >: public MHO_BinaryFileStreamerSingleType< XValueType >
{};
 
template< typename XValueType, typename... XValueTypeS >
class MHO_BinaryFileStreamerMultiType< XValueType, XValueTypeS... >: public MHO_BinaryFileStreamerMultiType< XValueType >,
                                                                     public MHO_BinaryFileStreamerMultiType< XValueTypeS... >
{};
 
//construct the multi-type streamer for most basic POD types and some vectors
typedef MHO_BinaryFileStreamerMultiType< bool, char, unsigned char, short, unsigned short, int, unsigned int, long,
                                         unsigned long, long long, unsigned long long, float, double, long double,
                                         std::complex< float >, std::complex< double >, std::complex< long double >,
                                         std::string, mho_json >
    MHO_BinaryFileStreamerBasicTypes;
 
class MHO_BinaryFileStreamer: public MHO_FileStreamer, public MHO_BinaryFileStreamerBasicTypes
{
    public:
        MHO_BinaryFileStreamer() { fNBytesWritten = 0; };
 
        virtual ~MHO_BinaryFileStreamer(){};
 
        virtual void OpenToRead() override;
 
        virtual void OpenToWrite() override;
 
        virtual void OpenToAppend() override;
 
        virtual void Close() override;
 
        virtual std::fstream& GetStream() override { return MHO_FileStreamer::GetStream(); }
 
        virtual const std::fstream& GetStream() const override { return MHO_FileStreamer::GetStream(); }
 
        virtual void ResetByteCount() override { fNBytesWritten = 0; }
 
        virtual void AddBytesWritten(uint64_t b) override { fNBytesWritten += b; }
 
        virtual uint64_t GetNBytesWritten() const override { return fNBytesWritten; };
 
    protected:
        uint64_t fNBytesWritten;
 
        MHO_BinaryFileStreamer& Self() override { return *this; }
};
 
} // namespace hops
 
#endif