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