[WK2] WTR needs an implementation of setAsynchronousSpellCheckingEnabled
[WebKit-https.git] / Tools / WebKitTestRunner / InjectedBundle / TestRunner.h
1 /*
2  * Copyright (C) 2010, 2011, 2012 Apple 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
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef TestRunner_h
27 #define TestRunner_h
28
29 #include "JSWrappable.h"
30 #include <JavaScriptCore/JSRetainPtr.h>
31 #include <WebKit2/WKBundleScriptWorld.h>
32 #include <WebKit2/WKRetainPtr.h>
33 #include <string>
34 #include <wtf/PassRefPtr.h>
35
36 #if PLATFORM(MAC)
37 #include <wtf/RetainPtr.h>
38 #include <CoreFoundation/CFRunLoop.h>
39 typedef RetainPtr<CFRunLoopTimerRef> PlatformTimerRef;
40 #elif PLATFORM(WIN)
41 typedef UINT_PTR PlatformTimerRef;
42 #elif PLATFORM(QT)
43 #include <QTimer>
44 typedef QTimer PlatformTimerRef;
45 #elif PLATFORM(GTK)
46 typedef unsigned int PlatformTimerRef;
47 #elif PLATFORM(EFL)
48 #if USE(EO)
49 typedef struct _Eo Ecore_Timer;
50 #else
51 typedef struct _Ecore_Timer Ecore_Timer;
52 #endif
53 typedef Ecore_Timer* PlatformTimerRef;
54 #endif
55
56 namespace WTR {
57
58 class TestRunner : public JSWrappable {
59 public:
60     static PassRefPtr<TestRunner> create();
61     virtual ~TestRunner();
62
63     // JSWrappable
64     virtual JSClassRef wrapperClass();
65
66     void makeWindowObject(JSContextRef, JSObjectRef windowObject, JSValueRef* exception);
67
68     // The basics.
69     void dumpAsText(bool dumpPixels);
70     void waitForPolicyDelegate();
71     void dumpChildFramesAsText() { m_whatToDump = AllFramesText; }
72     void waitUntilDone();
73     void notifyDone();
74     double preciseTime();
75
76     // Other dumping.
77     void dumpBackForwardList() { m_shouldDumpBackForwardListsForAllWindows = true; }
78     void dumpChildFrameScrollPositions() { m_shouldDumpAllFrameScrollPositions = true; }
79     void dumpEditingCallbacks() { m_dumpEditingCallbacks = true; }
80     void dumpSelectionRect() { m_dumpSelectionRect = true; }
81     void dumpStatusCallbacks() { m_dumpStatusCallbacks = true; }
82     void dumpTitleChanges() { m_dumpTitleChanges = true; }
83     void dumpFullScreenCallbacks() { m_dumpFullScreenCallbacks = true; }
84     void dumpFrameLoadCallbacks() { setShouldDumpFrameLoadCallbacks(true); }
85     void dumpProgressFinishedCallback() { setShouldDumpProgressFinishedCallback(true); }
86     void dumpResourceLoadCallbacks() { m_dumpResourceLoadCallbacks = true; }
87     void dumpResourceResponseMIMETypes() { m_dumpResourceResponseMIMETypes = true; }
88     void dumpWillCacheResponse() { m_dumpWillCacheResponse = true; }
89     void dumpApplicationCacheDelegateCallbacks() { m_dumpApplicationCacheDelegateCallbacks = true; }
90     void dumpDatabaseCallbacks() { m_dumpDatabaseCallbacks = true; }
91
92     void setShouldDumpFrameLoadCallbacks(bool value) { m_dumpFrameLoadCallbacks = value; }
93     void setShouldDumpProgressFinishedCallback(bool value) { m_dumpProgressFinishedCallback = value; }
94
95     // Special options.
96     void keepWebHistory();
97     void setAcceptsEditing(bool value) { m_shouldAllowEditing = value; }
98     void setCanOpenWindows(bool);
99     void setCloseRemainingWindowsWhenComplete(bool value) { m_shouldCloseExtraWindows = value; }
100     void setXSSAuditorEnabled(bool);
101     void setAllowUniversalAccessFromFileURLs(bool);
102     void setAllowFileAccessFromFileURLs(bool);
103     void setPluginsEnabled(bool);
104     void setJavaScriptCanAccessClipboard(bool);
105     void setPrivateBrowsingEnabled(bool);
106     void setPopupBlockingEnabled(bool);
107     void setAuthorAndUserStylesEnabled(bool);
108     void setCustomPolicyDelegate(bool enabled, bool permissive = false);
109     void addOriginAccessWhitelistEntry(JSStringRef sourceOrigin, JSStringRef destinationProtocol, JSStringRef destinationHost, bool allowDestinationSubdomains);
110     void removeOriginAccessWhitelistEntry(JSStringRef sourceOrigin, JSStringRef destinationProtocol, JSStringRef destinationHost, bool allowDestinationSubdomains);
111     void setUserStyleSheetEnabled(bool);
112     void setUserStyleSheetLocation(JSStringRef);
113     void setSpatialNavigationEnabled(bool);
114     void setTabKeyCyclesThroughElements(bool);
115     void setSerializeHTTPLoads();
116     void dispatchPendingLoadRequests();
117     void setCacheModel(int);
118     void setAsynchronousSpellCheckingEnabled(bool);
119
120     // Special DOM functions.
121     void clearBackForwardList();
122     void execCommand(JSStringRef name, JSStringRef argument);
123     bool isCommandEnabled(JSStringRef name);
124     unsigned windowCount();
125
126     // Repaint testing.
127     void testRepaint() { m_testRepaint = true; }
128     void repaintSweepHorizontally() { m_testRepaintSweepHorizontally = true; }
129     void display();
130     
131     // UserContent testing.
132     void addUserScript(JSStringRef source, bool runAtStart, bool allFrames);
133     void addUserStyleSheet(JSStringRef source, bool allFrames);
134
135     // Text search testing.
136     bool findString(JSStringRef, JSValueRef optionsArray);
137
138     // Local storage
139     void clearAllDatabases();
140     void setDatabaseQuota(uint64_t);
141     JSRetainPtr<JSStringRef> pathToLocalResource(JSStringRef);
142
143     // Application Cache
144     void clearAllApplicationCaches();
145     void clearApplicationCacheForOrigin(JSStringRef origin);
146     void setAppCacheMaximumSize(uint64_t);
147     long long applicationCacheDiskUsageForOrigin(JSStringRef origin);
148     void setApplicationCacheOriginQuota(unsigned long long);
149     void disallowIncreaseForApplicationCacheQuota();
150     bool shouldDisallowIncreaseForApplicationCacheQuota() { return m_disallowIncreaseForApplicationCacheQuota; }
151     JSValueRef originsWithApplicationCache();
152
153     // Printing
154     bool isPageBoxVisible(int pageIndex);
155
156     // Authentication
157     void setHandlesAuthenticationChallenges(bool);
158     void setAuthenticationUsername(JSStringRef);
159     void setAuthenticationPassword(JSStringRef);
160
161     void setValueForUser(JSContextRef, JSValueRef element, JSStringRef value);
162
163     // Audio testing.
164     void setAudioData(JSContextRef, JSValueRef data);
165
166     enum WhatToDump { RenderTree, MainFrameText, AllFramesText, Audio };
167     WhatToDump whatToDump() const { return m_whatToDump; }
168
169     bool shouldDumpAllFrameScrollPositions() const { return m_shouldDumpAllFrameScrollPositions; }
170     bool shouldDumpBackForwardListsForAllWindows() const { return m_shouldDumpBackForwardListsForAllWindows; }
171     bool shouldDumpEditingCallbacks() const { return m_dumpEditingCallbacks; }
172     bool shouldDumpMainFrameScrollPosition() const { return m_whatToDump == RenderTree; }
173     bool shouldDumpStatusCallbacks() const { return m_dumpStatusCallbacks; }
174     bool shouldDumpTitleChanges() const { return m_dumpTitleChanges; }
175     bool shouldDumpPixels() const { return m_dumpPixels; }
176     bool shouldDumpFullScreenCallbacks() const { return m_dumpFullScreenCallbacks; }
177     bool shouldDumpFrameLoadCallbacks() const { return m_dumpFrameLoadCallbacks; }
178     bool shouldDumpProgressFinishedCallback() const { return m_dumpProgressFinishedCallback; }
179     bool shouldDumpResourceLoadCallbacks() const { return m_dumpResourceLoadCallbacks; }
180     bool shouldDumpResourceResponseMIMETypes() const { return m_dumpResourceResponseMIMETypes; }
181     bool shouldDumpWillCacheResponse() const { return m_dumpWillCacheResponse; }
182     bool shouldDumpApplicationCacheDelegateCallbacks() const { return m_dumpApplicationCacheDelegateCallbacks; }
183     bool shouldDumpDatabaseCallbacks() const { return m_dumpDatabaseCallbacks; }
184     bool shouldDumpSelectionRect() const { return m_dumpSelectionRect; }
185
186     bool isPolicyDelegateEnabled() const { return m_policyDelegateEnabled; }
187     bool isPolicyDelegatePermissive() const { return m_policyDelegatePermissive; }
188
189     bool waitToDump() const { return m_waitToDump; }
190     void waitToDumpWatchdogTimerFired();
191     void invalidateWaitToDumpWatchdogTimer();
192
193     bool shouldAllowEditing() const { return m_shouldAllowEditing; }
194
195     bool shouldCloseExtraWindowsAfterRunningTest() const { return m_shouldCloseExtraWindows; }
196
197     void evaluateScriptInIsolatedWorld(JSContextRef, unsigned worldID, JSStringRef script);
198     static unsigned worldIDForWorld(WKBundleScriptWorldRef);
199
200     void showWebInspector();
201     void closeWebInspector();
202     void evaluateInWebInspector(long callId, JSStringRef script);
203
204     void setPOSIXLocale(JSStringRef);
205
206     bool willSendRequestReturnsNull() const { return m_willSendRequestReturnsNull; }
207     void setWillSendRequestReturnsNull(bool f) { m_willSendRequestReturnsNull = f; }
208     bool willSendRequestReturnsNullOnRedirect() const { return m_willSendRequestReturnsNullOnRedirect; }
209     void setWillSendRequestReturnsNullOnRedirect(bool f) { m_willSendRequestReturnsNullOnRedirect = f; }
210
211     void setTextDirection(JSStringRef);
212
213     void setShouldStayOnPageAfterHandlingBeforeUnload(bool);
214
215     void setDefersLoading(bool);
216
217     void setStopProvisionalFrameLoads() { m_shouldStopProvisionalFrameLoads = true; }
218     bool shouldStopProvisionalFrameLoads() const { return m_shouldStopProvisionalFrameLoads; }
219     
220     bool globalFlag() const { return m_globalFlag; }
221     void setGlobalFlag(bool value) { m_globalFlag = value; }
222
223     void addChromeInputField(JSValueRef);
224     void removeChromeInputField(JSValueRef);
225     void focusWebView(JSValueRef);
226     void setBackingScaleFactor(double, JSValueRef);
227
228     void setWindowIsKey(bool);
229
230     void callAddChromeInputFieldCallback();
231     void callRemoveChromeInputFieldCallback();
232     void callFocusWebViewCallback();
233     void callSetBackingScaleFactorCallback();
234
235     void overridePreference(JSStringRef preference, JSStringRef value);
236
237     // Cookies testing
238     void setAlwaysAcceptCookies(bool);
239
240     // Custom full screen behavior.
241     void setHasCustomFullScreenBehavior(bool value) { m_customFullScreenBehavior = value; }
242     bool hasCustomFullScreenBehavior() const { return m_customFullScreenBehavior; }
243     void setViewModeMediaFeature(JSStringRef);
244
245     // Web notifications.
246     void grantWebNotificationPermission(JSStringRef origin);
247     void denyWebNotificationPermission(JSStringRef origin);
248     void removeAllWebNotificationPermissions();
249     void simulateWebNotificationClick(JSValueRef notification);
250
251     // Geolocation.
252     void setGeolocationPermission(bool);
253     void setMockGeolocationPosition(double latitude, double longitude, double accuracy, JSValueRef altitude, JSValueRef altitudeAccuracy, JSValueRef heading, JSValueRef speed);
254     void setMockGeolocationPositionUnavailableError(JSStringRef message);
255
256     JSRetainPtr<JSStringRef> platformName();
257
258     void setPageVisibility(JSStringRef state);
259     void resetPageVisibility();
260
261     bool callShouldCloseOnWebView();
262
263     void setCustomTimeout(int duration);
264
265     // Work queue.
266     void queueBackNavigation(unsigned howFarBackward);
267     void queueForwardNavigation(unsigned howFarForward);
268     void queueLoad(JSStringRef url, JSStringRef target);
269     void queueLoadHTMLString(JSStringRef content, JSStringRef baseURL, JSStringRef unreachableURL);
270     void queueReload();
271     void queueLoadingScript(JSStringRef script);
272     void queueNonLoadingScript(JSStringRef script);
273
274 private:
275     static const double waitToDumpWatchdogTimerInterval;
276
277     TestRunner();
278
279     void platformInitialize();
280     void initializeWaitToDumpWatchdogTimerIfNeeded();
281
282     WhatToDump m_whatToDump;
283     bool m_shouldDumpAllFrameScrollPositions;
284     bool m_shouldDumpBackForwardListsForAllWindows;
285
286     bool m_shouldAllowEditing;
287     bool m_shouldCloseExtraWindows;
288
289     bool m_dumpEditingCallbacks;
290     bool m_dumpStatusCallbacks;
291     bool m_dumpTitleChanges;
292     bool m_dumpPixels;
293     bool m_dumpSelectionRect;
294     bool m_dumpFullScreenCallbacks;
295     bool m_dumpFrameLoadCallbacks;
296     bool m_dumpProgressFinishedCallback;
297     bool m_dumpResourceLoadCallbacks;
298     bool m_dumpResourceResponseMIMETypes;
299     bool m_dumpWillCacheResponse;
300     bool m_dumpApplicationCacheDelegateCallbacks;
301     bool m_dumpDatabaseCallbacks;
302     bool m_disallowIncreaseForApplicationCacheQuota;
303     bool m_waitToDump; // True if waitUntilDone() has been called, but notifyDone() has not yet been called.
304     bool m_testRepaint;
305     bool m_testRepaintSweepHorizontally;
306
307     bool m_willSendRequestReturnsNull;
308     bool m_willSendRequestReturnsNullOnRedirect;
309     bool m_shouldStopProvisionalFrameLoads;
310
311     bool m_policyDelegateEnabled;
312     bool m_policyDelegatePermissive;
313     
314     bool m_globalFlag;
315     bool m_customFullScreenBehavior;
316
317     int m_timeout;
318
319     bool m_userStyleSheetEnabled;
320     WKRetainPtr<WKStringRef> m_userStyleSheetLocation;
321
322     PlatformTimerRef m_waitToDumpWatchdogTimer;
323 };
324
325 } // namespace WTR
326
327 #endif // TestRunner_h