70d94014c8d750cb7d6570804528e208cc2f4a54
[WebKit-https.git] / Tools / WebKitTestRunner / EventSenderProxy.h
1 /*
2  * Copyright (C) 2011, 2014 Apple Inc. All rights reserved.
3  * Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
15  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
16  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
18  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
19  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
20  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
21  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
22  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
23  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
24  * THE POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 #ifndef EventSenderProxy_h
28 #define EventSenderProxy_h
29
30 #include <wtf/Deque.h>
31 #include <wtf/HashMap.h>
32 #include <wtf/RetainPtr.h>
33 #include <wtf/Vector.h>
34
35 #if PLATFORM(GTK)
36 #include <WebCore/GUniquePtrGtk.h>
37 #include <gdk/gdk.h>
38 #include <wtf/HashSet.h>
39 #elif PLATFORM(EFL)
40 #include "EWebKit2.h"
41 #endif
42
43 #if PLATFORM(COCOA)
44 OBJC_CLASS NSEvent;
45 #endif
46
47 namespace WTR {
48
49 class TestController;
50
51 #if PLATFORM(GTK)
52 struct WTREventQueueItem;
53 #elif PLATFORM(EFL)
54 struct WTREvent;
55 #endif
56
57 class EventSenderProxy {
58 public:
59     explicit EventSenderProxy(TestController*);
60     ~EventSenderProxy();
61
62     WKPoint position() const { return m_position; }
63
64     void mouseDown(unsigned button, WKEventModifiers);
65     void mouseUp(unsigned button, WKEventModifiers);
66     void mouseForceDown();
67     void mouseForceUp();
68     void mouseForceChanged(float);
69     void mouseForceClick();
70     void startAndCancelMouseForceClick();
71     void mouseMoveTo(double x, double y);
72     void mouseScrollBy(int x, int y);
73     void mouseScrollByWithWheelAndMomentumPhases(int x, int y, int phase, int momentum);
74     void swipeGestureWithWheelAndMomentumPhases(int x, int y, int phase, int momentum);
75     void continuousMouseScrollBy(int x, int y, bool paged);
76
77     void leapForward(int milliseconds);
78
79     void keyDown(WKStringRef key, WKEventModifiers, unsigned location);
80
81 #if ENABLE(TOUCH_EVENTS)
82     // Touch events.
83     void addTouchPoint(int x, int y);
84     void updateTouchPoint(int index, int x, int y);
85     void setTouchModifier(WKEventModifiers, bool enable);
86     void setTouchPointRadius(int radiusX, int radiusY);
87     void touchStart();
88     void touchMove();
89     void touchEnd();
90     void touchCancel();
91     void clearTouchPoints();
92     void releaseTouchPoint(int index);
93     void cancelTouchPoint(int index);
94 #endif
95
96 private:
97     TestController* m_testController;
98
99     double currentEventTime() { return m_time; }
100     void updateClickCountForButton(int button);
101
102 #if PLATFORM(GTK) || PLATFORM(EFL)
103     void replaySavedEvents();
104 #endif
105
106     void sendMouseDownToStartPressureEvents();
107 #if PLATFORM(COCOA)
108     enum class PressureChangeDirection { Increasing, Decreasing };
109     RetainPtr<NSEvent> beginPressureEvent(int stage);
110     RetainPtr<NSEvent> pressureChangeEvent(int stage, PressureChangeDirection);
111     RetainPtr<NSEvent> pressureChangeEvent(int stage, float pressure, PressureChangeDirection);
112 #endif
113
114 #if PLATFORM(GTK)
115     void sendOrQueueEvent(GdkEvent*);
116     void dispatchEvent(GdkEvent*);
117     GdkEvent* createMouseButtonEvent(GdkEventType, unsigned button, WKEventModifiers);
118     GUniquePtr<GdkEvent> createTouchEvent(GdkEventType, int id);
119     void sendUpdatedTouchEvents();
120 #elif PLATFORM(EFL)
121     void sendOrQueueEvent(const WTREvent&);
122     void dispatchEvent(const WTREvent&);
123 #if ENABLE(TOUCH_EVENTS)
124     void sendTouchEvent(Ewk_Touch_Event_Type);
125 #endif
126 #endif
127
128     double m_time;
129     WKPoint m_position;
130     bool m_leftMouseButtonDown;
131     int m_clickCount;
132     double m_clickTime;
133     WKPoint m_clickPosition;
134     WKEventMouseButton m_clickButton;
135 #if PLATFORM(COCOA)
136     int eventNumber;
137 #elif PLATFORM(GTK)
138     Deque<WTREventQueueItem> m_eventQueue;
139     unsigned m_mouseButtonCurrentlyDown;
140     Vector<GUniquePtr<GdkEvent>> m_touchEvents;
141     HashSet<int> m_updatedTouchEvents;
142 #elif PLATFORM(EFL)
143     Deque<WTREvent> m_eventQueue;
144     WKEventMouseButton m_mouseButton;
145 #if ENABLE(TOUCH_EVENTS)
146     Eina_List* m_touchPoints;
147 #endif
148 #endif
149 };
150
151 } // namespace WTR
152
153 #endif // EventSenderProxy_h