debugAssert.h

Go to the documentation of this file.

#ifndef G3D_DEBUGASSERT_H
#define G3D_DEBUGASSERT_H

#include <string>
#include "G3D/platform.h"

#include <cstdlib>

#ifdef _MSC_VER
// conditional expression is constant
# pragma warning (disable : 4127)
#endif

#ifdef G3D_LINUX
 // Needed so we can define a global display
 // pointer for debugAssert.
#if 0 /* G3DFIX: Disabled to avoid requirement for X11 libraries */
 #include <X11/Xlib.h>
 #include <X11/Xutil.h>
 #include <X11/Xatom.h>
#endif
#endif


namespace G3D {
typedef bool (*AssertionHook)(
 const char* _expression,
 const std::string& message,
 const char* filename,
 int lineNumber,
 bool useGuiPrompt);

void setAssertionHook(AssertionHook hook);

AssertionHook assertionHook();

void setFailureHook(AssertionHook hook);
AssertionHook failureHook();

namespace _internal {
 extern AssertionHook _debugHook;
 extern AssertionHook _failureHook;
} // internal
} // G3D

#ifdef G3D_DEBUG

# if defined(_MSC_VER) 
# define rawBreak() ::DebugBreak();
# elif defined(__i386__)
 // gcc on intel
# define rawBreak() __asm__ __volatile__ ( "int $3" ); 
# else
 // some other gcc
# define rawBreak() ::abort()
# endif


# define debugBreak() G3D::_internal::_releaseInputGrab_(); rawBreak(); G3D::_internal::_restoreInputGrab_();
# define debugAssert(exp) debugAssertM(exp, "Debug assertion failure")

 #ifdef G3D_DEBUG_NOGUI
 #define __debugPromptShowDialog__ false
 #else
 #define __debugPromptShowDialog__ true
 #endif

 #define debugAssertM(exp, message) do { \
 if (!(exp)) { \
 G3D::_internal::_releaseInputGrab_(); \
 if ((G3D::_internal::_debugHook != NULL) && \
 G3D::_internal::_debugHook((const char*)(#exp), message, __FILE__, __LINE__, __debugPromptShowDialog__)) { \
 rawBreak(); \
 } \
 G3D::_internal::_restoreInputGrab_(); \
 } \
 } while (0)

 #define alwaysAssertM debugAssertM

#else // Release
 #ifdef G3D_DEBUG_NOGUI
 #define __debugPromptShowDialog__ false
 #else
 #define __debugPromptShowDialog__ true
 #endif

 // In the release build, just define away assertions.
 #define rawBreak() do {} while (0)
 #define debugAssert(exp) do {} while (0)
 #define debugAssertM(exp, message) do {} while (0)
 #define debugBreak() do {} while (0)

 // But keep the 'always' assertions
 #define alwaysAssertM(exp, message) { \
 if (!(exp)) { \
 G3D::_internal::_releaseInputGrab_(); \
 if ((G3D::_internal::_failureHook != NULL) && \
 G3D::_internal::_failureHook(#exp, message, __FILE__, __LINE__, __debugPromptShowDialog__)) { \
 ::exit(-1); \
 } \
 G3D::_internal::_restoreInputGrab_(); \
 } \
 }

#endif // if debug



namespace G3D { namespace _internal {

#ifdef G3D_LINUX
#if 0 /* G3DFIX: Disabled to avoid requirement for X11 libraries */

 extern Display* x11Display;

 extern Window x11Window;
#endif
#endif

bool _handleDebugAssert_(
 const char* expression,
 const std::string& message,
 const char* filename,
 int lineNumber,
 bool useGuiPrompt);

bool _handleErrorCheck_(
 const char* expression,
 const std::string& message,
 const char* filename,
 int lineNumber,
 bool useGuiPrompt);

void _releaseInputGrab_();

void _restoreInputGrab_();

}; }; // namespace

#endif