input_events.hpp

Go to the documentation of this file.

#pragma once

 
#include <pulp/view/geometry.hpp>
#include <cstdint>
#include <string>
 
namespace pulp::view {
 
// ── Modifier flags ───────────────────────────────────────────────────────
 
enum Modifier : uint16_t {
    kModNone    = 0,
    kModShift   = 1 << 0,
    kModCtrl    = 1 << 1,   
    kModAlt     = 1 << 2,   
    kModMeta    = 1 << 3,   
    kModCmd     = 1 << 4,   
};

inline bool is_main_modifier(uint16_t mods) {
#ifdef __APPLE__
    return (mods & kModCmd) != 0;
#else
    return (mods & kModCtrl) != 0;
#endif
}
 
// ── Key codes ────────────────────────────────────────────────────────────
 
enum class KeyCode : int {
    unknown = 0,
 
    // Letters
    a = 'a', b = 'b', c = 'c', d = 'd', e = 'e', f = 'f', g = 'g', h = 'h',
    i = 'i', j = 'j', k = 'k', l = 'l', m = 'm', n = 'n', o = 'o', p = 'p',
    q = 'q', r = 'r', s = 's', t = 't', u = 'u', v = 'v', w = 'w', x = 'x',
    y = 'y', z = 'z',
 
    // Numbers
    num0 = '0', num1 = '1', num2 = '2', num3 = '3', num4 = '4',
    num5 = '5', num6 = '6', num7 = '7', num8 = '8', num9 = '9',
 
    // Punctuation (ASCII-valued). The Musical Typing layout's two top keys
    // beyond `p` are `;` and `'`, so they must be nameable to map them.
    semicolon = ';', apostrophe = '\'',
 
    // Navigation
    left = 256, right, up, down,
    home, end_, page_up, page_down,
 
    // Editing
    backspace = 270, delete_, tab, enter, escape,
    space = ' ',
 
    // Function keys
    f1 = 290, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12,
};
 
// ── Mouse / pointer event ────────────────────────────────────────────────

enum class MouseButton : uint8_t {
    none = 0,
    left = 1,
    right = 2,
    middle = 3,
};

enum class PointerType : uint8_t {
    mouse = 0,   
    touch = 1,   
    pen   = 2,   
};

enum class MousePhase : uint8_t {
    automatic = 0,  
    press,          
    drag,           
    release,        
    hover,          
};

struct MouseEvent {
    Point position;              
    Point window_position;       
    MouseButton button = MouseButton::left;
    uint16_t modifiers = 0;      
    int pointer_id = 0;          
    int click_count = 1;         
    bool is_down = false;        
    MousePhase phase = MousePhase::automatic;  
    bool is_cancelled = false;   
    bool is_wheel = false;       
    float scroll_delta_x = 0;   
    float scroll_delta_y = 0;   
 
    // ── Pointer / stylus properties (W3C PointerEvent) ──────────────
    PointerType pointer_type = PointerType::mouse;
    float pressure = 0.5f;       
    float altitude_angle = 0;    
    float azimuth_angle = 0;     
    float movement_x = 0;        
    float movement_y = 0;        
    bool has_movement_delta = false;  
 
    bool isShiftDown() const  { return (modifiers & kModShift) != 0; }
    bool isCtrlDown() const   { return (modifiers & kModCtrl) != 0; }
    bool isAltDown() const    { return (modifiers & kModAlt) != 0; }
    bool isCmdDown() const    { return (modifiers & kModCmd) != 0; }
    bool isMetaDown() const   { return (modifiers & kModMeta) != 0; }
    bool isMainModifier() const { return is_main_modifier(modifiers); }
    bool isTouch() const      { return pointer_type == PointerType::touch || (modifiers & 0x8000) != 0; }
    bool isPen() const        { return pointer_type == PointerType::pen; }
    bool isWheel() const      { return is_wheel; }
    bool isPrimary() const    { return pointer_id == 0; }
 
    // ── Gesture-phase resolution ─────────────────────────────────────
    // When `phase` is set explicitly (a real platform host), use it.
    // When it is `automatic` (legacy / headless callers that only set
    // `is_down`), keep the historical inference: `is_down` events that
    // begin a gesture read as a press. Callers on the button-state-CHANGED
    // convention (drag=is_down=false, release=is_down=true) are unchanged
    // because they leave `phase == automatic`.
    bool isPress() const {
        return phase == MousePhase::automatic ? is_down
                                              : phase == MousePhase::press;
    }

    bool isDrag() const { return phase == MousePhase::drag; }
    bool isRelease() const { return phase == MousePhase::release; }
    bool hasExplicitPhase() const { return phase != MousePhase::automatic; }

    const char* pointerTypeString() const {
        switch (pointer_type) {
            case PointerType::touch: return "touch";
            case PointerType::pen:   return "pen";
            default:                 return "mouse";
        }
    }
};
 
// ── Gesture event (pinch / rotate) ──────────────────────────────────────
 
enum class GesturePhase : uint8_t {
    began = 0,
    changed = 1,
    ended = 2,
    cancelled = 3,
};

struct GestureEvent {
    GesturePhase phase = GesturePhase::began;
    float scale = 1.0f;          
    float rotation = 0.0f;       
    float delta_scale = 0.0f;    
    float delta_rotation = 0.0f; 
    Point position;              
};
 
// ── Key event ────────────────────────────────────────────────────────────

struct KeyEvent {
    KeyCode key = KeyCode::unknown;
    uint16_t modifiers = 0;
    bool is_down = true;         
    bool is_repeat = false;      
 
    bool isShiftDown() const  { return (modifiers & kModShift) != 0; }
    bool isCtrlDown() const   { return (modifiers & kModCtrl) != 0; }
    bool isAltDown() const    { return (modifiers & kModAlt) != 0; }
    bool isCmdDown() const    { return (modifiers & kModCmd) != 0; }
    bool isMainModifier() const { return is_main_modifier(modifiers); }
};
 
// ── Text input event ─────────────────────────────────────────────────────

struct TextInputEvent {
    std::string text;            
};
 
} // namespace pulp::view