X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7ba4fbebbc40bdf9c140f4c9ba9977fbf810527d..f809133f9eb30d4746c71098bbc14c621b94ef0d:/include/wx/debug.h diff --git a/include/wx/debug.h b/include/wx/debug.h index 4fd54e2d91..436a05ab29 100644 --- a/include/wx/debug.h +++ b/include/wx/debug.h @@ -13,8 +13,35 @@ #define _WX_DEBUG_H_ #include +#include // for CHAR_BIT used below -#include "wx/wxchar.h" +#include "wx/wxchar.h" // for __TFILE__ and wxChar + +// ---------------------------------------------------------------------------- +// Defines controlling the debugging macros +// ---------------------------------------------------------------------------- + +// if _DEBUG is defined (MS VC++ and others use it in debug builds), define +// __WXDEBUG__ too +#ifdef _DEBUG + #ifndef __WXDEBUG__ + #define __WXDEBUG__ + #endif // !__WXDEBUG__ +#endif // _DEBUG + +// if NDEBUG is defined ( uses it), undef __WXDEBUG__ and WXDEBUG +#ifdef NDEBUG + #undef __WXDEBUG__ + #undef WXDEBUG +#endif // NDEBUG + +// if __WXDEBUG__ is defined, make sure that WXDEBUG is defined and >= 1 +#ifdef __WXDEBUG__ + #if !defined(WXDEBUG) || !WXDEBUG + #undef WXDEBUG + #define WXDEBUG 1 + #endif // !WXDEBUG +#endif // __WXDEBUG__ // ---------------------------------------------------------------------------- // Debugging macros @@ -36,11 +63,9 @@ // a judicious use of them might increase your program's stability. // ---------------------------------------------------------------------------- -// Use of these suppresses compiler warnings about testing constant expression -WXDLLEXPORT_DATA(extern const bool) wxTrue; -WXDLLEXPORT_DATA(extern const bool) wxFalse; - // Macros which are completely disabled in 'release' mode +// +// NB: these functions are implemented in src/common/appcmn.cpp #ifdef __WXDEBUG__ /* this function may be redefined to do something non trivial and is called @@ -51,7 +76,13 @@ WXDLLEXPORT_DATA(extern const bool) wxFalse; szFile and nLine - file name and line number of the ASSERT szMsg - optional message explaining the reason */ - void WXDLLEXPORT wxOnAssert(const wxChar *szFile, int nLine, const wxChar *szMsg = (const wxChar *) NULL); + extern void WXDLLEXPORT wxOnAssert(const wxChar *szFile, + int nLine, + const wxChar *szMsg = NULL); + + // call this function to break into the debugger uncodnitionally (assuming + // the program is running under debugger, of course) + extern void WXDLLEXPORT wxTrap(); /* notice the usage of else at the end of wxASSERT macro: this ensures that @@ -72,13 +103,25 @@ WXDLLEXPORT_DATA(extern const bool) wxFalse; // assert with additional message explaining it's cause #define wxASSERT_MSG(cond, msg) \ if ( !(cond) ) wxOnAssert(__TFILE__, __LINE__, msg); else + + // an assert helper used to avoid warning when testing constant expressions, + // i.e. wxASSERT( sizeof(int) == 4 ) can generate a compiler warning about + // expression being always true, but not using + // wxASSERT( wxAssertIsEqual(sizeof(int), 4) ) + extern bool WXDLLEXPORT wxAssertIsEqual(int x, int y); #else + #define wxTrap() + // nothing to do in release modes (hopefully at this moment there are // no more bugs ;-) #define wxASSERT(cond) #define wxASSERT_MSG(x, m) #endif //__WXDEBUG__ +// Use of wxFalse instead of FALSE suppresses compiler warnings about testing +// constant expression +WXDLLEXPORT_DATA(extern const bool) wxFalse; + // special form of assert: always triggers it (in debug mode) #define wxFAIL wxASSERT(wxFalse) @@ -107,11 +150,61 @@ WXDLLEXPORT_DATA(extern const bool) wxFalse; #define wxCHECK2_MSG(x, op, msg) if (!(x)) {wxFAIL_MSG(msg); op; } // special form of wxCHECK2: as wxCHECK, but for use in void functions -// NB: there is only one form (with msg parameter) and it's intentional: -// there is no other way to tell the caller what exactly went wrong -// from the void function (of course, the function shouldn't be void -// to begin with...) +// +// NB: there is only one form (with msg parameter) and it's intentional: +// there is no other way to tell the caller what exactly went wrong +// from the void function (of course, the function shouldn't be void +// to begin with...) #define wxCHECK_RET(x, msg) if (!(x)) {wxFAIL_MSG(msg); return; } +// ---------------------------------------------------------------------------- +// Compile time asserts +// +// Unlike the normal assert and related macros above which are checked during +// the program tun-time the macros below will result in a compilation error if +// the condition they check is false. This is usually used to check the +// expressions containing sizeof()s which cannot be tested with the +// preprocessor. If you can use the #if's, do use them as you can give a more +// detailed error message then. +// ---------------------------------------------------------------------------- + +/* + How this works (you don't have to understand it to be able to use the + macros): we rely on the fact that it is invalid to define a named bit field + in a struct of width 0. All the rest are just the hacks to minimize the + possibility of the compiler warnings when compiling this macro: in + particular, this is why we define a struct and not an object (which would + result in a warning about unused variable) and a named struct (otherwise we'd + get a warning about an unnamed struct not used to define an object!). + */ + +#define wxMAKE_ASSERT_NAME_HELPER(line) wxAssert_ ## line +#define wxMAKE_ASSERT_NAME(line) wxMAKE_ASSERT_NAME_HELPER(line) +#define wxMAKE_UNIQUE_ASSERT_NAME wxMAKE_ASSERT_NAME(__LINE__) +#define wxMAKE_UNIQUE_ASSERT_NAME2(text) wxMAKE_ASSERT_NAME(text) + +/* + The second argument of this macro must be a valid C++ identifier and not a + string. I.e. you should use it like this: + + wxCOMPILE_TIME_ASSERT( sizeof(int) >= 2, YourIntsAreTooSmall ); + + It may be used both within a function and in the global scope. +*/ +#define wxCOMPILE_TIME_ASSERT(expr, msg) \ + struct wxMAKE_UNIQUE_ASSERT_NAME { unsigned int msg: expr; } + +#define wxCOMPILE_TIME_ASSERT2(expr, msg, text) \ + struct wxMAKE_UNIQUE_ASSERT_NAME2(text) { unsigned int msg: expr; } + +// helpers for wxCOMPILE_TIME_ASSERT below, for private use only +#define wxMAKE_BITSIZE_MSG(type, size) type ## SmallerThan ## size ## Bits + +// a special case of compile time assert: check that the size of the given type +// is at least the given number of bits +#define wxASSERT_MIN_BITSIZE(type, size) \ + wxCOMPILE_TIME_ASSERT(sizeof(type) * CHAR_BIT >= size, \ + wxMAKE_BITSIZE_MSG(type, size)) + #endif // _WX_DEBUG_H_