Changeset 286823 in webkit

Timestamp:

Dec 9, 2021, 6:16:28 PM (5 years ago)

Author:

Aditya Keerthi

Message:

[iOS] Add SPI to enable find interactions on WKWebView
​https://bugs.webkit.org/show_bug.cgi?id=234017
rdar://86140542

Reviewed by Wenson Hsieh.

Source/WebKit:

• Platform/spi/ios/UIKitSPI.h:
• UIProcess/API/Cocoa/WKWebView.mm:

(-[WKWebView _initializeWithConfiguration:]):

• UIProcess/API/Cocoa/WKWebViewInternal.h:
• UIProcess/API/Cocoa/WKWebViewPrivate.h:
• UIProcess/API/ios/WKWebViewIOS.mm:

(-[WKWebView _findInteractionEnabled]):
(-[WKWebView _setFindInteractionEnabled:]):

Make the contentView the searchableObject, rather than self (the WKWebView)
to avoid a retain cycle.

(-[WKWebView _findInteraction]):
(-[WKWebView offsetFromPosition:toPosition:inDocument:]):
(-[WKWebView decorateFoundTextRange:inDocument:usingStyle:]):

• UIProcess/ios/WKContentViewInteraction.h:

Make WKContentView conform to _UITextSearching so that it can be set as
the interaction's searchableObject.

• UIProcess/ios/WKContentViewInteraction.mm:

(-[WKContentView decorateFoundTextRange:inDocument:usingStyle:]):
(-[WKContentView offsetFromPosition:toPosition:inDocument:]):
(-[WKContentView decorateFoundTextRange:usingStyle:]): Deleted.

Tools:

• TestWebKitAPI/Tests/WebKitCocoa/FindInPage.mm:

(TEST):

Test that the new SPI installs a _UIFindInteraction on the web view.

Location:

trunk

Files:

• Source/WebKit/ChangeLog (modified) (1 diff)
• Source/WebKit/Platform/spi/ios/UIKitSPI.h (modified) (2 diffs)
• Source/WebKit/UIProcess/API/Cocoa/WKWebView.mm (modified) (1 diff)
• Source/WebKit/UIProcess/API/Cocoa/WKWebViewInternal.h (modified) (1 diff)
• Source/WebKit/UIProcess/API/Cocoa/WKWebViewPrivate.h (modified) (2 diffs)
• Source/WebKit/UIProcess/API/ios/WKWebViewIOS.mm (modified) (3 diffs)
• Source/WebKit/UIProcess/ios/WKContentViewInteraction.h (modified) (2 diffs)
• Source/WebKit/UIProcess/ios/WKContentViewInteraction.mm (modified) (2 diffs)
• Tools/ChangeLog (modified) (1 diff)
• Tools/TestWebKitAPI/Tests/WebKitCocoa/FindInPage.mm (modified) (1 diff)

trunk/Source/WebKit/ChangeLog

@@ +1 @@
+2021-12-09  Aditya Keerthi  <akeerthi@apple.com>
+
+        [iOS] Add SPI to enable find interactions on WKWebView
+        https://bugs.webkit.org/show_bug.cgi?id=234017
+        rdar://86140542
+
+        Reviewed by Wenson Hsieh.
+
+        * Platform/spi/ios/UIKitSPI.h:
+        * UIProcess/API/Cocoa/WKWebView.mm:
+        (-[WKWebView _initializeWithConfiguration:]):
+        * UIProcess/API/Cocoa/WKWebViewInternal.h:
+        * UIProcess/API/Cocoa/WKWebViewPrivate.h:
+        * UIProcess/API/ios/WKWebViewIOS.mm:
+        (-[WKWebView _findInteractionEnabled]):
+        (-[WKWebView _setFindInteractionEnabled:]):
+
+        Make the contentView the searchableObject, rather than self (the WKWebView)
+        to avoid a retain cycle.
+
+        (-[WKWebView _findInteraction]):
+        (-[WKWebView offsetFromPosition:toPosition:inDocument:]):
+        (-[WKWebView decorateFoundTextRange:inDocument:usingStyle:]):
+        * UIProcess/ios/WKContentViewInteraction.h:
+
+        Make WKContentView conform to _UITextSearching so that it can be set as
+        the interaction's searchableObject.
+
+        * UIProcess/ios/WKContentViewInteraction.mm:
+        (-[WKContentView decorateFoundTextRange:inDocument:usingStyle:]):
+        (-[WKContentView offsetFromPosition:toPosition:inDocument:]):
+        (-[WKContentView decorateFoundTextRange:usingStyle:]): Deleted.
+
 2021-12-09  Alex Christensen  <achristensen@webkit.org>
 

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

