deferred_reporter Class

Deferred reporter class for a specific expression. More...

Declaration

class micro_os_plus::micro_test_plus::detail::deferred_reporter { ... }

Included Headers

#include <micro-os-plus/micro-test-plus.h>

Base class

class	deferred_reporter_base
	Base class for a deferred reporter that collects messages into a string. More...

Public Constructors Index

template <class Expr_T>
deferred_reporter (const Expr_T &expr, bool abort, const reflection::source_location &location, subtest &subtest, expression_formatter &expression)
	Constructs a deferred reporter for a specific expression. More...

Public Destructor Index

	~deferred_reporter ()=default
	Destructor for the deferred reporter. More...

Public Operators Index

template <class T>
auto &	operator<< (const T &msg)
	Appends a message to the reporter. More...

Public Member Functions Index

bool	value () const
	Retrieves the result value. More...

Protected Member Attributes Index

bool	abort_ = false
	Indicates whether the reporting should abort further processing. More...
std::string	deferred_output_ {}
	String to collect the expectation message passed via operator<<(). More...
bool	has_expression_ = false
	Indicates whether the reporter has an associated expression. More...
const reflection::source_location	location_ {}
	Stores the source location associated with the report. More...
subtest &	subtest_
	Reference to the test case invoking this report. More...
bool	value_ {}
	Stores the result value of the report. More...

Description

Deferred reporter class for a specific expression.

The deferred_reporter class extends deferred_reporter_base to provide deferred reporting functionality for a specific test expression within the framework.

This class is responsible for capturing the expression under evaluation, the abort status, and the source location. It is intended exclusively for internal use and is implemented in the include/micro-os-plus/micro-test-plus folder to ensure a structured and modular codebase.

Definition at line 219 of file deferred-reporter.h.

Public Constructors

deferred_reporter()

template <class Expr_T>

micro_os_plus::micro_test_plus::detail::deferred_reporter::deferred_reporter (const Expr_T & expr, bool abort, const reflection::source_location & location, subtest & subtest, expression_formatter & expression)

Constructs a deferred reporter for a specific expression.

Parameters

expr	The expression under evaluation.
abort	Indicates whether reporting should abort further processing.
location	The source location relevant to the report.
subtest	The subtest that owns this deferred report.
expression	The expression formatter to format the expression text.

This constructor initialises a deferred reporter for a specific expression, capturing the evaluation result, abort status, and source location.

The expression is evaluated and its boolean result is passed to the base class. The abort flag determines whether further test execution should be halted if the expectation fails. The source location provides contextual information for reporting purposes.

Declaration at line 234 of file deferred-reporter.h, definition at line 157 of file deferred-reporter-inlines.h.

157 deferred_reporter::deferred_reporter (

158 const Expr_T& expr, bool abort,

159 const reflection::source_location& location, subtest& subtest,

160 expression_formatter& expression)

161 : deferred_reporter_base{ static_cast<bool> (expr), location, subtest }

162

163 {

164#if defined(MICRO_OS_PLUS_TRACE) \

165 && defined(MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS_CONSTRUCTORS)

166 trace::printf ("%s\n", __PRETTY_FUNCTION__);

167#endif // MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS_CONSTRUCTORS

168 abort_ = abort;

169 has_expression_ = type_traits::is_op<Expr_T>;

170

171 expression.clear ();

172

173 expression << expr;

174 }

References micro_os_plus::micro_test_plus::detail::deferred_reporter_base::deferred_reporter_base, micro_os_plus::micro_test_plus::detail::deferred_reporter_base::abort_, micro_os_plus::micro_test_plus::detail::expression_formatter::clear and micro_os_plus::micro_test_plus::detail::deferred_reporter_base::has_expression_.

Public Destructor

~deferred_reporter()

micro_os_plus::micro_test_plus::detail::deferred_reporter::~deferred_reporter ()

default

Destructor for the deferred reporter.

Definition at line 241 of file deferred-reporter.h.

Public Operators

operator<<()

template <class T>

auto & micro_os_plus::micro_test_plus::detail::deferred_reporter_base::operator<< (const T & msg)

Appends a message to the reporter.

Template Parameters

T	The type of the message to append.

Parameters

msg	The message to append.

Returns

Reference to the current reporter instance.

This operator overload enables the deferred reporter to accumulate expectation messages by appending the provided value to the internal message string.

If the argument is a char, it is appended directly as a character. If the argument is of another arithmetic type, it is converted to a string using a fixed-size buffer and std::to_chars to avoid dynamic memory allocation. For all other types, the value is appended directly.

Declaration at line 153 of file deferred-reporter.h, definition at line 108 of file deferred-reporter-inlines.h.

108 deferred_reporter_base::operator<<(const T& msg)

