deferred-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_DEFERRED_REPORTER_H_
#define MICRO_OS_PLUS_MICRO_TEST_PLUS_DEFERRED_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 "reflection.h"
#include "expression-formatter.h"
 
#include <cstdio>
#include <string>
 
// ----------------------------------------------------------------------------
 
#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"
#endif // defined(__clang__)
#endif // defined(__GNUC__)
 
// ============================================================================
 
namespace micro_os_plus::micro_test_plus
{
  class subtest;
 
  // --------------------------------------------------------------------------
 
  namespace detail
  {
    // ========================================================================

    class deferred_reporter_base
    {
    public:
      deferred_reporter_base (bool value,
                              const reflection::source_location& location,
                              subtest& subtest);

      deferred_reporter_base (const deferred_reporter_base&) = delete;

      deferred_reporter_base (deferred_reporter_base&&) = delete;

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

      deferred_reporter_base&
      operator= (deferred_reporter_base&&)
          = delete;

      ~deferred_reporter_base ();

      template <class T>
        requires type_traits::printable<T>
      auto&
      operator<< (const T& msg);

      [[nodiscard]] bool
      value () const;
 
    protected:
      bool value_{};

      bool abort_ = false;

      bool has_expression_ = false;

      const reflection::source_location location_{};

      std::string deferred_output_{};

      subtest& subtest_;
    };
 
    // ========================================================================

    class deferred_reporter : public deferred_reporter_base
    {
    public:
      template <class Expr_T>
      deferred_reporter (const Expr_T& expr, bool abort,
                         const reflection::source_location& location,
                         subtest& subtest, expression_formatter& expression);

      ~deferred_reporter () = default;
    };
 
    // ------------------------------------------------------------------------
  } // namespace detail
 
  // --------------------------------------------------------------------------
} // 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/deferred-reporter-inlines.h"
 
// ----------------------------------------------------------------------------
 
#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_DEFERRED_REPORTER_H_
 
// ----------------------------------------------------------------------------