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