blob: a170e798dc92dfa7dd12f53e13eab0a52369bfec [file] [log] [blame]
commit-queue@webkit.orgce890e92012-06-20 18:28:05 +00001/*
joepeck@webkit.org69a4eaf2014-01-09 19:00:48 +00002 * Copyright (C) 2013 Apple Inc. All rights reserved.
commit-queue@webkit.orgce890e92012-06-20 18:28:05 +00003 * 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"
weinig@apple.com3f5ab022012-09-06 17:36:48 +000036#include <wtf/text/WTFString.h>
commit-queue@webkit.orgce890e92012-06-20 18:28:05 +000037
joepeck@webkit.org4d65fae2013-12-20 22:04:28 +000038#if ENABLE(INSPECTOR)
39
joepeck@webkit.orgb7b8b6b2013-12-21 00:44:36 +000040namespace JSC {
41class JSValue;
42}
43
joepeck@webkit.org69a4eaf2014-01-09 19:00:48 +000044namespace Inspector {
commit-queue@webkit.orgce890e92012-06-20 18:28:05 +000045
joepeck@webkit.org69a4eaf2014-01-09 19:00:48 +000046class InjectedScript;
commit-queue@webkit.orgce890e92012-06-20 18:28:05 +000047class InjectedScriptManager;
48
joepeck@webkit.org69a4eaf2014-01-09 19:00:48 +000049class JS_EXPORT_PRIVATE InjectedScriptModule : public InjectedScriptBase {
commit-queue@webkit.orgce890e92012-06-20 18:28:05 +000050public:
joepeck@webkit.org69a4eaf2014-01-09 19:00:48 +000051 virtual ~InjectedScriptModule();
commit-queue@webkit.orgce890e92012-06-20 18:28:05 +000052 virtual String source() const = 0;
joepeck@webkit.orgb7b8b6b2013-12-21 00:44:36 +000053 virtual JSC::JSValue host(InjectedScriptManager*, JSC::ExecState*) const = 0;
joepeck@webkit.org4d65fae2013-12-20 22:04:28 +000054 virtual bool returnsObject() const = 0;
commit-queue@webkit.orgce890e92012-06-20 18:28:05 +000055
56protected:
57 // Do not expose constructor in the child classes as well. Instead provide
58 // a static factory method that would create a new instance of the class
59 // and call its ensureInjected() method immediately.
60 InjectedScriptModule(const String& name);
weinig@apple.com4da3e8d2013-09-14 01:30:06 +000061 void ensureInjected(InjectedScriptManager*, JSC::ExecState*);
joepeck@webkit.org4d65fae2013-12-20 22:04:28 +000062 void ensureInjected(InjectedScriptManager*, InjectedScript);
commit-queue@webkit.orgce890e92012-06-20 18:28:05 +000063};
64
joepeck@webkit.org69a4eaf2014-01-09 19:00:48 +000065} // namespace Inspector
commit-queue@webkit.orgce890e92012-06-20 18:28:05 +000066
joepeck@webkit.org4d65fae2013-12-20 22:04:28 +000067#endif // ENABLE(INSPECTOR)
68
joepeck@webkit.org69a4eaf2014-01-09 19:00:48 +000069#endif // InjectedScriptModule_h