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