src/video/x11/SDL_x11keyboard.c
author Sam Lantinga
Sun, 02 Feb 2014 00:53:27 -0800
changeset 8149 681eb46b8ac4
parent 8093 b43765095a6f
child 8667 fb44c438a3e5
permissions -rw-r--r--
Fixed bug 2374 - Update copyright for 2014...

Is it that time already??
slouken@1950
     1
/*
slouken@5535
     2
  Simple DirectMedia Layer
slouken@8149
     3
  Copyright (C) 1997-2014 Sam Lantinga <slouken@libsdl.org>
slouken@1950
     4
slouken@5535
     5
  This software is provided 'as-is', without any express or implied
slouken@5535
     6
  warranty.  In no event will the authors be held liable for any damages
slouken@5535
     7
  arising from the use of this software.
slouken@1950
     8
slouken@5535
     9
  Permission is granted to anyone to use this software for any purpose,
slouken@5535
    10
  including commercial applications, and to alter it and redistribute it
slouken@5535
    11
  freely, subject to the following restrictions:
slouken@1950
    12
slouken@5535
    13
  1. The origin of this software must not be misrepresented; you must not
slouken@5535
    14
     claim that you wrote the original software. If you use this software
slouken@5535
    15
     in a product, an acknowledgment in the product documentation would be
slouken@5535
    16
     appreciated but is not required.
slouken@5535
    17
  2. Altered source versions must be plainly marked as such, and must not be
slouken@5535
    18
     misrepresented as being the original software.
slouken@5535
    19
  3. This notice may not be removed or altered from any source distribution.
slouken@1950
    20
*/
icculus@8093
    21
#include "../../SDL_internal.h"
slouken@1950
    22
slouken@5481
    23
#if SDL_VIDEO_DRIVER_X11
slouken@5481
    24
slouken@1950
    25
#include "SDL_x11video.h"
slouken@1950
    26
slouken@1950
    27
#include "../../events/SDL_keyboard_c.h"
slouken@2305
    28
#include "../../events/scancodes_darwin.h"
slouken@2305
    29
#include "../../events/scancodes_xfree86.h"
slouken@1950
    30
bob@2295
    31
#include <X11/keysym.h>
bob@2295
    32
bob@2295
    33
#include "imKStoUCS.h"
bob@2295
    34
slouken@3001
    35
/* *INDENT-OFF* */
slouken@3162
    36
