Added missing accessors

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

diff --git a/include/wx/debug.h b/include/wx/debug.h
index 029790e47d27094add67fc15eb3372ad0233da86..2f65767f4ec7f1ce053151b69fa543cdf6b4d8ab 100644 (file)
--- a/include/wx/debug.h
+++ b/include/wx/debug.h
@@ -9,8 +9,8 @@
 // Licence:    wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
-#ifndef   __DEBUGH__
-#define   __DEBUGH__
+#ifndef   __WXDEBUGH__
+#define   __WXDEBUGH__
 
 #include  <assert.h>
 
@@ -31,7 +31,7 @@
   <BR>
   <BR>
   Extensive use of these macros is recommended! Remember that ASSERTs are
-  disabled in final (without DEBUG defined) build, so they add strictly
+  disabled in final (without WXDEBUG defined) build, so they add strictly
   nothing to your program's code. On the other hand, CHECK macros do stay
   even in release builds, but in general are not much of a burden, while
   a judicious use of them might increase your program's stability.
@@ -43,7 +43,7 @@
 
 /** @name Macros which are completely disabled in 'release' mode */
 //@{
-#ifdef  __DEBUG__
+#ifdef  __WXDEBUG__
   /**
   this function may be redefined to do something non trivial and is called
   whenever one of debugging macros fails (i.e. condition is false in an
@@ -62,7 +62,7 @@
   // no more bugs ;-)
   #define   wxASSERT(cond)
   #define   wxASSERT_MSG(x, m)
-#endif  //DEBUG
+#endif  //WXDEBUG
 
   /// special form of assert: always triggers it (in debug mode)
 #define   wxFAIL                 wxASSERT(0)
@@ -82,13 +82,22 @@
 */
 //@{
   /// check that expression is true, "return" if not (also FAILs in debug mode)
-#define   wxCHECK(x)             if (!(x)) {wxFAIL; return; }
-  /// check that expression is true, "return ret" if not
-#define   wxCHECK_RET(x, ret)    if (!(x)) {wxFAIL; return ret; }
+#define   wxCHECK(x, rc)            if (!(x)) {wxFAIL; return rc; }
+  /// as wxCHECK but with a message explaining why we fail
+#define   wxCHECK_MSG(x, rc, msg)   if (!(x)) {wxFAIL_MSG(msg); return rc; }
   /// check that expression is true, perform op if not
-#define   wxCHECK2(x, op)        if (!(x)) {wxFAIL; op; }
+#define   wxCHECK2(x, op)           if (!(x)) {wxFAIL; op; }
+  /// as wxCHECK2 but with a message explaining why we fail
+#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...)
+#define   wxCHECK_RET(x, msg)       if (!(x)) {wxFAIL_MSG(msg); return; }
 //@}
 
 //@}
 
-#endif  // __DEBUGH__
\ No newline at end of file
+#endif  // __WXDEBUGH__
+