`reporter-inlines.h` File

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

Included Headers

#include <cstdio> #include <cstring>

Namespaces Index

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

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

Functions Index

detail::indent_t	indent (size_t level)
	Factory function that creates an indent_t manipulator. More...

Description

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

This header provides the inline implementations for the test reporting facilities used within the µTest++ framework. It defines the logic for formatting and outputting test results, including operator overloads for various value types, containers, and comparison expressions, as well as structured output for logical and exception-related assertions.

The implementations ensure that test outcomes are presented in a clear, consistent, and expressive manner, supporting both value and pointer semantics, and providing detailed diagnostics for both successful and failed test cases. Special attention is given to formatting, colour highlighting, and extensibility, enabling professional and readable test reports suitable for embedded and general C++ development.

All definitions reside within the micro_os_plus::micro_test_plus 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.

Functions

indent()

detail::indent_t micro_os_plus::micro_test_plus::indent (size_t level)

inline nodiscard

Factory function that creates an indent_t manipulator.

Parameters

level

The number of four-space indentation levels.

Returns: An indent_t value for use with operator<<.

Definition at line 81 of file reporter-inlines.h.

81 indent (size_t level)

82 {

83 return { level };

84 }

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/).

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 */

16// ----------------------------------------------------------------------------

49#ifndef MICRO_OS_PLUS_MICRO_TEST_PLUS_INLINES_REPORTER_INLINES_H_

50#define MICRO_OS_PLUS_MICRO_TEST_PLUS_INLINES_REPORTER_INLINES_H_

52// ----------------------------------------------------------------------------

54#if defined(__cplusplus)

56// ----------------------------------------------------------------------------

58#include <cstdio>

59#include <cstring>

61// ----------------------------------------------------------------------------

63#if defined(__GNUC__)

64#pragma GCC diagnostic push

66#pragma GCC diagnostic ignored "-Waggregate-return"

67#if defined(__clang__)

68#pragma clang diagnostic ignored "-Wunknown-warning-option"

69#pragma clang diagnostic ignored "-Wc++98-compat"

70#pragma clang diagnostic ignored "-Wc++98-compat-pedantic"

71#endif // defined(__clang__)

72#endif // defined(__GNUC__)

74// ============================================================================

76namespace micro_os_plus::micro_test_plus

77{

78 // --------------------------------------------------------------------------

80 inline detail::indent_t

81 indent (size_t level)

82 {

83 return { level };

84 }

86 // ==========================================================================

92 inline auto

93 reporter::verbosity () const -> micro_test_plus::verbosity

94 {

95 return verbosity_;

96 }

107 inline detail::expression_formatter&

108 reporter::expression ()

109 {

110 return expression_;

111 }

112

118 inline auto

119 reporter::colour_ (const bool cond) const

120 {

121 return cond ? colours_.pass : colours_.fail;

122 }

123

124 // --------------------------------------------------------------------------

125

144 template <typename T>

145 reporter&

146 reporter::operator<<(T* v)

147 {

148 if (v == nullptr)

149 {

150 // Explicitly render null pointers as "0x0" to avoid platform-specific

151 // representations such as "(nil)" on Linux/glibc.

152 buffer_.append ("0x0");

153 return *this;

154 }

155

156#if defined(__GNUC__)

157#pragma GCC diagnostic push

158

159#if defined(__clang__)

160#pragma clang diagnostic ignored "-Wunsafe-buffer-usage-in-libc-call"

161#endif // defined(__clang__)

162#endif // defined(__GNUC__)

163

164 char buff[20];

165 snprintf (buff, sizeof (buff), "%p", reinterpret_cast<void*> (v));

166 buffer_.append (buff);

167

168#if defined(__GNUC__)

169#pragma GCC diagnostic pop

170#endif // defined(__GNUC__)

171

172 return *this;

173 }

174

187 template <class T>

188 requires std::is_arithmetic_v<T>

189 reporter&

190 reporter::operator<<(T v)

191 {

192 detail::append_number_ (buffer_, v);

193 return *this;

194 }

195

196 // --------------------------------------------------------------------------

197} // namespace micro_os_plus::micro_test_plus

198

199#if defined(__GNUC__)

200#pragma GCC diagnostic pop

201#endif // defined(__GNUC__)

202

203// ----------------------------------------------------------------------------

204

205#endif // defined(__cplusplus)

206

207// ----------------------------------------------------------------------------

208

209#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_INLINES_REPORTER_INLINES_H_

210

211// ----------------------------------------------------------------------------

Generated via doxygen2docusaurus 2.2.2 by Doxygen 1.17.0.

Included Headers​

Namespaces Index​

Functions Index​

Description​

Functions​

indent()​

File Listing​