inspector/InjectedScriptModule.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 InjectedScriptModule_h
  33 #define InjectedScriptModule_h
  34
  35 #include "InjectedScriptBase.h"
  36 #include <wtf/text/WTFString.h>
  37
  38 namespace JSC {
  39 class JSValue;
  40 }
  41
  42 namespace Inspector {
  43
  44 class InjectedScript;
  45 class InjectedScriptManager;
  46
  47 class JS_EXPORT_PRIVATE InjectedScriptModule : public InjectedScriptBase {
  48 public:
  49     virtual ~InjectedScriptModule();
  50     virtual String source() const = 0;
  51     virtual JSC::JSValue host(InjectedScriptManager*, JSC::ExecState*) const = 0;
  52     virtual bool returnsObject() const = 0;
  53
  54 protected:
  55     // Do not expose constructor in the child classes as well. Instead provide
  56     // a static factory method that would create a new instance of the class
  57     // and call its ensureInjected() method immediately.
  58     InjectedScriptModule(const String& name);
  59     void ensureInjected(InjectedScriptManager*, JSC::ExecState*);
  60     void ensureInjected(InjectedScriptManager*, InjectedScript);
  61 };
  62
  63 } // namespace Inspector
  64
  65 #endif // InjectedScriptModule_h