1/*
2 * Copyright (C) 2012 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#ifndef InjectedScript_h
32#define InjectedScript_h
33
34#include "bindings/core/v8/ScriptValue.h"
35#include "core/InspectorTypeBuilder.h"
36#include "core/inspector/InjectedScriptBase.h"
37#include "core/inspector/InjectedScriptManager.h"
38#include "core/inspector/ScriptArguments.h"
39#include "wtf/Forward.h"
40#include "wtf/Vector.h"
41
42namespace blink {
43
44class InjectedScriptModule;
45class Node;
46class SerializedScriptValue;
47
48class InjectedScript FINAL : public InjectedScriptBase {
49public:
50    InjectedScript();
51    virtual ~InjectedScript() { }
52
53    void evaluate(
54        ErrorString*,
55        const String& expression,
56        const String& objectGroup,
57        bool includeCommandLineAPI,
58        bool returnByValue,
59        bool generatePreview,
60        RefPtr<TypeBuilder::Runtime::RemoteObject>* result,
61        TypeBuilder::OptOutput<bool>* wasThrown,
62        RefPtr<TypeBuilder::Debugger::ExceptionDetails>*);
63    void callFunctionOn(
64        ErrorString*,
65        const String& objectId,
66        const String& expression,
67        const String& arguments,
68        bool returnByValue,
69        bool generatePreview,
70        RefPtr<TypeBuilder::Runtime::RemoteObject>* result,
71        TypeBuilder::OptOutput<bool>* wasThrown);
72    void evaluateOnCallFrame(
73        ErrorString*,
74        const ScriptValue& callFrames,
75        const Vector<ScriptValue>& asyncCallStacks,
76        const String& callFrameId,
77        const String& expression,
78        const String& objectGroup,
79        bool includeCommandLineAPI,
80        bool returnByValue,
81        bool generatePreview,
82        RefPtr<TypeBuilder::Runtime::RemoteObject>* result,
83        TypeBuilder::OptOutput<bool>* wasThrown,
84        RefPtr<TypeBuilder::Debugger::ExceptionDetails>*);
85    void restartFrame(ErrorString*, const ScriptValue& callFrames, const String& callFrameId, RefPtr<JSONObject>* result);
86    void getStepInPositions(ErrorString*, const ScriptValue& callFrames, const String& callFrameId, RefPtr<TypeBuilder::Array<TypeBuilder::Debugger::Location> >& positions);
87    void setVariableValue(ErrorString*, const ScriptValue& callFrames, const String* callFrameIdOpt, const String* functionObjectIdOpt, int scopeNumber, const String& variableName, const String& newValueStr);
88    void getFunctionDetails(ErrorString*, const String& functionId, RefPtr<TypeBuilder::Debugger::FunctionDetails>* result);
89    void getCollectionEntries(ErrorString*, const String& objectId, RefPtr<TypeBuilder::Array<TypeBuilder::Debugger::CollectionEntry> >* result);
90    void getProperties(ErrorString*, const String& objectId, bool ownProperties, bool accessorPropertiesOnly, RefPtr<TypeBuilder::Array<TypeBuilder::Runtime::PropertyDescriptor> >* result);
91    void getInternalProperties(ErrorString*, const String& objectId, RefPtr<TypeBuilder::Array<TypeBuilder::Runtime::InternalPropertyDescriptor> >* result);
92    Node* nodeForObjectId(const String& objectId);
93    void releaseObject(const String& objectId);
94
95    PassRefPtr<TypeBuilder::Array<TypeBuilder::Debugger::CallFrame> > wrapCallFrames(const ScriptValue&, int asyncOrdinal);
96
97    PassRefPtr<TypeBuilder::Runtime::RemoteObject> wrapObject(const ScriptValue&, const String& groupName, bool generatePreview = false) const;
98    PassRefPtr<TypeBuilder::Runtime::RemoteObject> wrapTable(const ScriptValue& table, const ScriptValue& columns) const;
99    PassRefPtr<TypeBuilder::Runtime::RemoteObject> wrapNode(Node*, const String& groupName);
100    ScriptValue findObjectById(const String& objectId) const;
101
102    void inspectNode(Node*);
103    void releaseObjectGroup(const String&);
104
105private:
106    friend class InjectedScriptModule;
107    friend InjectedScript InjectedScriptManager::injectedScriptFor(ScriptState*);
108    InjectedScript(ScriptValue, InspectedStateAccessCheck);
109
110    ScriptValue nodeAsScriptValue(Node*);
111};
112
113
114} // namespace blink
115
116#endif
117