Bug 856364 - Paris binding for KeyboardEvent, r=peterv

content/events/src/nsDOMKeyboardEvent.cpp

@@ -21,6 +21,7 @@ nsDOMKeyboardEvent::nsDOMKeyboardEvent(mozilla::dom::EventTarget* aOwner,
     mEventIsInternal = true;
     mEvent->time = PR_Now();
   }
+  SetIsDOMBinding();
 }
 
 nsDOMKeyboardEvent::~nsDOMKeyboardEvent()
@@ -45,7 +46,7 @@ NS_IMETHODIMP
 nsDOMKeyboardEvent::GetAltKey(bool* aIsDown)
 {
   NS_ENSURE_ARG_POINTER(aIsDown);
-  *aIsDown = static_cast<nsInputEvent*>(mEvent)->IsAlt();
+  *aIsDown = AltKey();
   return NS_OK;
 }
 
@@ -53,7 +54,7 @@ NS_IMETHODIMP
 nsDOMKeyboardEvent::GetCtrlKey(bool* aIsDown)
 {
   NS_ENSURE_ARG_POINTER(aIsDown);
-  *aIsDown = static_cast<nsInputEvent*>(mEvent)->IsControl();
+  *aIsDown = CtrlKey();
   return NS_OK;
 }
 
@@ -61,7 +62,7 @@ NS_IMETHODIMP
 nsDOMKeyboardEvent::GetShiftKey(bool* aIsDown)
 {
   NS_ENSURE_ARG_POINTER(aIsDown);
-  *aIsDown = static_cast<nsInputEvent*>(mEvent)->IsShift();
+  *aIsDown = ShiftKey();
   return NS_OK;
 }
 
@@ -69,7 +70,7 @@ NS_IMETHODIMP
 nsDOMKeyboardEvent::GetMetaKey(bool* aIsDown)
 {
   NS_ENSURE_ARG_POINTER(aIsDown);
-  *aIsDown = static_cast<nsInputEvent*>(mEvent)->IsMeta();
+  *aIsDown = MetaKey();
   return NS_OK;
 }
 
