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#ifndef ScrollingTreeNode_h
27#define ScrollingTreeNode_h
28
29#if ENABLE(ASYNC_SCROLLING)
30
31#include "IntRect.h"
32#include "ScrollTypes.h"
33#include "ScrollingCoordinator.h"
34#include <wtf/RefCounted.h>
35
36namespace WebCore {
37
38class ScrollingStateFixedNode;
39class ScrollingStateNode;
40class ScrollingStateScrollingNode;
41
42class ScrollingTreeNode : public RefCounted<ScrollingTreeNode> {
43public:
44    virtual ~ScrollingTreeNode();
45
46    ScrollingNodeType nodeType() const { return m_nodeType; }
47    ScrollingNodeID scrollingNodeID() const { return m_nodeID; }
48
49    bool isFixedNode() const { return nodeType() == FixedNode; }
50    bool isStickyNode() const { return nodeType() == StickyNode; }
51    bool isScrollingNode() const { return nodeType() == FrameScrollingNode || nodeType() == OverflowScrollingNode; }
52    bool isFrameScrollingNode() const { return nodeType() == FrameScrollingNode; }
53    bool isOverflowScrollingNode() const { return nodeType() == OverflowScrollingNode; }
54
55    virtual void updateBeforeChildren(const ScrollingStateNode&) = 0;
56    virtual void updateAfterChildren(const ScrollingStateNode&) { }
57
58    virtual void updateLayersAfterAncestorChange(const ScrollingTreeNode& changedNode, const FloatRect& fixedPositionRect, const FloatSize& cumulativeDelta) = 0;
59
60    ScrollingTreeNode* parent() const { return m_parent; }
61    void setParent(ScrollingTreeNode* parent) { m_parent = parent; }
62
63    typedef Vector<RefPtr<ScrollingTreeNode>> ScrollingTreeChildrenVector;
64    ScrollingTreeChildrenVector* children() { return m_children.get(); }
65
66    void appendChild(PassRefPtr<ScrollingTreeNode>);
67    void removeChild(ScrollingTreeNode*);
68
69protected:
70    ScrollingTreeNode(ScrollingTree&, ScrollingNodeType, ScrollingNodeID);
71    ScrollingTree& scrollingTree() const { return m_scrollingTree; }
72
73    OwnPtr<ScrollingTreeChildrenVector> m_children;
74
75private:
76    ScrollingTree& m_scrollingTree;
77
78    const ScrollingNodeType m_nodeType;
79    const ScrollingNodeID m_nodeID;
80
81    ScrollingTreeNode* m_parent;
82};
83
84#define SCROLLING_NODE_TYPE_CASTS(ToValueTypeName, predicate) \
85    TYPE_CASTS_BASE(ToValueTypeName, ScrollingTreeNode, value, value->predicate, value.predicate)
86
87} // namespace WebCore
88
89#endif // ENABLE(ASYNC_SCROLLING)
90
91#endif // ScrollingTreeNode_h
92