expression-formatter.h

Go to the documentation of this file.

/*
 * 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.
 */
 
// ----------------------------------------------------------------------------

 
#ifndef MICRO_OS_PLUS_MICRO_TEST_PLUS_EXPRESSION_FORMATTER_H_
#define MICRO_OS_PLUS_MICRO_TEST_PLUS_EXPRESSION_FORMATTER_H_
 
// ----------------------------------------------------------------------------
 
#if defined(__cplusplus)
 
// ----------------------------------------------------------------------------
 
#if __has_include("micro-os-plus/project-config.h")
#include "micro-os-plus/project-config.h"
#endif // __has_include("micro-os-plus/project-config.h")
 
#if __has_include("micro-os-plus/micro-test-plus-defines.h")
#include "micro-os-plus/micro-test-plus-defines.h"
#endif // __has_include("micro-os-plus/micro-test-plus-defines.h")
 
#include "type-traits.h"
#include "detail.h"
 
#include <charconv>
#include <cstdio>
#include <string>
#include <string_view>
 
// ----------------------------------------------------------------------------
 
#if defined(__GNUC__)
#pragma GCC diagnostic push
 
#pragma GCC diagnostic ignored "-Wpadded"
#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 // defined(__clang__)
#endif // defined(__GNUC__)
 
// ============================================================================
 
namespace micro_os_plus::micro_test_plus
{
  // --------------------------------------------------------------------------
 
  namespace detail
  {
    // ------------------------------------------------------------------------

    struct colours
    {
      const char* none = ""; 
      const char* pass
          = ""; 
      const char* fail
          = ""; 
    };
 
    inline constexpr colours colours_red_green = {
      "\033[0m", 
      "\033[32m", 
      "\033[31m" 
    };
 
    // ========================================================================

    class expression_formatter
    {
    public:
      expression_formatter (colours& colours) noexcept;

      expression_formatter (const expression_formatter&) = delete;

      expression_formatter (expression_formatter&&) = delete;

      expression_formatter&
      operator= (const expression_formatter&)
          = delete;

      expression_formatter&
      operator= (expression_formatter&&)
          = delete;

      ~expression_formatter () = default;
 
      // ----------------------------------------------------------------------
      // Primitive operator<< overloads.

      expression_formatter&
      operator<< (std::string_view sv);

      expression_formatter&
      operator<< (char c);

      expression_formatter&
      operator<< (const char* s);

      expression_formatter&
      operator<< (bool v);

      expression_formatter& operator<< (std::nullptr_t);

      expression_formatter&
      operator<< (signed char c);

      expression_formatter&
      operator<< (unsigned char c);

      expression_formatter&
      operator<< (signed short v);

      expression_formatter&
      operator<< (unsigned short v);

      expression_formatter&
      operator<< (signed int v);

      expression_formatter&
      operator<< (unsigned int v);

      expression_formatter&
      operator<< (signed long v);

      expression_formatter&
      operator<< (unsigned long v);

      expression_formatter&
      operator<< (signed long long v);

      expression_formatter&
      operator<< (unsigned long long v);

      expression_formatter&
      operator<< (float v);

      expression_formatter&
      operator<< (double v);

      expression_formatter&
      operator<< (long double v);
 
      // ----------------------------------------------------------------------
      // Template operator<< overloads.

      template <typename T>
      expression_formatter&
      operator<< (T* v);

      template <class T>
        requires type_traits::is_op<T>
      expression_formatter&
      operator<< (const T& t);

      template <class T>
      expression_formatter&
      operator<< (const type_traits::genuine_integral_value<T>& v);

      template <class T>
        requires (type_traits::container_like<T>
                  and not type_traits::has_npos<T>)
      expression_formatter&
      operator<< (const T& t);
 
      // ----------------------------------------------------------------------
      // Compound expression operator<< overloads (without colour).

      template <class Lhs_T, class Rhs_T>
      expression_formatter&
      operator<< (const detail::eq_<Lhs_T, Rhs_T>& op);

      template <class Lhs_T, class Rhs_T>
      expression_formatter&
      operator<< (const detail::ne_<Lhs_T, Rhs_T>& op);

      template <class Lhs_T, class Rhs_T>
      expression_formatter&
      operator<< (const detail::gt_<Lhs_T, Rhs_T>& op);

      template <class Lhs_T, class Rhs_T>
      expression_formatter&
      operator<< (const detail::ge_<Lhs_T, Rhs_T>& op);

      template <class Lhs_T, class Rhs_T>
      expression_formatter&
      operator<< (const detail::lt_<Rhs_T, Lhs_T>& op);

      template <class Lhs_T, class Rhs_T>
      expression_formatter&
      operator<< (const detail::le_<Rhs_T, Lhs_T>& op);

      template <class Lhs_T, class Rhs_T>
      expression_formatter&
      operator<< (const detail::and_<Lhs_T, Rhs_T>& op);

      template <class Lhs_T, class Rhs_T>
      expression_formatter&
      operator<< (const detail::or_<Lhs_T, Rhs_T>& op);

      template <class T>
      expression_formatter&
      operator<< (const detail::not_<T>& op);
 
#if defined(__cpp_exceptions)

      template <class Callable_T, class Exception_T>
      expression_formatter&
      operator<< (const detail::throws_<Callable_T, Exception_T>& op);

      template <class Callable_T>
      expression_formatter&
      operator<< (const detail::throws_<Callable_T, void>& op);

      template <class Callable_T>
      expression_formatter&
      operator<< (const detail::nothrow_<Callable_T>& op);
 
#endif // defined(__cpp_exceptions)
 
      // ----------------------------------------------------------------------
      // Buffer accessors.

      [[nodiscard]] const std::string&
      str () const noexcept;

      [[nodiscard]] const char*
      c_str () const noexcept;

      void
      clear () noexcept;

      [[nodiscard]] bool
      empty () const noexcept;

      void
      append (size_t count, char ch);

      void
      reserve (size_t capacity);
 
    protected:
      [[nodiscard]] inline auto
      colour_ (const bool cond) const;

      colours& colours_;

      std::string buffer_{};
    };
 
    // ------------------------------------------------------------------------
  } // namespace detail
 
  // --------------------------------------------------------------------------
} // namespace micro_os_plus::micro_test_plus
 
#if defined(__GNUC__)
#pragma GCC diagnostic pop
#endif // defined(__GNUC__)
 
// ----------------------------------------------------------------------------
 
#endif // defined(__cplusplus)
 
// ============================================================================
// Templates, inlines & constexpr implementations.
 
#include "inlines/expression-formatter-inlines.h"
 
// ----------------------------------------------------------------------------
 
#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_EXPRESSION_FORMATTER_H_
 
// ----------------------------------------------------------------------------