2010-12-29 Pavel Feldman <pfeldman@chromium.org>
[WebKit-https.git] / WebCore / inspector / Inspector.idl
1 /*
2  * Copyright (C) 2010 Apple Inc. All rights reserved.
3  * Copyright (C) 2010 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 module core {
33     interface [Conditional=INSPECTOR] Inspector {
34
35         ///////////////////////////////////////////////////////////////////////
36         // generic Inspector's methods
37         ///////////////////////////////////////////////////////////////////////
38
39         [domain=Backend] void setInjectedScriptSource(in String scriptSource);
40         // HUGE FIXME: we need to expose InjectedScript methods here. Or document InjectedScript capabilities.
41         [domain=Backend] void dispatchOnInjectedScript(in long injectedScriptId, in String methodName, in String arguments, out Value result, out boolean isException);
42         [domain=Inspector] void addScriptToEvaluateOnLoad(in String scriptSource);
43         [domain=Inspector] void removeAllScriptsToEvaluateOnLoad();
44         [domain=Backend] void releaseWrapperObjectGroup(in long injectedScriptId, in String objectGroup);
45         [domain=Inspector] void getInspectorState(out Object state);
46         [domain=Inspector] void setMonitoringXHREnabled(in boolean enable, out boolean newState);
47         [domain=Inspector] void reloadPage();
48         [domain=Inspector] void populateScriptObjects();
49
50         [domain=Inspector] void openInInspectedWindow(in String url);
51         [domain=Inspector] void setSearchingForNode(in boolean enabled, out boolean newState);
52         [notify, domain=Inspector] void addNodesToSearchResult(out Array nodeIds);
53         [notify, domain=Inspector] void bringToFront();
54         [notify, domain=Inspector] void disconnectFromBackend();
55         [notify, domain=Inspector] void inspectedURLChanged(out String url);
56         [notify, domain=Inspector] void domContentEventFired(out double time);
57         [notify, domain=Inspector] void loadEventFired(out double time);
58         [notify, domain=Inspector] void reset();
59         [notify, domain=Inspector] void showPanel(out String panel);
60
61         [notify, domain=Inspector] void evaluateForTestInFrontend(out long testCallId, out String script);
62         [domain=Inspector] void didEvaluateForTestInFrontend(in long testCallId, in String jsonResult);
63
64         [domain=Inspector] void highlightDOMNode(in long nodeId);
65         [domain=Inspector] void hideDOMNodeHighlight();
66         [domain=Inspector] void highlightFrame(in unsigned long frameId);
67         [domain=Inspector] void hideFrameHighlight();
68         [notify, domain=Inspector] void updateFocusedNode(out long nodeId);
69
70         [domain=Inspector] void setExtraHeaders(in Object headers);
71
72         ///////////////////////////////////////////////////////////////////////
73         // Console API
74         ///////////////////////////////////////////////////////////////////////
75
76         [domain=Inspector] void setConsoleMessagesEnabled(in boolean enabled, out boolean newState);
77         [notify, domain=Inspector] void addConsoleMessage(out Object messageObj);
78         [notify, domain=Inspector] void updateConsoleMessageExpiredCount(out unsigned long count);
79         [notify, domain=Inspector] void updateConsoleMessageRepeatCount(out unsigned long count);
80         [domain=Inspector] void clearConsoleMessages();
81         [notify, domain=Inspector] void consoleMessagesCleared();
82
83         ///////////////////////////////////////////////////////////////////////
84         // Network API
85         ///////////////////////////////////////////////////////////////////////
86
87         [notify, domain=Network] void identifierForInitialRequest(out long identifier, out String url, out Object loader, out Value callStack);
88         [notify, domain=Network] void willSendRequest(out long identifier, out double time, out Object request, out Object redirectResponse);
89         [notify, domain=Network] void markResourceAsCached(out long identifier);
90         [notify, domain=Network] void didReceiveResponse(out long identifier, out double time, out String resourceType, out Object response);
91         [notify, domain=Network] void didReceiveContentLength(out long identifier, out double time, out long lengthReceived);
92         [notify, domain=Network] void didFinishLoading(out long identifier, out double finishTime);
93         [notify, domain=Network] void didFailLoading(out long identifier, out double time, out String localizedDescription);
94         [notify, domain=Network] void didLoadResourceFromMemoryCache(out double time, out Object resource);
95         [notify, domain=Network] void setInitialContent(out long identifier, out String sourceString, out String type);
96         [notify, domain=Network] void didCommitLoadForFrame(out Object frame, out Object loader);
97         [notify, domain=Network] void didCreateWebSocket(out unsigned long identifier, out String requestURL);
98         [notify, domain=Network] void willSendWebSocketHandshakeRequest(out unsigned long identifier, out double time, out Object request);
99         [notify, domain=Network] void didReceiveWebSocketHandshakeResponse(out unsigned long identifier, out double time, out Object response);
100         [notify, domain=Network] void didCloseWebSocket(out unsigned long identifier, out double time);
101
102         ///////////////////////////////////////////////////////////////////////
103         // Resources API
104         ///////////////////////////////////////////////////////////////////////
105
106         [domain=Resources] void cachedResources(out Object resources);
107         [domain=Resources] void resourceContent(in unsigned long frameId, in String url, in boolean base64Encode, out String content);
108         [notify, domain=Resources] void frameDetachedFromParent(out unsigned long frameId);
109
110         // FIXME: Introduce new StorageDomain.
111         [domain=Inspector] void getCookies(out Array cookies, out String cookiesString);
112         [domain=Inspector] void deleteCookie(in String cookieName, in String domain);
113 #if defined(ENABLE_DATABASE) && ENABLE_DATABASE
114         [notify, domain=Database] void addDatabase(out Object database);
115         [notify, domain=Database] void selectDatabase(out int databaseId);
116         [domain=Database] void getDatabaseTableNames(in long databaseId, out Array tableNames);
117         [domain=Database] void executeSQL(in long databaseId, in String query, out boolean success, out long transactionId);
118         [notify, domain=Database] void sqlTransactionSucceeded(out long transactionId, out Value columnNames, out Value values);
119         [notify, domain=Database] void sqlTransactionFailed(out long transactionId, out Value sqlError);
120 #endif
121 #if defined(ENABLE_DOM_STORAGE) && ENABLE_DOM_STORAGE
122         [domain=DOMStorage] void getDOMStorageEntries(in long storageId, out Array entries);
123         [domain=DOMStorage] void setDOMStorageItem(in long storageId, in String key, in String value, out boolean success);
124         [domain=DOMStorage] void removeDOMStorageItem(in long storageId, in String key, out boolean success);
125         [notify, domain=DOMStorage] void addDOMStorage(out Object storage);
126         [notify, domain=DOMStorage] void updateDOMStorage(out int storageId);
127         [notify, domain=DOMStorage] void selectDOMStorage(out int storageId);
128 #endif
129 #if defined(ENABLE_OFFLINE_WEB_APPLICATIONS) && ENABLE_OFFLINE_WEB_APPLICATIONS
130         [domain=ApplicationCache] void getApplicationCaches(out Value applicationCaches);
131         [notify, domain=ApplicationCache] void updateApplicationCacheStatus(out int status);
132         [notify, domain=ApplicationCache] void updateNetworkState(out boolean isNowOnline);
133 #endif
134 #if defined(ENABLE_FILE_SYSTEM) && ENABLE_FILE_SYSTEM
135         [domain=FileSystem] void getFileSystemPathAsync(in unsigned int type, in String origin);
136         [domain=FileSystem] void revealFolderInOS(in String path);
137
138         [notify, domain=FileSystem] void didGetFileSystemPath(out String root, out int type, out String origin);
139         [notify, domain=FileSystem] void didGetFileSystemError(out int type, out String origin);
140         [notify, domain=FileSystem] void didGetFileSystemDisabled();
141 #endif
142
143         ///////////////////////////////////////////////////////////////////////
144         // DOM API
145         ///////////////////////////////////////////////////////////////////////
146
147         [domain=DOM] void getChildNodes(in long nodeId);
148         [domain=DOM] void setAttribute(in long elementId, in String name, in String value, out boolean success);
149         [domain=DOM] void removeAttribute(in long elementId, in String name, out boolean success);
150         [domain=DOM] void setTextNodeValue(in long nodeId, in String value, out boolean success);
151         [domain=DOM] void getEventListenersForNode(in long nodeId, out long outNodeId, out Array listenersArray);
152         [domain=DOM] void copyNode(in long nodeId);
153         [domain=DOM] void removeNode(in long nodeId, out long outNodeId);
154         [domain=DOM] void changeTagName(in long nodeId, in String newTagName, out long outNodeId);
155         [domain=DOM] void getOuterHTML(in long nodeId, out String outerHTML);
156         [domain=DOM] void setOuterHTML(in long nodeId, in String outerHTML, out long outNodeId);
157         [domain=DOM] void addInspectedNode(in long nodeId);
158         [domain=DOM] void performSearch(in String query, in boolean runSynchronously);
159         [domain=DOM] void searchCanceled();
160         [domain=DOM] void pushNodeByPathToFrontend(in String path, out long nodeId);
161
162         [notify, domain=DOM] void setDocument(out Value root); // FIXME: should be requested from the front-end as getDocument.
163         [notify, domain=DOM] void attributesUpdated(out long id, out Array attributes);
164         [notify, domain=DOM] void characterDataModified(out long id, out String newValue);
165         [notify, domain=DOM] void setChildNodes(out long parentId, out Array nodes);
166         [notify, domain=DOM] void setDetachedRoot(out Object root);
167         [notify, domain=DOM] void childNodeCountUpdated(out long id, out int newValue);
168         [notify, domain=DOM] void childNodeInserted(out long parentId, out long prevId, out Object node);
169         [notify, domain=DOM] void childNodeRemoved(out long parentId, out long id);
170         [notify, domain=DOM] void didCommitLoad();
171
172         ///////////////////////////////////////////////////////////////////////
173         // CSS API
174         ///////////////////////////////////////////////////////////////////////
175
176         [domain=CSS] void getStylesForNode2(in long nodeId, out Value styles);
177         [domain=CSS] void getComputedStyleForNode2(in long nodeId, out Value style);
178         [domain=CSS] void getInlineStyleForNode2(in long nodeId, out Value style);
179         [domain=CSS] void getAllStyles2(out Array styleSheetIds);
180         [domain=CSS] void getStyleSheet2(in String styleSheetId, out Value styleSheet);
181         [domain=CSS] void getStyleSheetText2(in String styleSheetId, out String url, out String text);
182         [domain=CSS] void setStyleSheetText2(in String styleSheetId, in String text, out boolean success);
183         [domain=CSS] void setPropertyText2(in Object styleId, in long propertyIndex, in String text, in boolean overwrite, out Value style);
184         [domain=CSS] void toggleProperty2(in Object styleId, in long propertyIndex, in boolean disable, out Value style);
185         [domain=CSS] void setRuleSelector2(in Object ruleId, in String selector, out Value rule);
186         [domain=CSS] void addRule2(in long contextNodeId, in String selector, out Value rule);
187         [domain=CSS] void getSupportedCSSProperties(out Array cssProperties);
188         [domain=CSS] void querySelectorAll(in long documentId, in String selector, out Array result);
189
190         ///////////////////////////////////////////////////////////////////////
191         // Timeline API
192         ///////////////////////////////////////////////////////////////////////
193
194         [domain=Inspector] void startTimelineProfiler();
195         [domain=Inspector] void stopTimelineProfiler();
196         [notify, domain=Timeline] void timelineProfilerWasStarted();
197         [notify, domain=Timeline] void timelineProfilerWasStopped();
198         [notify, domain=Timeline] void addRecordToTimeline(out Object record);
199
200 #if defined(ENABLE_JAVASCRIPT_DEBUGGER) && ENABLE_JAVASCRIPT_DEBUGGER
201
202         ///////////////////////////////////////////////////////////////////////
203         // Debugger API
204         ///////////////////////////////////////////////////////////////////////
205
206         [domain=Backend] void enableDebugger(in boolean always);
207         [domain=Inspector] void disableDebugger(in boolean always); // FIXME: should be on the same domain as enableDebugger.
208         [notify, domain=Debugger] void debuggerWasEnabled();
209         [notify, domain=Debugger] void debuggerWasDisabled();
210
211         [notify, domain=Debugger] void attachDebuggerWhenShown(); // FIXME: do something with this eventually.
212
213         [notify, domain=Debugger] void parsedScriptSource(out String sourceID, out String url, out String data, out int firstLine, out int scriptWorldType);
214         [notify, domain=Debugger] void failedToParseScriptSource(out String url, out String data, out int firstLine, out int errorLine, out String errorMessage);
215
216         [domain=Debugger] void activateBreakpoints();
217         [domain=Debugger] void deactivateBreakpoints();
218
219         [domain=Debugger] void setBreakpoint(in String sourceID, in unsigned int lineNumber, in String condition, in boolean enabled, out String breakpointId, out unsigned int actualLineNumber);
220         [domain=Debugger] void removeBreakpoint(in String breakpointId);
221
222         [domain=Inspector] void setStickyBreakpoints(in Object breakpoints); // FIXME: Move to newly introduced BrowserDebugger.
223
224         [domain=DOM] void setDOMBreakpoint(in long nodeId, in long type); // FIXME: Move to newly introduced BrowserDebugger.
225         [domain=DOM] void removeDOMBreakpoint(in long nodeId, in long type); // FIXME: Move to newly introduced BrowserDebugger.
226
227         [domain=Inspector] void setEventListenerBreakpoint(in String eventName); // FIXME: Move to newly introduced BrowserDebugger.
228         [domain=Inspector] void removeEventListenerBreakpoint(in String eventName); // FIXME: Move to newly introduced BrowserDebugger.
229
230         [domain=Inspector] void setXHRBreakpoint(in String url); // FIXME: Move to newly introduced BrowserDebugger.
231         [domain=Inspector] void removeXHRBreakpoint(in String url); // FIXME: Move to newly introduced BrowserDebugger.
232
233         [domain=Debugger] void stepOverStatement(); // FIXME: rename to stepOver
234         [domain=Debugger] void stepIntoStatement(); // FIXME: rename to stepInto
235         [domain=Debugger] void stepOutOfFunction(); // FIXME: rename to stepOut
236         [domain=Debugger] void pause();
237         [notify, domain=Debugger] void pausedScript(out Object details);
238         [domain=Debugger] void resume();
239         [notify, domain=Debugger] void resumedScript(); // FIXME: Make this out parameter fo resume if possible.
240
241         [domain=Debugger] void setPauseOnExceptionsState(in long pauseOnExceptionsState, out long newState);
242
243         [domain=Debugger] void editScriptSource(in String sourceID, in String newContent, out boolean success, out String result, out Value newCallFrames);
244         [domain=Debugger] void getScriptSource(in String sourceID, out String scriptSource);
245
246         [notify, domain=Debugger] void breakpointResolved(out String breakpointId, out String sourceID, out unsigned int lineNumber, out String condition, out boolean enabled, out unsigned int originalLineNumber);
247
248 #if defined(ENABLE_WORKERS) && ENABLE_WORKERS
249         [notify, domain=Debugger] void didCreateWorker(out long id, out String url, out boolean isShared);
250         [notify, domain=Debugger] void didDestroyWorker(out long id);
251 #endif // ENABLE_WORKERS
252
253         ///////////////////////////////////////////////////////////////////////
254         // Profiler API
255         ///////////////////////////////////////////////////////////////////////
256
257         [domain=Inspector] void enableProfiler(in boolean always); // FIXME: preferrable with Inspector domain, dispatched on backend.
258         [domain=Inspector] void disableProfiler(in boolean always);
259         [notify, domain=Profiler] void profilerWasEnabled();
260         [notify, domain=Profiler] void profilerWasDisabled();
261
262         [domain=Inspector] void startProfiling(); // FIXME: dispatch on profiler agent.
263         [domain=Inspector] void stopProfiling(); // FIXME: dispatch on profiler agent.
264
265         [domain=Profiler] void getProfileHeaders(out Array headers);
266         [domain=Profiler] void getProfile(in String type, in unsigned long uid, out Object profile);
267         [domain=Profiler] void removeProfile(in String type, in unsigned long uid);
268         [domain=Profiler] void clearProfiles();
269
270         // FIXME: split into Profiler and HeapProfiler.
271         [domain=Profiler] void takeHeapSnapshot();
272         [notify, domain=Profiler] void addProfileHeader(out Object header);
273         [notify, domain=Profiler] void addHeapSnapshotChunk(out unsigned long uid, out String chunk);
274         [notify, domain=Profiler] void finishHeapSnapshot(out unsigned long uid);
275         [notify, domain=Profiler] void setRecordingProfile(out boolean isProfiling);
276         [notify, domain=Profiler] void resetProfiles();
277
278 #endif // ENABLE_JAVASCRIPT_DEBUGGER
279     };
280 }