109 {

110 if constexpr (std::is_same_v<T, char>)

111 {

112 deferred_output_.push_back (msg);

113 }

114 else if constexpr (std::is_arithmetic_v<T>)

115 {

116 // Optimise to avoid dynamic memory allocation in std::to_string by

117 // using a fixed-size buffer and std::to_chars.

118#if defined(__GNUC__)

119#pragma GCC diagnostic push

120#if defined(__clang__)

121#pragma clang diagnostic ignored "-Wunsafe-buffer-usage"

122#endif

123#endif

124 char buf[64];

125 // 64 bytes is sufficient for the longest decimal representation

126 // of any standard arithmetic type (long double ~45 chars).

127 static_assert (sizeof (buf) >= 50,

128 "buf must be large enough for any arithmetic type");

129 auto [ptr, ec] = std::to_chars (buf, buf + sizeof (buf), msg);

130 if (ec == std::errc{})

131 deferred_output_.append (buf, ptr);

132#if defined(__GNUC__)

133#pragma GCC diagnostic pop

134#endif

135 }

136 else

137 {

138 deferred_output_.append (msg);

139 }

140 return *this;

141 }

Reference micro_os_plus::micro_test_plus::detail::deferred_reporter_base::deferred_output_.

Public Member Functions

value()

bool micro_os_plus::micro_test_plus::detail::deferred_reporter_base::value ()

inline nodiscard

Retrieves the result value.

Parameters

None.

Return Values

true	The reported condition was met.
false	The reported condition was not met.

Returns the result value stored in value_.

Declaration at line 165 of file deferred-reporter.h, definition at line 87 of file deferred-reporter-inlines.h.

87 deferred_reporter_base::value () const

88 {

89 return value_;

90 }

Reference micro_os_plus::micro_test_plus::detail::deferred_reporter_base::value_.

Referenced by micro_os_plus::micro_test_plus::detail::deferred_reporter_base::deferred_reporter_base.

Protected Member Attributes

abort_

bool micro_os_plus::micro_test_plus::detail::deferred_reporter_base::abort_ = false

protected

Indicates whether the reporting should abort further processing.

Definition at line 177 of file deferred-reporter.h.

177 bool abort_ = false;

Referenced by deferred_reporter and micro_os_plus::micro_test_plus::detail::deferred_reporter_base::~deferred_reporter_base.

deferred_output_

std::string micro_os_plus::micro_test_plus::detail::deferred_reporter_base::deferred_output_ {}

protected

String to collect the expectation message passed via operator<<().

Definition at line 193 of file deferred-reporter.h.

193 std::string deferred_output_{};

Referenced by micro_os_plus::micro_test_plus::detail::deferred_reporter_base::~deferred_reporter_base and micro_os_plus::micro_test_plus::detail::deferred_reporter_base::operator<<.

has_expression_

bool micro_os_plus::micro_test_plus::detail::deferred_reporter_base::has_expression_ = false

protected

Indicates whether the reporter has an associated expression.

Definition at line 182 of file deferred-reporter.h.

182 bool has_expression_ = false;

Referenced by deferred_reporter and micro_os_plus::micro_test_plus::detail::deferred_reporter_base::~deferred_reporter_base.

location_

const reflection::source_location micro_os_plus::micro_test_plus::detail::deferred_reporter_base::location_ {}

protected

Stores the source location associated with the report.

Definition at line 187 of file deferred-reporter.h.

187 const reflection::source_location location_{};

Referenced by micro_os_plus::micro_test_plus::detail::deferred_reporter_base::deferred_reporter_base and micro_os_plus::micro_test_plus::detail::deferred_reporter_base::~deferred_reporter_base.

subtest_

subtest& micro_os_plus::micro_test_plus::detail::deferred_reporter_base::subtest_

protected

Reference to the test case invoking this report.

Definition at line 198 of file deferred-reporter.h.

198 subtest& subtest_;

Referenced by micro_os_plus::micro_test_plus::detail::deferred_reporter_base::deferred_reporter_base and micro_os_plus::micro_test_plus::detail::deferred_reporter_base::~deferred_reporter_base.

value_

bool micro_os_plus::micro_test_plus::detail::deferred_reporter_base::value_ {}

protected

Stores the result value of the report.

Definition at line 171 of file deferred-reporter.h.

171 bool value_{};

Referenced by micro_os_plus::micro_test_plus::detail::deferred_reporter_base::deferred_reporter_base, micro_os_plus::micro_test_plus::detail::deferred_reporter_base::~deferred_reporter_base and micro_os_plus::micro_test_plus::detail::deferred_reporter_base::value.

---

The documentation for this class was generated from the following files:

• deferred-reporter.h
• deferred-reporter-inlines.h

---

Generated via doxygen2docusaurus 2.2.0 by Doxygen 1.17.0.