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