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

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

@@ -55,6 +55,13 @@
 #include <cstdio>
 #include <cstring>
 
+#if defined(MICRO_OS_PLUS_TRACE)
+#include <micro-os-plus/diag/trace.h>
+#endif // MICRO_OS_PLUS_TRACE
+
+#include "micro-os-plus/micro-test-plus/deferred-reporter.h"
+#include "micro-os-plus/micro-test-plus/reporter.h"
+
 // ----------------------------------------------------------------------------
 
 #if defined(__GNUC__)
@@ -64,6 +71,7 @@
 #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
 
@@ -71,36 +79,135 @@
 
 namespace micro_os_plus::micro_test_plus
 {
-  // ==========================================================================
-
-  /**
-   * @details
-   * Binds the callable and its arguments into the stored `callable_` function
-   * object. When `run()` is called, the stored function is invoked with a
-   * reference to the derived `Self_T` instance as its first argument,
-   * followed by the bound arguments.
-   */
-  template <typename Self_T>
-  template <typename Callable_T, typename... Args_T>
-  runnable<Self_T>::runnable (const char* name, class runner& runner,
-                              size_t own_index, Callable_T&& callable,
-                              Args_T&&... arguments)
-      : runnable_base{ name, runner, own_index }
+  namespace detail
   {
-    // When there are no extra arguments the callable already has the signature
-    // void(Self_T&), so store it directly. Only use std::bind when additional
-    // arguments must be pre-bound, to avoid triggering a GCC ARM bug in
-    // __is_nothrow_invocable<_Bind<...>, Self_T&> (GCC 15.2.1).
-    if constexpr (sizeof...(arguments) == 0)
-      {
-        callable_ = std::forward<Callable_T> (callable);
-      }
-    else
-      {
-        callable_ = std::bind (std::forward<Callable_T> (callable),
-                               std::placeholders::_1,
-                               std::forward<Args_T> (arguments)...);
-      }
+    // ========================================================================
+
+    /**
+     * @details
+     * Returns a pointer to the null-terminated name stored in `name_`.
+     */
+    inline const char*
+    test_node::name (void) const noexcept
+    {
+      return name_;
+    }
+
+    /**
+     * @details
+     * Returns a reference to the `runner_totals` member.
+     */
+    inline runner_totals&
+    test_node::totals () noexcept
+    {
+      return totals_;
+    }
+
+    /**
+     * @details
+     * Returns a const reference to the `runner_totals` member.
+     */
+    inline const runner_totals&
+    test_node::totals () const noexcept
+    {
+      return totals_;
+    }
+
+    // ========================================================================
+
+    /**
+     * @details
+     * Returns the one-based positional index of this object within its parent.
+     */
+    inline size_t
+    runnable_base::own_index () const noexcept
+    {
+      return own_index_;
+    }
+
+    /**
+     * @details
+     * Sets the positional index of this object within its parent.
+     */
+    inline void
+    runnable_base::own_index (size_t index) noexcept
+    {
+      own_index_ = index;
+    }
+
+    /**
+     * @details
+     * Returns the sequential index of the most recently created child subtest.
+     */
+    inline size_t
+    runnable_base::current_subtest_index () const noexcept
+    {
+      return current_subtest_index_;
+    }
+
+    /**
+     * @details
+     * Each call to `test()` invokes this method before constructing the new
+     * `subtest`, so the index values form a strictly increasing, one-based
+     * sequence.
+     */
+    inline size_t
+    runnable_base::increment_subtest_index () noexcept
+    {
+      return ++current_subtest_index_;
+    }
+
+    /**
+     * @details
+     * Returns the number of child subtests owned by this node.
+     */
+    inline size_t
+    runnable_base::children_subtests_count (void) const noexcept
+    {
+      return children_subtests_.size ();
+    }
+
+    /**
+     * @details
+     * Returns a reference to the owning test runner.
+     */
+    inline class runner&
+    runnable_base::runner (void) const noexcept
+    {
+      return runner_;
+    }
+
+    // ========================================================================
+
+    /**
+     * @details
+     * Binds the callable and its arguments into the stored `callable_`
+     * function object. When `run()` is called, the stored function is invoked
+     * with a reference to the derived `Self_T` instance as its first argument,
+     * followed by the bound arguments.
+     */
+    template <typename Self_T>
+    template <typename Callable_T, typename... Args_T>
+    runnable<Self_T>::runnable (const char* name, class runner& runner,
+                                size_t own_index, Callable_T&& callable,
+                                Args_T&&... arguments)
+        : runnable_base{ name, runner, own_index }
+    {
+      // When there are no extra arguments the callable already has the
+      // signature void(Self_T&), so store it directly. Only use std::bind when
+      // additional arguments must be pre-bound, to avoid triggering a GCC ARM
+      // bug in
+      // __is_nothrow_invocable<_Bind<...>, Self_T&> (GCC 15.2.1).
+      if constexpr (sizeof...(arguments) == 0)
+        {
+          callable_ = std::forward<Callable_T> (callable);
+        }
+      else
+        {
+          callable_ = std::bind (std::forward<Callable_T> (callable),
+                                 std::placeholders::_1,
+                                 std::forward<Args_T> (arguments)...);
+        }
 
 #if defined(MICRO_OS_PLUS_TRACE) \
     && defined(MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS_CONSTRUCTORS)
@@ -110,22 +217,22 @@ namespace micro_os_plus::micro_test_plus
 #pragma clang diagnostic ignored "-Wunsafe-buffer-usage-in-libc-call"
 #endif
 #endif
-    trace::printf ("%s '%s' %zu\n", __PRETTY_FUNCTION__, name, own_index_);
+      trace::printf ("%s '%s' %zu\n", __PRETTY_FUNCTION__, name, own_index_);
 #if defined(__GNUC__)
 #pragma GCC diagnostic pop
 #endif
 #endif // MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS_CONSTRUCTORS
-  }
-
-  /**
-   * @details
-   * No-op in production builds. When tracing is enabled via
-   * `MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS_CONSTRUCTORS`, emits a trace
-   * message identifying the instance being destroyed.
-   */
-  template <typename Self_T>
-  runnable<Self_T>::~runnable ()
-  {
+    }
+
+    /**
+     * @details
+     * No-op in production builds. When tracing is enabled via
+     * `MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS_CONSTRUCTORS`, emits a trace
+     * message identifying the instance being destroyed.
+     */
+    template <typename Self_T>
+    runnable<Self_T>::~runnable ()
+    {
 #if defined(MICRO_OS_PLUS_TRACE) \
     && defined(MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS_CONSTRUCTORS)
 #if defined(__GNUC__)
@@ -134,12 +241,15 @@ namespace micro_os_plus::micro_test_plus
 #pragma clang diagnostic ignored "-Wunsafe-buffer-usage-in-libc-call"
 #endif
 #endif
-    trace::printf ("%s '%s'\n", __PRETTY_FUNCTION__, name_);
+      trace::printf ("%s '%s'\n", __PRETTY_FUNCTION__, name_);
 #if defined(__GNUC__)
 #pragma GCC diagnostic pop
 #endif
 #endif // MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS_CONSTRUCTORS
-  }
+    }
+
+    // ------------------------------------------------------------------------
+  } // namespace detail
 
   // ==========================================================================
 
