src/events/SDL_keyboard.c
author Sam Lantinga <slouken@libsdl.org>
Thu, 20 Jul 2017 10:46:38 -0700
changeset 11149 504c67e71589
parent 10926 97c829825e0e
child 11240 1f6105d09344
permissions -rw-r--r--
Fixed bug 3703 - Missing media keys support on Amazon Fire TV remote control

Holger Schemel

Summary: This patch adds support for key events for the "rewind" and "fast forward" media keys on the Amazon Fire TV remote control.

How to reproduce the problem: Run Android build of SDL2 application on the Amazon Fire TV (tested with "stick" version) and log key events.

Expected behaviour: Every key pressed on the Fire TV remote control should result in a corresponding key event (pressed/released).

Observed behaviour: Of the bottom row of buttons on the Fire TV remote control, only the "play/pause" (middle) button generates a key event, while the "rewind" (left) and "fast forward" (right) buttons to not generate any event at all.

The attached patch adds support for these two missing buttons/keys.

Note 1: Some missing definitions were added for the already existing key codes SDL_SCANCODE_APP1 and SDL_SCANCODE_APP2 (to keep up the correct order of enumerations / array positions when adding the two new key codes).

Note 2: Definitions in "scancodes_linux.h" and "scancodes_xfree86.h" (to also add support for these keys on other platforms) were added without testing. However, I was unable to find corresponding definitions for these two media keys for Windows and Mac OS X.

