KeyboardEvent.getModifierState() should support "CapsLock" modifier
[WebKit-https.git] / Source / WebCore / dom / KeyboardEvent.cpp
1 /**
2  * Copyright (C) 2001 Peter Kelly (pmk@post.com)
3  * Copyright (C) 2001 Tobias Anton (anton@stud.fbi.fh-darmstadt.de)
4  * Copyright (C) 2006 Samuel Weinig (sam.weinig@gmail.com)
5  * Copyright (C) 2003, 2005, 2006, 2007, 2013 Apple Inc. All rights reserved.
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public License
18  * along with this library; see the file COPYING.LIB.  If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20  * Boston, MA 02110-1301, USA.
21  */
22
23 #include "config.h"
24 #include "KeyboardEvent.h"
25
26 #include "Document.h"
27 #include "Editor.h"
28 #include "EventDispatcher.h"
29 #include "EventHandler.h"
30 #include "EventNames.h"
31 #include "Frame.h"
32 #include "PlatformKeyboardEvent.h"
33 #include "Settings.h"
34 #include "WindowsKeyboardCodes.h"
35
36 namespace WebCore {
37
38 static inline const AtomicString& eventTypeForKeyboardEventType(PlatformEvent::Type type)
39 {
40     switch (type) {
41         case PlatformEvent::KeyUp:
42             return eventNames().keyupEvent;
43         case PlatformEvent::RawKeyDown:
44             return eventNames().keydownEvent;
45         case PlatformEvent::Char:
46             return eventNames().keypressEvent;
47         case PlatformEvent::KeyDown:
48             // The caller should disambiguate the combined event into RawKeyDown or Char events.
49             break;
50         default:
51             break;
52     }
53     ASSERT_NOT_REACHED();
54     return eventNames().keydownEvent;
55 }
56
57 static inline int windowsVirtualKeyCodeWithoutLocation(int keycode)
58 {
59     switch (keycode) {
60     case VK_LCONTROL:
61     case VK_RCONTROL:
62         return VK_CONTROL;
63     case VK_LSHIFT:
64     case VK_RSHIFT:
65         return VK_SHIFT;
66     case VK_LMENU:
67     case VK_RMENU:
68         return VK_MENU;
69     default:
70         return keycode;
71     }
72 }
73
74 static inline KeyboardEvent::KeyLocationCode keyLocationCode(const PlatformKeyboardEvent& key)
75 {
76     if (key.isKeypad())
77         return KeyboardEvent::DOM_KEY_LOCATION_NUMPAD;
78
79     switch (key.windowsVirtualKeyCode()) {
80     case VK_LCONTROL:
81     case VK_LSHIFT:
82     case VK_LMENU:
83     case VK_LWIN:
84         return KeyboardEvent::DOM_KEY_LOCATION_LEFT;
85     case VK_RCONTROL:
86     case VK_RSHIFT:
87     case VK_RMENU:
88     case VK_RWIN:
89         return KeyboardEvent::DOM_KEY_LOCATION_RIGHT;
90     default:
91         return KeyboardEvent::DOM_KEY_LOCATION_STANDARD;
92     }
93 }
94
95 KeyboardEvent::KeyboardEvent() = default;
96
97 KeyboardEvent::KeyboardEvent(const PlatformKeyboardEvent& key, DOMWindow* view)
98     : UIEventWithKeyState(eventTypeForKeyboardEventType(key.type()),
99                           true, true, key.timestamp(), view, 0, key.ctrlKey(), key.altKey(), key.shiftKey(), key.metaKey())
100     , m_keyEvent(std::make_unique<PlatformKeyboardEvent>(key))
101 #if ENABLE(KEYBOARD_KEY_ATTRIBUTE)
102     , m_key(key.key())
103 #endif
104 #if ENABLE(KEYBOARD_CODE_ATTRIBUTE)
105     , m_code(key.code())
106 #endif
107     , m_keyIdentifier(key.keyIdentifier())
108     , m_location(keyLocationCode(key))
109     , m_repeat(key.isAutoRepeat())
110     , m_altGraphKey(false)
111     , m_capsLockKey(key.modifiers().contains(PlatformEvent::Modifier::CapsLockKey))
112     , m_isComposing(view && view->frame() && view->frame()->editor().hasComposition())
113 #if PLATFORM(COCOA)
114 #if USE(APPKIT)
115     , m_handledByInputMethod(key.handledByInputMethod())
116     , m_keypressCommands(key.commands())
117 #else
118     , m_handledByInputMethod(false)
119 #endif
120 #endif
121 {
122 }
123
124 // FIXME: This method should be get ride of in the future.
125 // DO NOT USE IT!
126 KeyboardEvent::KeyboardEvent(WTF::HashTableDeletedValueType)
127 {
128 }
129
130 KeyboardEvent::KeyboardEvent(const AtomicString& eventType, const KeyboardEventInit& initializer)
131     : UIEventWithKeyState(eventType, initializer)
132 #if ENABLE(KEYBOARD_KEY_ATTRIBUTE)
133     , m_key(initializer.key)
134 #endif
135 #if ENABLE(KEYBOARD_CODE_ATTRIBUTE)
136     , m_code(initializer.code)
137 #endif
138     , m_keyIdentifier(initializer.keyIdentifier)
139     , m_location(initializer.location)
140     , m_repeat(initializer.repeat)
141     , m_altGraphKey(false) // FIXME: should be initialized from initializer.modifierAltGraph.
142     , m_capsLockKey(false) // FIXME: should be initialized from initializer.modifierCapsLock.
143     , m_isComposing(initializer.isComposing)
144 #if PLATFORM(COCOA)
145     , m_handledByInputMethod(false)
146 #endif
147 {
148 }
149
150 KeyboardEvent::~KeyboardEvent()
151 {
152 }
153
154 void KeyboardEvent::initKeyboardEvent(const AtomicString& type, bool canBubble, bool cancelable, DOMWindow* view,
155                                       const String &keyIdentifier, unsigned location,
156                                       bool ctrlKey, bool altKey, bool shiftKey, bool metaKey, bool altGraphKey)
157 {
158     if (dispatched())
159         return;
160
161     initUIEvent(type, canBubble, cancelable, view, 0);
162
163     m_keyIdentifier = keyIdentifier;
164     m_location = location;
165     m_ctrlKey = ctrlKey;
166     m_shiftKey = shiftKey;
167     m_altKey = altKey;
168     m_metaKey = metaKey;
169     m_altGraphKey = altGraphKey;
170 }
171
172 bool KeyboardEvent::getModifierState(const String& keyIdentifier) const
173 {
174     if (keyIdentifier == "Control")
175         return ctrlKey();
176     if (keyIdentifier == "Shift")
177         return shiftKey();
178     if (keyIdentifier == "Alt")
179         return altKey();
180     if (keyIdentifier == "Meta")
181         return metaKey();
182     if (keyIdentifier == "AltGraph")
183         return altGraphKey();
184     if (keyIdentifier == "CapsLock")
185         return m_capsLockKey;
186     // FIXME: The specification also has Fn, FnLock, Hyper, NumLock, Super, ScrollLock, Symbol, SymbolLock.
187     return false;
188 }
189
190 int KeyboardEvent::keyCode() const
191 {
192     // IE: virtual key code for keyup/keydown, character code for keypress
193     // Firefox: virtual key code for keyup/keydown, zero for keypress
194     // We match IE.
195     if (!m_keyEvent)
196         return 0;
197     if (type() == eventNames().keydownEvent || type() == eventNames().keyupEvent)
198         return windowsVirtualKeyCodeWithoutLocation(m_keyEvent->windowsVirtualKeyCode());
199
200     return charCode();
201 }
202
203 int KeyboardEvent::charCode() const
204 {
205     // IE: not supported
206     // Firefox: 0 for keydown/keyup events, character code for keypress
207     // We match Firefox, unless in backward compatibility mode, where we always return the character code.
208     bool backwardCompatibilityMode = false;
209     if (view() && view()->frame())
210         backwardCompatibilityMode = view()->frame()->eventHandler().needsKeyboardEventDisambiguationQuirks();
211
212     if (!m_keyEvent || (type() != eventNames().keypressEvent && !backwardCompatibilityMode))
213         return 0;
214     String text = m_keyEvent->text();
215     return static_cast<int>(text.characterStartingAt(0));
216 }
217
218 EventInterface KeyboardEvent::eventInterface() const
219 {
220     return KeyboardEventInterfaceType;
221 }
222
223 bool KeyboardEvent::isKeyboardEvent() const
224 {
225     return true;
226 }
227
228 int KeyboardEvent::which() const
229 {
230     // Netscape's "which" returns a virtual key code for keydown and keyup, and a character code for keypress.
231     // That's exactly what IE's "keyCode" returns. So they are the same for keyboard events.
232     return keyCode();
233 }
234
235 KeyboardEvent* findKeyboardEvent(Event* event)
236 {
237     for (Event* e = event; e; e = e->underlyingEvent())
238         if (is<KeyboardEvent>(*e))
239             return downcast<KeyboardEvent>(e);
240     return nullptr;
241 }
242
243 } // namespace WebCore