[Mac] Implement basic hit testing in the scrolling tree
[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 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     ScrollingEventResult handleWheelEvent(const PlatformWheelEvent&) override = 0;
48     void setScrollPosition(const FloatPoint&) override;
49     void setScrollPositionWithoutContentEdgeConstraints(const FloatPoint&) override = 0;
50
51     void updateLayersAfterViewportChange(const FloatRect& fixedPositionRect, double scale) override = 0;
52     void updateLayersAfterDelegatedScroll(const FloatPoint&) override { }
53
54     SynchronousScrollingReasons synchronousScrollingReasons() const { return m_synchronousScrollingReasons; }
55     bool shouldUpdateScrollLayerPositionSynchronously() const { return m_synchronousScrollingReasons; }
56     bool fixedElementsLayoutRelativeToFrame() const { return m_fixedElementsLayoutRelativeToFrame; }
57
58     FloatSize viewToContentsOffset(const FloatPoint& scrollPosition) const;
59     FloatRect layoutViewportForScrollPosition(const FloatPoint& visibleContentOrigin, float scale) const;
60
61     FloatRect fixedPositionRect() { return FloatRect(lastCommittedScrollPosition(), scrollableAreaSize()); };
62
63 protected:
64     ScrollingTreeFrameScrollingNode(ScrollingTree&, ScrollingNodeType, ScrollingNodeID);
65
66     void scrollBy(const FloatSize&);
67     void scrollByWithoutContentEdgeConstraints(const FloatSize&);
68
69     float frameScaleFactor() const { return m_frameScaleFactor; }
70     int headerHeight() const { return m_headerHeight; }
71     int footerHeight() const { return m_footerHeight; }
72     float topContentInset() const { return m_topContentInset; }
73
74     FloatRect layoutViewport() const { return m_layoutViewport; };
75     void setLayoutViewport(const FloatRect& r) { m_layoutViewport = r; };
76
77     FloatPoint minLayoutViewportOrigin() const { return m_minLayoutViewportOrigin; }
78     FloatPoint maxLayoutViewportOrigin() const { return m_maxLayoutViewportOrigin; }
79
80     ScrollBehaviorForFixedElements scrollBehaviorForFixedElements() const { return m_behaviorForFixed; }
81
82 private:
83     WEBCORE_EXPORT LayoutPoint parentToLocalPoint(LayoutPoint) const final;
84     WEBCORE_EXPORT LayoutPoint localToContentsPoint(LayoutPoint) const final;
85
86     WEBCORE_EXPORT void dumpProperties(WTF::TextStream&, ScrollingStateTreeAsTextBehavior) const override;
87
88     FloatRect m_layoutViewport;
89     FloatPoint m_minLayoutViewportOrigin;
90     FloatPoint m_maxLayoutViewportOrigin;
91     
92     float m_frameScaleFactor { 1 };
93     float m_topContentInset { 0 };
94
95     int m_headerHeight { 0 };
96     int m_footerHeight { 0 };
97     
98     SynchronousScrollingReasons m_synchronousScrollingReasons { 0 };
99     ScrollBehaviorForFixedElements m_behaviorForFixed { StickToDocumentBounds };
100     
101     bool m_fixedElementsLayoutRelativeToFrame { false };
102 };
103
104 } // namespace WebCore
105
106 SPECIALIZE_TYPE_TRAITS_SCROLLING_NODE(ScrollingTreeFrameScrollingNode, isFrameScrollingNode())
107
108 #endif // ENABLE(ASYNC_SCROLLING)