reporter-human.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_BASIC_H_
#define MICRO_OS_PLUS_MICRO_TEST_PLUS_TEST_REPORTER_BASIC_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 "reporter.h"
#include "reflection.h"
 
// ----------------------------------------------------------------------------
 
#if defined(__GNUC__)
#pragma GCC diagnostic push
 
#pragma GCC diagnostic ignored "-Wpadded"
#if defined(__clang__)
#pragma clang diagnostic ignored "-Wc++98-compat"
#endif // defined(__clang__)
#endif // defined(__GNUC__)
 
// ============================================================================
 
namespace micro_os_plus::micro_test_plus
{
  // --------------------------------------------------------------------------
 
  class runner;
  class suite;
  class subtest;
 
  // ==========================================================================

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

    reporter_human (const reporter_human&) = delete;

    reporter_human (reporter_human&&) = delete;

    reporter_human&
    operator= (const reporter_human&)
        = delete;

    reporter_human&
    operator= (reporter_human&&)
        = delete;

    ~reporter_human () override;
 
    // ------------------------------------------------------------------------

    reporter_human&
    operator<< (detail::indent_t m);
 
    // Bring base class operator<< overloads into scope to prevent name hiding.
    using reporter::operator<<;
 
    // ------------------------------------------------------------------------

    void
    begin_session (runner& runner) override;

    void
    end_session (runner& runner) override;

    virtual void
    begin_suite (suite& suite) override;

    virtual void
    end_suite (suite& suite) override;

    virtual void
    begin_subtest (subtest& subtest) override;

    virtual void
    end_subtest (subtest& subtest) override;

    virtual const char*
    get_comment_prefix (void) override;
 
  protected:
    void
    output_pass_prefix_ (std::string& message, subtest& subtest) override;

    void
    output_pass_suffix_ (subtest& subtest) override;

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

    void
    output_fail_suffix_ (const reflection::source_location& location,
                         bool abort, subtest& subtest) override;
  };
 
  // --------------------------------------------------------------------------
} // namespace micro_os_plus::micro_test_plus
 
#if defined(__GNUC__)
#pragma GCC diagnostic pop
#endif // defined(__GNUC__)
 
// ----------------------------------------------------------------------------
 
#endif // defined(__cplusplus)
 
// ----------------------------------------------------------------------------
 
#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_TEST_REPORTER_BASIC_H_
 
// ----------------------------------------------------------------------------