https://bugs.webkit.org/show_bug.cgi?id=99111
[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 #include <wtf/Vector.h>
35
36 #if PLATFORM(MAC)
37 #include <wtf/RetainPtr.h>
38 #endif
39
40 namespace WebCore {
41
42 class ScrollingStateTree;
43
44 class ScrollingStateNode {
45     WTF_MAKE_NONCOPYABLE(ScrollingStateNode);
46
47 public:
48     ScrollingStateNode(ScrollingStateTree*);
49     virtual ~ScrollingStateNode();
50
51     virtual bool isScrollingStateScrollingNode() { return false; }
52
53     virtual PassOwnPtr<ScrollingStateNode> cloneAndResetNode() = 0;
54     void cloneAndResetChildNodes(ScrollingStateNode*);
55
56     virtual bool hasChangedProperties() const = 0;
57     virtual unsigned changedProperties() const = 0;
58     virtual void resetChangedProperties() = 0;
59     virtual void setHasChangedProperties() { setScrollLayerDidChange(true); }
60
61     PlatformLayer* platformScrollLayer() const;
62     void setScrollLayer(const GraphicsLayer*);
63     void setScrollLayer(PlatformLayer*);
64
65     bool scrollLayerDidChange() const { return m_scrollLayerDidChange; }
66     void setScrollLayerDidChange(bool scrollLayerDidChange) { m_scrollLayerDidChange = scrollLayerDidChange; }
67
68     ScrollingStateTree* scrollingStateTree() const { return m_scrollingStateTree; }
69     void setScrollingStateTree(ScrollingStateTree* tree) { m_scrollingStateTree = tree; }
70
71     ScrollingStateNode* parent() const { return m_parent; }
72     void setParent(ScrollingStateNode* parent) { m_parent = parent; }
73
74     void appendChild(PassOwnPtr<ScrollingStateNode>);
75
76     void removeChild(ScrollingStateNode*);
77
78 protected:
79     ScrollingStateNode(ScrollingStateNode*);
80
81     ScrollingStateTree* m_scrollingStateTree;
82
83 private:
84     ScrollingStateNode* m_parent;
85
86     OwnPtr<Vector<OwnPtr<ScrollingStateNode> > > m_children;
87
88     bool m_scrollLayerDidChange;
89
90 #if PLATFORM(MAC)
91     RetainPtr<PlatformLayer> m_platformScrollLayer;
92 #endif
93
94 };
95
96 } // namespace WebCore
97
98 #endif // ENABLE(THREADED_SCROLLING)
99
100 #endif // ScrollingStateNode_h