[Chromium] Fix broken DRT build for Aura Linux
[WebKit-https.git] / Tools / DumpRenderTree / chromium / EventSender.cpp
1 /*
2  * Copyright (C) 2010 Google 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 are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 // This file contains the definition for EventSender.
32 //
33 // Some notes about drag and drop handling:
34 // Windows drag and drop goes through a system call to doDragDrop. At that
35 // point, program control is given to Windows which then periodically makes
36 // callbacks into the webview. This won't work for layout tests, so instead,
37 // we queue up all the mouse move and mouse up events. When the test tries to
38 // start a drag (by calling EvenSendingController::doDragDrop), we take the
39 // events in the queue and replay them.
40 // The behavior of queuing events and replaying them can be disabled by a
41 // layout test by setting eventSender.dragMode to false.
42
43 #include "config.h"
44 #include "EventSender.h"
45
46 #include "TestShell.h"
47 #include "WebContextMenuData.h"
48 #include "WebDragData.h"
49 #include "WebDragOperation.h"
50 #include "WebPoint.h"
51 #include "WebString.h"
52 #include "WebTouchPoint.h"
53 #include "WebView.h"
54 #include "webkit/support/webkit_support.h"
55 #include <wtf/Deque.h>
56 #include <wtf/StringExtras.h>
57
58 #if OS(WINDOWS)
59 #include "win/WebInputEventFactory.h"
60 #endif
61
62 // FIXME: layout before each event?
63
64 using namespace std;
65 using namespace WebKit;
66
67 WebPoint EventSender::lastMousePos;
68 WebMouseEvent::Button EventSender::pressedButton = WebMouseEvent::ButtonNone;
69 WebMouseEvent::Button EventSender::lastButtonType = WebMouseEvent::ButtonNone;
70
71 struct SavedEvent {
72     enum SavedEventType {
73         Unspecified,
74         MouseUp,
75         MouseMove,
76         LeapForward
77     };
78
79     SavedEventType type;
80     WebMouseEvent::Button buttonType; // For MouseUp.
81     WebPoint pos; // For MouseMove.
82     int milliseconds; // For LeapForward.
83
84     SavedEvent()
85         : type(Unspecified)
86         , buttonType(WebMouseEvent::ButtonNone)
87         , milliseconds(0) { }
88 };
89
90 static WebDragData currentDragData;
91 static WebDragOperation currentDragEffect;
92 static WebDragOperationsMask currentDragEffectsAllowed;
93 static bool replayingSavedEvents = false;
94 static Deque<SavedEvent> mouseEventQueue;
95 static int touchModifiers;
96 static Vector<WebTouchPoint> touchPoints;
97
98 // Time and place of the last mouse up event.
99 static double lastClickTimeSec = 0;
100 static WebPoint lastClickPos;
101 static int clickCount = 0;
102
103 // maximum distance (in space and time) for a mouse click
104 // to register as a double or triple click
105 static const double multipleClickTimeSec = 1;
106 static const int multipleClickRadiusPixels = 5;
107
108 // How much we should scroll per event - the value here is chosen to
109 // match the WebKit impl and layout test results.
110 static const float scrollbarPixelsPerTick = 40.0f;
111
112 inline bool outsideMultiClickRadius(const WebPoint& a, const WebPoint& b)
113 {
114     return ((a.x - b.x) * (a.x - b.x) + (a.y - b.y) * (a.y - b.y)) >
115         multipleClickRadiusPixels * multipleClickRadiusPixels;
116 }
117
118 // Used to offset the time the event hander things an event happened. This is
119 // done so tests can run without a delay, but bypass checks that are time
120 // dependent (e.g., dragging has a timeout vs selection).
121 static uint32 timeOffsetMs = 0;
122
123 static double getCurrentEventTimeSec()
124 {
125     return (webkit_support::GetCurrentTimeInMillisecond() + timeOffsetMs) / 1000.0;
126 }
127
128 static void advanceEventTime(int32_t deltaMs)
129 {
130     timeOffsetMs += deltaMs;
131 }
132
133 static void initMouseEvent(WebInputEvent::Type t, WebMouseEvent::Button b,
134                            const WebPoint& pos, WebMouseEvent* e)
135 {
136     e->type = t;
137     e->button = b;
138     e->modifiers = 0;
139     e->x = pos.x;
140     e->y = pos.y;
141     e->globalX = pos.x;
142     e->globalY = pos.y;
143     e->timeStampSeconds = getCurrentEventTimeSec();
144     e->clickCount = clickCount;
145 }
146
147 // Returns true if the specified key is the system key.
148 static bool applyKeyModifier(const string& modifierName, WebInputEvent* event)
149 {
150     bool isSystemKey = false;
151     const char* characters = modifierName.c_str();
152     if (!strcmp(characters, "ctrlKey")
153 #if !OS(MAC_OS_X)
154         || !strcmp(characters, "addSelectionKey")
155 #endif
156         ) {
157         event->modifiers |= WebInputEvent::ControlKey;
158     } else if (!strcmp(characters, "shiftKey") || !strcmp(characters, "rangeSelectionKey"))
159         event->modifiers |= WebInputEvent::ShiftKey;
160     else if (!strcmp(characters, "altKey")) {
161         event->modifiers |= WebInputEvent::AltKey;
162 #if !OS(MAC_OS_X)
163         // On Windows all keys with Alt modifier will be marked as system key.
164         // We keep the same behavior on Linux and everywhere non-Mac, see:
165         // WebKit/chromium/src/gtk/WebInputEventFactory.cpp
166         // If we want to change this behavior on Linux, this piece of code must be
167         // kept in sync with the related code in above file.
168         isSystemKey = true;
169 #endif
170 #if OS(MAC_OS_X)
171     } else if (!strcmp(characters, "metaKey") || !strcmp(characters, "addSelectionKey")) {
172         event->modifiers |= WebInputEvent::MetaKey;
173         // On Mac only command key presses are marked as system key.
174         // See the related code in: WebKit/chromium/src/mac/WebInputEventFactory.cpp
175         // It must be kept in sync with the related code in above file.
176         isSystemKey = true;
177 #else
178     } else if (!strcmp(characters, "metaKey")) {
179         event->modifiers |= WebInputEvent::MetaKey;
180 #endif
181     }
182     return isSystemKey;
183 }
184
185 static bool applyKeyModifiers(const CppVariant* argument, WebInputEvent* event)
186 {
187     bool isSystemKey = false;
188     if (argument->isObject()) {
189         Vector<string> modifiers = argument->toStringVector();
190         for (Vector<string>::const_iterator i = modifiers.begin(); i != modifiers.end(); ++i)
191             isSystemKey |= applyKeyModifier(*i, event);
192     } else if (argument->isString())
193         isSystemKey = applyKeyModifier(argument->toString(), event);
194     return isSystemKey;
195 }
196
197 // Get the edit command corresponding to a keyboard event.
198 // Returns true if the specified event corresponds to an edit command, the name
199 // of the edit command will be stored in |*name|.
200 bool getEditCommand(const WebKeyboardEvent& event, string* name)
201 {
202 #if OS(MAC_OS_X)
203     // We only cares about Left,Right,Up,Down keys with Command or Command+Shift
204     // modifiers. These key events correspond to some special movement and
205     // selection editor commands, and was supposed to be handled in
206     // WebKit/chromium/src/EditorClientImpl.cpp. But these keys will be marked
207     // as system key, which prevents them from being handled. Thus they must be
208     // handled specially.
209     if ((event.modifiers & ~WebKeyboardEvent::ShiftKey) != WebKeyboardEvent::MetaKey)
210         return false;
211
212     switch (event.windowsKeyCode) {
213     case webkit_support::VKEY_LEFT:
214         *name = "MoveToBeginningOfLine";
215         break;
216     case webkit_support::VKEY_RIGHT:
217         *name = "MoveToEndOfLine";
218         break;
219     case webkit_support::VKEY_UP:
220         *name = "MoveToBeginningOfDocument";
221         break;
222     case webkit_support::VKEY_DOWN:
223         *name = "MoveToEndOfDocument";
224         break;
225     default:
226         return false;
227     }
228
229     if (event.modifiers & WebKeyboardEvent::ShiftKey)
230         name->append("AndModifySelection");
231
232     return true;
233 #else
234     return false;
235 #endif
236 }
237
238 // Key event location code introduced in DOM Level 3.
239 // See also: http://www.w3.org/TR/DOM-Level-3-Events/#events-keyboardevents
240 enum KeyLocationCode {
241     DOMKeyLocationStandard      = 0x00,
242     DOMKeyLocationLeft          = 0x01,
243     DOMKeyLocationRight         = 0x02,
244     DOMKeyLocationNumpad        = 0x03
245 };
246
247 EventSender::EventSender(TestShell* shell)
248     : m_shell(shell)
249 {
250     // Initialize the map that associates methods of this class with the names
251     // they will use when called by JavaScript. The actual binding of those
252     // names to their methods will be done by calling bindToJavaScript() (defined
253     // by CppBoundClass, the parent to EventSender).
254     bindMethod("addTouchPoint", &EventSender::addTouchPoint);
255     bindMethod("beginDragWithFiles", &EventSender::beginDragWithFiles);
256     bindMethod("cancelTouchPoint", &EventSender::cancelTouchPoint);
257     bindMethod("clearKillRing", &EventSender::clearKillRing);
258     bindMethod("clearTouchPoints", &EventSender::clearTouchPoints);
259     bindMethod("contextClick", &EventSender::contextClick);
260     bindMethod("continuousMouseScrollBy", &EventSender::continuousMouseScrollBy);
261     bindMethod("dispatchMessage", &EventSender::dispatchMessage);
262     bindMethod("dumpFilenameBeingDragged", &EventSender::dumpFilenameBeingDragged);
263     bindMethod("enableDOMUIEventLogging", &EventSender::enableDOMUIEventLogging);
264     bindMethod("fireKeyboardEventsToElement", &EventSender::fireKeyboardEventsToElement);
265     bindMethod("keyDown", &EventSender::keyDown);
266     bindMethod("leapForward", &EventSender::leapForward);
267     bindMethod("mouseDown", &EventSender::mouseDown);
268     bindMethod("mouseMoveTo", &EventSender::mouseMoveTo);
269     bindMethod("mouseScrollBy", &EventSender::mouseScrollBy);
270     bindMethod("mouseUp", &EventSender::mouseUp);
271     bindMethod("releaseTouchPoint", &EventSender::releaseTouchPoint);
272     bindMethod("scheduleAsynchronousClick", &EventSender::scheduleAsynchronousClick);
273     bindMethod("setTouchModifier", &EventSender::setTouchModifier);
274     bindMethod("textZoomIn", &EventSender::textZoomIn);
275     bindMethod("textZoomOut", &EventSender::textZoomOut);
276     bindMethod("touchCancel", &EventSender::touchCancel);
277     bindMethod("touchEnd", &EventSender::touchEnd);
278     bindMethod("touchMove", &EventSender::touchMove);
279     bindMethod("touchStart", &EventSender::touchStart);
280     bindMethod("updateTouchPoint", &EventSender::updateTouchPoint);
281     bindMethod("gestureScrollBegin", &EventSender::gestureScrollBegin);
282     bindMethod("gestureScrollEnd", &EventSender::gestureScrollEnd);
283     bindMethod("gestureScrollUpdate", &EventSender::gestureScrollUpdate);
284     bindMethod("gestureTap", &EventSender::gestureTap);
285     bindMethod("zoomPageIn", &EventSender::zoomPageIn);
286     bindMethod("zoomPageOut", &EventSender::zoomPageOut);
287     bindMethod("scalePageBy", &EventSender::scalePageBy);
288
289     // When set to true (the default value), we batch mouse move and mouse up
290     // events so we can simulate drag & drop.
291     bindProperty("dragMode", &dragMode);
292 #if OS(WINDOWS)
293     bindProperty("WM_KEYDOWN", &wmKeyDown);
294     bindProperty("WM_KEYUP", &wmKeyUp);
295     bindProperty("WM_CHAR", &wmChar);
296     bindProperty("WM_DEADCHAR", &wmDeadChar);
297     bindProperty("WM_SYSKEYDOWN", &wmSysKeyDown);
298     bindProperty("WM_SYSKEYUP", &wmSysKeyUp);
299     bindProperty("WM_SYSCHAR", &wmSysChar);
300     bindProperty("WM_SYSDEADCHAR", &wmSysDeadChar);
301 #endif
302 }
303
304 void EventSender::reset()
305 {
306     // The test should have finished a drag and the mouse button state.
307     ASSERT(currentDragData.isNull());
308     currentDragData.reset();
309     currentDragEffect = WebKit::WebDragOperationNone;
310     currentDragEffectsAllowed = WebKit::WebDragOperationNone;
311     pressedButton = WebMouseEvent::ButtonNone;
312     dragMode.set(true);
313 #if OS(WINDOWS)
314     wmKeyDown.set(WM_KEYDOWN);
315     wmKeyUp.set(WM_KEYUP);
316     wmChar.set(WM_CHAR);
317     wmDeadChar.set(WM_DEADCHAR);
318     wmSysKeyDown.set(WM_SYSKEYDOWN);
319     wmSysKeyUp.set(WM_SYSKEYUP);
320     wmSysChar.set(WM_SYSCHAR);
321     wmSysDeadChar.set(WM_SYSDEADCHAR);
322 #endif
323     lastMousePos = WebPoint(0, 0);
324     lastClickTimeSec = 0;
325     lastClickPos = WebPoint(0, 0);
326     clickCount = 0;
327     lastButtonType = WebMouseEvent::ButtonNone;
328     timeOffsetMs = 0;
329     touchModifiers = 0;
330     touchPoints.clear();
331     m_taskList.revokeAll();
332     m_gestureStartLocation = WebPoint(0, 0);
333 }
334
335 WebView* EventSender::webview()
336 {
337     return m_shell->webView();
338 }
339
340 void EventSender::doDragDrop(const WebDragData& dragData, WebDragOperationsMask mask)
341 {
342     WebMouseEvent event;
343     initMouseEvent(WebInputEvent::MouseDown, pressedButton, lastMousePos, &event);
344     WebPoint clientPoint(event.x, event.y);
345     WebPoint screenPoint(event.globalX, event.globalY);
346     currentDragData = dragData;
347     currentDragEffectsAllowed = mask;
348     currentDragEffect = webview()->dragTargetDragEnter(dragData, clientPoint, screenPoint, currentDragEffectsAllowed);
349
350     // Finish processing events.
351     replaySavedEvents();
352 }
353
354 void EventSender::dumpFilenameBeingDragged(const CppArgumentList&, CppVariant*)
355 {
356     printf("Filename being dragged: %s\n", currentDragData.fileContentFilename().utf8().data());
357 }
358
359 WebMouseEvent::Button EventSender::getButtonTypeFromButtonNumber(int buttonCode)
360 {
361     if (!buttonCode)
362         return WebMouseEvent::ButtonLeft;
363     if (buttonCode == 2)
364         return WebMouseEvent::ButtonRight;
365     return WebMouseEvent::ButtonMiddle;
366 }
367
368 int EventSender::getButtonNumberFromSingleArg(const CppArgumentList& arguments)
369 {
370     int buttonCode = 0;
371     if (arguments.size() > 0 && arguments[0].isNumber())
372         buttonCode = arguments[0].toInt32();
373     return buttonCode;
374 }
375
376 void EventSender::updateClickCountForButton(WebMouseEvent::Button buttonType)
377 {
378     if ((getCurrentEventTimeSec() - lastClickTimeSec < multipleClickTimeSec)
379         && (!outsideMultiClickRadius(lastMousePos, lastClickPos))
380         && (buttonType == lastButtonType))
381         ++clickCount;
382     else {
383         clickCount = 1;
384         lastButtonType = buttonType;
385     }
386 }
387
388 //
389 // Implemented javascript methods.
390 //
391
392 void EventSender::mouseDown(const CppArgumentList& arguments, CppVariant* result)
393 {
394     if (result) // Could be 0 if invoked asynchronously.
395         result->setNull();
396
397     webview()->layout();
398
399     int buttonNumber = getButtonNumberFromSingleArg(arguments);
400     ASSERT(buttonNumber != -1);
401
402     WebMouseEvent::Button buttonType = getButtonTypeFromButtonNumber(buttonNumber);
403
404     updateClickCountForButton(buttonType);
405
406     WebMouseEvent event;
407     pressedButton = buttonType;
408     initMouseEvent(WebInputEvent::MouseDown, buttonType, lastMousePos, &event);
409     if (arguments.size() >= 2 && (arguments[1].isObject() || arguments[1].isString()))
410         applyKeyModifiers(&(arguments[1]), &event);
411     webview()->handleInputEvent(event);
412 }
413
414 void EventSender::mouseUp(const CppArgumentList& arguments, CppVariant* result)
415 {
416     if (result) // Could be 0 if invoked asynchronously.
417         result->setNull();
418
419     webview()->layout();
420
421     int buttonNumber = getButtonNumberFromSingleArg(arguments);
422     ASSERT(buttonNumber != -1);
423
424     WebMouseEvent::Button buttonType = getButtonTypeFromButtonNumber(buttonNumber);
425
426     if (isDragMode() && !replayingSavedEvents) {
427         SavedEvent savedEvent;
428         savedEvent.type = SavedEvent::MouseUp;
429         savedEvent.buttonType = buttonType;
430         mouseEventQueue.append(savedEvent);
431         replaySavedEvents();
432     } else {
433         WebMouseEvent event;
434         initMouseEvent(WebInputEvent::MouseUp, buttonType, lastMousePos, &event);
435         if (arguments.size() >= 2 && (arguments[1].isObject() || arguments[1].isString()))
436             applyKeyModifiers(&(arguments[1]), &event);
437         doMouseUp(event);
438     }
439 }
440
441 void EventSender::doMouseUp(const WebMouseEvent& e)
442 {
443     webview()->handleInputEvent(e);
444
445     pressedButton = WebMouseEvent::ButtonNone;
446     lastClickTimeSec = e.timeStampSeconds;
447     lastClickPos = lastMousePos;
448
449     // If we're in a drag operation, complete it.
450     if (currentDragData.isNull())
451         return;
452     WebPoint clientPoint(e.x, e.y);
453     WebPoint screenPoint(e.globalX, e.globalY);
454
455     currentDragEffect = webview()->dragTargetDragOver(clientPoint, screenPoint, currentDragEffectsAllowed);
456     if (currentDragEffect)
457         webview()->dragTargetDrop(clientPoint, screenPoint);
458     else
459         webview()->dragTargetDragLeave();
460     webview()->dragSourceEndedAt(clientPoint, screenPoint, currentDragEffect);
461     webview()->dragSourceSystemDragEnded();
462
463     currentDragData.reset();
464 }
465
466 void EventSender::mouseMoveTo(const CppArgumentList& arguments, CppVariant* result)
467 {
468     result->setNull();
469
470     if (arguments.size() < 2 || !arguments[0].isNumber() || !arguments[1].isNumber())
471         return;
472     webview()->layout();
473
474     WebPoint mousePos(arguments[0].toInt32(), arguments[1].toInt32());
475
476     if (isDragMode() && pressedButton == WebMouseEvent::ButtonLeft && !replayingSavedEvents) {
477         SavedEvent savedEvent;
478         savedEvent.type = SavedEvent::MouseMove;
479         savedEvent.pos = mousePos;
480         mouseEventQueue.append(savedEvent);
481     } else {
482         WebMouseEvent event;
483         initMouseEvent(WebInputEvent::MouseMove, pressedButton, mousePos, &event);
484         doMouseMove(event);
485     }
486 }
487
488 void EventSender::doMouseMove(const WebMouseEvent& e)
489 {
490     lastMousePos = WebPoint(e.x, e.y);
491
492     webview()->handleInputEvent(e);
493
494     if (pressedButton == WebMouseEvent::ButtonNone || currentDragData.isNull())
495         return;
496     WebPoint clientPoint(e.x, e.y);
497     WebPoint screenPoint(e.globalX, e.globalY);
498     currentDragEffect = webview()->dragTargetDragOver(clientPoint, screenPoint, currentDragEffectsAllowed);
499 }
500
501 void EventSender::keyDown(const CppArgumentList& arguments, CppVariant* result)
502 {
503     result->setNull();
504     if (arguments.size() < 1 || !arguments[0].isString())
505         return;
506     bool generateChar = false;
507
508     // FIXME: I'm not exactly sure how we should convert the string to a key
509     // event. This seems to work in the cases I tested.
510     // FIXME: Should we also generate a KEY_UP?
511     string codeStr = arguments[0].toString();
512
513     // Convert \n -> VK_RETURN. Some layout tests use \n to mean "Enter", when
514     // Windows uses \r for "Enter".
515     int code = 0;
516     int text = 0;
517     bool needsShiftKeyModifier = false;
518     if ("\n" == codeStr) {
519         generateChar = true;
520         text = code = webkit_support::VKEY_RETURN;
521     } else if ("rightArrow" == codeStr)
522         code = webkit_support::VKEY_RIGHT;
523     else if ("downArrow" == codeStr)
524         code = webkit_support::VKEY_DOWN;
525     else if ("leftArrow" == codeStr)
526         code = webkit_support::VKEY_LEFT;
527     else if ("upArrow" == codeStr)
528         code = webkit_support::VKEY_UP;
529     else if ("insert" == codeStr)
530         code = webkit_support::VKEY_INSERT;
531     else if ("delete" == codeStr)
532         code = webkit_support::VKEY_DELETE;
533     else if ("pageUp" == codeStr)
534         code = webkit_support::VKEY_PRIOR;
535     else if ("pageDown" == codeStr)
536         code = webkit_support::VKEY_NEXT;
537     else if ("home" == codeStr)
538         code = webkit_support::VKEY_HOME;
539     else if ("end" == codeStr)
540         code = webkit_support::VKEY_END;
541     else if ("printScreen" == codeStr)
542         code = webkit_support::VKEY_SNAPSHOT;
543     else if ("menu" == codeStr)
544         // FIXME: Change this to webkit_support::VKEY_APPS.
545         code = 0x5D;
546     else {
547         // Compare the input string with the function-key names defined by the
548         // DOM spec (i.e. "F1",...,"F24"). If the input string is a function-key
549         // name, set its key code.
550         for (int i = 1; i <= 24; ++i) {
551             char functionChars[10];
552             snprintf(functionChars, 10, "F%d", i);
553             string functionKeyName(functionChars);
554             if (functionKeyName == codeStr) {
555                 code = webkit_support::VKEY_F1 + (i - 1);
556                 break;
557             }
558         }
559         if (!code) {
560             WebString webCodeStr = WebString::fromUTF8(codeStr.data(), codeStr.size());
561             ASSERT(webCodeStr.length() == 1);
562             text = code = webCodeStr.data()[0];
563             needsShiftKeyModifier = needsShiftModifier(code);
564             if ((code & 0xFF) >= 'a' && (code & 0xFF) <= 'z')
565                 code -= 'a' - 'A';
566             generateChar = true;
567         }
568     }
569
570     // For one generated keyboard event, we need to generate a keyDown/keyUp
571     // pair; refer to EventSender.cpp in Tools/DumpRenderTree/win.
572     // On Windows, we might also need to generate a char event to mimic the
573     // Windows event flow; on other platforms we create a merged event and test
574     // the event flow that that platform provides.
575     WebKeyboardEvent eventDown, eventChar, eventUp;
576     eventDown.type = WebInputEvent::RawKeyDown;
577     eventDown.modifiers = 0;
578     eventDown.windowsKeyCode = code;
579 #if OS(LINUX) && USE(GTK)
580     eventDown.nativeKeyCode = webkit_support::NativeKeyCodeForWindowsKeyCode(code, needsShiftKeyModifier);
581 #endif
582
583     if (generateChar) {
584         eventDown.text[0] = text;
585         eventDown.unmodifiedText[0] = text;
586     }
587     eventDown.setKeyIdentifierFromWindowsKeyCode();
588
589     if (arguments.size() >= 2 && (arguments[1].isObject() || arguments[1].isString()))
590         eventDown.isSystemKey = applyKeyModifiers(&(arguments[1]), &eventDown);
591
592     if (needsShiftKeyModifier)
593         eventDown.modifiers |= WebInputEvent::ShiftKey;
594
595     // See if KeyLocation argument is given.
596     if (arguments.size() >= 3 && arguments[2].isNumber()) {
597         int location = arguments[2].toInt32();
598         if (location == DOMKeyLocationNumpad)
599             eventDown.modifiers |= WebInputEvent::IsKeyPad;
600     }
601
602     eventChar = eventUp = eventDown;
603     eventUp.type = WebInputEvent::KeyUp;
604     // EventSender.m forces a layout here, with at least one
605     // test (fast/forms/focus-control-to-page.html) relying on this.
606     webview()->layout();
607
608     // In the browser, if a keyboard event corresponds to an editor command,
609     // the command will be dispatched to the renderer just before dispatching
610     // the keyboard event, and then it will be executed in the
611     // RenderView::handleCurrentKeyboardEvent() method, which is called from
612     // third_party/WebKit/Source/WebKit/chromium/src/EditorClientImpl.cpp.
613     // We just simulate the same behavior here.
614     string editCommand;
615     if (getEditCommand(eventDown, &editCommand))
616         m_shell->webViewHost()->setEditCommand(editCommand, "");
617
618     webview()->handleInputEvent(eventDown);
619
620     m_shell->webViewHost()->clearEditCommand();
621
622     if (generateChar) {
623         eventChar.type = WebInputEvent::Char;
624         eventChar.keyIdentifier[0] = '\0';
625         webview()->handleInputEvent(eventChar);
626     }
627
628     webview()->handleInputEvent(eventUp);
629 }
630
631 void EventSender::dispatchMessage(const CppArgumentList& arguments, CppVariant* result)
632 {
633     result->setNull();
634
635 #if OS(WINDOWS)
636     if (arguments.size() == 3) {
637         // Grab the message id to see if we need to dispatch it.
638         int msg = arguments[0].toInt32();
639
640         // WebKit's version of this function stuffs a MSG struct and uses
641         // TranslateMessage and DispatchMessage. We use a WebKeyboardEvent, which
642         // doesn't need to receive the DeadChar and SysDeadChar messages.
643         if (msg == WM_DEADCHAR || msg == WM_SYSDEADCHAR)
644             return;
645
646         webview()->layout();
647
648         unsigned long lparam = static_cast<unsigned long>(arguments[2].toDouble());
649         webview()->handleInputEvent(WebInputEventFactory::keyboardEvent(0, msg, arguments[1].toInt32(), lparam));
650     } else
651         ASSERT_NOT_REACHED();
652 #endif
653 }
654
655 bool EventSender::needsShiftModifier(int keyCode)
656 {
657     // If code is an uppercase letter, assign a SHIFT key to
658     // eventDown.modifier, this logic comes from
659     // Tools/DumpRenderTree/win/EventSender.cpp
660     return (keyCode & 0xFF) >= 'A' && (keyCode & 0xFF) <= 'Z';
661 }
662
663 void EventSender::leapForward(const CppArgumentList& arguments, CppVariant* result)
664 {
665     result->setNull();
666
667     if (arguments.size() < 1 || !arguments[0].isNumber())
668         return;
669
670     int milliseconds = arguments[0].toInt32();
671     if (isDragMode() && pressedButton == WebMouseEvent::ButtonLeft && !replayingSavedEvents) {
672         SavedEvent savedEvent;
673         savedEvent.type = SavedEvent::LeapForward;
674         savedEvent.milliseconds = milliseconds;
675         mouseEventQueue.append(savedEvent);
676     } else
677         doLeapForward(milliseconds);
678 }
679
680 void EventSender::doLeapForward(int milliseconds)
681 {
682     advanceEventTime(milliseconds);
683 }
684
685 // Apple's port of WebKit zooms by a factor of 1.2 (see
686 // WebKit/WebView/WebView.mm)
687 void EventSender::textZoomIn(const CppArgumentList&, CppVariant* result)
688 {
689     webview()->setZoomLevel(true, webview()->zoomLevel() + 1);
690     result->setNull();
691 }
692
693 void EventSender::textZoomOut(const CppArgumentList&, CppVariant* result)
694 {
695     webview()->setZoomLevel(true, webview()->zoomLevel() - 1);
696     result->setNull();
697 }
698
699 void EventSender::zoomPageIn(const CppArgumentList&, CppVariant* result)
700 {
701     webview()->setZoomLevel(false, webview()->zoomLevel() + 1);
702     result->setNull();
703 }
704
705 void EventSender::zoomPageOut(const CppArgumentList&, CppVariant* result)
706 {
707     webview()->setZoomLevel(false, webview()->zoomLevel() - 1);
708     result->setNull();
709 }
710
711 void EventSender::scalePageBy(const CppArgumentList& arguments, CppVariant* result)
712 {
713     if (arguments.size() < 3 || !arguments[0].isNumber() || !arguments[1].isNumber() || !arguments[2].isNumber())
714         return;
715
716     float scaleFactor = static_cast<float>(arguments[0].toDouble());
717     int x = arguments[1].toInt32();
718     int y = arguments[2].toInt32();
719     webview()->setPageScaleFactor(scaleFactor, WebPoint(x, y));
720     result->setNull();
721 }
722
723 void EventSender::mouseScrollBy(const CppArgumentList& arguments, CppVariant* result)
724 {
725     handleMouseWheel(arguments, result, false);
726 }
727
728 void EventSender::continuousMouseScrollBy(const CppArgumentList& arguments, CppVariant* result)
729 {
730     handleMouseWheel(arguments, result, true);
731 }
732
733 void EventSender::replaySavedEvents()
734 {
735     replayingSavedEvents = true;
736     while (!mouseEventQueue.isEmpty()) {
737         SavedEvent e = mouseEventQueue.takeFirst();
738
739         switch (e.type) {
740         case SavedEvent::MouseMove: {
741             WebMouseEvent event;
742             initMouseEvent(WebInputEvent::MouseMove, pressedButton, e.pos, &event);
743             doMouseMove(event);
744             break;
745         }
746         case SavedEvent::LeapForward:
747             doLeapForward(e.milliseconds);
748             break;
749         case SavedEvent::MouseUp: {
750             WebMouseEvent event;
751             initMouseEvent(WebInputEvent::MouseUp, e.buttonType, lastMousePos, &event);
752             doMouseUp(event);
753             break;
754         }
755         default:
756             ASSERT_NOT_REACHED();
757         }
758     }
759
760     replayingSavedEvents = false;
761 }
762
763 // Because actual context menu is implemented by the browser side, 
764 // this function does only what LayoutTests are expecting:
765 // - Many test checks the count of items. So returning non-zero value makes sense.
766 // - Some test compares the count before and after some action. So changing the count based on flags
767 //   also makes sense. This function is doing such for some flags.
768 // - Some test even checks actual string content. So providing it would be also helpful.
769 //
770 static Vector<WebString> makeMenuItemStringsFor(WebContextMenuData* contextMenu, MockSpellCheck* spellcheck)
771 {
772     // These constants are based on Safari's context menu because tests are made for it.
773     static const char* nonEditableMenuStrings[] = { "Back", "Reload Page", "Open in Dashbaord", "<separator>", "View Source", "Save Page As", "Print Page", "Inspect Element", 0 };
774     static const char* editableMenuStrings[] = { "Cut", "Copy", "<separator>", "Paste", "Spelling and Grammar", "Substitutions, Transformations", "Font", "Speech", "Paragraph Direction", "<separator>", 0 };
775
776     // This is possible because mouse events are cancelleable.
777     if (!contextMenu)
778         return Vector<WebString>();
779
780     Vector<WebString> strings;
781
782     if (contextMenu->isEditable) {
783         for (const char** item = editableMenuStrings; *item; ++item) 
784             strings.append(WebString::fromUTF8(*item));
785         Vector<WebString> suggestions;
786         spellcheck->fillSuggestionList(contextMenu->misspelledWord, &suggestions);
787         for (size_t i = 0; i < suggestions.size(); ++i) 
788             strings.append(suggestions[i]);
789     } else {
790         for (const char** item = nonEditableMenuStrings; *item; ++item) 
791             strings.append(WebString::fromUTF8(*item));
792     }
793
794     return strings;
795 }
796
797
798 void EventSender::contextClick(const CppArgumentList& arguments, CppVariant* result)
799 {
800     webview()->layout();
801
802     updateClickCountForButton(WebMouseEvent::ButtonRight);
803
804     // Clears last context menu data because we need to know if the context menu be requested 
805     // after following mouse events.
806     m_shell->webViewHost()->clearContextMenuData();
807
808     // Generate right mouse down and up.
809     WebMouseEvent event;
810     pressedButton = WebMouseEvent::ButtonRight;
811     initMouseEvent(WebInputEvent::MouseDown, WebMouseEvent::ButtonRight, lastMousePos, &event);
812     webview()->handleInputEvent(event);
813
814     initMouseEvent(WebInputEvent::MouseUp, WebMouseEvent::ButtonRight, lastMousePos, &event);
815     webview()->handleInputEvent(event);
816
817     pressedButton = WebMouseEvent::ButtonNone;
818
819     WebContextMenuData* lastContextMenu = m_shell->webViewHost()->lastContextMenuData();
820     result->set(WebBindings::makeStringArray(makeMenuItemStringsFor(lastContextMenu, m_shell->webViewHost()->mockSpellCheck())));
821 }
822
823 class MouseDownTask: public MethodTask<EventSender> {
824 public:
825     MouseDownTask(EventSender* obj, const CppArgumentList& arg)
826         : MethodTask<EventSender>(obj), m_arguments(arg) { }
827     virtual void runIfValid() { m_object->mouseDown(m_arguments, 0); }
828
829 private:
830     CppArgumentList m_arguments;
831 };
832
833 class MouseUpTask: public MethodTask<EventSender> {
834 public:
835     MouseUpTask(EventSender* obj, const CppArgumentList& arg)
836         : MethodTask<EventSender>(obj), m_arguments(arg) { }
837     virtual void runIfValid() { m_object->mouseUp(m_arguments, 0); }
838
839 private:
840     CppArgumentList m_arguments;
841 };
842
843 void EventSender::scheduleAsynchronousClick(const CppArgumentList& arguments, CppVariant* result)
844 {
845     result->setNull();
846     postTask(new MouseDownTask(this, arguments));
847     postTask(new MouseUpTask(this, arguments));
848 }
849
850 void EventSender::beginDragWithFiles(const CppArgumentList& arguments, CppVariant* result)
851 {
852     currentDragData.initialize();
853     Vector<string> files = arguments[0].toStringVector();
854     for (size_t i = 0; i < files.size(); ++i)
855         currentDragData.appendToFilenames(webkit_support::GetAbsoluteWebStringFromUTF8Path(files[i]));
856     currentDragEffectsAllowed = WebKit::WebDragOperationCopy;
857
858     // Provide a drag source.
859     webview()->dragTargetDragEnter(currentDragData, lastMousePos, lastMousePos, currentDragEffectsAllowed);
860
861     // dragMode saves events and then replays them later. We don't need/want that.
862     dragMode.set(false);
863
864     // Make the rest of eventSender think a drag is in progress.
865     pressedButton = WebMouseEvent::ButtonLeft;
866
867     result->setNull();
868 }
869
870 void EventSender::addTouchPoint(const CppArgumentList& arguments, CppVariant* result)
871 {
872     result->setNull();
873
874     WebTouchPoint touchPoint;
875     touchPoint.state = WebTouchPoint::StatePressed;
876     touchPoint.position = WebPoint(arguments[0].toInt32(), arguments[1].toInt32());
877     touchPoint.screenPosition = touchPoint.position;
878
879     int lowestId = 0;
880     for (size_t i = 0; i < touchPoints.size(); i++) {
881         if (touchPoints[i].id == lowestId)
882             lowestId++;
883     }
884     touchPoint.id = lowestId;
885     touchPoints.append(touchPoint);
886 }
887
888 void EventSender::clearTouchPoints(const CppArgumentList&, CppVariant* result)
889 {
890     result->setNull();
891     touchPoints.clear();
892 }
893
894 void EventSender::releaseTouchPoint(const CppArgumentList& arguments, CppVariant* result)
895 {
896     result->setNull();
897
898     const unsigned index = arguments[0].toInt32();
899     ASSERT(index < touchPoints.size());
900
901     WebTouchPoint* touchPoint = &touchPoints[index];
902     touchPoint->state = WebTouchPoint::StateReleased;
903 }
904
905 void EventSender::setTouchModifier(const CppArgumentList& arguments, CppVariant* result)
906 {
907     result->setNull();
908
909     int mask = 0;
910     const string keyName = arguments[0].toString();
911     if (keyName == "shift")
912         mask = WebInputEvent::ShiftKey;
913     else if (keyName == "alt")
914         mask = WebInputEvent::AltKey;
915     else if (keyName == "ctrl")
916         mask = WebInputEvent::ControlKey;
917     else if (keyName == "meta")
918         mask = WebInputEvent::MetaKey;
919
920     if (arguments[1].toBoolean())
921         touchModifiers |= mask;
922     else
923         touchModifiers &= ~mask;
924 }
925
926 void EventSender::updateTouchPoint(const CppArgumentList& arguments, CppVariant* result)
927 {
928     result->setNull();
929
930     const unsigned index = arguments[0].toInt32();
931     ASSERT(index < touchPoints.size());
932
933     WebPoint position(arguments[1].toInt32(), arguments[2].toInt32());
934     WebTouchPoint* touchPoint = &touchPoints[index];
935     touchPoint->state = WebTouchPoint::StateMoved;
936     touchPoint->position = position;
937     touchPoint->screenPosition = position;
938 }
939
940 void EventSender::cancelTouchPoint(const CppArgumentList& arguments, CppVariant* result)
941 {
942     result->setNull();
943
944     const unsigned index = arguments[0].toInt32();
945     ASSERT(index < touchPoints.size());
946
947     WebTouchPoint* touchPoint = &touchPoints[index];
948     touchPoint->state = WebTouchPoint::StateCancelled;
949 }
950
951 void EventSender::sendCurrentTouchEvent(const WebInputEvent::Type type)
952 {
953     ASSERT(static_cast<unsigned>(WebTouchEvent::touchesLengthCap) > touchPoints.size());
954     webview()->layout();
955
956     WebTouchEvent touchEvent;
957     touchEvent.type = type;
958     touchEvent.modifiers = touchModifiers;
959     touchEvent.timeStampSeconds = getCurrentEventTimeSec();
960     touchEvent.touchesLength = touchPoints.size();
961     for (unsigned i = 0; i < touchPoints.size(); ++i)
962         touchEvent.touches[i] = touchPoints[i];
963     webview()->handleInputEvent(touchEvent);
964
965     for (unsigned i = 0; i < touchPoints.size(); ++i) {
966         WebTouchPoint* touchPoint = &touchPoints[i];
967         if (touchPoint->state == WebTouchPoint::StateReleased) {
968             touchPoints.remove(i);
969             --i;
970         } else
971             touchPoint->state = WebTouchPoint::StateStationary;
972     }
973 }
974
975 void EventSender::handleMouseWheel(const CppArgumentList& arguments, CppVariant* result, bool continuous)
976 {
977     result->setNull();
978
979     if (arguments.size() < 2 || !arguments[0].isNumber() || !arguments[1].isNumber())
980         return;
981
982     // Force a layout here just to make sure every position has been
983     // determined before we send events (as well as all the other methods
984     // that send an event do).
985     webview()->layout();
986
987     int horizontal = arguments[0].toInt32();
988     int vertical = arguments[1].toInt32();
989     int paged = false;
990
991     if (arguments.size() > 2 && arguments[2].isBool())
992         paged = arguments[2].toBoolean();
993
994     WebMouseWheelEvent event;
995     initMouseEvent(WebInputEvent::MouseWheel, pressedButton, lastMousePos, &event);
996     event.wheelTicksX = static_cast<float>(horizontal);
997     event.wheelTicksY = static_cast<float>(vertical);
998     event.deltaX = event.wheelTicksX;
999     event.deltaY = event.wheelTicksY;
1000     event.scrollByPage = paged;
1001     if (continuous) {
1002         event.wheelTicksX /= scrollbarPixelsPerTick;
1003         event.wheelTicksY /= scrollbarPixelsPerTick;
1004     } else {
1005         event.deltaX *= scrollbarPixelsPerTick;
1006         event.deltaY *= scrollbarPixelsPerTick;
1007     }
1008     webview()->handleInputEvent(event);
1009 }
1010
1011 void EventSender::touchEnd(const CppArgumentList&, CppVariant* result)
1012 {
1013     result->setNull();
1014     sendCurrentTouchEvent(WebInputEvent::TouchEnd);
1015 }
1016
1017 void EventSender::touchMove(const CppArgumentList&, CppVariant* result)
1018 {
1019     result->setNull();
1020     sendCurrentTouchEvent(WebInputEvent::TouchMove);
1021 }
1022
1023 void EventSender::touchStart(const CppArgumentList&, CppVariant* result)
1024 {
1025     result->setNull();
1026     sendCurrentTouchEvent(WebInputEvent::TouchStart);
1027 }
1028
1029 void EventSender::touchCancel(const CppArgumentList&, CppVariant* result)
1030 {
1031     result->setNull();
1032     sendCurrentTouchEvent(WebInputEvent::TouchCancel);
1033 }
1034
1035 void EventSender::gestureScrollBegin(const CppArgumentList& arguments, CppVariant* result)
1036 {
1037     result->setNull();
1038     gestureEvent(WebInputEvent::GestureScrollBegin, arguments);
1039 }
1040
1041 void EventSender::gestureScrollEnd(const CppArgumentList& arguments, CppVariant* result)
1042 {
1043     result->setNull();
1044     gestureEvent(WebInputEvent::GestureScrollEnd, arguments);
1045 }
1046
1047 void EventSender::gestureScrollUpdate(const CppArgumentList& arguments, CppVariant* result)
1048 {
1049     result->setNull();
1050     gestureEvent(WebInputEvent::GestureScrollUpdate, arguments);
1051 }
1052
1053 void EventSender::gestureTap(const CppArgumentList& arguments, CppVariant* result)
1054 {
1055     result->setNull();
1056     gestureEvent(WebInputEvent::GestureTap, arguments);
1057 }
1058
1059 void EventSender::gestureEvent(WebInputEvent::Type type, const CppArgumentList& arguments)
1060 {
1061     if (arguments.size() < 2 || !arguments[0].isNumber() || !arguments[1].isNumber())
1062         return;
1063
1064     WebPoint point(arguments[0].toInt32(), arguments[1].toInt32());
1065
1066     WebGestureEvent event;
1067     event.type = type;
1068
1069     switch (type) {
1070     case WebInputEvent::GestureScrollUpdate:
1071         event.deltaX = static_cast<float>(arguments[0].toDouble());
1072         event.deltaY = static_cast<float>(arguments[1].toDouble());
1073         event.x = m_gestureStartLocation.x + event.deltaX;
1074         event.y = m_gestureStartLocation.y + event.deltaY;
1075         break;
1076
1077     case WebInputEvent::GestureScrollBegin:
1078         m_gestureStartLocation = WebPoint(point.x, point.y);
1079         // Fallthrough
1080     case WebInputEvent::GestureScrollEnd:
1081     case WebInputEvent::GestureTap:
1082         event.x = point.x;
1083         event.y = point.y;
1084         break;
1085     default:
1086         ASSERT_NOT_REACHED();
1087     }
1088
1089     event.globalX = event.x;
1090     event.globalY = event.y;
1091     event.timeStampSeconds = getCurrentEventTimeSec();
1092     webview()->handleInputEvent(event);
1093 }
1094
1095 //
1096 // Unimplemented stubs
1097 //
1098
1099 void EventSender::enableDOMUIEventLogging(const CppArgumentList&, CppVariant* result)
1100 {
1101     result->setNull();
1102 }
1103
1104 void EventSender::fireKeyboardEventsToElement(const CppArgumentList&, CppVariant* result)
1105 {
1106     result->setNull();
1107 }
1108
1109 void EventSender::clearKillRing(const CppArgumentList&, CppVariant* result)
1110 {
1111     result->setNull();
1112 }