Skip to content

Latest commit

 

History

History
47 lines (27 loc) · 1.92 KB

handling_asserts.md

File metadata and controls

47 lines (27 loc) · 1.92 KB

Handling asserts

This library uses a simple system to handle asserts. Asserts are fatal and must terminate otherwise the behavior is undefined if execution continues.

A total of 4 behaviors are supported:

  • We can print to stderr and abort
  • We can throw an exception
  • We can call a custom function
  • Do nothing and strip the check at compile time (default behavior)

Everything necessary is implemented in acl/core/error.h. See acl/config.h for details.

*Note: It is NOT possible to have different assert behaviors in two or more C++ files. All the C++ files within your static or dynamic library that reference ACL must all use the same assert handling strategy. In other words, you cannot enable the asserts for compression and disable them for decompression if the code lives within the same static or dynamic library.

Aborting

In order to enable the aborting behavior, simply define the macro ACL_ON_ASSERT_ABORT:

#define ACL_ON_ASSERT_ABORT

Throwing

In order to enable the throwing behavior, simply define the macro ACL_ON_ASSERT_THROW:

#define ACL_ON_ASSERT_THROW

Note that the type of the exception thrown is std::runtime_error.

Custom function

In order to enable the custom function calling behavior, define the macro ACL_ON_ASSERT_CUSTOM with the name of the function to call:

#define ACL_ON_ASSERT_CUSTOM on_custom_assert_impl

Note that the function signature is as follow: void on_custom_assert_impl(const char* expression, int line, const char* file, const char* format, ...) {}

You can also define your own assert implementation by defining the ACL_ASSERT macro as well:

#define ACL_ON_ASSERT_CUSTOM
#define ACL_ASSERT(expression, format, ...) checkf(expression, ANSI_TO_TCHAR(format), #__VA_ARGS__)

No checks

By default if no macro mentioned above is defined, all asserts will be stripped at compile time.