c83b45c84e19d4d98a3ffca2759f1a88df66df89
[WebKit-https.git] / Tools / WebKitTestRunner / mac / EventSenderProxy.mm
1 /*
2  * Copyright (C) 2011, 2014 Apple Inc. All rights reserved.
3  * Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
15  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
16  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
18  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
19  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
20  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
21  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
22  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
23  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
24  * THE POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 #import "config.h"
28 #import "EventSenderProxy.h"
29
30 #import "PlatformWebView.h"
31 #import "StringFunctions.h"
32 #import "TestController.h"
33 #import <Carbon/Carbon.h>
34 #import <WebKit/WKString.h>
35 #import <wtf/RetainPtr.h>
36
37 @interface NSApplication (Details)
38 - (void)_setCurrentEvent:(NSEvent *)event;
39 @end
40
41 namespace WTR {
42
43 enum MouseAction {
44     MouseDown,
45     MouseUp,
46     MouseDragged
47 };
48
49 // Match the DOM spec (sadly the DOM spec does not provide an enum)
50 enum MouseButton {
51     LeftMouseButton = 0,
52     MiddleMouseButton = 1,
53     RightMouseButton = 2,
54     NoMouseButton = -1
55 };
56
57 struct KeyMappingEntry {
58     int macKeyCode;
59     int macNumpadKeyCode;
60     unichar character;
61     NSString* characterName;
62 };
63
64 static NSEventType eventTypeForMouseButtonAndAction(int button, MouseAction action)
65 {
66     switch (button) {
67         case LeftMouseButton:
68             switch (action) {
69                 case MouseDown:
70                     return NSLeftMouseDown;
71                 case MouseUp:
72                     return NSLeftMouseUp;
73                 case MouseDragged:
74                     return NSLeftMouseDragged;
75             }
76         case RightMouseButton:
77             switch (action) {
78                 case MouseDown:
79                     return NSRightMouseDown;
80                 case MouseUp:
81                     return NSRightMouseUp;
82                 case MouseDragged:
83                     return NSRightMouseDragged;
84             }
85         default:
86             switch (action) {
87                 case MouseDown:
88                     return NSOtherMouseDown;
89                 case MouseUp:
90                     return NSOtherMouseUp;
91                 case MouseDragged:
92                     return NSOtherMouseDragged;
93             }
94     }
95     assert(0);
96     return static_cast<NSEventType>(0);
97 }
98
99 static int buildModifierFlags(WKEventModifiers modifiers)
100 {
101     int flags = 0;
102     if (modifiers & kWKEventModifiersControlKey)
103         flags |= NSControlKeyMask;
104     if (modifiers & kWKEventModifiersShiftKey)
105         flags |= NSShiftKeyMask;
106     if (modifiers & kWKEventModifiersAltKey)
107         flags |= NSAlternateKeyMask;
108     if (modifiers & kWKEventModifiersMetaKey)
109         flags |= NSCommandKeyMask;
110     return flags;
111 }
112
113 static NSTimeInterval absoluteTimeForEventTime(double currentEventTime)
114 {
115     return GetCurrentEventTime() + currentEventTime;
116 }
117
118 EventSenderProxy::EventSenderProxy(TestController* testController)
119     : m_testController(testController)
120     , m_time(0)
121     , m_position()
122     , m_leftMouseButtonDown(false)
123     , m_clickCount(0)
124     , m_clickTime(0)
125     , m_clickPosition()
126     , m_clickButton(kWKEventMouseButtonNoButton)
127     , eventNumber(0)
128 {
129 }
130
131 EventSenderProxy::~EventSenderProxy()
132 {
133 }
134
135 void EventSenderProxy::updateClickCountForButton(int button)
136 {
137     if (m_time - m_clickTime < 1 && m_position == m_clickPosition && button == m_clickButton) {
138         ++m_clickCount;
139         m_clickTime = m_time;
140         return;
141     }
142
143     m_clickCount = 1;
144     m_clickTime = m_time;
145     m_clickPosition = m_position;
146     m_clickButton = button;
147 }
148
149 void EventSenderProxy::mouseDown(unsigned buttonNumber, WKEventModifiers modifiers)
150 {
151     updateClickCountForButton(buttonNumber);
152
153     NSEventType eventType = eventTypeForMouseButtonAndAction(buttonNumber, MouseDown);
154     NSEvent *event = [NSEvent mouseEventWithType:eventType
155                                         location:NSMakePoint(m_position.x, m_position.y)
156                                    modifierFlags:buildModifierFlags(modifiers)
157                                        timestamp:absoluteTimeForEventTime(currentEventTime())
158                                     windowNumber:[m_testController->mainWebView()->platformWindow() windowNumber]
159                                          context:[NSGraphicsContext currentContext] 
160                                      eventNumber:++eventNumber 
161                                       clickCount:m_clickCount 
162                                         pressure:0.0];
163
164     NSView *targetView = [m_testController->mainWebView()->platformView() hitTest:[event locationInWindow]];
165     if (targetView) {
166         [NSApp _setCurrentEvent:event];
167         [targetView mouseDown:event];
168         [NSApp _setCurrentEvent:nil];
169         if (buttonNumber == LeftMouseButton)
170             m_leftMouseButtonDown = true;
171     }
172 }
173
174 void EventSenderProxy::mouseUp(unsigned buttonNumber, WKEventModifiers modifiers)
175 {
176     NSEventType eventType = eventTypeForMouseButtonAndAction(buttonNumber, MouseUp);
177     NSEvent *event = [NSEvent mouseEventWithType:eventType
178                                         location:NSMakePoint(m_position.x, m_position.y)
179                                    modifierFlags:buildModifierFlags(modifiers)
180                                        timestamp:absoluteTimeForEventTime(currentEventTime())
181                                     windowNumber:[m_testController->mainWebView()->platformWindow() windowNumber]
182                                          context:[NSGraphicsContext currentContext] 
183                                      eventNumber:++eventNumber 
184                                       clickCount:m_clickCount 
185                                         pressure:0.0];
186
187     NSView *targetView = [m_testController->mainWebView()->platformView() hitTest:[event locationInWindow]];
188     // FIXME: Silly hack to teach WKTR to respect capturing mouse events outside the WKView.
189     // The right solution is just to use NSApplication's built-in event sending methods, 
190     // instead of rolling our own algorithm for selecting an event target.
191     targetView = targetView ? targetView : m_testController->mainWebView()->platformView();
192     ASSERT(targetView);
193     [NSApp _setCurrentEvent:event];
194     [targetView mouseUp:event];
195     [NSApp _setCurrentEvent:nil];
196     if (buttonNumber == LeftMouseButton)
197         m_leftMouseButtonDown = false;
198     m_clickTime = currentEventTime();
199     m_clickPosition = m_position;
200 }
201
202 void EventSenderProxy::mouseMoveTo(double x, double y)
203 {
204     NSView *view = m_testController->mainWebView()->platformView();
205     NSPoint position = [view convertPoint:NSMakePoint(x, y) toView:nil];
206     m_position.x = position.x;
207     m_position.y = position.y;
208     NSEvent *event = [NSEvent mouseEventWithType:(m_leftMouseButtonDown ? NSLeftMouseDragged : NSMouseMoved)
209                                         location:position
210                                    modifierFlags:0 
211                                        timestamp:absoluteTimeForEventTime(currentEventTime())
212                                     windowNumber:[[view window] windowNumber] 
213                                          context:[NSGraphicsContext currentContext] 
214                                      eventNumber:++eventNumber 
215                                       clickCount:(m_leftMouseButtonDown ? m_clickCount : 0) 
216                                         pressure:0.0];
217
218     NSView *targetView = [m_testController->mainWebView()->platformView() hitTest:[event locationInWindow]];
219     if (targetView) {
220         [NSApp _setCurrentEvent:event];
221         [targetView mouseMoved:event];
222         [NSApp _setCurrentEvent:nil];
223     }
224 }
225
226 void EventSenderProxy::leapForward(int milliseconds)
227 {
228     m_time += milliseconds / 1000.0;
229 }
230
231 void EventSenderProxy::keyDown(WKStringRef key, WKEventModifiers modifiers, unsigned keyLocation)
232 {
233     NSString* character = [NSString stringWithCString:toSTD(key).c_str() 
234                                    encoding:[NSString defaultCStringEncoding]];
235
236     NSString *eventCharacter = character;
237     unsigned short keyCode = 0;
238     if ([character isEqualToString:@"leftArrow"]) {
239         const unichar ch = NSLeftArrowFunctionKey;
240         eventCharacter = [NSString stringWithCharacters:&ch length:1];
241         keyCode = 0x7B;
242     } else if ([character isEqualToString:@"rightArrow"]) {
243         const unichar ch = NSRightArrowFunctionKey;
244         eventCharacter = [NSString stringWithCharacters:&ch length:1];
245         keyCode = 0x7C;
246     } else if ([character isEqualToString:@"upArrow"]) {
247         const unichar ch = NSUpArrowFunctionKey;
248         eventCharacter = [NSString stringWithCharacters:&ch length:1];
249         keyCode = 0x7E;
250     } else if ([character isEqualToString:@"downArrow"]) {
251         const unichar ch = NSDownArrowFunctionKey;
252         eventCharacter = [NSString stringWithCharacters:&ch length:1];
253         keyCode = 0x7D;
254     } else if ([character isEqualToString:@"pageUp"]) {
255         const unichar ch = NSPageUpFunctionKey;
256         eventCharacter = [NSString stringWithCharacters:&ch length:1];
257         keyCode = 0x74;
258     } else if ([character isEqualToString:@"pageDown"]) {
259         const unichar ch = NSPageDownFunctionKey;
260         eventCharacter = [NSString stringWithCharacters:&ch length:1];
261         keyCode = 0x79;
262     } else if ([character isEqualToString:@"home"]) {
263         const unichar ch = NSHomeFunctionKey;
264         eventCharacter = [NSString stringWithCharacters:&ch length:1];
265         keyCode = 0x73;
266     } else if ([character isEqualToString:@"end"]) {
267         const unichar ch = NSEndFunctionKey;
268         eventCharacter = [NSString stringWithCharacters:&ch length:1];
269         keyCode = 0x77;
270     } else if ([character isEqualToString:@"insert"]) {
271         const unichar ch = NSInsertFunctionKey;
272         eventCharacter = [NSString stringWithCharacters:&ch length:1];
273         keyCode = 0x72;
274     } else if ([character isEqualToString:@"delete"]) {
275         const unichar ch = NSDeleteFunctionKey;
276         eventCharacter = [NSString stringWithCharacters:&ch length:1];
277         keyCode = 0x75;
278     } else if ([character isEqualToString:@"printScreen"]) {
279         const unichar ch = NSPrintScreenFunctionKey;
280         eventCharacter = [NSString stringWithCharacters:&ch length:1];
281         keyCode = 0x0; // There is no known virtual key code for PrintScreen.
282     } else if ([character isEqualToString:@"cyrillicSmallLetterA"]) {
283         const unichar ch = 0x0430;
284         eventCharacter = [NSString stringWithCharacters:&ch length:1];
285         keyCode = 0x3; // Shares key with "F" on Russian layout.
286     } else if ([character isEqualToString:@"leftControl"]) {
287         const unichar ch = 0xFFE3;
288         eventCharacter = [NSString stringWithCharacters:&ch length:1];
289         keyCode = 0x3B;
290     } else if ([character isEqualToString:@"leftShift"]) {
291         const unichar ch = 0xFFE1;
292         eventCharacter = [NSString stringWithCharacters:&ch length:1];
293         keyCode = 0x38;
294     } else if ([character isEqualToString:@"leftAlt"]) {
295         const unichar ch = 0xFFE7;
296         eventCharacter = [NSString stringWithCharacters:&ch length:1];
297         keyCode = 0x3A;
298     } else if ([character isEqualToString:@"rightControl"]) {
299         const unichar ch = 0xFFE4;
300         eventCharacter = [NSString stringWithCharacters:&ch length:1];
301         keyCode = 0x3E;
302     } else if ([character isEqualToString:@"rightShift"]) {
303         const unichar ch = 0xFFE2;
304         eventCharacter = [NSString stringWithCharacters:&ch length:1];
305         keyCode = 0x3C;
306     } else if ([character isEqualToString:@"rightAlt"]) {
307         const unichar ch = 0xFFE8;
308         eventCharacter = [NSString stringWithCharacters:&ch length:1];
309         keyCode = 0x3D;
310     }
311
312     // Compare the input string with the function-key names defined by the DOM spec (i.e. "F1",...,"F24").
313     // If the input string is a function-key name, set its key code.
314     for (unsigned i = 1; i <= 24; i++) {
315         if ([character isEqualToString:[NSString stringWithFormat:@"F%u", i]]) {
316             const unichar ch = NSF1FunctionKey + (i - 1);
317             eventCharacter = [NSString stringWithCharacters:&ch length:1];
318             switch (i) {
319                 case 1: keyCode = 0x7A; break;
320                 case 2: keyCode = 0x78; break;
321                 case 3: keyCode = 0x63; break;
322                 case 4: keyCode = 0x76; break;
323                 case 5: keyCode = 0x60; break;
324                 case 6: keyCode = 0x61; break;
325                 case 7: keyCode = 0x62; break;
326                 case 8: keyCode = 0x64; break;
327                 case 9: keyCode = 0x65; break;
328                 case 10: keyCode = 0x6D; break;
329                 case 11: keyCode = 0x67; break;
330                 case 12: keyCode = 0x6F; break;
331                 case 13: keyCode = 0x69; break;
332                 case 14: keyCode = 0x6B; break;
333                 case 15: keyCode = 0x71; break;
334                 case 16: keyCode = 0x6A; break;
335                 case 17: keyCode = 0x40; break;
336                 case 18: keyCode = 0x4F; break;
337                 case 19: keyCode = 0x50; break;
338                 case 20: keyCode = 0x5A; break;
339             }
340         }
341     }
342
343     // FIXME: No keyCode is set for most keys.
344     if ([character isEqualToString:@"\t"])
345         keyCode = 0x30;
346     else if ([character isEqualToString:@" "])
347         keyCode = 0x31;
348     else if ([character isEqualToString:@"\r"])
349         keyCode = 0x24;
350     else if ([character isEqualToString:@"\n"])
351         keyCode = 0x4C;
352     else if ([character isEqualToString:@"\x8"])
353         keyCode = 0x33;
354     else if ([character isEqualToString:@"a"])
355         keyCode = 0x00;
356     else if ([character isEqualToString:@"b"])
357         keyCode = 0x0B;
358     else if ([character isEqualToString:@"d"])
359         keyCode = 0x02;
360     else if ([character isEqualToString:@"e"])
361         keyCode = 0x0E;
362
363     KeyMappingEntry table[] = {
364         {0x2F, 0x41, '.', nil},
365         {0,    0x43, '*', nil},
366         {0,    0x45, '+', nil},
367         {0,    0x47, NSClearLineFunctionKey, @"clear"},
368         {0x2C, 0x4B, '/', nil},
369         {0,    0x4C, 3, @"enter" },
370         {0x1B, 0x4E, '-', nil},
371         {0x18, 0x51, '=', nil},
372         {0x1D, 0x52, '0', nil},
373         {0x12, 0x53, '1', nil},
374         {0x13, 0x54, '2', nil},
375         {0x14, 0x55, '3', nil},
376         {0x15, 0x56, '4', nil},
377         {0x17, 0x57, '5', nil},
378         {0x16, 0x58, '6', nil},
379         {0x1A, 0x59, '7', nil},
380         {0x1C, 0x5B, '8', nil},
381         {0x19, 0x5C, '9', nil},
382     };
383     for (unsigned i = 0; i < WTF_ARRAY_LENGTH(table); ++i) {
384         NSString* currentCharacterString = [NSString stringWithCharacters:&table[i].character length:1];
385         if ([character isEqualToString:currentCharacterString] || [character isEqualToString:table[i].characterName]) {
386             if (keyLocation == 0x03 /*DOM_KEY_LOCATION_NUMPAD*/)
387                 keyCode = table[i].macNumpadKeyCode;
388             else
389                 keyCode = table[i].macKeyCode;
390             eventCharacter = currentCharacterString;
391             break;
392         }
393     }
394
395     NSString *charactersIgnoringModifiers = eventCharacter;
396
397     int modifierFlags = 0;
398
399     if ([character length] == 1 && [character characterAtIndex:0] >= 'A' && [character characterAtIndex:0] <= 'Z') {
400         modifierFlags |= NSShiftKeyMask;
401         charactersIgnoringModifiers = [character lowercaseString];
402     }
403
404     modifierFlags |= buildModifierFlags(modifiers);
405
406     if (keyLocation == 0x03 /*DOM_KEY_LOCATION_NUMPAD*/)
407         modifierFlags |= NSNumericPadKeyMask;
408
409     // FIXME: [[[mainFrame frameView] documentView] layout];
410
411     NSEvent *event = [NSEvent keyEventWithType:NSKeyDown
412                         location:NSMakePoint(5, 5)
413                         modifierFlags:modifierFlags
414                         timestamp:absoluteTimeForEventTime(currentEventTime())
415                         windowNumber:[m_testController->mainWebView()->platformWindow() windowNumber]
416                         context:[NSGraphicsContext currentContext]
417                         characters:eventCharacter
418                         charactersIgnoringModifiers:charactersIgnoringModifiers
419                         isARepeat:NO
420                         keyCode:keyCode];
421
422     [NSApp _setCurrentEvent:event];
423     [[m_testController->mainWebView()->platformWindow() firstResponder] keyDown:event];
424     [NSApp _setCurrentEvent:nil];
425
426     event = [NSEvent keyEventWithType:NSKeyUp
427                         location:NSMakePoint(5, 5)
428                         modifierFlags:modifierFlags
429                         timestamp:absoluteTimeForEventTime(currentEventTime())
430                         windowNumber:[m_testController->mainWebView()->platformWindow() windowNumber]
431                         context:[NSGraphicsContext currentContext]
432                         characters:eventCharacter
433                         charactersIgnoringModifiers:charactersIgnoringModifiers
434                         isARepeat:NO
435                         keyCode:keyCode];
436
437     [NSApp _setCurrentEvent:event];
438     [[m_testController->mainWebView()->platformWindow() firstResponder] keyUp:event];
439     [NSApp _setCurrentEvent:nil];
440 }
441
442 void EventSenderProxy::mouseScrollBy(int x, int y)
443 {
444     RetainPtr<CGEventRef> cgScrollEvent = adoptCF(CGEventCreateScrollWheelEvent(0, kCGScrollEventUnitLine, 2, y, x));
445
446     // CGEvent locations are in global display coordinates.
447     CGPoint lastGlobalMousePosition = CGPointMake(m_position.x, [[NSScreen mainScreen] frame].size.height - m_position.y);
448     CGEventSetLocation(cgScrollEvent.get(), lastGlobalMousePosition);
449
450     NSEvent *event = [NSEvent eventWithCGEvent:cgScrollEvent.get()];
451     if (NSView *targetView = [m_testController->mainWebView()->platformView() hitTest:[event locationInWindow]]) {
452         [NSApp _setCurrentEvent:event];
453         [targetView scrollWheel:event];
454         [NSApp _setCurrentEvent:nil];
455     }
456 }
457
458 void EventSenderProxy::continuousMouseScrollBy(int x, int y, bool paged)
459 {
460     // FIXME: Implement this.
461     return;
462 }
463
464 #if MAC_OS_X_VERSION_MAX_ALLOWED < 1090
465 const uint32_t kCGScrollWheelEventMomentumPhase = 123;
466 #endif
467
468 void EventSenderProxy::mouseScrollByWithWheelAndMomentumPhases(int x, int y, int phase, int momentum)
469 {
470     RetainPtr<CGEventRef> cgScrollEvent = adoptCF(CGEventCreateScrollWheelEvent(0, kCGScrollEventUnitLine, 2, y, x));
471
472     // CGEvent locations are in global display coordinates.
473     CGPoint lastGlobalMousePosition = CGPointMake(m_position.x, [[NSScreen mainScreen] frame].size.height - m_position.y);
474     CGEventSetLocation(cgScrollEvent.get(), lastGlobalMousePosition);
475
476     CGEventSetIntegerValueField(cgScrollEvent.get(), kCGScrollWheelEventIsContinuous, 1);
477     CGEventSetIntegerValueField(cgScrollEvent.get(), kCGScrollWheelEventScrollPhase, phase);
478     CGEventSetIntegerValueField(cgScrollEvent.get(), kCGScrollWheelEventMomentumPhase, momentum);
479
480     NSEvent* event = [NSEvent eventWithCGEvent: cgScrollEvent.get()];
481
482     // Our event should have the correct settings:
483     if (NSView *targetView = [m_testController->mainWebView()->platformView() hitTest: [event locationInWindow]]) {
484         [NSApp _setCurrentEvent: event];
485         [targetView scrollWheel: event];
486         [NSApp _setCurrentEvent: nil];
487     }
488 }
489
490 } // namespace WTR