bfee0778289689379f98fc535d974591e7b77198
[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("zoomPageIn", &EventSender::zoomPageIn);
282     bindMethod("zoomPageOut", &EventSender::zoomPageOut);
283
284     // When set to true (the default value), we batch mouse move and mouse up
285     // events so we can simulate drag & drop.
286     bindProperty("dragMode", &dragMode);
287 #if OS(WINDOWS)
288     bindProperty("WM_KEYDOWN", &wmKeyDown);
289     bindProperty("WM_KEYUP", &wmKeyUp);
290     bindProperty("WM_CHAR", &wmChar);
291     bindProperty("WM_DEADCHAR", &wmDeadChar);
292     bindProperty("WM_SYSKEYDOWN", &wmSysKeyDown);
293     bindProperty("WM_SYSKEYUP", &wmSysKeyUp);
294     bindProperty("WM_SYSCHAR", &wmSysChar);
295     bindProperty("WM_SYSDEADCHAR", &wmSysDeadChar);
296 #endif
297 }
298
299 void EventSender::reset()
300 {
301     // The test should have finished a drag and the mouse button state.
302     ASSERT(currentDragData.isNull());
303     currentDragData.reset();
304     currentDragEffect = WebKit::WebDragOperationNone;
305     currentDragEffectsAllowed = WebKit::WebDragOperationNone;
306     pressedButton = WebMouseEvent::ButtonNone;
307     dragMode.set(true);
308 #if OS(WINDOWS)
309     wmKeyDown.set(WM_KEYDOWN);
310     wmKeyUp.set(WM_KEYUP);
311     wmChar.set(WM_CHAR);
312     wmDeadChar.set(WM_DEADCHAR);
313     wmSysKeyDown.set(WM_SYSKEYDOWN);
314     wmSysKeyUp.set(WM_SYSKEYUP);
315     wmSysChar.set(WM_SYSCHAR);
316     wmSysDeadChar.set(WM_SYSDEADCHAR);
317 #endif
318     lastMousePos = WebPoint(0, 0);
319     lastClickTimeSec = 0;
320     lastClickPos = WebPoint(0, 0);
321     clickCount = 0;
322     lastButtonType = WebMouseEvent::ButtonNone;
323     timeOffsetMs = 0;
324     touchModifiers = 0;
325     touchPoints.clear();
326     m_taskList.revokeAll();
327 }
328
329 WebView* EventSender::webview()
330 {
331     return m_shell->webView();
332 }
333
334 void EventSender::doDragDrop(const WebDragData& dragData, WebDragOperationsMask mask)
335 {
336     WebMouseEvent event;
337     initMouseEvent(WebInputEvent::MouseDown, pressedButton, lastMousePos, &event);
338     WebPoint clientPoint(event.x, event.y);
339     WebPoint screenPoint(event.globalX, event.globalY);
340     currentDragData = dragData;
341     currentDragEffectsAllowed = mask;
342     currentDragEffect = webview()->dragTargetDragEnter(dragData, clientPoint, screenPoint, currentDragEffectsAllowed);
343
344     // Finish processing events.
345     replaySavedEvents();
346 }
347
348 void EventSender::dumpFilenameBeingDragged(const CppArgumentList&, CppVariant*)
349 {
350     printf("Filename being dragged: %s\n", currentDragData.fileContentFilename().utf8().data());
351 }
352
353 WebMouseEvent::Button EventSender::getButtonTypeFromButtonNumber(int buttonCode)
354 {
355     if (!buttonCode)
356         return WebMouseEvent::ButtonLeft;
357     if (buttonCode == 2)
358         return WebMouseEvent::ButtonRight;
359     return WebMouseEvent::ButtonMiddle;
360 }
361
362 int EventSender::getButtonNumberFromSingleArg(const CppArgumentList& arguments)
363 {
364     int buttonCode = 0;
365     if (arguments.size() > 0 && arguments[0].isNumber())
366         buttonCode = arguments[0].toInt32();
367     return buttonCode;
368 }
369
370 void EventSender::updateClickCountForButton(WebMouseEvent::Button buttonType)
371 {
372     if ((getCurrentEventTimeSec() - lastClickTimeSec < multipleClickTimeSec)
373         && (!outsideMultiClickRadius(lastMousePos, lastClickPos))
374         && (buttonType == lastButtonType))
375         ++clickCount;
376     else {
377         clickCount = 1;
378         lastButtonType = buttonType;
379     }
380 }
381
382 //
383 // Implemented javascript methods.
384 //
385
386 void EventSender::mouseDown(const CppArgumentList& arguments, CppVariant* result)
387 {
388     if (result) // Could be 0 if invoked asynchronously.
389         result->setNull();
390
391     webview()->layout();
392
393     int buttonNumber = getButtonNumberFromSingleArg(arguments);
394     ASSERT(buttonNumber != -1);
395
396     WebMouseEvent::Button buttonType = getButtonTypeFromButtonNumber(buttonNumber);
397
398     updateClickCountForButton(buttonType);
399
400     WebMouseEvent event;
401     pressedButton = buttonType;
402     initMouseEvent(WebInputEvent::MouseDown, buttonType, lastMousePos, &event);
403     if (arguments.size() >= 2 && (arguments[1].isObject() || arguments[1].isString()))
404         applyKeyModifiers(&(arguments[1]), &event);
405     webview()->handleInputEvent(event);
406 }
407
408 void EventSender::mouseUp(const CppArgumentList& arguments, CppVariant* result)
409 {
410     if (result) // Could be 0 if invoked asynchronously.
411         result->setNull();
412
413     webview()->layout();
414
415     int buttonNumber = getButtonNumberFromSingleArg(arguments);
416     ASSERT(buttonNumber != -1);
417
418     WebMouseEvent::Button buttonType = getButtonTypeFromButtonNumber(buttonNumber);
419
420     if (isDragMode() && !replayingSavedEvents) {
421         SavedEvent savedEvent;
422         savedEvent.type = SavedEvent::MouseUp;
423         savedEvent.buttonType = buttonType;
424         mouseEventQueue.append(savedEvent);
425         replaySavedEvents();
426     } else {
427         WebMouseEvent event;
428         initMouseEvent(WebInputEvent::MouseUp, buttonType, lastMousePos, &event);
429         if (arguments.size() >= 2 && (arguments[1].isObject() || arguments[1].isString()))
430             applyKeyModifiers(&(arguments[1]), &event);
431         doMouseUp(event);
432     }
433 }
434
435 void EventSender::doMouseUp(const WebMouseEvent& e)
436 {
437     webview()->handleInputEvent(e);
438
439     pressedButton = WebMouseEvent::ButtonNone;
440     lastClickTimeSec = e.timeStampSeconds;
441     lastClickPos = lastMousePos;
442
443     // If we're in a drag operation, complete it.
444     if (currentDragData.isNull())
445         return;
446     WebPoint clientPoint(e.x, e.y);
447     WebPoint screenPoint(e.globalX, e.globalY);
448
449     currentDragEffect = webview()->dragTargetDragOver(clientPoint, screenPoint, currentDragEffectsAllowed);
450     if (currentDragEffect)
451         webview()->dragTargetDrop(clientPoint, screenPoint);
452     else
453         webview()->dragTargetDragLeave();
454     webview()->dragSourceEndedAt(clientPoint, screenPoint, currentDragEffect);
455     webview()->dragSourceSystemDragEnded();
456
457     currentDragData.reset();
458 }
459
460 void EventSender::mouseMoveTo(const CppArgumentList& arguments, CppVariant* result)
461 {
462     result->setNull();
463
464     if (arguments.size() < 2 || !arguments[0].isNumber() || !arguments[1].isNumber())
465         return;
466     webview()->layout();
467
468     WebPoint mousePos(arguments[0].toInt32(), arguments[1].toInt32());
469
470     if (isDragMode() && pressedButton == WebMouseEvent::ButtonLeft && !replayingSavedEvents) {
471         SavedEvent savedEvent;
472         savedEvent.type = SavedEvent::MouseMove;
473         savedEvent.pos = mousePos;
474         mouseEventQueue.append(savedEvent);
475     } else {
476         WebMouseEvent event;
477         initMouseEvent(WebInputEvent::MouseMove, pressedButton, mousePos, &event);
478         doMouseMove(event);
479     }
480 }
481
482 void EventSender::doMouseMove(const WebMouseEvent& e)
483 {
484     lastMousePos = WebPoint(e.x, e.y);
485
486     webview()->handleInputEvent(e);
487
488     if (pressedButton == WebMouseEvent::ButtonNone || currentDragData.isNull())
489         return;
490     WebPoint clientPoint(e.x, e.y);
491     WebPoint screenPoint(e.globalX, e.globalY);
492     currentDragEffect = webview()->dragTargetDragOver(clientPoint, screenPoint, currentDragEffectsAllowed);
493 }
494
495 void EventSender::keyDown(const CppArgumentList& arguments, CppVariant* result)
496 {
497     result->setNull();
498     if (arguments.size() < 1 || !arguments[0].isString())
499         return;
500     bool generateChar = false;
501
502     // FIXME: I'm not exactly sure how we should convert the string to a key
503     // event. This seems to work in the cases I tested.
504     // FIXME: Should we also generate a KEY_UP?
505     string codeStr = arguments[0].toString();
506
507     // Convert \n -> VK_RETURN. Some layout tests use \n to mean "Enter", when
508     // Windows uses \r for "Enter".
509     int code = 0;
510     int text = 0;
511     bool needsShiftKeyModifier = false;
512     if ("\n" == codeStr) {
513         generateChar = true;
514         text = code = webkit_support::VKEY_RETURN;
515     } else if ("rightArrow" == codeStr)
516         code = webkit_support::VKEY_RIGHT;
517     else if ("downArrow" == codeStr)
518         code = webkit_support::VKEY_DOWN;
519     else if ("leftArrow" == codeStr)
520         code = webkit_support::VKEY_LEFT;
521     else if ("upArrow" == codeStr)
522         code = webkit_support::VKEY_UP;
523     else if ("insert" == codeStr)
524         code = webkit_support::VKEY_INSERT;
525     else if ("delete" == codeStr)
526         code = webkit_support::VKEY_DELETE;
527     else if ("pageUp" == codeStr)
528         code = webkit_support::VKEY_PRIOR;
529     else if ("pageDown" == codeStr)
530         code = webkit_support::VKEY_NEXT;
531     else if ("home" == codeStr)
532         code = webkit_support::VKEY_HOME;
533     else if ("end" == codeStr)
534         code = webkit_support::VKEY_END;
535     else if ("printScreen" == codeStr)
536         code = webkit_support::VKEY_SNAPSHOT;
537     else if ("menu" == codeStr)
538         // FIXME: Change this to webkit_support::VKEY_APPS.
539         code = 0x5D;
540     else {
541         // Compare the input string with the function-key names defined by the
542         // DOM spec (i.e. "F1",...,"F24"). If the input string is a function-key
543         // name, set its key code.
544         for (int i = 1; i <= 24; ++i) {
545             char functionChars[10];
546             snprintf(functionChars, 10, "F%d", i);
547             string functionKeyName(functionChars);
548             if (functionKeyName == codeStr) {
549                 code = webkit_support::VKEY_F1 + (i - 1);
550                 break;
551             }
552         }
553         if (!code) {
554             WebString webCodeStr = WebString::fromUTF8(codeStr.data(), codeStr.size());
555             ASSERT(webCodeStr.length() == 1);
556             text = code = webCodeStr.data()[0];
557             needsShiftKeyModifier = needsShiftModifier(code);
558             if ((code & 0xFF) >= 'a' && (code & 0xFF) <= 'z')
559                 code -= 'a' - 'A';
560             generateChar = true;
561         }
562     }
563
564     // For one generated keyboard event, we need to generate a keyDown/keyUp
565     // pair; refer to EventSender.cpp in Tools/DumpRenderTree/win.
566     // On Windows, we might also need to generate a char event to mimic the
567     // Windows event flow; on other platforms we create a merged event and test
568     // the event flow that that platform provides.
569     WebKeyboardEvent eventDown, eventChar, eventUp;
570     eventDown.type = WebInputEvent::RawKeyDown;
571     eventDown.modifiers = 0;
572     eventDown.windowsKeyCode = code;
573     if (generateChar) {
574         eventDown.text[0] = text;
575         eventDown.unmodifiedText[0] = text;
576     }
577     eventDown.setKeyIdentifierFromWindowsKeyCode();
578
579     if (arguments.size() >= 2 && (arguments[1].isObject() || arguments[1].isString()))
580         eventDown.isSystemKey = applyKeyModifiers(&(arguments[1]), &eventDown);
581
582     if (needsShiftKeyModifier)
583         eventDown.modifiers |= WebInputEvent::ShiftKey;
584
585     // See if KeyLocation argument is given.
586     if (arguments.size() >= 3 && arguments[2].isNumber()) {
587         int location = arguments[2].toInt32();
588         if (location == DOMKeyLocationNumpad)
589             eventDown.modifiers |= WebInputEvent::IsKeyPad;
590     }
591
592     eventChar = eventUp = eventDown;
593     eventUp.type = WebInputEvent::KeyUp;
594     // EventSender.m forces a layout here, with at least one
595     // test (fast/forms/focus-control-to-page.html) relying on this.
596     webview()->layout();
597
598     // In the browser, if a keyboard event corresponds to an editor command,
599     // the command will be dispatched to the renderer just before dispatching
600     // the keyboard event, and then it will be executed in the
601     // RenderView::handleCurrentKeyboardEvent() method, which is called from
602     // third_party/WebKit/Source/WebKit/chromium/src/EditorClientImpl.cpp.
603     // We just simulate the same behavior here.
604     string editCommand;
605     if (getEditCommand(eventDown, &editCommand))
606         m_shell->webViewHost()->setEditCommand(editCommand, "");
607
608     webview()->handleInputEvent(eventDown);
609
610     m_shell->webViewHost()->clearEditCommand();
611
612     if (generateChar) {
613         eventChar.type = WebInputEvent::Char;
614         eventChar.keyIdentifier[0] = '\0';
615         webview()->handleInputEvent(eventChar);
616     }
617
618     webview()->handleInputEvent(eventUp);
619 }
620
621 void EventSender::dispatchMessage(const CppArgumentList& arguments, CppVariant* result)
622 {
623     result->setNull();
624
625 #if OS(WINDOWS)
626     if (arguments.size() == 3) {
627         // Grab the message id to see if we need to dispatch it.
628         int msg = arguments[0].toInt32();
629
630         // WebKit's version of this function stuffs a MSG struct and uses
631         // TranslateMessage and DispatchMessage. We use a WebKeyboardEvent, which
632         // doesn't need to receive the DeadChar and SysDeadChar messages.
633         if (msg == WM_DEADCHAR || msg == WM_SYSDEADCHAR)
634             return;
635
636         webview()->layout();
637
638         unsigned long lparam = static_cast<unsigned long>(arguments[2].toDouble());
639         webview()->handleInputEvent(WebInputEventFactory::keyboardEvent(0, msg, arguments[1].toInt32(), lparam));
640     } else
641         ASSERT_NOT_REACHED();
642 #endif
643 }
644
645 bool EventSender::needsShiftModifier(int keyCode)
646 {
647     // If code is an uppercase letter, assign a SHIFT key to
648     // eventDown.modifier, this logic comes from
649     // Tools/DumpRenderTree/win/EventSender.cpp
650     return (keyCode & 0xFF) >= 'A' && (keyCode & 0xFF) <= 'Z';
651 }
652
653 void EventSender::leapForward(const CppArgumentList& arguments, CppVariant* result)
654 {
655     result->setNull();
656
657     if (arguments.size() < 1 || !arguments[0].isNumber())
658         return;
659
660     int milliseconds = arguments[0].toInt32();
661     if (isDragMode() && pressedButton == WebMouseEvent::ButtonLeft && !replayingSavedEvents) {
662         SavedEvent savedEvent;
663         savedEvent.type = SavedEvent::LeapForward;
664         savedEvent.milliseconds = milliseconds;
665         mouseEventQueue.append(savedEvent);
666     } else
667         doLeapForward(milliseconds);
668 }
669
670 void EventSender::doLeapForward(int milliseconds)
671 {
672     advanceEventTime(milliseconds);
673 }
674
675 // Apple's port of WebKit zooms by a factor of 1.2 (see
676 // WebKit/WebView/WebView.mm)
677 void EventSender::textZoomIn(const CppArgumentList&, CppVariant* result)
678 {
679     webview()->setZoomLevel(true, webview()->zoomLevel() + 1);
680     result->setNull();
681 }
682
683 void EventSender::textZoomOut(const CppArgumentList&, CppVariant* result)
684 {
685     webview()->setZoomLevel(true, webview()->zoomLevel() - 1);
686     result->setNull();
687 }
688
689 void EventSender::zoomPageIn(const CppArgumentList&, CppVariant* result)
690 {
691     webview()->setZoomLevel(false, webview()->zoomLevel() + 1);
692     result->setNull();
693 }
694
695 void EventSender::zoomPageOut(const CppArgumentList&, CppVariant* result)
696 {
697     webview()->setZoomLevel(false, webview()->zoomLevel() - 1);
698     result->setNull();
699 }
700
701 void EventSender::mouseScrollBy(const CppArgumentList& arguments, CppVariant* result)
702 {
703     handleMouseWheel(arguments, result, false);
704 }
705
706 void EventSender::continuousMouseScrollBy(const CppArgumentList& arguments, CppVariant* result)
707 {
708     handleMouseWheel(arguments, result, true);
709 }
710
711 void EventSender::replaySavedEvents()
712 {
713     replayingSavedEvents = true;
714     while (!mouseEventQueue.isEmpty()) {
715         SavedEvent e = mouseEventQueue.takeFirst();
716
717         switch (e.type) {
718         case SavedEvent::MouseMove: {
719             WebMouseEvent event;
720             initMouseEvent(WebInputEvent::MouseMove, pressedButton, e.pos, &event);
721             doMouseMove(event);
722             break;
723         }
724         case SavedEvent::LeapForward:
725             doLeapForward(e.milliseconds);
726             break;
727         case SavedEvent::MouseUp: {
728             WebMouseEvent event;
729             initMouseEvent(WebInputEvent::MouseUp, e.buttonType, lastMousePos, &event);
730             doMouseUp(event);
731             break;
732         }
733         default:
734             ASSERT_NOT_REACHED();
735         }
736     }
737
738     replayingSavedEvents = false;
739 }
740
741 // Because actual context menu is implemented by the browser side, 
742 // this function does only what LayoutTests are expecting:
743 // - Many test checks the count of items. So returning non-zero value makes sense.
744 // - Some test compares the count before and after some action. So changing the count based on flags
745 //   also makes sense. This function is doing such for some flags.
746 // - Some test even checks actual string content. So providing it would be also helpful.
747 //
748 static Vector<WebString> makeMenuItemStringsFor(WebContextMenuData* contextMenu, MockSpellCheck* spellcheck)
749 {
750     // These constants are based on Safari's context menu because tests are made for it.
751     static const char* nonEditableMenuStrings[] = { "Back", "Reload Page", "Open in Dashbaord", "<separator>", "View Source", "Save Page As", "Print Page", "Inspect Element", 0 };
752     static const char* editableMenuStrings[] = { "Cut", "Copy", "<separator>", "Paste", "Spelling and Grammar", "Substitutions, Transformations", "Font", "Speech", "Paragraph Direction", "<separator>", 0 };
753
754     // This is possible because mouse events are cancelleable.
755     if (!contextMenu)
756         return Vector<WebString>();
757
758     Vector<WebString> strings;
759
760     if (contextMenu->isEditable) {
761         for (const char** item = editableMenuStrings; *item; ++item) 
762             strings.append(WebString::fromUTF8(*item));
763         Vector<WebString> suggestions;
764         spellcheck->fillSuggestionList(contextMenu->misspelledWord, &suggestions);
765         for (size_t i = 0; i < suggestions.size(); ++i) 
766             strings.append(suggestions[i]);
767     } else {
768         for (const char** item = nonEditableMenuStrings; *item; ++item) 
769             strings.append(WebString::fromUTF8(*item));
770     }
771
772     return strings;
773 }
774
775
776 void EventSender::contextClick(const CppArgumentList& arguments, CppVariant* result)
777 {
778     webview()->layout();
779
780     updateClickCountForButton(WebMouseEvent::ButtonRight);
781
782     // Clears last context menu data because we need to know if the context menu be requested 
783     // after following mouse events.
784     m_shell->webViewHost()->clearContextMenuData();
785
786     // Generate right mouse down and up.
787     WebMouseEvent event;
788     pressedButton = WebMouseEvent::ButtonRight;
789     initMouseEvent(WebInputEvent::MouseDown, WebMouseEvent::ButtonRight, lastMousePos, &event);
790     webview()->handleInputEvent(event);
791
792     initMouseEvent(WebInputEvent::MouseUp, WebMouseEvent::ButtonRight, lastMousePos, &event);
793     webview()->handleInputEvent(event);
794
795     pressedButton = WebMouseEvent::ButtonNone;
796
797     WebContextMenuData* lastContextMenu = m_shell->webViewHost()->lastContextMenuData();
798     result->set(WebBindings::makeStringArray(makeMenuItemStringsFor(lastContextMenu, m_shell->webViewHost()->mockSpellCheck())));
799 }
800
801 class MouseDownTask: public MethodTask<EventSender> {
802 public:
803     MouseDownTask(EventSender* obj, const CppArgumentList& arg)
804         : MethodTask<EventSender>(obj), m_arguments(arg) { }
805     virtual void runIfValid() { m_object->mouseDown(m_arguments, 0); }
806
807 private:
808     CppArgumentList m_arguments;
809 };
810
811 class MouseUpTask: public MethodTask<EventSender> {
812 public:
813     MouseUpTask(EventSender* obj, const CppArgumentList& arg)
814         : MethodTask<EventSender>(obj), m_arguments(arg) { }
815     virtual void runIfValid() { m_object->mouseUp(m_arguments, 0); }
816
817 private:
818     CppArgumentList m_arguments;
819 };
820
821 void EventSender::scheduleAsynchronousClick(const CppArgumentList& arguments, CppVariant* result)
822 {
823     result->setNull();
824     postTask(new MouseDownTask(this, arguments));
825     postTask(new MouseUpTask(this, arguments));
826 }
827
828 void EventSender::beginDragWithFiles(const CppArgumentList& arguments, CppVariant* result)
829 {
830     currentDragData.initialize();
831     Vector<string> files = arguments[0].toStringVector();
832     for (size_t i = 0; i < files.size(); ++i)
833         currentDragData.appendToFilenames(webkit_support::GetAbsoluteWebStringFromUTF8Path(files[i]));
834     currentDragEffectsAllowed = WebKit::WebDragOperationCopy;
835
836     // Provide a drag source.
837     webview()->dragTargetDragEnter(currentDragData, lastMousePos, lastMousePos, currentDragEffectsAllowed);
838
839     // dragMode saves events and then replays them later. We don't need/want that.
840     dragMode.set(false);
841
842     // Make the rest of eventSender think a drag is in progress.
843     pressedButton = WebMouseEvent::ButtonLeft;
844
845     result->setNull();
846 }
847
848 void EventSender::addTouchPoint(const CppArgumentList& arguments, CppVariant* result)
849 {
850     result->setNull();
851
852     WebTouchPoint touchPoint;
853     touchPoint.state = WebTouchPoint::StatePressed;
854     touchPoint.position = WebPoint(arguments[0].toInt32(), arguments[1].toInt32());
855     touchPoint.screenPosition = touchPoint.position;
856
857     int lowestId = 0;
858     for (size_t i = 0; i < touchPoints.size(); i++) {
859         if (touchPoints[i].id == lowestId)
860             lowestId++;
861     }
862     touchPoint.id = lowestId;
863     touchPoints.append(touchPoint);
864 }
865
866 void EventSender::clearTouchPoints(const CppArgumentList&, CppVariant* result)
867 {
868     result->setNull();
869     touchPoints.clear();
870 }
871
872 void EventSender::releaseTouchPoint(const CppArgumentList& arguments, CppVariant* result)
873 {
874     result->setNull();
875
876     const unsigned index = arguments[0].toInt32();
877     ASSERT(index < touchPoints.size());
878
879     WebTouchPoint* touchPoint = &touchPoints[index];
880     touchPoint->state = WebTouchPoint::StateReleased;
881 }
882
883 void EventSender::setTouchModifier(const CppArgumentList& arguments, CppVariant* result)
884 {
885     result->setNull();
886
887     int mask = 0;
888     const string keyName = arguments[0].toString();
889     if (keyName == "shift")
890         mask = WebInputEvent::ShiftKey;
891     else if (keyName == "alt")
892         mask = WebInputEvent::AltKey;
893     else if (keyName == "ctrl")
894         mask = WebInputEvent::ControlKey;
895     else if (keyName == "meta")
896         mask = WebInputEvent::MetaKey;
897
898     if (arguments[1].toBoolean())
899         touchModifiers |= mask;
900     else
901         touchModifiers &= ~mask;
902 }
903
904 void EventSender::updateTouchPoint(const CppArgumentList& arguments, CppVariant* result)
905 {
906     result->setNull();
907
908     const unsigned index = arguments[0].toInt32();
909     ASSERT(index < touchPoints.size());
910
911     WebPoint position(arguments[1].toInt32(), arguments[2].toInt32());
912     WebTouchPoint* touchPoint = &touchPoints[index];
913     touchPoint->state = WebTouchPoint::StateMoved;
914     touchPoint->position = position;
915     touchPoint->screenPosition = position;
916 }
917
918 void EventSender::cancelTouchPoint(const CppArgumentList& arguments, CppVariant* result)
919 {
920     result->setNull();
921
922     const unsigned index = arguments[0].toInt32();
923     ASSERT(index < touchPoints.size());
924
925     WebTouchPoint* touchPoint = &touchPoints[index];
926     touchPoint->state = WebTouchPoint::StateCancelled;
927 }
928
929 void EventSender::sendCurrentTouchEvent(const WebInputEvent::Type type)
930 {
931     ASSERT(static_cast<unsigned>(WebTouchEvent::touchPointsLengthCap) > touchPoints.size());
932     webview()->layout();
933
934     WebTouchEvent touchEvent;
935     touchEvent.type = type;
936     touchEvent.modifiers = touchModifiers;
937     touchEvent.timeStampSeconds = getCurrentEventTimeSec();
938     touchEvent.touchPointsLength = touchPoints.size();
939     for (unsigned i = 0; i < touchPoints.size(); ++i)
940         touchEvent.touchPoints[i] = touchPoints[i];
941     webview()->handleInputEvent(touchEvent);
942
943     for (unsigned i = 0; i < touchPoints.size(); ++i) {
944         WebTouchPoint* touchPoint = &touchPoints[i];
945         if (touchPoint->state == WebTouchPoint::StateReleased) {
946             touchPoints.remove(i);
947             --i;
948         } else
949             touchPoint->state = WebTouchPoint::StateStationary;
950     }
951 }
952
953 void EventSender::handleMouseWheel(const CppArgumentList& arguments, CppVariant* result, bool continuous)
954 {
955     result->setNull();
956
957     if (arguments.size() < 2 || !arguments[0].isNumber() || !arguments[1].isNumber())
958         return;
959
960     // Force a layout here just to make sure every position has been
961     // determined before we send events (as well as all the other methods
962     // that send an event do).
963     webview()->layout();
964
965     int horizontal = arguments[0].toInt32();
966     int vertical = arguments[1].toInt32();
967
968     WebMouseWheelEvent event;
969     initMouseEvent(WebInputEvent::MouseWheel, pressedButton, lastMousePos, &event);
970     event.wheelTicksX = static_cast<float>(horizontal);
971     event.wheelTicksY = static_cast<float>(vertical);
972     event.deltaX = event.wheelTicksX;
973     event.deltaY = event.wheelTicksY;
974     if (continuous) {
975         event.wheelTicksX /= scrollbarPixelsPerTick;
976         event.wheelTicksY /= scrollbarPixelsPerTick;
977     } else {
978         event.deltaX *= scrollbarPixelsPerTick;
979         event.deltaY *= scrollbarPixelsPerTick;
980     }
981     webview()->handleInputEvent(event);
982 }
983
984 void EventSender::touchEnd(const CppArgumentList&, CppVariant* result)
985 {
986     result->setNull();
987     sendCurrentTouchEvent(WebInputEvent::TouchEnd);
988 }
989
990 void EventSender::touchMove(const CppArgumentList&, CppVariant* result)
991 {
992     result->setNull();
993     sendCurrentTouchEvent(WebInputEvent::TouchMove);
994 }
995
996 void EventSender::touchStart(const CppArgumentList&, CppVariant* result)
997 {
998     result->setNull();
999     sendCurrentTouchEvent(WebInputEvent::TouchStart);
1000 }
1001
1002 void EventSender::touchCancel(const CppArgumentList&, CppVariant* result)
1003 {
1004     result->setNull();
1005     sendCurrentTouchEvent(WebInputEvent::TouchCancel);
1006 }
1007
1008 //
1009 // Unimplemented stubs
1010 //
1011
1012 void EventSender::enableDOMUIEventLogging(const CppArgumentList&, CppVariant* result)
1013 {
1014     result->setNull();
1015 }
1016
1017 void EventSender::fireKeyboardEventsToElement(const CppArgumentList&, CppVariant* result)
1018 {
1019     result->setNull();
1020 }
1021
1022 void EventSender::clearKillRing(const CppArgumentList&, CppVariant* result)
1023 {
1024     result->setNull();
1025 }