micro-test-plus 5.0.0
µTest++ Testing Framework
Loading...
Searching...
No Matches
micro-test-plus.h
Go to the documentation of this file.
1/*
2 * This file is part of the µOS++ project (https://micro-os-plus.github.io/).
3 * Copyright (c) 2021-2026 Liviu Ionescu. All rights reserved.
4 *
5 * Permission to use, copy, modify, and/or distribute this software for any
6 * purpose is hereby granted, under the terms of the MIT license.
7 *
8 * If a copy of the license was not distributed with this file, it can be
9 * obtained from https://opensource.org/licenses/mit.
10 *
11 * Major parts of the code are inspired from v1.1.8 of the Boost UT project,
12 * released under the terms of the Boost Version 1.0 Software License,
13 * which can be obtained from https://www.boost.org/LICENSE_1_0.txt.
14 */
15
16// ----------------------------------------------------------------------------
17
52
53#ifndef MICRO_TEST_PLUS_MICRO_TEST_PLUS_H_
54#define MICRO_TEST_PLUS_MICRO_TEST_PLUS_H_
55
56// ----------------------------------------------------------------------------
57
58#ifdef __cplusplus
59
60// ----------------------------------------------------------------------------
61
62#if defined(__cplusplus)
63#if !(__cplusplus >= 202002L || (defined(_MSVC_LANG) && _MSVC_LANG >= 202002L))
64#error "C++20 or higher is required"
65#endif
66#endif // defined(__cplusplus)
67
68#if __has_include(<micro-os-plus/project-config.h>)
69#include <micro-os-plus/project-config.h>
70#elif __has_include(<micro-os-plus/config.h>)
71#pragma message \
72 "micro-os-plus/config.h is deprecated, rename to micro-os-plus/project-config.h and include it instead of micro-os-plus/config.h"
73#include <micro-os-plus/config.h>
74#endif // __has_include(<micro-os-plus/project-config.h>)
75
76#if __has_include(<micro-os-plus/micro-test-plus-defines.h>)
77#include <micro-os-plus/micro-test-plus-defines.h>
78#endif // __has_include(<micro-os-plus/micro-test-plus-defines.h>)
79
80// No deps.
81#include "micro-test-plus/math.h"
82
83// Requires math.h.
84#include "micro-test-plus/type-traits.h"
85
86// No deps.
87#include "micro-test-plus/reflection.h"
88
89// Requires type-traits.h, reflection.h.
90#include "micro-test-plus/detail.h"
91
92// Requires type-traits.h, math.h.
93#include "micro-test-plus/literals.h"
94
95// No deps.
96#include "micro-test-plus/function-comparators.h"
97
98// No deps.
99#include "micro-test-plus/exceptions.h"
100
101// Requires type-traits.h + detail.h,
102#include "micro-test-plus/operators.h"
103
104// Requires type-traits.h, detail.h + reflection.h.
105#include "micro-test-plus/expression-formatter.h"
106
107// Requires type-traits.h, detail.h, expression-formatter.h, reflection.h.
108#include "micro-test-plus/reporter.h"
109
110// Requires type-traits.h, reflection.h, expression-formatter.h.
111#include "micro-test-plus/deferred-reporter.h"
112
113// No deps.
114#include "micro-test-plus/runner-totals.h"
115
116// Requires reporter.h, reflection.h.
117#include "micro-test-plus/reporter-human.h"
118
119// Requires reporter.h, reflection.h.
120#include "micro-test-plus/reporter-tap.h"
121
122// No deps.
123#include "micro-test-plus/utility.h"
124
125// Requires reporter.h, runner-totals.h, reflection.h, type-traits.h and
126// timings.h + deferred-reporter.h, reporter.h.
127#include "micro-test-plus/test.h"
128
129// Requires timings.h, test.h (detail::test_node, top_suite), reflection.h.
130#include "micro-test-plus/runner.h"
131
132// ----------------------------------------------------------------------------
133
158
159// ----------------------------------------------------------------------------
160
161#endif // __cplusplus
162
163// ----------------------------------------------------------------------------
164
165#endif // MICRO_TEST_PLUS_MICRO_TEST_PLUS_H_
166
167// ----------------------------------------------------------------------------
deferred-reporter.h
C++ header file with declarations for the µTest++ deferred reporter.
detail.h
C++ header file with declarations for the µTest++ internals.
exceptions.h
C++ header with declarations for the µTest++ exception-checking functions.
expression-formatter.h
C++ header file with declarations for the µTest++ expression formatter.
function-comparators.h
C++ header file with declarations for the µTest++ function comparators.
literals.h
C++ header file with declarations for the µTest++ user-defined literals and type wrappers.
math.h
C++ header file with declarations for the µTest++ mathematical utilities.
operators.h
C++ header file with declarations for the µTest++ operators.
reflection.h
C++ header file with declarations for the µTest++ reflection utilities.
reporter-human.h
C++ header file with declarations for the µTest++ human test reporter.
reporter-tap.h
C++ header file with declarations for the µTest++ TAP test reporter.
reporter.h
C++ header file with declarations for the µTest++ test reporter.
runner-totals.h
C++ header file with declarations for the µTest++ runner totals.
runner.h
C++ header file with declarations for the µTest++ test runner.
test.h
C++ header file with declarations for the µTest++ test suite.
type-traits.h
C++ header file with declarations for the µTest++ type trait utilities and metaprogramming support.
utility.h
C++ header file with declarations for the µTest++ utility helpers.