3rd-party/catch2
1
0
Fork 0
mirror of https://github.com/catchorg/Catch2.git synced 2024-11-22 13:26:10 +01:00
Code Issues Packages Projects Releases Wiki Activity

Fixup TOC script sluggification and documentation

Browse Source
This commit is contained in:
Martin Hořeňovský 2018-09-09 16:16:49 +02:00
parent a212fb440b
commit 46e99e258f
4 changed files with 144 additions and 119 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/configuration.md
View File

@ -3,14 +3,15 @@
**Contents**<br> **Contents**<br>
[main()/ implementation](#main-implementation)<br> [main()/ implementation](#main-implementation)<br>
[Reporter / Listener interfaces](#reporter--listener-interfaces)<br>
[Prefixing Catch macros](#prefixing-catch-macros)<br> [Prefixing Catch macros](#prefixing-catch-macros)<br>
[Terminal colour](#terminal-colour)<br> [Terminal colour](#terminal-colour)<br>
[Console width](#console-width)<br> [Console width](#console-width)<br>
[stdout](#stdout)<br> [stdout](#stdout)<br>
[Fallback stringifier](#fallback-stringifier)<br> [Fallback stringifier](#fallback-stringifier)<br>
[Default reporter](#default-reporter)<br> [Default reporter](#default-reporter)<br>
[C++11 toggles](#c-11-toggles)<br> [C++11 toggles](#c11-toggles)<br>
[C++17 toggles](#c-17-toggles)<br> [C++17 toggles](#c17-toggles)<br>
[Other toggles](#other-toggles)<br> [Other toggles](#other-toggles)<br>
[Windows header clutter](#windows-header-clutter)<br> [Windows header clutter](#windows-header-clutter)<br>
[Enabling stringification](#enabling-stringification)<br> [Enabling stringification](#enabling-stringification)<br>
@ -27,7 +28,7 @@ Nonetheless there are still some occasions where finer control is needed. For th
Although Catch is header only it still, internally, maintains a distinction between interface headers and headers that contain implementation. Only one source file in your test project should compile the implementation headers and this is controlled through the use of one of these macros - one of these identifiers should be defined before including Catch in *exactly one implementation file in your project*. Although Catch is header only it still, internally, maintains a distinction between interface headers and headers that contain implementation. Only one source file in your test project should compile the implementation headers and this is controlled through the use of one of these macros - one of these identifiers should be defined before including Catch in *exactly one implementation file in your project*.
# Reporter / Listener interfaces ## Reporter / Listener interfaces
CATCH_CONFIG_EXTERNAL_INTERFACES // Brings in necessary headers for Reporter/Listener implementation CATCH_CONFIG_EXTERNAL_INTERFACES // Brings in necessary headers for Reporter/Listener implementation

220
docs/release-notes.md
View File

@ -16,13 +16,15 @@
[Even Older versions](#even-older-versions)<br> [Even Older versions](#even-older-versions)<br>
# 2.4.0
## 2.4.0
**This release brings two new experimental features, generator support **This release brings two new experimental features, generator support
and a `-fno-exceptions` support. Being experimental means that they and a `-fno-exceptions` support. Being experimental means that they
will not be subject to the usual stability guarantees provided by semver.** will not be subject to the usual stability guarantees provided by semver.**
## Improvements ### Improvements
* Various small runtime performance improvements * Various small runtime performance improvements
* `CAPTURE` macro is now variadic * `CAPTURE` macro is now variadic
* Added `AND_GIVEN` macro (#1360) * Added `AND_GIVEN` macro (#1360)
@ -32,11 +34,11 @@ will not be subject to the usual stability guarantees provided by semver.**
* Doing so limits the functionality somewhat * Doing so limits the functionality somewhat
* Look [into the documentation](configuration.md#disablingexceptions) for details * Look [into the documentation](configuration.md#disablingexceptions) for details
## Fixes ### Fixes
* Suppressed `-Wnon-virtual-dtor` warnings in Matchers (#1357) * Suppressed `-Wnon-virtual-dtor` warnings in Matchers (#1357)
* Suppressed `-Wunreachable-code` warnings in floating point matchers (#1350) * Suppressed `-Wunreachable-code` warnings in floating point matchers (#1350)
## CMake ### CMake
* It is now possible to override which Python is used to run Catch's tests (#1365) * It is now possible to override which Python is used to run Catch's tests (#1365)
* Catch now provides infrastructure for adding tests that check compile-time configuration * Catch now provides infrastructure for adding tests that check compile-time configuration
* Catch no longer tries to install itself when used as a subproject (#1373) * Catch no longer tries to install itself when used as a subproject (#1373)
@ -45,7 +47,7 @@ will not be subject to the usual stability guarantees provided by semver.**
* This fixes conan installation of Catch * This fixes conan installation of Catch
# 2.3.0 ## 2.3.0
**This release changes the include paths provided by our CMake and **This release changes the include paths provided by our CMake and
pkg-config integration. The proper include path for the single-header pkg-config integration. The proper include path for the single-header
@ -56,7 +58,7 @@ than `single_include/catch.hpp`.**
## Fixes ### Fixes
* Fixed Objective-C++ build * Fixed Objective-C++ build
* `-Wunused-variable` suppression no longer leaks from Catch's header under Clang * `-Wunused-variable` suppression no longer leaks from Catch's header under Clang
* Implementation of the experimental new output capture can now be disabled (#1335) * Implementation of the experimental new output capture can now be disabled (#1335)
@ -64,7 +66,7 @@ than `single_include/catch.hpp`.**
* The JUnit and XML reporters will no longer skip over successful tests when running without `-s` (#1264, #1267, #1310) * The JUnit and XML reporters will no longer skip over successful tests when running without `-s` (#1264, #1267, #1310)
* See improvements for more details * See improvements for more details
## Improvements ### Improvements
* pkg-config and CMake integration has been rewritten * pkg-config and CMake integration has been rewritten
* If you use them, the new include path is `#include <catch2/catch.hpp>` * If you use them, the new include path is `#include <catch2/catch.hpp>`
* CMake installation now also installs scripts from `contrib/` * CMake installation now also installs scripts from `contrib/`
@ -76,12 +78,12 @@ than `single_include/catch.hpp`.**
* This means that you can do `DYNAMIC_SECTION("For X := " << x)`. * This means that you can do `DYNAMIC_SECTION("For X := " << x)`.
# 2.2.3 ## 2.2.3
**To fix some of the bugs, some behavior had to change in potentially breaking manner.** **To fix some of the bugs, some behavior had to change in potentially breaking manner.**
**This means that even though this is a patch release, it might not be a drop-in replacement.** **This means that even though this is a patch release, it might not be a drop-in replacement.**
## Fixes ### Fixes
* Listeners are now called before reporter * Listeners are now called before reporter
* This was always documented to be the case, now it actually works that way * This was always documented to be the case, now it actually works that way
* Catch's commandline will no longer accept multiple reporters * Catch's commandline will no longer accept multiple reporters
@ -100,23 +102,23 @@ than `single_include/catch.hpp`.**
* **This has potential to be a breaking change** * **This has potential to be a breaking change**
* Fixed compilation error when a type has an `operator<<` with templated lhs (#1285, #1306) * Fixed compilation error when a type has an `operator<<` with templated lhs (#1285, #1306)
## Improvements ### Improvements
* Added a new, experimental, output capture (#1243) * Added a new, experimental, output capture (#1243)
* This capture can also redirect output written via C apis, e.g. `printf` * This capture can also redirect output written via C apis, e.g. `printf`
* To opt-in, define `CATCH_CONFIG_EXPERIMENTAL_REDIRECT` in the implementation file * To opt-in, define `CATCH_CONFIG_EXPERIMENTAL_REDIRECT` in the implementation file
* Added a new fallback stringifier for classes derived from `std::exception` * Added a new fallback stringifier for classes derived from `std::exception`
* Both `StringMaker` specialization and `operator<<` overload are given priority * Both `StringMaker` specialization and `operator<<` overload are given priority
## Miscellaneous ### Miscellaneous
* `contrib/` now contains dbg scripts that skip over Catch's internals (#904, #1283) * `contrib/` now contains dbg scripts that skip over Catch's internals (#904, #1283)
* `gdbinit` for gdb `lldbinit` for lldb * `gdbinit` for gdb `lldbinit` for lldb
* `CatchAddTests.cmake` no longer strips whitespace from tests (#1265, #1281) * `CatchAddTests.cmake` no longer strips whitespace from tests (#1265, #1281)
* Online documentation now describes `--use-colour` option (#1263) * Online documentation now describes `--use-colour` option (#1263)
# 2.2.2 ## 2.2.2
## Fixes ### Fixes
* Fixed bug in `WithinAbs::match()` failing spuriously (#1228) * Fixed bug in `WithinAbs::match()` failing spuriously (#1228)
* Fixed clang-tidy diagnostic about virtual call in destructor (#1226) * Fixed clang-tidy diagnostic about virtual call in destructor (#1226)
* Reduced the number of GCC warnings suppression leaking out of the header (#1090, #1091) * Reduced the number of GCC warnings suppression leaking out of the header (#1090, #1091)
@ -125,7 +127,7 @@ than `single_include/catch.hpp`.**
* On platforms where `std::chrono::high_resolution_clock`'s resolution is low, the calibration would appear stuck * On platforms where `std::chrono::high_resolution_clock`'s resolution is low, the calibration would appear stuck
* Fixed compilation error when stringifying static arrays of `unsigned char`s (#1238) * Fixed compilation error when stringifying static arrays of `unsigned char`s (#1238)
## Improvements ### Improvements
* XML encoder now hex-encodes invalid UTF-8 sequences (#1207) * XML encoder now hex-encodes invalid UTF-8 sequences (#1207)
* This affects xml and junit reporters * This affects xml and junit reporters
* Some invalid UTF-8 parts are left as is, e.g. surrogate pairs. This is because certain extensions of UTF-8 allow them, such as WTF-8. * Some invalid UTF-8 parts are left as is, e.g. surrogate pairs. This is because certain extensions of UTF-8 allow them, such as WTF-8.
@ -134,29 +136,29 @@ than `single_include/catch.hpp`.**
* Added `PredicateMatcher`, a matcher that takes an arbitrary predicate function (#1236) * Added `PredicateMatcher`, a matcher that takes an arbitrary predicate function (#1236)
* See [documentation for details](https://github.com/catchorg/Catch2/blob/master/docs/matchers.md) * See [documentation for details](https://github.com/catchorg/Catch2/blob/master/docs/matchers.md)
## Others ### Others
* Modified CMake-installed pkg-config to allow `#include <catch.hpp>`(#1239) * Modified CMake-installed pkg-config to allow `#include <catch.hpp>`(#1239)
* The plans to standardize on `#include <catch2/catch.hpp>` are still in effect * The plans to standardize on `#include <catch2/catch.hpp>` are still in effect
# 2.2.1 ## 2.2.1
## Fixes ### Fixes
* Fixed compilation error when compiling Catch2 with `std=c++17` against libc++ (#1214) * Fixed compilation error when compiling Catch2 with `std=c++17` against libc++ (#1214)
* Clara (Catch2's CLI parsing library) used `std::optional` without including it explicitly * Clara (Catch2's CLI parsing library) used `std::optional` without including it explicitly
* Fixed Catch2 return code always being 0 (#1215) * Fixed Catch2 return code always being 0 (#1215)
* In the words of STL, "We feel superbad about letting this in" * In the words of STL, "We feel superbad about letting this in"
# 2.2.0 ## 2.2.0
## Fixes ### Fixes
* Hidden tests are not listed by default when listing tests (#1175) * Hidden tests are not listed by default when listing tests (#1175)
* This makes `catch_discover_tests` CMake script work better * This makes `catch_discover_tests` CMake script work better
* Fixed regression that meant `<windows.h>` could potentially not be included properly (#1197) * Fixed regression that meant `<windows.h>` could potentially not be included properly (#1197)
* Fixed installing `Catch2ConfigVersion.cmake` when Catch2 is a subproject. * Fixed installing `Catch2ConfigVersion.cmake` when Catch2 is a subproject.
## Improvements ### Improvements
* Added an option to warn (+ exit with error) when no tests were ran (#1158) * Added an option to warn (+ exit with error) when no tests were ran (#1158)
* Use as `-w NoTests` * Use as `-w NoTests`
* Added provisional support for Emscripten (#1114) * Added provisional support for Emscripten (#1114)
@ -168,38 +170,38 @@ than `single_include/catch.hpp`.**
* Added support for DJGPP DOS crosscompiler (#1206) * Added support for DJGPP DOS crosscompiler (#1206)
# 2.1.2 ## 2.1.2
## Fixes ### Fixes
* Fixed compilation error with `-fno-rtti` (#1165) * Fixed compilation error with `-fno-rtti` (#1165)
* Fixed NoAssertion warnings * Fixed NoAssertion warnings
* `operator<<` is used before range-based stringification (#1172) * `operator<<` is used before range-based stringification (#1172)
* Fixed `-Wpedantic` warnings (extra semicolons and binary literals) (#1173) * Fixed `-Wpedantic` warnings (extra semicolons and binary literals) (#1173)
## Improvements ### Improvements
* Added `CATCH_VERSION_{MAJOR,MINOR,PATCH}` macros (#1131) * Added `CATCH_VERSION_{MAJOR,MINOR,PATCH}` macros (#1131)
* Added `BrightYellow` colour for use in reporters (#979) * Added `BrightYellow` colour for use in reporters (#979)
* It is also used by ConsoleReporter for reconstructed expressions * It is also used by ConsoleReporter for reconstructed expressions
## Other changes ### Other changes
* Catch is now exported as a CMake package and linkable target (#1170) * Catch is now exported as a CMake package and linkable target (#1170)
# 2.1.1 ## 2.1.1
## Improvements ### Improvements
* Static arrays are now properly stringified like ranges across MSVC/GCC/Clang * Static arrays are now properly stringified like ranges across MSVC/GCC/Clang
* Embedded newer version of Clara -- v1.1.1 * Embedded newer version of Clara -- v1.1.1
* This should fix some warnings dragged in from Clara * This should fix some warnings dragged in from Clara
* MSVC's CLR exceptions are supported * MSVC's CLR exceptions are supported
## Fixes ### Fixes
* Fixed compilation when comparison operators do not return bool (#1147) * Fixed compilation when comparison operators do not return bool (#1147)
* Fixed CLR exceptions blowing up the executable during translation (#1138) * Fixed CLR exceptions blowing up the executable during translation (#1138)
## Other changes ### Other changes
* Many CMake changes * Many CMake changes
* `NO_SELFTEST` option is deprecated, use `BUILD_TESTING` instead. * `NO_SELFTEST` option is deprecated, use `BUILD_TESTING` instead.
* Catch specific CMake options were prefixed with `CATCH_` for namespacing purposes * Catch specific CMake options were prefixed with `CATCH_` for namespacing purposes
@ -207,9 +209,9 @@ than `single_include/catch.hpp`.**
# 2.1.0 ## 2.1.0
## Improvements ### Improvements
* Various performance improvements * Various performance improvements
* On top of the performance regression fixes * On top of the performance regression fixes
* Experimental support for PCH was added (#1061) * Experimental support for PCH was added (#1061)
@ -219,7 +221,7 @@ than `single_include/catch.hpp`.**
* Bugs in g++ 4.x and 5.x mean that some of them have to be left in * Bugs in g++ 4.x and 5.x mean that some of them have to be left in
## Fixes ### Fixes
* Fixed performance regression from Catch classic * Fixed performance regression from Catch classic
* One of the performance improvement patches for Catch classic was not applied to Catch2 * One of the performance improvement patches for Catch classic was not applied to Catch2
* Fixed platform detection for iOS (#1084) * Fixed platform detection for iOS (#1084)
@ -232,7 +234,7 @@ than `single_include/catch.hpp`.**
* Fixed `std::uncaught_exception` deprecation warning (#1124) * Fixed `std::uncaught_exception` deprecation warning (#1124)
## New features ### New features
* New Matchers * New Matchers
* Regex matcher for strings, `Matches`. * Regex matcher for strings, `Matches`.
* Set-equal matcher for vectors, `UnorderedEquals` * Set-equal matcher for vectors, `UnorderedEquals`
@ -241,15 +243,15 @@ than `single_include/catch.hpp`.**
* Containers are objects that respond to ADL `begin(T)` and `end(T)`. * Containers are objects that respond to ADL `begin(T)` and `end(T)`.
## Other changes ### Other changes
* Reporters will now be versioned in the `single_include` folder to ensure their compatibility with the last released version * Reporters will now be versioned in the `single_include` folder to ensure their compatibility with the last released version
# 2.0.1 ## 2.0.1
## Breaking changes ### Breaking changes
* Removed C++98 support * Removed C++98 support
* Removed legacy reporter support * Removed legacy reporter support
* Removed legacy generator support * Removed legacy generator support
@ -279,7 +281,7 @@ than `single_include/catch.hpp`.**
* `INFINITY == Approx(INFINITY)` returns true * `INFINITY == Approx(INFINITY)` returns true
## Improvements ### Improvements
* Reporters and Listeners can be defined in files different from the main file * Reporters and Listeners can be defined in files different from the main file
* The file has to define `CATCH_CONFIG_EXTERNAL_INTERFACES` before including catch.hpp. * The file has to define `CATCH_CONFIG_EXTERNAL_INTERFACES` before including catch.hpp.
* Errors that happen during set up before main are now caught and properly reported once main is entered * Errors that happen during set up before main are now caught and properly reported once main is entered
@ -313,7 +315,7 @@ than `single_include/catch.hpp`.**
* Add `pkg-config` support to CMake install command * Add `pkg-config` support to CMake install command
## Fixes ### Fixes
* Don't use console colour if running in XCode * Don't use console colour if running in XCode
* Explicit constructor in reporter base class * Explicit constructor in reporter base class
* Swept out `-Wweak-vtables`, `-Wexit-time-destructors`, `-Wglobal-constructors` warnings * Swept out `-Wweak-vtables`, `-Wexit-time-destructors`, `-Wglobal-constructors` warnings
@ -325,7 +327,7 @@ than `single_include/catch.hpp`.**
* Suppressed C4061 warning under MSVC * Suppressed C4061 warning under MSVC
## Internal changes ### Internal changes
* The development version now uses .cpp files instead of header files containing implementation. * The development version now uses .cpp files instead of header files containing implementation.
* This makes partial rebuilds much faster during development * This makes partial rebuilds much faster during development
* The expression decomposition layer has been rewritten * The expression decomposition layer has been rewritten
@ -333,13 +335,33 @@ than `single_include/catch.hpp`.**
* New library (TextFlow) is used for formatting text to output * New library (TextFlow) is used for formatting text to output
# Older versions ## Older versions
## 1.11.x ### 1.12.x
### 1.11.0 #### 1.12.2
##### Fixes
* Fixed missing <cassert> include
#### Fixes #### 1.12.1
##### Fixes
* Fixed deprecation warning in `ScopedMessage::~ScopedMessage`
* All uses of `min` or `max` identifiers are now wrapped in parentheses
* This avoids problems when Windows headers define `min` and `max` macros
#### 1.12.0
##### Fixes
* Fixed compilation for strict C++98 mode (ie not gnu++98) and older compilers (#1103)
* `INFO` messages are included in the `xml` reporter output even without `-s` specified.
### 1.11.x
#### 1.11.0
##### Fixes
* The original expression in `REQUIRE_FALSE( expr )` is now reporter properly as `!( expr )` (#1051) * The original expression in `REQUIRE_FALSE( expr )` is now reporter properly as `!( expr )` (#1051)
* Previously the parentheses were missing and `x != y` would be expanded as `!x != x` * Previously the parentheses were missing and `x != y` would be expanded as `!x != x`
* `Approx::Margin` is now inclusive (#952) * `Approx::Margin` is now inclusive (#952)
@ -347,7 +369,7 @@ than `single_include/catch.hpp`.**
* This means that `REQUIRE( 0.25f == Approx( 0.0f ).margin( 0.25f ) )` passes, instead of fails * This means that `REQUIRE( 0.25f == Approx( 0.0f ).margin( 0.25f ) )` passes, instead of fails
* `RandomNumberGenerator::result_type` is now unsigned (#1050) * `RandomNumberGenerator::result_type` is now unsigned (#1050)
#### Improvements ##### Improvements
* `__JETBRAINS_IDE__` macro handling is now CLion version specific (#1017) * `__JETBRAINS_IDE__` macro handling is now CLion version specific (#1017)
* When CLion 2017.3 or newer is detected, `__COUNTER__` is used instead of * When CLion 2017.3 or newer is detected, `__COUNTER__` is used instead of
* TeamCity reporter now explicitly flushes output stream after each report (#1057) * TeamCity reporter now explicitly flushes output stream after each report (#1057)
@ -355,35 +377,35 @@ than `single_include/catch.hpp`.**
* `ParseAndAddCatchTests` now can add test files as dependency to CMake configuration * `ParseAndAddCatchTests` now can add test files as dependency to CMake configuration
* This means you do not have to manually rerun CMake configuration step to detect new tests * This means you do not have to manually rerun CMake configuration step to detect new tests
## 1.10.x ### 1.10.x
### 1.10.0 #### 1.10.0
#### Fixes ##### Fixes
* Evaluation layer has been rewritten (backported from Catch 2) * Evaluation layer has been rewritten (backported from Catch 2)
* The new layer is much simpler and fixes some issues (#981) * The new layer is much simpler and fixes some issues (#981)
* Implemented workaround for VS 2017 raw string literal stringification bug (#995) * Implemented workaround for VS 2017 raw string literal stringification bug (#995)
* Fixed interaction between `[!shouldfail]` and `[!mayfail]` tags and sections * Fixed interaction between `[!shouldfail]` and `[!mayfail]` tags and sections
* Previously sections with failing assertions would be marked as failed, not failed-but-ok * Previously sections with failing assertions would be marked as failed, not failed-but-ok
#### Improvements ##### Improvements
* Added [libidentify](https://github.com/janwilmans/LibIdentify) support * Added [libidentify](https://github.com/janwilmans/LibIdentify) support
* Added "wait-for-keypress" option * Added "wait-for-keypress" option
## 1.9.x ### 1.9.x
### 1.9.6 #### 1.9.6
#### Improvements ##### Improvements
* Catch's runtime overhead has been significantly decreased (#937, #939) * Catch's runtime overhead has been significantly decreased (#937, #939)
* Added `--list-extra-info` cli option (#934). * Added `--list-extra-info` cli option (#934).
* It lists all tests together with extra information, ie filename, line number and description. * It lists all tests together with extra information, ie filename, line number and description.
### 1.9.5 #### 1.9.5
#### Fixes ##### Fixes
* Truthy expressions are now reconstructed properly, not as booleans (#914) * Truthy expressions are now reconstructed properly, not as booleans (#914)
* Various warnings are no longer erroneously suppressed in test files (files that include `catch.hpp`, but do not define `CATCH_CONFIG_MAIN` or `CATCH_CONFIG_RUNNER`) (#871) * Various warnings are no longer erroneously suppressed in test files (files that include `catch.hpp`, but do not define `CATCH_CONFIG_MAIN` or `CATCH_CONFIG_RUNNER`) (#871)
* Catch no longer fails to link when main is compiled as C++, but linked against Objective-C (#855) * Catch no longer fails to link when main is compiled as C++, but linked against Objective-C (#855)
@ -391,35 +413,35 @@ than `single_include/catch.hpp`.**
* Previously any GCC with minor version less than 3 would be incorrectly classified as not supporting `__COUNTER__`. * Previously any GCC with minor version less than 3 would be incorrectly classified as not supporting `__COUNTER__`.
* Suppressed C4996 warning caused by upcoming updated to MSVC 2017, marking `std::uncaught_exception` as deprecated. (#927) * Suppressed C4996 warning caused by upcoming updated to MSVC 2017, marking `std::uncaught_exception` as deprecated. (#927)
#### Improvements ##### Improvements
* CMake integration script now incorporates debug messages and registers tests in an improved way (#911) * CMake integration script now incorporates debug messages and registers tests in an improved way (#911)
* Various documentation improvements * Various documentation improvements
### 1.9.4 #### 1.9.4
#### Fixes ##### Fixes
* `CATCH_FAIL` macro no longer causes compilation error without variadic macro support * `CATCH_FAIL` macro no longer causes compilation error without variadic macro support
* `INFO` messages are no longer cleared after being reported once * `INFO` messages are no longer cleared after being reported once
#### Improvements and minor changes ##### Improvements and minor changes
* Catch now uses `wmain` when compiled under Windows and `UNICODE` is defined. * Catch now uses `wmain` when compiled under Windows and `UNICODE` is defined.
* Note that Catch still officially supports only ASCII * Note that Catch still officially supports only ASCII
### 1.9.3 #### 1.9.3
#### Fixes ##### Fixes
* Completed the fix for (lack of) uint64_t in earlier Visual Studios * Completed the fix for (lack of) uint64_t in earlier Visual Studios
### 1.9.2 #### 1.9.2
#### Improvements and minor changes ##### Improvements and minor changes
* All of `Approx`'s member functions now accept strong typedefs in C++11 mode (#888) * All of `Approx`'s member functions now accept strong typedefs in C++11 mode (#888)
* Previously `Approx::scale`, `Approx::epsilon`, `Approx::margin` and `Approx::operator()` didn't. * Previously `Approx::scale`, `Approx::epsilon`, `Approx::margin` and `Approx::operator()` didn't.
#### Fixes ##### Fixes
* POSIX signals are now disabled by default under QNX (#889) * POSIX signals are now disabled by default under QNX (#889)
* QNX does not support current enough (2001) POSIX specification * QNX does not support current enough (2001) POSIX specification
* JUnit no longer counts exceptions as failures if given test case is marked as ok to fail. * JUnit no longer counts exceptions as failures if given test case is marked as ok to fail.
@ -427,22 +449,22 @@ than `single_include/catch.hpp`.**
* Catch no longer attempts to define `uint64_t` on windows (#862) * Catch no longer attempts to define `uint64_t` on windows (#862)
* This was causing trouble when compiled under Cygwin * This was causing trouble when compiled under Cygwin
#### Other ##### Other
* Catch is now compiled under MSVC 2017 using `std:c++latest` (C++17 mode) in CI * Catch is now compiled under MSVC 2017 using `std:c++latest` (C++17 mode) in CI
* We now provide cmake script that autoregisters Catch tests into ctest. * We now provide cmake script that autoregisters Catch tests into ctest.
* See `contrib` folder. * See `contrib` folder.
### 1.9.1 #### 1.9.1
#### Fixes ##### Fixes
* Unexpected exceptions are no longer ignored by default (#885, #887) * Unexpected exceptions are no longer ignored by default (#885, #887)
### 1.9.0 #### 1.9.0
#### Improvements and minor changes ##### Improvements and minor changes
* Catch no longer attempts to ensure the exception type passed by user in `REQUIRE_THROWS_AS` is a constant reference. * Catch no longer attempts to ensure the exception type passed by user in `REQUIRE_THROWS_AS` is a constant reference.
* It was causing trouble when `REQUIRE_THROWS_AS` was used inside templated functions * It was causing trouble when `REQUIRE_THROWS_AS` was used inside templated functions
* This actually reverts changes made in v1.7.2 * This actually reverts changes made in v1.7.2
@ -456,7 +478,7 @@ than `single_include/catch.hpp`.**
* When Catch is compiled using C++11, `Approx` is now constructible with anything that can be explicitly converted to `double`. * When Catch is compiled using C++11, `Approx` is now constructible with anything that can be explicitly converted to `double`.
* Captured messages are now printed on unexpected exceptions * Captured messages are now printed on unexpected exceptions
#### Fixes: ##### Fixes:
* Clang's `-Wexit-time-destructors` should be suppressed for Catch's internals * Clang's `-Wexit-time-destructors` should be suppressed for Catch's internals
* GCC's `-Wparentheses` is now suppressed for all TU's that include `catch.hpp`. * GCC's `-Wparentheses` is now suppressed for all TU's that include `catch.hpp`.
* This is functionally a revert of changes made in 1.8.0, where we tried using `_Pragma` based suppression. This should have kept the suppression local to Catch's assertions, but bugs in GCC's handling of `_Pragma`s in C++ mode meant that it did not always work. * This is functionally a revert of changes made in 1.8.0, where we tried using `_Pragma` based suppression. This should have kept the suppression local to Catch's assertions, but bugs in GCC's handling of `_Pragma`s in C++ mode meant that it did not always work.
@ -465,18 +487,18 @@ than `single_include/catch.hpp`.**
* [Details can be found in documentation](configuration.md#catch_config_cpp11_stream_insertable_check) * [Details can be found in documentation](configuration.md#catch_config_cpp11_stream_insertable_check)
#### Other notes: ##### Other notes:
* We have added VS 2017 to our CI * We have added VS 2017 to our CI
* Work on Catch 2 should start soon * Work on Catch 2 should start soon
## 1.8.x ### 1.8.x
### 1.8.2 #### 1.8.2
#### Improvements and minor changes ##### Improvements and minor changes
* TAP reporter now behaves as if `-s` was always set * TAP reporter now behaves as if `-s` was always set
* This should be more consistent with the protocol desired behaviour. * This should be more consistent with the protocol desired behaviour.
* Compact reporter now obeys `-d yes` argument (#780) * Compact reporter now obeys `-d yes` argument (#780)
@ -490,7 +512,7 @@ than `single_include/catch.hpp`.**
* Listeners provide a way to hook into events generated by running your tests, including start and end of run, every test case, every section and every assertion. * Listeners provide a way to hook into events generated by running your tests, including start and end of run, every test case, every section and every assertion.
#### Fixes: ##### Fixes:
* Catch no longer attempts to reconstruct expression that led to a fatal error (#810) * Catch no longer attempts to reconstruct expression that led to a fatal error (#810)
* This fixes possible signal/SEH loop when processing expressions, where the signal was triggered by expression decomposition. * This fixes possible signal/SEH loop when processing expressions, where the signal was triggered by expression decomposition.
* Fixed (C4265) missing virtual destructor warning in Matchers (#844) * Fixed (C4265) missing virtual destructor warning in Matchers (#844)
@ -507,21 +529,21 @@ than `single_include/catch.hpp`.**
* Regression in Objective-C bindings (Matchers) fixed (#854) * Regression in Objective-C bindings (Matchers) fixed (#854)
#### Other notes: ##### Other notes:
* We have added VS 2013 and 2015 to our CI * We have added VS 2013 and 2015 to our CI
* Catch Classic (1.x.x) now contains its own, forked, version of Clara (the argument parser). * Catch Classic (1.x.x) now contains its own, forked, version of Clara (the argument parser).
### 1.8.1 #### 1.8.1
#### Fixes ##### Fixes
Cygwin issue with `gettimeofday` - `#define` was not early enough Cygwin issue with `gettimeofday` - `#define` was not early enough
### 1.8.0 #### 1.8.0
#### New features/ minor changes ##### New features/ minor changes
* Matchers have new, simpler (and documented) interface. * Matchers have new, simpler (and documented) interface.
* Catch provides string and vector matchers. * Catch provides string and vector matchers.
@ -541,7 +563,7 @@ Cygwin issue with `gettimeofday` - `#define` was not early enough
* `Approx` now supports an optional margin of absolute error * `Approx` now supports an optional margin of absolute error
* It has also received [new documentation](assertions.md#top). * It has also received [new documentation](assertions.md#top).
#### Fixes ##### Fixes
* Silenced C4312 ("conversion from int to 'ClassName *") warnings in the evaluate layer. * Silenced C4312 ("conversion from int to 'ClassName *") warnings in the evaluate layer.
* Fixed C4512 ("assignment operator could not be generated") warnings under VS2013. * Fixed C4512 ("assignment operator could not be generated") warnings under VS2013.
* Cygwin compatibility fixes * Cygwin compatibility fixes
@ -552,15 +574,15 @@ Cygwin issue with `gettimeofday` - `#define` was not early enough
* Otherwise it is supressed for the whole TU * Otherwise it is supressed for the whole TU
* Fixed test spec parser issue (with escapes in multiple names) * Fixed test spec parser issue (with escapes in multiple names)
#### Other ##### Other
* Various documentation fixes and improvements * Various documentation fixes and improvements
## 1.7.x ### 1.7.x
### 1.7.2 #### 1.7.2
#### Fixes and minor improvements ##### Fixes and minor improvements
Xml: Xml:
(technically the first two are breaking changes but are also fixes and arguably break few if any people) (technically the first two are breaking changes but are also fixes and arguably break few if any people)
@ -579,9 +601,9 @@ Other:
* Silenced a few more warnings in different circumstances * Silenced a few more warnings in different circumstances
* Travis improvements * Travis improvements
### 1.7.1 #### 1.7.1
#### Fixes: ##### Fixes:
* Fixed inconsistency in defining `NOMINMAX` and `WIN32_LEAN_AND_MEAN` inside `catch.hpp`. * Fixed inconsistency in defining `NOMINMAX` and `WIN32_LEAN_AND_MEAN` inside `catch.hpp`.
* Fixed SEH-related compilation error under older MinGW compilers, by making Windows SEH handling opt-in for compilers other than MSVC. * Fixed SEH-related compilation error under older MinGW compilers, by making Windows SEH handling opt-in for compilers other than MSVC.
* For specifics, look into the [documentation](configuration.md#top). * For specifics, look into the [documentation](configuration.md#top).
@ -591,9 +613,9 @@ Other:
* Fixed possible infinite recursion in Windows SEH. * Fixed possible infinite recursion in Windows SEH.
* Fixed possible compilation error caused by Catch's operator overloads being ambiguous in regards to user-defined templated operators. * Fixed possible compilation error caused by Catch's operator overloads being ambiguous in regards to user-defined templated operators.
### 1.7.0 #### 1.7.0
#### Features/ Changes: ##### Features/ Changes:
* Catch now runs significantly faster for passing tests * Catch now runs significantly faster for passing tests
* Microbenchmark focused on Catch's overhead went from ~3.4s to ~0.7s. * Microbenchmark focused on Catch's overhead went from ~3.4s to ~0.7s.
* Real world test using [JSON for Modern C++](https://github.com/nlohmann/json)'s test suite went from ~6m 25s to ~4m 14s. * Real world test using [JSON for Modern C++](https://github.com/nlohmann/json)'s test suite went from ~6m 25s to ~4m 14s.
@ -607,30 +629,30 @@ Other:
* Certain characters (space, tab, etc) are now pretty printed. * Certain characters (space, tab, etc) are now pretty printed.
* This means that a `char c = ' '; REQUIRE(c == '\t');` would be printed as `' ' == '\t'`, instead of ` == 9`. * This means that a `char c = ' '; REQUIRE(c == '\t');` would be printed as `' ' == '\t'`, instead of ` == 9`.
#### Fixes: ##### Fixes:
* Text formatting no longer attempts to access out-of-bounds characters under certain conditions. * Text formatting no longer attempts to access out-of-bounds characters under certain conditions.
* THROW family of assertions no longer trigger `-Wunused-value` on expressions containing explicit cast. * THROW family of assertions no longer trigger `-Wunused-value` on expressions containing explicit cast.
* Breaking into debugger under OS X works again and no longer required `DEBUG` to be defined. * Breaking into debugger under OS X works again and no longer required `DEBUG` to be defined.
* Compilation no longer breaks under certain compiler if a lambda is used inside assertion macro. * Compilation no longer breaks under certain compiler if a lambda is used inside assertion macro.
#### Other: ##### Other:
* Catch's CMakeLists now defines install command. * Catch's CMakeLists now defines install command.
* Catch's CMakeLists now generates projects with warnings enabled. * Catch's CMakeLists now generates projects with warnings enabled.
## 1.6.x ### 1.6.x
### 1.6.1 #### 1.6.1
#### Features/ Changes: ##### Features/ Changes:
* Catch now supports breaking into debugger on Linux * Catch now supports breaking into debugger on Linux
#### Fixes: ##### Fixes:
* Generators no longer leak memory (generators are still unsupported in general) * Generators no longer leak memory (generators are still unsupported in general)
* JUnit reporter now reports UTC timestamps, instead of "tbd" * JUnit reporter now reports UTC timestamps, instead of "tbd"
* `CHECK_THAT` macro is now properly defined as `CATCH_CHECK_THAT` when using `CATCH_` prefixed macros * `CHECK_THAT` macro is now properly defined as `CATCH_CHECK_THAT` when using `CATCH_` prefixed macros
#### Other: ##### Other:
* Types with overloaded `&&` operator are no longer evaluated twice when used in an assertion macro. * Types with overloaded `&&` operator are no longer evaluated twice when used in an assertion macro.
* The use of `__COUNTER__` is supressed when Catch is parsed by CLion * The use of `__COUNTER__` is supressed when Catch is parsed by CLion
* This change is not active when compiling a binary * This change is not active when compiling a binary
@ -640,28 +662,28 @@ Other:
* This can be disabled if needed, see [documentation](configuration.md#top) for details. * This can be disabled if needed, see [documentation](configuration.md#top) for details.
### 1.6.0 #### 1.6.0
#### Cmake/ projects: ##### Cmake/ projects:
* Moved CMakeLists.txt to root, made it friendlier for CLion and generating XCode and VS projects, and removed the manually maintained XCode and VS projects. * Moved CMakeLists.txt to root, made it friendlier for CLion and generating XCode and VS projects, and removed the manually maintained XCode and VS projects.
#### Features/ Changes: ##### Features/ Changes:
* Approx now supports `>=` and `<=` * Approx now supports `>=` and `<=`
* Can now use `\` to escape chars in test names on command line * Can now use `\` to escape chars in test names on command line
* Standardize C++11 feature toggles * Standardize C++11 feature toggles
#### Fixes: ##### Fixes:
* Blue shell colour * Blue shell colour
* Missing argument to `CATCH_CHECK_THROWS` * Missing argument to `CATCH_CHECK_THROWS`
* Don't encode extended ASCII in XML * Don't encode extended ASCII in XML
* use `std::shuffle` on more compilers (fixes deprecation warning/error) * use `std::shuffle` on more compilers (fixes deprecation warning/error)
* Use `__COUNTER__` more consistently (where available) * Use `__COUNTER__` more consistently (where available)
#### Other: ##### Other:
* Tweaks and changes to scripts - particularly for Approval test - to make them more portable * Tweaks and changes to scripts - particularly for Approval test - to make them more portable
# Even Older versions ## Even Older versions
Release notes were not maintained prior to v1.6.0, but you should be able to work them out from the Git history Release notes were not maintained prior to v1.6.0, but you should be able to work them out from the Git history
--- ---

10
docs/tostring.md
View File

@ -2,9 +2,9 @@
# String conversions # String conversions
**Contents**<br> **Contents**<br>
[operator << overload for std::ostream](#operator-overload-for-std-ostream)<br> [operator << overload for std::ostream](#operator--overload-for-stdostream)<br>
[Catch::StringMaker<T> specialisation](#catch-stringmaker-t-specialisation)<br> [Catch::StringMaker specialisation](#catchstringmaker-specialisation)<br>
[Catch::is_range<T> specialisation](#catch-is_range-t-specialisation)<br> [Catch::is_range specialisation](#catchis_range-specialisation)<br>
[Exceptions](#exceptions)<br> [Exceptions](#exceptions)<br>
Catch needs to be able to convert types you use in assertions and logging expressions into strings (for logging and reporting purposes). Catch needs to be able to convert types you use in assertions and logging expressions into strings (for logging and reporting purposes).
@ -25,7 +25,7 @@ std::ostream& operator << ( std::ostream& os, T const& value ) {
You should put this function in the same namespace as your type and have it declared before including Catch's header. You should put this function in the same namespace as your type and have it declared before including Catch's header.
## Catch::StringMaker<T> specialisation ## Catch::StringMaker specialisation
If you don't want to provide an ```operator <<``` overload, or you want to convert your type differently for testing purposes, you can provide a specialization for `Catch::StringMaker<T>`: If you don't want to provide an ```operator <<``` overload, or you want to convert your type differently for testing purposes, you can provide a specialization for `Catch::StringMaker<T>`:
``` ```
@ -39,7 +39,7 @@ namespace Catch {
} }
``` ```
## Catch::is_range<T> specialisation ## Catch::is_range specialisation
As a fallback, Catch attempts to detect if the type can be iterated As a fallback, Catch attempts to detect if the type can be iterated
(`begin(T)` and `end(T)` are valid) and if it can be, it is stringified (`begin(T)` and `end(T)` are valid) and if it can be, it is stringified
as a range. For certain types this can lead to infinite recursion, so as a range. For certain types this can lead to infinite recursion, so

26
scripts/updateDocumentToC.py
View File

@ -26,7 +26,7 @@ from scriptCommon import catchPath
minTocEntries = 4 minTocEntries = 4
headingExcludeDefault = [1,3,4,5] # use level 2 headers for at default headingExcludeDefault = [1,3,4,5] # use level 2 headers for at default
headingExcludeRelease = [2,3,4,5] # use level 1 headers for release-notes.md headingExcludeRelease = [1,3,4,5] # use level 1 headers for release-notes.md
documentsDefault = os.path.join(os.path.relpath(catchPath), 'docs/*.md') documentsDefault = os.path.join(os.path.relpath(catchPath), 'docs/*.md')
releaseNotesName = 'release-notes.md' releaseNotesName = 'release-notes.md'
@ -91,18 +91,20 @@ def dashifyHeadline(line):
level = len(stripped_right) - len(stripped_both) level = len(stripped_right) - len(stripped_both)
stripped_wspace = stripped_both.strip() stripped_wspace = stripped_both.strip()
# character replacements # GitHub's sluggification works in an interesting way
replaced_colon = stripped_wspace.replace('.', '') # 1) '+', '/', '(', ')' and so on are just removed
replaced_slash = replaced_colon.replace('/', '') # 2) spaces are converted into '-' directly
rem_nonvalids = ''.join([c if c in VALIDS # 3) multiple -- are not collapsed
else '-' for c in replaced_slash])
lowered = rem_nonvalids.lower() dashified = ''
dashified = re.sub(r'(-)\1+', r'\1', lowered) # remove duplicate dashes for c in stripped_wspace:
dashified = dashified.strip('-') # strip dashes from start and end if c in VALIDS:
dashified += c.lower()
# exception '&' (double-dash in github) elif c.isspace():
dashified = dashified.replace('-&-', '--') dashified += '-'
else:
# Unknown symbols are just removed
continue
return [stripped_wspace, dashified, level] return [stripped_wspace, dashified, level]