runner-options.h File Reference

C++ header file with declarations for the µTest++ runner options. More...

#include <span>
#include <string>
#include <string_view>
#include <utility>
#include <vector>
#include "inlines/runner-options-inlines.h"

Go to the source code of this file.

Classes
class	micro_os_plus::micro_test_plus::runner_options
	The configuration of a test session, and its command-line parser. 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.

Enumerations
enum class	micro_os_plus::micro_test_plus::colour_mode {   micro_os_plus::micro_test_plus::colour_mode::automatic ,   micro_os_plus::micro_test_plus::colour_mode::always ,   micro_os_plus::micro_test_plus::colour_mode::never }
	The use of colours in the console output. More...
enum class	micro_os_plus::micro_test_plus::reporter_kind {   micro_os_plus::micro_test_plus::reporter_kind::tap ,   micro_os_plus::micro_test_plus::reporter_kind::human }
	The built-in reporters. More...
enum class	micro_os_plus::micro_test_plus::verbosity {   micro_os_plus::micro_test_plus::verbosity::silent = 0 ,   micro_os_plus::micro_test_plus::verbosity::quiet = 1 ,   micro_os_plus::micro_test_plus::verbosity::normal = 2 ,   micro_os_plus::micro_test_plus::verbosity::verbose = 3 }
	The verbosity levels for test reporting. More...

Detailed Description

This header provides the runner_options class, which holds the configuration of a test session (the reporter, the verbosity, the output file, the use of colours, the filter, and the listing of the test cases) and parses it from the command line, together with the reporter_kind, verbosity, and colour_mode enumerations used by its members.

The options are usually parsed from the command line by the constructor taking the main() arguments, called by runner::initialise (argc, argv); the applications without a command line, such as the embedded ones without semihosting arguments, can set them directly and pass them to runner::initialise (options).

All definitions reside within the micro_os_plus::micro_test_plus namespace.

This file is included by micro-os-plus/micro-test-plus.h, which is the header that the applications include.

Definition in file runner-options.h.