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