Home | History | Annotate | Download | only in inspector 
      1 /*
      2  * Copyright (C) 2011 Google 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 are
      6  * met:
      7  *
      8  *     * Redistributions of source code must retain the above copyright
      9  * notice, this list of conditions and the following disclaimer.
     10  *     * Redistributions in binary form must reproduce the above
     11  * copyright notice, this list of conditions and the following disclaimer
     12  * in the documentation and/or other materials provided with the
     13  * distribution.
     14  *     * Neither the name of Google Inc. nor the names of its
     15  * contributors may be used to endorse or promote products derived from
     16  * this software without specific prior written permission.
     17  *
     18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
     21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
     24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     29  */
     30 
     31 #ifndef InspectorController_h
     32 #define InspectorController_h
     33 
     34 #include "PlatformString.h"
     35 #include <wtf/Forward.h>
     36 #include <wtf/Noncopyable.h>
     37 #include <wtf/Vector.h>
     38 
     39 namespace WebCore {
     40 
     41 class DOMWrapperWorld;
     42 class Frame;
     43 class GraphicsContext;
     44 class InjectedScriptManager;
     45 class InspectorAgent;
     46 class InspectorBackendDispatcher;
     47 class InspectorClient;
     48 class InspectorFrontend;
     49 class InspectorFrontendClient;
     50 class Page;
     51 class PostWorkerNotificationToFrontendTask;
     52 class Node;
     53 
     54 class InspectorController {
     55     WTF_MAKE_NONCOPYABLE(InspectorController);
     56     WTF_MAKE_FAST_ALLOCATED;
     57 public:
     58     InspectorController(Page*, InspectorClient*);
     59     ~InspectorController();
     60 
     61     bool enabled() const;
     62     Page* inspectedPage() const;
     63 
     64     void show();
     65     void close();
     66 
     67     void setInspectorFrontendClient(PassOwnPtr<InspectorFrontendClient>);
     68     bool hasInspectorFrontendClient() const;
     69     void didClearWindowObjectInWorld(Frame*, DOMWrapperWorld*);
     70     void setInspectorExtensionAPI(const String& source);
     71 
     72     void dispatchMessageFromFrontend(const String& message);
     73 
     74     bool hasFrontend() const { return m_inspectorFrontend; }
     75     void connectFrontend();
     76     void disconnectFrontend();
     77     void restoreInspectorStateFromCookie(const String& inspectorCookie);
     78 
     79     void showConsole();
     80     void inspect(Node*);
     81     void drawNodeHighlight(GraphicsContext&) const;
     82     void hideHighlight();
     83     Node* highlightedNode() const;
     84 
     85     void evaluateForTestInFrontend(long callId, const String& script);
     86 
     87     void startTimelineProfiler();
     88     void stopTimelineProfiler();
     89     bool timelineProfilerEnabled();
     90 
     91 #if ENABLE(JAVASCRIPT_DEBUGGER)
     92     bool profilerEnabled();
     93     void enableProfiler();
     94     void startUserInitiatedProfiling();
     95     bool isRecordingUserInitiatedProfile() const;
     96     void stopUserInitiatedProfiling();
     97     void disableProfiler();
     98     void showAndEnableDebugger();
     99     bool debuggerEnabled();
    100     void disableDebugger();
    101     void resume();
    102 #endif
    103 
    104 private:
    105     friend class PostWorkerNotificationToFrontendTask;
    106 
    107     OwnPtr<InjectedScriptManager> m_injectedScriptManager;
    108     OwnPtr<InspectorAgent> m_inspectorAgent;
    109     RefPtr<InspectorBackendDispatcher> m_inspectorBackendDispatcher;
    110     OwnPtr<InspectorFrontendClient> m_inspectorFrontendClient;
    111     OwnPtr<InspectorFrontend> m_inspectorFrontend;
    112     InspectorClient* m_inspectorClient;
    113     bool m_openingFrontend;
    114     bool m_startUserInitiatedDebuggingWhenFrontedIsConnected;
    115 };
    116 
    117 }
    118 
    119 #endif // !defined(InspectorController_h)
    120