stopwatch-inlines.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_INLINES_STOPWATCH_INLINES_H_
#define MICRO_OS_PLUS_MICRO_TEST_PLUS_INLINES_STOPWATCH_INLINES_H_
 
// ----------------------------------------------------------------------------
 
#if defined(__cplusplus)
 
// ----------------------------------------------------------------------------
 
#if defined(__GNUC__)
#pragma GCC diagnostic push
 
#pragma GCC diagnostic ignored "-Waggregate-return"
#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::detail
{
  // ==========================================================================

  inline bool
  stopwatch::has_elapsed (void) const noexcept
  {
    return is_recorded (start_time_) && is_recorded (stop_time_);
  }

  inline bool
  stopwatch::is_recorded (const timespec& ts) noexcept
  {
    return ts.tv_sec != 0 || ts.tv_nsec != 0;
  }
 
  // --------------------------------------------------------------------------
 
#if defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_DEPRECATED_ENABLED)
  // Deprecated since 6.0.0; use has_elapsed().
  inline bool
  stopwatch::has_begin (void) const noexcept
  {
    return is_recorded (start_time_);
  }

  // Deprecated since 6.0.0; use has_elapsed().
  inline bool
  stopwatch::has_end (void) const noexcept
  {
    return is_recorded (stop_time_);
  }

  // Deprecated since 6.0.0; use has_elapsed().
  inline bool
  stopwatch::has_timestamps (void) const noexcept
  {
    return has_elapsed ();
  }

  // Deprecated since 6.0.0; use elapsed().
  inline void
  stopwatch::compute_elapsed_time (uint32_t& milliseconds,
                                   uint32_t& microseconds) const noexcept
  {
    const auto count = elapsed ().count ();
    milliseconds = static_cast<uint32_t> (count / 1000);
    microseconds = static_cast<uint32_t> (count % 1000);
  }

  // Deprecated since 6.0.0; use start().
  inline void
  stopwatch::timestamp_begin (const timespec& ts) noexcept
  {
    if (!is_recorded (start_time_))
      {
        start_time_ = ts;
      }
  }

  // Deprecated since 6.0.0; use stop().
  inline void
  stopwatch::timestamp_end (const timespec& ts) noexcept
  {
    if (!is_recorded (stop_time_))
      {
        stop_time_ = ts;
      }
  }
#endif // defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_DEPRECATED_ENABLED)
 
  // --------------------------------------------------------------------------
} // namespace micro_os_plus::micro_test_plus::detail
 
#if defined(__GNUC__)
#pragma GCC diagnostic pop
#endif // defined(__GNUC__)
 
// ----------------------------------------------------------------------------
 
#endif // defined(__cplusplus)
 
// ----------------------------------------------------------------------------
 
#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_INLINES_STOPWATCH_INLINES_H_
 
// ----------------------------------------------------------------------------