Updated for Mahogany.

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

diff --git a/include/wx/debug.h b/include/wx/debug.h
index 029790e47d27094add67fc15eb3372ad0233da86..99d01d268adedc5af25041f9594ddf577a309b94 100644 (file)
--- a/include/wx/debug.h
+++ b/include/wx/debug.h
@@ -9,11 +9,18 @@
 // Licence:    wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
-#ifndef   __DEBUGH__
-#define   __DEBUGH__
+#ifndef   _WX_DEBUG_H_
+#define   _WX_DEBUG_H_
 
 #include  <assert.h>
 
+#include  "wx/wxchar.h"
+
+#ifndef __TFILE__
+#define __XFILE__(x) _T(x)
+#define __TFILE__ __XFILE__(__FILE__)
+#endif
+
 // ----------------------------------------------------------------------------
 /** 
   @name Debugging macros 
@@ -31,7 +38,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 +50,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
@@ -51,23 +58,38 @@
   @param   szFile and nLine - file name and line number of the ASSERT
            szMsg            - optional message explaining the reason
   */
-  void wxOnAssert(const char *szFile, int nLine, const char *szMsg = NULL);
+  void WXDLLEXPORT wxOnAssert(const wxChar *szFile, int nLine, const wxChar *szMsg = (const wxChar *) NULL);
 
   /// generic assert macro
-  #define   wxASSERT(cond)   if ( !(cond) ) wxOnAssert(__FILE__, __LINE__)
-  /// assert with additional message explaining it's cause 
-  #define   wxASSERT_MSG(x, m)  if ( !(x) ) wxOnAssert(__FILE__, __LINE__, m)
+  #define   wxASSERT(cond)   if ( !(cond) ) wxOnAssert(__TFILE__, __LINE__)
+
+#if 0 // defined(__BORLANDC__) && defined(__WIN16__)
+  // Too much text, so make wxASSERT_MSG the same as wxASSERT,
+  // thus removing the text from the program.
+  #define   wxASSERT_MSG(x, m)  if ( !(x) ) wxOnAssert(__TFILE__, __LINE__)
+#else
+  /// assert with additional message explaining it's cause
+  #define   wxASSERT_MSG(x, m)  if ( !(x) ) wxOnAssert(__TFILE__, __LINE__, m)
+#endif
+
 #else
   // nothing to do in release modes (hopefully at this moment there are
   // 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)
+#define   wxFAIL                 wxASSERT(wxFalse)
+
+#if 0 // defined(__BORLANDC__) && defined(__WIN16__)
+  // Too much text, so make wxFAIL_MSG the same as wxFAIL,
+  // thus removing the text from the program.
+#define   wxFAIL_MSG(msg)        wxASSERT(wxFalse)
+#else
   /// FAIL with some message
-#define   wxFAIL_MSG(msg)        wxASSERT_MSG(0, msg)
+#define   wxFAIL_MSG(msg)        wxASSERT_MSG(wxFalse, msg)
+#endif
 //@}
 
 // NB: these macros work also in release mode!
@@ -82,13 +104,21 @@
 */
 //@{
   /// 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  // _WX_DEBUG_H_