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