70bd81d006d6e78f1b0de7aaf9312dbbc4011f37
[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 "ScrollSnapOffsetsInfo.h"
32 #include "ScrollTypes.h"
33 #include "ScrollingCoordinator.h"
34 #include "ScrollingTreeNode.h"
35
36 #if PLATFORM(IOS_FAMILY)
37 class ScrollingTreeScrollingNodeDelegate;
38 #endif
39
40 namespace WebCore {
41
42 class ScrollingTree;
43 class ScrollingStateScrollingNode;
44
45 class ScrollingTreeScrollingNode : public ScrollingTreeNode {
46 #if PLATFORM(IOS_FAMILY)
47     friend class ScrollingTreeScrollingNodeDelegate;
48 #endif
49
50 public:
51     virtual ~ScrollingTreeScrollingNode();
52
53     WEBCORE_EXPORT void commitStateBeforeChildren(const ScrollingStateNode&) override;
54     WEBCORE_EXPORT void commitStateAfterChildren(const ScrollingStateNode&) override;
55
56     WEBCORE_EXPORT void updateLayersAfterAncestorChange(const ScrollingTreeNode& changedNode, const FloatRect& fixedPositionRect, const FloatSize& cumulativeDelta) override;
57
58     virtual void handleWheelEvent(const PlatformWheelEvent&) = 0;
59     WEBCORE_EXPORT virtual void setScrollPosition(const FloatPoint&);
60     WEBCORE_EXPORT virtual void setScrollPositionWithoutContentEdgeConstraints(const FloatPoint&);
61
62     virtual void updateLayersAfterViewportChange(const FloatRect& fixedPositionRect, double scale) = 0;
63     virtual void updateLayersAfterDelegatedScroll(const FloatPoint&) { }
64
65     virtual FloatPoint scrollPosition() const = 0;
66     const FloatSize& scrollableAreaSize() const { return m_scrollableAreaSize; }
67     const FloatSize& totalContentsSize() const { return m_totalContentsSize; }
68
69 #if ENABLE(CSS_SCROLL_SNAP)
70     const Vector<float>& horizontalSnapOffsets() const { return m_snapOffsetsInfo.horizontalSnapOffsets; }
71     const Vector<float>& verticalSnapOffsets() const { return m_snapOffsetsInfo.verticalSnapOffsets; }
72     const Vector<ScrollOffsetRange<float>>& horizontalSnapOffsetRanges() const { return m_snapOffsetsInfo.horizontalSnapOffsetRanges; }
73     const Vector<ScrollOffsetRange<float>>& verticalSnapOffsetRanges() const { return m_snapOffsetsInfo.verticalSnapOffsetRanges; }
74     unsigned currentHorizontalSnapPointIndex() const { return m_currentHorizontalSnapPointIndex; }
75     unsigned currentVerticalSnapPointIndex() const { return m_currentVerticalSnapPointIndex; }
76     void setCurrentHorizontalSnapPointIndex(unsigned index) { m_currentHorizontalSnapPointIndex = index; }
77     void setCurrentVerticalSnapPointIndex(unsigned index) { m_currentVerticalSnapPointIndex = index; }
78 #endif
79
80     bool useDarkAppearanceForScrollbars() const { return m_scrollableAreaParameters.useDarkAppearanceForScrollbars; }
81
82 protected:
83     ScrollingTreeScrollingNode(ScrollingTree&, ScrollingNodeType, ScrollingNodeID);
84
85     WEBCORE_EXPORT virtual FloatPoint minimumScrollPosition() const;
86     WEBCORE_EXPORT virtual FloatPoint maximumScrollPosition() const;
87
88     virtual void setScrollLayerPosition(const FloatPoint&, const FloatRect& layoutViewport) = 0;
89
90     FloatPoint lastCommittedScrollPosition() const { return m_lastCommittedScrollPosition; }
91     const FloatSize& reachableContentsSize() const { return m_reachableContentsSize; }
92     const LayoutRect& parentRelativeScrollableRect() const { return m_parentRelativeScrollableRect; }
93     const IntPoint& scrollOrigin() const { return m_scrollOrigin; }
94
95     // If the totalContentsSize changes in the middle of a rubber-band, we still want to use the old totalContentsSize for the sake of
96     // computing the stretchAmount(). Using the old value will keep the animation smooth. When there is no rubber-band in progress at
97     // all, m_totalContentsSizeForRubberBand should be equivalent to m_totalContentsSize.
98     const FloatSize& totalContentsSizeForRubberBand() const { return m_totalContentsSizeForRubberBand; }
99     void setTotalContentsSizeForRubberBand(const FloatSize& totalContentsSizeForRubberBand) { m_totalContentsSizeForRubberBand = totalContentsSizeForRubberBand; }
100
101     ScrollElasticity horizontalScrollElasticity() const { return m_scrollableAreaParameters.horizontalScrollElasticity; }
102     ScrollElasticity verticalScrollElasticity() const { return m_scrollableAreaParameters.verticalScrollElasticity; }
103
104     bool hasEnabledHorizontalScrollbar() const { return m_scrollableAreaParameters.hasEnabledHorizontalScrollbar; }
105     bool hasEnabledVerticalScrollbar() const { return m_scrollableAreaParameters.hasEnabledVerticalScrollbar; }
106
107     bool canHaveScrollbars() const { return m_scrollableAreaParameters.horizontalScrollbarMode != ScrollbarAlwaysOff || m_scrollableAreaParameters.verticalScrollbarMode != ScrollbarAlwaysOff; }
108
109     WEBCORE_EXPORT void dumpProperties(WTF::TextStream&, ScrollingStateTreeAsTextBehavior) const override;
110
111 private:
112     FloatSize m_scrollableAreaSize;
113     FloatSize m_totalContentsSize;
114     FloatSize m_totalContentsSizeForRubberBand;
115     FloatSize m_reachableContentsSize;
116     FloatPoint m_lastCommittedScrollPosition;
117     LayoutRect m_parentRelativeScrollableRect;
118     IntPoint m_scrollOrigin;
119 #if ENABLE(CSS_SCROLL_SNAP)
120     ScrollSnapOffsetsInfo<float> m_snapOffsetsInfo;
121     unsigned m_currentHorizontalSnapPointIndex { 0 };
122     unsigned m_currentVerticalSnapPointIndex { 0 };
123 #endif
124     ScrollableAreaParameters m_scrollableAreaParameters;
125 };
126
127 } // namespace WebCore
128
129 SPECIALIZE_TYPE_TRAITS_SCROLLING_NODE(ScrollingTreeScrollingNode, isScrollingNode())
130
131 #endif // ENABLE(ASYNC_SCROLLING)