static const struct {
slouken@3001
    37
    KeySym keysym;
slouken@7580
    38
    SDL_Scancode scancode;
slouken@7580
    39
} KeySymToSDLScancode[] = {
slouken@7580
    40
    { XK_Return, SDL_SCANCODE_RETURN },
slouken@7580
    41
    { XK_Escape, SDL_SCANCODE_ESCAPE },
slouken@7580
    42
    { XK_BackSpace, SDL_SCANCODE_BACKSPACE },
slouken@7580
    43
    { XK_Tab, SDL_SCANCODE_TAB },
slouken@7580
    44
    { XK_Caps_Lock, SDL_SCANCODE_CAPSLOCK },
slouken@7580
    45
    { XK_F1, SDL_SCANCODE_F1 },
slouken@7580
    46
    { XK_F2, SDL_SCANCODE_F2 },
slouken@7580
    47
    { XK_F3, SDL_SCANCODE_F3 },
slouken@7580
    48
    { XK_F4, SDL_SCANCODE_F4 },
slouken@7580
    49
    { XK_F5, SDL_SCANCODE_F5 },
slouken@7580
    50
    { XK_F6, SDL_SCANCODE_F6 },
slouken@7580
    51
    { XK_F7, SDL_SCANCODE_F7 },
slouken@7580
    52
    { XK_F8, SDL_SCANCODE_F8 },
slouken@7580
    53
    { XK_F9, SDL_SCANCODE_F9 },
slouken@7580
    54
    { XK_F10, SDL_SCANCODE_F10 },
slouken@7580
    55
    { XK_F11, SDL_SCANCODE_F11 },
slouken@7580
    56
    { XK_F12, SDL_SCANCODE_F12 },
slouken@7580
    57
    { XK_Print, SDL_SCANCODE_PRINTSCREEN },
slouken@7580
    58
    { XK_Scroll_Lock, SDL_SCANCODE_SCROLLLOCK },
slouken@7580
    59
    { XK_Pause, SDL_SCANCODE_PAUSE },
slouken@7580
    60
    { XK_Insert, SDL_SCANCODE_INSERT },
slouken@7580
    61
    { XK_Home, SDL_SCANCODE_HOME },
slouken@7580
    62
    { XK_Prior, SDL_SCANCODE_PAGEUP },
slouken@7580
    63
    { XK_Delete, SDL_SCANCODE_DELETE },
slouken@7580
    64
    { XK_End, SDL_SCANCODE_END },
slouken@7580
    65
    { XK_Next, SDL_SCANCODE_PAGEDOWN },
slouken@7580
    66
    { XK_Right, SDL_SCANCODE_RIGHT },
slouken@7580
    67
    { XK_Left, SDL_SCANCODE_LEFT },
slouken@7580
    68
    { XK_Down, SDL_SCANCODE_DOWN },
slouken@7580
    69
    { XK_Up, SDL_SCANCODE_UP },
slouken@7580
    70
    { XK_Num_Lock, SDL_SCANCODE_NUMLOCKCLEAR },
slouken@7580
    71
    { XK_KP_Divide, SDL_SCANCODE_KP_DIVIDE },
slouken@7580
    72
    { XK_KP_Multiply, SDL_SCANCODE_KP_MULTIPLY },
slouken@7580
    73
    { XK_KP_Subtract, SDL_SCANCODE_KP_MINUS },
slouken@7580
    74
    { XK_KP_Add, SDL_SCANCODE_KP_PLUS },
slouken@7580
    75
    { XK_KP_Enter, SDL_SCANCODE_KP_ENTER },
slouken@7580
    76
    { XK_KP_Delete, SDL_SCANCODE_KP_PERIOD },
slouken@7580
    77
    { XK_KP_End, SDL_SCANCODE_KP_1 },
slouken@7580
    78
    { XK_KP_Down, SDL_SCANCODE_KP_2 },
slouken@7580
    79
    { XK_KP_Next, SDL_SCANCODE_KP_3 },
slouken@7580
    80
    { XK_KP_Left, SDL_SCANCODE_KP_4 },
slouken@7580
    81
    { XK_KP_Begin, SDL_SCANCODE_KP_5 },
slouken@7580
    82
    { XK_KP_Right, SDL_SCANCODE_KP_6 },
slouken@7580
    83
    { XK_KP_Home, SDL_SCANCODE_KP_7 },
slouken@7580
    84
    { XK_KP_Up, SDL_SCANCODE_KP_8 },
slouken@7580
    85
    { XK_KP_Prior, SDL_SCANCODE_KP_9 },
slouken@7580
    86
    { XK_KP_Insert, SDL_SCANCODE_KP_0 },
slouken@7580
    87
    { XK_KP_Decimal, SDL_SCANCODE_KP_PERIOD },
slouken@7580
    88
    { XK_KP_1, SDL_SCANCODE_KP_1 },
slouken@7580
    89
    { XK_KP_2, SDL_SCANCODE_KP_2 },
slouken@7580
    90
    { XK_KP_3, SDL_SCANCODE_KP_3 },
slouken@7580
    91
    { XK_KP_4, SDL_SCANCODE_KP_4 },
slouken@7580
    92
    { XK_KP_5, SDL_SCANCODE_KP_5 },
slouken@7580
    93
    { XK_KP_6, SDL_SCANCODE_KP_6 },
slouken@7580
    94
    { XK_KP_7, SDL_SCANCODE_KP_7 },
slouken@7580
    95
    { XK_KP_8, SDL_SCANCODE_KP_8 },
slouken@7580
    96
    { XK_KP_9, SDL_SCANCODE_KP_9 },
slouken@7580
    97
    { XK_KP_0, SDL_SCANCODE_KP_0 },
slouken@7580
    98
    { XK_KP_Decimal, SDL_SCANCODE_KP_PERIOD },
slouken@7580
    99
    { XK_Hyper_R, SDL_SCANCODE_APPLICATION },
slouken@7580
   100
    { XK_KP_Equal, SDL_SCANCODE_KP_EQUALS },
slouken@7580
   101
    { XK_F13, SDL_SCANCODE_F13 },
slouken@7580
   102
    { XK_F14, SDL_SCANCODE_F14 },
slouken@7580
   103
    { XK_F15, SDL_SCANCODE_F15 },
slouken@7580
   104
    { XK_F16, SDL_SCANCODE_F16 },
slouken@7580
   105
    { XK_F17, SDL_SCANCODE_F17 },
slouken@7580
   106
    { XK_F18, SDL_SCANCODE_F18 },
slouken@7580
   107
    { XK_F19, SDL_SCANCODE_F19 },
slouken@7580
   108
    { XK_F20, SDL_SCANCODE_F20 },
slouken@7580
   109
    { XK_F21, SDL_SCANCODE_F21 },
slouken@7580
   110
    { XK_F22, SDL_SCANCODE_F22 },
slouken@7580
   111
    { XK_F23, SDL_SCANCODE_F23 },
slouken@7580
   112
    { XK_F24, SDL_SCANCODE_F24 },
slouken@7580
   113
    { XK_Execute, SDL_SCANCODE_EXECUTE },
slouken@7580
   114
    { XK_Help, SDL_SCANCODE_HELP },
slouken@7580
   115
    { XK_Menu, SDL_SCANCODE_MENU },
slouken@7580
   116
    { XK_Select, SDL_SCANCODE_SELECT },
slouken@7580
   117
    { XK_Cancel, SDL_SCANCODE_STOP },
slouken@7580
   118
    { XK_Redo, SDL_SCANCODE_AGAIN },
slouken@7580
   119
    { XK_Undo, SDL_SCANCODE_UNDO },
slouken@7580
   120
    { XK_Find, SDL_SCANCODE_FIND },
slouken@7580
   121
    { XK_KP_Separator, SDL_SCANCODE_KP_COMMA },
slouken@7580
   122
    { XK_Sys_Req, SDL_SCANCODE_SYSREQ },
slouken@7580
   123
    { XK_Control_L, SDL_SCANCODE_LCTRL },
slouken@7580
   124
    { XK_Shift_L, SDL_SCANCODE_LSHIFT },
slouken@7580
   125
    { XK_Alt_L, SDL_SCANCODE_LALT },
slouken@7580
   126
    { XK_Meta_L, SDL_SCANCODE_LGUI },
slouken@7580
   127
    { XK_Super_L, SDL_SCANCODE_LGUI },
slouken@7580
   128
    { XK_Control_R, SDL_SCANCODE_RCTRL },
slouken@7580
   129
    { XK_Shift_R, SDL_SCANCODE_RSHIFT },
slouken@7580
   130
    { XK_Alt_R, SDL_SCANCODE_RALT },
slouken@7580
   131
    { XK_Meta_R, SDL_SCANCODE_RGUI },
slouken@7580
   132
    { XK_Super_R, SDL_SCANCODE_RGUI },
slouken@7580
   133
    { XK_Mode_switch, SDL_SCANCODE_MODE },
bob@2295
   134
};
bob@2295
   135
