298f49dbbdd5b4956ae6aa17ec84d3d8049e32ef
[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 "ScrollableArea.h"
34 #include "ScrollingCoordinator.h"
35 #include "ScrollingTreeNode.h"
36
37 namespace WebCore {
38
39 class ScrollingTree;
40 class ScrollingStateScrollingNode;
41
42 class WEBCORE_EXPORT ScrollingTreeScrollingNode : public ScrollingTreeNode {
43     friend class ScrollingTreeScrollingNodeDelegate;
44 #if PLATFORM(MAC)
45     friend class ScrollingTreeScrollingNodeDelegateMac;
46 #endif
47     friend class ScrollingTree;
48
49 public:
50     virtual ~ScrollingTreeScrollingNode();
51
52     void commitStateBeforeChildren(const ScrollingStateNode&) override;
53     void commitStateAfterChildren(const ScrollingStateNode&) override;
54
55     virtual ScrollingEventResult handleWheelEvent(const PlatformWheelEvent&);
56
57     FloatPoint currentScrollPosition() const { return m_currentScrollPosition; }
58     FloatPoint currentScrollOffset() const { return ScrollableArea::scrollOffsetFromPosition(m_currentScrollPosition, toFloatSize(m_scrollOrigin)); }
59     FloatPoint lastCommittedScrollPosition() const { return m_lastCommittedScrollPosition; }
60     FloatSize scrollDeltaSinceLastCommit() const { return m_currentScrollPosition - m_lastCommittedScrollPosition; }
61
62     // These are imperative; they adjust the scrolling layers.
63     void scrollTo(const FloatPoint&, ScrollType = ScrollType::User, ScrollPositionClamp = ScrollPositionClamp::ToContentEdges);
64     void scrollBy(const FloatSize&, ScrollPositionClamp = ScrollPositionClamp::ToContentEdges);
65
66     void wasScrolledByDelegatedScrolling(const FloatPoint& position, Optional<FloatRect> overrideLayoutViewport = { }, ScrollingLayerPositionAction = ScrollingLayerPositionAction::Sync);
67     
68     const FloatSize& scrollableAreaSize() const { return m_scrollableAreaSize; }
69     const FloatSize& totalContentsSize() const { return m_totalContentsSize; }
70
71     bool horizontalScrollbarHiddenByStyle() const { return m_scrollableAreaParameters.horizontalScrollbarHiddenByStyle; }
72     bool verticalScrollbarHiddenByStyle() const { return m_scrollableAreaParameters.verticalScrollbarHiddenByStyle; }
73     bool canHaveScrollbars() const { return m_scrollableAreaParameters.horizontalScrollbarMode != ScrollbarAlwaysOff || m_scrollableAreaParameters.verticalScrollbarMode != ScrollbarAlwaysOff; }
74
75 #if ENABLE(CSS_SCROLL_SNAP)
76     const Vector<float>& horizontalSnapOffsets() const { return m_snapOffsetsInfo.horizontalSnapOffsets; }
77     const Vector<float>& verticalSnapOffsets() const { return m_snapOffsetsInfo.verticalSnapOffsets; }
78     const Vector<ScrollOffsetRange<float>>& horizontalSnapOffsetRanges() const { return m_snapOffsetsInfo.horizontalSnapOffsetRanges; }
79     const Vector<ScrollOffsetRange<float>>& verticalSnapOffsetRanges() const { return m_snapOffsetsInfo.verticalSnapOffsetRanges; }
80     unsigned currentHorizontalSnapPointIndex() const { return m_currentHorizontalSnapPointIndex; }
81     unsigned currentVerticalSnapPointIndex() const { return m_currentVerticalSnapPointIndex; }
82     void setCurrentHorizontalSnapPointIndex(unsigned index) { m_currentHorizontalSnapPointIndex = index; }
83     void setCurrentVerticalSnapPointIndex(unsigned index) { m_currentVerticalSnapPointIndex = index; }
84 #endif
85
86     bool useDarkAppearanceForScrollbars() const { return m_scrollableAreaParameters.useDarkAppearanceForScrollbars; }
87
88     bool scrollLimitReached(const PlatformWheelEvent&) const;
89     ScrollingTreeScrollingNode* scrollingNodeForPoint(LayoutPoint) const override;
90
91 #if PLATFORM(COCOA)
92     CALayer *scrollContainerLayer() const { return m_scrollContainerLayer.get(); }
93     CALayer *scrolledContentsLayer() const { return m_scrolledContentsLayer.get(); }
94 #endif
95
96 protected:
97     ScrollingTreeScrollingNode(ScrollingTree&, ScrollingNodeType, ScrollingNodeID);
98
99     virtual FloatPoint minimumScrollPosition() const;
100     virtual FloatPoint maximumScrollPosition() const;
101
102     FloatPoint clampScrollPosition(const FloatPoint&) const;
103     
104     virtual FloatPoint adjustedScrollPosition(const FloatPoint&, ScrollPositionClamp = ScrollPositionClamp::ToContentEdges) const;
105
106     virtual void currentScrollPositionChanged();
107     virtual void updateViewportForCurrentScrollPosition(Optional<FloatRect> = { }) { }
108     virtual bool scrollPositionAndLayoutViewportMatch(const FloatPoint& position, Optional<FloatRect> overrideLayoutViewport);
109
110     virtual void repositionScrollingLayers() { }
111     virtual void repositionRelatedLayers() { }
112
113     void applyLayerPositions() override;
114
115     const FloatSize& reachableContentsSize() const { return m_reachableContentsSize; }
116     const LayoutRect& parentRelativeScrollableRect() const { return m_parentRelativeScrollableRect; }
117     const IntPoint& scrollOrigin() const { return m_scrollOrigin; }
118
119     // If the totalContentsSize changes in the middle of a rubber-band, we still want to use the old totalContentsSize for the sake of
120     // computing the stretchAmount(). Using the old value will keep the animation smooth. When there is no rubber-band in progress at
121     // all, m_totalContentsSizeForRubberBand should be equivalent to m_totalContentsSize.
122     const FloatSize& totalContentsSizeForRubberBand() const { return m_totalContentsSizeForRubberBand; }
123     void setTotalContentsSizeForRubberBand(const FloatSize& totalContentsSizeForRubberBand) { m_totalContentsSizeForRubberBand = totalContentsSizeForRubberBand; }
124
125     ScrollElasticity horizontalScrollElasticity() const { return m_scrollableAreaParameters.horizontalScrollElasticity; }
126     ScrollElasticity verticalScrollElasticity() const { return m_scrollableAreaParameters.verticalScrollElasticity; }
127
128     bool hasEnabledHorizontalScrollbar() const { return m_scrollableAreaParameters.hasEnabledHorizontalScrollbar; }
129     bool hasEnabledVerticalScrollbar() const { return m_scrollableAreaParameters.hasEnabledVerticalScrollbar; }
130
131     bool expectsWheelEventTestTrigger() const { return m_expectsWheelEventTestTrigger; }
132
133     LayoutPoint parentToLocalPoint(LayoutPoint) const override;
134     LayoutPoint localToContentsPoint(LayoutPoint) const override;
135
136     void dumpProperties(WTF::TextStream&, ScrollingStateTreeAsTextBehavior) const override;
137
138 private:
139     FloatSize m_scrollableAreaSize;
140     FloatSize m_totalContentsSize;
141     FloatSize m_totalContentsSizeForRubberBand;
142     FloatSize m_reachableContentsSize;
143     FloatPoint m_lastCommittedScrollPosition;
144     LayoutRect m_parentRelativeScrollableRect;
145     FloatPoint m_currentScrollPosition;
146     IntPoint m_scrollOrigin;
147 #if ENABLE(CSS_SCROLL_SNAP)
148     ScrollSnapOffsetsInfo<float> m_snapOffsetsInfo;
149     unsigned m_currentHorizontalSnapPointIndex { 0 };
150     unsigned m_currentVerticalSnapPointIndex { 0 };
151 #endif
152     ScrollableAreaParameters m_scrollableAreaParameters;
153     bool m_expectsWheelEventTestTrigger { false };
154     bool m_isFirstCommit { true };
155
156 #if PLATFORM(COCOA)
157     RetainPtr<CALayer> m_scrollContainerLayer;
158     RetainPtr<CALayer> m_scrolledContentsLayer;
159 #endif
160 };
161
162 } // namespace WebCore
163
164 SPECIALIZE_TYPE_TRAITS_SCROLLING_NODE(ScrollingTreeScrollingNode, isScrollingNode())
165
166 #endif // ENABLE(ASYNC_SCROLLING)