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