Adding support for DOM3 KeyboardEvents Code in KeyboardEvents

Source/web/WebInputEventConversion.cpp

 /*
  * Copyright (C) 2009 Google Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are
  * met:
  *
  *     * Redistributions of source code must retain the above copyright
  * notice, this list of conditions and the following disclaimer.
  *     * Redistributions in binary form must reproduce the above
@@ skipping 27 matching lines @@
 #include "core/events/MouseEvent.h"
 #include "core/events/TouchEvent.h"
 #include "core/events/WheelEvent.h"
 #include "core/frame/FrameHost.h"
 #include "core/frame/FrameView.h"
 #include "core/frame/PinchViewport.h"
 #include "core/page/Page.h"
 #include "core/rendering/RenderObject.h"
 #include "platform/KeyboardCodes.h"
 #include "platform/Widget.h"
+#include "public/web/WebViewClient.h"
+#include "web/WebViewImpl.h"
 
 namespace blink {
 
 static const double millisPerSecond = 1000.0;
 
 static float scaleDeltaToWindow(const Widget* widget, float delta)
 {
     float scale = 1;
     if (widget) {
         FrameView* rootView = toFrameView(widget->root());
@@ skipping 240 matching lines @@
     case WebInputEvent::RawKeyDown:
         return PlatformEvent::RawKeyDown;
     case WebInputEvent::Char:
         return PlatformEvent::Char;
     default:
         ASSERT_NOT_REACHED();
     }
     return PlatformEvent::KeyDown;
 }
 
-PlatformKeyboardEventBuilder::PlatformKeyboardEventBuilder(const WebKeyboardEvent& e)
+static void getDomCodeStringFromEnum(Widget* widget, String& code, long domCode)

[bokan, 2015/01/20 17:05:58]

Can we return the string, rather than using an output parameter? It'd be
clearer.

[Habib Virji, 2015/01/22 16:01:30]

Done.

+{
+    FrameView* view = toFrameView(widget->root());
+    if (view) {
+        WebViewImpl* webView = WebViewImpl::fromPage(view->page());
+        if (webView)
+            code = webView->client()->domCodeStringFromEnum(domCode);
+    }

[Wez, 2015/01/17 02:35:10]

This leaves the |code| empty, which is also the state it's in if we create a
KeyboardEvent without a code - the DOM UIEvents spec requires unknown codes to
return "Undefined" or something along those lines, IIRC - perhaps check w/
garykac@ what the right thing is to return if there is no |code|, e.g. should
the event just act as though it has no |code| field?

[Habib Virji, 2015/01/22 16:01:30]

I have sent mail to Gary with the questions. 

For timebeing it is done now in two steps:
- If some invalid key is entered: domCodeSringFromEnum, will return "Undefined"
for such keys.
- In case domCodeString cannot execute, it will still return "Undefined" from
Blink. (Though not sure if it's right thing, will amend based on Gary's
comment).

+}
+
+static long getDomEnumFromCodeString(const Widget* widget, const String& code)
+{
+    FrameView* view = toFrameView(widget->root());
+    if (view) {
+        WebViewImpl* webView = WebViewImpl::fromPage(view->page());
+        if (webView)
+            return webView->client()->domEnumFromCodeString(code.utf8().data());
+    }
+    return 0;

[Wez, 2015/01/17 02:35:10]

This means that the embedder cannot use zero as one of the enum values,
otherwise this wouldn't be distinguishable from an actual code; maybe document
that on the domEnumFromCodeString() API interface?

+}
+
+PlatformKeyboardEventBuilder::PlatformKeyboardEventBuilder(Widget* widget, const WebKeyboardEvent& e)
 {
     m_type = toPlatformKeyboardEventType(e.type);
     m_text = String(e.text);
     m_unmodifiedText = String(e.unmodifiedText);
     m_keyIdentifier = String(e.keyIdentifier);
     m_autoRepeat = (e.modifiers & WebInputEvent::IsAutoRepeat);
     m_nativeVirtualKeyCode = e.nativeKeyCode;
     m_isKeypad = (e.modifiers & WebInputEvent::IsKeyPad);
     m_isSystemKey = e.isSystemKey;
+    getDomCodeStringFromEnum(widget, m_code, e.domCode);
 
     m_modifiers = toPlatformEventModifiers(e.modifiers);
 
     // FIXME: PlatformKeyboardEvents expect a locational version of the keycode (e.g. VK_LSHIFT
     // instead of VK_SHIFT). This should be changed so the location/keycode are stored separately,
     // as in other places in the code.
     m_windowsVirtualKeyCode = e.windowsKeyCode;
     if (e.windowsKeyCode == VK_SHIFT) {
         if (e.modifiers & WebInputEvent::IsLeft)
             m_windowsVirtualKeyCode = VK_LSHIFT;
@@ skipping 310 matching lines @@
     type = WebInputEvent::MouseWheel;
     updateWebMouseEventFromCoreMouseEvent(event, widget, *renderObject, *this);
     deltaX = -event.deltaX();
     deltaY = -event.deltaY();
     wheelTicksX = event.ticksX();
     wheelTicksY = event.ticksY();
     scrollByPage = event.deltaMode() == WheelEvent::DOM_DELTA_PAGE;
     canScroll = event.canScroll();
 }
 
-WebKeyboardEventBuilder::WebKeyboardEventBuilder(const KeyboardEvent& event)
+WebKeyboardEventBuilder::WebKeyboardEventBuilder(const Widget* widget, const KeyboardEvent& event)
 {
     if (event.type() == EventTypeNames::keydown)
         type = KeyDown;
     else if (event.type() == EventTypeNames::keyup)
         type = WebInputEvent::KeyUp;
     else if (event.type() == EventTypeNames::keypress)
         type = WebInputEvent::Char;
     else
         return; // Skip all other keyboard events.
 
     modifiers = getWebInputModifiers(event);
     if (event.location() == KeyboardEvent::DOM_KEY_LOCATION_NUMPAD)
         modifiers |= WebInputEvent::IsKeyPad;
     else if (event.location() == KeyboardEvent::DOM_KEY_LOCATION_LEFT)
         modifiers |= WebInputEvent::IsLeft;
     else if (event.location() == KeyboardEvent::DOM_KEY_LOCATION_RIGHT)
         modifiers |= WebInputEvent::IsRight;
 
     timeStampSeconds = event.timeStamp() / millisPerSecond;
     windowsKeyCode = event.keyCode();
 
     // The platform keyevent does not exist if the event was created using
     // initKeyboardEvent.
     if (!event.keyEvent())
         return;
     nativeKeyCode = event.keyEvent()->nativeVirtualKeyCode();
+    domCode = getDomEnumFromCodeString(widget, event.keyEvent()->code());
     unsigned numberOfCharacters = std::min(event.keyEvent()->text().length(), static_cast<unsigned>(textLengthCap));
     for (unsigned i = 0; i < numberOfCharacters; ++i) {
         text[i] = event.keyEvent()->text()[i];
         unmodifiedText[i] = event.keyEvent()->unmodifiedText()[i];
     }
     memcpy(keyIdentifier, event.keyIdentifier().ascii().data(), event.keyIdentifier().length());
 }
 
 WebInputEvent::Type toWebKeyboardEventType(PlatformEvent::Type type)
 {
     switch (type) {
     case PlatformEvent::KeyUp:
         return WebInputEvent::KeyUp;
     case PlatformEvent::KeyDown:
         return WebInputEvent::KeyDown;
     case PlatformEvent::RawKeyDown:
         return WebInputEvent::RawKeyDown;
     case PlatformEvent::Char:
         return WebInputEvent::Char;
     default:
         return WebInputEvent::Undefined;
     }
 }
 
-WebKeyboardEventBuilder::WebKeyboardEventBuilder(const PlatformKeyboardEvent& event)
+WebKeyboardEventBuilder::WebKeyboardEventBuilder(const Widget* widget, const PlatformKeyboardEvent& event)
 {
     type = toWebKeyboardEventType(event.type());
     modifiers = toWebEventModifiers(event.modifiers());
     if (event.isAutoRepeat())
         modifiers |= WebInputEvent::IsAutoRepeat;
     if (event.isKeypad())
         modifiers |= WebInputEvent::IsKeyPad;
     isSystemKey = event.isSystemKey();
     nativeKeyCode = event.nativeVirtualKeyCode();
+    domCode = getDomEnumFromCodeString(widget, event.code());
 
     windowsKeyCode = windowsKeyCodeWithoutLocation(event.windowsVirtualKeyCode());
     modifiers |= locationModifiersFromWindowsKeyCode(event.windowsVirtualKeyCode());
 
     event.text().copyTo(text, 0, textLengthCap);
     event.unmodifiedText().copyTo(unmodifiedText, 0, textLengthCap);
     memcpy(keyIdentifier, event.keyIdentifier().ascii().data(), std::min(static_cast<unsigned>(keyIdentifierLengthCap), event.keyIdentifier().length()));
 }
 
 static WebTouchPoint toWebTouchPoint(const Touch* touch, const RenderObject* renderObject, WebTouchPoint::State state)
@@ skipping 83 matching lines @@
     modifiers = getWebInputModifiers(event);
 
     globalX = event.screenX();
     globalY = event.screenY();
     IntPoint localPoint = convertAbsoluteLocationForRenderObject(event.absoluteLocation(), *renderObject);
     x = localPoint.x();
     y = localPoint.y();
 }
 
 } // namespace blink