@@ -208,6 +318,47 @@ namespace micro_os_plus::micro_test_plus
     after_subtest_create_ (std::move (child_subtest), parent_suite_);
   }
 
+  /**
+   * @details
+   * Constructs and returns a `deferred_reporter<Expr_T>` with `abort = false`.
+   * The reporter evaluates the condition and records a pass or fail when
+   * it is destroyed at the end of the expression statement.
+   */
+  template <class Expr_T>
+    requires type_traits::checkable<Expr_T>
+  auto
+  subtest::expect (const Expr_T& expr, const reflection::source_location& sl)
+  {
+    return detail::deferred_reporter{ expr, false, sl, *this,
+                                      reporter ().expression () };
+  }
+
+  /**
+   * @details
+   * Constructs and returns a `deferred_reporter<Expr_T>` with `abort = true`.
+   * The reporter evaluates the condition, records a pass or fail when it is
+   * destroyed, and aborts execution if the condition is false.
+   */
+  template <class Expr_T>
+    requires type_traits::checkable<Expr_T>
+  auto
+  subtest::assume (const Expr_T& expr, const reflection::source_location& sl)
+  {
+    return detail::deferred_reporter{ expr, true, sl, *this,
+                                      reporter ().expression () };
+  }
+
+  /**
+   * @details
+   * Top-level subtests (direct children of a `suite`) have depth 1.
+   * Each additional level of nesting increments the depth by 1.
+   */
+  inline size_t
+  subtest::nesting_depth () const noexcept
+  {
+    return nesting_depth_;
+  }
+
   // ==========================================================================
 
   /**
@@ -308,6 +459,41 @@ namespace micro_os_plus::micro_test_plus
     after_subtest_create_ (std::move (child_subtest), *this);
   }
 
+  /**
+   * @details
+   * Returns a reference to the `timestamps` member.
+   */
+  inline detail::timestamps&
+  suite::timings () noexcept
+  {
+    return timings_;
+  }
+
+  /**
+   * @details
+   * Returns a const reference to the `timestamps` member.
+   */
+  inline const detail::timestamps&
+  suite::timings () const noexcept
+  {
+    return timings_;
+  }
+
+  // ==========================================================================
+
+  /**
+   * @details
+   * Sets the name of the top-level suite.
+   *
+   * Used internally by the runner to set the name of the top suite after
+   * initialisation.
+   */
+  inline void
+  top_suite::name (const char* new_name) noexcept
+  {
+    name_ = new_name;
+  }
+
   // ==========================================================================
 
   /**
@@ -321,7 +507,7 @@ namespace micro_os_plus::micro_test_plus
                               Callable_T&& callable, Args_T&&... arguments)
       // The nullptr passed to the base constructor is an optimisation to save
       // some space, since this callble is not used by the static runner.
-      : suite{ name, runner, nullptr }
+      : suite{ name, detail::to_runner (runner), nullptr }
   {
     if constexpr (sizeof...(arguments) == 0)
       {
@@ -348,7 +534,7 @@ namespace micro_os_plus::micro_test_plus
 #endif
 #endif // MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS_CONSTRUCTORS
 
-    static_runner::register_static_suite (runner, *this);
+    detail::register_static_suite (runner, *this);
   }
 
   // --------------------------------------------------------------------------

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

@@ -0,0 +1,120 @@
+/*
+ * 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.
+ */
+
+// ----------------------------------------------------------------------------
+
+/**
+ * @file
+ * @brief C++ header file with inline implementations for the µTest++
+ * timing utilities.
+ *
+ * @details
+ * This header provides the inline method bodies for the `timestamp` and
+ * `timestamps` classes, separated from the class declarations in
+ * `timings.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_TIMINGS_INLINES_H_
+#define MICRO_TEST_PLUS_TIMINGS_INLINES_H_
+
+// ----------------------------------------------------------------------------
+
+#ifdef __cplusplus
+
+// ----------------------------------------------------------------------------
+
+#if defined(__GNUC__)
+#pragma GCC diagnostic push
+#if defined(__clang__)
+#pragma clang diagnostic ignored "-Wc++98-compat"
+#pragma clang diagnostic ignored "-Wpre-c++17-compat"
+#endif
+#endif
+
+// ============================================================================
+
+namespace micro_os_plus::micro_test_plus::detail
+{
+  // ==========================================================================
+
+  /**
+   * @details
+   * Stores the supplied `timespec` value in the `value_` member.
+   */
+  inline timestamp::timestamp (const timespec& ts) noexcept : value_{ ts }
+  {
+  }
+
+  /**
+   * @details
+   * Returns a mutable reference to the `value_` member.
+   */
+  inline timespec&
+  timestamp::value () noexcept
+  {
+    return value_;
+  }
+
+  /**
+   * @details
+   * Returns a const reference to the `value_` member.
+   */
+  inline const timespec&
+  timestamp::value () const noexcept
+  {
+    return value_;
+  }
+
+  // ==========================================================================
+
+  /**
+   * @details
+   * Returns `true` when `begin_time_` holds a value, i.e. when
+   * `timestamp_begin()` has previously been called.
+   */
+  inline bool
+  timestamps::has_begin () const noexcept
+  {
+    return begin_time_.has_value ();
+  }
+
+  /**
+   * @details
+   * Returns `true` when `end_time_` holds a value, i.e. when
+   * `timestamp_end()` has previously been called.
+   */
+  inline bool
+  timestamps::has_end () const noexcept
+  {
+    return end_time_.has_value ();
+  }
+
+  // --------------------------------------------------------------------------
+} // namespace micro_os_plus::micro_test_plus::detail
+
+#if defined(__GNUC__)
+#pragma GCC diagnostic pop
+#endif
+
+// ----------------------------------------------------------------------------
+
+#endif // __cplusplus
+
+// ----------------------------------------------------------------------------
+
+#endif // MICRO_TEST_PLUS_TIMINGS_INLINES_H_
+
+// ----------------------------------------------------------------------------

