https://bugs.webkit.org/show_bug.cgi?id=97365
[WebKit-https.git] / Source / WebCore / page / scrolling / ScrollingStateNode.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 #ifndef ScrollingStateNode_h
27 #define ScrollingStateNode_h
28
29 #if ENABLE(THREADED_SCROLLING)
30
31 #include "GraphicsLayer.h"
32 #include <wtf/OwnPtr.h>
33 #include <wtf/PassOwnPtr.h>
34
35 #if PLATFORM(MAC)
36 #include <wtf/RetainPtr.h>
37 #endif
38
39 namespace WebCore {
40
41 class ScrollingStateTree;
42
43 class ScrollingStateNode {
44     WTF_MAKE_NONCOPYABLE(ScrollingStateNode);
45
46 public:
47     ScrollingStateNode(ScrollingStateTree*);
48     virtual ~ScrollingStateNode();
49
50     virtual PassOwnPtr<ScrollingStateNode> cloneNode() = 0;
51
52     virtual bool hasChangedProperties() const = 0;
53     virtual unsigned changedProperties() const = 0;
54     virtual void resetChangedProperties() = 0;
55
56     PlatformLayer* platformScrollLayer() const;
57     void setScrollLayer(const GraphicsLayer*);
58     void setScrollLayer(PlatformLayer*);
59
60     bool scrollLayerDidChange() const { return m_scrollLayerDidChange; }
61     void setScrollLayerDidChange(bool scrollLayerDidChange) { m_scrollLayerDidChange = scrollLayerDidChange; }
62
63     ScrollingStateTree* scrollingStateTree() const { return m_scrollingStateTree; }
64     void setScrollingStateTree(ScrollingStateTree* tree) { m_scrollingStateTree = tree; }
65
66     ScrollingStateNode* parent() const { return m_parent; }
67     ScrollingStateNode* firstChild() const { return m_firstChild.get(); }
68     ScrollingStateNode* nextSibling() const { return m_nextSibling.get(); }
69
70     void setParent(ScrollingStateNode* parent) { m_parent = parent; }
71     void setFirstChild(PassOwnPtr<ScrollingStateNode> firstChild) { m_firstChild = firstChild; }
72     void setNextSibling(PassOwnPtr<ScrollingStateNode> nextSibling) { m_nextSibling = nextSibling; }
73
74     void appendChild(PassOwnPtr<ScrollingStateNode>);
75     ScrollingStateNode* traverseNext() const;
76
77 protected:
78     ScrollingStateNode(ScrollingStateNode*);
79
80     ScrollingStateTree* m_scrollingStateTree;
81
82 private:
83     ScrollingStateNode* m_parent;
84     OwnPtr<ScrollingStateNode> m_firstChild;
85     OwnPtr<ScrollingStateNode> m_nextSibling;
86
87     bool m_scrollLayerDidChange;
88
89 #if PLATFORM(MAC)
90     RetainPtr<PlatformLayer> m_platformScrollLayer;
91 #endif
92
93 };
94
95 } // namespace WebCore
96
97 #endif // ENABLE(THREADED_SCROLLING)
98
99 #endif // ScrollingStateNode_h