arch/all-hosted/hidd/x11/x11_kbdclass.c

   1 /*
   2     Copyright © 1995-2017, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc: X11 hidd handling keypresses.
   6     Lang: English.
   7 */
   8
   9 #include "x11_debug.h"
  10
  11 #define __OOP_NOATTRBASES__
  12
  13 #include <proto/utility.h>
  14 #include <hidd/keyboard.h>
  15 #include <devices/inputevent.h>
  16
  17 #define timeval sys_timeval
  18 #include <X11/keysym.h>
  19 #undef timeval
  20
  21 #include "x11_types.h"
  22 #include LC_LIBDEFS_FILE
  23 #include "x11_hostlib.h"
  24
  25 /****************************************************************************************/
  26
  27 long xkey2hidd (XKeyEvent *xk, struct x11_staticdata *xsd);
  28
  29 static OOP_AttrBase HiddKbdAB;
  30
  31 static struct OOP_ABDescr attrbases[] =
  32 {
  33     { IID_Hidd_Kbd  , &HiddKbdAB    },
  34     { NULL          , NULL          }
  35 };
  36
  37 /****************************************************************************************/
  38
  39 static struct _keytable
  40 {
  41     KeySym keysym;
  42     WORD   hiddcode;
  43 }
  44 keytable[] =
  45 {
  46     {XK_Return,         0x44 },
  47     {XK_Right,          0x4e },
  48     {XK_Up,             0x4c },
  49     {XK_Left,           0x4f },
  50     {XK_Down,           0x4d },
  51     {XK_Help,           0x5f },
  52
  53     {XK_BackSpace,      0x41 },
  54     {XK_Delete,         0x46 },
  55     {XK_space,          0x40 },
  56     {XK_Shift_L,        0x60 },
  57     {XK_Shift_R,        0x61 },
  58     {XK_Caps_Lock,      0x62 },
  59     {XK_Alt_L,          0x64 },
  60     {XK_Alt_R,          0x65 },
  61     {XK_Escape,         0x45 },
  62     {XK_Tab,            0x42 },
  63
  64     {XK_F1,             0x50 },
  65     {XK_F2,             0x51 },
  66     {XK_F3,             0x52 },
  67     {XK_F4,             0x53 },
  68     {XK_F5,             0x54 },
  69     {XK_F6,             0x55 },
  70     {XK_F7,             0x56 },
  71     {XK_F8,             0x57 },
  72     {XK_F9,             0x58 },
  73     {XK_F10,            0x59 },
  74
  75     {XK_F11,            0x4B },
  76     {XK_F12,            0x5f }, /* HELP, F12 would be 0x6F */
  77     {XK_Home,           0x70 },
  78     {XK_End,            0x71 },
  79     {XK_Insert,         0x47 },
  80     {XK_Prior,          0x48 }, /* PageUP */
  81     {XK_Next,           0x49 }, /* PageDown */
  82     {XK_Print,          0x6c },
  83     {XK_Scroll_Lock,    0x6b },
  84     {XK_Pause,          0x6e },
  85
  86     {XK_KP_Enter,       0x43 },
  87     {XK_KP_Subtract,    0x4a },
  88     {XK_KP_Decimal,     0x3c },
  89     {XK_KP_Separator,   0x3c },
  90     {XK_KP_Delete,      0x3c },
  91     {XK_KP_Add,         0x5e },
  92     {XK_KP_Subtract,    0x4a },
  93     {XK_KP_Multiply,    0x5d },
  94     {XK_KP_Divide,      0x5c },
  95
  96     {XK_KP_0,           0x0f },
  97     {XK_KP_Insert,      0x0f },
  98     {XK_KP_1,           0x1d },
  99     {XK_KP_End,         0x1d },
 100     {XK_KP_2,           0x1e },
 101     {XK_KP_Down,        0x1e },
 102     {XK_KP_3,           0x1f },
 103     {XK_KP_Page_Down,   0x1f },
 104     {XK_KP_4,           0x2d },
 105     {XK_KP_Left,        0x2d },
 106     {XK_KP_5,           0x2e },
 107     {XK_KP_Begin,       0x2e },
 108     {XK_KP_6,           0x2f },
 109     {XK_KP_Right,       0x2f },
 110     {XK_KP_7,           0x3d },
 111     {XK_KP_Home,        0x3d },
 112     {XK_KP_8,           0x3e },
 113     {XK_KP_Up,          0x3e },
 114     {XK_KP_9,           0x3f },
 115     {XK_KP_Page_Up,     0x3f },
 116
 117     {XK_E,              0x12 },
 118     {XK_e,              0x12 },
 119     {XK_R,              0x13 },
 120     {XK_r,              0x13 },
 121     {XK_T,              0x14 },
 122     {XK_t,              0x14 },
 123     {XK_U,              0x16 },
 124     {XK_u,              0x16 },
 125     {XK_I,              0x17 },
 126     {XK_i,              0x17 },
 127     {XK_O,              0x18 },
 128     {XK_o,              0x18 },
 129     {XK_P,              0x19 },
 130     {XK_p,              0x19 },
 131
 132     {XK_S,              0x21 },
 133     {XK_s,              0x21 },
 134     {XK_D,              0x22 },
 135     {XK_d,              0x22 },
 136     {XK_F,              0x23 },
 137     {XK_f,              0x23 },
 138     {XK_G,              0x24 },
 139     {XK_g,              0x24 },
 140     {XK_H,              0x25 },
 141     {XK_h,              0x25 },
 142     {XK_J,              0x26 },
 143     {XK_j,              0x26 },
 144     {XK_K,              0x27 },
 145     {XK_k,              0x27 },
 146     {XK_L,              0x28 },
 147     {XK_l,              0x28 },
 148
 149     {XK_X,              0x32 },
 150     {XK_x,              0x32 },
 151     {XK_c,              0x33 },
 152     {XK_C,              0x33 },
 153     {XK_V,              0x34 },
 154     {XK_v,              0x34 },
 155     {XK_B,              0x35 },
 156     {XK_b,              0x35 },
 157     {XK_N,              0x36 },
 158     {XK_n,              0x36 },
 159
 160     {XK_1,              0x01 },
 161     {XK_2,              0x02 },
 162     {XK_3,              0x03 },
 163     {XK_4,              0x04 },
 164     {XK_5,              0x05 },
 165     {XK_6,              0x06 },
 166     {XK_7,              0x07 },
 167     {XK_8,              0x08 },
 168     {XK_9,              0x09 },
 169     {XK_0,              0x0A },
 170     {0, - 1 }
 171 };
 172
 173 /****************************************************************************************/
 174
 175 /* English keyboard */
 176 static struct _keytable english_keytable[] =
 177 {
 178     {XK_Control_L,      0x63 }, /* left control = control */
 179     {XK_Multi_key,      0x63 }, /* right control = control */
 180     {XK_Super_L,        0x66 }, /* left win = LAMIGA */
 181     {XK_Super_R,        0x67 }, /* right win = RAMIGA */
 182     {XK_Menu,           0x67 }, /* menu key = RAMIGA */
 183     {XK_Meta_L,         0x64 }, /* left Alt = LALT */
 184     {XK_Mode_switch,    0x65 }, /* right Alt = RALT */
 185
 186     /* Key left of S */
 187     {XK_A,              0x20 },
 188     {XK_a,              0x20 },
 189
 190     /* Key right of N */
 191     {XK_M,              0x37 },
 192     {XK_m,              0x37 },
 193
 194     /* Key right of TAB */
 195     {XK_Q,              0x10 },
 196     {XK_q,              0x10 },
 197
 198     /* Key between T and U */
 199     {XK_y,              0x15 },
 200     {XK_Y,              0x15 },
 201
 202     /* Key left of E */
 203     {XK_W,              0x11 },
 204     {XK_w,              0x11 },
 205
 206     /* Key left of X */
 207     {XK_z,              0x31 },
 208     {XK_Z,              0x31 },
 209
 210
 211     /* Key left of 1 */
 212     {XK_grave,          0x00 },
 213
 214     /* Keys right of 0 */
 215     {XK_minus,          0x0B },
 216     {XK_equal,          0x0C },
 217
 218     /* Keys right of P */
 219     {XK_bracketleft,    0x1A },
 220     {XK_bracketright,   0x1B },
 221
 222     /* Keys right of L */
 223     {XK_semicolon,      0x29 },
 224     {XK_apostrophe,     0x2A },
 225     {XK_backslash,      0x2B }, /* Third key right of L might not be present */
 226
 227     /* Key right of shift and 2nd left of X (might not be present) */
 228     {XK_less,           0x30 },
 229
 230     /* Keys 2nd right of N (= usually right of M) */
 231     {XK_comma,          0x38 },
 232     {XK_period,         0x39 },
 233     {XK_slash,          0x3A },
 234
 235     {0, -1 }
 236 };
 237
 238 /****************************************************************************************/
 239
 240 #if 0
 241 /* German keyboard */
 242 static struct _keytable german_keytable[] =
 243 {
 244     {XK_Control_L,      0x63 }, /* linke STRG = control */
 245     {XK_Multi_key,      0x63 }, /* rechte STRG = control */
 246     {XK_Super_L,        0x66 }, /* Linke Win = LAMIGA */
 247     {XK_Super_R,        0x67 }, /* Rechte Win = RAMIGA */
 248     {XK_Meta_L,         0x64 }, /* Linke Alt = LALT */
 249     {XK_Mode_switch,    0x65 }, /* Alt Gr = RALT */
 250
 251     /* Key left of S */
 252     {XK_A,              0x20 },
 253     {XK_a,              0x20 },
 254
 255     /* Key right of N */
 256     {XK_M,              0x37 },
 257     {XK_m,              0x37 },
 258
 259     /* Key right of TAB */
 260     {XK_Q,              0x10 },
 261     {XK_q,              0x10 },
 262
 263     /* Key between T and U */
 264     {XK_Z,              0x15 },
 265     {XK_z,              0x15 },
 266
 267     /* Key left of E */
 268     {XK_W,              0x11 },
 269     {XK_w,              0x11 },
 270
 271     /* Key left of X */
 272     {XK_y,              0x31 },
 273     {XK_Y,              0x31 },
 274
 275      /* Key left of 1 */
 276     {XK_asciicircum,    0x00 }, /* Akzent links neben 1 Taste */
 277
 278     /* Keys right of 0 */
 279     {XK_equal,          0x0A }, /* = */
 280     {XK_ssharp,         0x0B }, /* scharfes s */
 281     {XK_acute,          0x0C }, /* Akzent rechts von scharfem s */
 282
 283     /* Keys right of P */
 284     {XK_udiaeresis,     0x1A }, /* Umlaut u */
 285     {XK_Udiaeresis,     0x1A },
 286     {XK_plus,           0x1B }, /* + */
 287
 288     /* Keys right of L */
 289     {XK_odiaeresis,     0x29 }, /* Umlaut o */
 290     {XK_Odiaeresis,     0x29 },
 291     {XK_adiaeresis,     0x2A }, /* Umlaut a */
 292     {XK_Adiaeresis,     0x2A },
 293     {XK_numbersign,     0x2B }, /* # */
 294
 295     /* Key right of shift and 2nd left of X (might not be present) */
 296     {XK_less,           0x30 }, /* < */
 297
 298     /* Keys 2nd right of N (= usually right of M) */
 299     {XK_comma,          0x38 }, /* Komma */
 300     {XK_period,         0x39 }, /* Punkt */
 301     {XK_minus,          0x3A }, /* Minus */
 302
 303     {0, -1 }
 304 };
 305 #endif
 306
 307 #if 0
 308 /* Italian keyboard */
 309 static struct _keytable italian_keytable[] =
 310 {
 311     {XK_Control_L,      0x63 }, /* left CTRL = control */
 312     {XK_Multi_key,      0x63 }, /* right CTRL = control */
 313     {XK_Super_L,        0x66 }, /* left win = LAMIGA */
 314     {XK_Super_R,        0x67 }, /* right win = RAMIGA */
 315     {XK_Meta_L,         0x64 }, /* left alt = LALT */
 316     {XK_Mode_switch,    0x65 }, /* right alt = RALT */
 317
 318
 319     /* Key left of S */
 320     {XK_A,              0x20 },
 321     {XK_a,              0x20 },
 322
 323     /* Key right of N */
 324     {XK_M,              0x37 },
 325     {XK_m,              0x37 },
 326
 327     /* Key right of TAB */
 328     {XK_Q,              0x10 },
 329     {XK_q,              0x10 },
 330
 331     /* Key between T and U */
 332     {XK_y,              0x15 },
 333     {XK_Y,              0x15 },
 334
 335     /* Key left of E */
 336     {XK_W,              0x11 },
 337     {XK_w,              0x11 },
 338
 339     /* Key left of X */
 340     {XK_z,              0x31 },
 341     {XK_Z,              0x31 },
 342
 343
 344     /* Key left of 1 */
 345     {XK_backslash,      0x00 },
 346
 347     /* Keys right of 0 */
 348     {XK_apostrophe,     0x0B },
 349     {XK_Igrave,         0x0C },
 350     {XK_igrave,         0x0C },
 351
 352     /* Keys right of P */
 353     {XK_Egrave,         0x1A },
 354     {XK_egrave,         0x1A },
 355     {XK_plus,           0x1B }, /* + */
 356
 357     /* Keys right of L */
 358     {XK_Ograve,         0x29 },
 359     {XK_ograve,         0x29 },
 360     {XK_Agrave,         0x2A },
 361     {XK_agrave,         0x2A },
 362     {XK_Ugrave,         0x2B }, /* Third key right of L might not be present */
 363     {XK_ugrave,         0x2B },
 364
 365     /* Key right of shift and 2nd left of X (might not be present) */
 366     {XK_less,           0x30 }, /* < */
 367
 368     /* Keys 2nd right of N (= usually right of M) */
 369     {XK_comma,          0x38 },
 370     {XK_period,         0x39 },
 371     {XK_minus,          0x3A },
 372
 373     {0, -1 }
 374 };
 375 #endif
 376
 377 /****************************************************************************************/
 378
 379 #if 0
 380
 381 /* Use this template to create a keytable for your language:
 382
 383    Do not touch the right values (rawkey numbers). Only change
 384    the XK's at the left side. To find out the XK_ names (keysym)
 385    start "xev" and press the key the comment describes (for
 386    example "Key left of S" in the xev window. In the Shell
 387    window you will see output like this:
 388
 389    KeyPress event, serial 30, synthetic NO, window 0x5000001,
 390     root 0x47, subw 0x5000002, time 3410089115, (24,45), root:(28,69),
 391     state 0x0, keycode 50 (keysym 0xffe1, Shift_L), same_screen YES,
 392     XLookupString gives 0 characters:  ""  |
 393                                            |
 394    This is the keysym name _______________/
 395
 396    So in this case you would have to write  "XK_Shift_L"
 397
 398    Check all keys, not just the ones with "XK_????"!!!
 399 */
 400
 401 static struct _keytable template_keytable[] =
 402 {
 403     {XK_Control_L,      0x63 }, /* left control = control */
 404     {XK_Multi_key,      0x63 }, /* right control = control */
 405     {XK_Super_L,        0x66 }, /* left win = LAMIGA */
 406     {XK_Super_R,        0x67 }, /* right win = RAMIGA */
 407     {XK_Meta_L,         0x64 }, /* left Alt = LALT */
 408     {XK_Mode_switch,    0x65 }, /* right Alt = RALT */
 409
 410     /* Key left of S */
 411     {XK_A,              0x20 },
 412     {XK_a,              0x20 },
 413
 414     /* Key right of N */
 415     {XK_M,              0x37 },
 416     {XK_m,              0x37 },
 417
 418     /* Key right of TAB */
 419     {XK_Q,              0x10 },
 420     {XK_q,              0x10 },
 421
 422     /* Key between T and U */
 423     {XK_????,           0x15 },
 424     {XK_????,           0x15 },
 425
 426     /* Key left of E */
 427     {XK_W,              0x11 },
 428     {XK_w,              0x11 },
 429
 430     /* Key left of X */
 431     {XK_????,           0x31 },
 432     {XK_????,           0x31 },
 433
 434
 435     /* Key left of 1 */
 436     {XK_????,           0x00 },
 437
 438     /* Keys right of 0 */
 439     {XK_????,           0x0B },
 440     {XK_????,           0x0C },
 441
 442     /* Keys right of P */
 443     {XK_????,           0x1A },
 444     {XK_????,           0x1B },
 445
 446     /* Keys right of L */
 447     {XK_????,           0x29 },
 448     {XK_????,           0x2A },
 449     {XK_????,           0x2B }, /* Third key right of L might not be present */
 450
 451     /* Key right of shift and 2nd left of X (might not be present) */
 452     {XK_less,           0x30 },
 453
 454     /* Keys 2nd right of N (= usually right of M) */
 455     {XK_comma,          0x38 },
 456     {XK_period,         0x39 },
 457     {XK_slash,          0x3A },
 458
 459     {0, -1 }
 460 };
 461
 462 #endif
 463
 464 /****************************************************************************************/
 465
 466 OOP_Object * X11Kbd__Root__New(OOP_Class *cl, OOP_Object *o, struct pRoot_New *msg)
 467 {
 468     BOOL            has_kbd_hidd = FALSE;
 469     struct TagItem *tag, *tstate;
 470     APTR            callback = NULL;
 471     APTR            callbackdata = NULL;
 472
 473     EnterFunc(bug("X11Kbd::New()\n"));
 474
 475     ObtainSemaphoreShared( &XSD(cl)->sema);
 476
 477     if (XSD(cl)->kbdhidd)
 478         has_kbd_hidd = TRUE;
 479
 480     ReleaseSemaphore( &XSD(cl)->sema);
 481
 482     if (has_kbd_hidd) { /* Cannot open twice */
 483         D(bug("[X11Kbd] Attempt to create second instance\n"));
 484         ReturnPtr("X11Kbd::New", OOP_Object *, NULL); /* Should have some error code here */
 485     }
 486
 487     tstate = msg->attrList;
 488     D(bug("tstate: %p, tag=%x\n", tstate, tstate->ti_Tag));
 489
 490     while ((tag = NextTagItem(&tstate)))
 491     {
 492         ULONG idx;
 493
 494         D(bug("Got tag %d, data %x\n", tag->ti_Tag, tag->ti_Data));
 495
 496         if (IS_HIDDKBD_ATTR(tag->ti_Tag, idx))
 497         {
 498             D(bug("Kbd hidd tag\n"));
 499             switch (idx)
 500             {
 501                 case aoHidd_Kbd_IrqHandler:
 502                     callback = (APTR)tag->ti_Data;
 503                     D(bug("Got callback %p\n", (APTR)tag->ti_Data));
 504                     break;
 505
 506                 case aoHidd_Kbd_IrqHandlerData:
 507                     callbackdata = (APTR)tag->ti_Data;
 508                     D(bug("Got data %p\n", (APTR)tag->ti_Data));
 509                     break;
 510             }
 511         }
 512
 513     } /* while (tags to process) */
 514
 515     if (NULL == callback)
 516         ReturnPtr("X11Kbd::New", OOP_Object *, NULL); /* Should have some error code here */
 517
 518     o = (OOP_Object *)OOP_DoSuperMethod(cl, o, (OOP_Msg)msg);
 519     if (o)
 520     {
 521         struct x11kbd_data *data = OOP_INST_DATA(cl, o);
 522
 523         data->kbd_callback = (VOID (*)(APTR, UWORD))callback;
 524         data->callbackdata = callbackdata;
 525         data->prev_keycode = 0xFFFF;
 526
 527         ObtainSemaphore( &XSD(cl)->sema);
 528         XSD(cl)->kbdhidd = o;
 529         ReleaseSemaphore( &XSD(cl)->sema);
 530     }
 531
 532     ReturnPtr("X11Kbd::New", OOP_Object *, o);
 533 }
 534
 535 /****************************************************************************************/
 536
 537 VOID X11Kbd__Root__Dispose(OOP_Class *cl, OOP_Object *o, OOP_Msg msg)
 538 {
 539     EnterFunc(bug("[X11Kbd] Dispose()\n"));
 540
 541     ObtainSemaphore( &XSD(cl)->sema);
 542     XSD(cl)->kbdhidd = NULL;
 543     ReleaseSemaphore( &XSD(cl)->sema);
 544     OOP_DoSuperMethod(cl, o, msg);
 545 }
 546
 547 /****************************************************************************************/
 548
 549 VOID X11Kbd__Hidd_Kbd_X11__HandleEvent(OOP_Class *cl, OOP_Object *o, struct pHidd_Kbd_X11_HandleEvent *msg)
 550 {
 551     struct x11kbd_data  *data;
 552     XKeyEvent           *xk;
 553     long                 keycode;
 554
 555     EnterFunc(bug("x11kbd_handleevent()\n"));
 556
 557     data = OOP_INST_DATA(cl, o);
 558     xk = &(msg->event->xkey);
 559
 560     keycode = xkey2hidd(xk, XSD(cl));
 561     if (keycode == -1)
 562     {
 563         ReturnVoid("X11Kbd::HandleEvent: Unknown key!");
 564     }
 565
 566     if (msg->event->type == KeyRelease)
 567     {
 568         keycode |= IECODE_UP_PREFIX;
 569     }
 570
 571     if (keycode != data->prev_keycode)
 572     {
 573         data->kbd_callback(data->callbackdata, keycode);
 574         data->prev_keycode = keycode;
 575     }
 576
 577     ReturnVoid("X11Kbd::HandleEvent");
 578 }
 579
 580 /****************************************************************************************/
 581
 582 #undef XSD
 583 #define XSD(cl) xsd
 584
 585 /****************************************************************************************/
 586
 587 WORD lookup_keytable(KeySym *ks, struct _keytable *keytable)
 588 {
 589     short t;
 590     WORD  result = -1;
 591
 592     for (t = 0; keytable[t].hiddcode != -1; t++)
 593     {
 594         if (*ks == keytable[t].keysym)
 595         {
 596             D(bug("xktac: found in key table\n"));
 597             result = keytable[t].hiddcode;
 598             break;
 599         }
 600     }
 601
 602     return result;
 603 }
 604
 605 /****************************************************************************************/
 606
 607 long xkey2hidd (XKeyEvent *xk, struct x11_staticdata *xsd)
 608 {
 609     char    buffer[10];
 610     KeySym  ks;
 611     D(int     count;)
 612     long    result;
 613
 614     D(bug("xkey2hidd\n"));
 615
 616     if (xsd->havetable)
 617     {
 618         result = -1;
 619         if ((xk->keycode >= 0) && (xk->keycode < 256))
 620         {
 621             result = xsd->keycode2rawkey[xk->keycode];
 622             if (result == 255) result = -1;
 623         }
 624
 625         return result;
 626     }
 627
 628     LOCK_X11
 629     xk->state = 0;
 630     D(count =) XCALL(XLookupString, xk, buffer, 10, &ks, NULL);
 631     UNLOCK_X11
 632
 633     D(bug("xk2h: Code %d (0x%x). Event was decoded into %d chars: %d (0x%x)\n",xk->keycode, xk->keycode, count,ks,ks));
 634
 635     result = lookup_keytable(&ks, keytable);
 636     if (result == -1) result = lookup_keytable(&ks, english_keytable);
 637
 638     ReturnInt ("xk2h", long, result);
 639
 640 } /* XKeyToAmigaCode */
 641
 642
 643 /****************************************************************************************/
 644
 645 #undef XSD
 646 #define XSD(cl) (&LIBBASE->xsd)
 647
 648 /****************************************************************************************/
 649
 650 static int kbd_init(LIBBASETYPEPTR LIBBASE)
 651 {
 652
 653     return OOP_ObtainAttrBases(attrbases);
 654 }
 655
 656 /****************************************************************************************/
 657
 658 static int kbd_expunge(LIBBASETYPEPTR LIBBASE)
 659 {
 660     OOP_ReleaseAttrBases(attrbases);
 661     return TRUE;
 662 }
 663
 664 /****************************************************************************************/
 665
 666 ADD2INITLIB(kbd_init, 0);
 667 ADD2EXPUNGELIB(kbd_expunge, 0);
 668
 669 /****************************************************************************************/