2f4415ac8852669c730d28a65751131e5ba2c993
[WebKit-https.git] / Source / WebCore / page / scrolling / ScrollingTreeNode.h
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 #pragma once
27
28 #if ENABLE(ASYNC_SCROLLING)
29
30 #include "IntRect.h"
31 #include "ScrollTypes.h"
32 #include "ScrollingCoordinator.h"
33 #include "ScrollingStateNode.h"
34 #include <wtf/RefCounted.h>
35 #include <wtf/TypeCasts.h>
36
37 namespace WebCore {
38
39 class ScrollingStateFixedNode;
40 class ScrollingStateScrollingNode;
41 class ScrollingTreeFrameScrollingNode;
42
43 class ScrollingTreeNode : public RefCounted<ScrollingTreeNode> {
44 public:
45     virtual ~ScrollingTreeNode();
46
47     ScrollingNodeType nodeType() const { return m_nodeType; }
48     ScrollingNodeID scrollingNodeID() const { return m_nodeID; }
49     
50     bool isFixedNode() const { return nodeType() == ScrollingNodeType::Fixed; }
51     bool isStickyNode() const { return nodeType() == ScrollingNodeType::Sticky; }
52     bool isScrollingNode() const { return isFrameScrollingNode() || isOverflowScrollingNode(); }
53     bool isFrameScrollingNode() const { return nodeType() == ScrollingNodeType::MainFrame || nodeType() == ScrollingNodeType::Subframe; }
54     bool isFrameHostingNode() const { return nodeType() == ScrollingNodeType::FrameHosting; }
55     bool isOverflowScrollingNode() const { return nodeType() == ScrollingNodeType::Overflow; }
56
57     virtual void commitStateBeforeChildren(const ScrollingStateNode&) = 0;
58     virtual void commitStateAfterChildren(const ScrollingStateNode&) { }
59
60     virtual void updateLayersAfterAncestorChange(const ScrollingTreeNode& changedNode, const FloatRect& fixedPositionRect, const FloatSize& cumulativeDelta) = 0;
61
62     ScrollingTreeNode* parent() const { return m_parent; }
63     void setParent(ScrollingTreeNode* parent) { m_parent = parent; }
64
65     Vector<RefPtr<ScrollingTreeNode>>* children() { return m_children.get(); }
66
67     void appendChild(Ref<ScrollingTreeNode>&&);
68     void removeChild(ScrollingTreeNode&);
69
70     WEBCORE_EXPORT ScrollingTreeFrameScrollingNode* enclosingFrameNodeIncludingSelf();
71
72     WEBCORE_EXPORT void dump(WTF::TextStream&, ScrollingStateTreeAsTextBehavior) const;
73
74 protected:
75     ScrollingTreeNode(ScrollingTree&, ScrollingNodeType, ScrollingNodeID);
76     ScrollingTree& scrollingTree() const { return m_scrollingTree; }
77
78     std::unique_ptr<Vector<RefPtr<ScrollingTreeNode>>> m_children;
79
80     WEBCORE_EXPORT virtual void dumpProperties(WTF::TextStream&, ScrollingStateTreeAsTextBehavior) const;
81
82 private:
83     ScrollingTree& m_scrollingTree;
84
85     const ScrollingNodeType m_nodeType;
86     const ScrollingNodeID m_nodeID;
87
88     ScrollingTreeNode* m_parent;
89 };
90
91 } // namespace WebCore
92
93 #define SPECIALIZE_TYPE_TRAITS_SCROLLING_NODE(ToValueTypeName, predicate) \
94 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::ToValueTypeName) \
95     static bool isType(const WebCore::ScrollingTreeNode& node) { return node.predicate; } \
96 SPECIALIZE_TYPE_TRAITS_END()
97
98 #endif // ENABLE(ASYNC_SCROLLING)