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

 
#ifndef MICRO_OS_PLUS_MICRO_TEST_PLUS_TIMINGS_H_
#define MICRO_OS_PLUS_MICRO_TEST_PLUS_TIMINGS_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 <cstdint>
#include <optional>
#include <ctime>
 
// ----------------------------------------------------------------------------
 
#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 // defined(__clang__)
#endif // defined(__GNUC__)
 
// ============================================================================
 
namespace micro_os_plus::micro_test_plus
{
  // --------------------------------------------------------------------------
 
  namespace detail
  {
    // ========================================================================

    class timestamp
    {
    public:
      timestamp () noexcept;

      timestamp (const timespec& ts) noexcept;
 
      // `timespec` is trivially copyable, so copy and move are safe to
      // default. Defaulting these operations allows `timestamp` to be used in
      // contexts that require copyability or movability (e.g. containers,
      // algorithms).
      timestamp (const timestamp&) = default;

      timestamp (timestamp&&) = default;

      timestamp&
      operator= (const timestamp&)
          = default;

      timestamp&
      operator= (timestamp&&)
          = default;

      ~timestamp () = default;

      bool
      has_clock (void) const noexcept;

      [[nodiscard]] timespec&
      value () noexcept;

      [[nodiscard]] const timespec&
      value () const noexcept;
 
    protected:
      timespec value_{};
    };
 
    // ========================================================================

    class timestamps
    {
    public:
      timestamps () = default;

      timestamps (const timestamps&) = delete;

      timestamps (timestamps&&) = delete;

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

      timestamps&
      operator= (timestamps&&)
          = delete;

      ~timestamps () = default;

      void
      timestamp_begin (void) noexcept;

      void
      timestamp_begin (const timespec& ts) noexcept;

      void
      timestamp_end (void) noexcept;

      void
      timestamp_end (const timespec& ts) noexcept;

      bool
      has_begin () const noexcept;

      bool
      has_end () const noexcept;

      bool
      has_timestamps (void) const noexcept;

      void
      compute_elapsed_time (uint32_t& milliseconds,
                            uint32_t& microseconds) const;
 
    protected:
      std::optional<timestamp> begin_time_;

      std::optional<timestamp> end_time_;
    };
 
    // ------------------------------------------------------------------------
  } // 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/timings-inlines.h"
 
// ----------------------------------------------------------------------------
 
#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_TIMINGS_H_
 
// ----------------------------------------------------------------------------