<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[190278] trunk/Source/WebKit2</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.webkit.org/projects/webkit/changeset/190278">190278</a></dd>
<dt>Author</dt> <dd>wenson_hsieh@apple.com</dd>
<dt>Date</dt> <dd>2015-09-28 06:53:40 -0700 (Mon, 28 Sep 2015)</dd>
</dl>
<h3>Log Message</h3>
<pre>Expose a WKWebView API for allowing programmatic focus to trigger node assistance
https://bugs.webkit.org/show_bug.cgi?id=149567
Reviewed by Darin Adler.
Adds an API method to WKWebView that allows clients to override the default iOS behavior of not
starting node assistance when programmatically focusing. Also fixes a bug caused by naively
introducing the flag where the autofocus attribute could trigger node assistance before layout
occurs, causing an ASSERT to fail in EditorState::postLayoutData.
I fixed this issue by not assisting the node if the editor state is missing post layout data,
instead deferring node assistance until layout has occurred.
* UIProcess/API/Cocoa/WKWebView.h:
* UIProcess/API/Cocoa/WKWebView.mm:
(-[WKWebView initWithFrame:configuration:]): Initializes the new node assistance flag to NO, which
is the current default behavior.
(-[WKWebView canAssistOnProgrammaticFocus]):
(-[WKWebView setCanAssistOnProgrammaticFocus:]): New API method that allows clients to set node
assistance behavior upon programmatic focus.
* UIProcess/API/Cocoa/WKWebViewConfiguration.h:
* UIProcess/API/Cocoa/WKWebViewConfiguration.mm:
(-[WKWebViewConfiguration init]): Added new node assistance flag to configuration.
(-[WKWebViewConfiguration _canAssistOnProgrammaticFocus]):
(-[WKWebViewConfiguration _setCanAssistOnProgrammaticFocus:]):
* UIProcess/WebPageProxy.h: Added NodeAssistanceArguments struct.
* UIProcess/ios/WKContentViewInteraction.mm:
(-[WKContentView _startAssistingNode:userIsInteracting:blurPreviousNode:userObject:]): Do not return
early if the node assistance flag is set to allow programmatic focus.
* UIProcess/ios/WebPageProxyIOS.mm:
(WebKit::WebPageProxy::didCommitLayerTree): After committing the layer tree, if we have deferred
starting node assistance, immediately trigger node assistance.
(WebKit::WebPageProxy::startAssistingNode): Defer starting node assistance if we have not yet repainted.
(WebKit::WebPageProxy::stopAssistingNode): Also cancel any deferred node assistance.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkSourceWebKit2ChangeLog">trunk/Source/WebKit2/ChangeLog</a></li>
<li><a href="#trunkSourceWebKit2UIProcessAPICocoaWKWebViewh">trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebView.h</a></li>
<li><a href="#trunkSourceWebKit2UIProcessAPICocoaWKWebViewmm">trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebView.mm</a></li>
<li><a href="#trunkSourceWebKit2UIProcessAPICocoaWKWebViewConfigurationh">trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebViewConfiguration.h</a></li>
<li><a href="#trunkSourceWebKit2UIProcessAPICocoaWKWebViewConfigurationmm">trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebViewConfiguration.mm</a></li>
<li><a href="#trunkSourceWebKit2UIProcessWebPageProxyh">trunk/Source/WebKit2/UIProcess/WebPageProxy.h</a></li>
<li><a href="#trunkSourceWebKit2UIProcessiosWKContentViewInteractionmm">trunk/Source/WebKit2/UIProcess/ios/WKContentViewInteraction.mm</a></li>
<li><a href="#trunkSourceWebKit2UIProcessiosWebPageProxyIOSmm">trunk/Source/WebKit2/UIProcess/ios/WebPageProxyIOS.mm</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkSourceWebKit2ChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/ChangeLog (190277 => 190278)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/ChangeLog 2015-09-28 09:19:05 UTC (rev 190277)
+++ trunk/Source/WebKit2/ChangeLog 2015-09-28 13:53:40 UTC (rev 190278)
</span><span class="lines">@@ -1,3 +1,40 @@
</span><ins>+2015-09-27 Wenson Hsieh <wenson_hsieh@apple.com>
+
+ Expose a WKWebView API for allowing programmatic focus to trigger node assistance
+ https://bugs.webkit.org/show_bug.cgi?id=149567
+
+ Reviewed by Darin Adler.
+
+ Adds an API method to WKWebView that allows clients to override the default iOS behavior of not
+ starting node assistance when programmatically focusing. Also fixes a bug caused by naively
+ introducing the flag where the autofocus attribute could trigger node assistance before layout
+ occurs, causing an ASSERT to fail in EditorState::postLayoutData.
+
+ I fixed this issue by not assisting the node if the editor state is missing post layout data,
+ instead deferring node assistance until layout has occurred.
+
+ * UIProcess/API/Cocoa/WKWebView.h:
+ * UIProcess/API/Cocoa/WKWebView.mm:
+ (-[WKWebView initWithFrame:configuration:]): Initializes the new node assistance flag to NO, which
+ is the current default behavior.
+ (-[WKWebView canAssistOnProgrammaticFocus]):
+ (-[WKWebView setCanAssistOnProgrammaticFocus:]): New API method that allows clients to set node
+ assistance behavior upon programmatic focus.
+ * UIProcess/API/Cocoa/WKWebViewConfiguration.h:
+ * UIProcess/API/Cocoa/WKWebViewConfiguration.mm:
+ (-[WKWebViewConfiguration init]): Added new node assistance flag to configuration.
+ (-[WKWebViewConfiguration _canAssistOnProgrammaticFocus]):
+ (-[WKWebViewConfiguration _setCanAssistOnProgrammaticFocus:]):
+ * UIProcess/WebPageProxy.h: Added NodeAssistanceArguments struct.
+ * UIProcess/ios/WKContentViewInteraction.mm:
+ (-[WKContentView _startAssistingNode:userIsInteracting:blurPreviousNode:userObject:]): Do not return
+ early if the node assistance flag is set to allow programmatic focus.
+ * UIProcess/ios/WebPageProxyIOS.mm:
+ (WebKit::WebPageProxy::didCommitLayerTree): After committing the layer tree, if we have deferred
+ starting node assistance, immediately trigger node assistance.
+ (WebKit::WebPageProxy::startAssistingNode): Defer starting node assistance if we have not yet repainted.
+ (WebKit::WebPageProxy::stopAssistingNode): Also cancel any deferred node assistance.
+
</ins><span class="cx"> 2015-09-26 Carlos Garcia Campos <cgarcia@igalia.com>
</span><span class="cx">
</span><span class="cx"> REGRESSION(r188639): [GTK] Several inspector tests started to time out in GTK+ bots after r188639
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessAPICocoaWKWebViewh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebView.h (190277 => 190278)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebView.h 2015-09-28 09:19:05 UTC (rev 190277)
+++ trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebView.h 2015-09-28 13:53:40 UTC (rev 190278)
</span><span class="lines">@@ -241,6 +241,11 @@
</span><span class="cx"> /*! @abstract The scroll view associated with the web view.
</span><span class="cx"> */
</span><span class="cx"> @property (nonatomic, readonly, strong) UIScrollView *scrollView;
</span><ins>+
+/*! @abstract A Boolean value indicating whether programmatic focus on
+ an element is allowed to trigger assistance.
+ */
+@property (nonatomic) BOOL canAssistOnProgrammaticFocus;
</ins><span class="cx"> #endif
</span><span class="cx">
</span><span class="cx"> #if !TARGET_OS_IPHONE
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessAPICocoaWKWebViewmm"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebView.mm (190277 => 190278)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebView.mm 2015-09-28 09:19:05 UTC (rev 190277)
+++ trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebView.mm 2015-09-28 13:53:40 UTC (rev 190278)
</span><span class="lines">@@ -211,6 +211,8 @@
</span><span class="cx"> BOOL _pageIsPrintingToPDF;
</span><span class="cx"> RetainPtr<CGPDFDocumentRef> _printedDocument;
</span><span class="cx"> Vector<std::function<void ()>> _snapshotsDeferredDuringResize;
</span><ins>+
+ BOOL _canAssistOnProgrammaticFocus;
</ins><span class="cx"> #endif
</span><span class="cx"> #if PLATFORM(MAC)
</span><span class="cx"> RetainPtr<WKView> _wkView;
</span><span class="lines">@@ -366,6 +368,8 @@
</span><span class="cx"> _page->contentSizeCategoryDidChange([self _contentSizeCategory]);
</span><span class="cx">
</span><span class="cx"> [[_configuration _contentProviderRegistry] addPage:*_page];
</span><ins>+
+ [self setCanAssistOnProgrammaticFocus:[_configuration canAssistOnProgrammaticFocus]];
</ins><span class="cx"> #endif
</span><span class="cx">
</span><span class="cx"> #if PLATFORM(MAC)
</span><span class="lines">@@ -716,6 +720,16 @@
</span><span class="cx"> return _scrollView.get();
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+- (BOOL)canAssistOnProgrammaticFocus
+{
+ return _canAssistOnProgrammaticFocus;
+}
+
+- (void)setCanAssistOnProgrammaticFocus:(BOOL)canAssistOnProgrammaticFocus
+{
+ _canAssistOnProgrammaticFocus = canAssistOnProgrammaticFocus;
+}
+
</ins><span class="cx"> - (WKBrowsingContextController *)browsingContextController
</span><span class="cx"> {
</span><span class="cx"> return [_contentView browsingContextController];
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessAPICocoaWKWebViewConfigurationh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebViewConfiguration.h (190277 => 190278)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebViewConfiguration.h 2015-09-28 09:19:05 UTC (rev 190277)
+++ trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebViewConfiguration.h 2015-09-28 13:53:40 UTC (rev 190278)
</span><span class="lines">@@ -119,6 +119,12 @@
</span><span class="cx"> */
</span><span class="cx"> @property (nonatomic) BOOL allowsPictureInPictureMediaPlayback WK_AVAILABLE(NA, 9_0);
</span><span class="cx">
</span><ins>+/*! @abstract A Boolean value indicating whether programmatic focus on
+ an element is allowed to trigger assistance.
+ @discussion The default value is NO.
+ */
+@property (nonatomic) BOOL canAssistOnProgrammaticFocus;
+
</ins><span class="cx"> #endif
</span><span class="cx">
</span><span class="cx"> @end
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessAPICocoaWKWebViewConfigurationmm"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebViewConfiguration.mm (190277 => 190278)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebViewConfiguration.mm 2015-09-28 09:19:05 UTC (rev 190277)
+++ trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebViewConfiguration.mm 2015-09-28 13:53:40 UTC (rev 190278)
</span><span class="lines">@@ -112,6 +112,7 @@
</span><span class="cx"> _allowsInlineMediaPlayback = WKGetDeviceClass() == WKDeviceClassiPad;
</span><span class="cx"> _inlineMediaPlaybackRequiresPlaysInlineAttribute = !_allowsInlineMediaPlayback;
</span><span class="cx"> _mediaDataLoadsAutomatically = NO;
</span><ins>+ _canAssistOnProgrammaticFocus = NO;
</ins><span class="cx"> #endif
</span><span class="cx">
</span><span class="cx"> #if ENABLE(WIRELESS_PLAYBACK_TARGET)
</span><span class="lines">@@ -364,6 +365,16 @@
</span><span class="cx"> {
</span><span class="cx"> _mediaDataLoadsAutomatically = mediaDataLoadsAutomatically;
</span><span class="cx"> }
</span><ins>+
+- (BOOL)_canAssistOnProgrammaticFocus
+{
+ return _canAssistOnProgrammaticFocus;
+}
+
+- (void)_setCanAssistOnProgrammaticFocus:(BOOL)canAssistOnProgrammaticFocus
+{
+ _canAssistOnProgrammaticFocus = canAssistOnProgrammaticFocus;
+}
</ins><span class="cx"> #endif
</span><span class="cx">
</span><span class="cx"> @end
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessWebPageProxyh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/WebPageProxy.h (190277 => 190278)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/WebPageProxy.h 2015-09-28 09:19:05 UTC (rev 190277)
+++ trunk/Source/WebKit2/UIProcess/WebPageProxy.h 2015-09-28 13:53:40 UTC (rev 190278)
</span><span class="lines">@@ -248,6 +248,12 @@
</span><span class="cx"> #if PLATFORM(IOS)
</span><span class="cx"> typedef GenericCallback<const WebCore::IntPoint&, uint32_t, uint32_t, uint32_t> GestureCallback;
</span><span class="cx"> typedef GenericCallback<const WebCore::IntPoint&, uint32_t> TouchesCallback;
</span><ins>+struct NodeAssistanceArguments {
+ AssistedNodeInformation m_nodeInformation;
+ bool m_userIsInteracting;
+ bool m_blurPreviousNode;
+ RefPtr<API::Object> m_userData;
+};
</ins><span class="cx"> #endif
</span><span class="cx">
</span><span class="cx"> #if PLATFORM(COCOA)
</span><span class="lines">@@ -1765,6 +1771,11 @@
</span><span class="cx"> #endif
</span><span class="cx">
</span><span class="cx"> bool m_userContentExtensionsEnabled { true };
</span><ins>+
+#if PLATFORM(IOS)
+ bool m_hasDeferredStartAssistingNode { false };
+ std::unique_ptr<NodeAssistanceArguments> m_deferredNodeAssistanceArguments;
+#endif
</ins><span class="cx"> };
</span><span class="cx">
</span><span class="cx"> } // namespace WebKit
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessiosWKContentViewInteractionmm"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/ios/WKContentViewInteraction.mm (190277 => 190278)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/ios/WKContentViewInteraction.mm 2015-09-28 09:19:05 UTC (rev 190277)
+++ trunk/Source/WebKit2/UIProcess/ios/WKContentViewInteraction.mm 2015-09-28 13:53:40 UTC (rev 190278)
</span><span class="lines">@@ -3015,7 +3015,7 @@
</span><span class="cx"> {
</span><span class="cx"> // FIXME: This is a temporary workaround for <rdar://problem/22126518>. The real fix will involve refactoring
</span><span class="cx"> // the way we assist programmatically focused nodes.
</span><del>- if (!userIsInteracting && !_textSelectionAssistant)
</del><ins>+ if (!userIsInteracting && !_textSelectionAssistant && !_webView.canAssistOnProgrammaticFocus)
</ins><span class="cx"> return;
</span><span class="cx">
</span><span class="cx"> if (blurPreviousNode)
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessiosWebPageProxyIOSmm"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/ios/WebPageProxyIOS.mm (190277 => 190278)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/ios/WebPageProxyIOS.mm 2015-09-28 09:19:05 UTC (rev 190277)
+++ trunk/Source/WebKit2/UIProcess/ios/WebPageProxyIOS.mm 2015-09-28 13:53:40 UTC (rev 190278)
</span><span class="lines">@@ -358,6 +358,12 @@
</span><span class="cx"> m_hitRenderTreeSizeThreshold = true;
</span><span class="cx"> didLayout(WebCore::ReachedSessionRestorationRenderTreeSizeThreshold);
</span><span class="cx"> }
</span><ins>+
+ if (m_hasDeferredStartAssistingNode) {
+ m_pageClient.startAssistingNode(m_deferredNodeAssistanceArguments->m_nodeInformation, m_deferredNodeAssistanceArguments->m_userIsInteracting, m_deferredNodeAssistanceArguments->m_blurPreviousNode, m_deferredNodeAssistanceArguments->m_userData.get());
+ m_hasDeferredStartAssistingNode = false;
+ m_deferredNodeAssistanceArguments = nullptr;
+ }
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> void WebPageProxy::selectWithGesture(const WebCore::IntPoint point, WebCore::TextGranularity granularity, uint32_t gestureType, uint32_t gestureState, std::function<void (const WebCore::IntPoint&, uint32_t, uint32_t, uint32_t, CallbackBase::Error)> callbackFunction)
</span><span class="lines">@@ -805,11 +811,22 @@
</span><span class="cx">
</span><span class="cx"> void WebPageProxy::startAssistingNode(const AssistedNodeInformation& information, bool userIsInteracting, bool blurPreviousNode, const UserData& userData)
</span><span class="cx"> {
</span><del>- m_pageClient.startAssistingNode(information, userIsInteracting, blurPreviousNode, process().transformHandlesToObjects(userData.object()).get());
</del><ins>+ API::Object* userDataObject = process().transformHandlesToObjects(userData.object()).get();
+ if (m_editorState.isMissingPostLayoutData) {
+ m_deferredNodeAssistanceArguments = std::make_unique<NodeAssistanceArguments>(NodeAssistanceArguments { information, userIsInteracting, blurPreviousNode, userDataObject });
+ m_hasDeferredStartAssistingNode = true;
+ return;
+ }
+
+ m_pageClient.startAssistingNode(information, userIsInteracting, blurPreviousNode, userDataObject);
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> void WebPageProxy::stopAssistingNode()
</span><span class="cx"> {
</span><ins>+ if (m_hasDeferredStartAssistingNode) {
+ m_hasDeferredStartAssistingNode = false;
+ m_deferredNodeAssistanceArguments = nullptr;
+ }
</ins><span class="cx"> m_pageClient.stopAssistingNode();
</span><span class="cx"> }
</span><span class="cx">
</span></span></pre>
</div>
</div>
</body>
</html>