include/wx/debug.h

   1 /**
   2 *  Name:        wx/debug.h
   3 *  Purpose:     Misc debug functions and macros
   4 *  Author:      Vadim Zeitlin
   5 *  Modified by: Ryan Norton (Converted to C)
   6 *  Created:     29/01/98
   7 *  RCS-ID:      $Id$
   8 *  Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
   9 *  Licence:     wxWindows licence
  10 */
  11
  12 /* THIS IS A C FILE, DON'T USE C++ FEATURES (IN PARTICULAR COMMENTS) IN IT */
  13
  14 #ifndef   _WX_DEBUG_H_
  15 #define   _WX_DEBUG_H_
  16
  17 #ifndef __WXWINCE__
  18 #include  <assert.h>
  19 #endif
  20 #include  <limits.h>            /*  for CHAR_BIT used below */
  21
  22 #include  "wx/wxchar.h"         /*  for __TFILE__ and wxChar */
  23
  24 /*  ---------------------------------------------------------------------------- */
  25 /*  Defines controlling the debugging macros */
  26 /*  ---------------------------------------------------------------------------- */
  27
  28 /*  if _DEBUG is defined (MS VC++ and others use it in debug builds), define */
  29 /*  __WXDEBUG__ too */
  30 #ifdef _DEBUG
  31     #ifndef __WXDEBUG__
  32         #define __WXDEBUG__
  33     #endif /*  !__WXDEBUG__ */
  34 #endif /*  _DEBUG */
  35
  36 /*  if NDEBUG is defined (<assert.h> uses it), undef __WXDEBUG__ and WXDEBUG */
  37 #ifdef NDEBUG
  38     #undef __WXDEBUG__
  39     #undef WXDEBUG
  40 #endif /*  NDEBUG */
  41
  42 /*  if __WXDEBUG__ is defined, make sure that WXDEBUG is defined and >= 1 */
  43 #ifdef __WXDEBUG__
  44     #if !defined(WXDEBUG) || !WXDEBUG
  45         #undef WXDEBUG
  46         #define WXDEBUG 1
  47     #endif /*  !WXDEBUG */
  48 #endif /*  __WXDEBUG__ */
  49
  50 #ifndef __WXFUNCTION__
  51     /* TODO: add more compilers supporting __FUNCTION__ */
  52     #if defined(__GNUC__) || \
  53         (defined(_MSC_VER) && _MSC_VER >= 1300) || \
  54         defined(__FUNCTION__)
  55         #define __WXFUNCTION__ __FUNCTION__
  56     #else
  57         /* still define __WXFUNCTION__ to avoid #ifdefs elsewhere */
  58         #define __WXFUNCTION__ (NULL)
  59     #endif
  60 #endif /* __WXFUNCTION__ already defined */
  61
  62 /*  ---------------------------------------------------------------------------- */
  63 /*  Debugging macros */
  64 /*  */
  65 /*  All debugging macros rely on ASSERT() which in turn calls user-defined */
  66 /*  OnAssert() function. To keep things simple, it's called even when the */
  67 /*  expression is true (i.e. everything is ok) and by default does nothing: just */
  68 /*  returns the same value back. But if you redefine it to do something more sexy */
  69 /*  (popping up a message box in your favourite GUI, sending you e-mail or */
  70 /*  whatever) it will affect all ASSERTs, FAILs and CHECKs in your code. */
  71 /*  */
  72 /*  Warning: if you don't like advice on programming style, don't read */
  73 /*  further! ;-) */
  74 /*  */
  75 /*  Extensive use of these macros is recommended! Remember that ASSERTs are */
  76 /*  disabled in final build (without __WXDEBUG__ defined), so they add strictly */
  77 /*  nothing to your program's code. On the other hand, CHECK macros do stay */
  78 /*  even in release builds, but in general are not much of a burden, while */
  79 /*  a judicious use of them might increase your program's stability. */
  80 /*  ---------------------------------------------------------------------------- */
  81
  82 /*  Macros which are completely disabled in 'release' mode */
  83 /*  */
  84 /*  NB: these functions are implemented in src/common/appcmn.cpp */
  85 #if defined(__cplusplus) && defined(__WXDEBUG__)
  86   /*
  87     This function is called whenever one of debugging macros fails (i.e.
  88     condition is false in an assertion). To customize its behaviour, override
  89     wxApp::OnAssert().
  90
  91     Parameters:
  92        szFile and nLine - file name and line number of the ASSERT
  93        szFunc           - function name of the ASSERT, may be NULL (NB: ASCII)
  94        szCond           - text form of the condition which failed
  95        szMsg            - optional message explaining the reason
  96   */
  97   extern void WXDLLIMPEXP_BASE wxOnAssert(const wxChar *szFile,
  98                                           int nLine,
  99                                           const char *szFunc,
 100                                           const wxChar *szCond,
 101                                           const wxChar *szMsg = NULL);
 102
 103   /*  call this function to break into the debugger unconditionally (assuming */
 104   /*  the program is running under debugger, of course) */
 105   extern void WXDLLIMPEXP_BASE wxTrap();
 106
 107   /*  generic assert macro */
 108   #define wxASSERT(cond) wxASSERT_MSG(cond, NULL)
 109
 110   /*  assert with additional message explaining it's cause */
 111   #define wxASSERT_MSG(cond, msg)                                             \
 112     if ( cond )                                                               \
 113         ;                                                                     \
 114     else                                                                      \
 115         wxOnAssert(__TFILE__, __LINE__, __WXFUNCTION__, _T(#cond), msg)
 116
 117   /*  special form of assert: always triggers it (in debug mode) */
 118   #define wxFAIL wxFAIL_MSG(NULL)
 119
 120   /*  FAIL with some message */
 121   #define wxFAIL_MSG(msg) wxFAIL_COND_MSG("wxAssertFailure", msg)
 122
 123   /*  FAIL with some message and a condition */
 124   #define wxFAIL_COND_MSG(cond, msg)                                          \
 125       wxOnAssert(__TFILE__, __LINE__,  __WXFUNCTION__, _T(cond), msg)
 126
 127   /*  an assert helper used to avoid warning when testing constant expressions, */
 128   /*  i.e. wxASSERT( sizeof(int) == 4 ) can generate a compiler warning about */
 129   /*  expression being always true, but not using */
 130   /*  wxASSERT( wxAssertIsEqual(sizeof(int), 4) ) */
 131   /*  */
 132   /*  NB: this is made obsolete by wxCOMPILE_TIME_ASSERT() and shouldn't be */
 133   /*      used any longer */
 134   extern bool WXDLLIMPEXP_BASE wxAssertIsEqual(int x, int y);
 135 #else
 136   #define wxTrap()
 137
 138   /*  nothing to do in release modes (hopefully at this moment there are */
 139   /*  no more bugs ;-) */
 140   #define wxASSERT(cond)
 141   #define wxASSERT_MSG(cond, msg)
 142   #define wxFAIL
 143   #define wxFAIL_MSG(msg)
 144   #define wxFAIL_COND_MSG(cond, msg)
 145 #endif  /* __WXDEBUG__ */
 146
 147 #ifdef __cplusplus
 148     /*  Use of wxFalse instead of false suppresses compiler warnings about testing */
 149     /*  constant expression */
 150     extern WXDLLIMPEXP_DATA_BASE(const bool) wxFalse;
 151 #endif
 152
 153 #define wxAssertFailure wxFalse
 154
 155 /*  NB: the following macros work also in release mode! */
 156
 157 /*
 158   These macros must be used only in invalid situation: for example, an
 159   invalid parameter (NULL pointer) is passed to a function. Instead of
 160   dereferencing it and causing core dump the function might try using
 161   CHECK( p != NULL ) or CHECK( p != NULL, return LogError("p is NULL!!") )
 162 */
 163
 164 /*  check that expression is true, "return" if not (also FAILs in debug mode) */
 165 #define wxCHECK(cond, rc)            wxCHECK_MSG(cond, rc, NULL)
 166
 167 /*  as wxCHECK but with a message explaining why we fail */
 168 #define wxCHECK_MSG(cond, rc, msg)   wxCHECK2_MSG(cond, return rc, msg)
 169
 170 /*  check that expression is true, perform op if not */
 171 #define wxCHECK2(cond, op)           wxCHECK2_MSG(cond, op, NULL)
 172
 173 /*  as wxCHECK2 but with a message explaining why we fail */
 174 #define wxCHECK2_MSG(cond, op, msg)                                           \
 175     if ( cond )                                                               \
 176         ;                                                                     \
 177     else                                                                      \
 178     {                                                                         \
 179         wxFAIL_COND_MSG(#cond, msg);                                          \
 180         op;                                                                   \
 181     }                                                                         \
 182     struct wxDummyCheckStruct /* just to force a semicolon */
 183
 184 /*  special form of wxCHECK2: as wxCHECK, but for use in void functions */
 185 /*  */
 186 /*  NB: there is only one form (with msg parameter) and it's intentional: */
 187 /*      there is no other way to tell the caller what exactly went wrong */
 188 /*      from the void function (of course, the function shouldn't be void */
 189 /*      to begin with...) */
 190 #define wxCHECK_RET(cond, msg)       wxCHECK2_MSG(cond, return, msg)
 191
 192 /*  ---------------------------------------------------------------------------- */
 193 /*  Compile time asserts */
 194 /*  */
 195 /*  Unlike the normal assert and related macros above which are checked during */
 196 /*  the program tun-time the macros below will result in a compilation error if */
 197 /*  the condition they check is false. This is usually used to check the */
 198 /*  expressions containing sizeof()s which cannot be tested with the */
 199 /*  preprocessor. If you can use the #if's, do use them as you can give a more */
 200 /*  detailed error message then. */
 201 /*  ---------------------------------------------------------------------------- */
 202
 203 /*
 204   How this works (you don't have to understand it to be able to use the
 205   macros): we rely on the fact that it is invalid to define a named bit field
 206   in a struct of width 0. All the rest are just the hacks to minimize the
 207   possibility of the compiler warnings when compiling this macro: in
 208   particular, this is why we define a struct and not an object (which would
 209   result in a warning about unused variable) and a named struct (otherwise we'd
 210   get a warning about an unnamed struct not used to define an object!).
 211  */
 212
 213 #define wxMAKE_UNIQUE_ASSERT_NAME           wxMAKE_UNIQUE_NAME(wxAssert_)
 214
 215 /*
 216   The second argument of this macro must be a valid C++ identifier and not a
 217   string. I.e. you should use it like this:
 218
 219     wxCOMPILE_TIME_ASSERT( sizeof(int) >= 2, YourIntsAreTooSmall );
 220
 221  It may be used both within a function and in the global scope.
 222 */
 223 #if defined(__WATCOMC__) && defined(__cplusplus)
 224     /* avoid "unused symbol" warning */
 225     #define wxCOMPILE_TIME_ASSERT(expr, msg) \
 226         class wxMAKE_UNIQUE_ASSERT_NAME { \
 227           unsigned int msg: expr; \
 228           wxMAKE_UNIQUE_ASSERT_NAME() { wxUnusedVar(msg); } \
 229         }
 230 #else
 231     #define wxCOMPILE_TIME_ASSERT(expr, msg) \
 232         struct wxMAKE_UNIQUE_ASSERT_NAME { unsigned int msg: expr; }
 233 #endif
 234
 235 /*
 236    When using VC++ 6 with "Edit and Continue" on, the compiler completely
 237    mishandles __LINE__ and so wxCOMPILE_TIME_ASSERT() doesn't work, provide a
 238    way to make "unique" assert names by specifying a unique prefix explicitly
 239  */
 240 #define wxMAKE_UNIQUE_ASSERT_NAME2(text) wxCONCAT(wxAssert_, text)
 241
 242 #define wxCOMPILE_TIME_ASSERT2(expr, msg, text) \
 243     struct wxMAKE_UNIQUE_ASSERT_NAME2(text) { unsigned int msg: expr; }
 244
 245 /*  helpers for wxCOMPILE_TIME_ASSERT below, for private use only */
 246 #define wxMAKE_BITSIZE_MSG(type, size) type ## SmallerThan ## size ## Bits
 247
 248 /*  a special case of compile time assert: check that the size of the given type */
 249 /*  is at least the given number of bits */
 250 #define wxASSERT_MIN_BITSIZE(type, size) \
 251     wxCOMPILE_TIME_ASSERT(sizeof(type) * CHAR_BIT >= size, \
 252                           wxMAKE_BITSIZE_MSG(type, size))
 253
 254 /*  ---------------------------------------------------------------------------- */
 255 /*  other miscellaneous debugger-related functions */
 256 /*  ---------------------------------------------------------------------------- */
 257
 258 /*
 259     Return true if we're running under debugger.
 260
 261     Currently this only really works under Win32 and Mac in CodeWarrior builds,
 262     it always returns false in other cases.
 263  */
 264 #ifdef __cplusplus
 265     /* ABX: check __WIN32__ instead of __WXMSW__ for the same MSWBase in any Win32 port */
 266     #if defined(__WXMAC__) || defined(__WIN32__)
 267         extern bool WXDLLIMPEXP_BASE wxIsDebuggerRunning();
 268     #else /*  !Mac */
 269         inline bool wxIsDebuggerRunning() { return false; }
 270     #endif /*  Mac/!Mac */
 271 #endif /* __cplusplus */
 272
 273 #endif  /*  _WX_DEBUG_H_ */