micro_test_plus Namespace
Primary namespace for the µTest++ testing framework. More...
Definition
Namespaces Index
| namespace | anonymous{runner.cpp} |
|
Local helpers of the runner. More... | |
| namespace | detail |
|
Internal implementation details for the µTest++ framework. More... | |
| namespace | extension |
|
The templates and the concepts for extending the µTest++ testing framework. More... | |
| namespace | literals |
|
Deprecated user-defined literals of the test checks. More... | |
| namespace | operators |
|
Deprecated comparison and logical operators of the test checks. More... | |
| namespace | reflection |
|
Reflection utilities for the µTest++ testing framework. More... | |
| namespace | type_traits |
|
Deprecated v5.0.1 namespace of the concepts and of the value wrapper templates. More... | |
| namespace | utility |
|
Utility functions for the µTest++ testing framework. More... | |
Classes Index
| class | counters |
|
Aggregated check and test case counters for a node in the test tree. More... | |
| class | located_name |
|
A name of a suite or of a test case, with the location where it was given. More... | |
| class | runner |
|
The test runner for the µTest++ framework. More... | |
| class | runner_options |
|
The configuration of a test session, and its command-line parser. More... | |
| class | static_suite |
|
A test suite designed for static (namespace-scope) registration with a runner. More... | |
| class | suite |
|
A named, runnable test suite registered with the test runner. More... | |
| class | test_case |
|
A named, runnable test case that lives inside a suite. More... | |
| struct | to_t<T> |
|
Deprecated generic strongly-typed wrapper for explicit type conversion. More... | |
| class | top_suite |
|
The optional top suite owned by every runner instance. More... | |
Typedefs Index
| using | expression_formatter = detail::expression_formatter |
|
Public name of the formatter used to report operand values. More... | |
| using | static_runner = runner |
| using | subtest = test_case |
Enumerations Index
| enum class | colour_mode { ... } |
|
The use of colours in the console output. More... | |
| enum class | reporter_kind { ... } |
|
The built-in reporters. More... | |
| enum class | verbosity { ... } |
|
The verbosity levels for test reporting. More... | |
Functions Index
template <class First_T, class Second_T, class... Rest_T> | |
| constexpr auto | all_of (First_T &&first, Second_T &&second, Rest_T &&... rest) |
|
Generic logical and operation, for two or more operands. More... | |
template <class First_T, class Second_T, class... Rest_T> | |
| constexpr auto | any_of (First_T &&first, Second_T &&second, Rest_T &&... rest) |
|
Generic logical (inclusive) or operation, for two or more operands. More... | |
template <class Lhs_T, class Rhs_T, class Epsilon_T> | |
| constexpr auto | approx (Lhs_T &&lhs, Rhs_T &&rhs, Epsilon_T &&epsilon) |
|
Approximate equality comparator, with an explicit tolerance. More... | |
template <class Lhs_T, class Rhs_T> | |
| constexpr auto | eq (Lhs_T &&lhs, Rhs_T &&rhs) |
|
Generic equality comparator. More... | |
template <class Lhs_T, class Rhs_T> | |
| constexpr auto | ge (Lhs_T &&lhs, Rhs_T &&rhs) |
|
Generic greater than or equal comparator. More... | |
template <class Lhs_T, class Rhs_T> | |
| constexpr auto | gt (Lhs_T &&lhs, Rhs_T &&rhs) |
|
Generic greater than comparator. More... | |
template <class Lhs_T, class Rhs_T> | |
| constexpr auto | le (Lhs_T &&lhs, Rhs_T &&rhs) |
|
Generic less than or equal comparator. More... | |
template <class Lhs_T, class Rhs_T> | |
| constexpr auto | lt (Lhs_T &&lhs, Rhs_T &&rhs) |
|
Generic less than comparator. More... | |
template <class Lhs_T, class Rhs_T> | |
| constexpr auto | ne (Lhs_T &&lhs, Rhs_T &&rhs) |
|
Generic non-equality comparator. More... | |
template <class Expr_T> | |
| constexpr auto | negate (Expr_T &&expr) |
|
Generic logical not operation. More... | |
template <class Callable_T> | |
| auto | nothrow (Callable_T &&func) |
|
Checks whether a callable does not throw any exception, for expect() or require(). More... | |
template <class Callable_T> | |
| auto | throws (Callable_T &&func) |
|
Checks whether a callable throws any exception, for expect() or require(). More... | |
template <class Exception_T, class Callable_T> | |
| auto | throws (Callable_T &&func) |
|
Checks whether a callable throws a specific exception, for expect() or require(). More... | |
Value Wrappers Index
| using | to_b = detail::value< bool > |
|
Deprecated strongly-typed wrapper for bool values. More... | |
| using | to_c = detail::value< char > |
|
Deprecated strongly-typed wrapper for char values. More... | |
| using | to_sc = detail::value< signed char > |
|
Deprecated strongly-typed wrapper for signed char values. More... | |
| using | to_s = detail::value< short > |
|
Deprecated strongly-typed wrapper for short values. More... | |
| using | to_i = detail::value< int > |
|
Deprecated strongly-typed wrapper for int values. More... | |
| using | to_l = detail::value< long > |
|
Deprecated strongly-typed wrapper for long values. More... | |
| using | to_ll = detail::value< long long > |
|
Deprecated strongly-typed wrapper for long long values. More... | |
| using | to_u = detail::value< unsigned > |
|
Deprecated strongly-typed wrapper for unsigned values. More... | |
| using | to_uc = detail::value< unsigned char > |
|
Deprecated strongly-typed wrapper for unsigned char values. More... | |
| using | to_us = detail::value< unsigned short > |
|
Deprecated strongly-typed wrapper for unsigned short values. More... | |
| using | to_ul = detail::value< unsigned long > |
|
Deprecated strongly-typed wrapper for unsigned long values. More... | |
| using | to_ull = detail::value< unsigned long long > |
|
Deprecated strongly-typed wrapper for unsigned long long values. More... | |
| using | to_i8 = detail::value< std::int8_t > |
|
Deprecated strongly-typed wrapper for std::int8_t values. More... | |
| using | to_i16 = detail::value< std::int16_t > |
|
Deprecated strongly-typed wrapper for std::int16_t values. More... | |
| using | to_i32 = detail::value< std::int32_t > |
|
Deprecated strongly-typed wrapper for std::int32_t values. More... | |
| using | to_i64 = detail::value< std::int64_t > |
|
Deprecated strongly-typed wrapper for std::int64_t values. More... | |
| using | to_u8 = detail::value< std::uint8_t > |
|
Deprecated strongly-typed wrapper for std::uint8_t values. More... | |
| using | to_u16 = detail::value< std::uint16_t > |
|
Deprecated strongly-typed wrapper for std::uint16_t values. More... | |
| using | to_u32 = detail::value< std::uint32_t > |
|
Deprecated strongly-typed wrapper for std::uint32_t values. More... | |
| using | to_u64 = detail::value< std::uint64_t > |
|
Deprecated strongly-typed wrapper for std::uint64_t values. More... | |
| using | to_f = detail::value< float > |
|
Deprecated strongly-typed wrapper for float values. More... | |
| using | to_d = detail::value< double > |
|
Deprecated strongly-typed wrapper for double values. More... | |
| using | to_ld = detail::value< long double > |
|
Deprecated strongly-typed wrapper for long double values. More... | |
Deprecated Value Wrappers Index
| using | _b = to_b |
|
Deprecated strongly-typed wrapper for bool values, the v5.0.1 name of to_b. More... | |
| using | _c = to_c |
|
Deprecated strongly-typed wrapper for char values, the v5.0.1 name of to_c. More... | |
| using | _sc = to_sc |
|
Deprecated strongly-typed wrapper for signed char values, the v5.0.1 name of to_sc. More... | |
| using | _s = to_s |
|
Deprecated strongly-typed wrapper for short values, the v5.0.1 name of to_s. More... | |
| using | _i = to_i |
|
Deprecated strongly-typed wrapper for int values, the v5.0.1 name of to_i. More... | |
| using | _l = to_l |
|
Deprecated strongly-typed wrapper for long values, the v5.0.1 name of to_l. More... | |
| using | _ll = to_ll |
|
Deprecated strongly-typed wrapper for long long values, the v5.0.1 name of to_ll. More... | |
| using | _u = to_u |
|
Deprecated strongly-typed wrapper for unsigned values, the v5.0.1 name of to_u. More... | |
| using | _uc = to_uc |
|
Deprecated strongly-typed wrapper for unsigned char values, the v5.0.1 name of to_uc. More... | |
| using | _us = to_us |
|
Deprecated strongly-typed wrapper for unsigned short values, the v5.0.1 name of to_us. More... | |
| using | _ul = to_ul |
|
Deprecated strongly-typed wrapper for unsigned long values, the v5.0.1 name of to_ul. More... | |
| using | _ull = to_ull |
|
Deprecated strongly-typed wrapper for unsigned long long values, the v5.0.1 name of to_ull. More... | |
| using | _i8 = to_i8 |
|
Deprecated strongly-typed wrapper for std::int8_t values, the v5.0.1 name of to_i8. More... | |
| using | _i16 = to_i16 |
|
Deprecated strongly-typed wrapper for std::int16_t values, the v5.0.1 name of to_i16. More... | |
| using | _i32 = to_i32 |
|
Deprecated strongly-typed wrapper for std::int32_t values, the v5.0.1 name of to_i32. More... | |
| using | _i64 = to_i64 |
|
Deprecated strongly-typed wrapper for std::int64_t values, the v5.0.1 name of to_i64. More... | |
| using | _u8 = to_u8 |
|
Deprecated strongly-typed wrapper for std::uint8_t values, the v5.0.1 name of to_u8. More... | |
| using | _u16 = to_u16 |
|
Deprecated strongly-typed wrapper for std::uint16_t values, the v5.0.1 name of to_u16. More... | |
| using | _u32 = to_u32 |
|
Deprecated strongly-typed wrapper for std::uint32_t values, the v5.0.1 name of to_u32. More... | |
| using | _u64 = to_u64 |
|
Deprecated strongly-typed wrapper for std::uint64_t values, the v5.0.1 name of to_u64. More... | |
| using | _f = to_f |
|
Deprecated strongly-typed wrapper for float values, the v5.0.1 name of to_f. More... | |
| using | _d = to_d |
|
Deprecated strongly-typed wrapper for double values, the v5.0.1 name of to_d. More... | |
| using | _ld = to_ld |
|
Deprecated strongly-typed wrapper for long double values, the v5.0.1 name of to_ld. More... | |
template <class T> | |
| using | _t = to_t< T > |
|
Deprecated generic strongly-typed wrapper, the v5.0.1 name of to_t. More... | |
Deprecated Functions Index
template <class Expr_T> | |
| constexpr auto | _not (Expr_T &&expr) |
|
Deprecated generic logical not operation, the v5.0.1 name of negate(). More... | |
template <class Lhs_T, class Rhs_T> | |
| constexpr auto | _and (Lhs_T &&lhs, Rhs_T &&rhs) |
|
Deprecated generic logical and operation, the v5.0.1 name of all_of(). More... | |
template <class Lhs_T, class Rhs_T> | |
| constexpr auto | _or (Lhs_T &&lhs, Rhs_T &&rhs) |
|
Deprecated generic logical (inclusive) or operation, the v5.0.1 name of any_of(). More... | |
template <class T> | |
| constexpr T & | mut (const T &t) noexcept |
|
Deprecated generic mutator to remove const qualification from a reference. More... | |
template <class T> | |
| constexpr auto | approx (T value, std::type_identity_t< T > epsilon) noexcept -> detail::value< T > |
|
Deprecated wrapping of a floating-point value with an explicit comparison tolerance. More... | |
Description
Primary namespace for the µTest++ testing framework.
The micro_os_plus::micro_test_plus namespace encapsulates all core components, types, and utilities of the µTest++ testing framework, providing a dedicated scope for its public API.
The main classes (the runner, the suites, and the test cases) are defined directly in this namespace. Several nested namespaces group specific aspects of the framework: extension (the concepts for custom comparators, operators, and helpers), reflection (source locations and type names), utility (utility functions), and detail (internal implementation details, including the reporters, the mathematical utilities of detail::math, and the value wrappers). The namespaces literals (user-defined literals), operators (comparison and logical operators), and type_traits (the v5.0.1 concepts) are deprecated, and are kept for the earlier code.
The declarations are in the headers of the include/micro-os-plus/micro-test-plus folder, and the non-inline definitions in the src folder.
Generated via doxygen2docusaurus 2.2.8 by Doxygen 1.18.0.