Add a way to get the UI-side scrolling tree as text via UIScriptController
[WebKit-https.git] / Source / WebCore / page / scrolling / mac / ScrollingTreeFixedNode.mm
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 "ScrollingTreeFixedNode.h"
28
29 #if ENABLE(ASYNC_SCROLLING)
30
31 #include "ScrollingStateFixedNode.h"
32 #include "ScrollingTree.h"
33 #include "TextStream.h"
34 #include <QuartzCore/CALayer.h>
35
36 namespace WebCore {
37
38 Ref<ScrollingTreeFixedNode> ScrollingTreeFixedNode::create(ScrollingTree& scrollingTree, ScrollingNodeID nodeID)
39 {
40     return adoptRef(*new ScrollingTreeFixedNode(scrollingTree, nodeID));
41 }
42
43 ScrollingTreeFixedNode::ScrollingTreeFixedNode(ScrollingTree& scrollingTree, ScrollingNodeID nodeID)
44     : ScrollingTreeNode(scrollingTree, FixedNode, nodeID)
45 {
46     scrollingTree.fixedOrStickyNodeAdded();
47 }
48
49 ScrollingTreeFixedNode::~ScrollingTreeFixedNode()
50 {
51     scrollingTree().fixedOrStickyNodeRemoved();
52 }
53
54 void ScrollingTreeFixedNode::commitStateBeforeChildren(const ScrollingStateNode& stateNode)
55 {
56     const ScrollingStateFixedNode& fixedStateNode = downcast<ScrollingStateFixedNode>(stateNode);
57
58     if (fixedStateNode.hasChangedProperty(ScrollingStateNode::ScrollLayer))
59         m_layer = fixedStateNode.layer();
60
61     if (stateNode.hasChangedProperty(ScrollingStateFixedNode::ViewportConstraints))
62         m_constraints = fixedStateNode.viewportConstraints();
63 }
64
65 static inline CGPoint operator*(CGPoint& a, const CGSize& b)
66 {
67     return CGPointMake(a.x * b.width, a.y * b.height);
68 }
69
70 void ScrollingTreeFixedNode::updateLayersAfterAncestorChange(const ScrollingTreeNode& changedNode, const FloatRect& fixedPositionRect, const FloatSize& cumulativeDelta)
71 {
72     FloatPoint layerPosition = m_constraints.layerPositionForViewportRect(fixedPositionRect);
73     layerPosition -= cumulativeDelta;
74
75     CGRect layerBounds = [m_layer bounds];
76     CGPoint anchorPoint = [m_layer anchorPoint];
77     CGPoint newPosition = layerPosition - m_constraints.alignmentOffset() + anchorPoint * layerBounds.size;
78     
79     [m_layer setPosition:newPosition];
80
81     if (!m_children)
82         return;
83
84     FloatSize newDelta = layerPosition - m_constraints.layerPositionAtLastLayout() + cumulativeDelta;
85
86     for (auto& child : *m_children)
87         child->updateLayersAfterAncestorChange(changedNode, fixedPositionRect, newDelta);
88 }
89
90 void ScrollingTreeFixedNode::dumpProperties(TextStream& ts, ScrollingStateTreeAsTextBehavior behavior) const
91 {
92     ts << "fixed node";
93     ScrollingTreeNode::dumpProperties(ts, behavior);
94     ts.dumpProperty("fixed constraints", m_constraints);
95     
96     if (behavior & ScrollingStateTreeAsTextBehaviorIncludeLayerPositions) {
97         FloatRect layerBounds = [m_layer bounds];
98         FloatPoint anchorPoint = [m_layer anchorPoint];
99         FloatPoint position = [m_layer position];
100         FloatPoint layerTopLeft = position - toFloatSize(anchorPoint) * layerBounds.size() + m_constraints.alignmentOffset();
101         ts.dumpProperty("layer top left", layerTopLeft);
102     }
103 }
104
105 } // namespace WebCore
106
107 #endif // ENABLE(ASYNC_SCROLLING)