203f35857955d63180ee568bec7b3db676f8dc5f
[WebKit.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 <JavaScriptCore/JavaScriptCore.h>
30 #include <wtf/PassRefPtr.h>
31 #include <wtf/RefCounted.h>
32 #include <wtf/RetainPtr.h>
33 #include <string>
34
35 namespace WTR {
36
37 class LayoutTestController : public RefCounted<LayoutTestController> {
38 public:
39     static PassRefPtr<LayoutTestController> create(const std::string& testPathOrURL);
40     ~LayoutTestController();
41
42     void makeWindowObject(JSContextRef context, JSObjectRef windowObject, JSValueRef* exception);
43
44     bool dumpAsText() const { return m_dumpAsText; }
45     void setDumpAsText(bool dumpAsText) { m_dumpAsText = dumpAsText; }
46
47     bool waitToDump() const { return m_waitToDump; }
48     void setWaitToDump();
49     void waitToDumpWatchdogTimerFired();
50     void invalidateWaitToDumpWatchdog();
51     void notifyDone();
52
53     unsigned numberOfActiveAnimations() const;
54     bool pauseAnimationAtTimeOnElementWithId(JSStringRef animationName, double time, JSStringRef elementId);
55
56 private:
57     LayoutTestController(const std::string& testPathOrURL);
58
59     bool m_dumpAsText;
60     bool m_waitToDump; // True if waitUntilDone() has been called, but notifyDone() has not yet been called.
61
62     std::string m_testPathOrURL;
63     
64     RetainPtr<CFRunLoopTimerRef> m_waitToDumpWatchdog;
65
66     static JSClassRef getJSClass();
67     static JSStaticValue* staticValues();
68     static JSStaticFunction* staticFunctions();
69 };
70
71 } // namespace WTR
72
73 #endif // LayoutTestController_h