Web Inspector: make "sdk" component compile independently from the rest of the front...
[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 /**
66  * @param {string} eventName
67  * @param {Function} listener
68  * @param {boolean=} capturing
69  */
70 function addEventListener(eventName, listener, capturing) {}
71
72 /** @param {boolean=} onlyFirst */
73 Array.prototype.remove = function(obj, onlyFirst) {}
74 Array.prototype.keySet = function() {}
75 /** @return {number} */
76 Array.prototype.upperBound = function(anchor) {}
77 /** @return {number} */
78 Array.prototype.binaryIndexOf = function(anchor) {}
79 Array.prototype.sortRange = function(comparator, leftBound, rightBound, k) {}
80
81 /**
82  * @this {Array.<number>}
83  * @param {function(number,number):boolean} comparator
84  * @param {number} left
85  * @param {number} right
86  * @param {number} pivotIndex
87  * @return {number}
88  */
89 Array.prototype.partition = function(comparator, left, right, pivotIndex) {}
90
91 /**
92  * @this {Array.<number>}
93  * @param {number} k
94  * @param {function(number,number):boolean=} comparator
95  * @return {number}
96  */
97 Array.prototype.qselect = function(k, comparator) {}
98
99 /**
100  * @this {Array.<*>}
101  * @param {string} field
102  * @return {Array.<*>}
103  */
104 Array.prototype.select = function(field) {}
105
106 DOMApplicationCache.prototype.UNCACHED = 0;
107 DOMApplicationCache.prototype.IDLE = 1;
108 DOMApplicationCache.prototype.CHECKING = 2;
109 DOMApplicationCache.prototype.DOWNLOADING = 3;
110 DOMApplicationCache.prototype.UPDATEREADY = 4;
111 DOMApplicationCache.prototype.OBSOLETE = 5;
112
113
114
115 // Inspector Backend
116 var InspectorBackend = {}
117 InspectorBackend.runAfterPendingDispatches = function(message) {}
118
119 /** @interface */
120 function InspectorFrontendHostAPI() {}
121 InspectorFrontendHostAPI.prototype.platform = function() {}
122 InspectorFrontendHostAPI.prototype.port = function() {}
123 InspectorFrontendHostAPI.prototype.bringToFront = function() {}
124 InspectorFrontendHostAPI.prototype.closeWindow = function() {}
125 InspectorFrontendHostAPI.prototype.requestAttachWindow = function() {}
126 InspectorFrontendHostAPI.prototype.requestDetachWindow = function() {}
127 InspectorFrontendHostAPI.prototype.requestSetDockSide = function() {}
128 InspectorFrontendHostAPI.prototype.setAttachedWindowHeight = function(height) {}
129 InspectorFrontendHostAPI.prototype.moveWindowBy = function(x, y) {}
130 InspectorFrontendHostAPI.prototype.setInjectedScriptForOrigin = function(origin, script) {}
131 InspectorFrontendHostAPI.prototype.loaded = function() {}
132 InspectorFrontendHostAPI.prototype.localizedStringsURL = function() {}
133 InspectorFrontendHostAPI.prototype.hiddenPanels = function() {}
134 InspectorFrontendHostAPI.prototype.inspectedURLChanged = function(url) {}
135 InspectorFrontendHostAPI.prototype.documentCopy = function(event) {}
136 InspectorFrontendHostAPI.prototype.copyText = function(text) {}
137 InspectorFrontendHostAPI.prototype.openInNewTab = function(url) {}
138 InspectorFrontendHostAPI.prototype.canSave = function() {}
139 InspectorFrontendHostAPI.prototype.save = function(url, content, forceSaveAs) {}
140 InspectorFrontendHostAPI.prototype.canAppend = function() {}
141 InspectorFrontendHostAPI.prototype.append = function(url, content) {}
142 InspectorFrontendHostAPI.prototype.sendMessageToBackend = function(message) {}
143 InspectorFrontendHostAPI.prototype.recordActionTaken = function(actionCode) {}
144 InspectorFrontendHostAPI.prototype.recordPanelShown = function(panelCode) {}
145 InspectorFrontendHostAPI.prototype.recordSettingChanged = function(settingCode) {}
146 InspectorFrontendHostAPI.prototype.loadResourceSynchronously = function(url) {}
147 InspectorFrontendHostAPI.prototype.setZoomFactor = function(zoom) {}
148 InspectorFrontendHostAPI.prototype.canInspectWorkers = function() {}
149 /** @type {InspectorFrontendHostAPI} */
150 var InspectorFrontendHost;
151
152 /** @constructor */
153 function SourceMapV3()
154 {
155     /** @type {number} */ this.version;
156     /** @type {string} */ this.file;
157     /** @type {Array.<string>} */ this.sources;
158     /** @type {Array.<SourceMapV3.Section>} */ this.sections;
159     /** @type {string} */ this.mappings
160 }
161
162 /** @constructor */
163 SourceMapV3.Section = function()
164 {
165     /** @type {SourceMapV3} */ this.map;
166     /** @type {SourceMapV3.Offset} */ this.offset;
167 }
168
169 /** @constructor */
170 SourceMapV3.Offset = function()
171 {
172     /** @type {number} */ this.line;
173     /** @type {number} */ this.column;
174 }
175
176 // FIXME: remove everything below.
177 var WebInspector = {}
178
179 WebInspector.panels = {};
180
181 /**
182  * @param {Element} element
183  * @param {function()=} onclose
184  */
185 WebInspector.showViewInDrawer = function(element, view, onclose) {}
186
187 WebInspector.closeViewInDrawer = function() {}
188
189 /**
190  * @param {string=} messageLevel
191  * @param {boolean=} showConsole
192  */
193 WebInspector.log = function(message, messageLevel, showConsole) {}
194
195 WebInspector.showErrorMessage = function(error) {}
196
197 WebInspector.addMainEventListeners = function(doc) {}
198
199 WebInspector.openResource = function(url, external) {}
200
201 WebInspector.showConsole = function() {}
202
203 /**
204  * @param {string} expression
205  * @param {boolean=} showResultOnly
206  */
207 WebInspector.evaluateInConsole = function(expression, showResultOnly) {}
208
209 WebInspector.queryParamsObject = {}
210
211 WebInspector.Events = {
212     InspectorClosing: "InspectorClosing"
213 }
214
215 /** Extensions API */
216
217 /** @constructor */
218 function AuditCategory() {}
219 /** @constructor */
220 function AuditResult() {}
221 /** @constructor */
222 function EventSink() {}
223 /** @constructor */
224 function ExtensionSidebarPane() {}
225 /** @constructor */
226 function Panel() {}
227 /** @constructor */
228 function PanelWithSidebar() {}
229 /** @constructor */
230 function Request() {}
231 /** @constructor */
232 function Resource() {}
233 /** @constructor */
234 function Timeline() {}
235
236 /** @type {string} */
237 Location.prototype.origin = "";
238
239 /**
240  * @constructor
241  */
242 function ExtensionDescriptor() {
243     this.startPage = "";
244     this.name = "";
245 }
246
247 /**
248  * @constructor
249  */
250 function ExtensionReloadOptions() {
251     this.ignoreCache = false;
252     this.injectedScript = "";
253     this.userAgent = "";
254 }
255
256 WebInspector.showPanel = function(panel)
257 {
258 }
259
260 /**
261  * @type {string} 
262  */
263 WebInspector.inspectedPageDomain;
264
265 WebInspector.isCompactMode = function() { return false; }
266
267 WebInspector.SourceJavaScriptTokenizer = {}
268 WebInspector.SourceJavaScriptTokenizer.Keywords = {}
269
270 var InspectorTest = {}
271
272 /* jsdifflib API */
273 var difflib = {};
274 difflib.stringAsLines = function(text) { return []; }
275 /** @constructor */
276 difflib.SequenceMatcher = function(baseText, newText) { }
277 difflib.SequenceMatcher.prototype.get_opcodes = function() { return []; }
278
279 /** @constructor */
280 WebInspector.CodeMirrorTextEditor = function(url, delegate) { }
281
282 WebInspector.ProfileURLRegExp = "";