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

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