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

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

@@ -60,6 +60,7 @@
 // ----------------------------------------------------------------------------
 
 #include <cstdint>
+
 #include "type-traits.h"
 #include "math.h"
 
@@ -643,14 +644,8 @@ namespace micro_os_plus::micro_test_plus
      * @brief Constructor for the deprecated strongly-typed wrapper.
      *
      * @param t The value to be wrapped and explicitly converted.
-     *
-     * @details
-     * Constructs an `_t` instance by forwarding the provided value to the base
-     * `type_traits::value<T>` wrapper.
      */
-    constexpr explicit _t (const T& t) : type_traits::value<T>{ t }
-    {
-    }
+    constexpr explicit _t (const T& t);
   };
 
 #if defined(__GNUC__)
@@ -885,14 +880,8 @@ namespace micro_os_plus::micro_test_plus
      * @brief Constructor for the strongly-typed wrapper.
      *
      * @param t The value to be wrapped and explicitly converted.
-     *
-     * @details
-     * Constructs a `to_t` instance by forwarding the provided value to the
-     * base `type_traits::value<T>` wrapper.
      */
-    constexpr explicit to_t (const T& t) : type_traits::value<T>{ t }
-    {
-    }
+    constexpr explicit to_t (const T& t);
   };
 
   // --------------------------------------------------------------------------
@@ -906,6 +895,11 @@ namespace micro_os_plus::micro_test_plus
 
 #endif // __cplusplus
 
+// ============================================================================
+// Templates & constexpr implementations.
+
+#include "inlines/literals-inlines.h"
+
 // ----------------------------------------------------------------------------
 
 #endif // MICRO_TEST_PLUS_LITERALS_H_

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

@@ -213,6 +213,11 @@ namespace micro_os_plus::micro_test_plus
 
 #endif // __cplusplus
 
+// ============================================================================
+// Templates & constexpr implementations.
+
+#include "inlines/math-inlines.h"
+
 // ----------------------------------------------------------------------------
 
 #endif // MICRO_TEST_PLUS_MATH_H_

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

@@ -54,7 +54,7 @@
 
 #include <string_view>
 
-#include "detail.h"
+#include "type-traits.h"
 
 // ----------------------------------------------------------------------------
 