slouken@3162
   136
static const struct
bob@2295
   137
{
slouken@7882
   138
    SDL_Scancode const *table;
slouken@2305
   139
    int table_size;
slouken@2305
   140
} scancode_set[] = {
slouken@2308
   141
    { darwin_scancode_table, SDL_arraysize(darwin_scancode_table) },
slouken@2308
   142
    { xfree86_scancode_table, SDL_arraysize(xfree86_scancode_table) },
slouken@2825
   143
    { xfree86_scancode_table2, SDL_arraysize(xfree86_scancode_table2) },
slouken@2308
   144
};
slouken@2308
   145
/* *INDENT-OFF* */
bob@2295
   146
slouken@7580
   147
/* This function only works for keyboards in US QWERTY layout */
slouken@7580
   148
static SDL_Scancode
slouken@7580
   149
X11_KeyCodeToSDLScancode(Display *display, KeyCode keycode)
slouken@3001
   150
{
slouken@3001
   151
    KeySym keysym;
slouken@3001
   152
    int i;
slouken@3001
   153
dimitris@6318
   154
#if SDL_VIDEO_DRIVER_X11_HAS_XKBKEYCODETOKEYSYM
icculus@7827
   155
    keysym = X11_XkbKeycodeToKeysym(display, keycode, 0, 0);
dimitris@6318
   156
#else
slouken@3001
   157
    keysym = XKeycodeToKeysym(display, keycode, 0);
dimitris@6318
   158
#endif
slouken@3001
   159
    if (keysym == NoSymbol) {
slouken@7580
   160
        return SDL_SCANCODE_UNKNOWN;
slouken@7580
   161
    }
slouken@7580
   162
slouken@7580
   163
    if (keysym >= XK_A && keysym <= XK_Z) {
slouken@7580
   164
        return SDL_SCANCODE_A + (keysym - XK_A);
slouken@7580
   165
    }
slouken@7580
   166
slouken@7580
   167
    if (keysym >= XK_0 && keysym <= XK_9) {
slouken@7580
   168
        return SDL_SCANCODE_0 + (keysym - XK_0);
slouken@3001
   169
    }
slouken@3001
   170
slouken@7580
   171
    for (i = 0; i < SDL_arraysize(KeySymToSDLScancode); ++i) {
slouken@7580
   172
        if (keysym == KeySymToSDLScancode[i].keysym) {
slouken@7580
   173
            return KeySymToSDLScancode[i].scancode;
slouken@7580
   174
        }
slouken@7580
   175
    }
slouken@7580
   176
    return SDL_SCANCODE_UNKNOWN;
slouken@7580
   177
}
slouken@7580
   178
