[Qt] Delay viewport position, scale and contents size updates until tiles are rendered
[WebKit-https.git] / Source / WebKit2 / UIProcess / PageViewportController.cpp
1 /*
2  * Copyright (C) 2011, 2012 Nokia Corporation and/or its subsidiary(-ies)
3  * Copyright (C) 2011 Benjamin Poulain <benjamin@webkit.org>
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Library General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Library General Public License for more details.
14  *
15  * You should have received a copy of the GNU Library General Public License
16  * along with this program; see the file COPYING.LIB.  If not, write to
17  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18  * Boston, MA 02110-1301, USA.
19  *
20  */
21
22 #include "config.h"
23 #include "PageViewportController.h"
24
25 #include "PageViewportControllerClient.h"
26 #include "WebPageProxy.h"
27 #include <WebCore/FloatRect.h>
28 #include <WebCore/FloatSize.h>
29 #include <wtf/MathExtras.h>
30
31 using namespace WebCore;
32
33 namespace WebKit {
34
35 bool fuzzyCompare(float a, float b, float epsilon)
36 {
37     return std::abs(a - b) < epsilon;
38 }
39
40 ViewportUpdateDeferrer::ViewportUpdateDeferrer(PageViewportController* PageViewportController, SuspendContentFlag suspendContentFlag)
41     : m_controller(PageViewportController)
42 {
43     m_controller->m_activeDeferrerCount++;
44
45     // There is no need to suspend content for immediate updates
46     // only during animations or longer gestures.
47     if (suspendContentFlag == DeferUpdateAndSuspendContent)
48         m_controller->suspendContent();
49 }
50
51 ViewportUpdateDeferrer::~ViewportUpdateDeferrer()
52 {
53     if (--(m_controller->m_activeDeferrerCount))
54         return;
55
56     m_controller->resumeContent();
57
58     // Make sure that tiles all around the viewport will be requested.
59     m_controller->syncVisibleContents();
60 }
61
62 PageViewportController::PageViewportController(WebKit::WebPageProxy* proxy, PageViewportControllerClient* client)
63     : m_webPageProxy(proxy)
64     , m_client(client)
65     , m_allowsUserScaling(false)
66     , m_minimumScaleToFit(1)
67     , m_activeDeferrerCount(0)
68     , m_hasSuspendedContent(false)
69     , m_hadUserInteraction(false)
70     , m_effectiveScale(1)
71 {
72     // Initializing Viewport Raw Attributes to avoid random negative scale factors
73     // if there is a race condition between the first layout and setting the viewport attributes for the first time.
74     m_rawAttributes.initialScale = 1;
75     m_rawAttributes.minimumScale = 1;
76     m_rawAttributes.maximumScale = 1;
77     m_rawAttributes.userScalable = m_allowsUserScaling;
78
79     ASSERT(m_client);
80     m_client->setController(this);
81 }
82
83 float PageViewportController::innerBoundedViewportScale(float viewportScale) const
84 {
85     return clampTo(viewportScale, toViewportScale(m_minimumScaleToFit), toViewportScale(m_rawAttributes.maximumScale));
86 }
87
88 float PageViewportController::outerBoundedViewportScale(float viewportScale) const
89 {
90     if (m_allowsUserScaling) {
91         // Bounded by [0.1, 10.0] like the viewport meta code in WebCore.
92         float hardMin = toViewportScale(std::max<float>(0.1, 0.5 * m_minimumScaleToFit));
93         float hardMax = toViewportScale(std::min<float>(10, 2 * m_rawAttributes.maximumScale));
94         return clampTo(viewportScale, hardMin, hardMax);
95     }
96     return innerBoundedViewportScale(viewportScale);
97 }
98
99 float PageViewportController::devicePixelRatio() const
100 {
101     return m_webPageProxy->deviceScaleFactor();
102 }
103
104 FloatPoint PageViewportController::clampViewportToContents(const WebCore::FloatPoint& viewportPos, float viewportScale)
105 {
106     const float horizontalRange = std::max(0.f, m_contentsSize.width() - m_viewportSize.width() / viewportScale);
107     const float verticalRange = std::max(0.f, m_contentsSize.height() - m_viewportSize.height() / viewportScale);
108
109     return FloatPoint(clampTo(viewportPos.x(), 0.f, horizontalRange), clampTo(viewportPos.y(), 0.f, verticalRange));
110 }
111
112 void PageViewportController::didCommitLoad()
113 {
114     // Reset the position to the top, page/history scroll requests may override this before we re-enable rendering.
115     applyPositionAfterRenderingContents(FloatPoint());
116 }
117
118 void PageViewportController::didChangeContentsSize(const IntSize& newSize)
119 {
120     m_contentsSize = newSize;
121     updateMinimumScaleToFit();
122 }
123
124 void PageViewportController::didRenderFrame(const IntSize& contentsSize)
125 {
126     // Only update the viewport's contents dimensions along with its render.
127     m_client->didChangeContentsSize(contentsSize);
128
129     // Apply any scale or scroll position we locked to be set on the viewport
130     // only when there is something to display there. The scale goes first to
131     // avoid offsetting our deferred position by scaling at the viewport center.
132     // All position and scale changes resulting from a web process event should
133     // go through here to be applied on the viewport to avoid showing incomplete
134     // tiles to the user during a few milliseconds.
135     ViewportUpdateDeferrer guard(this);
136     if (m_effectiveScaleIsLocked) {
137         m_client->setContentsScale(m_effectiveScale, false);
138         m_effectiveScaleIsLocked = false;
139     }
140     if (m_viewportPosIsLocked) {
141         m_client->setViewportPosition(clampViewportToContents(m_viewportPos, m_effectiveScale));
142         m_viewportPosIsLocked = false;
143     }
144 }
145
146 void PageViewportController::pageTransitionViewportReady()
147 {
148     if (!m_rawAttributes.layoutSize.isEmpty()) {
149         m_hadUserInteraction = false;
150         applyScaleAfterRenderingContents(innerBoundedViewportScale(toViewportScale(m_rawAttributes.initialScale)));
151     }
152
153     // At this point we should already have received the first viewport arguments and the requested scroll
154     // position for the newly loaded page and sent our reactions to the web process. It's now safe to tell
155     // the web process to start rendering the new page contents and possibly re-use the current tiles.
156     // This assumes that all messages have been handled in order and that nothing has been pushed back on the event loop.
157     m_webPageProxy->commitPageTransitionViewport();
158 }
159
160 void PageViewportController::pageDidRequestScroll(const IntPoint& cssPosition)
161 {
162     // Ignore the request if suspended. Can only happen due to delay in event delivery.
163     if (m_activeDeferrerCount)
164         return;
165
166     // Keep the unclamped position in case the contents size is changed later on.
167     applyPositionAfterRenderingContents(cssPosition);
168 }
169
170 void PageViewportController::didChangeViewportSize(const FloatSize& newSize)
171 {
172     if (newSize.isEmpty())
173         return;
174
175     m_viewportSize = newSize;
176
177     // Let the WebProcess know about the new viewport size, so that
178     // it can resize the content accordingly.
179     m_webPageProxy->setViewportSize(roundedIntSize(newSize));
180
181     syncVisibleContents();
182 }
183
184 void PageViewportController::didChangeContentsVisibility(const FloatPoint& viewportPos, float viewportScale, const FloatPoint& trajectoryVector)
185 {
186     if (!m_viewportPosIsLocked)
187         m_viewportPos = viewportPos;
188     if (!m_effectiveScaleIsLocked)
189         m_effectiveScale = viewportScale;
190
191     syncVisibleContents(trajectoryVector);
192 }
193
194 void PageViewportController::syncVisibleContents(const FloatPoint& trajectoryVector)
195 {
196     DrawingAreaProxy* const drawingArea = m_webPageProxy->drawingArea();
197     if (!drawingArea || m_viewportSize.isEmpty() || m_contentsSize.isEmpty())
198         return;
199
200     FloatRect visibleContentsRect(clampViewportToContents(m_viewportPos, m_effectiveScale), m_viewportSize / m_effectiveScale);
201     visibleContentsRect.intersect(FloatRect(FloatPoint::zero(), m_contentsSize));
202     drawingArea->setVisibleContentsRect(visibleContentsRect, m_effectiveScale, trajectoryVector);
203
204     m_client->didChangeVisibleContents();
205 }
206
207 void PageViewportController::didChangeViewportAttributes(const WebCore::ViewportAttributes& newAttributes)
208 {
209     if (newAttributes.layoutSize.isEmpty())
210         return;
211
212     m_rawAttributes = newAttributes;
213     WebCore::restrictScaleFactorToInitialScaleIfNotUserScalable(m_rawAttributes);
214
215     m_allowsUserScaling = !!m_rawAttributes.userScalable;
216     updateMinimumScaleToFit();
217
218     m_client->didChangeViewportAttributes();
219 }
220
221 void PageViewportController::suspendContent()
222 {
223     if (m_hasSuspendedContent)
224         return;
225
226     m_hasSuspendedContent = true;
227     m_webPageProxy->suspendActiveDOMObjectsAndAnimations();
228 }
229
230 void PageViewportController::resumeContent()
231 {
232     m_client->didResumeContent();
233
234     if (!m_hasSuspendedContent)
235         return;
236
237     m_hasSuspendedContent = false;
238     m_webPageProxy->resumeActiveDOMObjectsAndAnimations();
239 }
240
241 void PageViewportController::applyScaleAfterRenderingContents(float scale)
242 {
243     m_effectiveScale = scale;
244     m_effectiveScaleIsLocked = true;
245     syncVisibleContents();
246 }
247
248 void PageViewportController::applyPositionAfterRenderingContents(const FloatPoint& pos)
249 {
250     m_viewportPos = pos;
251     m_viewportPosIsLocked = true;
252     syncVisibleContents();
253 }
254
255 void PageViewportController::updateMinimumScaleToFit()
256 {
257     if (m_viewportSize.isEmpty())
258         return;
259
260     float minimumScale = WebCore::computeMinimumScaleFactorForContentContained(m_rawAttributes, WebCore::roundedIntSize(m_viewportSize), WebCore::roundedIntSize(m_contentsSize));
261
262     if (!fuzzyCompare(minimumScale, m_minimumScaleToFit, 0.001)) {
263         m_minimumScaleToFit = minimumScale;
264
265         if (!m_hadUserInteraction && !hasSuspendedContent())
266             applyScaleAfterRenderingContents(toViewportScale(minimumScale));
267
268         m_client->didChangeViewportAttributes();
269     }
270 }
271
272 } // namespace WebKit