@@ -107,9 +107,6 @@ namespace micro_os_plus::micro_test_plus
    */
   namespace operators
   {
-    // In order to simplify things and use the return type `auto`,
-    // the definition must be included before any use.
-
     /**
      * @ingroup micro-test-plus-string-operators
      * @brief Equality operator for `string_view` objects.
@@ -118,18 +115,9 @@ namespace micro_os_plus::micro_test_plus
      * @param [in] rhs The right hand side `std::string_view` operand.
      * @return A comparator object that evaluates to true if the string views
      * are equal.
-     *
-     * @details
-     * This overload of the equality operator enables direct comparison of two
-     * `std::string_view` objects within the µTest++ framework. It constructs a
-     * comparator object that can be used in test expectations and assertions
-     * to verify that two string views are equal.
      */
     [[nodiscard]] constexpr auto
-    operator== (std::string_view lhs, std::string_view rhs)
-    {
-      return detail::eq_{ lhs, rhs };
-    }
+    operator== (std::string_view lhs, std::string_view rhs);
 
     /**
      * @ingroup micro-test-plus-string-operators
@@ -139,18 +127,9 @@ namespace micro_os_plus::micro_test_plus
      * @param [in] rhs The right hand side `std::string_view` operand.
      * @return A comparator object that evaluates to true if the string views
      * are not equal.
-     *
-     * @details
-     * This overload of the non-equality operator enables direct comparison of
-     * two `std::string_view` objects within the µTest++ framework. It
-     * constructs a comparator object that can be used in test expectations and
-     * assertions to verify that two string views are not equal.
      */
     [[nodiscard]] constexpr auto
-    operator!= (std::string_view lhs, std::string_view rhs)
-    {
-      return detail::ne_{ lhs, rhs };
-    }
+    operator!= (std::string_view lhs, std::string_view rhs);
 
     /**
      * @ingroup micro-test-plus-container-operators
@@ -165,24 +144,12 @@ namespace micro_os_plus::micro_test_plus
      * @param [in] rhs The right hand side container operand.
      * @return A comparator object that evaluates to true if the containers are
      * equal.
-     *
-     * @details
-     * This overload of the equality operator enables direct comparison of two
-     * container objects within the µTest++ framework. It constructs a
-     * comparator object that can be used in test expectations and assertions
-     * to verify that two containers are equal in content and order.
-     *
-     * The operator is enabled only for types recognised as containers by the
-     * framework's type traits.
      */
     template <class Lhs_T, class Rhs_T>
       requires (type_traits::container_like<Lhs_T>
                 and type_traits::container_like<Rhs_T>)
     [[nodiscard]] constexpr auto
-    operator== (const Lhs_T& lhs, const Rhs_T& rhs)
-    {
-      return detail::eq_{ lhs, rhs };
-    }
+    operator== (const Lhs_T& lhs, const Rhs_T& rhs);
 
     /**
      * @ingroup micro-test-plus-container-operators
@@ -197,24 +164,12 @@ namespace micro_os_plus::micro_test_plus
      * @param [in] rhs The right hand side container operand.
      * @return A comparator object that evaluates to true if the containers are
      * not equal.
-     *
-     * @details
-     * This overload of the non-equality operator enables direct comparison of
-     * two container objects within the µTest++ framework. It constructs a
-     * comparator object that can be used in test expectations and assertions
-     * to verify that two containers are not equal in content or order.
-     *
-     * The operator is enabled only for types recognised as containers by the
-     * framework's type traits.
      */
     template <class Lhs_T, class Rhs_T>
       requires (type_traits::container_like<Lhs_T>
                 and type_traits::container_like<Rhs_T>)
     [[nodiscard]] constexpr auto
-    operator!= (const Lhs_T& lhs, const Rhs_T& rhs)
-    {
-      return detail::ne_{ lhs, rhs };
-    }
+    operator!= (const Lhs_T& lhs, const Rhs_T& rhs);
 
     /**
      * @ingroup micro-test-plus-operators
@@ -228,23 +183,11 @@ namespace micro_os_plus::micro_test_plus
      * @param [in] rhs Right hand side operand.
      * @return A comparator object that evaluates to true if the operands are
      * equal.
-     *
-     * @details
-     * This overload of the equality operator enables comparison between two
-     * operands, where at least one is a local type derived from the local `op`
-     * base. It constructs a comparator object that can be used within the
-     * µTest++ framework to assert that the operands are equal. This operator
-     * is intended for use with the framework's strongly-typed constants,
-     * wrappers, or other custom types, ensuring type-safe and expressive test
-     * assertions.
      */
     template <class Lhs_T, class Rhs_T>
       requires type_traits::any_op<Lhs_T, Rhs_T>
     [[nodiscard]] constexpr auto
-    operator== (const Lhs_T& lhs, const Rhs_T& rhs)
-    {
-      return detail::eq_{ lhs, rhs };
-    }
+    operator== (const Lhs_T& lhs, const Rhs_T& rhs);
 
     /**
      * @ingroup micro-test-plus-operators
@@ -258,23 +201,11 @@ namespace micro_os_plus::micro_test_plus
      * @param [in] rhs Right hand side operand.
      * @return A comparator object that evaluates to true if the operands are
      * not equal.
-     *
-     * @details
-     * This overload of the non-equality operator enables comparison between
-     * two operands, where at least one is a local type derived from the local
-     * `op` base. It constructs a comparator object that can be used within the
-     * µTest++ framework to assert that the operands are not equal. This
-     * operator is intended for use with the framework's strongly-typed
-     * constants, wrappers, or other custom types, ensuring type-safe and
-     * expressive test assertions.
      */
     template <class Lhs_T, class Rhs_T>
       requires type_traits::any_op<Lhs_T, Rhs_T>
     [[nodiscard]] constexpr auto
-    operator!= (const Lhs_T& lhs, const Rhs_T& rhs)
-    {
-      return detail::ne_{ lhs, rhs };
-    }
+    operator!= (const Lhs_T& lhs, const Rhs_T& rhs);
 
     /**
      * @ingroup micro-test-plus-operators
@@ -288,23 +219,11 @@ namespace micro_os_plus::micro_test_plus
      * @param [in] rhs Right hand side operand.
      * @return A comparator object that evaluates to true if the left hand side
      * operand is greater than the right hand side operand.
-     *
-     * @details
-     * This overload of the greater than operator enables comparison between
-     * two operands, where at least one is a local type derived from the local
-     * `op` base. It constructs a comparator object that can be used within the
-     * µTest++ framework to assert that the left hand side operand is greater
-     * than the right hand side operand. This operator is intended for use with
-     * the framework's strongly-typed constants, wrappers, or other custom
-     * types, ensuring type-safe and expressive test assertions.
      */
     template <class Lhs_T, class Rhs_T>
       requires type_traits::any_op<Lhs_T, Rhs_T>
     [[nodiscard]] constexpr auto
-    operator> (const Lhs_T& lhs, const Rhs_T& rhs)
-    {
-      return detail::gt_{ lhs, rhs };
-    }
+    operator> (const Lhs_T& lhs, const Rhs_T& rhs);
 
     /**
      * @ingroup micro-test-plus-operators
@@ -318,24 +237,11 @@ namespace micro_os_plus::micro_test_plus
      * @param [in] rhs Right hand side operand.
      * @return A comparator object that evaluates to true if the left hand side
      * operand is greater than or equal to the right hand side operand.
-     *
-     * @details
-     * This overload of the greater than or equal operator enables comparison
-     * between two operands, where at least one is a local type derived from
-     * the local `op` base. It constructs a comparator object that can be used
-     * within the µTest++ framework to assert that the left hand side operand
-     * is greater than or equal to the right hand side operand. This operator
-     * is intended for use with the framework's strongly-typed constants,
-     * wrappers, or other custom types, ensuring type-safe and expressive test
-     * assertions.
      */
     template <class Lhs_T, class Rhs_T>
       requires type_traits::any_op<Lhs_T, Rhs_T>
     [[nodiscard]] constexpr auto
-    operator>= (const Lhs_T& lhs, const Rhs_T& rhs)
-    {
-      return detail::ge_{ lhs, rhs };
-    }
+    operator>= (const Lhs_T& lhs, const Rhs_T& rhs);
 
     /**
      * @ingroup micro-test-plus-operators
@@ -349,23 +255,11 @@ namespace micro_os_plus::micro_test_plus
      * @param [in] rhs Right hand side operand.
      * @return A comparator object that evaluates to true if the left hand side
      * operand is less than the right hand side operand.
-     *
-     * @details
-     * This overload of the less than operator enables comparison between two
-     * operands, where at least one is a local type derived from the local `op`
-     * base. It constructs a comparator object that can be used within the
-     * µTest++ framework to assert that the left hand side operand is less than
-     * the right hand side operand. This operator is intended for use with the
-     * framework's strongly-typed constants, wrappers, or other custom types,
-     * ensuring type-safe and expressive test assertions.
      */
     template <class Lhs_T, class Rhs_T>
       requires type_traits::any_op<Lhs_T, Rhs_T>
     [[nodiscard]] constexpr auto
-    operator< (const Lhs_T& lhs, const Rhs_T& rhs)
-    {
-      return detail::lt_{ lhs, rhs };
-    }
+    operator< (const Lhs_T& lhs, const Rhs_T& rhs);
 
     /**
      * @ingroup micro-test-plus-operators
@@ -379,24 +273,11 @@ namespace micro_os_plus::micro_test_plus
      * @param [in] rhs Right hand side operand.
      * @return A comparator object that evaluates to true if the left hand side
      * operand is less than or equal to the right hand side operand.
-     *
-     * @details
-     * This overload of the less than or equal operator enables comparison
-     * between two operands, where at least one is a local type derived from
-     * the local `op` base. It constructs a comparator object that can be used
-     * within the µTest++ framework to assert that the left hand side operand
-     * is less than or equal to the right hand side operand. This operator is
-     * intended for use with the framework's strongly-typed constants,
-     * wrappers, or other custom types, ensuring type-safe and expressive test
-     * assertions.
      */
     template <class Lhs_T, class Rhs_T>
       requires type_traits::any_op<Lhs_T, Rhs_T>
     [[nodiscard]] constexpr auto
-    operator<= (const Lhs_T& lhs, const Rhs_T& rhs)
-    {
-      return detail::le_{ lhs, rhs };
-    }
+    operator<= (const Lhs_T& lhs, const Rhs_T& rhs);
 
     /**
      * @ingroup micro-test-plus-operators
@@ -410,23 +291,11 @@ namespace micro_os_plus::micro_test_plus
      * @param [in] rhs Right hand side operand.
      * @return A logical conjunction object that evaluates to true if both
      * operands are true.
-     *
-     * @details
-     * This overload of the logical `&&` (and) operator enables conjunction
-     * between two operands, where at least one is a local type derived from
-     * the local `op` base. It constructs a logical conjunction object that can
-     * be used within the µTest++ framework to assert that both operands
-     * evaluate to true. This operator is intended for use with the framework's
-     * strongly-typed constants, wrappers, or other custom types, ensuring
-     * type-safe and expressive test assertions.
      */
     template <class Lhs_T, class Rhs_T>
       requires type_traits::any_op<Lhs_T, Rhs_T>
     [[nodiscard]] constexpr auto
-    operator and (const Lhs_T& lhs, const Rhs_T& rhs)
-    {
-      return detail::and_{ lhs, rhs };
-    }
+    operator and (const Lhs_T& lhs, const Rhs_T& rhs);
 
     /**
      * @ingroup micro-test-plus-operators
@@ -440,23 +309,11 @@ namespace micro_os_plus::micro_test_plus
      * @param [in] rhs Right hand side operand.
      * @return A logical disjunction object that evaluates to true if at least
      * one operand is true.
-     *
-     * @details
-     * This overload of the logical `||` (or) operator enables disjunction
-     * between two operands, where at least one is a local type derived from
-     * the local `op` base. It constructs a logical disjunction object that can
-     * be used within the µTest++ framework to assert that at least one operand
-     * evaluates to true. This operator is intended for use with the
-     * framework's strongly-typed constants, wrappers, or other custom types,
-     * ensuring type-safe and expressive test assertions.
      */
     template <class Lhs_T, class Rhs_T>
       requires type_traits::any_op<Lhs_T, Rhs_T>
     [[nodiscard]] constexpr auto
-    operator or (const Lhs_T& lhs, const Rhs_T& rhs)
-    {
-      return detail::or_{ lhs, rhs };
-    }
+    operator or (const Lhs_T& lhs, const Rhs_T& rhs);
 
     /**
      * @ingroup micro-test-plus-operators
@@ -469,23 +326,11 @@ namespace micro_os_plus::micro_test_plus
      * @param [in] t Operand to be logically negated.
      * @return A logical negator object that evaluates to true if the operand
      * is false.
-     *
-     * @details
-     * This overload of the logical `!` (not) operator enables logical negation
-     * of an operand, provided it is a local type derived from the local `op`
-     * base. It constructs a logical negator object that can be used within the
-     * µTest++ framework to assert that a given condition is false. This
-     * operator is intended for use with the framework's strongly-typed
-     * constants, wrappers, or other custom types, ensuring type-safe and
-     * expressive test assertions.
      */
     template <class T>
       requires type_traits::is_op<T>
     [[nodiscard]] constexpr auto
-    operator not(const T& t)
-    {
-      return detail::not_{ t };
-    }
+    operator not(const T& t);
 
     // ------------------------------------------------------------------------
   } // namespace operators
