Path: blob/master/platform/linuxbsd/wayland/key_mapping_xkb.cpp
10278 views
/**************************************************************************/1/* key_mapping_xkb.cpp */2/**************************************************************************/3/* This file is part of: */4/* GODOT ENGINE */5/* https://godotengine.org */6/**************************************************************************/7/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */8/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */9/* */10/* Permission is hereby granted, free of charge, to any person obtaining */11/* a copy of this software and associated documentation files (the */12/* "Software"), to deal in the Software without restriction, including */13/* without limitation the rights to use, copy, modify, merge, publish, */14/* distribute, sublicense, and/or sell copies of the Software, and to */15/* permit persons to whom the Software is furnished to do so, subject to */16/* the following conditions: */17/* */18/* The above copyright notice and this permission notice shall be */19/* included in all copies or substantial portions of the Software. */20/* */21/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */22/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */23/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */24/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */25/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */26/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */27/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */28/**************************************************************************/2930#include "key_mapping_xkb.h"3132void KeyMappingXKB::initialize() {33// XKB keycode to Godot Key map.3435xkb_keycode_map[XKB_KEY_Escape] = Key::ESCAPE;36xkb_keycode_map[XKB_KEY_Tab] = Key::TAB;37xkb_keycode_map[XKB_KEY_ISO_Left_Tab] = Key::BACKTAB;38xkb_keycode_map[XKB_KEY_BackSpace] = Key::BACKSPACE;39xkb_keycode_map[XKB_KEY_Return] = Key::ENTER;40xkb_keycode_map[XKB_KEY_Insert] = Key::INSERT;41xkb_keycode_map[XKB_KEY_Delete] = Key::KEY_DELETE;42xkb_keycode_map[XKB_KEY_Clear] = Key::KEY_DELETE;43xkb_keycode_map[XKB_KEY_Pause] = Key::PAUSE;44xkb_keycode_map[XKB_KEY_Print] = Key::PRINT;45xkb_keycode_map[XKB_KEY_Home] = Key::HOME;46xkb_keycode_map[XKB_KEY_End] = Key::END;47xkb_keycode_map[XKB_KEY_Left] = Key::LEFT;48xkb_keycode_map[XKB_KEY_Up] = Key::UP;49xkb_keycode_map[XKB_KEY_Right] = Key::RIGHT;50xkb_keycode_map[XKB_KEY_Down] = Key::DOWN;51xkb_keycode_map[XKB_KEY_Prior] = Key::PAGEUP;52xkb_keycode_map[XKB_KEY_Next] = Key::PAGEDOWN;53xkb_keycode_map[XKB_KEY_Shift_L] = Key::SHIFT;54xkb_keycode_map[XKB_KEY_Shift_R] = Key::SHIFT;55xkb_keycode_map[XKB_KEY_Shift_Lock] = Key::SHIFT;56xkb_keycode_map[XKB_KEY_Control_L] = Key::CTRL;57xkb_keycode_map[XKB_KEY_Control_R] = Key::CTRL;58xkb_keycode_map[XKB_KEY_Meta_L] = Key::META;59xkb_keycode_map[XKB_KEY_Meta_R] = Key::META;60xkb_keycode_map[XKB_KEY_Alt_L] = Key::ALT;61xkb_keycode_map[XKB_KEY_Alt_R] = Key::ALT;62xkb_keycode_map[XKB_KEY_Caps_Lock] = Key::CAPSLOCK;63xkb_keycode_map[XKB_KEY_Num_Lock] = Key::NUMLOCK;64xkb_keycode_map[XKB_KEY_Scroll_Lock] = Key::SCROLLLOCK;65xkb_keycode_map[XKB_KEY_less] = Key::QUOTELEFT;66xkb_keycode_map[XKB_KEY_grave] = Key::SECTION;67xkb_keycode_map[XKB_KEY_Super_L] = Key::META;68xkb_keycode_map[XKB_KEY_Super_R] = Key::META;69xkb_keycode_map[XKB_KEY_Menu] = Key::MENU;70xkb_keycode_map[XKB_KEY_Hyper_L] = Key::HYPER;71xkb_keycode_map[XKB_KEY_Hyper_R] = Key::HYPER;72xkb_keycode_map[XKB_KEY_Help] = Key::HELP;73xkb_keycode_map[XKB_KEY_KP_Space] = Key::SPACE;74xkb_keycode_map[XKB_KEY_KP_Tab] = Key::TAB;75xkb_keycode_map[XKB_KEY_KP_Enter] = Key::KP_ENTER;76xkb_keycode_map[XKB_KEY_Home] = Key::HOME;77xkb_keycode_map[XKB_KEY_Left] = Key::LEFT;78xkb_keycode_map[XKB_KEY_Up] = Key::UP;79xkb_keycode_map[XKB_KEY_Right] = Key::RIGHT;80xkb_keycode_map[XKB_KEY_Down] = Key::DOWN;81xkb_keycode_map[XKB_KEY_Prior] = Key::PAGEUP;82xkb_keycode_map[XKB_KEY_Next] = Key::PAGEDOWN;83xkb_keycode_map[XKB_KEY_End] = Key::END;84xkb_keycode_map[XKB_KEY_Begin] = Key::CLEAR;85xkb_keycode_map[XKB_KEY_Insert] = Key::INSERT;86xkb_keycode_map[XKB_KEY_Delete] = Key::KEY_DELETE;87xkb_keycode_map[XKB_KEY_KP_Equal] = Key::EQUAL;88xkb_keycode_map[XKB_KEY_KP_Separator] = Key::COMMA;89xkb_keycode_map[XKB_KEY_KP_Decimal] = Key::KP_PERIOD;90xkb_keycode_map[XKB_KEY_KP_Multiply] = Key::KP_MULTIPLY;91xkb_keycode_map[XKB_KEY_KP_Divide] = Key::KP_DIVIDE;92xkb_keycode_map[XKB_KEY_KP_Subtract] = Key::KP_SUBTRACT;93xkb_keycode_map[XKB_KEY_KP_Add] = Key::KP_ADD;94xkb_keycode_map[XKB_KEY_KP_0] = Key::KP_0;95xkb_keycode_map[XKB_KEY_KP_1] = Key::KP_1;96xkb_keycode_map[XKB_KEY_KP_2] = Key::KP_2;97xkb_keycode_map[XKB_KEY_KP_3] = Key::KP_3;98xkb_keycode_map[XKB_KEY_KP_4] = Key::KP_4;99xkb_keycode_map[XKB_KEY_KP_5] = Key::KP_5;100xkb_keycode_map[XKB_KEY_KP_6] = Key::KP_6;101xkb_keycode_map[XKB_KEY_KP_7] = Key::KP_7;102xkb_keycode_map[XKB_KEY_KP_8] = Key::KP_8;103xkb_keycode_map[XKB_KEY_KP_9] = Key::KP_9;104// Same keys but with numlock off.105xkb_keycode_map[XKB_KEY_KP_Insert] = Key::INSERT;106xkb_keycode_map[XKB_KEY_KP_Delete] = Key::KEY_DELETE;107xkb_keycode_map[XKB_KEY_KP_End] = Key::END;108xkb_keycode_map[XKB_KEY_KP_Down] = Key::DOWN;109xkb_keycode_map[XKB_KEY_KP_Page_Down] = Key::PAGEDOWN;110xkb_keycode_map[XKB_KEY_KP_Left] = Key::LEFT;111// X11 documents this (numpad 5) as "begin of line" but no toolkit seems to interpret it this way.112// On Windows this is emitting Key::Clear so for consistency it will be mapped to Key::Clear113xkb_keycode_map[XKB_KEY_KP_Begin] = Key::CLEAR;114xkb_keycode_map[XKB_KEY_KP_Right] = Key::RIGHT;115xkb_keycode_map[XKB_KEY_KP_Home] = Key::HOME;116xkb_keycode_map[XKB_KEY_KP_Up] = Key::UP;117xkb_keycode_map[XKB_KEY_KP_Page_Up] = Key::PAGEUP;118xkb_keycode_map[XKB_KEY_F1] = Key::F1;119xkb_keycode_map[XKB_KEY_F2] = Key::F2;120xkb_keycode_map[XKB_KEY_F3] = Key::F3;121xkb_keycode_map[XKB_KEY_F4] = Key::F4;122xkb_keycode_map[XKB_KEY_F5] = Key::F5;123xkb_keycode_map[XKB_KEY_F6] = Key::F6;124xkb_keycode_map[XKB_KEY_F7] = Key::F7;125xkb_keycode_map[XKB_KEY_F8] = Key::F8;126xkb_keycode_map[XKB_KEY_F9] = Key::F9;127xkb_keycode_map[XKB_KEY_F10] = Key::F10;128xkb_keycode_map[XKB_KEY_F11] = Key::F11;129xkb_keycode_map[XKB_KEY_F12] = Key::F12;130xkb_keycode_map[XKB_KEY_F13] = Key::F13;131xkb_keycode_map[XKB_KEY_F14] = Key::F14;132xkb_keycode_map[XKB_KEY_F15] = Key::F15;133xkb_keycode_map[XKB_KEY_F16] = Key::F16;134xkb_keycode_map[XKB_KEY_F17] = Key::F17;135xkb_keycode_map[XKB_KEY_F18] = Key::F18;136xkb_keycode_map[XKB_KEY_F19] = Key::F19;137xkb_keycode_map[XKB_KEY_F20] = Key::F20;138xkb_keycode_map[XKB_KEY_F21] = Key::F21;139xkb_keycode_map[XKB_KEY_F22] = Key::F22;140xkb_keycode_map[XKB_KEY_F23] = Key::F23;141xkb_keycode_map[XKB_KEY_F24] = Key::F24;142xkb_keycode_map[XKB_KEY_F25] = Key::F25;143xkb_keycode_map[XKB_KEY_F26] = Key::F26;144xkb_keycode_map[XKB_KEY_F27] = Key::F27;145xkb_keycode_map[XKB_KEY_F28] = Key::F28;146xkb_keycode_map[XKB_KEY_F29] = Key::F29;147xkb_keycode_map[XKB_KEY_F30] = Key::F30;148xkb_keycode_map[XKB_KEY_F31] = Key::F31;149xkb_keycode_map[XKB_KEY_F32] = Key::F32;150xkb_keycode_map[XKB_KEY_F33] = Key::F33;151xkb_keycode_map[XKB_KEY_F34] = Key::F34;152xkb_keycode_map[XKB_KEY_F35] = Key::F35;153xkb_keycode_map[XKB_KEY_yen] = Key::YEN;154xkb_keycode_map[XKB_KEY_section] = Key::SECTION;155// Media keys.156xkb_keycode_map[XKB_KEY_XF86Back] = Key::BACK;157xkb_keycode_map[XKB_KEY_XF86Forward] = Key::FORWARD;158xkb_keycode_map[XKB_KEY_XF86Stop] = Key::STOP;159xkb_keycode_map[XKB_KEY_XF86Refresh] = Key::REFRESH;160xkb_keycode_map[XKB_KEY_XF86Favorites] = Key::FAVORITES;161xkb_keycode_map[XKB_KEY_XF86OpenURL] = Key::OPENURL;162xkb_keycode_map[XKB_KEY_XF86HomePage] = Key::HOMEPAGE;163xkb_keycode_map[XKB_KEY_XF86Search] = Key::SEARCH;164xkb_keycode_map[XKB_KEY_XF86AudioLowerVolume] = Key::VOLUMEDOWN;165xkb_keycode_map[XKB_KEY_XF86AudioMute] = Key::VOLUMEMUTE;166xkb_keycode_map[XKB_KEY_XF86AudioRaiseVolume] = Key::VOLUMEUP;167xkb_keycode_map[XKB_KEY_XF86AudioPlay] = Key::MEDIAPLAY;168xkb_keycode_map[XKB_KEY_XF86AudioStop] = Key::MEDIASTOP;169xkb_keycode_map[XKB_KEY_XF86AudioPrev] = Key::MEDIAPREVIOUS;170xkb_keycode_map[XKB_KEY_XF86AudioNext] = Key::MEDIANEXT;171xkb_keycode_map[XKB_KEY_XF86AudioRecord] = Key::MEDIARECORD;172xkb_keycode_map[XKB_KEY_XF86Standby] = Key::STANDBY;173// Launch keys.174xkb_keycode_map[XKB_KEY_XF86Mail] = Key::LAUNCHMAIL;175xkb_keycode_map[XKB_KEY_XF86AudioMedia] = Key::LAUNCHMEDIA;176xkb_keycode_map[XKB_KEY_XF86MyComputer] = Key::LAUNCH0;177xkb_keycode_map[XKB_KEY_XF86Calculator] = Key::LAUNCH1;178xkb_keycode_map[XKB_KEY_XF86Launch0] = Key::LAUNCH2;179xkb_keycode_map[XKB_KEY_XF86Launch1] = Key::LAUNCH3;180xkb_keycode_map[XKB_KEY_XF86Launch2] = Key::LAUNCH4;181xkb_keycode_map[XKB_KEY_XF86Launch3] = Key::LAUNCH5;182xkb_keycode_map[XKB_KEY_XF86Launch4] = Key::LAUNCH6;183xkb_keycode_map[XKB_KEY_XF86Launch5] = Key::LAUNCH7;184xkb_keycode_map[XKB_KEY_XF86Launch6] = Key::LAUNCH8;185xkb_keycode_map[XKB_KEY_XF86Launch7] = Key::LAUNCH9;186xkb_keycode_map[XKB_KEY_XF86Launch8] = Key::LAUNCHA;187xkb_keycode_map[XKB_KEY_XF86Launch9] = Key::LAUNCHB;188xkb_keycode_map[XKB_KEY_XF86LaunchA] = Key::LAUNCHC;189xkb_keycode_map[XKB_KEY_XF86LaunchB] = Key::LAUNCHD;190xkb_keycode_map[XKB_KEY_XF86LaunchC] = Key::LAUNCHE;191xkb_keycode_map[XKB_KEY_XF86LaunchD] = Key::LAUNCHF;192193// Scancode to Godot Key map.194scancode_map[0x09] = Key::ESCAPE;195scancode_map[0x0A] = Key::KEY_1;196scancode_map[0x0B] = Key::KEY_2;197scancode_map[0x0C] = Key::KEY_3;198scancode_map[0x0D] = Key::KEY_4;199scancode_map[0x0E] = Key::KEY_5;200scancode_map[0x0F] = Key::KEY_6;201scancode_map[0x10] = Key::KEY_7;202scancode_map[0x11] = Key::KEY_8;203scancode_map[0x12] = Key::KEY_9;204scancode_map[0x13] = Key::KEY_0;205scancode_map[0x14] = Key::MINUS;206scancode_map[0x15] = Key::EQUAL;207scancode_map[0x16] = Key::BACKSPACE;208scancode_map[0x17] = Key::TAB;209scancode_map[0x18] = Key::Q;210scancode_map[0x19] = Key::W;211scancode_map[0x1A] = Key::E;212scancode_map[0x1B] = Key::R;213scancode_map[0x1C] = Key::T;214scancode_map[0x1D] = Key::Y;215scancode_map[0x1E] = Key::U;216scancode_map[0x1F] = Key::I;217scancode_map[0x20] = Key::O;218scancode_map[0x21] = Key::P;219scancode_map[0x22] = Key::BRACELEFT;220scancode_map[0x23] = Key::BRACERIGHT;221scancode_map[0x24] = Key::ENTER;222scancode_map[0x25] = Key::CTRL; // Left223scancode_map[0x26] = Key::A;224scancode_map[0x27] = Key::S;225scancode_map[0x28] = Key::D;226scancode_map[0x29] = Key::F;227scancode_map[0x2A] = Key::G;228scancode_map[0x2B] = Key::H;229scancode_map[0x2C] = Key::J;230scancode_map[0x2D] = Key::K;231scancode_map[0x2E] = Key::L;232scancode_map[0x2F] = Key::SEMICOLON;233scancode_map[0x30] = Key::APOSTROPHE;234scancode_map[0x31] = Key::SECTION;235scancode_map[0x32] = Key::SHIFT; // Left236scancode_map[0x33] = Key::BACKSLASH;237scancode_map[0x34] = Key::Z;238scancode_map[0x35] = Key::X;239scancode_map[0x36] = Key::C;240scancode_map[0x37] = Key::V;241scancode_map[0x38] = Key::B;242scancode_map[0x39] = Key::N;243scancode_map[0x3A] = Key::M;244scancode_map[0x3B] = Key::COMMA;245scancode_map[0x3C] = Key::PERIOD;246scancode_map[0x3D] = Key::SLASH;247scancode_map[0x3E] = Key::SHIFT; // Right248scancode_map[0x3F] = Key::KP_MULTIPLY;249scancode_map[0x40] = Key::ALT; // Left250scancode_map[0x41] = Key::SPACE;251scancode_map[0x42] = Key::CAPSLOCK;252scancode_map[0x43] = Key::F1;253scancode_map[0x44] = Key::F2;254scancode_map[0x45] = Key::F3;255scancode_map[0x46] = Key::F4;256scancode_map[0x47] = Key::F5;257scancode_map[0x48] = Key::F6;258scancode_map[0x49] = Key::F7;259scancode_map[0x4A] = Key::F8;260scancode_map[0x4B] = Key::F9;261scancode_map[0x4C] = Key::F10;262scancode_map[0x4D] = Key::NUMLOCK;263scancode_map[0x4E] = Key::SCROLLLOCK;264scancode_map[0x4F] = Key::KP_7;265scancode_map[0x50] = Key::KP_8;266scancode_map[0x51] = Key::KP_9;267scancode_map[0x52] = Key::KP_SUBTRACT;268scancode_map[0x53] = Key::KP_4;269scancode_map[0x54] = Key::KP_5;270scancode_map[0x55] = Key::KP_6;271scancode_map[0x56] = Key::KP_ADD;272scancode_map[0x57] = Key::KP_1;273scancode_map[0x58] = Key::KP_2;274scancode_map[0x59] = Key::KP_3;275scancode_map[0x5A] = Key::KP_0;276scancode_map[0x5B] = Key::KP_PERIOD;277//scancode_map[0x5C]278//scancode_map[0x5D] // Zenkaku Hankaku279scancode_map[0x5E] = Key::QUOTELEFT;280scancode_map[0x5F] = Key::F11;281scancode_map[0x60] = Key::F12;282//scancode_map[0x61] // Romaji283//scancode_map[0x62] // Katakana284//scancode_map[0x63] // Hiragana285//scancode_map[0x64] // Henkan286//scancode_map[0x65] // Hiragana Katakana287//scancode_map[0x66] // Muhenkan288scancode_map[0x67] = Key::COMMA; // KP_Separator289scancode_map[0x68] = Key::KP_ENTER;290scancode_map[0x69] = Key::CTRL; // Right291scancode_map[0x6A] = Key::KP_DIVIDE;292scancode_map[0x6B] = Key::PRINT;293scancode_map[0x6C] = Key::ALT; // Right294scancode_map[0x6D] = Key::ENTER;295scancode_map[0x6E] = Key::HOME;296scancode_map[0x6F] = Key::UP;297scancode_map[0x70] = Key::PAGEUP;298scancode_map[0x71] = Key::LEFT;299scancode_map[0x72] = Key::RIGHT;300scancode_map[0x73] = Key::END;301scancode_map[0x74] = Key::DOWN;302scancode_map[0x75] = Key::PAGEDOWN;303scancode_map[0x76] = Key::INSERT;304scancode_map[0x77] = Key::KEY_DELETE;305//scancode_map[0x78] // Macro306scancode_map[0x79] = Key::VOLUMEMUTE;307scancode_map[0x7A] = Key::VOLUMEDOWN;308scancode_map[0x7B] = Key::VOLUMEUP;309//scancode_map[0x7C] // Power310scancode_map[0x7D] = Key::EQUAL; // KP_Equal311//scancode_map[0x7E] // KP_PlusMinus312scancode_map[0x7F] = Key::PAUSE;313scancode_map[0x80] = Key::LAUNCH0;314scancode_map[0x81] = Key::COMMA; // KP_Comma315//scancode_map[0x82] // Hangul316//scancode_map[0x83] // Hangul_Hanja317scancode_map[0x84] = Key::YEN;318scancode_map[0x85] = Key::META; // Left319scancode_map[0x86] = Key::META; // Right320scancode_map[0x87] = Key::MENU;321322scancode_map[0xA6] = Key::BACK; // On Chromebooks323scancode_map[0xA7] = Key::FORWARD; // On Chromebooks324325scancode_map[0xB5] = Key::REFRESH; // On Chromebooks326327scancode_map[0xBF] = Key::F13;328scancode_map[0xC0] = Key::F14;329scancode_map[0xC1] = Key::F15;330scancode_map[0xC2] = Key::F16;331scancode_map[0xC3] = Key::F17;332scancode_map[0xC4] = Key::F18;333scancode_map[0xC5] = Key::F19;334scancode_map[0xC6] = Key::F20;335scancode_map[0xC7] = Key::F21;336scancode_map[0xC8] = Key::F22;337scancode_map[0xC9] = Key::F23;338scancode_map[0xCA] = Key::F24;339scancode_map[0xCB] = Key::F25;340scancode_map[0xCC] = Key::F26;341scancode_map[0xCD] = Key::F27;342scancode_map[0xCE] = Key::F28;343scancode_map[0xCF] = Key::F29;344scancode_map[0xD0] = Key::F30;345scancode_map[0xD1] = Key::F31;346scancode_map[0xD2] = Key::F32;347scancode_map[0xD3] = Key::F33;348scancode_map[0xD4] = Key::F34;349scancode_map[0xD5] = Key::F35;350351// Godot to scancode map.352for (const KeyValue<unsigned int, Key> &E : scancode_map) {353scancode_map_inv[E.value] = E.key;354}355356// Scancode to physical location map.357// Ctrl.358location_map[0x25] = KeyLocation::LEFT;359location_map[0x69] = KeyLocation::RIGHT;360// Shift.361location_map[0x32] = KeyLocation::LEFT;362location_map[0x3E] = KeyLocation::RIGHT;363// Alt.364location_map[0x40] = KeyLocation::LEFT;365location_map[0x6C] = KeyLocation::RIGHT;366// Meta.367location_map[0x85] = KeyLocation::LEFT;368location_map[0x86] = KeyLocation::RIGHT;369}370371Key KeyMappingXKB::get_keycode(xkb_keycode_t p_keysym) {372if (p_keysym >= 0x20 && p_keysym < 0x7E) { // ASCII, maps 1-1373if (p_keysym > 0x60 && p_keysym < 0x7B) { // Lowercase ASCII.374return (Key)(p_keysym - 32);375} else {376return (Key)p_keysym;377}378}379380const Key *key = xkb_keycode_map.getptr(p_keysym);381if (key) {382return *key;383}384return Key::NONE;385}386387Key KeyMappingXKB::get_scancode(unsigned int p_code) {388const Key *key = scancode_map.getptr(p_code);389if (key) {390return *key;391}392393return Key::NONE;394}395396xkb_keycode_t KeyMappingXKB::get_xkb_keycode(Key p_key) {397const unsigned int *key = scancode_map_inv.getptr(p_key);398if (key) {399return *key;400}401return 0x00;402}403404KeyLocation KeyMappingXKB::get_location(unsigned int p_code) {405const KeyLocation *location = location_map.getptr(p_code);406if (location) {407return *location;408}409return KeyLocation::UNSPECIFIED;410}411412413