JavaScriptCore files should not be included relatively
[WebKit-https.git] / Source / JavaScriptCore / 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 #pragma once
33
34 #include "InspectorEnvironment.h"
35 #include "InspectorProtocolObjects.h"
36 #include "ScriptObject.h"
37 #include <wtf/Forward.h>
38 #include <wtf/RefPtr.h>
39
40 namespace Deprecated {
41 class ScriptFunctionCall;
42 }
43
44 namespace Inspector {
45
46 typedef String ErrorString;
47
48 class JS_EXPORT_PRIVATE InjectedScriptBase {
49 public:
50     virtual ~InjectedScriptBase();
51
52     const String& name() const { return m_name; }
53     bool hasNoValue() const { return m_injectedScriptObject.hasNoValue(); }
54     JSC::ExecState* scriptState() const { return m_injectedScriptObject.scriptState(); }
55
56 protected:
57     InjectedScriptBase(const String& name);
58     InjectedScriptBase(const String& name, Deprecated::ScriptObject, InspectorEnvironment*);
59
60     InspectorEnvironment* inspectorEnvironment() const { return m_environment; }
61
62     bool hasAccessToInspectedScriptState() const;
63
64     const Deprecated::ScriptObject& injectedScriptObject() const;
65     JSC::JSValue callFunctionWithEvalEnabled(Deprecated::ScriptFunctionCall&, bool& hadException) const;
66     Ref<JSON::Value> makeCall(Deprecated::ScriptFunctionCall&);
67     void makeEvalCall(ErrorString&, Deprecated::ScriptFunctionCall&, RefPtr<Protocol::Runtime::RemoteObject>& resultObject, bool& wasThrown, std::optional<int>& savedResultIndex);
68
69 private:
70     String m_name;
71     Deprecated::ScriptObject m_injectedScriptObject;
72     InspectorEnvironment* m_environment { nullptr };
73 };
74
75 } // namespace Inspector