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