runner-totals.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_TEST_PLUS_TEST_RUNNER_TOTALS_H_
#define MICRO_TEST_PLUS_TEST_RUNNER_TOTALS_H_
 
// ----------------------------------------------------------------------------
 
#ifdef __cplusplus
 
// ----------------------------------------------------------------------------
 
#include <cstddef>
 
// ----------------------------------------------------------------------------
 
#if defined(__GNUC__)
#pragma GCC diagnostic push
#if defined(__clang__)
#pragma clang diagnostic ignored "-Wc++98-compat"
#endif
#endif
 
// ============================================================================
 
namespace micro_os_plus::micro_test_plus
{
  // --------------------------------------------------------------------------
 
  namespace detail
  {
    // ========================================================================

    class runner_totals
    {
    public:
      runner_totals () = default;

      runner_totals (const runner_totals&) = delete;

      runner_totals (runner_totals&&) = delete;

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

      runner_totals&
      operator= (runner_totals&&)
          = delete;

      runner_totals&
      operator+= (const runner_totals& other) noexcept;

      void
      increment_successful_checks (size_t count = 1) noexcept;

      void
      increment_failed_checks (size_t count = 1) noexcept;

      void
      increment_executed_subtests (size_t count = 1) noexcept;

      [[nodiscard]] size_t
      successful_checks () const noexcept;

      [[nodiscard]] size_t
      failed_checks () const noexcept;

      [[nodiscard]] size_t
      executed_checks () const noexcept;

      [[nodiscard]] size_t
      executed_subtests () const noexcept;

      [[nodiscard]] bool
      was_successful (void) const noexcept;
 
    protected:
      size_t successful_checks_ = 0;

      size_t failed_checks_ = 0;

      size_t executed_subtests_ = 0;
    };
 
    // ------------------------------------------------------------------------
  } // namespace detail
 
  // --------------------------------------------------------------------------
} // namespace micro_os_plus::micro_test_plus
 
#if defined(__GNUC__)
#pragma GCC diagnostic pop
#endif
 
// ----------------------------------------------------------------------------
 
#endif // __cplusplus
 
// ============================================================================
// Templates & constexpr implementations.
 
#include "inlines/runner-totals-inlines.h"
 
// ----------------------------------------------------------------------------
 
#endif // MICRO_TEST_PLUS_TEST_RUNNER_TOTALS_H_
 
// ----------------------------------------------------------------------------