[EFL] Build break with latest EFL 1.8 libraries.
[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(GTK)
43 typedef unsigned int PlatformTimerRef;
44 #elif PLATFORM(EFL)
45 #if USE(EO)
46 typedef struct _Eo_Opaque Ecore_Timer;
47 #else
48 typedef struct _Ecore_Timer Ecore_Timer;
49 #endif
50 typedef Ecore_Timer* PlatformTimerRef;
51 #endif
52
53 namespace WTR {
54
55 class TestRunner : public JSWrappable {
56 public:
57     static PassRefPtr<TestRunner> create();
58     virtual ~TestRunner();
59
60     // JSWrappable
61     virtual JSClassRef wrapperClass();
62
63     void makeWindowObject(JSContextRef, JSObjectRef windowObject, JSValueRef* exception);
64
65     // The basics.
66     void dumpAsText(bool dumpPixels);
67     void waitForPolicyDelegate();
68     void dumpChildFramesAsText() { m_whatToDump = AllFramesText; }
69     void waitUntilDone();
70     void notifyDone();
71     double preciseTime();
72
73     // Other dumping.
74     void dumpBackForwardList() { m_shouldDumpBackForwardListsForAllWindows = true; }
75     void dumpChildFrameScrollPositions() { m_shouldDumpAllFrameScrollPositions = true; }
76     void dumpEditingCallbacks() { m_dumpEditingCallbacks = true; }
77     void dumpSelectionRect() { m_dumpSelectionRect = true; }
78     void dumpStatusCallbacks() { m_dumpStatusCallbacks = true; }
79     void dumpTitleChanges() { m_dumpTitleChanges = true; }
80     void dumpFullScreenCallbacks() { m_dumpFullScreenCallbacks = true; }
81     void dumpFrameLoadCallbacks() { setShouldDumpFrameLoadCallbacks(true); }
82     void dumpProgressFinishedCallback() { setShouldDumpProgressFinishedCallback(true); }
83     void dumpResourceLoadCallbacks() { m_dumpResourceLoadCallbacks = true; }
84     void dumpResourceResponseMIMETypes() { m_dumpResourceResponseMIMETypes = true; }
85     void dumpWillCacheResponse() { m_dumpWillCacheResponse = true; }
86     void dumpApplicationCacheDelegateCallbacks() { m_dumpApplicationCacheDelegateCallbacks = true; }
87     void dumpDatabaseCallbacks() { m_dumpDatabaseCallbacks = true; }
88     void dumpDOMAsWebArchive() { m_whatToDump = DOMAsWebArchive; }
89
90     void setShouldDumpFrameLoadCallbacks(bool value) { m_dumpFrameLoadCallbacks = value; }
91     void setShouldDumpProgressFinishedCallback(bool value) { m_dumpProgressFinishedCallback = value; }
92
93     // Special options.
94     void keepWebHistory();
95     void setAcceptsEditing(bool value) { m_shouldAllowEditing = value; }
96     void setCanOpenWindows(bool);
97     void setCloseRemainingWindowsWhenComplete(bool value) { m_shouldCloseExtraWindows = value; }
98     void setXSSAuditorEnabled(bool);
99     void setAllowUniversalAccessFromFileURLs(bool);
100     void setAllowFileAccessFromFileURLs(bool);
101     void setPluginsEnabled(bool);
102     void setJavaScriptCanAccessClipboard(bool);
103     void setPrivateBrowsingEnabled(bool);
104     void setPopupBlockingEnabled(bool);
105     void setAuthorAndUserStylesEnabled(bool);
106     void setCustomPolicyDelegate(bool enabled, bool permissive = false);
107     void addOriginAccessWhitelistEntry(JSStringRef sourceOrigin, JSStringRef destinationProtocol, JSStringRef destinationHost, bool allowDestinationSubdomains);
108     void removeOriginAccessWhitelistEntry(JSStringRef sourceOrigin, JSStringRef destinationProtocol, JSStringRef destinationHost, bool allowDestinationSubdomains);
109     void setUserStyleSheetEnabled(bool);
110     void setUserStyleSheetLocation(JSStringRef);
111     void setSpatialNavigationEnabled(bool);
112     void setTabKeyCyclesThroughElements(bool);
113     void setSerializeHTTPLoads();
114     void dispatchPendingLoadRequests();
115     void setCacheModel(int);
116     void setAsynchronousSpellCheckingEnabled(bool);
117
118     // Special DOM functions.
119     void clearBackForwardList();
120     void execCommand(JSStringRef name, JSStringRef argument);
121     bool isCommandEnabled(JSStringRef name);
122     unsigned windowCount();
123
124     // Repaint testing.
125     void testRepaint() { m_testRepaint = true; }
126     void repaintSweepHorizontally() { m_testRepaintSweepHorizontally = true; }
127     void display();
128     
129     // UserContent testing.
130     void addUserScript(JSStringRef source, bool runAtStart, bool allFrames);
131     void addUserStyleSheet(JSStringRef source, bool allFrames);
132
133     // Text search testing.
134     bool findString(JSStringRef, JSValueRef optionsArray);
135
136     // Local storage
137     void clearAllDatabases();
138     void setDatabaseQuota(uint64_t);
139     JSRetainPtr<JSStringRef> pathToLocalResource(JSStringRef);
140
141     // Application Cache
142     void clearAllApplicationCaches();
143     void clearApplicationCacheForOrigin(JSStringRef origin);
144     void setAppCacheMaximumSize(uint64_t);
145     long long applicationCacheDiskUsageForOrigin(JSStringRef origin);
146     void setApplicationCacheOriginQuota(unsigned long long);
147     void disallowIncreaseForApplicationCacheQuota();
148     bool shouldDisallowIncreaseForApplicationCacheQuota() { return m_disallowIncreaseForApplicationCacheQuota; }
149     JSValueRef originsWithApplicationCache();
150
151     // Printing
152     bool isPageBoxVisible(int pageIndex);
153     bool isPrinting() { return m_isPrinting; }
154     void setPrinting() { m_isPrinting = true; }
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 setAudioResult(JSContextRef, JSValueRef data);
165
166     void setBlockAllPlugins(bool shouldBlock);
167
168     enum WhatToDump { RenderTree, MainFrameText, AllFramesText, Audio, DOMAsWebArchive };
169     WhatToDump whatToDump() const { return m_whatToDump; }
170
171     bool shouldDumpAllFrameScrollPositions() const { return m_shouldDumpAllFrameScrollPositions; }
172     bool shouldDumpBackForwardListsForAllWindows() const { return m_shouldDumpBackForwardListsForAllWindows; }
173     bool shouldDumpEditingCallbacks() const { return m_dumpEditingCallbacks; }
174     bool shouldDumpMainFrameScrollPosition() const { return m_whatToDump == RenderTree; }
175     bool shouldDumpStatusCallbacks() const { return m_dumpStatusCallbacks; }
176     bool shouldDumpTitleChanges() const { return m_dumpTitleChanges; }
177     bool shouldDumpPixels() const { return m_dumpPixels; }
178     bool shouldDumpFullScreenCallbacks() const { return m_dumpFullScreenCallbacks; }
179     bool shouldDumpFrameLoadCallbacks() const { return m_dumpFrameLoadCallbacks; }
180     bool shouldDumpProgressFinishedCallback() const { return m_dumpProgressFinishedCallback; }
181     bool shouldDumpResourceLoadCallbacks() const { return m_dumpResourceLoadCallbacks; }
182     bool shouldDumpResourceResponseMIMETypes() const { return m_dumpResourceResponseMIMETypes; }
183     bool shouldDumpWillCacheResponse() const { return m_dumpWillCacheResponse; }
184     bool shouldDumpApplicationCacheDelegateCallbacks() const { return m_dumpApplicationCacheDelegateCallbacks; }
185     bool shouldDumpDatabaseCallbacks() const { return m_dumpDatabaseCallbacks; }
186     bool shouldDumpSelectionRect() const { return m_dumpSelectionRect; }
187
188     bool isPolicyDelegateEnabled() const { return m_policyDelegateEnabled; }
189     bool isPolicyDelegatePermissive() const { return m_policyDelegatePermissive; }
190
191     bool waitToDump() const { return m_waitToDump; }
192     void waitToDumpWatchdogTimerFired();
193     void invalidateWaitToDumpWatchdogTimer();
194
195     bool shouldAllowEditing() const { return m_shouldAllowEditing; }
196
197     bool shouldCloseExtraWindowsAfterRunningTest() const { return m_shouldCloseExtraWindows; }
198
199     void evaluateScriptInIsolatedWorld(JSContextRef, unsigned worldID, JSStringRef script);
200     static unsigned worldIDForWorld(WKBundleScriptWorldRef);
201
202     void showWebInspector();
203     void closeWebInspector();
204     void evaluateInWebInspector(long callId, JSStringRef script);
205
206     void setPOSIXLocale(JSStringRef);
207
208     bool willSendRequestReturnsNull() const { return m_willSendRequestReturnsNull; }
209     void setWillSendRequestReturnsNull(bool f) { m_willSendRequestReturnsNull = f; }
210     bool willSendRequestReturnsNullOnRedirect() const { return m_willSendRequestReturnsNullOnRedirect; }
211     void setWillSendRequestReturnsNullOnRedirect(bool f) { m_willSendRequestReturnsNullOnRedirect = f; }
212
213     void setTextDirection(JSStringRef);
214
215     void setShouldStayOnPageAfterHandlingBeforeUnload(bool);
216
217     void setDefersLoading(bool);
218
219     void setStopProvisionalFrameLoads() { m_shouldStopProvisionalFrameLoads = true; }
220     bool shouldStopProvisionalFrameLoads() const { return m_shouldStopProvisionalFrameLoads; }
221     
222     bool globalFlag() const { return m_globalFlag; }
223     void setGlobalFlag(bool value) { m_globalFlag = value; }
224
225     void addChromeInputField(JSValueRef);
226     void removeChromeInputField(JSValueRef);
227     void focusWebView(JSValueRef);
228     void setBackingScaleFactor(double, JSValueRef);
229
230     void setWindowIsKey(bool);
231
232     void callAddChromeInputFieldCallback();
233     void callRemoveChromeInputFieldCallback();
234     void callFocusWebViewCallback();
235     void callSetBackingScaleFactorCallback();
236
237     void overridePreference(JSStringRef preference, JSStringRef value);
238
239     // Cookies testing
240     void setAlwaysAcceptCookies(bool);
241
242     // Custom full screen behavior.
243     void setHasCustomFullScreenBehavior(bool value) { m_customFullScreenBehavior = value; }
244     bool hasCustomFullScreenBehavior() const { return m_customFullScreenBehavior; }
245
246     // Web notifications.
247     void grantWebNotificationPermission(JSStringRef origin);
248     void denyWebNotificationPermission(JSStringRef origin);
249     void removeAllWebNotificationPermissions();
250     void simulateWebNotificationClick(JSValueRef notification);
251
252     // Geolocation.
253     void setGeolocationPermission(bool);
254     void setMockGeolocationPosition(double latitude, double longitude, double accuracy, JSValueRef altitude, JSValueRef altitudeAccuracy, JSValueRef heading, JSValueRef speed);
255     void setMockGeolocationPositionUnavailableError(JSStringRef message);
256
257     JSRetainPtr<JSStringRef> platformName();
258
259     void setPageVisibility(JSStringRef state);
260     void resetPageVisibility();
261
262     bool callShouldCloseOnWebView();
263
264     void setCustomTimeout(int duration);
265
266     // Work queue.
267     void queueBackNavigation(unsigned howFarBackward);
268     void queueForwardNavigation(unsigned howFarForward);
269     void queueLoad(JSStringRef url, JSStringRef target);
270     void queueLoadHTMLString(JSStringRef content, JSStringRef baseURL, JSStringRef unreachableURL);
271     void queueReload();
272     void queueLoadingScript(JSStringRef script);
273     void queueNonLoadingScript(JSStringRef script);
274
275     bool secureEventInputIsEnabled() const;
276     
277     JSValueRef numberOfDFGCompiles(JSValueRef theFunction);
278     JSValueRef neverInlineFunction(JSValueRef theFunction);
279
280 private:
281     static const double waitToDumpWatchdogTimerInterval;
282
283     TestRunner();
284
285     void platformInitialize();
286     void initializeWaitToDumpWatchdogTimerIfNeeded();
287
288     WhatToDump m_whatToDump;
289     bool m_shouldDumpAllFrameScrollPositions;
290     bool m_shouldDumpBackForwardListsForAllWindows;
291
292     bool m_shouldAllowEditing;
293     bool m_shouldCloseExtraWindows;
294
295     bool m_dumpEditingCallbacks;
296     bool m_dumpStatusCallbacks;
297     bool m_dumpTitleChanges;
298     bool m_dumpPixels;
299     bool m_dumpSelectionRect;
300     bool m_dumpFullScreenCallbacks;
301     bool m_dumpFrameLoadCallbacks;
302     bool m_dumpProgressFinishedCallback;
303     bool m_dumpResourceLoadCallbacks;
304     bool m_dumpResourceResponseMIMETypes;
305     bool m_dumpWillCacheResponse;
306     bool m_dumpApplicationCacheDelegateCallbacks;
307     bool m_dumpDatabaseCallbacks;
308     bool m_disallowIncreaseForApplicationCacheQuota;
309     bool m_waitToDump; // True if waitUntilDone() has been called, but notifyDone() has not yet been called.
310     bool m_testRepaint;
311     bool m_testRepaintSweepHorizontally;
312     bool m_isPrinting;
313
314     bool m_willSendRequestReturnsNull;
315     bool m_willSendRequestReturnsNullOnRedirect;
316     bool m_shouldStopProvisionalFrameLoads;
317
318     bool m_policyDelegateEnabled;
319     bool m_policyDelegatePermissive;
320     
321     bool m_globalFlag;
322     bool m_customFullScreenBehavior;
323
324     int m_timeout;
325
326     bool m_userStyleSheetEnabled;
327     WKRetainPtr<WKStringRef> m_userStyleSheetLocation;
328
329     PlatformTimerRef m_waitToDumpWatchdogTimer;
330 };
331
332 } // namespace WTR
333
334 #endif // TestRunner_h