@@ -132 +132 @@
 
 #if HAVE(UIFINDINTERACTION)
+#import <UIKit/_UIFindInteraction.h>
 #import <UIKit/_UITextSearching.h>
 #endif
@@ -327 +328 @@
 - (void)clearAllDecoratedFoundText;
 
+@end
+
+@interface _UIFindInteraction : NSObject <UIInteraction>
+@property (nonatomic, strong) id<_UITextSearching> searchableObject;
 @end
 

trunk/Source/WebKit/UIProcess/API/Cocoa/WKWebView.mm

@@ -368 +368 @@
     _allowsLinkPreview = linkedOnOrAfter(WebCore::SDKVersion::FirstWithLinkPreviewEnabledByDefault);
 
+#if HAVE(UIFINDINTERACTION)
+    _findInteractionEnabled = NO;
+#endif
+
     auto fastClickingEnabled = []() {
         if (NSNumber *enabledValue = [[NSUserDefaults standardUserDefaults] objectForKey:@"WebKitFastClickingDisabled"])

trunk/Source/WebKit/UIProcess/API/Cocoa/WKWebViewInternal.h

@@ -152 +152 @@
 #endif
 
+#if HAVE(UIFINDINTERACTION)
+    RetainPtr<_UIFindInteraction> _findInteraction;
+    BOOL _findInteractionEnabled;
+#endif
+
     RetainPtr<_WKRemoteObjectRegistry> _remoteObjectRegistry;
 

trunk/Source/WebKit/UIProcess/API/Cocoa/WKWebViewPrivate.h

@@ -25 +25 @@
 
 #if TARGET_OS_IPHONE
+#if __has_include(<UIKit/_UIFindInteraction.h>)
+#import <UIKit/_UIFindInteraction.h>
+#endif
 #if __has_include(<UIKit/_UITextSearching.h>)
 #import <UIKit/_UITextSearching.h>
@@ -439 +442 @@
 @property (nonatomic, copy, setter=_setEphemeralUIEventAttribution:) UIEventAttribution *_ephemeralUIEventAttribution WK_API_AVAILABLE(ios(WK_IOS_TBA));
 - (void)_setEphemeralUIEventAttribution:(UIEventAttribution *)attribution forApplicationWithBundleID:(NSString *)bundleID WK_API_AVAILABLE(ios(WK_IOS_TBA));
+
+#if __has_include(<UIKit/_UIFindInteraction.h>)
+@property (nonatomic, readonly) _UIFindInteraction *_findInteraction WK_API_AVAILABLE(ios(WK_IOS_TBA));
+@property (nonatomic, readwrite, setter=_setFindInteractionEnabled:) BOOL _findInteractionEnabled WK_API_AVAILABLE(ios(WK_IOS_TBA));
+#endif
+
 #endif
 

trunk/Source/WebKit/UIProcess/API/ios/WKWebViewIOS.mm

@@ -3484 +3484 @@
 #if HAVE(UIFINDINTERACTION)
 
+- (BOOL)_findInteractionEnabled
+{
+    return _findInteractionEnabled;
+}
+
+- (void)_setFindInteractionEnabled:(BOOL)enabled
+{
+    if (_findInteractionEnabled != enabled) {
+        _findInteractionEnabled = enabled;
+
+        if (enabled) {
+            if (!_findInteraction) {
+                _findInteraction = adoptNS([[_UIFindInteraction alloc] init]);
+                [_findInteraction setSearchableObject:_contentView.get()];
+            }
+
+            [self addInteraction:_findInteraction.get()];
+        } else {
+            [self removeInteraction:_findInteraction.get()];
+            _findInteraction = nil;
+        }
+    }
+}
+
+- (_UIFindInteraction *)_findInteraction
+{
+    return _findInteraction.get();
+}
+
 - (UITextRange *)selectedTextRange
 {
@@ -3491 +3520 @@
 - (NSInteger)offsetFromPosition:(UITextPosition *)from toPosition:(UITextPosition *)toPosition inDocument:(_UITextSearchDocumentIdentifier)document
 {
-    return [_contentView offsetFromPosition:from toPosition:toPosition];
+    return [_contentView offsetFromPosition:from toPosition:toPosition inDocument:document];
 }
 
@@ -3501 +3530 @@
 - (void)decorateFoundTextRange:(UITextRange *)range inDocument:(_UITextSearchDocumentIdentifier)document usingStyle:(_UIFoundTextStyle)style
 {
-    [_contentView decorateFoundTextRange:range usingStyle:style];
+    [_contentView decorateFoundTextRange:range inDocument:document usingStyle:style];
 }
 

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

@@ -538 +538 @@
     , WKHoverPlatterDelegate
 #endif
+#if HAVE(UIFINDINTERACTION)
+    , _UITextSearching
+#endif
 >
 
@@ -715 +718 @@
 - (void)clearTextIndicator:(WebCore::TextIndicatorDismissalAnimation)animation;
 
-#if HAVE(UIFINDINTERACTION)
-- (void)performTextSearchWithQueryString:(NSString *)string usingOptions:(_UITextSearchOptions *)options resultAggregator:(id<_UITextSearchAggregator>)aggregator;
-- (void)decorateFoundTextRange:(UITextRange *)range usingStyle:(_UIFoundTextStyle)style;
-- (void)clearAllDecoratedFoundText;
-#endif
-
 @property (nonatomic, readonly) BOOL _shouldUseContextMenus;
 @property (nonatomic, readonly) BOOL _shouldUseContextMenusForFormControls;

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

@@ -9988 +9988 @@
 }
 
-- (void)decorateFoundTextRange:(UITextRange *)range usingStyle:(_UIFoundTextStyle)style
+- (void)decorateFoundTextRange:(UITextRange *)range inDocument:(_UITextSearchDocumentIdentifier)document usingStyle:(_UIFoundTextStyle)style
 {
     if (![range isKindOfClass:[WKFoundTextRange class]])
@@ -10005 +10005 @@
     _foundHighlightedTextRange = nil;
     _page->hideFindUI();
+}
+
+- (NSInteger)offsetFromPosition:(UITextPosition *)from toPosition:(UITextPosition *)toPosition inDocument:(_UITextSearchDocumentIdentifier)document
+{
+    return [self offsetFromPosition:from toPosition:toPosition];
 }
 

trunk/Tools/ChangeLog

@@ +1 @@
+2021-12-09  Aditya Keerthi  <akeerthi@apple.com>
+
+        [iOS] Add SPI to enable find interactions on WKWebView
+        https://bugs.webkit.org/show_bug.cgi?id=234017
+        rdar://86140542
+
+        Reviewed by Wenson Hsieh.
+
+        * TestWebKitAPI/Tests/WebKitCocoa/FindInPage.mm:
+        (TEST):
+
+        Test that the new SPI installs a _UIFindInteraction on the web view.
+
 2021-12-09  Lauro Moura  <lmoura@igalia.com>
 

trunk/Tools/TestWebKitAPI/Tests/WebKitCocoa/FindInPage.mm

@@ -453 +453 @@
 }
 
+TEST(WebKit, FindInteraction)
+{
+    RetainPtr<WKWebView> webView = adoptNS([[WKWebView alloc] initWithFrame:CGRectMake(0, 0, 200, 200)]);
+
+    EXPECT_NULL([webView _findInteraction]);
+
+    [webView _setFindInteractionEnabled:YES];
+    EXPECT_NOT_NULL([webView _findInteraction]);
+
+    [webView _setFindInteractionEnabled:NO];
+    EXPECT_NULL([webView _findInteraction]);
+}
+
 #endif // HAVE(UIFINDINTERACTION)