Stop pretending that AbstractView is a thing, it's not
[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_altGraphKey(false)
110 #if PLATFORM(COCOA)
111 #if USE(APPKIT)
112     , m_handledByInputMethod(key.handledByInputMethod())
113     , m_keypressCommands(key.commands())
114 #else
115     , m_handledByInputMethod(false)
116 #endif
117 #endif
118 {
119 }
120
121 // FIXME: This method should be get ride of in the future.
122 // DO NOT USE IT!
123 KeyboardEvent::KeyboardEvent(WTF::HashTableDeletedValueType)
124 {
125 }
126
127 KeyboardEvent::KeyboardEvent(const AtomicString& eventType, const KeyboardEventInit& initializer)
128     : UIEventWithKeyState(eventType, initializer)
129     , m_keyIdentifier(initializer.keyIdentifier)
130     , m_location(initializer.location)
131     , m_altGraphKey(false)
132 #if PLATFORM(COCOA)
133     , m_handledByInputMethod(false)
134 #endif
135 {
136 }
137
138 KeyboardEvent::~KeyboardEvent()
139 {
140 }
141
142 void KeyboardEvent::initKeyboardEvent(const AtomicString& type, bool canBubble, bool cancelable, DOMWindow* view,
143                                       const String &keyIdentifier, unsigned location,
144                                       bool ctrlKey, bool altKey, bool shiftKey, bool metaKey, bool altGraphKey)
145 {
146     if (dispatched())
147         return;
148
149     initUIEvent(type, canBubble, cancelable, view, 0);
150
151     m_keyIdentifier = keyIdentifier;
152     m_location = location;
153     m_ctrlKey = ctrlKey;
154     m_shiftKey = shiftKey;
155     m_altKey = altKey;
156     m_metaKey = metaKey;
157     m_altGraphKey = altGraphKey;
158 }
159
160 bool KeyboardEvent::getModifierState(const String& keyIdentifier) const
161 {
162     if (keyIdentifier == "Control")
163         return ctrlKey();
164     if (keyIdentifier == "Shift")
165         return shiftKey();
166     if (keyIdentifier == "Alt")
167         return altKey();
168     if (keyIdentifier == "Meta")
169         return metaKey();
170     return false;
171 }
172
173 int KeyboardEvent::keyCode() const
174 {
175     // IE: virtual key code for keyup/keydown, character code for keypress
176     // Firefox: virtual key code for keyup/keydown, zero for keypress
177     // We match IE.
178     if (!m_keyEvent)
179         return 0;
180     if (type() == eventNames().keydownEvent || type() == eventNames().keyupEvent)
181         return windowsVirtualKeyCodeWithoutLocation(m_keyEvent->windowsVirtualKeyCode());
182
183     return charCode();
184 }
185
186 int KeyboardEvent::charCode() const
187 {
188     // IE: not supported
189     // Firefox: 0 for keydown/keyup events, character code for keypress
190     // We match Firefox, unless in backward compatibility mode, where we always return the character code.
191     bool backwardCompatibilityMode = false;
192     if (view() && view()->frame())
193         backwardCompatibilityMode = view()->frame()->eventHandler().needsKeyboardEventDisambiguationQuirks();
194
195     if (!m_keyEvent || (type() != eventNames().keypressEvent && !backwardCompatibilityMode))
196         return 0;
197     String text = m_keyEvent->text();
198     return static_cast<int>(text.characterStartingAt(0));
199 }
200
201 EventInterface KeyboardEvent::eventInterface() const
202 {
203     return KeyboardEventInterfaceType;
204 }
205
206 bool KeyboardEvent::isKeyboardEvent() const
207 {
208     return true;
209 }
210
211 int KeyboardEvent::which() const
212 {
213     // Netscape's "which" returns a virtual key code for keydown and keyup, and a character code for keypress.
214     // That's exactly what IE's "keyCode" returns. So they are the same for keyboard events.
215     return keyCode();
216 }
217
218 KeyboardEvent* findKeyboardEvent(Event* event)
219 {
220     for (Event* e = event; e; e = e->underlyingEvent())
221         if (is<KeyboardEvent>(*e))
222             return downcast<KeyboardEvent>(e);
223     return nullptr;
224 }
225
226 } // namespace WebCore