1/*
2 * Copyright (C) 2004, 2006, 2007, 2008, 2009, 2010 Apple Inc.  All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 * 1. Redistributions of source code must retain the above copyright
8 *    notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 *    notice, this list of conditions and the following disclaimer in the
11 *    documentation and/or other materials provided with the distribution.
12 *
13 * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26#import "config.h"
27#import "KeyEventCocoa.h"
28
29#import "Logging.h"
30#import "WindowsKeyboardCodes.h"
31#import <wtf/ASCIICType.h>
32#import <wtf/text/WTFString.h>
33
34#if PLATFORM(IOS)
35#import "KeyEventCodesIOS.h"
36#endif
37
38using namespace WTF;
39
40namespace WebCore {
41
42String keyIdentifierForCharCode(unichar charCode)
43{
44    switch (charCode) {
45        // Each identifier listed in the DOM spec is listed here.
46        // Many are simply commented out since they do not appear on standard Macintosh keyboards
47        // or are on a key that doesn't have a corresponding character.
48
49        // "Accept"
50        // "AllCandidates"
51
52        // "Alt"
53        case NSMenuFunctionKey:
54            return "Alt";
55
56        // "Apps"
57        // "BrowserBack"
58        // "BrowserForward"
59        // "BrowserHome"
60        // "BrowserRefresh"
61        // "BrowserSearch"
62        // "BrowserStop"
63        // "CapsLock"
64
65        // "Clear"
66        case NSClearLineFunctionKey:
67            return "Clear";
68
69        // "CodeInput"
70        // "Compose"
71        // "Control"
72        // "Crsel"
73        // "Convert"
74        // "Copy"
75        // "Cut"
76
77        // "Down"
78        case NSDownArrowFunctionKey:
79            return "Down";
80        // "End"
81        case NSEndFunctionKey:
82            return "End";
83        // "Enter"
84        case 0x3: case 0xA: case 0xD: // Macintosh calls the one on the main keyboard Return, but Windows calls it Enter, so we'll do the same for the DOM
85            return "Enter";
86
87        // "EraseEof"
88
89        // "Execute"
90        case NSExecuteFunctionKey:
91            return "Execute";
92
93        // "Exsel"
94
95        // "F1"
96        case NSF1FunctionKey:
97            return "F1";
98        // "F2"
99        case NSF2FunctionKey:
100            return "F2";
101        // "F3"
102        case NSF3FunctionKey:
103            return "F3";
104        // "F4"
105        case NSF4FunctionKey:
106            return "F4";
107        // "F5"
108        case NSF5FunctionKey:
109            return "F5";
110        // "F6"
111        case NSF6FunctionKey:
112            return "F6";
113        // "F7"
114        case NSF7FunctionKey:
115            return "F7";
116        // "F8"
117        case NSF8FunctionKey:
118            return "F8";
119        // "F9"
120        case NSF9FunctionKey:
121            return "F9";
122        // "F10"
123        case NSF10FunctionKey:
124            return "F10";
125        // "F11"
126        case NSF11FunctionKey:
127            return "F11";
128        // "F12"
129        case NSF12FunctionKey:
130            return "F12";
131        // "F13"
132        case NSF13FunctionKey:
133            return "F13";
134        // "F14"
135        case NSF14FunctionKey:
136            return "F14";
137        // "F15"
138        case NSF15FunctionKey:
139            return "F15";
140        // "F16"
141        case NSF16FunctionKey:
142            return "F16";
143        // "F17"
144        case NSF17FunctionKey:
145            return "F17";
146        // "F18"
147        case NSF18FunctionKey:
148            return "F18";
149        // "F19"
150        case NSF19FunctionKey:
151            return "F19";
152        // "F20"
153        case NSF20FunctionKey:
154            return "F20";
155        // "F21"
156        case NSF21FunctionKey:
157            return "F21";
158        // "F22"
159        case NSF22FunctionKey:
160            return "F22";
161        // "F23"
162        case NSF23FunctionKey:
163            return "F23";
164        // "F24"
165        case NSF24FunctionKey:
166            return "F24";
167
168        // "FinalMode"
169
170        // "Find"
171        case NSFindFunctionKey:
172            return "Find";
173
174        // "FullWidth"
175        // "HalfWidth"
176        // "HangulMode"
177        // "HanjaMode"
178
179        // "Help"
180        case NSHelpFunctionKey:
181            return "Help";
182
183        // "Hiragana"
184
185        // "Home"
186        case NSHomeFunctionKey:
187            return "Home";
188        // "Insert"
189        case NSInsertFunctionKey:
190            return "Insert";
191
192        // "JapaneseHiragana"
193        // "JapaneseKatakana"
194        // "JapaneseRomaji"
195        // "JunjaMode"
196        // "KanaMode"
197        // "KanjiMode"
198        // "Katakana"
199        // "LaunchApplication1"
200        // "LaunchApplication2"
201        // "LaunchMail"
202
203        // "Left"
204        case NSLeftArrowFunctionKey:
205            return "Left";
206
207        // "Meta"
208        // "MediaNextTrack"
209        // "MediaPlayPause"
210        // "MediaPreviousTrack"
211        // "MediaStop"
212
213        // "ModeChange"
214        case NSModeSwitchFunctionKey:
215            return "ModeChange";
216
217        // "Nonconvert"
218        // "NumLock"
219
220        // "PageDown"
221        case NSPageDownFunctionKey:
222            return "PageDown";
223        // "PageUp"
224        case NSPageUpFunctionKey:
225            return "PageUp";
226
227        // "Paste"
228
229        // "Pause"
230        case NSPauseFunctionKey:
231            return "Pause";
232
233        // "Play"
234        // "PreviousCandidate"
235
236        // "PrintScreen"
237        case NSPrintScreenFunctionKey:
238            return "PrintScreen";
239
240        // "Process"
241        // "Props"
242
243        // "Right"
244        case NSRightArrowFunctionKey:
245            return "Right";
246
247        // "RomanCharacters"
248
249        // "Scroll"
250        case NSScrollLockFunctionKey:
251            return "Scroll";
252        // "Select"
253        case NSSelectFunctionKey:
254            return "Select";
255
256        // "SelectMedia"
257        // "Shift"
258
259        // "Stop"
260        case NSStopFunctionKey:
261            return "Stop";
262        // "Up"
263        case NSUpArrowFunctionKey:
264            return "Up";
265        // "Undo"
266        case NSUndoFunctionKey:
267            return "Undo";
268
269        // "VolumeDown"
270        // "VolumeMute"
271        // "VolumeUp"
272        // "Win"
273        // "Zoom"
274
275        // More function keys, not in the key identifier specification.
276        case NSF25FunctionKey:
277            return "F25";
278        case NSF26FunctionKey:
279            return "F26";
280        case NSF27FunctionKey:
281            return "F27";
282        case NSF28FunctionKey:
283            return "F28";
284        case NSF29FunctionKey:
285            return "F29";
286        case NSF30FunctionKey:
287            return "F30";
288        case NSF31FunctionKey:
289            return "F31";
290        case NSF32FunctionKey:
291            return "F32";
292        case NSF33FunctionKey:
293            return "F33";
294        case NSF34FunctionKey:
295            return "F34";
296        case NSF35FunctionKey:
297            return "F35";
298
299        // Turn 0x7F into 0x08, because backspace needs to always be 0x08.
300        case 0x7F:
301            return "U+0008";
302        // Standard says that DEL becomes U+007F.
303        case NSDeleteFunctionKey:
304            return "U+007F";
305
306        // Always use 0x09 for tab instead of AppKit's backtab character.
307        case NSBackTabCharacter:
308            return "U+0009";
309
310        case NSBeginFunctionKey:
311        case NSBreakFunctionKey:
312        case NSClearDisplayFunctionKey:
313        case NSDeleteCharFunctionKey:
314        case NSDeleteLineFunctionKey:
315        case NSInsertCharFunctionKey:
316        case NSInsertLineFunctionKey:
317        case NSNextFunctionKey:
318        case NSPrevFunctionKey:
319        case NSPrintFunctionKey:
320        case NSRedoFunctionKey:
321        case NSResetFunctionKey:
322        case NSSysReqFunctionKey:
323        case NSSystemFunctionKey:
324        case NSUserFunctionKey:
325            // FIXME: We should use something other than the vendor-area Unicode values for the above keys.
326            // For now, just fall through to the default.
327        default:
328            return String::format("U+%04X", toASCIIUpper(charCode));
329    }
330}
331
332int windowsKeyCodeForKeyCode(uint16_t keyCode)
333{
334    static const int windowsKeyCode[] = {
335        /* 0 */ VK_A,
336        /* 1 */ VK_S,
337        /* 2 */ VK_D,
338        /* 3 */ VK_F,
339        /* 4 */ VK_H,
340        /* 5 */ VK_G,
341        /* 6 */ VK_Z,
342        /* 7 */ VK_X,
343        /* 8 */ VK_C,
344        /* 9 */ VK_V,
345        /* 0x0A */ VK_OEM_3, // "Section" - key to the left from 1 (ISO Keyboard Only)
346        /* 0x0B */ VK_B,
347        /* 0x0C */ VK_Q,
348        /* 0x0D */ VK_W,
349        /* 0x0E */ VK_E,
350        /* 0x0F */ VK_R,
351        /* 0x10 */ VK_Y,
352        /* 0x11 */ VK_T,
353        /* 0x12 */ VK_1,
354        /* 0x13 */ VK_2,
355        /* 0x14 */ VK_3,
356        /* 0x15 */ VK_4,
357        /* 0x16 */ VK_6,
358        /* 0x17 */ VK_5,
359        /* 0x18 */ VK_OEM_PLUS, // =+
360        /* 0x19 */ VK_9,
361        /* 0x1A */ VK_7,
362        /* 0x1B */ VK_OEM_MINUS, // -_
363        /* 0x1C */ VK_8,
364        /* 0x1D */ VK_0,
365        /* 0x1E */ VK_OEM_6, // ]}
366        /* 0x1F */ VK_O,
367        /* 0x20 */ VK_U,
368        /* 0x21 */ VK_OEM_4, // {[
369        /* 0x22 */ VK_I,
370        /* 0x23 */ VK_P,
371        /* 0x24 */ VK_RETURN, // Return
372        /* 0x25 */ VK_L,
373        /* 0x26 */ VK_J,
374        /* 0x27 */ VK_OEM_7, // '"
375        /* 0x28 */ VK_K,
376        /* 0x29 */ VK_OEM_1, // ;:
377        /* 0x2A */ VK_OEM_5, // \|
378        /* 0x2B */ VK_OEM_COMMA, // ,<
379        /* 0x2C */ VK_OEM_2, // /?
380        /* 0x2D */ VK_N,
381        /* 0x2E */ VK_M,
382        /* 0x2F */ VK_OEM_PERIOD, // .>
383        /* 0x30 */ VK_TAB,
384        /* 0x31 */ VK_SPACE,
385        /* 0x32 */ VK_OEM_3, // `~
386        /* 0x33 */ VK_BACK, // Backspace
387        /* 0x34 */ 0, // n/a
388        /* 0x35 */ VK_ESCAPE,
389        /* 0x36 */ VK_APPS, // Right Command
390        /* 0x37 */ VK_LWIN, // Left Command
391        /* 0x38 */ VK_LSHIFT, // Left Shift
392        /* 0x39 */ VK_CAPITAL, // Caps Lock
393        /* 0x3A */ VK_LMENU, // Left Option
394        /* 0x3B */ VK_LCONTROL, // Left Ctrl
395        /* 0x3C */ VK_RSHIFT, // Right Shift
396        /* 0x3D */ VK_RMENU, // Right Option
397        /* 0x3E */ VK_RCONTROL, // Right Ctrl
398        /* 0x3F */ 0, // fn
399        /* 0x40 */ VK_F17,
400        /* 0x41 */ VK_DECIMAL, // Num Pad .
401        /* 0x42 */ 0, // n/a
402        /* 0x43 */ VK_MULTIPLY, // Num Pad *
403        /* 0x44 */ 0, // n/a
404        /* 0x45 */ VK_ADD, // Num Pad +
405        /* 0x46 */ 0, // n/a
406        /* 0x47 */ VK_CLEAR, // Num Pad Clear
407        /* 0x48 */ VK_VOLUME_UP,
408        /* 0x49 */ VK_VOLUME_DOWN,
409        /* 0x4A */ VK_VOLUME_MUTE,
410        /* 0x4B */ VK_DIVIDE, // Num Pad /
411        /* 0x4C */ VK_RETURN, // Num Pad Enter
412        /* 0x4D */ 0, // n/a
413        /* 0x4E */ VK_SUBTRACT, // Num Pad -
414        /* 0x4F */ VK_F18,
415        /* 0x50 */ VK_F19,
416        /* 0x51 */ VK_OEM_PLUS, // Num Pad =. There is no such key on common PC keyboards, mapping to normal "+=".
417        /* 0x52 */ VK_NUMPAD0,
418        /* 0x53 */ VK_NUMPAD1,
419        /* 0x54 */ VK_NUMPAD2,
420        /* 0x55 */ VK_NUMPAD3,
421        /* 0x56 */ VK_NUMPAD4,
422        /* 0x57 */ VK_NUMPAD5,
423        /* 0x58 */ VK_NUMPAD6,
424        /* 0x59 */ VK_NUMPAD7,
425        /* 0x5A */ VK_F20,
426        /* 0x5B */ VK_NUMPAD8,
427        /* 0x5C */ VK_NUMPAD9,
428        /* 0x5D */ 0, // Yen (JIS Keyboard Only)
429        /* 0x5E */ 0, // Underscore (JIS Keyboard Only)
430        /* 0x5F */ 0, // KeypadComma (JIS Keyboard Only)
431        /* 0x60 */ VK_F5,
432        /* 0x61 */ VK_F6,
433        /* 0x62 */ VK_F7,
434        /* 0x63 */ VK_F3,
435        /* 0x64 */ VK_F8,
436        /* 0x65 */ VK_F9,
437        /* 0x66 */ 0, // Eisu (JIS Keyboard Only)
438        /* 0x67 */ VK_F11,
439        /* 0x68 */ 0, // Kana (JIS Keyboard Only)
440        /* 0x69 */ VK_F13,
441        /* 0x6A */ VK_F16,
442        /* 0x6B */ VK_F14,
443        /* 0x6C */ 0, // n/a
444        /* 0x6D */ VK_F10,
445        /* 0x6E */ 0, // n/a (Windows95 key?)
446        /* 0x6F */ VK_F12,
447        /* 0x70 */ 0, // n/a
448        /* 0x71 */ VK_F15,
449        /* 0x72 */ VK_INSERT, // Help
450        /* 0x73 */ VK_HOME, // Home
451        /* 0x74 */ VK_PRIOR, // Page Up
452        /* 0x75 */ VK_DELETE, // Forward Delete
453        /* 0x76 */ VK_F4,
454        /* 0x77 */ VK_END, // End
455        /* 0x78 */ VK_F2,
456        /* 0x79 */ VK_NEXT, // Page Down
457        /* 0x7A */ VK_F1,
458        /* 0x7B */ VK_LEFT, // Left Arrow
459        /* 0x7C */ VK_RIGHT, // Right Arrow
460        /* 0x7D */ VK_DOWN, // Down Arrow
461        /* 0x7E */ VK_UP, // Up Arrow
462        /* 0x7F */ 0 // n/a
463    };
464
465    if (keyCode >= 0x80)
466        return 0;
467
468     return windowsKeyCode[keyCode];
469}
470
471int windowsKeyCodeForCharCode(unichar charCode)
472{
473    switch (charCode) {
474#if PLATFORM(IOS)
475        case 8: case 0x7F: return VK_BACK;
476        case 9: return VK_TAB;
477        case 0xD: case 3: return VK_RETURN;
478        case 0x1B: return VK_ESCAPE;
479        case ' ': return VK_SPACE;
480        case NSHomeFunctionKey: return VK_HOME;
481        case NSEndFunctionKey: return VK_END;
482        case NSPageUpFunctionKey: return VK_PRIOR;
483        case NSPageDownFunctionKey: return VK_NEXT;
484        case NSUpArrowFunctionKey: return VK_UP;
485        case NSDownArrowFunctionKey: return VK_DOWN;
486        case NSLeftArrowFunctionKey: return VK_LEFT;
487        case NSRightArrowFunctionKey: return VK_RIGHT;
488        case NSDeleteFunctionKey: return VK_DELETE;
489
490        case '0': case ')': return VK_0;
491        case '1': case '!': return VK_1;
492        case '2': case '@': return VK_2;
493        case '3': case '#': return VK_3;
494        case '4': case '$': return VK_4;
495        case '5': case '%': return VK_5;
496        case '6': case '^': return VK_6;
497        case '7': case '&': return VK_7;
498        case '8': case '*': return VK_8;
499        case '9': case '(': return VK_9;
500#endif
501        case 'a': case 'A': return VK_A;
502        case 'b': case 'B': return VK_B;
503        case 'c': case 'C': return VK_C;
504        case 'd': case 'D': return VK_D;
505        case 'e': case 'E': return VK_E;
506        case 'f': case 'F': return VK_F;
507        case 'g': case 'G': return VK_G;
508        case 'h': case 'H': return VK_H;
509        case 'i': case 'I': return VK_I;
510        case 'j': case 'J': return VK_J;
511        case 'k': case 'K': return VK_K;
512        case 'l': case 'L': return VK_L;
513        case 'm': case 'M': return VK_M;
514        case 'n': case 'N': return VK_N;
515        case 'o': case 'O': return VK_O;
516        case 'p': case 'P': return VK_P;
517        case 'q': case 'Q': return VK_Q;
518        case 'r': case 'R': return VK_R;
519        case 's': case 'S': return VK_S;
520        case 't': case 'T': return VK_T;
521        case 'u': case 'U': return VK_U;
522        case 'v': case 'V': return VK_V;
523        case 'w': case 'W': return VK_W;
524        case 'x': case 'X': return VK_X;
525        case 'y': case 'Y': return VK_Y;
526        case 'z': case 'Z': return VK_Z;
527
528        // AppKit generates Unicode PUA character codes for some function keys; using these when key code is not known.
529        case NSPauseFunctionKey: return VK_PAUSE;
530        case NSSelectFunctionKey: return VK_SELECT;
531        case NSPrintFunctionKey: return VK_PRINT;
532        case NSExecuteFunctionKey: return VK_EXECUTE;
533        case NSPrintScreenFunctionKey: return VK_SNAPSHOT;
534#if PLATFORM(IOS)
535        case NSInsertFunctionKey: case NSHelpFunctionKey: return VK_INSERT;
536
537        case NSF1FunctionKey: return VK_F1;
538        case NSF2FunctionKey: return VK_F2;
539        case NSF3FunctionKey: return VK_F3;
540        case NSF4FunctionKey: return VK_F4;
541        case NSF5FunctionKey: return VK_F5;
542        case NSF6FunctionKey: return VK_F6;
543        case NSF7FunctionKey: return VK_F7;
544        case NSF8FunctionKey: return VK_F8;
545        case NSF9FunctionKey: return VK_F9;
546        case NSF10FunctionKey: return VK_F10;
547        case NSF11FunctionKey: return VK_F11;
548        case NSF12FunctionKey: return VK_F12;
549        case NSF13FunctionKey: return VK_F13;
550        case NSF14FunctionKey: return VK_F14;
551        case NSF15FunctionKey: return VK_F15;
552        case NSF16FunctionKey: return VK_F16;
553        case NSF17FunctionKey: return VK_F17;
554        case NSF18FunctionKey: return VK_F18;
555        case NSF19FunctionKey: return VK_F19;
556        case NSF20FunctionKey: return VK_F20;
557#else
558        case NSInsertFunctionKey: return VK_INSERT;
559#endif
560        case NSF21FunctionKey: return VK_F21;
561        case NSF22FunctionKey: return VK_F22;
562        case NSF23FunctionKey: return VK_F23;
563        case NSF24FunctionKey: return VK_F24;
564        case NSScrollLockFunctionKey: return VK_SCROLL;
565
566        // This is for U.S. keyboard mapping, and doesn't necessarily make sense for different keyboard layouts.
567        // For example, '"' on Windows Russian layout is VK_2, not VK_OEM_7.
568        case ';': case ':': return VK_OEM_1;
569        case '=': case '+': return VK_OEM_PLUS;
570        case ',': case '<': return VK_OEM_COMMA;
571        case '-': case '_': return VK_OEM_MINUS;
572        case '.': case '>': return VK_OEM_PERIOD;
573        case '/': case '?': return VK_OEM_2;
574        case '`': case '~': return VK_OEM_3;
575        case '[': case '{': return VK_OEM_4;
576        case '\\': case '|': return VK_OEM_5;
577        case ']': case '}': return VK_OEM_6;
578        case '\'': case '"': return VK_OEM_7;
579
580    }
581
582    return 0;
583}
584
585}
586