ScrollingStateNode.h [plain text]
#ifndef ScrollingStateNode_h
#define ScrollingStateNode_h
#if ENABLE(ASYNC_SCROLLING) || USE(COORDINATED_GRAPHICS)
#include "GraphicsLayer.h"
#include "ScrollingCoordinator.h"
#include <wtf/RefCounted.h>
#include <wtf/TypeCasts.h>
#include <wtf/Vector.h>
namespace WebCore {
class GraphicsLayer;
class ScrollingStateTree;
class TextStream;
class LayerRepresentation {
public:
enum Type {
EmptyRepresentation,
GraphicsLayerRepresentation,
PlatformLayerRepresentation,
PlatformLayerIDRepresentation
};
LayerRepresentation()
: m_graphicsLayer(nullptr)
, m_layerID(0)
, m_representation(EmptyRepresentation)
{ }
LayerRepresentation(GraphicsLayer* graphicsLayer)
: m_graphicsLayer(graphicsLayer)
, m_layerID(graphicsLayer ? graphicsLayer->primaryLayerID() : 0)
, m_representation(GraphicsLayerRepresentation)
{ }
LayerRepresentation(PlatformLayer* platformLayer)
: m_platformLayer(platformLayer)
, m_layerID(0)
, m_representation(PlatformLayerRepresentation)
{
retainPlatformLayer(platformLayer);
}
LayerRepresentation(GraphicsLayer::PlatformLayerID layerID)
: m_graphicsLayer(nullptr)
, m_layerID(layerID)
, m_representation(PlatformLayerIDRepresentation)
{
}
LayerRepresentation(const LayerRepresentation& other)
: m_platformLayer(other.m_platformLayer)
, m_layerID(other.m_layerID)
, m_representation(other.m_representation)
{
if (m_representation == PlatformLayerRepresentation)
retainPlatformLayer(m_platformLayer);
}
~LayerRepresentation()
{
if (m_representation == PlatformLayerRepresentation)
releasePlatformLayer(m_platformLayer);
}
operator GraphicsLayer*() const
{
ASSERT(m_representation == GraphicsLayerRepresentation);
return m_graphicsLayer;
}
operator PlatformLayer*() const
{
ASSERT(m_representation == PlatformLayerRepresentation);
return m_platformLayer;
}
GraphicsLayer::PlatformLayerID layerID() const
{
return m_layerID;
}
operator GraphicsLayer::PlatformLayerID() const
{
ASSERT(m_representation != PlatformLayerRepresentation);
return m_layerID;
}
LayerRepresentation& operator=(const LayerRepresentation& other)
{
m_platformLayer = other.m_platformLayer;
m_layerID = other.m_layerID;
m_representation = other.m_representation;
if (m_representation == PlatformLayerRepresentation)
retainPlatformLayer(m_platformLayer);
return *this;
}
bool operator==(const LayerRepresentation& other) const
{
if (m_representation != other.m_representation)
return false;
switch (m_representation) {
case EmptyRepresentation:
return true;
case GraphicsLayerRepresentation:
return m_graphicsLayer == other.m_graphicsLayer
&& m_layerID == other.m_layerID;
case PlatformLayerRepresentation:
return m_platformLayer == other.m_platformLayer;
case PlatformLayerIDRepresentation:
return m_layerID == other.m_layerID;
}
ASSERT_NOT_REACHED();
return true;
}
LayerRepresentation toRepresentation(Type representation) const
{
switch (representation) {
case EmptyRepresentation:
return LayerRepresentation();
case GraphicsLayerRepresentation:
ASSERT(m_representation == GraphicsLayerRepresentation);
return *this;
case PlatformLayerRepresentation:
return m_graphicsLayer ? m_graphicsLayer->platformLayer() : nullptr;
case PlatformLayerIDRepresentation:
return LayerRepresentation(m_layerID);
}
return LayerRepresentation();
}
bool representsGraphicsLayer() const { return m_representation == GraphicsLayerRepresentation; }
bool representsPlatformLayerID() const { return m_representation == PlatformLayerIDRepresentation; }
private:
WEBCORE_EXPORT void retainPlatformLayer(PlatformLayer*);
WEBCORE_EXPORT void releasePlatformLayer(PlatformLayer*);
union {
GraphicsLayer* m_graphicsLayer;
PlatformLayer *m_platformLayer;
};
GraphicsLayer::PlatformLayerID m_layerID;
Type m_representation;
};
class ScrollingStateNode : public RefCounted<ScrollingStateNode> {
WTF_MAKE_FAST_ALLOCATED;
public:
ScrollingStateNode(ScrollingNodeType, ScrollingStateTree&, ScrollingNodeID);
virtual ~ScrollingStateNode();
ScrollingNodeType nodeType() const { return m_nodeType; }
bool isFixedNode() const { return m_nodeType == FixedNode; }
bool isStickyNode() const { return m_nodeType == StickyNode; }
bool isScrollingNode() const { return m_nodeType == FrameScrollingNode || m_nodeType == OverflowScrollingNode; }
bool isFrameScrollingNode() const { return m_nodeType == FrameScrollingNode; }
bool isOverflowScrollingNode() const { return m_nodeType == OverflowScrollingNode; }
virtual Ref<ScrollingStateNode> clone(ScrollingStateTree& adoptiveTree) = 0;
PassRefPtr<ScrollingStateNode> cloneAndReset(ScrollingStateTree& adoptiveTree);
void cloneAndResetChildren(ScrollingStateNode&, ScrollingStateTree& adoptiveTree);
enum {
ScrollLayer = 0,
NumStateNodeBits = 1
};
typedef unsigned ChangedProperties;
bool hasChangedProperties() const { return m_changedProperties; }
bool hasChangedProperty(unsigned propertyBit) const { return m_changedProperties & (1 << propertyBit); }
void resetChangedProperties() { m_changedProperties = 0; }
void setPropertyChanged(unsigned propertyBit);
ChangedProperties changedProperties() const { return m_changedProperties; }
void setChangedProperties(ChangedProperties changedProperties) { m_changedProperties = changedProperties; }
virtual void syncLayerPositionForViewportRect(const LayoutRect& ) { }
const LayerRepresentation& layer() const { return m_layer; }
WEBCORE_EXPORT void setLayer(const LayerRepresentation&);
ScrollingStateTree& scrollingStateTree() const { return m_scrollingStateTree; }
ScrollingNodeID scrollingNodeID() const { return m_nodeID; }
ScrollingStateNode* parent() const { return m_parent; }
void setParent(ScrollingStateNode* parent) { m_parent = parent; }
ScrollingNodeID parentNodeID() const { return m_parent ? m_parent->scrollingNodeID() : 0; }
Vector<RefPtr<ScrollingStateNode>>* children() const { return m_children.get(); }
void appendChild(PassRefPtr<ScrollingStateNode>);
String scrollingStateTreeAsText() const;
protected:
ScrollingStateNode(const ScrollingStateNode&, ScrollingStateTree&);
private:
void dump(TextStream&, int indent) const;
virtual void dumpProperties(TextStream&, int indent) const = 0;
const ScrollingNodeType m_nodeType;
ScrollingNodeID m_nodeID;
ChangedProperties m_changedProperties;
ScrollingStateTree& m_scrollingStateTree;
ScrollingStateNode* m_parent;
std::unique_ptr<Vector<RefPtr<ScrollingStateNode>>> m_children;
LayerRepresentation m_layer;
};
}
#define SPECIALIZE_TYPE_TRAITS_SCROLLING_STATE_NODE(ToValueTypeName, predicate) \
SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::ToValueTypeName) \
static bool isType(const WebCore::ScrollingStateNode& node) { return node.predicate; } \
SPECIALIZE_TYPE_TRAITS_END()
#endif // ENABLE(ASYNC_SCROLLING) || USE(COORDINATED_GRAPHICS)
#endif // ScrollingStateNode_h