#ifndef ScrollingTree_h
#define ScrollingTree_h
#if ENABLE(ASYNC_SCROLLING)
#include "PlatformWheelEvent.h"
#include "Region.h"
#include "ScrollingCoordinator.h"
#include <wtf/Functional.h>
#include <wtf/HashMap.h>
#include <wtf/OwnPtr.h>
#include <wtf/PassOwnPtr.h>
#include <wtf/ThreadSafeRefCounted.h>
namespace WebCore {
class IntPoint;
class ScrollingStateTree;
class ScrollingStateNode;
class ScrollingTreeNode;
class ScrollingTreeScrollingNode;
class ScrollingTree : public ThreadSafeRefCounted<ScrollingTree> {
public:
ScrollingTree();
virtual ~ScrollingTree();
enum EventResult {
DidNotHandleEvent,
DidHandleEvent,
SendToMainThread
};
virtual bool isThreadedScrollingTree() const { return false; }
virtual bool isRemoteScrollingTree() const { return false; }
virtual bool isScrollingTreeIOS() const { return false; }
virtual EventResult tryToHandleWheelEvent(const PlatformWheelEvent&) = 0;
bool shouldHandleWheelEventSynchronously(const PlatformWheelEvent&);
void setMainFrameIsRubberBanding(bool);
bool isRubberBandInProgress();
virtual void invalidate() { }
virtual void commitNewTreeState(PassOwnPtr<ScrollingStateTree>);
void setMainFramePinState(bool pinnedToTheLeft, bool pinnedToTheRight, bool pinnedToTheTop, bool pinnedToTheBottom);
virtual PassRefPtr<ScrollingTreeNode> createScrollingTreeNode(ScrollingNodeType, ScrollingNodeID) = 0;
virtual void scrollingTreeNodeDidScroll(ScrollingNodeID, const FloatPoint& scrollPosition, SetOrSyncScrollingLayerPosition = SyncScrollingLayerPosition) = 0;
virtual void scrollingTreeNodeRequestsScroll(ScrollingNodeID, const FloatPoint& , bool ) { }
virtual void viewportChangedViaDelegatedScrolling(ScrollingNodeID, const WebCore::FloatRect& fixedPositionRect, double scale);
virtual void scrollPositionChangedViaDelegatedScrolling(ScrollingNodeID, const WebCore::FloatPoint& scrollPosition, bool inUserInteration);
FloatPoint mainFrameScrollPosition();
#if PLATFORM(IOS)
virtual FloatRect fixedPositionRect() = 0;
virtual void scrollingTreeNodeWillStartPanGesture() { }
virtual void scrollingTreeNodeWillStartScroll() { }
virtual void scrollingTreeNodeDidEndScroll() { }
#endif
bool isPointInNonFastScrollableRegion(IntPoint);
#if PLATFORM(MAC)
virtual void handleWheelEventPhase(PlatformWheelEventPhase) = 0;
#endif
void setCanRubberBandState(bool canRubberBandAtLeft, bool canRubberBandAtRight, bool canRubberBandAtTop, bool canRubberBandAtBottom);
bool rubberBandsAtLeft();
bool rubberBandsAtRight();
bool rubberBandsAtTop();
bool rubberBandsAtBottom();
bool isHandlingProgrammaticScroll();
void setScrollPinningBehavior(ScrollPinningBehavior);
ScrollPinningBehavior scrollPinningBehavior();
bool willWheelEventStartSwipeGesture(const PlatformWheelEvent&);
void setScrollingPerformanceLoggingEnabled(bool flag);
bool scrollingPerformanceLoggingEnabled();
ScrollingTreeNode* rootNode() const { return m_rootNode.get(); }
ScrollingNodeID latchedNode();
void setLatchedNode(ScrollingNodeID);
void clearLatchedNode();
bool hasLatchedNode() const { return m_latchedNode; }
void setOrClearLatchedNode(const PlatformWheelEvent&, ScrollingNodeID);
bool hasFixedOrSticky() const { return !!m_fixedOrStickyNodeCount; }
void fixedOrStickyNodeAdded() { ++m_fixedOrStickyNodeCount; }
void fixedOrStickyNodeRemoved()
{
ASSERT(m_fixedOrStickyNodeCount);
--m_fixedOrStickyNodeCount;
}
protected:
void setMainFrameScrollPosition(FloatPoint);
virtual void handleWheelEvent(const PlatformWheelEvent&);
private:
void removeDestroyedNodes(const ScrollingStateTree&);
typedef HashMap<ScrollingNodeID, RefPtr<ScrollingTreeNode>> OrphanScrollingNodeMap;
void updateTreeFromStateNode(const ScrollingStateNode*, OrphanScrollingNodeMap&);
ScrollingTreeNode* nodeForID(ScrollingNodeID) const;
RefPtr<ScrollingTreeNode> m_rootNode;
typedef HashMap<ScrollingNodeID, ScrollingTreeNode*> ScrollingTreeNodeMap;
ScrollingTreeNodeMap m_nodeMap;
Mutex m_mutex;
Region m_nonFastScrollableRegion;
FloatPoint m_mainFrameScrollPosition;
bool m_hasWheelEventHandlers;
Mutex m_swipeStateMutex;
bool m_rubberBandsAtLeft;
bool m_rubberBandsAtRight;
bool m_rubberBandsAtTop;
bool m_rubberBandsAtBottom;
bool m_mainFramePinnedToTheLeft;
bool m_mainFramePinnedToTheRight;
bool m_mainFramePinnedToTheTop;
bool m_mainFramePinnedToTheBottom;
bool m_mainFrameIsRubberBanding;
ScrollPinningBehavior m_scrollPinningBehavior;
ScrollingNodeID m_latchedNode;
bool m_scrollingPerformanceLoggingEnabled;
bool m_isHandlingProgrammaticScroll;
unsigned m_fixedOrStickyNodeCount;
};
#define SCROLLING_TREE_TYPE_CASTS(ToValueTypeName, predicate) \
TYPE_CASTS_BASE(ToValueTypeName, WebCore::ScrollingTree, value, value->predicate, value.predicate)
}
#endif // ENABLE(ASYNC_SCROLLING)
#endif // ScrollingTree_h