2011-04-20 Dominic Cooney <dominicc@chromium.org>
[WebKit-https.git] / Tools / 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 <map>
35 #include <set>
36 #include <string>
37 #include <vector>
38 #include <wtf/PassRefPtr.h>
39 #include <wtf/RefCounted.h>
40
41 class LayoutTestController : public RefCounted<LayoutTestController> {
42 public:
43     static PassRefPtr<LayoutTestController> create(const std::string& testPathOrURL, const std::string& expectedPixelHash);
44     ~LayoutTestController();
45
46     void makeWindowObject(JSContextRef context, JSObjectRef windowObject, JSValueRef* exception);
47
48     void addDisallowedURL(JSStringRef url);
49     void addURLToRedirect(std::string origin, std::string destination);
50     const std::string& redirectionDestinationForURL(std::string);
51     void clearAllApplicationCaches();
52     void clearAllDatabases();
53     void clearApplicationCacheForOrigin(JSStringRef name);
54     void clearBackForwardList();
55     void clearPersistentUserStyleSheet();
56     bool callShouldCloseOnWebView();
57     JSStringRef copyDecodedHostName(JSStringRef name);
58     JSStringRef copyEncodedHostName(JSStringRef name);
59     JSRetainPtr<JSStringRef> counterValueForElementById(JSStringRef id);
60     void disableImageLoading();
61     void dispatchPendingLoadRequests();
62     void display();
63     void displayInvalidatedRegion();
64     void execCommand(JSStringRef name, JSStringRef value);
65     bool findString(JSContextRef, JSStringRef, JSObjectRef optionsArray);
66     JSValueRef originsWithApplicationCache(JSContextRef);
67     bool isCommandEnabled(JSStringRef name);
68     void keepWebHistory();
69     JSValueRef computedStyleIncludingVisitedInfo(JSContextRef, JSValueRef);
70     JSValueRef nodesFromRect(JSContextRef, JSValueRef, int x, int y, unsigned top, unsigned right, unsigned bottom, unsigned left, bool ignoreClipping);
71     void notifyDone();
72     int numberOfPages(float pageWidthInPixels, float pageHeightInPixels);
73     int numberOfPendingGeolocationPermissionRequests();
74     void overridePreference(JSStringRef key, JSStringRef value);
75     int pageNumberForElementById(JSStringRef id, float pageWidthInPixels, float pageHeightInPixels);
76     JSRetainPtr<JSStringRef> pageProperty(const char* propertyName, int pageNumber) const;
77     JSRetainPtr<JSStringRef> pageSizeAndMarginsInPixels(int pageNumber, int width, int height, int marginTop, int marginRight, int marginBottom, int marginLeft) const;
78     bool isPageBoxVisible(int pageNumber) const;
79     JSStringRef pathToLocalResource(JSContextRef, JSStringRef url);
80     void queueBackNavigation(int howFarBackward);
81     void queueForwardNavigation(int howFarForward);
82     void queueLoad(JSStringRef url, JSStringRef target);
83     void queueLoadHTMLString(JSStringRef content, JSStringRef baseURL);
84     void queueLoadAlternateHTMLString(JSStringRef content, JSStringRef baseURL, JSStringRef unreachableURL);
85     void queueLoadingScript(JSStringRef script);
86     void queueNonLoadingScript(JSStringRef script);
87     void queueReload();
88     void removeAllVisitedLinks();
89     void setAcceptsEditing(bool acceptsEditing);
90     void setAllowUniversalAccessFromFileURLs(bool);
91     void setAllowFileAccessFromFileURLs(bool);
92     void setAppCacheMaximumSize(unsigned long long quota);
93     void setApplicationCacheOriginQuota(unsigned long long quota);
94     void setAuthorAndUserStylesEnabled(bool);
95     void setAutofilled(JSContextRef, JSValueRef nodeObject, bool autofilled);
96     void setCacheModel(int);
97     void setCustomPolicyDelegate(bool setDelegate, bool permissive);
98     void setDatabaseQuota(unsigned long long quota);
99     void setDomainRelaxationForbiddenForURLScheme(bool forbidden, JSStringRef scheme);
100     void setIconDatabaseEnabled(bool iconDatabaseEnabled);
101     void setJavaScriptProfilingEnabled(bool profilingEnabled);
102     void setJavaScriptCanAccessClipboard(bool flag);
103     void setMainFrameIsFirstResponder(bool flag);
104     void setMockDeviceOrientation(bool canProvideAlpha, double alpha, bool canProvideBeta, double beta, bool canProvideGamma, double gamma);
105     void setMockGeolocationError(int code, JSStringRef message);
106     void setMockGeolocationPosition(double latitude, double longitude, double accuracy);
107     void addMockSpeechInputResult(JSStringRef result, double confidence, JSStringRef language);
108     void setPersistentUserStyleSheetLocation(JSStringRef path);
109     void setPluginsEnabled(bool flag);
110     void setPopupBlockingEnabled(bool flag);
111     void setPrivateBrowsingEnabled(bool flag);
112     void setSelectTrailingWhitespaceEnabled(bool flag);
113     void setSmartInsertDeleteEnabled(bool flag);
114     void setTabKeyCyclesThroughElements(bool cycles);
115     void setUseDashboardCompatibilityMode(bool flag);
116     void setUserStyleSheetEnabled(bool flag);
117     void setUserStyleSheetLocation(JSStringRef path);
118     void setValueForUser(JSContextRef, JSValueRef nodeObject, JSStringRef value);
119     void setViewModeMediaFeature(JSStringRef mode);
120     void setXSSAuditorEnabled(bool flag);
121     void setFrameFlatteningEnabled(bool enable);
122     void setSpatialNavigationEnabled(bool enable);
123     void setScrollbarPolicy(JSStringRef orientation, JSStringRef policy);
124     void setEditingBehavior(const char* editingBehavior);
125
126     JSValueRef shadowRoot(JSContextRef, JSValueRef);
127     JSValueRef ensureShadowRoot(JSContextRef, JSValueRef);
128     void removeShadowRoot(JSContextRef, JSValueRef);
129
130     void waitForPolicyDelegate();
131     size_t webHistoryItemCount();
132     unsigned workerThreadCount() const;
133     int windowCount();
134     
135     void grantDesktopNotificationPermission(JSStringRef origin);
136     bool checkDesktopNotificationPermission(JSStringRef origin);
137
138     bool elementDoesAutoCompleteForElementWithId(JSStringRef id);
139
140     bool dumpAsAudio() const { return m_dumpAsAudio; }
141     void setDumpAsAudio(bool dumpAsAudio) { m_dumpAsAudio = dumpAsAudio; }
142     
143     bool dumpAsPDF() const { return m_dumpAsPDF; }
144     void setDumpAsPDF(bool dumpAsPDF) { m_dumpAsPDF = dumpAsPDF; }
145
146     bool dumpAsText() const { return m_dumpAsText; }
147     void setDumpAsText(bool dumpAsText) { m_dumpAsText = dumpAsText; }
148
149     bool generatePixelResults() const { return m_generatePixelResults; }
150     void setGeneratePixelResults(bool generatePixelResults) { m_generatePixelResults = generatePixelResults; }
151
152     bool dumpApplicationCacheDelegateCallbacks() const { return m_dumpApplicationCacheDelegateCallbacks; }
153     void setDumpApplicationCacheDelegateCallbacks(bool dumpCallbacks) { m_dumpApplicationCacheDelegateCallbacks = dumpCallbacks; }
154
155     bool dumpBackForwardList() const { return m_dumpBackForwardList; }
156     void setDumpBackForwardList(bool dumpBackForwardList) { m_dumpBackForwardList = dumpBackForwardList; }
157
158     bool dumpChildFrameScrollPositions() const { return m_dumpChildFrameScrollPositions; }
159     void setDumpChildFrameScrollPositions(bool dumpChildFrameScrollPositions) { m_dumpChildFrameScrollPositions = dumpChildFrameScrollPositions; }
160
161     bool dumpChildFramesAsText() const { return m_dumpChildFramesAsText; }
162     void setDumpChildFramesAsText(bool dumpChildFramesAsText) { m_dumpChildFramesAsText = dumpChildFramesAsText; }
163
164     bool dumpDatabaseCallbacks() const { return m_dumpDatabaseCallbacks; }
165     void setDumpDatabaseCallbacks(bool dumpDatabaseCallbacks) { m_dumpDatabaseCallbacks = dumpDatabaseCallbacks; }
166
167     bool dumpDOMAsWebArchive() const { return m_dumpDOMAsWebArchive; }
168     void setDumpDOMAsWebArchive(bool dumpDOMAsWebArchive) { m_dumpDOMAsWebArchive = dumpDOMAsWebArchive; }
169
170     bool dumpEditingCallbacks() const { return m_dumpEditingCallbacks; }
171     void setDumpEditingCallbacks(bool dumpEditingCallbacks) { m_dumpEditingCallbacks = dumpEditingCallbacks; }
172
173     bool dumpFrameLoadCallbacks() const { return m_dumpFrameLoadCallbacks; }
174     void setDumpFrameLoadCallbacks(bool dumpFrameLoadCallbacks) { m_dumpFrameLoadCallbacks = dumpFrameLoadCallbacks; }
175     
176     bool dumpUserGestureInFrameLoadCallbacks() const { return m_dumpUserGestureInFrameLoadCallbacks; }
177     void setDumpUserGestureInFrameLoadCallbacks(bool dumpUserGestureInFrameLoadCallbacks) { m_dumpUserGestureInFrameLoadCallbacks = dumpUserGestureInFrameLoadCallbacks; }    
178
179     bool dumpHistoryDelegateCallbacks() const { return m_dumpHistoryDelegateCallbacks; }
180     void setDumpHistoryDelegateCallbacks(bool dumpHistoryDelegateCallbacks) { m_dumpHistoryDelegateCallbacks = dumpHistoryDelegateCallbacks; }
181     
182     bool dumpResourceLoadCallbacks() const { return m_dumpResourceLoadCallbacks; }
183     void setDumpResourceLoadCallbacks(bool dumpResourceLoadCallbacks) { m_dumpResourceLoadCallbacks = dumpResourceLoadCallbacks; }
184     
185     bool dumpResourceResponseMIMETypes() const { return m_dumpResourceResponseMIMETypes; }
186     void setDumpResourceResponseMIMETypes(bool dumpResourceResponseMIMETypes) { m_dumpResourceResponseMIMETypes = dumpResourceResponseMIMETypes; }
187
188     bool dumpSelectionRect() const { return m_dumpSelectionRect; }
189     void setDumpSelectionRect(bool dumpSelectionRect) { m_dumpSelectionRect = dumpSelectionRect; }
190
191     bool dumpSourceAsWebArchive() const { return m_dumpSourceAsWebArchive; }
192     void setDumpSourceAsWebArchive(bool dumpSourceAsWebArchive) { m_dumpSourceAsWebArchive = dumpSourceAsWebArchive; }
193
194     bool dumpStatusCallbacks() const { return m_dumpStatusCallbacks; }
195     void setDumpStatusCallbacks(bool dumpStatusCallbacks) { m_dumpStatusCallbacks = dumpStatusCallbacks; }
196
197     bool dumpTitleChanges() const { return m_dumpTitleChanges; }
198     void setDumpTitleChanges(bool dumpTitleChanges) { m_dumpTitleChanges = dumpTitleChanges; }
199
200     bool dumpIconChanges() const { return m_dumpIconChanges; }
201     void setDumpIconChanges(bool dumpIconChanges) { m_dumpIconChanges = dumpIconChanges; }
202
203     bool dumpVisitedLinksCallback() const { return m_dumpVisitedLinksCallback; }
204     void setDumpVisitedLinksCallback(bool dumpVisitedLinksCallback) { m_dumpVisitedLinksCallback = dumpVisitedLinksCallback; }
205     
206     bool dumpWillCacheResponse() const { return m_dumpWillCacheResponse; }
207     void setDumpWillCacheResponse(bool dumpWillCacheResponse) { m_dumpWillCacheResponse = dumpWillCacheResponse; }
208     
209     bool callCloseOnWebViews() const { return m_callCloseOnWebViews; }
210     void setCallCloseOnWebViews(bool callCloseOnWebViews) { m_callCloseOnWebViews = callCloseOnWebViews; }
211
212     bool canOpenWindows() const { return m_canOpenWindows; }
213     void setCanOpenWindows(bool canOpenWindows) { m_canOpenWindows = canOpenWindows; }
214
215     bool closeRemainingWindowsWhenComplete() const { return m_closeRemainingWindowsWhenComplete; }
216     void setCloseRemainingWindowsWhenComplete(bool closeRemainingWindowsWhenComplete) { m_closeRemainingWindowsWhenComplete = closeRemainingWindowsWhenComplete; }
217     
218     bool newWindowsCopyBackForwardList() const { return m_newWindowsCopyBackForwardList; }
219     void setNewWindowsCopyBackForwardList(bool newWindowsCopyBackForwardList) { m_newWindowsCopyBackForwardList = newWindowsCopyBackForwardList; }
220     
221     bool stopProvisionalFrameLoads() const { return m_stopProvisionalFrameLoads; }
222     void setStopProvisionalFrameLoads(bool stopProvisionalFrameLoads) { m_stopProvisionalFrameLoads = stopProvisionalFrameLoads; }
223
224     bool testOnscreen() const { return m_testOnscreen; }
225     void setTestOnscreen(bool testOnscreen) { m_testOnscreen = testOnscreen; }
226
227     bool testRepaint() const { return m_testRepaint; }
228     void setTestRepaint(bool testRepaint) { m_testRepaint = testRepaint; }
229
230     bool testRepaintSweepHorizontally() const { return m_testRepaintSweepHorizontally; }
231     void setTestRepaintSweepHorizontally(bool testRepaintSweepHorizontally) { m_testRepaintSweepHorizontally = testRepaintSweepHorizontally; }
232
233     bool waitToDump() const { return m_waitToDump; }
234     void setWaitToDump(bool waitToDump);
235     void waitToDumpWatchdogTimerFired();
236
237     const std::set<std::string>& willSendRequestClearHeaders() const { return m_willSendRequestClearHeaders; }
238     void setWillSendRequestClearHeader(std::string header) { m_willSendRequestClearHeaders.insert(header); }
239
240     bool willSendRequestReturnsNull() const { return m_willSendRequestReturnsNull; }
241     void setWillSendRequestReturnsNull(bool returnsNull) { m_willSendRequestReturnsNull = returnsNull; }
242
243     bool willSendRequestReturnsNullOnRedirect() const { return m_willSendRequestReturnsNullOnRedirect; }
244     void setWillSendRequestReturnsNullOnRedirect(bool returnsNull) { m_willSendRequestReturnsNullOnRedirect = returnsNull; }
245
246     bool windowIsKey() const { return m_windowIsKey; }
247     void setWindowIsKey(bool windowIsKey);
248
249     bool alwaysAcceptCookies() const { return m_alwaysAcceptCookies; }
250     void setAlwaysAcceptCookies(bool alwaysAcceptCookies);
251     
252     bool handlesAuthenticationChallenges() const { return m_handlesAuthenticationChallenges; }
253     void setHandlesAuthenticationChallenges(bool handlesAuthenticationChallenges) { m_handlesAuthenticationChallenges = handlesAuthenticationChallenges; }
254     
255     bool isPrinting() const { return m_isPrinting; }
256     void setIsPrinting(bool isPrinting) { m_isPrinting = isPrinting; }
257
258     const std::string& authenticationUsername() const { return m_authenticationUsername; }
259     void setAuthenticationUsername(std::string username) { m_authenticationUsername = username; }
260     
261     const std::string& authenticationPassword() const { return m_authenticationPassword; }
262     void setAuthenticationPassword(std::string password) { m_authenticationPassword = password; }
263
264     bool globalFlag() const { return m_globalFlag; }
265     void setGlobalFlag(bool globalFlag) { m_globalFlag = globalFlag; }
266     
267     bool deferMainResourceDataLoad() const { return m_deferMainResourceDataLoad; }
268     void setDeferMainResourceDataLoad(bool flag) { m_deferMainResourceDataLoad = flag; }
269
270     const std::string& testPathOrURL() const { return m_testPathOrURL; }
271     const std::string& expectedPixelHash() const { return m_expectedPixelHash; }
272
273     const std::string& encodedAudioData() const { return m_encodedAudioData; }
274     void setEncodedAudioData(const std::string& encodedAudioData) { m_encodedAudioData = encodedAudioData; }
275     
276     bool pauseAnimationAtTimeOnElementWithId(JSStringRef animationName, double time, JSStringRef elementId);
277     bool pauseTransitionAtTimeOnElementWithId(JSStringRef propertyName, double time, JSStringRef elementId);
278     bool sampleSVGAnimationForElementAtTime(JSStringRef animationId, double time, JSStringRef elementId);
279     unsigned numberOfActiveAnimations() const;
280     void suspendAnimations() const;
281     void resumeAnimations() const;
282
283     void addOriginAccessWhitelistEntry(JSStringRef sourceOrigin, JSStringRef destinationProtocol, JSStringRef destinationHost, bool allowDestinationSubdomains);
284     void removeOriginAccessWhitelistEntry(JSStringRef sourceOrigin, JSStringRef destinationProtocol, JSStringRef destinationHost, bool allowDestinationSubdomains);
285
286     void addUserScript(JSStringRef source, bool runAtStart, bool allFrames);
287     void addUserStyleSheet(JSStringRef source, bool allFrames);
288
289     void setGeolocationPermission(bool allow);
290     bool isGeolocationPermissionSet() const { return m_isGeolocationPermissionSet; }
291     bool geolocationPermission() const { return m_geolocationPermission; }
292
293     void setDeveloperExtrasEnabled(bool);
294     void setAsynchronousSpellCheckingEnabled(bool);
295     void showWebInspector();
296     void closeWebInspector();
297     void setTimelineProfilingEnabled(bool enabled);
298     void evaluateInWebInspector(long callId, JSStringRef script);
299     void evaluateScriptInIsolatedWorld(unsigned worldId, JSObjectRef globalObject, JSStringRef script);
300
301     void setPOSIXLocale(JSStringRef locale);
302
303     void setWebViewEditable(bool);
304
305     void abortModal();
306
307     bool hasSpellingMarker(int from, int length);
308     bool hasGrammarMarker(int from, int length);
309
310     void dumpConfigurationForViewport(int deviceDPI, int deviceWidth, int deviceHeight, int availableWidth, int availableHeight);
311
312     static void setSerializeHTTPLoads(bool serialize);
313
314     // The following API test functions should probably be moved to platform-specific 
315     // unit tests outside of DRT once they exist.
316     void apiTestNewWindowDataLoadBaseURL(JSStringRef utf8Data, JSStringRef baseURL);
317     void apiTestGoToCurrentBackForwardItem();
318
319     // Simulate a request an embedding application could make, populating per-session credential storage.
320     void authenticateSession(JSStringRef url, JSStringRef username, JSStringRef password);
321
322     JSRetainPtr<JSStringRef> layerTreeAsText() const;
323
324     JSRetainPtr<JSStringRef> markerTextForListItem(JSContextRef context, JSValueRef nodeObject) const;
325
326     JSValueRef originsWithLocalStorage(JSContextRef);
327     void deleteAllLocalStorage();
328     void deleteLocalStorageForOrigin(JSStringRef originIdentifier);
329     void observeStorageTrackerNotifications(unsigned number);
330     void syncLocalStorage();
331
332     void setShouldPaintBrokenImage(bool);
333     bool shouldPaintBrokenImage() const { return m_shouldPaintBrokenImage; }
334
335     static const unsigned maxViewWidth;
336     static const unsigned maxViewHeight;
337
338     void setMinimumTimerInterval(double);
339
340 private:
341     LayoutTestController(const std::string& testPathOrURL, const std::string& expectedPixelHash);
342
343     void setGeolocationPermissionCommon(bool allow);
344
345     bool m_dumpApplicationCacheDelegateCallbacks;
346     bool m_dumpAsAudio;
347     bool m_dumpAsPDF;
348     bool m_dumpAsText;
349     bool m_dumpBackForwardList;
350     bool m_dumpChildFrameScrollPositions;
351     bool m_dumpChildFramesAsText;
352     bool m_dumpDOMAsWebArchive;
353     bool m_dumpDatabaseCallbacks;
354     bool m_dumpEditingCallbacks;
355     bool m_dumpFrameLoadCallbacks;
356     bool m_dumpUserGestureInFrameLoadCallbacks;
357     bool m_dumpHistoryDelegateCallbacks;
358     bool m_dumpResourceLoadCallbacks;
359     bool m_dumpResourceResponseMIMETypes;
360     bool m_dumpSelectionRect;
361     bool m_dumpSourceAsWebArchive;
362     bool m_dumpStatusCallbacks;
363     bool m_dumpTitleChanges;
364     bool m_dumpIconChanges;
365     bool m_dumpVisitedLinksCallback;
366     bool m_dumpWillCacheResponse;
367     bool m_generatePixelResults;
368     bool m_callCloseOnWebViews;
369     bool m_canOpenWindows;
370     bool m_closeRemainingWindowsWhenComplete;
371     bool m_newWindowsCopyBackForwardList;
372     bool m_stopProvisionalFrameLoads;
373     bool m_testOnscreen;
374     bool m_testRepaint;
375     bool m_testRepaintSweepHorizontally;
376     bool m_waitToDump; // True if waitUntilDone() has been called, but notifyDone() has not yet been called.
377     bool m_willSendRequestReturnsNull;
378     bool m_willSendRequestReturnsNullOnRedirect;
379     bool m_windowIsKey;
380     bool m_alwaysAcceptCookies;
381     bool m_globalFlag;
382     bool m_isGeolocationPermissionSet;
383     bool m_geolocationPermission;
384     bool m_handlesAuthenticationChallenges;
385     bool m_isPrinting;
386     bool m_deferMainResourceDataLoad;
387     bool m_shouldPaintBrokenImage;
388
389     std::string m_authenticationUsername;
390     std::string m_authenticationPassword; 
391     std::string m_testPathOrURL;
392     std::string m_expectedPixelHash;    // empty string if no hash
393
394     std::set<std::string> m_willSendRequestClearHeaders;
395     
396     // base64 encoded WAV audio data is stored here.
397     std::string m_encodedAudioData;
398     
399     // origins which have been granted desktop notification access
400     std::vector<JSStringRef> m_desktopNotificationAllowedOrigins;
401
402     std::map<std::string, std::string> m_URLsToRedirect;
403     
404     static JSClassRef getJSClass();
405     static JSStaticValue* staticValues();
406     static JSStaticFunction* staticFunctions();
407 };
408
409 #endif // LayoutTestController_h