Web Inspector: We should have a way to capture heap snapshots programatically.
[WebKit-https.git] / Source / JavaScriptCore / inspector / JSGlobalObjectConsoleClient.cpp
1 /*
2  * Copyright (C) 2014 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  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27 #include "JSGlobalObjectConsoleClient.h"
28
29 #include "ConsoleMessage.h"
30 #include "InspectorConsoleAgent.h"
31 #include "ScriptArguments.h"
32 #include "ScriptCallStack.h"
33 #include "ScriptCallStackFactory.h"
34
35 using namespace JSC;
36
37 namespace Inspector {
38
39 #if !LOG_DISABLED
40 static bool sLogToSystemConsole = true;
41 #else
42 static bool sLogToSystemConsole = false;
43 #endif
44
45 bool JSGlobalObjectConsoleClient::logToSystemConsole()
46 {
47     return sLogToSystemConsole;
48 }
49
50 void JSGlobalObjectConsoleClient::setLogToSystemConsole(bool shouldLog)
51 {
52     sLogToSystemConsole = shouldLog;
53 }
54
55 JSGlobalObjectConsoleClient::JSGlobalObjectConsoleClient(InspectorConsoleAgent* consoleAgent)
56     : ConsoleClient()
57     , m_consoleAgent(consoleAgent)
58 {
59 }
60
61 void JSGlobalObjectConsoleClient::messageWithTypeAndLevel(MessageType type, MessageLevel level, JSC::ExecState* exec, RefPtr<ScriptArguments>&& arguments)
62 {
63     if (JSGlobalObjectConsoleClient::logToSystemConsole())
64         ConsoleClient::printConsoleMessageWithArguments(MessageSource::ConsoleAPI, type, level, exec, arguments.copyRef());
65
66     String message;
67     arguments->getFirstArgumentAsString(message);
68     m_consoleAgent->addMessageToConsole(std::make_unique<ConsoleMessage>(MessageSource::ConsoleAPI, type, level, message, WTFMove(arguments), exec));
69 }
70
71 void JSGlobalObjectConsoleClient::count(ExecState* exec, RefPtr<ScriptArguments>&& arguments)
72 {
73     m_consoleAgent->count(exec, arguments);
74 }
75
76 void JSGlobalObjectConsoleClient::profile(JSC::ExecState*, const String&)
77 {
78     // FIXME: support |console.profile| for JSContexts. <https://webkit.org/b/136466>
79 }
80
81 void JSGlobalObjectConsoleClient::profileEnd(JSC::ExecState*, const String&)
82 {
83     // FIXME: support |console.profile| for JSContexts. <https://webkit.org/b/136466>
84 }
85
86 void JSGlobalObjectConsoleClient::takeHeapSnapshot(JSC::ExecState*, const String& title)
87 {
88     m_consoleAgent->takeHeapSnapshot(title);
89 }
90
91 void JSGlobalObjectConsoleClient::time(ExecState*, const String& title)
92 {
93     m_consoleAgent->startTiming(title);
94 }
95
96 void JSGlobalObjectConsoleClient::timeEnd(ExecState* exec, const String& title)
97 {
98     RefPtr<ScriptCallStack> callStack(createScriptCallStackForConsole(exec, 1));
99     m_consoleAgent->stopTiming(title, WTFMove(callStack));
100 }
101
102 void JSGlobalObjectConsoleClient::timeStamp(ExecState*, RefPtr<ScriptArguments>&&)
103 {
104     // FIXME: JSContext inspection needs a timeline.
105     warnUnimplemented(ASCIILiteral("console.timeStamp"));
106 }
107
108 void JSGlobalObjectConsoleClient::warnUnimplemented(const String& method)
109 {
110     String message = method + " is currently ignored in JavaScript context inspection.";
111     m_consoleAgent->addMessageToConsole(std::make_unique<ConsoleMessage>(MessageSource::ConsoleAPI, MessageType::Log, MessageLevel::Warning, message, nullptr, nullptr));
112 }
113
114 } // namespace Inspector