<!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>[168747] 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/168747">168747</a></dd>
<dt>Author</dt> <dd>benjamin@webkit.org</dd>
<dt>Date</dt> <dd>2014-05-13 15:47:55 -0700 (Tue, 13 May 2014)</dd>
</dl>

<h3>Log Message</h3>
<pre>[iOS][WK2] When the secondary UIScrollView delegates respond to callbacks, delay the state change until both delegates have finished
https://bugs.webkit.org/show_bug.cgi?id=132849
&lt;rdar://problem/16863716&gt;

Patch by Benjamin Poulain &lt;bpoulain@apple.com&gt; on 2014-05-13
Reviewed by Anders Carlsson.

When there are two delegates responding to UIScrollView changes, there was often an intermediate invalid
state forwarded to the UIProcess.

For example, on scroll, WKWebView would update the state based on the current obscured insets in response to
delegate callbacks.
After that update, Safari would modify the insets, thus updating the state again.
The first state changed by WKWebView is incomplete, and should never have been set.

This patch works around the issue by delaying visible update rect in those cases.

When the two delegates of WKScrollView respond to the same selector, WKScrollView invokes 
[UIWebView _willInvokeUIScrollViewDelegateCallback] on entry, and
[UIWebView _didInvokeUIScrollViewDelegateCallback] on exit.

Between those two calls, WKWebView does not forward the new UI state to the WebProcess.

