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

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

@@ -54,10 +54,11 @@
 
 // ----------------------------------------------------------------------------
 
-#include "math.h"
 #include <string_view>
 #include <type_traits>
 
+#include "math.h"
+
 // ----------------------------------------------------------------------------
 
 #if defined(__GNUC__)
@@ -517,23 +518,15 @@ namespace micro_os_plus::micro_test_plus
        *
        * @param v The value to be stored.
        */
-      constexpr explicit value_base_ (const T& v) noexcept : value_{ v }
-      {
-      }
+      constexpr explicit value_base_ (const T& v) noexcept;
 
       /**
        * @brief Explicit conversion operator to the underlying value type.
        *
        * @return The stored value as type `T`.
-       *
-       * @details
-       * Allows explicit conversion to the encapsulated value.
        */
       [[nodiscard]] constexpr explicit
-      operator T () const noexcept
-      {
-        return value_;
-      }
+      operator T () const noexcept;
 
       /**
        * @brief Getter for the stored value.
@@ -541,15 +534,9 @@ namespace micro_os_plus::micro_test_plus
        * @par Parameters
        *	 None.
        * @return The stored value.
-       *
-       * @details
-       * Returns the stored value by value.
        */
       [[nodiscard]] constexpr T
-      get (void) const noexcept
-      {
-        return value_;
-      }
+      get (void) const noexcept;
 
       /**
        * @brief The stored value.
@@ -586,24 +573,15 @@ namespace micro_os_plus::micro_test_plus
       /**
        * @brief Default constructor. Initialises the base with `N`.
        */
-      constexpr integral_constant () noexcept : value_base_<decltype (N)>{ N }
-      {
-      }
+      constexpr integral_constant () noexcept;
 
       /**
        * @brief Unary minus operator.
        *
        * @return An `integral_constant` with value `-N`.
-       *
-       * @details
-       * Returns a new `integral_constant` instance representing the negative
-       * of the current value.
        */
       [[nodiscard]] constexpr auto
-      operator- () const noexcept
-      {
-        return integral_constant<-N>{};
-      }
+      operator- () const noexcept;
     };
 
     /**
@@ -668,10 +646,7 @@ namespace micro_os_plus::micro_test_plus
        * @return The compile-time constant as type `T`.
        */
       [[nodiscard]] constexpr explicit
-      operator T () const noexcept
-      {
-        return value;
-      }
+      operator T () const noexcept;
 
       /**
        * @brief Getter for the compile-time constant value.
@@ -681,25 +656,15 @@ namespace micro_os_plus::micro_test_plus
        * @return The compile-time constant as type `T`.
        */
       [[nodiscard]] constexpr T
-      get (void) const noexcept
-      {
-        return value;
-      }
+      get (void) const noexcept;
 
       /**
        * @brief Unary minus operator.
        *
        * @return A `floating_point_constant` with negated sign parameter.
-       *
-       * @details
-       * Returns a new `floating_point_constant` instance representing the
-       * negative of the current value by flipping the sign parameter `P`.
        */
       [[nodiscard]] constexpr auto
-      operator- () const noexcept
-      {
-        return floating_point_constant<T, N, D, Size, -P>{};
-      }
+      operator- () const noexcept;
     };
 
     /**
@@ -722,10 +687,7 @@ namespace micro_os_plus::micro_test_plus
        *
        * @param _value The integral value to be stored.
        */
-      constexpr genuine_integral_value (const T& _value) noexcept
-          : value_base_<T>{ _value }
-      {
-      }
+      constexpr genuine_integral_value (const T& _value) noexcept;
     };
 
     /**
@@ -749,9 +711,7 @@ namespace micro_os_plus::micro_test_plus
        *
        * @param _value The value to be stored.
        */
-      constexpr value (const T& _value) noexcept : value_base_<T>{ _value }
-      {
-      }
+      constexpr value (const T& _value) noexcept;
     };
 
     /**
@@ -792,11 +752,24 @@ namespace micro_os_plus::micro_test_plus
        */
       T epsilon = T{};
 
