1cec7b3e5aa6c05c15ff99354005eba9e225c7a3
[WebKit-https.git] / Source / WebCore / bindings / js / PageScriptDebugServer.cpp
1 /*
2  * Copyright (c) 2011 Google Inc. All rights reserved.
3  * Copyright (C) 2013 Apple Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are
7  * met:
8  *
9  *     * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *     * Redistributions in binary form must reproduce the above
12  * copyright notice, this list of conditions and the following disclaimer
13  * in the documentation and/or other materials provided with the
14  * distribution.
15  *     * Neither the name of Google Inc. nor the names of its
16  * contributors may be used to endorse or promote products derived from
17  * this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31
32 #include "config.h"
33
34 #if ENABLE(JAVASCRIPT_DEBUGGER)
35
36 #include "PageScriptDebugServer.h"
37
38 #include "Document.h"
39 #include "EventLoop.h"
40 #include "FrameView.h"
41 #include "JSDOMWindowCustom.h"
42 #include "MainFrame.h"
43 #include "Page.h"
44 #include "PageGroup.h"
45 #include "PluginView.h"
46 #include "ScriptController.h"
47 #include "ScriptDebugListener.h"
48 #include "Widget.h"
49 #include <runtime/JSLock.h>
50 #include <wtf/MainThread.h>
51 #include <wtf/OwnPtr.h>
52 #include <wtf/PassOwnPtr.h>
53 #include <wtf/StdLibExtras.h>
54
55 #if PLATFORM(IOS)
56 #include "JSDOMWindowBase.h"
57 #include "WebCoreThreadInternal.h"
58 #endif
59
60 using namespace JSC;
61
62 namespace WebCore {
63
64 static Page* toPage(JSGlobalObject* globalObject)
65 {
66     ASSERT_ARG(globalObject, globalObject);
67
68     JSDOMWindow* window = asJSDOMWindow(globalObject);
69     Frame* frame = window->impl().frame();
70     return frame ? frame->page() : 0;
71 }
72
73 PageScriptDebugServer& PageScriptDebugServer::shared()
74 {
75     DEFINE_STATIC_LOCAL(PageScriptDebugServer, server, ());
76     return server;
77 }
78
79 PageScriptDebugServer::PageScriptDebugServer()
80     : ScriptDebugServer()
81     , m_pausedPage(0)
82 {
83 }
84
85 PageScriptDebugServer::~PageScriptDebugServer()
86 {
87 }
88
89 void PageScriptDebugServer::addListener(ScriptDebugListener* listener, Page* page)
90 {
91     ASSERT_ARG(listener, listener);
92     ASSERT_ARG(page, page);
93
94     OwnPtr<ListenerSet>& listeners = m_pageListenersMap.add(page, nullptr).iterator->value;
95     if (!listeners)
96         listeners = adoptPtr(new ListenerSet);
97     listeners->add(listener);
98
99     recompileAllJSFunctionsSoon();
100     page->setDebugger(this);
101 }
102
103 void PageScriptDebugServer::removeListener(ScriptDebugListener* listener, Page* page)
104 {
105     ASSERT_ARG(listener, listener);
106     ASSERT_ARG(page, page);
107
108     PageListenersMap::iterator it = m_pageListenersMap.find(page);
109     if (it == m_pageListenersMap.end())
110         return;
111
112     ListenerSet* listeners = it->value.get();
113     listeners->remove(listener);
114     if (listeners->isEmpty()) {
115         m_pageListenersMap.remove(it);
116         didRemoveLastListener(page);
117     }
118 }
119
120 void PageScriptDebugServer::recompileAllJSFunctions()
121 {
122     JSLockHolder lock(JSDOMWindow::commonVM());
123     // If JavaScript stack is not empty postpone recompilation.
124     if (JSDOMWindow::commonVM()->entryScope)
125         recompileAllJSFunctionsSoon();
126     else
127         Debugger::recompileAllJSFunctions(JSDOMWindow::commonVM());
128 }
129
130 ScriptDebugServer::ListenerSet* PageScriptDebugServer::getListenersForGlobalObject(JSGlobalObject* globalObject)
131 {
132     Page* page = toPage(globalObject);
133     if (!page)
134         return 0;
135     return m_pageListenersMap.get(page);
136 }
137
138 void PageScriptDebugServer::didPause(JSC::JSGlobalObject* globalObject)
139 {
140     ASSERT(!m_pausedPage);
141
142     Page* page = toPage(globalObject);
143     ASSERT(page);
144     if (!page)
145         return;
146
147     m_pausedPage = page;
148
149     setJavaScriptPaused(page->group(), true);
150 }
151
152 void PageScriptDebugServer::didContinue(JSC::JSGlobalObject* globalObject)
153 {
154     // Page can be null if we are continuing because the Page closed.
155     Page* page = toPage(globalObject);
156     ASSERT(!page || page == m_pausedPage);
157
158     m_pausedPage = 0;
159
160     if (page)
161         setJavaScriptPaused(page->group(), false);
162 }
163
164 void PageScriptDebugServer::didRemoveLastListener(Page* page)
165 {
166     ASSERT(page);
167
168     if (m_pausedPage == page)
169         m_doneProcessingDebuggerEvents = true;
170
171     recompileAllJSFunctionsSoon();
172     page->setDebugger(0);
173 }
174
175 void PageScriptDebugServer::runEventLoopWhilePaused()
176 {
177 #if PLATFORM(IOS)
178     // On iOS, running an EventLoop causes us to run a nested WebRunLoop.
179     // Since the WebThread is autoreleased at the end of run loop iterations
180     // we need to gracefully handle releasing and reacquiring the lock.
181     ASSERT(WebThreadIsLockedOrDisabled());
182     {
183         if (WebThreadIsEnabled())
184             JSC::JSLock::DropAllLocks dropAllLocks(WebCore::JSDOMWindowBase::commonVM(), JSC::JSLock::DropAllLocks::AlwaysDropLocks);
185         WebRunLoopEnableNested();
186 #endif
187
188     EventLoop loop;
189     while (!m_doneProcessingDebuggerEvents && !loop.ended())
190         loop.cycle();
191
192 #if PLATFORM(IOS)
193         WebRunLoopDisableNested();
194     }
195     ASSERT(WebThreadIsLockedOrDisabled());
196 #endif
197 }
198
199 void PageScriptDebugServer::setJavaScriptPaused(const PageGroup& pageGroup, bool paused)
200 {
201     setMainThreadCallbacksPaused(paused);
202
203     const HashSet<Page*>& pages = pageGroup.pages();
204
205     HashSet<Page*>::const_iterator end = pages.end();
206     for (HashSet<Page*>::const_iterator it = pages.begin(); it != end; ++it)
207         setJavaScriptPaused(*it, paused);
208 }
209
210 void PageScriptDebugServer::setJavaScriptPaused(Page* page, bool paused)
211 {
212     ASSERT_ARG(page, page);
213
214     page->setDefersLoading(paused);
215
216     for (Frame* frame = &page->mainFrame(); frame; frame = frame->tree().traverseNext())
217         setJavaScriptPaused(frame, paused);
218 }
219
220 void PageScriptDebugServer::setJavaScriptPaused(Frame* frame, bool paused)
221 {
222     ASSERT_ARG(frame, frame);
223
224     if (!frame->script().canExecuteScripts(NotAboutToExecuteScript))
225         return;
226
227     frame->script().setPaused(paused);
228
229     Document* document = frame->document();
230     if (paused) {
231         document->suspendScriptedAnimationControllerCallbacks();
232         document->suspendActiveDOMObjects(ActiveDOMObject::JavaScriptDebuggerPaused);
233     } else {
234         document->resumeActiveDOMObjects(ActiveDOMObject::JavaScriptDebuggerPaused);
235         document->resumeScriptedAnimationControllerCallbacks();
236     }
237
238     setJavaScriptPaused(frame->view(), paused);
239 }
240
241 void PageScriptDebugServer::setJavaScriptPaused(FrameView* view, bool paused)
242 {
243     if (!view)
244         return;
245
246     for (auto it = view->children().begin(), end = view->children().end(); it != end; ++it) {
247         Widget* widget = (*it).get();
248         if (!widget->isPluginView())
249             continue;
250         toPluginView(widget)->setJavaScriptPaused(paused);
251     }
252 }
253
254 } // namespace WebCore
255
256 #endif // ENABLE(JAVASCRIPT_DEBUGGER)