reporter.h File Reference

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

#include <cstdio>
#include <string_view>
#include <string>
#include <memory>
#include <vector>
#include <charconv>
#include "type-traits.h"
#include "detail.h"
#include "expression-formatter.h"
#include "reflection.h"
#include "inlines/reporter-inlines.h"

Go to the source code of this file.

Classes
struct	micro_os_plus::micro_test_plus::detail::indent_t
	Parameterised stream manipulator for outputting indentation. More...
class	micro_os_plus::micro_test_plus::reporter
	Reporter to display test results, including operand values and types for failures. More...

Namespaces
namespace	micro_os_plus
	The primary namespace for the µOS++ framework.
namespace	micro_os_plus::micro_test_plus
	Primary namespace for the µTest++ testing framework.
namespace	micro_os_plus::micro_test_plus::detail
	Internal implementation details for the µTest++ framework.

Enumerations
enum class	micro_os_plus::micro_test_plus::verbosity {   micro_os_plus::micro_test_plus::silent = 0 ,   micro_os_plus::micro_test_plus::quiet = 1 ,   micro_os_plus::micro_test_plus::normal = 2 ,   micro_os_plus::micro_test_plus::verbose = 3 }
	The verbosity levels for test reporting. More...

Functions
reporter &	micro_os_plus::micro_test_plus::endl (reporter &stream)
	Output stream manipulator for ending a line in test reports.
detail::indent_t	micro_os_plus::micro_test_plus::indent (size_t level)
	Factory function that creates an indent_t manipulator.

Detailed Description

This header provides the declarations for the test reporting facilities used within the µTest++ framework. It defines the interfaces for formatting and outputting test results, including operator overloads for a wide range of value types, containers, and comparison expressions, as well as structured output for logical and exception-related assertions.

The test reporter is responsible for presenting test outcomes 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.

Definition in file reporter.h.