1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
|
/*
* Copyright (C) 2004, 2005, 2006 Apple Computer, Inc. All rights reserved.
* Copyright (C) 2008 Collabora, Ltd. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE COMPUTER, INC. OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef PlatformKeyboardEvent_h
#define PlatformKeyboardEvent_h
#include "PlatformString.h"
#if PLATFORM(MAC)
#include <wtf/RetainPtr.h>
#ifdef __OBJC__
@class NSEvent;
#else
class NSEvent;
#endif
#endif
#if PLATFORM(WIN)
typedef struct HWND__ *HWND;
typedef unsigned WPARAM;
typedef long LPARAM;
#endif
#if PLATFORM(GTK)
typedef struct _GdkEventKey GdkEventKey;
#endif
#if PLATFORM(QT)
QT_BEGIN_NAMESPACE
class QKeyEvent;
QT_END_NAMESPACE
#endif
#if PLATFORM(WX)
class wxKeyEvent;
#endif
#if PLATFORM(HAIKU)
class BMessage;
#endif
#if PLATFORM(EFL)
typedef struct _Evas_Event_Key_Down Evas_Event_Key_Down;
typedef struct _Evas_Event_Key_Up Evas_Event_Key_Up;
#endif
#if PLATFORM(BREWMP)
typedef unsigned short uint16;
typedef unsigned long int uint32;
#define AEEEvent uint16
#endif
namespace WebCore {
class PlatformKeyboardEvent {
WTF_MAKE_FAST_ALLOCATED;
public:
enum Type {
// KeyDown is sent by platforms such as Mac OS X, gtk and Qt, and has information about both physical pressed key, and its translation.
// For DOM processing, it needs to be disambiguated as RawKeyDown or Char event.
KeyDown,
// KeyUp is sent by all platforms.
KeyUp,
// These events are sent by platforms such as Windows and wxWidgets. RawKeyDown only has information about a physical key, and Char
// only has information about a character it was translated into.
RawKeyDown,
Char
};
enum ModifierKey {
AltKey = 1 << 0,
CtrlKey = 1 << 1,
MetaKey = 1 << 2,
ShiftKey = 1 << 3
};
PlatformKeyboardEvent()
: m_type(KeyDown)
, m_autoRepeat(false)
, m_windowsVirtualKeyCode(0)
, m_nativeVirtualKeyCode(0)
, m_isKeypad(false)
, m_shiftKey(false)
, m_ctrlKey(false)
, m_altKey(false)
, m_metaKey(false)
#if PLATFORM(WIN) || PLATFORM(CHROMIUM)
, m_isSystemKey(false)
#endif
#if PLATFORM(GTK)
, m_gdkEventKey(0)
#endif
#if PLATFORM(QT)
, m_qtEvent(0)
#endif
{
}
Type type() const { return m_type; }
void disambiguateKeyDownEvent(Type, bool backwardCompatibilityMode = false); // Only used on platforms that need it, i.e. those that generate KeyDown events.
// Text as as generated by processing a virtual key code with a keyboard layout
// (in most cases, just a character code, but the layout can emit several
// characters in a single keypress event on some platforms).
// This may bear no resemblance to the ultimately inserted text if an input method
// processes the input.
// Will be null for KeyUp and RawKeyDown events.
String text() const { return m_text; }
// Text that would have been generated by the keyboard if no modifiers were pressed
// (except for Shift); useful for shortcut (accelerator) key handling.
// Otherwise, same as text().
String unmodifiedText() const { return m_unmodifiedText; }
// Most compatible Windows virtual key code associated with the event.
// Zero for Char events.
int windowsVirtualKeyCode() const { return m_windowsVirtualKeyCode; }
void setWindowsVirtualKeyCode(int code) { m_windowsVirtualKeyCode = code; }
int nativeVirtualKeyCode() const { return m_nativeVirtualKeyCode; }
void setNativeVirtualKeyCode(int code) { m_nativeVirtualKeyCode = code; }
String keyIdentifier() const { return m_keyIdentifier; }
bool isAutoRepeat() const { return m_autoRepeat; }
void setIsAutoRepeat(bool in) { m_autoRepeat = in; }
bool isKeypad() const { return m_isKeypad; }
bool shiftKey() const { return m_shiftKey; }
bool ctrlKey() const { return m_ctrlKey; }
bool altKey() const { return m_altKey; }
bool metaKey() const { return m_metaKey; }
unsigned modifiers() const {
return (altKey() ? AltKey : 0)
| (ctrlKey() ? CtrlKey : 0)
| (metaKey() ? MetaKey : 0)
| (shiftKey() ? ShiftKey : 0);
}
static bool currentCapsLockState();
static void getCurrentModifierState(bool& shiftKey, bool& ctrlKey, bool& altKey, bool& metaKey);
#if PLATFORM(MAC)
PlatformKeyboardEvent(NSEvent*);
NSEvent* macEvent() const { return m_macEvent.get(); }
#endif
#if PLATFORM(WIN)
PlatformKeyboardEvent(HWND, WPARAM, LPARAM, Type, bool);
#endif
#if PLATFORM(GTK)
PlatformKeyboardEvent(GdkEventKey*);
GdkEventKey* gdkEventKey() const;
// Used by WebKit2
static String keyIdentifierForGdkKeyCode(unsigned);
static int windowsKeyCodeForGdkKeyCode(unsigned);
static String singleCharacterString(unsigned);
#endif
#if PLATFORM(ANDROID)
PlatformKeyboardEvent(int keyCode, UChar32 unichar, int repeatCount,
bool down, bool cap, bool alt, bool sym);
UChar32 unichar() const { return m_unichar; }
int repeatCount() const { return m_repeatCount; }
#endif
#if PLATFORM(QT)
PlatformKeyboardEvent(QKeyEvent*);
QKeyEvent* qtEvent() const { return m_qtEvent; }
uint32_t nativeModifiers() const;
uint32_t nativeScanCode() const;
#endif
#if PLATFORM(WX)
PlatformKeyboardEvent(wxKeyEvent&);
#endif
#if PLATFORM(HAIKU)
PlatformKeyboardEvent(BMessage*);
#endif
#if PLATFORM(BREWMP)
PlatformKeyboardEvent(AEEEvent, uint16, uint32, Type);
#endif
#if PLATFORM(WIN) || PLATFORM(CHROMIUM)
bool isSystemKey() const { return m_isSystemKey; }
#endif
#if PLATFORM(EFL)
PlatformKeyboardEvent(const Evas_Event_Key_Down*);
PlatformKeyboardEvent(const Evas_Event_Key_Up*);
#endif
protected:
Type m_type;
String m_text;
String m_unmodifiedText;
String m_keyIdentifier;
bool m_autoRepeat;
int m_windowsVirtualKeyCode;
int m_nativeVirtualKeyCode;
bool m_isKeypad;
bool m_shiftKey;
bool m_ctrlKey;
bool m_altKey;
bool m_metaKey;
#if PLATFORM(ANDROID)
/* the actual repeatCount (as opposed to just a bool m_autoRepeat)
0 for initial down and up
*/
int m_repeatCount;
/* The originall unichar value. Sometimes the m_text/m_unmodifiedText
fields are stripped (e.g. for RawKeyDown), so we record it also here
in case someone (e.g. plugins) want to sniff it w/o waiting for a
Char event type.
*/
UChar32 m_unichar;
#endif
#if PLATFORM(MAC)
RetainPtr<NSEvent> m_macEvent;
#endif
#if PLATFORM(WIN) || PLATFORM(CHROMIUM)
bool m_isSystemKey;
#endif
#if PLATFORM(GTK)
GdkEventKey* m_gdkEventKey;
#endif
#if PLATFORM(QT)
QKeyEvent* m_qtEvent;
#endif
};
#if PLATFORM(QT)
// Used by WebKit2.
String keyIdentifierForQtKeyCode(int keyCode);
int windowsKeyCodeForKeyEvent(unsigned int keycode, bool isKeypad = false);
#endif
} // namespace WebCore
#endif // PlatformKeyboardEvent_h
|
