src/third_party/WebKit/Source/core/inspector/InspectorRuntimeAgent.h

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