reactos/lib/keyboard/kbdheb/kbdheb.c

   1 /*
   2  * ReactOS Hebrew ASCII Keyboard layout
   3  * Copyright (C) 2005 ReactOS
   4  * License: LGPL, see: LGPL.txt
   5  * author: Royce Mitchell III
   6  *
   7  * Thanks to: http://www.barcodeman.com/altek/mule/scandoc.php
   8  * and http://win.tue.nl/~aeb/linux/kbd/scancodes-1.html
   9  */
  10
  11 #include <windows.h>
  12 #include <internal/kbd.h>
  13
  14 #ifdef _MSC_VER
  15 #ifndef STDCALL
  16 #define STDCALL __stdcall
  17 #endif
  18 #endif//_MSC_VER
  19
  20 #ifdef _M_IA64
  21 #define ROSDATA static __declspec(allocate(".data"))
  22 #else
  23 #ifdef _MSC_VER
  24 #pragma data_seg(".data")
  25 #define ROSDATA static
  26 #else
  27 #define ROSDATA static __attribute__((section(".data")))
  28 #endif
  29 #endif
  30
  31 #define VK_EMPTY 0xff   /* The non-existent VK */
  32 #define KSHIFT   0x001  /* Shift modifier */
  33 #define KCTRL    0x002  /* Ctrl modifier */
  34 #define KALT     0x004  /* Alt modifier */
  35 #define KEXT     0x100  /* Extended key code */
  36 #define KMULTI   0x200  /* Multi-key */
  37 #define KSPEC    0x400  /* Special key */
  38 #define KNUMP    0x800  /* Number-pad */
  39 #define KNUMS    0xc00  /* Special + number pad */
  40 #define KMEXT    0x300  /* Multi + ext */
  41
  42 enum
  43 {
  44         // vowels, etc
  45         SHEVA = 0x5B0,
  46         HATAF_SEGOL,
  47         HATAF_PATAH,
  48         HATAF_QAMATS,
  49         HIRIQ,
  50         TSERE,
  51         SEGOL,
  52         PATAH,
  53         QAMATS,
  54         HOLAM,
  55         QUBUTS = 0x5BB,
  56         DAGESH,
  57         MAPIQ = DAGESH,
  58         METEG,
  59         MAQAF,
  60         RAFE,
  61         PASEQ,
  62         SHIN_DOT,
  63         SIN_DOT,
  64         SOF_PASUQ,
  65         YIDDISH_DOUBLE_VAV = 0x5F0,
  66         YIDDISH_VAV_YUD,
  67         YIDDISH_DOUBLE_YUD,
  68         GERESH,
  69         GERSHAYIM,
  70
  71         // consonants
  72         ALEF = 0x5D0,
  73         BET,
  74         GIMEL,
  75         DALET,
  76         HEY,
  77         VAV,
  78         ZAYIN,
  79         HET,
  80         TET,
  81         YUD,
  82         KAF_SOFIT,
  83         KAF,
  84         LAMED,
  85         MEM_SOFIT,
  86         MEM,
  87         NUN_SOFIT,
  88         NUN,
  89         SAMEKH,
  90         AYIN,
  91         PEY_SOFIT,
  92         PEY,
  93         TSADI_SOFIT,
  94         TSADI,
  95         QOF,
  96         RESH,
  97         SHIN,
  98         TAV
  99 };
 100
 101 ROSDATA USHORT scancode_to_vk[] =
 102 {
 103   /* Numbers Row */
 104
 105   /* - 00 - */
 106   VK_EMPTY,     // 00: ?
 107   VK_ESCAPE,    // 01: esc
 108   '1',          // 02: '1'
 109   '2',          // 03: '2'
 110   '3',          // 04: '3'
 111   '4',          // 05: '4'
 112   '5',          // 06: '5'
 113   '6',          // 07: '6'
 114   '7',          // 08: '7'
 115   '8',          // 09: '8'
 116   '9',          // 0A: '9'
 117   '0',          // 0B: '0'
 118   VK_OEM_MINUS, // 0C: '-'
 119   VK_OEM_PLUS,  // OD: '+'
 120   VK_BACK,      // OE: backspace
 121
 122   /* - 0f - */
 123   /* First Letters Row */
 124   VK_TAB,       // 0F: tab
 125   VK_OEM_2,     // 10: 'Q'
 126   VK_OEM_7,     // 11: 'W'
 127   'E',          // 12: 'E'
 128   'R',          // 13: 'R'
 129   'T',          // 14: 'T'
 130   'Y',          // 15: 'Y'
 131   'U',          // 16: 'U'
 132   'I',          // 17: 'I'
 133   'O',          // 18: 'O'
 134   'P',          // 19: 'P'
 135   VK_OEM_4,     // 1A: '{'
 136   VK_OEM_6,     // 1B: '}'
 137   VK_RETURN,    // 1C: enter
 138
 139   /* - 1d - */
 140   /* Second Letters Row */
 141   VK_LCONTROL,  // 1D: lctrl
 142   'A',          // 1E: 'A'
 143   'S',          // 1F: 'S'
 144   'D',          // 20: 'D'
 145   'F',          // 21: 'F'
 146   'G',          // 22: 'G'
 147   'H',          // 23: 'H'
 148   'J',          // 24: 'J'
 149   'K',          // 25: 'K'
 150   'L',          // 26: 'L'
 151   VK_OEM_1,     // 27: ';'
 152   VK_OEM_COMMA, // 28: '\''
 153   VK_OEM_3,     // 29: ?
 154   VK_LSHIFT,    // 2A: lshift
 155   VK_OEM_5,     // 2B: ?
 156
 157   /* - 2c - */
 158   /* Third letters row */
 159   'Z',          // 2C: 'Z'
 160   'X',          // 2D: 'X'
 161   'C',          // 2E: 'C'
 162   'V',          // 2F: 'V'
 163   'B',          // 30: 'B'
 164   'N',          // 31: 'N'
 165   'M',          // 32: 'M'
 166   'Q',          // 33: ','
 167   'W',          // 34: '.'
 168   VK_OEM_PERIOD,// 35: '/'
 169   VK_RSHIFT,    // 36: rshift
 170   /* - 37 - */
 171   /* Bottom Row */
 172   VK_MULTIPLY,  // 37: ?
 173   VK_LMENU,     // 38: lalt
 174   VK_SPACE,     // 39: space
 175   VK_CAPITAL,   // 3A: caps lock?
 176
 177   /* - 3b - */
 178   /* F-Keys */
 179   VK_F1, VK_F2, VK_F3, VK_F4, VK_F5, VK_F6,
 180   VK_F7, VK_F8, VK_F9, VK_F10,
 181   /* - 45 - */
 182   /* Locks */
 183   VK_NUMLOCK | KMEXT,
 184   VK_SCROLL | KMULTI,
 185   /* - 47 - */
 186   /* Number-Pad */
 187   VK_HOME | KNUMS,      VK_UP | KNUMS,         VK_PRIOR | KNUMS, VK_SUBTRACT,
 188   VK_LEFT | KNUMS,      VK_CLEAR | KNUMS,      VK_RIGHT | KNUMS, VK_ADD,
 189   VK_END | KNUMS,       VK_DOWN | KNUMS,       VK_NEXT | KNUMS,
 190   VK_INSERT | KNUMS,    VK_DELETE | KNUMS,
 191   /* - 54 - */
 192   /* Presumably PrtSc */
 193   VK_SNAPSHOT,
 194   /* - 55 - */
 195   /* Oddities, and the remaining standard F-Keys */
 196   VK_EMPTY,     VK_EMPTY,     VK_F11,       VK_F12,
 197   /* - 59 - */
 198   VK_CLEAR,     VK_EMPTY,     VK_EMPTY,     VK_EMPTY,     VK_EMPTY, /* EREOF */
 199   VK_EMPTY,     VK_EMPTY,     VK_EMPTY,     VK_EMPTY,     VK_EMPTY, /* ZOOM */
 200   VK_HELP,
 201   /* - 64 - */
 202   /* Even more F-Keys (for example, NCR keyboards from the early 90's) */
 203   VK_F13, VK_F14, VK_F15, VK_F16, VK_F17, VK_F18, VK_F19, VK_F20,
 204   VK_F21, VK_F22, VK_F23,
 205   /* - 6f - */
 206   /* Not sure who uses these codes */
 207   VK_EMPTY, VK_EMPTY, VK_EMPTY,
 208   /* - 72 - */
 209   VK_EMPTY, VK_EMPTY, VK_EMPTY, VK_EMPTY,
 210   /* - 76 - */
 211   /* One more f-key */
 212   VK_F24,
 213   /* - 77 - */
 214   VK_EMPTY, VK_EMPTY, VK_EMPTY, VK_EMPTY,
 215   VK_EMPTY, VK_EMPTY, VK_EMPTY, VK_EMPTY, /* PA1 */
 216   VK_EMPTY,
 217   /* - 80 - */
 218   0
 219 };
 220
 221 ROSDATA VSC_VK extcode0_to_vk[] = {
 222   { 0, 0 },
 223 };
 224
 225 ROSDATA VSC_VK extcode1_to_vk[] = {
 226   { 0, 0 },
 227 };
 228
 229 ROSDATA VK_TO_BIT modifier_keys[] = {
 230   { VK_SHIFT,   KSHIFT },
 231   { VK_CONTROL, KCTRL },
 232   { VK_MENU,    KALT },
 233   { 0,          0 }
 234 };
 235
 236 ROSDATA MODIFIERS modifier_bits = {
 237   modifier_keys,
 238   3,
 239   { 0, 1, 2, 3 } /* Modifier bit order, NONE, SHIFT, CTRL, ALT */
 240 };
 241
 242 #define NOCAPS 0
 243 #define CAPS   KSHIFT /* Caps -> shift */
 244
 245 ROSDATA VK_TO_WCHARS2 key_to_chars_2mod[] = {
 246   /* Normal vs Shifted */
 247   /* The numbers */
 248   { '1',         NOCAPS, {'1', '!'} },
 249   /* Ctrl-2 generates NUL */
 250   { '3',         NOCAPS, {'3', '#'} },
 251   { '4',         NOCAPS, {'4', '$'} },
 252   { '5',         NOCAPS, {'5', '%'} },
 253   /* Ctrl-6 generates RS */
 254   { '7',         NOCAPS, {'7', '&'} },
 255   { '8',         NOCAPS, {'8', '*'} },
 256   { '9',         NOCAPS, {'9', '('} },
 257   { '0',         NOCAPS, {'0', ')'} },
 258
 259   /* Specials */
 260   /* Ctrl-_ generates ? */
 261   { VK_OEM_PLUS    ,NOCAPS, {'=', '+'} },
 262   { VK_OEM_1       ,NOCAPS, {PEY_SOFIT, PEY_SOFIT} },
 263   { 'Q'            ,NOCAPS, {TAV, TAV} },
 264   { 'W'            ,NOCAPS, {TSADI_SOFIT, TSADI_SOFIT} },
 265   { VK_OEM_7       ,NOCAPS, {'\'','\"'} },
 266   { VK_OEM_3       ,NOCAPS, {'`', '~'} },
 267   { VK_OEM_COMMA   ,NOCAPS, {',', '<'} },
 268   { VK_OEM_PERIOD  ,NOCAPS, {'.', '>'} },
 269   { VK_OEM_2       ,NOCAPS, {'/', '?'} },
 270   /* Keys that do not have shift states */
 271   { VK_TAB     ,NOCAPS, {'\t','\t'} },
 272   { VK_ADD     ,NOCAPS, {'+', '+'} },
 273   { VK_SUBTRACT,NOCAPS, {'-', '-'} },
 274   { VK_MULTIPLY,NOCAPS, {'*', '*'} },
 275   { VK_DIVIDE  ,NOCAPS, {'/', '/'} },
 276   { VK_ESCAPE  ,NOCAPS, {'\x1b','\x1b'} },
 277   { VK_SPACE   ,NOCAPS, {' ', ' '} },
 278   { 0, 0 }
 279 };
 280
 281 ROSDATA VK_TO_WCHARS3 key_to_chars_3mod[] = {
 282   /* Normal, Shifted, Ctrl */
 283   /* Legacy (telnet-style) ascii escapes */
 284   { VK_OEM_4, 0, {'[', '{', 0x1b /* ESC */} },
 285   { VK_OEM_6, 0, {']', '}', 0x1d /* GS */} },
 286   { VK_OEM_5, 0, {'\\','|', 0x1c /* FS */} },
 287   { VK_RETURN,0, {'\r', '\r', '\n'} },
 288   { 0,0 }
 289 };
 290
 291 ROSDATA VK_TO_WCHARS4 key_to_chars_4mod[] = {
 292   /* Normal, Shifted, Ctrl, C-S-x */
 293
 294   /* The alphabet */
 295   { 'A',         NOCAPS, {SHIN, SHIN, 0x01, 0x01} },
 296   { 'B',         NOCAPS, {NUN, NUN, 0x02, 0x02} },
 297   { 'C',         NOCAPS, {BET, BET, 0x03, 0x03} },
 298   { 'D',         NOCAPS, {GIMEL, GIMEL, 0x04, 0x04} },
 299   { 'E',         NOCAPS, {QOF, QOF, 0x05, 0x05} },
 300   { 'F',         NOCAPS, {KAF, KAF, 0x06, 0x06} },
 301   { 'G',         NOCAPS, {AYIN, AYIN, 0x07, 0x07} },
 302   { 'H',         NOCAPS, {QOF, QOF, 0x08, 0x08} },
 303   { 'I',         NOCAPS, {NUN_SOFIT, NUN_SOFIT, 0x09, 0x09} },
 304   { 'J',         NOCAPS, {HET, HET, 0x0a, 0x0a} },
 305   { 'K',         NOCAPS, {LAMED, LAMED, 0x0b, 0x0b} },
 306   { 'L',         NOCAPS, {KAF_SOFIT, KAF_SOFIT, 0x0c, 0x0c} },
 307   { 'M',         NOCAPS, {TSADI, TSADI, 0x0d, 0x0d} },
 308   { 'N',         NOCAPS, {MEM, MEM, 0x0e, 0x0e} },
 309   { 'O',         NOCAPS, {MEM_SOFIT, MEM_SOFIT, 0x0f, 0x0f} },
 310   { 'P',         NOCAPS, {PEY, PEY, 0x10, 0x10} },
 311   { VK_OEM_2,    NOCAPS, {'/', '?', 0x11, 0x11} },
 312   { 'R',         NOCAPS, {RESH, RESH, 0x12, 0x12} },
 313   { 'S',         NOCAPS, {DALET, DALET, 0x13, 0x13} },
 314   { 'T',         NOCAPS, {ALEF, ALEF, 0x14, 0x14} },
 315   { 'U',         NOCAPS, {VAV, VAV, 0x15, 0x15} },
 316   { 'V',         NOCAPS, {HEY, HEY, 0x16, 0x16} },
 317   { VK_OEM_7,    NOCAPS, {'\'', '\"', 0x17, 0x17} },
 318   { 'X',         NOCAPS, {SAMEKH, SAMEKH, 0x18, 0x18} },
 319   { 'Y',         NOCAPS, {TET, TET, 0x19, 0x19} },
 320   { 'Z',         NOCAPS, {ZAYIN, ZAYIN, 0x1a, 0x1a} },
 321
 322   /* Legacy Ascii generators */
 323   { '2', NOCAPS, {'2', '@', WCH_NONE, 0} },
 324   { '6', NOCAPS, {'6', '^', WCH_NONE, 0x1e /* RS */} },
 325   { VK_OEM_MINUS, NOCAPS, {'-', '_', WCH_NONE, 0x1f /* US */} },
 326   { 0, 0 }
 327 };
 328
 329 ROSDATA VK_TO_WCHARS1 keypad_numbers[] =
 330 {
 331   { VK_NUMPAD0, 0, {'0'} },
 332   { VK_NUMPAD1, 0, {'1'} },
 333   { VK_NUMPAD2, 0, {'2'} },
 334   { VK_NUMPAD3, 0, {'3'} },
 335   { VK_NUMPAD4, 0, {'4'} },
 336   { VK_NUMPAD5, 0, {'5'} },
 337   { VK_NUMPAD6, 0, {'6'} },
 338   { VK_NUMPAD7, 0, {'7'} },
 339   { VK_NUMPAD8, 0, {'8'} },
 340   { VK_NUMPAD9, 0, {'9'} },
 341   { VK_DECIMAL, 0, {'.'} },
 342   { VK_BACK,    0, {'\010'} },
 343   { 0,0 }
 344 };
 345
 346 #define vk_master(n,x) { (PVK_TO_WCHARS1)x, n, sizeof(x[0]) }
 347
 348 ROSDATA VK_TO_WCHAR_TABLE vk_to_wchar_master_table[] =
 349 {
 350   vk_master(1,keypad_numbers),
 351   vk_master(2,key_to_chars_2mod),
 352   vk_master(3,key_to_chars_3mod),
 353   vk_master(4,key_to_chars_4mod),
 354   { 0,0,0 }
 355 };
 356
 357 ROSDATA VSC_LPWSTR key_names[] =
 358 {
 359   { 0x00, L"" },
 360   { 0x01, L"Esc" },
 361   { 0x0e, L"Backspace" },
 362   { 0x0f, L"Tab" },
 363   { 0x1c, L"Enter" },
 364   { 0x1d, L"Ctrl" },
 365   { 0x2a, L"Shift" },
 366   { 0x36, L"Right Shift" },
 367   { 0x37, L"Num *" },
 368   { 0x38, L"Alt" },
 369   { 0x39, L"Space" },
 370   { 0x3a, L"Caps Lock" },
 371   { 0x3b, L"F1" },
 372   { 0x3c, L"F2" },
 373   { 0x3d, L"F3" },
 374   { 0x3e, L"F4" },
 375   { 0x3f, L"F5" },
 376   { 0x40, L"F6" },
 377   { 0x41, L"F7" },
 378   { 0x42, L"F8" },
 379   { 0x43, L"F9" },
 380   { 0x44, L"F10" },
 381   { 0x45, L"Pause" },
 382   { 0x46, L"Scroll Lock" },
 383   { 0x47, L"Num 7" },
 384   { 0x48, L"Num 8" },
 385   { 0x49, L"Num 9" },
 386   { 0x4a, L"Num -" },
 387   { 0x4b, L"Num 4" },
 388   { 0x4c, L"Num 5" },
 389   { 0x4d, L"Num 6" },
 390   { 0x4e, L"Num +" },
 391   { 0x4f, L"Num 1" },
 392   { 0x50, L"Num 2" },
 393   { 0x51, L"Num 3" },
 394   { 0x52, L"Num 0" },
 395   { 0x53, L"Num Del" },
 396   { 0x54, L"Sys Req" },
 397   { 0x57, L"F11" },
 398   { 0x58, L"F12" },
 399   { 0x7c, L"F13" },
 400   { 0x7d, L"F14" },
 401   { 0x7e, L"F15" },
 402   { 0x7f, L"F16" },
 403   { 0x80, L"F17" },
 404   { 0x81, L"F18" },
 405   { 0x82, L"F19" },
 406   { 0x83, L"F20" },
 407   { 0x84, L"F21" },
 408   { 0x85, L"F22" },
 409   { 0x86, L"F23" },
 410   { 0x87, L"F24" },
 411   { 0, NULL },
 412 };
 413
 414 ROSDATA VSC_LPWSTR extended_key_names[] =
 415 {
 416   { 0x1c, L"Num Enter" },
 417   { 0x1d, L"Right Ctrl" },
 418   { 0x35, L"Num /" },
 419   { 0x37, L"Prnt Scrn" },
 420   { 0x38, L"Right Alt" },
 421   { 0x45, L"Num Lock" },
 422   { 0x46, L"Break" },
 423   { 0x47, L"Home" },
 424   { 0x48, L"Up" },
 425   { 0x49, L"Page Up" },
 426   { 0x4a, L"Left" },
 427   { 0x4c, L"Center" },
 428   { 0x4d, L"Right" },
 429   { 0x4f, L"End" },
 430   { 0x50, L"Down" },
 431   { 0x51, L"Page Down" },
 432   { 0x52, L"Insert" },
 433   { 0x53, L"Delete" },
 434   { 0x54, L"<ReactOS>" },
 435   { 0x55, L"Help" },
 436   { 0x56, L"Left Windows" },
 437   { 0x5b, L"Right Windows" },
 438   { 0, NULL },
 439 };
 440
 441 /* Finally, the master table */
 442 ROSDATA KBDTABLES keyboard_layout_table =
 443 {
 444   /* modifier assignments */
 445   &modifier_bits,
 446
 447   /* character from vk tables */
 448   vk_to_wchar_master_table,
 449
 450   /* diacritical marks -- currently implemented by wine code */
 451   /* English doesn't have any, anyway */
 452   NULL,
 453
 454   /* Key names */
 455   (VSC_LPWSTR *)key_names,
 456   (VSC_LPWSTR *)extended_key_names,
 457   NULL, /* Dead key names */
 458
 459   /* scan code to virtual key maps */
 460   scancode_to_vk,
 461   sizeof(scancode_to_vk) / sizeof(scancode_to_vk[0]),
 462   extcode0_to_vk,
 463   extcode1_to_vk,
 464
 465   MAKELONG(0,1), /* Version 1.0 */
 466
 467   /* Ligatures -- does Hebrew have any? */
 468   0,
 469   0,
 470   NULL
 471 };
 472
 473 PKBDTABLES STDCALL KbdLayerDescriptor()
 474 {
 475   return &keyboard_layout_table;
 476 }
 477