REGRESSION (r230523): Caps lock indicator not shown in password field
[WebKit-https.git] / Source / WebCore / platform / mac / KeyEventMac.mm
1 /*
2  * Copyright (C) 2004, 2006, 2007, 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(MAC)
30
31 #import "KeyEventCocoa.h"
32 #import "Logging.h"
33 #import "WindowsKeyboardCodes.h"
34 #import <Carbon/Carbon.h>
35 #import <wtf/MainThread.h>
36
37 namespace WebCore {
38 using namespace WTF;
39
40 int windowsKeyCodeForKeyCode(uint16_t keyCode)
41 {
42     static const int windowsKeyCode[] = {
43         /* 0 */ VK_A,
44         /* 1 */ VK_S,
45         /* 2 */ VK_D,
46         /* 3 */ VK_F,
47         /* 4 */ VK_H,
48         /* 5 */ VK_G,
49         /* 6 */ VK_Z,
50         /* 7 */ VK_X,
51         /* 8 */ VK_C,
52         /* 9 */ VK_V,
53         /* 0x0A */ VK_OEM_3, // "Section" - key to the left from 1 (ISO Keyboard Only)
54         /* 0x0B */ VK_B,
55         /* 0x0C */ VK_Q,
56         /* 0x0D */ VK_W,
57         /* 0x0E */ VK_E,
58         /* 0x0F */ VK_R,
59         /* 0x10 */ VK_Y,
60         /* 0x11 */ VK_T,
61         /* 0x12 */ VK_1,
62         /* 0x13 */ VK_2,
63         /* 0x14 */ VK_3,
64         /* 0x15 */ VK_4,
65         /* 0x16 */ VK_6,
66         /* 0x17 */ VK_5,
67         /* 0x18 */ VK_OEM_PLUS, // =+
68         /* 0x19 */ VK_9,
69         /* 0x1A */ VK_7,
70         /* 0x1B */ VK_OEM_MINUS, // -_
71         /* 0x1C */ VK_8,
72         /* 0x1D */ VK_0,
73         /* 0x1E */ VK_OEM_6, // ]}
74         /* 0x1F */ VK_O,
75         /* 0x20 */ VK_U,
76         /* 0x21 */ VK_OEM_4, // {[
77         /* 0x22 */ VK_I,
78         /* 0x23 */ VK_P,
79         /* 0x24 */ VK_RETURN, // Return
80         /* 0x25 */ VK_L,
81         /* 0x26 */ VK_J,
82         /* 0x27 */ VK_OEM_7, // '"
83         /* 0x28 */ VK_K,
84         /* 0x29 */ VK_OEM_1, // ;:
85         /* 0x2A */ VK_OEM_5, // \|
86         /* 0x2B */ VK_OEM_COMMA, // ,<
87         /* 0x2C */ VK_OEM_2, // /?
88         /* 0x2D */ VK_N,
89         /* 0x2E */ VK_M,
90         /* 0x2F */ VK_OEM_PERIOD, // .>
91         /* 0x30 */ VK_TAB,
92         /* 0x31 */ VK_SPACE,
93         /* 0x32 */ VK_OEM_3, // `~
94         /* 0x33 */ VK_BACK, // Backspace
95         /* 0x34 */ 0, // n/a
96         /* 0x35 */ VK_ESCAPE,
97         /* 0x36 */ VK_APPS, // Right Command
98         /* 0x37 */ VK_LWIN, // Left Command
99         /* 0x38 */ VK_LSHIFT, // Left Shift
100         /* 0x39 */ VK_CAPITAL, // Caps Lock
101         /* 0x3A */ VK_LMENU, // Left Option
102         /* 0x3B */ VK_LCONTROL, // Left Ctrl
103         /* 0x3C */ VK_RSHIFT, // Right Shift
104         /* 0x3D */ VK_RMENU, // Right Option
105         /* 0x3E */ VK_RCONTROL, // Right Ctrl
106         /* 0x3F */ 0, // fn
107         /* 0x40 */ VK_F17,
108         /* 0x41 */ VK_DECIMAL, // Num Pad .
109         /* 0x42 */ 0, // n/a
110         /* 0x43 */ VK_MULTIPLY, // Num Pad *
111         /* 0x44 */ 0, // n/a
112         /* 0x45 */ VK_ADD, // Num Pad +
113         /* 0x46 */ 0, // n/a
114         /* 0x47 */ VK_CLEAR, // Num Pad Clear
115         /* 0x48 */ VK_VOLUME_UP,
116         /* 0x49 */ VK_VOLUME_DOWN,
117         /* 0x4A */ VK_VOLUME_MUTE,
118         /* 0x4B */ VK_DIVIDE, // Num Pad /
119         /* 0x4C */ VK_RETURN, // Num Pad Enter
120         /* 0x4D */ 0, // n/a
121         /* 0x4E */ VK_SUBTRACT, // Num Pad -
122         /* 0x4F */ VK_F18,
123         /* 0x50 */ VK_F19,
124         /* 0x51 */ VK_OEM_PLUS, // Num Pad =. There is no such key on common PC keyboards, mapping to normal "+=".
125         /* 0x52 */ VK_NUMPAD0,
126         /* 0x53 */ VK_NUMPAD1,
127         /* 0x54 */ VK_NUMPAD2,
128         /* 0x55 */ VK_NUMPAD3,
129         /* 0x56 */ VK_NUMPAD4,
130         /* 0x57 */ VK_NUMPAD5,
131         /* 0x58 */ VK_NUMPAD6,
132         /* 0x59 */ VK_NUMPAD7,
133         /* 0x5A */ VK_F20,
134         /* 0x5B */ VK_NUMPAD8,
135         /* 0x5C */ VK_NUMPAD9,
136         /* 0x5D */ 0, // Yen (JIS Keyboard Only)
137         /* 0x5E */ 0, // Underscore (JIS Keyboard Only)
138         /* 0x5F */ 0, // KeypadComma (JIS Keyboard Only)
139         /* 0x60 */ VK_F5,
140         /* 0x61 */ VK_F6,
141         /* 0x62 */ VK_F7,
142         /* 0x63 */ VK_F3,
143         /* 0x64 */ VK_F8,
144         /* 0x65 */ VK_F9,
145         /* 0x66 */ 0, // Eisu (JIS Keyboard Only)
146         /* 0x67 */ VK_F11,
147         /* 0x68 */ 0, // Kana (JIS Keyboard Only)
148         /* 0x69 */ VK_F13,
149         /* 0x6A */ VK_F16,
150         /* 0x6B */ VK_F14,
151         /* 0x6C */ 0, // n/a
152         /* 0x6D */ VK_F10,
153         /* 0x6E */ 0, // n/a (Windows95 key?)
154         /* 0x6F */ VK_F12,
155         /* 0x70 */ 0, // n/a
156         /* 0x71 */ VK_F15,
157         /* 0x72 */ VK_INSERT, // Help
158         /* 0x73 */ VK_HOME, // Home
159         /* 0x74 */ VK_PRIOR, // Page Up
160         /* 0x75 */ VK_DELETE, // Forward Delete
161         /* 0x76 */ VK_F4,
162         /* 0x77 */ VK_END, // End
163         /* 0x78 */ VK_F2,
164         /* 0x79 */ VK_NEXT, // Page Down
165         /* 0x7A */ VK_F1,
166         /* 0x7B */ VK_LEFT, // Left Arrow
167         /* 0x7C */ VK_RIGHT, // Right Arrow
168         /* 0x7D */ VK_DOWN, // Down Arrow
169         /* 0x7E */ VK_UP, // Up Arrow
170     };
171     if (keyCode < WTF_ARRAY_LENGTH(windowsKeyCode))
172         return windowsKeyCode[keyCode];
173     return 0;
174 }
175
176 int windowsKeyCodeForCharCode(unichar charCode)
177 {
178     switch (charCode) {
179     case 'a': case 'A': return VK_A;
180     case 'b': case 'B': return VK_B;
181     case 'c': case 'C': return VK_C;
182     case 'd': case 'D': return VK_D;
183     case 'e': case 'E': return VK_E;
184     case 'f': case 'F': return VK_F;
185     case 'g': case 'G': return VK_G;
186     case 'h': case 'H': return VK_H;
187     case 'i': case 'I': return VK_I;
188     case 'j': case 'J': return VK_J;
189     case 'k': case 'K': return VK_K;
190     case 'l': case 'L': return VK_L;
191     case 'm': case 'M': return VK_M;
192     case 'n': case 'N': return VK_N;
193     case 'o': case 'O': return VK_O;
194     case 'p': case 'P': return VK_P;
195     case 'q': case 'Q': return VK_Q;
196     case 'r': case 'R': return VK_R;
197     case 's': case 'S': return VK_S;
198     case 't': case 'T': return VK_T;
199     case 'u': case 'U': return VK_U;
200     case 'v': case 'V': return VK_V;
201     case 'w': case 'W': return VK_W;
202     case 'x': case 'X': return VK_X;
203     case 'y': case 'Y': return VK_Y;
204     case 'z': case 'Z': return VK_Z;
205
206     // AppKit generates Unicode PUA character codes for some function keys; using these when key code is not known.
207     case NSPauseFunctionKey: return VK_PAUSE;
208     case NSSelectFunctionKey: return VK_SELECT;
209     case NSPrintFunctionKey: return VK_PRINT;
210     case NSExecuteFunctionKey: return VK_EXECUTE;
211     case NSPrintScreenFunctionKey: return VK_SNAPSHOT;
212     case NSInsertFunctionKey: return VK_INSERT;
213     case NSF21FunctionKey: return VK_F21;
214     case NSF22FunctionKey: return VK_F22;
215     case NSF23FunctionKey: return VK_F23;
216     case NSF24FunctionKey: return VK_F24;
217     case NSScrollLockFunctionKey: return VK_SCROLL;
218
219     // This is for U.S. keyboard mapping, and doesn't necessarily make sense for different keyboard layouts.
220     // For example, '"' on Windows Russian layout is VK_2, not VK_OEM_7.
221     case ';': case ':': return VK_OEM_1;
222     case '=': case '+': return VK_OEM_PLUS;
223     case ',': case '<': return VK_OEM_COMMA;
224     case '-': case '_': return VK_OEM_MINUS;
225     case '.': case '>': return VK_OEM_PERIOD;
226     case '/': case '?': return VK_OEM_2;
227     case '`': case '~': return VK_OEM_3;
228     case '[': case '{': return VK_OEM_4;
229     case '\\': case '|': return VK_OEM_5;
230     case ']': case '}': return VK_OEM_6;
231     case '\'': case '"': return VK_OEM_7;
232     }
233     return 0;
234 }
235
236 void PlatformKeyboardEvent::disambiguateKeyDownEvent(Type type, bool backwardCompatibilityMode)
237 {
238     // Can only change type from KeyDown to RawKeyDown or Char, as we lack information for other conversions.
239     ASSERT(m_type == KeyDown);
240     ASSERT(type == RawKeyDown || type == Char);
241     m_type = type;
242     if (backwardCompatibilityMode)
243         return;
244
245     if (type == RawKeyDown) {
246         m_text = String();
247         m_unmodifiedText = String();
248     } else {
249         m_keyIdentifier = String();
250         m_windowsVirtualKeyCode = 0;
251         if (m_text.length() == 1 && (m_text[0U] >= 0xF700 && m_text[0U] <= 0xF7FF)) {
252             // According to NSEvents.h, OpenStep reserves the range 0xF700-0xF8FF for function keys. However, some actual private use characters
253             // happen to be in this range, e.g. the Apple logo (Option+Shift+K).
254             // 0xF7FF is an arbitrary cut-off.
255             m_text = String();
256             m_unmodifiedText = String();
257         }
258     }
259 }
260
261 bool PlatformKeyboardEvent::currentCapsLockState()
262 {
263     auto currentModifiers = currentStateOfModifierKeys();
264     return currentModifiers.contains(PlatformEvent::Modifier::CapsLockKey);
265 }
266
267 void PlatformKeyboardEvent::getCurrentModifierState(bool& shiftKey, bool& ctrlKey, bool& altKey, bool& metaKey)
268 {
269     auto currentModifiers = currentStateOfModifierKeys();
270     shiftKey = currentModifiers.contains(PlatformEvent::Modifier::ShiftKey);
271     ctrlKey = currentModifiers.contains(PlatformEvent::Modifier::CtrlKey);
272     altKey = currentModifiers.contains(PlatformEvent::Modifier::AltKey);
273     metaKey = currentModifiers.contains(PlatformEvent::Modifier::MetaKey);
274 }
275
276 OptionSet<PlatformEvent::Modifier> PlatformKeyboardEvent::currentStateOfModifierKeys()
277 {
278 #if ENABLE(WEBPROCESS_WINDOWSERVER_BLOCKING)
279     // s_currentModifiers is only set in the WebContent process, not in the UI process.
280     if (s_currentModifiers) {
281         ASSERT(isMainThread());
282         return *s_currentModifiers;
283     }
284 #endif
285     UInt32 currentModifiers = GetCurrentKeyModifiers();
286
287     OptionSet<PlatformEvent::Modifier> modifiers;
288     if (currentModifiers & ::shiftKey)
289         modifiers.add(PlatformEvent::Modifier::ShiftKey);
290     if (currentModifiers & ::controlKey)
291         modifiers.add(PlatformEvent::Modifier::CtrlKey);
292     if (currentModifiers & ::optionKey)
293         modifiers.add(PlatformEvent::Modifier::AltKey);
294     if (currentModifiers & ::cmdKey)
295         modifiers.add(PlatformEvent::Modifier::MetaKey);
296     if (currentModifiers & ::alphaLock)
297         modifiers.add(PlatformEvent::Modifier::CapsLockKey);
298
299     return modifiers;
300 }
301
302 } // namespace WebCore
303
304 #endif // PLATFORM(MAC)