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