slouken@7580
   179
static Uint32
slouken@7580
   180
X11_KeyCodeToUcs4(Display *display, KeyCode keycode)
slouken@7580
   181
{
slouken@7580
   182
    KeySym keysym;
slouken@7580
   183
slouken@7580
   184
#if SDL_VIDEO_DRIVER_X11_HAS_XKBKEYCODETOKEYSYM
icculus@7827
   185
    keysym = X11_XkbKeycodeToKeysym(display, keycode, 0, 0);
slouken@7580
   186
#else
slouken@7580
   187
    keysym = XKeycodeToKeysym(display, keycode, 0);
slouken@7580
   188
#endif
slouken@7580
   189
    if (keysym == NoSymbol) {
slouken@7580
   190
        return 0;
slouken@3001
   191
    }
slouken@3001
   192
slouken@7580
   193
    return X11_KeySymToUcs4(keysym);
slouken@3001
   194
}
slouken@3001
   195
bob@2295
   196
int
slouken@1950
   197
X11_InitKeyboard(_THIS)
slouken@1950
   198
{
slouken@1950
   199
    SDL_VideoData *data = (SDL_VideoData *) _this->driverdata;
icculus@7672
   200
    int i = 0;
icculus@7672
   201
    int j = 0;
slouken@2305
   202
    int min_keycode, max_keycode;
slouken@3001
   203
    struct {
slouken@5218
   204
        SDL_Scancode scancode;
slouken@3001
   205
        KeySym keysym;
slouken@3001
   206
        int value;
slouken@3001
   207
    } fingerprint[] = {
slouken@3001
   208
        { SDL_SCANCODE_HOME, XK_Home, 0 },
slouken@3001
   209
        { SDL_SCANCODE_PAGEUP, XK_Prior, 0 },
slouken@3001
   210
        { SDL_SCANCODE_PAGEDOWN, XK_Next, 0 },
slouken@2305
   211
    };
slouken@2305
   212
    SDL_bool fingerprint_detected;
bob@2295
   213
icculus@7827
   214
    X11_XAutoRepeatOn(data->display);
bob@2299
   215
slouken@2305
   216
    /* Try to determine which scancodes are being used based on fingerprint */
slouken@2305
   217
    fingerprint_detected = SDL_FALSE;
icculus@7827
   218
    X11_XDisplayKeycodes(data->display, &min_keycode, &max_keycode);
slouken@3001
   219
    for (i = 0; i < SDL_arraysize(fingerprint); ++i) {
slouken@3001
   220
        fingerprint[i].value =
icculus@7827
   221
            X11_XKeysymToKeycode(data->display, fingerprint[i].keysym) -
slouken@2305
   222
            min_keycode;
slouken@2305
   223
    }
slouken@2305
   224
    for (i = 0; i < SDL_arraysize(scancode_set); ++i) {
slouken@2305
   225
        /* Make sure the scancode set isn't too big */
slouken@2305
   226
        if ((max_keycode - min_keycode + 1) <= scancode_set[i].table_size) {
slouken@2305
   227
            continue;
slouken@2305
   228
        }
slouken@2305
   229
        for (j = 0; j < SDL_arraysize(fingerprint); ++j) {
slouken@3001
   230
            if (fingerprint[j].value < 0
slouken@3001
   231
                || fingerprint[j].value >= scancode_set[i].table_size) {
slouken@2305
   232
                break;
slouken@2305
   233
            }
slouken@3001
   234
            if (scancode_set[i].table[fingerprint[j].value] !=
slouken@3001
   235
                fingerprint[j].scancode) {
bob@2295
   236
                break;
bob@2295
   237
            }
bob@2295
   238
        }
slouken@2305
   239
        if (j == SDL_arraysize(fingerprint)) {
slouken@4535
   240
#ifdef DEBUG_KEYBOARD
slouken@4535
   241
            printf("Using scancode set %d, min_keycode = %d, max_keycode = %d, table_size = %d\n", i, min_keycode, max_keycode, scancode_set[i].table_size);
slouken@4535
   242
#endif
slouken@2305
   243
            SDL_memcpy(&data->key_layout[min_keycode], scancode_set[i].table,
slouken@5218
   244
                       sizeof(SDL_Scancode) * scancode_set[i].table_size);
slouken@2305
   245
            fingerprint_detected = SDL_TRUE;
slouken@2305
   246
            break;
bob@2295
   247
        }
bob@2295
   248
    }
bob@2295
   249
slouken@2305
   250
    if (!fingerprint_detected) {
slouken@5220
   251
        SDL_Keycode keymap[SDL_NUM_SCANCODES];
slouken@3001
   252
slouken@2305
   253
        printf
slouken@2305
   254
            ("Keyboard layout unknown, please send the following to the SDL mailing list (sdl@libsdl.org):\n");
bob@2295
   255
slouken@2305
   256
        /* Determine key_layout - only works on US QWERTY layout */
slouken@3001
   257
        SDL_GetDefaultKeymap(keymap);
slouken@2305
   258
        for (i = min_keycode; i <= max_keycode; ++i) {
slouken@2305
   259
            KeySym sym;
dimitris@6318
   260
#if SDL_VIDEO_DRIVER_X11_HAS_XKBKEYCODETOKEYSYM
icculus@7827
   261
            sym = X11_XkbKeycodeToKeysym(data->display, i, 0, 0);
dimitris@6318
   262
#else
slouken@2305
   263
            sym = XKeycodeToKeysym(data->display, i, 0);
dimitris@6318
   264
#endif
slouken@3001
   265
            if (sym != NoSymbol) {
slouken@7580
   266
                SDL_Scancode scancode;
icculus@3667
   267
                printf("code = %d, sym = 0x%X (%s) ", i - min_keycode,
icculus@7827
   268
                       (unsigned int) sym, X11_XKeysymToString(sym));
slouken@7580
   269
                scancode = X11_KeyCodeToSDLScancode(data->display, i);
slouken@7580
   270
                data->key_layout[i] = scancode;
slouken@7580
   271
                if (scancode == SDL_SCANCODE_UNKNOWN) {
slouken@2305
   272
                    printf("scancode not found\n");
slouken@2305
   273
                } else {
slouken@7824
   274
                    printf("scancode = %d (%s)\n", scancode, SDL_GetScancodeName(scancode));
slouken@2305
   275
                }
bob@2295
   276
            }
bob@2295
   277
        }
bob@2295
   278
    }
slouken@2305
   279
slouken@2306
   280
    X11_UpdateKeymap(_this);
slouken@2305
   281
slouken@2305
   282
    SDL_SetScancodeName(SDL_SCANCODE_APPLICATION, "Menu");
bob@2295
   283
bob@2295
   284
    return 0;
bob@2295
   285
}
bob@2295
   286
