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