Implement visual-viewport based position:fixed handling for Mac async scrolling
[WebKit-https.git] / Source / WebCore / page / scrolling / ScrollingTreeScrollingNode.h
1 /*
2  * Copyright (C) 2012 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. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #if ENABLE(ASYNC_SCROLLING)
29
30 #include "IntRect.h"
31 #include "ScrollTypes.h"
32 #include "ScrollingCoordinator.h"
33 #include "ScrollingTreeNode.h"
34
35 namespace WebCore {
36
37 class ScrollingTree;
38 class ScrollingStateScrollingNode;
39
40 class ScrollingTreeScrollingNode : public ScrollingTreeNode {
41 public:
42     virtual ~ScrollingTreeScrollingNode();
43
44     WEBCORE_EXPORT void commitStateBeforeChildren(const ScrollingStateNode&) override;
45     WEBCORE_EXPORT void commitStateAfterChildren(const ScrollingStateNode&) override;
46
47     WEBCORE_EXPORT void updateLayersAfterAncestorChange(const ScrollingTreeNode& changedNode, const FloatRect& fixedPositionRect, const FloatSize& cumulativeDelta) override;
48
49     virtual void handleWheelEvent(const PlatformWheelEvent&) = 0;
50     WEBCORE_EXPORT virtual void setScrollPosition(const FloatPoint&);
51     WEBCORE_EXPORT virtual void setScrollPositionWithoutContentEdgeConstraints(const FloatPoint&);
52
53     virtual void updateLayersAfterViewportChange(const FloatRect& fixedPositionRect, double scale) = 0;
54     virtual void updateLayersAfterDelegatedScroll(const FloatPoint&) { }
55
56     virtual FloatPoint scrollPosition() const = 0;
57
58 #if ENABLE(CSS_SCROLL_SNAP)
59     const Vector<float>& horizontalSnapOffsets() const { return m_horizontalSnapOffsets; }
60     const Vector<float>& verticalSnapOffsets() const { return m_verticalSnapOffsets; }
61     unsigned currentHorizontalSnapPointIndex() const { return m_currentHorizontalSnapPointIndex; }
62     unsigned currentVerticalSnapPointIndex() const { return m_currentVerticalSnapPointIndex; }
63     void setCurrentHorizontalSnapPointIndex(unsigned index) { m_currentHorizontalSnapPointIndex = index; }
64     void setCurrentVerticalSnapPointIndex(unsigned index) { m_currentVerticalSnapPointIndex = index; }
65 #endif
66
67 protected:
68     ScrollingTreeScrollingNode(ScrollingTree&, ScrollingNodeType, ScrollingNodeID);
69
70     WEBCORE_EXPORT virtual FloatPoint minimumScrollPosition() const;
71     WEBCORE_EXPORT virtual FloatPoint maximumScrollPosition() const;
72
73     virtual void setScrollLayerPosition(const FloatPoint&, const FloatRect& layoutViewport) = 0;
74
75     FloatPoint lastCommittedScrollPosition() const { return m_lastCommittedScrollPosition; }
76     const FloatSize& scrollableAreaSize() const { return m_scrollableAreaSize; }
77     const FloatSize& totalContentsSize() const { return m_totalContentsSize; }
78     const FloatSize& reachableContentsSize() const { return m_reachableContentsSize; }
79     const IntPoint& scrollOrigin() const { return m_scrollOrigin; }
80
81     // If the totalContentsSize changes in the middle of a rubber-band, we still want to use the old totalContentsSize for the sake of
82     // computing the stretchAmount(). Using the old value will keep the animation smooth. When there is no rubber-band in progress at
83     // all, m_totalContentsSizeForRubberBand should be equivalent to m_totalContentsSize.
84     const FloatSize& totalContentsSizeForRubberBand() const { return m_totalContentsSizeForRubberBand; }
85     void setTotalContentsSizeForRubberBand(const FloatSize& totalContentsSizeForRubberBand) { m_totalContentsSizeForRubberBand = totalContentsSizeForRubberBand; }
86
87     ScrollElasticity horizontalScrollElasticity() const { return m_scrollableAreaParameters.horizontalScrollElasticity; }
88     ScrollElasticity verticalScrollElasticity() const { return m_scrollableAreaParameters.verticalScrollElasticity; }
89
90     bool hasEnabledHorizontalScrollbar() const { return m_scrollableAreaParameters.hasEnabledHorizontalScrollbar; }
91     bool hasEnabledVerticalScrollbar() const { return m_scrollableAreaParameters.hasEnabledVerticalScrollbar; }
92
93     bool canHaveScrollbars() const { return m_scrollableAreaParameters.horizontalScrollbarMode != ScrollbarAlwaysOff || m_scrollableAreaParameters.verticalScrollbarMode != ScrollbarAlwaysOff; }
94
95 private:
96     FloatSize m_scrollableAreaSize;
97     FloatSize m_totalContentsSize;
98     FloatSize m_totalContentsSizeForRubberBand;
99     FloatSize m_reachableContentsSize;
100     FloatPoint m_lastCommittedScrollPosition;
101     IntPoint m_scrollOrigin;
102 #if ENABLE(CSS_SCROLL_SNAP)
103     Vector<float> m_horizontalSnapOffsets;
104     Vector<float> m_verticalSnapOffsets;
105     unsigned m_currentHorizontalSnapPointIndex { 0 };
106     unsigned m_currentVerticalSnapPointIndex { 0 };
107 #endif
108     ScrollableAreaParameters m_scrollableAreaParameters;
109 };
110
111 } // namespace WebCore
112
113 SPECIALIZE_TYPE_TRAITS_SCROLLING_NODE(ScrollingTreeScrollingNode, isScrollingNode())
114
115 #endif // ENABLE(ASYNC_SCROLLING)