nanocoat/include/lib/scritchinput/scritchinput.h

   1 /* -*- Mode: C; indent-tabs-mode: t; tab-width: 4 -*-
   2 // ---------------------------------------------------------------------------
   3 // SquirrelJME
   4 //     Copyright (C) Stephanie Gawroriski <xer@multiphasicapps.net>
   5 // ---------------------------------------------------------------------------
   6 // SquirrelJME is under the Mozilla Public License Version 2.0.
   7 // See license.mkd for licensing and copyright information.
   8 // -------------------------------------------------------------------------*/
   9
  10 /**
  11  * Scritch Input Library.
  12  *
  13  * @since 2024/05/01
  14  */
  15
  16 #ifndef SQUIRRELJME_SCRITCHINPUT_H
  17 #define SQUIRRELJME_SCRITCHINPUT_H
  18
  19 #include "sjme/stdTypes.h"
  20
  21 /* Anti-C++. */
  22 #ifdef __cplusplus
  23         #ifndef SJME_CXX_IS_EXTERNED
  24                 #define SJME_CXX_IS_EXTERNED
  25                 #define SJME_CXX_SQUIRRELJME_SCRITCHINPUT_H
  26 extern "C" {
  27         #endif /* #ifdef SJME_CXX_IS_EXTERNED */
  28 #endif     /* #ifdef __cplusplus */
  29
  30 /*--------------------------------------------------------------------------*/
  31
  32 /**
  33  * The types of events that are possible.
  34  *
  35  * @since 2024/06/28
  36  */
  37 typedef enum sjme_scritchinput_type
  38 {
  39         /** Unknown event. */
  40         SJME_SCRITCHINPUT_TYPE_UNKNOWN = 0,
  41
  42         /** Key event: Pressed. */
  43         SJME_SCRITCHINPUT_TYPE_KEY_PRESSED = 1,
  44
  45         /** Key event: Released. */
  46         SJME_SCRITCHINPUT_TYPE_KEY_RELEASED = 2,
  47
  48         /** Key event: Repeated. */
  49         SJME_SCRITCHINPUT_TYPE_KEY_REPEATED = 4,
  50
  51         /** Mouse event: Button pressed. */
  52         SJME_SCRITCHINPUT_TYPE_MOUSE_BUTTON_PRESSED = 8,
  53
  54         /** Mouse event: Button released. */
  55         SJME_SCRITCHINPUT_TYPE_MOUSE_BUTTON_RELEASED = 16,
  56
  57         /** Mouse event: Motion. */
  58         SJME_SCRITCHINPUT_TYPE_MOUSE_MOTION = 32,
  59
  60         /** Gamepad event: Button pressed. */
  61         SJME_SCRITCHINPUT_TYPE_GAMEPAD_BUTTON_PRESSED = 64,
  62
  63         /** Gamepad event: Button released. */
  64         SJME_SCRITCHINPUT_TYPE_GAMEPAD_BUTTON_RELEASED = 128,
  65
  66         /** Gamepad event: Motion on axis. */
  67         SJME_SCRITCHINPUT_TYPE_GAMEPAD_AXIS_MOTION = 256,
  68
  69         /** Touch event: Finger pressed. */
  70         SJME_SCRITCHINPUT_TYPE_TOUCH_FINGER_PRESSED = 512,
  71
  72         /** Touch event: Finger released. */
  73         SJME_SCRITCHINPUT_TYPE_TOUCH_FINGER_RELEASED = 1024,
  74
  75         /** Touch event: Drag motion. */
  76         SJME_SCRITCHINPUT_TYPE_TOUCH_DRAG_MOTION = 2048,
  77
  78         /** Stylus event: Pressed. */
  79         SJME_SCRITCHINPUT_TYPE_STYLUS_PEN_PRESSED = 4096,
  80
  81         /** Stylus event: Released. */
  82         SJME_SCRITCHINPUT_TYPE_STYLUS_PEN_RELEASED = 8192,
  83
  84         /** Stylus event: Dragging motion. */
  85         SJME_SCRITCHINPUT_TYPE_STYLUS_DRAG_MOTION = 16384,
  86
  87         /** Stylus event: Hovering over display. */
  88         SJME_SCRITCHINPUT_TYPE_STYLUS_HOVER_MOTION = 32768,
  89
  90         /** Gyroscope event: Axis motion. */
  91         SJME_SCRITCHINPUT_TYPE_GYRO_AXIS_MOTION = 65536,
  92
  93         /** Device action (flip open/close, shaken, not stirred). */
  94         SJME_SCRITCHINPUT_TYPE_DEVICE_ACTION = 131072,
  95
  96         /** A character key was pressed. */
  97         SJME_SCRITCHINPUT_TYPE_KEY_CHAR_PRESSED = 262144,
  98 } sjme_scritchinput_type;
  99
 100 typedef enum sjme_scritchinput_key
 101 {
 102         /** Backspace. */
 103         SJME_SCRITCHINPUT_KEY_BACKSPACE = 8,
 104
 105         /** Tab. */
 106         SJME_SCRITCHINPUT_KEY_TAB = 9,
 107
 108         /** Enter. */
 109         SJME_SCRITCHINPUT_KEY_ENTER = 10,
 110
 111         /** Escape. */
 112         SJME_SCRITCHINPUT_KEY_ESCAPE = 27,
 113
 114         /** Star key. */
 115         SJME_SCRITCHINPUT_KEY_STAR = 42,
 116
 117         /** Space key. */
 118         SJME_SCRITCHINPUT_KEY_SPACE = 32,
 119
 120         /** Pound key. */
 121         SJME_SCRITCHINPUT_KEY_POUND = 35,
 122
 123         /** Delete key. */
 124         SJME_SCRITCHINPUT_KEY_DELETE = 127,
 125
 126         /** Unknown, zero is the invalid index so always make it known. */
 127         SJME_SCRITCHINPUT_KEY_UNKNOWN = 0,
 128
 129         /** The up arrow key. */
 130         SJME_SCRITCHINPUT_KEY_UP = -1,
 131
 132         /** Down arrow key. */
 133         SJME_SCRITCHINPUT_KEY_DOWN = -2,
 134
 135         /** Left arrow key. */
 136         SJME_SCRITCHINPUT_KEY_LEFT = -3,
 137
 138         /** Right arrow key. */
 139         SJME_SCRITCHINPUT_KEY_RIGHT = -4,
 140
 141         /** Game Up. */
 142         SJME_SCRITCHINPUT_KEY_VGAME_UP = -9,
 143
 144         /** Game Down. */
 145         SJME_SCRITCHINPUT_KEY_VGAME_DOWN = -10,
 146
 147         /** Game Left. */
 148         SJME_SCRITCHINPUT_KEY_VGAME_LEFT = -11,
 149
 150         /** Game Right. */
 151         SJME_SCRITCHINPUT_KEY_VGAME_RIGHT = -12,
 152
 153         /** Game fire. */
 154         SJME_SCRITCHINPUT_KEY_VGAME_FIRE = -13,
 155
 156         /** Game A. */
 157         SJME_SCRITCHINPUT_KEY_VGAME_A = -14,
 158
 159         /** Game B. */
 160         SJME_SCRITCHINPUT_KEY_VGAME_B = -15,
 161
 162         /** Game C. */
 163         SJME_SCRITCHINPUT_KEY_VGAME_C = -16,
 164
 165         /** Game D. */
 166         SJME_SCRITCHINPUT_KEY_VGAME_D = -17,
 167
 168         /** Shift. */
 169         SJME_SCRITCHINPUT_KEY_SHIFT = -18,
 170
 171         /** Control. */
 172         SJME_SCRITCHINPUT_KEY_CONTROL = -19,
 173
 174         /** Alt. */
 175         SJME_SCRITCHINPUT_KEY_ALT = -20,
 176
 177         /** Logo. */
 178         SJME_SCRITCHINPUT_KEY_LOGO = -21,
 179
 180         /** Caps lock. */
 181         SJME_SCRITCHINPUT_KEY_CAPSLOCK = -22,
 182
 183         /** Context menu. */
 184         SJME_SCRITCHINPUT_KEY_CONTEXT_MENU = -23,
 185
 186         /** Home. */
 187         SJME_SCRITCHINPUT_KEY_HOME = -24,
 188
 189         /** End. */
 190         SJME_SCRITCHINPUT_KEY_END = -25,
 191
 192         /** Page Up. */
 193         SJME_SCRITCHINPUT_KEY_PAGE_UP = -26,
 194
 195         /** Page Down. */
 196         SJME_SCRITCHINPUT_KEY_PAGE_DOWN = -27,
 197
 198         /** Meta. */
 199         SJME_SCRITCHINPUT_KEY_META = -28,
 200
 201         /** Numlock. */
 202         SJME_SCRITCHINPUT_KEY_NUMLOCK = -29,
 203
 204         /** Pause. */
 205         SJME_SCRITCHINPUT_KEY_PAUSE = -30,
 206
 207         /** Print Screen. */
 208         SJME_SCRITCHINPUT_KEY_PRINTSCREEN = -31,
 209
 210         /** Scroll lock. */
 211         SJME_SCRITCHINPUT_KEY_SCROLLLOCK = -32,
 212
 213         /** Insert. */
 214         SJME_SCRITCHINPUT_KEY_INSERT = -33,
 215
 216         /** Game Virtual Left Command. */
 217         SJME_SCRITCHINPUT_KEY_VGAME_COMMAND_LEFT = -34,
 218
 219         /** Game Virtual Right Command. */
 220         SJME_SCRITCHINPUT_KEY_VGAME_COMMAND_RIGHT = -35,
 221
 222         /** Game virtual Center Command. */
 223         SJME_SCRITCHINPUT_KEY_VGAME_COMMAND_CENTER = -36,
 224
 225         /** Game virtual open LCDUI inspector. */
 226         SJME_SCRITCHINPUT_KEY_VGAME_LCDUI_INSPECTOR = -37,
 227
 228         /** Number pad divide. */
 229         SJME_SCRITCHINPUT_KEY_NUMPAD_DIVIDE = -38,
 230
 231         /** Number pad multiply. */
 232         SJME_SCRITCHINPUT_KEY_NUMPAD_MULTIPLY = -39,
 233
 234         /** Number pad minus. */
 235         SJME_SCRITCHINPUT_KEY_NUMPAD_MINUS = -40,
 236
 237         /** Number pad plus. */
 238         SJME_SCRITCHINPUT_KEY_NUMPAD_PLUS = -41,
 239
 240         /** Number pad decimal. */
 241         SJME_SCRITCHINPUT_KEY_NUMPAD_DECIMAL = -42,
 242
 243         /** Number pad enter. */
 244         SJME_SCRITCHINPUT_KEY_NUMPAD_ENTER = -43,
 245
 246         /** Number pad 0. */
 247         SJME_SCRITCHINPUT_KEY_NUMPAD_0 = -50,
 248
 249         /** Number pad 1. */
 250         SJME_SCRITCHINPUT_KEY_NUMPAD_1 = -51,
 251
 252         /** Number pad 2. */
 253         SJME_SCRITCHINPUT_KEY_NUMPAD_2 = -52,
 254
 255         /** Number pad 3. */
 256         SJME_SCRITCHINPUT_KEY_NUMPAD_3 = -53,
 257
 258         /** Number pad 4. */
 259         SJME_SCRITCHINPUT_KEY_NUMPAD_4 = -54,
 260
 261         /** Number pad 5. */
 262         SJME_SCRITCHINPUT_KEY_NUMPAD_5 = -55,
 263
 264         /** Number pad 6. */
 265         SJME_SCRITCHINPUT_KEY_NUMPAD_6 = -56,
 266
 267         /** Number pad 7. */
 268         SJME_SCRITCHINPUT_KEY_NUMPAD_7 = -57,
 269
 270         /** Number pad 8. */
 271         SJME_SCRITCHINPUT_KEY_NUMPAD_8 = -58,
 272
 273         /** Number pad 9. */
 274         SJME_SCRITCHINPUT_KEY_NUMPAD_9 = -59,
 275
 276         /** F24. */
 277         SJME_SCRITCHINPUT_KEY_F24 = -64,
 278
 279         /** F23. */
 280         SJME_SCRITCHINPUT_KEY_F23 = -65,
 281
 282         /** F22. */
 283         SJME_SCRITCHINPUT_KEY_F22 = -66,
 284
 285         /** F21. */
 286         SJME_SCRITCHINPUT_KEY_F21 = -67,
 287
 288         /** F20. */
 289         SJME_SCRITCHINPUT_KEY_F20 = -68,
 290
 291         /** F19. */
 292         SJME_SCRITCHINPUT_KEY_F19 = -69,
 293
 294         /** F18. */
 295         SJME_SCRITCHINPUT_KEY_F18 = -70,
 296
 297         /** F17. */
 298         SJME_SCRITCHINPUT_KEY_F17 = -71,
 299
 300         /** F16. */
 301         SJME_SCRITCHINPUT_KEY_F16 = -72,
 302
 303         /** F15. */
 304         SJME_SCRITCHINPUT_KEY_F15 = -73,
 305
 306         /** F14. */
 307         SJME_SCRITCHINPUT_KEY_F14 = -74,
 308
 309         /** F13. */
 310         SJME_SCRITCHINPUT_KEY_F13 = -75,
 311
 312         /** F12. */
 313         SJME_SCRITCHINPUT_KEY_F12 = -76,
 314
 315         /** F11. */
 316         SJME_SCRITCHINPUT_KEY_F11 = -77,
 317
 318         /** F10. */
 319         SJME_SCRITCHINPUT_KEY_F10 = -78,
 320
 321         /** F9. */
 322         SJME_SCRITCHINPUT_KEY_F9 = -79,
 323
 324         /** F8. */
 325         SJME_SCRITCHINPUT_KEY_F8 = -80,
 326
 327         /** F7. */
 328         SJME_SCRITCHINPUT_KEY_F7 = -81,
 329
 330         /** F6. */
 331         SJME_SCRITCHINPUT_KEY_F6 = -82,
 332
 333         /** F5. */
 334         SJME_SCRITCHINPUT_KEY_F5 = -83,
 335
 336         /** F4. */
 337         SJME_SCRITCHINPUT_KEY_F4 = -84,
 338
 339         /** F3. */
 340         SJME_SCRITCHINPUT_KEY_F3 = -85,
 341
 342         /** F2. */
 343         SJME_SCRITCHINPUT_KEY_F2 = -86,
 344
 345         /** F1. */
 346         SJME_SCRITCHINPUT_KEY_F1 = -87,
 347 } sjme_scritchinput_key;
 348
 349 typedef enum sjme_scritchinput_modifier
 350 {
 351         /** Modifier status not supported. */
 352         SJME_SCRITCHINPUT_MODIFIER_UNSUPPORTED = -1,
 353
 354         /** Alt key modifier. */
 355         SJME_SCRITCHINPUT_MODIFIER_ALT = 65536,
 356
 357         /** Function (Fn/Chr) key modifier. */
 358         SJME_SCRITCHINPUT_MODIFIER_CHR = 8388608,
 359
 360         /** Command key modifier. */
 361         SJME_SCRITCHINPUT_MODIFIER_COMMAND = 4194304,
 362
 363         /** Ctrl key modifier. */
 364         SJME_SCRITCHINPUT_MODIFIER_CTRL = 262144,
 365
 366         /** Shift key modifier. */
 367         SJME_SCRITCHINPUT_MODIFIER_SHIFT = 131072,
 368
 369         /** Mask for all the modifier keys. */
 370         SJME_SCRITCHINPUT_MODIFIER_MASK = 13041664,
 371 } sjme_scritchinput_modifier;
 372
 373 typedef struct sjme_scritchinput_eventDataUnknown
 374 {
 375         /** Value 1. */
 376         sjme_jint a;
 377
 378         /** Value 2. */
 379         sjme_jint b;
 380
 381         /** Value 3. */
 382         sjme_jint c;
 383
 384         /** Value 4. */
 385         sjme_jint d;
 386
 387         /** Value 5. */
 388         sjme_jint e;
 389
 390         /** Value 6. */
 391         sjme_jint f;
 392
 393         /** Value 7. */
 394         sjme_jint g;
 395
 396         /** Value 8. */
 397         sjme_jint h;
 398
 399         /** Value 9. */
 400         sjme_jint i;
 401
 402         /** Value 10. */
 403         sjme_jint j;
 404
 405         /** Value 11. */
 406         sjme_jint k;
 407
 408         /** Value 12. */
 409         sjme_jint l;
 410 } sjme_scritchinput_eventDataUnknown;
 411
 412 /**
 413  * Event data for key events.
 414  *
 415  * @since 2024/06/30
 416  */
 417 typedef struct sjme_scritchinput_eventDataKey
 418 {
 419         /** Unicode key core or @c sjme_scritchinput_key . */
 420         sjme_jint code;
 421
 422         /** The modifiers held down, from @c sjme_scritchinput_modifier . */
 423         sjme_jint modifiers;
 424 } sjme_scritchinput_eventDataKey;
 425
 426 typedef struct sjme_scritchinput_eventDataMouseButton
 427 {
 428         /** The buttons being pressed. */
 429         sjme_jint buttonMask;
 430
 431         /** The modifiers held down, from @c sjme_scritchinput_modifier . */
 432         sjme_jint modifiers;
 433
 434         /** The X coordinate. */
 435         sjme_jint x;
 436
 437         /** The Y coordinate. */
 438         sjme_jint y;
 439
 440         /** The button being pressed. */
 441         sjme_jint button;
 442 } sjme_scritchinput_eventDataMouseButton;
 443
 444 typedef struct sjme_scritchinput_eventDataMouseMotion
 445 {
 446         /** The buttons being pressed. */
 447         sjme_jint buttonMask;
 448
 449         /** The modifiers held down, from @c sjme_scritchinput_modifier . */
 450         sjme_jint modifiers;
 451
 452         /** The X coordinate. */
 453         sjme_jint x;
 454
 455         /** The Y coordinate. */
 456         sjme_jint y;
 457 } sjme_scritchinput_eventDataMouseMotion;
 458
 459 typedef struct sjme_scritchinput_eventDataGamePadButton
 460 {
 461         sjme_jint todo;
 462 } sjme_scritchinput_eventDataGamePadButton;
 463
 464 typedef struct sjme_scritchinput_eventDataGamePadAxisMotion
 465 {
 466         sjme_jint todo;
 467 } sjme_scritchinput_eventDataGamePadAxisMotion;
 468
 469 typedef struct sjme_scritchinput_eventDataTouchFinger
 470 {
 471         sjme_jint todo;
 472 } sjme_scritchinput_eventDataTouchFinger;
 473
 474 typedef struct sjme_scritchinput_eventDataTouchDrag
 475 {
 476         sjme_jint todo;
 477 } sjme_scritchinput_eventDataTouchDrag;
 478
 479 typedef struct sjme_scritchinput_eventDataStylusPen
 480 {
 481         sjme_jint todo;
 482 } sjme_scritchinput_eventDataStylusPen;
 483
 484 typedef struct sjme_scritchinput_eventDataStylusMotion
 485 {
 486         sjme_jint todo;
 487 } sjme_scritchinput_eventDataStylusMotion;
 488
 489 typedef struct sjme_scritchinput_eventDataDeviceAction
 490 {
 491         sjme_jint todo;
 492 } sjme_scritchinput_eventDataDeviceAction;
 493
 494 /**
 495  * Structure which contains event data and otherwise.
 496  *
 497  * @since 2024/06/28
 498  */
 499 typedef struct sjme_scritchinput_event
 500 {
 501         /** The type of event that has occurred. */
 502         sjme_scritchinput_type type;
 503
 504         /** The time the event occurred at. */
 505         sjme_jlong time;
 506
 507         /** The event data. */
 508         union
 509         {
 510                 /** Unknown event. */
 511                 sjme_scritchinput_eventDataUnknown unknown;
 512
 513                 /** Key events. */
 514                 sjme_scritchinput_eventDataKey key;
 515
 516                 /** Mouse button events. */
 517                 sjme_scritchinput_eventDataMouseButton mouseButton;
 518
 519                 /** Mouse motion events. */
 520                 sjme_scritchinput_eventDataMouseMotion mouseMotion;
 521
 522                 /** Game pad button. */
 523                 sjme_scritchinput_eventDataGamePadButton gamePadButton;
 524
 525                 /** Game pad axis motion. */
 526                 sjme_scritchinput_eventDataGamePadAxisMotion gamePadAxisMotion;
 527
 528                 /** Touchscreen/Touchpad finger. */
 529                 sjme_scritchinput_eventDataTouchFinger touchFinger;
 530
 531                 /** Touch drag. */
 532                 sjme_scritchinput_eventDataTouchDrag touchDrag;
 533
 534                 /** Stylus pen. */
 535                 sjme_scritchinput_eventDataStylusPen stylusPen;
 536
 537                 /** Stylus motion. */
 538                 sjme_scritchinput_eventDataStylusMotion stylusMotion;
 539
 540                 /** Device action. */
 541                 sjme_scritchinput_eventDataDeviceAction deviceAction;
 542         } data;
 543 } sjme_scritchinput_event;
 544
 545 /*--------------------------------------------------------------------------*/
 546
 547 /* Anti-C++. */
 548 #ifdef __cplusplus
 549         #ifdef SJME_CXX_SQUIRRELJME_SCRITCHINPUT_H
 550 }
 551                 #undef SJME_CXX_SQUIRRELJME_SCRITCHINPUT_H
 552                 #undef SJME_CXX_IS_EXTERNED
 553         #endif /* #ifdef SJME_CXX_SQUIRRELJME_SCRITCHINPUT_H */
 554 #endif     /* #ifdef __cplusplus */
 555
 556 #endif /* SQUIRRELJME_SCRITCHINPUT_H */