added macros to avoid code repetition when defining comparison operators; use them...

[wxWidgets.git] / include / wx / debug.h

diff --git a/include/wx/debug.h b/include/wx/debug.h
index 50d938e1a9acb5ffde2eafe1c0cce3ef4b421007..f7815a9844da32e8e10acbf40e23945e656cbd80 100644 (file)
--- a/include/wx/debug.h
+++ b/include/wx/debug.h
@@ -19,7 +19,7 @@
 #endif
 #include  <limits.h>            /*  for CHAR_BIT used below */
 
 #endif
 #include  <limits.h>            /*  for CHAR_BIT used below */
 

-#include  "wx/wxchar.h"         /*  for __TFILE__ and wxChar */
+#include  "wx/chartype.h"     /*  for __TFILE__ and wxChar */

 
 /*  ---------------------------------------------------------------------------- */
 /*  Defines controlling the debugging macros */
 
 /*  ---------------------------------------------------------------------------- */
 /*  Defines controlling the debugging macros */


@@ -47,18 +47,28 @@
     #endif /*  !WXDEBUG */
 #endif /*  __WXDEBUG__ */
 
     #endif /*  !WXDEBUG */
 #endif /*  __WXDEBUG__ */
 

-/* TODO: add more compilers supporting __FUNCTION__ */
-#if !defined(__GNUC__) && \
-    !(defined(_MSC_VER) && _MSC_VER >= 1300) && \
-    !defined(__FUNCTION__)
-    /* no __FUNCTION__ support, still define it to avoid #ifdefs elsewhere */
-    #define __FUNCTION__ (NULL)
-#endif
+#ifndef __WXFUNCTION__
+    /* TODO: add more compilers supporting __FUNCTION__ */
+    #if defined(__DMC__)
+        /* 
+           __FUNCTION__ happens to be not defined within class members
+           http://www.digitalmars.com/drn-bin/wwwnews?c%2B%2B.beta/485
+        */
+        #define __WXFUNCTION__ (NULL)
+    #elif defined(__GNUC__) || \
+          (defined(_MSC_VER) && _MSC_VER >= 1300) || \
+          defined(__FUNCTION__)
+        #define __WXFUNCTION__ __FUNCTION__
+    #else
+        /* still define __WXFUNCTION__ to avoid #ifdefs elsewhere */
+        #define __WXFUNCTION__ (NULL)
+    #endif
+#endif /* __WXFUNCTION__ already defined */

 
 /*  ---------------------------------------------------------------------------- */
 /*  Debugging macros */
 /*  */
 
 /*  ---------------------------------------------------------------------------- */
 /*  Debugging macros */
 /*  */

-/*  All debugging macros rely on ASSERT() which in turn calls user-defined */
+/*  All debugging macros rely on ASSERT() which in turn calls the 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 */
 /*  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 */


@@ -103,12 +113,24 @@
   /*  generic assert macro */
   #define wxASSERT(cond) wxASSERT_MSG(cond, NULL)
 
   /*  generic assert macro */
   #define wxASSERT(cond) wxASSERT_MSG(cond, NULL)
 

