Skip to main content

deferred-reporter-inlines.h File

C++ header file with inline implementations for the µTest++ internals. More...

Included Headers​

#include <charconv> #include <cstdio> #include <micro-os-plus/diag/trace.h>

Namespaces Index​

namespacemicro_os_plus

The primary namespace for the µOS++ framework. More...

namespacemicro_test_plus

Primary namespace for the µTest++ testing framework. More...

namespacedetail

Internal implementation details for the µTest++ framework. More...

Description​

C++ header file with inline implementations for the µTest++ internals.

This header provides the inline implementations for internal components of the µTest++ framework, including operator overloads and constructors for deferred reporting mechanisms.

It defines the logic for accumulating expectation messages, handling both arithmetic and string-like types, as well as the construction and destruction behaviour of deferred reporters, ensuring that test outcomes are accurately captured and reported.

All definitions reside within the micro_os_plus::micro_test_plus::detail namespace, ensuring clear separation from user code and minimising the risk of naming conflicts.

The header files are organised within the include/micro-os-plus/micro-test-plus folder to maintain a structured and modular codebase.

This file is intended solely for internal use within the framework and should not be included directly by user code.

File Listing​

The file content with the documentation metadata removed is:

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 Software License,
13 * which can be obtained from https://www.boost.org/LICENSE_1_0.txt.
14 */
15
16// ----------------------------------------------------------------------------
17
44
45#ifndef MICRO_TEST_PLUS_DEFERRED_REPORTER_INLINES_H_
46#define MICRO_TEST_PLUS_DEFERRED_REPORTER_INLINES_H_
47
48// ----------------------------------------------------------------------------
49
50#ifdef __cplusplus
51
52// ----------------------------------------------------------------------------
53
54#include <charconv>
55#include <cstdio>
56
57#include <micro-os-plus/diag/trace.h>
58
59// ----------------------------------------------------------------------------
60
61#if defined(__GNUC__)
62#pragma GCC diagnostic push
63#pragma GCC diagnostic ignored "-Waggregate-return"
64#if defined(__clang__)
65#pragma clang diagnostic ignored "-Wc++98-compat"
66#pragma clang diagnostic ignored "-Wc++98-compat-pedantic"
67#endif
68#endif
69
70// ============================================================================
71
72namespace micro_os_plus::micro_test_plus
73{
74 // --------------------------------------------------------------------------
75
76 namespace detail
77 {
78 // ========================================================================
79
84 inline bool
85 deferred_reporter_base::value () const
86 {
87 return value_;
88 }
89
90 // ------------------------------------------------------------------------
91
103 template <class T>
104 requires type_traits::printable<T>
105 auto&
106 deferred_reporter_base::operator<<(const T& msg)
107 {
108 if constexpr (std::is_same_v<T, char>)
109 {
110 deferred_output_.push_back (msg);
111 }
112 else if constexpr (std::is_arithmetic_v<T>)
113 {
114 // Optimise to avoid dynamic memory allocation in std::to_string by
115 // using a fixed-size buffer and std::to_chars.
116#if defined(__GNUC__)
117#pragma GCC diagnostic push
118#if defined(__clang__)
119#pragma clang diagnostic ignored "-Wunsafe-buffer-usage"
120#endif
121#endif
122 char buf[64];
123 // 64 bytes is sufficient for the longest decimal representation
124 // of any standard arithmetic type (long double ~45 chars).
125 static_assert (sizeof (buf) >= 50,
126 "buf must be large enough for any arithmetic type");
127 auto [ptr, ec] = std::to_chars (buf, buf + sizeof (buf), msg);
128 if (ec == std::errc{})
129 deferred_output_.append (buf, ptr);
130#if defined(__GNUC__)
131#pragma GCC diagnostic pop
132#endif
133 }
134 else
135 {
136 deferred_output_.append (msg);
137 }
138 return *this;
139 }
140
141 // ------------------------------------------------------------------------
142
154 template <class Expr_T>
155 deferred_reporter::deferred_reporter (
156 const Expr_T& expr, bool abort,
157 const reflection::source_location& location, subtest& subtest,
158 expression_formatter& expression)
159 : deferred_reporter_base{ static_cast<bool> (expr), location, subtest }
160
161 {
162#if defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_CONSTRUCTORS_ENABLED)
163 trace::printf ("%s\n", __PRETTY_FUNCTION__);
164#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_CONSTRUCTORS_ENABLED
165 abort_ = abort;
166 has_expression_ = type_traits::is_op<Expr_T>;
167
168 expression.clear ();
169
170 expression << expr;
171 }
172
173 // ------------------------------------------------------------------------
174 } // namespace detail
175
176 // --------------------------------------------------------------------------
177} // namespace micro_os_plus::micro_test_plus
178
179#if defined(__GNUC__)
180#pragma GCC diagnostic pop
181#endif
182
183// ----------------------------------------------------------------------------
184
185#endif // __cplusplus
186
187// ----------------------------------------------------------------------------
188
189#endif // MICRO_TEST_PLUS_DEFERRED_REPORTER_INLINES_H_
190
191// ----------------------------------------------------------------------------

Generated via doxygen2docusaurus 2.2.1 by Doxygen 1.17.0.

Last updated on