restored previously removed inline

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

diff --git a/include/wx/debug.h b/include/wx/debug.h
index 5ccea5af0fdda1a1e1b44e5d2048f0cd43d49770..4cb9dd165d94f1b1b171f0f21708317df8f30e4b 100644 (file)
--- a/include/wx/debug.h
+++ b/include/wx/debug.h
@@ -1,12 +1,12 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        debug.h
+// Name:        wx/debug.h

 // Purpose:     Misc debug functions and macros
 // Author:      Vadim Zeitlin
 // Modified by:
 // Created:     29/01/98
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
 // Purpose:     Misc debug functions and macros
 // Author:      Vadim Zeitlin
 // Modified by:
 // Created:     29/01/98
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>

-// Licence:    wxWindows license
+// Licence:     wxWindows license

 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef   _WX_DEBUG_H_
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef   _WX_DEBUG_H_


@@ -14,19 +14,21 @@
 
 #include  <assert.h>
 
 
 #include  <assert.h>
 

+#include  "wx/wxchar.h"
+

 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------

-/** 
-  @name Debugging macros 
+/**
+  @name Debugging macros

 
   All debugging macros rely on ASSERT() which in turn calls 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
 
   All debugging macros rely on ASSERT() which in turn calls 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

-  (popping up a message box in your favourite GUI, sending you e-mail or 
+  (popping up a message box in your favourite GUI, sending you e-mail or

   whatever) it will affect all ASSERTs, FAILs and CHECKs in your code.
   <BR>
   <BR>
   whatever) it will affect all ASSERTs, FAILs and CHECKs in your code.
   <BR>
   <BR>

-  <b>Warning</b>: if you don't like advices on programming style, don't read 
+  <b>Warning</b>: if you don't like advices on programming style, don't read

   further! ;-)
   <BR>
   <BR>
   further! ;-)
   <BR>
   <BR>


@@ -41,6 +43,10 @@
 // ----------------------------------------------------------------------------
 //@{
 
 // ----------------------------------------------------------------------------
 //@{
 

+// Use of these suppresses compiler warnings about testing constant expression
+WXDLLEXPORT_DATA(extern const bool) wxTrue;
+WXDLLEXPORT_DATA(extern const bool) wxFalse;
+

 /** @name Macros which are completely disabled in 'release' mode */
 //@{
 #ifdef  __WXDEBUG__
 /** @name Macros which are completely disabled in 'release' mode */
 //@{
 #ifdef  __WXDEBUG__


@@ -51,12 +57,13 @@
   @param   szFile and nLine - file name and line number of the ASSERT
            szMsg            - optional message explaining the reason
   */
   @param   szFile and nLine - file name and line number of the ASSERT
            szMsg            - optional message explaining the reason
   */

-  void WXDLLEXPORT wxOnAssert(const char *szFile, int nLine, const char *szMsg = (const char *) NULL);
+  void WXDLLEXPORT wxOnAssert(const wxChar *szFile, int nLine, const wxChar *szMsg = (const wxChar *) NULL);

 
   /// generic assert macro
 
   /// 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__)
+
+  /// assert with additional message explaining it's cause
+  #define   wxASSERT_MSG(x, m)  if ( !(x) ) wxOnAssert(__TFILE__, __LINE__, m)

 #else
   // nothing to do in release modes (hopefully at this moment there are
   // no more bugs ;-)
 #else
   // nothing to do in release modes (hopefully at this moment there are
   // no more bugs ;-)


@@ -64,21 +71,22 @@
   #define   wxASSERT_MSG(x, m)
 #endif  //__WXDEBUG__
 
   #define   wxASSERT_MSG(x, m)
 #endif  //__WXDEBUG__
 

-  /// special form of assert: always triggers it (in debug mode)
+/// special form of assert: always triggers it (in debug mode)

 #define   wxFAIL                 wxASSERT(wxFalse)
 #define   wxFAIL                 wxASSERT(wxFalse)

-  /// FAIL with some message
+
+/// FAIL with some message

 #define   wxFAIL_MSG(msg)        wxASSERT_MSG(wxFalse, msg)
 //@}
 
 // NB: these macros work also in release mode!
 
 #define   wxFAIL_MSG(msg)        wxASSERT_MSG(wxFalse, msg)
 //@}
 
 // NB: these macros work also in release mode!
 

-/** 
+/**

   These macros must be used only in invalid situation: for example, an
   invalid parameter (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!!") )
 
   These macros must be used only in invalid situation: for example, an
   invalid parameter (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!!") )
 

-  @name Macros which remain even in 'release' mode 
+  @name Macros which remain even in 'release' mode

 */
 //@{
   /// check that expression is true, "return" if not (also FAILs in debug mode)
 */
 //@{
   /// check that expression is true, "return" if not (also FAILs in debug mode)


@@ -100,4 +108,3 @@
 //@}
 
 #endif  // _WX_DEBUG_H_
 //@}
 
 #endif  // _WX_DEBUG_H_

-