Part 2 of removing PlatformString.h, remove PlatformString.h
[WebKit-https.git] / Source / WebCore / inspector / InspectorFrontendClientLocal.cpp
1 /*
2  * Copyright (C) 2010 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 #include "config.h"
32
33 #if ENABLE(INSPECTOR)
34
35 #include "InspectorFrontendClientLocal.h"
36
37 #include "Chrome.h"
38 #include "Document.h"
39 #include "FloatRect.h"
40 #include "Frame.h"
41 #include "FrameLoadRequest.h"
42 #include "FrameLoader.h"
43 #include "FrameView.h"
44 #include "InspectorBackendDispatcher.h"
45 #include "InspectorController.h"
46 #include "InspectorFrontendHost.h"
47 #include "InspectorPageAgent.h"
48 #include "Page.h"
49 #include "ScriptFunctionCall.h"
50 #include "ScriptObject.h"
51 #include "ScriptState.h"
52 #include "Settings.h"
53 #include "Timer.h"
54 #include "UserGestureIndicator.h"
55 #include "WindowFeatures.h"
56 #include <wtf/Deque.h>
57 #include <wtf/text/CString.h>
58 #include <wtf/text/WTFString.h>
59
60 namespace WebCore {
61
62 static const char* inspectorAttachedHeightSetting = "inspectorAttachedHeight";
63 static const unsigned defaultAttachedHeight = 300;
64 static const float minimumAttachedHeight = 250.0f;
65 static const float maximumAttachedHeightRatio = 0.75f;
66
67 class InspectorBackendDispatchTask {
68 public:
69     InspectorBackendDispatchTask(InspectorController* inspectorController)
70         : m_inspectorController(inspectorController)
71         , m_timer(this, &InspectorBackendDispatchTask::onTimer)
72     {
73     }
74
75     void dispatch(const String& message)
76     {
77         m_messages.append(message);
78         if (!m_timer.isActive())
79             m_timer.startOneShot(0);
80     }
81
82     void reset()
83     {
84         m_messages.clear();
85         m_timer.stop();
86     }
87
88     void onTimer(Timer<InspectorBackendDispatchTask>*)
89     {
90         if (!m_messages.isEmpty()) {
91             // Dispatch can lead to the timer destruction -> schedule the next shot first.
92             m_timer.startOneShot(0);
93             m_inspectorController->dispatchMessageFromFrontend(m_messages.takeFirst());
94         }
95     }
96
97 private:
98     InspectorController* m_inspectorController;
99     Timer<InspectorBackendDispatchTask> m_timer;
100     Deque<String> m_messages;
101 };
102
103 String InspectorFrontendClientLocal::Settings::getProperty(const String&)
104 {
105     return String();
106 }
107
108 void InspectorFrontendClientLocal::Settings::setProperty(const String&, const String&)
109 {
110 }
111
112 InspectorFrontendClientLocal::InspectorFrontendClientLocal(InspectorController* inspectorController, Page* frontendPage, PassOwnPtr<Settings> settings)
113     : m_inspectorController(inspectorController)
114     , m_frontendPage(frontendPage)
115     , m_settings(settings)
116     , m_frontendLoaded(false)
117 {
118     m_frontendPage->settings()->setAllowFileAccessFromFileURLs(true);
119     m_dispatchTask = adoptPtr(new InspectorBackendDispatchTask(inspectorController));
120 }
121
122 InspectorFrontendClientLocal::~InspectorFrontendClientLocal()
123 {
124     if (m_frontendHost)
125         m_frontendHost->disconnectClient();
126     m_frontendPage = 0;
127     m_inspectorController = 0;
128 }
129
130 void InspectorFrontendClientLocal::windowObjectCleared()
131 {
132     if (m_frontendHost)
133         m_frontendHost->disconnectClient();
134     
135     ScriptState* frontendScriptState = scriptStateFromPage(debuggerWorld(), m_frontendPage);
136     m_frontendHost = InspectorFrontendHost::create(this, m_frontendPage);
137     ScriptGlobalObject::set(frontendScriptState, "InspectorFrontendHost", m_frontendHost.get());
138 }
139
140 void InspectorFrontendClientLocal::frontendLoaded()
141 {
142     bringToFront();
143     setDockingUnavailable(!canAttachWindow());
144     m_frontendLoaded = true;
145     for (Vector<String>::iterator it = m_evaluateOnLoad.begin(); it != m_evaluateOnLoad.end(); ++it)
146         evaluateOnLoad(*it);
147     m_evaluateOnLoad.clear();
148 }
149
150 void InspectorFrontendClientLocal::requestAttachWindow()
151 {
152     if (!canAttachWindow())
153         return;
154     attachWindow();
155     setAttachedWindow(true);
156 }
157
158 void InspectorFrontendClientLocal::requestDetachWindow()
159 {
160     detachWindow();
161     setAttachedWindow(false);
162 }
163
164 bool InspectorFrontendClientLocal::canAttachWindow()
165 {
166     // Don't allow the attach if the window would be too small to accommodate the minimum inspector height.
167     // Also don't allow attaching to another inspector -- two inspectors in one window is too much!
168     bool isInspectorPage = m_inspectorController->inspectedPage()->inspectorController()->hasInspectorFrontendClient();
169     unsigned inspectedPageHeight = m_inspectorController->inspectedPage()->mainFrame()->view()->visibleHeight();
170     unsigned maximumAttachedHeight = inspectedPageHeight * maximumAttachedHeightRatio;
171     return minimumAttachedHeight <= maximumAttachedHeight && !isInspectorPage;
172 }
173
174 void InspectorFrontendClientLocal::setDockingUnavailable(bool unavailable)
175 {
176     evaluateOnLoad(String::format("[\"setDockingUnavailable\", %s]", unavailable ? "true" : "false"));
177 }
178
179 void InspectorFrontendClientLocal::changeAttachedWindowHeight(unsigned height)
180 {
181     unsigned totalHeight = m_frontendPage->mainFrame()->view()->visibleHeight() + m_inspectorController->inspectedPage()->mainFrame()->view()->visibleHeight();
182     unsigned attachedHeight = constrainedAttachedWindowHeight(height, totalHeight);
183     m_settings->setProperty(inspectorAttachedHeightSetting, String::number(attachedHeight));
184     setAttachedWindowHeight(attachedHeight);
185 }
186
187 void InspectorFrontendClientLocal::openInNewTab(const String& url)
188 {
189     UserGestureIndicator indicator(DefinitelyProcessingUserGesture);
190     Page* page = m_inspectorController->inspectedPage();
191     Frame* mainFrame = page->mainFrame();
192     FrameLoadRequest request(mainFrame->document()->securityOrigin(), ResourceRequest(), "_blank");
193
194     bool created;
195     WindowFeatures windowFeatures;
196     Frame* frame = WebCore::createWindow(mainFrame, mainFrame, request, windowFeatures, created);
197     if (!frame)
198         return;
199
200     frame->loader()->setOpener(mainFrame);
201     frame->page()->setOpenedByDOM();
202
203     // FIXME: Why does one use mainFrame and the other frame?
204     frame->loader()->changeLocation(mainFrame->document()->securityOrigin(), frame->document()->completeURL(url), "", false, false);
205 }
206
207 void InspectorFrontendClientLocal::moveWindowBy(float x, float y)
208 {
209     FloatRect frameRect = m_frontendPage->chrome()->windowRect();
210     frameRect.move(x, y);
211     m_frontendPage->chrome()->setWindowRect(frameRect);
212 }
213
214 void InspectorFrontendClientLocal::setAttachedWindow(bool attached)
215 {
216     evaluateOnLoad(String::format("[\"setAttachedWindow\", %s]", attached ? "true" : "false"));
217 }
218
219 void InspectorFrontendClientLocal::restoreAttachedWindowHeight()
220 {
221     unsigned inspectedPageHeight = m_inspectorController->inspectedPage()->mainFrame()->view()->visibleHeight();
222     String value = m_settings->getProperty(inspectorAttachedHeightSetting);
223     unsigned preferredHeight = value.isEmpty() ? defaultAttachedHeight : value.toUInt();
224     
225     // This call might not go through (if the window starts out detached), but if the window is initially created attached,
226     // InspectorController::attachWindow is never called, so we need to make sure to set the attachedWindowHeight.
227     // FIXME: Clean up code so we only have to call setAttachedWindowHeight in InspectorController::attachWindow
228     setAttachedWindowHeight(constrainedAttachedWindowHeight(preferredHeight, inspectedPageHeight));
229 }
230
231 bool InspectorFrontendClientLocal::isDebuggingEnabled()
232 {
233     if (m_frontendLoaded)
234         return evaluateAsBoolean("[\"isDebuggingEnabled\"]");
235     return false;
236 }
237
238 void InspectorFrontendClientLocal::setDebuggingEnabled(bool enabled)
239 {
240     evaluateOnLoad(String::format("[\"setDebuggingEnabled\", %s]", enabled ? "true" : "false"));
241 }
242
243 bool InspectorFrontendClientLocal::isTimelineProfilingEnabled()
244 {
245     if (m_frontendLoaded)
246         return evaluateAsBoolean("[\"isTimelineProfilingEnabled\"]");
247     return false;
248 }
249
250 void InspectorFrontendClientLocal::setTimelineProfilingEnabled(bool enabled)
251 {
252     evaluateOnLoad(String::format("[\"setTimelineProfilingEnabled\", %s]", enabled ? "true" : "false"));
253 }
254
255 bool InspectorFrontendClientLocal::isProfilingJavaScript()
256 {
257     if (m_frontendLoaded)
258         return evaluateAsBoolean("[\"isProfilingJavaScript\"]");
259     return false;
260 }
261
262 void InspectorFrontendClientLocal::startProfilingJavaScript()
263 {
264     evaluateOnLoad("[\"startProfilingJavaScript\"]");
265 }
266
267 void InspectorFrontendClientLocal::stopProfilingJavaScript()
268 {
269     evaluateOnLoad("[\"stopProfilingJavaScript\"]");
270 }
271
272 void InspectorFrontendClientLocal::showConsole()
273 {
274     evaluateOnLoad("[\"showConsole\"]");
275 }
276
277 void InspectorFrontendClientLocal::showResources()
278 {
279     evaluateOnLoad("[\"showResources\"]");
280 }
281
282 void InspectorFrontendClientLocal::showMainResourceForFrame(Frame* frame)
283 {
284     String frameId = m_inspectorController->pageAgent()->frameId(frame);
285     evaluateOnLoad(String::format("[\"showMainResourceForFrame\", \"%s\"]", frameId.ascii().data()));
286 }
287
288 unsigned InspectorFrontendClientLocal::constrainedAttachedWindowHeight(unsigned preferredHeight, unsigned totalWindowHeight)
289 {
290     using namespace std;
291     return roundf(max(minimumAttachedHeight, min<float>(preferredHeight, totalWindowHeight * maximumAttachedHeightRatio)));
292 }
293
294 void InspectorFrontendClientLocal::sendMessageToBackend(const String& message)
295 {
296     m_dispatchTask->dispatch(message);
297 }
298
299 bool InspectorFrontendClientLocal::evaluateAsBoolean(const String& expression)
300 {
301     if (!m_frontendPage->mainFrame())
302         return false;
303     ScriptValue value = m_frontendPage->mainFrame()->script()->executeScript(expression);
304     return value.toString(mainWorldScriptState(m_frontendPage->mainFrame())) == "true";
305 }
306
307 void InspectorFrontendClientLocal::evaluateOnLoad(const String& expression)
308 {
309     if (m_frontendLoaded)
310         m_frontendPage->mainFrame()->script()->executeScript("InspectorFrontendAPI.dispatch(" + expression + ")");
311     else
312         m_evaluateOnLoad.append(expression);
313 }
314
315 } // namespace WebCore
316
317 #endif