[iOS] Tapping any link crashes in WebCore::EventHandler::mouseMoved()
[WebKit-https.git] / Source / WebCore / page / ios / EventHandlerIOS.mm
1 /*
2  * Copyright (C) 2006, 2007, 2008, 2009 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 COMPUTER, 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 COMPUTER, 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 "BlockExceptions.h"
31 #import "Chrome.h"
32 #import "ChromeClient.h"
33 #import "FocusController.h"
34 #import "Frame.h"
35 #import "FrameView.h"
36 #import "KeyboardEvent.h"
37 #import "MouseEventWithHitTestResults.h"
38 #import "Page.h"
39 #import "PlatformEventFactoryIOS.h"
40 #import "PlatformKeyboardEvent.h"
41 #import "RenderWidget.h"
42 #import "WAKView.h"
43 #import "WAKWindow.h"
44 #import "WebEvent.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 void EventHandler::touchEvent(WebEvent *event)
108 {
109     CurrentEventScope scope(event);
110
111     event.wasHandled = handleTouchEvent(PlatformEventFactory::createPlatformTouchEvent(event));
112 }
113 #endif
114
115 bool EventHandler::tabsToAllFormControls(KeyboardEvent* event) const
116 {
117     Page* page = m_frame.page();
118     if (!page)
119         return false;
120
121     KeyboardUIMode keyboardUIMode = page->chrome().client().keyboardUIMode();
122     bool handlingOptionTab = isKeyboardOptionTab(event);
123
124     // If tab-to-links is off, option-tab always highlights all controls.
125     if ((keyboardUIMode & KeyboardAccessTabsToLinks) == 0 && handlingOptionTab)
126         return true;
127
128     // If system preferences say to include all controls, we always include all controls.
129     if (keyboardUIMode & KeyboardAccessFull)
130         return true;
131
132     // Otherwise tab-to-links includes all controls, unless the sense is flipped via option-tab.
133     if (keyboardUIMode & KeyboardAccessTabsToLinks)
134         return !handlingOptionTab;
135
136     return handlingOptionTab;
137 }
138
139 bool EventHandler::keyEvent(WebEvent *event)
140 {
141     BEGIN_BLOCK_OBJC_EXCEPTIONS;
142
143     ASSERT(event.type == WebEventKeyDown || event.type == WebEventKeyUp);
144
145     CurrentEventScope scope(event);
146     bool eventWasHandled = keyEvent(PlatformEventFactory::createPlatformKeyboardEvent(event));
147     event.wasHandled = eventWasHandled;
148     return eventWasHandled;
149
150     END_BLOCK_OBJC_EXCEPTIONS;
151
152     return false;
153 }
154
155 void EventHandler::focusDocumentView()
156 {
157     Page* page = m_frame.page();
158     if (!page)
159         return;
160
161     if (FrameView* frameView = m_frame.view()) {
162         if (NSView *documentView = frameView->documentView())
163             page->chrome().focusNSView(documentView);
164     }
165
166     page->focusController().setFocusedFrame(&m_frame);
167 }
168
169 bool EventHandler::passWidgetMouseDownEventToWidget(const MouseEventWithHitTestResults& event)
170 {
171     // Figure out which view to send the event to.
172     RenderObject* target = event.targetNode() ? event.targetNode()->renderer() : nullptr;
173     if (!target || !target->isWidget())
174         return false;
175
176     // Double-click events don't exist in Cocoa. Since passWidgetMouseDownEventToWidget() will
177     // just pass currentEvent down to the widget, we don't want to call it for events that
178     // don't correspond to Cocoa events. The mousedown/ups will have already been passed on as
179     // part of the pressed/released handling.
180     return passMouseDownEventToWidget(toRenderWidget(target)->widget());
181 }
182
183 bool EventHandler::passWidgetMouseDownEventToWidget(RenderWidget* renderWidget)
184 {
185     return passMouseDownEventToWidget(renderWidget->widget());
186 }
187
188 static bool lastEventIsMouseUp()
189 {
190     // Many AppKit widgets run their own event loops and consume events while the mouse is down.
191     // When they finish, currentEvent is the mouseUp that they exited on. We need to update
192     // the WebCore state with this mouseUp, which we never saw. This method lets us detect
193     // that state. Handling this was critical when we used AppKit widgets for form elements.
194     // It's not clear in what cases this is helpful now -- it's possible it can be removed. 
195
196     BEGIN_BLOCK_OBJC_EXCEPTIONS;
197     WebEvent *currentEventAfterHandlingMouseDown = [WAKWindow currentEvent];
198     return currentEventAfterHandlingMouseDown
199         && EventHandler::currentEvent() != currentEventAfterHandlingMouseDown
200         && currentEventAfterHandlingMouseDown.type == WebEventMouseUp
201         && currentEventAfterHandlingMouseDown.timestamp >= EventHandler::currentEvent().timestamp;
202     END_BLOCK_OBJC_EXCEPTIONS;
203
204     return false;
205 }
206
207 bool EventHandler::passMouseDownEventToWidget(Widget* pWidget)
208 {
209     // FIXME: This function always returns true. It should be changed either to return
210     // false in some cases or the return value should be removed.
211
212     RefPtr<Widget> widget = pWidget;
213
214     if (!widget) {
215         LOG_ERROR("hit a RenderWidget without a corresponding Widget, means a frame is half-constructed");
216         return true;
217     }
218
219     BEGIN_BLOCK_OBJC_EXCEPTIONS;
220
221     NSView *nodeView = widget->platformWidget();
222     ASSERT(nodeView);
223     ASSERT([nodeView superview]);
224     NSView *view = [nodeView hitTest:[[nodeView superview] convertPoint:currentEvent().locationInWindow fromView:nil]];
225     if (!view) {
226         // We probably hit the border of a RenderWidget
227         return true;
228     }
229
230     Page* page = m_frame.page();
231     if (!page)
232         return true;
233
234     if (page->chrome().client().firstResponder() != view) {
235         // Normally [NSWindow sendEvent:] handles setting the first responder.
236         // But in our case, the event was sent to the view representing the entire web page.
237         if ([view acceptsFirstResponder] && [view needsPanelToBecomeKey])
238             page->chrome().client().makeFirstResponder(view);
239     }
240
241     // We need to "defer loading" while tracking the mouse, because tearing down the
242     // page while an AppKit control is tracking the mouse can cause a crash.
243
244     // FIXME: In theory, WebCore now tolerates tear-down while tracking the
245     // mouse. We should confirm that, and then remove the deferrsLoading
246     // hack entirely.
247
248     bool wasDeferringLoading = page->defersLoading();
249     if (!wasDeferringLoading)
250         page->setDefersLoading(true);
251
252     ASSERT(!m_sendingEventToSubview);
253     m_sendingEventToSubview = true;
254     [view mouseDown:currentEvent()];
255     m_sendingEventToSubview = false;
256     
257     if (!wasDeferringLoading)
258         page->setDefersLoading(false);
259
260     // Remember which view we sent the event to, so we can direct the release event properly.
261     m_mouseDownView = view;
262     m_mouseDownWasInSubframe = false;
263
264     // Many AppKit widgets run their own event loops and consume events while the mouse is down.
265     // When they finish, currentEvent is the mouseUp that they exited on.  We need to update
266     // the EventHandler state with this mouseUp, which we never saw.
267     // If this event isn't a mouseUp, we assume that the mouseUp will be coming later.  There
268     // is a hole here if the widget consumes both the mouseUp and subsequent events.
269     if (lastEventIsMouseUp())
270         m_mousePressed = false;
271
272     END_BLOCK_OBJC_EXCEPTIONS;
273
274     return true;
275 }
276
277 // Note that this does the same kind of check as [target isDescendantOf:superview].
278 // There are two differences: This is a lot slower because it has to walk the whole
279 // tree, and this works in cases where the target has already been deallocated.
280 static bool findViewInSubviews(NSView *superview, NSView *target)
281 {
282     BEGIN_BLOCK_OBJC_EXCEPTIONS;
283     NSEnumerator *e = [[superview subviews] objectEnumerator];
284     NSView *subview;
285     while ((subview = [e nextObject])) {
286         if (subview == target || findViewInSubviews(subview, target)) {
287             return true;
288         }
289     }
290     END_BLOCK_OBJC_EXCEPTIONS;
291
292     return false;
293 }
294
295 NSView *EventHandler::mouseDownViewIfStillGood()
296 {
297     // Since we have no way of tracking the lifetime of m_mouseDownView, we have to assume that
298     // it could be deallocated already. We search for it in our subview tree; if we don't find
299     // it, we set it to nil.
300     NSView *mouseDownView = m_mouseDownView;
301     if (!mouseDownView) {
302         return nil;
303     }
304     FrameView* topFrameView = m_frame.view();
305     NSView *topView = topFrameView ? topFrameView->platformWidget() : nil;
306     if (!topView || !findViewInSubviews(topView, mouseDownView)) {
307         m_mouseDownView = nil;
308         return nil;
309     }
310     return mouseDownView;
311 }
312
313 bool EventHandler::eventActivatedView(const PlatformMouseEvent&) const
314 {
315     return false;
316 }
317
318 bool EventHandler::eventLoopHandleMouseUp(const MouseEventWithHitTestResults&)
319 {
320     NSView *view = mouseDownViewIfStillGood();
321     if (!view)
322         return false;
323
324     if (!m_mouseDownWasInSubframe) {
325         ASSERT(!m_sendingEventToSubview);
326         m_sendingEventToSubview = true;
327         BEGIN_BLOCK_OBJC_EXCEPTIONS;
328         [view mouseUp:currentEvent()];
329         END_BLOCK_OBJC_EXCEPTIONS;
330         m_sendingEventToSubview = false;
331     }
332  
333     return true;
334 }
335     
336 bool EventHandler::passSubframeEventToSubframe(MouseEventWithHitTestResults& event, Frame* subframe, HitTestResult* hoveredNode)
337 {
338     BEGIN_BLOCK_OBJC_EXCEPTIONS;
339
340     WebEventType currentEventType = currentEvent().type;
341     switch (currentEventType) {
342         case WebEventMouseMoved: {
343             // Since we're passing in currentNSEvent() here, we can call
344             // handleMouseMoveEvent() directly, since the save/restore of
345             // currentNSEvent() that mouseMoved() does would have no effect.
346             ASSERT(!m_sendingEventToSubview);
347             m_sendingEventToSubview = true;
348             subframe->eventHandler().handleMouseMoveEvent(currentPlatformMouseEvent(), hoveredNode);
349             m_sendingEventToSubview = false;
350             return true;
351         }
352         case WebEventMouseDown: {
353             Node* node = event.targetNode();
354             if (!node)
355                 return false;
356             RenderObject* renderer = node->renderer();
357             if (!renderer || !renderer->isWidget())
358                 return false;
359             Widget* widget = toRenderWidget(renderer)->widget();
360             if (!widget || !widget->isFrameView())
361                 return false;
362             if (!passWidgetMouseDownEventToWidget(toRenderWidget(renderer)))
363                 return false;
364             m_mouseDownWasInSubframe = true;
365             return true;
366         }
367         case WebEventMouseUp: {
368             if (!m_mouseDownWasInSubframe)
369                 return false;
370             ASSERT(!m_sendingEventToSubview);
371             m_sendingEventToSubview = true;
372             subframe->eventHandler().handleMouseReleaseEvent(currentPlatformMouseEvent());
373             m_sendingEventToSubview = false;
374             return true;
375         }
376         case WebEventKeyDown:
377         case WebEventKeyUp:
378         case WebEventScrollWheel:
379         case WebEventTouchBegin:
380         case WebEventTouchCancel:
381         case WebEventTouchChange:
382         case WebEventTouchEnd:
383             return false;
384     }
385     END_BLOCK_OBJC_EXCEPTIONS;
386
387     return false;
388 }
389
390 bool EventHandler::passWheelEventToWidget(const PlatformWheelEvent&, Widget* widget)
391 {
392     BEGIN_BLOCK_OBJC_EXCEPTIONS;
393
394     if (currentEvent().type != WebEventScrollWheel || m_sendingEventToSubview || !widget)
395         return false;
396
397     NSView* nodeView = widget->platformWidget();
398     ASSERT(nodeView);
399     ASSERT([nodeView superview]);
400     NSView *view = [nodeView hitTest:[[nodeView superview] convertPoint:currentEvent().locationInWindow fromView:nil]];
401     if (!view) {
402         // We probably hit the border of a RenderWidget
403         return false;
404     }
405
406     ASSERT(!m_sendingEventToSubview);
407     m_sendingEventToSubview = true;
408     [view scrollWheel:currentEvent()];
409     m_sendingEventToSubview = false;
410     return true;
411
412     END_BLOCK_OBJC_EXCEPTIONS;
413     return false;
414 }
415
416 void EventHandler::mouseDown(WebEvent *event)
417 {
418     FrameView* v = m_frame.view();
419     if (!v || m_sendingEventToSubview)
420         return;
421
422     BEGIN_BLOCK_OBJC_EXCEPTIONS;
423
424     m_frame.loader().resetMultipleFormSubmissionProtection();
425
426     m_mouseDownView = nil;
427
428     CurrentEventScope scope(event);
429
430     event.wasHandled = handleMousePressEvent(currentPlatformMouseEvent());
431
432     END_BLOCK_OBJC_EXCEPTIONS;
433 }
434
435 void EventHandler::mouseUp(WebEvent *event)
436 {
437     FrameView* v = m_frame.view();
438     if (!v || m_sendingEventToSubview)
439         return;
440
441     BEGIN_BLOCK_OBJC_EXCEPTIONS;
442
443     CurrentEventScope scope(event);
444
445     event.wasHandled = handleMouseReleaseEvent(currentPlatformMouseEvent());
446
447     m_mouseDownView = nil;
448
449     END_BLOCK_OBJC_EXCEPTIONS;
450 }
451
452 void EventHandler::mouseMoved(WebEvent *event)
453 {
454     // Reject a mouse moved if the button is down - screws up tracking during autoscroll
455     // These happen because WebKit sometimes has to fake up moved events.
456     if (!m_frame.view() || m_mousePressed || m_sendingEventToSubview)
457         return;
458
459     BEGIN_BLOCK_OBJC_EXCEPTIONS;
460
461     m_frame.document()->updateStyleIfNeeded();
462
463     WKBeginObservingContentChanges(true);
464     CurrentEventScope scope(event);
465     event.wasHandled = mouseMoved(currentPlatformMouseEvent());
466     m_frame.document()->updateStyleIfNeeded();
467     WKStopObservingContentChanges();
468
469     END_BLOCK_OBJC_EXCEPTIONS;
470 }
471
472 bool EventHandler::passMousePressEventToSubframe(MouseEventWithHitTestResults& mev, Frame* subframe)
473 {
474     return passSubframeEventToSubframe(mev, subframe);
475 }
476
477 bool EventHandler::passMouseMoveEventToSubframe(MouseEventWithHitTestResults& mev, Frame* subframe, HitTestResult* hoveredNode)
478 {
479     return passSubframeEventToSubframe(mev, subframe, hoveredNode);
480 }
481
482 bool EventHandler::passMouseReleaseEventToSubframe(MouseEventWithHitTestResults& mev, Frame* subframe)
483 {
484     return passSubframeEventToSubframe(mev, subframe);
485 }
486
487 unsigned EventHandler::accessKeyModifiers()
488 {
489     // Control+Option key combinations are usually unused on Mac OS X, but not when VoiceOver is enabled.
490     // So, we use Control in this case, even though it conflicts with Emacs-style key bindings.
491     // See <https://bugs.webkit.org/show_bug.cgi?id=21107> for more detail.
492     if (AXObjectCache::accessibilityEnhancedUserInterfaceEnabled())
493         return PlatformKeyboardEvent::CtrlKey;
494
495     return PlatformKeyboardEvent::CtrlKey | PlatformKeyboardEvent::AltKey;
496 }
497
498 PlatformMouseEvent EventHandler::currentPlatformMouseEvent() const
499 {
500     return PlatformEventFactory::createPlatformMouseEvent(currentEvent());
501 }
502
503 }