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