Fix another line somehow missing from the wxGraphicsBitmap forward port.

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

diff --git a/include/wx/debug.h b/include/wx/debug.h
index 41ec9bbba2e99689a1a97f1e57da221ab46a0589..80099fa4743c69269607a9c1f38b5ac2ed42d0cb 100644 (file)
--- a/include/wx/debug.h
+++ b/include/wx/debug.h
@@ -37,28 +37,29 @@ class WXDLLIMPEXP_FWD_BASE wxCStrData;
     2:  Maximal (at least for now): asserts which are "expensive"
         (performance-wise) or only make sense for finding errors in wxWidgets
         itself, as opposed to bugs in applications using it, are also enabled.
     2:  Maximal (at least for now): asserts which are "expensive"
         (performance-wise) or only make sense for finding errors in wxWidgets
         itself, as opposed to bugs in applications using it, are also enabled.

-
-    For compatibility reasons, currently wxDEBUG_LEVEL is defined if
-    __WXDEBUG__ is defined but in the near future (2.9.1) the role of the flags
-    will change and wxDEBUG_LEVEL will be the primary value with __WXDEBUG__
-    only used for compatibility.

  */
 
  */
 

-// if _DEBUG is defined (MS VC++ and others use it in debug builds), define
-// __WXDEBUG__ too
-#ifdef _DEBUG
+// unless wxDEBUG_LEVEL is predefined (by configure or via wx/setup.h under
+// Windows), use the default
+#if !defined(wxDEBUG_LEVEL)
+    #define wxDEBUG_LEVEL 1
+#endif // !defined(wxDEBUG_LEVEL)
+
+/*
+    __WXDEBUG__ is defined when wxDEBUG_LEVEL != 0. This is done mostly for
+    compatibility but it also provides a simpler way to check if asserts and
+    debug logging is enabled at all.
+ */
+#if wxDEBUG_LEVEL > 0

     #ifndef __WXDEBUG__
         #define __WXDEBUG__
     #ifndef __WXDEBUG__
         #define __WXDEBUG__

-    #endif // !__WXDEBUG__
-#endif // _DEBUG
-
-// if NDEBUG is defined (<assert.h> uses it), undef __WXDEBUG__ and WXDEBUG
-#ifdef NDEBUG
+    #endif
+#else

     #undef __WXDEBUG__
     #undef __WXDEBUG__

-    #undef WXDEBUG
-#endif // NDEBUG
+#endif

 
 

-// if __WXDEBUG__ is defined, make sure that WXDEBUG is defined and >= 1
+// Finally there is also a very old WXDEBUG macro not used anywhere at all, it
+// is only defined for compatibility.

 #ifdef __WXDEBUG__
     #if !defined(WXDEBUG) || !WXDEBUG
         #undef WXDEBUG
 #ifdef __WXDEBUG__
     #if !defined(WXDEBUG) || !WXDEBUG
         #undef WXDEBUG


@@ -66,15 +67,6 @@ class WXDLLIMPEXP_FWD_BASE wxCStrData;
     #endif // !WXDEBUG
 #endif // __WXDEBUG__
 
     #endif // !WXDEBUG
 #endif // __WXDEBUG__
 

-// temporarily define wxDEBUG_LEVEL as function of __WXDEBUG__
-#if !defined(wxDEBUG_LEVEL)
-    #ifdef __WXDEBUG__
-        #define wxDEBUG_LEVEL 1
-    #else
-        #define wxDEBUG_LEVEL 0
-    #endif
-#endif // !defined(wxDEBUG_LEVEL)
-

 // ----------------------------------------------------------------------------
 // Handling assertion failures
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // Handling assertion failures
 // ----------------------------------------------------------------------------


@@ -105,7 +97,7 @@ extern WXDLLIMPEXP_DATA_BASE(wxAssertHandler_t) wxTheAssertHandler;
 
     While usually it is enough -- and more convenient -- to just override
     OnAssertFailure(), to handle all assertion failures, including those
 
     While usually it is enough -- and more convenient -- to just override
     OnAssertFailure(), to handle all assertion failures, including those