* UIProcess/API/Cocoa/WKWebView.mm:
(-[WKWebView _willInvokeUIScrollViewDelegateCallback]):
(-[WKWebView _didInvokeUIScrollViewDelegateCallback]):
(-[WKWebView _updateVisibleContentRects]):
* UIProcess/API/Cocoa/WKWebViewInternal.h:
* UIProcess/API/ios/WKViewIOS.mm:
(-[WKView _commonInitializationWithContextRef:pageGroupRef:relatedToPage:]):
* UIProcess/ios/WKScrollView.h:
* UIProcess/ios/WKScrollView.mm:
(-[WKScrollViewDelegateForwarder initWithInternalDelegate:externalDelegate:]):
(-[WKScrollViewDelegateForwarder forwardInvocation:]):
(-[WKScrollView setInternalDelegate:]):</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkSourceWebKit2ChangeLog">trunk/Source/WebKit2/ChangeLog</a></li>
<li><a href="#trunkSourceWebKit2UIProcessAPICocoaWKWebViewmm">trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebView.mm</a></li>
<li><a href="#trunkSourceWebKit2UIProcessAPICocoaWKWebViewInternalh">trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebViewInternal.h</a></li>
<li><a href="#trunkSourceWebKit2UIProcessAPIiosWKViewIOSmm">trunk/Source/WebKit2/UIProcess/API/ios/WKViewIOS.mm</a></li>
<li><a href="#trunkSourceWebKit2UIProcessiosWKScrollViewh">trunk/Source/WebKit2/UIProcess/ios/WKScrollView.h</a></li>
<li><a href="#trunkSourceWebKit2UIProcessiosWKScrollViewmm">trunk/Source/WebKit2/UIProcess/ios/WKScrollView.mm</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkSourceWebKit2ChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/ChangeLog (168746 => 168747)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/ChangeLog        2014-05-13 22:34:21 UTC (rev 168746)
+++ trunk/Source/WebKit2/ChangeLog        2014-05-13 22:47:55 UTC (rev 168747)
</span><span class="lines">@@ -1,5 +1,42 @@
</span><span class="cx"> 2014-05-13  Benjamin Poulain  &lt;bpoulain@apple.com&gt;
</span><span class="cx"> 
</span><ins>+        [iOS][WK2] When the secondary UIScrollView delegates respond to callbacks, delay the state change until both delegates have finished
+        https://bugs.webkit.org/show_bug.cgi?id=132849
+        &lt;rdar://problem/16863716&gt;
+
+        Reviewed by Anders Carlsson.
+
+        When there are two delegates responding to UIScrollView changes, there was often an intermediate invalid
+        state forwarded to the UIProcess.
+
+        For example, on scroll, WKWebView would update the state based on the current obscured insets in response to
+        delegate callbacks.
+        After that update, Safari would modify the insets, thus updating the state again.
+        The first state changed by WKWebView is incomplete, and should never have been set.
+
+        This patch works around the issue by delaying visible update rect in those cases.
+
+        When the two delegates of WKScrollView respond to the same selector, WKScrollView invokes 
+        [UIWebView _willInvokeUIScrollViewDelegateCallback] on entry, and
+        [UIWebView _didInvokeUIScrollViewDelegateCallback] on exit.
+
+        Between those two calls, WKWebView does not forward the new UI state to the WebProcess.
+
+        * UIProcess/API/Cocoa/WKWebView.mm:
+        (-[WKWebView _willInvokeUIScrollViewDelegateCallback]):
+        (-[WKWebView _didInvokeUIScrollViewDelegateCallback]):
+        (-[WKWebView _updateVisibleContentRects]):
+        * UIProcess/API/Cocoa/WKWebViewInternal.h:
+        * UIProcess/API/ios/WKViewIOS.mm:
+        (-[WKView _commonInitializationWithContextRef:pageGroupRef:relatedToPage:]):
+        * UIProcess/ios/WKScrollView.h:
+        * UIProcess/ios/WKScrollView.mm:
+        (-[WKScrollViewDelegateForwarder initWithInternalDelegate:externalDelegate:]):
+        (-[WKScrollViewDelegateForwarder forwardInvocation:]):
+        (-[WKScrollView setInternalDelegate:]):
+
+2014-05-13  Benjamin Poulain  &lt;bpoulain@apple.com&gt;
+
</ins><span class="cx">         [iOS][WK2] Remove the _extendedBackgroundExclusionInsets SPI
</span><span class="cx">         https://bugs.webkit.org/show_bug.cgi?id=132848
</span><span class="cx">         &lt;rdar://problem/16875093&gt;
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessAPICocoaWKWebViewmm"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebView.mm (168746 => 168747)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebView.mm        2014-05-13 22:34:21 UTC (rev 168746)
+++ trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebView.mm        2014-05-13 22:47:55 UTC (rev 168747)
</span><span class="lines">@@ -135,6 +135,9 @@
</span><span class="cx">     RetainPtr&lt;UIView &lt;WKWebViewContentProvider&gt;&gt; _customContentView;
</span><span class="cx"> 
</span><span class="cx">     WebCore::Color _scrollViewBackgroundColor;
</span><ins>+
+    BOOL _delayUpdateVisibleContentRects;
+    BOOL _hadDelayedUpdateVisibleContentRects;
</ins><span class="cx"> #endif
</span><span class="cx"> #if PLATFORM(MAC)
</span><span class="cx">     RetainPtr&lt;WKView&gt; _wkView;
</span><span class="lines">@@ -419,6 +422,20 @@
</span><span class="cx">     [_customContentView web_setContentProviderData:data suggestedFilename:suggestedFilename];
</span><span class="cx"> }
</span><span class="cx"> 
</span><ins>+- (void)_willInvokeUIScrollViewDelegateCallback
+{
+    _delayUpdateVisibleContentRects = YES;
+}
+
+- (void)_didInvokeUIScrollViewDelegateCallback
+{
+    _delayUpdateVisibleContentRects = NO;
+    if (_hadDelayedUpdateVisibleContentRects) {
+        _hadDelayedUpdateVisibleContentRects = NO;
+        [self _updateVisibleContentRects];
+    }
+}
+
</ins><span class="cx"> static CGFloat contentZoomScale(WKWebView* webView)
</span><span class="cx"> {
</span><span class="cx">     UIView *zoomView;
</span><span class="lines">@@ -883,6 +900,11 @@
</span><span class="cx">     if (![self usesStandardContentView])
</span><span class="cx">         return;
</span><span class="cx"> 
</span><ins>+    if (_delayUpdateVisibleContentRects) {
+        _hadDelayedUpdateVisibleContentRects = YES;
+        return;
+    }
+
</ins><span class="cx">     if (_isAnimatingResize)
</span><span class="cx">         return;
</span><span class="cx"> 
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessAPICocoaWKWebViewInternalh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebViewInternal.h (168746 => 168747)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebViewInternal.h        2014-05-13 22:34:21 UTC (rev 168746)
+++ trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebViewInternal.h        2014-05-13 22:47:55 UTC (rev 168747)
</span><span class="lines">@@ -73,6 +73,9 @@
</span><span class="cx"> 
</span><span class="cx"> - (void)_setHasCustomContentView:(BOOL)hasCustomContentView loadedMIMEType:(const WTF::String&amp;)mimeType;
</span><span class="cx"> - (void)_didFinishLoadingDataForCustomContentProviderWithSuggestedFilename:(const WTF::String&amp;)suggestedFilename data:(NSData *)data;
</span><ins>+
+- (void)_willInvokeUIScrollViewDelegateCallback;
+- (void)_didInvokeUIScrollViewDelegateCallback;
</ins><span class="cx"> #endif
</span><span class="cx"> @end
</span><span class="cx"> 
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessAPIiosWKViewIOSmm"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/API/ios/WKViewIOS.mm (168746 => 168747)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/API/ios/WKViewIOS.mm        2014-05-13 22:34:21 UTC (rev 168746)
+++ trunk/Source/WebKit2/UIProcess/API/ios/WKViewIOS.mm        2014-05-13 22:47:55 UTC (rev 168747)
</span><span class="lines">@@ -221,7 +221,6 @@
</span><span class="cx">     CGRect bounds = self.bounds;
</span><span class="cx"> 
</span><span class="cx">     _scrollView = adoptNS([[WKScrollView alloc] initWithFrame:bounds]);
</span><del>-    [_scrollView setInternalDelegate:self];
</del><span class="cx">     [_scrollView setBouncesZoom:YES];
</span><span class="cx"> 
</span><span class="cx">     [self addSubview:_scrollView.get()];
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessiosWKScrollViewh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/ios/WKScrollView.h (168746 => 168747)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/ios/WKScrollView.h        2014-05-13 22:34:21 UTC (rev 168746)
+++ trunk/Source/WebKit2/UIProcess/ios/WKScrollView.h        2014-05-13 22:47:55 UTC (rev 168747)
</span><span class="lines">@@ -1,5 +1,5 @@
</span><span class="cx"> /*
</span><del>- * Copyright (C) 2013 Apple Inc. All rights reserved.
</del><ins>+ * Copyright (C) 2013, 2014 Apple Inc. All rights reserved.
</ins><span class="cx">  *
</span><span class="cx">  * Redistribution and use in source and binary forms, with or without
</span><span class="cx">  * modification, are permitted provided that the following conditions
</span><span class="lines">@@ -27,9 +27,11 @@
</span><span class="cx"> 
</span><span class="cx"> #import &lt;UIKit/UIWebScrollView.h&gt;
</span><span class="cx"> 
</span><ins>+@class WKWebView;
+
</ins><span class="cx"> @interface WKScrollView : UIWebScrollView
</span><span class="cx"> 
</span><del>-@property (nonatomic, assign) id &lt;UIScrollViewDelegate&gt; internalDelegate;
</del><ins>+@property (nonatomic, assign) WKWebView &lt;UIScrollViewDelegate&gt; *internalDelegate;
</ins><span class="cx"> 
</span><span class="cx"> @end
</span><span class="cx"> 
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessiosWKScrollViewmm"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/ios/WKScrollView.mm (168746 => 168747)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/ios/WKScrollView.mm        2014-05-13 22:34:21 UTC (rev 168746)
+++ trunk/Source/WebKit2/UIProcess/ios/WKScrollView.mm        2014-05-13 22:47:55 UTC (rev 168747)
</span><span class="lines">@@ -1,5 +1,5 @@
</span><span class="cx"> /*
</span><del>- * Copyright (C) 2013 Apple Inc. All rights reserved.
</del><ins>+ * Copyright (C) 2013, 2014 Apple Inc. All rights reserved.
</ins><span class="cx">  *
</span><span class="cx">  * Redistribution and use in source and binary forms, with or without
</span><span class="cx">  * modification, are permitted provided that the following conditions
</span><span class="lines">@@ -28,6 +28,7 @@
</span><span class="cx"> 
</span><span class="cx"> #if PLATFORM(IOS)
</span><span class="cx"> 
</span><ins>+#import &quot;WKWebViewInternal.h&quot;
</ins><span class="cx"> #import &lt;CoreGraphics/CGFloat.h&gt;
</span><span class="cx"> 
</span><span class="cx"> @interface UIScrollView (UIScrollViewInternalHack)
</span><span class="lines">@@ -36,16 +37,16 @@
</span><span class="cx"> 
</span><span class="cx"> @interface WKScrollViewDelegateForwarder : NSObject &lt;UIScrollViewDelegate&gt;
</span><span class="cx"> 
</span><del>-- (instancetype)initWithInternalDelegate:(id &lt;UIScrollViewDelegate&gt;)internalDelegate externalDelegate:(id &lt;UIScrollViewDelegate&gt;)externalDelegate;
</del><ins>+- (instancetype)initWithInternalDelegate:(WKWebView *)internalDelegate externalDelegate:(id &lt;UIScrollViewDelegate&gt;)externalDelegate;
</ins><span class="cx"> 
</span><span class="cx"> @end
</span><span class="cx"> 
</span><span class="cx"> @implementation WKScrollViewDelegateForwarder {
</span><del>-    id &lt;UIScrollViewDelegate&gt; _internalDelegate;
</del><ins>+    WKWebView *_internalDelegate;
</ins><span class="cx">     id &lt;UIScrollViewDelegate&gt; _externalDelegate;
</span><span class="cx"> }
</span><span class="cx"> 
</span><del>-- (instancetype)initWithInternalDelegate:(id &lt;UIScrollViewDelegate&gt;)internalDelegate externalDelegate:(id &lt;UIScrollViewDelegate&gt;)externalDelegate
</del><ins>+- (instancetype)initWithInternalDelegate:(WKWebView &lt;UIScrollViewDelegate&gt; *)internalDelegate externalDelegate:(id &lt;UIScrollViewDelegate&gt;)externalDelegate
</ins><span class="cx"> {
</span><span class="cx">     self = [super init];
</span><span class="cx">     if (!self)
</span><span class="lines">@@ -72,16 +73,22 @@
</span><span class="cx"> 
</span><span class="cx"> - (void)forwardInvocation:(NSInvocation *)anInvocation
</span><span class="cx"> {
</span><del>-    BOOL messageHandled = NO;
-    if ([_internalDelegate respondsToSelector:[anInvocation selector]]) {
</del><ins>+    SEL aSelector = [anInvocation selector];
+    BOOL internalDelegateWillRespond = [_internalDelegate respondsToSelector:aSelector];
+    BOOL externalDelegateWillRespond = [_externalDelegate respondsToSelector:aSelector];
+
+    if (internalDelegateWillRespond &amp;&amp; externalDelegateWillRespond)
+        [_internalDelegate _willInvokeUIScrollViewDelegateCallback];
+
+    if (internalDelegateWillRespond)
</ins><span class="cx">         [anInvocation invokeWithTarget:_internalDelegate];
</span><del>-        messageHandled = YES;
-    }
-    if ([_externalDelegate respondsToSelector:[anInvocation selector]]) {
</del><ins>+    if (externalDelegateWillRespond)
</ins><span class="cx">         [anInvocation invokeWithTarget:_externalDelegate];
</span><del>-        messageHandled = YES;
-    }
-    if (!messageHandled)
</del><ins>+
+    if (internalDelegateWillRespond &amp;&amp; externalDelegateWillRespond)
+        [_internalDelegate _didInvokeUIScrollViewDelegateCallback];
+
+    if (!internalDelegateWillRespond &amp;&amp; !externalDelegateWillRespond)
</ins><span class="cx">         [super forwardInvocation:anInvocation];
</span><span class="cx"> }
</span><span class="cx"> 
</span><span class="lines">@@ -104,7 +111,7 @@
</span><span class="cx">     WKScrollViewDelegateForwarder *_delegateForwarder;
</span><span class="cx"> }
</span><span class="cx"> 
</span><del>-- (void)setInternalDelegate:(id &lt;UIScrollViewDelegate&gt;)internalDelegate
</del><ins>+- (void)setInternalDelegate:(WKWebView &lt;UIScrollViewDelegate&gt; *)internalDelegate
</ins><span class="cx"> {
</span><span class="cx">     if (internalDelegate == _internalDelegate)
</span><span class="cx">         return;
</span></span></pre>
</div>
</div>

</body>
</html>