Remove remnants of iOS WK1 scrolling tree code
[WebKit-https.git] / Source / WebCore / page / scrolling / ScrollingTreeFrameScrollingNode.h
1 /*
2  * Copyright (C) 2014 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)
29
30 #include "ScrollingTreeScrollingNode.h"
31
32 namespace WebCore {
33
34 class PlatformWheelEvent;
35 class ScrollingTree;
36 class ScrollingStateScrollingNode;
37
38 class WEBCORE_EXPORT ScrollingTreeFrameScrollingNode : public ScrollingTreeScrollingNode {
39 public:
40     virtual ~ScrollingTreeFrameScrollingNode();
41
42     void commitStateBeforeChildren(const ScrollingStateNode&) override;
43     
44     // FIXME: We should implement this when we support ScrollingTreeScrollingNodes as children.
45     void updateLayersAfterAncestorChange(const ScrollingTreeNode& /*changedNode*/, const FloatRect& /*fixedPositionRect*/, const FloatSize& /*cumulativeDelta*/) override { }
46
47     void updateLayersAfterViewportChange(const FloatRect& fixedPositionRect, double scale) override = 0;
48     void updateLayersAfterDelegatedScroll(const FloatPoint&) override { }
49
50     SynchronousScrollingReasons synchronousScrollingReasons() const { return m_synchronousScrollingReasons; }
51     bool shouldUpdateScrollLayerPositionSynchronously() const { return m_synchronousScrollingReasons; }
52     bool fixedElementsLayoutRelativeToFrame() const { return m_fixedElementsLayoutRelativeToFrame; }
53
54     FloatSize viewToContentsOffset(const FloatPoint& scrollPosition) const;
55     FloatRect layoutViewportForScrollPosition(const FloatPoint& visibleContentOrigin, float scale) const;
56
57     FloatRect fixedPositionRect() { return FloatRect(lastCommittedScrollPosition(), scrollableAreaSize()); };
58
59     float frameScaleFactor() const { return m_frameScaleFactor; }
60
61 protected:
62     ScrollingTreeFrameScrollingNode(ScrollingTree&, ScrollingNodeType, ScrollingNodeID);
63
64     int headerHeight() const { return m_headerHeight; }
65     int footerHeight() const { return m_footerHeight; }
66     float topContentInset() const { return m_topContentInset; }
67
68     FloatRect layoutViewport() const { return m_layoutViewport; };
69     void setLayoutViewport(const FloatRect& r) { m_layoutViewport = r; };
70
71     FloatPoint minLayoutViewportOrigin() const { return m_minLayoutViewportOrigin; }
72     FloatPoint maxLayoutViewportOrigin() const { return m_maxLayoutViewportOrigin; }
73
74     ScrollBehaviorForFixedElements scrollBehaviorForFixedElements() const { return m_behaviorForFixed; }
75
76 private:
77     LayoutPoint parentToLocalPoint(LayoutPoint) const final;
78     LayoutPoint localToContentsPoint(LayoutPoint) const final;
79
80     void dumpProperties(WTF::TextStream&, ScrollingStateTreeAsTextBehavior) const override;
81
82     FloatRect m_layoutViewport;
83     FloatPoint m_minLayoutViewportOrigin;
84     FloatPoint m_maxLayoutViewportOrigin;
85     
86     float m_frameScaleFactor { 1 };
87     float m_topContentInset { 0 };
88
89     int m_headerHeight { 0 };
90     int m_footerHeight { 0 };
91     
92     SynchronousScrollingReasons m_synchronousScrollingReasons { 0 };
93     ScrollBehaviorForFixedElements m_behaviorForFixed { StickToDocumentBounds };
94     
95     bool m_fixedElementsLayoutRelativeToFrame { false };
96 };
97
98 } // namespace WebCore
99
100 SPECIALIZE_TYPE_TRAITS_SCROLLING_NODE(ScrollingTreeFrameScrollingNode, isFrameScrollingNode())
101
102 #endif // ENABLE(ASYNC_SCROLLING)