wxWidgets defines three families of the assert-like macros: the wxASSERT() and wxFAIL() macros only do anything if __WXDEBUG__ is defined (in other words, in the debug build) but disappear completely in the release build. On the other hand, the wxCHECK() macros stay in release builds but a check failure doesn't generate any user-visible effects. Finally, the compile time assertions don't happen during the run-time but result in the compilation error messages if the condition they check fail.
Related class group: Debugging.
Defines | |
#define | wxDEBUG_LEVEL |
Preprocessor symbol defining the level of debug support available. | |
#define | wxASSERT(condition) |
Assert macro. | |
#define | wxASSERT_LEVEL_2(condition) |
Assert macro for expensive run-time checks. | |
#define | wxASSERT_LEVEL_2_MSG(condition, msg) |
Assert macro with a custom message for expensive run-time checks. | |
#define | wxASSERT_MIN_BITSIZE(type, size) |
This macro results in a compile time assertion failure if the size of the given type is less than size bits. | |
#define | wxASSERT_MSG(condition, message) |
Assert macro with message. | |
#define | wxCHECK(condition, retValue) |
Checks that the condition is true, returns with the given return value if not (stops execution in debug mode). | |
#define | wxCHECK_MSG(condition, retValue, message) |
Checks that the condition is true, returns with the given return value if not (stops execution in debug mode). | |
#define | wxCHECK_RET(condition, message) |
Checks that the condition is true, and returns if not (stops execution with the given error message in debug mode). | |
#define | wxCHECK2(condition, operation) |
Checks that the condition is true, and if not, it will wxFAIL() and execute the given operation if it is not. | |
#define | wxCHECK2_MSG(condition, operation, message) |
This is the same as wxCHECK2(), but wxFAIL_MSG() with the specified message is called instead of wxFAIL() if the condition is false. | |
#define | wxCOMPILE_TIME_ASSERT(condition, message) |
Using wxCOMPILE_TIME_ASSERT() results in a compilation error if the specified condition is false. | |
#define | wxCOMPILE_TIME_ASSERT2(condition, message, name) |
This macro is identical to wxCOMPILE_TIME_ASSERT() except that it allows you to specify a unique name for the struct internally defined by this macro to avoid getting the compilation errors described for wxCOMPILE_TIME_ASSERT(). | |
#define | wxFAIL |
Will always generate an assert error if this code is reached (in debug mode). | |
#define | wxFAIL_MSG(message) |
Will always generate an assert error with specified message if this code is reached (in debug mode). | |
#define | WXDEBUG_NEW(arg) |
This is defined in debug mode to be call the redefined new operator with filename and line number arguments. | |
Typedefs | |
typedef void(* | wxAssertHandler_t )(const wxString &file, int line, const wxString &func, const wxString &cond, const wxString &msg) |
Type for the function called in case of assert failure. | |
Functions | |
void | wxDisableAsserts () |
Disable the condition checks in the assertions. | |
bool | wxIsDebuggerRunning () |
Returns true if the program is running under debugger, false otherwise. | |
wxAssertHandler_t | wxSetAssertHandler (wxAssertHandler_t handler) |
Sets the function to be called in case of assertion failure. | |
void | wxTrap () |
In debug mode (when __WXDEBUG__ is defined) this function generates a debugger exception meaning that the control is passed to the debugger if one is attached to the process. |
#define wxASSERT | ( | condition | ) |
Assert macro.
An error message will be generated if the condition is false in debug mode, but nothing will be done in the release build.
Please note that the condition in wxASSERT() should have no side effects because it will not be executed in release mode at all.
This macro should be used to catch (in debug builds) logical errors done by the programmer.
#include <wx/debug.h>
#define wxASSERT_LEVEL_2 | ( | condition | ) |
Assert macro for expensive run-time checks.
This macro does nothing unless wxDEBUG_LEVEL is 2 or more and is meant to be used for the assertions with noticeable performance impact and which, hence, should be disabled during run-time.
If wxDEBUG_LEVEL is 2 or more, it becomes the same as wxASSERT().
Include file:
#include <wx/debug.h>
#define wxASSERT_LEVEL_2_MSG | ( | condition, | |||
msg | ) |
Assert macro with a custom message for expensive run-time checks.
If wxDEBUG_LEVEL is 2 or more, this is the same as wxASSERT_MSG(), otherwise it doesn't do anything at all.
#include <wx/debug.h>
#define wxASSERT_MIN_BITSIZE | ( | type, | |||
size | ) |
This macro results in a compile time assertion failure if the size of the given type
is less than size
bits.
This macro should be used to catch (in debug builds) logical errors done by the programmer.
You may use it like this, for example:
// we rely on the int being able to hold values up to 2^32 wxASSERT_MIN_BITSIZE(int, 32); // can't work with the platforms using UTF-8 for wchar_t wxASSERT_MIN_BITSIZE(wchar_t, 16);
Include file:
#include <wx/debug.h>
#define wxASSERT_MSG | ( | condition, | |||
message | ) |
Assert macro with message.
An error message will be generated if the condition is false.
This macro should be used to catch (in debug builds) logical errors done by the programmer.
#include <wx/debug.h>
#define wxCHECK | ( | condition, | |||
retValue | ) |
Checks that the condition is true, returns with the given return value if not (stops execution in debug mode).
This check is done even in release mode.
This macro should be used to catch (both in debug and release builds) logical errors done by the programmer.
Include file:
#include <wx/debug.h>
#define wxCHECK2 | ( | condition, | |||
operation | ) |
Checks that the condition is true, and if not, it will wxFAIL() and execute the given operation
if it is not.
This is a generalisation of wxCHECK() and may be used when something else than just returning from the function must be done when the condition
is false. This check is done even in release mode.
This macro should be used to catch (both in debug and release builds) logical errors done by the programmer.
Include file:
#include <wx/debug.h>
#define wxCHECK2_MSG | ( | condition, | |||
operation, | |||||
message | ) |
This is the same as wxCHECK2(), but wxFAIL_MSG() with the specified message
is called instead of wxFAIL() if the condition
is false.
This macro should be used to catch (both in debug and release builds) logical errors done by the programmer.
Include file:
#include <wx/debug.h>
#define wxCHECK_MSG | ( | condition, | |||
retValue, | |||||
message | ) |
Checks that the condition is true, returns with the given return value if not (stops execution in debug mode).
This check is done even in release mode.
This macro may be only used in non-void functions, see also wxCHECK_RET().
This macro should be used to catch (both in debug and release builds) logical errors done by the programmer.
Include file:
#include <wx/debug.h>
#define wxCHECK_RET | ( | condition, | |||
message | ) |
Checks that the condition is true, and returns if not (stops execution with the given error message in debug mode).
This check is done even in release mode.
This macro should be used in void functions instead of wxCHECK_MSG().
This macro should be used to catch (both in debug and release builds) logical errors done by the programmer.
Include file:
#include <wx/debug.h>
#define wxCOMPILE_TIME_ASSERT | ( | condition, | |||
message | ) |
Using wxCOMPILE_TIME_ASSERT() results in a compilation error if the specified condition
is false.
The compiler error message should include the message
identifier - please note that it must be a valid C++ identifier and not a string unlike in the other cases.
This macro is mostly useful for testing the expressions involving the sizeof
operator as they can't be tested by the preprocessor but it is sometimes desirable to test them at the compile time.
Note that this macro internally declares a struct whose name it tries to make unique by using the __LINE__
in it but it may still not work if you use it on the same line in two different source files. In this case you may either change the line in which either of them appears on or use the wxCOMPILE_TIME_ASSERT2() macro.
Also note that Microsoft Visual C++ has a bug which results in compiler errors if you use this macro with 'Program Database For Edit And Continue' (/ZI
) option, so you shouldn't use it ('Program Database' (/Zi
) is ok though) for the code making use of this macro.
This macro should be used to catch misconfigurations at compile-time.
#include <wx/debug.h>
#define wxCOMPILE_TIME_ASSERT2 | ( | condition, | |||
message, | |||||
name | ) |
This macro is identical to wxCOMPILE_TIME_ASSERT() except that it allows you to specify a unique name
for the struct internally defined by this macro to avoid getting the compilation errors described for wxCOMPILE_TIME_ASSERT().
This macro should be used to catch misconfigurations at compile-time.
Include file:
#include <wx/debug.h>
#define wxDEBUG_LEVEL |
Preprocessor symbol defining the level of debug support available.
Currently wxDEBUG_LEVEL is 0 in release builds (__WXDEBUG__ not defined) and 1 in debug builds (it is). In the immediate future this will change however and this symbol will be defined directly as 0, 1 or 2 while __WXDEBUG__ won't be used by wxWidgets any longer.
Include file:
#include <wx/debug.h>
#define WXDEBUG_NEW | ( | arg | ) |
This is defined in debug mode to be call the redefined new operator with filename and line number arguments.
The definition is:
#define WXDEBUG_NEW new(__FILE__,__LINE__)
In non-debug mode, this is defined as the normal new operator.
Include file:
#include <wx/object.h>
#define wxFAIL |
Will always generate an assert error if this code is reached (in debug mode).
Note that you don't have to (and cannot) use brackets when invoking this macro:
if (...some condition...) { wxFAIL; }
This macro should be used to catch (in debug builds) logical errors done by the programmer.
#include <wx/debug.h>
#define wxFAIL_MSG | ( | message | ) |
Will always generate an assert error with specified message if this code is reached (in debug mode).
This macro is useful for marking unreachable" code areas, for example it may be used in the "default:" branch of a switch statement if all possible cases are processed above.
This macro should be used to catch (in debug builds) logical errors done by the programmer.
#include <wx/debug.h>
typedef void(* wxAssertHandler_t)(const wxString &file, int line, const wxString &func, const wxString &cond, const wxString &msg) |
void wxDisableAsserts | ( | ) |
Disable the condition checks in the assertions.
This is the same as calling wxSetAssertHandler() with NULL handler.
bool wxIsDebuggerRunning | ( | ) |
Returns true if the program is running under debugger, false otherwise.
Please note that this function is currently only implemented for Win32 and Mac builds using CodeWarrior and always returns false elsewhere.
Include file:
#include <wx/debug.h>
wxAssertHandler_t wxSetAssertHandler | ( | wxAssertHandler_t | handler | ) |
Sets the function to be called in case of assertion failure.
The default assert handler forwards to wxApp::OnAssertFailure() whose default behaviour is, in turn, to show the standard assertion failure dialog if a wxApp object exists or shows the same dialog itself directly otherwise.
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 need to provide your assertion handler function.
This function also provides a simple way to disable all asserts: simply pass NULL pointer to it. Doing this will result in not even evaluating assert conditions at all, avoiding almost all run-time cost of asserts.
Notice that this function is not MT-safe, so you should call it before starting any other threads.
The return value of this function is the previous assertion handler. It can be called after any pre-processing by your handler and can also be restored later if you uninstall your handler.
handler | The function to call in case of assertion failure or NULL. |
#include <wx/debug.h>
void wxTrap | ( | ) |
In debug mode (when __WXDEBUG__
is defined) this function generates a debugger exception meaning that the control is passed to the debugger if one is attached to the process.
Otherwise the program just terminates abnormally. In release mode this function does nothing.
Include file:
#include <wx/debug.h>
![]() |
[ top ] |