Source/WebCore/inspector/InjectedScript.h

   1 /*
   2  * Copyright (C) 2010, 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 InjectedScript_h
  32 #define InjectedScript_h
  33
  34 #include "InjectedScriptManager.h"
  35 #include "ScriptObject.h"
  36 #include <wtf/Forward.h>
  37 #include <wtf/Noncopyable.h>
  38 #include <wtf/PassRefPtr.h>
  39 #include <wtf/RefPtr.h>
  40
  41 namespace WebCore {
  42
  43 class InspectorArray;
  44 class InspectorObject;
  45 class InspectorValue;
  46 class Node;
  47 class ScriptFunctionCall;
  48
  49 typedef String ErrorString;
  50
  51 class InjectedScript {
  52 public:
  53     InjectedScript();
  54     ~InjectedScript() { }
  55
  56     bool hasNoValue() const { return m_injectedScriptObject.hasNoValue(); }
  57
  58     void evaluate(ErrorString*,
  59                   const String& expression,
  60                   const String& objectGroup,
  61                   bool includeCommandLineAPI,
  62                   bool returnByValue,
  63                   RefPtr<InspectorObject>* result,
  64                   bool* wasThrown);
  65     void callFunctionOn(ErrorString*,
  66                         const String& objectId,
  67                         const String& expression,
  68                         const String& arguments,
  69                         bool returnByValue,
  70                         RefPtr<InspectorObject>* result,
  71                         bool* wasThrown);
  72     void evaluateOnCallFrame(ErrorString*,
  73                              const ScriptValue& callFrames,
  74                              const String& callFrameId,
  75                              const String& expression,
  76                              const String& objectGroup,
  77                              bool includeCommandLineAPI,
  78                              bool returnByValue,
  79                              RefPtr<InspectorObject>* result,
  80                              bool* wasThrown);
  81     void getFunctionLocation(ErrorString*, const String& functionId, RefPtr<InspectorObject>* result);
  82     void getProperties(ErrorString*, const String& objectId, bool ownProperties, RefPtr<InspectorArray>* result);
  83     Node* nodeForObjectId(const String& objectId);
  84     void releaseObject(const String& objectId);
  85
  86 #if ENABLE(JAVASCRIPT_DEBUGGER)
  87     PassRefPtr<InspectorArray> wrapCallFrames(const ScriptValue&);
  88 #endif
  89
  90     PassRefPtr<InspectorObject> wrapObject(ScriptValue, const String& groupName);
  91     PassRefPtr<InspectorObject> wrapNode(Node*, const String& groupName);
  92     void inspectNode(Node*);
  93     void releaseObjectGroup(const String&);
  94     ScriptState* scriptState() const { return m_injectedScriptObject.scriptState(); }
  95
  96 private:
  97     friend InjectedScript InjectedScriptManager::injectedScriptFor(ScriptState*);
  98     typedef bool (*InspectedStateAccessCheck)(ScriptState*);
  99     InjectedScript(ScriptObject, InspectedStateAccessCheck);
 100
 101     bool canAccessInspectedWindow();
 102     void makeCall(ScriptFunctionCall&, RefPtr<InspectorValue>* result);
 103     void makeEvalCall(ErrorString*, ScriptFunctionCall&, RefPtr<InspectorObject>* result, bool* wasThrown);
 104     ScriptValue nodeAsScriptValue(Node*);
 105
 106     ScriptObject m_injectedScriptObject;
 107     InspectedStateAccessCheck m_inspectedStateAccessCheck;
 108 };
 109
 110 } // namespace WebCore
 111
 112 #endif