AX: Simulated touch events are not working on iOS
[WebKit-https.git] / Source / WebCore / page / ios / EventHandlerIOS.mm
1 /*
2  * Copyright (C) 2006-2016 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. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #import "config.h"
27 #import "EventHandler.h"
28
29 #import "AXObjectCache.h"
30 #import "Chrome.h"
31 #import "ChromeClient.h"
32 #import "FocusController.h"
33 #import "Frame.h"
34 #import "FrameView.h"
35 #import "KeyboardEvent.h"
36 #import "MouseEventWithHitTestResults.h"
37 #import "Page.h"
38 #import "PlatformEventFactoryIOS.h"
39 #import "PlatformKeyboardEvent.h"
40 #import "RenderWidget.h"
41 #import "WAKView.h"
42 #import "WAKWindow.h"
43 #import "WebEvent.h"
44 #import <wtf/BlockObjCExceptions.h>
45 #import <wtf/NeverDestroyed.h>
46 #import <wtf/Noncopyable.h>
47
48 #if ENABLE(IOS_TOUCH_EVENTS)
49 #import <WebKitAdditions/EventHandlerIOSTouch.cpp>
50 #endif
51
52 namespace WebCore {
53
54 static RetainPtr<WebEvent>& currentEventSlot()
55 {
56     static NeverDestroyed<RetainPtr<WebEvent>> event;
57     return event;
58 }
59
60 WebEvent *EventHandler::currentEvent()
61 {
62     return currentEventSlot().get();
63 }
64
65 class CurrentEventScope {
66     WTF_MAKE_NONCOPYABLE(CurrentEventScope);
67 public:
68     CurrentEventScope(WebEvent *);
69     ~CurrentEventScope();
70
71 private:
72     RetainPtr<WebEvent> m_savedCurrentEvent;
73 #ifndef NDEBUG
74     RetainPtr<WebEvent> m_event;
75 #endif
76 };
77
78 inline CurrentEventScope::CurrentEventScope(WebEvent *event)
79     : m_savedCurrentEvent(currentEventSlot())
80 #ifndef NDEBUG
81     , m_event(event)
82 #endif
83 {
84     currentEventSlot() = event;
85 }
86
87 inline CurrentEventScope::~CurrentEventScope()
88 {
89     ASSERT(currentEventSlot() == m_event);
90     currentEventSlot() = m_savedCurrentEvent;
91 }
92
93 bool EventHandler::wheelEvent(WebEvent *event)
94 {
95     Page* page = m_frame.page();
96     if (!page)
97         return false;
98
99     CurrentEventScope scope(event);
100
101     bool eventWasHandled = handleWheelEvent(PlatformEventFactory::createPlatformWheelEvent(event));
102     event.wasHandled = eventWasHandled;
103     return eventWasHandled;
104 }
105
106 #if ENABLE(IOS_TOUCH_EVENTS)
107
108 bool EventHandler::dispatchSimulatedTouchEvent(IntPoint location)
109 {
110     bool handled = handleTouchEvent(PlatformEventFactory::createPlatformSimulatedTouchEvent(PlatformEvent::TouchStart, location));
111     handled |= handleTouchEvent(PlatformEventFactory::createPlatformSimulatedTouchEvent(PlatformEvent::TouchEnd, location));
112     return handled;
113 }
114     
115 void EventHandler::touchEvent(WebEvent *event)
116 {
117     CurrentEventScope scope(event);
118
119     event.wasHandled = handleTouchEvent(PlatformEventFactory::createPlatformTouchEvent(event));
120 }
121 #endif
122
123 bool EventHandler::tabsToAllFormControls(KeyboardEvent* event) const
124 {
125     Page* page = m_frame.page();
126     if (!page)
127         return false;
128
129     KeyboardUIMode keyboardUIMode = page->chrome().client().keyboardUIMode();
130     bool handlingOptionTab = isKeyboardOptionTab(event);
131
132     // If tab-to-links is off, option-tab always highlights all controls.
133     if ((keyboardUIMode & KeyboardAccessTabsToLinks) == 0 && handlingOptionTab)
134         return true;
135
136     // If system preferences say to include all controls, we always include all controls.
137     if (keyboardUIMode & KeyboardAccessFull)
138         return true;
139
140     // Otherwise tab-to-links includes all controls, unless the sense is flipped via option-tab.
141     if (keyboardUIMode & KeyboardAccessTabsToLinks)
142         return !handlingOptionTab;
143
144     return handlingOptionTab;
145 }
146
147 bool EventHandler::keyEvent(WebEvent *event)
148 {
149     BEGIN_BLOCK_OBJC_EXCEPTIONS;
150
151     ASSERT(event.type == WebEventKeyDown || event.type == WebEventKeyUp);
152
153     CurrentEventScope scope(event);
154     bool eventWasHandled = keyEvent(PlatformEventFactory::createPlatformKeyboardEvent(event));
155     event.wasHandled = eventWasHandled;
156     return eventWasHandled;
157
158     END_BLOCK_OBJC_EXCEPTIONS;
159
160     return false;
161 }
162
163 void EventHandler::focusDocumentView()
164 {
165     Page* page = m_frame.page();
166     if (!page)
167         return;
168
169     if (FrameView* frameView = m_frame.view()) {
170         if (NSView *documentView = frameView->documentView())
171             page->chrome().focusNSView(documentView);
172     }
173
174     page->focusController().setFocusedFrame(&m_frame);
175 }
176
177 bool EventHandler::passWidgetMouseDownEventToWidget(const MouseEventWithHitTestResults& event)
178 {
179     // Figure out which view to send the event to.
180     auto* target = event.targetNode() ? event.targetNode()->renderer() : nullptr;
181     if (!is<RenderWidget>(target))
182         return false;
183
184     // Double-click events don't exist in Cocoa. Since passWidgetMouseDownEventToWidget() will
185     // just pass currentEvent down to the widget, we don't want to call it for events that
186     // don't correspond to Cocoa events. The mousedown/ups will have already been passed on as
187     // part of the pressed/released handling.
188     return passMouseDownEventToWidget(downcast<RenderWidget>(*target).widget());
189 }
190
191 bool EventHandler::passWidgetMouseDownEventToWidget(RenderWidget* renderWidget)
192 {
193     return passMouseDownEventToWidget(renderWidget->widget());
194 }
195
196 static bool lastEventIsMouseUp()
197 {
198     // Many AppKit widgets run their own event loops and consume events while the mouse is down.
199     // When they finish, currentEvent is the mouseUp that they exited on. We need to update
200     // the WebCore state with this mouseUp, which we never saw. This method lets us detect
201     // that state. Handling this was critical when we used AppKit widgets for form elements.
202     // It's not clear in what cases this is helpful now -- it's possible it can be removed. 
203
204     BEGIN_BLOCK_OBJC_EXCEPTIONS;
205     WebEvent *currentEventAfterHandlingMouseDown = [WAKWindow currentEvent];
206     return currentEventAfterHandlingMouseDown
207         && EventHandler::currentEvent() != currentEventAfterHandlingMouseDown
208         && currentEventAfterHandlingMouseDown.type == WebEventMouseUp
209         && currentEventAfterHandlingMouseDown.timestamp >= EventHandler::currentEvent().timestamp;
210     END_BLOCK_OBJC_EXCEPTIONS;
211
212     return false;
213 }
214
215 bool EventHandler::passMouseDownEventToWidget(Widget* pWidget)
216 {
217     // FIXME: This function always returns true. It should be changed either to return
218     // false in some cases or the return value should be removed.
219
220     RefPtr<Widget> widget = pWidget;
221
222     if (!widget) {
223         LOG_ERROR("hit a RenderWidget without a corresponding Widget, means a frame is half-constructed");
224         return true;
225     }
226
227     // In WebKit2 we will never have a native widget. Just return early and let the regular event handler machinery take care of
228     // dispatching the event.
229     if (!widget->platformWidget())
230         return false;
231
232     BEGIN_BLOCK_OBJC_EXCEPTIONS;
233
234     NSView *nodeView = widget->platformWidget();
235     ASSERT(nodeView);
236     ASSERT([nodeView superview]);
237     NSView *view = [nodeView hitTest:[[nodeView superview] convertPoint:currentEvent().locationInWindow fromView:nil]];
238     if (!view) {
239         // We probably hit the border of a RenderWidget
240         return true;
241     }
242
243     Page* page = m_frame.page();
244     if (!page)
245         return true;
246
247     if (page->chrome().client().firstResponder() != view) {
248         // Normally [NSWindow sendEvent:] handles setting the first responder.
249         // But in our case, the event was sent to the view representing the entire web page.
250         if ([view acceptsFirstResponder] && [view needsPanelToBecomeKey])
251             page->chrome().client().makeFirstResponder(view);
252     }
253
254     // We need to "defer loading" while tracking the mouse, because tearing down the
255     // page while an AppKit control is tracking the mouse can cause a crash.
256
257     // FIXME: In theory, WebCore now tolerates tear-down while tracking the
258     // mouse. We should confirm that, and then remove the deferrsLoading
259     // hack entirely.
260
261     bool wasDeferringLoading = page->defersLoading();
262     if (!wasDeferringLoading)
263         page->setDefersLoading(true);
264
265     ASSERT(!m_sendingEventToSubview);
266     m_sendingEventToSubview = true;
267
268     {
269         WidgetHierarchyUpdatesSuspensionScope suspendWidgetHierarchyUpdates;
270         [view mouseDown:currentEvent()];
271     }
272
273     m_sendingEventToSubview = false;
274     
275     if (!wasDeferringLoading)
276         page->setDefersLoading(false);
277
278     // Remember which view we sent the event to, so we can direct the release event properly.
279     m_mouseDownView = view;
280     m_mouseDownWasInSubframe = false;
281
282     // Many AppKit widgets run their own event loops and consume events while the mouse is down.
283     // When they finish, currentEvent is the mouseUp that they exited on.  We need to update
284     // the EventHandler state with this mouseUp, which we never saw.
285     // If this event isn't a mouseUp, we assume that the mouseUp will be coming later.  There
286     // is a hole here if the widget consumes both the mouseUp and subsequent events.
287     if (lastEventIsMouseUp())
288         m_mousePressed = false;
289
290     END_BLOCK_OBJC_EXCEPTIONS;
291
292     return true;
293 }
294
295 // Note that this does the same kind of check as [target isDescendantOf:superview].
296 // There are two differences: This is a lot slower because it has to walk the whole
297 // tree, and this works in cases where the target has already been deallocated.
298 static bool findViewInSubviews(NSView *superview, NSView *target)
299 {
300     BEGIN_BLOCK_OBJC_EXCEPTIONS;
301     NSEnumerator *e = [[superview subviews] objectEnumerator];
302     NSView *subview;
303     while ((subview = [e nextObject])) {
304         if (subview == target || findViewInSubviews(subview, target)) {
305             return true;
306         }
307     }
308     END_BLOCK_OBJC_EXCEPTIONS;
309
310     return false;
311 }
312
313 NSView *EventHandler::mouseDownViewIfStillGood()
314 {
315     // Since we have no way of tracking the lifetime of m_mouseDownView, we have to assume that
316     // it could be deallocated already. We search for it in our subview tree; if we don't find
317     // it, we set it to nil.
318     NSView *mouseDownView = m_mouseDownView;
319     if (!mouseDownView) {
320         return nil;
321     }
322     FrameView* topFrameView = m_frame.view();
323     NSView *topView = topFrameView ? topFrameView->platformWidget() : nil;
324     if (!topView || !findViewInSubviews(topView, mouseDownView)) {
325         m_mouseDownView = nil;
326         return nil;
327     }
328     return mouseDownView;
329 }
330
331 bool EventHandler::eventActivatedView(const PlatformMouseEvent&) const
332 {
333     return false;
334 }
335
336 bool EventHandler::eventLoopHandleMouseUp(const MouseEventWithHitTestResults&)
337 {
338     NSView *view = mouseDownViewIfStillGood();
339     if (!view)
340         return false;
341
342     if (!m_mouseDownWasInSubframe) {
343         ASSERT(!m_sendingEventToSubview);
344         m_sendingEventToSubview = true;
345         BEGIN_BLOCK_OBJC_EXCEPTIONS;
346         [view mouseUp:currentEvent()];
347         END_BLOCK_OBJC_EXCEPTIONS;
348         m_sendingEventToSubview = false;
349     }
350  
351     return true;
352 }
353     
354 bool EventHandler::passSubframeEventToSubframe(MouseEventWithHitTestResults& event, Frame* subframe, HitTestResult* hoveredNode)
355 {
356     BEGIN_BLOCK_OBJC_EXCEPTIONS;
357
358     WebEventType currentEventType = currentEvent().type;
359     switch (currentEventType) {
360         case WebEventMouseMoved: {
361             // Since we're passing in currentNSEvent() here, we can call
362             // handleMouseMoveEvent() directly, since the save/restore of
363             // currentNSEvent() that mouseMoved() does would have no effect.
364             ASSERT(!m_sendingEventToSubview);
365             m_sendingEventToSubview = true;
366             subframe->eventHandler().handleMouseMoveEvent(currentPlatformMouseEvent(), hoveredNode);
367             m_sendingEventToSubview = false;
368             return true;
369         }
370         case WebEventMouseDown: {
371             Node* node = event.targetNode();
372             if (!node)
373                 return false;
374             auto* renderer = node->renderer();
375             if (!is<RenderWidget>(renderer))
376                 return false;
377             Widget* widget = downcast<RenderWidget>(*renderer).widget();
378             if (!widget || !widget->isFrameView())
379                 return false;
380             if (!passWidgetMouseDownEventToWidget(downcast<RenderWidget>(renderer)))
381                 return false;
382             m_mouseDownWasInSubframe = true;
383             return true;
384         }
385         case WebEventMouseUp: {
386             if (!m_mouseDownWasInSubframe)
387                 return false;
388             ASSERT(!m_sendingEventToSubview);
389             m_sendingEventToSubview = true;
390             subframe->eventHandler().handleMouseReleaseEvent(currentPlatformMouseEvent());
391             m_sendingEventToSubview = false;
392             return true;
393         }
394         case WebEventKeyDown:
395         case WebEventKeyUp:
396         case WebEventScrollWheel:
397         case WebEventTouchBegin:
398         case WebEventTouchCancel:
399         case WebEventTouchChange:
400         case WebEventTouchEnd:
401             return false;
402     }
403     END_BLOCK_OBJC_EXCEPTIONS;
404
405     return false;
406 }
407
408 bool EventHandler::widgetDidHandleWheelEvent(const PlatformWheelEvent&, Widget& widget)
409 {
410     BEGIN_BLOCK_OBJC_EXCEPTIONS;
411
412     NSView* nodeView = widget.platformWidget();
413     if (!nodeView) {
414         // WK2 code path. No wheel events on iOS anyway.
415         return false;
416     }
417
418     if (currentEvent().type != WebEventScrollWheel || m_sendingEventToSubview)
419         return false;
420
421     ASSERT(nodeView);
422     ASSERT([nodeView superview]);
423     NSView *view = [nodeView hitTest:[[nodeView superview] convertPoint:currentEvent().locationInWindow fromView:nil]];
424     if (!view) {
425         // We probably hit the border of a RenderWidget
426         return false;
427     }
428
429     ASSERT(!m_sendingEventToSubview);
430     m_sendingEventToSubview = true;
431     [view scrollWheel:currentEvent()];
432     m_sendingEventToSubview = false;
433     return true;
434
435     END_BLOCK_OBJC_EXCEPTIONS;
436     return false;
437 }
438
439 void EventHandler::mouseDown(WebEvent *event)
440 {
441     FrameView* v = m_frame.view();
442     if (!v || m_sendingEventToSubview)
443         return;
444
445     BEGIN_BLOCK_OBJC_EXCEPTIONS;
446
447     // FIXME: Why is this here? EventHandler::handleMousePressEvent() calls it.
448     m_frame.loader().resetMultipleFormSubmissionProtection();
449
450     m_mouseDownView = nil;
451
452     CurrentEventScope scope(event);
453
454     event.wasHandled = handleMousePressEvent(currentPlatformMouseEvent());
455
456     END_BLOCK_OBJC_EXCEPTIONS;
457 }
458
459 void EventHandler::mouseUp(WebEvent *event)
460 {
461     FrameView* v = m_frame.view();
462     if (!v || m_sendingEventToSubview)
463         return;
464
465     BEGIN_BLOCK_OBJC_EXCEPTIONS;
466
467     CurrentEventScope scope(event);
468
469     event.wasHandled = handleMouseReleaseEvent(currentPlatformMouseEvent());
470
471     m_mouseDownView = nil;
472
473     END_BLOCK_OBJC_EXCEPTIONS;
474 }
475
476 void EventHandler::mouseMoved(WebEvent *event)
477 {
478     // Reject a mouse moved if the button is down - screws up tracking during autoscroll
479     // These happen because WebKit sometimes has to fake up moved events.
480     if (!m_frame.view() || m_mousePressed || m_sendingEventToSubview)
481         return;
482
483     BEGIN_BLOCK_OBJC_EXCEPTIONS;
484
485     m_frame.document()->updateStyleIfNeeded();
486
487     WKBeginObservingContentChanges(true);
488     CurrentEventScope scope(event);
489     event.wasHandled = mouseMoved(currentPlatformMouseEvent());
490     
491     // FIXME: Why is this here?
492     m_frame.document()->updateStyleIfNeeded();
493     WKStopObservingContentChanges();
494
495     END_BLOCK_OBJC_EXCEPTIONS;
496 }
497
498 static bool frameHasPlatformWidget(const Frame& frame)
499 {
500     if (FrameView* frameView = frame.view()) {
501         if (frameView->platformWidget())
502             return true;
503     }
504
505     return false;
506 }
507
508 bool EventHandler::passMousePressEventToSubframe(MouseEventWithHitTestResults& mev, Frame* subframe)
509 {
510     // WebKit1 code path.
511     if (frameHasPlatformWidget(m_frame))
512         return passSubframeEventToSubframe(mev, subframe);
513
514     // WebKit2 code path.
515     subframe->eventHandler().handleMousePressEvent(mev.event());
516     return true;
517 }
518
519 bool EventHandler::passMouseMoveEventToSubframe(MouseEventWithHitTestResults& mev, Frame* subframe, HitTestResult* hoveredNode)
520 {
521     // WebKit1 code path.
522     if (frameHasPlatformWidget(m_frame))
523         return passSubframeEventToSubframe(mev, subframe, hoveredNode);
524
525     subframe->eventHandler().handleMouseMoveEvent(mev.event(), hoveredNode);
526     return true;
527 }
528
529 bool EventHandler::passMouseReleaseEventToSubframe(MouseEventWithHitTestResults& mev, Frame* subframe)
530 {
531     // WebKit1 code path.
532     if (frameHasPlatformWidget(m_frame))
533         return passSubframeEventToSubframe(mev, subframe);
534
535     // WebKit2 code path.
536     subframe->eventHandler().handleMouseReleaseEvent(mev.event());
537     return true;
538 }
539
540 unsigned EventHandler::accessKeyModifiers()
541 {
542     // Control+Option key combinations are usually unused on Mac OS X, but not when VoiceOver is enabled.
543     // So, we use Control in this case, even though it conflicts with Emacs-style key bindings.
544     // See <https://bugs.webkit.org/show_bug.cgi?id=21107> for more detail.
545     if (AXObjectCache::accessibilityEnhancedUserInterfaceEnabled())
546         return PlatformKeyboardEvent::CtrlKey;
547
548     return PlatformKeyboardEvent::CtrlKey | PlatformKeyboardEvent::AltKey;
549 }
550
551 PlatformMouseEvent EventHandler::currentPlatformMouseEvent() const
552 {
553     return PlatformEventFactory::createPlatformMouseEvent(currentEvent());
554 }
555
556 }