Note 3: I have also updated the (broken) link to the USB usage page standard PDF document (comment in "include/SDL_scancode.h").
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2017 Sam Lantinga <slouken@libsdl.org>
     4 
     5   This software is provided 'as-is', without any express or implied
     6   warranty.  In no event will the authors be held liable for any damages
     7   arising from the use of this software.
     8 
     9   Permission is granted to anyone to use this software for any purpose,
    10   including commercial applications, and to alter it and redistribute it
    11   freely, subject to the following restrictions:
    12 
    13   1. The origin of this software must not be misrepresented; you must not
    14      claim that you wrote the original software. If you use this software
    15      in a product, an acknowledgment in the product documentation would be
    16      appreciated but is not required.
    17   2. Altered source versions must be plainly marked as such, and must not be
    18      misrepresented as being the original software.
    19   3. This notice may not be removed or altered from any source distribution.
    20 */
    21 #include "../SDL_internal.h"
    22 
    23 /* General keyboard handling code for SDL */
    24 
    25 #include "SDL_timer.h"
    26 #include "SDL_events.h"
    27 #include "SDL_events_c.h"
    28 #include "SDL_assert.h"
    29 #include "../video/SDL_sysvideo.h"
    30 
    31 
    32 /* #define DEBUG_KEYBOARD */
    33 
    34 /* Global keyboard information */
    35 
    36 typedef struct SDL_Keyboard SDL_Keyboard;
    37 
    38 struct SDL_Keyboard
    39 {
    40     /* Data common to all keyboards */
    41     SDL_Window *focus;
    42     Uint16 modstate;
    43     Uint8 keystate[SDL_NUM_SCANCODES];
    44     SDL_Keycode keymap[SDL_NUM_SCANCODES];
    45 };
    46 
    47 static SDL_Keyboard SDL_keyboard;
    48 
    49 static const SDL_Keycode SDL_default_keymap[SDL_NUM_SCANCODES] = {
    50     0, 0, 0, 0,
    51     'a',
    52     'b',
    53     'c',
    54     'd',
    55     'e',
    56     'f',
    57     'g',
    58     'h',
    59     'i',
    60     'j',
    61     'k',
    62     'l',
    63     'm',
    64     'n',
    65     'o',
    66     'p',
    67     'q',
    68     'r',
    69     's',
    70     't',
    71     'u',
    72     'v',
    73     'w',
    74     'x',
    75     'y',
    76     'z',
    77     '1',
    78     '2',
    79     '3',
    80     '4',
    81     '5',
    82     '6',
    83     '7',
    84     '8',
    85     '9',
    86     '0',
    87     SDLK_RETURN,
    88     SDLK_ESCAPE,
    89     SDLK_BACKSPACE,
    90     SDLK_TAB,
    91     SDLK_SPACE,
    92     '-',
    93     '=',
    94     '[',
    95     ']',
    96     '\\',
    97     '#',
    98     ';',
    99     '\'',
   100     '`',
   101     ',',
   102     '.',
   103     '/',
   104     SDLK_CAPSLOCK,
   105     SDLK_F1,
   106     SDLK_F2,
   107     SDLK_F3,
   108     SDLK_F4,
   109     SDLK_F5,
   110     SDLK_F6,
   111     SDLK_F7,
   112     SDLK_F8,
   113     SDLK_F9,
   114     SDLK_F10,
   115     SDLK_F11,
   116     SDLK_F12,
   117     SDLK_PRINTSCREEN,
   118     SDLK_SCROLLLOCK,
   119     SDLK_PAUSE,
   120     SDLK_INSERT,
   121     SDLK_HOME,
   122     SDLK_PAGEUP,
   123     SDLK_DELETE,
   124     SDLK_END,
   125     SDLK_PAGEDOWN,
   126     SDLK_RIGHT,
   127     SDLK_LEFT,
   128     SDLK_DOWN,
   129     SDLK_UP,
   130     SDLK_NUMLOCKCLEAR,
   131     SDLK_KP_DIVIDE,
   132     SDLK_KP_MULTIPLY,
   133     SDLK_KP_MINUS,
   134     SDLK_KP_PLUS,
   135     SDLK_KP_ENTER,
   136     SDLK_KP_1,
   137     SDLK_KP_2,
   138     SDLK_KP_3,
   139     SDLK_KP_4,
   140     SDLK_KP_5,
   141     SDLK_KP_6,
   142     SDLK_KP_7,
   143     SDLK_KP_8,
   144     SDLK_KP_9,
   145     SDLK_KP_0,
   146     SDLK_KP_PERIOD,
   147     0,
   148     SDLK_APPLICATION,
   149     SDLK_POWER,
   150     SDLK_KP_EQUALS,
   151     SDLK_F13,
   152     SDLK_F14,
   153     SDLK_F15,
   154     SDLK_F16,
   155     SDLK_F17,
   156     SDLK_F18,
   157     SDLK_F19,
   158     SDLK_F20,
   159     SDLK_F21,
   160     SDLK_F22,
   161     SDLK_F23,
   162     SDLK_F24,
   163     SDLK_EXECUTE,
   164     SDLK_HELP,
   165     SDLK_MENU,
   166     SDLK_SELECT,
   167     SDLK_STOP,
   168     SDLK_AGAIN,
   169     SDLK_UNDO,
   170     SDLK_CUT,
   171     SDLK_COPY,
   172     SDLK_PASTE,
   173     SDLK_FIND,
   174     SDLK_MUTE,
   175     SDLK_VOLUMEUP,
   176     SDLK_VOLUMEDOWN,
   177     0, 0, 0,
   178     SDLK_KP_COMMA,
   179     SDLK_KP_EQUALSAS400,
   180     0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
   181     SDLK_ALTERASE,
   182     SDLK_SYSREQ,
   183     SDLK_CANCEL,
   184     SDLK_CLEAR,
   185     SDLK_PRIOR,
   186     SDLK_RETURN2,
   187     SDLK_SEPARATOR,
   188     SDLK_OUT,
   189     SDLK_OPER,
   190     SDLK_CLEARAGAIN,
   191     SDLK_CRSEL,
   192     SDLK_EXSEL,
   193     0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
   194     SDLK_KP_00,
   195     SDLK_KP_000,
   196     SDLK_THOUSANDSSEPARATOR,
   197     SDLK_DECIMALSEPARATOR,
   198     SDLK_CURRENCYUNIT,
   199     SDLK_CURRENCYSUBUNIT,
   200     SDLK_KP_LEFTPAREN,
   201     SDLK_KP_RIGHTPAREN,
   202     SDLK_KP_LEFTBRACE,
   203     SDLK_KP_RIGHTBRACE,
   204     SDLK_KP_TAB,
   205     SDLK_KP_BACKSPACE,
   206     SDLK_KP_A,
   207     SDLK_KP_B,
   208     SDLK_KP_C,
   209     SDLK_KP_D,
   210     SDLK_KP_E,
   211     SDLK_KP_F,
   212     SDLK_KP_XOR,
   213     SDLK_KP_POWER,
   214     SDLK_KP_PERCENT,
   215     SDLK_KP_LESS,
   216     SDLK_KP_GREATER,
   217     SDLK_KP_AMPERSAND,
   218     SDLK_KP_DBLAMPERSAND,
   219     SDLK_KP_VERTICALBAR,
   220     SDLK_KP_DBLVERTICALBAR,
   221     SDLK_KP_COLON,
   222     SDLK_KP_HASH,
   223     SDLK_KP_SPACE,
   224     SDLK_KP_AT,
   225     SDLK_KP_EXCLAM,
   226     SDLK_KP_MEMSTORE,
   227     SDLK_KP_MEMRECALL,
   228     SDLK_KP_MEMCLEAR,
   229     SDLK_KP_MEMADD,
   230     SDLK_KP_MEMSUBTRACT,
   231     SDLK_KP_MEMMULTIPLY,
   232     SDLK_KP_MEMDIVIDE,
   233     SDLK_KP_PLUSMINUS,
   234     SDLK_KP_CLEAR,
   235     SDLK_KP_CLEARENTRY,
   236     SDLK_KP_BINARY,
   237     SDLK_KP_OCTAL,
   238     SDLK_KP_DECIMAL,
   239     SDLK_KP_HEXADECIMAL,
   240     0, 0,
   241     SDLK_LCTRL,
   242     SDLK_LSHIFT,
   243     SDLK_LALT,
   244     SDLK_LGUI,
   245     SDLK_RCTRL,
   246     SDLK_RSHIFT,
   247     SDLK_RALT,
   248     SDLK_RGUI,
   249     0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
   250     SDLK_MODE,
   251     SDLK_AUDIONEXT,
   252     SDLK_AUDIOPREV,
   253     SDLK_AUDIOSTOP,
   254     SDLK_AUDIOPLAY,
   255     SDLK_AUDIOMUTE,
   256     SDLK_MEDIASELECT,
   257     SDLK_WWW,
   258     SDLK_MAIL,
   259     SDLK_CALCULATOR,
   260     SDLK_COMPUTER,
   261     SDLK_AC_SEARCH,
   262     SDLK_AC_HOME,
   263     SDLK_AC_BACK,
   264     SDLK_AC_FORWARD,
   265     SDLK_AC_STOP,
   266     SDLK_AC_REFRESH,
   267     SDLK_AC_BOOKMARKS,
   268     SDLK_BRIGHTNESSDOWN,
   269     SDLK_BRIGHTNESSUP,
   270     SDLK_DISPLAYSWITCH,
   271     SDLK_KBDILLUMTOGGLE,
   272     SDLK_KBDILLUMDOWN,
   273     SDLK_KBDILLUMUP,
   274     SDLK_EJECT,
   275     SDLK_SLEEP,
   276     SDLK_APP1,
   277     SDLK_APP2,
   278     SDLK_AUDIOREWIND,
   279     SDLK_AUDIOFASTFORWARD,
   280 };
   281 
   282 static const char *SDL_scancode_names[SDL_NUM_SCANCODES] = {
   283     NULL, NULL, NULL, NULL,
   284     "A",
   285     "B",
   286     "C",
   287     "D",
   288     "E",
   289     "F",
   290     "G",
   291     "H",
   292     "I",
   293     "J",
   294     "K",
   295     "L",
   296     "M",
   297     "N",
   298     "O",
   299     "P",
   300     "Q",
   301     "R",
   302     "S",
   303     "T",
   304     "U",
   305     "V",
   306     "W",
   307     "X",
   308     "Y",
   309     "Z",
   310     "1",
   311     "2",
   312     "3",
   313     "4",
   314     "5",
   315     "6",
   316     "7",
   317     "8",
   318     "9",
   319     "0",
   320     "Return",
   321     "Escape",
   322     "Backspace",
   323     "Tab",
   324     "Space",
   325     "-",
   326     "=",
   327     "[",
   328     "]",
   329     "\\",
   330     "#",
   331     ";",
   332     "'",
   333     "`",
   334     ",",
   335     ".",
   336     "/",
   337     "CapsLock",
   338     "F1",
   339     "F2",
   340     "F3",
   341     "F4",
   342     "F5",
   343     "F6",
   344     "F7",
   345     "F8",
   346     "F9",
   347     "F10",
   348     "F11",
   349     "F12",
   350     "PrintScreen",
   351     "ScrollLock",
   352     "Pause",
   353     "Insert",
   354     "Home",
   355     "PageUp",
   356     "Delete",
   357     "End",
   358     "PageDown",
   359     "Right",
   360     "Left",
   361     "Down",
   362     "Up",
   363     "Numlock",
   364     "Keypad /",
   365     "Keypad *",
   366     "Keypad -",
   367     "Keypad +",
   368     "Keypad Enter",
   369     "Keypad 1",
   370     "Keypad 2",
   371     "Keypad 3",
   372     "Keypad 4",
   373     "Keypad 5",
   374     "Keypad 6",
   375     "Keypad 7",
   376     "Keypad 8",
   377     "Keypad 9",
   378     "Keypad 0",
   379     "Keypad .",
   380     NULL,
   381     "Application",
   382     "Power",
   383     "Keypad =",
   384     "F13",
   385     "F14",
   386     "F15",
   387     "F16",
   388     "F17",
   389     "F18",
   390     "F19",
   391     "F20",
   392     "F21",
   393     "F22",
   394     "F23",
   395     "F24",
   396     "Execute",
   397     "Help",
   398     "Menu",
   399     "Select",
   400     "Stop",
   401     "Again",
   402     "Undo",
   403     "Cut",
   404     "Copy",
   405     "Paste",
   406     "Find",
   407     "Mute",
   408     "VolumeUp",
   409     "VolumeDown",
   410     NULL, NULL, NULL,
   411     "Keypad ,",
   412     "Keypad = (AS400)",
   413     NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
   414     NULL, NULL, NULL, NULL, NULL, NULL,
   415     "AltErase",
   416     "SysReq",
   417     "Cancel",
   418     "Clear",
   419     "Prior",
   420     "Return",
   421     "Separator",
   422     "Out",
   423     "Oper",
   424     "Clear / Again",
   425     "CrSel",
   426     "ExSel",
   427     NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
   428     "Keypad 00",
   429     "Keypad 000",
   430     "ThousandsSeparator",
   431     "DecimalSeparator",
   432     "CurrencyUnit",
   433     "CurrencySubUnit",
   434     "Keypad (",
   435     "Keypad )",
   436     "Keypad {",
   437     "Keypad }",
   438     "Keypad Tab",
   439     "Keypad Backspace",
   440     "Keypad A",
   441     "Keypad B",
   442     "Keypad C",
   443     "Keypad D",
   444     "Keypad E",
   445     "Keypad F",
   446     "Keypad XOR",
   447     "Keypad ^",
   448     "Keypad %",
   449     "Keypad <",
   450     "Keypad >",
   451     "Keypad &",
   452     "Keypad &&",
   453     "Keypad |",
   454     "Keypad ||",
   455     "Keypad :",
   456     "Keypad #",
   457     "Keypad Space",
   458     "Keypad @",
   459     "Keypad !",
   460     "Keypad MemStore",
   461     "Keypad MemRecall",
   462     "Keypad MemClear",
   463     "Keypad MemAdd",
   464     "Keypad MemSubtract",
   465     "Keypad MemMultiply",
   466     "Keypad MemDivide",
   467     "Keypad +/-",
   468     "Keypad Clear",
   469     "Keypad ClearEntry",
   470     "Keypad Binary",
   471     "Keypad Octal",
   472     "Keypad Decimal",
   473     "Keypad Hexadecimal",
   474     NULL, NULL,
   475     "Left Ctrl",
   476     "Left Shift",
   477     "Left Alt",
   478     "Left GUI",
   479     "Right Ctrl",
   480     "Right Shift",
   481     "Right Alt",
   482     "Right GUI",
   483     NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
   484     NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
   485     NULL,
   486     "ModeSwitch",
   487     "AudioNext",
   488     "AudioPrev",
   489     "AudioStop",
   490     "AudioPlay",
   491     "AudioMute",
   492     "MediaSelect",
   493     "WWW",
   494     "Mail",
   495     "Calculator",
   496     "Computer",
   497     "AC Search",
   498     "AC Home",
   499     "AC Back",
   500     "AC Forward",
   501     "AC Stop",
   502     "AC Refresh",
   503     "AC Bookmarks",
   504     "BrightnessDown",
   505     "BrightnessUp",
   506     "DisplaySwitch",
   507     "KBDIllumToggle",
   508     "KBDIllumDown",
   509     "KBDIllumUp",
   510     "Eject",
   511     "Sleep",
   512     "App1",
   513     "App2",
   514     "AudioRewind",
   515     "AudioFastForward",
   516 };
   517 
   518 /* Taken from SDL_iconv() */
   519 char *
   520 SDL_UCS4ToUTF8(Uint32 ch, char *dst)
   521 {
   522     Uint8 *p = (Uint8 *) dst;
   523     if (ch <= 0x7F) {
   524         *p = (Uint8) ch;
   525         ++dst;
   526     } else if (ch <= 0x7FF) {
   527         p[0] = 0xC0 | (Uint8) ((ch >> 6) & 0x1F);
   528         p[1] = 0x80 | (Uint8) (ch & 0x3F);
   529         dst += 2;
   530     } else if (ch <= 0xFFFF) {
   531         p[0] = 0xE0 | (Uint8) ((ch >> 12) & 0x0F);
   532         p[1] = 0x80 | (Uint8) ((ch >> 6) & 0x3F);
   533         p[2] = 0x80 | (Uint8) (ch & 0x3F);
   534         dst += 3;
   535     } else if (ch <= 0x1FFFFF) {
   536         p[0] = 0xF0 | (Uint8) ((ch >> 18) & 0x07);
   537         p[1] = 0x80 | (Uint8) ((ch >> 12) & 0x3F);
   538         p[2] = 0x80 | (Uint8) ((ch >> 6) & 0x3F);
   539         p[3] = 0x80 | (Uint8) (ch & 0x3F);
   540         dst += 4;
   541     } else if (ch <= 0x3FFFFFF) {
   542         p[0] = 0xF8 | (Uint8) ((ch >> 24) & 0x03);
   543         p[1] = 0x80 | (Uint8) ((ch >> 18) & 0x3F);
   544         p[2] = 0x80 | (Uint8) ((ch >> 12) & 0x3F);
   545         p[3] = 0x80 | (Uint8) ((ch >> 6) & 0x3F);
   546         p[4] = 0x80 | (Uint8) (ch & 0x3F);
   547         dst += 5;
   548     } else {
   549         p[0] = 0xFC | (Uint8) ((ch >> 30) & 0x01);
   550         p[1] = 0x80 | (Uint8) ((ch >> 24) & 0x3F);
   551         p[2] = 0x80 | (Uint8) ((ch >> 18) & 0x3F);
   552         p[3] = 0x80 | (Uint8) ((ch >> 12) & 0x3F);
   553         p[4] = 0x80 | (Uint8) ((ch >> 6) & 0x3F);
   554         p[5] = 0x80 | (Uint8) (ch & 0x3F);
   555         dst += 6;
   556     }
   557     return dst;
   558 }
   559 
   560 /* Public functions */
   561 int
   562 SDL_KeyboardInit(void)
   563 {
   564     SDL_Keyboard *keyboard = &SDL_keyboard;
   565 
   566     /* Set the default keymap */
   567     SDL_memcpy(keyboard->keymap, SDL_default_keymap, sizeof(SDL_default_keymap));
   568     return (0);
   569 }
   570 
   571 void
   572 SDL_ResetKeyboard(void)
   573 {
   574     SDL_Keyboard *keyboard = &SDL_keyboard;
   575     SDL_Scancode scancode;
   576 
   577 #ifdef DEBUG_KEYBOARD
   578     printf("Resetting keyboard\n");
   579 #endif
   580     for (scancode = (SDL_Scancode) 0; scancode < SDL_NUM_SCANCODES; ++scancode) {
   581         if (keyboard->keystate[scancode] == SDL_PRESSED) {
   582             SDL_SendKeyboardKey(SDL_RELEASED, scancode);
   583         }
   584     }
   585 }
   586 
   587 void
   588 SDL_GetDefaultKeymap(SDL_Keycode * keymap)
   589 {
   590     SDL_memcpy(keymap, SDL_default_keymap, sizeof(SDL_default_keymap));
   591 }
   592 
   593 void
   594 SDL_SetKeymap(int start, SDL_Keycode * keys, int length)
   595 {
   596     SDL_Keyboard *keyboard = &SDL_keyboard;
   597 
   598     if (start < 0 || start + length > SDL_NUM_SCANCODES) {
   599         return;
   600     }
   601 
   602     SDL_memcpy(&keyboard->keymap[start], keys, sizeof(*keys) * length);
   603 }
   604 
   605 void
   606 SDL_SetScancodeName(SDL_Scancode scancode, const char *name)
   607 {
   608     SDL_scancode_names[scancode] = name;
   609 }
   610 
   611 SDL_Window *
   612 SDL_GetKeyboardFocus(void)
   613 {
   614     SDL_Keyboard *keyboard = &SDL_keyboard;
   615 
   616     return keyboard->focus;
   617 }
   618 
   619 void
   620 SDL_SetKeyboardFocus(SDL_Window * window)
   621 {
   622     SDL_Keyboard *keyboard = &SDL_keyboard;
   623 
   624     if (keyboard->focus && !window) {
   625         /* We won't get anymore keyboard messages, so reset keyboard state */
   626         SDL_ResetKeyboard();
   627     }
   628 
   629     /* See if the current window has lost focus */
   630     if (keyboard->focus && keyboard->focus != window) {
   631 
   632         /* new window shouldn't think it has mouse captured. */
   633         SDL_assert(!window || !(window->flags & SDL_WINDOW_MOUSE_CAPTURE));
   634 
   635         /* old window must lose an existing mouse capture. */
   636         if (keyboard->focus->flags & SDL_WINDOW_MOUSE_CAPTURE) {
   637             SDL_CaptureMouse(SDL_FALSE);  /* drop the capture. */
   638             SDL_assert(!(keyboard->focus->flags & SDL_WINDOW_MOUSE_CAPTURE));
   639         }
   640 
   641         SDL_SendWindowEvent(keyboard->focus, SDL_WINDOWEVENT_FOCUS_LOST,
   642                             0, 0);
   643 
   644         /* Ensures IME compositions are committed */
   645         if (SDL_EventState(SDL_TEXTINPUT, SDL_QUERY)) {
   646             SDL_VideoDevice *video = SDL_GetVideoDevice();
   647             if (video && video->StopTextInput) {
   648                 video->StopTextInput(video);
   649             }
   650         }
   651     }
   652 
   653     keyboard->focus = window;
   654 
   655     if (keyboard->focus) {
   656         SDL_SendWindowEvent(keyboard->focus, SDL_WINDOWEVENT_FOCUS_GAINED,
   657                             0, 0);
   658 
   659         if (SDL_EventState(SDL_TEXTINPUT, SDL_QUERY)) {
   660             SDL_VideoDevice *video = SDL_GetVideoDevice();
   661             if (video && video->StartTextInput) {
   662                 video->StartTextInput(video);
   663             }
   664         }
   665     }
   666 }
   667 
   668 int
   669 SDL_SendKeyboardKey(Uint8 state, SDL_Scancode scancode)
   670 {
   671     SDL_Keyboard *keyboard = &SDL_keyboard;
   672     int posted;
   673     SDL_Keymod modifier;
   674     SDL_Keycode keycode;
   675     Uint16 modstate;
   676     Uint32 type;
   677     Uint8 repeat;
   678 
   679     if (!scancode) {
   680         return 0;
   681     }
   682 #ifdef DEBUG_KEYBOARD
   683     printf("The '%s' key has been %s\n", SDL_GetScancodeName(scancode),
   684            state == SDL_PRESSED ? "pressed" : "released");
   685 #endif
   686 
   687     /* Figure out what type of event this is */
   688     switch (state) {
   689     case SDL_PRESSED:
   690         type = SDL_KEYDOWN;
   691         break;
   692     case SDL_RELEASED:
   693         type = SDL_KEYUP;
   694         break;
   695     default:
   696         /* Invalid state -- bail */
   697         return 0;
   698     }
   699 
   700     /* Drop events that don't change state */
   701     repeat = (state && keyboard->keystate[scancode]);
   702     if (keyboard->keystate[scancode] == state && !repeat) {
   703 #if 0
   704         printf("Keyboard event didn't change state - dropped!\n");
   705 #endif
   706         return 0;
   707     }
   708 
   709     /* Update internal keyboard state */
   710     keyboard->keystate[scancode] = state;
   711 
   712     keycode = keyboard->keymap[scancode];
   713 
   714     /* Update modifiers state if applicable */
   715     switch (keycode) {
   716     case SDLK_LCTRL:
   717         modifier = KMOD_LCTRL;
   718         break;
   719     case SDLK_RCTRL:
   720         modifier = KMOD_RCTRL;
   721         break;
   722     case SDLK_LSHIFT:
   723         modifier = KMOD_LSHIFT;
   724         break;
   725     case SDLK_RSHIFT:
   726         modifier = KMOD_RSHIFT;
   727         break;
   728     case SDLK_LALT:
   729         modifier = KMOD_LALT;
   730         break;
   731     case SDLK_RALT:
   732         modifier = KMOD_RALT;
   733         break;
   734     case SDLK_LGUI:
   735         modifier = KMOD_LGUI;
   736         break;
   737     case SDLK_RGUI:
   738         modifier = KMOD_RGUI;
   739         break;
   740     case SDLK_MODE:
   741         modifier = KMOD_MODE;
   742         break;
   743     default:
   744         modifier = KMOD_NONE;
   745         break;
   746     }
   747     if (SDL_KEYDOWN == type) {
   748         modstate = keyboard->modstate;
   749         switch (keycode) {
   750         case SDLK_NUMLOCKCLEAR:
   751             keyboard->modstate ^= KMOD_NUM;
   752             break;
   753         case SDLK_CAPSLOCK:
   754             keyboard->modstate ^= KMOD_CAPS;
   755             break;
   756         default:
   757             keyboard->modstate |= modifier;
   758             break;
   759         }
   760     } else {
   761         keyboard->modstate &= ~modifier;
   762         modstate = keyboard->modstate;
   763     }
   764 
   765     /* Post the event, if desired */
   766     posted = 0;
   767     if (SDL_GetEventState(type) == SDL_ENABLE) {
   768         SDL_Event event;
   769         event.key.type = type;
   770         event.key.state = state;
   771         event.key.repeat = repeat;
   772         event.key.keysym.scancode = scancode;
   773         event.key.keysym.sym = keycode;
   774         event.key.keysym.mod = modstate;
   775         event.key.windowID = keyboard->focus ? keyboard->focus->id : 0;
   776         posted = (SDL_PushEvent(&event) > 0);
   777     }
   778     return (posted);
   779 }
   780 
   781 int
   782 SDL_SendKeyboardText(const char *text)
   783 {
   784     SDL_Keyboard *keyboard = &SDL_keyboard;
   785     int posted;
   786 
   787     /* Don't post text events for unprintable characters */
   788     if ((unsigned char)*text < ' ' || *text == 127) {
   789         return 0;
   790     }
   791 
   792     /* Post the event, if desired */
   793     posted = 0;
   794     if (SDL_GetEventState(SDL_TEXTINPUT) == SDL_ENABLE) {
   795         SDL_Event event;
   796         event.text.type = SDL_TEXTINPUT;
   797         event.text.windowID = keyboard->focus ? keyboard->focus->id : 0;
   798         SDL_utf8strlcpy(event.text.text, text, SDL_arraysize(event.text.text));
   799         posted = (SDL_PushEvent(&event) > 0);
   800     }
   801     return (posted);
   802 }
   803 
   804 int
   805 SDL_SendEditingText(const char *text, int start, int length)
   806 {
   807     SDL_Keyboard *keyboard = &SDL_keyboard;
   808     int posted;
   809 
   810     /* Post the event, if desired */
   811     posted = 0;
   812     if (SDL_GetEventState(SDL_TEXTEDITING) == SDL_ENABLE) {
   813         SDL_Event event;
   814         event.edit.type = SDL_TEXTEDITING;
   815         event.edit.windowID = keyboard->focus ? keyboard->focus->id : 0;
   816         event.edit.start = start;
   817         event.edit.length = length;
   818         SDL_utf8strlcpy(event.edit.text, text, SDL_arraysize(event.edit.text));
   819         posted = (SDL_PushEvent(&event) > 0);
   820     }
   821     return (posted);
   822 }
   823 
   824 void
   825 SDL_KeyboardQuit(void)
   826 {
   827 }
   828 
   829 const Uint8 *
   830 SDL_GetKeyboardState(int *numkeys)
   831 {
   832     SDL_Keyboard *keyboard = &SDL_keyboard;
   833 
   834     if (numkeys != (int *) 0) {
   835         *numkeys = SDL_NUM_SCANCODES;
   836     }
   837     return keyboard->keystate;
   838 }
   839 
   840 SDL_Keymod
   841 SDL_GetModState(void)
   842 {
   843     SDL_Keyboard *keyboard = &SDL_keyboard;
   844 
   845     return (SDL_Keymod) keyboard->modstate;
   846 }
   847 
   848 void
   849 SDL_SetModState(SDL_Keymod modstate)
   850 {
   851     SDL_Keyboard *keyboard = &SDL_keyboard;
   852 
   853     keyboard->modstate = modstate;
   854 }
   855 
   856 /* Note that SDL_ToggleModState() is not a public API. SDL_SetModState() is. */
   857 void
   858 SDL_ToggleModState(const SDL_Keymod modstate, const SDL_bool toggle)
   859 {
   860     SDL_Keyboard *keyboard = &SDL_keyboard;
   861     if (toggle) {
   862         keyboard->modstate |= modstate;
   863     } else {
   864         keyboard->modstate &= ~modstate;
   865     }
   866 }
   867 
   868 
   869 SDL_Keycode
   870 SDL_GetKeyFromScancode(SDL_Scancode scancode)
   871 {
   872     SDL_Keyboard *keyboard = &SDL_keyboard;
   873 
   874     if (((int)scancode) < ((int)SDL_SCANCODE_UNKNOWN) || scancode >= SDL_NUM_SCANCODES) {
   875           SDL_InvalidParamError("scancode");
   876           return 0;
   877     }
   878 
   879     return keyboard->keymap[scancode];
   880 }
   881 
   882 SDL_Scancode
   883 SDL_GetScancodeFromKey(SDL_Keycode key)
   884 {
   885     SDL_Keyboard *keyboard = &SDL_keyboard;
   886     SDL_Scancode scancode;
   887 
   888     for (scancode = SDL_SCANCODE_UNKNOWN; scancode < SDL_NUM_SCANCODES;
   889          ++scancode) {
   890         if (keyboard->keymap[scancode] == key) {
   891             return scancode;
   892         }
   893     }
   894     return SDL_SCANCODE_UNKNOWN;
   895 }
   896 
   897 const char *
   898 SDL_GetScancodeName(SDL_Scancode scancode)
   899 {
   900     const char *name;
   901     if (((int)scancode) < ((int)SDL_SCANCODE_UNKNOWN) || scancode >= SDL_NUM_SCANCODES) {
   902           SDL_InvalidParamError("scancode");
   903           return "";
   904     }
   905 
   906     name = SDL_scancode_names[scancode];
   907     if (name)
   908         return name;
   909     else
   910         return "";
   911 }
   912 
   913 SDL_Scancode SDL_GetScancodeFromName(const char *name)
   914 {
   915     int i;
   916 
   917     if (!name || !*name) {
   918             SDL_InvalidParamError("name");
   919         return SDL_SCANCODE_UNKNOWN;
   920     }
   921 
   922     for (i = 0; i < SDL_arraysize(SDL_scancode_names); ++i) {
   923         if (!SDL_scancode_names[i]) {
   924             continue;
   925         }
   926         if (SDL_strcasecmp(name, SDL_scancode_names[i]) == 0) {
   927             return (SDL_Scancode)i;
   928         }
   929     }
   930 
   931     SDL_InvalidParamError("name");
   932     return SDL_SCANCODE_UNKNOWN;
   933 }
   934 
   935 const char *
   936 SDL_GetKeyName(SDL_Keycode key)
   937 {
   938     static char name[8];
   939     char *end;
   940 
   941     if (key & SDLK_SCANCODE_MASK) {
   942         return
   943             SDL_GetScancodeName((SDL_Scancode) (key & ~SDLK_SCANCODE_MASK));
   944     }
   945 
   946     switch (key) {
   947     case SDLK_RETURN:
   948         return SDL_GetScancodeName(SDL_SCANCODE_RETURN);
   949     case SDLK_ESCAPE:
   950         return SDL_GetScancodeName(SDL_SCANCODE_ESCAPE);
   951     case SDLK_BACKSPACE:
   952         return SDL_GetScancodeName(SDL_SCANCODE_BACKSPACE);
   953     case SDLK_TAB:
   954         return SDL_GetScancodeName(SDL_SCANCODE_TAB);
   955     case SDLK_SPACE:
   956         return SDL_GetScancodeName(SDL_SCANCODE_SPACE);
   957     case SDLK_DELETE:
   958         return SDL_GetScancodeName(SDL_SCANCODE_DELETE);
   959     default:
   960         /* Unaccented letter keys on latin keyboards are normally
   961            labeled in upper case (and probably on others like Greek or
   962            Cyrillic too, so if you happen to know for sure, please
   963            adapt this). */
   964         if (key >= 'a' && key <= 'z') {
   965             key -= 32;
   966         }
   967 
   968         end = SDL_UCS4ToUTF8((Uint32) key, name);
   969         *end = '\0';
   970         return name;
   971     }
   972 }
   973 
   974 SDL_Keycode
   975 SDL_GetKeyFromName(const char *name)
   976 {
   977     SDL_Keycode key;
   978 
   979     /* Check input */
   980     if (name == NULL) {
   981         return SDLK_UNKNOWN;
   982     }
   983 
   984     /* If it's a single UTF-8 character, then that's the keycode itself */
   985     key = *(const unsigned char *)name;
   986     if (key >= 0xF0) {
   987         if (SDL_strlen(name) == 4) {
   988             int i = 0;
   989             key  = (Uint16)(name[i]&0x07) << 18;
   990             key |= (Uint16)(name[++i]&0x3F) << 12;
   991             key |= (Uint16)(name[++i]&0x3F) << 6;
   992             key |= (Uint16)(name[++i]&0x3F);
   993             return key;
   994         }
   995         return SDLK_UNKNOWN;
   996     } else if (key >= 0xE0) {
   997         if (SDL_strlen(name) == 3) {
   998             int i = 0;
   999             key  = (Uint16)(name[i]&0x0F) << 12;
  1000             key |= (Uint16)(name[++i]&0x3F) << 6;
  1001             key |= (Uint16)(name[++i]&0x3F);
  1002             return key;
  1003         }
  1004         return SDLK_UNKNOWN;
  1005     } else if (key >= 0xC0) {
  1006         if (SDL_strlen(name) == 2) {
  1007             int i = 0;
  1008             key  = (Uint16)(name[i]&0x1F) << 6;
  1009             key |= (Uint16)(name[++i]&0x3F);
  1010             return key;
  1011         }
  1012         return SDLK_UNKNOWN;
  1013     } else {
  1014         if (SDL_strlen(name) == 1) {
  1015             if (key >= 'A' && key <= 'Z') {
  1016                 key += 32;
  1017             }
  1018             return key;
  1019         }
  1020 
  1021         /* Get the scancode for this name, and the associated keycode */
  1022         return SDL_default_keymap[SDL_GetScancodeFromName(name)];
  1023     }
  1024 }
  1025 
  1026 /* vi: set ts=4 sw=4 expandtab: */