Source/WebCore: Moved markerTextForListItem from TestRunner to Internals
[WebKit-https.git] / Tools / DumpRenderTree / qt / TestRunnerQt.h
1 /*
2  * Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies)
3  * Copyright (C) 2009 Torch Mobile Inc. http://www.torchmobile.com/
4  * Copyright (C) 2012 Apple Inc. All Rights Reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * 1.  Redistributions of source code must retain the above copyright
11  *     notice, this list of conditions and the following disclaimer.
12  * 2.  Redistributions in binary form must reproduce the above copyright
13  *     notice, this list of conditions and the following disclaimer in the
14  *     documentation and/or other materials provided with the distribution.
15  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
16  *     its contributors may be used to endorse or promote products derived
17  *     from this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
20  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
23  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
26  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef TestRunnerQt_h
32 #define TestRunnerQt_h
33
34 #include <QBasicTimer>
35 #include <QObject>
36 #include <QSize>
37 #include <QString>
38 #include <QTimer>
39 #include <QTimerEvent>
40 #include <QVariant>
41 #include <QtDebug>
42
43 #include <qwebdatabase.h>
44 #include <qwebelement.h>
45 #include <qwebframe.h>
46 #include <qwebhistory.h>
47 #include <qwebpage.h>
48 #include <qwebsecurityorigin.h>
49
50 class QWebFrame;
51 class DumpRenderTreeSupportQt;
52 namespace WebCore {
53 class DumpRenderTree;
54 }
55
56 class TestRunnerQt : public QObject {
57     Q_OBJECT
58     Q_PROPERTY(int webHistoryItemCount READ webHistoryItemCount)
59     Q_PROPERTY(bool globalFlag READ globalFlag WRITE setGlobalFlag)
60 public:
61     TestRunnerQt(WebCore::DumpRenderTree*);
62
63     bool shouldDisallowIncreaseForApplicationCacheQuota() const { return m_disallowIncreaseForApplicationCacheQuota; }
64     bool shouldDumpAsText() const { return m_textDump; }
65     bool shouldDumpAsAudio() const { return m_audioDump; }
66     bool shouldDumpPixels() const { return m_shouldDumpPixels; }
67     bool shouldDumpBackForwardList() const { return m_dumpBackForwardList; }
68     bool shouldDumpChildrenAsText() const { return m_dumpChildrenAsText; }
69     bool shouldDumpChildFrameScrollPositions() const { return m_dumpChildFrameScrollPositions; }
70     bool shouldDumpDatabaseCallbacks() const { return m_dumpDatabaseCallbacks; }
71     bool shouldDumpApplicationCacheDelegateCallbacks() const { return m_dumpApplicationCacheDelegateCallbacks; }
72     bool shouldDumpStatusCallbacks() const { return m_dumpStatusCallbacks; }
73     bool shouldWaitUntilDone() const { return m_waitForDone; }
74     bool shouldHandleErrorPages() const { return m_handleErrorPages; }
75     bool canOpenWindows() const { return m_canOpenWindows; }
76     bool shouldDumpTitleChanges() const { return m_dumpTitleChanges; }
77     bool waitForPolicy() const { return m_waitForPolicy; }
78     bool ignoreReqestForPermission() const { return m_ignoreDesktopNotification; }
79     bool isPrinting() { return m_isPrinting; }
80
81     const QByteArray& audioData() const { return m_audioData; }
82
83     void reset();
84
85     static const unsigned int maxViewWidth;
86     static const unsigned int maxViewHeight;
87
88     void setTimeout(int timeout) { m_timeout = timeout; }
89     void setShouldTimeout(bool flag) { m_shouldTimeout = flag; }
90
91 protected:
92     void timerEvent(QTimerEvent*);
93
94 Q_SIGNALS:
95     void done();
96
97     void showPage();
98     void hidePage();
99     void geolocationPermissionSet();
100
101 public Q_SLOTS:
102     void maybeDump(bool ok);
103     void disallowIncreaseForApplicationCacheQuota() { m_disallowIncreaseForApplicationCacheQuota = true; }
104     void dumpAsText(bool shouldDumpPixels = false);
105     void dumpChildFramesAsText() { m_dumpChildrenAsText = true; }
106     void dumpChildFrameScrollPositions() { m_dumpChildFrameScrollPositions = true; }
107     void dumpDatabaseCallbacks() { m_dumpDatabaseCallbacks = true; }
108     void dumpApplicationCacheDelegateCallbacks() { m_dumpApplicationCacheDelegateCallbacks = true; }
109     void dumpStatusCallbacks() { m_dumpStatusCallbacks = true; }
110     void dumpNotifications();
111     void setCanOpenWindows() { m_canOpenWindows = true; }
112     void setPrinting() { m_isPrinting = true; }
113     void waitUntilDone();
114     int webHistoryItemCount();
115     void keepWebHistory();
116     void notifyDone();
117     void dumpBackForwardList() { m_dumpBackForwardList = true; }
118     bool globalFlag() const { return m_globalFlag; }
119     void setGlobalFlag(bool flag) { m_globalFlag = flag; }
120     void handleErrorPages() { m_handleErrorPages = true; }
121     void dumpEditingCallbacks();
122     void dumpFrameLoadCallbacks();
123     void dumpProgressFinishedCallback();
124     void dumpUserGestureInFrameLoadCallbacks();
125     void dumpResourceLoadCallbacks();
126     void dumpResourceResponseMIMETypes();
127     void dumpWillCacheResponse();
128     void dumpHistoryCallbacks();
129     void setWillSendRequestReturnsNullOnRedirect(bool enabled);
130     void setWillSendRequestReturnsNull(bool enabled);
131     void setWillSendRequestClearHeader(const QStringList& headers);
132     void queueBackNavigation(int howFarBackward);
133     void queueForwardNavigation(int howFarForward);
134     void queueLoad(const QString& url, const QString& target = QString());
135     void queueLoadHTMLString(const QString& content, const QString& baseURL = QString(), const QString& failingURL = QString());
136     void queueReload();
137     void queueLoadingScript(const QString& script);
138     void queueNonLoadingScript(const QString& script);
139     void provisionalLoad();
140     void setCloseRemainingWindowsWhenComplete(bool = false) { }
141     int windowCount();
142     void ignoreLegacyWebNotificationPermissionRequests();
143     void simulateLegacyWebNotificationClick(const QString& title);
144     void grantWebNotificationPermission(const QString& origin);
145     void denyWebNotificationPermission(const QString& origin);
146     void removeAllWebNotificationPermissions();
147     void simulateWebNotificationClick(const QWebElement&);
148     void display();
149     void displayInvalidatedRegion();
150     void clearBackForwardList();
151     QString pathToLocalResource(const QString& url);
152     void dumpTitleChanges() { m_dumpTitleChanges = true; }
153     QString encodeHostName(const QString& host);
154     QString decodeHostName(const QString& host);
155     void dumpSelectionRect() const { }
156     void setDeveloperExtrasEnabled(bool);
157     void setAsynchronousSpellCheckingEnabled(bool);
158     void showWebInspector();
159     void closeWebInspector();
160     void evaluateInWebInspector(long callId, const QString& script);
161     void removeAllVisitedLinks();
162     void setAllowUniversalAccessFromFileURLs(bool enable);
163     void setAllowFileAccessFromFileURLs(bool enable);
164     void setAppCacheMaximumSize(unsigned long long quota);
165     void setValueForUser(const QWebElement&, const QString& value);
166     void setFixedContentsSize(int width, int height);
167     void setPrivateBrowsingEnabled(bool);
168     void setSpatialNavigationEnabled(bool);
169     void setPluginsEnabled(bool flag);
170     void setPopupBlockingEnabled(bool);
171     void setPOSIXLocale(const QString& locale);
172     void resetLoadFinished() { m_loadFinished = false; }
173     void setWindowIsKey(bool);
174     void setMainFrameIsFirstResponder(bool);
175     void setDeferMainResourceDataLoad(bool);
176     void setJavaScriptCanAccessClipboard(bool enable);
177     void setXSSAuditorEnabled(bool);
178     void setCaretBrowsingEnabled(bool);
179     void setAuthorAndUserStylesEnabled(bool);
180     void setViewModeMediaFeature(const QString& mode);
181     void setSmartInsertDeleteEnabled(bool);
182     void setSelectTrailingWhitespaceEnabled(bool);
183     void execCommand(const QString& name, const QString& value = QString());
184     bool isCommandEnabled(const QString& name) const;
185     bool findString(const QString&, const QStringList& optionArray);
186
187     bool elementDoesAutoCompleteForElementWithId(const QString& elementId);
188
189     void addOriginAccessWhitelistEntry(const QString& sourceOrigin, const QString& destinationProtocol, const QString& destinationHost, bool allowDestinationSubdomains);
190     void removeOriginAccessWhitelistEntry(const QString& sourceOrigin, const QString& destinationProtocol, const QString& destinationHost, bool allowDestinationSubdomains);
191
192     void dispatchPendingLoadRequests();
193
194     void clearAllApplicationCaches();
195     void clearApplicationCacheForOrigin(const QString& url);
196     void setApplicationCacheOriginQuota(unsigned long long);
197     QStringList originsWithApplicationCache();
198     long long applicationCacheDiskUsageForOrigin(const QString&); 
199     void setCacheModel(int);
200
201     void setDatabaseQuota(int size);
202     void clearAllDatabases();
203     void setIconDatabaseEnabled(bool);
204
205     void setCustomPolicyDelegate(bool enabled, bool permissive = false);
206     void waitForPolicyDelegate();
207
208     void overridePreference(const QString& name, const QVariant& value);
209     void setUserStyleSheetLocation(const QString& url);
210     void setUserStyleSheetEnabled(bool);
211     void setDomainRelaxationForbiddenForURLScheme(bool forbidden, const QString& scheme);
212     bool callShouldCloseOnWebView();
213     // For now, this is a no-op. This may change depending on outcome of
214     // https://bugs.webkit.org/show_bug.cgi?id=33333
215     void setCallCloseOnWebViews() { }
216     // This is a no-op - it allows us to pass
217     // plugins/get-url-that-the-resource-load-delegate-will-disallow.html
218     // which is a Mac-specific test.
219     void addDisallowedURL(const QString&) { }
220
221     void setMockDeviceOrientation(bool canProvideAlpha, double alpha, bool canProvideBeta, double beta, bool canProvideGamma, double gamma);
222
223     void setMockGeolocationPositionUnavailableError(const QString& message);
224     void setMockGeolocationPosition(double latitude, double longitude, double accuracy);
225     void setGeolocationPermission(bool allow);
226     int numberOfPendingGeolocationPermissionRequests();
227     bool isGeolocationPermissionSet() const { return m_isGeolocationPermissionSet; }
228     bool geolocationPermission() const { return m_geolocationPermission; }
229
230     void addMockSpeechInputResult(const QString& result, double confidence, const QString& language);
231     void setMockSpeechInputDumpRect(bool flag);
232     void startSpeechInput(const QString& inputElement);
233
234     void setPageVisibility(const char*);
235     void resetPageVisibility();
236
237     void setAutomaticLinkDetectionEnabled(bool);
238
239     // Empty stub method to keep parity with object model exposed by global TestRunner.
240     void abortModal() { }
241
242     void addURLToRedirect(const QString& origin, const QString& destination);
243
244     /*
245         Policy values: 'on', 'auto' or 'off'.
246         Orientation values: 'vertical' or 'horizontal'.
247     */
248     void setScrollbarPolicy(const QString& orientation, const QString& policy);
249
250     QVariantMap computedStyleIncludingVisitedInfo(const QWebElement&) const;
251
252     // Simulate a request an embedding application could make, populating per-session credential storage.
253     void authenticateSession(const QString& url, const QString& username, const QString& password);
254
255     void evaluateScriptInIsolatedWorldAndReturnValue(int worldID, const QString& script);
256     void evaluateScriptInIsolatedWorld(int worldID, const QString& script);
257     void addUserStyleSheet(const QString& sourceCode);
258     
259     void originsWithLocalStorage();
260     void deleteAllLocalStorage();
261     void deleteLocalStorageForOrigin(const QString& originIdentifier);
262     long long localStorageDiskUsageForOrigin(const QString& originIdentifier);
263     void observeStorageTrackerNotifications(unsigned number);
264     void syncLocalStorage();
265     void setTextDirection(const QString& directionName);
266     void goBack();
267     void setDefersLoading(bool);
268     void setAlwaysAcceptCookies(bool);
269     void setAlwaysBlockCookies(bool);
270
271     void setAudioData(const QByteArray&);
272
273 private Q_SLOTS:
274     void processWork();
275
276 private:
277     void setGeolocationPermissionCommon(bool allow);
278
279 private:
280     bool m_hasDumped;
281     bool m_textDump;
282     bool m_audioDump;
283     bool m_shouldDumpPixels;
284     bool m_disallowIncreaseForApplicationCacheQuota;
285     bool m_dumpBackForwardList;
286     bool m_dumpChildrenAsText;
287     bool m_dumpChildFrameScrollPositions;
288     bool m_canOpenWindows;
289     bool m_waitForDone;
290     bool m_dumpTitleChanges;
291     bool m_dumpDatabaseCallbacks;
292     bool m_dumpApplicationCacheDelegateCallbacks;
293     bool m_dumpStatusCallbacks;
294     bool m_waitForPolicy;
295     bool m_handleErrorPages;
296     bool m_loadFinished;
297     bool m_globalFlag;
298     bool m_userStyleSheetEnabled;
299     bool m_isGeolocationPermissionSet;
300     bool m_isPrinting;
301     bool m_geolocationPermission;
302
303     QUrl m_userStyleSheetLocation;
304     QBasicTimer m_timeoutTimer;
305     QWebFrame* m_topLoadingFrame;
306     WebCore::DumpRenderTree* m_drt;
307     QWebHistory* m_webHistory;
308     bool m_ignoreDesktopNotification;
309
310     QByteArray m_audioData;
311
312     bool m_shouldTimeout;
313     int m_timeout;
314 };
315
316 #endif // TestRunnerQt_h