package/include/micro-os-plus/micro-test-plus/inlines/type-traits-inlines.h

@@ -0,0 +1,231 @@
+/*
+ * 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++
+ * type trait utilities.
+ *
+ * @details
+ * This header provides the out-of-class template and inline implementations
+ * for all methods declared in the type-traits struct templates in
+ * `type-traits.h`. It defines the bodies of the constructors, conversion
+ * operators, and accessor methods for `value_base_`, `integral_constant`,
+ * `floating_point_constant`, `genuine_integral_value`, and the `value<T>`
+ * templates.
+ *
+ * Separating the implementations from the declarations keeps `type-traits.h`
+ * concise and focused on the interface, whilst grouping all method bodies
+ * here for maintainability.
+ *
+ * All definitions reside within the
+ * `micro_os_plus::micro_test_plus::type_traits` namespace, ensuring clear
+ * separation from user code and minimising the risk of naming conflicts.
+ *
+ * This file is intended solely for internal use within the framework and
+ * should not be included directly by user code.
+ */
+
+#ifndef MICRO_TEST_PLUS_TYPE_TRAITS_INLINES_H_
+#define MICRO_TEST_PLUS_TYPE_TRAITS_INLINES_H_
+
+// ----------------------------------------------------------------------------
+
+#ifdef __cplusplus
+
+// ----------------------------------------------------------------------------
+
+#if defined(__GNUC__)
+#pragma GCC diagnostic push
+#if defined(__clang__)
+#pragma clang diagnostic ignored "-Wc++98-compat"
+#pragma clang diagnostic ignored "-Wc++98-compat-pedantic"
+#endif
+#endif
+
+// ============================================================================
+
+namespace micro_os_plus::micro_test_plus
+{
+  namespace type_traits
+  {
+    // ========================================================================
+
+    /**
+     * @details
+     * Stores the supplied value in the `value_` member.
+     */
+    template <class T>
+    constexpr value_base_<T>::value_base_ (const T& v) noexcept : value_{ v }
+    {
+    }
+
+    /**
+     * @details
+     * Allows explicit conversion to the encapsulated value.
+     */
+    template <class T>
+    constexpr value_base_<T>::
+    operator T () const noexcept
+    {
+      return value_;
+    }
+
+    /**
+     * @details
+     * Returns the stored value by value.
+     */
+    template <class T>
+    constexpr T
+    value_base_<T>::get (void) const noexcept
+    {
+      return value_;
+    }
+
+    // ------------------------------------------------------------------------
+
+    /**
+     * @details
+     * Delegates to `value_base_<decltype(N)>{ N }` to initialise the base.
+     */
+    template <auto N>
+    constexpr integral_constant<N>::integral_constant () noexcept
+        : value_base_<decltype (N)>{ N }
+    {
+    }
+
+    /**
+     * @details
+     * Returns a new `integral_constant` instance representing the negative
+     * of the current value.
+     */
+    template <auto N>
+    constexpr auto
+    integral_constant<N>::operator- () const noexcept
+    {
+      return integral_constant<-N>{};
+    }
+
+    // ------------------------------------------------------------------------
+
+    /**
+     * @details
+     * Returns the compile-time constant value as type `T`.
+     */
+    template <class T, auto N, auto D, auto Size, auto P>
+    constexpr floating_point_constant<T, N, D, Size, P>::
+    operator T () const noexcept
+    {
+      return value;
+    }
+
+    /**
+     * @details
+     * Returns the compile-time constant value as type `T`.
+     */
+    template <class T, auto N, auto D, auto Size, auto P>
+    constexpr T
+    floating_point_constant<T, N, D, Size, P>::get (void) const noexcept
+    {
+      return value;
+    }
+
+    /**
+     * @details
+     * Returns a new `floating_point_constant` instance representing the
+     * negative of the current value by flipping the sign parameter `P`.
+     */
+    template <class T, auto N, auto D, auto Size, auto P>
+    constexpr auto
+    floating_point_constant<T, N, D, Size, P>::operator- () const noexcept
+    {
+      return floating_point_constant<T, N, D, Size, -P>{};
+    }
+
+    // ------------------------------------------------------------------------
+
+    /**
+     * @details
+     * Delegates to `value_base_<T>{ _value }` to initialise the base.
+     */
+    template <class T>
+    constexpr genuine_integral_value<T>::genuine_integral_value (
+        const T& _value) noexcept
+        : value_base_<T>{ _value }
+    {
+    }
+
+    // ------------------------------------------------------------------------
+
+    /**
+     * @details
+     * Delegates to `value_base_<T>{ _value }` to initialise the base.
+     */
+    template <class T>
+    constexpr value<T>::value (const T& _value) noexcept
+        : value_base_<T>{ _value }
+    {
+    }
+
+    // ------------------------------------------------------------------------
+
+    /**
+     * @details
+     * Delegates to `value_base_<T>{ _value }` and stores the supplied
+     * precision in `epsilon`.
+     */
+    template <class T>
+      requires is_floating_point<T>
+    constexpr value<T>::value (const T& _value, const T precision) noexcept
+        : value_base_<T>{ _value }, epsilon{ precision }
+    {
+    }
+
+    /**
+     * @details
+     * The epsilon is computed as 1 divided by 10 raised to the number of
+     * decimal digits in the value.
+     */
+    template <class T>
+      requires is_floating_point<T>
+    constexpr value<T>::value (const T& val)
+        : value{ val,
+                 T (1)
+                     / math::pow (T (10),
+                                  math::den_size<unsigned long long> (val)) }
+    {
+    }
+
+    // ------------------------------------------------------------------------
+  } // namespace type_traits
+
+  // --------------------------------------------------------------------------
+} // namespace micro_os_plus::micro_test_plus
+
+#if defined(__GNUC__)
+#pragma GCC diagnostic pop
+#endif
+
+// ----------------------------------------------------------------------------
+
+#endif // __cplusplus
+
+// ----------------------------------------------------------------------------
+
+#endif // MICRO_TEST_PLUS_TYPE_TRAITS_INLINES_H_
+
+// ----------------------------------------------------------------------------