1b307590c176919f810a2803660aed1fa2f512ad
[WebKit-https.git] / Tools / WebKitTestRunner / InjectedBundle / Bindings / TestRunner.idl
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 interface TestRunner {
27     // The basics.
28     void dumpAsText(boolean dumpPixels);
29     void dumpChildFramesAsText();
30     void waitForPolicyDelegate();
31     void waitUntilDone();
32     void notifyDone();
33     double preciseTime();
34
35     // Other dumping.
36     void dumpBackForwardList();
37     void dumpChildFrameScrollPositions();
38     void dumpEditingCallbacks();
39     void dumpSelectionRect();
40     void dumpStatusCallbacks();
41     void dumpTitleChanges();
42     void dumpFullScreenCallbacks();
43     void dumpFrameLoadCallbacks();
44     void dumpProgressFinishedCallback();
45     void dumpResourceLoadCallbacks();
46     void dumpResourceResponseMIMETypes();
47     void dumpWillCacheResponse();
48     void dumpApplicationCacheDelegateCallbacks();
49     void dumpDatabaseCallbacks();
50     void dumpDOMAsWebArchive();
51     void dumpPolicyDelegateCallbacks();
52
53     // Special options.
54     void keepWebHistory();
55     void setAcceptsEditing(boolean value);
56     void setCanOpenWindows(boolean value);
57     void setCloseRemainingWindowsWhenComplete(boolean value);
58     void setXSSAuditorEnabled(boolean value);
59     void setAllowUniversalAccessFromFileURLs(boolean value);
60     void setAllowFileAccessFromFileURLs(boolean value);
61     void setPluginsEnabled(boolean value);
62     void setJavaScriptCanAccessClipboard(boolean value);
63     void setPrivateBrowsingEnabled(boolean value);
64     void setPopupBlockingEnabled(boolean value);
65     void setAuthorAndUserStylesEnabled(boolean value);
66     void setCustomPolicyDelegate(boolean enabled, boolean permissive);
67     void addOriginAccessWhitelistEntry(DOMString sourceOrigin, DOMString destinationProtocol, DOMString destinationHost, boolean allowDestinationSubdomains);
68     void removeOriginAccessWhitelistEntry(DOMString sourceOrigin, DOMString destinationProtocol, DOMString destinationHost, boolean allowDestinationSubdomains);
69     void setUserStyleSheetEnabled(boolean value);
70     void setUserStyleSheetLocation(DOMString location);
71     void setSpatialNavigationEnabled(boolean value);
72     void setTabKeyCyclesThroughElements(boolean enabled);
73     void setSerializeHTTPLoads();
74     void dispatchPendingLoadRequests();
75     void setCacheModel(int model);
76     void setAsynchronousSpellCheckingEnabled(boolean value);
77     void setPrinting();
78
79     // Special DOM functions.
80     void clearBackForwardList();
81     void execCommand(DOMString name, DOMString argument);
82     boolean isCommandEnabled(DOMString name);
83     unsigned long windowCount();
84
85     // Special DOM variables.
86     attribute boolean globalFlag;
87
88     // Repaint testing.
89     void testRepaint();
90     void repaintSweepHorizontally();
91     void display();
92
93     // Printing
94     boolean isPageBoxVisible(int pageIndex);
95
96     [PassContext] void setValueForUser(object element, DOMString value);
97
98     // UserContent testing.
99     void addUserScript(DOMString source, boolean runAtStart, boolean allFrames);
100     void addUserStyleSheet(DOMString source, boolean allFrames);
101
102     // Local storage API
103     void clearAllDatabases();
104     void setDatabaseQuota(unsigned long long quota);
105     DOMString pathToLocalResource(DOMString url);
106
107     attribute double databaseDefaultQuota;
108     attribute double databaseMaxQuota;
109
110     // Application Cache API
111     void clearAllApplicationCaches();
112     void setAppCacheMaximumSize(unsigned long long size);
113     long long applicationCacheDiskUsageForOrigin(DOMString origin);
114     void clearApplicationCacheForOrigin(DOMString name);
115     void disallowIncreaseForApplicationCacheQuota();
116     object originsWithApplicationCache();
117
118     // Text search testing.
119     boolean findString(DOMString target, object optionsArray);
120
121     // Evaluating script in a special context.
122     [PassContext] void evaluateScriptInIsolatedWorld(unsigned long worldID, DOMString script);
123
124     // For Web Inspector tests
125     void showWebInspector();
126     void closeWebInspector();
127     void evaluateInWebInspector(DOMString script);
128     readonly attribute DOMString inspectorTestStubURL;
129
130     void setPOSIXLocale(DOMString locale);
131
132     void setTextDirection(DOMString direction);
133
134     void setWillSendRequestReturnsNull(boolean flag);
135     void setWillSendRequestReturnsNullOnRedirect(boolean flag);
136     
137     void setShouldStayOnPageAfterHandlingBeforeUnload(boolean flag);
138
139     void setDefersLoading(boolean flag);
140     void setStopProvisionalFrameLoads();
141
142     // Focus testing.
143     void addChromeInputField(object callback);
144     void removeChromeInputField(object callback);
145     void focusWebView(object callback);
146
147     void setBackingScaleFactor(double backingScaleFactor, object callback);
148
149     void setWindowIsKey(boolean isKey);
150
151     // Cookies testing
152     void setAlwaysAcceptCookies(boolean accept);
153
154     void overridePreference(DOMString preference, DOMString value);
155
156     // Page Visibility API
157     void setPageVisibility(DOMString state);
158     void resetPageVisibility();
159
160     // Control full screen behavior.
161     void setHasCustomFullScreenBehavior(boolean value);
162
163     // Web notifications support
164     void grantWebNotificationPermission(DOMString origin);
165     void denyWebNotificationPermission(DOMString origin);
166     void removeAllWebNotificationPermissions();
167     void simulateWebNotificationClick(object notification);
168
169     // Geolocation
170     void setGeolocationPermission(boolean value);
171     void setMockGeolocationPosition(double latitude, double longitude, double accuracy, [Default=Undefined] optional object altitude, optional object altitudeAccuracy, optional object heading, optional object speed);
172     void setMockGeolocationPositionUnavailableError(DOMString errorMessage);
173     boolean isGeolocationProviderActive();
174
175     // MediaStream
176     void setUserMediaPermission(boolean value);
177
178     // Audio testing.
179     [PassContext] void setAudioResult(object data);
180
181     boolean callShouldCloseOnWebView();
182
183     // Work queue.
184     void queueBackNavigation(unsigned long howFarBackward);
185     void queueForwardNavigation(unsigned long howFarForward);
186     void queueLoad(DOMString url, DOMString target, optional boolean shouldOpenExternalURLs);
187     void queueLoadHTMLString(DOMString content, optional DOMString baseURL, optional DOMString unreachableURL);
188     void queueReload();
189     void queueLoadingScript(DOMString script);
190     void queueNonLoadingScript(DOMString script);
191
192     // Authentication
193     void setHandlesAuthenticationChallenges(boolean value);
194     void setAuthenticationUsername(DOMString username);
195     void setAuthenticationPassword(DOMString password);
196
197     // Secure text input mode (Mac only)
198     readonly attribute boolean secureEventInputIsEnabled;
199     
200     // Override plugin load policy.
201     void setBlockAllPlugins(boolean shouldBlock);
202     
203     // Hooks to the JSC compiler.
204     object numberOfDFGCompiles(object function);
205     object neverInlineFunction(object function);
206 };
207