Applied patch [ 819044 ] Adds MSW wxPen::GetDashCount

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

diff --git a/include/wx/debug.h b/include/wx/debug.h
index 10966502ec7592d7610e00a87d1e607d95c2e81a..649550d08c8e0484d51aa924b98ca7dbd8098079 100644 (file)
--- a/include/wx/debug.h
+++ b/include/wx/debug.h
@@ -6,13 +6,15 @@
 // Created:     29/01/98
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
 // Created:     29/01/98
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>

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

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

+#ifndef __WXWINCE__

 #include  <assert.h>
 #include  <assert.h>

+#endif

 #include  <limits.h>            // for CHAR_BIT used below
 
 #include  "wx/wxchar.h"         // for __TFILE__ and wxChar
 #include  <limits.h>            // for CHAR_BIT used below
 
 #include  "wx/wxchar.h"         // for __TFILE__ and wxChar


@@ -53,11 +55,11 @@
 // (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.
 //
 // (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.
 //

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

 // further! ;-)
 //
 // Extensive use of these macros is recommended! Remember that ASSERTs are
 // further! ;-)
 //
 // Extensive use of these macros is recommended! Remember that ASSERTs are

-// disabled in final (without __WXDEBUG__ defined) build, so they add strictly
+// disabled in final build (without __WXDEBUG__ defined), 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.
 // 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.


@@ -76,39 +78,41 @@
        szFile and nLine - file name and line number of the ASSERT
        szMsg            - optional message explaining the reason
   */
        szFile and nLine - file name and line number of the ASSERT
        szMsg            - optional message explaining the reason
   */

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

 
 

-  // call this function to break into the debugger uncodnitionally (assuming
+  // call this function to break into the debugger unconditionally (assuming

   // the program is running under debugger, of course)
   // the program is running under debugger, of course)

-  extern void WXDLLEXPORT wxTrap();
-
-  /*
-    notice the usage of else at the end of wxASSERT macro: this ensures that
-    the following code
-
-        if ( ... )
-            wxASSERT(...);
-        else
-            ...
-
-    works like expected: if there were no "else", the one in the code above
-    would be matched with a wrong "if"
-  */
+  extern void WXDLLIMPEXP_BASE wxTrap();
+
+  // helper function used to implement wxASSERT and wxASSERT_MSG
+  //
+  // note using "int" and not "bool" for cond to avoid VC++ warnings about
+  // implicit conversions when doing "wxAssert( pointer )" and also use of
+  // "!!cond" below to ensure that everything is converted to int
+  extern void WXDLLIMPEXP_BASE wxAssert(int cond,
+                                        const wxChar *szFile,
+                                        int nLine,
+                                        const wxChar *szCond,
+                                        const wxChar *szMsg = NULL) ;

 
   // generic assert macro
 
   // generic assert macro

-  #define wxASSERT(cond) if ( !(cond) ) wxOnAssert(__TFILE__, __LINE__); else
+  #define wxASSERT(cond) wxAssert(!!(cond), __TFILE__, __LINE__, _T(#cond))

 
   // assert with additional message explaining it's cause
   #define wxASSERT_MSG(cond, msg) \
 
   // assert with additional message explaining it's cause
   #define wxASSERT_MSG(cond, msg) \

