OMKTracer.h

Go to the documentation of this file.

/***************************************************************************
*   Copyright (C) 2006 by Benoit Chanclou,bunraku   *
*   bchanclo@irisa.fr   *
*                                                                         *
*   This program is free software; you can redistribute it and/or modify  *
*   it under the terms of the GNU General Public License as published by  *
*   the Free Software Foundation; either version 2 of the License, or     *
*   (at your option) any later version.                                   *
*                                                                         *
*   This program is distributed in the hope that it will be useful,       *
*   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
*   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
*   GNU General Public License for more details.                          *
*                                                                         *
*   You should have received a copy of the GNU General Public License     *
*   along with this program; if not, write to the                         *
*   Free Software Foundation, Inc.,                                       *
*   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
***************************************************************************/

#ifndef OMK_TRACER_H
#define OMK_TRACER_H

#include "OBTTrace.h"
#include "OMKOpenMASK.h"
#include "OMKException.h"


// We use defines instead of static constants because, those ones are defined 
// after some other static variables which use trace. So they are not defined 
// when the trace are made, thus there is a crash.
#define OMK_DEBUG_WARNING "WARNING"
#define OMK_DEBUG_FATAL_ERROR "FATAL ERROR"
#define OMK_DEBUG_ERROR "ERROR"
#define OMK_DEBUG_MESSAGE "MESSAGE"
#define OMK_DEBUG_OMK "Kernel"
#define OMK_DEBUG_OMK_EXEC "Kernel:Stack"
#define OMK_DEBUG_OMK_OBJ "Kernel:Object"
#define OMK_DEBUG_OMK_POL "Kernel:Polator"
#define OMK_DEBUG_OMK_NAME "Kernel:Name"
#define OMK_DEBUG_OMK_EVENT "Kernel:Event"
#define OMK_DEBUG_OMK_MULTI "Kernel:Multi"
#define OMK_DEBUG_OMK_EXT "Kernel:Extension"
#define OMK_DEBUG_OMK_ATTR "Kernel:Attribute"
#define OMK_DEBUG_OMK_TYPE "Kernel:Type"
#define OMK_DEBUG_INP_EXT "Input:Extension"
#define OMK_DEBUG_VIS "Vis"
#define OMK_DEBUG_VIS_EXEC "Vis:Stack"
#define OMK_DEBUG_III "Iii"
#define OMK_DEBUG_INP "Inp"
#define OMK_DEBUG_PVM "PVM"




namespace OMK
{
  class SimulatedObject ;
        class Extension ;
        class IAttribute ;
        class ExtensibleSimulatedObject ;

        //=============================================================================
        class OMK_API TracerIdTmp 
        {
        public:
                TracerIdTmp( const char* id ) ;
                ~TracerIdTmp() ;
        private:
                bool _unregisterId ;
                std::string _id ;
        };


        std::string OMK_API getAttrOwnerMsg( const IAttribute* attr ) ;






        std::string OMK_API debugMsg( const SimulatedObject* obj ) ;
        std::string OMK_API debugMsg( const Extension* ext, ExtensibleSimulatedObject* obj = 0 ) ;
        std::string OMK_API debugMsg( const IAttribute* attr ) ;
}

// Undefined the previous definition of OMERROR
# ifdef OMERROR
# undef OMERROR
# endif
// Define the OMERROR macro
# define OMERROR(X) TRACE( OMK_DEBUG_ERROR, X )

// Undefined the previous definition of OMMESSAGE
# ifdef OMMESSAGE
# undef OMMESSAGE
# endif
// Define the TRACE macro
# define OMMESSAGE(X) TRACE( OMK_DEBUG_MESSAGE, X )

# ifdef OMFATALERROR
# undef OMFATALERROR
# endif
# define OMFATALERROR(X) \
std::ostringstream msgForDebugTrace ; \
msgForDebugTrace << X ; \
TRACE( OMK_DEBUG_FATAL_ERROR, msgForDebugTrace.str() ) ; \
  throw OMK::Exception( msgForDebugTrace.str().c_str() ) ;

// Undefined the previous definition of TRACE
# ifdef OMTRACE
# undef OMTRACE
# endif
// Define the TRACE macro
# define OMTRACE(X) TRACE( OMK_DEBUG_WARNING, X )

// Undefined the previous definition of TRACE
# ifdef OMTRACEID
# undef OMTRACEID
# endif
// Define the TRACE macro
# define OMTRACEID(ID,X) TRACE( ID, X )

#if defined NDEBUG
// in non debug mode, nothing to do 
# ifndef OMASSERT
#   define OMASSERT(X) void()
# endif
# ifndef OMASSERTM
#   define OMASSERTM(TEST,X) void()
# endif

#else // !NDEBUG
// In debug mode

// Undefined the previous definition of OMASSERT
# ifdef OMASSERT
#   undef OMASSERT
# endif
// Define the OMASSERT macro
#   define OMASSERT(X) \
        if( !(X) ) \
{ \
        std::ostringstream msgForDebugASSERT ; \
        msgForDebugASSERT << #X ; \
        OMTRACEID( OMK_DEBUG_FATAL_ERROR, msgForDebugASSERT.str() ) ; \
  throw OMK::Exception( msgForDebugASSERT.str().c_str() ) ; \
}

#   define OMASSERTM(TEST, X) \
        if( !(TEST) ) \
{ \
        std::ostringstream msgForDebugASSERTM ; \
        msgForDebugASSERTM << #TEST << std::endl << X ; \
        OMTRACEID( OMK_DEBUG_FATAL_ERROR, msgForDebugASSERTM.str() ) ; \
  throw OMK::Exception( msgForDebugASSERTM.str().c_str() ) ; \
}

#endif // !NDEBUG

#endif // !OMK_TRACER_H

---