timer_requirements.hpp

Go to the documentation of this file.

/**
 * @file timer_requirements.hpp
 * @brief Timer driver requirements validator
 * @ingroup validation
 *
 * Validates that Timer drivers provide required functionality using the
 * method detection system.
 *
 * ## Timer Driver Contract
 *
 * Every Sound Byte Libs Timer driver MUST implement these methods:
 * - `delay_ms(uint32_t)` - Blocking millisecond delay
 * - `millis() -> uint32_t` - Milliseconds since boot
 *
 * ## Validation Usage
 *
 * Add validation at the bottom of driver timer.hpp:
 * ```cpp
 * #include <sbl/validation/timer_requirements.hpp>
 * static_assert(sbl::validation::timer_driver_valid<sbl::driver::Timer>,
 *               "Timer driver missing required methods");
 * ```
 *
 * @see method_detection.hpp
 */
 
#ifndef SBL_VALIDATION_TIMER_REQUIREMENTS_HPP_
#define SBL_VALIDATION_TIMER_REQUIREMENTS_HPP_
 
#include "method_detection.hpp"
 
namespace sbl {
namespace validation {
 
/**
 * @brief Timer driver requirements validator
 *
 * Validates that Timer drivers provide required methods.
 */
template<typename TimerDriver>
class TimerDriverRequirements {
public:
    /**
     * @brief Validate all required Timer methods
     */
    static constexpr bool validate() {
        static_assert(has_timer_delay_ms<TimerDriver>::value,
                      "SBL ERROR: Timer driver missing delay_ms() method.\n"
                      "Required: static void delay_ms(uint32_t)");
 
        static_assert(has_timer_millis<TimerDriver>::value,
                      "SBL ERROR: Timer driver missing millis() method.\n"
                      "Required: static uint32_t millis()");
 
        return true;
    }
};
 
/**
 * @brief Helper to validate a Timer driver implementation
 *
 * Usage:
 * ```cpp
 * static_assert(sbl::validation::timer_driver_valid<MyTimerDriver>,
 *               "Timer driver incomplete");
 * ```
 */
template<typename TimerDriver>
constexpr bool timer_driver_valid = TimerDriverRequirements<TimerDriver>::validate();
 
} // namespace validation
} // namespace sbl
 
#endif // SBL_VALIDATION_TIMER_REQUIREMENTS_HPP_