slouken@2305
   287
void
slouken@2305
   288
X11_UpdateKeymap(_THIS)
bob@2295
   289
{
bob@2295
   290
    SDL_VideoData *data = (SDL_VideoData *) _this->driverdata;
slouken@2305
   291
    int i;
slouken@5218
   292
    SDL_Scancode scancode;
slouken@5220
   293
    SDL_Keycode keymap[SDL_NUM_SCANCODES];
bob@2295
   294
slouken@7580
   295
    SDL_GetDefaultKeymap(keymap);
slouken@2305
   296
    for (i = 0; i < SDL_arraysize(data->key_layout); i++) {
slouken@7580
   297
        Uint32 key;
bob@2295
   298
slouken@3001
   299
        /* Make sure this is a valid scancode */
slouken@2305
   300
        scancode = data->key_layout[i];
slouken@3001
   301
        if (scancode == SDL_SCANCODE_UNKNOWN) {
slouken@2305
   302
            continue;
slouken@2305
   303
        }
bob@2295
   304
slouken@7580
   305
        /* See if there is a UCS keycode for this scancode */
slouken@7580
   306
        key = X11_KeyCodeToUcs4(data->display, (KeyCode)i);
slouken@7580
   307
        if (key) {
slouken@7580
   308
            keymap[scancode] = key;
slouken@7580
   309
        }
bob@2295
   310
    }
slouken@4465
   311
    SDL_SetKeymap(0, keymap, SDL_NUM_SCANCODES);
slouken@1950
   312
}
slouken@1950
   313
slouken@1950
   314
void
slouken@1950
   315
X11_QuitKeyboard(_THIS)
slouken@1950
   316
{
slouken@1950
   317
}
slouken@1950
   318
slouken@5481
   319
#endif /* SDL_VIDEO_DRIVER_X11 */
slouken@5481
   320
slouken@1950
   321
/* vi: set ts=4 sw=4 expandtab: */