Web Inspector: JSContext inspection should report exceptions in the console
[WebKit-https.git] / Source / WebCore / page / Console.cpp
1 /*
2  * Copyright (C) 2007 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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #include "config.h"
30 #include "Console.h"
31
32 #include "Chrome.h"
33 #include "ChromeClient.h"
34 #include "Document.h"
35 #include "Frame.h"
36 #include "FrameLoader.h"
37 #include "FrameTree.h"
38 #include "InspectorConsoleInstrumentation.h"
39 #include "InspectorController.h"
40 #include "Page.h"
41 #include "PageConsole.h"
42 #include "PageGroup.h"
43 #include "ScriptProfile.h"
44 #include "ScriptProfiler.h"
45 #include "ScriptableDocumentParser.h"
46 #include "Settings.h"
47 #include <bindings/ScriptValue.h>
48 #include <inspector/ConsoleTypes.h>
49 #include <inspector/ScriptArguments.h>
50 #include <inspector/ScriptCallStack.h>
51 #include <inspector/ScriptCallStackFactory.h>
52 #include <stdio.h>
53 #include <wtf/text/CString.h>
54 #include <wtf/text/WTFString.h>
55
56 using namespace Inspector;
57
58 namespace WebCore {
59
60 Console::Console(Frame* frame)
61     : DOMWindowProperty(frame)
62 {
63 }
64
65 Console::~Console()
66 {
67 }
68
69 static void internalAddMessage(Page* page, MessageType type, MessageLevel level, JSC::ExecState* state, PassRefPtr<ScriptArguments> prpArguments, bool acceptNoArguments = false, bool printTrace = false)
70 {
71     RefPtr<ScriptArguments> arguments = prpArguments;
72
73     if (!page)
74         return;
75
76     if (!acceptNoArguments && !arguments->argumentCount())
77         return;
78
79     size_t stackSize = printTrace ? ScriptCallStack::maxCallStackSizeToCapture : 1;
80     RefPtr<ScriptCallStack> callStack(createScriptCallStackForConsole(state, stackSize));
81     const ScriptCallFrame& lastCaller = callStack->at(0);
82
83     String message;
84     bool gotMessage = arguments->getFirstArgumentAsString(message);
85     InspectorInstrumentation::addMessageToConsole(page, MessageSource::ConsoleAPI, type, level, message, state, arguments);
86
87     if (page->settings().privateBrowsingEnabled())
88         return;
89
90     if (gotMessage)
91         page->chrome().client().addMessageToConsole(MessageSource::ConsoleAPI, type, level, message, lastCaller.lineNumber(), lastCaller.columnNumber(), lastCaller.sourceURL());
92
93     if (!page->settings().logsPageMessagesToSystemConsoleEnabled() && !PageConsole::shouldPrintExceptions())
94         return;
95
96     PageConsole::printSourceURLAndPosition(lastCaller.sourceURL(), lastCaller.lineNumber());
97
98     printf(": ");
99
100     PageConsole::printMessageSourceAndLevelPrefix(MessageSource::ConsoleAPI, level, printTrace);
101
102     for (size_t i = 0; i < arguments->argumentCount(); ++i) {
103         String argAsString = arguments->argumentAt(i).toString(arguments->globalState());
104         printf(" %s", argAsString.utf8().data());
105     }
106
107     printf("\n");
108
109     if (!printTrace)
110         return;
111
112     for (size_t i = 0; i < callStack->size(); ++i) {
113         const ScriptCallFrame& callFrame = callStack->at(i);
114
115         String functionName = String(callFrame.functionName());
116         if (functionName.isEmpty())
117             functionName = ASCIILiteral("(unknown)");
118
119         printf("%lu: %s (", static_cast<unsigned long>(i), functionName.utf8().data());
120
121         PageConsole::printSourceURLAndPosition(callFrame.sourceURL(), callFrame.lineNumber());
122
123         printf(")\n");
124     }
125 }
126
127 void Console::debug(JSC::ExecState* state, PassRefPtr<ScriptArguments> arguments)
128 {
129     internalAddMessage(page(), MessageType::Log, MessageLevel::Debug, state, arguments);
130 }
131
132 void Console::error(JSC::ExecState* state, PassRefPtr<ScriptArguments> arguments)
133 {
134     internalAddMessage(page(), MessageType::Log, MessageLevel::Error, state, arguments);
135 }
136
137 void Console::info(JSC::ExecState* state, PassRefPtr<ScriptArguments> arguments)
138 {
139     log(state, arguments);
140 }
141
142 void Console::log(JSC::ExecState* state, PassRefPtr<ScriptArguments> arguments)
143 {
144     internalAddMessage(page(), MessageType::Log, MessageLevel::Log, state, arguments);
145 }
146
147 void Console::warn(JSC::ExecState* state, PassRefPtr<ScriptArguments> arguments)
148 {
149     internalAddMessage(page(), MessageType::Log, MessageLevel::Warning, state, arguments);
150 }
151
152 void Console::dir(JSC::ExecState* state, PassRefPtr<ScriptArguments> arguments)
153 {
154     internalAddMessage(page(), MessageType::Dir, MessageLevel::Log, state, arguments);
155 }
156
157 void Console::dirxml(JSC::ExecState* state, PassRefPtr<ScriptArguments> arguments)
158 {
159     internalAddMessage(page(), MessageType::DirXML, MessageLevel::Log, state, arguments);
160 }
161
162 void Console::table(JSC::ExecState* state, PassRefPtr<ScriptArguments> arguments)
163 {
164     internalAddMessage(page(), MessageType::Table, MessageLevel::Log, state, arguments);
165 }
166
167 void Console::clear(JSC::ExecState* state, PassRefPtr<ScriptArguments> arguments)
168 {
169     internalAddMessage(page(), MessageType::Clear, MessageLevel::Log, state, arguments, true);
170 }
171
172 void Console::trace(JSC::ExecState* state, PassRefPtr<ScriptArguments> arguments)
173 {
174     internalAddMessage(page(), MessageType::Trace, MessageLevel::Log, state, arguments, true, true);
175 }
176
177 void Console::assertCondition(JSC::ExecState* state, PassRefPtr<ScriptArguments> arguments, bool condition)
178 {
179     if (condition)
180         return;
181
182     internalAddMessage(page(), MessageType::Assert, MessageLevel::Error, state, arguments, true);
183 }
184
185 void Console::count(JSC::ExecState* state, PassRefPtr<ScriptArguments> arguments)
186 {
187     InspectorInstrumentation::consoleCount(page(), state, arguments);
188 }
189
190 void Console::profile(JSC::ExecState* state, const String& title)
191 {
192     Page* page = this->page();
193     if (!page)
194         return;
195
196     // FIXME: log a console message when profiling is disabled.
197     if (!InspectorInstrumentation::profilerEnabled(page))
198         return;
199
200     String resolvedTitle = title;
201     if (title.isNull()) // no title so give it the next user initiated profile title.
202         resolvedTitle = InspectorInstrumentation::getCurrentUserInitiatedProfileName(page, true);
203
204     ScriptProfiler::start(state, resolvedTitle);
205
206     RefPtr<ScriptCallStack> callStack(createScriptCallStackForConsole(state, 1));
207     const ScriptCallFrame& lastCaller = callStack->at(0);
208     InspectorInstrumentation::addStartProfilingMessageToConsole(page, resolvedTitle, lastCaller.lineNumber(), lastCaller.columnNumber(), lastCaller.sourceURL());
209 }
210
211 void Console::profileEnd(JSC::ExecState* state, const String& title)
212 {
213     Page* page = this->page();
214     if (!page)
215         return;
216
217     if (!InspectorInstrumentation::profilerEnabled(page))
218         return;
219
220     RefPtr<ScriptProfile> profile = ScriptProfiler::stop(state, title);
221     if (!profile)
222         return;
223
224     m_profiles.append(profile);
225     RefPtr<ScriptCallStack> callStack(createScriptCallStackForConsole(state, 1));
226     InspectorInstrumentation::addProfile(page, profile, callStack);
227 }
228
229 void Console::time(const String& title)
230 {
231     InspectorInstrumentation::startConsoleTiming(m_frame, title);
232 }
233
234 void Console::timeEnd(JSC::ExecState* state, const String& title)
235 {
236     RefPtr<ScriptCallStack> callStack(createScriptCallStackForConsole(state, 1));
237     InspectorInstrumentation::stopConsoleTiming(m_frame, title, callStack.release());
238 }
239
240 void Console::timeStamp(PassRefPtr<ScriptArguments> arguments)
241 {
242     InspectorInstrumentation::consoleTimeStamp(m_frame, arguments);
243 }
244
245 void Console::group(JSC::ExecState* state, PassRefPtr<ScriptArguments> arguments)
246 {
247     InspectorInstrumentation::addMessageToConsole(page(), MessageSource::ConsoleAPI, MessageType::StartGroup, MessageLevel::Log, String(), state, arguments);
248 }
249
250 void Console::groupCollapsed(JSC::ExecState* state, PassRefPtr<ScriptArguments> arguments)
251 {
252     InspectorInstrumentation::addMessageToConsole(page(), MessageSource::ConsoleAPI, MessageType::StartGroupCollapsed, MessageLevel::Log, String(), state, arguments);
253 }
254
255 void Console::groupEnd()
256 {
257     InspectorInstrumentation::addMessageToConsole(page(), MessageSource::ConsoleAPI, MessageType::EndGroup, MessageLevel::Log, String(), String(), 0, 0);
258 }
259
260 Page* Console::page() const
261 {
262     if (!m_frame)
263         return 0;
264     return m_frame->page();
265 }
266
267 } // namespace WebCore