473c4429fcadf6dd7767372e07e60981703165d7
[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)
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         RootContentsLayer,
53         ScrolledContentsLayer,
54         CounterScrollingLayer,
55         InsetClipLayer,
56         ContentShadowLayer,
57         HeaderHeight,
58         FooterHeight,
59         HeaderLayer,
60         FooterLayer,
61         BehaviorForFixedElements,
62         TopContentInset,
63         FixedElementsLayoutRelativeToFrame,
64         VisualViewportIsSmallerThanLayoutViewport,
65         AsyncFrameOrOverflowScrollingEnabled,
66         LayoutViewport,
67         MinLayoutViewportOrigin,
68         MaxLayoutViewportOrigin,
69     };
70
71     float frameScaleFactor() const { return m_frameScaleFactor; }
72     WEBCORE_EXPORT void setFrameScaleFactor(float);
73
74     const EventTrackingRegions& eventTrackingRegions() const { return m_eventTrackingRegions; }
75     WEBCORE_EXPORT void setEventTrackingRegions(const EventTrackingRegions&);
76
77     SynchronousScrollingReasons synchronousScrollingReasons() const { return m_synchronousScrollingReasons; }
78     WEBCORE_EXPORT void setSynchronousScrollingReasons(SynchronousScrollingReasons);
79
80     ScrollBehaviorForFixedElements scrollBehaviorForFixedElements() const { return m_behaviorForFixed; }
81     WEBCORE_EXPORT void setScrollBehaviorForFixedElements(ScrollBehaviorForFixedElements);
82
83     FloatRect layoutViewport() const { return m_layoutViewport; };
84     WEBCORE_EXPORT void setLayoutViewport(const FloatRect&);
85
86     FloatPoint minLayoutViewportOrigin() const { return m_minLayoutViewportOrigin; }
87     WEBCORE_EXPORT void setMinLayoutViewportOrigin(const FloatPoint&);
88
89     FloatPoint maxLayoutViewportOrigin() const { return m_maxLayoutViewportOrigin; }
90     WEBCORE_EXPORT void setMaxLayoutViewportOrigin(const FloatPoint&);
91
92     int headerHeight() const { return m_headerHeight; }
93     WEBCORE_EXPORT void setHeaderHeight(int);
94
95     int footerHeight() const { return m_footerHeight; }
96     WEBCORE_EXPORT void setFooterHeight(int);
97
98     float topContentInset() const { return m_topContentInset; }
99     WEBCORE_EXPORT void setTopContentInset(float);
100
101     const LayerRepresentation& rootContentsLayer() const { return m_rootContentsLayer; }
102     WEBCORE_EXPORT void setRootContentsLayer(const LayerRepresentation&);
103
104     // This is a layer moved in the opposite direction to scrolling, for example for background-attachment:fixed
105     const LayerRepresentation& counterScrollingLayer() const { return m_counterScrollingLayer; }
106     WEBCORE_EXPORT void setCounterScrollingLayer(const LayerRepresentation&);
107
108     // This is a clipping layer that will scroll with the page for all y-delta scroll values between 0
109     // and topContentInset(). Once the y-deltas get beyond the content inset point, this layer no longer
110     // needs to move. If the topContentInset() is 0, this layer does not need to move at all. This is
111     // only used on the Mac.
112     const LayerRepresentation& insetClipLayer() const { return m_insetClipLayer; }
113     WEBCORE_EXPORT void setInsetClipLayer(const LayerRepresentation&);
114
115     const LayerRepresentation& contentShadowLayer() const { return m_contentShadowLayer; }
116     WEBCORE_EXPORT void setContentShadowLayer(const LayerRepresentation&);
117
118     // The header and footer layers scroll vertically with the page, they should remain fixed when scrolling horizontally.
119     const LayerRepresentation& headerLayer() const { return m_headerLayer; }
120     WEBCORE_EXPORT void setHeaderLayer(const LayerRepresentation&);
121
122     // The header and footer layers scroll vertically with the page, they should remain fixed when scrolling horizontally.
123     const LayerRepresentation& footerLayer() const { return m_footerLayer; }
124     WEBCORE_EXPORT void setFooterLayer(const LayerRepresentation&);
125
126     // True when the visual viewport is smaller than the layout viewport, indicating that panning should be possible.
127     bool visualViewportIsSmallerThanLayoutViewport() const { return m_visualViewportIsSmallerThanLayoutViewport; }
128     WEBCORE_EXPORT void setVisualViewportIsSmallerThanLayoutViewport(bool);
129
130     // These are more like Settings, and should probably move to the Scrolling{State}Tree itself.
131     bool fixedElementsLayoutRelativeToFrame() const { return m_fixedElementsLayoutRelativeToFrame; }
132     WEBCORE_EXPORT void setFixedElementsLayoutRelativeToFrame(bool);
133
134     bool asyncFrameOrOverflowScrollingEnabled() const { return m_asyncFrameOrOverflowScrollingEnabled; }
135     void setAsyncFrameOrOverflowScrollingEnabled(bool);
136
137     void dumpProperties(WTF::TextStream&, ScrollingStateTreeAsTextBehavior) const override;
138
139 private:
140     ScrollingStateFrameScrollingNode(ScrollingStateTree&, ScrollingNodeType, ScrollingNodeID);
141     ScrollingStateFrameScrollingNode(const ScrollingStateFrameScrollingNode&, ScrollingStateTree&);
142
143     void setPropertyChangedBitsAfterReattach() override;
144
145     LayerRepresentation m_rootContentsLayer;
146     LayerRepresentation m_counterScrollingLayer;
147     LayerRepresentation m_insetClipLayer;
148     LayerRepresentation m_contentShadowLayer;
149     LayerRepresentation m_headerLayer;
150     LayerRepresentation m_footerLayer;
151
152     EventTrackingRegions m_eventTrackingRegions;
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_fixedElementsLayoutRelativeToFrame { false };
165     bool m_visualViewportIsSmallerThanLayoutViewport { false };
166     bool m_asyncFrameOrOverflowScrollingEnabled { false };
167 };
168
169 } // namespace WebCore
170
171 SPECIALIZE_TYPE_TRAITS_SCROLLING_STATE_NODE(ScrollingStateFrameScrollingNode, isFrameScrollingNode())
172
173 #endif // ENABLE(ASYNC_SCROLLING)