1 /*
2  * Copyright (C) 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 InspectorRuntimeAgent_h
32 #define InspectorRuntimeAgent_h
33 
34 #if ENABLE(INSPECTOR)
35 
36 #include "ScriptState.h"
37 #include <wtf/Forward.h>
38 #include <wtf/Noncopyable.h>
39 
40 namespace WebCore {
41 
42 class InjectedScriptManager;
43 class InspectorArray;
44 class InspectorObject;
45 class InspectorValue;
46 
47 typedef String ErrorString;
48 
49 class InspectorRuntimeAgent {
50     WTF_MAKE_NONCOPYABLE(InspectorRuntimeAgent);
51 public:
52     virtual ~InspectorRuntimeAgent();
53 
54     // Part of the protocol.
55     void evaluate(ErrorString*, const String& expression, const String* const objectGroup, const bool* const includeCommandLineAPI, RefPtr<InspectorObject>* result, bool* wasThrown);
56     void evaluateOn(ErrorString*, const String& objectId, const String& expression, RefPtr<InspectorObject>* result, bool* wasThrown);
57     void releaseObject(ErrorString*, const String& objectId);
58     void getProperties(ErrorString*, const String& objectId, bool ignoreHasOwnProperty, RefPtr<InspectorArray>* result);
59     void setPropertyValue(ErrorString*, const String& objectId, const String& propertyName, const String& expression);
60     void releaseObjectGroup(ErrorString*, const String& objectGroup);
61 
62 protected:
63     explicit InspectorRuntimeAgent(InjectedScriptManager*);
64     virtual ScriptState* getDefaultInspectedState() = 0;
65 
66 private:
67     InjectedScriptManager* m_injectedScriptManager;
68 };
69 
70 } // namespace WebCore
71 
72 #endif // ENABLE(INSPECTOR)
73 #endif // InspectorRuntimeAgent_h
74