Changeset 236619 in webkit

Timestamp:

Sep 28, 2018, 4:02:41 PM (7 years ago)

Author:

dbates@webkit.org

Message:

[iOS] Allow programmatic focus when hardware keyboard is attached
​https://bugs.webkit.org/show_bug.cgi?id=190017
<rdar://problem/42270463>

Reviewed by Wenson Hsieh.

Source/WebCore:

Add support for checking if the embedding client is WebKitTestRunner and export isDumpRenderTree()
so that we can make use of it from WebKit. We will make use of these functions to keep the current
behavior of disallowing programmatic focus when running tests in these apps. This is needed to
keep testing deterministic. Otherwise, test results would be dependent on whether a hardware
keyboard is attached. When running tests in Simulator.app the hardware keyboard may also not be
connected (i.e. Hardware > Keyboard > Connect Hardware Keyboard is disabled).

• platform/RuntimeApplicationChecks.h:
• platform/cocoa/RuntimeApplicationChecksCocoa.mm:

(WebCore::IOSApplication::isWebKitTestRunner): Added.

Source/WebKit:

Make the experience of using iOS with a hardware keyboard more desktop-like by allowing
programmatic focusing of editable elements.

• Platform/spi/ios/UIKitSPI.h: Forward declare SPI.
• Shared/NativeWebKeyboardEvent.h:
• Shared/ios/NativeWebKeyboardEventIOS.mm:

(WebKit::isInHardwareKeyboardMode): Returns whether we are in hardware keyboard mode. In DumpRenderTree
and WebKitTestRunner this function always returns false to keep test results deterministic.

• UIProcess/ios/WKContentViewInteraction.mm:

(-[WKContentView _startAssistingNode:userIsInteracting:blurPreviousNode:changingActivityState:userObject:]):
Allow starting an input session if we are in hardware keyboard mode.

• WebProcess/WebPage/ios/WebPageIOS.mm:

(WebKit::WebPage::platformEditorState const): Send the full editor state if we are in hardware
keyboard mode regardless of whether layout has been performed so that UIProcess can update UI,
including the position of the caret, immediately.

Location:

trunk/Source

Files:

• WebCore/ChangeLog (modified) (1 diff)
• WebCore/platform/RuntimeApplicationChecks.h (modified) (1 diff)
• WebCore/platform/cocoa/RuntimeApplicationChecksCocoa.mm (modified) (1 diff)
• WebKit/ChangeLog (modified) (1 diff)
• WebKit/Platform/spi/ios/UIKitSPI.h (modified) (1 diff)
• WebKit/Shared/NativeWebKeyboardEvent.h (modified) (1 diff)
• WebKit/Shared/ios/NativeWebKeyboardEventIOS.mm (modified) (1 diff)
• WebKit/UIProcess/ios/WKContentViewInteraction.mm (modified) (1 diff)
• WebKit/WebProcess/WebPage/ios/WebPageIOS.mm (modified) (2 diffs)

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2018-09-28  Daniel Bates  <dabates@apple.com>
+
+        [iOS] Allow programmatic focus when hardware keyboard is attached
+        https://bugs.webkit.org/show_bug.cgi?id=190017
+        <rdar://problem/42270463>
+
+        Reviewed by Wenson Hsieh.
+
+        Add support for checking if the embedding client is WebKitTestRunner and export isDumpRenderTree()
+        so that we can make use of it from WebKit. We will make use of these functions to keep the current
+        behavior of disallowing programmatic focus when running tests in these apps. This is needed to
+        keep testing deterministic. Otherwise, test results would be dependent on whether a hardware
+        keyboard is attached. When running tests in Simulator.app the hardware keyboard may also not be
+        connected (i.e. Hardware > Keyboard > Connect Hardware Keyboard is disabled).
+
+        * platform/RuntimeApplicationChecks.h:
+        * platform/cocoa/RuntimeApplicationChecksCocoa.mm:
+        (WebCore::IOSApplication::isWebKitTestRunner): Added.
+
 2018-09-28  Ryosuke Niwa  <rniwa@webkit.org>
 

trunk/Source/WebCore/platform/RuntimeApplicationChecks.h

@@ -80 +80 @@
 WEBCORE_EXPORT bool isMobileSafari();
 WEBCORE_EXPORT bool isWebBookmarksD();
-bool isDumpRenderTree();
+WEBCORE_EXPORT bool isWebKitTestRunner();
+WEBCORE_EXPORT bool isDumpRenderTree();
 bool isMobileStore();
 bool isSpringBoard();

trunk/Source/WebCore/platform/cocoa/RuntimeApplicationChecksCocoa.mm

@@ -218 +218 @@
 }
 
