stopwatch.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_STOPWATCH_H_
#define MICRO_OS_PLUS_MICRO_TEST_PLUS_STOPWATCH_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 <chrono>
#include <cstdint>
#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
  {
    // ========================================================================

    void
    read_clock (timespec& ts) noexcept;
 
    // ========================================================================

    class stopwatch final
    {
    public:
      stopwatch (void) = default;

      stopwatch (const stopwatch&) = delete;

      stopwatch (stopwatch&&) = delete;

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

      stopwatch&
      operator= (stopwatch&&)
          = delete;

      ~stopwatch () = default;

      void
      start (void) noexcept;

      void
      stop (void) noexcept;

      [[nodiscard]] bool
      has_elapsed (void) const noexcept;

      [[nodiscard]] std::chrono::microseconds
      elapsed (void) const noexcept;
 
#if defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_DEPRECATED_ENABLED)

      [[deprecated ("use has_elapsed() (since 6.0.0)"), nodiscard]] bool
      has_begin (void) const noexcept;

      [[deprecated ("use has_elapsed() (since 6.0.0)"), nodiscard]] bool
      has_end (void) const noexcept;

      [[deprecated ("use has_elapsed() (since 6.0.0)"), nodiscard]] bool
      has_timestamps (void) const noexcept;

      [[deprecated ("use elapsed() (since 6.0.0)")]] void
      compute_elapsed_time (uint32_t& milliseconds,
                            uint32_t& microseconds) const noexcept;

      [[deprecated ("use start() (since 6.0.0)")]] void
      timestamp_begin (void) noexcept;

      [[deprecated ("use start() (since 6.0.0)")]] void
      timestamp_begin (const timespec& ts) noexcept;

      [[deprecated ("use stop() (since 6.0.0)")]] void
      timestamp_end (void) noexcept;

      [[deprecated ("use stop() (since 6.0.0)")]] void
      timestamp_end (const timespec& ts) noexcept;

#endif // defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_DEPRECATED_ENABLED)
 
    private:
      friend struct stopwatch_test_access;

      [[nodiscard]] static bool
      is_recorded (const timespec& ts) noexcept;

      timespec start_time_{};

      timespec stop_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/stopwatch-inlines.h"
 
// ----------------------------------------------------------------------------
 
#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_STOPWATCH_H_
 
// ----------------------------------------------------------------------------