deferred-reporter-inlines.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_INLINES_DEFERRED_REPORTER_INLINES_H_
#define MICRO_OS_PLUS_MICRO_TEST_PLUS_INLINES_DEFERRED_REPORTER_INLINES_H_
 
// ----------------------------------------------------------------------------
 
#if defined(__cplusplus)
 
// ----------------------------------------------------------------------------
 
#if __has_include("micro-os-plus/diag/trace.h")
#include "micro-os-plus/diag/trace.h"
#endif // __has_include("micro-os-plus/diag/trace.h")
 
#include <charconv>
#include <cstdio>
 
// ----------------------------------------------------------------------------
 
#if defined(__GNUC__)
#pragma GCC diagnostic push
 
#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
{
  // --------------------------------------------------------------------------
 
  namespace detail
  {
    // ========================================================================

    inline bool
    deferred_reporter_base::value () const
    {
      return value_;
    }
 
    // ------------------------------------------------------------------------

    template <class T>
      requires type_traits::printable<T>
    auto&
    deferred_reporter_base::operator<< (const T& msg)
    {
      if constexpr (std::is_same_v<T, char>)
        {
          deferred_output_.push_back (msg);
        }
      else if constexpr (std::is_arithmetic_v<T>)
        {
          // Optimise to avoid dynamic memory allocation in std::to_string by
          // using a fixed-size buffer and std::to_chars.
#if defined(__GNUC__)
#pragma GCC diagnostic push
 
#if defined(__clang__)
#pragma clang diagnostic ignored "-Wunsafe-buffer-usage"
#endif // defined(__clang__)
#endif // defined(__GNUC__)
 
          char buf[64];
          // 64 bytes is sufficient for the longest decimal representation
          // of any standard arithmetic type (long double ~45 chars).
          static_assert (sizeof (buf) >= 50,
                         "buf must be large enough for any arithmetic type");
          auto [ptr, ec] = std::to_chars (buf, buf + sizeof (buf), msg);
          if (ec == std::errc{})
            deferred_output_.append (buf, ptr);
 
#if defined(__GNUC__)
#pragma GCC diagnostic pop
#endif // defined(__GNUC__)
        }
      else
        {
          deferred_output_.append (msg);
        }
      return *this;
    }
 
    // ------------------------------------------------------------------------

    template <class Expr_T>
    deferred_reporter::deferred_reporter (
        const Expr_T& expr, bool abort,
        const reflection::source_location& location, subtest& subtest,
        expression_formatter& expression)
        : deferred_reporter_base{ static_cast<bool> (expr), location, subtest }
 
    {
#if defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_CONSTRUCTORS_ENABLED)
      trace::printf ("%s\n", __PRETTY_FUNCTION__);
#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_CONSTRUCTORS_ENABLED
      abort_ = abort;
      has_expression_ = type_traits::is_op<Expr_T>;
 
      expression.clear ();
 
      expression << expr;
    }
 
    // ------------------------------------------------------------------------
  } // namespace detail
 
  // --------------------------------------------------------------------------
} // 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_INLINES_DEFERRED_REPORTER_INLINES_H_
 
// ----------------------------------------------------------------------------