[iOS] Draw caps lock indicator in password fields
[WebKit-https.git] / Source / WebCore / platform / ios / KeyEventIOS.mm
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 "PlatformKeyboardEvent.h"
28
29 #if PLATFORM(IOS_FAMILY)
30
31 #import "KeyEventCocoa.h"
32 #import "KeyEventCodesIOS.h"
33 #import "NotImplemented.h"
34 #import "WebEvent.h"
35 #import "WindowsKeyboardCodes.h"
36 #import <pal/spi/cocoa/IOKitSPI.h>
37 #import <wtf/MainThread.h>
38
39 using namespace WTF;
40
41 namespace WebCore {
42
43 int windowsKeyCodeForKeyCode(uint16_t keyCode)
44 {
45     static const int windowsKeyCode[] = {
46         /* 0 */ 0, // n/a
47         /* 1 */ 0, // n/a
48         /* 2 */ 0, // n/a
49         /* 3 */ 0, // n/a
50         /* 4 */ VK_A,
51         /* 5 */ VK_B,
52         /* 6 */ VK_C,
53         /* 7 */ VK_D,
54         /* 8 */ VK_E,
55         /* 9 */ VK_F,
56         /* 0x0A */ VK_G,
57         /* 0x0B */ VK_H,
58         /* 0x0C */ VK_I,
59         /* 0x0D */ VK_J,
60         /* 0x0E */ VK_K,
61         /* 0x0F */ VK_L,
62         /* 0x10 */ VK_M,
63         /* 0x11 */ VK_N,
64         /* 0x12 */ VK_O,
65         /* 0x13 */ VK_P,
66         /* 0x14 */ VK_Q,
67         /* 0x15 */ VK_R,
68         /* 0x16 */ VK_S,
69         /* 0x17 */ VK_T,
70         /* 0x18 */ VK_U,
71         /* 0x19 */ VK_V,
72         /* 0x1A */ VK_W,
73         /* 0x1B */ VK_X,
74         /* 0x1C */ VK_Y,
75         /* 0x1D */ VK_Z,
76         /* 0x1E */ VK_1,
77         /* 0x1F */ VK_2,
78         /* 0x20 */ VK_3,
79         /* 0x21 */ VK_4,
80         /* 0x22 */ VK_5,
81         /* 0x23 */ VK_6,
82         /* 0x24 */ VK_7,
83         /* 0x25 */ VK_8,
84         /* 0x26 */ VK_9,
85         /* 0x27 */ VK_0,
86         /* 0x28 */ VK_RETURN, // Return
87         /* 0x29 */ VK_ESCAPE,
88         /* 0x2A */ VK_BACK, // Backspace
89         /* 0x2B */ VK_TAB,
90         /* 0x2C */ VK_SPACE,
91         /* 0x2D */ VK_OEM_MINUS, // -_
92         /* 0x2E */ VK_OEM_PLUS, // =+
93         /* 0x2F */ VK_OEM_4, // [{
94         /* 0x30 */ VK_OEM_6, // ]}
95         /* 0x31 */ VK_OEM_5, // \|
96         /* 0x32 */ 0, // kHIDUsage_KeyboardNonUSPound
97         /* 0x33 */ VK_OEM_1, // ;:
98         /* 0x34 */ VK_OEM_7, // '"
99         /* 0x35 */ VK_OEM_3, // `~
100         /* 0x36 */ VK_OEM_COMMA, // ,<
101         /* 0x37 */ VK_OEM_PERIOD, // .>
102         /* 0x38 */ VK_OEM_2, // /?
103         /* 0x39 */ VK_CAPITAL, // Caps Lock
104         /* 0x3A */ VK_F1,
105         /* 0x3B */ VK_F2,
106         /* 0x3C */ VK_F3,
107         /* 0x3D */ VK_F4,
108         /* 0x3E */ VK_F5,
109         /* 0x3F */ VK_F6,
110         /* 0x40 */ VK_F7,
111         /* 0x41 */ VK_F8,
112         /* 0x42 */ VK_F9,
113         /* 0x43 */ VK_F10,
114         /* 0x44 */ VK_F11,
115         /* 0x45 */ VK_F12,
116         /* 0x46 */ VK_SNAPSHOT, // Print Screen
117         /* 0x47 */ VK_SCROLL, // Scroll Lock
118         /* 0x48 */ VK_PAUSE,
119         /* 0x49 */ VK_INSERT,
120         /* 0x4A */ VK_HOME, // Home
121         /* 0x4B */ VK_PRIOR, // Page Up
122         /* 0x4C */ VK_DELETE, // Forward Delete
123         /* 0x4D */ VK_END, // End
124         /* 0x4E */ VK_NEXT, // Page Down
125         /* 0x4F */ VK_RIGHT, // Right Arrow
126         /* 0x50 */ VK_LEFT, // Left Arrow
127         /* 0x51 */ VK_DOWN, // Down Arrow
128         /* 0x52 */ VK_UP, // Up Arrow
129         /* 0x53 */ VK_CLEAR, // Num Pad Clear
130         /* 0x54 */ VK_DIVIDE, // Num Pad /
131         /* 0x55 */ VK_MULTIPLY, // Num Pad *
132         /* 0x56 */ VK_SUBTRACT, // Num Pad -
133         /* 0x57 */ VK_ADD, // Num Pad +
134         /* 0x58 */ VK_RETURN, // Num Pad Enter
135         /* 0x59 */ VK_NUMPAD1,
136         /* 0x5A */ VK_NUMPAD2,
137         /* 0x5B */ VK_NUMPAD3,
138         /* 0x5C */ VK_NUMPAD4,
139         /* 0x5D */ VK_NUMPAD5,
140         /* 0x5E */ VK_NUMPAD6,
141         /* 0x5F */ VK_NUMPAD7,
142         /* 0x60 */ VK_NUMPAD8,
143         /* 0x61 */ VK_NUMPAD9,
144         /* 0x62 */ VK_NUMPAD0,
145         /* 0x63 */ VK_DECIMAL, // Num Pad .
146         /* 0x64 */ 0, // Non-ANSI \|
147         /* 0x65 */ 0, // Application
148         /* 0x66 */ 0, // Power
149         /* 0x67 */ VK_OEM_PLUS, // Num Pad =. There is no such key on common PC keyboards, mapping to normal "+=".
150         /* 0x68 */ VK_F13,
151         /* 0x69 */ VK_F14,
152         /* 0x6A */ VK_F15,
153         /* 0x6B */ VK_F16,
154         /* 0x6C */ VK_F17,
155         /* 0x6D */ VK_F18,
156         /* 0x6E */ VK_F19,
157         /* 0x6F */ VK_F20,
158         /* 0x70 */ VK_F21,
159         /* 0x71 */ VK_F22,
160         /* 0x72 */ VK_F23,
161         /* 0x73 */ VK_F24,
162         /* 0x74 */ VK_EXECUTE,
163         /* 0x75 */ VK_INSERT, // Help
164         /* 0x76 */ 0, // Menu
165         /* 0x77 */ VK_SELECT,
166         /* 0x78 */ 0, // Stop
167         /* 0x79 */ 0, // Again
168         /* 0x7A */ 0, // Undo
169         /* 0x7B */ 0, // Cut
170         /* 0x7C */ 0, // Copy
171         /* 0x7D */ 0, // Paste
172         /* 0x7E */ 0, // Find
173         /* 0x7F */ VK_VOLUME_MUTE, // Mute
174         /* 0x80 */ VK_VOLUME_UP, // Volume Up
175         /* 0x81 */ VK_VOLUME_DOWN, // Volume Down
176     };
177     // Check if key is a modifier.
178     switch (keyCode) {
179     case kHIDUsage_KeyboardLeftControl:
180         return VK_LCONTROL;
181     case kHIDUsage_KeyboardLeftShift:
182         return VK_LSHIFT;
183     case kHIDUsage_KeyboardLeftAlt: // Left Option
184         return VK_LMENU;
185     case kHIDUsage_KeyboardLeftGUI: // Left Command
186         return VK_LWIN;
187     case kHIDUsage_KeyboardRightControl:
188         return VK_RCONTROL;
189     case kHIDUsage_KeyboardRightShift:
190         return VK_RSHIFT;
191     case kHIDUsage_KeyboardRightAlt: // Right Option
192         return VK_RMENU;
193     case kHIDUsage_KeyboardRightGUI: // Right Command
194         return VK_APPS;
195     }
196     // Otherwise check all other known keys.
197     if (keyCode < WTF_ARRAY_LENGTH(windowsKeyCode))
198         return windowsKeyCode[keyCode];
199     return 0; // Unknown key
200 }
201
202 int windowsKeyCodeForCharCode(unichar charCode)
203 {
204     switch (charCode) {
205     case 8: case 0x7F: return VK_BACK;
206     case 9: return VK_TAB;
207     case 0xD: case 3: return VK_RETURN;
208     case 0x1B: return VK_ESCAPE; // WebKit generated code for Escape.
209     case ' ': return VK_SPACE;
210
211     case '0': case ')': return VK_0;
212     case '1': case '!': return VK_1;
213     case '2': case '@': return VK_2;
214     case '3': case '#': return VK_3;
215     case '4': case '$': return VK_4;
216     case '5': case '%': return VK_5;
217     case '6': case '^': return VK_6;
218     case '7': case '&': return VK_7;
219     case '8': case '*': return VK_8;
220     case '9': case '(': return VK_9;
221     case 'a': case 'A': return VK_A;
222     case 'b': case 'B': return VK_B;
223     case 'c': case 'C': return VK_C;
224     case 'd': case 'D': return VK_D;
225     case 'e': case 'E': return VK_E;
226     case 'f': case 'F': return VK_F;
227     case 'g': case 'G': return VK_G;
228     case 'h': case 'H': return VK_H;
229     case 'i': case 'I': return VK_I;
230     case 'j': case 'J': return VK_J;
231     case 'k': case 'K': return VK_K;
232     case 'l': case 'L': return VK_L;
233     case 'm': case 'M': return VK_M;
234     case 'n': case 'N': return VK_N;
235     case 'o': case 'O': return VK_O;
236     case 'p': case 'P': return VK_P;
237     case 'q': case 'Q': return VK_Q;
238     case 'r': case 'R': return VK_R;
239     case 's': case 'S': return VK_S;
240     case 't': case 'T': return VK_T;
241     case 'u': case 'U': return VK_U;
242     case 'v': case 'V': return VK_V;
243     case 'w': case 'W': return VK_W;
244     case 'x': case 'X': return VK_X;
245     case 'y': case 'Y': return VK_Y;
246     case 'z': case 'Z': return VK_Z;
247
248     // WebKit uses Unicode PUA codes in the OpenStep reserve range for some special keys.
249     case NSUpArrowFunctionKey: return VK_UP;
250     case NSDownArrowFunctionKey: return VK_DOWN;
251     case NSLeftArrowFunctionKey: return VK_LEFT;
252     case NSRightArrowFunctionKey: return VK_RIGHT;
253     case NSPageUpFunctionKey: return VK_PRIOR;
254     case NSPageDownFunctionKey: return VK_NEXT;
255
256     // This is for U.S. keyboard mapping, and doesn't necessarily make sense for different keyboard layouts.
257     // For example, '"' on Windows Russian layout is VK_2, not VK_OEM_7.
258     case ';': case ':': return VK_OEM_1;
259     case '=': case '+': return VK_OEM_PLUS;
260     case ',': case '<': return VK_OEM_COMMA;
261     case '-': case '_': return VK_OEM_MINUS;
262     case '.': case '>': return VK_OEM_PERIOD;
263     case '/': case '?': return VK_OEM_2;
264     case '`': case '~': return VK_OEM_3;
265     case '[': case '{': return VK_OEM_4;
266     case '\\': case '|': return VK_OEM_5;
267     case ']': case '}': return VK_OEM_6;
268     case '\'': case '"': return VK_OEM_7;
269     }
270     return 0;
271 }
272
273 static bool isFunctionKey(UChar charCode)
274 {
275     switch (charCode) {
276     case 1: // Home
277     case 4: // End
278     case 5: // FIXME: For some reason WebKitTestRunner generates this code for F14 (why?).
279     case 0x7F: // Forward Delete
280     case 0x10: // Function key (e.g. F1, F2, ...)
281
282     // WebKit uses Unicode PUA codes in the OpenStep reserve range for some special keys.
283     case NSUpArrowFunctionKey:
284     case NSDownArrowFunctionKey:
285     case NSLeftArrowFunctionKey:
286     case NSRightArrowFunctionKey:
287     case NSPageUpFunctionKey:
288     case NSPageDownFunctionKey:
289     case NSClearLineFunctionKey: // Num Lock / Clear
290         return true;
291     }
292     return false;
293 }
294
295 void PlatformKeyboardEvent::disambiguateKeyDownEvent(Type type, bool backwardCompatibilityMode)
296 {
297     // Can only change type from KeyDown to RawKeyDown or Char, as we lack information for other conversions.
298     ASSERT(m_type == KeyDown);
299     ASSERT(type == RawKeyDown || type == Char);
300     m_type = type;
301     if (backwardCompatibilityMode)
302         return;
303
304     if (type == PlatformEvent::RawKeyDown) {
305         m_text = String();
306         m_unmodifiedText = String();
307     } else {
308         m_keyIdentifier = String();
309         m_windowsVirtualKeyCode = 0;
310         if (m_text.length() == 1 && isFunctionKey(m_text[0U])) {
311             m_text = String();
312             m_unmodifiedText = String();
313         }
314     }
315 }
316
317 OptionSet<PlatformEvent::Modifier> PlatformKeyboardEvent::currentStateOfModifierKeys()
318 {
319     // s_currentModifiers is only set in the WebContent process, not in the UI process.
320     if (s_currentModifiers) {
321         ASSERT(isMainThread());
322         return *s_currentModifiers;
323     }
324
325     ::WebEventFlags currentModifiers = [::WebEvent modifierFlags];
326
327     OptionSet<PlatformEvent::Modifier> modifiers;
328     if (currentModifiers & ::WebEventFlagMaskShiftKey)
329         modifiers.add(PlatformEvent::Modifier::ShiftKey);
330     if (currentModifiers & ::WebEventFlagMaskControlKey)
331         modifiers.add(PlatformEvent::Modifier::CtrlKey);
332     if (currentModifiers & ::WebEventFlagMaskOptionKey)
333         modifiers.add(PlatformEvent::Modifier::AltKey);
334     if (currentModifiers & ::WebEventFlagMaskCommandKey)
335         modifiers.add(PlatformEvent::Modifier::MetaKey);
336     if (currentModifiers & ::WebEventFlagMaskLeftCapsLockKey)
337         modifiers.add(PlatformEvent::Modifier::CapsLockKey);
338
339     return modifiers;
340 }
341
342 }
343
344 #endif // PLATFORM(IOS_FAMILY)