0fbc4ff52ec4db5b7f22e478e3198074875b3468
[WebKit-https.git] / Source / WebCore / page / scrolling / ScrollingStateFrameScrollingNode.h
1 /*
2  * Copyright (C) 2014, 2016 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) || USE(COORDINATED_GRAPHICS)
29
30 #include "EventTrackingRegions.h"
31 #include "ScrollTypes.h"
32 #include "ScrollbarThemeComposite.h"
33 #include "ScrollingCoordinator.h"
34 #include "ScrollingStateScrollingNode.h"
35
36 namespace WebCore {
37
38 class Scrollbar;
39
40 class ScrollingStateFrameScrollingNode final : public ScrollingStateScrollingNode {
41 public:
42     static Ref<ScrollingStateFrameScrollingNode> create(ScrollingStateTree&, ScrollingNodeType, ScrollingNodeID);
43
44     Ref<ScrollingStateNode> clone(ScrollingStateTree&) override;
45
46     virtual ~ScrollingStateFrameScrollingNode();
47
48     enum ChangedProperty {
49         FrameScaleFactor = NumScrollingStateNodeBits,
50         EventTrackingRegion,
51         ReasonsForSynchronousScrolling,
52         ScrolledContentsLayer,
53         CounterScrollingLayer,
54         InsetClipLayer,
55         ContentShadowLayer,
56         HeaderHeight,
57         FooterHeight,
58         HeaderLayer,
59         FooterLayer,
60         PainterForScrollbar,
61         BehaviorForFixedElements,
62         TopContentInset,
63         FixedElementsLayoutRelativeToFrame,
64         VisualViewportEnabled,
65         LayoutViewport,
66         MinLayoutViewportOrigin,
67         MaxLayoutViewportOrigin,
68     };
69
70     float frameScaleFactor() const { return m_frameScaleFactor; }
71     WEBCORE_EXPORT void setFrameScaleFactor(float);
72
73     const EventTrackingRegions& eventTrackingRegions() const { return m_eventTrackingRegions; }
74     WEBCORE_EXPORT void setEventTrackingRegions(const EventTrackingRegions&);
75
76     SynchronousScrollingReasons synchronousScrollingReasons() const { return m_synchronousScrollingReasons; }
77     WEBCORE_EXPORT void setSynchronousScrollingReasons(SynchronousScrollingReasons);
78
79     ScrollBehaviorForFixedElements scrollBehaviorForFixedElements() const { return m_behaviorForFixed; }
80     WEBCORE_EXPORT void setScrollBehaviorForFixedElements(ScrollBehaviorForFixedElements);
81
82     FloatRect layoutViewport() const { return m_layoutViewport; };
83     WEBCORE_EXPORT void setLayoutViewport(const FloatRect&);
84
85     FloatPoint minLayoutViewportOrigin() const { return m_minLayoutViewportOrigin; }
86     WEBCORE_EXPORT void setMinLayoutViewportOrigin(const FloatPoint&);
87
88     FloatPoint maxLayoutViewportOrigin() const { return m_maxLayoutViewportOrigin; }
89     WEBCORE_EXPORT void setMaxLayoutViewportOrigin(const FloatPoint&);
90
91     int headerHeight() const { return m_headerHeight; }
92     WEBCORE_EXPORT void setHeaderHeight(int);
93
94     int footerHeight() const { return m_footerHeight; }
95     WEBCORE_EXPORT void setFooterHeight(int);
96
97     float topContentInset() const { return m_topContentInset; }
98     WEBCORE_EXPORT void setTopContentInset(float);
99
100     // This is a layer moved in the opposite direction to scrolling, for example for background-attachment:fixed
101     const LayerRepresentation& counterScrollingLayer() const { return m_counterScrollingLayer; }
102     WEBCORE_EXPORT void setCounterScrollingLayer(const LayerRepresentation&);
103
104     // This is a clipping layer that will scroll with the page for all y-delta scroll values between 0
105     // and topContentInset(). Once the y-deltas get beyond the content inset point, this layer no longer
106     // needs to move. If the topContentInset() is 0, this layer does not need to move at all. This is
107     // only used on the Mac.
108     const LayerRepresentation& insetClipLayer() const { return m_insetClipLayer; }
109     WEBCORE_EXPORT void setInsetClipLayer(const LayerRepresentation&);
110
111     const LayerRepresentation& contentShadowLayer() const { return m_contentShadowLayer; }
112     WEBCORE_EXPORT void setContentShadowLayer(const LayerRepresentation&);
113
114     // The header and footer layers scroll vertically with the page, they should remain fixed when scrolling horizontally.
115     const LayerRepresentation& headerLayer() const { return m_headerLayer; }
116     WEBCORE_EXPORT void setHeaderLayer(const LayerRepresentation&);
117
118     // The header and footer layers scroll vertically with the page, they should remain fixed when scrolling horizontally.
119     const LayerRepresentation& footerLayer() const { return m_footerLayer; }
120     WEBCORE_EXPORT void setFooterLayer(const LayerRepresentation&);
121
122     bool fixedElementsLayoutRelativeToFrame() const { return m_fixedElementsLayoutRelativeToFrame; }
123     WEBCORE_EXPORT void setFixedElementsLayoutRelativeToFrame(bool);
124
125     bool visualViewportEnabled() const { return m_visualViewportEnabled; };
126     WEBCORE_EXPORT void setVisualViewportEnabled(bool);
127
128 #if PLATFORM(MAC)
129     NSScrollerImp *verticalScrollerImp() const { return m_verticalScrollerImp.get(); }
130     NSScrollerImp *horizontalScrollerImp() const { return m_horizontalScrollerImp.get(); }
131 #endif
132     void setScrollerImpsFromScrollbars(Scrollbar* verticalScrollbar, Scrollbar* horizontalScrollbar);
133
134     void dumpProperties(WTF::TextStream&, ScrollingStateTreeAsTextBehavior) const override;
135
136 private:
137     ScrollingStateFrameScrollingNode(ScrollingStateTree&, ScrollingNodeType, ScrollingNodeID);
138     ScrollingStateFrameScrollingNode(const ScrollingStateFrameScrollingNode&, ScrollingStateTree&);
139
140     LayerRepresentation m_counterScrollingLayer;
141     LayerRepresentation m_insetClipLayer;
142     LayerRepresentation m_contentShadowLayer;
143     LayerRepresentation m_headerLayer;
144     LayerRepresentation m_footerLayer;
145
146 #if PLATFORM(MAC)
147     RetainPtr<NSScrollerImp> m_verticalScrollerImp;
148     RetainPtr<NSScrollerImp> m_horizontalScrollerImp;
149 #endif
150
151     EventTrackingRegions m_eventTrackingRegions;
152     FloatPoint m_requestedScrollPosition;
153
154     FloatRect m_layoutViewport;
155     FloatPoint m_minLayoutViewportOrigin;
156     FloatPoint m_maxLayoutViewportOrigin;
157
158     float m_frameScaleFactor { 1 };
159     float m_topContentInset { 0 };
160     int m_headerHeight { 0 };
161     int m_footerHeight { 0 };
162     SynchronousScrollingReasons m_synchronousScrollingReasons { 0 };
163     ScrollBehaviorForFixedElements m_behaviorForFixed { StickToDocumentBounds };
164     bool m_requestedScrollPositionRepresentsProgrammaticScroll { false };
165     bool m_fixedElementsLayoutRelativeToFrame { false };
166     bool m_visualViewportEnabled { false };
167 };
168
169 } // namespace WebCore
170
171 SPECIALIZE_TYPE_TRAITS_SCROLLING_STATE_NODE(ScrollingStateFrameScrollingNode, isFrameScrollingNode())
172
173 #endif // ENABLE(ASYNC_SCROLLING) || USE(COORDINATED_GRAPHICS)