[Mac] Implement basic hit testing in the scrolling tree
[WebKit-https.git] / Source / WebKit / UIProcess / RemoteLayerTree / mac / ScrollerPairMac.mm
1 /*
2  * Copyright (C) 2019 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 #include "config.h"
27 #include "ScrollerPairMac.h"
28
29 #if PLATFORM(MAC)
30
31 #include "RemoteScrollingTree.h"
32 #include <WebCore/FloatPoint.h>
33 #include <WebCore/IntRect.h>
34 #include <WebCore/NSScrollerImpDetails.h>
35 #include <WebCore/PlatformMouseEvent.h>
36 #include <WebCore/PlatformWheelEvent.h>
37 #include <WebCore/ScrollTypes.h>
38 #include <WebCore/ScrollableArea.h>
39 #include <WebCore/ScrollingTreeScrollingNode.h>
40 #include <pal/spi/mac/NSScrollerImpSPI.h>
41
42 @interface WKScrollerImpPairDelegate : NSObject <NSScrollerImpPairDelegate> {
43     WebKit::ScrollerPairMac* _scrollerPair;
44 }
45 - (id)initWithScrollerPair:(WebKit::ScrollerPairMac*)scrollerPair;
46 @end
47
48 @implementation WKScrollerImpPairDelegate
49
50 - (id)initWithScrollerPair:(WebKit::ScrollerPairMac*)scrollerPair
51 {
52     self = [super init];
53     if (!self)
54         return nil;
55
56     _scrollerPair = scrollerPair;
57     return self;
58 }
59
60 - (void)invalidate
61 {
62     _scrollerPair = nullptr;
63 }
64
65 - (NSRect)contentAreaRectForScrollerImpPair:(NSScrollerImpPair *)scrollerImpPair
66 {
67     UNUSED_PARAM(scrollerImpPair);
68     if (!_scrollerPair)
69         return NSZeroRect;
70
71     auto size = _scrollerPair->visibleSize();
72     return NSMakeRect(0, 0, size.width(), size.height());
73 }
74
75 - (BOOL)inLiveResizeForScrollerImpPair:(NSScrollerImpPair *)scrollerImpPair
76 {
77     // FIMXE: Not implemented.
78     return NO;
79 }
80
81 - (NSPoint)mouseLocationInContentAreaForScrollerImpPair:(NSScrollerImpPair *)scrollerImpPair
82 {
83     UNUSED_PARAM(scrollerImpPair);
84     if (!_scrollerPair)
85         return NSZeroPoint;
86
87     return _scrollerPair->lastKnownMousePosition();
88 }
89
90 - (NSPoint)scrollerImpPair:(NSScrollerImpPair *)scrollerImpPair convertContentPoint:(NSPoint)pointInContentArea toScrollerImp:(NSScrollerImp *)scrollerImp
91 {
92     UNUSED_PARAM(scrollerImpPair);
93
94     if (!_scrollerPair || !scrollerImp)
95         return NSZeroPoint;
96
97     WebKit::ScrollerMac* scroller = nullptr;
98     if ([scrollerImp isHorizontal])
99         scroller = &_scrollerPair->horizontalScroller();
100     else
101         scroller = &_scrollerPair->verticalScroller();
102
103     ASSERT(scrollerImp == scroller->scrollerImp());
104
105     return scroller->convertFromContent(WebCore::IntPoint(pointInContentArea));
106 }
107
108 - (void)scrollerImpPair:(NSScrollerImpPair *)scrollerImpPair setContentAreaNeedsDisplayInRect:(NSRect)rect
109 {
110     UNUSED_PARAM(scrollerImpPair);
111     UNUSED_PARAM(rect);
112 }
113
114 - (void)scrollerImpPair:(NSScrollerImpPair *)scrollerImpPair updateScrollerStyleForNewRecommendedScrollerStyle:(NSScrollerStyle)newRecommendedScrollerStyle
115 {
116     [scrollerImpPair setScrollerStyle:newRecommendedScrollerStyle];
117 }
118
119 @end
120
121 namespace WebKit {
122
123 ScrollerPairMac::ScrollerPairMac(WebCore::ScrollingTreeScrollingNode& node)
124     : m_scrollingNode(node)
125     , m_verticalScroller(*this, ScrollerMac::Orientation::Vertical)
126     , m_horizontalScroller(*this, ScrollerMac::Orientation::Horizontal)
127 {
128     m_scrollerImpPairDelegate = adoptNS([[WKScrollerImpPairDelegate alloc] initWithScrollerPair:this]);
129
130     m_scrollerImpPair = adoptNS([[NSScrollerImpPair alloc] init]);
131     [m_scrollerImpPair.get() setDelegate:m_scrollerImpPairDelegate.get()];
132     [m_scrollerImpPair setScrollerStyle:WebCore::ScrollerStyle::recommendedScrollerStyle()];
133
134     m_verticalScroller.attach();
135     m_horizontalScroller.attach();
136 }
137
138 ScrollerPairMac::~ScrollerPairMac()
139 {
140     [m_scrollerImpPairDelegate invalidate];
141     [m_scrollerImpPair setDelegate:nil];
142 }
143
144 bool ScrollerPairMac::handleWheelEvent(const WebCore::PlatformWheelEvent& event)
145 {
146     switch (event.phase()) {
147     case WebCore::PlatformWheelEventPhaseBegan:
148         [m_scrollerImpPair beginScrollGesture];
149         break;
150     case WebCore::PlatformWheelEventPhaseEnded:
151     case WebCore::PlatformWheelEventPhaseCancelled:
152         [m_scrollerImpPair endScrollGesture];
153         break;
154     case WebCore::PlatformWheelEventPhaseMayBegin:
155         [m_scrollerImpPair beginScrollGesture];
156         [m_scrollerImpPair contentAreaScrolled];
157         break;
158     default:
159         break;
160     }
161     // FIXME: this needs to return whether the event was handled.
162     return true;
163 }
164
165 bool ScrollerPairMac::handleMouseEvent(const WebCore::PlatformMouseEvent& event)
166 {
167     if (event.type() != WebCore::PlatformEvent::MouseMoved)
168         return false;
169
170     m_lastKnownMousePosition = event.position();
171     [m_scrollerImpPair mouseMovedInContentArea];
172     // FIXME: this needs to return whether the event was handled.
173     return true;
174 }
175
176 void ScrollerPairMac::updateValues()
177 {
178     auto position = m_scrollingNode.scrollPosition();
179
180     if (position != m_lastScrollPosition) {
181         if (m_lastScrollPosition) {
182             auto delta = position - *m_lastScrollPosition;
183             [m_scrollerImpPair contentAreaScrolledInDirection:NSMakePoint(delta.width(), delta.height())];
184         }
185         m_lastScrollPosition = position;
186     }
187
188     m_verticalScroller.updateValues();
189     m_horizontalScroller.updateValues();
190 }
191
192 WebCore::FloatSize ScrollerPairMac::visibleSize() const
193 {
194     return m_scrollingNode.scrollableAreaSize();
195 }
196
197 bool ScrollerPairMac::useDarkAppearance() const
198 {
199     return m_scrollingNode.useDarkAppearanceForScrollbars();
200 }
201
202 ScrollerPairMac::Values ScrollerPairMac::valuesForOrientation(ScrollerMac::Orientation orientation)
203 {
204     float position;
205     float totalSize;
206     float visibleSize;
207     if (orientation == ScrollerMac:: Orientation::Vertical) {
208         position = m_scrollingNode.scrollPosition().y();
209         totalSize = m_scrollingNode.totalContentsSize().height();
210         visibleSize = m_scrollingNode.scrollableAreaSize().height();
211     } else {
212         position = m_scrollingNode.scrollPosition().x();
213         totalSize = m_scrollingNode.totalContentsSize().width();
214         visibleSize = m_scrollingNode.scrollableAreaSize().width();
215     }
216
217     float value;
218     float overhang;
219     WebCore::ScrollableArea::computeScrollbarValueAndOverhang(position, totalSize, visibleSize, value, overhang);
220
221     float proportion = totalSize ? (visibleSize - overhang) / totalSize : 1;
222
223     return { value, proportion };
224 }
225
226 }
227
228 #endif