@@ -79,7 +80,7 @@ nsDOMKeyboardEvent::GetModifierState(const nsAString& aKey,
 {
   NS_ENSURE_ARG_POINTER(aState);
 
-  *aState = GetModifierStateInternal(aKey);
+  *aState = GetModifierState(aKey);
   return NS_OK;
 }
 
@@ -87,39 +88,41 @@ NS_IMETHODIMP
 nsDOMKeyboardEvent::GetCharCode(uint32_t* aCharCode)
 {
   NS_ENSURE_ARG_POINTER(aCharCode);
+  *aCharCode = CharCode();
+  return NS_OK;
+}
 
+uint32_t
+nsDOMKeyboardEvent::CharCode()
+{
   switch (mEvent->message) {
   case NS_KEY_UP:
   case NS_KEY_DOWN:
-    *aCharCode = 0;
-    break;
+    return 0;
   case NS_KEY_PRESS:
-    *aCharCode = ((nsKeyEvent*)mEvent)->charCode;
-    break;
-  default:
-    *aCharCode = 0;
-    break;
+    return static_cast<nsKeyEvent*>(mEvent)->charCode;
   }
-  return NS_OK;
+  return 0;
 }
 
 NS_IMETHODIMP
 nsDOMKeyboardEvent::GetKeyCode(uint32_t* aKeyCode)
 {
   NS_ENSURE_ARG_POINTER(aKeyCode);
+  *aKeyCode = KeyCode();
+  return NS_OK;
+}
 
+uint32_t
+nsDOMKeyboardEvent::KeyCode()
+{
   switch (mEvent->message) {
   case NS_KEY_UP:
   case NS_KEY_PRESS:
   case NS_KEY_DOWN:
-    *aKeyCode = ((nsKeyEvent*)mEvent)->keyCode;
-    break;
-  default:
-    *aKeyCode = 0;
-    break;
+    return static_cast<nsKeyEvent*>(mEvent)->keyCode;
   }
-
-  return NS_OK;
+  return 0;
 }
 
 /* virtual */
@@ -127,29 +130,30 @@ nsresult
 nsDOMKeyboardEvent::Which(uint32_t* aWhich)
 {
   NS_ENSURE_ARG_POINTER(aWhich);
+  *aWhich = Which();
+  return NS_OK;
+}
 
+uint32_t
+nsDOMKeyboardEvent::Which()
+{
   switch (mEvent->message) {
     case NS_KEY_UP:
     case NS_KEY_DOWN:
-      return GetKeyCode(aWhich);
+      return KeyCode();
     case NS_KEY_PRESS:
       //Special case for 4xp bug 62878.  Try to make value of which
       //more closely mirror the values that 4.x gave for RETURN and BACKSPACE
       {
         uint32_t keyCode = ((nsKeyEvent*)mEvent)->keyCode;
         if (keyCode == NS_VK_RETURN || keyCode == NS_VK_BACK) {
-          *aWhich = keyCode;
-          return NS_OK;
+          return keyCode;
         }
-        return GetCharCode(aWhich);
+        return CharCode();
       }
-      break;
-    default:
-      *aWhich = 0;
-      break;
   }
 
-  return NS_OK;
+  return 0;
 }
 
 NS_IMETHODIMP
@@ -157,7 +161,7 @@ nsDOMKeyboardEvent::GetLocation(uint32_t* aLocation)
 {
   NS_ENSURE_ARG_POINTER(aLocation);
 
-  *aLocation = static_cast<nsKeyEvent*>(mEvent)->location;
+  *aLocation = Location();
   return NS_OK;
 }
 

content/events/src/nsDOMKeyboardEvent.h

@@ -8,6 +8,7 @@
 
 #include "nsIDOMKeyEvent.h"
 #include "nsDOMUIEvent.h"
+#include "mozilla/dom/KeyEventBinding.h"
 
 class nsDOMKeyboardEvent : public nsDOMUIEvent,
                            public nsIDOMKeyEvent
@@ -25,6 +26,56 @@ public:
   // Forward to base class
   NS_FORWARD_TO_NSDOMUIEVENT
 
+  virtual JSObject* WrapObject(JSContext* aCx, JSObject* aScope)
+  {
+    return mozilla::dom::KeyEventBinding::Wrap(aCx, aScope, this);
+  }
+
+  bool AltKey()
+  {
+    return static_cast<nsInputEvent*>(mEvent)->IsAlt();
+  }
+
+  bool CtrlKey()
+  {
+    return static_cast<nsInputEvent*>(mEvent)->IsControl();
+  }
+
+  bool ShiftKey()
+  {
+    return static_cast<nsInputEvent*>(mEvent)->IsShift();
+  }
+
+  bool MetaKey()
+  {
+    return static_cast<nsInputEvent*>(mEvent)->IsMeta();
+  }
+
+  bool GetModifierState(const nsAString& aKey)
+  {
+    return GetModifierStateInternal(aKey);
+  }
+
+  uint32_t CharCode();
+  uint32_t KeyCode();
+  virtual uint32_t Which() MOZ_OVERRIDE;
+
+  uint32_t Location()
+  {
+    return static_cast<nsKeyEvent*>(mEvent)->location;
+  }
+
+  void InitKeyEvent(const nsAString& aType, bool aCanBubble, bool aCancelable,
+                    nsIDOMWindow* aView, bool aCtrlKey, bool aAltKey,
+                    bool aShiftKey, bool aMetaKey,
+                    uint32_t aKeyCode, uint32_t aCharCode,
+                    mozilla::ErrorResult& aRv)
+  {
+    aRv = InitKeyEvent(aType, aCanBubble, aCancelable, aView,
+                       aCtrlKey, aAltKey, aShiftKey,aMetaKey,
+                       aKeyCode, aCharCode);
+  }
+
 protected:
   // Specific implementation for a keyboard event.
   virtual nsresult Which(uint32_t* aWhich);

content/events/src/nsDOMMouseEvent.h

@@ -37,6 +37,13 @@ public:
                                 JSContext* aCx, JS::Value* aVal);
 
   // Web IDL binding methods
+  virtual uint32_t Which() MOZ_OVERRIDE
+  {
+    uint32_t w = 0;
+    Which(&w);
+    return w;
+  }
+
   int32_t ScreenX();
   int32_t ScreenY();
   int32_t ClientX();

