From 3e972b2dadc45290fab5ccb42d12bc93957d52ea Mon Sep 17 00:00:00 2001 From: veclavtalica Date: Sun, 6 Oct 2024 23:49:05 +0300 Subject: [PATCH] twn_input: add twn_scancode.h as port of SDL_scancode.h, remove SDL2/SDL.h header usage sa for plans on having clean public headers --- include/twn_input.h | 29 +-- include/twn_scancode.h | 420 +++++++++++++++++++++++++++++++++++++++++ src/twn_input.c | 4 +- src/twn_input_c.h | 20 ++ 4 files changed, 451 insertions(+), 22 deletions(-) create mode 100644 include/twn_scancode.h diff --git a/include/twn_input.h b/include/twn_input.h index 5a3d0e5..f0d5364 100644 --- a/include/twn_input.h +++ b/include/twn_input.h @@ -4,12 +4,11 @@ #include "twn_config.h" #include "twn_vec.h" #include "twn_engine_api.h" - -#include +#include "twn_scancode.h" #include #include - +#include typedef enum ButtonSource { BUTTON_SOURCE_NOT_SET, @@ -20,20 +19,8 @@ typedef enum ButtonSource { } ButtonSource; -union ButtonCode { - SDL_Scancode scancode; - SDL_Keycode keycode; - SDL_GameControllerButton gamepad_button; - uint8_t mouse_button; /* SDL_BUTTON_ enum */ -}; - - -/* an input to which an action is bound */ -/* it is not limited to literal buttons */ -typedef struct Button { - enum ButtonSource source; - union ButtonCode code; -} Button; +/* internal */ +typedef struct Button Button; /* represents the collective state of a group of buttons */ @@ -58,13 +45,15 @@ typedef struct ActionHashItem { typedef struct InputState { - ActionHashItem *action_hash; const uint8_t *keyboard_state; /* array of booleans indexed by scancode */ uint32_t mouse_state; /* SDL mouse button bitmask */ Vec2i mouse_window_position; Vec2i mouse_relative_position; ButtonSource last_active_source; bool is_anything_just_pressed; + + /* engine state */ + ActionHashItem *action_hash; } InputState; @@ -74,10 +63,10 @@ TWN_API void input_state_update(InputState *input); TWN_API void input_bind_action_scancode(InputState *input, char *action_name, - SDL_Scancode scancode); + Scancode scancode); TWN_API void input_unbind_action_scancode(InputState *input, char *action_name, - SDL_Scancode scancode); + Scancode scancode); TWN_API void input_bind_action_mouse(InputState *input, char *action_name, uint8_t mouse_button); diff --git a/include/twn_scancode.h b/include/twn_scancode.h new file mode 100644 index 0000000..f9daed2 --- /dev/null +++ b/include/twn_scancode.h @@ -0,0 +1,420 @@ +#ifndef TWN_SCANCODE_H +#define TWN_SCANCODE_H + +/* + Simple DirectMedia Layer + Copyright (C) 1997-2024 Sam Lantinga + + This software is provided 'as-is', without any express or implied + warranty. In no event will the authors be held liable for any damages + arising from the use of this software. + + Permission is granted to anyone to use this software for any purpose, + including commercial applications, and to alter it and redistribute it + freely, subject to the following restrictions: + + 1. The origin of this software must not be misrepresented; you must not + claim that you wrote the original software. If you use this software + in a product, an acknowledgment in the product documentation would be + appreciated but is not required. + 2. Altered source versions must be plainly marked as such, and must not be + misrepresented as being the original software. + 3. This notice may not be removed or altered from any source distribution. +*/ + +/* based on SDL2 */ + +typedef enum +{ + SCANCODE_UNKNOWN = 0, + + /** + * \name Usage page 0x07 + * + * These values are from usage page 0x07 (USB keyboard page). + */ + /* @{ */ + + SCANCODE_A = 4, + SCANCODE_B = 5, + SCANCODE_C = 6, + SCANCODE_D = 7, + SCANCODE_E = 8, + SCANCODE_F = 9, + SCANCODE_G = 10, + SCANCODE_H = 11, + SCANCODE_I = 12, + SCANCODE_J = 13, + SCANCODE_K = 14, + SCANCODE_L = 15, + SCANCODE_M = 16, + SCANCODE_N = 17, + SCANCODE_O = 18, + SCANCODE_P = 19, + SCANCODE_Q = 20, + SCANCODE_R = 21, + SCANCODE_S = 22, + SCANCODE_T = 23, + SCANCODE_U = 24, + SCANCODE_V = 25, + SCANCODE_W = 26, + SCANCODE_X = 27, + SCANCODE_Y = 28, + SCANCODE_Z = 29, + + SCANCODE_1 = 30, + SCANCODE_2 = 31, + SCANCODE_3 = 32, + SCANCODE_4 = 33, + SCANCODE_5 = 34, + SCANCODE_6 = 35, + SCANCODE_7 = 36, + SCANCODE_8 = 37, + SCANCODE_9 = 38, + SCANCODE_0 = 39, + + SCANCODE_RETURN = 40, + SCANCODE_ESCAPE = 41, + SCANCODE_BACKSPACE = 42, + SCANCODE_TAB = 43, + SCANCODE_SPACE = 44, + + SCANCODE_MINUS = 45, + SCANCODE_EQUALS = 46, + SCANCODE_LEFTBRACKET = 47, + SCANCODE_RIGHTBRACKET = 48, + SCANCODE_BACKSLASH = 49, /**< Located at the lower left of the return + * key on ISO keyboards and at the right end + * of the QWERTY row on ANSI keyboards. + * Produces REVERSE SOLIDUS (backslash) and + * VERTICAL LINE in a US layout, REVERSE + * SOLIDUS and VERTICAL LINE in a UK Mac + * layout, NUMBER SIGN and TILDE in a UK + * Windows layout, DOLLAR SIGN and POUND SIGN + * in a Swiss German layout, NUMBER SIGN and + * APOSTROPHE in a German layout, GRAVE + * ACCENT and POUND SIGN in a French Mac + * layout, and ASTERISK and MICRO SIGN in a + * French Windows layout. + */ + SCANCODE_NONUSHASH = 50, /**< ISO USB keyboards actually use this code + * instead of 49 for the same key, but all + * OSes I've seen treat the two codes + * identically. So, as an implementor, unless + * your keyboard generates both of those + * codes and your OS treats them differently, + * you should generate SCANCODE_BACKSLASH + * instead of this code. As a user, you + * should not rely on this code because SDL + * will never generate it with most (all?) + * keyboards. + */ + SCANCODE_SEMICOLON = 51, + SCANCODE_APOSTROPHE = 52, + SCANCODE_GRAVE = 53, /**< Located in the top left corner (on both ANSI + * and ISO keyboards). Produces GRAVE ACCENT and + * TILDE in a US Windows layout and in US and UK + * Mac layouts on ANSI keyboards, GRAVE ACCENT + * and NOT SIGN in a UK Windows layout, SECTION + * SIGN and PLUS-MINUS SIGN in US and UK Mac + * layouts on ISO keyboards, SECTION SIGN and + * DEGREE SIGN in a Swiss German layout (Mac: + * only on ISO keyboards), CIRCUMFLEX ACCENT and + * DEGREE SIGN in a German layout (Mac: only on + * ISO keyboards), SUPERSCRIPT TWO and TILDE in a + * French Windows layout, COMMERCIAL AT and + * NUMBER SIGN in a French Mac layout on ISO + * keyboards, and LESS-THAN SIGN and GREATER-THAN + * SIGN in a Swiss German, German, or French Mac + * layout on ANSI keyboards. + */ + SCANCODE_COMMA = 54, + SCANCODE_PERIOD = 55, + SCANCODE_SLASH = 56, + + SCANCODE_CAPSLOCK = 57, + + SCANCODE_F1 = 58, + SCANCODE_F2 = 59, + SCANCODE_F3 = 60, + SCANCODE_F4 = 61, + SCANCODE_F5 = 62, + SCANCODE_F6 = 63, + SCANCODE_F7 = 64, + SCANCODE_F8 = 65, + SCANCODE_F9 = 66, + SCANCODE_F10 = 67, + SCANCODE_F11 = 68, + SCANCODE_F12 = 69, + + SCANCODE_PRINTSCREEN = 70, + SCANCODE_SCROLLLOCK = 71, + SCANCODE_PAUSE = 72, + SCANCODE_INSERT = 73, /**< insert on PC, help on some Mac keyboards (but + does send code 73, not 117) */ + SCANCODE_HOME = 74, + SCANCODE_PAGEUP = 75, + SCANCODE_DELETE = 76, + SCANCODE_END = 77, + SCANCODE_PAGEDOWN = 78, + SCANCODE_RIGHT = 79, + SCANCODE_LEFT = 80, + SCANCODE_DOWN = 81, + SCANCODE_UP = 82, + + SCANCODE_NUMLOCKCLEAR = 83, /**< num lock on PC, clear on Mac keyboards + */ + SCANCODE_KP_DIVIDE = 84, + SCANCODE_KP_MULTIPLY = 85, + SCANCODE_KP_MINUS = 86, + SCANCODE_KP_PLUS = 87, + SCANCODE_KP_ENTER = 88, + SCANCODE_KP_1 = 89, + SCANCODE_KP_2 = 90, + SCANCODE_KP_3 = 91, + SCANCODE_KP_4 = 92, + SCANCODE_KP_5 = 93, + SCANCODE_KP_6 = 94, + SCANCODE_KP_7 = 95, + SCANCODE_KP_8 = 96, + SCANCODE_KP_9 = 97, + SCANCODE_KP_0 = 98, + SCANCODE_KP_PERIOD = 99, + + SCANCODE_NONUSBACKSLASH = 100, /**< This is the additional key that ISO + * keyboards have over ANSI ones, + * located between left shift and Y. + * Produces GRAVE ACCENT and TILDE in a + * US or UK Mac layout, REVERSE SOLIDUS + * (backslash) and VERTICAL LINE in a + * US or UK Windows layout, and + * LESS-THAN SIGN and GREATER-THAN SIGN + * in a Swiss German, German, or French + * layout. */ + SCANCODE_APPLICATION = 101, /**< windows contextual menu, compose */ + SCANCODE_POWER = 102, /**< The USB document says this is a status flag, + * not a physical key - but some Mac keyboards + * do have a power key. */ + SCANCODE_KP_EQUALS = 103, + SCANCODE_F13 = 104, + SCANCODE_F14 = 105, + SCANCODE_F15 = 106, + SCANCODE_F16 = 107, + SCANCODE_F17 = 108, + SCANCODE_F18 = 109, + SCANCODE_F19 = 110, + SCANCODE_F20 = 111, + SCANCODE_F21 = 112, + SCANCODE_F22 = 113, + SCANCODE_F23 = 114, + SCANCODE_F24 = 115, + SCANCODE_EXECUTE = 116, + SCANCODE_HELP = 117, /**< AL Integrated Help Center */ + SCANCODE_MENU = 118, /**< Menu (show menu) */ + SCANCODE_SELECT = 119, + SCANCODE_STOP = 120, /**< AC Stop */ + SCANCODE_AGAIN = 121, /**< AC Redo/Repeat */ + SCANCODE_UNDO = 122, /**< AC Undo */ + SCANCODE_CUT = 123, /**< AC Cut */ + SCANCODE_COPY = 124, /**< AC Copy */ + SCANCODE_PASTE = 125, /**< AC Paste */ + SCANCODE_FIND = 126, /**< AC Find */ + SCANCODE_MUTE = 127, + SCANCODE_VOLUMEUP = 128, + SCANCODE_VOLUMEDOWN = 129, +/* not sure whether there's a reason to enable these */ +/* SCANCODE_LOCKINGCAPSLOCK = 130, */ +/* SCANCODE_LOCKINGNUMLOCK = 131, */ +/* SCANCODE_LOCKINGSCROLLLOCK = 132, */ + SCANCODE_KP_COMMA = 133, + SCANCODE_KP_EQUALSAS400 = 134, + + SCANCODE_INTERNATIONAL1 = 135, /**< used on Asian keyboards, see + footnotes in USB doc */ + SCANCODE_INTERNATIONAL2 = 136, + SCANCODE_INTERNATIONAL3 = 137, /**< Yen */ + SCANCODE_INTERNATIONAL4 = 138, + SCANCODE_INTERNATIONAL5 = 139, + SCANCODE_INTERNATIONAL6 = 140, + SCANCODE_INTERNATIONAL7 = 141, + SCANCODE_INTERNATIONAL8 = 142, + SCANCODE_INTERNATIONAL9 = 143, + SCANCODE_LANG1 = 144, /**< Hangul/English toggle */ + SCANCODE_LANG2 = 145, /**< Hanja conversion */ + SCANCODE_LANG3 = 146, /**< Katakana */ + SCANCODE_LANG4 = 147, /**< Hiragana */ + SCANCODE_LANG5 = 148, /**< Zenkaku/Hankaku */ + SCANCODE_LANG6 = 149, /**< reserved */ + SCANCODE_LANG7 = 150, /**< reserved */ + SCANCODE_LANG8 = 151, /**< reserved */ + SCANCODE_LANG9 = 152, /**< reserved */ + + SCANCODE_ALTERASE = 153, /**< Erase-Eaze */ + SCANCODE_SYSREQ = 154, + SCANCODE_CANCEL = 155, /**< AC Cancel */ + SCANCODE_CLEAR = 156, + SCANCODE_PRIOR = 157, + SCANCODE_RETURN2 = 158, + SCANCODE_SEPARATOR = 159, + SCANCODE_OUT = 160, + SCANCODE_OPER = 161, + SCANCODE_CLEARAGAIN = 162, + SCANCODE_CRSEL = 163, + SCANCODE_EXSEL = 164, + + SCANCODE_KP_00 = 176, + SCANCODE_KP_000 = 177, + SCANCODE_THOUSANDSSEPARATOR = 178, + SCANCODE_DECIMALSEPARATOR = 179, + SCANCODE_CURRENCYUNIT = 180, + SCANCODE_CURRENCYSUBUNIT = 181, + SCANCODE_KP_LEFTPAREN = 182, + SCANCODE_KP_RIGHTPAREN = 183, + SCANCODE_KP_LEFTBRACE = 184, + SCANCODE_KP_RIGHTBRACE = 185, + SCANCODE_KP_TAB = 186, + SCANCODE_KP_BACKSPACE = 187, + SCANCODE_KP_A = 188, + SCANCODE_KP_B = 189, + SCANCODE_KP_C = 190, + SCANCODE_KP_D = 191, + SCANCODE_KP_E = 192, + SCANCODE_KP_F = 193, + SCANCODE_KP_XOR = 194, + SCANCODE_KP_POWER = 195, + SCANCODE_KP_PERCENT = 196, + SCANCODE_KP_LESS = 197, + SCANCODE_KP_GREATER = 198, + SCANCODE_KP_AMPERSAND = 199, + SCANCODE_KP_DBLAMPERSAND = 200, + SCANCODE_KP_VERTICALBAR = 201, + SCANCODE_KP_DBLVERTICALBAR = 202, + SCANCODE_KP_COLON = 203, + SCANCODE_KP_HASH = 204, + SCANCODE_KP_SPACE = 205, + SCANCODE_KP_AT = 206, + SCANCODE_KP_EXCLAM = 207, + SCANCODE_KP_MEMSTORE = 208, + SCANCODE_KP_MEMRECALL = 209, + SCANCODE_KP_MEMCLEAR = 210, + SCANCODE_KP_MEMADD = 211, + SCANCODE_KP_MEMSUBTRACT = 212, + SCANCODE_KP_MEMMULTIPLY = 213, + SCANCODE_KP_MEMDIVIDE = 214, + SCANCODE_KP_PLUSMINUS = 215, + SCANCODE_KP_CLEAR = 216, + SCANCODE_KP_CLEARENTRY = 217, + SCANCODE_KP_BINARY = 218, + SCANCODE_KP_OCTAL = 219, + SCANCODE_KP_DECIMAL = 220, + SCANCODE_KP_HEXADECIMAL = 221, + + SCANCODE_LCTRL = 224, + SCANCODE_LSHIFT = 225, + SCANCODE_LALT = 226, /**< alt, option */ + SCANCODE_LGUI = 227, /**< windows, command (apple), meta */ + SCANCODE_RCTRL = 228, + SCANCODE_RSHIFT = 229, + SCANCODE_RALT = 230, /**< alt gr, option */ + SCANCODE_RGUI = 231, /**< windows, command (apple), meta */ + + SCANCODE_MODE = 257, /**< I'm not sure if this is really not covered + * by any of the above, but since there's a + * special KMOD_MODE for it I'm adding it here + */ + + /* @} *//* Usage page 0x07 */ + + /** + * \name Usage page 0x0C + * + * These values are mapped from usage page 0x0C (USB consumer page). + * See https://usb.org/sites/default/files/hut1_2.pdf + * + * There are way more keys in the spec than we can represent in the + * current scancode range, so pick the ones that commonly come up in + * real world usage. + */ + /* @{ */ + + SCANCODE_AUDIONEXT = 258, + SCANCODE_AUDIOPREV = 259, + SCANCODE_AUDIOSTOP = 260, + SCANCODE_AUDIOPLAY = 261, + SCANCODE_AUDIOMUTE = 262, + SCANCODE_MEDIASELECT = 263, + SCANCODE_WWW = 264, /**< AL Internet Browser */ + SCANCODE_MAIL = 265, + SCANCODE_CALCULATOR = 266, /**< AL Calculator */ + SCANCODE_COMPUTER = 267, + SCANCODE_AC_SEARCH = 268, /**< AC Search */ + SCANCODE_AC_HOME = 269, /**< AC Home */ + SCANCODE_AC_BACK = 270, /**< AC Back */ + SCANCODE_AC_FORWARD = 271, /**< AC Forward */ + SCANCODE_AC_STOP = 272, /**< AC Stop */ + SCANCODE_AC_REFRESH = 273, /**< AC Refresh */ + SCANCODE_AC_BOOKMARKS = 274, /**< AC Bookmarks */ + + /* @} *//* Usage page 0x0C */ + + /** + * \name Walther keys + * + * These are values that Christian Walther added (for mac keyboard?). + */ + /* @{ */ + + SCANCODE_BRIGHTNESSDOWN = 275, + SCANCODE_BRIGHTNESSUP = 276, + SCANCODE_DISPLAYSWITCH = 277, /**< display mirroring/dual display + switch, video mode switch */ + SCANCODE_KBDILLUMTOGGLE = 278, + SCANCODE_KBDILLUMDOWN = 279, + SCANCODE_KBDILLUMUP = 280, + SCANCODE_EJECT = 281, + SCANCODE_SLEEP = 282, /**< SC System Sleep */ + + SCANCODE_APP1 = 283, + SCANCODE_APP2 = 284, + + /* @} *//* Walther keys */ + + /** + * \name Usage page 0x0C (additional media keys) + * + * These values are mapped from usage page 0x0C (USB consumer page). + */ + /* @{ */ + + SCANCODE_AUDIOREWIND = 285, + SCANCODE_AUDIOFASTFORWARD = 286, + + /* @} *//* Usage page 0x0C (additional media keys) */ + + /** + * \name Mobile keys + * + * These are values that are often used on mobile phones. + */ + /* @{ */ + + SCANCODE_SOFTLEFT = 287, /**< Usually situated below the display on phones and + used as a multi-function feature key for selecting + a software defined function shown on the bottom left + of the display. */ + SCANCODE_SOFTRIGHT = 288, /**< Usually situated below the display on phones and + used as a multi-function feature key for selecting + a software defined function shown on the bottom right + of the display. */ + SCANCODE_CALL = 289, /**< Used for accepting phone calls. */ + SCANCODE_ENDCALL = 290, /**< Used for rejecting phone calls. */ + + /* @} *//* Mobile keys */ + + /* Add any other keys here. */ + + NUM_SCANCODES = 512 /**< not a key, just marks the number of scancodes + for array bounds */ +} Scancode; + +#endif diff --git a/src/twn_input.c b/src/twn_input.c index 2cbfa07..47e51ee 100644 --- a/src/twn_input.c +++ b/src/twn_input.c @@ -202,7 +202,7 @@ void input_state_update(InputState *input) { void input_bind_action_scancode(InputState *input, char *action_name, - SDL_Scancode scancode) + Scancode scancode) { input_bind_code_to_action(input, action_name, @@ -213,7 +213,7 @@ void input_bind_action_scancode(InputState *input, void input_unbind_action_scancode(InputState *input, char *action_name, - SDL_Scancode scancode) + Scancode scancode) { input_unbind_code_from_action(input, action_name, diff --git a/src/twn_input_c.h b/src/twn_input_c.h index 5bb81de..72f1de7 100644 --- a/src/twn_input_c.h +++ b/src/twn_input_c.h @@ -2,6 +2,26 @@ #define INPUT_INTERNAL_API_H #include "twn_input.h" +#include "twn_vec.h" + +#include + + +union ButtonCode { + SDL_Scancode scancode; + SDL_Keycode keycode; + SDL_GameControllerButton gamepad_button; + uint8_t mouse_button; /* SDL_BUTTON_ enum */ +}; + + +/* an input to which an action is bound */ +/* it is not limited to literal buttons */ +typedef struct Button { + enum ButtonSource source; + union ButtonCode code; +} Button; + void input_reset_state(InputState *input);