@@ -501,6 +346,11 @@ namespace micro_os_plus::micro_test_plus
 
 #endif // __cplusplus
 
+// ============================================================================
+// Templates & constexpr implementations.
+
+#include "inlines/operators-inlines.h"
+
 // ----------------------------------------------------------------------------
 
 #endif // MICRO_TEST_PLUS_OPERATORS_H_

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

@@ -194,12 +194,6 @@ namespace micro_os_plus::micro_test_plus
      *
      * @param name The fully qualified name as a C-string.
      * @return A pointer to the short name within the input string.
-     *
-     * @details
-     * Searches @p name for the last `/` separator and returns a pointer to
-     * the character immediately following it, effectively stripping the
-     * folder path. If no `/` is found, the original pointer is returned
-     * unchanged.
      */
     const char*
     short_name (const char* name) noexcept;
@@ -212,12 +206,6 @@ namespace micro_os_plus::micro_test_plus
      * @par Parameters
      *	 None.
      * @return A `std::string_view` containing the extracted type name.
-     *
-     * @details
-     * Constructs a `std::string_view` from `__PRETTY_FUNCTION__` and
-     * parses out the portion that represents the template argument `T`,
-     * using compiler-specific prefix and suffix markers to locate the
-     * type-name substring at compile time.
      */
     template <class T>
     [[nodiscard]] constexpr auto
