[wpe-2.38] [OIPF] Add window.KeyEvent interface with VK keys mapping

This change is required by Britbox application to properly handle seek/play/pause

Author: Piotr Marcinkowski

Source/WebCore/CMakeLists.txt

@@ -1313,6 +1313,15 @@ set(WebCore_NON_SVG_IDL_FILES
     xml/XSLTProcessor.idl
 )
 
+if (ENABLE_OIPF_VK)
+    list(APPEND WebCore_NON_SVG_IDL_FILES
+        page/VkConsts.idl
+    )
+    list(APPEND WebCore_UNIFIED_SOURCE_LIST_FILES
+        SourcesOIPF.txt
+    )
+endif ()
+
 set(WebCore_SVG_IDL_FILES
     svg/Document+SVG.idl
     svg/SVGAElement.idl

Source/WebCore/SourcesOIPF.txt

@@ -0,0 +1 @@
+page/VkConsts.cpp

Source/WebCore/page/DOMWindow.cpp

@@ -134,6 +134,10 @@
 #include <wtf/URL.h>
 #include <wtf/text/WTFString.h>
 
+#if ENABLE(OIPF_VK)
+#include "VkConsts.h"
+#endif
+
 #if ENABLE(USER_MESSAGE_HANDLERS)
 #include "UserContentController.h"
 #include "UserMessageHandlerDescriptor.h"
@@ -354,6 +358,18 @@ FloatRect DOMWindow::adjustWindowRect(Page& page, const FloatRect& pendingChange
     return window;
 }
 
+#if ENABLE(OIPF_VK)
+RefPtr<VkConsts> DOMWindow::keyEvent()
+{
+    if (!isCurrentlyDisplayedInFrame())
+        return nullptr;
+    if (!m_keyEvent)
+        m_keyEvent = VkConsts::create(*this);
+
+    return m_keyEvent;
+}
+#endif
+
 bool DOMWindow::allowPopUp(Frame& firstFrame)
 {
     if (DocumentLoader* documentLoader = firstFrame.loader().documentLoader()) {

Source/WebCore/page/DOMWindow.h

@@ -89,6 +89,10 @@ class WebCoreOpaqueRoot;
 class WebKitNamespace;
 class WebKitPoint;
 
+#if ENABLE(OIPF_VK)
+class VkConsts;
+#endif
+
 #if ENABLE(DEVICE_ORIENTATION)
 class DeviceMotionController;
 class DeviceOrientationController;
@@ -162,6 +166,10 @@ class DOMWindow final
 
     static FloatRect adjustWindowRect(Page&, const FloatRect& pendingChanges);
 
+#if ENABLE(OIPF_VK)
+    RefPtr<VkConsts> keyEvent();
+#endif
+
     bool allowPopUp(); // Call on first window, not target window.
     static bool allowPopUp(Frame& firstFrame);
     static bool canShowModalDialog(const Frame&);
@@ -462,6 +470,9 @@ class DOMWindow final
     mutable RefPtr<BarProp> m_toolbar;
     mutable RefPtr<Location> m_location;
     mutable RefPtr<VisualViewport> m_visualViewport;
+#if ENABLE(OIPF_VK)
+    mutable RefPtr<VkConsts> m_keyEvent;
+#endif
 
     String m_status;
     String m_defaultStatus;

Source/WebCore/page/DOMWindow.idl

@@ -124,6 +124,10 @@
     // Internal operations, not exposed to the Web.
     [EnabledForWorld=shadowRootIsAlwaysOpen] NodeList collectMatchingElementsInFlatTree(Node scope, DOMString selectors);
     [EnabledForWorld=shadowRootIsAlwaysOpen] Element? matchingElementInFlatTree(Node scope, DOMString selectors);
+
+#if defined(ENABLE_OIPF_VK) && ENABLE_OIPF_VK
+    readonly attribute VkConsts KeyEvent;
+#endif
 };
 
 [

Source/WebCore/page/VkConsts.cpp

@@ -0,0 +1,10 @@
+#include "VkConsts.h"
+
+namespace WebCore {
+
+VkConsts::VkConsts(DOMWindow& window)
+    : DOMWindowProperty(&window)
+{
+}
+
+} // namespace WebCore

Source/WebCore/page/VkConsts.h

@@ -0,0 +1,19 @@
+#ifndef VKCONSTS_H
+#define VKCONSTS_H
+
+#include "config.h"
+#include "DOMWindowProperty.h"
+#include <wtf/RefCounted.h>
+
+namespace WebCore {
+
+class VkConsts final : public RefCounted<VkConsts>, public DOMWindowProperty {
+public:
+    static Ref<VkConsts> create(DOMWindow& window) { return adoptRef(*new VkConsts(window)); }
+
+private:
+    explicit VkConsts(DOMWindow&);
+};
+} // namespace WebCore
+
+#endif // VKCONSTS_H

Source/WebCore/page/VkConsts.idl

@@ -0,0 +1,61 @@
+[
+    Exposed=Window,
+    DoNotCheckConstants
+] interface VkConsts {
+    const long VK_ENTER = 13;
+    const long VK_LEFT = 37;
+    const long VK_UP = 38;
+    const long VK_RIGHT = 39;
+    const long VK_DOWN = 40;
+    const long VK_SPACE = 32;
+    const long VK_BACK_SPACE = 8;
+    const long VK_0 = 48;
+    const long VK_1 = 49;
+    const long VK_2 = 50;
+    const long VK_3 = 51;
+    const long VK_4 = 52;
+    const long VK_5 = 53;
+    const long VK_6 = 54;
+    const long VK_7 = 55;
+    const long VK_8 = 56;
+    const long VK_9 = 57;
+    const long VK_A = 65;
+    const long VK_B = 66;
+    const long VK_C = 67;
+    const long VK_D = 68;
+    const long VK_E = 69;
+    const long VK_F = 70;
+    const long VK_G = 71;
+    const long VK_H = 72;
+    const long VK_I = 73;
+    const long VK_J = 74;
+    const long VK_K = 75;
+    const long VK_L = 76;
+    const long VK_M = 77;
+    const long VK_N = 78;
+    const long VK_O = 79;
+    const long VK_P = 80;
+    const long VK_Q = 81;
+    const long VK_R = 82;
+    const long VK_S = 83;
+    const long VK_T = 84;
+    const long VK_U = 85;
+    const long VK_V = 86;
+    const long VK_W = 87;
+    const long VK_X = 88;
+    const long VK_Y = 89;
+    const long VK_Z = 90;
+    const long VK_RED = 403;
+    const long VK_GREEN = 404;
+    const long VK_YELLOW = 405;
+    const long VK_BLUE = 406;
+    const long VK_HELP = 47;
+    const long VK_PLAY = 250;
+    const long VK_PAUSE = 19;
+    const long VK_PLAY_PAUSE = 179;
+    const long VK_STOP = 178;
+    const long VK_FAST_FWD = 228;
+    const long VK_REWIND = 227;
+    const long VK_BACK = 27;
+    const long VK_CONTEXT_MENU = 93;
+};

Source/cmake/OptionsWPE.cmake

@@ -104,6 +104,7 @@ WEBKIT_OPTION_DEPEND(ENABLE_DOCUMENTATION ENABLE_INTROSPECTION)
 WEBKIT_OPTION_DEFINE(USE_GSTREAMER_HOLEPUNCH "Whether to enable GStreamer holepunch" PRIVATE OFF)
 WEBKIT_OPTION_DEFINE(USE_EXTERNAL_HOLEPUNCH "Whether to enable external holepunch" PRIVATE OFF)
 WEBKIT_OPTION_DEFINE(ENABLE_ACCELERATED_2D_CANVAS "Whether to enable accelerated 2D canvas" PRIVATE OFF)
+WEBKIT_OPTION_DEFINE(ENABLE_OIPF_VK "Whether to enable OIPF keys for DAE applications" PRIVATE OFF)
 
 # Supported platforms.
 WEBKIT_OPTION_DEFINE(USE_WPEWEBKIT_PLATFORM_WESTEROS "Whether to enable support for the Westeros platform" PUBLIC OFF)