kc3-lang/SDL/src/video/winrt/SDL_winrtkeyboard.cpp

Branch : - branch - v2.28 - tag -

• Show log

  Commit

• Author : David Ludwig
  Date : 2014-04-17 12:43:51
  Hash : 63b46d3d
  Message : WinRT: keyboard VirtualKey translation improvements from Sylvain Becker Changes included: - adding support for a few, additional, VirtualKey constants - removing accesses to 'windows_scancode_table', as the table's contents don't line up with WinRT virtual keys. Using Windows older VK_* constants may, however, be a good alternative in a future update.

• src/video/winrt/SDL_winrtkeyboard.cpp

• /*
    Simple DirectMedia Layer
    Copyright (C) 1997-2014 Sam Lantinga <slouken@libsdl.org>
  
    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.
  */
  #include "../../SDL_internal.h"
  
  #if SDL_VIDEO_DRIVER_WINRT
  
  /* Standard C++11 includes */
  #include <unordered_map>
  
  
  /* Windows-specific includes */
  #include <Windows.h>
  #include <agile.h>
  
  
  /* SDL-specific includes */
  #include <SDL.h>
  #include "SDL_winrtevents_c.h"
  
  extern "C" {
  #include "../../events/scancodes_windows.h"
  #include "../../events/SDL_keyboard_c.h"
  }
  
  
  static SDL_Scancode WinRT_Official_Keycodes[] = {
      SDL_SCANCODE_UNKNOWN, // VirtualKey.None -- 0
      SDL_SCANCODE_UNKNOWN, // VirtualKey.LeftButton -- 1
      SDL_SCANCODE_UNKNOWN, // VirtualKey.RightButton -- 2
      SDL_SCANCODE_CANCEL, // VirtualKey.Cancel -- 3
      SDL_SCANCODE_UNKNOWN, // VirtualKey.MiddleButton -- 4
      SDL_SCANCODE_UNKNOWN, // VirtualKey.XButton1 -- 5
      SDL_SCANCODE_UNKNOWN, // VirtualKey.XButton2 -- 6
      SDL_SCANCODE_UNKNOWN, // -- 7
      SDL_SCANCODE_BACKSPACE, // VirtualKey.Back -- 8
      SDL_SCANCODE_TAB, // VirtualKey.Tab -- 9
      SDL_SCANCODE_UNKNOWN, // -- 10
      SDL_SCANCODE_UNKNOWN, // -- 11
      SDL_SCANCODE_CLEAR, // VirtualKey.Clear -- 12
      SDL_SCANCODE_RETURN, // VirtualKey.Enter -- 13
      SDL_SCANCODE_UNKNOWN, // -- 14
      SDL_SCANCODE_UNKNOWN, // -- 15
      SDL_SCANCODE_LSHIFT, // VirtualKey.Shift -- 16
      SDL_SCANCODE_LCTRL, // VirtualKey.Control -- 17
      SDL_SCANCODE_MENU, // VirtualKey.Menu -- 18
      SDL_SCANCODE_PAUSE, // VirtualKey.Pause -- 19
      SDL_SCANCODE_CAPSLOCK, // VirtualKey.CapitalLock -- 20
      SDL_SCANCODE_UNKNOWN, // VirtualKey.Kana or VirtualKey.Hangul -- 21
      SDL_SCANCODE_UNKNOWN, // -- 22
      SDL_SCANCODE_UNKNOWN, // VirtualKey.Junja -- 23
      SDL_SCANCODE_UNKNOWN, // VirtualKey.Final -- 24
      SDL_SCANCODE_UNKNOWN, // VirtualKey.Hanja or VirtualKey.Kanji -- 25
      SDL_SCANCODE_UNKNOWN, // -- 26
      SDL_SCANCODE_ESCAPE, // VirtualKey.Escape -- 27
      SDL_SCANCODE_UNKNOWN, // VirtualKey.Convert -- 28
      SDL_SCANCODE_UNKNOWN, // VirtualKey.NonConvert -- 29
      SDL_SCANCODE_UNKNOWN, // VirtualKey.Accept -- 30
      SDL_SCANCODE_UNKNOWN, // VirtualKey.ModeChange -- 31  (maybe SDL_SCANCODE_MODE ?)
      SDL_SCANCODE_SPACE, // VirtualKey.Space -- 32
      SDL_SCANCODE_PAGEUP, // VirtualKey.PageUp -- 33
      SDL_SCANCODE_PAGEDOWN, // VirtualKey.PageDown -- 34
      SDL_SCANCODE_END, // VirtualKey.End -- 35
      SDL_SCANCODE_HOME, // VirtualKey.Home -- 36
      SDL_SCANCODE_LEFT, // VirtualKey.Left -- 37
      SDL_SCANCODE_UP, // VirtualKey.Up -- 38
      SDL_SCANCODE_RIGHT, // VirtualKey.Right -- 39
      SDL_SCANCODE_DOWN, // VirtualKey.Down -- 40
      SDL_SCANCODE_SELECT, // VirtualKey.Select -- 41
      SDL_SCANCODE_UNKNOWN, // VirtualKey.Print -- 42  (maybe SDL_SCANCODE_PRINTSCREEN ?)
      SDL_SCANCODE_EXECUTE, // VirtualKey.Execute -- 43
      SDL_SCANCODE_UNKNOWN, // VirtualKey.Snapshot -- 44
      SDL_SCANCODE_INSERT, // VirtualKey.Insert -- 45
      SDL_SCANCODE_DELETE, // VirtualKey.Delete -- 46
      SDL_SCANCODE_HELP, // VirtualKey.Help -- 47
      SDL_SCANCODE_0, // VirtualKey.Number0 -- 48
      SDL_SCANCODE_1, // VirtualKey.Number1 -- 49
      SDL_SCANCODE_2, // VirtualKey.Number2 -- 50
      SDL_SCANCODE_3, // VirtualKey.Number3 -- 51
      SDL_SCANCODE_4, // VirtualKey.Number4 -- 52
      SDL_SCANCODE_5, // VirtualKey.Number5 -- 53
      SDL_SCANCODE_6, // VirtualKey.Number6 -- 54
      SDL_SCANCODE_7, // VirtualKey.Number7 -- 55
      SDL_SCANCODE_8, // VirtualKey.Number8 -- 56
      SDL_SCANCODE_9, // VirtualKey.Number9 -- 57
      SDL_SCANCODE_UNKNOWN, // -- 58
      SDL_SCANCODE_UNKNOWN, // -- 59
      SDL_SCANCODE_UNKNOWN, // -- 60
      SDL_SCANCODE_UNKNOWN, // -- 61
      SDL_SCANCODE_UNKNOWN, // -- 62
      SDL_SCANCODE_UNKNOWN, // -- 63
      SDL_SCANCODE_UNKNOWN, // -- 64
      SDL_SCANCODE_A, // VirtualKey.A -- 65
      SDL_SCANCODE_B, // VirtualKey.B -- 66
      SDL_SCANCODE_C, // VirtualKey.C -- 67
      SDL_SCANCODE_D, // VirtualKey.D -- 68
      SDL_SCANCODE_E, // VirtualKey.E -- 69
      SDL_SCANCODE_F, // VirtualKey.F -- 70
      SDL_SCANCODE_G, // VirtualKey.G -- 71
      SDL_SCANCODE_H, // VirtualKey.H -- 72
      SDL_SCANCODE_I, // VirtualKey.I -- 73
      SDL_SCANCODE_J, // VirtualKey.J -- 74
      SDL_SCANCODE_K, // VirtualKey.K -- 75
      SDL_SCANCODE_L, // VirtualKey.L -- 76
      SDL_SCANCODE_M, // VirtualKey.M -- 77
      SDL_SCANCODE_N, // VirtualKey.N -- 78
      SDL_SCANCODE_O, // VirtualKey.O -- 79
      SDL_SCANCODE_P, // VirtualKey.P -- 80
      SDL_SCANCODE_Q, // VirtualKey.Q -- 81
      SDL_SCANCODE_R, // VirtualKey.R -- 82
      SDL_SCANCODE_S, // VirtualKey.S -- 83
      SDL_SCANCODE_T, // VirtualKey.T -- 84
      SDL_SCANCODE_U, // VirtualKey.U -- 85
      SDL_SCANCODE_V, // VirtualKey.V -- 86
      SDL_SCANCODE_W, // VirtualKey.W -- 87
      SDL_SCANCODE_X, // VirtualKey.X -- 88
      SDL_SCANCODE_Y, // VirtualKey.Y -- 89
      SDL_SCANCODE_Z, // VirtualKey.Z -- 90
      SDL_SCANCODE_UNKNOWN, // VirtualKey.LeftWindows -- 91  (maybe SDL_SCANCODE_APPLICATION or SDL_SCANCODE_LGUI ?)
      SDL_SCANCODE_UNKNOWN, // VirtualKey.RightWindows -- 92  (maybe SDL_SCANCODE_APPLICATION or SDL_SCANCODE_RGUI ?)
      SDL_SCANCODE_APPLICATION, // VirtualKey.Application -- 93
      SDL_SCANCODE_UNKNOWN, // -- 94
      SDL_SCANCODE_SLEEP, // VirtualKey.Sleep -- 95
      SDL_SCANCODE_KP_0, // VirtualKey.NumberPad0 -- 96
      SDL_SCANCODE_KP_1, // VirtualKey.NumberPad1 -- 97
      SDL_SCANCODE_KP_2, // VirtualKey.NumberPad2 -- 98
      SDL_SCANCODE_KP_3, // VirtualKey.NumberPad3 -- 99
      SDL_SCANCODE_KP_4, // VirtualKey.NumberPad4 -- 100
      SDL_SCANCODE_KP_5, // VirtualKey.NumberPad5 -- 101
      SDL_SCANCODE_KP_6, // VirtualKey.NumberPad6 -- 102
      SDL_SCANCODE_KP_7, // VirtualKey.NumberPad7 -- 103
      SDL_SCANCODE_KP_8, // VirtualKey.NumberPad8 -- 104
      SDL_SCANCODE_KP_9, // VirtualKey.NumberPad9 -- 105
      SDL_SCANCODE_KP_MULTIPLY, // VirtualKey.Multiply -- 106
      SDL_SCANCODE_KP_PLUS, // VirtualKey.Add -- 107
      SDL_SCANCODE_UNKNOWN, // VirtualKey.Separator -- 108
      SDL_SCANCODE_KP_MINUS, // VirtualKey.Subtract -- 109
      SDL_SCANCODE_UNKNOWN, // VirtualKey.Decimal -- 110  (maybe SDL_SCANCODE_DECIMALSEPARATOR, SDL_SCANCODE_KP_DECIMAL, or SDL_SCANCODE_KP_PERIOD ?)
      SDL_SCANCODE_KP_DIVIDE, // VirtualKey.Divide -- 111
      SDL_SCANCODE_F1, // VirtualKey.F1 -- 112
      SDL_SCANCODE_F2, // VirtualKey.F2 -- 113
      SDL_SCANCODE_F3, // VirtualKey.F3 -- 114
      SDL_SCANCODE_F4, // VirtualKey.F4 -- 115
      SDL_SCANCODE_F5, // VirtualKey.F5 -- 116
      SDL_SCANCODE_F6, // VirtualKey.F6 -- 117
      SDL_SCANCODE_F7, // VirtualKey.F7 -- 118
      SDL_SCANCODE_F8, // VirtualKey.F8 -- 119
      SDL_SCANCODE_F9, // VirtualKey.F9 -- 120
      SDL_SCANCODE_F10, // VirtualKey.F10 -- 121
      SDL_SCANCODE_F11, // VirtualKey.F11 -- 122
      SDL_SCANCODE_F12, // VirtualKey.F12 -- 123
      SDL_SCANCODE_F13, // VirtualKey.F13 -- 124
      SDL_SCANCODE_F14, // VirtualKey.F14 -- 125
      SDL_SCANCODE_F15, // VirtualKey.F15 -- 126
      SDL_SCANCODE_F16, // VirtualKey.F16 -- 127
      SDL_SCANCODE_F17, // VirtualKey.F17 -- 128
      SDL_SCANCODE_F18, // VirtualKey.F18 -- 129
      SDL_SCANCODE_F19, // VirtualKey.F19 -- 130
      SDL_SCANCODE_F20, // VirtualKey.F20 -- 131
      SDL_SCANCODE_F21, // VirtualKey.F21 -- 132
      SDL_SCANCODE_F22, // VirtualKey.F22 -- 133
      SDL_SCANCODE_F23, // VirtualKey.F23 -- 134
      SDL_SCANCODE_F24, // VirtualKey.F24 -- 135
      SDL_SCANCODE_UNKNOWN, // -- 136
      SDL_SCANCODE_UNKNOWN, // -- 137
      SDL_SCANCODE_UNKNOWN, // -- 138
      SDL_SCANCODE_UNKNOWN, // -- 139
      SDL_SCANCODE_UNKNOWN, // -- 140
      SDL_SCANCODE_UNKNOWN, // -- 141
      SDL_SCANCODE_UNKNOWN, // -- 142
      SDL_SCANCODE_UNKNOWN, // -- 143
      SDL_SCANCODE_NUMLOCKCLEAR, // VirtualKey.NumberKeyLock -- 144
      SDL_SCANCODE_SCROLLLOCK, // VirtualKey.Scroll -- 145
      SDL_SCANCODE_UNKNOWN, // -- 146
      SDL_SCANCODE_UNKNOWN, // -- 147
      SDL_SCANCODE_UNKNOWN, // -- 148
      SDL_SCANCODE_UNKNOWN, // -- 149
      SDL_SCANCODE_UNKNOWN, // -- 150
      SDL_SCANCODE_UNKNOWN, // -- 151
      SDL_SCANCODE_UNKNOWN, // -- 152
      SDL_SCANCODE_UNKNOWN, // -- 153
      SDL_SCANCODE_UNKNOWN, // -- 154
      SDL_SCANCODE_UNKNOWN, // -- 155
      SDL_SCANCODE_UNKNOWN, // -- 156
      SDL_SCANCODE_UNKNOWN, // -- 157
      SDL_SCANCODE_UNKNOWN, // -- 158
      SDL_SCANCODE_UNKNOWN, // -- 159
      SDL_SCANCODE_LSHIFT, // VirtualKey.LeftShift -- 160
      SDL_SCANCODE_RSHIFT, // VirtualKey.RightShift -- 161
      SDL_SCANCODE_LCTRL, // VirtualKey.LeftControl -- 162
      SDL_SCANCODE_RCTRL, // VirtualKey.RightControl -- 163
      SDL_SCANCODE_MENU, // VirtualKey.LeftMenu -- 164
      SDL_SCANCODE_MENU, // VirtualKey.RightMenu -- 165
      SDL_SCANCODE_AC_BACK, // VirtualKey.GoBack -- 166 : The go back key.
      SDL_SCANCODE_AC_FORWARD, // VirtualKey.GoForward -- 167 : The go forward key.
      SDL_SCANCODE_AC_REFRESH, // VirtualKey.Refresh -- 168 : The refresh key.
      SDL_SCANCODE_AC_STOP, // VirtualKey.Stop -- 169 : The stop key.
      SDL_SCANCODE_AC_SEARCH, // VirtualKey.Search -- 170 : The search key.
      SDL_SCANCODE_AC_BOOKMARKS, // VirtualKey.Favorites -- 171 : The favorites key.
      SDL_SCANCODE_AC_HOME // VirtualKey.GoHome -- 172 : The go home key.
  };
  
  static std::unordered_map<int, SDL_Scancode> WinRT_Unofficial_Keycodes;
  
  static SDL_Scancode
  TranslateKeycode(int keycode)
  {
      if (WinRT_Unofficial_Keycodes.empty()) {
          /* Set up a table of keycodes that aren't listed in WinRT's
           * VirtualKey enum.
           */
  
          WinRT_Unofficial_Keycodes[173] = SDL_SCANCODE_MUTE;
          WinRT_Unofficial_Keycodes[174] = SDL_SCANCODE_VOLUMEDOWN;
          WinRT_Unofficial_Keycodes[175] = SDL_SCANCODE_VOLUMEUP;
          WinRT_Unofficial_Keycodes[176] = SDL_SCANCODE_AUDIONEXT;
          WinRT_Unofficial_Keycodes[177] = SDL_SCANCODE_AUDIOPREV;
          // WinRT_Unofficial_Keycodes[178] = ;
          WinRT_Unofficial_Keycodes[179] = SDL_SCANCODE_AUDIOPLAY;
          WinRT_Unofficial_Keycodes[180] = SDL_SCANCODE_MAIL;
          WinRT_Unofficial_Keycodes[181] = SDL_SCANCODE_MEDIASELECT;
          // WinRT_Unofficial_Keycodes[182] = ;
          WinRT_Unofficial_Keycodes[183] = SDL_SCANCODE_CALCULATOR;
          // WinRT_Unofficial_Keycodes[184] = ;
          // WinRT_Unofficial_Keycodes[185] = ;
          WinRT_Unofficial_Keycodes[186] = SDL_SCANCODE_SEMICOLON;
          WinRT_Unofficial_Keycodes[187] = SDL_SCANCODE_EQUALS;
          WinRT_Unofficial_Keycodes[188] = SDL_SCANCODE_COMMA;
          WinRT_Unofficial_Keycodes[189] = SDL_SCANCODE_MINUS;
          WinRT_Unofficial_Keycodes[190] = SDL_SCANCODE_PERIOD;
          WinRT_Unofficial_Keycodes[191] = SDL_SCANCODE_SLASH;
          WinRT_Unofficial_Keycodes[192] = SDL_SCANCODE_GRAVE;
          // ?
          // ...
          // ?
          WinRT_Unofficial_Keycodes[219] = SDL_SCANCODE_LEFTBRACKET;
          WinRT_Unofficial_Keycodes[220] = SDL_SCANCODE_BACKSLASH;
          WinRT_Unofficial_Keycodes[221] = SDL_SCANCODE_RIGHTBRACKET;
          WinRT_Unofficial_Keycodes[222] = SDL_SCANCODE_APOSTROPHE;
      }
  
      /* Try to get a documented, WinRT, 'VirtualKey' first (as documented at
         http://msdn.microsoft.com/en-us/library/windows/apps/windows.system.virtualkey.aspx ).
         If that fails, fall back to a Win32 virtual key.
      */
      // TODO, WinRT: try filling out the WinRT keycode table as much as possible, using the Win32 table for interpretation hints
      //SDL_Log("WinRT TranslateKeycode, keycode=%d\n", (int)keycode);
      SDL_Scancode scancode = SDL_SCANCODE_UNKNOWN;
      if (keycode < SDL_arraysize(WinRT_Official_Keycodes)) {
          scancode = WinRT_Official_Keycodes[keycode];
      }
      if (scancode == SDL_SCANCODE_UNKNOWN) {
          if (WinRT_Unofficial_Keycodes.find(keycode) != WinRT_Unofficial_Keycodes.end()) {
              scancode = WinRT_Unofficial_Keycodes[keycode];
          }
      }
      if (scancode == SDL_SCANCODE_UNKNOWN) {
          SDL_Log("WinRT TranslateKeycode, unknown keycode=%d\n", (int)keycode);
      }
      return scancode;
  }
  
  void
  WINRT_ProcessKeyDownEvent(Windows::UI::Core::KeyEventArgs ^args)
  {
      SDL_Scancode sdlScancode = TranslateKeycode((int)args->VirtualKey);
  #if 0
      SDL_Keycode keycode = SDL_GetKeyFromScancode(sdlScancode);
      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",
          (args->Handled ? "1" : "0"),
          (args->KeyStatus.IsExtendedKey ? "1" : "0"),
          (args->KeyStatus.IsKeyReleased ? "1" : "0"),
          (args->KeyStatus.IsMenuKeyDown ? "1" : "0"),
          args->KeyStatus.RepeatCount,
          args->KeyStatus.ScanCode,
          (args->KeyStatus.WasKeyDown ? "1" : "0"),
          args->VirtualKey,
          sdlScancode,
          SDL_GetScancodeName(sdlScancode),
          keycode,
          SDL_GetKeyName(keycode));
      //args->Handled = true;
      //VirtualKey vkey = args->VirtualKey;
  #endif
      SDL_SendKeyboardKey(SDL_PRESSED, sdlScancode);
  }
  
  void
  WINRT_ProcessKeyUpEvent(Windows::UI::Core::KeyEventArgs ^args)
  {
      SDL_Scancode sdlScancode = TranslateKeycode((int)args->VirtualKey);
  #if 0
      SDL_Keycode keycode = SDL_GetKeyFromScancode(sdlScancode);
      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",
          (args->Handled ? "1" : "0"),
          (args->KeyStatus.IsExtendedKey ? "1" : "0"),
          (args->KeyStatus.IsKeyReleased ? "1" : "0"),
          (args->KeyStatus.IsMenuKeyDown ? "1" : "0"),
          args->KeyStatus.RepeatCount,
          args->KeyStatus.ScanCode,
          (args->KeyStatus.WasKeyDown ? "1" : "0"),
          args->VirtualKey,
          sdlScancode,
          SDL_GetScancodeName(sdlScancode),
          keycode,
          SDL_GetKeyName(keycode));
      //args->Handled = true;
  #endif
      SDL_SendKeyboardKey(SDL_RELEASED, sdlScancode);
  }
  
  #endif // SDL_VIDEO_DRIVER_WINRT