70b8c677a534f597fbd6e3b0146960eeca1f6815
[WebKit-https.git] / Source / WebCore / inspector / InjectedScript.h
1 /*
2  * Copyright (C) 2010, 2011 Google Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef InjectedScript_h
32 #define InjectedScript_h
33
34 #include "InjectedScriptManager.h"
35 #include "ScriptObject.h"
36 #include <wtf/Forward.h>
37 #include <wtf/Noncopyable.h>
38 #include <wtf/PassRefPtr.h>
39 #include <wtf/RefPtr.h>
40
41 namespace WebCore {
42
43 class InspectorArray;
44 class InspectorObject;
45 class InspectorValue;
46 class Node;
47 class ScriptFunctionCall;
48
49 typedef String ErrorString;
50
51 class InjectedScript {
52 public:
53     InjectedScript();
54     ~InjectedScript() { }
55
56     bool hasNoValue() const { return m_injectedScriptObject.hasNoValue(); }
57
58     void evaluate(ErrorString*, const String& expression, const String& objectGroup, bool includeCommandLineAPI, RefPtr<InspectorObject>* result, bool* wasThrown);
59     void callFunctionOn(ErrorString*, const String& objectId, const String& expression, const String& arguments, RefPtr<InspectorObject>* result, bool* wasThrown);
60     void evaluateOnCallFrame(ErrorString*, const ScriptValue& callFrames, const String& callFrameId, const String& expression, const String& objectGroup, bool includeCommandLineAPI, RefPtr<InspectorObject>* result, bool* wasThrown);
61     void getProperties(ErrorString*, const String& objectId, bool ignoreHasOwnProperty, RefPtr<InspectorArray>* result);
62     Node* nodeForObjectId(const String& objectId);
63     void releaseObject(const String& objectId);
64
65 #if ENABLE(JAVASCRIPT_DEBUGGER)
66     PassRefPtr<InspectorArray> wrapCallFrames(const ScriptValue&);
67 #endif
68
69     PassRefPtr<InspectorObject> wrapObject(ScriptValue, const String& groupName);
70     PassRefPtr<InspectorObject> wrapNode(Node*, const String& groupName);
71     void inspectNode(Node*);
72     void releaseObjectGroup(const String&);
73     ScriptState* scriptState() const { return m_injectedScriptObject.scriptState(); }
74
75 private:
76     friend InjectedScript InjectedScriptManager::injectedScriptFor(ScriptState*);
77     typedef bool (*InspectedStateAccessCheck)(ScriptState*);
78     InjectedScript(ScriptObject, InspectedStateAccessCheck);
79
80     bool canAccessInspectedWindow();
81     void makeCall(ScriptFunctionCall&, RefPtr<InspectorValue>* result);
82     void makeEvalCall(ErrorString*, ScriptFunctionCall&, RefPtr<InspectorObject>* result, bool* wasThrown);
83     ScriptValue nodeAsScriptValue(Node*);
84
85     ScriptObject m_injectedScriptObject;
86     InspectedStateAccessCheck m_inspectedStateAccessCheck;
87 };
88
89 } // namespace WebCore
90
91 #endif