X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9e3d3318dc6f58870d13eb6567da721d060533a6..d7e1a3227440c2910124edfc8896bbe23d6d0ab3:/include/wx/debug.h?ds=sidebyside diff --git a/include/wx/debug.h b/include/wx/debug.h index 99d01d268a..4cb9dd165d 100644 --- a/include/wx/debug.h +++ b/include/wx/debug.h @@ -1,12 +1,12 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: debug.h +// Name: wx/debug.h // Purpose: Misc debug functions and macros // Author: Vadim Zeitlin // Modified by: // Created: 29/01/98 // RCS-ID: $Id$ // Copyright: (c) 1998 Vadim Zeitlin -// Licence: wxWindows license +// Licence: wxWindows license ///////////////////////////////////////////////////////////////////////////// #ifndef _WX_DEBUG_H_ @@ -16,24 +16,19 @@ #include "wx/wxchar.h" -#ifndef __TFILE__ -#define __XFILE__(x) _T(x) -#define __TFILE__ __XFILE__(__FILE__) -#endif - // ---------------------------------------------------------------------------- -/** - @name Debugging macros +/** + @name Debugging macros All debugging macros rely on ASSERT() which in turn calls user-defined OnAssert() function. To keep things simple, it's called even when the expression is TRUE (i.e. everything is ok) and by default does nothing: just returns the same value back. But if you redefine it to do something more sexy - (popping up a message box in your favourite GUI, sending you e-mail or + (popping up a message box in your favourite GUI, sending you e-mail or whatever) it will affect all ASSERTs, FAILs and CHECKs in your code.

- Warning: if you don't like advices on programming style, don't read + Warning: if you don't like advices on programming style, don't read further! ;-)

@@ -48,6 +43,10 @@ // ---------------------------------------------------------------------------- //@{ +// Use of these suppresses compiler warnings about testing constant expression +WXDLLEXPORT_DATA(extern const bool) wxTrue; +WXDLLEXPORT_DATA(extern const bool) wxFalse; + /** @name Macros which are completely disabled in 'release' mode */ //@{ #ifdef __WXDEBUG__ @@ -63,15 +62,8 @@ /// generic assert macro #define wxASSERT(cond) if ( !(cond) ) wxOnAssert(__TFILE__, __LINE__) -#if 0 // defined(__BORLANDC__) && defined(__WIN16__) - // Too much text, so make wxASSERT_MSG the same as wxASSERT, - // thus removing the text from the program. - #define wxASSERT_MSG(x, m) if ( !(x) ) wxOnAssert(__TFILE__, __LINE__) -#else /// assert with additional message explaining it's cause #define wxASSERT_MSG(x, m) if ( !(x) ) wxOnAssert(__TFILE__, __LINE__, m) -#endif - #else // nothing to do in release modes (hopefully at this moment there are // no more bugs ;-) @@ -79,28 +71,22 @@ #define wxASSERT_MSG(x, m) #endif //__WXDEBUG__ - /// special form of assert: always triggers it (in debug mode) +/// special form of assert: always triggers it (in debug mode) #define wxFAIL wxASSERT(wxFalse) -#if 0 // defined(__BORLANDC__) && defined(__WIN16__) - // Too much text, so make wxFAIL_MSG the same as wxFAIL, - // thus removing the text from the program. -#define wxFAIL_MSG(msg) wxASSERT(wxFalse) -#else - /// FAIL with some message +/// FAIL with some message #define wxFAIL_MSG(msg) wxASSERT_MSG(wxFalse, msg) -#endif //@} // NB: these macros work also in release mode! -/** +/** These macros must be used only in invalid situation: for example, an invalid parameter (NULL pointer) is passed to a function. Instead of dereferencing it and causing core dump the function might try using CHECK( p != NULL ) or CHECK( p != NULL, return LogError("p is NULL!!") ) - @name Macros which remain even in 'release' mode + @name Macros which remain even in 'release' mode */ //@{ /// check that expression is true, "return" if not (also FAILs in debug mode)