388888b0afe57096db8ecb4456997f8eed41ac6f
[WebKit-https.git] / Tools / DumpRenderTree / chromium / EventSender.h
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 /*
32   EventSender class:
33   Bound to a JavaScript window.eventSender object using
34   CppBoundClass::bindToJavascript(), this allows layout tests to fire DOM events.
35 */
36
37 #ifndef EventSender_h
38 #define EventSender_h
39
40 #include "CppBoundClass.h"
41 #include "Task.h"
42 #include "WebDragOperation.h"
43 #include "WebInputEvent.h"
44 #include "WebPoint.h"
45
46 class TestShell;
47
48 namespace WebKit {
49 class WebDragData;
50 class WebView;
51 }
52
53 class EventSender : public CppBoundClass {
54 public:
55     // Builds the property and method lists needed to bind this class to a JS
56     // object.
57     EventSender(TestShell*);
58
59     // Resets some static variable state.
60     void reset();
61
62     // Simulate drag&drop system call.
63     void doDragDrop(const WebKit::WebDragData&, WebKit::WebDragOperationsMask);
64
65     // Test helper for dragging out images.
66     void dumpFilenameBeingDragged(const CppArgumentList&, CppVariant*);
67
68     // JS callback methods.
69     void mouseDown(const CppArgumentList&, CppVariant*);
70     void mouseUp(const CppArgumentList&, CppVariant*);
71     void mouseMoveTo(const CppArgumentList&, CppVariant*);
72     void leapForward(const CppArgumentList&, CppVariant*);
73     void keyDown(const CppArgumentList&, CppVariant*);
74     void dispatchMessage(const CppArgumentList&, CppVariant*);
75     void textZoomIn(const CppArgumentList&, CppVariant*);
76     void textZoomOut(const CppArgumentList&, CppVariant*);
77     void zoomPageIn(const CppArgumentList&, CppVariant*);
78     void zoomPageOut(const CppArgumentList&, CppVariant*);
79     void scalePageBy(const CppArgumentList&, CppVariant*);
80     void mouseScrollBy(const CppArgumentList&, CppVariant*);
81     void continuousMouseScrollBy(const CppArgumentList&, CppVariant*);
82     void scheduleAsynchronousClick(const CppArgumentList&, CppVariant*);
83     void beginDragWithFiles(const CppArgumentList&, CppVariant*);
84     CppVariant dragMode;
85
86     void addTouchPoint(const CppArgumentList&, CppVariant*);
87     void cancelTouchPoint(const CppArgumentList&, CppVariant*);
88     void clearTouchPoints(const CppArgumentList&, CppVariant*);
89     void releaseTouchPoint(const CppArgumentList&, CppVariant*);
90     void setTouchModifier(const CppArgumentList&, CppVariant*);
91     void touchCancel(const CppArgumentList&, CppVariant*);
92     void touchEnd(const CppArgumentList&, CppVariant*);
93     void touchMove(const CppArgumentList&, CppVariant*);
94     void touchStart(const CppArgumentList&, CppVariant*);
95     void updateTouchPoint(const CppArgumentList&, CppVariant*);
96
97     void gestureScrollBegin(const CppArgumentList&, CppVariant*);
98     void gestureScrollEnd(const CppArgumentList&, CppVariant*);
99     void gestureTap(const CppArgumentList&, CppVariant*);
100     void gestureEvent(WebKit::WebInputEvent::Type, const CppArgumentList&);
101
102     // Unimplemented stubs
103     void contextClick(const CppArgumentList&, CppVariant*);
104     void enableDOMUIEventLogging(const CppArgumentList&, CppVariant*);
105     void fireKeyboardEventsToElement(const CppArgumentList&, CppVariant*);
106     void clearKillRing(const CppArgumentList&, CppVariant*);
107
108     // Properties used in layout tests.
109 #if defined(OS_WIN)
110     CppVariant wmKeyDown;
111     CppVariant wmKeyUp;
112     CppVariant wmChar;
113     CppVariant wmDeadChar;
114     CppVariant wmSysKeyDown;
115     CppVariant wmSysKeyUp;
116     CppVariant wmSysChar;
117     CppVariant wmSysDeadChar;
118 #endif
119
120     TaskList* taskList() { return &m_taskList; }
121
122 private:
123     // Returns the test shell's webview.
124     WebKit::WebView* webview();
125
126     // Returns true if dragMode is true.
127     bool isDragMode() { return dragMode.isBool() && dragMode.toBoolean(); }
128
129     // Sometimes we queue up mouse move and mouse up events for drag drop
130     // handling purposes. These methods dispatch the event.
131     void doMouseMove(const WebKit::WebMouseEvent&);
132     void doMouseUp(const WebKit::WebMouseEvent&);
133     static void doLeapForward(int milliseconds);
134     void replaySavedEvents();
135
136     // Helper to return the button type given a button code
137     static WebKit::WebMouseEvent::Button getButtonTypeFromButtonNumber(int);
138
139     // Helper to extract the button number from the optional argument in
140     // mouseDown and mouseUp
141     static int getButtonNumberFromSingleArg(const CppArgumentList&);
142
143     // Returns true if the specified key code passed in needs a shift key
144     // modifier to be passed into the generated event.
145     bool needsShiftModifier(int);
146
147     void updateClickCountForButton(WebKit::WebMouseEvent::Button);
148
149     // Compose a touch event from the current touch points and send it.
150     void sendCurrentTouchEvent(const WebKit::WebInputEvent::Type);
151
152     // Handle a request to send a wheel event.
153     void handleMouseWheel(const CppArgumentList&, CppVariant*, bool continuous);
154
155     TaskList m_taskList;
156
157     // Non-owning pointer. The EventSender is owned by the TestShell.
158     TestShell* m_shell;
159
160     // Location of last mouseMoveTo event.
161     static WebKit::WebPoint lastMousePos;
162
163     // Currently pressed mouse button (Left/Right/Middle or None)
164     static WebKit::WebMouseEvent::Button pressedButton;
165
166     // The last button number passed to mouseDown and mouseUp.
167     // Used to determine whether the click count continues to
168     // increment or not.
169     static WebKit::WebMouseEvent::Button lastButtonType;
170 };
171
172 #endif // EventSender_h