EventSource.hpp

Go to the documentation of this file.

#pragma once
 
#include "MayaFlux/Core/GlobalGraphicsInfo.hpp"
 
#include "MayaFlux/IO/Keys.hpp"
 
#include <queue>
 
namespace MayaFlux::Kriya {
class EventAwaiter;
}
 
namespace MayaFlux::Vruta {
 
/**
 * @struct EventFilter
 * @brief Filter criteria for window events
 *
 * Used to filter events in the pending queue. Multiple criteria can be
 * combined to create specific filters (e.g., a specific key press).
 */
struct MAYAFLUX_API EventFilter {
    std::optional<Core::WindowEventType> event_type;
    std::optional<IO::Keys> key_code; // For KEY_PRESSED/RELEASED filtering
    std::optional<IO::MouseButtons> button; // For MOUSE_BUTTON_* filtering
 
    EventFilter() = default;
 
    /**
     * @brief Constructs filter for specific event type
     * @param type The window event type to filter
     */
    EventFilter(Core::WindowEventType type)
        : event_type(type)
    {
    }
 
    /**
     * @brief Constructs filter for specific key event
     * @param key The key to filter for
     */
    EventFilter(IO::Keys key)
        : key_code(key)
    {
    }
};
 
/**
 * @class EventSource
 * @brief Awaitable event stream for window events
 *
 * Unlike clocks (SampleClock, FrameClock) which tick periodically,
 * EventSource is signaled when discrete window events occur.
 * Coroutines can suspend until events arrive.
 */
class MAYAFLUX_API EventSource {
public:
    EventSource() = default;
    ~EventSource() = default;
 
    EventSource(const EventSource&) = delete;
    EventSource& operator=(const EventSource&) = delete;
    EventSource(EventSource&&) noexcept = default;
    EventSource& operator=(EventSource&&) noexcept = default;
 
    /**
     * @brief Signals that an event occurred
     * @param event The event data
     *
     * Called by GLFW callbacks. Queues event and resumes waiting coroutines.
     */
    void signal(Core::WindowEvent event);
 
    /**
     * @brief Creates awaiter for next event (any type)
     */
    Kriya::EventAwaiter next_event();
 
    /**
     * @brief Creates awaiter for specific event type
     */
    Kriya::EventAwaiter await_event(Core::WindowEventType type);
 
    /**
     * @brief Checks if events are pending
     */
    [[nodiscard]] bool has_pending() const { return !m_pending_events.empty(); }
 
    /**
     * @brief Gets number of pending events
     */
    [[nodiscard]] size_t pending_count() const { return m_pending_events.size(); }
 
    /**
     * @brief Clears all pending events
     */
    void clear() { m_pending_events = {}; }
 
    /**
     * @brief Query if a specific key is currently pressed
     * @param key The key to check
     * @return True if key is currently pressed
     */
    [[nodiscard]] bool is_key_pressed(IO::Keys key) const;
 
    /**
     * @brief Query if a specific mouse button is currently pressed
     * @param button Mouse button to check
     * @return True if button is currently pressed
     */
    [[nodiscard]] bool is_mouse_pressed(int button) const;
 
    /**
     * @brief Get current mouse position
     * @return Pair of (x, y) coordinates
     */
    [[nodiscard]] std::pair<double, double> get_mouse_position() const;
 
private:
    std::queue<Core::WindowEvent> m_pending_events;
    std::vector<Kriya::EventAwaiter*> m_waiters;
 
    std::unordered_map<int16_t, bool> m_key_states;
    std::unordered_map<int, bool> m_button_states;
    double m_mouse_x {};
    double m_mouse_y {};
 
    /**
     * @brief Pop event matching filter from queue
     * @param filter Filter criteria
     * @return Event if found, nullopt otherwise
     *
     * Searches the queue for an event matching all filter criteria.
     * Removes and returns the first matching event, preserving order
     * of non-matching events.
     */
    std::optional<Core::WindowEvent> pop_event(const EventFilter& filter);
 
    void register_waiter(Kriya::EventAwaiter* awaiter);
    void unregister_waiter(Kriya::EventAwaiter* awaiter);
 
    friend class Kriya::EventAwaiter;
};
 
}