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