diff options
| author | Martin Hořeňovský | 2024-10-27 17:08:47 +0100 |
|---|---|---|
| committer | Martin Hořeňovský | 2024-10-27 20:27:03 +0100 |
| commit | e26028880790addff43cc5546de1e39214d86a04 (patch) | |
| tree | 0d3dede7149aa56198e6b0ecb0f8752eb005eeb7 /docs | |
| parent | 7c2e1fb1b210cf1710549fd8b2df37d700b90178 (diff) | |
| download | catch3-e26028880790addff43cc5546de1e39214d86a04.tar.gz | |
Allow disabling use of __builtin_constant_p in internal macros
Turns out that even in GCC, the expression in `__builtin_cosntant_p`
can end up evaluated and side-effects executed. To allow users to
work around this bug, I added a configuration option to disable its
use in internal macros.
Related to #2925
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/configuration.md | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/configuration.md b/docs/configuration.md index 8a3ddfab..f268ba50 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -158,11 +158,14 @@ by using `_NO_` in the macro, e.g. `CATCH_CONFIG_NO_CPP17_UNCAUGHT_EXCEPTIONS`. CATCH_CONFIG_ANDROID_LOGWRITE // Use android's logging system for debug output CATCH_CONFIG_GLOBAL_NEXTAFTER // Use nextafter{,f,l} instead of std::nextafter CATCH_CONFIG_GETENV // System has a working `getenv` + CATCH_CONFIG_USE_BUILTIN_CONSTANT_P // Use __builtin_constant_p to trigger warnings > [`CATCH_CONFIG_ANDROID_LOGWRITE`](https://github.com/catchorg/Catch2/issues/1743) and [`CATCH_CONFIG_GLOBAL_NEXTAFTER`](https://github.com/catchorg/Catch2/pull/1739) were introduced in Catch2 2.10.0 > `CATCH_CONFIG_GETENV` was [introduced](https://github.com/catchorg/Catch2/pull/2562) in Catch2 3.2.0 +> `CATCH_CONFIG_USE_BUILTIN_CONSTANT_P` was introduced in Catch2 vX.Y.Z + Currently Catch enables `CATCH_CONFIG_WINDOWS_SEH` only when compiled with MSVC, because some versions of MinGW do not have the necessary Win32 API support. `CATCH_CONFIG_POSIX_SIGNALS` is on by default, except when Catch is compiled under `Cygwin`, where it is disabled by default (but can be force-enabled by defining `CATCH_CONFIG_POSIX_SIGNALS`). @@ -183,6 +186,12 @@ With the exception of `CATCH_CONFIG_EXPERIMENTAL_REDIRECT`, these toggles can be disabled by using `_NO_` form of the toggle, e.g. `CATCH_CONFIG_NO_WINDOWS_SEH`. +`CATCH_CONFIG_USE_BUILTIN_CONSTANT_P` is ON by default for Clang and GCC +(but as far as possible, not for other compilers masquerading for these +two). However, it can cause bugs where the enclosed code is evaluated, even +though it should not be, e.g. in [#2925](https://github.com/catchorg/Catch2/issues/2925). + + ### `CATCH_CONFIG_FAST_COMPILE` This compile-time flag speeds up compilation of assertion macros by ~20%, by disabling the generation of assertion-local try-catch blocks for |