#pragma once
#include "RectEdges.h"
#include "ScrollSnapOffsetsInfo.h"
#include "ScrollTypes.h"
#include "Scrollbar.h"
#include <wtf/Forward.h>
#include <wtf/WeakPtr.h>
namespace WTF {
class TextStream;
}
namespace WebCore {
class FloatPoint;
class GraphicsContext;
class LayoutPoint;
class LayoutSize;
class PlatformTouchEvent;
class PlatformWheelEvent;
class ScrollAnimator;
class GraphicsLayer;
class TiledBacking;
enum class WheelScrollGestureState : uint8_t;
inline int offsetForOrientation(ScrollOffset offset, ScrollbarOrientation orientation)
{
switch (orientation) {
case HorizontalScrollbar: return offset.x();
case VerticalScrollbar: return offset.y();
}
ASSERT_NOT_REACHED();
return 0;
}
class ScrollableArea : public CanMakeWeakPtr<ScrollableArea> {
public:
virtual bool isScrollView() const { return false; }
virtual bool isRenderLayer() const { return false; }
virtual bool isListBox() const { return false; }
virtual bool isPDFPlugin() const { return false; }
ScrollBehaviorStatus currentScrollBehaviorStatus() { return static_cast<ScrollBehaviorStatus>(m_currentScrollBehaviorStatus); }
void setScrollBehaviorStatus(ScrollBehaviorStatus status) { m_currentScrollBehaviorStatus = static_cast<unsigned>(status); }
WEBCORE_EXPORT bool scroll(ScrollDirection, ScrollGranularity, float multiplier = 1);
WEBCORE_EXPORT void scrollToOffsetWithAnimation(const FloatPoint&, ScrollClamping = ScrollClamping::Clamped);
WEBCORE_EXPORT void scrollToOffsetWithoutAnimation(const FloatPoint&, ScrollClamping = ScrollClamping::Clamped);
void scrollToOffsetWithoutAnimation(ScrollbarOrientation, float offset);
WEBCORE_EXPORT void notifyScrollPositionChanged(const ScrollPosition&);
virtual bool requestScrollPositionUpdate(const ScrollPosition&, ScrollType = ScrollType::User, ScrollClamping = ScrollClamping::Clamped) { return false; }
WEBCORE_EXPORT virtual bool handleWheelEventForScrolling(const PlatformWheelEvent&, Optional<WheelScrollGestureState>);
bool usesScrollSnap() const;
#if ENABLE(CSS_SCROLL_SNAP)
WEBCORE_EXPORT const Vector<LayoutUnit>* horizontalSnapOffsets() const;
WEBCORE_EXPORT const Vector<LayoutUnit>* verticalSnapOffsets() const;
WEBCORE_EXPORT const Vector<ScrollOffsetRange<LayoutUnit>>* horizontalSnapOffsetRanges() const;
WEBCORE_EXPORT const Vector<ScrollOffsetRange<LayoutUnit>>* verticalSnapOffsetRanges() const;
virtual void updateSnapOffsets() { };
void setHorizontalSnapOffsets(const Vector<LayoutUnit>&);
void setVerticalSnapOffsets(const Vector<LayoutUnit>&);
void setHorizontalSnapOffsetRanges(const Vector<ScrollOffsetRange<LayoutUnit>>&);
void setVerticalSnapOffsetRanges(const Vector<ScrollOffsetRange<LayoutUnit>>&);
void clearSnapOffsets();
void clearHorizontalSnapOffsets();
void clearVerticalSnapOffsets();
unsigned currentHorizontalSnapPointIndex() const { return m_currentHorizontalSnapPointIndex; }
void setCurrentHorizontalSnapPointIndex(unsigned index) { m_currentHorizontalSnapPointIndex = index; }
unsigned currentVerticalSnapPointIndex() const { return m_currentVerticalSnapPointIndex; }
void setCurrentVerticalSnapPointIndex(unsigned index) { m_currentVerticalSnapPointIndex = index; }
IntPoint nearestActiveSnapPoint(const IntPoint&);
#endif
void updateScrollSnapState();
#if ENABLE(TOUCH_EVENTS)
virtual bool handleTouchEvent(const PlatformTouchEvent&);
#endif
#if PLATFORM(IOS_FAMILY)
virtual void didStartScroll() { }
virtual void didEndScroll() { }
virtual void didUpdateScroll() { }
#endif
bool constrainsScrollingToContentEdge() const { return m_constrainsScrollingToContentEdge; }
void setConstrainsScrollingToContentEdge(bool constrainsScrollingToContentEdge) { m_constrainsScrollingToContentEdge = constrainsScrollingToContentEdge; }
void setVerticalScrollElasticity(ScrollElasticity scrollElasticity) { m_verticalScrollElasticity = scrollElasticity; }
ScrollElasticity verticalScrollElasticity() const { return static_cast<ScrollElasticity>(m_verticalScrollElasticity); }
void setHorizontalScrollElasticity(ScrollElasticity scrollElasticity) { m_horizontalScrollElasticity = scrollElasticity; }
ScrollElasticity horizontalScrollElasticity() const { return static_cast<ScrollElasticity>(m_horizontalScrollElasticity); }
virtual ScrollbarMode horizontalScrollbarMode() const { return ScrollbarAuto; }
virtual ScrollbarMode verticalScrollbarMode() const { return ScrollbarAuto; }
bool canHaveScrollbars() const { return horizontalScrollbarMode() != ScrollbarAlwaysOff || verticalScrollbarMode() != ScrollbarAlwaysOff; }
virtual bool horizontalScrollbarHiddenByStyle() const { return false; }
virtual bool verticalScrollbarHiddenByStyle() const { return false; }
bool allowsHorizontalScrolling() const;
bool allowsVerticalScrolling() const;
WEBCORE_EXPORT String horizontalScrollbarStateForTesting() const;
WEBCORE_EXPORT String verticalScrollbarStateForTesting() const;
bool inLiveResize() const { return m_inLiveResize; }
WEBCORE_EXPORT virtual void willStartLiveResize();
WEBCORE_EXPORT virtual void willEndLiveResize();
WEBCORE_EXPORT void contentAreaWillPaint() const;
WEBCORE_EXPORT void mouseEnteredContentArea() const;
WEBCORE_EXPORT void mouseExitedContentArea() const;
WEBCORE_EXPORT void mouseMovedInContentArea() const;
WEBCORE_EXPORT void mouseEnteredScrollbar(Scrollbar*) const;
void mouseExitedScrollbar(Scrollbar*) const;
void mouseIsDownInScrollbar(Scrollbar*, bool) const;
void contentAreaDidShow() const;
void contentAreaDidHide() const;
void lockOverlayScrollbarStateToHidden(bool shouldLockState) const;
WEBCORE_EXPORT bool scrollbarsCanBeActive() const;
WEBCORE_EXPORT virtual void didAddScrollbar(Scrollbar*, ScrollbarOrientation);
WEBCORE_EXPORT virtual void willRemoveScrollbar(Scrollbar*, ScrollbarOrientation);
WEBCORE_EXPORT virtual void contentsResized();
virtual void updateContentsSize() { }
enum class AvailableSizeChangeReason {
ScrollbarsChanged,
AreaSizeChanged
};
WEBCORE_EXPORT virtual void availableContentSizeChanged(AvailableSizeChangeReason);
bool hasOverlayScrollbars() const;
WEBCORE_EXPORT virtual void setScrollbarOverlayStyle(ScrollbarOverlayStyle);
ScrollbarOverlayStyle scrollbarOverlayStyle() const { return static_cast<ScrollbarOverlayStyle>(m_scrollbarOverlayStyle); }
void invalidateScrollbars();
bool useDarkAppearanceForScrollbars() const;
virtual ScrollingNodeID scrollingNodeID() const { return 0; }
WEBCORE_EXPORT ScrollAnimator& scrollAnimator() const;
ScrollAnimator* existingScrollAnimator() const { return m_scrollAnimator.get(); }
virtual bool isActive() const = 0;
WEBCORE_EXPORT virtual void invalidateScrollbar(Scrollbar&, const IntRect&);
virtual bool isScrollCornerVisible() const = 0;
virtual IntRect scrollCornerRect() const = 0;
WEBCORE_EXPORT virtual void invalidateScrollCorner(const IntRect&);
virtual bool forceUpdateScrollbarsOnMainThreadForPerformanceTesting() const = 0;
virtual IntRect convertFromScrollbarToContainingView(const Scrollbar& scrollbar, const IntRect& scrollbarRect) const
{
return scrollbar.Widget::convertToContainingView(scrollbarRect);
}
virtual IntRect convertFromContainingViewToScrollbar(const Scrollbar& scrollbar, const IntRect& parentRect) const
{
return scrollbar.Widget::convertFromContainingView(parentRect);
}
virtual IntPoint convertFromScrollbarToContainingView(const Scrollbar& scrollbar, const IntPoint& scrollbarPoint) const
{
return scrollbar.Widget::convertToContainingView(scrollbarPoint);
}
virtual IntPoint convertFromContainingViewToScrollbar(const Scrollbar& scrollbar, const IntPoint& parentPoint) const
{
return scrollbar.Widget::convertFromContainingView(parentPoint);
}
int horizontalScrollbarIntrusion() const;
int verticalScrollbarIntrusion() const;
WEBCORE_EXPORT IntSize scrollbarIntrusion() const;
virtual Scrollbar* horizontalScrollbar() const { return nullptr; }
virtual Scrollbar* verticalScrollbar() const { return nullptr; }
const IntPoint& scrollOrigin() const { return m_scrollOrigin; }
bool scrollOriginChanged() const { return m_scrollOriginChanged; }
virtual ScrollPosition scrollPosition() const = 0;
virtual ScrollPosition minimumScrollPosition() const;
virtual ScrollPosition maximumScrollPosition() const;
ScrollPosition constrainScrollPosition(const ScrollPosition& position) const
{
return position.constrainedBetween(minimumScrollPosition(), maximumScrollPosition());
}
WEBCORE_EXPORT ScrollOffset scrollOffset() const;
ScrollOffset maximumScrollOffset() const;
WEBCORE_EXPORT ScrollPosition scrollPositionFromOffset(ScrollOffset) const;
WEBCORE_EXPORT ScrollOffset scrollOffsetFromPosition(ScrollPosition) const;
template<typename PositionType, typename SizeType>
static PositionType scrollPositionFromOffset(PositionType offset, SizeType scrollOrigin)
{
return offset - scrollOrigin;
}
template<typename PositionType, typename SizeType>
static PositionType scrollOffsetFromPosition(PositionType position, SizeType scrollOrigin)
{
return position + scrollOrigin;
}
WEBCORE_EXPORT virtual bool scrolledToTop() const;
WEBCORE_EXPORT virtual bool scrolledToBottom() const;
WEBCORE_EXPORT virtual bool scrolledToLeft() const;
WEBCORE_EXPORT virtual bool scrolledToRight() const;
ScrollType currentScrollType() const { return static_cast<ScrollType>(m_currentScrollType); }
void setCurrentScrollType(ScrollType scrollType) { m_currentScrollType = static_cast<unsigned>(scrollType); }
bool scrollShouldClearLatchedState() const { return m_scrollShouldClearLatchedState; }
void setScrollShouldClearLatchedState(bool shouldClear) { m_scrollShouldClearLatchedState = shouldClear; }
enum VisibleContentRectIncludesScrollbars { ExcludeScrollbars, IncludeScrollbars };
enum VisibleContentRectBehavior {
ContentsVisibleRect,
#if PLATFORM(IOS_FAMILY)
LegacyIOSDocumentViewRect,
LegacyIOSDocumentVisibleRect = LegacyIOSDocumentViewRect
#else
LegacyIOSDocumentVisibleRect = ContentsVisibleRect
#endif
};
WEBCORE_EXPORT IntRect visibleContentRect(VisibleContentRectBehavior = ContentsVisibleRect) const;
WEBCORE_EXPORT IntRect visibleContentRectIncludingScrollbars(VisibleContentRectBehavior = ContentsVisibleRect) const;
int visibleWidth() const { return visibleSize().width(); }
int visibleHeight() const { return visibleSize().height(); }
virtual IntSize visibleSize() const = 0;
virtual IntSize contentsSize() const = 0;
virtual IntSize overhangAmount() const { return IntSize(); }
virtual IntPoint lastKnownMousePositionInView() const { return IntPoint(); }
virtual bool isHandlingWheelEvent() const { return false; }
virtual int headerHeight() const { return 0; }
virtual int footerHeight() const { return 0; }
WEBCORE_EXPORT IntSize totalContentsSize() const;
WEBCORE_EXPORT virtual IntSize reachableTotalContentsSize() const;
virtual bool useDarkAppearance() const { return false; }
virtual bool shouldSuspendScrollAnimations() const { return true; }
WEBCORE_EXPORT virtual void scrollbarStyleChanged(ScrollbarStyle , bool );
virtual void setVisibleScrollerThumbRect(const IntRect&) { }
virtual ScrollableArea* enclosingScrollableArea() const = 0;
virtual bool isScrollableOrRubberbandable() = 0;
virtual bool hasScrollableOrRubberbandableAncestor() = 0;
virtual IntRect scrollableAreaBoundingBox(bool* = nullptr) const = 0;
virtual bool isUserScrollInProgress() const { return false; }
virtual bool isRubberBandInProgress() const { return false; }
virtual bool isScrollSnapInProgress() const { return false; }
virtual bool scrollAnimatorEnabled() const { return false; }
WEBCORE_EXPORT void setScrollOffsetFromInternals(const ScrollOffset&);
WEBCORE_EXPORT static LayoutPoint constrainScrollPositionForOverhang(const LayoutRect& visibleContentRect, const LayoutSize& totalContentsSize, const LayoutPoint& scrollPosition, const LayoutPoint& scrollOrigin, int headerHeight, int footetHeight);
LayoutPoint constrainScrollPositionForOverhang(const LayoutPoint& scrollPosition);
WEBCORE_EXPORT static void computeScrollbarValueAndOverhang(float currentPosition, float totalSize, float visibleSize, float& doubleValue, float& overhangAmount);
bool isPinnedForScrollDeltaOnAxis(float scrollDelta, ScrollEventAxis) const;
bool isPinnedForScrollDelta(const FloatSize&) const;
RectEdges<bool> edgePinnedState() const;
virtual bool usesCompositedScrolling() const { return false; }
virtual bool usesAsyncScrolling() const { return false; }
virtual GraphicsLayer* layerForHorizontalScrollbar() const { return nullptr; }
virtual GraphicsLayer* layerForVerticalScrollbar() const { return nullptr; }
bool hasLayerForHorizontalScrollbar() const;
bool hasLayerForVerticalScrollbar() const;
void verticalScrollbarLayerDidChange();
void horizontalScrollbarLayerDidChange();
virtual bool usesMockScrollAnimator() const { return false; }
virtual void logMockScrollAnimatorMessage(const String&) const { };
virtual bool shouldPlaceBlockDirectionScrollbarOnLeft() const = 0;
virtual String debugDescription() const = 0;
virtual float pageScaleFactor() const
{
return 1.0f;
}
protected:
WEBCORE_EXPORT ScrollableArea();
WEBCORE_EXPORT virtual ~ScrollableArea();
void setScrollOrigin(const IntPoint&);
void resetScrollOriginChanged() { m_scrollOriginChanged = false; }
WEBCORE_EXPORT virtual float adjustScrollStepForFixedContent(float step, ScrollbarOrientation, ScrollGranularity);
virtual void invalidateScrollbarRect(Scrollbar&, const IntRect&) = 0;
virtual void invalidateScrollCornerRect(const IntRect&) = 0;
friend class ScrollingCoordinator;
virtual GraphicsLayer* layerForScrollCorner() const { return nullptr; }
#if ENABLE(RUBBER_BANDING)
virtual GraphicsLayer* layerForOverhangAreas() const { return nullptr; }
#endif
bool hasLayerForScrollCorner() const;
private:
WEBCORE_EXPORT virtual IntRect visibleContentRectInternal(VisibleContentRectIncludesScrollbars, VisibleContentRectBehavior) const;
void scrollPositionChanged(const ScrollPosition&);
friend class ScrollAnimator;
void setScrollOffsetFromAnimation(const ScrollOffset&);
virtual void setScrollOffset(const ScrollOffset&) = 0;
mutable std::unique_ptr<ScrollAnimator> m_scrollAnimator;
#if ENABLE(CSS_SCROLL_SNAP)
ScrollSnapOffsetsInfo<LayoutUnit>& ensureSnapOffsetsInfo();
std::unique_ptr<ScrollSnapOffsetsInfo<LayoutUnit>> m_snapOffsetsInfo;
unsigned m_currentHorizontalSnapPointIndex { 0 };
unsigned m_currentVerticalSnapPointIndex { 0 };
#endif
IntPoint m_scrollOrigin;
unsigned m_constrainsScrollingToContentEdge : 1;
unsigned m_inLiveResize : 1;
unsigned m_verticalScrollElasticity : 2; unsigned m_horizontalScrollElasticity : 2;
unsigned m_scrollbarOverlayStyle : 2;
unsigned m_scrollOriginChanged : 1;
unsigned m_currentScrollType : 1; unsigned m_scrollShouldClearLatchedState : 1;
unsigned m_currentScrollBehaviorStatus : 1;
};
WTF::TextStream& operator<<(WTF::TextStream&, const ScrollableArea&);
}