-    occurring even before wxApp object creation of after its destruction you
+    occurring even before wxApp object creation or after its destruction you

     need to provide your assertion handler function.
 
     This function also provides a simple way to disable all asserts: simply
     need to provide your assertion handler function.
 
     This function also provides a simple way to disable all asserts: simply


@@ -126,9 +118,17 @@ inline wxAssertHandler_t wxSetAssertHandler(wxAssertHandler_t handler)
     return old;
 }
 
     return old;
 }
 

+/*
+    Reset the default assert handler.
+
+    This may be used to enable asserts, which are disabled by default in this
+    case, for programs built in release build (NDEBUG defined).
+ */
+extern void WXDLLIMPEXP_BASE wxSetDefaultAssertHandler();
+

 #else // !wxDEBUG_LEVEL
 
 #else // !wxDEBUG_LEVEL
 

-// provide empty subs in case assertions are completely disabled
+// provide empty stubs in case assertions are completely disabled

 //
 // NB: can't use WXUNUSED() here as we're included from wx/defs.h before it is
 //     defined
 //
 // NB: can't use WXUNUSED() here as we're included from wx/defs.h before it is
 //     defined


@@ -137,11 +137,26 @@ inline wxAssertHandler_t wxSetAssertHandler(wxAssertHandler_t /* handler */)
     return NULL;
 }
 
     return NULL;
 }
 

+inline void wxSetDefaultAssertHandler() { }
+

 #endif // wxDEBUG_LEVEL/!wxDEBUG_LEVEL
 
 // simply a synonym for wxSetAssertHandler(NULL)
 inline void wxDisableAsserts() { wxSetAssertHandler(NULL); }
 
 #endif // wxDEBUG_LEVEL/!wxDEBUG_LEVEL
 
 // simply a synonym for wxSetAssertHandler(NULL)
 inline void wxDisableAsserts() { wxSetAssertHandler(NULL); }
 

+/*
+    A macro which disables asserts for applications compiled in release build.
+
+    By default, IMPLEMENT_APP (or rather IMPLEMENT_WXWIN_MAIN) disable the
+    asserts in the applications compiled in the release build by calling this.
+    It does nothing if NDEBUG is not defined.
+ */
+#ifdef NDEBUG
+    #define wxDISABLE_ASSERTS_IN_RELEASE_BUILD() wxDisableAsserts()
+#else
+    #define wxDISABLE_ASSERTS_IN_RELEASE_BUILD()
+#endif
+

 #if wxDEBUG_LEVEL
 
 /*
 #if wxDEBUG_LEVEL
 
 /*


@@ -259,7 +274,10 @@ extern void WXDLLIMPEXP_BASE wxOnAssert(const char *file,
     // wxFAIL is a special form of assert: it always triggers (and so is
     // usually used in normally unreachable code)
     #define wxFAIL_COND_MSG(cond, msg) \
     // wxFAIL is a special form of assert: it always triggers (and so is
     // usually used in normally unreachable code)
     #define wxFAIL_COND_MSG(cond, msg) \

-        wxOnAssert(__FILE__, __LINE__,  __WXFUNCTION__, cond, msg)
+        if ( !wxTheAssertHandler )                                            \
+        {}                                                                    \
+        else                                                                  \
+            wxOnAssert(__FILE__, __LINE__,  __WXFUNCTION__, cond, msg)

     #define wxFAIL_MSG(msg) wxFAIL_COND_MSG("Assert failure", msg)
     #define wxFAIL wxFAIL_MSG((const char*)NULL)
 #else // !wxDEBUG_LEVEL
     #define wxFAIL_MSG(msg) wxFAIL_COND_MSG("Assert failure", msg)
     #define wxFAIL wxFAIL_MSG((const char*)NULL)
 #else // !wxDEBUG_LEVEL