2010-07-12 Ilya Tikhonovsky <loislo@chromium.org>
[WebKit-https.git] / WebCore / inspector / Inspector.idl
1 /*
2  * Copyright (C) 2007, 2008 Apple Inc. All rights reserved.
3  * Copyright (C) 2008 Matt Lilek <webkit@mattlilek.com>
4  * Copyright (C) 2009, 2010 Google Inc. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are
8  * met:
9  *
10  *     * Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  *     * Redistributions in binary form must reproduce the above
13  * copyright notice, this list of conditions and the following disclaimer
14  * in the documentation and/or other materials provided with the
15  * distribution.
16  *     * Neither the name of Google Inc. nor the names of its
17  * contributors may be used to endorse or promote products derived from
18  * this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32
33 module core {
34     interface [Conditional=INSPECTOR] Inspector {
35         [notify] void addRecordToTimeline(in Object record);
36         [notify] void addNodesToSearchResult(in Array nodeIds);
37         [notify] void attributesUpdated(in long id, in Array attributes);
38         [notify] void childNodeCountUpdated(in long id, in int newValue);
39         [notify] void childNodeInserted(in long parentId, in long prevId, in Object node);
40         [notify] void childNodeRemoved(in long parentId, in long id);
41         [notify] void setChildNodes(in long parentId, in Array nodes);
42         [notify] void setDetachedRoot(in Object root);
43         [notify] void setDocument(in Value root);
44
45         void storeLastActivePanel(in String panelName);
46
47         void saveApplicationSettings(in String settings);
48         void saveSessionSettings(in String settings);
49
50         void enableSearchingForNode();
51         void disableSearchingForNode();
52
53         void enableMonitoringXHR();
54         void disableMonitoringXHR();
55
56         void enableResourceTracking(in boolean always);
57         void disableResourceTracking(in boolean always);
58         void getResourceContent(in unsigned long identifier);
59         void reloadPage();
60
61         void startTimelineProfiler();
62         void stopTimelineProfiler();
63
64 #if defined(ENABLE_JAVASCRIPT_DEBUGGER) && ENABLE_JAVASCRIPT_DEBUGGER
65         void enableDebugger(in boolean always);
66         void disableDebugger(in boolean always);
67
68         void setBreakpoint(in String sourceID, in unsigned long lineNumber, in boolean enabled, in String condition);
69         void removeBreakpoint(in String sourceID, in unsigned long lineNumber);
70         void activateBreakpoints();
71         void deactivateBreakpoints();
72
73         void pauseInDebugger();
74         void resumeDebugger();
75
76         void stepOverStatementInDebugger();
77         void stepIntoStatementInDebugger();
78         void stepOutOfFunctionInDebugger();
79
80         void setPauseOnExceptionsState(in long pauseOnExceptionsState);
81
82         void editScriptSource(in String sourceID, in String newContent);
83         void getScriptSource(in String sourceID);
84
85         void enableProfiler(in boolean always);
86         void disableProfiler(in boolean always);
87
88         void startProfiling();
89         void stopProfiling();
90
91         void getProfileHeaders();
92         void getProfile(in unsigned long uid);
93
94         void removeProfile(in unsigned long uid);
95         void clearProfiles();
96
97         void takeHeapSnapshot();
98 #endif
99         void setInjectedScriptSource(in String scriptSource);
100         void dispatchOnInjectedScript(in long injectedScriptId, in String methodName, in String arguments, in boolean async);
101
102         void addScriptToEvaluateOnLoad(in String scriptSource);
103         void removeAllScriptsToEvaluateOnLoad();
104
105         void getChildNodes(in long nodeId);
106         [custorResponse=didApplyDomChange] void setAttribute(in long elementId, in String name, in String value, out boolean success);
107         [customResponse=didApplyDomChange] void removeAttribute(in long elementId, in String name, out boolean success);
108         void setTextNodeValue(in long nodeId, in String value);
109         void getEventListenersForNode(in long nodeId, out long nodeId, out Array listenersArray);
110         void copyNode(in long nodeId);
111         void removeNode(in long nodeId, out long nodeId);
112         void changeTagName(in long nodeId, in String newTagName, out long nodeId);
113         void getOuterHTML(in long nodeId, out String outerHTML);
114         void setOuterHTML(in long nodeId, in String outerHTML, out long nodeId);
115         void addInspectedNode(in long nodeId);
116         void performSearch(in String query, in boolean runSynchronously);
117         void searchCanceled();
118         void pushNodeByPathToFrontend(in String path);
119
120         void clearConsoleMessages();
121
122         void highlightDOMNode(in long nodeId);
123         void hideDOMNodeHighlight();
124
125         void getStyles(in long nodeId, in boolean authOnly, out Value styles);
126         void getAllStyles(out Array styles);
127         void getInlineStyle(in long nodeId, out Value style);
128         void getComputedStyle(in long nodeId, out Value style);
129         void getStyleSheet(in long styleSheetId, out Value styleSheet);
130         void getRuleRangesForStyleSheetId(in long styleSheetId);
131         void applyStyleText(in long styleId, in String styleText, in String propertyName, out boolean success, out Value style, out Array changedProperties);
132         void setStyleText(in long styleId, in String styleText, out boolean success);
133         void setStyleProperty(in long styleId, in String name, in String value, out boolean success);
134         void toggleStyleEnabled(in long styleId, in String propertyName, in boolean disabled, out Value style);
135         void setRuleSelector(in long ruleId, in String selector, in long selectedNodeId, out Value rule, out boolean selectorAffectsNode);
136         void addRule(in String selector, in long selectedNodeId, out Value rule, out boolean selectorAffectsNode);
137
138         void getCookies();
139         void deleteCookie(in String cookieName, in String domain);
140
141 #if defined(ENABLE_OFFLINE_WEB_APPLICATIONS)
142         void getApplicationCaches();
143 #endif
144
145         void releaseWrapperObjectGroup(in long injectedScriptId, in String objectGroup);
146         void didEvaluateForTestInFrontend(in String jsonResult);
147
148 #if defined(ENABLE_DATABASE) && ENABLE_DATABASE
149         void getDatabaseTableNames(in long databaseId);
150 #endif
151
152 #if defined(ENABLE_DOM_STORAGE) && ENABLE_DOM_STORAGE
153         void getDOMStorageEntries(in long storageId);
154         void setDOMStorageItem(in long storageId, in String key, in String value);
155         void removeDOMStorageItem(in long storageId, in String key);
156 #endif
157     };
158 }