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

Author: magomez

Source/WebCore/CMakeLists.txt

@@ -2258,6 +2258,15 @@ if (USE_LIBWEBRTC)
     )
 endif ()
 
+if (ENABLE_OIPF_VK)
+    list(APPEND WebCore_IDL_FILES
+        page/VkConsts.idl
+    )
+    list(APPEND WebCore_SOURCES
+        page/VkConsts.cpp
+    )
+endif ()
+
 # FIXME: This needs a more scalable solution. See webkit.org/b/267080 for some related discussion.
 if (HAVE_OS_DARK_MODE_SUPPORT)
     set(FEATURE_DEFINES_WITH_SPACE_SEPARATOR "${FEATURE_DEFINES_WITH_SPACE_SEPARATOR} HAVE_OS_DARK_MODE_SUPPORT")

Source/WebCore/page/DOMWindow.cpp

@@ -48,6 +48,10 @@
 #include <wtf/IsoMallocInlines.h>
 #include <wtf/NeverDestroyed.h>
 
+#if ENABLE(OIPF_VK)
+#include "VkConsts.h"
+#endif
+
 namespace WebCore {
 
 WTF_MAKE_ISO_ALLOCATED_IMPL(DOMWindow);
@@ -527,6 +531,16 @@ void DOMWindow::blur()
     RELEASE_ASSERT_NOT_REACHED();
 }
 
+#if ENABLE(OIPF_VK)
+ExceptionOr<RefPtr<VkConsts>> DOMWindow::keyEvent()
+{
+    auto* localThis = dynamicDowncast<LocalDOMWindow>(*this);
+    if (!localThis)
+        return Exception { ExceptionCode::SecurityError };
+    return localThis->keyEvent();
+}
+#endif
+
 ExceptionOr<void> DOMWindow::print()
 {
     auto* localThis = dynamicDowncast<LocalDOMWindow>(*this);

Source/WebCore/page/DOMWindow.h

@@ -76,6 +76,10 @@ class WebKitNamespace;
 class WebKitPoint;
 class WindowProxy;
 
+#if ENABLE(OIPF_VK)
+class VkConsts;
+#endif
+
 #if ENABLE(DEVICE_ORIENTATION)
 class DeviceMotionController;
 class DeviceOrientationController;
@@ -130,6 +134,10 @@ class DOMWindow : public RefCounted<DOMWindow>, public EventTarget {
     void focus(LocalDOMWindow& incumbentWindow);
     void blur();
 
+#if ENABLE(OIPF_VK)
+    ExceptionOr<RefPtr<VkConsts>> keyEvent();
+#endif
+
     ExceptionOr<AtomString> name() const;
     ExceptionOr<void> setName(const AtomString&);
     ExceptionOr<String> status() const;

Source/WebCore/page/DOMWindow.idl

@@ -120,6 +120,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
 };
 
 DOMWindow includes AnimationFrameProvider;

Source/WebCore/page/LocalDOMWindow.cpp

@@ -160,6 +160,10 @@
 #include "PointerLockController.h"
 #endif
 
+#if ENABLE(OIPF_VK)
+#include "VkConsts.h"
+#endif
+
 namespace WebCore {
 using namespace Inspector;
 
@@ -2782,4 +2786,16 @@ CookieStore& LocalDOMWindow::cookieStore()
     return *m_cookieStore;
 }
 
+#if ENABLE(OIPF_VK)
+RefPtr<VkConsts> LocalDOMWindow::keyEvent()
+{
+    if (!isCurrentlyDisplayedInFrame())
+        return nullptr;
+    if (!m_keyEvent)
+        m_keyEvent = VkConsts::create(*this);
+
+    return m_keyEvent;
+}
+#endif
+
 } // namespace WebCore

Source/WebCore/page/LocalDOMWindow.h

@@ -61,6 +61,10 @@ class JSValue;
 
 namespace WebCore {
 
+#if ENABLE(OIPF_VK)
+class VkConsts;
+#endif
+
 enum class IncludeTargetOrigin : bool { No, Yes };
 
 class LocalDOMWindowObserver : public CanMakeWeakPtr<LocalDOMWindowObserver> {
@@ -363,6 +367,10 @@ class LocalDOMWindow final
 
     CookieStore& cookieStore();
 
+#if ENABLE(OIPF_VK)
+    RefPtr<VkConsts> keyEvent();
+#endif
+
 private:
     explicit LocalDOMWindow(Document&);
 
@@ -412,6 +420,9 @@ class LocalDOMWindow final
     mutable RefPtr<BarProp> m_toolbar;
     mutable RefPtr<VisualViewport> m_visualViewport;
     mutable RefPtr<Navigation> m_navigation;
+#if ENABLE(OIPF_VK)
+    mutable RefPtr<VkConsts> m_keyEvent;
+#endif
 
     String m_status;
 

Source/WebCore/page/VkConsts.cpp

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

Source/WebCore/page/VkConsts.h

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

@@ -112,6 +112,7 @@ WEBKIT_OPTION_DEFINE(USE_SOUP2 "Whether to enable usage of Soup 2 instead of Sou
 # Private options specific to the WPE port.
 WEBKIT_OPTION_DEFINE(USE_EXTERNAL_HOLEPUNCH "Whether to enable external holepunch" PRIVATE OFF)
 WEBKIT_OPTION_DEFINE(USE_ANGLE_GBM "Whether to enable ANGLE implementation with GBM" PRIVATE OFF)
+WEBKIT_OPTION_DEFINE(ENABLE_OIPF_VK "Whether to enable OIPF keys for DAE applications" PRIVATE OFF)
 
 WEBKIT_OPTION_DEPEND(ENABLE_DOCUMENTATION ENABLE_INTROSPECTION)