0503cdb26caf7a20d1d1e10d22f6588503b54213
[WebKit-https.git] / Source / WebCore / page / scrolling / ScrollingTreeNode.cpp
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 "ScrollingTreeNode.h"
28
29 #if ENABLE(ASYNC_SCROLLING)
30
31 #include "ScrollingStateTree.h"
32 #include "ScrollingTreeFrameScrollingNode.h"
33 #include <wtf/text/TextStream.h>
34
35 namespace WebCore {
36
37 ScrollingTreeNode::ScrollingTreeNode(ScrollingTree& scrollingTree, ScrollingNodeType nodeType, ScrollingNodeID nodeID)
38     : m_scrollingTree(scrollingTree)
39     , m_nodeType(nodeType)
40     , m_nodeID(nodeID)
41     , m_parent(nullptr)
42 {
43 }
44
45 ScrollingTreeNode::~ScrollingTreeNode() = default;
46
47 void ScrollingTreeNode::appendChild(Ref<ScrollingTreeNode>&& childNode)
48 {
49     childNode->setParent(this);
50
51     if (!m_children)
52         m_children = std::make_unique<Vector<RefPtr<ScrollingTreeNode>>>();
53     m_children->append(WTFMove(childNode));
54 }
55
56 void ScrollingTreeNode::removeChild(ScrollingTreeNode& node)
57 {
58     if (!m_children)
59         return;
60
61     size_t index = m_children->find(&node);
62
63     // The index will be notFound if the node to remove is a deeper-than-1-level descendant or
64     // if node is the root state node.
65     if (index != notFound) {
66         m_children->remove(index);
67         return;
68     }
69
70     for (auto& child : *m_children)
71         child->removeChild(node);
72 }
73
74 void ScrollingTreeNode::dumpProperties(TextStream& ts, ScrollingStateTreeAsTextBehavior behavior) const
75 {
76     if (behavior & ScrollingStateTreeAsTextBehaviorIncludeNodeIDs)
77         ts.dumpProperty("nodeID", scrollingNodeID());
78 }
79
80 ScrollingTreeFrameScrollingNode* ScrollingTreeNode::enclosingFrameNodeIncludingSelf()
81 {
82     auto* node = this;
83     while (node && !node->isFrameScrollingNode())
84         node = node->parent();
85
86     return downcast<ScrollingTreeFrameScrollingNode>(node);
87 }
88
89 void ScrollingTreeNode::dump(TextStream& ts, ScrollingStateTreeAsTextBehavior behavior) const
90 {
91     dumpProperties(ts, behavior);
92
93     if (m_children) {
94         for (auto& child : *m_children) {
95             TextStream::GroupScope scope(ts);
96             child->dump(ts, behavior);
97         }
98     }
99 }
100
101 } // namespace WebCore
102
103 #endif // ENABLE(ASYNC_SCROLLING)