@micro-os-plus/micro-test-plus 3.3.1 → 4.1.0

package/include/micro-os-plus/micro-test-plus/inlines/runner-inlines.h

@@ -0,0 +1,151 @@
+/*
+ * 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.
+ */
+
+// ----------------------------------------------------------------------------
+
+/**
+ * @file
+ * @brief C++ header file with inline implementations for the µTest++ test
+ * runner.
+ *
+ * @details
+ * This header provides the inline template implementation for
+ * `runner::suite()`, the method used to create and register a named test
+ * suite with a `runner` instance. The method constructs a `suite` object
+ * on the heap (wrapped in `std::unique_ptr`), transfers ownership to the
+ * runner via `register_suite_()`, and the newly created suite runs
+ * immediately as part of the registration process.
+ *
+ * The implementation is separated into this inline header so that the
+ * template definition is visible at every call site without cluttering the
+ * main `runner.h` declaration file.
+ *
+ * This file is intended solely for internal use within the framework and
+ * should not be included directly by user code.
+ */
+
+#ifndef MICRO_TEST_PLUS_TEST_RUNNER_INLINES_H_
+#define MICRO_TEST_PLUS_TEST_RUNNER_INLINES_H_
+
+// ----------------------------------------------------------------------------
+
+#ifdef __cplusplus
+
+// ----------------------------------------------------------------------------
+
+#if defined(MICRO_OS_PLUS_TRACE)
+#include <micro-os-plus/diag/trace.h>
+#endif // MICRO_OS_PLUS_TRACE
+
+// ----------------------------------------------------------------------------
+
+#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"
+#else // GCC only
+#pragma GCC diagnostic ignored "-Wredundant-tags"
+#endif
+#endif
+
+// ============================================================================
+
+namespace micro_os_plus::micro_test_plus
+{
+  // ==========================================================================
+
+  /**
+   * @details
+   * Returns a reference to the reporter object stored in the unique pointer.
+   */
+  inline class reporter&
+  runner::reporter (void) const noexcept
+  {
+    return *reporter_;
+  }
+
+  /**
+   * @details
+   * Returns a reference to the `timestamps` member.
+   */
+  inline detail::timestamps&
+  runner::timings () noexcept
+  {
+    return timings_;
+  }
+
+  /**
+   * @details
+   * Returns a const reference to the `timestamps` member.
+   */
+  inline const detail::timestamps&
+  runner::timings () const noexcept
+  {
+    return timings_;
+  }
+
+  // --------------------------------------------------------------------------
+
+  /**
+   * @details
+   * Constructs a `suite` object on the heap, binding the callable and any
+   * additional arguments, then transfers ownership to the runner via
+   * `register_suite_()`. The suite runs immediately as part of the
+   * registration process.
+   */
+  template <typename Callable_T, typename... Args_T>
+  void
+  runner::suite (const char* name, Callable_T&& callable,
+                 Args_T&&... arguments)
+  {
+#if defined(MICRO_OS_PLUS_TRACE) \
+    && defined(MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS)
+#if defined(__GNUC__)
+#pragma GCC diagnostic push
+#if defined(__clang__)
+#pragma clang diagnostic ignored "-Wunsafe-buffer-usage-in-libc-call"
+#endif
+#endif
+    trace::printf ("%s '%s'\n", __PRETTY_FUNCTION__, name);
+#if defined(__GNUC__)
+#pragma GCC diagnostic pop
+#endif
+#endif // MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS
+
+    auto child_suite = std::make_unique<class suite> (
+        name, *this, std::forward<Callable_T> (callable),
+        std::forward<Args_T> (arguments)...);
+
+    register_suite_ (std::move (child_suite));
+  }
+
+  // --------------------------------------------------------------------------
+} // namespace micro_os_plus::micro_test_plus
+
+#if defined(__GNUC__)
+#pragma GCC diagnostic pop
+#endif
+
+// ----------------------------------------------------------------------------
+
+#endif // __cplusplus
+
+// ----------------------------------------------------------------------------
+
+#endif // MICRO_TEST_PLUS_TEST_RUNNER_INLINES_H_
+
+// ----------------------------------------------------------------------------

package/include/micro-os-plus/micro-test-plus/inlines/runner-totals-inlines.h

@@ -0,0 +1,152 @@
+/*
+ * 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.
+ */
+
+// ----------------------------------------------------------------------------
+
+/**
+ * @file
+ * @brief C++ header file with inline implementations for the µTest++
+ * runner totals.
+ *
+ * @details
+ * This header provides the inline method bodies for the `runner_totals`
+ * class, separated from the class declaration in `runner-totals.h` to
+ * enforce the project convention that declarations reside in headers
+ * and implementations reside in inline files.
+ *
+ * All definitions reside within the `micro_os_plus::micro_test_plus`
+ * namespace, ensuring clear separation from user code and minimising
+ * the risk of naming conflicts.
+ */
+
+#ifndef MICRO_TEST_PLUS_RUNNER_TOTALS_INLINES_H_
+#define MICRO_TEST_PLUS_RUNNER_TOTALS_INLINES_H_
+
+// ----------------------------------------------------------------------------
+
+#ifdef __cplusplus
+
+// ----------------------------------------------------------------------------
+
+#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::detail
+{
+  // ==========================================================================
+
+  /**
+   * @details
+   * Adds `count` to the `successful_checks_` counter.
+   */
+  inline void
+  runner_totals::increment_successful_checks (size_t count) noexcept
+  {
+    successful_checks_ += count;
+  }
+
+  /**
+   * @details
+   * Adds `count` to the `failed_checks_` counter.
+   */
+  inline void
+  runner_totals::increment_failed_checks (size_t count) noexcept
+  {
+    failed_checks_ += count;
+  }
+
+  /**
+   * @details
+   * Adds `count` to the `executed_subtests_` counter.
+   */
+  inline void
+  runner_totals::increment_executed_subtests (size_t count) noexcept
+  {
+    executed_subtests_ += count;
+  }
+
+  /**
+   * @details
+   * Returns the value of the `successful_checks_` counter.
+   */
+  inline size_t
+  runner_totals::successful_checks () const noexcept
+  {
+    return successful_checks_;
+  }
+
+  /**
+   * @details
+   * Returns the value of the `failed_checks_` counter.
+   */
+  inline size_t
+  runner_totals::failed_checks () const noexcept
+  {
+    return failed_checks_;
+  }
+
+  /**
+   * @details
+   * Returns the sum of `successful_checks_` and `failed_checks_`.
+   */
+  inline size_t
+  runner_totals::executed_checks () const noexcept
+  {
+    return successful_checks_ + failed_checks_;
+  }
+
+  /**
+   * @details
+   * Returns the value of the `executed_subtests_` counter.
+   */
+  inline size_t
+  runner_totals::executed_subtests () const noexcept
+  {
+    return executed_subtests_;
+  }
+
+  /**
+   * @details
+   * A runner with no checks at all is considered successful, as it
+   * did not fail any check.
+   */
+  inline bool
+  runner_totals::was_successful (void) const noexcept
+  {
+    return failed_checks_ == 0;
+  }
+
+  // --------------------------------------------------------------------------
+} // namespace micro_os_plus::micro_test_plus::detail
+
+#if defined(__GNUC__)
+#pragma GCC diagnostic pop
+#endif
+
+// ----------------------------------------------------------------------------
+
+#endif // __cplusplus
+
+// ----------------------------------------------------------------------------
+
+#endif // MICRO_TEST_PLUS_RUNNER_TOTALS_INLINES_H_
+
+// ----------------------------------------------------------------------------