a7947ff628d44eeef85bd3ca0a32ee28c003acc0
[WebKit-https.git] / Source / WebCore / page / scrolling / mac / ScrollingTreeFrameScrollingNodeMac.h
1 /*
2  * Copyright (C) 2012, 2014-2015 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #if ENABLE(ASYNC_SCROLLING) && PLATFORM(MAC)
29
30 #include "ScrollController.h"
31 #include "ScrollbarThemeMac.h"
32 #include "ScrollingTreeFrameScrollingNode.h"
33 #include <wtf/RetainPtr.h>
34
35 OBJC_CLASS CALayer;
36
37 namespace WebCore {
38
39 class ScrollingTreeFrameScrollingNodeMac : public ScrollingTreeFrameScrollingNode, private ScrollControllerClient {
40 public:
41     WEBCORE_EXPORT static Ref<ScrollingTreeFrameScrollingNode> create(ScrollingTree&, ScrollingNodeID);
42     virtual ~ScrollingTreeFrameScrollingNodeMac();
43
44 private:
45     ScrollingTreeFrameScrollingNodeMac(ScrollingTree&, ScrollingNodeID);
46
47     void releaseReferencesToScrollerImpsOnTheMainThread();
48
49     // ScrollingTreeNode member functions.
50     void commitStateBeforeChildren(const ScrollingStateNode&) override;
51     void commitStateAfterChildren(const ScrollingStateNode&) override;
52
53     void handleWheelEvent(const PlatformWheelEvent&) override;
54
55     // ScrollController member functions.
56     bool allowsHorizontalStretching(const PlatformWheelEvent&) override;
57     bool allowsVerticalStretching(const PlatformWheelEvent&) override;
58     IntSize stretchAmount() override;
59     bool pinnedInDirection(const FloatSize&) override;
60     bool canScrollHorizontally() override;
61     bool canScrollVertically() override;
62     bool shouldRubberBandInDirection(ScrollDirection) override;
63     void immediateScrollBy(const FloatSize&) override;
64     void immediateScrollByWithoutContentEdgeConstraints(const FloatSize&) override;
65     void stopSnapRubberbandTimer() override;
66     void adjustScrollPositionToBoundsIfNecessary() override;
67
68     FloatPoint scrollPosition() const override;
69     void setScrollPosition(const FloatPoint&) override;
70     void setScrollPositionWithoutContentEdgeConstraints(const FloatPoint&) override;
71
72     void updateLayersAfterViewportChange(const FloatRect& fixedPositionRect, double scale) override;
73
74     void setScrollLayerPosition(const FloatPoint&, const FloatRect& layoutViewport) override;
75
76     FloatPoint minimumScrollPosition() const override;
77     FloatPoint maximumScrollPosition() const override;
78
79     void updateMainFramePinState(const FloatPoint& scrollPosition);
80
81     bool isAlreadyPinnedInDirectionOfGesture(const PlatformWheelEvent&, ScrollEventAxis);
82
83     void deferTestsForReason(WheelEventTestTrigger::ScrollableAreaIdentifier, WheelEventTestTrigger::DeferTestTriggerReason) const override;
84     void removeTestDeferralForReason(WheelEventTestTrigger::ScrollableAreaIdentifier, WheelEventTestTrigger::DeferTestTriggerReason) const override;
85
86 #if ENABLE(CSS_SCROLL_SNAP) && PLATFORM(MAC)
87     LayoutUnit scrollOffsetOnAxis(ScrollEventAxis) const override;
88     void immediateScrollOnAxis(ScrollEventAxis, float delta) override;
89     float pageScaleFactor() const override;
90     void startScrollSnapTimer() override;
91     void stopScrollSnapTimer() override;
92     LayoutSize scrollExtent() const override;
93 #endif
94
95     void logExposedUnfilledArea();
96
97     ScrollController m_scrollController;
98
99     RetainPtr<CALayer> m_scrollLayer;
100     RetainPtr<CALayer> m_scrolledContentsLayer;
101     RetainPtr<CALayer> m_counterScrollingLayer;
102     RetainPtr<CALayer> m_insetClipLayer;
103     RetainPtr<CALayer> m_contentShadowLayer;
104     RetainPtr<CALayer> m_headerLayer;
105     RetainPtr<CALayer> m_footerLayer;
106     RetainPtr<NSScrollerImp> m_verticalScrollerImp;
107     RetainPtr<NSScrollerImp> m_horizontalScrollerImp;
108     FloatPoint m_probableMainThreadScrollPosition;
109     bool m_lastScrollHadUnfilledPixels { false };
110     bool m_hadFirstUpdate { false };
111     bool m_expectsWheelEventTestTrigger { false };
112 };
113
114 } // namespace WebCore
115
116 #endif // ENABLE(ASYNC_SCROLLING) && PLATFORM(MAC)