reporter.h

Go to the documentation of this file.

/*
 * This file is part of the µOS++ project (https://micro-os-plus.github.io/).
 * Copyright (c) 2021-2026 Liviu Ionescu. All rights reserved.
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose is hereby granted, under the terms of the MIT license.
 *
 * If a copy of the license was not distributed with this file, it can be
 * obtained from https://opensource.org/licenses/mit.
 *
 * Major parts of the code are inspired from v1.1.8 of the Boost UT project,
 * released under the terms of the Boost Version 1.0 Software License,
 * which can be obtained from https://www.boost.org/LICENSE_1_0.txt.
 */
 
// ----------------------------------------------------------------------------

 
#ifndef MICRO_OS_PLUS_MICRO_TEST_PLUS_TEST_REPORTER_H_
#define MICRO_OS_PLUS_MICRO_TEST_PLUS_TEST_REPORTER_H_
 
// ----------------------------------------------------------------------------
 
#if defined(__cplusplus)
 
// ----------------------------------------------------------------------------
 
#if __has_include("micro-os-plus/project-config.h")
#include "micro-os-plus/project-config.h"
#endif // __has_include("micro-os-plus/project-config.h")
 
#if __has_include("micro-os-plus/micro-test-plus-defines.h")
#include "micro-os-plus/micro-test-plus-defines.h"
#endif // __has_include("micro-os-plus/micro-test-plus-defines.h")
 
#include "type-traits.h"
#include "detail.h"
#include "expression-formatter.h"
#include "reflection.h"
 
#include <cstdio>
#include <string_view>
#include <string>
#include <memory>
#include <vector>
#include <charconv>
 
// ----------------------------------------------------------------------------
 
#if defined(__GNUC__)
#pragma GCC diagnostic push
 
#pragma GCC diagnostic ignored "-Wpadded"
#pragma GCC diagnostic ignored "-Waggregate-return"
#if defined(__clang__)
#pragma clang diagnostic ignored "-Wc++98-compat"
#pragma clang diagnostic ignored "-Wc++98-compat-pedantic"
#endif // defined(__clang__)
#endif // defined(__GNUC__)
 
// =============================================================================
 
namespace micro_os_plus::micro_test_plus
{
  // --------------------------------------------------------------------------

  enum class verbosity
  {
    silent = 0, 
    quiet = 1, 
    normal = 2, 
    verbose = 3 
  };
 
  // Forward definitions.
  class reporter;
  class runner;
  class suite;
  class subtest;

  reporter&
  endl (reporter& stream);
 
  namespace detail
  {
    // ------------------------------------------------------------------------

    struct indent_t
    {
      size_t level; 
    };
 
    // ------------------------------------------------------------------------
  } // namespace detail

  [[nodiscard]] detail::indent_t
  indent (size_t level);
 
  // ==========================================================================

  class reporter
  {
  public:
    reporter (std::unique_ptr<std::vector<std::string_view>> argvs);

    virtual ~reporter ();

    reporter&
    operator<< (std::string_view sv);

    reporter&
    operator<< (char c);

    reporter&
    operator<< (const char* s);

    reporter&
    operator<< (bool v);

    reporter& operator<< (std::nullptr_t);

    template <class T>
      requires std::is_arithmetic_v<T>
    reporter&
    operator<< (T v);

    template <typename T>
    reporter&
    operator<< (T* v);

    reporter&
    operator<< (reporter& (*func) (reporter&));
 
    // ------------------------------------------------------------------------
    // Specific operators.
 
    // ------------------------------------------------------------------------

    void
    endline (void);

    void
    write_buffer_to_stdout (void);

    void
    flush (void);
 
    // ------------------------------------------------------------------------

    void
    pass (std::string& message, const std::string& expression,
          subtest& subtest);

    void
    fail (bool abort, std::string& message, const std::string& expression,
          bool has_expression, const reflection::source_location& location,
          subtest& subtest);
 
    // ------------------------------------------------------------------------

    virtual void
    begin_session (runner& runner)
        = 0;

    virtual void
    end_session (runner& runner)
        = 0;

    virtual void
    begin_suite (suite& suite)
        = 0;

    virtual void
    end_suite (suite& suite)
        = 0;

    virtual void
    begin_subtest (subtest& subtest)
        = 0;

    virtual void
    end_subtest (subtest& subtest)
        = 0;

    virtual const char*
    get_comment_prefix (void)
        = 0;

    auto
    verbosity () const -> micro_test_plus::verbosity;

    detail::expression_formatter&
    expression ();
 
    // ------------------------------------------------------------------------
 
  protected:
    [[nodiscard]] inline auto
    colour_ (const bool cond) const;
 
    void
    write_buffer_to_file_ (void);

    void
    write_info_ (void);

    virtual void
    output_pass_prefix_ (std::string& message, subtest& subtest)
        = 0;

    virtual void
    output_pass_suffix_ (subtest& subtest)
        = 0;

    virtual void
    output_fail_prefix_ (std::string& message, const bool has_expression,
                         const reflection::source_location& location,
                         subtest& subtest)
        = 0;

    virtual void
    output_fail_suffix_ (const reflection::source_location& location,
                         bool abort, subtest& subtest)
        = 0;
 
  protected:
    enum verbosity verbosity_ = verbosity::normal;

    detail::colours colours_{};

    std::string buffer_{};

    detail::expression_formatter expression_{ colours_ };

    bool add_empty_line_{ true };

    const char* output_file_path_{ nullptr };

    FILE* output_file_{ nullptr };

    std::unique_ptr<std::vector<std::string_view>> argvs_{};
  };
 
  // --------------------------------------------------------------------------
} // namespace micro_os_plus::micro_test_plus
 
#if defined(__GNUC__)
#pragma GCC diagnostic pop
#endif // defined(__GNUC__)
 
// ----------------------------------------------------------------------------
 
#endif // defined(__cplusplus)
 
// ============================================================================
// Templates, inlines & constexpr implementations.
 
#include "inlines/reporter-inlines.h"
 
// ----------------------------------------------------------------------------
 
#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_TEST_REPORTER_H_
 
// ----------------------------------------------------------------------------