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 #if ENABLE(INSPECTOR)
  36
  37 #include "InspectorEnvironment.h"
  38 #include "InspectorJSTypeBuilders.h"
  39 #include "bindings/ScriptObject.h"
  40 #include <wtf/Forward.h>
  41 #include <wtf/RefPtr.h>
  42
  43 namespace Deprecated {
  44 class ScriptFunctionCall;
  45 }
  46
  47 namespace Inspector {
  48
  49 typedef String ErrorString;
  50
  51 class JS_EXPORT_PRIVATE InjectedScriptBase {
  52 public:
  53     virtual ~InjectedScriptBase();
  54
  55     const String& name() const { return m_name; }
  56     bool hasNoValue() const { return m_injectedScriptObject.hasNoValue(); }
  57     JSC::ExecState* scriptState() const { return m_injectedScriptObject.scriptState(); }
  58
  59 protected:
  60     InjectedScriptBase(const String& name);
  61     InjectedScriptBase(const String& name, Deprecated::ScriptObject, InspectorEnvironment*);
  62
  63     InspectorEnvironment* inspectorEnvironment() const { return m_environment; }
  64
  65     void initialize(Deprecated::ScriptObject, InspectorEnvironment*);
  66     bool hasAccessToInspectedScriptState() const;
  67
  68     const Deprecated::ScriptObject& injectedScriptObject() const;
  69     Deprecated::ScriptValue callFunctionWithEvalEnabled(Deprecated::ScriptFunctionCall&, bool& hadException) const;
  70     void makeCall(Deprecated::ScriptFunctionCall&, RefPtr<InspectorValue>* result);
  71     void makeEvalCall(ErrorString*, Deprecated::ScriptFunctionCall&, RefPtr<TypeBuilder::Runtime::RemoteObject>* result, TypeBuilder::OptOutput<bool>* wasThrown);
  72
  73 private:
  74     String m_name;
  75     Deprecated::ScriptObject m_injectedScriptObject;
  76     InspectorEnvironment* m_environment;
  77 };
  78
  79 } // namespace Inspector
  80
  81 #endif // ENABLE(INSPECTOR)
  82
  83 #endif // InjectedScriptBase_h