Base API configuration options for assertions
The Base API supports quality software development with assertions. They are contained in various places in the Base API include files.
These tests are switched off by default to have the performance of a release build. To activate the tests, you need to define the two macros mi::base::mi_base_assert() and mi::base::mi_base_assert_msg() before including the relevant include files. Defining only one of the two macros is considered an error. These macros and their parameters have the following meaning:
- mi::base::mi_base_assert(expr)
-
If expr evaluates to true this macro shall have no effect. If expr evaluates to false this macro may print a diagnostic message and change the control flow of the program, such as aborting the program or throwing an exception. But it may also have no effect at all, for example if assertions are configured to be disabled.
- mi::base::mi_base_assert_msg(expr, msg)
-
Same behavior as mi::base::mi_base_assert(expr), but the msg text string contains additional diagnostic information that may be shown with a diagnostic message. Typical usages would contain precondition or postcondition as clarifying context information in the msg parameter.