e231f6b3fc8702f5131173dcd2b515e1d4d4f908
[WebKit.git] / Source / WebCore / platform / ScrollableArea.h
1 /*
2  * Copyright (C) 2008, 2011, 2014-2015 Apple Inc. All Rights Reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef ScrollableArea_h
27 #define ScrollableArea_h
28
29 #include "Scrollbar.h"
30 #include <wtf/Vector.h>
31
32 namespace WebCore {
33
34 class FloatPoint;
35 class GraphicsContext;
36 class LayoutPoint;
37 class LayoutSize;
38 class PlatformTouchEvent;
39 class PlatformWheelEvent;
40 class ScrollAnimator;
41 class GraphicsLayer;
42 class TiledBacking;
43
44 // scrollPosition is in content coordinates (0,0 is at scrollOrigin), so may have negative components.
45 typedef IntPoint ScrollPosition;
46 // scrollOffset() is the value used by scrollbars (min is 0,0), and should never have negative components.
47 typedef IntPoint ScrollOffset;
48
49 class ScrollableArea {
50 public:
51     WEBCORE_EXPORT bool scroll(ScrollDirection, ScrollGranularity, float multiplier = 1);
52     WEBCORE_EXPORT void scrollToOffsetWithoutAnimation(const FloatPoint&);
53     void scrollToOffsetWithoutAnimation(ScrollbarOrientation, float offset);
54
55     // Should be called when the scroll position changes externally, for example if the scroll layer position
56     // is updated on the scrolling thread and we need to notify the main thread.
57     WEBCORE_EXPORT void notifyScrollPositionChanged(const ScrollPosition&);
58
59     // Allows subclasses to handle scroll position updates themselves. If this member function
60     // returns true, the scrollable area won't actually update the scroll position and instead
61     // expect it to happen sometime in the future.
62     virtual bool requestScrollPositionUpdate(const ScrollPosition&) { return false; }
63
64     WEBCORE_EXPORT bool handleWheelEvent(const PlatformWheelEvent&);
65
66 #if ENABLE(CSS_SCROLL_SNAP)
67     const Vector<LayoutUnit>* horizontalSnapOffsets() const { return m_horizontalSnapOffsets.get(); };
68     const Vector<LayoutUnit>* verticalSnapOffsets() const { return m_verticalSnapOffsets.get(); };
69     virtual void updateSnapOffsets() { };
70     void setHorizontalSnapOffsets(std::unique_ptr<Vector<LayoutUnit>>);
71     void setVerticalSnapOffsets(std::unique_ptr<Vector<LayoutUnit>>);
72     void clearHorizontalSnapOffsets();
73     void clearVerticalSnapOffsets();
74     unsigned currentHorizontalSnapPointIndex() const { return m_currentHorizontalSnapPointIndex; }
75     void setCurrentHorizontalSnapPointIndex(unsigned index) { m_currentHorizontalSnapPointIndex = index; }
76     unsigned currentVerticalSnapPointIndex() const { return m_currentVerticalSnapPointIndex; }
77     void setCurrentVerticalSnapPointIndex(unsigned index) { m_currentVerticalSnapPointIndex = index; }
78     IntPoint nearestActiveSnapPoint(const IntPoint&);
79 #endif
80
81     void updateScrollSnapState();
82
83 #if ENABLE(TOUCH_EVENTS)
84     virtual bool isTouchScrollable() const { return false; }
85     virtual bool handleTouchEvent(const PlatformTouchEvent&);
86 #endif
87
88 #if PLATFORM(IOS)
89     virtual bool isOverflowScroll() const { return false; }
90     virtual void didStartScroll() { }
91     virtual void didEndScroll() { }
92     virtual void didUpdateScroll() { }
93 #endif
94     virtual void setIsUserScroll(bool) { }
95
96     // Functions for controlling if you can scroll past the end of the document.
97     bool constrainsScrollingToContentEdge() const { return m_constrainsScrollingToContentEdge; }
98     void setConstrainsScrollingToContentEdge(bool constrainsScrollingToContentEdge) { m_constrainsScrollingToContentEdge = constrainsScrollingToContentEdge; }
99
100     void setVerticalScrollElasticity(ScrollElasticity scrollElasticity) { m_verticalScrollElasticity = scrollElasticity; }
101     ScrollElasticity verticalScrollElasticity() const { return static_cast<ScrollElasticity>(m_verticalScrollElasticity); }
102
103     void setHorizontalScrollElasticity(ScrollElasticity scrollElasticity) { m_horizontalScrollElasticity = scrollElasticity; }
104     ScrollElasticity horizontalScrollElasticity() const { return static_cast<ScrollElasticity>(m_horizontalScrollElasticity); }
105
106     bool inLiveResize() const { return m_inLiveResize; }
107     WEBCORE_EXPORT virtual void willStartLiveResize();
108     WEBCORE_EXPORT virtual void willEndLiveResize();
109
110     WEBCORE_EXPORT void contentAreaWillPaint() const;
111     WEBCORE_EXPORT void mouseEnteredContentArea() const;
112     WEBCORE_EXPORT void mouseExitedContentArea() const;
113     WEBCORE_EXPORT void mouseMovedInContentArea() const;
114     WEBCORE_EXPORT void mouseEnteredScrollbar(Scrollbar*) const;
115     void mouseExitedScrollbar(Scrollbar*) const;
116     void mouseIsDownInScrollbar(Scrollbar*, bool) const;
117     void contentAreaDidShow() const;
118     void contentAreaDidHide() const;
119
120     void lockOverlayScrollbarStateToHidden(bool shouldLockState) const;
121     WEBCORE_EXPORT bool scrollbarsCanBeActive() const;
122
123     WEBCORE_EXPORT virtual void didAddScrollbar(Scrollbar*, ScrollbarOrientation);
124     WEBCORE_EXPORT virtual void willRemoveScrollbar(Scrollbar*, ScrollbarOrientation);
125
126     WEBCORE_EXPORT virtual void contentsResized();
127
128     // Force the contents to recompute their size (i.e. do layout).
129     virtual void updateContentsSize() { }
130
131     enum class AvailableSizeChangeReason {
132         ScrollbarsChanged,
133         AreaSizeChanged
134     };
135     WEBCORE_EXPORT virtual void availableContentSizeChanged(AvailableSizeChangeReason);
136
137     bool hasOverlayScrollbars() const;
138     WEBCORE_EXPORT virtual void setScrollbarOverlayStyle(ScrollbarOverlayStyle);
139     ScrollbarOverlayStyle scrollbarOverlayStyle() const { return static_cast<ScrollbarOverlayStyle>(m_scrollbarOverlayStyle); }
140
141     // This getter will create a ScrollAnimator if it doesn't already exist.
142     WEBCORE_EXPORT ScrollAnimator& scrollAnimator() const;
143
144     // This getter will return null if the ScrollAnimator hasn't been created yet.
145     ScrollAnimator* existingScrollAnimator() const { return m_scrollAnimator.get(); }
146
147     virtual bool isActive() const = 0;
148     virtual int scrollSize(ScrollbarOrientation) const = 0;
149     virtual int scrollOffset(ScrollbarOrientation) const = 0;
150     WEBCORE_EXPORT virtual void invalidateScrollbar(Scrollbar&, const IntRect&);
151     virtual bool isScrollCornerVisible() const = 0;
152     virtual IntRect scrollCornerRect() const = 0;
153     WEBCORE_EXPORT virtual void invalidateScrollCorner(const IntRect&);
154
155     virtual bool updatesScrollLayerPositionOnMainThread() const = 0;
156
157     virtual bool forceUpdateScrollbarsOnMainThreadForPerformanceTesting() const = 0;
158
159     // Convert points and rects between the scrollbar and its containing view.
160     // The client needs to implement these in order to be aware of layout effects
161     // like CSS transforms.
162     virtual IntRect convertFromScrollbarToContainingView(const Scrollbar& scrollbar, const IntRect& scrollbarRect) const
163     {
164         return scrollbar.Widget::convertToContainingView(scrollbarRect);
165     }
166     virtual IntRect convertFromContainingViewToScrollbar(const Scrollbar& scrollbar, const IntRect& parentRect) const
167     {
168         return scrollbar.Widget::convertFromContainingView(parentRect);
169     }
170     virtual IntPoint convertFromScrollbarToContainingView(const Scrollbar& scrollbar, const IntPoint& scrollbarPoint) const
171     {
172         return scrollbar.Widget::convertToContainingView(scrollbarPoint);
173     }
174     virtual IntPoint convertFromContainingViewToScrollbar(const Scrollbar& scrollbar, const IntPoint& parentPoint) const
175     {
176         return scrollbar.Widget::convertFromContainingView(parentPoint);
177     }
178
179     int horizontalScrollbarIntrusion() const;
180     int verticalScrollbarIntrusion() const;
181     WEBCORE_EXPORT IntSize scrollbarIntrusion() const;
182
183     virtual Scrollbar* horizontalScrollbar() const { return nullptr; }
184     virtual Scrollbar* verticalScrollbar() const { return nullptr; }
185
186     const IntPoint& scrollOrigin() const { return m_scrollOrigin; }
187     bool scrollOriginChanged() const { return m_scrollOriginChanged; }
188
189     virtual ScrollPosition scrollPosition() const;
190     virtual ScrollPosition minimumScrollPosition() const;
191     virtual ScrollPosition maximumScrollPosition() const;
192
193     ScrollPosition constrainScrollPosition(const ScrollPosition& position) const
194     {
195         return position.constrainedBetween(minimumScrollPosition(), maximumScrollPosition());
196     }
197
198     ScrollOffset maximumScrollOffset() const;
199
200     WEBCORE_EXPORT ScrollPosition scrollPositionFromOffset(ScrollOffset) const;
201     WEBCORE_EXPORT ScrollOffset scrollOffsetFromPosition(ScrollPosition) const;
202
203     template<typename PositionType, typename SizeType>
204     static PositionType scrollPositionFromOffset(PositionType offset, SizeType scrollOrigin)
205     {
206         return offset - scrollOrigin;
207     }
208
209     template<typename PositionType, typename SizeType>
210     static PositionType scrollOffsetFromPosition(PositionType position, SizeType scrollOrigin)
211     {
212         return position + scrollOrigin;
213     }
214
215     WEBCORE_EXPORT virtual bool scrolledToTop() const;
216     WEBCORE_EXPORT virtual bool scrolledToBottom() const;
217     WEBCORE_EXPORT virtual bool scrolledToLeft() const;
218     WEBCORE_EXPORT virtual bool scrolledToRight() const;
219
220     bool isScrolledProgrammatically() const { return m_scrolledProgrammatically; }
221     void setScrolledProgrammatically(bool state) { m_scrolledProgrammatically = state; }
222
223     enum VisibleContentRectIncludesScrollbars { ExcludeScrollbars, IncludeScrollbars };
224     enum VisibleContentRectBehavior {
225         ContentsVisibleRect,
226 #if PLATFORM(IOS)
227         LegacyIOSDocumentViewRect,
228         LegacyIOSDocumentVisibleRect = LegacyIOSDocumentViewRect
229 #else
230         LegacyIOSDocumentVisibleRect = ContentsVisibleRect
231 #endif
232     };
233
234     WEBCORE_EXPORT IntRect visibleContentRect(VisibleContentRectBehavior = ContentsVisibleRect) const;
235     WEBCORE_EXPORT IntRect visibleContentRectIncludingScrollbars(VisibleContentRectBehavior = ContentsVisibleRect) const;
236
237     int visibleWidth() const { return visibleSize().width(); }
238     int visibleHeight() const { return visibleSize().height(); }
239     virtual IntSize visibleSize() const = 0;
240
241     virtual IntSize contentsSize() const = 0;
242     virtual IntSize overhangAmount() const { return IntSize(); }
243     virtual IntPoint lastKnownMousePosition() const { return IntPoint(); }
244     virtual bool isHandlingWheelEvent() const { return false; }
245
246     virtual int headerHeight() const { return 0; }
247     virtual int footerHeight() const { return 0; }
248
249     // The totalContentsSize() is equivalent to the contentsSize() plus the header and footer heights.
250     WEBCORE_EXPORT IntSize totalContentsSize() const;
251
252     virtual bool shouldSuspendScrollAnimations() const { return true; }
253     WEBCORE_EXPORT virtual void scrollbarStyleChanged(ScrollbarStyle /*newStyle*/, bool /*forceUpdate*/);
254     virtual void setVisibleScrollerThumbRect(const IntRect&) { }
255     
256     // Note that this only returns scrollable areas that can actually be scrolled.
257     virtual ScrollableArea* enclosingScrollableArea() const = 0;
258
259     virtual bool isScrollableOrRubberbandable() = 0;
260     virtual bool hasScrollableOrRubberbandableAncestor() = 0;
261
262     // Returns the bounding box of this scrollable area, in the coordinate system of the enclosing scroll view.
263     virtual IntRect scrollableAreaBoundingBox(bool* = nullptr) const = 0;
264
265     virtual bool isRubberBandInProgress() const { return false; }
266     virtual bool isScrollSnapInProgress() const { return false; }
267
268     virtual bool scrollAnimatorEnabled() const { return false; }
269
270     // NOTE: Only called from Internals for testing.
271     WEBCORE_EXPORT void setScrollOffsetFromInternals(const ScrollOffset&);
272
273     WEBCORE_EXPORT static LayoutPoint constrainScrollPositionForOverhang(const LayoutRect& visibleContentRect, const LayoutSize& totalContentsSize, const LayoutPoint& scrollPosition, const LayoutPoint& scrollOrigin, int headerHeight, int footetHeight);
274     LayoutPoint constrainScrollPositionForOverhang(const LayoutPoint& scrollPosition);
275
276     // Computes the double value for the scrollbar's current position and the current overhang amount.
277     // This function is static so that it can be called from the main thread or the scrolling thread.
278     static void computeScrollbarValueAndOverhang(float currentPosition, float totalSize, float visibleSize, float& doubleValue, float& overhangAmount);
279
280     // Let subclasses provide a way of asking for and servicing scroll
281     // animations.
282     virtual bool scheduleAnimation() { return false; }
283     void serviceScrollAnimations();
284
285 #if PLATFORM(IOS)
286     bool isHorizontalScrollerPinnedToMinimumPosition() const { return !horizontalScrollbar() || scrollOffset(HorizontalScrollbar) <= 0; }
287     bool isHorizontalScrollerPinnedToMaximumPosition() const { return !horizontalScrollbar() || scrollOffset(HorizontalScrollbar) >= maximumScrollOffset().x(); }
288     bool isVerticalScrollerPinnedToMinimumPosition() const { return !verticalScrollbar() || scrollOffset(VerticalScrollbar) <= 0; }
289     bool isVerticalScrollerPinnedToMaximumPosition() const { return !verticalScrollbar() || scrollOffset(VerticalScrollbar) >= maximumScrollOffset().y(); }
290
291     bool isPinnedInBothDirections(const IntSize&) const; 
292     bool isPinnedHorizontallyInDirection(int horizontalScrollDelta) const; 
293     bool isPinnedVerticallyInDirection(int verticalScrollDelta) const;
294 #endif
295
296     virtual TiledBacking* tiledBacking() const { return nullptr; }
297
298     // True if scrolling happens by moving compositing layers.
299     virtual bool usesCompositedScrolling() const { return false; }
300     // True if the contents can be scrolled asynchronously (i.e. by a ScrollingCoordinator).
301     virtual bool usesAsyncScrolling() const { return false; }
302
303     virtual GraphicsLayer* layerForHorizontalScrollbar() const { return nullptr; }
304     virtual GraphicsLayer* layerForVerticalScrollbar() const { return nullptr; }
305
306     bool hasLayerForHorizontalScrollbar() const;
307     bool hasLayerForVerticalScrollbar() const;
308
309     void verticalScrollbarLayerDidChange();
310     void horizontalScrollbarLayerDidChange();
311
312     virtual bool usesMockScrollAnimator() const { return false; }
313     virtual void logMockScrollAnimatorMessage(const String&) const { };
314
315     bool verticalScrollbarIsOnLeft() const;
316     static bool systemLanguageIsRTL();
317
318 protected:
319     WEBCORE_EXPORT ScrollableArea();
320     WEBCORE_EXPORT virtual ~ScrollableArea();
321
322     void setScrollOrigin(const IntPoint&);
323     void resetScrollOriginChanged() { m_scrollOriginChanged = false; }
324
325     WEBCORE_EXPORT virtual float adjustScrollStepForFixedContent(float step, ScrollbarOrientation, ScrollGranularity);
326     virtual void invalidateScrollbarRect(Scrollbar&, const IntRect&) = 0;
327     virtual void invalidateScrollCornerRect(const IntRect&) = 0;
328
329     friend class ScrollingCoordinator;
330     virtual GraphicsLayer* layerForScrolling() const { return nullptr; }
331     virtual GraphicsLayer* layerForScrollCorner() const { return nullptr; }
332 #if ENABLE(RUBBER_BANDING)
333     virtual GraphicsLayer* layerForOverhangAreas() const { return nullptr; }
334 #endif
335
336     bool hasLayerForScrollCorner() const;
337
338 private:
339     WEBCORE_EXPORT virtual IntRect visibleContentRectInternal(VisibleContentRectIncludesScrollbars, VisibleContentRectBehavior) const;
340     void scrollPositionChanged(const ScrollPosition&);
341     
342     // NOTE: Only called from the ScrollAnimator.
343     friend class ScrollAnimator;
344     void setScrollOffsetFromAnimation(const ScrollOffset&);
345
346     // This function should be overriden by subclasses to perform the actual
347     // scroll of the content.
348     virtual void setScrollOffset(const ScrollOffset&) = 0;
349
350     mutable std::unique_ptr<ScrollAnimator> m_scrollAnimator;
351
352 #if ENABLE(CSS_SCROLL_SNAP)
353     std::unique_ptr<Vector<LayoutUnit>> m_horizontalSnapOffsets;
354     std::unique_ptr<Vector<LayoutUnit>> m_verticalSnapOffsets;
355     unsigned m_currentHorizontalSnapPointIndex { 0 };
356     unsigned m_currentVerticalSnapPointIndex { 0 };
357 #endif
358
359     // There are 8 possible combinations of writing mode and direction. Scroll origin will be non-zero in the x or y axis
360     // if there is any reversed direction or writing-mode. The combinations are:
361     // writing-mode / direction     scrollOrigin.x() set    scrollOrigin.y() set
362     // horizontal-tb / ltr          NO                      NO
363     // horizontal-tb / rtl          YES                     NO
364     // horizontal-bt / ltr          NO                      YES
365     // horizontal-bt / rtl          YES                     YES
366     // vertical-lr / ltr            NO                      NO
367     // vertical-lr / rtl            NO                      YES
368     // vertical-rl / ltr            YES                     NO
369     // vertical-rl / rtl            YES                     YES
370     IntPoint m_scrollOrigin;
371
372     unsigned m_constrainsScrollingToContentEdge : 1;
373
374     unsigned m_inLiveResize : 1;
375
376     unsigned m_verticalScrollElasticity : 2; // ScrollElasticity
377     unsigned m_horizontalScrollElasticity : 2; // ScrollElasticity
378
379     unsigned m_scrollbarOverlayStyle : 2; // ScrollbarOverlayStyle
380
381     unsigned m_scrollOriginChanged : 1;
382     unsigned m_scrolledProgrammatically : 1;
383 };
384
385 } // namespace WebCore
386
387 #endif // ScrollableArea_h