WebCore:
[WebKit-https.git] / WebKitTools / DumpRenderTree / LayoutTestController.h
1 /*
2  * Copyright (C) 2007 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
34 class LayoutTestController {
35 public:
36     LayoutTestController(bool testRepaintDefault, bool testRepaintSweepHorizontallyDefault);
37     ~LayoutTestController();
38
39     void makeWindowObject(JSContextRef context, JSObjectRef windowObject, JSValueRef* exception);
40
41     // Controller Methods - platfrom independant implementations
42     void addDisallowedURL(JSStringRef url);
43     void clearAllDatabases();
44     void clearBackForwardList();
45     JSStringRef copyDecodedHostName(JSStringRef name);
46     JSStringRef copyEncodedHostName(JSStringRef name);
47     void execCommand(JSStringRef name, JSStringRef value);
48     void display();
49     void keepWebHistory();
50     void notifyDone();
51     JSStringRef pathToLocalResource(JSContextRef, JSStringRef url);
52     void queueBackNavigation(int howFarBackward);
53     void queueForwardNavigation(int howFarForward);
54     void queueLoad(JSStringRef url, JSStringRef target);
55     void queueReload();
56     void queueScript(JSStringRef url);
57     void setAcceptsEditing(bool acceptsEditing);
58     void setAuthorAndUserStylesEnabled(bool);
59     void setCustomPolicyDelegate(bool setDelegate);
60     void setDatabaseQuota(unsigned long long quota);
61     void setMainFrameIsFirstResponder(bool flag);
62     void setPrivateBrowsingEnabled(bool flag);
63     void setPopupBlockingEnabled(bool flag);
64     void setTabKeyCyclesThroughElements(bool cycles);
65     void setUseDashboardCompatibilityMode(bool flag);
66     void setUserStyleSheetEnabled(bool flag);
67     void setUserStyleSheetLocation(JSStringRef path);
68     void setPersistentUserStyleSheetLocation(JSStringRef path);
69     void clearPersistentUserStyleSheet();
70     int windowCount();
71     
72     bool elementDoesAutoCompleteForElementWithId(JSStringRef id);
73
74     bool dumpAsText() const { return m_dumpAsText; }
75     void setDumpAsText(bool dumpAsText) { m_dumpAsText = dumpAsText; }
76
77     bool dumpAsPDF() const { return m_dumpAsPDF; }
78     void setDumpAsPDF(bool dumpAsPDF) { m_dumpAsPDF = dumpAsPDF; }
79     
80     bool dumpBackForwardList() const { return m_dumpBackForwardList; }
81     void setDumpBackForwardList(bool dumpBackForwardList) { m_dumpBackForwardList = dumpBackForwardList; }
82
83     bool dumpChildFrameScrollPositions() const { return m_dumpChildFrameScrollPositions; }
84     void setDumpChildFrameScrollPositions(bool dumpChildFrameScrollPositions) { m_dumpChildFrameScrollPositions = dumpChildFrameScrollPositions; }
85
86     bool dumpChildFramesAsText() const { return m_dumpChildFramesAsText; }
87     void setDumpChildFramesAsText(bool dumpChildFramesAsText) { m_dumpChildFramesAsText = dumpChildFramesAsText; }
88
89     bool dumpDatabaseCallbacks() const { return m_dumpDatabaseCallbacks; }
90     void setDumpDatabaseCallbacks(bool dumpDatabaseCallbacks) { m_dumpDatabaseCallbacks = dumpDatabaseCallbacks; }
91
92     bool dumpStatusCallbacks() const { return m_dumpStatusCallbacks; }
93     void setDumpStatusCallbacks(bool dumpStatusCallbacks) { m_dumpStatusCallbacks = dumpStatusCallbacks; }
94
95     bool dumpDOMAsWebArchive() const { return m_dumpDOMAsWebArchive; }
96     void setDumpDOMAsWebArchive(bool dumpDOMAsWebArchive) { m_dumpDOMAsWebArchive = dumpDOMAsWebArchive; }
97
98     bool dumpSelectionRect() const { return m_dumpSelectionRect; }
99     void setDumpSelectionRect(bool dumpSelectionRect) { m_dumpSelectionRect = dumpSelectionRect; }
100
101     bool dumpSourceAsWebArchive() const { return m_dumpSourceAsWebArchive; }
102     void setDumpSourceAsWebArchive(bool dumpSourceAsWebArchive) { m_dumpSourceAsWebArchive = dumpSourceAsWebArchive; }
103
104     bool dumpTitleChanges() const { return m_dumpTitleChanges; }
105     void setDumpTitleChanges(bool dumpTitleChanges) { m_dumpTitleChanges = dumpTitleChanges; }
106
107     bool dumpEditingCallbacks() const { return m_dumpEditingCallbacks; }
108     void setDumpEditingCallbacks(bool dumpEditingCallbacks) { m_dumpEditingCallbacks = dumpEditingCallbacks; }
109
110     bool dumpResourceLoadCallbacks() const { return m_dumpResourceLoadCallbacks; }
111     void setDumpResourceLoadCallbacks(bool dumpResourceLoadCallbacks) { m_dumpResourceLoadCallbacks = dumpResourceLoadCallbacks; }
112
113     bool dumpFrameLoadCallbacks() const { return m_dumpFrameLoadCallbacks; }
114     void setDumpFrameLoadCallbacks(bool dumpFrameLoadCallbacks) { m_dumpFrameLoadCallbacks = dumpFrameLoadCallbacks; }
115
116     bool addFileToPasteboardOnDrag() const { return m_addFileToPasteboardOnDrag; }
117     void setAddFileToPasteboardOnDrag(bool addFileToPasteboardOnDrag) { m_addFileToPasteboardOnDrag = addFileToPasteboardOnDrag; }
118
119     bool callCloseOnWebViews() const { return m_callCloseOnWebViews; }
120     void setCallCloseOnWebViews(bool callCloseOnWebViews) { m_callCloseOnWebViews = callCloseOnWebViews; }
121
122     bool canOpenWindows() const { return m_canOpenWindows; }
123     void setCanOpenWindows(bool canOpenWindows) { m_canOpenWindows = canOpenWindows; }
124
125     bool closeRemainingWindowsWhenComplete() const { return m_closeRemainingWindowsWhenComplete; }
126     void setCloseRemainingWindowsWhenComplete(bool closeRemainingWindowsWhenComplete) { m_closeRemainingWindowsWhenComplete = closeRemainingWindowsWhenComplete; }
127     
128     bool stopProvisionalFrameLoads() const { return m_stopProvisionalFrameLoads; }
129     void setStopProvisionalFrameLoads(bool stopProvisionalFrameLoads) { m_stopProvisionalFrameLoads = stopProvisionalFrameLoads; }
130
131     bool testRepaint() const { return m_testRepaint; }
132     void setTestRepaint(bool testRepaint) { m_testRepaint = testRepaint; }
133
134     bool testRepaintSweepHorizontally() const { return m_testRepaintSweepHorizontally; }
135     void setTestRepaintSweepHorizontally(bool testRepaintSweepHorizontally) { m_testRepaintSweepHorizontally = testRepaintSweepHorizontally; }
136
137     bool waitToDump() const { return m_waitToDump; }
138     void setWaitToDump(bool waitToDump);
139
140     bool windowIsKey() const { return m_windowIsKey; }
141     void setWindowIsKey(bool windowIsKey);
142
143     bool globalFlag() const { return m_globalFlag; }
144     void setGlobalFlag(bool globalFlag) { m_globalFlag = globalFlag; }
145     
146 private:
147     bool m_dumpAsText;
148     bool m_dumpAsPDF;
149     bool m_dumpBackForwardList;
150     bool m_dumpChildFrameScrollPositions;
151     bool m_dumpChildFramesAsText;
152     bool m_dumpDatabaseCallbacks;
153     bool m_dumpDOMAsWebArchive;
154     bool m_dumpSelectionRect;
155     bool m_dumpSourceAsWebArchive;
156     bool m_dumpStatusCallbacks;
157     bool m_dumpTitleChanges;
158     bool m_dumpEditingCallbacks;
159     bool m_dumpResourceLoadCallbacks;
160     bool m_dumpFrameLoadCallbacks;
161     bool m_addFileToPasteboardOnDrag;
162     bool m_callCloseOnWebViews;
163     bool m_canOpenWindows;
164     bool m_closeRemainingWindowsWhenComplete;
165     bool m_stopProvisionalFrameLoads;
166     bool m_testRepaint;
167     bool m_testRepaintSweepHorizontally;
168     bool m_waitToDump; // True if waitUntilDone() has been called, but notifyDone() has not yet been called.
169     bool m_windowIsKey;
170
171     bool m_globalFlag;
172
173     static JSClassRef getJSClass();
174     static JSStaticValue* staticValues();
175     static JSStaticFunction* staticFunctions();
176 };
177
178 #endif // LayoutTestController_h