april_debug.h

Go to the documentation of this file.

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


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

/* we make sure we have the user settings before this file */
#include    <april/april_global.h>
#include    <april/april_config.h>

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


enum    APRDBG_Codes        {
    APRDBG_CTORDTOR,    /* all constructors and destructors */
    APRDBG_V_CTORDTOR,  /* constructors and destructors called a lot */
    APRDBG_LIBRARY,     /* library in general */
    APRDBG_MW,          /* main window of an application */

    APRDBG_F,           /* factory */
    APRDBG_A,           /* actor */
    APRDBG_FA,          /* actor factory */
    APRDBG_ACMP,        /* actor component */
    APRDBG_AT,          /* actuator */
    APRDBG_FAT,         /* actuator factory */
    APRDBG_B,           /* brain */
    APRDBG_FB,          /* brain factory */
    APRDBG_COMP,        /* component */
    APRDBG_DIR,         /* director */
    APRDBG_DNA,         /* DNA */
    APRDBG_DNAV,        /* DNA View*/
    APRDBG_ED,          /* event data */
    APRDBG_EL,          /* event line */
    APRDBG_ES,          /* event source */
    APRDBG_FES,         /* event source factory */
    APRDBG_R,           /* reflex */
    APRDBG_FR,          /* reflex factory */
    APRDBG_S,           /* sensor */
    APRDBG_FS,          /* sensor factory */
    APRDBG_W,           /* world */
    APRDBG_FW,          /* world factory */
    APRDBG_UID,         /* unique id */

    APRDBG_MAX
};


#ifndef ENABLE_LOGGING
#   ifndef QT_NO_DEBUG

#       define  ENABLE_LOGGING  1

#   else

#       define  ENABLE_LOGGING  0

#   endif
#endif

#if ENABLE_LOGGING
#   include <QDebug>

/* IS_APRIL_DEBUG_ID_ALLOWED should be defined in LIBAPRIL_config.h */
#ifndef IS_APRIL_DEBUG_ID_ALLOWED

#   define  IS_APRIL_DEBUG_ID_ALLOWED( id ) false

#endif

#   define APRDBG(id,txt)   \
    if ( IS_APRIL_DEBUG_ID_ALLOWED( id ) ) \
    qDebug() << april::debugName(id) << ": " << txt
#   define APRDBG2(id,txt1,txt2)    \
    if ( IS_APRIL_DEBUG_ID_ALLOWED( id ) ) \
    qDebug() << april::debugName(id) << ": " << txt1 << txt2
#   define APRDBG3(id,txt1,txt2,txt3)   \
    if ( IS_APRIL_DEBUG_ID_ALLOWED( id ) ) \
    qDebug() << april::debugName(id) << ": " << txt1 << txt2 << txt3
#   define APRDBG_FUNC(id)  APRDBG(id, __func__ )
#   define APRDBG_CDTOR     APRDBG2(APRDBG_CTORDTOR, __func__, this )



#else


#   define APRDBG(id,txt)
#   define APRDBG2(id,txt1,txt2)
#   define APRDBG3(id,txt1,txt2,txt3)
#   define APRDBG_FUNC(id)
#   define APRDBG_CDTOR

#endif





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

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

namespace   april   {

APRILSHARED_EXPORT  const char *        debugName           ( int i );

APRILSHARED_EXPORT  bool                filterDebug         ( int i );

}

/*  FUNCTIONS    =========================================================== */
//
//
//
//
#endif // __APRIL_DEBUG_INC__
/* ------------------------------------------------------------------------- */
/* ========================================================================= */