stopwatch.cpp

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

 
// ----------------------------------------------------------------------------
 
#include "micro-os-plus/micro-test-plus/stopwatch.h"
 
// ----------------------------------------------------------------------------
 
#if defined(__GNUC__)
#pragma GCC diagnostic ignored "-Waggregate-return"
#if defined(__clang__)
#pragma clang diagnostic ignored "-Wpre-c++17-compat"
#pragma clang diagnostic ignored "-Wc++98-compat"
#pragma clang diagnostic ignored "-Wc++98-compat-pedantic"
#endif // defined(__clang__)
#endif // defined(__GNUC__)
 
// ============================================================================
 
#if defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_ENABLED)
 
// ----------------------------------------------------------------------------
 
namespace micro_os_plus::micro_test_plus::detail
{
  // --------------------------------------------------------------------------

  void
  read_clock (timespec& ts) noexcept
  {
#if defined(_WIN32)
    timespec_get (&ts, TIME_UTC);
#elif defined(CLOCK_MONOTONIC)
    clock_gettime (CLOCK_MONOTONIC, &ts);
#else
    (void)ts;
#endif // defined(_WIN32) || defined(CLOCK_MONOTONIC)
  }
 
  // --------------------------------------------------------------------------

  void
  stopwatch::start (void) noexcept
  {
    start_time_ = {};
    stop_time_ = {};
    read_clock (start_time_);
  }

  void
  stopwatch::stop (void) noexcept
  {
    stop_time_ = {};
    read_clock (stop_time_);
  }

  std::chrono::microseconds
  stopwatch::elapsed (void) const noexcept
  {
    if (!has_elapsed ())
      {
        return std::chrono::microseconds::zero ();
      }
 
    const std::chrono::nanoseconds delta = std::chrono::seconds{
      stop_time_.tv_sec - start_time_.tv_sec
    } + std::chrono::nanoseconds{ stop_time_.tv_nsec - start_time_.tv_nsec };
 
    return std::chrono::duration_cast<std::chrono::microseconds> (delta);
  }
 
#if defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_DEPRECATED_ENABLED)
  // Deprecated since 6.0.0; use start().
  void
  stopwatch::timestamp_begin (void) noexcept
  {
    if (!is_recorded (start_time_))
      {
        read_clock (start_time_);
      }
  }

  // Deprecated since 6.0.0; use stop().
  void
  stopwatch::timestamp_end (void) noexcept
  {
    if (!is_recorded (stop_time_))
      {
        read_clock (stop_time_);
      }
  }
#endif // defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_DEPRECATED_ENABLED)
 
  // --------------------------------------------------------------------------
} // namespace micro_os_plus::micro_test_plus::detail
 
// ----------------------------------------------------------------------------
 
#endif // defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_ENABLED)
 
// ----------------------------------------------------------------------------