haiku/headers/os/support/Debug.h

/******************************************************************************
/
/	File:			Debug.h
/
/	Description:	Compile time and runtime switchable debug macros.
/
/	Copyright 1993-98, Be Incorporated
/
******************************************************************************/

#ifndef _DEBUG_H
#define _DEBUG_H

#include <BeBuild.h>
#include <SupportDefs.h>
#include <stdarg.h>
#include <stdio.h>
#include <stdlib.h>
#include <OS.h>

/*------------------------------*/
/*----- Private... -------------*/
#ifdef __cplusplus
extern "C" {
#endif
	extern _IMPEXP_ROOT bool _rtDebugFlag;

	_IMPEXP_ROOT bool _debugFlag();
	_IMPEXP_ROOT bool _setDebugFlag(bool);
	
	_IMPEXP_ROOT int _debugPrintf(const char *, ...);
	_IMPEXP_ROOT int _sPrintf(const char *, ...);
	_IMPEXP_ROOT int _xdebugPrintf(const char *, ...);
	_IMPEXP_ROOT int _debuggerAssert(const char *, int, char *);
#ifdef __cplusplus
	}
#endif
/*-------- ...to here ----------*/


/*-------------------------------------------------------------*/
/*----- Debug macros ------------------------------------------*/


#if DEBUG
	#define SET_DEBUG_ENABLED(FLAG)	_setDebugFlag(FLAG)
	#define	IS_DEBUG_ENABLED()		_debugFlag()
	
	#define SERIAL_PRINT(ARGS)		_sPrintf ARGS
	#define PRINT(ARGS) 			_debugPrintf ARGS
	#define PRINT_OBJECT(OBJ)		if (_rtDebugFlag) {		\
										PRINT(("%s\t", #OBJ));	\
										(OBJ).PrintToStream(); 	\
										} ((void) 0)
	#define TRACE()					_debugPrintf("File: %s, Line: %d, Thread: %d\n", \
										__FILE__, __LINE__, find_thread(NULL))
		
	#define SERIAL_TRACE()			_sPrintf("File: %s, Line: %d, Thread: %d\n", \
										__FILE__, __LINE__, find_thread(NULL))
	
	#define DEBUGGER(MSG)			if (_rtDebugFlag) debugger(MSG)
	#if !defined(ASSERT)
		#define ASSERT(E)			(!(E) ? _debuggerAssert(__FILE__,__LINE__, #E) \
										: (int)0)
	#endif

	#define ASSERT_WITH_MESSAGE(expr, msg) \
								(!(expr) ? _debuggerAssert( __FILE__,__LINE__, msg) \
										: (int)0)	
	
	#define TRESPASS()			DEBUGGER("Should not be here");
	
	#define DEBUG_ONLY(arg)		arg

#else /* DEBUG == 0 */
	#define SET_DEBUG_ENABLED(FLAG)	(void)0
	#define	IS_DEBUG_ENABLED()		(void)0
	
	#define SERIAL_PRINT(ARGS)		(void)0
	#define PRINT(ARGS)				(void)0
	#define PRINT_OBJECT(OBJ)		(void)0
	#define TRACE()					(void)0
	#define SERIAL_TRACE()			(void)0
	
	#define DEBUGGER(MSG)			(void)0
	#if !defined(ASSERT)
		#define ASSERT(E)				(void)0
	#endif
	#define ASSERT_WITH_MESSAGE(expr, msg) \
									(void)0
	#define TRESPASS()				(void)0
	#define DEBUG_ONLY(x)
#endif


#if !__MWERKS__
	// STATIC_ASSERT is a compile-time check that can be used to
	// verify static expressions such as: STATIC_ASSERT(sizeof(int64) == 8);
	#define STATIC_ASSERT(x)								\
		do {												\
			struct __staticAssertStruct__ {					\
				char __static_assert_failed__[2*(x) - 1];	\
			};												\
		} while (false)
#else
	#define STATIC_ASSERT(x) 
	// the STATIC_ASSERT above doesn't work too well with mwcc because
	// of scoping bugs; for now make it do nothing
#endif

/*-------------------------------------------------------------*/
/*-------------------------------------------------------------*/

#endif /* _DEBUG_H */