debug.h

Go to the documentation of this file.

#ifndef DEBUG_H
#define DEBUG_H

#ifndef PP_H
#include "pp.h"
#endif
#include <stdarg.h>

#ifdef MSVC

#define ppFileLine(txt)     __FILE__ "(" ppTokStr(__LINE__) ") : " txt
#else

#define ppFileLine(txt)     __FILE__ ":" ppTokStr(__LINE__) ": " txt
#endif


/* Some conditional macros for release versus debug mode */
#ifdef NDEBUG

#define ppRelease(v)        v

#define ppDebug(v)

#define ppReleaseParam(v)   , v

#define ppDebugParam(v)

#define ppDebRel(deb,rel)   rel

#else

#define ppRelease(v)        
#define ppDebug(v)          v
#define ppReleaseParam(v)
#define ppDebugParam(v)     , v
#define ppDebRel(deb,rel)   deb

#endif /*NDEBUG*/

#ifndef throwassert /* Allow throwassert to be replaced by predefining it */

#ifdef _MSC_VER /* Microsoft's inline assembly */
#define throwassert(sz)     ppDebug( { trace(( "%s\n", ppFileLine(sz) )); __asm { int 3 } } )
#else   /* GNU's inline assembly */
#define throwassert(sz)     ppDebug( { trace(( "%s\n", ppFileLine(sz) )); __asm__("int3"); } ) /*assert(false) */
#endif
#endif

#ifndef isdebugger  /* Allow isdebugger to be replaced by predefining it */
#define isdebugging()       ppDebug( _isdebugging() )
#endif 
#ifndef assert      /* Allow assert to be replaced by predefining it */

#define assert(e)           ppDebug( { if( !(e) ) throwassert(#e); } )
#endif
#ifndef assertptr   /* Allow assertptr to be replaced by predefining it */

#define assertptr(p,len)    assert( _checkptr((p),(len),1) )
#endif
#ifndef assertconst

#define assertconst(p,len)  assert( _checkconst((p),(len),1) )
#endif
#ifndef assertobjptr    /* Allow assertptr to be replaced by predefining it */

#define assertobjptr(p)     assert( _checkptr((p),sizeof(*(p)),min(4,sizeof(*(p)))) )
#endif
#ifndef assertcodeptr   /* Allow assertptr to be replaced by predefining it */

#define assertobjconst(p)   assert( _checkconst((p),sizeof(*(p)),min(4,sizeof(*(p)))) )
#endif
#ifndef assertcodeptr   /* Allow assertptr to be replaced by predefining it */

#define assertcodeptr(p)    assert( _checkcall( p ) )
#endif

#ifndef trace

#define trace(args)     ppDebug( debug_trace args )
#endif
#ifndef traceline

#define traceline(args) ppDebug( { debug_trace("%s\n", ppFileLine(ppNULL) ); debug_trace args; } )
#endif 


ppCPP(extern "C" {)

typedef int (*debug_vlog_t)( const char*, va_list );
void debug_setvlog( debug_vlog_t debug_vlog );
void debug_setlogmask( unsigned mask );
unsigned debug_getlogmask(void);
void debug_log( unsigned mask, const char* fmt, ... );
void debug_vlog( unsigned mask, const char* fmt, va_list args );
void debug_logalways(const char* fmt, ... );
void debug_vlogalways(const char* fmt, va_list args );
#define LOG debug_log
void debug_loghex( unsigned mask, const void* ptr, size_t size );
#define LOG_ERROR       0
#define LOG_STARTUP     1
#define LOG_WARNING     2
#define LOG_SECURITY    4
#define LOG_INFO        8
#define LOG_PROFILE     16

#ifdef NDEBUG
#define debug_settrace(fp)
#else /*NDEBUG*/

typedef int (*debug_trace_t)(const char*,...);
void debug_settrace( debug_trace_t trace );
#ifndef DEBUG_C
extern const debug_trace_t debug_trace;
#endif
/* Little helper functions to keep OS dependent junk out of most of the code */
int _checkptr( void* p, size_t len, size_t align );
int _checkconst( const void* p, size_t len, size_t align );
int _checkcall( const void* p );
int _isdebugging(void);
#endif /*NDEBUG*/

ppCPP(})


#endif /* DEBUG_H */