/////////////////////////////////////////////////////////////////////////////
-// 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>
-// Licence: wxWindows license
+// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
-#ifndef __DEBUGH__
-#define __DEBUGH__
+#ifndef _WX_DEBUG_H_
+#define _WX_DEBUG_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
- (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>
- <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>
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.
// ----------------------------------------------------------------------------
//@{
+// 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 __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
@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__)
+
+ /// 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 ;-)
#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(wxFalse)
- /// special form of assert: always triggers it (in debug mode)
-#define wxFAIL wxASSERT(0)
- /// FAIL with some message
-#define wxFAIL_MSG(msg) wxASSERT_MSG(0, msg)
+/// FAIL with some message
+#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!!") )
- @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)
-#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_
projects / wxWidgets.git / blobdiff