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#include "config.h"
27#include "ScrollingStateStickyNode.h"
28
29#if ENABLE(ASYNC_SCROLLING) || USE(COORDINATED_GRAPHICS)
30
31#include "GraphicsLayer.h"
32#include "Logging.h"
33#include "ScrollingStateTree.h"
34#include <wtf/text/TextStream.h>
35
36namespace WebCore {
37
38Ref<ScrollingStateStickyNode> ScrollingStateStickyNode::create(ScrollingStateTree& stateTree, ScrollingNodeID nodeID)
39{
40 return adoptRef(*new ScrollingStateStickyNode(stateTree, nodeID));
41}
42
43ScrollingStateStickyNode::ScrollingStateStickyNode(ScrollingStateTree& tree, ScrollingNodeID nodeID)
44 : ScrollingStateNode(ScrollingNodeType::Sticky, tree, nodeID)
45{
46}
47
48ScrollingStateStickyNode::ScrollingStateStickyNode(const ScrollingStateStickyNode& node, ScrollingStateTree& adoptiveTree)
49 : ScrollingStateNode(node, adoptiveTree)
50 , m_constraints(StickyPositionViewportConstraints(node.viewportConstraints()))
51{
52}
53
54ScrollingStateStickyNode::~ScrollingStateStickyNode() = default;
55
56Ref<ScrollingStateNode> ScrollingStateStickyNode::clone(ScrollingStateTree& adoptiveTree)
57{
58 return adoptRef(*new ScrollingStateStickyNode(*this, adoptiveTree));
59}
60
61void ScrollingStateStickyNode::setAllPropertiesChanged()
62{
63 setPropertyChangedBit(ViewportConstraints);
64 ScrollingStateNode::setAllPropertiesChanged();
65}
66
67void ScrollingStateStickyNode::updateConstraints(const StickyPositionViewportConstraints& constraints)
68{
69 if (m_constraints == constraints)
70 return;
71
72 LOG_WITH_STREAM(Scrolling, stream << "ScrollingStateStickyNode " << scrollingNodeID() << " updateConstraints with constraining rect " << constraints.constrainingRectAtLastLayout() << " sticky offset " << constraints.stickyOffsetAtLastLayout() << " layer pos at last layout " << constraints.layerPositionAtLastLayout());
73
74 m_constraints = constraints;
75 setPropertyChanged(ViewportConstraints);
76}
77
78void ScrollingStateStickyNode::reconcileLayerPositionForViewportRect(const LayoutRect& viewportRect, ScrollingLayerPositionAction action)
79{
80 FloatPoint position = m_constraints.layerPositionForConstrainingRect(viewportRect);
81 if (layer().representsGraphicsLayer()) {
82 auto* graphicsLayer = static_cast<GraphicsLayer*>(layer());
83
84 LOG_WITH_STREAM(Compositing, stream << "ScrollingStateStickyNode " << scrollingNodeID() << " reconcileLayerPositionForViewportRect " << action << " position of layer " << graphicsLayer->primaryLayerID() << " to " << position << " sticky offset " << m_constraints.stickyOffsetAtLastLayout());
85
86 switch (action) {
87 case ScrollingLayerPositionAction::Set:
88 graphicsLayer->setPosition(position);
89 break;
90
91 case ScrollingLayerPositionAction::SetApproximate:
92 graphicsLayer->setApproximatePosition(position);
93 break;
94
95 case ScrollingLayerPositionAction::Sync:
96 graphicsLayer->syncPosition(position);
97 break;
98 }
99 }
100}
101
102void ScrollingStateStickyNode::dumpProperties(TextStream& ts, ScrollingStateTreeAsTextBehavior behavior) const
103{
104 ts << "Sticky node";
105 ScrollingStateNode::dumpProperties(ts, behavior);
106
107 if (m_constraints.anchorEdges()) {
108 TextStream::GroupScope scope(ts);
109 ts << "anchor edges: ";
110 if (m_constraints.hasAnchorEdge(ViewportConstraints::AnchorEdgeLeft))
111 ts << "AnchorEdgeLeft ";
112 if (m_constraints.hasAnchorEdge(ViewportConstraints::AnchorEdgeRight))
113 ts << "AnchorEdgeRight ";
114 if (m_constraints.hasAnchorEdge(ViewportConstraints::AnchorEdgeTop))
115 ts << "AnchorEdgeTop ";
116 if (m_constraints.hasAnchorEdge(ViewportConstraints::AnchorEdgeBottom))
117 ts << "AnchorEdgeBottom";
118 }
119
120 if (m_constraints.hasAnchorEdge(ViewportConstraints::AnchorEdgeLeft))
121 ts.dumpProperty("left offset", m_constraints.leftOffset());
122 if (m_constraints.hasAnchorEdge(ViewportConstraints::AnchorEdgeRight))
123 ts.dumpProperty("right offset", m_constraints.rightOffset());
124 if (m_constraints.hasAnchorEdge(ViewportConstraints::AnchorEdgeTop))
125 ts.dumpProperty("top offset", m_constraints.topOffset());
126 if (m_constraints.hasAnchorEdge(ViewportConstraints::AnchorEdgeBottom))
127 ts.dumpProperty("bottom offset", m_constraints.bottomOffset());
128
129 ts.dumpProperty("containing block rect", m_constraints.containingBlockRect());
130
131 ts.dumpProperty("sticky box rect", m_constraints.stickyBoxRect());
132
133 ts.dumpProperty("constraining rect", m_constraints.constrainingRectAtLastLayout());
134
135 ts.dumpProperty("sticky offset at last layout", m_constraints.stickyOffsetAtLastLayout());
136
137 ts.dumpProperty("layer position at last layout", m_constraints.layerPositionAtLastLayout());
138}
139
140} // namespace WebCore
141
142#endif // ENABLE(ASYNC_SCROLLING) || USE(COORDINATED_GRAPHICS)
143