code.vuplus.com Git - vuplus_webkit/blob - Source/WebCore/platform/PlatformKeyboardEvent.h

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