blob: e3d768bfbc62ca94cdb11feeb89516dc434636ea [file] [log] [blame]
/*
* Copyright (C) 2012, 2014-2015 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.
*/
#pragma once
#if ENABLE(ASYNC_SCROLLING)
#include "ScrollSnapOffsetsInfo.h"
#include "ScrollTypes.h"
#include "ScrollingCoordinator.h"
#include "ScrollingStateNode.h"
#if PLATFORM(COCOA)
OBJC_CLASS NSScrollerImp;
#endif
namespace WebCore {
struct RequestedScrollData {
FloatPoint scrollPosition;
ScrollType scrollType { ScrollType::User };
ScrollClamping clamping { ScrollClamping::Clamped };
bool operator==(const RequestedScrollData& other) const
{
return scrollPosition == other.scrollPosition
&& scrollType == other.scrollType
&& clamping == other.clamping;
}
};
class ScrollingStateScrollingNode : public ScrollingStateNode {
public:
virtual ~ScrollingStateScrollingNode();
enum ChangedProperty {
ScrollableAreaSize = NumStateNodeBits,
TotalContentsSize,
ReachableContentsSize,
ScrollPosition,
ScrollOrigin,
ScrollableAreaParams,
#if ENABLE(SCROLLING_THREAD)
ReasonsForSynchronousScrolling,
#endif
RequestedScrollPosition,
#if ENABLE(CSS_SCROLL_SNAP)
HorizontalSnapOffsets,
VerticalSnapOffsets,
HorizontalSnapOffsetRanges,
VerticalSnapOffsetRanges,
CurrentHorizontalSnapOffsetIndex,
CurrentVerticalSnapOffsetIndex,
#endif
IsMonitoringWheelEvents,
ScrollContainerLayer,
ScrolledContentsLayer,
HorizontalScrollbarLayer,
VerticalScrollbarLayer,
PainterForScrollbar,
NumScrollingStateNodeBits // This must remain at the last position.
};
const FloatSize& scrollableAreaSize() const { return m_scrollableAreaSize; }
WEBCORE_EXPORT void setScrollableAreaSize(const FloatSize&);
const FloatSize& totalContentsSize() const { return m_totalContentsSize; }
WEBCORE_EXPORT void setTotalContentsSize(const FloatSize&);
const FloatSize& reachableContentsSize() const { return m_reachableContentsSize; }
WEBCORE_EXPORT void setReachableContentsSize(const FloatSize&);
const FloatPoint& scrollPosition() const { return m_scrollPosition; }
WEBCORE_EXPORT void setScrollPosition(const FloatPoint&);
const IntPoint& scrollOrigin() const { return m_scrollOrigin; }
WEBCORE_EXPORT void setScrollOrigin(const IntPoint&);
#if ENABLE(CSS_SCROLL_SNAP)
const Vector<float>& horizontalSnapOffsets() const { return m_snapOffsetsInfo.horizontalSnapOffsets; }
WEBCORE_EXPORT void setHorizontalSnapOffsets(const Vector<float>&);
const Vector<float>& verticalSnapOffsets() const { return m_snapOffsetsInfo.verticalSnapOffsets; }
WEBCORE_EXPORT void setVerticalSnapOffsets(const Vector<float>&);
const Vector<ScrollOffsetRange<float>>& horizontalSnapOffsetRanges() const { return m_snapOffsetsInfo.horizontalSnapOffsetRanges; }
WEBCORE_EXPORT void setHorizontalSnapOffsetRanges(const Vector<ScrollOffsetRange<float>>&);
const Vector<ScrollOffsetRange<float>>& verticalSnapOffsetRanges() const { return m_snapOffsetsInfo.verticalSnapOffsetRanges; }
WEBCORE_EXPORT void setVerticalSnapOffsetRanges(const Vector<ScrollOffsetRange<float>>&);
unsigned currentHorizontalSnapPointIndex() const { return m_currentHorizontalSnapPointIndex; }
WEBCORE_EXPORT void setCurrentHorizontalSnapPointIndex(unsigned);
unsigned currentVerticalSnapPointIndex() const { return m_currentVerticalSnapPointIndex; }
WEBCORE_EXPORT void setCurrentVerticalSnapPointIndex(unsigned);
#endif
const ScrollableAreaParameters& scrollableAreaParameters() const { return m_scrollableAreaParameters; }
WEBCORE_EXPORT void setScrollableAreaParameters(const ScrollableAreaParameters& params);
#if ENABLE(SCROLLING_THREAD)
OptionSet<SynchronousScrollingReason> synchronousScrollingReasons() const { return m_synchronousScrollingReasons; }
WEBCORE_EXPORT void setSynchronousScrollingReasons(OptionSet<SynchronousScrollingReason>);
#endif
const RequestedScrollData& requestedScrollData() const { return m_requestedScrollData; }
WEBCORE_EXPORT void setRequestedScrollData(const RequestedScrollData&);
bool isMonitoringWheelEvents() const { return m_isMonitoringWheelEvents; }
WEBCORE_EXPORT void setIsMonitoringWheelEvents(bool);
const LayerRepresentation& scrollContainerLayer() const { return m_scrollContainerLayer; }
WEBCORE_EXPORT void setScrollContainerLayer(const LayerRepresentation&);
// This is a layer with the contents that move.
const LayerRepresentation& scrolledContentsLayer() const { return m_scrolledContentsLayer; }
WEBCORE_EXPORT void setScrolledContentsLayer(const LayerRepresentation&);
const LayerRepresentation& horizontalScrollbarLayer() const { return m_horizontalScrollbarLayer; }
WEBCORE_EXPORT void setHorizontalScrollbarLayer(const LayerRepresentation&);
const LayerRepresentation& verticalScrollbarLayer() const { return m_verticalScrollbarLayer; }
WEBCORE_EXPORT void setVerticalScrollbarLayer(const LayerRepresentation&);
#if PLATFORM(MAC)
NSScrollerImp *verticalScrollerImp() const { return m_verticalScrollerImp.get(); }
NSScrollerImp *horizontalScrollerImp() const { return m_horizontalScrollerImp.get(); }
#endif
void setScrollerImpsFromScrollbars(Scrollbar* verticalScrollbar, Scrollbar* horizontalScrollbar);
protected:
ScrollingStateScrollingNode(ScrollingStateTree&, ScrollingNodeType, ScrollingNodeID);
ScrollingStateScrollingNode(const ScrollingStateScrollingNode&, ScrollingStateTree&);
void setPropertyChangedBitsAfterReattach() override;
void dumpProperties(WTF::TextStream&, ScrollingStateTreeAsTextBehavior) const override;
private:
FloatSize m_scrollableAreaSize;
FloatSize m_totalContentsSize;
FloatSize m_reachableContentsSize;
FloatPoint m_scrollPosition;
IntPoint m_scrollOrigin;
#if ENABLE(CSS_SCROLL_SNAP)
ScrollSnapOffsetsInfo<float> m_snapOffsetsInfo;
unsigned m_currentHorizontalSnapPointIndex { 0 };
unsigned m_currentVerticalSnapPointIndex { 0 };
#endif
LayerRepresentation m_scrollContainerLayer;
LayerRepresentation m_scrolledContentsLayer;
LayerRepresentation m_horizontalScrollbarLayer;
LayerRepresentation m_verticalScrollbarLayer;
#if PLATFORM(MAC)
RetainPtr<NSScrollerImp> m_verticalScrollerImp;
RetainPtr<NSScrollerImp> m_horizontalScrollerImp;
#endif
ScrollableAreaParameters m_scrollableAreaParameters;
RequestedScrollData m_requestedScrollData;
#if ENABLE(SCROLLING_THREAD)
OptionSet<SynchronousScrollingReason> m_synchronousScrollingReasons;
#endif
bool m_isMonitoringWheelEvents { false };
};
} // namespace WebCore
SPECIALIZE_TYPE_TRAITS_SCROLLING_STATE_NODE(ScrollingStateScrollingNode, isScrollingNode())
#endif // ENABLE(ASYNC_SCROLLING)