check-result.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.
 */
 
// ----------------------------------------------------------------------------

 
#ifndef MICRO_OS_PLUS_MICRO_TEST_PLUS_CHECK_RESULT_H_
#define MICRO_OS_PLUS_MICRO_TEST_PLUS_CHECK_RESULT_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 "expression-formatter.h"
#include "extension.h"
#include "reflection.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 test_case;
 
  // --------------------------------------------------------------------------
 
  namespace detail
  {
    // ========================================================================

    enum class check_kind
    {
      expectation,

      requirement
    };
 
    // ========================================================================

    struct failure_info
    {
      check_kind kind;

      std::string message;

      bool has_expression;

      reflection::source_location location;
    };
 
    // ========================================================================

    class check_result
    {
    public:
      check_result (void);

      template <class Expr_T>
      void
      init (const Expr_T& expr, check_kind kind,
            const reflection::source_location& location, test_case& test_case,
            expression_formatter& expression, bool writes_passed);

      check_result (const check_result&) = delete;

      check_result (check_result&&) = delete;

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

      check_result&
      operator= (check_result&&)
          = delete;

      ~check_result () noexcept (false);

      template <class T>
        requires detail::message_argument<T>
      check_result&&
      operator<< (const T& msg) &&;
 
#if !defined(__DOXYGEN__)
      template <class T>
        requires (not detail::message_argument<T>)
      check_result&&
      operator<< (const T& msg) &&;
#endif // !defined(__DOXYGEN__)

      [[nodiscard]] bool
      value (void) const&& noexcept;
 
    private:
      void
      start (bool value, check_kind kind, bool has_expression,
             const reflection::source_location& location, test_case& test_case,
             bool writes_passed);

      bool value_ = false;

      bool is_written_ = false;

      failure_info info_;

#if defined(__cpp_exceptions)
      int uncaught_exceptions_ = 0;
#endif // defined(__cpp_exceptions)

      test_case* test_case_ = nullptr;
    };
 
    // ------------------------------------------------------------------------
  } // 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/check-result-inlines.h"
 
// ----------------------------------------------------------------------------
 
#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_CHECK_RESULT_H_
 
// ----------------------------------------------------------------------------