Add support for KeyboardEvent.getModifierState() operation
[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 "EventDispatcher.h"
28 #include "EventHandler.h"
29 #include "EventNames.h"
30 #include "Frame.h"
31 #include "PlatformKeyboardEvent.h"
32 #include "Settings.h"
33 #include "WindowsKeyboardCodes.h"
34
35 namespace WebCore {
36
37 static inline const AtomicString& eventTypeForKeyboardEventType(PlatformEvent::Type type)
38 {
39     switch (type) {
40         case PlatformEvent::KeyUp:
41             return eventNames().keyupEvent;
42         case PlatformEvent::RawKeyDown:
43             return eventNames().keydownEvent;
44         case PlatformEvent::Char:
45             return eventNames().keypressEvent;
46         case PlatformEvent::KeyDown:
47             // The caller should disambiguate the combined event into RawKeyDown or Char events.
48             break;
49         default:
50             break;
51     }
52     ASSERT_NOT_REACHED();
53     return eventNames().keydownEvent;
54 }
55
56 static inline int windowsVirtualKeyCodeWithoutLocation(int keycode)
57 {
58     switch (keycode) {
59     case VK_LCONTROL:
60     case VK_RCONTROL:
61         return VK_CONTROL;
62     case VK_LSHIFT:
63     case VK_RSHIFT:
64         return VK_SHIFT;
65     case VK_LMENU:
66     case VK_RMENU:
67         return VK_MENU;
68     default:
69         return keycode;
70     }
71 }
72
73 static inline KeyboardEvent::KeyLocationCode keyLocationCode(const PlatformKeyboardEvent& key)
74 {
75     if (key.isKeypad())
76         return KeyboardEvent::DOM_KEY_LOCATION_NUMPAD;
77
78     switch (key.windowsVirtualKeyCode()) {
79     case VK_LCONTROL:
80     case VK_LSHIFT:
81     case VK_LMENU:
82     case VK_LWIN:
83         return KeyboardEvent::DOM_KEY_LOCATION_LEFT;
84     case VK_RCONTROL:
85     case VK_RSHIFT:
86     case VK_RMENU:
87     case VK_RWIN:
88         return KeyboardEvent::DOM_KEY_LOCATION_RIGHT;
89     default:
90         return KeyboardEvent::DOM_KEY_LOCATION_STANDARD;
91     }
92 }
93
94 KeyboardEvent::KeyboardEvent()
95     : m_location(DOM_KEY_LOCATION_STANDARD)
96     , m_altGraphKey(false)
97 #if PLATFORM(COCOA)
98     , m_handledByInputMethod(false)
99 #endif
100 {
101 }
102
103 KeyboardEvent::KeyboardEvent(const PlatformKeyboardEvent& key, DOMWindow* view)
104     : UIEventWithKeyState(eventTypeForKeyboardEventType(key.type()),
105                           true, true, key.timestamp(), view, 0, key.ctrlKey(), key.altKey(), key.shiftKey(), key.metaKey())
106     , m_keyEvent(std::make_unique<PlatformKeyboardEvent>(key))
107     , m_keyIdentifier(key.keyIdentifier())
108     , m_location(keyLocationCode(key))
109     , m_repeat(key.isAutoRepeat())
110     , m_altGraphKey(false)
111 #if PLATFORM(COCOA)
112 #if USE(APPKIT)
113     , m_handledByInputMethod(key.handledByInputMethod())
114     , m_keypressCommands(key.commands())
115 #else
116     , m_handledByInputMethod(false)
117 #endif
118 #endif
119 {
120 }
121
122 // FIXME: This method should be get ride of in the future.
123 // DO NOT USE IT!
124 KeyboardEvent::KeyboardEvent(WTF::HashTableDeletedValueType)
125 {
126 }
127
128 KeyboardEvent::KeyboardEvent(const AtomicString& eventType, const KeyboardEventInit& initializer)
129     : UIEventWithKeyState(eventType, initializer)
130     , m_keyIdentifier(initializer.keyIdentifier)
131     , m_location(initializer.location)
132     , m_repeat(initializer.repeat)
133     , m_altGraphKey(false)
134 #if PLATFORM(COCOA)
135     , m_handledByInputMethod(false)
136 #endif
137 {
138 }
139
140 KeyboardEvent::~KeyboardEvent()
141 {
142 }
143
144 void KeyboardEvent::initKeyboardEvent(const AtomicString& type, bool canBubble, bool cancelable, DOMWindow* view,
145                                       const String &keyIdentifier, unsigned location,
146                                       bool ctrlKey, bool altKey, bool shiftKey, bool metaKey, bool altGraphKey)
147 {
148     if (dispatched())
149         return;
150
151     initUIEvent(type, canBubble, cancelable, view, 0);
152
153     m_keyIdentifier = keyIdentifier;
154     m_location = location;
155     m_ctrlKey = ctrlKey;
156     m_shiftKey = shiftKey;
157     m_altKey = altKey;
158     m_metaKey = metaKey;
159     m_altGraphKey = altGraphKey;
160 }
161
162 bool KeyboardEvent::getModifierState(const String& keyIdentifier) const
163 {
164     if (keyIdentifier == "Control")
165         return ctrlKey();
166     if (keyIdentifier == "Shift")
167         return shiftKey();
168     if (keyIdentifier == "Alt")
169         return altKey();
170     if (keyIdentifier == "Meta")
171         return metaKey();
172     if (keyIdentifier == "AltGraph")
173         return altGraphKey();
174     // FIXME: We should support CapsLock, Fn, FnLock, Hyper, NumLock, Super, ScrollLock, Symbol, SymbolLock.
175     return false;
176 }
177
178 int KeyboardEvent::keyCode() const
179 {
180     // IE: virtual key code for keyup/keydown, character code for keypress
181     // Firefox: virtual key code for keyup/keydown, zero for keypress
182     // We match IE.
183     if (!m_keyEvent)
184         return 0;
185     if (type() == eventNames().keydownEvent || type() == eventNames().keyupEvent)
186         return windowsVirtualKeyCodeWithoutLocation(m_keyEvent->windowsVirtualKeyCode());
187
188     return charCode();
189 }
190
191 int KeyboardEvent::charCode() const
192 {
193     // IE: not supported
194     // Firefox: 0 for keydown/keyup events, character code for keypress
195     // We match Firefox, unless in backward compatibility mode, where we always return the character code.
196     bool backwardCompatibilityMode = false;
197     if (view() && view()->frame())
198         backwardCompatibilityMode = view()->frame()->eventHandler().needsKeyboardEventDisambiguationQuirks();
199
200     if (!m_keyEvent || (type() != eventNames().keypressEvent && !backwardCompatibilityMode))
201         return 0;
202     String text = m_keyEvent->text();
203     return static_cast<int>(text.characterStartingAt(0));
204 }
205
206 EventInterface KeyboardEvent::eventInterface() const
207 {
208     return KeyboardEventInterfaceType;
209 }
210
211 bool KeyboardEvent::isKeyboardEvent() const
212 {
213     return true;
214 }
215
216 int KeyboardEvent::which() const
217 {
218     // Netscape's "which" returns a virtual key code for keydown and keyup, and a character code for keypress.
219     // That's exactly what IE's "keyCode" returns. So they are the same for keyboard events.
220     return keyCode();
221 }
222
223 KeyboardEvent* findKeyboardEvent(Event* event)
224 {
225     for (Event* e = event; e; e = e->underlyingEvent())
226         if (is<KeyboardEvent>(*e))
227             return downcast<KeyboardEvent>(e);
228     return nullptr;
229 }
230
231 } // namespace WebCore