[WTR] Reset EventSender before running each test.
[WebKit-https.git] / Tools / WebKitTestRunner / gtk / EventSenderProxyGtk.cpp
1 /*
2  * Copyright (C) 2007, 2008 Apple Inc. All rights reserved.
3  * Copyright (C) 2009 Zan Dobersek <zandobersek@gmail.com>
4  * Copyright (C) 2009 Holger Hans Peter Freyther
5  * Copyright (C) 2010 Igalia S.L.
6  * Copyright (c) 2010 Motorola Mobility, Inc.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1.  Redistributions of source code must retain the above copyright
13  *     notice, this list of conditions and the following disclaimer.
14  * 2.  Redistributions in binary form must reproduce the above copyright
15  *     notice, this list of conditions and the following disclaimer in the
16  *     documentation and/or other materials provided with the distribution.
17  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
18  *     its contributors may be used to endorse or promote products derived
19  *     from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
22  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
23  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
25  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
26  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
28  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32
33 #include "config.h"
34 #include "EventSenderProxy.h"
35
36 #include "PlatformWebView.h"
37 #include "TestController.h"
38 #include <wtf/OwnArrayPtr.h>
39 #include <wtf/PassOwnArrayPtr.h>
40 #include <gdk/gdkkeysyms.h>
41 #include <gtk/gtk.h>
42 #include <wtf/gobject/GOwnPtr.h>
43 #include <wtf/text/WTFString.h>
44
45 namespace WTR {
46
47 // WebCore and layout tests assume this value
48 static const float pixelsPerScrollTick = 40;
49
50 // Key event location code defined in DOM Level 3.
51 enum KeyLocationCode {
52     DOMKeyLocationStandard      = 0x00,
53     DOMKeyLocationLeft          = 0x01,
54     DOMKeyLocationRight         = 0x02,
55     DOMKeyLocationNumpad        = 0x03
56 };
57
58
59 struct WTREventQueueItem {
60     GdkEvent* event;
61     gulong delay;
62
63     WTREventQueueItem()
64         : event(0)
65         , delay(0)
66     {
67     }
68     WTREventQueueItem(GdkEvent* event, gulong delay)
69         : event(event)
70         , delay(delay)
71     {
72     }
73 };
74
75 EventSenderProxy::EventSenderProxy(TestController* testController)
76     : m_testController(testController)
77     , m_time(0)
78     , m_leftMouseButtonDown(false)
79     , m_clickCount(0)
80     , m_clickTime(0)
81     , m_clickButton(kWKEventMouseButtonNoButton)
82     , m_mouseButtonCurrentlyDown(0)
83 {
84 }
85
86 EventSenderProxy::~EventSenderProxy()
87 {
88 }
89
90 static guint getMouseButtonModifiers(int gdkButton)
91 {
92     if (gdkButton == 1)
93         return GDK_BUTTON1_MASK;
94     if (gdkButton == 2)
95         return GDK_BUTTON2_MASK;
96     if (gdkButton == 3)
97         return GDK_BUTTON3_MASK;
98     return 0;
99 }
100
101 static unsigned eventSenderButtonToGDKButton(unsigned button)
102 {
103     int mouseButton = 3;
104     if (button <= 2)
105         mouseButton = button + 1;
106     // fast/events/mouse-click-events expects the 4th button to be treated as the middle button.
107     else if (button == 3)
108         mouseButton = 2;
109
110     return mouseButton;
111 }
112
113 GdkEvent* EventSenderProxy::createMouseButtonEvent(GdkEventType eventType, unsigned button, WKEventModifiers modifiers)
114 {
115     GdkEvent* mouseEvent = gdk_event_new(eventType);
116
117     mouseEvent->button.button = eventSenderButtonToGDKButton(button);
118     mouseEvent->button.x = m_position.x;
119     mouseEvent->button.y = m_position.y;
120     mouseEvent->button.window = gtk_widget_get_window(GTK_WIDGET(m_testController->mainWebView()->platformView()));
121     g_object_ref(mouseEvent->button.window);
122     gdk_event_set_device(mouseEvent, gdk_device_manager_get_client_pointer(gdk_display_get_device_manager(gdk_window_get_display(mouseEvent->button.window))));
123     mouseEvent->button.state = modifiers | getMouseButtonModifiers(mouseEvent->button.button);
124     mouseEvent->button.time = GDK_CURRENT_TIME;
125     mouseEvent->button.axes = 0;
126
127     int xRoot, yRoot;
128     gdk_window_get_root_coords(mouseEvent->button.window, m_position.x, m_position.y, &xRoot, &yRoot);
129     mouseEvent->button.x_root = xRoot;
130     mouseEvent->button.y_root = yRoot;
131
132     return mouseEvent;
133 }
134
135 void EventSenderProxy::updateClickCountForButton(int button)
136 {
137     if (m_time - m_clickTime < 1 && m_position == m_clickPosition && button == m_clickButton) {
138         ++m_clickCount;
139         m_clickTime = m_time;
140         return;
141     }
142
143     m_clickCount = 1;
144     m_clickTime = m_time;
145     m_clickPosition = m_position;
146     m_clickButton = button;
147 }
148
149 static void dispatchEvent(GdkEvent* event)
150 {
151     gtk_main_do_event(event);
152     gdk_event_free(event);
153 }
154
155 void EventSenderProxy::replaySavedEvents()
156 {
157     while (!m_eventQueue.isEmpty()) {
158         WTREventQueueItem item = m_eventQueue.first();
159         if (item.delay)
160             g_usleep(item.delay * 1000);
161
162         dispatchEvent(item.event);
163         m_eventQueue.remove(0);
164     }
165 }
166
167 void EventSenderProxy::sendOrQueueEvent(GdkEvent* event)
168 {
169     if (m_eventQueue.isEmpty() || !m_eventQueue.last().delay) {
170         dispatchEvent(event);
171         return;
172     }
173
174     m_eventQueue.last().event = event;
175     replaySavedEvents();
176 }
177
178 static guint webkitModifiersToGDKModifiers(WKEventModifiers wkModifiers)
179 {
180     guint modifiers = 0;
181
182     if (wkModifiers & kWKEventModifiersControlKey)
183         modifiers |= GDK_CONTROL_MASK;
184     if (wkModifiers & kWKEventModifiersShiftKey)
185         modifiers |= GDK_SHIFT_MASK;
186     if (wkModifiers & kWKEventModifiersAltKey)
187         modifiers |= GDK_MOD1_MASK;
188     if (wkModifiers & kWKEventModifiersMetaKey)
189         modifiers |= GDK_META_MASK;
190
191     return modifiers;
192 }
193
194 int getGDKKeySymForKeyRef(WKStringRef keyRef, unsigned location, guint* modifiers)
195 {
196     if (location == DOMKeyLocationNumpad) {
197         if (WKStringIsEqualToUTF8CString(keyRef, "leftArrow"))
198             return GDK_KEY_KP_Left;
199         if (WKStringIsEqualToUTF8CString(keyRef, "rightArror"))
200             return GDK_KEY_KP_Right;
201         if (WKStringIsEqualToUTF8CString(keyRef, "upArrow"))
202             return GDK_KEY_KP_Up;
203         if (WKStringIsEqualToUTF8CString(keyRef, "downArrow"))
204             return GDK_KEY_KP_Down;
205         if (WKStringIsEqualToUTF8CString(keyRef, "pageUp"))
206             return GDK_KEY_KP_Page_Up;
207         if (WKStringIsEqualToUTF8CString(keyRef, "pageDown"))
208             return GDK_KEY_KP_Page_Down;
209         if (WKStringIsEqualToUTF8CString(keyRef, "home"))
210             return GDK_KEY_KP_Home;
211         if (WKStringIsEqualToUTF8CString(keyRef, "end"))
212             return GDK_KEY_KP_End;
213         if (WKStringIsEqualToUTF8CString(keyRef, "insert"))
214             return GDK_KEY_KP_Insert;
215         if (WKStringIsEqualToUTF8CString(keyRef, "delete"))
216             return GDK_KEY_KP_Delete;
217
218         return GDK_KEY_VoidSymbol;
219     }
220
221     if (WKStringIsEqualToUTF8CString(keyRef, "leftArrow"))
222         return GDK_KEY_Left;
223     if (WKStringIsEqualToUTF8CString(keyRef, "rightArrow"))
224         return GDK_KEY_Right;
225     if (WKStringIsEqualToUTF8CString(keyRef, "upArrow"))
226         return GDK_KEY_Up;
227     if (WKStringIsEqualToUTF8CString(keyRef, "downArrow"))
228         return GDK_KEY_Down;
229     if (WKStringIsEqualToUTF8CString(keyRef, "pageUp"))
230         return GDK_KEY_Page_Up;
231     if (WKStringIsEqualToUTF8CString(keyRef, "pageDown"))
232         return GDK_KEY_Page_Down;
233     if (WKStringIsEqualToUTF8CString(keyRef, "home"))
234         return GDK_KEY_Home;
235     if (WKStringIsEqualToUTF8CString(keyRef, "end"))
236         return GDK_KEY_End;
237     if (WKStringIsEqualToUTF8CString(keyRef, "insert"))
238         return GDK_KEY_Insert;
239     if (WKStringIsEqualToUTF8CString(keyRef, "delete"))
240         return GDK_KEY_Delete;
241     if (WKStringIsEqualToUTF8CString(keyRef, "printScreen"))
242         return GDK_KEY_Print;
243     if (WKStringIsEqualToUTF8CString(keyRef, "menu"))
244         return GDK_KEY_Menu;
245     if (WKStringIsEqualToUTF8CString(keyRef, "F1"))
246         return GDK_KEY_F1;
247     if (WKStringIsEqualToUTF8CString(keyRef, "F2"))
248         return GDK_KEY_F2;
249     if (WKStringIsEqualToUTF8CString(keyRef, "F3"))
250         return GDK_KEY_F3;
251     if (WKStringIsEqualToUTF8CString(keyRef, "F4"))
252         return GDK_KEY_F4;
253     if (WKStringIsEqualToUTF8CString(keyRef, "F5"))
254         return GDK_KEY_F5;
255     if (WKStringIsEqualToUTF8CString(keyRef, "F6"))
256         return GDK_KEY_F6;
257     if (WKStringIsEqualToUTF8CString(keyRef, "F7"))
258         return GDK_KEY_F7;
259     if (WKStringIsEqualToUTF8CString(keyRef, "F8"))
260         return GDK_KEY_F8;
261     if (WKStringIsEqualToUTF8CString(keyRef, "F9"))
262         return GDK_KEY_F9;
263     if (WKStringIsEqualToUTF8CString(keyRef, "F10"))
264         return GDK_KEY_F10;
265     if (WKStringIsEqualToUTF8CString(keyRef, "F11"))
266         return GDK_KEY_F11;
267     if (WKStringIsEqualToUTF8CString(keyRef, "F12"))
268         return GDK_KEY_F12;
269
270     size_t bufferSize = WKStringGetMaximumUTF8CStringSize(keyRef);
271     OwnArrayPtr<char> buffer = adoptArrayPtr(new char[bufferSize]);
272     WKStringGetUTF8CString(keyRef, buffer.get(), bufferSize);
273     char charCode = buffer.get()[0];
274
275     if (charCode == '\n' || charCode == '\r')
276         return GDK_KEY_Return;
277     if (charCode == '\t')
278         return GDK_KEY_Tab;
279     if (charCode == '\x8')
280         return GDK_KEY_BackSpace;
281
282     if (WTF::isASCIIUpper(charCode))
283         *modifiers |= GDK_SHIFT_MASK;
284
285     return gdk_unicode_to_keyval(static_cast<guint32>(buffer.get()[0]));
286 }
287
288 void EventSenderProxy::keyDown(WKStringRef keyRef, WKEventModifiers wkModifiers, unsigned location)
289 {
290     guint modifiers = webkitModifiersToGDKModifiers(wkModifiers);
291     int gdkKeySym = getGDKKeySymForKeyRef(keyRef, location, &modifiers);
292
293     GdkEvent* pressEvent = gdk_event_new(GDK_KEY_PRESS);
294     pressEvent->key.keyval = gdkKeySym;
295     pressEvent->key.state = modifiers;
296     pressEvent->key.window = gtk_widget_get_window(GTK_WIDGET(m_testController->mainWebView()->platformWindow()));
297     g_object_ref(pressEvent->key.window);
298     gdk_event_set_device(pressEvent, gdk_device_manager_get_client_pointer(gdk_display_get_device_manager(gdk_window_get_display(pressEvent->key.window))));
299
300     GOwnPtr<GdkKeymapKey> keys;
301     gint nKeys;
302     if (gdk_keymap_get_entries_for_keyval(gdk_keymap_get_default(), gdkKeySym, &keys.outPtr(), &nKeys))
303         pressEvent->key.hardware_keycode = keys.get()[0].keycode;
304
305     GdkEvent* releaseEvent = gdk_event_copy(pressEvent);
306     dispatchEvent(pressEvent);
307     releaseEvent->key.type = GDK_KEY_RELEASE;
308     dispatchEvent(releaseEvent);
309 }
310
311 void EventSenderProxy::mouseDown(unsigned button, WKEventModifiers wkModifiers)
312 {
313     // If the same mouse button is already in the down position don't
314     // send another event as it may confuse Xvfb.
315     unsigned gdkButton = eventSenderButtonToGDKButton(button);
316     if (m_mouseButtonCurrentlyDown == gdkButton)
317         return;
318
319     m_mouseButtonCurrentlyDown = gdkButton;
320
321     // Normally GDK will send both GDK_BUTTON_PRESS and GDK_2BUTTON_PRESS for
322     // the second button press during double-clicks. WebKit GTK+ selectively
323     // ignores the first GDK_BUTTON_PRESS of that pair using gdk_event_peek.
324     // Since our events aren't ever going onto the GDK event queue, WebKit won't
325     // be able to filter out the first GDK_BUTTON_PRESS, so we just don't send
326     // it here. Eventually this code should probably figure out a way to get all
327     // appropriate events onto the event queue and this work-around should be
328     // removed.
329     updateClickCountForButton(button);
330
331     GdkEventType eventType;
332     if (m_clickCount == 2)
333         eventType = GDK_2BUTTON_PRESS;
334     else if (m_clickCount == 3)
335         eventType = GDK_3BUTTON_PRESS;
336     else
337         eventType = GDK_BUTTON_PRESS;
338
339     GdkEvent* event = createMouseButtonEvent(eventType, button, wkModifiers);
340     sendOrQueueEvent(event);
341 }
342
343 void EventSenderProxy::mouseUp(unsigned button, WKEventModifiers wkModifiers)
344 {
345     m_clickButton = kWKEventMouseButtonNoButton;
346     GdkEvent* event = createMouseButtonEvent(GDK_BUTTON_RELEASE, button, wkModifiers);
347     sendOrQueueEvent(event);
348
349     if (m_mouseButtonCurrentlyDown == event->button.button)
350         m_mouseButtonCurrentlyDown = 0;
351     m_clickPosition = m_position;
352     m_clickTime = GDK_CURRENT_TIME;
353 }
354
355 void EventSenderProxy::mouseMoveTo(double x, double y)
356 {
357     m_position.x = x;
358     m_position.y = y;
359
360     GdkEvent* event = gdk_event_new(GDK_MOTION_NOTIFY);
361     event->motion.x = m_position.x;
362     event->motion.y = m_position.y;
363
364     event->motion.time = GDK_CURRENT_TIME;
365     event->motion.window = gtk_widget_get_window(GTK_WIDGET(m_testController->mainWebView()->platformView()));
366     g_object_ref(event->motion.window);
367     gdk_event_set_device(event, gdk_device_manager_get_client_pointer(gdk_display_get_device_manager(gdk_window_get_display(event->motion.window))));
368     event->motion.state = 0 | getMouseButtonModifiers(m_mouseButtonCurrentlyDown);
369     event->motion.axes = 0;
370
371     int xRoot, yRoot;
372     gdk_window_get_root_coords(gtk_widget_get_window(GTK_WIDGET(m_testController->mainWebView()->platformView())), m_position.x, m_position.y , &xRoot, &yRoot);
373     event->motion.x_root = xRoot;
374     event->motion.y_root = yRoot;
375
376     sendOrQueueEvent(event);
377 }
378
379 void EventSenderProxy::mouseScrollBy(int horizontal, int vertical)
380 {
381     GdkEvent* event = gdk_event_new(GDK_SCROLL);
382     event->scroll.x = m_position.x;
383     event->scroll.y = m_position.y;
384     event->scroll.time = GDK_CURRENT_TIME;
385     event->scroll.window = gtk_widget_get_window(GTK_WIDGET(m_testController->mainWebView()->platformView()));
386     g_object_ref(event->scroll.window);
387     gdk_event_set_device(event, gdk_device_manager_get_client_pointer(gdk_display_get_device_manager(gdk_window_get_display(event->scroll.window))));
388
389     // For more than one tick in a scroll, we need smooth scroll event
390 #if GTK_CHECK_VERSION(3, 3, 18)
391     if ((horizontal && vertical) || horizontal > 1 || horizontal < -1 || vertical > 1 || vertical < -1) {
392         event->scroll.direction = GDK_SCROLL_SMOOTH;
393         event->scroll.delta_x = -horizontal;
394         event->scroll.delta_y = -vertical;
395
396         sendOrQueueEvent(event);
397         return;
398     }
399 #endif
400
401     if (horizontal < 0)
402         event->scroll.direction = GDK_SCROLL_RIGHT;
403     else if (horizontal > 0)
404         event->scroll.direction = GDK_SCROLL_LEFT;
405     else if (vertical < 0)
406         event->scroll.direction = GDK_SCROLL_DOWN;
407     else if (vertical > 0)
408         event->scroll.direction = GDK_SCROLL_UP;
409     else
410         g_assert_not_reached();
411
412     sendOrQueueEvent(event);
413 }
414
415 void EventSenderProxy::continuousMouseScrollBy(int horizontal, int vertical, bool paged)
416 {
417     // Gtk+ does not support paged scroll events.
418     g_return_if_fail(!paged);
419
420 #if GTK_CHECK_VERSION(3, 3, 18)
421     GdkEvent* event = gdk_event_new(GDK_SCROLL);
422     event->scroll.x = m_position.x;
423     event->scroll.y = m_position.y;
424     event->scroll.time = GDK_CURRENT_TIME;
425     event->scroll.window = gtk_widget_get_window(GTK_WIDGET(m_testController->mainWebView()->platformView()));
426     g_object_ref(event->scroll.window);
427     gdk_event_set_device(event, gdk_device_manager_get_client_pointer(gdk_display_get_device_manager(gdk_window_get_display(event->scroll.window))));
428
429     event->scroll.direction = GDK_SCROLL_SMOOTH;
430     event->scroll.delta_x = -horizontal / pixelsPerScrollTick;
431     event->scroll.delta_y = -vertical / pixelsPerScrollTick;
432
433     sendOrQueueEvent(event);
434 #endif
435 }
436
437 void EventSenderProxy::leapForward(int milliseconds)
438 {
439     if (m_eventQueue.isEmpty())
440         m_eventQueue.append(WTREventQueueItem());
441
442     m_eventQueue.last().delay = milliseconds;
443     m_time += milliseconds / 1000.0;
444 }
445
446 } // namespace WTR