bytebuffer.h

Go to the documentation of this file.

/* ========================================================================= */
/* ------------------------------------------------------------------------- *//*


 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Please read COPYING and README files in root folder
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*/
/* ------------------------------------------------------------------------- */
/* ========================================================================= */
#ifndef __BYTEBUFFER_INC__
#define __BYTEBUFFER_INC__
//
//
//
//
/*  INCLUDES    ------------------------------------------------------------ */

#include    <libbbb/libbbb.h>
#include    <qglobal.h>
#include    <QDebug>

/*  INCLUDES    ============================================================ */
//
//
//
//
/*  CLASS    --------------------------------------------------------------- */

class   QFile;

namespace bbb   {


class
        BBBSHARED_EXPORT
        ByteBuffer              {

    //
    //
    //
    //
    /*  DEFINITIONS    ----------------------------------------------------- */

#   define  BYTEBUFFER_INCREASE_STEP            256

    /*  DEFINITIONS    ===================================================== */
    //
    //
    //
    //
    /*  DATA    ------------------------------------------------------------ */

private:


    char *      p_;


    unsigned    alloc_;


    unsigned    used_;


    quint64     iterator_;


    bool        err_;




    /*  DATA    ============================================================ */
    //
    //
    //
    //
    /*  FUNCTIONS    ------------------------------------------------------- */

public:


    ByteBuffer          ( void );


    ~ByteBuffer         ( void );


    inline bool         isValid             ( void ) const
    { return ( err_ == false ); }


    inline bool         isEmpty             ( void ) const
    { return ( used_ == 0 ); }


    inline unsigned     allocated           ( void ) const
    { return alloc_; }


    inline unsigned     size                ( void ) const
    { return used_; }


    inline unsigned     count               ( void ) const
    { return used_; }


    inline unsigned     lenght              ( void ) const
    { return used_; }


    inline void         seek                ( quint64 loc )
    { iterator_ = loc; if ( iterator_ > used_ ) iterator_ = 0; }


    inline quint64      position            ( void ) const
    { return iterator_; }


    void                reset               ( void );


    bool                reinitFromFile      ( QFile & file );


    bool                saveToFile          ( QFile & file );


    unsigned            getRaw              ( unsigned bytes )
    {
        char * ret = (char *)reserve( bytes );
        if ( ret == NULL ) return 0;
        return (ret - p_);
    }



    /* ******************************************************************* */
    /* ******************************************************************* */


    inline void         append              ( int new_val )
    {
        qint64 * loc = (qint64*)reserve( sizeof(qint64) );
        if ( loc == NULL ) return;
        *loc = new_val;
    }


    inline void         append              ( unsigned new_val )
    {
        quint64 * loc = (quint64*)reserve( sizeof(quint64) );
        if ( loc == NULL ) return;
        *loc = new_val;
    }


    inline void         append              ( quint64 new_val )
    {
        quint64 * loc = (quint64*)reserve( sizeof(quint64) );
        if ( loc == NULL ) return;
        *loc = new_val;
    }


    inline void         append              ( qint64 new_val )
    {
        qint64 * loc = (qint64*)reserve( sizeof(qint64) );
        if ( loc == NULL ) return;
        *loc = new_val;
    }


    inline void         append              ( bool new_val )
    {
        quint64 * loc = (quint64*)reserve( sizeof(quint64) );
        if ( loc == NULL ) return;
        *loc = new_val;
    }


    inline void         append              ( double new_val )
    {
        double * loc = (double*)reserve( sizeof(double) );
        if ( loc == NULL ) return;
        *loc = new_val;
    }


    void                append              ( const QString & new_val );


    void                append              (
            const char *        new_val,
            int                 len = -1,
            bool                uncounted = false
            );


    /* ******************************************************************* */


    /* ******************************************************************* */
    /* ******************************************************************* */


    bool                getValue            ( bool & out_val, quint64 offset );


    quint64             getValue            ( char * out_val, int max_buf, quint64 offset );


    bool                getValue            ( quint64 offset, int count, char * out_val );


    bool                getValue            ( char ** out_val, quint64 offset );


    bool                getValue            ( double & out_val, quint64 offset );


    bool                getValue            ( int & out_val, quint64 offset );


    bool                getValue            ( qint64 & out_val, quint64 offset );


    bool                getValue            ( QString & out_val, quint64 offset );


    bool                getValue            ( quint64 & out_val, quint64 offset );


    bool                getValue            ( unsigned & out_val, quint64 offset );

    /* ******************************************************************* */



    /* ******************************************************************* */
    /* ******************************************************************* */


    inline bool         getValue            ( int & out_val )
    { return getValue( out_val, iterator_ ); }


    inline bool         getValue            ( unsigned & out_val )
    { return getValue( out_val, iterator_ ); }


    inline bool         getValue            ( qint64 & out_val )
    { return getValue( out_val, iterator_ ); }


    inline bool         getValue            ( quint64 & out_val )
    { return getValue( out_val, iterator_ ); }


    inline bool         getValue            ( bool & out_val )
    { return getValue( out_val, iterator_ ); }


    inline bool         getValue            ( double & out_val )
    { return getValue( out_val, iterator_ ); }


    inline bool         getValue            ( QString & out_val )
    { return getValue( out_val, iterator_ ); }


    inline bool         getValue            ( char ** out_val )
    { return getValue( out_val, iterator_ ); }


    inline quint64      getValue            ( char * out_val, int max_buf )
    { return getValue( out_val, max_buf, iterator_ ); }


    inline bool         getValue            ( int count, char * out_buf )
    { return getValue( iterator_, count, out_buf ); }


    inline bool         readUncountedBytes  ( int count, char * out_buf )
    { return getValue( iterator_, count, out_buf ); }



    /* ******************************************************************* */



private:


    void *              reserve             ( unsigned bytes );


    inline void         markError           ( void )
    { Q_ASSERT( false ); err_ = true; }


    inline void         markErrorFree       ( void )
    { err_ = false; }






    /*  FUNCTIONS    ======================================================= */
    //
    //
    //
    //

};  /*  class ByteBuffer    */

/*  CLASS    =============================================================== */
//
//
//
//

}   //  namespace   bbb

#endif // __BYTEBUFFER_INC__
/* ------------------------------------------------------------------------- */
/* ========================================================================= */