Web Inspector: Save Console Evaluations into Command Line variables $1-$99 ($n)
[WebKit-https.git] / Source / JavaScriptCore / inspector / InjectedScript.cpp
1 /*
2  * Copyright (C) 2013 Apple Inc. All rights reserved.
3  * Copyright (C) 2012 Google 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 #include "InjectedScript.h"
34
35 #include "InspectorValues.h"
36 #include "JSCInlines.h"
37 #include "ScriptFunctionCall.h"
38 #include "ScriptObject.h"
39 #include <wtf/text/WTFString.h>
40
41 using Inspector::Protocol::Array;
42
43 namespace Inspector {
44
45 InjectedScript::InjectedScript()
46     : InjectedScriptBase(ASCIILiteral("InjectedScript"))
47 {
48 }
49
50 InjectedScript::InjectedScript(Deprecated::ScriptObject injectedScriptObject, InspectorEnvironment* environment)
51     : InjectedScriptBase(ASCIILiteral("InjectedScript"), injectedScriptObject, environment)
52 {
53 }
54
55 InjectedScript::~InjectedScript()
56 {
57 }
58
59 void InjectedScript::evaluate(ErrorString& errorString, const String& expression, const String& objectGroup, bool includeCommandLineAPI, bool returnByValue, bool generatePreview, bool saveResult, RefPtr<Inspector::Protocol::Runtime::RemoteObject>* result, Inspector::Protocol::OptOutput<bool>* wasThrown, Inspector::Protocol::OptOutput<int>* savedResultIndex)
60 {
61     Deprecated::ScriptFunctionCall function(injectedScriptObject(), ASCIILiteral("evaluate"), inspectorEnvironment()->functionCallHandler());
62     function.appendArgument(expression);
63     function.appendArgument(objectGroup);
64     function.appendArgument(includeCommandLineAPI);
65     function.appendArgument(returnByValue);
66     function.appendArgument(generatePreview);
67     function.appendArgument(saveResult);
68     makeEvalCall(errorString, function, result, wasThrown, savedResultIndex);
69 }
70
71 void InjectedScript::callFunctionOn(ErrorString& errorString, const String& objectId, const String& expression, const String& arguments, bool returnByValue, bool generatePreview, RefPtr<Inspector::Protocol::Runtime::RemoteObject>* result, Inspector::Protocol::OptOutput<bool>* wasThrown)
72 {
73     Deprecated::ScriptFunctionCall function(injectedScriptObject(), ASCIILiteral("callFunctionOn"), inspectorEnvironment()->functionCallHandler());
74     function.appendArgument(objectId);
75     function.appendArgument(expression);
76     function.appendArgument(arguments);
77     function.appendArgument(returnByValue);
78     function.appendArgument(generatePreview);
79     makeEvalCall(errorString, function, result, wasThrown);
80 }
81
82 void InjectedScript::evaluateOnCallFrame(ErrorString& errorString, const Deprecated::ScriptValue& callFrames, const String& callFrameId, const String& expression, const String& objectGroup, bool includeCommandLineAPI, bool returnByValue, bool generatePreview, bool saveResult, RefPtr<Inspector::Protocol::Runtime::RemoteObject>* result, Inspector::Protocol::OptOutput<bool>* wasThrown, Inspector::Protocol::OptOutput<int>* savedResultIndex)
83 {
84     Deprecated::ScriptFunctionCall function(injectedScriptObject(), ASCIILiteral("evaluateOnCallFrame"), inspectorEnvironment()->functionCallHandler());
85     function.appendArgument(callFrames);
86     function.appendArgument(callFrameId);
87     function.appendArgument(expression);
88     function.appendArgument(objectGroup);
89     function.appendArgument(includeCommandLineAPI);
90     function.appendArgument(returnByValue);
91     function.appendArgument(generatePreview);
92     function.appendArgument(saveResult);
93     makeEvalCall(errorString, function, result, wasThrown, savedResultIndex);
94 }
95
96 void InjectedScript::getFunctionDetails(ErrorString& errorString, const String& functionId, RefPtr<Inspector::Protocol::Debugger::FunctionDetails>* result)
97 {
98     Deprecated::ScriptFunctionCall function(injectedScriptObject(), ASCIILiteral("getFunctionDetails"), inspectorEnvironment()->functionCallHandler());
99     function.appendArgument(functionId);
100
101     RefPtr<InspectorValue> resultValue;
102     makeCall(function, &resultValue);
103     if (!resultValue || resultValue->type() != InspectorValue::Type::Object) {
104         if (!resultValue->asString(errorString))
105             errorString = ASCIILiteral("Internal error");
106         return;
107     }
108
109     *result = BindingTraits<Inspector::Protocol::Debugger::FunctionDetails>::runtimeCast(WTF::move(resultValue));
110 }
111
112 void InjectedScript::getProperties(ErrorString& errorString, const String& objectId, bool ownProperties, bool generatePreview, RefPtr<Array<Inspector::Protocol::Runtime::PropertyDescriptor>>* properties)
113 {
114     Deprecated::ScriptFunctionCall function(injectedScriptObject(), ASCIILiteral("getProperties"), inspectorEnvironment()->functionCallHandler());
115     function.appendArgument(objectId);
116     function.appendArgument(ownProperties);
117     function.appendArgument(generatePreview);
118
119     RefPtr<InspectorValue> result;
120     makeCall(function, &result);
121     if (!result || result->type() != InspectorValue::Type::Array) {
122         errorString = ASCIILiteral("Internal error");
123         return;
124     }
125
126     *properties = BindingTraits<Array<Inspector::Protocol::Runtime::PropertyDescriptor>>::runtimeCast(WTF::move(result));
127 }
128
129 void InjectedScript::getDisplayableProperties(ErrorString& errorString, const String& objectId, bool generatePreview, RefPtr<Array<Inspector::Protocol::Runtime::PropertyDescriptor>>* properties)
130 {
131     Deprecated::ScriptFunctionCall function(injectedScriptObject(), ASCIILiteral("getDisplayableProperties"), inspectorEnvironment()->functionCallHandler());
132     function.appendArgument(objectId);
133     function.appendArgument(generatePreview);
134
135     RefPtr<InspectorValue> result;
136     makeCall(function, &result);
137     if (!result || result->type() != InspectorValue::Type::Array) {
138         errorString = ASCIILiteral("Internal error");
139         return;
140     }
141
142     *properties = BindingTraits<Array<Inspector::Protocol::Runtime::PropertyDescriptor>>::runtimeCast(WTF::move(result));
143 }
144
145 void InjectedScript::getInternalProperties(ErrorString& errorString, const String& objectId, bool generatePreview, RefPtr<Array<Inspector::Protocol::Runtime::InternalPropertyDescriptor>>* properties)
146 {
147     Deprecated::ScriptFunctionCall function(injectedScriptObject(), ASCIILiteral("getInternalProperties"), inspectorEnvironment()->functionCallHandler());
148     function.appendArgument(objectId);
149     function.appendArgument(generatePreview);
150
151     RefPtr<InspectorValue> result;
152     makeCall(function, &result);
153     if (!result || result->type() != InspectorValue::Type::Array) {
154         errorString = ASCIILiteral("Internal error");
155         return;
156     }
157
158     auto array = BindingTraits<Array<Inspector::Protocol::Runtime::InternalPropertyDescriptor>>::runtimeCast(WTF::move(result));
159     *properties = array->length() > 0 ? array : nullptr;
160 }
161
162 void InjectedScript::getCollectionEntries(ErrorString& errorString, const String& objectId, const String& objectGroup, int startIndex, int numberToFetch, RefPtr<Protocol::Array<Protocol::Runtime::CollectionEntry>>* entries)
163 {
164     Deprecated::ScriptFunctionCall function(injectedScriptObject(), ASCIILiteral("getCollectionEntries"), inspectorEnvironment()->functionCallHandler());
165     function.appendArgument(objectId);
166     function.appendArgument(objectGroup);
167     function.appendArgument(startIndex);
168     function.appendArgument(numberToFetch);
169
170     RefPtr<InspectorValue> result;
171     makeCall(function, &result);
172     if (!result || result->type() != InspectorValue::Type::Array) {
173         errorString = ASCIILiteral("Internal error");
174         return;
175     }
176
177     *entries = BindingTraits<Array<Protocol::Runtime::CollectionEntry>>::runtimeCast(WTF::move(result));
178 }
179
180 Ref<Array<Inspector::Protocol::Debugger::CallFrame>> InjectedScript::wrapCallFrames(const Deprecated::ScriptValue& callFrames)
181 {
182     ASSERT(!hasNoValue());
183     Deprecated::ScriptFunctionCall function(injectedScriptObject(), ASCIILiteral("wrapCallFrames"), inspectorEnvironment()->functionCallHandler());
184     function.appendArgument(callFrames);
185
186     bool hadException = false;
187     Deprecated::ScriptValue callFramesValue = callFunctionWithEvalEnabled(function, hadException);
188     ASSERT(!hadException);
189     RefPtr<InspectorValue> result = callFramesValue.toInspectorValue(scriptState());
190     if (result->type() == InspectorValue::Type::Array)
191         return BindingTraits<Array<Inspector::Protocol::Debugger::CallFrame>>::runtimeCast(WTF::move(result)).releaseNonNull();
192
193     return Array<Inspector::Protocol::Debugger::CallFrame>::create();
194 }
195
196 RefPtr<Inspector::Protocol::Runtime::RemoteObject> InjectedScript::wrapObject(const Deprecated::ScriptValue& value, const String& groupName, bool generatePreview) const
197 {
198     ASSERT(!hasNoValue());
199     Deprecated::ScriptFunctionCall wrapFunction(injectedScriptObject(), ASCIILiteral("wrapObject"), inspectorEnvironment()->functionCallHandler());
200     wrapFunction.appendArgument(value);
201     wrapFunction.appendArgument(groupName);
202     wrapFunction.appendArgument(hasAccessToInspectedScriptState());
203     wrapFunction.appendArgument(generatePreview);
204
205     bool hadException = false;
206     Deprecated::ScriptValue r = callFunctionWithEvalEnabled(wrapFunction, hadException);
207     if (hadException)
208         return nullptr;
209
210     RefPtr<InspectorObject> resultObject;
211     bool castSucceeded = r.toInspectorValue(scriptState())->asObject(resultObject);
212     ASSERT_UNUSED(castSucceeded, castSucceeded);
213
214     return BindingTraits<Inspector::Protocol::Runtime::RemoteObject>::runtimeCast(resultObject);
215 }
216
217 RefPtr<Inspector::Protocol::Runtime::RemoteObject> InjectedScript::wrapTable(const Deprecated::ScriptValue& table, const Deprecated::ScriptValue& columns) const
218 {
219     ASSERT(!hasNoValue());
220     Deprecated::ScriptFunctionCall wrapFunction(injectedScriptObject(), ASCIILiteral("wrapTable"), inspectorEnvironment()->functionCallHandler());
221     wrapFunction.appendArgument(hasAccessToInspectedScriptState());
222     wrapFunction.appendArgument(table);
223     if (columns.hasNoValue())
224         wrapFunction.appendArgument(false);
225     else
226         wrapFunction.appendArgument(columns);
227
228     bool hadException = false;
229     Deprecated::ScriptValue r = callFunctionWithEvalEnabled(wrapFunction, hadException);
230     if (hadException)
231         return nullptr;
232
233     RefPtr<InspectorObject> resultObject;
234     bool castSucceeded = r.toInspectorValue(scriptState())->asObject(resultObject);
235     ASSERT_UNUSED(castSucceeded, castSucceeded);
236
237     return BindingTraits<Inspector::Protocol::Runtime::RemoteObject>::runtimeCast(resultObject);
238 }
239
240 void InjectedScript::setExceptionValue(const Deprecated::ScriptValue& value)
241 {
242     ASSERT(!hasNoValue());
243     Deprecated::ScriptFunctionCall function(injectedScriptObject(), ASCIILiteral("setExceptionValue"), inspectorEnvironment()->functionCallHandler());
244     function.appendArgument(value);
245     RefPtr<InspectorValue> result;
246     makeCall(function, &result);
247 }
248
249 void InjectedScript::clearExceptionValue()
250 {
251     ASSERT(!hasNoValue());
252     Deprecated::ScriptFunctionCall function(injectedScriptObject(), ASCIILiteral("clearExceptionValue"), inspectorEnvironment()->functionCallHandler());
253     RefPtr<InspectorValue> result;
254     makeCall(function, &result);
255 }
256
257 Deprecated::ScriptValue InjectedScript::findObjectById(const String& objectId) const
258 {
259     ASSERT(!hasNoValue());
260     Deprecated::ScriptFunctionCall function(injectedScriptObject(), ASCIILiteral("findObjectById"), inspectorEnvironment()->functionCallHandler());
261     function.appendArgument(objectId);
262
263     bool hadException = false;
264     Deprecated::ScriptValue resultValue = callFunctionWithEvalEnabled(function, hadException);
265     ASSERT(!hadException);
266
267     return resultValue;
268 }
269
270 void InjectedScript::inspectObject(Deprecated::ScriptValue value)
271 {
272     ASSERT(!hasNoValue());
273     Deprecated::ScriptFunctionCall function(injectedScriptObject(), ASCIILiteral("inspectObject"), inspectorEnvironment()->functionCallHandler());
274     function.appendArgument(value);
275     RefPtr<InspectorValue> result;
276     makeCall(function, &result);
277 }
278
279 void InjectedScript::releaseObject(const String& objectId)
280 {
281     Deprecated::ScriptFunctionCall function(injectedScriptObject(), ASCIILiteral("releaseObject"), inspectorEnvironment()->functionCallHandler());
282     function.appendArgument(objectId);
283     RefPtr<InspectorValue> result;
284     makeCall(function, &result);
285 }
286
287 void InjectedScript::releaseObjectGroup(const String& objectGroup)
288 {
289     ASSERT(!hasNoValue());
290     Deprecated::ScriptFunctionCall releaseFunction(injectedScriptObject(), ASCIILiteral("releaseObjectGroup"), inspectorEnvironment()->functionCallHandler());
291     releaseFunction.appendArgument(objectGroup);
292
293     bool hadException = false;
294     callFunctionWithEvalEnabled(releaseFunction, hadException);
295     ASSERT(!hadException);
296 }
297
298 } // namespace Inspector
299