#pragma once

#include <AH/Settings/NamespaceSettings.hpp>

#include <platform/pico_shim.h>

BEGIN_AH_NAMESPACE

/// @addtogroup    AH_Timing
/// @{

/// A function type that returns a time value.
using timefunction = unsigned long (*)();

/**
 * @brief   A class for easily managing timed events. A wrapper for "Blink 
 *          Without Delay".
 * 
 * @tparam  time
 *          The time function to use.
 */
template <timefunction time = micros>
class Timer {
  public:
    /**
     * @brief   Constructor.
     * @param   interval
     *          The interval between two events.
     */
    Timer(unsigned long interval) : interval(interval) {
#ifdef ARDUINO
        begin();
#endif
    }
    /// Initialize or reset the timer. The timer will fire immediately.
    void begin() { previous = time() - interval; }
    /// Initialize or reset the timer. The timer will fire after one period.
    void beginNextPeriod() { previous = time(); }
    /// Update the timer and return true if the event should fire.
    explicit operator bool() {
        auto now = time();
        if (now - previous >= interval) {
            previous += interval;
            return true;
        }
        return false;
    }

    /// Get the interval of the timer.
    unsigned long getInterval() const { return interval; }
    /// Set the interval of the timer.
    void setInterval(unsigned long interval) { this->interval = interval; }

  private:
    unsigned long interval;
    unsigned long previous = 0;
};

/// @}

END_AH_NAMESPACE