<!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>[172200] 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/172200">172200</a></dd>
<dt>Author</dt> <dd>timothy_horton@apple.com</dd>
<dt>Date</dt> <dd>2014-08-06 19:58:22 -0700 (Wed, 06 Aug 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Services overlay flashes a lot; should have some hysteresis before showing overlay
https://bugs.webkit.org/show_bug.cgi?id=135683
<rdar://problem/16878039>
Reviewed by Simon Fraser.
Don't show the highlight until it's been 200ms since the last change
in selection or change in which highlight is hovered, whichever was more recent.
* WebProcess/WebPage/ServicesOverlayController.h:
* WebProcess/WebPage/mac/ServicesOverlayController.mm:
(WebKit::ServicesOverlayController::ServicesOverlayController):
(WebKit::ServicesOverlayController::selectionRectsDidChange):
Keep track of when the selection last changed.
(WebKit::ServicesOverlayController::drawTelephoneNumberHighlightIfVisible):
Make establishHoveredTelephoneHighlight take a bool instead of Boolean.
(WebKit::ServicesOverlayController::mouseIsOverHighlight):
Factor mouseIsOverHighlight out of establishHoveredTelephoneHighlight and drawHighlight.
(WebKit::ServicesOverlayController::remainingTimeUntilHighlightShouldBeShown):
Return the amount of time until the highlight should be shown; this is
the maximum of (the difference between the last selection change and the timeout)
and (the difference between the last change in which highlight is hovered and the timeout).
Telephone number highlights are shown immediately, because they are already stable
by virtue of being expanded to include the entire telephone number.
(WebKit::ServicesOverlayController::repaintHighlightTimerFired):
(WebKit::ServicesOverlayController::drawHighlight):
If the highlight shouldn't be shown yet (because we haven't hit the two timeouts),
schedule a timer to repaint us around when we will hit the timeouts.
(WebKit::ServicesOverlayController::establishHoveredTelephoneHighlight):
(WebKit::ServicesOverlayController::mouseEvent):
Don't allow mouseUp to trigger the menu if we shouldn't be showing the overlay yet.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkSourceWebKit2ChangeLog">trunk/Source/WebKit2/ChangeLog</a></li>
<li><a href="#trunkSourceWebKit2WebProcessWebPageServicesOverlayControllerh">trunk/Source/WebKit2/WebProcess/WebPage/ServicesOverlayController.h</a></li>
<li><a href="#trunkSourceWebKit2WebProcessWebPagemacServicesOverlayControllermm">trunk/Source/WebKit2/WebProcess/WebPage/mac/ServicesOverlayController.mm</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkSourceWebKit2ChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/ChangeLog (172199 => 172200)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/ChangeLog 2014-08-07 02:43:35 UTC (rev 172199)
+++ trunk/Source/WebKit2/ChangeLog 2014-08-07 02:58:22 UTC (rev 172200)
</span><span class="lines">@@ -1,3 +1,43 @@
</span><ins>+2014-08-06 Tim Horton <timothy_horton@apple.com>
+
+ Services overlay flashes a lot; should have some hysteresis before showing overlay
+ https://bugs.webkit.org/show_bug.cgi?id=135683
+ <rdar://problem/16878039>
+
+ Reviewed by Simon Fraser.
+
+ Don't show the highlight until it's been 200ms since the last change
+ in selection or change in which highlight is hovered, whichever was more recent.
+
+ * WebProcess/WebPage/ServicesOverlayController.h:
+ * WebProcess/WebPage/mac/ServicesOverlayController.mm:
+ (WebKit::ServicesOverlayController::ServicesOverlayController):
+ (WebKit::ServicesOverlayController::selectionRectsDidChange):
+ Keep track of when the selection last changed.
+
+ (WebKit::ServicesOverlayController::drawTelephoneNumberHighlightIfVisible):
+ Make establishHoveredTelephoneHighlight take a bool instead of Boolean.
+
+ (WebKit::ServicesOverlayController::mouseIsOverHighlight):
+ Factor mouseIsOverHighlight out of establishHoveredTelephoneHighlight and drawHighlight.
+
+ (WebKit::ServicesOverlayController::remainingTimeUntilHighlightShouldBeShown):
+ Return the amount of time until the highlight should be shown; this is
+ the maximum of (the difference between the last selection change and the timeout)
+ and (the difference between the last change in which highlight is hovered and the timeout).
+
+ Telephone number highlights are shown immediately, because they are already stable
+ by virtue of being expanded to include the entire telephone number.
+
+ (WebKit::ServicesOverlayController::repaintHighlightTimerFired):
+ (WebKit::ServicesOverlayController::drawHighlight):
+ If the highlight shouldn't be shown yet (because we haven't hit the two timeouts),
+ schedule a timer to repaint us around when we will hit the timeouts.
+
+ (WebKit::ServicesOverlayController::establishHoveredTelephoneHighlight):
+ (WebKit::ServicesOverlayController::mouseEvent):
+ Don't allow mouseUp to trigger the menu if we shouldn't be showing the overlay yet.
+
</ins><span class="cx"> 2014-08-06 Simon Fraser <simon.fraser@apple.com>
</span><span class="cx">
</span><span class="cx"> [iOS WK2] www.france24.com doesn't always load the page, sections stay white
</span></span></pre></div>
<a id="trunkSourceWebKit2WebProcessWebPageServicesOverlayControllerh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/WebProcess/WebPage/ServicesOverlayController.h (172199 => 172200)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/WebProcess/WebPage/ServicesOverlayController.h 2014-08-07 02:43:35 UTC (rev 172199)
+++ trunk/Source/WebKit2/WebProcess/WebPage/ServicesOverlayController.h 2014-08-07 02:58:22 UTC (rev 172200)
</span><span class="lines">@@ -30,6 +30,7 @@
</span><span class="cx">
</span><span class="cx"> #include "PageOverlay.h"
</span><span class="cx"> #include <WebCore/Range.h>
</span><ins>+#include <WebCore/Timer.h>
</ins><span class="cx">
</span><span class="cx"> typedef void* DDHighlightRef;
</span><span class="cx">
</span><span class="lines">@@ -79,17 +80,23 @@
</span><span class="cx"> void drawSelectionHighlight(WebCore::GraphicsContext&, const WebCore::IntRect& dirtyRect);
</span><span class="cx"> void drawHighlight(DDHighlightRef, WebCore::GraphicsContext&);
</span><span class="cx">
</span><del>- void establishHoveredTelephoneHighlight(Boolean& onButton);
</del><ins>+ void establishHoveredTelephoneHighlight(bool& mouseIsOverButton);
</ins><span class="cx"> void maybeCreateSelectionHighlight();
</span><span class="cx">
</span><span class="cx"> void clearSelectionHighlight();
</span><span class="cx"> void clearHoveredTelephoneNumberHighlight();
</span><span class="cx">
</span><ins>+ bool mouseIsOverHighlight(DDHighlightRef, bool& mouseIsOverButton) const;
+ std::chrono::milliseconds remainingTimeUntilHighlightShouldBeShown() const;
+ void repaintHighlightTimerFired(WebCore::Timer<ServicesOverlayController>&);
+
</ins><span class="cx"> WebPage* m_webPage;
</span><span class="cx"> PageOverlay* m_servicesOverlay;
</span><span class="cx">
</span><span class="cx"> Vector<WebCore::LayoutRect> m_currentSelectionRects;
</span><span class="cx"> RetainPtr<DDHighlightRef> m_selectionHighlight;
</span><ins>+ std::chrono::steady_clock::time_point m_lastSelectionChangeTime;
+ std::chrono::steady_clock::time_point m_lastHoveredHighlightChangeTime;
</ins><span class="cx">
</span><span class="cx"> Vector<RefPtr<WebCore::Range>> m_currentTelephoneNumberRanges;
</span><span class="cx"> Vector<RetainPtr<DDHighlightRef>> m_telephoneNumberHighlights;
</span><span class="lines">@@ -98,6 +105,8 @@
</span><span class="cx"> RetainPtr<DDHighlightRef> m_currentHoveredHighlight;
</span><span class="cx"> RetainPtr<DDHighlightRef> m_currentMouseDownOnButtonHighlight;
</span><span class="cx">
</span><ins>+ WebCore::Timer<ServicesOverlayController> m_repaintHighlightTimer;
+
</ins><span class="cx"> WebCore::IntPoint m_mousePosition;
</span><span class="cx"> };
</span><span class="cx">
</span></span></pre></div>
<a id="trunkSourceWebKit2WebProcessWebPagemacServicesOverlayControllermm"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/WebProcess/WebPage/mac/ServicesOverlayController.mm (172199 => 172200)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/WebProcess/WebPage/mac/ServicesOverlayController.mm 2014-08-07 02:43:35 UTC (rev 172199)
+++ trunk/Source/WebKit2/WebProcess/WebPage/mac/ServicesOverlayController.mm 2014-08-07 02:58:22 UTC (rev 172200)
</span><span class="lines">@@ -76,6 +76,7 @@
</span><span class="cx"> ServicesOverlayController::ServicesOverlayController(WebPage& webPage)
</span><span class="cx"> : m_webPage(&webPage)
</span><span class="cx"> , m_servicesOverlay(nullptr)
</span><ins>+ , m_repaintHighlightTimer(this, &ServicesOverlayController::repaintHighlightTimerFired)
</ins><span class="cx"> {
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -216,6 +217,8 @@
</span><span class="cx"> clearSelectionHighlight();
</span><span class="cx"> m_currentSelectionRects = rects;
</span><span class="cx">
</span><ins>+ m_lastSelectionChangeTime = std::chrono::steady_clock::now();
+
</ins><span class="cx"> compactRectsWithGapRects(m_currentSelectionRects, gapRects);
</span><span class="cx">
</span><span class="cx"> // DataDetectors needs these reversed in order to place the arrow in the right location.
</span><span class="lines">@@ -306,8 +309,8 @@
</span><span class="cx">
</span><span class="cx"> // Found out which - if any - telephone number is hovered.
</span><span class="cx"> if (!m_hoveredTelephoneNumberData) {
</span><del>- Boolean onButton;
- establishHoveredTelephoneHighlight(onButton);
</del><ins>+ bool mouseIsOverButton;
+ establishHoveredTelephoneHighlight(mouseIsOverButton);
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> // If a telephone number is actually hovered, draw it.
</span><span class="lines">@@ -319,18 +322,52 @@
</span><span class="cx"> return false;
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+bool ServicesOverlayController::mouseIsOverHighlight(DDHighlightRef highlight, bool& mouseIsOverButton) const
+{
+ Boolean onButton;
+ bool hovered = DDHighlightPointIsOnHighlight(highlight, (CGPoint)m_mousePosition, &onButton);
+ mouseIsOverButton = onButton;
+ return hovered;
+}
+
+std::chrono::milliseconds ServicesOverlayController::remainingTimeUntilHighlightShouldBeShown() const
+{
+ // Highlight hysteresis is only for selection services, because telephone number highlights are already much more stable
+ // by virtue of being expanded to include the entire telephone number.
+ if (m_hoveredTelephoneNumberData)
+ return std::chrono::milliseconds::zero();
+
+ std::chrono::steady_clock::duration minimumTimeUntilHighlightShouldBeShown = 200_ms;
+
+ auto now = std::chrono::steady_clock::now();
+ auto timeSinceLastSelectionChange = now - m_lastSelectionChangeTime;
+ auto timeSinceMouseOverSelection = now - m_lastHoveredHighlightChangeTime;
+
+ return std::chrono::duration_cast<std::chrono::milliseconds>(std::max(minimumTimeUntilHighlightShouldBeShown - timeSinceLastSelectionChange, minimumTimeUntilHighlightShouldBeShown - timeSinceMouseOverSelection));
+}
+
+void ServicesOverlayController::repaintHighlightTimerFired(WebCore::Timer<ServicesOverlayController>&)
+{
+ if (m_servicesOverlay)
+ m_servicesOverlay->setNeedsDisplay();
+}
+
</ins><span class="cx"> void ServicesOverlayController::drawHighlight(DDHighlightRef highlight, WebCore::GraphicsContext& graphicsContext)
</span><span class="cx"> {
</span><span class="cx"> ASSERT(highlight);
</span><span class="cx">
</span><del>- Boolean onButton;
- bool mouseIsOverHighlight = DDHighlightPointIsOnHighlight(highlight, (CGPoint)m_mousePosition, &onButton);
-
- if (!mouseIsOverHighlight) {
</del><ins>+ bool mouseIsOverButton;
+ if (!mouseIsOverHighlight(highlight, mouseIsOverButton)) {
</ins><span class="cx"> LOG(Services, "ServicesOverlayController::drawHighlight - Mouse is not over highlight, so drawing nothing");
</span><span class="cx"> return;
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ auto remainingTimeUntilHighlightShouldBeShown = this->remainingTimeUntilHighlightShouldBeShown();
+ if (remainingTimeUntilHighlightShouldBeShown > std::chrono::steady_clock::duration::zero()) {
+ m_repaintHighlightTimer.startOneShot(remainingTimeUntilHighlightShouldBeShown);
+ return;
+ }
+
</ins><span class="cx"> CGContextRef cgContext = graphicsContext.platformContext();
</span><span class="cx">
</span><span class="cx"> CGLayerRef highlightLayer = DDHighlightGetLayerWithContext(highlight, cgContext);
</span><span class="lines">@@ -371,7 +408,7 @@
</span><span class="cx"> m_hoveredTelephoneNumberData = nullptr;
</span><span class="cx"> }
</span><span class="cx">
</span><del>-void ServicesOverlayController::establishHoveredTelephoneHighlight(Boolean& onButton)
</del><ins>+void ServicesOverlayController::establishHoveredTelephoneHighlight(bool& mouseIsOverButton)
</ins><span class="cx"> {
</span><span class="cx"> ASSERT(m_currentTelephoneNumberRanges.size() == m_telephoneNumberHighlights.size());
</span><span class="cx">
</span><span class="lines">@@ -395,7 +432,7 @@
</span><span class="cx"> m_telephoneNumberHighlights[i] = adoptCF(DDHighlightCreateWithRectsInVisibleRectWithStyleAndDirection(nullptr, &cgRect, 1, viewForRange->boundsRect(), DDHighlightOutlineWithArrow, YES, NSWritingDirectionNatural, NO, YES));
</span><span class="cx"> }
</span><span class="cx">
</span><del>- if (!DDHighlightPointIsOnHighlight(m_telephoneNumberHighlights[i].get(), (CGPoint)m_mousePosition, &onButton))
</del><ins>+ if (!mouseIsOverHighlight(m_telephoneNumberHighlights[i].get(), mouseIsOverButton))
</ins><span class="cx"> continue;
</span><span class="cx">
</span><span class="cx"> if (!m_hoveredTelephoneNumberData || m_hoveredTelephoneNumberData->highlight != m_telephoneNumberHighlights[i])
</span><span class="lines">@@ -406,7 +443,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> clearHoveredTelephoneNumberHighlight();
</span><del>- onButton = false;
</del><ins>+ mouseIsOverButton = false;
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> void ServicesOverlayController::maybeCreateSelectionHighlight()
</span><span class="lines">@@ -434,8 +471,8 @@
</span><span class="cx">
</span><span class="cx"> DDHighlightRef oldHoveredHighlight = m_currentHoveredHighlight.get();
</span><span class="cx">
</span><del>- Boolean onButton = false;
- establishHoveredTelephoneHighlight(onButton);
</del><ins>+ bool mouseIsOverButton = false;
+ establishHoveredTelephoneHighlight(mouseIsOverButton);
</ins><span class="cx"> if (m_hoveredTelephoneNumberData) {
</span><span class="cx"> ASSERT(m_hoveredTelephoneNumberData->highlight);
</span><span class="cx"> m_currentHoveredHighlight = m_hoveredTelephoneNumberData->highlight;
</span><span class="lines">@@ -443,14 +480,16 @@
</span><span class="cx"> if (!m_selectionHighlight)
</span><span class="cx"> maybeCreateSelectionHighlight();
</span><span class="cx">
</span><del>- if (m_selectionHighlight && DDHighlightPointIsOnHighlight(m_selectionHighlight.get(), (CGPoint)m_mousePosition, &onButton))
</del><ins>+ if (m_selectionHighlight && mouseIsOverHighlight(m_selectionHighlight.get(), mouseIsOverButton))
</ins><span class="cx"> m_currentHoveredHighlight = m_selectionHighlight;
</span><span class="cx"> else
</span><span class="cx"> m_currentHoveredHighlight = nullptr;
</span><span class="cx"> }
</span><span class="cx">
</span><del>- if (oldHoveredHighlight != m_currentHoveredHighlight)
</del><ins>+ if (oldHoveredHighlight != m_currentHoveredHighlight) {
+ m_lastHoveredHighlightChangeTime = std::chrono::steady_clock::now();
</ins><span class="cx"> m_servicesOverlay->setNeedsDisplay();
</span><ins>+ }
</ins><span class="cx">
</span><span class="cx"> // If this event has nothing to do with the left button, it clears the current mouse down tracking and we're done processing it.
</span><span class="cx"> if (event.button() != WebMouseEvent::LeftButton) {
</span><span class="lines">@@ -463,7 +502,7 @@
</span><span class="cx"> RetainPtr<DDHighlightRef> mouseDownHighlight = WTF::move(m_currentMouseDownOnButtonHighlight);
</span><span class="cx">
</span><span class="cx"> // If the mouse lifted while still over the highlight button that it went down on, then that is a click.
</span><del>- if (onButton && mouseDownHighlight) {
</del><ins>+ if (mouseIsOverButton && mouseDownHighlight && remainingTimeUntilHighlightShouldBeShown() <= std::chrono::steady_clock::duration::zero()) {
</ins><span class="cx"> handleClick(m_mousePosition, mouseDownHighlight.get());
</span><span class="cx"> return true;
</span><span class="cx"> }
</span><span class="lines">@@ -474,7 +513,7 @@
</span><span class="cx"> // Check and see if the mouse moved within the confines of the DD highlight button.
</span><span class="cx"> if (event.type() == WebEvent::MouseMove) {
</span><span class="cx"> // Moving with the mouse button down is okay as long as the mouse never leaves the highlight button.
</span><del>- if (m_currentMouseDownOnButtonHighlight && onButton)
</del><ins>+ if (m_currentMouseDownOnButtonHighlight && mouseIsOverButton)
</ins><span class="cx"> return true;
</span><span class="cx">
</span><span class="cx"> m_currentMouseDownOnButtonHighlight = nullptr;
</span><span class="lines">@@ -483,7 +522,7 @@
</span><span class="cx">
</span><span class="cx"> // Check and see if the mouse went down over a DD highlight button.
</span><span class="cx"> if (event.type() == WebEvent::MouseDown) {
</span><del>- if (m_currentHoveredHighlight && onButton) {
</del><ins>+ if (m_currentHoveredHighlight && mouseIsOverButton) {
</ins><span class="cx"> m_currentMouseDownOnButtonHighlight = m_currentHoveredHighlight;
</span><span class="cx"> m_servicesOverlay->setNeedsDisplay();
</span><span class="cx"> return true;
</span></span></pre>
</div>
</div>
</body>
</html>