refcnt.h

Go to the documentation of this file.

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


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

#include    <libbbb/libbbb.h>

#ifdef  REFCNT_DEBUG
#include    <QMap>
#include    <QString>
#endif

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

namespace   bbb    {

#define REMOVE_CONSTRUCTOR_REF(p)   p->decRef()

#ifdef  REFCNT_DEBUG

#   define  INC_REF(p,o)            p->incRef(o, \
    QString("Set owner %4 in %3 in file: %1, line %2")\
    .arg( __FILE__ ) \
    .arg( __LINE__ ) \
    .arg( __func__ ) \
    .arg( (quint64)o ) )

#   define  DEC_REF(p,o)            p->decRef( o )

#   define  OWN_REF(p,crto,newo)    p->changeRefOwner( crto, newo, \
    QString("Owner changed from %4 to %5 in %3 in file: %1, line %2")\
    .arg( __FILE__ ) \
    .arg( __LINE__ ) \
    .arg( __func__ ) \
    .arg( (quint64)crto ) \
    .arg( (quint64)newo ) )

#   define  OWN_CREF(p,newo)        p->changeRefOwner( static_cast<libbbb::RefCnt*>(p), newo, \
    QString("Owner changed from %4 to %5 in %3 in file: %1, line %2") \
    .arg( __FILE__ ) \
    .arg( __LINE__ ) \
    .arg( __func__ ) \
    .arg( (quint64)static_cast<libbbb::RefCnt*>(p) ) \
    .arg( (quint64)newo ) )

#else

#   define  INC_REF(p,o)        p->incRef()

#   define  DEC_REF(p,o)        p->decRef()

#   define  OWN_REF(p,crto, newo)

#   define  OWN_CREF(p,newo)


#endif

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

class
        BBBSHARED_EXPORT
        RefCnt              {

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

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

private:

    unsigned int            reference_cnt_;

#ifdef  REFCNT_DEBUG

    QMap<void*,QString>     ref_list_;

#endif

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

public:


    RefCnt              ( void );


protected:


    virtual             ~RefCnt     ( void );


public:


    void                incRef      ( void )
    { reference_cnt_++; }


    void                decRef      ( void );

    
    unsigned int        referenceCount (void )
    { return reference_cnt_; }


#ifdef  REFCNT_DEBUG

    void                incRef      ( void * owner, const QString & s_descr );

    void                decRef      ( void * owner );

    void                changeRefOwner      (
            void *              current_owner,
            void *              new_owner,
            QString             s_descr
            );

    void                printRefMap ( void );

#endif


    void                forceDelete ( void )
    { reference_cnt_ = 0; delete this; }


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

};  /*  class RefCnt    */

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

}   //  namespace   bbb

#endif // __REFCNT_INC__
/* ------------------------------------------------------------------------- */
/* ========================================================================= */