UT/UT_Debug.h

Go to the documentation of this file.

#ifndef __UT_Debug__
#define __UT_Debug__

#include "UT_API.h"
/*
//  This is a convenience class for adding debugging code to your
//  source. It allows the use of run-time switches via environment
//  variables and can be compiled out by not defining the pre-processor
//  symbol UT_DEBUG.
//
//  Typical use of this class involves declaring a static variable of
//  type UT_Debug with the name of an environment variable switch that
//  will enable this object. Then use it as follows:
//  
//  static UT_Debug     debug("UT_DEBUG_THIS");
//  ...
//  if( debug.on() )
//      debug.output("This is %x\n", this);
*/

//  It's UGLY but... 

#ifdef UT_DEBUG

#include <stdlib.h>
#include <string.h>

#define UT_IF(s)        s
#define UT_IFNOT(s)
#define UT_IFELSE(t, f) t

class UT_API UT_Debug
{
public:
    explicit UT_Debug(const char *name) { myState = getenv(name) != 0; }
    int         on() const      { return myState; }
    void        setDebugFile(const char *) const;
    void        output(const char *fmt, ...) const;
private:
    int         myState;
};

#else

#define UT_IF(s)
#define UT_IFNOT(s)     s
#define UT_IFELSE(t, f) f

class UT_API UT_Debug
{
public:
    explicit UT_Debug(const char *)                      {}
    int         on() const                       { return 0; }
    void        setDebugFile(const char *) const;
    void        output(const char *, ...) const;
};

#endif

// this macro must be used with a double parentheses!
// eg. UT_DBGOUT(( "value = %d", myValue ));
#ifdef UT_DEBUG
    #include <stdio.h>

    #define UT_DBGOUT(ZZ)   { \
                                const char *basename = strrchr(__FILE__, '/'); \
                                if (!basename)  basename = __FILE__; \
                                else            basename++; \
                                printf( "%s(%d): ", basename, __LINE__ ); \
                                printf ZZ ; \
                                printf( "\n" ); \
                            }
    #define UT_DBGPRINTF(ZZ)    printf ZZ
    #define UT_DBG_CHECKMEMORY  UTdebugCheckMemory()
#else
    #define UT_DBGOUT(ZZ)
    #define UT_DBGPRINTF(ZZ)
    #define UT_DBG_CHECKMEMORY  
#endif

// UTgetSESIlogFlag will use UT_ASSERT_LEVEL >= 1 to check if it should be
// enabled. If we don't have sufficient assertion level, then the appropriate
// environment variable passed in will be used instead.
// Note that it uses a UT_Symbol table to keep track of the different vars. 
// So it shouldn't be terribly inefficient to call multiple times.

UT_API int UTgetSESIlogFlag(int env_control);


// UTisSESImachine will efficiently check the IP address of this computer to
// see if it is one of SESI's IP addresses and returns 1 if so.
// WARNING: This can register false positive on customer machines
// as we have 192.168s listed...
UT_API int UTisSESImachine();

UT_API int UTdebugCheckMemory();

#endif /* __UT_Debug__ */

---