2011-01-07 Maciej Stachowiak <mjs@apple.com>
[WebKit.git] / Tools / WebKitTestRunner / InjectedBundle / LayoutTestController.cpp
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 #include "LayoutTestController.h"
27
28 #include "InjectedBundle.h"
29 #include "InjectedBundlePage.h"
30 #include "JSLayoutTestController.h"
31 #include "StringFunctions.h"
32 #include <WebKit2/WKBundleBackForwardList.h>
33 #include <WebKit2/WKBundleFrame.h>
34 #include <WebKit2/WKBundleFramePrivate.h>
35 #include <WebKit2/WKBundlePagePrivate.h>
36 #include <WebKit2/WKBundleScriptWorld.h>
37 #include <WebKit2/WKBundlePrivate.h>
38 #include <WebKit2/WKRetainPtr.h>
39 #include <WebKit2/WebKit2.h>
40
41 namespace WTR {
42
43 // This is lower than DumpRenderTree's timeout, to make it easier to work through the failures
44 // Eventually it should be changed to match.
45 const double LayoutTestController::waitToDumpWatchdogTimerInterval = 6;
46
47 static JSValueRef propertyValue(JSContextRef context, JSObjectRef object, const char* propertyName)
48 {
49     if (!object)
50         return 0;
51     JSRetainPtr<JSStringRef> propertyNameString(Adopt, JSStringCreateWithUTF8CString(propertyName));
52     JSValueRef exception;
53     return JSObjectGetProperty(context, object, propertyNameString.get(), &exception);
54 }
55
56 static JSObjectRef propertyObject(JSContextRef context, JSObjectRef object, const char* propertyName)
57 {
58     JSValueRef value = propertyValue(context, object, propertyName);
59     if (!value || !JSValueIsObject(context, value))
60         return 0;
61     return const_cast<JSObjectRef>(value);
62 }
63
64 static JSObjectRef getElementById(WKBundleFrameRef frame, JSStringRef elementId)
65 {
66     JSContextRef context = WKBundleFrameGetJavaScriptContext(frame);
67     JSObjectRef document = propertyObject(context, JSContextGetGlobalObject(context), "document");
68     if (!document)
69         return 0;
70     JSValueRef getElementById = propertyObject(context, document, "getElementById");
71     if (!getElementById || !JSValueIsObject(context, getElementById))
72         return 0;
73     JSValueRef elementIdValue = JSValueMakeString(context, elementId);
74     JSValueRef exception;
75     JSValueRef element = JSObjectCallAsFunction(context, const_cast<JSObjectRef>(getElementById), document, 1, &elementIdValue, &exception);
76     if (!element || !JSValueIsObject(context, element))
77         return 0;
78     return const_cast<JSObjectRef>(element);
79 }
80
81 PassRefPtr<LayoutTestController> LayoutTestController::create()
82 {
83     return adoptRef(new LayoutTestController);
84 }
85
86 LayoutTestController::LayoutTestController()
87     : m_whatToDump(RenderTree)
88     , m_shouldDumpAllFrameScrollPositions(false)
89     , m_shouldDumpBackForwardListsForAllWindows(false)
90     , m_shouldAllowEditing(true)
91     , m_shouldCloseExtraWindows(false)
92     , m_dumpEditingCallbacks(false)
93     , m_dumpStatusCallbacks(false)
94     , m_dumpTitleChanges(false)
95     , m_waitToDump(false)
96     , m_testRepaint(false)
97     , m_testRepaintSweepHorizontally(false)
98 {
99     platformInitialize();
100 }
101
102 LayoutTestController::~LayoutTestController()
103 {
104 }
105
106 JSClassRef LayoutTestController::wrapperClass()
107 {
108     return JSLayoutTestController::layoutTestControllerClass();
109 }
110
111 void LayoutTestController::display()
112 {
113     // FIXME: actually implement, once we want pixel tests
114 }
115
116 void LayoutTestController::waitUntilDone()
117 {
118     m_waitToDump = true;
119     initializeWaitToDumpWatchdogTimerIfNeeded();
120 }
121
122 void LayoutTestController::waitToDumpWatchdogTimerFired()
123 {
124     invalidateWaitToDumpWatchdogTimer();
125     const char* message = "FAIL: Timed out waiting for notifyDone to be called\n";
126     InjectedBundle::shared().os() << message << "\n";
127     InjectedBundle::shared().done();
128 }
129
130 void LayoutTestController::notifyDone()
131 {
132     if (!InjectedBundle::shared().isTestRunning())
133         return;
134
135     if (m_waitToDump && !InjectedBundle::shared().page()->isLoading())
136         InjectedBundle::shared().page()->dump();
137     m_waitToDump = false;
138 }
139
140 unsigned LayoutTestController::numberOfActiveAnimations() const
141 {
142     // FIXME: Is it OK this works only for the main frame?
143     // FIXME: If this is needed only for the main frame, then why is the function on WKBundleFrame instead of WKBundlePage?
144     WKBundleFrameRef mainFrame = WKBundlePageGetMainFrame(InjectedBundle::shared().page()->page());
145     return WKBundleFrameGetNumberOfActiveAnimations(mainFrame);
146 }
147
148 bool LayoutTestController::pauseAnimationAtTimeOnElementWithId(JSStringRef animationName, double time, JSStringRef elementId)
149 {
150     // FIXME: Is it OK this works only for the main frame?
151     // FIXME: If this is needed only for the main frame, then why is the function on WKBundleFrame instead of WKBundlePage?
152     WKBundleFrameRef mainFrame = WKBundlePageGetMainFrame(InjectedBundle::shared().page()->page());
153     return WKBundleFramePauseAnimationOnElementWithId(mainFrame, toWK(animationName).get(), toWK(elementId).get(), time);
154 }
155
156 void LayoutTestController::suspendAnimations()
157 {
158     WKBundleFrameRef mainFrame = WKBundlePageGetMainFrame(InjectedBundle::shared().page()->page());
159     WKBundleFrameSuspendAnimations(mainFrame);
160 }
161
162 void LayoutTestController::resumeAnimations()
163 {
164     WKBundleFrameRef mainFrame = WKBundlePageGetMainFrame(InjectedBundle::shared().page()->page());
165     WKBundleFrameResumeAnimations(mainFrame);
166 }
167
168 JSRetainPtr<JSStringRef> LayoutTestController::layerTreeAsText() const
169 {
170     WKBundleFrameRef mainFrame = WKBundlePageGetMainFrame(InjectedBundle::shared().page()->page());
171     WKRetainPtr<WKStringRef> text(AdoptWK, WKBundleFrameCopyLayerTreeAsText(mainFrame));
172     return toJS(text);
173 }
174
175 void LayoutTestController::addUserScript(JSStringRef source, bool runAtStart, bool allFrames)
176 {
177     WKRetainPtr<WKStringRef> sourceWK = toWK(source);
178     WKRetainPtr<WKBundleScriptWorldRef> scriptWorld(AdoptWK, WKBundleScriptWorldCreateWorld());
179
180     WKBundleAddUserScript(InjectedBundle::shared().bundle(), InjectedBundle::shared().pageGroup(), scriptWorld.get(), sourceWK.get(), 0, 0, 0,
181         (runAtStart ? kWKInjectAtDocumentStart : kWKInjectAtDocumentEnd),
182         (allFrames ? kWKInjectInAllFrames : kWKInjectInTopFrameOnly));
183 }
184
185 void LayoutTestController::addUserStyleSheet(JSStringRef source, bool allFrames)
186 {
187     WKRetainPtr<WKStringRef> sourceWK = toWK(source);
188     WKRetainPtr<WKBundleScriptWorldRef> scriptWorld(AdoptWK, WKBundleScriptWorldCreateWorld());
189
190     WKBundleAddUserStyleSheet(InjectedBundle::shared().bundle(), InjectedBundle::shared().pageGroup(), scriptWorld.get(), sourceWK.get(), 0, 0, 0,
191         (allFrames ? kWKInjectInAllFrames : kWKInjectInTopFrameOnly));
192 }
193
194 void LayoutTestController::keepWebHistory()
195 {
196     WKBundleSetShouldTrackVisitedLinks(InjectedBundle::shared().bundle(), true);
197 }
198
199 JSValueRef LayoutTestController::computedStyleIncludingVisitedInfo(JSValueRef element)
200 {
201     // FIXME: Is it OK this works only for the main frame?
202     WKBundleFrameRef mainFrame = WKBundlePageGetMainFrame(InjectedBundle::shared().page()->page());
203     JSContextRef context = WKBundleFrameGetJavaScriptContext(mainFrame);
204     if (!JSValueIsObject(context, element))
205         return JSValueMakeUndefined(context);
206     JSValueRef value = WKBundleFrameGetComputedStyleIncludingVisitedInfo(mainFrame, const_cast<JSObjectRef>(element));
207     if (!value)
208         return JSValueMakeUndefined(context);
209     return value;
210 }
211
212 JSRetainPtr<JSStringRef> LayoutTestController::counterValueForElementById(JSStringRef elementId)
213 {
214     WKBundleFrameRef mainFrame = WKBundlePageGetMainFrame(InjectedBundle::shared().page()->page());
215     JSObjectRef element = getElementById(mainFrame, elementId);
216     if (!element)
217         return 0;
218     WKRetainPtr<WKStringRef> value(AdoptWK, WKBundleFrameCopyCounterValue(mainFrame, const_cast<JSObjectRef>(element)));
219     return toJS(value);
220 }
221
222 JSRetainPtr<JSStringRef> LayoutTestController::markerTextForListItem(JSValueRef element)
223 {
224     WKBundleFrameRef mainFrame = WKBundlePageGetMainFrame(InjectedBundle::shared().page()->page());
225     JSContextRef context = WKBundleFrameGetJavaScriptContext(mainFrame);
226     if (!element || !JSValueIsObject(context, element))
227         return 0;
228     WKRetainPtr<WKStringRef> text(AdoptWK, WKBundleFrameCopyMarkerText(mainFrame, const_cast<JSObjectRef>(element)));
229     if (WKStringIsEmpty(text.get()))
230         return 0;
231     return toJS(text);
232 }
233
234 void LayoutTestController::execCommand(JSStringRef name, JSStringRef argument)
235 {
236     WKBundlePageExecuteEditingCommand(InjectedBundle::shared().page()->page(), toWK(name).get(), toWK(argument).get());
237 }
238
239 bool LayoutTestController::findString(JSStringRef target, JSValueRef optionsArrayAsValue)
240 {
241     WKFindOptions options = 0;
242
243     WKBundleFrameRef mainFrame = WKBundlePageGetMainFrame(InjectedBundle::shared().page()->page());
244     JSContextRef context = WKBundleFrameGetJavaScriptContext(mainFrame);
245     JSRetainPtr<JSStringRef> lengthPropertyName(Adopt, JSStringCreateWithUTF8CString("length"));
246     JSObjectRef optionsArray = JSValueToObject(context, optionsArrayAsValue, 0);
247     JSValueRef lengthValue = JSObjectGetProperty(context, optionsArray, lengthPropertyName.get(), 0);
248     if (!JSValueIsNumber(context, lengthValue))
249         return false;
250
251     size_t length = static_cast<size_t>(JSValueToNumber(context, lengthValue, 0));
252     for (size_t i = 0; i < length; ++i) {
253         JSValueRef value = JSObjectGetPropertyAtIndex(context, optionsArray, i, 0);
254         if (!JSValueIsString(context, value))
255             continue;
256
257         JSRetainPtr<JSStringRef> optionName(Adopt, JSValueToStringCopy(context, value, 0));
258
259         if (JSStringIsEqualToUTF8CString(optionName.get(), "CaseInsensitive"))
260             options |= kWKFindOptionsCaseInsensitive;
261         else if (JSStringIsEqualToUTF8CString(optionName.get(), "AtWordStarts"))
262             options |= kWKFindOptionsAtWordStarts;
263         else if (JSStringIsEqualToUTF8CString(optionName.get(), "TreatMedialCapitalAsWordStart"))
264             options |= kWKFindOptionsTreatMedialCapitalAsWordStart;
265         else if (JSStringIsEqualToUTF8CString(optionName.get(), "Backwards"))
266             options |= kWKFindOptionsBackwards;
267         else if (JSStringIsEqualToUTF8CString(optionName.get(), "WrapAround"))
268             options |= kWKFindOptionsWrapAround;
269         else if (JSStringIsEqualToUTF8CString(optionName.get(), "StartInSelection")) {
270             // FIXME: No kWKFindOptionsStartInSelection.
271         }
272     }
273
274     return WKBundlePageFindString(InjectedBundle::shared().page()->page(), toWK(target).get(), options);
275 }
276
277 bool LayoutTestController::isCommandEnabled(JSStringRef name)
278 {
279     return WKBundlePageIsEditingCommandEnabled(InjectedBundle::shared().page()->page(), toWK(name).get());
280 }
281
282 void LayoutTestController::setCanOpenWindows(bool)
283 {
284     // It's not clear if or why any tests require opening windows be forbidden.
285     // For now, just ignore this setting, and if we find later it's needed we can add it.
286 }
287
288 void LayoutTestController::setXSSAuditorEnabled(bool enabled)
289 {
290     WKBundleOverrideXSSAuditorEnabledForTestRunner(InjectedBundle::shared().bundle(), InjectedBundle::shared().pageGroup(), true);
291 }
292
293 unsigned LayoutTestController::windowCount()
294 {
295     return InjectedBundle::shared().pageCount();
296 }
297
298 void LayoutTestController::clearBackForwardList()
299 {
300     WKBundleBackForwardListClear(WKBundlePageGetBackForwardList(InjectedBundle::shared().page()->page()));
301 }
302
303 // Object Creation
304
305 void LayoutTestController::makeWindowObject(JSContextRef context, JSObjectRef windowObject, JSValueRef* exception)
306 {
307     setProperty(context, windowObject, "layoutTestController", this, kJSPropertyAttributeReadOnly | kJSPropertyAttributeDontDelete, exception);
308 }
309
310 } // namespace WTR