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

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_
+
+// ----------------------------------------------------------------------------

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

@@ -0,0 +1,126 @@
+/*
+ * 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++ utility
+ * functions.
+ *
+ * @details
+ * This header provides the inline implementations for the utility function
+ * templates used within the µTest++ framework. It defines the logic for
+ * splitting strings into substrings using a specified delimiter, enabling
+ * convenient and type-safe string parsing in test expressions.
+ *
+ * All definitions reside within the
+ * `micro_os_plus::micro_test_plus::utility` namespace, ensuring clear
+ * separation from user code and minimising the risk of naming conflicts.
+ *
+ * The header files are organised within the
+ * `include/micro-os-plus/micro-test-plus` folder to maintain a structured and
+ * modular codebase.
+ *
+ * This file is intended solely for internal use within the framework and
+ * should not be included directly by user code.
+ */
+
+#ifndef MICRO_TEST_PLUS_UTILITY_INLINES_H_
+#define MICRO_TEST_PLUS_UTILITY_INLINES_H_
+
+// ----------------------------------------------------------------------------
+
+#ifdef __cplusplus
+
+// ----------------------------------------------------------------------------
+
+#if defined(__GNUC__)
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Waggregate-return"
+#if defined(__clang__)
+#pragma clang diagnostic ignored "-Wc++98-compat"
+#endif
+#endif
+
+// ============================================================================
+
+namespace micro_os_plus::micro_test_plus
+{
+  // --------------------------------------------------------------------------
+  namespace utility
+  {
+    /**
+     * @details
+     * This function template facilitates string handling in tests by splitting
+     * a string into a vector of substrings, using the specified delimiter.
+     *
+     * The function iterates through the input string, identifying delimiter
+     * positions and extracting substrings between them. Each resulting
+     * substring is added to the output vector. This approach supports flexible
+     * parsing of delimited data, which is particularly useful for validating
+     * string processing logic in test cases.
+     *
+     * **Example**
+     *
+     * @code{.cpp}
+     * namespace mt = micro_os_plus::micro_test_plus;
+     *
+     * t.expect (std::vector<std::string_view>{ "a", "b" }
+     *             == mt::utility::split<std::string_view> ("a.b", "."))
+     *         << "a.b splits into [a,b]";
+     * @endcode
+     */
+    template <class T = std::string_view, class Delim_T>
+    [[nodiscard]] auto
+    split (T input, Delim_T delim) -> std::vector<T>
+    {
+      std::vector<T> output{};
+      std::size_t first{};
+      while (first < std::size (input))
+        {
+          const auto second = input.find_first_of (delim, first);
+          if (first != second)
+            {
+              output.emplace_back (input.substr (first, second - first));
+            }
+          if (second == T::npos)
+            {
+              break;
+            }
+          first = second + 1;
+        }
+      return output;
+    }
+
+    // ------------------------------------------------------------------------
+  } // namespace utility
+
+  // --------------------------------------------------------------------------
+} // namespace micro_os_plus::micro_test_plus
+
+#if defined(__GNUC__)
+#pragma GCC diagnostic pop
+#endif
+
+// ----------------------------------------------------------------------------
+
+#endif // __cplusplus
+
+// ----------------------------------------------------------------------------
+
+#endif // MICRO_TEST_PLUS_UTILITY_INLINES_H_
+
+// ----------------------------------------------------------------------------

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

@@ -60,6 +60,7 @@
 // ----------------------------------------------------------------------------
 
 #include <cstdint>
+
 #include "type-traits.h"
 #include "math.h"
 
@@ -74,6 +75,8 @@
 #endif
 #endif
 
+// =============================================================================
+
 namespace micro_os_plus::micro_test_plus
 {
   // --------------------------------------------------------------------------
@@ -324,7 +327,6 @@ namespace micro_os_plus::micro_test_plus
      *
      * @return A `type_traits::integral_constant` instance holding the parsed
      * `uint8_t` value.
-     * and reporting mechanisms.
      */
     template <char... Cs>
     [[nodiscard]] constexpr auto
@@ -642,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__)
@@ -675,8 +671,8 @@ namespace micro_os_plus::micro_test_plus
    *
    * @code
    * int x = 42;
-   * auto wrapped = to_i{x}; // Explicitly treat x as an int for test
-   * comparison
+   * // Explicitly treat x as an int for test comparison.
+   * auto wrapped = to_i{x};
    * @endcode
    *
    * @since 3.2.0
@@ -884,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);
   };
 
   // --------------------------------------------------------------------------
@@ -905,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

@@ -64,9 +64,12 @@
 #pragma GCC diagnostic ignored "-Wconversion"
 #if defined(__clang__)
 #pragma clang diagnostic ignored "-Wc++98-compat"
+#pragma clang diagnostic ignored "-Wc++20-compat"
 #endif
 #endif
 
+// ============================================================================
+
 namespace micro_os_plus::micro_test_plus
 {
   // --------------------------------------------------------------------------
@@ -103,7 +106,7 @@ namespace micro_os_plus::micro_test_plus
      */
     template <class T>
     [[nodiscard]] constexpr auto
-    abs (const T t) -> T;
+    abs (const T t) noexcept -> T;
 
     /**
      * @brief Computes the minimum of two comparable values.
@@ -117,7 +120,7 @@ namespace micro_os_plus::micro_test_plus
      */
     template <class T>
     [[nodiscard]] constexpr auto
-    min_value (const T& lhs, const T& rhs) -> const T&;
+    min_value (const T& lhs, const T& rhs) noexcept -> const T&;
 
     /**
      * @brief Generic exponentiation function to compute the power of a base
@@ -134,7 +137,7 @@ namespace micro_os_plus::micro_test_plus
      */
     template <class T, class Exp_T>
     [[nodiscard]] constexpr auto
-    pow (const T base, const Exp_T exp) -> T;
+    pow (const T base, const Exp_T exp) noexcept -> T;
 
     /**
      * @brief Computes the integral value of a number represented as an array
@@ -148,7 +151,7 @@ namespace micro_os_plus::micro_test_plus
      * @return The parsed integral value of type \c T.
      */
     template <class T, char... Cs>
-    [[nodiscard]] constexpr auto
+    [[nodiscard]] consteval auto
     num (void) -> T;
 
     /**
@@ -163,7 +166,7 @@ namespace micro_os_plus::micro_test_plus
      * @return The parsed decimal part as an integral value of type \c T.
      */
     template <class T, char... Cs>
-    [[nodiscard]] constexpr auto
+    [[nodiscard]] consteval auto
     den (void) -> T;
 
     /**
@@ -178,7 +181,7 @@ namespace micro_os_plus::micro_test_plus
      * @return The number of decimal places as a value of type \c T.
      */
     template <class T, char... Cs>
-    [[nodiscard]] constexpr auto
+    [[nodiscard]] consteval auto
     den_size (void) -> T;
 
     /**
@@ -210,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_