Reviewed by Eric. Landed by rwlbuis.
[WebKit-https.git] / WebCore / platform / qt / PlatformKeyboardEventQt.cpp
1 /*
2  * Copyright (C) 2006 Nikolas Zimmermann <zimmermann@kde.org>
3  *
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
16  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
19  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
22  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
23  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27
28 #include "config.h"
29 #include "HelperQt.h"
30 #include "KeyboardCodes.h"
31 #include "PlatformKeyboardEvent.h"
32
33 #include <QKeyEvent>
34
35 namespace WebCore {
36
37 static String keyIdentifierForQtKeyCode(int keyCode)
38 {
39     switch (keyCode) {
40         case Qt::Key_Menu:
41         case Qt::Key_Alt:
42             return "Alt";
43         case Qt::Key_Clear:
44             return "Clear";
45         case Qt::Key_Down:
46             return "Down";
47         case Qt::Key_End:
48             return "End";
49         case Qt::Key_Enter:
50             return "Enter";
51         case Qt::Key_Execute:
52             return "Execute";
53         case Qt::Key_F1:
54             return "F1";
55         case Qt::Key_F2:
56             return "F2";
57         case Qt::Key_F3:
58             return "F3";
59         case Qt::Key_F4:
60             return "F4";
61         case Qt::Key_F5:
62             return "F5";
63         case Qt::Key_F6:
64             return "F6";
65         case Qt::Key_F7:
66             return "F7";
67         case Qt::Key_F8:
68             return "F8";
69         case Qt::Key_F9:
70             return "F9";
71         case Qt::Key_F10:
72             return "F10";
73         case Qt::Key_F11:
74             return "F11";
75         case Qt::Key_F12:
76             return "F12";
77         case Qt::Key_F13:
78             return "F13";
79         case Qt::Key_F14:
80             return "F14";
81         case Qt::Key_F15:
82             return "F15";
83         case Qt::Key_F16:
84             return "F16";
85         case Qt::Key_F17:
86             return "F17";
87         case Qt::Key_F18:
88             return "F18";
89         case Qt::Key_F19:
90             return "F19";
91         case Qt::Key_F20:
92             return "F20";
93         case Qt::Key_F21:
94             return "F21";
95         case Qt::Key_F22:
96             return "F22";
97         case Qt::Key_F23:
98             return "F23";
99         case Qt::Key_F24:
100             return "F24";
101         case Qt::Key_Help:
102             return "Help";
103         case Qt::Key_Home:
104             return "Home";
105         case Qt::Key_Insert:
106             return "Insert";
107         case Qt::Key_Left:
108             return "Left";
109         case Qt::Key_PageDown:
110             return "PageDown";
111         case Qt::Key_PageUp:
112             return "PageUp";
113         case Qt::Key_Pause:
114             return "Pause";
115         case Qt::Key_Print:
116             return "PrintScreen";
117         case Qt::Key_Right:
118             return "Right";
119         case Qt::Key_Select:
120             return "Select";
121         case Qt::Key_Up:
122             return "Up";
123             // Standard says that DEL becomes U+00007F.
124         case Qt::Key_Delete:
125             return "U+00007F";
126         default:
127             return String::sprintf("U+%06X", toupper(keyCode));
128     }
129 }
130
131 static int windowsKeyCodeForKeyEvent(unsigned int keycode)
132 {
133     switch (keycode) {
134         /* FIXME: Need to supply a bool in this func, to determine wheter the event comes from the keypad
135         case Qt::Key_0:
136             return VK_NUMPAD0;// (60) Numeric keypad 0 key
137         case Qt::Key_1:
138             return VK_NUMPAD1;// (61) Numeric keypad 1 key
139         case Qt::Key_2:
140             return  VK_NUMPAD2; // (62) Numeric keypad 2 key
141         case Qt::Key_3:
142             return VK_NUMPAD3; // (63) Numeric keypad 3 key
143         case Qt::Key_4:
144             return VK_NUMPAD4; // (64) Numeric keypad 4 key
145         case Qt::Key_5:
146             return VK_NUMPAD5; //(65) Numeric keypad 5 key
147         case Qt::Key_6:
148             return VK_NUMPAD6; // (66) Numeric keypad 6 key
149         case Qt::Key_7:
150             return VK_NUMPAD7; // (67) Numeric keypad 7 key
151         case Qt::Key_8:
152             return VK_NUMPAD8; // (68) Numeric keypad 8 key
153         case Qt::Key_9:
154             return VK_NUMPAD9; // (69) Numeric keypad 9 key
155         case Qt::Key_Asterisk:
156             return VK_MULTIPLY; // (6A) Multiply key
157         case Qt::Key_Plus:
158             return VK_ADD; // (6B) Add key
159         case Qt::Key_Minus:
160             return VK_SUBTRACT; // (6D) Subtract key
161         case Qt::Key_Period:
162             return VK_DECIMAL; // (6E) Decimal key
163         case Qt::Key_Slash:
164             return VK_DIVIDE; // (6F) Divide key
165
166         */
167         case Qt::Key_BackSpace:
168             return VK_BACK; // (08) BACKSPACE key
169         case Qt::Key_Tab:
170             return VK_TAB; // (09) TAB key
171         case Qt::Key_Clear:
172             return VK_CLEAR; // (0C) CLEAR key
173         case Qt::Key_Return:
174             return VK_RETURN; //(0D) Return key
175         case Qt::Key_Shift:
176             return VK_SHIFT; // (10) SHIFT key
177         case Qt::Key_Control:
178             return VK_CONTROL; // (11) CTRL key
179         case Qt::Key_Menu:
180         case Qt::Key_Alt:
181             return VK_MENU; // (12) ALT key
182
183         case Qt::Key_Pause:
184             return VK_PAUSE; // (13) PAUSE key
185         case Qt::Key_CapsLock:
186             return VK_CAPITAL; // (14) CAPS LOCK key
187         case Qt::Key_Kana_Lock:
188         case Qt::Key_Kana_Shift:
189             return VK_KANA; // (15) Input Method Editor (IME) Kana mode
190         case Qt::Key_Hangul:
191             return VK_HANGUL; // VK_HANGUL (15) IME Hangul mode
192             // VK_JUNJA (17) IME Junja mode
193             // VK_FINAL (18) IME final mode
194         case Qt::Key_Hangul_Hanja:
195             return VK_HANJA; // (19) IME Hanja mode
196         case Qt::Key_Kanji:
197             return VK_KANJI; // (19) IME Kanji mode
198         case Qt::Key_Escape:
199             return VK_ESCAPE; // (1B) ESC key
200             // VK_CONVERT (1C) IME convert
201             // VK_NONCONVERT (1D) IME nonconvert
202             // VK_ACCEPT (1E) IME accept
203             // VK_MODECHANGE (1F) IME mode change request
204         case Qt::Key_Space:
205             return VK_SPACE; // (20) SPACEBAR
206         case Qt::Key_PageUp:
207             return VK_PRIOR; // (21) PAGE UP key
208         case Qt::Key_PageDown:
209             return VK_NEXT; // (22) PAGE DOWN key
210         case Qt::Key_End:
211             return VK_END; // (23) END key
212         case Qt::Key_Home:
213             return VK_HOME; // (24) HOME key
214         case Qt::Key_Left:
215             return VK_LEFT; // (25) LEFT ARROW key
216         case Qt::Key_Up:
217             return VK_UP; // (26) UP ARROW key
218         case Qt::Key_Right:
219             return VK_RIGHT; // (27) RIGHT ARROW key
220         case Qt::Key_Down:
221             return VK_DOWN; // (28) DOWN ARROW key
222         case Qt::Key_Select:
223             return VK_SELECT; // (29) SELECT key
224         case Qt::Key_Print:
225             return VK_PRINT; // (2A) PRINT key
226         case Qt::Key_Execute:
227             return VK_EXECUTE;// (2B) EXECUTE key
228             //dunno on this
229             //case Qt::Key_PrintScreen:
230             //      return VK_SNAPSHOT; // (2C) PRINT SCREEN key
231         case Qt::Key_Insert:
232             return VK_INSERT; // (2D) INS key
233         case Qt::Key_Delete:
234             return VK_DELETE; // (2E) DEL key
235         case Qt::Key_Help:
236             return VK_HELP; // (2F) HELP key
237         case Qt::Key_0:
238         case Qt::Key_ParenLeft:
239             return VK_0;    //  (30) 0) key
240         case Qt::Key_1:
241             return VK_1; //  (31) 1 ! key
242         case Qt::Key_2:
243         case Qt::Key_At:
244             return VK_2; //  (32) 2 & key
245         case Qt::Key_3:
246         case Qt::Key_NumberSign:
247             return VK_3; //case '3': case '#';
248         case Qt::Key_4:
249         case Qt::Key_Dollar: //  (34) 4 key '$';
250             return VK_4;
251         case Qt::Key_5:
252         case Qt::Key_Percent:
253             return VK_5; //  (35) 5 key  '%'
254         case Qt::Key_6:
255         case Qt::Key_AsciiCircum:
256             return VK_6; //  (36) 6 key  '^'
257         case Qt::Key_7:
258         case Qt::Key_Ampersand:
259             return VK_7; //  (37) 7 key  case '&'
260         case Qt::Key_8:
261         case Qt::Key_Asterisk:
262             return VK_8; //  (38) 8 key  '*'
263         case Qt::Key_9:
264         case Qt::Key_ParenRight:
265             return VK_9; //  (39) 9 key '('
266         case Qt::Key_A:
267             return VK_A; //  (41) A key case 'a': case 'A': return 0x41;
268         case Qt::Key_B:
269             return VK_B; //  (42) B key case 'b': case 'B': return 0x42;
270         case Qt::Key_C:
271             return VK_C; //  (43) C key case 'c': case 'C': return 0x43;
272         case Qt::Key_D:
273             return VK_D; //  (44) D key case 'd': case 'D': return 0x44;
274         case Qt::Key_E:
275             return VK_E; //  (45) E key case 'e': case 'E': return 0x45;
276         case Qt::Key_F:
277             return VK_F; //  (46) F key case 'f': case 'F': return 0x46;
278         case Qt::Key_G:
279             return VK_G; //  (47) G key case 'g': case 'G': return 0x47;
280         case Qt::Key_H:
281             return VK_H; //  (48) H key case 'h': case 'H': return 0x48;
282         case Qt::Key_I:
283             return VK_I; //  (49) I key case 'i': case 'I': return 0x49;
284         case Qt::Key_J:
285             return VK_J; //  (4A) J key case 'j': case 'J': return 0x4A;
286         case Qt::Key_K:
287             return VK_K; //  (4B) K key case 'k': case 'K': return 0x4B;
288         case Qt::Key_L:
289             return VK_L; //  (4C) L key case 'l': case 'L': return 0x4C;
290         case Qt::Key_M:
291             return VK_M; //  (4D) M key case 'm': case 'M': return 0x4D;
292         case Qt::Key_N:
293             return VK_N; //  (4E) N key case 'n': case 'N': return 0x4E;
294         case Qt::Key_O:
295             return VK_O; //  (4F) O key case 'o': case 'O': return 0x4F;
296         case Qt::Key_P:
297             return VK_P; //  (50) P key case 'p': case 'P': return 0x50;
298         case Qt::Key_Q:
299             return VK_Q; //  (51) Q key case 'q': case 'Q': return 0x51;
300         case Qt::Key_R:
301             return VK_R; //  (52) R key case 'r': case 'R': return 0x52;
302         case Qt::Key_S:
303             return VK_S; //  (53) S key case 's': case 'S': return 0x53;
304         case Qt::Key_T:
305             return VK_T; //  (54) T key case 't': case 'T': return 0x54;
306         case Qt::Key_U:
307             return VK_U; //  (55) U key case 'u': case 'U': return 0x55;
308         case Qt::Key_V:
309             return VK_V; //  (56) V key case 'v': case 'V': return 0x56;
310         case Qt::Key_W:
311             return VK_W; //  (57) W key case 'w': case 'W': return 0x57;
312         case Qt::Key_X:
313             return VK_X; //  (58) X key case 'x': case 'X': return 0x58;
314         case Qt::Key_Y:
315             return VK_Y; //  (59) Y key case 'y': case 'Y': return 0x59;
316         case Qt::Key_Z:
317             return VK_Z; //  (5A) Z key case 'z': case 'Z': return 0x5A;
318         case Qt::Key_Meta:
319             return VK_LWIN; // (5B) Left Windows key (Microsoft Natural keyboard)
320         //case Qt::Key_Meta_R: TODO: What to do here?
321         //    return VK_RWIN; // (5C) Right Windows key (Natural keyboard)
322             // VK_APPS (5D) Applications key (Natural keyboard)
323             // VK_SLEEP (5F) Computer Sleep key
324             // VK_SEPARATOR (6C) Separator key
325             // VK_SUBTRACT (6D) Subtract key
326             // VK_DECIMAL (6E) Decimal key
327             // VK_DIVIDE (6F) Divide key
328             // handled by key code above
329
330         case Qt::Key_NumLock:
331             return VK_NUMLOCK; // (90) NUM LOCK key
332
333         case Qt::Key_ScrollLock:
334             return VK_SCROLL; // (91) SCROLL LOCK key
335
336             // VK_LSHIFT (A0) Left SHIFT key
337             // VK_RSHIFT (A1) Right SHIFT key
338             // VK_LCONTROL (A2) Left CONTROL key
339             // VK_RCONTROL (A3) Right CONTROL key
340             // VK_LMENU (A4) Left MENU key
341             // VK_RMENU (A5) Right MENU key
342             // VK_BROWSER_BACK (A6) Windows 2000/XP: Browser Back key
343             // VK_BROWSER_FORWARD (A7) Windows 2000/XP: Browser Forward key
344             // VK_BROWSER_REFRESH (A8) Windows 2000/XP: Browser Refresh key
345             // VK_BROWSER_STOP (A9) Windows 2000/XP: Browser Stop key
346             // VK_BROWSER_SEARCH (AA) Windows 2000/XP: Browser Search key
347             // VK_BROWSER_FAVORITES (AB) Windows 2000/XP: Browser Favorites key
348             // VK_BROWSER_HOME (AC) Windows 2000/XP: Browser Start and Home key
349             // VK_VOLUME_MUTE (AD) Windows 2000/XP: Volume Mute key
350             // VK_VOLUME_DOWN (AE) Windows 2000/XP: Volume Down key
351             // VK_VOLUME_UP (AF) Windows 2000/XP: Volume Up key
352             // VK_MEDIA_NEXT_TRACK (B0) Windows 2000/XP: Next Track key
353             // VK_MEDIA_PREV_TRACK (B1) Windows 2000/XP: Previous Track key
354             // VK_MEDIA_STOP (B2) Windows 2000/XP: Stop Media key
355             // VK_MEDIA_PLAY_PAUSE (B3) Windows 2000/XP: Play/Pause Media key
356             // VK_LAUNCH_MAIL (B4) Windows 2000/XP: Start Mail key
357             // VK_LAUNCH_MEDIA_SELECT (B5) Windows 2000/XP: Select Media key
358             // VK_LAUNCH_APP1 (B6) Windows 2000/XP: Start Application 1 key
359             // VK_LAUNCH_APP2 (B7) Windows 2000/XP: Start Application 2 key
360
361             // VK_OEM_1 (BA) Used for miscellaneous characters; it can vary by keyboard. Windows 2000/XP: For the US standard keyboard, the ';:' key
362         case Qt::Key_Semicolon:
363         case Qt::Key_Colon:
364             return VK_OEM_1; //case ';': case ':': return 0xBA;
365             // VK_OEM_PLUS (BB) Windows 2000/XP: For any country/region, the '+' key
366         case Qt::Key_Plus:
367         case Qt::Key_Equal:
368             return VK_OEM_PLUS; //case '=': case '+': return 0xBB;
369             // VK_OEM_COMMA (BC) Windows 2000/XP: For any country/region, the ',' key
370         case Qt::Key_Comma:
371         case Qt::Key_Less:
372             return VK_OEM_COMMA; //case ',': case '<': return 0xBC;
373             // VK_OEM_MINUS (BD) Windows 2000/XP: For any country/region, the '-' key
374         case Qt::Key_Minus:
375         case Qt::Key_Underscore:
376             return VK_OEM_MINUS; //case '-': case '_': return 0xBD;
377             // VK_OEM_PERIOD (BE) Windows 2000/XP: For any country/region, the '.' key
378         case Qt::Key_Period:
379         case Qt::Key_Greater:
380             return VK_OEM_PERIOD; //case '.': case '>': return 0xBE;
381             // VK_OEM_2 (BF) Used for miscellaneous characters; it can vary by keyboard. Windows 2000/XP: For the US standard keyboard, the '/?' key
382         case Qt::Key_Slash:
383         case Qt::Key_Question:
384             return VK_OEM_2; //case '/': case '?': return 0xBF;
385             // VK_OEM_3 (C0) Used for miscellaneous characters; it can vary by keyboard. Windows 2000/XP: For the US standard keyboard, the '`~' key
386         case Qt::Key_AsciiTilde:
387         case Qt::Key_QuoteLeft:
388             return VK_OEM_3; //case '`': case '~': return 0xC0;
389             // VK_OEM_4 (DB) Used for miscellaneous characters; it can vary by keyboard. Windows 2000/XP: For the US standard keyboard, the '[{' key
390         case Qt::Key_BracketLeft:
391         case Qt::Key_BraceLeft:
392             return VK_OEM_4; //case '[': case '{': return 0xDB;
393             // VK_OEM_5 (DC) Used for miscellaneous characters; it can vary by keyboard. Windows 2000/XP: For the US standard keyboard, the '\|' key
394         case Qt::Key_Backslash:
395         case Qt::Key_Bar:
396             return VK_OEM_5; //case '\\': case '|': return 0xDC;
397             // VK_OEM_6 (DD) Used for miscellaneous characters; it can vary by keyboard. Windows 2000/XP: For the US standard keyboard, the ']}' key
398         case Qt::Key_BracketRight:
399         case Qt::Key_BraceRight:
400             return VK_OEM_6; // case ']': case '}': return 0xDD;
401             // VK_OEM_7 (DE) Used for miscellaneous characters; it can vary by keyboard. Windows 2000/XP: For the US standard keyboard, the 'single-quote/double-quote' key
402         case Qt::Key_QuoteDbl:
403             return VK_OEM_7; // case '\'': case '"': return 0xDE;
404             // VK_OEM_8 (DF) Used for miscellaneous characters; it can vary by keyboard.
405             // VK_OEM_102 (E2) Windows 2000/XP: Either the angle bracket key or the backslash key on the RT 102-key keyboard
406             // VK_PROCESSKEY (E5) Windows 95/98/Me, Windows NT 4.0, Windows 2000/XP: IME PROCESS key
407             // VK_PACKET (E7) Windows 2000/XP: Used to pass Unicode characters as if they were keystrokes. The VK_PACKET key is the low word of a 32-bit Virtual Key value used for non-keyboard input methods. For more information, see Remark in KEYBDINPUT,SendInput, WM_KEYDOWN, and WM_KEYUP
408             // VK_ATTN (F6) Attn key
409             // VK_CRSEL (F7) CrSel key
410             // VK_EXSEL (F8) ExSel key
411             // VK_EREOF (F9) Erase EOF key
412             // VK_PLAY (FA) Play key
413             // VK_ZOOM (FB) Zoom key
414             // VK_NONAME (FC) Reserved for future use
415             // VK_PA1 (FD) PA1 key
416             // VK_OEM_CLEAR (FE) Clear key
417         default:
418             return 0;
419     }
420
421 }
422
423 PlatformKeyboardEvent::PlatformKeyboardEvent(QKeyEvent* event, bool isKeyUp)
424 {
425     m_text = fromQString(event->text());
426     m_unmodifiedText = fromQString(event->text()); // TODO: not correct
427     m_keyIdentifier = keyIdentifierForQtKeyCode(event->key());
428     m_isKeyUp = isKeyUp;
429     m_autoRepeat = event->isAutoRepeat();
430     m_WindowsKeyCode = windowsKeyCodeForKeyEvent(event->key());
431     m_isKeypad = (event->modifiers() & Qt::KeypadModifier) != 0;
432     m_shiftKey = (event->modifiers() & Qt::ShiftModifier) != 0;
433     m_ctrlKey = (event->modifiers() & Qt::ControlModifier) != 0;
434     m_altKey = (event->modifiers() & Qt::AltModifier) != 0;
435     m_metaKey = (event->modifiers() & Qt::MetaModifier) != 0;    
436 }
437
438 }
439
440 // vim: ts=4 sw=4 et