-  /*  assert with additional message explaining it's cause */
-  #define wxASSERT_MSG(cond, msg)                                             \
-    if ( cond )                                                               \
-        ;                                                                     \
-    else                                                                      \
-        wxOnAssert(__TFILE__, __LINE__, __FUNCTION__, _T(#cond), msg)
+
+  /*  assert with additional message explaining its cause */
+
+  /*  compilers can give a warning (such as "possible unwanted ;") when using */
+  /*  the default definition of wxASSERT_MSG so we provide an alternative */
+  #if defined(__MWERKS__)
+    #define wxASSERT_MSG(cond, msg)                                           \
+      if ( cond )                                                             \
+      {}                                                                      \
+      else                                                                    \
+          wxOnAssert(__TFILE__, __LINE__, __WXFUNCTION__, _T(#cond), msg)
+  #else
+    #define wxASSERT_MSG(cond, msg)                                           \
+      if ( cond )                                                             \
+          ;                                                                   \
+      else                                                                    \
+          wxOnAssert(__TFILE__, __LINE__, __WXFUNCTION__, _T(#cond), msg)
+  #endif

 
   /*  special form of assert: always triggers it (in debug mode) */
   #define wxFAIL wxFAIL_MSG(NULL)
 
   /*  special form of assert: always triggers it (in debug mode) */
   #define wxFAIL wxFAIL_MSG(NULL)


@@ -118,20 +140,20 @@
 
   /*  FAIL with some message and a condition */
   #define wxFAIL_COND_MSG(cond, msg)                                          \
 
   /*  FAIL with some message and a condition */
   #define wxFAIL_COND_MSG(cond, msg)                                          \

-      wxOnAssert(__TFILE__, __LINE__,  __FUNCTION__, _T(cond), msg)
+      wxOnAssert(__TFILE__, __LINE__,  __WXFUNCTION__, _T(cond), msg)

 
 

-  /*  an assert helper used to avoid warning when testing constant expressions, */
+  /*  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) ) */
   /*  */
   /*  i.e. wxASSERT( sizeof(int) == 4 ) can generate a compiler warning about */
   /*  expression being always true, but not using */
   /*  wxASSERT( wxAssertIsEqual(sizeof(int), 4) ) */
   /*  */

-  /*  NB: this is made obsolete by wxCOMPILE_TIME_ASSERT() and shouldn't be */
-  /*      used any longer */
+  /*  NB: this is made obsolete by wxCOMPILE_TIME_ASSERT() and should no */
+  /*      longer be used. */

   extern bool WXDLLIMPEXP_BASE wxAssertIsEqual(int x, int y);
 #else
   #define wxTrap()
 
   extern bool WXDLLIMPEXP_BASE wxAssertIsEqual(int x, int y);
 #else
   #define wxTrap()
 

-  /*  nothing to do in release modes (hopefully at this moment there are */
+  /*  nothing to do in release mode (hopefully at this moment there are */

   /*  no more bugs ;-) */
   #define wxASSERT(cond)
   #define wxASSERT_MSG(cond, msg)
   /*  no more bugs ;-) */
   #define wxASSERT(cond)
   #define wxASSERT_MSG(cond, msg)


@@ -148,11 +170,11 @@
 
 #define wxAssertFailure wxFalse
 
 
 #define wxAssertFailure wxFalse
 

-/*  NB: the following macros work also in release mode! */
+/*  NB: the following macros also work in release mode! */

 
 /*
   These macros must be used only in invalid situation: for example, an
 
 /*
   These macros must be used only in invalid situation: for example, an

-  invalid parameter (NULL pointer) is passed to a function. Instead of
+  invalid parameter (e.g. a 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!!") )
 */
   dereferencing it and causing core dump the function might try using
   CHECK( p != NULL ) or CHECK( p != NULL, return LogError("p is NULL!!") )
 */


@@ -167,15 +189,29 @@
 #define wxCHECK2(cond, op)           wxCHECK2_MSG(cond, op, NULL)
 
 /*  as wxCHECK2 but with a message explaining why we fail */
 #define wxCHECK2(cond, op)           wxCHECK2_MSG(cond, op, NULL)
 
 /*  as wxCHECK2 but with a message explaining why we fail */

-#define wxCHECK2_MSG(cond, op, msg)                                           \
-    if ( cond )                                                               \
-        ;                                                                     \
-    else                                                                      \
-    {                                                                         \
-        wxFAIL_COND_MSG(#cond, msg);                                          \
-        op;                                                                   \
-    }                                                                         \
-    struct wxDummyCheckStruct /* just to force a semicolon */
+
+/* see comment near the definition of wxASSERT_MSG for the # if/else reason */
+#if defined(__MWERKS__)
+    #define wxCHECK2_MSG(cond, op, msg)                                       \
+        if ( cond )                                                           \
+        {}                                                                    \
+        else                                                                  \
+        {                                                                     \
+            wxFAIL_COND_MSG(#cond, msg);                                      \
+            op;                                                               \
+        }                                                                     \
+        struct wxDummyCheckStruct /* just to force a semicolon */
+#else
+    #define wxCHECK2_MSG(cond, op, msg)                                       \
+        if ( cond )                                                           \
+            ;                                                                 \
+        else                                                                  \
+        {                                                                     \
+            wxFAIL_COND_MSG(#cond, msg);                                      \
+            op;                                                               \
+        }                                                                     \
+        struct wxDummyCheckStruct /* just to force a semicolon */
+#endif

 
 /*  special form of wxCHECK2: as wxCHECK, but for use in void functions */
 /*  */
 
 /*  special form of wxCHECK2: as wxCHECK, but for use in void functions */
 /*  */