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/JavaScriptCore.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(const std::string& testPathOrURL);

    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_dumpAsText = true; }

    49     void waitUntilDone();

    50     void notifyDone();

    51 

    52     // Other kinds of dumping.

    53     void dumpChildFrameScrollPositions() { m_shouldDumpAllFrameScrollPositions = true; }

    54     void dumpStatusCallbacks() { m_dumpStatusCallbacks = true; }

    55 

    56     // Repaint testing.

    57     void testRepaint() { m_testRepaint = true; }

    58     void repaintSweepHorizontally() { m_testRepaintSweepHorizontally = true; }

    59     void display();

    60 

    61     // Animation testing.

    62     unsigned numberOfActiveAnimations() const;

    63     bool pauseAnimationAtTimeOnElementWithId(JSStringRef animationName, double time, JSStringRef elementId);

    64 

    65     bool shouldDumpAllFrameScrollPositions() const { return m_shouldDumpAllFrameScrollPositions; }

    66     bool shouldDumpAsText() const { return m_dumpAsText; }

    67     bool shouldDumpDOMAsWebArchive() const;

    68     bool shouldDumpMainFrameScrollPosition() const;

    69     bool shouldDumpSourceAsWebArchive() const;

    70     bool shouldDumpStatusCallbacks() const { return m_dumpStatusCallbacks; }

    71 

    72     bool waitToDump() const { return m_waitToDump; }

    73     void waitToDumpWatchdogTimerFired();

    74     void invalidateWaitToDumpWatchdog();

    75 

    76 private:

    77     LayoutTestController(const std::string& testPathOrURL);

    78 

    79     bool m_dumpAsText;

    80     bool m_shouldDumpAllFrameScrollPositions;

    81     bool m_dumpStatusCallbacks;

    82     bool m_waitToDump; // True if waitUntilDone() has been called, but notifyDone() has not yet been called.

    83     bool m_testRepaint;

    84     bool m_testRepaintSweepHorizontally;

    85 

    86     std::string m_testPathOrURL;

    87     

    88     RetainPtr<CFRunLoopTimerRef> m_waitToDumpWatchdog;

    89 };

    90 

    91 } // namespace WTR

    92 

    93 #endif // LayoutTestController_h