X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3b1de9c2eeedf27401d897a609baf15d8ff5914e..d6c9c1b71e069396bbe3850862de9aa10e6812e0:/include/wx/debug.h diff --git a/include/wx/debug.h b/include/wx/debug.h index ca8a8989b9..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_ @@ -14,19 +14,21 @@ #include +#include "wx/wxchar.h" + // ---------------------------------------------------------------------------- -/** - @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! ;-)

@@ -41,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__ @@ -51,20 +57,13 @@ @param szFile and nLine - file name and line number of the ASSERT szMsg - optional message explaining the reason */ - void WXDLLEXPORT wxOnAssert(const char *szFile, int nLine, const char *szMsg = (const char *) NULL); + void WXDLLEXPORT wxOnAssert(const wxChar *szFile, int nLine, const wxChar *szMsg = (const wxChar *) NULL); /// generic assert macro - #define wxASSERT(cond) if ( !(cond) ) wxOnAssert(__FILE__, __LINE__) + #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(__FILE__, __LINE__) -#else /// assert with additional message explaining it's cause - #define wxASSERT_MSG(x, m) if ( !(x) ) wxOnAssert(__FILE__, __LINE__, m) -#endif - + #define wxASSERT_MSG(x, m) if ( !(x) ) wxOnAssert(__TFILE__, __LINE__, m) #else // nothing to do in release modes (hopefully at this moment there are // no more bugs ;-) @@ -72,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) @@ -115,4 +108,3 @@ //@} #endif // _WX_DEBUG_H_ -