Web Inspector: fix closure compiler warnings in extension server and API
[WebKit-https.git] / Source / WebCore / inspector / front-end / externs.js
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 // WebKit Web Facing API
32 var console = {}
33 /** @param {...*} vararg */
34 console.warn = function(vararg) {}
35 /** @param {...*} vararg */
36 console.assert = function(vararg) {}
37 /** @param {...*} vararg */
38 console.error = function(vararg) {}
39 console.trace = function() {}
40
41 var JSON = {}
42 /** @param {string} str */
43 JSON.parse = function(str) {}
44 /**
45  * @param {*} obj
46  * @param {Function=} replacer
47  * @param {number=} space
48  * @return {string}
49  */
50 JSON.stringify = function(obj, replacer, space) {}
51
52 /** @param {boolean=} param */
53 Element.prototype.scrollIntoViewIfNeeded = function(param) {}
54 /** @type {boolean} */
55 Event.prototype.isMetaOrCtrlForTest = false;
56 /** @param {...*} vararg */
57 Event.prototype.initWebKitWheelEvent = function(vararg) {}
58 Event.prototype.stopImmediatePropagation = function() {}
59
60 /** @param {Element} element */
61 window.getComputedStyle = function(element) {}
62 /** @param {*} message */
63 function postMessage(message) {}
64
65 /** @type {*} */
66 window.testRunner = null;
67
68 /**
69  * @constructor
70  */
71 function WebKitMutation(callback)
72 {
73     this.type = "";
74     /** @type {Node} */ this.target = null;
75     /** @type {Array.<Node>} */ this.addedNodes = [];
76     /** @type {Array.<Node>} */ this.removedNodes = [];
77 }
78
79 /**
80  * @constructor
81  * @param {function(Array.<WebKitMutation>)} callback
82  */
83 function WebKitMutationObserver(callback) {}
84 /** 
85  * @param {Node} container
86  * @param {Object} options
87  */
88 WebKitMutationObserver.prototype.observe = function(container, options) {}
89 WebKitMutationObserver.prototype.disconnect = function() {}
90
91 /**
92  * @param {string} eventName
93  * @param {Function} listener
94  * @param {boolean=} capturing
95  */
96 function addEventListener(eventName, listener, capturing) {}
97
98 /** @param {boolean=} onlyFirst */
99 Array.prototype.remove = function(obj, onlyFirst) {}
100 Array.prototype.keySet = function() {}
101 /** @return {number} */
102 Array.prototype.upperBound = function(anchor) {}
103 /** @return {number} */
104 Array.prototype.binaryIndexOf = function(anchor) {}
105 Array.prototype.sortRange = function(comparator, leftBound, rightBound, k) {}
106
107 /**
108  * @this {Array.<number>}
109  * @param {function(number,number):boolean} comparator
110  * @param {number} left
111  * @param {number} right
112  * @param {number} pivotIndex
113  * @return {number}
114  */
115 Array.prototype.partition = function(comparator, left, right, pivotIndex) {}
116
117 /**
118  * @this {Array.<number>}
119  * @param {number} k
120  * @param {function(number,number):boolean=} comparator
121  * @return {number}
122  */
123 Array.prototype.qselect = function(k, comparator) {}
124
125 /**
126  * @this {Array.<*>}
127  * @param {string} field
128  * @return {Array.<*>}
129  */
130 Array.prototype.select = function(field) {}
131
132 DOMApplicationCache.prototype.UNCACHED = 0;
133 DOMApplicationCache.prototype.IDLE = 1;
134 DOMApplicationCache.prototype.CHECKING = 2;
135 DOMApplicationCache.prototype.DOWNLOADING = 3;
136 DOMApplicationCache.prototype.UPDATEREADY = 4;
137 DOMApplicationCache.prototype.OBSOLETE = 5;
138
139 // File System API
140 /**
141  * @constructor
142  */
143 function DOMFileSystem() {}
144
145 /**
146  * @type {DirectoryEntry}
147  */
148 DOMFileSystem.prototype.root = null;
149
150 /** @type {Node} */
151 Range.prototype.startContainer;
152
153 // Inspector Backend
154 var InspectorBackend = {}
155 InspectorBackend.runAfterPendingDispatches = function(message) {}
156
157 /** @interface */
158 function InspectorFrontendHostAPI() {}
159 InspectorFrontendHostAPI.prototype.platform = function() {}
160 InspectorFrontendHostAPI.prototype.port = function() {}
161 InspectorFrontendHostAPI.prototype.bringToFront = function() {}
162 InspectorFrontendHostAPI.prototype.closeWindow = function() {}
163 InspectorFrontendHostAPI.prototype.requestSetDockSide = function(dockSide) {}
164 InspectorFrontendHostAPI.prototype.setAttachedWindowHeight = function(height) {}
165 InspectorFrontendHostAPI.prototype.moveWindowBy = function(x, y) {}
166 InspectorFrontendHostAPI.prototype.setInjectedScriptForOrigin = function(origin, script) {}
167 InspectorFrontendHostAPI.prototype.loaded = function() {}
168 InspectorFrontendHostAPI.prototype.localizedStringsURL = function() {}
169 InspectorFrontendHostAPI.prototype.hiddenPanels = function() {}
170 InspectorFrontendHostAPI.prototype.inspectedURLChanged = function(url) {}
171 InspectorFrontendHostAPI.prototype.documentCopy = function(event) {}
172 InspectorFrontendHostAPI.prototype.copyText = function(text) {}
173 InspectorFrontendHostAPI.prototype.openInNewTab = function(url) {}
174 InspectorFrontendHostAPI.prototype.canSave = function() {}
175 InspectorFrontendHostAPI.prototype.save = function(url, content, forceSaveAs) {}
176 InspectorFrontendHostAPI.prototype.close = function(url) {}
177 InspectorFrontendHostAPI.prototype.append = function(url, content) {}
178 InspectorFrontendHostAPI.prototype.sendMessageToBackend = function(message) {}
179 InspectorFrontendHostAPI.prototype.recordActionTaken = function(actionCode) {}
180 InspectorFrontendHostAPI.prototype.recordPanelShown = function(panelCode) {}
181 InspectorFrontendHostAPI.prototype.recordSettingChanged = function(settingCode) {}
182 InspectorFrontendHostAPI.prototype.loadResourceSynchronously = function(url) {}
183 InspectorFrontendHostAPI.prototype.supportsFileSystems = function() {}
184 InspectorFrontendHostAPI.prototype.requestFileSystems = function() {}
185 InspectorFrontendHostAPI.prototype.addFileSystem = function() {}
186 InspectorFrontendHostAPI.prototype.removeFileSystem = function(fileSystemPath) {}
187 InspectorFrontendHostAPI.prototype.isolatedFileSystem = function(fileSystemId, registeredName) {}
188 InspectorFrontendHostAPI.prototype.setZoomFactor = function(zoom) {}
189 InspectorFrontendHostAPI.prototype.canInspectWorkers = function() {}
190 /** @type {InspectorFrontendHostAPI} */
191 var InspectorFrontendHost;
192
193 /** @constructor */
194 function SourceMapV3()
195 {
196     /** @type {number} */ this.version;
197     /** @type {string} */ this.file;
198     /** @type {Array.<string>} */ this.sources;
199     /** @type {Array.<SourceMapV3.Section>} */ this.sections;
200     /** @type {string} */ this.mappings
201 }
202
203 /** @constructor */
204 SourceMapV3.Section = function()
205 {
206     /** @type {SourceMapV3} */ this.map;
207     /** @type {SourceMapV3.Offset} */ this.offset;
208 }
209
210 /** @constructor */
211 SourceMapV3.Offset = function()
212 {
213     /** @type {number} */ this.line;
214     /** @type {number} */ this.column;
215 }
216
217 // FIXME: remove everything below.
218 var WebInspector = {}
219
220 WebInspector.queryParamsObject = {}
221 WebInspector.toggleSearchingForNode = function() {}
222 WebInspector.panels = {};
223
224 /**
225  * @param {Element} element
226  * @param {function()=} onclose
227  */
228 WebInspector.showViewInDrawer = function(element, view, onclose) {}
229
230 WebInspector.closeViewInDrawer = function() {}
231
232 /**
233  * @param {string=} messageLevel
234  * @param {boolean=} showConsole
235  */
236 WebInspector.log = function(message, messageLevel, showConsole) {}
237
238 WebInspector.showErrorMessage = function(error) {}
239
240 WebInspector.addMainEventListeners = function(doc) {}
241
242 WebInspector.openResource = function(url, external) {}
243
244 WebInspector.showConsole = function() {}
245
246 /**
247  * @param {string} expression
248  * @param {boolean=} showResultOnly
249  */
250 WebInspector.evaluateInConsole = function(expression, showResultOnly) {}
251
252 WebInspector.queryParamsObject = {}
253
254 WebInspector.Events = {
255     InspectorLoaded: "InspectorLoaded",
256     InspectorClosing: "InspectorClosing"
257 }
258
259 /** Extensions API */
260
261 /** @constructor */
262 function AuditCategory() {}
263 /** @constructor */
264 function AuditResult() {}
265 /** @constructor */
266 function EventSink() {}
267 /** @constructor */
268 function ExtensionSidebarPane() {}
269 /** @constructor */
270 function Panel() {}
271 /** @constructor */
272 function PanelWithSidebar() {}
273 /** @constructor */
274 function Request() {}
275 /** @constructor */
276 function Resource() {}
277 /** @constructor */
278 function Timeline() {}
279
280 var extensionServer;
281
282 /** @type {string} */
283 Location.prototype.origin = "";
284
285 /**
286  * @constructor
287  */
288 function ExtensionDescriptor() {
289     this.startPage = "";
290     this.name = "";
291 }
292
293 /**
294  * @constructor
295  */
296 function ExtensionReloadOptions() {
297     this.ignoreCache = false;
298     this.injectedScript = "";
299     this.userAgent = "";
300 }
301
302 WebInspector.showPanel = function(panel)
303 {
304 }
305
306 /**
307  * @type {string} 
308  */
309 WebInspector.inspectedPageDomain;
310
311 WebInspector.SourceJavaScriptTokenizer = {}
312 WebInspector.SourceJavaScriptTokenizer.Keywords = {}
313
314 var InspectorTest = {}
315
316 /* jsdifflib API */
317 var difflib = {};
318 difflib.stringAsLines = function(text) { return []; }
319 /** @constructor */
320 difflib.SequenceMatcher = function(baseText, newText) { }
321 difflib.SequenceMatcher.prototype.get_opcodes = function() { return []; }
322
323 /** @constructor */
324 WebInspector.CodeMirrorTextEditor = function(url, delegate) { }
325
326 WebInspector.ProfileURLRegExp = "";
327
328
329 /** @type {boolean} */
330 window.dispatchStandaloneTestRunnerMessages;