-                    if ( !(cond) ) wxOnAssert(__TFILE__, __LINE__, msg); else
+    wxAssert(!!(cond), __TFILE__, __LINE__, _T(#cond), msg)

 
   // 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) )
 
   // 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) )

-  extern bool WXDLLEXPORT wxAssertIsEqual(int x, int y);
+  //
+  // NB: this is made obsolete by wxCOMPILE_TIME_ASSERT() and shouldn't be
+  //     used any longer
+  extern bool WXDLLIMPEXP_BASE wxAssertIsEqual(int x, int y);

 #else
   #define wxTrap()
 
 #else
   #define wxTrap()
 


@@ -120,13 +124,14 @@
 
 // Use of wxFalse instead of FALSE suppresses compiler warnings about testing
 // constant expression
 
 // Use of wxFalse instead of FALSE suppresses compiler warnings about testing
 // constant expression

-WXDLLEXPORT_DATA(extern const bool) wxFalse;
+WXDLLIMPEXP_DATA_BASE(extern const bool) wxFalse;
+#define wxAssertFailure wxFalse

 
 // 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(wxAssertFailure)

 
 // FAIL with some message
 
 // FAIL with some message

-#define wxFAIL_MSG(msg)        wxASSERT_MSG(wxFalse, msg)
+#define wxFAIL_MSG(msg)        wxASSERT_MSG(wxAssertFailure, msg)

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


@@ -178,9 +183,7 @@ WXDLLEXPORT_DATA(extern const bool) wxFalse;
   get a warning about an unnamed struct not used to define an object!).
  */
 
   get a warning about an unnamed struct not used to define an object!).
  */
 

-#define wxMAKE_ASSERT_NAME_HELPER(line) wxAssert_ ## line
-#define wxMAKE_ASSERT_NAME(line)        wxMAKE_ASSERT_NAME_HELPER(line)
-#define wxMAKE_UNIQUE_ASSERT_NAME       wxMAKE_ASSERT_NAME(__LINE__)
+#define wxMAKE_UNIQUE_ASSERT_NAME           wxMAKE_UNIQUE_NAME(wxAssert_)

 
 /*
   The second argument of this macro must be a valid C++ identifier and not a
 
 /*
   The second argument of this macro must be a valid C++ identifier and not a


@@ -193,6 +196,16 @@ WXDLLEXPORT_DATA(extern const bool) wxFalse;
 #define wxCOMPILE_TIME_ASSERT(expr, msg) \
     struct wxMAKE_UNIQUE_ASSERT_NAME { unsigned int msg: expr; }
 
 #define wxCOMPILE_TIME_ASSERT(expr, msg) \
     struct wxMAKE_UNIQUE_ASSERT_NAME { unsigned int msg: expr; }
 

+/*
+   When using VC++ 6 with "Edit and Continue" on, the compiler completely
+   mishandles __LINE__ and so wxCOMPILE_TIME_ASSERT() doesn't work, provide a
+   way to make "unique" assert names by specifying a unique prefix explicitly
+ */
+#define wxMAKE_UNIQUE_ASSERT_NAME2(text) wxCONCAT(wxAssert_, text)
+
+#define wxCOMPILE_TIME_ASSERT2(expr, msg, text) \
+    struct wxMAKE_UNIQUE_ASSERT_NAME2(text) { unsigned int msg: expr; }
+

 // helpers for wxCOMPILE_TIME_ASSERT below, for private use only
 #define wxMAKE_BITSIZE_MSG(type, size) type ## SmallerThan ## size ## Bits
 
 // helpers for wxCOMPILE_TIME_ASSERT below, for private use only
 #define wxMAKE_BITSIZE_MSG(type, size) type ## SmallerThan ## size ## Bits
 


@@ -202,5 +215,19 @@ WXDLLEXPORT_DATA(extern const bool) wxFalse;
     wxCOMPILE_TIME_ASSERT(sizeof(type) * CHAR_BIT >= size, \
                           wxMAKE_BITSIZE_MSG(type, size))
 
     wxCOMPILE_TIME_ASSERT(sizeof(type) * CHAR_BIT >= size, \
                           wxMAKE_BITSIZE_MSG(type, size))
 

+// ----------------------------------------------------------------------------
+// other miscellaneous debugger-related functions
+// ----------------------------------------------------------------------------
+
+// return true if we're running under debugger
+//
+// currently this only really works under Mac in CodeWarrior builds, it always
+// returns false otherwise
+#ifdef __WXMAC__
+    extern bool WXDLLIMPEXP_BASE wxIsDebuggerRunning();
+#else // !Mac
+    inline bool wxIsDebuggerRunning() { return false; }
+#endif // Mac/!Mac
+

 #endif  // _WX_DEBUG_H_
 
 #endif  // _WX_DEBUG_H_