+bool IOSApplication::isWebKitTestRunner()
+{
+    // We use a prefix match instead of strict equality since multiple instances of WebKitTestRunner
+    // may be launched, where the bundle identifier of each instance has a unique suffix.
+    static bool isWebKitTestRunner = applicationBundleIsEqualTo("org.webkit.WebKitTestRunnerApp"_s); // e.g. org.webkit.WebKitTestRunnerApp0
+    return isWebKitTestRunner;
+}
+
 bool IOSApplication::isMobileStore()
 {

trunk/Source/WebKit/ChangeLog

@@ +1 @@
+2018-09-28  Daniel Bates  <dabates@apple.com>
+
+        [iOS] Allow programmatic focus when hardware keyboard is attached
+        https://bugs.webkit.org/show_bug.cgi?id=190017
+        <rdar://problem/42270463>
+
+        Reviewed by Wenson Hsieh.
+
+        Make the experience of using iOS with a hardware keyboard more desktop-like by allowing
+        programmatic focusing of editable elements.
+
+        * Platform/spi/ios/UIKitSPI.h: Forward declare SPI.
+        * Shared/NativeWebKeyboardEvent.h:
+        * Shared/ios/NativeWebKeyboardEventIOS.mm:
+        (WebKit::isInHardwareKeyboardMode): Returns whether we are in hardware keyboard mode. In DumpRenderTree
+        and WebKitTestRunner this function always returns false to keep test results deterministic.
+        * UIProcess/ios/WKContentViewInteraction.mm:
+        (-[WKContentView _startAssistingNode:userIsInteracting:blurPreviousNode:changingActivityState:userObject:]):
+        Allow starting an input session if we are in hardware keyboard mode.
+        * WebProcess/WebPage/ios/WebPageIOS.mm:
+        (WebKit::WebPage::platformEditorState const): Send the full editor state if we are in hardware
+        keyboard mode regardless of whether layout has been performed so that UIProcess can update UI,
+        including the position of the caret, immediately.
+
 2018-09-28  Ryosuke Niwa  <rniwa@webkit.org>
 

trunk/Source/WebKit/Platform/spi/ios/UIKitSPI.h

@@ -248 +248 @@
 - (void)geometryChangeDone:(BOOL)keyboardVisible;
 - (void)prepareForGeometryChange;
++ (BOOL)isInHardwareKeyboardMode;
 @end
 

trunk/Source/WebKit/Shared/NativeWebKeyboardEvent.h

@@ -106 +106 @@
 };
 
+// FIXME: Find a better place for this.
+#if PLATFORM(IOS)
+bool isInHardwareKeyboardMode();
+#endif
+
 } // namespace WebKit
 

trunk/Source/WebKit/Shared/ios/NativeWebKeyboardEventIOS.mm

@@ -29 +29 @@
 #if PLATFORM(IOS)
 
+#import "UIKitSPI.h"
 #import "WebIOSEventFactory.h"
+#import <WebCore/RuntimeApplicationChecks.h>
 
 namespace WebKit {
+
+bool isInHardwareKeyboardMode()
+{
+    return !WebCore::IOSApplication::isDumpRenderTree() && !WebCore::IOSApplication::isWebKitTestRunner() && [UIKeyboard isInHardwareKeyboardMode];
+}
 
 NativeWebKeyboardEvent::NativeWebKeyboardEvent(::WebEvent *event)

trunk/Source/WebKit/UIProcess/ios/WKContentViewInteraction.mm

@@ -4192 +4192 @@
 #else
             || _isChangingFocus
+            || isInHardwareKeyboardMode()
 #endif
 #if ENABLE(DRAG_SUPPORT)

trunk/Source/WebKit/WebProcess/WebPage/ios/WebPageIOS.mm

@@ -38 +38 @@
 #import "InteractionInformationAtPosition.h"
 #import "Logging.h"
+#import "NativeWebKeyboardEvent.h"
 #import "PluginView.h"
 #import "PrintInfo.h"
@@ -192 +193 @@
     }
 
-    // We only set the remaining EditorState entries if the layout is done. To compute these
-    // entries, we need the layout to be done and we don't want to trigger a synchronous
-    // layout as this would be bad for performance. If we have a composition, we send everything
-    // right away as the UIProcess needs the caretRects ASAP for marked text.
-    bool frameViewHasFinishedLayout = frame.view() && !frame.view()->needsLayout();
-    if (shouldIncludePostLayoutData == IncludePostLayoutDataHint::No && !frameViewHasFinishedLayout && !frame.editor().hasComposition()) {
+    // We only set the remaining EditorState entries if layout is done as a performance optimization
+    // to avoid the need to force a synchronous layout here to compute these entries. If we
+    // have a composition or are using a hardware keyboard then we send the full editor state
+    // immediately so that the UIProcess can update UI, including the position of the caret.
+    bool needsLayout = !frame.view() || frame.view()->needsLayout();
+    if (shouldIncludePostLayoutData == IncludePostLayoutDataHint::No && needsLayout && !isInHardwareKeyboardMode() && !frame.editor().hasComposition()) {
         result.isMissingPostLayoutData = true;
         return;