29cf6de9befb41d33a9ac9a78834c5f0742a4338
[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::didChangeContentsSize(const IntSize& newSize)
113 {
114     if (m_viewportSize.isEmpty() || newSize.isEmpty())
115         return;
116
117     m_contentsSize = newSize;
118     updateMinimumScaleToFit();
119
120     m_client->didChangeContentsSize();
121 }
122
123 void PageViewportController::pageTransitionViewportReady()
124 {
125     // At this point we should already have received the first viewport arguments and the requested scroll
126     // position for the newly loaded page and sent our reactions to the web process. It's now safe to tell
127     // the web process to start rendering the new page contents and possibly re-use the current tiles.
128     // This assumes that all messages have been handled in order and that nothing has been pushed back on the event loop.
129     m_webPageProxy->commitPageTransitionViewport();
130 }
131
132 void PageViewportController::pageDidRequestScroll(const IntPoint& cssPosition)
133 {
134     // Ignore the request if suspended. Can only happen due to delay in event delivery.
135     if (m_activeDeferrerCount)
136         return;
137
138     m_client->setViewportPosition(clampViewportToContents(cssPosition, m_effectiveScale));
139 }
140
141 void PageViewportController::didChangeViewportSize(const FloatSize& newSize)
142 {
143     if (newSize.isEmpty())
144         return;
145
146     m_viewportSize = newSize;
147
148     // Let the WebProcess know about the new viewport size, so that
149     // it can resize the content accordingly.
150     m_webPageProxy->setViewportSize(roundedIntSize(newSize));
151
152     syncVisibleContents();
153 }
154
155 void PageViewportController::didChangeContentsVisibility(const FloatPoint& viewportPos, float viewportScale, const FloatPoint& trajectoryVector)
156 {
157     m_viewportPos = viewportPos;
158     m_effectiveScale = viewportScale;
159     syncVisibleContents(trajectoryVector);
160 }
161
162 void PageViewportController::syncVisibleContents(const FloatPoint& trajectoryVector)
163 {
164     DrawingAreaProxy* const drawingArea = m_webPageProxy->drawingArea();
165     if (!drawingArea || m_viewportSize.isEmpty() || m_contentsSize.isEmpty())
166         return;
167
168     FloatRect visibleContentsRect(clampViewportToContents(m_viewportPos, m_effectiveScale), m_viewportSize / m_effectiveScale);
169     visibleContentsRect.intersect(FloatRect(FloatPoint::zero(), m_contentsSize));
170     drawingArea->setVisibleContentsRect(visibleContentsRect, m_effectiveScale, trajectoryVector);
171
172     m_client->didChangeVisibleContents();
173 }
174
175 void PageViewportController::didChangeViewportAttributes(const WebCore::ViewportAttributes& newAttributes)
176 {
177     if (newAttributes.layoutSize.isEmpty())
178         return;
179
180     m_rawAttributes = newAttributes;
181     WebCore::restrictScaleFactorToInitialScaleIfNotUserScalable(m_rawAttributes);
182
183     m_allowsUserScaling = !!m_rawAttributes.userScalable;
184     updateMinimumScaleToFit();
185
186     m_client->didChangeViewportAttributes();
187 }
188
189 void PageViewportController::suspendContent()
190 {
191     if (m_hasSuspendedContent)
192         return;
193
194     m_hasSuspendedContent = true;
195     m_webPageProxy->suspendActiveDOMObjectsAndAnimations();
196 }
197
198 void PageViewportController::resumeContent()
199 {
200     if (!m_rawAttributes.layoutSize.isEmpty() && m_rawAttributes.initialScale > 0) {
201         m_hadUserInteraction = false;
202         m_client->setContentsScale(innerBoundedViewportScale(toViewportScale(m_rawAttributes.initialScale)), /* isInitialScale */ true);
203         m_rawAttributes.initialScale = -1; // Mark used.
204     }
205
206     m_client->didResumeContent();
207
208     if (!m_hasSuspendedContent)
209         return;
210
211     m_hasSuspendedContent = false;
212     m_webPageProxy->resumeActiveDOMObjectsAndAnimations();
213 }
214
215 void PageViewportController::updateMinimumScaleToFit()
216 {
217     float minimumScale = WebCore::computeMinimumScaleFactorForContentContained(m_rawAttributes, WebCore::roundedIntSize(m_viewportSize), WebCore::roundedIntSize(m_contentsSize));
218
219     if (!fuzzyCompare(minimumScale, m_minimumScaleToFit, 0.001)) {
220         m_minimumScaleToFit = minimumScale;
221
222         if (!m_hadUserInteraction && !hasSuspendedContent())
223             m_client->setContentsScale(toViewportScale(minimumScale), true /* isInitialScale */);
224
225         m_client->didChangeViewportAttributes();
226     }
227 }
228
229 } // namespace WebKit