content/events/src/nsDOMUIEvent.h

@@ -132,7 +132,7 @@ public:
     return y;
   }
 
-  uint32_t Which()
+  virtual uint32_t Which()
   {
     uint32_t w;
     GetWhich(&w);

dom/bindings/Bindings.conf

@@ -557,6 +557,10 @@ DOMInterfaces = {
     'workers': True,
 }],
 
+'KeyEvent': {
+    'nativeType': 'nsDOMKeyboardEvent',
+},
+
 'Location': {
     # NOTE: Before you turn on codegen for Location, make sure all the
     # Unforgeable stuff is dealt with.

dom/webidl/KeyEvent.webidl

@@ -0,0 +1,256 @@
+/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this file,
+ * You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+
+interface WindowProxy;
+
+interface KeyEvent : UIEvent
+{
+  const unsigned long DOM_VK_CANCEL         = 0x03;
+  const unsigned long DOM_VK_HELP           = 0x06;
+  const unsigned long DOM_VK_BACK_SPACE     = 0x08;
+  const unsigned long DOM_VK_TAB            = 0x09;
+  const unsigned long DOM_VK_CLEAR          = 0x0C;
+  const unsigned long DOM_VK_RETURN         = 0x0D;
+  const unsigned long DOM_VK_ENTER          = 0x0E;
+  const unsigned long DOM_VK_SHIFT          = 0x10;
+  const unsigned long DOM_VK_CONTROL        = 0x11;
+  const unsigned long DOM_VK_ALT            = 0x12;
+  const unsigned long DOM_VK_PAUSE          = 0x13;
+  const unsigned long DOM_VK_CAPS_LOCK      = 0x14;
+  const unsigned long DOM_VK_KANA           = 0x15;
+  const unsigned long DOM_VK_HANGUL         = 0x15;
+  const unsigned long DOM_VK_EISU           = 0x16; // Japanese Mac keyboard only
+  const unsigned long DOM_VK_JUNJA          = 0x17;
+  const unsigned long DOM_VK_FINAL          = 0x18;
+  const unsigned long DOM_VK_HANJA          = 0x19;
+  const unsigned long DOM_VK_KANJI          = 0x19;
+  const unsigned long DOM_VK_ESCAPE         = 0x1B;
+  const unsigned long DOM_VK_CONVERT        = 0x1C;
+  const unsigned long DOM_VK_NONCONVERT     = 0x1D;
+  const unsigned long DOM_VK_ACCEPT         = 0x1E;
+  const unsigned long DOM_VK_MODECHANGE     = 0x1F;
+  const unsigned long DOM_VK_SPACE          = 0x20;
+  const unsigned long DOM_VK_PAGE_UP        = 0x21;
+  const unsigned long DOM_VK_PAGE_DOWN      = 0x22;
+  const unsigned long DOM_VK_END            = 0x23;
+  const unsigned long DOM_VK_HOME           = 0x24;
+  const unsigned long DOM_VK_LEFT           = 0x25;
+  const unsigned long DOM_VK_UP             = 0x26;
+  const unsigned long DOM_VK_RIGHT          = 0x27;
+  const unsigned long DOM_VK_DOWN           = 0x28;
+  const unsigned long DOM_VK_SELECT         = 0x29;
+  const unsigned long DOM_VK_PRINT          = 0x2A;
+  const unsigned long DOM_VK_EXECUTE        = 0x2B;
+  const unsigned long DOM_VK_PRINTSCREEN    = 0x2C;
+  const unsigned long DOM_VK_INSERT         = 0x2D;
+  const unsigned long DOM_VK_DELETE         = 0x2E;
+
+  // DOM_VK_0 - DOM_VK_9 match their ascii values
+  const unsigned long DOM_VK_0              = 0x30;
+  const unsigned long DOM_VK_1              = 0x31;
+  const unsigned long DOM_VK_2              = 0x32;
+  const unsigned long DOM_VK_3              = 0x33;
+  const unsigned long DOM_VK_4              = 0x34;
+  const unsigned long DOM_VK_5              = 0x35;
+  const unsigned long DOM_VK_6              = 0x36;
+  const unsigned long DOM_VK_7              = 0x37;
+  const unsigned long DOM_VK_8              = 0x38;
+  const unsigned long DOM_VK_9              = 0x39;
+
+  const unsigned long DOM_VK_COLON          = 0x3A;
+  const unsigned long DOM_VK_SEMICOLON      = 0x3B;
+  const unsigned long DOM_VK_LESS_THAN      = 0x3C;
+  const unsigned long DOM_VK_EQUALS         = 0x3D;
+  const unsigned long DOM_VK_GREATER_THAN   = 0x3E;
+  const unsigned long DOM_VK_QUESTION_MARK  = 0x3F;
+  const unsigned long DOM_VK_AT             = 0x40;
+
+  // DOM_VK_A - DOM_VK_Z match their ascii values
+  const unsigned long DOM_VK_A              = 0x41;
+  const unsigned long DOM_VK_B              = 0x42;
+  const unsigned long DOM_VK_C              = 0x43;
+  const unsigned long DOM_VK_D              = 0x44;
+  const unsigned long DOM_VK_E              = 0x45;
+  const unsigned long DOM_VK_F              = 0x46;
+  const unsigned long DOM_VK_G              = 0x47;
+  const unsigned long DOM_VK_H              = 0x48;
+  const unsigned long DOM_VK_I              = 0x49;
+  const unsigned long DOM_VK_J              = 0x4A;
+  const unsigned long DOM_VK_K              = 0x4B;
+  const unsigned long DOM_VK_L              = 0x4C;
+  const unsigned long DOM_VK_M              = 0x4D;
+  const unsigned long DOM_VK_N              = 0x4E;
+  const unsigned long DOM_VK_O              = 0x4F;
+  const unsigned long DOM_VK_P              = 0x50;
+  const unsigned long DOM_VK_Q              = 0x51;
+  const unsigned long DOM_VK_R              = 0x52;
+  const unsigned long DOM_VK_S              = 0x53;
+  const unsigned long DOM_VK_T              = 0x54;
+  const unsigned long DOM_VK_U              = 0x55;
+  const unsigned long DOM_VK_V              = 0x56;
+  const unsigned long DOM_VK_W              = 0x57;
+  const unsigned long DOM_VK_X              = 0x58;
+  const unsigned long DOM_VK_Y              = 0x59;
+  const unsigned long DOM_VK_Z              = 0x5A;
+
+  const unsigned long DOM_VK_WIN            = 0x5B;
+  const unsigned long DOM_VK_CONTEXT_MENU   = 0x5D;
+  const unsigned long DOM_VK_SLEEP          = 0x5F;
+
+  // Numpad keys
+  const unsigned long DOM_VK_NUMPAD0        = 0x60;
+  const unsigned long DOM_VK_NUMPAD1        = 0x61;
+  const unsigned long DOM_VK_NUMPAD2        = 0x62;
+  const unsigned long DOM_VK_NUMPAD3        = 0x63;
+  const unsigned long DOM_VK_NUMPAD4        = 0x64;
+  const unsigned long DOM_VK_NUMPAD5        = 0x65;
+  const unsigned long DOM_VK_NUMPAD6        = 0x66;
+  const unsigned long DOM_VK_NUMPAD7        = 0x67;
+  const unsigned long DOM_VK_NUMPAD8        = 0x68;
+  const unsigned long DOM_VK_NUMPAD9        = 0x69;
+  const unsigned long DOM_VK_MULTIPLY       = 0x6A;
+  const unsigned long DOM_VK_ADD            = 0x6B;
+  const unsigned long DOM_VK_SEPARATOR      = 0x6C;
+  const unsigned long DOM_VK_SUBTRACT       = 0x6D;
+  const unsigned long DOM_VK_DECIMAL        = 0x6E;
+  const unsigned long DOM_VK_DIVIDE         = 0x6F;
+
+  const unsigned long DOM_VK_F1             = 0x70;
+  const unsigned long DOM_VK_F2             = 0x71;
+  const unsigned long DOM_VK_F3             = 0x72;
+  const unsigned long DOM_VK_F4             = 0x73;
+  const unsigned long DOM_VK_F5             = 0x74;
+  const unsigned long DOM_VK_F6             = 0x75;
+  const unsigned long DOM_VK_F7             = 0x76;
+  const unsigned long DOM_VK_F8             = 0x77;
+  const unsigned long DOM_VK_F9             = 0x78;
+  const unsigned long DOM_VK_F10            = 0x79;
+  const unsigned long DOM_VK_F11            = 0x7A;
+  const unsigned long DOM_VK_F12            = 0x7B;
+  const unsigned long DOM_VK_F13            = 0x7C;
+  const unsigned long DOM_VK_F14            = 0x7D;
+  const unsigned long DOM_VK_F15            = 0x7E;
+  const unsigned long DOM_VK_F16            = 0x7F;
+  const unsigned long DOM_VK_F17            = 0x80;
+  const unsigned long DOM_VK_F18            = 0x81;
+  const unsigned long DOM_VK_F19            = 0x82;
+  const unsigned long DOM_VK_F20            = 0x83;
+  const unsigned long DOM_VK_F21            = 0x84;
+  const unsigned long DOM_VK_F22            = 0x85;
+  const unsigned long DOM_VK_F23            = 0x86;
+  const unsigned long DOM_VK_F24            = 0x87;
+
+  const unsigned long DOM_VK_NUM_LOCK       = 0x90;
+  const unsigned long DOM_VK_SCROLL_LOCK    = 0x91;
+
+  // OEM specific virtual keyCode of Windows should pass through DOM keyCode
+  // for compatibility with the other web browsers on Windows.
+  const unsigned long DOM_VK_WIN_OEM_FJ_JISHO   = 0x92;
+  const unsigned long DOM_VK_WIN_OEM_FJ_MASSHOU = 0x93;
+  const unsigned long DOM_VK_WIN_OEM_FJ_TOUROKU = 0x94;
+  const unsigned long DOM_VK_WIN_OEM_FJ_LOYA    = 0x95;
+  const unsigned long DOM_VK_WIN_OEM_FJ_ROYA    = 0x96;
+
+  const unsigned long DOM_VK_CIRCUMFLEX     = 0xA0;
+  const unsigned long DOM_VK_EXCLAMATION    = 0xA1;
+  const unsigned long DOM_VK_DOUBLE_QUOTE   = 0xA2;
+  const unsigned long DOM_VK_HASH           = 0xA3;
+  const unsigned long DOM_VK_DOLLAR         = 0xA4;
+  const unsigned long DOM_VK_PERCENT        = 0xA5;
+  const unsigned long DOM_VK_AMPERSAND      = 0xA6;
+  const unsigned long DOM_VK_UNDERSCORE     = 0xA7;
+  const unsigned long DOM_VK_OPEN_PAREN     = 0xA8;
+  const unsigned long DOM_VK_CLOSE_PAREN    = 0xA9;
+  const unsigned long DOM_VK_ASTERISK       = 0xAA;
+  const unsigned long DOM_VK_PLUS           = 0xAB;
+  const unsigned long DOM_VK_PIPE           = 0xAC;
+  const unsigned long DOM_VK_HYPHEN_MINUS   = 0xAD;
+
+  const unsigned long DOM_VK_OPEN_CURLY_BRACKET  = 0xAE;
+  const unsigned long DOM_VK_CLOSE_CURLY_BRACKET = 0xAF;
+
+  const unsigned long DOM_VK_TILDE          = 0xB0;
+
+  const unsigned long DOM_VK_VOLUME_MUTE    = 0xB5;
+  const unsigned long DOM_VK_VOLUME_DOWN    = 0xB6;
+  const unsigned long DOM_VK_VOLUME_UP      = 0xB7;
+
+  const unsigned long DOM_VK_COMMA          = 0xBC;
+  const unsigned long DOM_VK_PERIOD         = 0xBE;
+  const unsigned long DOM_VK_SLASH          = 0xBF;
+  const unsigned long DOM_VK_BACK_QUOTE     = 0xC0;
+  const unsigned long DOM_VK_OPEN_BRACKET   = 0xDB; // square bracket
+  const unsigned long DOM_VK_BACK_SLASH     = 0xDC;
+  const unsigned long DOM_VK_CLOSE_BRACKET  = 0xDD; // square bracket
+  const unsigned long DOM_VK_QUOTE          = 0xDE; // Apostrophe
+
+  const unsigned long DOM_VK_META           = 0xE0;
+  const unsigned long DOM_VK_ALTGR          = 0xE1;
+
+  // OEM specific virtual keyCode of Windows should pass through DOM keyCode
+  // for compatibility with the other web browsers on Windows.
+  const unsigned long DOM_VK_WIN_ICO_HELP    = 0xE3;
+  const unsigned long DOM_VK_WIN_ICO_00      = 0xE4;
+  const unsigned long DOM_VK_WIN_ICO_CLEAR   = 0xE6;
+  const unsigned long DOM_VK_WIN_OEM_RESET   = 0xE9;
+  const unsigned long DOM_VK_WIN_OEM_JUMP    = 0xEA;
+  const unsigned long DOM_VK_WIN_OEM_PA1     = 0xEB;
+  const unsigned long DOM_VK_WIN_OEM_PA2     = 0xEC;
+  const unsigned long DOM_VK_WIN_OEM_PA3     = 0xED;
+  const unsigned long DOM_VK_WIN_OEM_WSCTRL  = 0xEE;
+  const unsigned long DOM_VK_WIN_OEM_CUSEL   = 0xEF;
+  const unsigned long DOM_VK_WIN_OEM_ATTN    = 0xF0;
+  const unsigned long DOM_VK_WIN_OEM_FINISH  = 0xF1;
+  const unsigned long DOM_VK_WIN_OEM_COPY    = 0xF2;
+  const unsigned long DOM_VK_WIN_OEM_AUTO    = 0xF3;
+  const unsigned long DOM_VK_WIN_OEM_ENLW    = 0xF4;
+  const unsigned long DOM_VK_WIN_OEM_BACKTAB = 0xF5;
+
+  // Following keys are not used on most keyboards.  However, for compatibility
+  // with other browsers on Windows, we should define them.
+  const unsigned long DOM_VK_ATTN           = 0xF6;
+  const unsigned long DOM_VK_CRSEL          = 0xF7;
+  const unsigned long DOM_VK_EXSEL          = 0xF8;
+  const unsigned long DOM_VK_EREOF          = 0xF9;
+  const unsigned long DOM_VK_PLAY           = 0xFA;
+  const unsigned long DOM_VK_ZOOM           = 0xFB;
+  const unsigned long DOM_VK_PA1            = 0xFD;
+
+  // OEM specific virtual keyCode of Windows should pass through DOM keyCode
+  // for compatibility with the other web browsers on Windows.
+  const unsigned long DOM_VK_WIN_OEM_CLEAR  = 0xFE;
+
+  readonly attribute unsigned long    charCode;
+  readonly attribute unsigned long    keyCode;
+
+  readonly attribute boolean          altKey;
+  readonly attribute boolean          ctrlKey;
+  readonly attribute boolean          shiftKey;
+  readonly attribute boolean          metaKey;
+
+  [Throws]
+  void initKeyEvent(DOMString type,
+                    boolean canBubble,
+                    boolean cancelable,
+                    WindowProxy? view,
+                    boolean ctrlKey,
+                    boolean altKey,
+                    boolean shiftKey,
+                    boolean metaKey,
+                    unsigned long keyCode,
+                    unsigned long charCode);
+
+  boolean getModifierState(DOMString key);
+
+  const unsigned long DOM_KEY_LOCATION_STANDARD = 0x00;
+  const unsigned long DOM_KEY_LOCATION_LEFT     = 0x01;
+  const unsigned long DOM_KEY_LOCATION_RIGHT    = 0x02;
+  const unsigned long DOM_KEY_LOCATION_NUMPAD   = 0x03;
+  const unsigned long DOM_KEY_LOCATION_MOBILE   = 0x04;
+  const unsigned long DOM_KEY_LOCATION_JOYSTICK = 0x05;
+
+  readonly attribute unsigned long location;
+};

dom/webidl/WebIDL.mk

@@ -150,6 +150,7 @@ webidl_files = \
   IDBVersionChangeEvent.webidl \
   ImageData.webidl \
   InspectorUtils.webidl \
+  KeyEvent.webidl \
   LinkStyle.webidl \
   LocalMediaStream.webidl \
   Location.webidl \