Unreviewed, rolling out r164422.
[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 "Frame.h"
30 #include "PlatformKeyboardEvent.h"
31 #include "Settings.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 KeyboardEventInit::KeyboardEventInit()
94     : location(0)
95     , ctrlKey(false)
96     , altKey(false)
97     , shiftKey(false)
98     , metaKey(false)
99 {
100 }
101
102 KeyboardEvent::KeyboardEvent()
103     : m_location(DOM_KEY_LOCATION_STANDARD)
104     , m_altGraphKey(false)
105 {
106 }
107
108 KeyboardEvent::KeyboardEvent(const PlatformKeyboardEvent& key, AbstractView* view)
109     : UIEventWithKeyState(eventTypeForKeyboardEventType(key.type()),
110                           true, true, key.timestamp(), view, 0, key.ctrlKey(), key.altKey(), key.shiftKey(), key.metaKey())
111     , m_keyEvent(adoptPtr(new PlatformKeyboardEvent(key)))
112     , m_keyIdentifier(key.keyIdentifier())
113     , m_location(keyLocationCode(key))
114     , m_altGraphKey(false)
115 {
116 }
117
118 KeyboardEvent::KeyboardEvent(const AtomicString& eventType, const KeyboardEventInit& initializer)
119     : UIEventWithKeyState(eventType, initializer.bubbles, initializer.cancelable, initializer.view, initializer.detail, initializer.ctrlKey, initializer.altKey, initializer.shiftKey, initializer.metaKey)
120     , m_keyIdentifier(initializer.keyIdentifier)
121     , m_location(initializer.location)
122     , m_altGraphKey(false)
123 {
124 }
125
126 KeyboardEvent::~KeyboardEvent()
127 {
128 }
129
130 void KeyboardEvent::initKeyboardEvent(const AtomicString& type, bool canBubble, bool cancelable, AbstractView* view,
131                                       const String &keyIdentifier, unsigned location,
132                                       bool ctrlKey, bool altKey, bool shiftKey, bool metaKey, bool altGraphKey)
133 {
134     if (dispatched())
135         return;
136
137     initUIEvent(type, canBubble, cancelable, view, 0);
138
139     m_keyIdentifier = keyIdentifier;
140     m_location = location;
141     m_ctrlKey = ctrlKey;
142     m_shiftKey = shiftKey;
143     m_altKey = altKey;
144     m_metaKey = metaKey;
145     m_altGraphKey = altGraphKey;
146 }
147
148 bool KeyboardEvent::getModifierState(const String& keyIdentifier) const
149 {
150     if (keyIdentifier == "Control")
151         return ctrlKey();
152     if (keyIdentifier == "Shift")
153         return shiftKey();
154     if (keyIdentifier == "Alt")
155         return altKey();
156     if (keyIdentifier == "Meta")
157         return metaKey();
158     return false;
159 }
160
161 int KeyboardEvent::keyCode() const
162 {
163     // IE: virtual key code for keyup/keydown, character code for keypress
164     // Firefox: virtual key code for keyup/keydown, zero for keypress
165     // We match IE.
166     if (!m_keyEvent)
167         return 0;
168     if (type() == eventNames().keydownEvent || type() == eventNames().keyupEvent)
169         return windowsVirtualKeyCodeWithoutLocation(m_keyEvent->windowsVirtualKeyCode());
170
171     return charCode();
172 }
173
174 int KeyboardEvent::charCode() const
175 {
176     // IE: not supported
177     // Firefox: 0 for keydown/keyup events, character code for keypress
178     // We match Firefox, unless in backward compatibility mode, where we always return the character code.
179     bool backwardCompatibilityMode = false;
180     if (view() && view()->frame())
181         backwardCompatibilityMode = view()->frame()->eventHandler().needsKeyboardEventDisambiguationQuirks();
182
183     if (!m_keyEvent || (type() != eventNames().keypressEvent && !backwardCompatibilityMode))
184         return 0;
185     String text = m_keyEvent->text();
186     return static_cast<int>(text.characterStartingAt(0));
187 }
188
189 EventInterface KeyboardEvent::eventInterface() const
190 {
191     return KeyboardEventInterfaceType;
192 }
193
194 bool KeyboardEvent::isKeyboardEvent() const
195 {
196     return true;
197 }
198
199 int KeyboardEvent::which() const
200 {
201     // Netscape's "which" returns a virtual key code for keydown and keyup, and a character code for keypress.
202     // That's exactly what IE's "keyCode" returns. So they are the same for keyboard events.
203     return keyCode();
204 }
205
206 KeyboardEvent* findKeyboardEvent(Event* event)
207 {
208     for (Event* e = event; e; e = e->underlyingEvent())
209         if (e->isKeyboardEvent())
210             return toKeyboardEvent(e);
211     return 0;
212 }
213
214 } // namespace WebCore