1/*
2 * Copyright (C) 2011 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 InspectorRuntimeAgent_h
32#define InspectorRuntimeAgent_h
33
34#include "core/InspectorFrontend.h"
35#include "core/inspector/InspectorBaseAgent.h"
36#include "wtf/Forward.h"
37#include "wtf/Noncopyable.h"
38
39namespace blink {
40
41class InjectedScript;
42class InjectedScriptManager;
43class InstrumentingAgents;
44class JSONArray;
45class ScriptState;
46class ScriptDebugServer;
47
48typedef String ErrorString;
49
50class InspectorRuntimeAgent : public InspectorBaseAgent<InspectorRuntimeAgent>, public InspectorBackendDispatcher::RuntimeCommandHandler {
51    WTF_MAKE_NONCOPYABLE(InspectorRuntimeAgent);
52public:
53    virtual ~InspectorRuntimeAgent();
54    virtual void trace(Visitor*) OVERRIDE;
55
56    // Part of the protocol.
57    virtual void enable(ErrorString*) OVERRIDE;
58    virtual void disable(ErrorString*) OVERRIDE FINAL;
59    virtual void evaluate(ErrorString*,
60        const String& expression,
61        const String* objectGroup,
62        const bool* includeCommandLineAPI,
63        const bool* doNotPauseOnExceptionsAndMuteConsole,
64        const int* executionContextId,
65        const bool* returnByValue,
66        const bool* generatePreview,
67        RefPtr<TypeBuilder::Runtime::RemoteObject>& result,
68        TypeBuilder::OptOutput<bool>* wasThrown,
69        RefPtr<TypeBuilder::Debugger::ExceptionDetails>&) OVERRIDE FINAL;
70    virtual void callFunctionOn(ErrorString*,
71                        const String& objectId,
72                        const String& expression,
73                        const RefPtr<JSONArray>* optionalArguments,
74                        const bool* doNotPauseOnExceptionsAndMuteConsole,
75                        const bool* returnByValue,
76                        const bool* generatePreview,
77                        RefPtr<TypeBuilder::Runtime::RemoteObject>& result,
78                        TypeBuilder::OptOutput<bool>* wasThrown) OVERRIDE FINAL;
79    virtual void releaseObject(ErrorString*, const String& objectId) OVERRIDE FINAL;
80    virtual void getProperties(ErrorString*, const String& objectId, const bool* ownProperties, const bool* accessorPropertiesOnly, RefPtr<TypeBuilder::Array<TypeBuilder::Runtime::PropertyDescriptor> >& result, RefPtr<TypeBuilder::Array<TypeBuilder::Runtime::InternalPropertyDescriptor> >& internalProperties) OVERRIDE FINAL;
81    virtual void releaseObjectGroup(ErrorString*, const String& objectGroup) OVERRIDE FINAL;
82    virtual void run(ErrorString*) OVERRIDE;
83    virtual void isRunRequired(ErrorString*, bool* out_result) OVERRIDE;
84
85    virtual void setFrontend(InspectorFrontend*) OVERRIDE FINAL;
86    virtual void clearFrontend() OVERRIDE FINAL;
87    virtual void restore() OVERRIDE FINAL;
88
89protected:
90    InspectorRuntimeAgent(InjectedScriptManager*, ScriptDebugServer*);
91    virtual InjectedScript injectedScriptForEval(ErrorString*, const int* executionContextId) = 0;
92
93    virtual void muteConsole() = 0;
94    virtual void unmuteConsole() = 0;
95
96    InjectedScriptManager* injectedScriptManager() { return m_injectedScriptManager; }
97    void addExecutionContextToFrontend(ScriptState*, bool isPageContext, const String& origin, const String& frameId);
98
99    bool m_enabled;
100    InspectorFrontend::Runtime* m_frontend;
101
102    typedef HashMap<RefPtr<ScriptState>, int> ScriptStateToId;
103    ScriptStateToId m_scriptStateToId;
104
105private:
106    RawPtrWillBeMember<InjectedScriptManager> m_injectedScriptManager;
107    ScriptDebugServer* m_scriptDebugServer;
108};
109
110} // namespace blink
111
112#endif // InspectorRuntimeAgent_h
113