mirror
/
libx52
mirror of https://github.com/nirenjan/libx52.git
1
0
Fork 0
Code Releases Wiki Activity

feat: Reorder VKM key identifiers to sync with HID usage tables 

This change allows us to create manual key maps in the future, allowing
users with different keyboard layoutss to share a profile without having
to rewrite it for their keyboard layout.
profile-support
nirenjan 2026-04-02 22:11:05 -07:00
parent 03d58c62e8
commit 0fdcb725af
3 changed files with 134 additions and 132 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

223
vkm/vkm.h
View File

@ -221,104 +221,91 @@ typedef enum {
} vkm_mouse_scroll_direction; } vkm_mouse_scroll_direction;
/** /**
* @brief Physical key identifiers (105-key ISO / “international” PC set) * @brief Physical key identifiers (USB HID keyboard/keypad page, usage page 0x07)
* *
* Logical key codes for \ref vkm_keyboard_send. Identifiers follow the USB HID * Logical key codes for \ref vkm_keyboard_send. Each enumerator's numeric value is
* Usage Tables (keyboard/keypad page) in meaning; enumerator values are * the USB HID usage ID for that key (same encoding as the keyboard bitmap in HID
* arbitrary and are not HID usage IDs. * report descriptors, except for \c VKM_KEY_NONE). Letters use the HID ordering
* * (\c A=0x04 … \c Z=0x1D), not QWERTY row order. \c VKM_KEY_MAX is \c 0xE8, one
* Shift keys are listed with the alphanumeric block; other modifiers are grouped * past the highest usage used here, so valid keys satisfy \c key < VKM_KEY_MAX.
* at the start of the enumerator list.
*/ */
typedef enum { typedef enum {
VKM_KEY_NONE = 0, /**< Sentinel: no key (e.g. modifier-only update) */ VKM_KEY_NONE = 0x00, /**< Sentinel: no key (e.g. modifier-only update) */
VKM_KEY_LEFT_CTRL, /**< Left Control */ VKM_KEY_A = 0x04, /**< \c A / a (HID Latin alphabet block) */
VKM_KEY_LEFT_ALT, /**< Left Alt */ VKM_KEY_B, /**< \c B */
VKM_KEY_LEFT_GUI, /**< Left GUI / Meta / Windows key */ VKM_KEY_C, /**< \c C */
VKM_KEY_RIGHT_CTRL, /**< Right Control */ VKM_KEY_D, /**< \c D */
VKM_KEY_RIGHT_ALT, /**< Right Alt / AltGr */ VKM_KEY_E, /**< \c E */
VKM_KEY_RIGHT_GUI, /**< Right GUI / Meta */ VKM_KEY_F, /**< \c F */
VKM_KEY_APPLICATION, /**< Application / Menu key */ VKM_KEY_G, /**< \c G */
VKM_KEY_H, /**< \c H */
VKM_KEY_I, /**< \c I */
VKM_KEY_J, /**< \c J */
VKM_KEY_K, /**< \c K */
VKM_KEY_L, /**< \c L */
VKM_KEY_M, /**< \c M */
VKM_KEY_N, /**< \c N */
VKM_KEY_O, /**< \c O */
VKM_KEY_P, /**< \c P */
VKM_KEY_Q, /**< \c Q */
VKM_KEY_R, /**< \c R */
VKM_KEY_S, /**< \c S */
VKM_KEY_T, /**< \c T */
VKM_KEY_U, /**< \c U */
VKM_KEY_V, /**< \c V */
VKM_KEY_W, /**< \c W */
VKM_KEY_X, /**< \c X */
VKM_KEY_Y, /**< \c Y */
VKM_KEY_Z, /**< \c Z */
VKM_KEY_ESCAPE, /**< Escape */ VKM_KEY_1 = 0x1E, /**< \c 1 / ! */
VKM_KEY_F1, /**< F1 */ VKM_KEY_2, /**< \c 2 / @ */
VKM_KEY_F2, /**< F2 */ VKM_KEY_3, /**< \c 3 / # */
VKM_KEY_F3, /**< F3 */ VKM_KEY_4, /**< \c 4 / $ */
VKM_KEY_F4, /**< F4 */ VKM_KEY_5, /**< \c 5 / % */
VKM_KEY_F5, /**< F5 */ VKM_KEY_6, /**< \c 6 / ^ */
VKM_KEY_F6, /**< F6 */ VKM_KEY_7, /**< \c 7 / & */
VKM_KEY_F7, /**< F7 */ VKM_KEY_8, /**< \c 8 / * */
VKM_KEY_F8, /**< F8 */ VKM_KEY_9, /**< \c 9 / ( */
VKM_KEY_F9, /**< F9 */ VKM_KEY_0, /**< \c 0 / ) */
VKM_KEY_F10, /**< F10 */
VKM_KEY_F11, /**< F11 */
VKM_KEY_F12, /**< F12 */
VKM_KEY_GRAVE_ACCENT, /**< Grave accent / tilde (` and ~ on US) */ VKM_KEY_ENTER = 0x28, /**< Return / Enter */
VKM_KEY_1, /**< \c 1 / ! */ VKM_KEY_ESCAPE, /**< Escape */
VKM_KEY_2, /**< \c 2 / @ */ VKM_KEY_BACKSPACE, /**< Delete / Backspace */
VKM_KEY_3, /**< \c 3 / # */ VKM_KEY_TAB, /**< Tab */
VKM_KEY_4, /**< \c 4 / $ */ VKM_KEY_SPACE, /**< Space bar */
VKM_KEY_5, /**< \c 5 / % */ VKM_KEY_MINUS, /**< Minus / underscore */
VKM_KEY_6, /**< \c 6 / ^ */ VKM_KEY_EQUAL, /**< Equals / plus */
VKM_KEY_7, /**< \c 7 / & */ VKM_KEY_LEFT_BRACKET, /**< Left bracket / brace */
VKM_KEY_8, /**< \c 8 / * */ VKM_KEY_RIGHT_BRACKET, /**< Right bracket / brace */
VKM_KEY_9, /**< \c 9 / ( */ VKM_KEY_BACKSLASH, /**< Backslash / pipe (US placement; JIS Yen) */
VKM_KEY_0, /**< \c 0 / ) */ VKM_KEY_NONUS_HASH, /**< Non-US # / ~ (HID usage 0x32) */
VKM_KEY_MINUS, /**< Minus / underscore */ VKM_KEY_SEMICOLON, /**< Semicolon / colon */
VKM_KEY_EQUAL, /**< Equals / plus */ VKM_KEY_APOSTROPHE, /**< Apostrophe / quote */
VKM_KEY_BACKSPACE, /**< Backspace */ VKM_KEY_GRAVE_ACCENT, /**< Grave accent / tilde */
VKM_KEY_COMMA, /**< Comma / less-than */
VKM_KEY_PERIOD, /**< Period / greater-than */
VKM_KEY_SLASH, /**< Slash / question */
VKM_KEY_TAB, /**< Tab */ VKM_KEY_CAPS_LOCK = 0x39, /**< Caps Lock */
VKM_KEY_Q, /**< \c Q */
VKM_KEY_W, /**< \c W */
VKM_KEY_E, /**< \c E */
VKM_KEY_R, /**< \c R */
VKM_KEY_T, /**< \c T */
VKM_KEY_Y, /**< \c Y */
VKM_KEY_U, /**< \c U */
VKM_KEY_I, /**< \c I */
VKM_KEY_O, /**< \c O */
VKM_KEY_P, /**< \c P */
VKM_KEY_LEFT_BRACKET, /**< Left bracket / brace */
VKM_KEY_RIGHT_BRACKET, /**< Right bracket / brace */
VKM_KEY_BACKSLASH, /**< Backslash / pipe (US placement; JIS Yen) */
VKM_KEY_CAPS_LOCK, /**< Caps Lock */ VKM_KEY_F1 = 0x3A, /**< F1 */
VKM_KEY_A, /**< \c A */ VKM_KEY_F2, /**< F2 */
VKM_KEY_S, /**< \c S */ VKM_KEY_F3, /**< F3 */
VKM_KEY_D, /**< \c D */ VKM_KEY_F4, /**< F4 */
VKM_KEY_F, /**< \c F */ VKM_KEY_F5, /**< F5 */
VKM_KEY_G, /**< \c G */ VKM_KEY_F6, /**< F6 */
VKM_KEY_H, /**< \c H */ VKM_KEY_F7, /**< F7 */
VKM_KEY_J, /**< \c J */ VKM_KEY_F8, /**< F8 */
VKM_KEY_K, /**< \c K */ VKM_KEY_F9, /**< F9 */
VKM_KEY_L, /**< \c L */ VKM_KEY_F10, /**< F10 */
VKM_KEY_SEMICOLON, /**< Semicolon / colon */ VKM_KEY_F11, /**< F11 */
VKM_KEY_APOSTROPHE, /**< Apostrophe / quote */ VKM_KEY_F12, /**< F12 */
VKM_KEY_NONUS_HASH, /**< ISO non-US # / ~ (HID usage) */
VKM_KEY_ENTER, /**< Return / Enter */
VKM_KEY_LEFT_SHIFT, /**< Left Shift */ VKM_KEY_PRINT_SCREEN = 0x46, /**< Print Screen */
VKM_KEY_INTL_BACKSLASH, /**< ISO extra key (e.g. \| between left Shift and Z) */ VKM_KEY_SCROLL_LOCK, /**< Scroll Lock */
VKM_KEY_Z, /**< \c Z */ VKM_KEY_PAUSE, /**< Pause / Break */
VKM_KEY_X, /**< \c X */
VKM_KEY_C, /**< \c C */
VKM_KEY_V, /**< \c V */
VKM_KEY_B, /**< \c B */
VKM_KEY_N, /**< \c N */
VKM_KEY_M, /**< \c M */
VKM_KEY_COMMA, /**< Comma / less-than */
VKM_KEY_PERIOD, /**< Period / greater-than */
VKM_KEY_SLASH, /**< Slash / question */
VKM_KEY_RIGHT_SHIFT, /**< Right Shift */
VKM_KEY_SPACE, /**< Space bar */
VKM_KEY_PRINT_SCREEN, /**< Print Screen */
VKM_KEY_SCROLL_LOCK, /**< Scroll Lock */
VKM_KEY_PAUSE, /**< Pause / Break */
VKM_KEY_INSERT, /**< Insert */ VKM_KEY_INSERT, /**< Insert */
VKM_KEY_HOME, /**< Home */ VKM_KEY_HOME, /**< Home */
@ -327,31 +314,43 @@ typedef enum {
VKM_KEY_END, /**< End */ VKM_KEY_END, /**< End */
VKM_KEY_PAGE_DOWN, /**< Page Down */ VKM_KEY_PAGE_DOWN, /**< Page Down */
VKM_KEY_RIGHT_ARROW, /**< Arrow right */ VKM_KEY_RIGHT_ARROW, /**< Arrow right */
VKM_KEY_LEFT_ARROW, /**< Arrow left */ VKM_KEY_LEFT_ARROW, /**< Arrow left */
VKM_KEY_DOWN_ARROW, /**< Arrow down */ VKM_KEY_DOWN_ARROW, /**< Arrow down */
VKM_KEY_UP_ARROW, /**< Arrow up */ VKM_KEY_UP_ARROW, /**< Arrow up */
VKM_KEY_KEYPAD_NUM_LOCK, /**< Keypad Num Lock */ VKM_KEY_KEYPAD_NUM_LOCK = 0x53, /**< Keypad Num Lock */
VKM_KEY_KEYPAD_DIVIDE, /**< Keypad \c / */ VKM_KEY_KEYPAD_DIVIDE, /**< Keypad \c / */
VKM_KEY_KEYPAD_MULTIPLY,/**< Keypad \c * */ VKM_KEY_KEYPAD_MULTIPLY, /**< Keypad \c * */
VKM_KEY_KEYPAD_MINUS, /**< Keypad \c - */ VKM_KEY_KEYPAD_MINUS, /**< Keypad \c - */
VKM_KEY_KEYPAD_PLUS, /**< Keypad \c + */ VKM_KEY_KEYPAD_PLUS, /**< Keypad \c + */
VKM_KEY_KEYPAD_ENTER, /**< Keypad Enter */ VKM_KEY_KEYPAD_ENTER, /**< Keypad Enter */
VKM_KEY_KEYPAD_1, /**< Keypad \c 1 / End */ VKM_KEY_KEYPAD_1, /**< Keypad \c 1 / End */
VKM_KEY_KEYPAD_2, /**< Keypad \c 2 / Down */ VKM_KEY_KEYPAD_2, /**< Keypad \c 2 / Down */
VKM_KEY_KEYPAD_3, /**< Keypad \c 3 / Page Down */ VKM_KEY_KEYPAD_3, /**< Keypad \c 3 / Page Down */
VKM_KEY_KEYPAD_4, /**< Keypad \c 4 / Left */ VKM_KEY_KEYPAD_4, /**< Keypad \c 4 / Left */
VKM_KEY_KEYPAD_5, /**< Keypad \c 5 */ VKM_KEY_KEYPAD_5, /**< Keypad \c 5 */
VKM_KEY_KEYPAD_6, /**< Keypad \c 6 / Right */ VKM_KEY_KEYPAD_6, /**< Keypad \c 6 / Right */
VKM_KEY_KEYPAD_7, /**< Keypad \c 7 / Home */ VKM_KEY_KEYPAD_7, /**< Keypad \c 7 / Home */
VKM_KEY_KEYPAD_8, /**< Keypad \c 8 / Up */ VKM_KEY_KEYPAD_8, /**< Keypad \c 8 / Up */
VKM_KEY_KEYPAD_9, /**< Keypad \c 9 / Page Up */ VKM_KEY_KEYPAD_9, /**< Keypad \c 9 / Page Up */
VKM_KEY_KEYPAD_0, /**< Keypad \c 0 / Insert */ VKM_KEY_KEYPAD_0, /**< Keypad \c 0 / Insert */
VKM_KEY_KEYPAD_DECIMAL, /**< Keypad decimal / Delete */ VKM_KEY_KEYPAD_DECIMAL, /**< Keypad decimal / Delete */
VKM_KEY_KEYPAD_COMMA, /**< Keypad comma (locale-specific layouts) */ VKM_KEY_INTL_BACKSLASH, /**< Non-US \c \\ / \c | (ISO key; HID 0x64) */
VKM_KEY_APPLICATION, /**< Application / Menu */
VKM_KEY_MAX /**< Past last key; do not use in application code */ VKM_KEY_KEYPAD_COMMA = 0x85, /**< Keypad comma (Braz. keypad, etc.) */
VKM_KEY_LEFT_CTRL = 0xE0, /**< Left Control */
VKM_KEY_LEFT_SHIFT, /**< Left Shift */
VKM_KEY_LEFT_ALT, /**< Left Alt */
VKM_KEY_LEFT_GUI, /**< Left GUI / Meta / Windows key */
VKM_KEY_RIGHT_CTRL, /**< Right Control */
VKM_KEY_RIGHT_SHIFT, /**< Right Shift */
VKM_KEY_RIGHT_ALT, /**< Right Alt / AltGr */
VKM_KEY_RIGHT_GUI, /**< Right GUI / Meta */
VKM_KEY_MAX /**< One past highest usage; bounds checks and tables */
} vkm_key; } vkm_key;
/** /**

8
vkm/vkm_linux_evdev.c
View File

@ -20,8 +20,14 @@
#include "vkm-internal.h" #include "vkm-internal.h"
/** evdev codes; index by \ref vkm_key. \c -1 for \ref VKM_KEY_NONE only. */ /** evdev codes; index by \ref vkm_key (HID usage). \c -1 if unmapped. */
static const int vkm_key_to_evdev[VKM_KEY_MAX] = { static const int vkm_key_to_evdev[VKM_KEY_MAX] = {
#if defined(__GNUC__) || defined(__clang__)
[0 ...(VKM_KEY_MAX - 1)] = -1,
#else
#error "vkm_linux_evdev.c requires GCC or Clang (sparse vkm_key_to_evdev initializer)"
#endif
[VKM_KEY_NONE] = -1, [VKM_KEY_NONE] = -1,
[VKM_KEY_LEFT_CTRL] = KEY_LEFTCTRL, [VKM_KEY_LEFT_CTRL] = KEY_LEFTCTRL,

35
vkm/vkm_linux_evdev_test.c
View File

@ -163,26 +163,23 @@ static void expect_enable_mouse_events(bool hi_res, bool horiz)
#undef EXPECT_KEY_CODE #undef EXPECT_KEY_CODE
} }
/** Same order as \c enable_keyboard_events() in \c vkm_linux_evdev.c (skip \c VKM_KEY_NONE). */ /** Same order as \c enable_keyboard_events() in \c vkm_linux_evdev.c (skip unmapped indices). */
static const unsigned int expect_kb_codes[] = { static const unsigned int expect_kb_codes[] = {
KEY_LEFTCTRL, KEY_LEFTALT, KEY_LEFTMETA, KEY_RIGHTCTRL, KEY_RIGHTALT, KEY_RIGHTMETA, KEY_A, KEY_B, KEY_C, KEY_D, KEY_E, KEY_F, KEY_G, KEY_H, KEY_I, KEY_J, KEY_K, KEY_L, KEY_M,
KEY_MENU, KEY_ESC, KEY_F1, KEY_F2, KEY_F3, KEY_F4, KEY_N, KEY_O, KEY_P, KEY_Q, KEY_R, KEY_S, KEY_T, KEY_U, KEY_V, KEY_W, KEY_X, KEY_Y, KEY_Z,
KEY_F5, KEY_F6, KEY_F7, KEY_F8, KEY_F9, KEY_F10, KEY_1, KEY_2, KEY_3, KEY_4, KEY_5, KEY_6, KEY_7, KEY_8, KEY_9, KEY_0,
KEY_F11, KEY_F12, KEY_GRAVE, KEY_1, KEY_2, KEY_3, KEY_ENTER, KEY_ESC, KEY_BACKSPACE, KEY_TAB, KEY_SPACE, KEY_MINUS, KEY_EQUAL, KEY_LEFTBRACE,
KEY_4, KEY_5, KEY_6, KEY_7, KEY_8, KEY_9, KEY_RIGHTBRACE, KEY_BACKSLASH, KEY_NUMERIC_POUND, KEY_SEMICOLON, KEY_APOSTROPHE, KEY_GRAVE,
KEY_0, KEY_MINUS, KEY_EQUAL, KEY_BACKSPACE, KEY_TAB, KEY_Q, KEY_COMMA, KEY_DOT, KEY_SLASH,
KEY_W, KEY_E, KEY_R, KEY_T, KEY_Y, KEY_U, KEY_CAPSLOCK,
KEY_I, KEY_O, KEY_P, KEY_LEFTBRACE, KEY_RIGHTBRACE, KEY_BACKSLASH, KEY_F1, KEY_F2, KEY_F3, KEY_F4, KEY_F5, KEY_F6, KEY_F7, KEY_F8, KEY_F9, KEY_F10, KEY_F11, KEY_F12,
KEY_CAPSLOCK, KEY_A, KEY_S, KEY_D, KEY_F, KEY_G, KEY_PRINT, KEY_SCROLLLOCK, KEY_PAUSE, KEY_INSERT, KEY_HOME, KEY_PAGEUP, KEY_DELETE, KEY_END,
KEY_H, KEY_J, KEY_K, KEY_L, KEY_SEMICOLON, KEY_APOSTROPHE, KEY_PAGEDOWN, KEY_RIGHT, KEY_LEFT, KEY_DOWN, KEY_UP,
KEY_NUMERIC_POUND, KEY_ENTER, KEY_LEFTSHIFT, KEY_102ND, KEY_Z, KEY_X, KEY_NUMLOCK, KEY_KPSLASH, KEY_KPASTERISK, KEY_KPMINUS, KEY_KPPLUS, KEY_KPENTER,
KEY_C, KEY_V, KEY_B, KEY_N, KEY_M, KEY_COMMA, KEY_KP1, KEY_KP2, KEY_KP3, KEY_KP4, KEY_KP5, KEY_KP6, KEY_KP7, KEY_KP8, KEY_KP9, KEY_KP0,
KEY_DOT, KEY_SLASH, KEY_RIGHTSHIFT, KEY_SPACE, KEY_PRINT, KEY_SCROLLLOCK, KEY_KPDOT, KEY_102ND, KEY_MENU, KEY_KPCOMMA,
KEY_PAUSE, KEY_INSERT, KEY_HOME, KEY_PAGEUP, KEY_DELETE, KEY_END, KEY_LEFTCTRL, KEY_LEFTSHIFT, KEY_LEFTALT, KEY_LEFTMETA, KEY_RIGHTCTRL, KEY_RIGHTSHIFT,
KEY_PAGEDOWN, KEY_RIGHT, KEY_LEFT, KEY_DOWN, KEY_UP, KEY_NUMLOCK, KEY_RIGHTALT, KEY_RIGHTMETA,
KEY_KPSLASH, KEY_KPASTERISK, KEY_KPMINUS, KEY_KPPLUS, KEY_KPENTER, KEY_KP1,
KEY_KP2, KEY_KP3, KEY_KP4, KEY_KP5, KEY_KP6, KEY_KP7,
KEY_KP8, KEY_KP9, KEY_KP0, KEY_KPDOT, KEY_KPCOMMA,
}; };
static void expect_enable_keyboard_event_codes(void) static void expect_enable_keyboard_event_codes(void)