File catch_amalgamated.hpp

↰ Parent directory (include)

Definition (include/catch_amalgamated.hpp)

Detailed Description

This is a convenience header for Catch2. It includes all of Catch2 headers.

Generally the Catch2 users should use specific includes they need, but this header can be used instead for ease-of-experimentation, or just plain convenience, at the cost of (significantly) increased compilation times.

When a new header is added to either the top level folder, or to the corresponding internal subfolder, it should be added here. Headers added to the various subparts (e.g. matchers, generators, etc…), should go their respective catch-all headers.

This is a convenience header for Catch2’s benchmarking. It includes all of Catch2 headers related to benchmarking.

Generally the Catch2 users should use specific includes they need, but this header can be used instead for ease-of-experimentation, or just plain convenience, at the cost of (significantly) increased compilation times.

When a new header is added to either the benchmark folder, or to the corresponding internal (detail) subfolder, it should be added here.

Wrapper for the CONFIG configuration option

When generating internal unique names, there are two options. Either we mix in the current line number, or mix in an incrementing number. We prefer the latter, using __COUNTER__, but users might want to use the former.

Wrapper for the WCHAR configuration option

We want to support platforms that do not provide wchar_t, so we sometimes have to disable providing wchar_t overloads through Catch2, e.g. the StringMaker specialization for std::wstring.

Wrapper for the STATIC_ANALYSIS_SUPPORT configuration option

Some of Catch2’s macros can be defined differently to work better with static analysis tools, like clang-tidy or coverity. Currently the main use case is to show that SECTION``s are executed exclusively, and not all in one run of a ``TEST_CASE.

This is a convenience header for Catch2’s Generator support. It includes all of Catch2 headers related to generators.

Generally the Catch2 users should use specific includes they need, but this header can be used instead for ease-of-experimentation, or just plain convenience, at the cost of (significantly) increased compilation times.

When a new header is added to either the generators folder, or to the corresponding internal subfolder, it should be added here.

This is a convenience header for Catch2’s interfaces. It includes all of Catch2 headers related to interfaces.

Generally the Catch2 users should use specific includes they need, but this header can be used instead for ease-of-experimentation, or just plain convenience, at the cost of somewhat increased compilation times.

When a new header is added to either the interfaces folder, or to the corresponding internal subfolder, it should be added here.

Wrapper for ANDROID_LOGWRITE configuration option

We want to default to enabling it when compiled for android, but users of the library should also be able to disable it if they want to.

Wrapper for UNCAUGHT_EXCEPTIONS configuration option

For some functionality, Catch2 requires to know whether there is an active exception. Because std::uncaught_exception is deprecated in C++17, we want to use std::uncaught_exceptions if possible.

This is a convenience header for Catch2’s Matcher support. It includes all of Catch2 headers related to matchers.

Generally the Catch2 users should use specific includes they need, but this header can be used instead for ease-of-experimentation, or just plain convenience, at the cost of increased compilation times.

When a new header is added to either the matchers folder, or to the corresponding internal subfolder, it should be added here.

This is a convenience header for Catch2’s Reporter support. It includes all of Catch2 headers related to reporters, including all reporters.

Generally the Catch2 users should use specific includes they need, but this header can be used instead for ease-of-experimentation, or just plain convenience, at the cost of (significantly) increased compilation times.

When a new header (reporter) is added to either the reporter folder, or to the corresponding internal subfolder, it should be added here.

Includes

  • algorithm

  • array

  • cassert

  • chrono

  • cmath

  • cstddef

  • cstdint

  • cstdio

  • cstring

  • ctime

  • exception

  • functional

  • initializer_list

  • iosfwd

  • iterator

  • limits

  • map

  • memory

  • ostream

  • random

  • ratio

  • set

  • sstream

  • string

  • tuple

  • type_traits

  • utility

  • vector

Included By

Namespaces

Classes

Enums

Functions

Defines

Typedefs

Variables