2010-05-06 Anders Carlsson <andersca@apple.com>
[WebKit.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/RefCounted.h>
38
39 class LayoutTestController : public RefCounted<LayoutTestController> {
40 public:
41     LayoutTestController(const std::string& testPathOrURL, const std::string& expectedPixelHash);
42     ~LayoutTestController();
43
44     void makeWindowObject(JSContextRef context, JSObjectRef windowObject, JSValueRef* exception);
45
46     void addDisallowedURL(JSStringRef url);
47     void clearAllDatabases();
48     void clearBackForwardList();
49     void clearPersistentUserStyleSheet();
50     bool callShouldCloseOnWebView();
51     JSStringRef copyDecodedHostName(JSStringRef name);
52     JSStringRef copyEncodedHostName(JSStringRef name);
53     void disableImageLoading();
54     void dispatchPendingLoadRequests();
55     void display();
56     void execCommand(JSStringRef name, JSStringRef value);
57     JSRetainPtr<JSStringRef> counterValueForElementById(JSStringRef id);
58     bool isCommandEnabled(JSStringRef name);
59     void keepWebHistory();
60     JSValueRef computedStyleIncludingVisitedInfo(JSContextRef, JSValueRef);
61     void notifyDone();
62     int numberOfPages(float pageWidthInPixels, float pageHeightInPixels);
63     void overridePreference(JSStringRef key, JSStringRef value);
64     int pageNumberForElementById(JSStringRef id, float pageWidthInPixels, float pageHeightInPixels);
65     JSStringRef pathToLocalResource(JSContextRef, JSStringRef url);
66     void queueBackNavigation(int howFarBackward);
67     void queueForwardNavigation(int howFarForward);
68     void queueLoad(JSStringRef url, JSStringRef target);
69     void queueLoadingScript(JSStringRef script);
70     void queueNonLoadingScript(JSStringRef script);
71     void queueReload();
72     void removeAllVisitedLinks();
73     void setAcceptsEditing(bool acceptsEditing);
74     void setAllowUniversalAccessFromFileURLs(bool);
75     void setAllowFileAccessFromFileURLs(bool);
76     void setAppCacheMaximumSize(unsigned long long quota);
77     void setAuthorAndUserStylesEnabled(bool);
78     void setCacheModel(int);
79     void setCustomPolicyDelegate(bool setDelegate, bool permissive);
80     void setDatabaseQuota(unsigned long long quota);
81     void setDomainRelaxationForbiddenForURLScheme(bool forbidden, JSStringRef scheme);
82     void setIconDatabaseEnabled(bool iconDatabaseEnabled);
83     void setJavaScriptProfilingEnabled(bool profilingEnabled);
84     void setJavaScriptCanAccessClipboard(bool flag);
85     void setMainFrameIsFirstResponder(bool flag);
86     void setMockGeolocationError(int code, JSStringRef message);
87     void setMockGeolocationPosition(double latitude, double longitude, double accuracy);
88     void setPersistentUserStyleSheetLocation(JSStringRef path);
89     void setPluginsEnabled(bool flag);
90     void setPopupBlockingEnabled(bool flag);
91     void setPrivateBrowsingEnabled(bool flag);
92     void setSelectTrailingWhitespaceEnabled(bool flag);
93     void setSmartInsertDeleteEnabled(bool flag);
94     void setTabKeyCyclesThroughElements(bool cycles);
95     void setUseDashboardCompatibilityMode(bool flag);
96     void setUserStyleSheetEnabled(bool flag);
97     void setUserStyleSheetLocation(JSStringRef path);
98     void setXSSAuditorEnabled(bool flag);
99     void setFrameFlatteningEnabled(bool enable);
100     void setSpatialNavigationEnabled(bool enable);
101     void setScrollbarPolicy(JSStringRef orientation, JSStringRef policy);
102
103     void waitForPolicyDelegate();
104     size_t webHistoryItemCount();
105     unsigned workerThreadCount() const;
106     int windowCount();
107     
108     void grantDesktopNotificationPermission(JSStringRef origin);
109     bool checkDesktopNotificationPermission(JSStringRef origin);
110
111     bool elementDoesAutoCompleteForElementWithId(JSStringRef id);
112
113     bool dumpAsPDF() const { return m_dumpAsPDF; }
114     void setDumpAsPDF(bool dumpAsPDF) { m_dumpAsPDF = dumpAsPDF; }
115
116     bool dumpAsText() const { return m_dumpAsText; }
117     void setDumpAsText(bool dumpAsText) { m_dumpAsText = dumpAsText; }
118     
119     bool dumpBackForwardList() const { return m_dumpBackForwardList; }
120     void setDumpBackForwardList(bool dumpBackForwardList) { m_dumpBackForwardList = dumpBackForwardList; }
121
122     bool dumpChildFrameScrollPositions() const { return m_dumpChildFrameScrollPositions; }
123     void setDumpChildFrameScrollPositions(bool dumpChildFrameScrollPositions) { m_dumpChildFrameScrollPositions = dumpChildFrameScrollPositions; }
124
125     bool dumpChildFramesAsText() const { return m_dumpChildFramesAsText; }
126     void setDumpChildFramesAsText(bool dumpChildFramesAsText) { m_dumpChildFramesAsText = dumpChildFramesAsText; }
127
128     bool dumpDatabaseCallbacks() const { return m_dumpDatabaseCallbacks; }
129     void setDumpDatabaseCallbacks(bool dumpDatabaseCallbacks) { m_dumpDatabaseCallbacks = dumpDatabaseCallbacks; }
130
131     bool dumpDOMAsWebArchive() const { return m_dumpDOMAsWebArchive; }
132     void setDumpDOMAsWebArchive(bool dumpDOMAsWebArchive) { m_dumpDOMAsWebArchive = dumpDOMAsWebArchive; }
133
134     bool dumpEditingCallbacks() const { return m_dumpEditingCallbacks; }
135     void setDumpEditingCallbacks(bool dumpEditingCallbacks) { m_dumpEditingCallbacks = dumpEditingCallbacks; }
136
137     bool dumpFrameLoadCallbacks() const { return m_dumpFrameLoadCallbacks; }
138     void setDumpFrameLoadCallbacks(bool dumpFrameLoadCallbacks) { m_dumpFrameLoadCallbacks = dumpFrameLoadCallbacks; }
139
140     bool dumpHistoryDelegateCallbacks() const { return m_dumpHistoryDelegateCallbacks; }
141     void setDumpHistoryDelegateCallbacks(bool dumpHistoryDelegateCallbacks) { m_dumpHistoryDelegateCallbacks = dumpHistoryDelegateCallbacks; }
142     
143     bool dumpResourceLoadCallbacks() const { return m_dumpResourceLoadCallbacks; }
144     void setDumpResourceLoadCallbacks(bool dumpResourceLoadCallbacks) { m_dumpResourceLoadCallbacks = dumpResourceLoadCallbacks; }
145     
146     bool dumpResourceResponseMIMETypes() const { return m_dumpResourceResponseMIMETypes; }
147     void setDumpResourceResponseMIMETypes(bool dumpResourceResponseMIMETypes) { m_dumpResourceResponseMIMETypes = dumpResourceResponseMIMETypes; }
148
149     bool dumpSelectionRect() const { return m_dumpSelectionRect; }
150     void setDumpSelectionRect(bool dumpSelectionRect) { m_dumpSelectionRect = dumpSelectionRect; }
151
152     bool dumpSourceAsWebArchive() const { return m_dumpSourceAsWebArchive; }
153     void setDumpSourceAsWebArchive(bool dumpSourceAsWebArchive) { m_dumpSourceAsWebArchive = dumpSourceAsWebArchive; }
154
155     bool dumpStatusCallbacks() const { return m_dumpStatusCallbacks; }
156     void setDumpStatusCallbacks(bool dumpStatusCallbacks) { m_dumpStatusCallbacks = dumpStatusCallbacks; }
157
158     bool dumpTitleChanges() const { return m_dumpTitleChanges; }
159     void setDumpTitleChanges(bool dumpTitleChanges) { m_dumpTitleChanges = dumpTitleChanges; }
160
161     bool dumpIconChanges() const { return m_dumpIconChanges; }
162     void setDumpIconChanges(bool dumpIconChanges) { m_dumpIconChanges = dumpIconChanges; }
163
164     bool dumpVisitedLinksCallback() const { return m_dumpVisitedLinksCallback; }
165     void setDumpVisitedLinksCallback(bool dumpVisitedLinksCallback) { m_dumpVisitedLinksCallback = dumpVisitedLinksCallback; }
166     
167     bool dumpWillCacheResponse() const { return m_dumpWillCacheResponse; }
168     void setDumpWillCacheResponse(bool dumpWillCacheResponse) { m_dumpWillCacheResponse = dumpWillCacheResponse; }
169     
170     bool callCloseOnWebViews() const { return m_callCloseOnWebViews; }
171     void setCallCloseOnWebViews(bool callCloseOnWebViews) { m_callCloseOnWebViews = callCloseOnWebViews; }
172
173     bool canOpenWindows() const { return m_canOpenWindows; }
174     void setCanOpenWindows(bool canOpenWindows) { m_canOpenWindows = canOpenWindows; }
175
176     bool closeRemainingWindowsWhenComplete() const { return m_closeRemainingWindowsWhenComplete; }
177     void setCloseRemainingWindowsWhenComplete(bool closeRemainingWindowsWhenComplete) { m_closeRemainingWindowsWhenComplete = closeRemainingWindowsWhenComplete; }
178     
179     bool newWindowsCopyBackForwardList() const { return m_newWindowsCopyBackForwardList; }
180     void setNewWindowsCopyBackForwardList(bool newWindowsCopyBackForwardList) { m_newWindowsCopyBackForwardList = newWindowsCopyBackForwardList; }
181     
182     bool stopProvisionalFrameLoads() const { return m_stopProvisionalFrameLoads; }
183     void setStopProvisionalFrameLoads(bool stopProvisionalFrameLoads) { m_stopProvisionalFrameLoads = stopProvisionalFrameLoads; }
184
185     bool testOnscreen() const { return m_testOnscreen; }
186     void setTestOnscreen(bool testOnscreen) { m_testOnscreen = testOnscreen; }
187
188     bool testRepaint() const { return m_testRepaint; }
189     void setTestRepaint(bool testRepaint) { m_testRepaint = testRepaint; }
190
191     bool testRepaintSweepHorizontally() const { return m_testRepaintSweepHorizontally; }
192     void setTestRepaintSweepHorizontally(bool testRepaintSweepHorizontally) { m_testRepaintSweepHorizontally = testRepaintSweepHorizontally; }
193
194     bool waitToDump() const { return m_waitToDump; }
195     void setWaitToDump(bool waitToDump);
196     void waitToDumpWatchdogTimerFired();
197
198     const std::set<std::string>& willSendRequestClearHeaders() const { return m_willSendRequestClearHeaders; }
199     void setWillSendRequestClearHeader(std::string header) { m_willSendRequestClearHeaders.insert(header); }
200
201     bool willSendRequestReturnsNull() const { return m_willSendRequestReturnsNull; }
202     void setWillSendRequestReturnsNull(bool returnsNull) { m_willSendRequestReturnsNull = returnsNull; }
203
204     bool willSendRequestReturnsNullOnRedirect() const { return m_willSendRequestReturnsNullOnRedirect; }
205     void setWillSendRequestReturnsNullOnRedirect(bool returnsNull) { m_willSendRequestReturnsNullOnRedirect = returnsNull; }
206
207     bool windowIsKey() const { return m_windowIsKey; }
208     void setWindowIsKey(bool windowIsKey);
209
210     bool alwaysAcceptCookies() const { return m_alwaysAcceptCookies; }
211     void setAlwaysAcceptCookies(bool alwaysAcceptCookies);
212     
213     bool handlesAuthenticationChallenges() const { return m_handlesAuthenticationChallenges; }
214     void setHandlesAuthenticationChallenges(bool handlesAuthenticationChallenges) { m_handlesAuthenticationChallenges = handlesAuthenticationChallenges; }
215     
216     bool isPrinting() const { return m_isPrinting; }
217     void setIsPrinting(bool isPrinting) { m_isPrinting = isPrinting; }
218
219     const std::string& authenticationUsername() const { return m_authenticationUsername; }
220     void setAuthenticationUsername(std::string username) { m_authenticationUsername = username; }
221     
222     const std::string& authenticationPassword() const { return m_authenticationPassword; }
223     void setAuthenticationPassword(std::string password) { m_authenticationPassword = password; }
224
225     bool globalFlag() const { return m_globalFlag; }
226     void setGlobalFlag(bool globalFlag) { m_globalFlag = globalFlag; }
227     
228     const std::string& testPathOrURL() const { return m_testPathOrURL; }
229     const std::string& expectedPixelHash() const { return m_expectedPixelHash; }
230     
231     bool pauseAnimationAtTimeOnElementWithId(JSStringRef animationName, double time, JSStringRef elementId);
232     bool pauseTransitionAtTimeOnElementWithId(JSStringRef propertyName, double time, JSStringRef elementId);
233     bool sampleSVGAnimationForElementAtTime(JSStringRef animationId, double time, JSStringRef elementId);
234     unsigned numberOfActiveAnimations() const;
235
236     void addOriginAccessWhitelistEntry(JSStringRef sourceOrigin, JSStringRef destinationProtocol, JSStringRef destinationHost, bool allowDestinationSubdomains);
237     void removeOriginAccessWhitelistEntry(JSStringRef sourceOrigin, JSStringRef destinationProtocol, JSStringRef destinationHost, bool allowDestinationSubdomains);
238
239     void addUserScript(JSStringRef source, bool runAtStart);
240     void addUserStyleSheet(JSStringRef source);
241
242     void setGeolocationPermission(bool allow);
243     bool isGeolocationPermissionSet() const { return m_isGeolocationPermissionSet; }
244     bool geolocationPermission() const { return m_geolocationPermission; }
245
246     void setDeveloperExtrasEnabled(bool);
247     void showWebInspector();
248     void closeWebInspector();
249     void setTimelineProfilingEnabled(bool enabled);
250     void evaluateInWebInspector(long callId, JSStringRef script);
251     void evaluateScriptInIsolatedWorld(unsigned worldId, JSObjectRef globalObject, JSStringRef script);
252
253     void setPOSIXLocale(JSStringRef locale);
254
255     void setWebViewEditable(bool);
256
257     // The following API test functions should probably be moved to platform-specific 
258     // unit tests outside of DRT once they exist.
259     void apiTestNewWindowDataLoadBaseURL(JSStringRef utf8Data, JSStringRef baseURL);
260     void apiTestGoToCurrentBackForwardItem();
261
262     // Simulate a request an embedding application could make, populating per-session credential storage.
263     void authenticateSession(JSStringRef url, JSStringRef username, JSStringRef password);
264
265     JSRetainPtr<JSStringRef> layerTreeAsText() const;
266
267     JSRetainPtr<JSStringRef> markerTextForListItem(JSContextRef context, JSValueRef nodeObject) const;
268
269     static const unsigned maxViewWidth;
270     static const unsigned maxViewHeight;
271
272 private:
273     bool m_dumpAsPDF;
274     bool m_dumpAsText;
275     bool m_dumpBackForwardList;
276     bool m_dumpChildFrameScrollPositions;
277     bool m_dumpChildFramesAsText;
278     bool m_dumpDOMAsWebArchive;
279     bool m_dumpDatabaseCallbacks;
280     bool m_dumpEditingCallbacks;
281     bool m_dumpFrameLoadCallbacks;
282     bool m_dumpHistoryDelegateCallbacks;
283     bool m_dumpResourceLoadCallbacks;
284     bool m_dumpResourceResponseMIMETypes;
285     bool m_dumpSelectionRect;
286     bool m_dumpSourceAsWebArchive;
287     bool m_dumpStatusCallbacks;
288     bool m_dumpTitleChanges;
289     bool m_dumpIconChanges;
290     bool m_dumpVisitedLinksCallback;
291     bool m_dumpWillCacheResponse;
292     bool m_callCloseOnWebViews;
293     bool m_canOpenWindows;
294     bool m_closeRemainingWindowsWhenComplete;
295     bool m_newWindowsCopyBackForwardList;
296     bool m_stopProvisionalFrameLoads;
297     bool m_testOnscreen;
298     bool m_testRepaint;
299     bool m_testRepaintSweepHorizontally;
300     bool m_waitToDump; // True if waitUntilDone() has been called, but notifyDone() has not yet been called.
301     bool m_willSendRequestReturnsNull;
302     bool m_willSendRequestReturnsNullOnRedirect;
303     bool m_windowIsKey;
304     bool m_alwaysAcceptCookies;
305     bool m_globalFlag;
306     bool m_isGeolocationPermissionSet;
307     bool m_geolocationPermission;
308     bool m_handlesAuthenticationChallenges;
309     bool m_isPrinting;
310
311     std::string m_authenticationUsername;
312     std::string m_authenticationPassword; 
313     std::string m_testPathOrURL;
314     std::string m_expectedPixelHash;    // empty string if no hash
315
316     std::set<std::string> m_willSendRequestClearHeaders;
317     
318     // origins which have been granted desktop notification access
319     std::vector<JSStringRef> m_desktopNotificationAllowedOrigins;
320     
321     static JSClassRef getJSClass();
322     static JSStaticValue* staticValues();
323     static JSStaticFunction* staticFunctions();
324 };
325
326 #endif // LayoutTestController_h