src/video/winrt/SDL_winrtkeyboard.cpp
changeset 8489 7fd62b320c31
child 8494 5d165785918d
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/src/video/winrt/SDL_winrtkeyboard.cpp	Mon Aug 26 17:17:53 2013 -0400
     1.3 @@ -0,0 +1,300 @@
     1.4 +/*
     1.5 +  Simple DirectMedia Layer
     1.6 +  Copyright (C) 1997-2013 Sam Lantinga <slouken@libsdl.org>
     1.7 +
     1.8 +  This software is provided 'as-is', without any express or implied
     1.9 +  warranty.  In no event will the authors be held liable for any damages
    1.10 +  arising from the use of this software.
    1.11 +
    1.12 +  Permission is granted to anyone to use this software for any purpose,
    1.13 +  including commercial applications, and to alter it and redistribute it
    1.14 +  freely, subject to the following restrictions:
    1.15 +
    1.16 +  1. The origin of this software must not be misrepresented; you must not
    1.17 +     claim that you wrote the original software. If you use this software
    1.18 +     in a product, an acknowledgment in the product documentation would be
    1.19 +     appreciated but is not required.
    1.20 +  2. Altered source versions must be plainly marked as such, and must not be
    1.21 +     misrepresented as being the original software.
    1.22 +  3. This notice may not be removed or altered from any source distribution.
    1.23 +*/
    1.24 +#include "SDL_config.h"
    1.25 +
    1.26 +#if SDL_VIDEO_DRIVER_WINRT
    1.27 +
    1.28 +// Standard C++11 headers:
    1.29 +#include <unordered_map>
    1.30 +
    1.31 +
    1.32 +// Windows-specific headers:
    1.33 +#include <Windows.h>
    1.34 +
    1.35 +
    1.36 +// SDL-specific headers:
    1.37 +#include <SDL.h>
    1.38 +#include "SDL_winrtevents_c.h"
    1.39 +
    1.40 +extern "C" {
    1.41 +#include "../../events/scancodes_windows.h"
    1.42 +#include "../../events/SDL_keyboard_c.h"
    1.43 +}
    1.44 +
    1.45 +
    1.46 +static SDL_Scancode WinRT_Official_Keycodes[] = {
    1.47 +    SDL_SCANCODE_UNKNOWN, // VirtualKey.None -- 0
    1.48 +    SDL_SCANCODE_UNKNOWN, // VirtualKey.LeftButton -- 1
    1.49 +    SDL_SCANCODE_UNKNOWN, // VirtualKey.RightButton -- 2
    1.50 +    SDL_SCANCODE_CANCEL, // VirtualKey.Cancel -- 3
    1.51 +    SDL_SCANCODE_UNKNOWN, // VirtualKey.MiddleButton -- 4
    1.52 +    SDL_SCANCODE_UNKNOWN, // VirtualKey.XButton1 -- 5
    1.53 +    SDL_SCANCODE_UNKNOWN, // VirtualKey.XButton2 -- 6
    1.54 +    SDL_SCANCODE_UNKNOWN, // -- 7
    1.55 +    SDL_SCANCODE_BACKSPACE, // VirtualKey.Back -- 8
    1.56 +    SDL_SCANCODE_TAB, // VirtualKey.Tab -- 9
    1.57 +    SDL_SCANCODE_UNKNOWN, // -- 10
    1.58 +    SDL_SCANCODE_UNKNOWN, // -- 11
    1.59 +    SDL_SCANCODE_CLEAR, // VirtualKey.Clear -- 12
    1.60 +    SDL_SCANCODE_RETURN, // VirtualKey.Enter -- 13
    1.61 +    SDL_SCANCODE_UNKNOWN, // -- 14
    1.62 +    SDL_SCANCODE_UNKNOWN, // -- 15
    1.63 +    SDL_SCANCODE_LSHIFT, // VirtualKey.Shift -- 16
    1.64 +    SDL_SCANCODE_LCTRL, // VirtualKey.Control -- 17
    1.65 +    SDL_SCANCODE_MENU, // VirtualKey.Menu -- 18
    1.66 +    SDL_SCANCODE_PAUSE, // VirtualKey.Pause -- 19
    1.67 +    SDL_SCANCODE_CAPSLOCK, // VirtualKey.CapitalLock -- 20
    1.68 +    SDL_SCANCODE_UNKNOWN, // VirtualKey.Kana or VirtualKey.Hangul -- 21
    1.69 +    SDL_SCANCODE_UNKNOWN, // -- 22
    1.70 +    SDL_SCANCODE_UNKNOWN, // VirtualKey.Junja -- 23
    1.71 +    SDL_SCANCODE_UNKNOWN, // VirtualKey.Final -- 24
    1.72 +    SDL_SCANCODE_UNKNOWN, // VirtualKey.Hanja or VirtualKey.Kanji -- 25
    1.73 +    SDL_SCANCODE_UNKNOWN, // -- 26
    1.74 +    SDL_SCANCODE_ESCAPE, // VirtualKey.Escape -- 27
    1.75 +    SDL_SCANCODE_UNKNOWN, // VirtualKey.Convert -- 28
    1.76 +    SDL_SCANCODE_UNKNOWN, // VirtualKey.NonConvert -- 29
    1.77 +    SDL_SCANCODE_UNKNOWN, // VirtualKey.Accept -- 30
    1.78 +    SDL_SCANCODE_UNKNOWN, // VirtualKey.ModeChange -- 31  (maybe SDL_SCANCODE_MODE ?)
    1.79 +    SDL_SCANCODE_SPACE, // VirtualKey.Space -- 32
    1.80 +    SDL_SCANCODE_PAGEUP, // VirtualKey.PageUp -- 33
    1.81 +    SDL_SCANCODE_PAGEDOWN, // VirtualKey.PageDown -- 34
    1.82 +    SDL_SCANCODE_END, // VirtualKey.End -- 35
    1.83 +    SDL_SCANCODE_HOME, // VirtualKey.Home -- 36
    1.84 +    SDL_SCANCODE_LEFT, // VirtualKey.Left -- 37
    1.85 +    SDL_SCANCODE_UP, // VirtualKey.Up -- 38
    1.86 +    SDL_SCANCODE_RIGHT, // VirtualKey.Right -- 39
    1.87 +    SDL_SCANCODE_DOWN, // VirtualKey.Down -- 40
    1.88 +    SDL_SCANCODE_SELECT, // VirtualKey.Select -- 41
    1.89 +    SDL_SCANCODE_UNKNOWN, // VirtualKey.Print -- 42  (maybe SDL_SCANCODE_PRINTSCREEN ?)
    1.90 +    SDL_SCANCODE_EXECUTE, // VirtualKey.Execute -- 43
    1.91 +    SDL_SCANCODE_UNKNOWN, // VirtualKey.Snapshot -- 44
    1.92 +    SDL_SCANCODE_INSERT, // VirtualKey.Insert -- 45
    1.93 +    SDL_SCANCODE_DELETE, // VirtualKey.Delete -- 46
    1.94 +    SDL_SCANCODE_HELP, // VirtualKey.Help -- 47
    1.95 +    SDL_SCANCODE_0, // VirtualKey.Number0 -- 48
    1.96 +    SDL_SCANCODE_1, // VirtualKey.Number1 -- 49
    1.97 +    SDL_SCANCODE_2, // VirtualKey.Number2 -- 50
    1.98 +    SDL_SCANCODE_3, // VirtualKey.Number3 -- 51
    1.99 +    SDL_SCANCODE_4, // VirtualKey.Number4 -- 52
   1.100 +    SDL_SCANCODE_5, // VirtualKey.Number5 -- 53
   1.101 +    SDL_SCANCODE_6, // VirtualKey.Number6 -- 54
   1.102 +    SDL_SCANCODE_7, // VirtualKey.Number7 -- 55
   1.103 +    SDL_SCANCODE_8, // VirtualKey.Number8 -- 56
   1.104 +    SDL_SCANCODE_9, // VirtualKey.Number9 -- 57
   1.105 +    SDL_SCANCODE_UNKNOWN, // -- 58
   1.106 +    SDL_SCANCODE_UNKNOWN, // -- 59
   1.107 +    SDL_SCANCODE_UNKNOWN, // -- 60
   1.108 +    SDL_SCANCODE_UNKNOWN, // -- 61
   1.109 +    SDL_SCANCODE_UNKNOWN, // -- 62
   1.110 +    SDL_SCANCODE_UNKNOWN, // -- 63
   1.111 +    SDL_SCANCODE_UNKNOWN, // -- 64
   1.112 +    SDL_SCANCODE_A, // VirtualKey.A -- 65
   1.113 +    SDL_SCANCODE_B, // VirtualKey.B -- 66
   1.114 +    SDL_SCANCODE_C, // VirtualKey.C -- 67
   1.115 +    SDL_SCANCODE_D, // VirtualKey.D -- 68
   1.116 +    SDL_SCANCODE_E, // VirtualKey.E -- 69
   1.117 +    SDL_SCANCODE_F, // VirtualKey.F -- 70
   1.118 +    SDL_SCANCODE_G, // VirtualKey.G -- 71
   1.119 +    SDL_SCANCODE_H, // VirtualKey.H -- 72
   1.120 +    SDL_SCANCODE_I, // VirtualKey.I -- 73
   1.121 +    SDL_SCANCODE_J, // VirtualKey.J -- 74
   1.122 +    SDL_SCANCODE_K, // VirtualKey.K -- 75
   1.123 +    SDL_SCANCODE_L, // VirtualKey.L -- 76
   1.124 +    SDL_SCANCODE_M, // VirtualKey.M -- 77
   1.125 +    SDL_SCANCODE_N, // VirtualKey.N -- 78
   1.126 +    SDL_SCANCODE_O, // VirtualKey.O -- 79
   1.127 +    SDL_SCANCODE_P, // VirtualKey.P -- 80
   1.128 +    SDL_SCANCODE_Q, // VirtualKey.Q -- 81
   1.129 +    SDL_SCANCODE_R, // VirtualKey.R -- 82
   1.130 +    SDL_SCANCODE_S, // VirtualKey.S -- 83
   1.131 +    SDL_SCANCODE_T, // VirtualKey.T -- 84
   1.132 +    SDL_SCANCODE_U, // VirtualKey.U -- 85
   1.133 +    SDL_SCANCODE_V, // VirtualKey.V -- 86
   1.134 +    SDL_SCANCODE_W, // VirtualKey.W -- 87
   1.135 +    SDL_SCANCODE_X, // VirtualKey.X -- 88
   1.136 +    SDL_SCANCODE_Y, // VirtualKey.Y -- 89
   1.137 +    SDL_SCANCODE_Z, // VirtualKey.Z -- 90
   1.138 +    SDL_SCANCODE_UNKNOWN, // VirtualKey.LeftWindows -- 91  (maybe SDL_SCANCODE_APPLICATION or SDL_SCANCODE_LGUI ?)
   1.139 +    SDL_SCANCODE_UNKNOWN, // VirtualKey.RightWindows -- 92  (maybe SDL_SCANCODE_APPLICATION or SDL_SCANCODE_RGUI ?)
   1.140 +    SDL_SCANCODE_APPLICATION, // VirtualKey.Application -- 93
   1.141 +    SDL_SCANCODE_UNKNOWN, // -- 94
   1.142 +    SDL_SCANCODE_SLEEP, // VirtualKey.Sleep -- 95
   1.143 +    SDL_SCANCODE_KP_0, // VirtualKey.NumberPad0 -- 96
   1.144 +    SDL_SCANCODE_KP_1, // VirtualKey.NumberPad1 -- 97
   1.145 +    SDL_SCANCODE_KP_2, // VirtualKey.NumberPad2 -- 98
   1.146 +    SDL_SCANCODE_KP_3, // VirtualKey.NumberPad3 -- 99
   1.147 +    SDL_SCANCODE_KP_4, // VirtualKey.NumberPad4 -- 100
   1.148 +    SDL_SCANCODE_KP_5, // VirtualKey.NumberPad5 -- 101
   1.149 +    SDL_SCANCODE_KP_6, // VirtualKey.NumberPad6 -- 102
   1.150 +    SDL_SCANCODE_KP_7, // VirtualKey.NumberPad7 -- 103
   1.151 +    SDL_SCANCODE_KP_8, // VirtualKey.NumberPad8 -- 104
   1.152 +    SDL_SCANCODE_KP_9, // VirtualKey.NumberPad9 -- 105
   1.153 +    SDL_SCANCODE_KP_MULTIPLY, // VirtualKey.Multiply -- 106
   1.154 +    SDL_SCANCODE_KP_PLUS, // VirtualKey.Add -- 107
   1.155 +    SDL_SCANCODE_UNKNOWN, // VirtualKey.Separator -- 108
   1.156 +    SDL_SCANCODE_KP_MINUS, // VirtualKey.Subtract -- 109
   1.157 +    SDL_SCANCODE_UNKNOWN, // VirtualKey.Decimal -- 110  (maybe SDL_SCANCODE_DECIMALSEPARATOR, SDL_SCANCODE_KP_DECIMAL, or SDL_SCANCODE_KP_PERIOD ?)
   1.158 +    SDL_SCANCODE_KP_DIVIDE, // VirtualKey.Divide -- 111
   1.159 +    SDL_SCANCODE_F1, // VirtualKey.F1 -- 112
   1.160 +    SDL_SCANCODE_F2, // VirtualKey.F2 -- 113
   1.161 +    SDL_SCANCODE_F3, // VirtualKey.F3 -- 114
   1.162 +    SDL_SCANCODE_F4, // VirtualKey.F4 -- 115
   1.163 +    SDL_SCANCODE_F5, // VirtualKey.F5 -- 116
   1.164 +    SDL_SCANCODE_F6, // VirtualKey.F6 -- 117
   1.165 +    SDL_SCANCODE_F7, // VirtualKey.F7 -- 118
   1.166 +    SDL_SCANCODE_F8, // VirtualKey.F8 -- 119
   1.167 +    SDL_SCANCODE_F9, // VirtualKey.F9 -- 120
   1.168 +    SDL_SCANCODE_F10, // VirtualKey.F10 -- 121
   1.169 +    SDL_SCANCODE_F11, // VirtualKey.F11 -- 122
   1.170 +    SDL_SCANCODE_F12, // VirtualKey.F12 -- 123
   1.171 +    SDL_SCANCODE_F13, // VirtualKey.F13 -- 124
   1.172 +    SDL_SCANCODE_F14, // VirtualKey.F14 -- 125
   1.173 +    SDL_SCANCODE_F15, // VirtualKey.F15 -- 126
   1.174 +    SDL_SCANCODE_F16, // VirtualKey.F16 -- 127
   1.175 +    SDL_SCANCODE_F17, // VirtualKey.F17 -- 128
   1.176 +    SDL_SCANCODE_F18, // VirtualKey.F18 -- 129
   1.177 +    SDL_SCANCODE_F19, // VirtualKey.F19 -- 130
   1.178 +    SDL_SCANCODE_F20, // VirtualKey.F20 -- 131
   1.179 +    SDL_SCANCODE_F21, // VirtualKey.F21 -- 132
   1.180 +    SDL_SCANCODE_F22, // VirtualKey.F22 -- 133
   1.181 +    SDL_SCANCODE_F23, // VirtualKey.F23 -- 134
   1.182 +    SDL_SCANCODE_F24, // VirtualKey.F24 -- 135
   1.183 +    SDL_SCANCODE_UNKNOWN, // -- 136
   1.184 +    SDL_SCANCODE_UNKNOWN, // -- 137
   1.185 +    SDL_SCANCODE_UNKNOWN, // -- 138
   1.186 +    SDL_SCANCODE_UNKNOWN, // -- 139
   1.187 +    SDL_SCANCODE_UNKNOWN, // -- 140
   1.188 +    SDL_SCANCODE_UNKNOWN, // -- 141
   1.189 +    SDL_SCANCODE_UNKNOWN, // -- 142
   1.190 +    SDL_SCANCODE_UNKNOWN, // -- 143
   1.191 +    SDL_SCANCODE_NUMLOCKCLEAR, // VirtualKey.NumberKeyLock -- 144
   1.192 +    SDL_SCANCODE_SCROLLLOCK, // VirtualKey.Scroll -- 145
   1.193 +    SDL_SCANCODE_UNKNOWN, // -- 146
   1.194 +    SDL_SCANCODE_UNKNOWN, // -- 147
   1.195 +    SDL_SCANCODE_UNKNOWN, // -- 148
   1.196 +    SDL_SCANCODE_UNKNOWN, // -- 149
   1.197 +    SDL_SCANCODE_UNKNOWN, // -- 150
   1.198 +    SDL_SCANCODE_UNKNOWN, // -- 151
   1.199 +    SDL_SCANCODE_UNKNOWN, // -- 152
   1.200 +    SDL_SCANCODE_UNKNOWN, // -- 153
   1.201 +    SDL_SCANCODE_UNKNOWN, // -- 154
   1.202 +    SDL_SCANCODE_UNKNOWN, // -- 155
   1.203 +    SDL_SCANCODE_UNKNOWN, // -- 156
   1.204 +    SDL_SCANCODE_UNKNOWN, // -- 157
   1.205 +    SDL_SCANCODE_UNKNOWN, // -- 158
   1.206 +    SDL_SCANCODE_UNKNOWN, // -- 159
   1.207 +    SDL_SCANCODE_LSHIFT, // VirtualKey.LeftShift -- 160
   1.208 +    SDL_SCANCODE_RSHIFT, // VirtualKey.RightShift -- 161
   1.209 +    SDL_SCANCODE_LCTRL, // VirtualKey.LeftControl -- 162
   1.210 +    SDL_SCANCODE_RCTRL, // VirtualKey.RightControl -- 163
   1.211 +    SDL_SCANCODE_MENU, // VirtualKey.LeftMenu -- 164
   1.212 +    SDL_SCANCODE_MENU, // VirtualKey.RightMenu -- 165
   1.213 +};
   1.214 +
   1.215 +static std::unordered_map<int, SDL_Scancode> WinRT_Unofficial_Keycodes;
   1.216 +
   1.217 +static SDL_Scancode
   1.218 +TranslateKeycode(int keycode)
   1.219 +{
   1.220 +    if (WinRT_Unofficial_Keycodes.empty()) {
   1.221 +        /* Set up a table of undocumented (by Microsoft), WinRT-specific,
   1.222 +           key codes: */
   1.223 +        // TODO, WinRT: move content declarations of WinRT_Unofficial_Keycodes into a C++11 initializer list, when possible
   1.224 +        WinRT_Unofficial_Keycodes[220] = SDL_SCANCODE_GRAVE;
   1.225 +        WinRT_Unofficial_Keycodes[222] = SDL_SCANCODE_BACKSLASH;
   1.226 +    }
   1.227 +
   1.228 +    /* Try to get a documented, WinRT, 'VirtualKey' first (as documented at
   1.229 +       http://msdn.microsoft.com/en-us/library/windows/apps/windows.system.virtualkey.aspx ).
   1.230 +       If that fails, fall back to a Win32 virtual key.
   1.231 +    */
   1.232 +    // TODO, WinRT: try filling out the WinRT keycode table as much as possible, using the Win32 table for interpretation hints
   1.233 +    //SDL_Log("WinRT TranslateKeycode, keycode=%d\n", (int)keycode);
   1.234 +    SDL_Scancode scancode = SDL_SCANCODE_UNKNOWN;
   1.235 +    if (keycode < SDL_arraysize(WinRT_Official_Keycodes)) {
   1.236 +        scancode = WinRT_Official_Keycodes[keycode];
   1.237 +    }
   1.238 +    if (scancode == SDL_SCANCODE_UNKNOWN) {
   1.239 +        if (WinRT_Unofficial_Keycodes.find(keycode) != WinRT_Unofficial_Keycodes.end()) {
   1.240 +            scancode = WinRT_Unofficial_Keycodes[keycode];
   1.241 +        }
   1.242 +    }
   1.243 +    if (scancode == SDL_SCANCODE_UNKNOWN) {
   1.244 +        if (keycode < SDL_arraysize(windows_scancode_table)) {
   1.245 +            scancode = windows_scancode_table[keycode];
   1.246 +        }
   1.247 +    }
   1.248 +    if (scancode == SDL_SCANCODE_UNKNOWN) {
   1.249 +        SDL_Log("WinRT TranslateKeycode, unknown keycode=%d\n", (int)keycode);
   1.250 +    }
   1.251 +    return scancode;
   1.252 +}
   1.253 +
   1.254 +void
   1.255 +WINRT_ProcessKeyDownEvent(Windows::UI::Core::KeyEventArgs ^args)
   1.256 +{
   1.257 +    SDL_Scancode sdlScancode = TranslateKeycode((int)args->VirtualKey);
   1.258 +#if 0
   1.259 +    SDL_Keycode keycode = SDL_GetKeyFromScancode(sdlScancode);
   1.260 +    SDL_Log("key down, handled=%s, ext?=%s, released?=%s, menu key down?=%s, repeat count=%d, native scan code=%d, was down?=%s, vkey=%d, sdl scan code=%d (%s), sdl key code=%d (%s)\n",
   1.261 +        (args->Handled ? "1" : "0"),
   1.262 +        (args->KeyStatus.IsExtendedKey ? "1" : "0"),
   1.263 +        (args->KeyStatus.IsKeyReleased ? "1" : "0"),
   1.264 +        (args->KeyStatus.IsMenuKeyDown ? "1" : "0"),
   1.265 +        args->KeyStatus.RepeatCount,
   1.266 +        args->KeyStatus.ScanCode,
   1.267 +        (args->KeyStatus.WasKeyDown ? "1" : "0"),
   1.268 +        args->VirtualKey,
   1.269 +        sdlScancode,
   1.270 +        SDL_GetScancodeName(sdlScancode),
   1.271 +        keycode,
   1.272 +        SDL_GetKeyName(keycode));
   1.273 +    //args->Handled = true;
   1.274 +    //VirtualKey vkey = args->VirtualKey;
   1.275 +#endif
   1.276 +    SDL_SendKeyboardKey(SDL_PRESSED, sdlScancode);
   1.277 +}
   1.278 +
   1.279 +void
   1.280 +WINRT_ProcessKeyUpEvent(Windows::UI::Core::KeyEventArgs ^args)
   1.281 +{
   1.282 +    SDL_Scancode sdlScancode = TranslateKeycode((int)args->VirtualKey);
   1.283 +#if 0
   1.284 +    SDL_Keycode keycode = SDL_GetKeyFromScancode(sdlScancode);
   1.285 +    SDL_Log("key up, handled=%s, ext?=%s, released?=%s, menu key down?=%s, repeat count=%d, native scan code=%d, was down?=%s, vkey=%d, sdl scan code=%d (%s), sdl key code=%d (%s)\n",
   1.286 +        (args->Handled ? "1" : "0"),
   1.287 +        (args->KeyStatus.IsExtendedKey ? "1" : "0"),
   1.288 +        (args->KeyStatus.IsKeyReleased ? "1" : "0"),
   1.289 +        (args->KeyStatus.IsMenuKeyDown ? "1" : "0"),
   1.290 +        args->KeyStatus.RepeatCount,
   1.291 +        args->KeyStatus.ScanCode,
   1.292 +        (args->KeyStatus.WasKeyDown ? "1" : "0"),
   1.293 +        args->VirtualKey,
   1.294 +        sdlScancode,
   1.295 +        SDL_GetScancodeName(sdlScancode),
   1.296 +        keycode,
   1.297 +        SDL_GetKeyName(keycode));
   1.298 +    //args->Handled = true;
   1.299 +#endif
   1.300 +    SDL_SendKeyboardKey(SDL_RELEASED, sdlScancode);
   1.301 +}
   1.302 +
   1.303 +#endif // SDL_VIDEO_DRIVER_WINRT