@@ -237,6 +225,11 @@ namespace micro_os_plus::micro_test_plus
 
 #endif // __cplusplus
 
+// ============================================================================
+// Templates & constexpr implementations.
+
+#include "inlines/reflection-inlines.h"
+
 // ----------------------------------------------------------------------------
 
 #endif // MICRO_TEST_PLUS_REFLECTION_H_

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

@@ -53,6 +53,7 @@
 // ----------------------------------------------------------------------------
 
 #include "reporter.h"
+#include "reflection.h"
 
 // ----------------------------------------------------------------------------
 
@@ -64,12 +65,18 @@
 #endif
 #endif
 
-// =============================================================================
+// ============================================================================
 
 namespace micro_os_plus::micro_test_plus
 {
   // --------------------------------------------------------------------------
 
+  class runner;
+  class suite;
+  class subtest;
+
+  // ==========================================================================
+
   /**
    * @brief Human (standard output) implementation of `reporter`.
    *
@@ -97,9 +104,6 @@ namespace micro_os_plus::micro_test_plus
     /**
      * @brief Constructor for the reporter_human class.
      *
-     * @details
-     * The rule of five is enforced to prevent accidental copying or moving.
-     *
      * @param argvs Owning pointer to the command-line arguments vector;
      * the reporter takes ownership via move.
      */
@@ -119,13 +123,15 @@ namespace micro_os_plus::micro_test_plus
      * @brief Deleted copy assignment operator to prevent copying.
      */
     reporter_human&
-    operator= (const reporter_human&) = delete;
+    operator= (const reporter_human&)
+        = delete;
 
     /**
      * @brief Deleted move assignment operator to prevent moving.
      */
     reporter_human&
-    operator= (reporter_human&&) = delete;
+    operator= (reporter_human&&)
+        = delete;
 
     /**
      * @brief Destructor for the reporter_human class.
@@ -141,7 +147,7 @@ namespace micro_os_plus::micro_test_plus
      * @return Reference to the current reporter instance.
      */
     reporter_human&
-    operator<< (indent_t m);
+    operator<< (detail::indent_t m);
 
     // Bring base class operator<< overloads into scope to prevent name hiding.
     using reporter::operator<<;
@@ -149,7 +155,7 @@ namespace micro_os_plus::micro_test_plus
     // ------------------------------------------------------------------------
 
     /**
-     * @brief Mark the beginning of a test suite.
+     * @brief Mark the beginning of a test session.
      *
      * @param runner Reference to the test runner.
      * @par Returns
@@ -159,7 +165,7 @@ namespace micro_os_plus::micro_test_plus
     begin_session (runner& runner) override;
 
     /**
-     * @brief Mark the end of a test suite.
+     * @brief Mark the end of a test session.
      *
      * @param runner Reference to the test runner.
      * @par Returns
@@ -245,7 +251,7 @@ namespace micro_os_plus::micro_test_plus
      * @brief Outputs the prefix for a failing condition.
      *
      * @param message The message to display.
-     * @param hasExpression Whether the failure is associated with an
+     * @param has_expression Whether the failure is associated with an
      * expression.
      * @param location The source location of the failure.
      * @param subtest The subtest that owns this check.
@@ -253,7 +259,7 @@ namespace micro_os_plus::micro_test_plus
      *   Nothing.
      */
     void
-    output_fail_prefix_ (std::string& message, const bool hasExpression,
+    output_fail_prefix_ (std::string& message, const bool has_expression,
                          const reflection::source_location& location,
                          subtest& subtest) override;
 

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

@@ -46,6 +46,7 @@
 // ----------------------------------------------------------------------------
 
 #include "reporter.h"
+#include "reflection.h"
 
 // ----------------------------------------------------------------------------
 
@@ -63,6 +64,12 @@ namespace micro_os_plus::micro_test_plus
 {
   // --------------------------------------------------------------------------
 
+  class runner;
+  class suite;
+  class subtest;
+
+  // ==========================================================================
+
   /**
    * @brief TAP (Test Anything Protocol) implementation of `reporter`.
    *
@@ -89,9 +96,6 @@ namespace micro_os_plus::micro_test_plus
     /**
      * @brief Constructor for the reporter_tap class.
      *
-     * @details
-     * The rule of five is enforced to prevent accidental copying or moving.
-     *
      * @param argvs Owning pointer to the command-line arguments vector;
      * the reporter takes ownership via move.
      */
@@ -111,13 +115,15 @@ namespace micro_os_plus::micro_test_plus
      * @brief Deleted copy assignment operator to prevent copying.
      */
     reporter_tap&
-    operator= (const reporter_tap&) = delete;
+    operator= (const reporter_tap&)
+        = delete;
 
     /**
      * @brief Deleted move assignment operator to prevent moving.
      */
     reporter_tap&
-    operator= (reporter_tap&&) = delete;
+    operator= (reporter_tap&&)
+        = delete;
 
     /**
      * @brief Destructor for the reporter_tap class.
@@ -133,7 +139,7 @@ namespace micro_os_plus::micro_test_plus
      * @return Reference to the current reporter instance.
      */
     reporter_tap&
-    operator<< (indent_t m);
+    operator<< (detail::indent_t m);
 
     // Bring base class operator<< overloads into scope to prevent name hiding.
     using reporter::operator<<;
@@ -237,7 +243,7 @@ namespace micro_os_plus::micro_test_plus
      * @brief Outputs the prefix for a failing condition.
      *
      * @param message The message to display.
-     * @param hasExpression Whether the failure is associated with an
+     * @param has_expression Whether the failure is associated with an
      * expression.
      * @param location The source location of the failure.
      * @param subtest The subtest that owns this check.
@@ -245,7 +251,7 @@ namespace micro_os_plus::micro_test_plus
      *   Nothing.
      */
     void
-    output_fail_prefix_ (std::string& message, const bool hasExpression,
+    output_fail_prefix_ (std::string& message, const bool has_expression,
                          const reflection::source_location& location,
                          subtest& subtest) override;