e30228e3074bf4434a7fe318614f08803d86c3e0
[WebKit-https.git] / Source / WebCore / inspector / InspectorController.h
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 InspectorAgent;
45 class InspectorBackendDispatcher;
46 class InspectorClient;
47 class InspectorFrontend;
48 class InspectorFrontendClient;
49 class Page;
50 class PostWorkerNotificationToFrontendTask;
51 class Node;
52
53 class InspectorController {
54     WTF_MAKE_NONCOPYABLE(InspectorController);
55     WTF_MAKE_FAST_ALLOCATED;
56 public:
57     static const char* const ConsolePanel;
58     static const char* const ElementsPanel;
59     static const char* const ProfilesPanel;
60     static const char* const ScriptsPanel;
61
62     InspectorController(Page*, InspectorClient*);
63     ~InspectorController();
64
65     Page* inspectedPage() { return m_inspectedPage; }
66
67     bool enabled() const;
68
69     void show();
70     void showPanel(const String& panel);
71     void close();
72
73     void setInspectorFrontendClient(PassOwnPtr<InspectorFrontendClient>);
74     bool hasInspectorFrontendClient() const;
75     void didClearWindowObjectInWorld(Frame*, DOMWrapperWorld*);
76     void setInspectorExtensionAPI(const String& source);
77     void dispatchMessageFromFrontend(const String& message);
78
79     bool hasFrontend() const { return m_inspectorFrontend; }
80     void connectFrontend();
81     void disconnectFrontend();
82     void restoreInspectorStateFromCookie(const String& inspectorCookie);
83
84     void inspect(Node*);
85     void drawNodeHighlight(GraphicsContext&) const;
86     void hideHighlight();
87
88     void evaluateForTestInFrontend(long callId, const String& script);
89
90     void startTimelineProfiler();
91     void stopTimelineProfiler();
92     bool timelineProfilerEnabled();
93
94 #if ENABLE(JAVASCRIPT_DEBUGGER)
95     bool profilerEnabled();
96     void enableProfiler();
97     void startUserInitiatedProfiling();
98     bool isRecordingUserInitiatedProfile() const;
99     void stopUserInitiatedProfiling();
100     void disableProfiler();
101     void showAndEnableDebugger();
102     bool debuggerEnabled();
103     void disableDebugger();
104     void resume();
105 #endif
106
107 private:
108     friend class InspectorAgent;
109     friend class PostWorkerNotificationToFrontendTask;
110
111     void disconnectFrontendImpl(); // used by InspectorAgent
112     void frontendLoaded();
113
114     OwnPtr<InspectorAgent> m_inspectorAgent;
115     OwnPtr<InspectorBackendDispatcher> m_inspectorBackendDispatcher;
116     OwnPtr<InspectorFrontendClient> m_inspectorFrontendClient;
117     OwnPtr<InspectorFrontend> m_inspectorFrontend;
118     Page* m_inspectedPage;
119     InspectorClient* m_inspectorClient;
120     bool m_openingFrontend;
121 };
122
123 }
124
125 #endif // !defined(InspectorController_h)