counters.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_COUNTERS_H_
#define MICRO_OS_PLUS_MICRO_TEST_PLUS_COUNTERS_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 <cstddef>
 
// ----------------------------------------------------------------------------
 
#if defined(__GNUC__)
#pragma GCC diagnostic push
 
#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 test_case;
 
  namespace detail
  {
    class check_result;
    class runnable_base;
  } // namespace detail
 
  // ==========================================================================

  class counters
  {
  public:
    counters (void) = default;

    counters (const counters& other) = default;

    counters (counters&& other) = default;

    counters&
    operator= (const counters& other)
        = default;

    counters&
    operator= (counters&& other)
        = default;

    ~counters () = default;

    [[nodiscard]] size_t
    passed_checks (void) const noexcept;
 
#if defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_DEPRECATED_ENABLED)

    [[deprecated ("use passed_checks() (since 6.0.0)"), nodiscard]] size_t
    successful_checks (void) const noexcept;

#endif // defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_DEPRECATED_ENABLED)

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

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

    [[nodiscard]] size_t
    executed_test_cases (void) const noexcept;
 
#if defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_DEPRECATED_ENABLED)

    [[deprecated ("use executed_test_cases() (since 6.0.0)"),
      nodiscard]] size_t
    executed_subtests (void) const noexcept;

#endif // defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_DEPRECATED_ENABLED)

    [[nodiscard]] size_t
    failed_test_cases (void) const noexcept;

    [[nodiscard]] size_t
    skipped_test_cases (void) const noexcept;

    [[nodiscard]] bool
    passed (void) const noexcept;
 
#if defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_DEPRECATED_ENABLED)

    [[deprecated ("use passed() (since 6.0.0)"), nodiscard]] bool
    was_successful (void) const noexcept;

#endif // defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_DEPRECATED_ENABLED)
 
  private:
    friend class runner;

    friend class suite;

    friend class test_case;

    friend class detail::check_result;

    friend class detail::runnable_base;

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

    void
    increment_passed_checks (size_t count = 1) noexcept;

    void
    increment_failed_checks (size_t count = 1) noexcept;

    void
    increment_executed_test_cases (size_t count = 1) noexcept;

    void
    increment_failed_test_cases (size_t count = 1) noexcept;

    void
    increment_skipped_test_cases (size_t count = 1) noexcept;

    size_t passed_checks_ = 0;

    size_t failed_checks_ = 0;

    size_t executed_test_cases_ = 0;

    size_t failed_test_cases_ = 0;

    size_t skipped_test_cases_ = 0;
  };
 
  // --------------------------------------------------------------------------
} // 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/counters-inlines.h"
 
// ----------------------------------------------------------------------------
 
#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_COUNTERS_H_
 
// ----------------------------------------------------------------------------