/*
 * Copyright (C) 2012 Apple Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef ScrollingStateNode_h
#define ScrollingStateNode_h

#if ENABLE(THREADED_SCROLLING) || USE(COORDINATED_GRAPHICS)

#include "PlatformLayer.h"
#include "ScrollingCoordinator.h"
#include <wtf/OwnPtr.h>
#include <wtf/PassOwnPtr.h>
#include <wtf/Vector.h>

#if PLATFORM(MAC)
#include <wtf/RetainPtr.h>
#endif

namespace WebCore {

class GraphicsLayer;
class ScrollingStateTree;
class TextStream;

class ScrollingStateNode {
public:
    ScrollingStateNode(ScrollingStateTree*, ScrollingNodeID);
    virtual ~ScrollingStateNode();

    virtual bool isScrollingNode() { return false; }
    virtual bool isFixedNode() { return false; }
    virtual bool isStickyNode() { return false; }

    virtual PassOwnPtr<ScrollingStateNode> clone() = 0;
    PassOwnPtr<ScrollingStateNode> cloneAndReset();
    void cloneAndResetChildren(ScrollingStateNode*);

    enum {
        ScrollLayer = 0,
        NumStateNodeBits = 1
    };
    typedef unsigned ChangedProperties;

    bool hasChangedProperties() const { return m_changedProperties; }
    bool hasChangedProperty(unsigned propertyBit) { return m_changedProperties & (1 << propertyBit); }
    void resetChangedProperties() { m_changedProperties = 0; }
    void setPropertyChanged(unsigned propertyBit) { m_changedProperties |= (1 << propertyBit); }

    virtual void syncLayerPositionForViewportRect(const LayoutRect& /*viewportRect*/) { }

    GraphicsLayer* graphicsLayer() { return m_graphicsLayer; }
    PlatformLayer* platformScrollLayer() const;
    void setScrollLayer(GraphicsLayer*);
    void setScrollPlatformLayer(PlatformLayer*);

    ScrollingStateTree* scrollingStateTree() const { return m_scrollingStateTree; }
    void setScrollingStateTree(ScrollingStateTree* tree) { m_scrollingStateTree = tree; }

    ScrollingNodeID scrollingNodeID() const { return m_nodeID; }

    ScrollingStateNode* parent() const { return m_parent; }
    void setParent(ScrollingStateNode* parent) { m_parent = parent; }

    Vector<OwnPtr<ScrollingStateNode> >* children() const { return m_children.get(); }

    void appendChild(PassOwnPtr<ScrollingStateNode>);
    void removeChild(ScrollingStateNode*);

    String scrollingStateTreeAsText() const;

protected:
    ScrollingStateNode(const ScrollingStateNode&);
    static void writeIndent(TextStream&, int indent);

    ScrollingStateTree* m_scrollingStateTree;

private:
    void dump(TextStream&, int indent) const;

    virtual void dumpProperties(TextStream&, int indent) const = 0;
    ChangedProperties changedProperties() const { return m_changedProperties; }
    void willBeRemovedFromStateTree();

    ScrollingNodeID m_nodeID;
    ChangedProperties m_changedProperties;

    ScrollingStateNode* m_parent;
    OwnPtr<Vector<OwnPtr<ScrollingStateNode> > > m_children;

#if PLATFORM(MAC)
    RetainPtr<PlatformLayer> m_platformScrollLayer;
#endif
    GraphicsLayer* m_graphicsLayer;

};

} // namespace WebCore

#endif // ENABLE(THREADED_SCROLLING) || USE(COORDINATED_GRAPHICS)

#endif // ScrollingStateNode_h