7c7d590e9e1539a5a8578f2541cf7abb8dd7d996
[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 static guint getMouseButtonModifiers(int gdkButton)
87 {
88     if (gdkButton == 1)
89         return GDK_BUTTON1_MASK;
90     if (gdkButton == 2)
91         return GDK_BUTTON2_MASK;
92     if (gdkButton == 3)
93         return GDK_BUTTON3_MASK;
94     return 0;
95 }
96
97 static unsigned eventSenderButtonToGDKButton(unsigned button)
98 {
99     int mouseButton = 3;
100     if (button <= 2)
101         mouseButton = button + 1;
102     // fast/events/mouse-click-events expects the 4th button to be treated as the middle button.
103     else if (button == 3)
104         mouseButton = 2;
105
106     return mouseButton;
107 }
108
109 GdkEvent* EventSenderProxy::createMouseButtonEvent(GdkEventType eventType, unsigned button, WKEventModifiers modifiers)
110 {
111     GdkEvent* mouseEvent = gdk_event_new(eventType);
112
113     mouseEvent->button.button = eventSenderButtonToGDKButton(button);
114     mouseEvent->button.x = m_position.x;
115     mouseEvent->button.y = m_position.y;
116     mouseEvent->button.window = gtk_widget_get_window(GTK_WIDGET(m_testController->mainWebView()->platformView()));
117     g_object_ref(mouseEvent->button.window);
118     gdk_event_set_device(mouseEvent, gdk_device_manager_get_client_pointer(gdk_display_get_device_manager(gdk_window_get_display(mouseEvent->button.window))));
119     mouseEvent->button.state = modifiers | getMouseButtonModifiers(mouseEvent->button.button);
120     mouseEvent->button.time = GDK_CURRENT_TIME;
121     mouseEvent->button.axes = 0;
122
123     int xRoot, yRoot;
124     gdk_window_get_root_coords(mouseEvent->button.window, m_position.x, m_position.y, &xRoot, &yRoot);
125     mouseEvent->button.x_root = xRoot;
126     mouseEvent->button.y_root = yRoot;
127
128     return mouseEvent;
129 }
130
131 void EventSenderProxy::updateClickCountForButton(int button)
132 {
133     if (m_time - m_clickTime < 1 && m_position == m_clickPosition && button == m_clickButton) {
134         ++m_clickCount;
135         m_clickTime = m_time;
136         return;
137     }
138
139     m_clickCount = 1;
140     m_clickTime = m_time;
141     m_clickPosition = m_position;
142     m_clickButton = button;
143 }
144
145 static void dispatchEvent(GdkEvent* event)
146 {
147     gtk_main_do_event(event);
148     gdk_event_free(event);
149 }
150
151 void EventSenderProxy::replaySavedEvents()
152 {
153     while (!m_eventQueue.isEmpty()) {
154         WTREventQueueItem item = m_eventQueue.first();
155         if (item.delay)
156             g_usleep(item.delay * 1000);
157
158         dispatchEvent(item.event);
159         m_eventQueue.remove(0);
160     }
161 }
162
163 void EventSenderProxy::sendOrQueueEvent(GdkEvent* event)
164 {
165     if (m_eventQueue.isEmpty() || !m_eventQueue.last().delay) {
166         dispatchEvent(event);
167         return;
168     }
169
170     m_eventQueue.last().event = event;
171     replaySavedEvents();
172 }
173
174 static guint webkitModifiersToGDKModifiers(WKEventModifiers wkModifiers)
175 {
176     guint modifiers = 0;
177
178     if (wkModifiers & kWKEventModifiersControlKey)
179         modifiers |= GDK_CONTROL_MASK;
180     if (wkModifiers & kWKEventModifiersShiftKey)
181         modifiers |= GDK_SHIFT_MASK;
182     if (wkModifiers & kWKEventModifiersAltKey)
183         modifiers |= GDK_MOD1_MASK;
184     if (wkModifiers & kWKEventModifiersMetaKey)
185         modifiers |= GDK_META_MASK;
186
187     return modifiers;
188 }
189
190 int getGDKKeySymForKeyRef(WKStringRef keyRef, unsigned location, guint* modifiers)
191 {
192     if (location == DOMKeyLocationNumpad) {
193         if (WKStringIsEqualToUTF8CString(keyRef, "leftArrow"))
194             return GDK_KEY_KP_Left;
195         if (WKStringIsEqualToUTF8CString(keyRef, "rightArror"))
196             return GDK_KEY_KP_Right;
197         if (WKStringIsEqualToUTF8CString(keyRef, "upArrow"))
198             return GDK_KEY_KP_Up;
199         if (WKStringIsEqualToUTF8CString(keyRef, "downArrow"))
200             return GDK_KEY_KP_Down;
201         if (WKStringIsEqualToUTF8CString(keyRef, "pageUp"))
202             return GDK_KEY_KP_Page_Up;
203         if (WKStringIsEqualToUTF8CString(keyRef, "pageDown"))
204             return GDK_KEY_KP_Page_Down;
205         if (WKStringIsEqualToUTF8CString(keyRef, "home"))
206             return GDK_KEY_KP_Home;
207         if (WKStringIsEqualToUTF8CString(keyRef, "end"))
208             return GDK_KEY_KP_End;
209         if (WKStringIsEqualToUTF8CString(keyRef, "insert"))
210             return GDK_KEY_KP_Insert;
211         if (WKStringIsEqualToUTF8CString(keyRef, "delete"))
212             return GDK_KEY_KP_Delete;
213
214         return GDK_KEY_VoidSymbol;
215     }
216
217     if (WKStringIsEqualToUTF8CString(keyRef, "leftArrow"))
218         return GDK_KEY_Left;
219     if (WKStringIsEqualToUTF8CString(keyRef, "rightArrow"))
220         return GDK_KEY_Right;
221     if (WKStringIsEqualToUTF8CString(keyRef, "upArrow"))
222         return GDK_KEY_Up;
223     if (WKStringIsEqualToUTF8CString(keyRef, "downArrow"))
224         return GDK_KEY_Down;
225     if (WKStringIsEqualToUTF8CString(keyRef, "pageUp"))
226         return GDK_KEY_Page_Up;
227     if (WKStringIsEqualToUTF8CString(keyRef, "pageDown"))
228         return GDK_KEY_Page_Down;
229     if (WKStringIsEqualToUTF8CString(keyRef, "home"))
230         return GDK_KEY_Home;
231     if (WKStringIsEqualToUTF8CString(keyRef, "end"))
232         return GDK_KEY_End;
233     if (WKStringIsEqualToUTF8CString(keyRef, "insert"))
234         return GDK_KEY_Insert;
235     if (WKStringIsEqualToUTF8CString(keyRef, "delete"))
236         return GDK_KEY_Delete;
237     if (WKStringIsEqualToUTF8CString(keyRef, "printScreen"))
238         return GDK_KEY_Print;
239     if (WKStringIsEqualToUTF8CString(keyRef, "menu"))
240         return GDK_KEY_Menu;
241     if (WKStringIsEqualToUTF8CString(keyRef, "F1"))
242         return GDK_KEY_F1;
243     if (WKStringIsEqualToUTF8CString(keyRef, "F2"))
244         return GDK_KEY_F2;
245     if (WKStringIsEqualToUTF8CString(keyRef, "F3"))
246         return GDK_KEY_F3;
247     if (WKStringIsEqualToUTF8CString(keyRef, "F4"))
248         return GDK_KEY_F4;
249     if (WKStringIsEqualToUTF8CString(keyRef, "F5"))
250         return GDK_KEY_F5;
251     if (WKStringIsEqualToUTF8CString(keyRef, "F6"))
252         return GDK_KEY_F6;
253     if (WKStringIsEqualToUTF8CString(keyRef, "F7"))
254         return GDK_KEY_F7;
255     if (WKStringIsEqualToUTF8CString(keyRef, "F8"))
256         return GDK_KEY_F8;
257     if (WKStringIsEqualToUTF8CString(keyRef, "F9"))
258         return GDK_KEY_F9;
259     if (WKStringIsEqualToUTF8CString(keyRef, "F10"))
260         return GDK_KEY_F10;
261     if (WKStringIsEqualToUTF8CString(keyRef, "F11"))
262         return GDK_KEY_F11;
263     if (WKStringIsEqualToUTF8CString(keyRef, "F12"))
264         return GDK_KEY_F12;
265
266     size_t bufferSize = WKStringGetMaximumUTF8CStringSize(keyRef);
267     OwnArrayPtr<char> buffer = adoptArrayPtr(new char[bufferSize]);
268     WKStringGetUTF8CString(keyRef, buffer.get(), bufferSize);
269     char charCode = buffer.get()[0];
270
271     if (charCode == '\n' || charCode == '\r')
272         return GDK_KEY_Return;
273     if (charCode == '\t')
274         return GDK_KEY_Tab;
275     if (charCode == '\x8')
276         return GDK_KEY_BackSpace;
277
278     if (WTF::isASCIIUpper(charCode))
279         *modifiers |= GDK_SHIFT_MASK;
280
281     return gdk_unicode_to_keyval(static_cast<guint32>(buffer.get()[0]));
282 }
283
284 void EventSenderProxy::keyDown(WKStringRef keyRef, WKEventModifiers wkModifiers, unsigned location)
285 {
286     guint modifiers = webkitModifiersToGDKModifiers(wkModifiers);
287     int gdkKeySym = getGDKKeySymForKeyRef(keyRef, location, &modifiers);
288
289     GdkEvent* pressEvent = gdk_event_new(GDK_KEY_PRESS);
290     pressEvent->key.keyval = gdkKeySym;
291     pressEvent->key.state = modifiers;
292     pressEvent->key.window = gtk_widget_get_window(GTK_WIDGET(m_testController->mainWebView()->platformWindow()));
293     g_object_ref(pressEvent->key.window);
294     gdk_event_set_device(pressEvent, gdk_device_manager_get_client_pointer(gdk_display_get_device_manager(gdk_window_get_display(pressEvent->key.window))));
295
296     GOwnPtr<GdkKeymapKey> keys;
297     gint nKeys;
298     if (gdk_keymap_get_entries_for_keyval(gdk_keymap_get_default(), gdkKeySym, &keys.outPtr(), &nKeys))
299         pressEvent->key.hardware_keycode = keys.get()[0].keycode;
300
301     GdkEvent* releaseEvent = gdk_event_copy(pressEvent);
302     dispatchEvent(pressEvent);
303     releaseEvent->key.type = GDK_KEY_RELEASE;
304     dispatchEvent(releaseEvent);
305 }
306
307 void EventSenderProxy::mouseDown(unsigned button, WKEventModifiers wkModifiers)
308 {
309     // If the same mouse button is already in the down position don't
310     // send another event as it may confuse Xvfb.
311     unsigned gdkButton = eventSenderButtonToGDKButton(button);
312     if (m_mouseButtonCurrentlyDown == gdkButton)
313         return;
314
315     m_mouseButtonCurrentlyDown = gdkButton;
316
317     // Normally GDK will send both GDK_BUTTON_PRESS and GDK_2BUTTON_PRESS for
318     // the second button press during double-clicks. WebKit GTK+ selectively
319     // ignores the first GDK_BUTTON_PRESS of that pair using gdk_event_peek.
320     // Since our events aren't ever going onto the GDK event queue, WebKit won't
321     // be able to filter out the first GDK_BUTTON_PRESS, so we just don't send
322     // it here. Eventually this code should probably figure out a way to get all
323     // appropriate events onto the event queue and this work-around should be
324     // removed.
325     updateClickCountForButton(button);
326
327     GdkEventType eventType;
328     if (m_clickCount == 2)
329         eventType = GDK_2BUTTON_PRESS;
330     else if (m_clickCount == 3)
331         eventType = GDK_3BUTTON_PRESS;
332     else
333         eventType = GDK_BUTTON_PRESS;
334
335     GdkEvent* event = createMouseButtonEvent(eventType, button, wkModifiers);
336     sendOrQueueEvent(event);
337 }
338
339 void EventSenderProxy::mouseUp(unsigned button, WKEventModifiers wkModifiers)
340 {
341     m_clickButton = kWKEventMouseButtonNoButton;
342     GdkEvent* event = createMouseButtonEvent(GDK_BUTTON_RELEASE, button, wkModifiers);
343     sendOrQueueEvent(event);
344
345     if (m_mouseButtonCurrentlyDown == event->button.button)
346         m_mouseButtonCurrentlyDown = 0;
347     m_clickPosition = m_position;
348     m_clickTime = GDK_CURRENT_TIME;
349 }
350
351 void EventSenderProxy::mouseMoveTo(double x, double y)
352 {
353     m_position.x = x;
354     m_position.y = y;
355
356     GdkEvent* event = gdk_event_new(GDK_MOTION_NOTIFY);
357     event->motion.x = m_position.x;
358     event->motion.y = m_position.y;
359
360     event->motion.time = GDK_CURRENT_TIME;
361     event->motion.window = gtk_widget_get_window(GTK_WIDGET(m_testController->mainWebView()->platformView()));
362     g_object_ref(event->motion.window);
363     gdk_event_set_device(event, gdk_device_manager_get_client_pointer(gdk_display_get_device_manager(gdk_window_get_display(event->motion.window))));
364     event->motion.state = 0 | getMouseButtonModifiers(m_mouseButtonCurrentlyDown);
365     event->motion.axes = 0;
366
367     int xRoot, yRoot;
368     gdk_window_get_root_coords(gtk_widget_get_window(GTK_WIDGET(m_testController->mainWebView()->platformView())), m_position.x, m_position.y , &xRoot, &yRoot);
369     event->motion.x_root = xRoot;
370     event->motion.y_root = yRoot;
371
372     sendOrQueueEvent(event);
373 }
374
375 void EventSenderProxy::mouseScrollBy(int horizontal, int vertical)
376 {
377     GdkEvent* event = gdk_event_new(GDK_SCROLL);
378     event->scroll.x = m_position.x;
379     event->scroll.y = m_position.y;
380     event->scroll.time = GDK_CURRENT_TIME;
381     event->scroll.window = gtk_widget_get_window(GTK_WIDGET(m_testController->mainWebView()->platformView()));
382     g_object_ref(event->scroll.window);
383     gdk_event_set_device(event, gdk_device_manager_get_client_pointer(gdk_display_get_device_manager(gdk_window_get_display(event->scroll.window))));
384
385     // For more than one tick in a scroll, we need smooth scroll event
386 #if GTK_CHECK_VERSION(3, 3, 18)
387     if ((horizontal && vertical) || horizontal > 1 || horizontal < -1 || vertical > 1 || vertical < -1) {
388         event->scroll.direction = GDK_SCROLL_SMOOTH;
389         event->scroll.delta_x = -horizontal;
390         event->scroll.delta_y = -vertical;
391
392         sendOrQueueEvent(event);
393         return;
394     }
395 #endif
396
397     if (horizontal < 0)
398         event->scroll.direction = GDK_SCROLL_RIGHT;
399     else if (horizontal > 0)
400         event->scroll.direction = GDK_SCROLL_LEFT;
401     else if (vertical < 0)
402         event->scroll.direction = GDK_SCROLL_DOWN;
403     else if (vertical > 0)
404         event->scroll.direction = GDK_SCROLL_UP;
405     else
406         g_assert_not_reached();
407
408     sendOrQueueEvent(event);
409 }
410
411 void EventSenderProxy::continuousMouseScrollBy(int horizontal, int vertical, bool paged)
412 {
413     // Gtk+ does not support paged scroll events.
414     g_return_if_fail(!paged);
415
416 #if GTK_CHECK_VERSION(3, 3, 18)
417     GdkEvent* event = gdk_event_new(GDK_SCROLL);
418     event->scroll.x = m_position.x;
419     event->scroll.y = m_position.y;
420     event->scroll.time = GDK_CURRENT_TIME;
421     event->scroll.window = gtk_widget_get_window(GTK_WIDGET(m_testController->mainWebView()->platformView()));
422     g_object_ref(event->scroll.window);
423     gdk_event_set_device(event, gdk_device_manager_get_client_pointer(gdk_display_get_device_manager(gdk_window_get_display(event->scroll.window))));
424
425     event->scroll.direction = GDK_SCROLL_SMOOTH;
426     event->scroll.delta_x = -horizontal / pixelsPerScrollTick;
427     event->scroll.delta_y = -vertical / pixelsPerScrollTick;
428
429     sendOrQueueEvent(event);
430 #endif
431 }
432
433 void EventSenderProxy::leapForward(int milliseconds)
434 {
435     if (m_eventQueue.isEmpty())
436         m_eventQueue.append(WTREventQueueItem());
437
438     m_eventQueue.last().delay = milliseconds;
439     m_time += milliseconds / 1000.0;
440 }
441
442 } // namespace WTR