inspector/InjectedScriptBase.h

   1 /*
   2  * Copyright (C) 2013 Apple Inc. All rights reserved.
   3  * Copyright (C) 2012 Google Inc. All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are
   7  * met:
   8  *
   9  *     * Redistributions of source code must retain the above copyright
  10  * notice, this list of conditions and the following disclaimer.
  11  *     * Redistributions in binary form must reproduce the above
  12  * copyright notice, this list of conditions and the following disclaimer
  13  * in the documentation and/or other materials provided with the
  14  * distribution.
  15  *     * Neither the name of Google Inc. nor the names of its
  16  * contributors may be used to endorse or promote products derived from
  17  * this software without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  23  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30  */
  31
  32 #ifndef InjectedScriptBase_h
  33 #define InjectedScriptBase_h
  34
  35 #include "InspectorEnvironment.h"
  36 #include "InspectorProtocolObjects.h"
  37 #include "bindings/ScriptObject.h"
  38 #include <wtf/Forward.h>
  39 #include <wtf/RefPtr.h>
  40
  41 namespace Deprecated {
  42 class ScriptFunctionCall;
  43 }
  44
  45 namespace Inspector {
  46
  47 typedef String ErrorString;
  48
  49 class JS_EXPORT_PRIVATE InjectedScriptBase {
  50 public:
  51     virtual ~InjectedScriptBase();
  52
  53     const String& name() const { return m_name; }
  54     bool hasNoValue() const { return m_injectedScriptObject.hasNoValue(); }
  55     JSC::ExecState* scriptState() const { return m_injectedScriptObject.scriptState(); }
  56
  57 protected:
  58     InjectedScriptBase(const String& name);
  59     InjectedScriptBase(const String& name, Deprecated::ScriptObject, InspectorEnvironment*);
  60
  61     InspectorEnvironment* inspectorEnvironment() const { return m_environment; }
  62
  63     void initialize(Deprecated::ScriptObject, InspectorEnvironment*);
  64     bool hasAccessToInspectedScriptState() const;
  65
  66     const Deprecated::ScriptObject& injectedScriptObject() const;
  67     Deprecated::ScriptValue callFunctionWithEvalEnabled(Deprecated::ScriptFunctionCall&, bool& hadException) const;
  68     void makeCall(Deprecated::ScriptFunctionCall&, RefPtr<InspectorValue>* result);
  69     void makeEvalCall(ErrorString&, Deprecated::ScriptFunctionCall&, RefPtr<Protocol::Runtime::RemoteObject>* result, Protocol::OptOutput<bool>* wasThrown, Protocol::OptOutput<int>* savedResult = nullptr);
  70
  71 private:
  72     String m_name;
  73     Deprecated::ScriptObject m_injectedScriptObject;
  74     InspectorEnvironment* m_environment;
  75 };
  76
  77 } // namespace Inspector
  78
  79 #endif // InjectedScriptBase_h