varmap.h

Go to the documentation of this file.

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


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

#include    <QMap>
#include    <QString>
#include    <QStringList>
#include    "vardata.h"

/*  INCLUDES    ============================================================ */
//
//
//
//
/*  DEFINITIONS    --------------------------------------------------------- */

namespace   bbb    {

/*  DEFINITIONS    ========================================================= */
//
//
//
//
/*  CLASS    --------------------------------------------------------------- */

class
        BBBSHARED_EXPORT
        VarMap              {

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

public:
    
    typedef QMap<QString, VarData*> vmap;

    typedef QMap<QString, VarData*>::iterator iterator;

    enum    UniteType   {
        FavorMine,
        FavorOther,
        AppendOther
    };

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

protected:

    vmap            vars_;

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

public:


    VarMap          ( void );

    virtual         ~VarMap         ( void );

    void            add             ( VarData * vd );

    int             count           ( void ) const
    { return vars_.count(); }
    
    int             count           ( const QString & s_name ) const;
    
    void            clear           ( void );

    void            clear           ( const QString & s_name );
    
    bool            delVar          ( const QString & s_name );
    
    QStringList     names           ( void ) const
    { return vars_.keys(); }
    
    iterator        begin           ( void )
    { return vars_.begin(); }
    
    iterator        end             ( void )
    { return vars_.end(); }

    
    
    /* -------------------------------------------------------------------- */

    
    void            setValue            ( const QString & s_name, const QStringList & sl );

    void            setValue            ( const QString & s_name, QString s, int index = 0 );

    void            setValue            ( const QString & s_name, qint64 i, int index = 0 );

    void            setValue            ( const QString & s_name, bool b, int index = 0 );

    void            setValue            ( const QString & s_name, double d, int index = 0 );
    
    void            appendValue         ( const QString & s_name, QString s );

    void            appendValue         ( const QString & s_name, qint64 i );

    void            appendValue         ( const QString & s_name, bool b );

    void            appendValue         ( const QString & s_name, double d );

    void            append              ( const QString & s_name, const QStringList & sl );

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

    
    bool            contains        ( const QString & s_name ) const
    { return vars_.contains( s_name ); }

    VarData *       value           ( const QString & s_name ) const
    { return vars_.value( s_name ); }

    VarData *       sureValue       ( const QString & s_name );

    QString         valueS          ( const QString & s_name, int i = 0 ) const
    { 
        VarData * vd = vars_.value( s_name );
        if ( ( vd == NULL ) || ( vd->count() == 0 ) )   {
            return QString();
        } else {
            return vd->value( i );
        }
    }

    QStringList     valueSL         ( const QString & s_name ) const
    { 
        VarData * vd = vars_.value( s_name );
        if ( vd == NULL )   {
            return QStringList();
        } else {
            const QStringList & sl = vd->valueSL();
            return sl;
        }
    }
    
    /* ==================================================================== */

    
    /* -------------------------------------------------------------------- */

    
    bool            isInteger           ( const QString & s_name, int i = 0 ) const;

    bool            isDouble            ( const QString & s_name, int i = 0 ) const;

    bool            isBool              ( const QString & s_name, int i = 0 ) const;

    qint64          toInteger           ( const QString & s_name, bool * b_ok = NULL, int i = 0 ) const;

    double          toDouble            ( const QString & s_name, bool * b_ok = NULL, int i = 0 ) const;

    bool            toBool              ( const QString & s_name, bool * b_ok = NULL, int i = 0 ) const;
    
    /* ==================================================================== */


    
    void            unite               ( const VarMap & other, UniteType ut = FavorOther );
    
    void            extendToFit         ( const QString & s_name, int i );
    

    static QStringList  toNamespaceList ( const QString & s );
    
    
    
    /*  FUNCTIONS    ======================================================= */
    //
    //
    //
    //

};  /*  class VarMap    */

/*  CLASS    =============================================================== */
//
//
//
//
}   //  namespace   bbb

#endif // __VARMAP_INC__
/* ------------------------------------------------------------------------- */
/* ========================================================================= */