micro-test-plus 6.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
12// ----------------------------------------------------------------------------
13
44
45#ifndef MICRO_OS_PLUS_MICRO_TEST_PLUS_H_
46#define MICRO_OS_PLUS_MICRO_TEST_PLUS_H_
47
48// ----------------------------------------------------------------------------
49
50#if defined(__cplusplus)
51
52// ----------------------------------------------------------------------------
53
54#if defined(__cplusplus)
55#if !(__cplusplus >= 202002L || (defined(_MSVC_LANG) && _MSVC_LANG >= 202002L))
56#error "C++20 or higher is required"
57#endif // C++20 check
58#endif // defined(__cplusplus)
59
60#if __has_include("micro-os-plus/project-config.h")
61#include "micro-os-plus/project-config.h"
62#endif // __has_include("micro-os-plus/project-config.h")
63
64#if __has_include("micro-os-plus/micro-test-plus-defines.h")
65#include "micro-os-plus/micro-test-plus-defines.h"
66#endif // __has_include("micro-os-plus/micro-test-plus-defines.h")
67
68// ----------------------------------------------------------------------------
69
70#if defined(__DOXYGEN__)
71// Present here solely for Doxygen, to document the macros.
72#define MICRO_OS_PLUS_MICRO_TEST_PLUS_ENABLED
73#define MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_ENABLED
74#define MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_CONSTRUCTORS_ENABLED
75#define MICRO_OS_PLUS_MICRO_TEST_PLUS_DEPRECATED_ENABLED
76#endif // defined(__DOXYGEN__)
77
78// ----------------------------------------------------------------------------
79
80#if defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_ENABLED)
81
82// ----------------------------------------------------------------------------
83
84// No deps.
85#include "micro-test-plus/math.h"
86
87// No deps.
88#include "micro-test-plus/extension.h"
89
90// No deps.
91#include "micro-test-plus/reflection.h"
92
93// Requires extension.h, reflection.h.
94#include "micro-test-plus/detail.h"
95
96// No deps.
97#include "micro-test-plus/function-comparators.h"
98
99// No deps.
100#include "micro-test-plus/exceptions.h"
101
102// Requires extension.h, detail.h + reflection.h.
103#include "micro-test-plus/expression-formatter.h"
104
105// No deps.
106#include "micro-test-plus/runner-options.h"
107
108// Requires extension.h, detail.h, expression-formatter.h, reflection.h,
109// runner-options.h.
110#include "micro-test-plus/reporter.h"
111
112// Requires extension.h, reflection.h, expression-formatter.h.
113#include "micro-test-plus/check-result.h"
114
115// No deps.
116#include "micro-test-plus/counters.h"
117
118// Requires reporter.h, reflection.h.
119#include "micro-test-plus/reporter-human.h"
120
121// Requires reporter.h, reflection.h.
122#include "micro-test-plus/reporter-tap.h"
123
124// No deps.
125#include "micro-test-plus/utility.h"
126
127// Requires reporter.h, counters.h, reflection.h, extension.h and
128// stopwatch.h + check-result.h, reporter.h.
129#include "micro-test-plus/test.h"
130
131// Requires stopwatch.h, test.h (top_suite), counters.h, reflection.h,
132// runner-options.h.
133#include "micro-test-plus/runner.h"
134
135// Requires counters.h, extension.h, function-comparators.h, math.h,
136// reflection.h, runner.h, stopwatch.h, test.h.
137#include "micro-test-plus/deprecated.h"
138
139// Defined in detail.h for the library formats only; the templates above
140// have already been parsed, so keep it out of the application code.
141#undef MICRO_OS_PLUS_MICRO_TEST_PLUS_PRI_SIZE
142
143// ----------------------------------------------------------------------------
144
145#endif // defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_ENABLED)
146
147// ----------------------------------------------------------------------------
148
149#endif // defined(__cplusplus)
150
151// ----------------------------------------------------------------------------
152
153#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_H_
154
155// ----------------------------------------------------------------------------
check-result.h
C++ header file with declarations for the µTest++ check result.
counters.h
C++ header file with declarations for the µTest++ counters.
deprecated.h
C++ header file with declarations for the deprecated µTest++ definitions.
detail.h
C++ header file with declarations for the µTest++ internals.
exceptions.h
C++ header file with declarations for the µTest++ exception-checking functions.
expression-formatter.h
C++ header file with declarations for the µTest++ expression formatter.
extension.h
C++ header file with declarations for the µTest++ extension concepts.
function-comparators.h
C++ header file with declarations for the µTest++ function comparators.
math.h
C++ header file with declarations for the µTest++ mathematical utilities.
reflection.h
C++ header file with declarations for the µTest++ reflection utilities.
reporter-human.h
C++ header file with declarations for the µTest++ human-readable 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-options.h
C++ header file with declarations for the µTest++ runner options.
runner.h
C++ header file with declarations for the µTest++ test runner.
test.h
C++ header file with declarations for the µTest++ test hierarchy.
utility.h
C++ header file with declarations for the µTest++ utility helpers.