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 ScrollingStateStickyNode_h
27#define ScrollingStateStickyNode_h
28
29#if ENABLE(THREADED_SCROLLING) || USE(COORDINATED_GRAPHICS)
30
31#include "ScrollingConstraints.h"
32#include "ScrollingStateNode.h"
33
34#include <wtf/Forward.h>
35
36namespace WebCore {
37
38class StickyPositionViewportConstraints;
39
40class ScrollingStateStickyNode : public ScrollingStateNode {
41public:
42    static PassOwnPtr<ScrollingStateStickyNode> create(ScrollingStateTree*, ScrollingNodeID);
43
44    virtual PassOwnPtr<ScrollingStateNode> clone();
45
46    virtual ~ScrollingStateStickyNode();
47
48    enum {
49        ViewportConstraints = NumStateNodeBits
50    };
51
52    void updateConstraints(const StickyPositionViewportConstraints&);
53    const StickyPositionViewportConstraints& viewportConstraints() const { return m_constraints; }
54
55private:
56    ScrollingStateStickyNode(ScrollingStateTree*, ScrollingNodeID);
57    ScrollingStateStickyNode(const ScrollingStateStickyNode&);
58
59    virtual bool isStickyNode() OVERRIDE { return true; }
60
61    virtual void syncLayerPositionForViewportRect(const LayoutRect& viewportRect) OVERRIDE;
62
63    virtual void dumpProperties(TextStream&, int indent) const OVERRIDE;
64
65    StickyPositionViewportConstraints m_constraints;
66};
67
68inline ScrollingStateStickyNode* toScrollingStateStickyNode(ScrollingStateNode* node)
69{
70    ASSERT_WITH_SECURITY_IMPLICATION(!node || node->isStickyNode());
71    return static_cast<ScrollingStateStickyNode*>(node);
72}
73
74// This will catch anyone doing an unnecessary cast.
75void toScrollingStateStickyNode(const ScrollingStateStickyNode*);
76
77} // namespace WebCore
78
79#endif // ENABLE(THREADED_SCROLLING) || USE(COORDINATED_GRAPHICS)
80
81#endif // ScrollingStateStickyNode_h
82