Header Cosmetics

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

diff --git a/include/wx/debug.h b/include/wx/debug.h
index 93f394a60b1301d07f847e5c063c5e54b9eb61fc..1bb9ded462a094e7f4051deaed809796684ff774 100644 (file)
--- a/include/wx/debug.h
+++ b/include/wx/debug.h
@@ -6,7 +6,7 @@
 // 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_
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef   _WX_DEBUG_H_


@@ -55,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.


@@ -68,7 +68,7 @@
 // Macros which are completely disabled in 'release' mode
 //
 // NB: these functions are implemented in src/common/appcmn.cpp
 // Macros which are completely disabled in 'release' mode
 //
 // NB: these functions are implemented in src/common/appcmn.cpp

-#ifdef  __WXDEBUG__
+#if defined(__cplusplus) && defined(__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
   /*
     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


@@ -78,25 +78,25 @@
        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 *szCond,
-                                     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();
+  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
 
   // 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 WXDLLEXPORT wxAssert(int cond,
-                                   const wxChar *szFile,
-                                   int nLine,
-                                   const wxChar *szCond,
-                                   const wxChar *szMsg = NULL) ;
+  extern void WXDLLIMPEXP_BASE wxAssert(int cond,
+                                        const wxChar *szFile,
+                                        int nLine,
+                                        const wxChar *szCond,
+                                        const wxChar *szMsg = NULL) ;

 
   // generic assert macro
   #define wxASSERT(cond) wxAssert(!!(cond), __TFILE__, __LINE__, _T(#cond))
 
   // generic assert macro
   #define wxASSERT(cond) wxAssert(!!(cond), __TFILE__, __LINE__, _T(#cond))


@@ -112,7 +112,7 @@
   //
   // 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 shouldn't be
   //     used any longer

-  extern bool WXDLLEXPORT wxAssertIsEqual(int x, int y);
+  extern bool WXDLLIMPEXP_BASE wxAssertIsEqual(int x, int y);

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


@@ -122,9 +122,12 @@
   #define wxASSERT_MSG(x, m)
 #endif  //__WXDEBUG__
 
   #define wxASSERT_MSG(x, m)
 #endif  //__WXDEBUG__
 

-// Use of wxFalse instead of FALSE suppresses compiler warnings about testing
-// constant expression
-WXDLLEXPORT_DATA(extern const bool) wxFalse;
+#ifdef __cplusplus
+    // Use of wxFalse instead of FALSE suppresses compiler warnings about testing
+    // constant expression
+    WXDLLIMPEXP_DATA_BASE(extern const bool) wxFalse;
+#endif
+

 #define wxAssertFailure wxFalse
 
 // special form of assert: always triggers it (in debug mode)
 #define wxAssertFailure wxFalse
 
 // special form of assert: always triggers it (in debug mode)


@@ -181,19 +184,9 @@ WXDLLEXPORT_DATA(extern const bool) wxFalse;
   particular, this is why we define a struct and not an object (which would
   result in a warning about unused variable) and a named struct (otherwise we'd
   get a warning about an unnamed struct not used to define an object!).
   particular, this is why we define a struct and not an object (which would
   result in a warning about unused variable) and a named struct (otherwise we'd
   get a warning about an unnamed struct not used to define an object!).

-  The _n__ part is to stop VC++ 7 being confused since it encloses __LINE++ in
-  parentheses. Unfortunately this does not work with MetroWerks CW so this fix
-  is being limited to VC++.

  */
 
  */
 

-#define wxMAKE_ASSERT_NAME_HELPER(line)     wxAssert_ ## line
-#define wxMAKE_ASSERT_NAME(line)            wxMAKE_ASSERT_NAME_HELPER(line)
-#ifdef __VISUALC__
-#define wxMAKE_UNIQUE_ASSERT_NAME           wxMAKE_ASSERT_NAME(_n___ ## __LINE__)
-#else
-#define wxMAKE_UNIQUE_ASSERT_NAME           wxMAKE_ASSERT_NAME(__LINE__)
-#endif
-#define wxMAKE_UNIQUE_ASSERT_NAME2(text)    wxMAKE_ASSERT_NAME(text)
+#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


@@ -206,6 +199,13 @@ 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; }
 
 #define wxCOMPILE_TIME_ASSERT2(expr, msg, text) \
     struct wxMAKE_UNIQUE_ASSERT_NAME2(text) { unsigned int msg: expr; }
 


@@ -218,5 +218,21 @@ 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 __cplusplus
+    #ifdef __WXMAC__
+        extern bool WXDLLIMPEXP_BASE wxIsDebuggerRunning();
+    #else // !Mac
+        inline bool wxIsDebuggerRunning() { return false; }
+    #endif // Mac/!Mac
+#endif //__cplusplus
+

 #endif  // _WX_DEBUG_H_
 
 #endif  // _WX_DEBUG_H_