+      // Note: These constructor bodies are defined inline rather than
+      // out-of-line in type-traits-inlines.h. Clang 16 has a deficiency
+      // where it fails to match out-of-line constructor definitions to a
+      // `requires`-constrained partial specialisation: it either rejects
+      // the `requires` clause on the definition as differing from the
+      // declaration, or — when the clause is omitted — incorrectly matches
+      // the definition against the primary template instead of this
+      // specialisation. Keeping the bodies here avoids both failure modes.
+
       /**
        * @brief Constructs a floating-point value with a specified precision.
        *
        * @param _value The floating-point value to be stored.
        * @param precision The epsilon value to be used for comparisons.
+       *
+       * @details
+       * Delegates to `value_base_<T>{ _value }` and stores the supplied
+       * precision in `epsilon`.
        */
       constexpr value (const T& _value, const T precision) noexcept
           : value_base_<T>{ _value }, epsilon{ precision }
@@ -835,6 +808,11 @@ namespace micro_os_plus::micro_test_plus
 
 #endif // __cplusplus
 
+// ============================================================================
+// Templates & constexpr implementations.
+
+#include "inlines/type-traits-inlines.h"
+
 // ----------------------------------------------------------------------------
 
 #endif // MICRO_TEST_PLUS_TYPE_TRAITS_H_

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

@@ -34,10 +34,6 @@
 
 // ----------------------------------------------------------------------------
 
-#if defined(MICRO_OS_PLUS_INCLUDE_CONFIG_H)
-#include <micro-os-plus/config.h>
-#endif // MICRO_OS_PLUS_INCLUDE_CONFIG_H
-
 #include <string_view>
 #include <vector>
 
@@ -128,6 +124,11 @@ namespace micro_os_plus::micro_test_plus
 
 #endif // __cplusplus
 
+// ============================================================================
+// Templates & constexpr implementations.
+
+#include "inlines/utility-inlines.h"
+
 // ----------------------------------------------------------------------------
 
 #endif // MICRO_TEST_PLUS_UTILITY_H_

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

@@ -63,29 +63,58 @@
 #include <micro-os-plus/config.h>
 #endif // MICRO_OS_PLUS_INCLUDE_CONFIG_H
 
+// No deps.
+#include "micro-test-plus/math.h"
+
+// Requires math.h.
 #include "micro-test-plus/type-traits.h"
+
+// No deps.
 #include "micro-test-plus/reflection.h"
 
+// Requires type-traits.h, reflection.h.
 #include "micro-test-plus/detail.h"
 
-#include "micro-test-plus/math.h"
+// Requires type-traits.h, math.h.
 #include "micro-test-plus/literals.h"
+
+// No deps.
 #include "micro-test-plus/function-comparators.h"
+
+// No deps.
 #include "micro-test-plus/exceptions.h"
+
+// Requires type-traits.h + detail.h,
 #include "micro-test-plus/operators.h"
 
+// Requires type-traits.h, detail.h + reflection.h.
+#include "micro-test-plus/expression-formatter.h"
+
+// Requires type-traits.h, detail.h, expression-formatter.h, reflection.h.
+#include "micro-test-plus/reporter.h"
+
+// Requires type-traits.h, reflection.h, expression-formatter.h.
 #include "micro-test-plus/deferred-reporter.h"
-#include "micro-test-plus/test.h"
 
-#include "micro-test-plus/runner.h"
+// No deps.
 #include "micro-test-plus/runner-totals.h"
 
-#include "micro-test-plus/reporter.h"
+// Requires reporter.h, reflection.h.
 #include "micro-test-plus/reporter-human.h"
+
+// Requires reporter.h, reflection.h.
 #include "micro-test-plus/reporter-tap.h"
 
+// No deps.
 #include "micro-test-plus/utility.h"
 
+// Requires reporter.h, runner-totals.h, reflection.h, type-traits.h and
+// timings.h + deferred-reporter.h, reporter.h.
+#include "micro-test-plus/test.h"
+
+// Requires timings.h, test.h (detail::test_node, top_suite), reflection.h.
+#include "micro-test-plus/runner.h"
+
 // ----------------------------------------------------------------------------
 
 /**
@@ -113,26 +142,6 @@
  * straightforward integration with the wider µOS++ ecosystem.
  */
 
