6ae20d8b63a0d7798c9c6ac5cc0146472f8d9d41
[WebKit-https.git] / WebKitTools / WebKitTestRunner / InjectedBundle / LayoutTestController.h
1 /*
2  * Copyright (C) 2010 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  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef LayoutTestController_h
27 #define LayoutTestController_h
28
29 #include "JSWrappable.h"
30 #include <JavaScriptCore/JSRetainPtr.h>
31 #include <wtf/PassRefPtr.h>
32 #include <wtf/RetainPtr.h>
33 #include <string>
34
35 namespace WTR {
36
37 class LayoutTestController : public JSWrappable {
38 public:
39     static PassRefPtr<LayoutTestController> create();
40     virtual ~LayoutTestController();
41
42     // JSWrappable
43     virtual JSClassRef wrapperClass();
44
45     void makeWindowObject(JSContextRef, JSObjectRef windowObject, JSValueRef* exception);
46
47     // The basics.
48     void dumpAsText() { m_whatToDump = MainFrameText; }
49     void dumpChildFramesAsText() { m_whatToDump = AllFramesText; }
50     void waitUntilDone();
51     void notifyDone();
52
53     // Other dumping.
54     void dumpChildFrameScrollPositions() { m_shouldDumpAllFrameScrollPositions = true; }
55     void dumpEditingCallbacks() { m_dumpEditingCallbacks = true; }
56     void dumpSelectionRect() { } // Will need to do something when we support pixel tests.
57     void dumpStatusCallbacks() { m_dumpStatusCallbacks = true; }
58     void dumpTitleChanges() { m_dumpTitleChanges = true; }
59
60     // Special options.
61     void keepWebHistory();
62     void setAcceptsEditing(bool value) { m_shouldAllowEditing = value; }
63     void setCanOpenWindows(bool);
64     void setCloseRemainingWindowsWhenComplete(bool value) { m_shouldCloseExtraWindows = value; }
65     void setXSSAuditorEnabled(bool);
66     unsigned windowCount();
67
68     // Special DOM functions.
69     JSValueRef computedStyleIncludingVisitedInfo(JSValueRef element);
70     JSRetainPtr<JSStringRef> counterValueForElementById(JSStringRef elementId);
71     JSRetainPtr<JSStringRef> markerTextForListItem(JSValueRef element);
72     void execCommand(JSStringRef name, JSStringRef argument);
73     bool isCommandEnabled(JSStringRef name);
74
75     // Repaint testing.
76     void testRepaint() { m_testRepaint = true; }
77     void repaintSweepHorizontally() { m_testRepaintSweepHorizontally = true; }
78     void display();
79
80     // Animation testing.
81     unsigned numberOfActiveAnimations() const;
82     bool pauseAnimationAtTimeOnElementWithId(JSStringRef animationName, double time, JSStringRef elementId);
83
84     // UserContent testing.
85     void addUserScript(JSStringRef source, bool runAtStart, bool allFrames);
86     void addUserStyleSheet(JSStringRef source, bool allFrames);
87
88     enum WhatToDump { RenderTree, MainFrameText, AllFramesText };
89     WhatToDump whatToDump() const { return m_whatToDump; }
90
91     bool shouldDumpAllFrameScrollPositions() const { return m_shouldDumpAllFrameScrollPositions; }
92     bool shouldDumpEditingCallbacks() const { return m_dumpEditingCallbacks; }
93     bool shouldDumpMainFrameScrollPosition() const { return m_whatToDump == RenderTree; }
94
95     bool shouldDumpStatusCallbacks() const { return m_dumpStatusCallbacks; }
96     bool shouldDumpTitleChanges() const { return m_dumpTitleChanges; }
97
98     bool waitToDump() const { return m_waitToDump; }
99     void waitToDumpWatchdogTimerFired();
100     void invalidateWaitToDumpWatchdogTimer();
101
102     bool shouldAllowEditing() const { return m_shouldAllowEditing; }
103
104     bool shouldCloseExtraWindowsAfterRunningTest() const { return m_shouldCloseExtraWindows; }
105
106 private:
107     static const double waitToDumpWatchdogTimerInterval;
108
109     LayoutTestController();
110
111     void platformInitialize();
112     void initializeWaitToDumpWatchdogTimerIfNeeded();
113
114     WhatToDump m_whatToDump;
115     bool m_shouldDumpAllFrameScrollPositions;
116
117     bool m_shouldAllowEditing;
118     bool m_shouldCloseExtraWindows;
119
120     bool m_dumpEditingCallbacks;
121     bool m_dumpStatusCallbacks;
122     bool m_dumpTitleChanges;
123     bool m_waitToDump; // True if waitUntilDone() has been called, but notifyDone() has not yet been called.
124     bool m_testRepaint;
125     bool m_testRepaintSweepHorizontally;
126
127 #if PLATFORM(MAC)
128     RetainPtr<CFRunLoopTimerRef> m_waitToDumpWatchdogTimer;
129 #elif PLATFORM(WIN)
130     UINT_PTR m_waitToDumpWatchdogTimer;
131 #endif
132 };
133
134 } // namespace WTR
135
136 #endif // LayoutTestController_h