include/wx/debug.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        debug.h
   3 // Purpose:     Misc debug functions and macros
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     29/01/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
   9 // Licence:     wxWindows license
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef   _WX_DEBUG_H_
  13 #define   _WX_DEBUG_H_
  14
  15 #include  <assert.h>
  16
  17 // ----------------------------------------------------------------------------
  18 /**
  19   @name Debugging macros
  20
  21   All debugging macros rely on ASSERT() which in turn calls user-defined
  22   OnAssert() function. To keep things simple, it's called even when the
  23   expression is TRUE (i.e. everything is ok) and by default does nothing: just
  24   returns the same value back. But if you redefine it to do something more sexy
  25   (popping up a message box in your favourite GUI, sending you e-mail or
  26   whatever) it will affect all ASSERTs, FAILs and CHECKs in your code.
  27   <BR>
  28   <BR>
  29   <b>Warning</b>: if you don't like advices on programming style, don't read
  30   further! ;-)
  31   <BR>
  32   <BR>
  33   Extensive use of these macros is recommended! Remember that ASSERTs are
  34   disabled in final (without __WXDEBUG__ defined) build, so they add strictly
  35   nothing to your program's code. On the other hand, CHECK macros do stay
  36   even in release builds, but in general are not much of a burden, while
  37   a judicious use of them might increase your program's stability.
  38
  39   @memo Debugging macros (replacement for standard assert()) and more.
  40   */
  41 // ----------------------------------------------------------------------------
  42 //@{
  43
  44 /** @name Macros which are completely disabled in 'release' mode */
  45 //@{
  46 #ifdef  __WXDEBUG__
  47   /**
  48   this function may be redefined to do something non trivial and is called
  49   whenever one of debugging macros fails (i.e. condition is false in an
  50   assertion)
  51   @param   szFile and nLine - file name and line number of the ASSERT
  52            szMsg            - optional message explaining the reason
  53   */
  54   void WXDLLEXPORT wxOnAssert(const char *szFile, int nLine, const char *szMsg = (const char *) NULL);
  55
  56   /// generic assert macro
  57   #define   wxASSERT(cond)   if ( !(cond) ) wxOnAssert(__FILE__, __LINE__)
  58
  59 #if 0 // defined(__BORLANDC__) && defined(__WIN16__)
  60   // Too much text, so make wxASSERT_MSG the same as wxASSERT,
  61   // thus removing the text from the program.
  62   #define   wxASSERT_MSG(x, m)  if ( !(x) ) wxOnAssert(__FILE__, __LINE__)
  63 #else
  64   /// assert with additional message explaining it's cause
  65   #define   wxASSERT_MSG(x, m)  if ( !(x) ) wxOnAssert(__FILE__, __LINE__, m)
  66 #endif
  67
  68 #else
  69   // nothing to do in release modes (hopefully at this moment there are
  70   // no more bugs ;-)
  71   #define   wxASSERT(cond)
  72   #define   wxASSERT_MSG(x, m)
  73 #endif  //__WXDEBUG__
  74
  75   /// special form of assert: always triggers it (in debug mode)
  76 #define   wxFAIL                 wxASSERT(wxFalse)
  77
  78 #if 0 // defined(__BORLANDC__) && defined(__WIN16__)
  79   // Too much text, so make wxFAIL_MSG the same as wxFAIL,
  80   // thus removing the text from the program.
  81 #define   wxFAIL_MSG(msg)        wxASSERT(wxFalse)
  82 #else
  83   /// FAIL with some message
  84 #define   wxFAIL_MSG(msg)        wxASSERT_MSG(wxFalse, msg)
  85 #endif
  86 //@}
  87
  88 // NB: these macros work also in release mode!
  89
  90 /**
  91   These macros must be used only in invalid situation: for example, an
  92   invalid parameter (NULL pointer) is passed to a function. Instead of
  93   dereferencing it and causing core dump the function might try using
  94   CHECK( p != NULL ) or CHECK( p != NULL, return LogError("p is NULL!!") )
  95
  96   @name Macros which remain even in 'release' mode
  97 */
  98 //@{
  99   /// check that expression is true, "return" if not (also FAILs in debug mode)
 100 #define   wxCHECK(x, rc)            if (!(x)) {wxFAIL; return rc; }
 101   /// as wxCHECK but with a message explaining why we fail
 102 #define   wxCHECK_MSG(x, rc, msg)   if (!(x)) {wxFAIL_MSG(msg); return rc; }
 103   /// check that expression is true, perform op if not
 104 #define   wxCHECK2(x, op)           if (!(x)) {wxFAIL; op; }
 105   /// as wxCHECK2 but with a message explaining why we fail
 106 #define   wxCHECK2_MSG(x, op, msg)  if (!(x)) {wxFAIL_MSG(msg); op; }
 107   /// special form of wxCHECK2: as wxCHECK, but for use in void functions
 108   //  NB: there is only one form (with msg parameter) and it's intentional:
 109   //      there is no other way to tell the caller what exactly went wrong
 110   //      from the void function (of course, the function shouldn't be void
 111   //      to begin with...)
 112 #define   wxCHECK_RET(x, msg)       if (!(x)) {wxFAIL_MSG(msg); return; }
 113 //@}
 114
 115 //@}
 116
 117 #endif  // _WX_DEBUG_H_
 118