-// ============================================================================
-// Templates & constexpr implementations.
-
-#include <micro-os-plus/diag/trace.h>
-
-// All inlines are included **after** all declarations.
-#include "micro-test-plus/inlines/literals-inlines.h"
-#include "micro-test-plus/inlines/math-inlines.h"
-
-#include "micro-test-plus/inlines/reflection-inlines.h"
-
-#include "micro-test-plus/inlines/deferred-reporter-inlines.h"
-#include "micro-test-plus/inlines/reporter-inlines.h"
-
-#include "micro-test-plus/inlines/function-comparators-inlines.h"
-#include "micro-test-plus/inlines/runner-inlines.h"
-#include "micro-test-plus/inlines/test-inlines.h"
-
-#include "micro-test-plus/inlines/utility-inlines.h"
-
 // ----------------------------------------------------------------------------
 
 #endif // __cplusplus

package/meson.build

@@ -46,6 +46,7 @@ _local_sources += [
   'src/runner.cpp',
   'src/runner-totals.cpp',
   'src/deferred-reporter.cpp',
+  'src/expression-formatter.cpp',
   'src/reporter.cpp',
   'src/reporter-human.cpp',
   'src/reporter-tap.cpp',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@micro-os-plus/micro-test-plus",
-  "version": "4.0.0",
+  "version": "4.1.1",
   "description": "A source code library with µTest++, a lightweight testing framework for embedded platforms",
   "repository": {
     "type": "git",
@@ -50,12 +50,20 @@
     "postversion": "git push origin --all && git push origin --tags"
   },
   "xpack": {
-    "minimumXpmRequired": "0.20.8"
+    "minimumXpmRequired": "0.20.8",
+    "devDependencies": {
+      "@xpack-dev-tools/clang": "21.1.8-1.1"
+    },
+    "actions": {
+      "clang-format": "bash scripts/clang-format.sh",
+      "cmake-format": "bash scripts/cmake-format.sh"
+    }
   },
   "topConfig": {
     "descriptiveName": "µTest++ Testing Framework",
     "permalinkName": "micro-test-plus",
-    "useDoxygen": "true"
+    "useDoxygen": "true",
+    "hasObjectLibrary": "true"
   },
   "engines": {
     "node": ">=20.0"

package/src/deferred-reporter.cpp

@@ -40,8 +40,12 @@
 #include <micro-os-plus/config.h>
 #endif // MICRO_OS_PLUS_INCLUDE_CONFIG_H
 
-#include <micro-os-plus/micro-test-plus.h>
+#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/test.h"
 
 // ----------------------------------------------------------------------------
 
@@ -80,6 +84,16 @@ namespace micro_os_plus::micro_test_plus
 
     /**
      * @details
+     * The destructor finalises the deferred reporting process for a test
+     * expression. If the evaluated expression is true, the reporter records a
+     * successful outcome along with any accumulated message. If the expression
+     * is false, the reporter records a failure, including the abort status,
+     * message, and source location for comprehensive reporting.
+     *
+     * This mechanism ensures that all relevant information about the test
+     * outcome is captured and reported accurately when the deferred reporter
+     * goes out of scope.
+     *
      * The destructor ensures that if an abort condition is set and the test
      * expression has failed, the test output is flushed and the process is
      * terminated. This mechanism guarantees immediate feedback and halts
@@ -93,12 +107,18 @@ namespace micro_os_plus::micro_test_plus
       trace::printf ("%s\n", __PRETTY_FUNCTION__);
 #endif // MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS_CONSTRUCTORS
 
+      auto& expression_str = subtest_.reporter ().expression ().str ();
+
       if (value_) [[likely]]
         {
+          subtest_.reporter ().pass (deferred_output_, expression_str,
+                                     subtest_);
           subtest_.totals ().increment_successful_checks ();
         }
       else
         {
+          subtest_.reporter ().fail (abort_, deferred_output_, expression_str,
+                                     has_expression_, location_, subtest_);
           subtest_.totals ().increment_failed_checks ();
         }
 
@@ -109,7 +129,6 @@ namespace micro_os_plus::micro_test_plus
           subtest_.abort (location_);
         }
     }
-
   } // namespace detail
 
   // ==========================================================================

package/src/expression-formatter.cpp

@@ -0,0 +1,289 @@
+/*
+ * 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++ source file with non-template implementations for the µTest++
+ * expression formatter.
+ *
+ * @details
+ * This source file contains the non-template `operator<<` overloads of
+ * `expression_formatter` for all standard arithmetic, character, string,
+ * boolean, and null-pointer types. Each overload appends the formatted
+ * value — together with an appropriate type suffix where applicable — to
+ * the internal string buffer.
+ *
+ * All definitions reside within the
+ * `micro_os_plus::micro_test_plus` namespace.
+ *
+ * This file must be included when building the µTest++ library.
+ */
+
+// ----------------------------------------------------------------------------
+
+#if defined(MICRO_OS_PLUS_INCLUDE_CONFIG_H)
+#include <micro-os-plus/config.h>
+#endif // MICRO_OS_PLUS_INCLUDE_CONFIG_H
+
+#include "micro-os-plus/micro-test-plus/expression-formatter.h"
+
+// ----------------------------------------------------------------------------
+
+#if defined(__GNUC__)
+#pragma GCC diagnostic ignored "-Waggregate-return"
+#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::detail
+{
+  // --------------------------------------------------------------------------
+
+  /**
+   * @details
+   * Appends the contents of the `std::string_view` directly to the
+   * internal buffer using `buffer_.append(sv)`.
+   */
+  expression_formatter&
+  expression_formatter::operator<< (std::string_view sv)
+  {
+    buffer_.append (sv);
+    return *this;
+  }
+
+  /**
+   * @details
+   * Appends the single character @p c to the internal buffer using
+   * `buffer_.append(1, c)`.
+   */
+  expression_formatter&
+  expression_formatter::operator<< (char c)
+  {
+    buffer_.append (1, c);
+    return *this;
+  }
+
+  /**
+   * @details
+   * Appends the null-terminated C string @p s to the internal buffer
+   * using `buffer_.append(s)`.
+   */
+  expression_formatter&
+  expression_formatter::operator<< (const char* s)
+  {
+    buffer_.append (s);
+    return *this;
+  }
+
+  /**
+   * @details
+   * Appends the string `"true"` or `"false"` to the internal buffer
+   * based on the value of @p v.
+   */
+  expression_formatter&
+  expression_formatter::operator<< (bool v)
+  {
+    buffer_.append (v ? "true" : "false");
+    return *this;
+  }
+
+  /**
+   * @details
+   * Appends the string `"nullptr"` to the internal buffer.
+   */
+  expression_formatter&
+  expression_formatter::operator<< (std::nullptr_t)
+  {
+    buffer_.append ("nullptr");
+    return *this;
+  }
+
+  /**
+   * @details
+   * Converts @p c to its decimal string representation via
+   * `append_number_()` and appends the type suffix `"c"`.
+   */
+  expression_formatter&
+  expression_formatter::operator<< (signed char c)
+  {
+    detail::append_number_ (buffer_, c);
+    buffer_.append ("c");
+    return *this;
+  }
+
+  /**
+   * @details
+   * Converts @p c to its decimal string representation via
+   * `append_number_()` and appends the type suffix `"uc"`.
+   */
+  expression_formatter&
+  expression_formatter::operator<< (unsigned char c)
+  {
+    detail::append_number_ (buffer_, c);
+    buffer_.append ("uc");
+    return *this;
+  }
+
+  /**
+   * @details
+   * Converts @p v to its decimal string representation via
+   * `append_number_()` and appends the type suffix `"s"`.
+   */
+  expression_formatter&
+  expression_formatter::operator<< (signed short v)
+  {
+    detail::append_number_ (buffer_, v);
+    buffer_.append ("s");
+    return *this;
+  }
+
+  /**
+   * @details
+   * Converts @p v to its decimal string representation via
+   * `append_number_()` and appends the type suffix `"us"`.
+   */
+  expression_formatter&
+  expression_formatter::operator<< (unsigned short v)
+  {
+    detail::append_number_ (buffer_, v);
+    buffer_.append ("us");
+    return *this;
+  }
+
+  /**
+   * @details
+   * Converts @p v to its decimal string representation via
+   * `append_number_()` without a type suffix.
+   */
+  expression_formatter&
+  expression_formatter::operator<< (signed int v)
+  {
+    detail::append_number_ (buffer_, v);
+    return *this;
+  }
+
+  /**
+   * @details
+   * Converts @p v to its decimal string representation via
+   * `append_number_()` and appends the type suffix `"u"`.
+   */
+  expression_formatter&
+  expression_formatter::operator<< (unsigned int v)
+  {
+    detail::append_number_ (buffer_, v);
+    buffer_.append ("u");
+    return *this;
+  }
+
+  /**
+   * @details
+   * Converts @p v to its decimal string representation via
+   * `append_number_()` and appends the type suffix `"l"`.
+   */
+  expression_formatter&
+  expression_formatter::operator<< (signed long v)
+  {
+    detail::append_number_ (buffer_, v);
+    buffer_.append ("l");
+    return *this;
+  }
+
+  /**
+   * @details
+   * Converts @p v to its decimal string representation via
+   * `append_number_()` and appends the type suffix `"ul"`.
+   */
+  expression_formatter&
+  expression_formatter::operator<< (unsigned long v)
+  {
+    detail::append_number_ (buffer_, v);
+    buffer_.append ("ul");
+    return *this;
+  }
+
+  /**
+   * @details
+   * Converts @p v to its decimal string representation via
+   * `append_number_()` and appends the type suffix `"ll"`.
+   */
+  expression_formatter&
+  expression_formatter::operator<< (signed long long v)
+  {
+    detail::append_number_ (buffer_, v);
+    buffer_.append ("ll");
+    return *this;
+  }
+
+  /**
+   * @details
+   * Converts @p v to its decimal string representation via
+   * `append_number_()` and appends the type suffix `"ull"`.
+   */
+  expression_formatter&
+  expression_formatter::operator<< (unsigned long long v)
+  {
+    detail::append_number_ (buffer_, v);
+    buffer_.append ("ull");
+    return *this;
+  }
+
+  /**
+   * @details
+   * Converts @p v to its string representation via `append_number_()`
+   * and appends the type suffix `"f"`.
+   */
+  expression_formatter&
+  expression_formatter::operator<< (float v)
+  {
+    detail::append_number_ (buffer_, v);
+    buffer_.append ("f");
+    return *this;
+  }
+
+  /**
+   * @details
+   * Converts @p v to its string representation via `append_number_()`
+   * without a type suffix.
+   */
+  expression_formatter&
+  expression_formatter::operator<< (double v)
+  {
+    detail::append_number_ (buffer_, v);
+    return *this;
+  }
+
+  /**
+   * @details
+   * Converts @p v to its string representation via `append_number_()`
+   * and appends the type suffix `"l"`.
+   */
+  expression_formatter&
+  expression_formatter::operator<< (long double v)
+  {
+    detail::append_number_ (buffer_, v);
+    buffer_.append ("l");
+    return *this;
+  }
+
+  // --------------------------------------------------------------------------
+} // namespace micro_os_plus::micro_test_plus::detail
+
+// ----------------------------------------------------------------------------

package/src/reflection.cpp

@@ -33,11 +33,13 @@
 
 // ----------------------------------------------------------------------------
 
+#include <cstring>
+
 #if defined(MICRO_OS_PLUS_INCLUDE_CONFIG_H)
 #include <micro-os-plus/config.h>
 #endif // MICRO_OS_PLUS_INCLUDE_CONFIG_H
 
-#include <micro-os-plus/micro-test-plus.h>
+#include "micro-os-plus/micro-test-plus/reflection.h"
 
 // ----------------------------------------------------------------------------