16eda2cc672380f78b38c3858347511125ce6e87
[WebKit-https.git] / WebKitTools / DumpRenderTree / LayoutTestController.h
1 /*
2  * Copyright (C) 2007, 2008, 2009 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  *
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  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission. 
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28  
29 #ifndef LayoutTestController_h
30 #define LayoutTestController_h
31
32 #include <JavaScriptCore/JSObjectRef.h>
33 #include <JavaScriptCore/JSRetainPtr.h>
34 #include <set>
35 #include <string>
36 #include <vector>
37 #include <wtf/PassRefPtr.h>
38 #include <wtf/RefCounted.h>
39
40 class LayoutTestController : public RefCounted<LayoutTestController> {
41 public:
42     static PassRefPtr<LayoutTestController> create(const std::string& testPathOrURL, const std::string& expectedPixelHash);
43     ~LayoutTestController();
44
45     void makeWindowObject(JSContextRef context, JSObjectRef windowObject, JSValueRef* exception);
46
47     void addDisallowedURL(JSStringRef url);
48     void clearAllDatabases();
49     void clearBackForwardList();
50     void clearPersistentUserStyleSheet();
51     bool callShouldCloseOnWebView();
52     JSStringRef copyDecodedHostName(JSStringRef name);
53     JSStringRef copyEncodedHostName(JSStringRef name);
54     void disableImageLoading();
55     void dispatchPendingLoadRequests();
56     void display();
57     void execCommand(JSStringRef name, JSStringRef value);
58     JSRetainPtr<JSStringRef> counterValueForElementById(JSStringRef id);
59     bool isCommandEnabled(JSStringRef name);
60     void keepWebHistory();
61     JSValueRef computedStyleIncludingVisitedInfo(JSContextRef, JSValueRef);
62     void notifyDone();
63     int numberOfPages(float pageWidthInPixels, float pageHeightInPixels);
64     void overridePreference(JSStringRef key, JSStringRef value);
65     int pageNumberForElementById(JSStringRef id, float pageWidthInPixels, float pageHeightInPixels);
66     JSRetainPtr<JSStringRef> pageProperty(const char* propertyName, int pageNumber) const;
67     JSRetainPtr<JSStringRef> pageSizeAndMarginsInPixels(int pageNumber, int width, int height, int marginTop, int marginRight, int marginBottom, int marginLeft) const;
68     bool isPageBoxVisible(int pageNumber) const;
69     JSStringRef pathToLocalResource(JSContextRef, JSStringRef url);
70     void queueBackNavigation(int howFarBackward);
71     void queueForwardNavigation(int howFarForward);
72     void queueLoad(JSStringRef url, JSStringRef target);
73     void queueLoadingScript(JSStringRef script);
74     void queueNonLoadingScript(JSStringRef script);
75     void queueReload();
76     void removeAllVisitedLinks();
77     void setAcceptsEditing(bool acceptsEditing);
78     void setAllowUniversalAccessFromFileURLs(bool);
79     void setAllowFileAccessFromFileURLs(bool);
80     void setAppCacheMaximumSize(unsigned long long quota);
81     void setAuthorAndUserStylesEnabled(bool);
82     void setCacheModel(int);
83     void setCustomPolicyDelegate(bool setDelegate, bool permissive);
84     void setDatabaseQuota(unsigned long long quota);
85     void setDomainRelaxationForbiddenForURLScheme(bool forbidden, JSStringRef scheme);
86     void setIconDatabaseEnabled(bool iconDatabaseEnabled);
87     void setJavaScriptProfilingEnabled(bool profilingEnabled);
88     void setJavaScriptCanAccessClipboard(bool flag);
89     void setMainFrameIsFirstResponder(bool flag);
90     void setMockGeolocationError(int code, JSStringRef message);
91     void setMockGeolocationPosition(double latitude, double longitude, double accuracy);
92     void setPersistentUserStyleSheetLocation(JSStringRef path);
93     void setPluginsEnabled(bool flag);
94     void setPopupBlockingEnabled(bool flag);
95     void setPrivateBrowsingEnabled(bool flag);
96     void setSelectTrailingWhitespaceEnabled(bool flag);
97     void setSmartInsertDeleteEnabled(bool flag);
98     void setTabKeyCyclesThroughElements(bool cycles);
99     void setUseDashboardCompatibilityMode(bool flag);
100     void setUserStyleSheetEnabled(bool flag);
101     void setUserStyleSheetLocation(JSStringRef path);
102     void setXSSAuditorEnabled(bool flag);
103     void setFrameFlatteningEnabled(bool enable);
104     void setSpatialNavigationEnabled(bool enable);
105     void setScrollbarPolicy(JSStringRef orientation, JSStringRef policy);
106     void setEditingBehavior(const char* editingBehavior);
107
108     void waitForPolicyDelegate();
109     size_t webHistoryItemCount();
110     unsigned workerThreadCount() const;
111     int windowCount();
112     
113     void grantDesktopNotificationPermission(JSStringRef origin);
114     bool checkDesktopNotificationPermission(JSStringRef origin);
115
116     bool elementDoesAutoCompleteForElementWithId(JSStringRef id);
117
118     bool dumpAsPDF() const { return m_dumpAsPDF; }
119     void setDumpAsPDF(bool dumpAsPDF) { m_dumpAsPDF = dumpAsPDF; }
120
121     bool dumpAsText() const { return m_dumpAsText; }
122     void setDumpAsText(bool dumpAsText) { m_dumpAsText = dumpAsText; }
123     
124     bool dumpBackForwardList() const { return m_dumpBackForwardList; }
125     void setDumpBackForwardList(bool dumpBackForwardList) { m_dumpBackForwardList = dumpBackForwardList; }
126
127     bool dumpChildFrameScrollPositions() const { return m_dumpChildFrameScrollPositions; }
128     void setDumpChildFrameScrollPositions(bool dumpChildFrameScrollPositions) { m_dumpChildFrameScrollPositions = dumpChildFrameScrollPositions; }
129
130     bool dumpChildFramesAsText() const { return m_dumpChildFramesAsText; }
131     void setDumpChildFramesAsText(bool dumpChildFramesAsText) { m_dumpChildFramesAsText = dumpChildFramesAsText; }
132
133     bool dumpDatabaseCallbacks() const { return m_dumpDatabaseCallbacks; }
134     void setDumpDatabaseCallbacks(bool dumpDatabaseCallbacks) { m_dumpDatabaseCallbacks = dumpDatabaseCallbacks; }
135
136     bool dumpDOMAsWebArchive() const { return m_dumpDOMAsWebArchive; }
137     void setDumpDOMAsWebArchive(bool dumpDOMAsWebArchive) { m_dumpDOMAsWebArchive = dumpDOMAsWebArchive; }
138
139     bool dumpEditingCallbacks() const { return m_dumpEditingCallbacks; }
140     void setDumpEditingCallbacks(bool dumpEditingCallbacks) { m_dumpEditingCallbacks = dumpEditingCallbacks; }
141
142     bool dumpFrameLoadCallbacks() const { return m_dumpFrameLoadCallbacks; }
143     void setDumpFrameLoadCallbacks(bool dumpFrameLoadCallbacks) { m_dumpFrameLoadCallbacks = dumpFrameLoadCallbacks; }
144
145     bool dumpHistoryDelegateCallbacks() const { return m_dumpHistoryDelegateCallbacks; }
146     void setDumpHistoryDelegateCallbacks(bool dumpHistoryDelegateCallbacks) { m_dumpHistoryDelegateCallbacks = dumpHistoryDelegateCallbacks; }
147     
148     bool dumpResourceLoadCallbacks() const { return m_dumpResourceLoadCallbacks; }
149     void setDumpResourceLoadCallbacks(bool dumpResourceLoadCallbacks) { m_dumpResourceLoadCallbacks = dumpResourceLoadCallbacks; }
150     
151     bool dumpResourceResponseMIMETypes() const { return m_dumpResourceResponseMIMETypes; }
152     void setDumpResourceResponseMIMETypes(bool dumpResourceResponseMIMETypes) { m_dumpResourceResponseMIMETypes = dumpResourceResponseMIMETypes; }
153
154     bool dumpSelectionRect() const { return m_dumpSelectionRect; }
155     void setDumpSelectionRect(bool dumpSelectionRect) { m_dumpSelectionRect = dumpSelectionRect; }
156
157     bool dumpSourceAsWebArchive() const { return m_dumpSourceAsWebArchive; }
158     void setDumpSourceAsWebArchive(bool dumpSourceAsWebArchive) { m_dumpSourceAsWebArchive = dumpSourceAsWebArchive; }
159
160     bool dumpStatusCallbacks() const { return m_dumpStatusCallbacks; }
161     void setDumpStatusCallbacks(bool dumpStatusCallbacks) { m_dumpStatusCallbacks = dumpStatusCallbacks; }
162
163     bool dumpTitleChanges() const { return m_dumpTitleChanges; }
164     void setDumpTitleChanges(bool dumpTitleChanges) { m_dumpTitleChanges = dumpTitleChanges; }
165
166     bool dumpIconChanges() const { return m_dumpIconChanges; }
167     void setDumpIconChanges(bool dumpIconChanges) { m_dumpIconChanges = dumpIconChanges; }
168
169     bool dumpVisitedLinksCallback() const { return m_dumpVisitedLinksCallback; }
170     void setDumpVisitedLinksCallback(bool dumpVisitedLinksCallback) { m_dumpVisitedLinksCallback = dumpVisitedLinksCallback; }
171     
172     bool dumpWillCacheResponse() const { return m_dumpWillCacheResponse; }
173     void setDumpWillCacheResponse(bool dumpWillCacheResponse) { m_dumpWillCacheResponse = dumpWillCacheResponse; }
174     
175     bool callCloseOnWebViews() const { return m_callCloseOnWebViews; }
176     void setCallCloseOnWebViews(bool callCloseOnWebViews) { m_callCloseOnWebViews = callCloseOnWebViews; }
177
178     bool canOpenWindows() const { return m_canOpenWindows; }
179     void setCanOpenWindows(bool canOpenWindows) { m_canOpenWindows = canOpenWindows; }
180
181     bool closeRemainingWindowsWhenComplete() const { return m_closeRemainingWindowsWhenComplete; }
182     void setCloseRemainingWindowsWhenComplete(bool closeRemainingWindowsWhenComplete) { m_closeRemainingWindowsWhenComplete = closeRemainingWindowsWhenComplete; }
183     
184     bool newWindowsCopyBackForwardList() const { return m_newWindowsCopyBackForwardList; }
185     void setNewWindowsCopyBackForwardList(bool newWindowsCopyBackForwardList) { m_newWindowsCopyBackForwardList = newWindowsCopyBackForwardList; }
186     
187     bool stopProvisionalFrameLoads() const { return m_stopProvisionalFrameLoads; }
188     void setStopProvisionalFrameLoads(bool stopProvisionalFrameLoads) { m_stopProvisionalFrameLoads = stopProvisionalFrameLoads; }
189
190     bool testOnscreen() const { return m_testOnscreen; }
191     void setTestOnscreen(bool testOnscreen) { m_testOnscreen = testOnscreen; }
192
193     bool testRepaint() const { return m_testRepaint; }
194     void setTestRepaint(bool testRepaint) { m_testRepaint = testRepaint; }
195
196     bool testRepaintSweepHorizontally() const { return m_testRepaintSweepHorizontally; }
197     void setTestRepaintSweepHorizontally(bool testRepaintSweepHorizontally) { m_testRepaintSweepHorizontally = testRepaintSweepHorizontally; }
198
199     bool waitToDump() const { return m_waitToDump; }
200     void setWaitToDump(bool waitToDump);
201     void waitToDumpWatchdogTimerFired();
202
203     const std::set<std::string>& willSendRequestClearHeaders() const { return m_willSendRequestClearHeaders; }
204     void setWillSendRequestClearHeader(std::string header) { m_willSendRequestClearHeaders.insert(header); }
205
206     bool willSendRequestReturnsNull() const { return m_willSendRequestReturnsNull; }
207     void setWillSendRequestReturnsNull(bool returnsNull) { m_willSendRequestReturnsNull = returnsNull; }
208
209     bool willSendRequestReturnsNullOnRedirect() const { return m_willSendRequestReturnsNullOnRedirect; }
210     void setWillSendRequestReturnsNullOnRedirect(bool returnsNull) { m_willSendRequestReturnsNullOnRedirect = returnsNull; }
211
212     bool windowIsKey() const { return m_windowIsKey; }
213     void setWindowIsKey(bool windowIsKey);
214
215     bool alwaysAcceptCookies() const { return m_alwaysAcceptCookies; }
216     void setAlwaysAcceptCookies(bool alwaysAcceptCookies);
217     
218     bool handlesAuthenticationChallenges() const { return m_handlesAuthenticationChallenges; }
219     void setHandlesAuthenticationChallenges(bool handlesAuthenticationChallenges) { m_handlesAuthenticationChallenges = handlesAuthenticationChallenges; }
220     
221     bool isPrinting() const { return m_isPrinting; }
222     void setIsPrinting(bool isPrinting) { m_isPrinting = isPrinting; }
223
224     const std::string& authenticationUsername() const { return m_authenticationUsername; }
225     void setAuthenticationUsername(std::string username) { m_authenticationUsername = username; }
226     
227     const std::string& authenticationPassword() const { return m_authenticationPassword; }
228     void setAuthenticationPassword(std::string password) { m_authenticationPassword = password; }
229
230     bool globalFlag() const { return m_globalFlag; }
231     void setGlobalFlag(bool globalFlag) { m_globalFlag = globalFlag; }
232     
233     const std::string& testPathOrURL() const { return m_testPathOrURL; }
234     const std::string& expectedPixelHash() const { return m_expectedPixelHash; }
235     
236     bool pauseAnimationAtTimeOnElementWithId(JSStringRef animationName, double time, JSStringRef elementId);
237     bool pauseTransitionAtTimeOnElementWithId(JSStringRef propertyName, double time, JSStringRef elementId);
238     bool sampleSVGAnimationForElementAtTime(JSStringRef animationId, double time, JSStringRef elementId);
239     unsigned numberOfActiveAnimations() const;
240
241     void addOriginAccessWhitelistEntry(JSStringRef sourceOrigin, JSStringRef destinationProtocol, JSStringRef destinationHost, bool allowDestinationSubdomains);
242     void removeOriginAccessWhitelistEntry(JSStringRef sourceOrigin, JSStringRef destinationProtocol, JSStringRef destinationHost, bool allowDestinationSubdomains);
243
244     void addUserScript(JSStringRef source, bool runAtStart, bool allFrames);
245     void addUserStyleSheet(JSStringRef source, bool allFrames);
246
247     void setGeolocationPermission(bool allow);
248     bool isGeolocationPermissionSet() const { return m_isGeolocationPermissionSet; }
249     bool geolocationPermission() const { return m_geolocationPermission; }
250
251     void setDeveloperExtrasEnabled(bool);
252     void showWebInspector();
253     void closeWebInspector();
254     void setTimelineProfilingEnabled(bool enabled);
255     void evaluateInWebInspector(long callId, JSStringRef script);
256     void evaluateScriptInIsolatedWorld(unsigned worldId, JSObjectRef globalObject, JSStringRef script);
257
258     void setPOSIXLocale(JSStringRef locale);
259
260     void setWebViewEditable(bool);
261
262     void abortModal();
263
264     // The following API test functions should probably be moved to platform-specific 
265     // unit tests outside of DRT once they exist.
266     void apiTestNewWindowDataLoadBaseURL(JSStringRef utf8Data, JSStringRef baseURL);
267     void apiTestGoToCurrentBackForwardItem();
268
269     // Simulate a request an embedding application could make, populating per-session credential storage.
270     void authenticateSession(JSStringRef url, JSStringRef username, JSStringRef password);
271
272     JSRetainPtr<JSStringRef> layerTreeAsText() const;
273
274     JSRetainPtr<JSStringRef> markerTextForListItem(JSContextRef context, JSValueRef nodeObject) const;
275
276     static const unsigned maxViewWidth;
277     static const unsigned maxViewHeight;
278
279 private:
280     LayoutTestController(const std::string& testPathOrURL, const std::string& expectedPixelHash);
281
282     bool m_dumpAsPDF;
283     bool m_dumpAsText;
284     bool m_dumpBackForwardList;
285     bool m_dumpChildFrameScrollPositions;
286     bool m_dumpChildFramesAsText;
287     bool m_dumpDOMAsWebArchive;
288     bool m_dumpDatabaseCallbacks;
289     bool m_dumpEditingCallbacks;
290     bool m_dumpFrameLoadCallbacks;
291     bool m_dumpHistoryDelegateCallbacks;
292     bool m_dumpResourceLoadCallbacks;
293     bool m_dumpResourceResponseMIMETypes;
294     bool m_dumpSelectionRect;
295     bool m_dumpSourceAsWebArchive;
296     bool m_dumpStatusCallbacks;
297     bool m_dumpTitleChanges;
298     bool m_dumpIconChanges;
299     bool m_dumpVisitedLinksCallback;
300     bool m_dumpWillCacheResponse;
301     bool m_callCloseOnWebViews;
302     bool m_canOpenWindows;
303     bool m_closeRemainingWindowsWhenComplete;
304     bool m_newWindowsCopyBackForwardList;
305     bool m_stopProvisionalFrameLoads;
306     bool m_testOnscreen;
307     bool m_testRepaint;
308     bool m_testRepaintSweepHorizontally;
309     bool m_waitToDump; // True if waitUntilDone() has been called, but notifyDone() has not yet been called.
310     bool m_willSendRequestReturnsNull;
311     bool m_willSendRequestReturnsNullOnRedirect;
312     bool m_windowIsKey;
313     bool m_alwaysAcceptCookies;
314     bool m_globalFlag;
315     bool m_isGeolocationPermissionSet;
316     bool m_geolocationPermission;
317     bool m_handlesAuthenticationChallenges;
318     bool m_isPrinting;
319
320     std::string m_authenticationUsername;
321     std::string m_authenticationPassword; 
322     std::string m_testPathOrURL;
323     std::string m_expectedPixelHash;    // empty string if no hash
324
325     std::set<std::string> m_willSendRequestClearHeaders;
326     
327     // origins which have been granted desktop notification access
328     std::vector<JSStringRef> m_desktopNotificationAllowedOrigins;
329     
330     static JSClassRef getJSClass();
331     static JSStaticValue* staticValues();
332     static JSStaticFunction* staticFunctions();
333 };
334
335 #endif // LayoutTestController_h