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 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 "DOMWindow.h"
  28 #include "EventNames.h"
  29 #include "EventHandler.h"
  30 #include "Frame.h"
  31 #include "PlatformKeyboardEvent.h"
  32 #include "Settings.h"
  33
  34 namespace WebCore {
  35
  36 using namespace EventNames;
  37
  38 static inline const AtomicString& eventTypeForKeyboardEventType(PlatformKeyboardEvent::Type type)
  39 {
  40     switch (type) {
  41         case PlatformKeyboardEvent::KeyUp:
  42             return keyupEvent;
  43         case PlatformKeyboardEvent::RawKeyDown:
  44             return keydownEvent;
  45         case PlatformKeyboardEvent::Char:
  46             return keypressEvent;
  47         case PlatformKeyboardEvent::KeyDown:
  48             // The caller should disambiguate the combined event into RawKeyDown or Char events.
  49             break;
  50     }
  51     ASSERT_NOT_REACHED();
  52     return keydownEvent;
  53 }
  54
  55 KeyboardEvent::KeyboardEvent()
  56     : m_keyEvent(0)
  57     , m_keyLocation(DOM_KEY_LOCATION_STANDARD)
  58     , m_altGraphKey(false)
  59 {
  60 }
  61
  62 KeyboardEvent::KeyboardEvent(const PlatformKeyboardEvent& key, AbstractView* view)
  63     : UIEventWithKeyState(eventTypeForKeyboardEventType(key.type()),
  64                           true, true, view, 0, key.ctrlKey(), key.altKey(), key.shiftKey(), key.metaKey())
  65     , m_keyEvent(new PlatformKeyboardEvent(key))
  66     , m_keyIdentifier(key.keyIdentifier())
  67     , m_keyLocation(key.isKeypad() ? DOM_KEY_LOCATION_NUMPAD : DOM_KEY_LOCATION_STANDARD) // FIXME: differentiate right/left, too
  68     , m_altGraphKey(false)
  69 {
  70 }
  71
  72 KeyboardEvent::KeyboardEvent(const AtomicString& eventType, bool canBubble, bool cancelable, AbstractView *view,
  73                              const String &keyIdentifier,  unsigned keyLocation,
  74                              bool ctrlKey, bool altKey, bool shiftKey, bool metaKey, bool altGraphKey)
  75     : UIEventWithKeyState(eventType, canBubble, cancelable, view, 0, ctrlKey, altKey, shiftKey, metaKey)
  76     , m_keyEvent(0)
  77     , m_keyIdentifier(keyIdentifier)
  78     , m_keyLocation(keyLocation)
  79     , m_altGraphKey(altGraphKey)
  80 {
  81 }
  82
  83 KeyboardEvent::~KeyboardEvent()
  84 {
  85     delete m_keyEvent;
  86 }
  87
  88 void KeyboardEvent::initKeyboardEvent(const AtomicString& type, bool canBubble, bool cancelable, AbstractView* view,
  89                                       const String &keyIdentifier, unsigned keyLocation,
  90                                       bool ctrlKey, bool altKey, bool shiftKey, bool metaKey, bool altGraphKey)
  91 {
  92     if (dispatched())
  93         return;
  94
  95     initUIEvent(type, canBubble, cancelable, view, 0);
  96
  97     m_keyIdentifier = keyIdentifier;
  98     m_keyLocation = keyLocation;
  99     m_ctrlKey = ctrlKey;
 100     m_shiftKey = shiftKey;
 101     m_altKey = altKey;
 102     m_metaKey = metaKey;
 103     m_altGraphKey = altGraphKey;
 104 }
 105
 106 bool KeyboardEvent::getModifierState(const String& keyIdentifier) const
 107 {
 108     if (keyIdentifier == "Control")
 109         return ctrlKey();
 110     if (keyIdentifier == "Shift")
 111         return shiftKey();
 112     if (keyIdentifier == "Alt")
 113         return altKey();
 114     if (keyIdentifier == "Meta")
 115         return metaKey();
 116     return false;
 117 }
 118
 119 int KeyboardEvent::keyCode() const
 120 {
 121     // IE: virtual key code for keyup/keydown, character code for keypress
 122     // Firefox: virtual key code for keyup/keydown, zero for keypress
 123     // We match IE.
 124     if (!m_keyEvent)
 125         return 0;
 126     if (type() == keydownEvent || type() == keyupEvent)
 127         return m_keyEvent->windowsVirtualKeyCode();
 128     return charCode();
 129 }
 130
 131 int KeyboardEvent::charCode() const
 132 {
 133     // IE: not supported
 134     // Firefox: 0 for keydown/keyup events, character code for keypress
 135     // We match Firefox, unless in backward compatibility mode, where we always return the character code.
 136     bool backwardCompatibilityMode = false;
 137     if (view())
 138         backwardCompatibilityMode = view()->frame()->eventHandler()->needsKeyboardEventDisambiguationQuirks();
 139
 140     if (!m_keyEvent || (type() != keypressEvent && !backwardCompatibilityMode))
 141         return 0;
 142     String text = m_keyEvent->text();
 143     return static_cast<int>(text.characterStartingAt(0));
 144 }
 145
 146 bool KeyboardEvent::isKeyboardEvent() const
 147 {
 148     return true;
 149 }
 150
 151 int KeyboardEvent::which() const
 152 {
 153     // Netscape's "which" returns a virtual key code for keydown and keyup, and a character code for keypress.
 154     // That's exactly what IE's "keyCode" returns. So they are the same for keyboard events.
 155     return keyCode();
 156 }
 157
 158 KeyboardEvent* findKeyboardEvent(Event* event)
 159 {
 160     for (Event* e = event; e; e = e->underlyingEvent())
 161         if (e->isKeyboardEvent())
 162             return static_cast<KeyboardEvent*>(e);
 163     return 0;
 164 }
 165
 166 } // namespace WebCore