Web Inspector: Save Console Evaluations into Command Line variables $1-$99 ($n)
[WebKit-https.git] / Source / WebCore / inspector / CommandLineAPIModuleSource.js
1 /*
2  * Copyright (C) 2007 Apple 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
6  * are met:
7  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 //# sourceURL=__WebInspectorCommandLineAPIModuleSource__
30
31 /**
32  * @param {InjectedScriptHost} InjectedScriptHost
33  * @param {Window} inspectedWindow
34  * @param {number} injectedScriptId
35  * @param {InjectedScript} injectedScript
36  * @param {CommandLineAPIHost} CommandLineAPIHost
37  */
38 (function (InjectedScriptHost, inspectedWindow, injectedScriptId, injectedScript, CommandLineAPIHost) {
39
40 /**
41  * @param {Arguments} array
42  * @param {number=} index
43  * @return {Array.<*>}
44  */
45 function slice(array, index)
46 {
47     var result = [];
48     for (var i = index || 0; i < array.length; ++i)
49         result.push(array[i]);
50     return result;
51 }
52
53 /**
54  * Please use this bind, not the one from Function.prototype
55  * @param {function(...)} func
56  * @param {Object} thisObject
57  * @param {...number} var_args
58  */
59 function bind(func, thisObject, var_args)
60 {
61     var args = slice(arguments, 2);
62
63     /**
64      * @param {...number} var_args
65      */
66     function bound(var_args)
67     {
68         return func.apply(thisObject, args.concat(slice(arguments)));
69     }
70     bound.toString = function() {
71         return "bound: " + func;
72     };
73     return bound;
74 }
75
76 /**
77  * @constructor
78  * @param {CommandLineAPIImpl} commandLineAPIImpl
79  * @param {Object} callFrame
80  */
81 function CommandLineAPI(commandLineAPIImpl, callFrame)
82 {
83     /**
84      * @param {string} member
85      * @return {boolean}
86      */
87     function inScopeVariables(member)
88     {
89         if (!callFrame)
90             return false;
91
92         var scopeChain = callFrame.scopeChain;
93         for (var i = 0; i < scopeChain.length; ++i) {
94             if (member in scopeChain[i])
95                 return true;
96         }
97         return false;
98     }
99
100     /**
101      * @param {string} name The name of the method for which a toString method should be generated.
102      * @return {function():string}
103      */
104     function customToStringMethod(name)
105     {
106         return function () { return "function " + name + "() { [Command Line API] }"; };
107     }
108
109     for (var i = 0; i < CommandLineAPI.members_.length; ++i) {
110         var member = CommandLineAPI.members_[i];
111         if (member in inspectedWindow || inScopeVariables(member))
112             continue;
113
114         this[member] = bind(commandLineAPIImpl[member], commandLineAPIImpl);
115         this[member].toString = customToStringMethod(member);
116     }
117
118     // $0
119     this.__defineGetter__("$0", bind(commandLineAPIImpl._inspectedObject, commandLineAPIImpl));
120
121     // $1-$99
122     for (var i = 1; i <= injectedScript._savedResults.length; ++i) {
123         var member = "$" + i;
124         if (member in inspectedWindow || inScopeVariables(member))
125             continue;
126
127         this.__defineGetter__("$" + i, bind(injectedScript._savedResult, injectedScript, i));
128     }
129
130     this.$_ = injectedScript._lastResult;
131     this.$exception = injectedScript._exceptionValue;
132 }
133
134 /**
135  * @type {Array.<string>}
136  * @const
137  */
138 CommandLineAPI.members_ = [
139     "$", "$$", "$x", "dir", "dirxml", "keys", "values", "profile", "profileEnd", "table",
140     "monitorEvents", "unmonitorEvents", "inspect", "copy", "clear", "getEventListeners"
141 ];
142
143 /**
144  * @constructor
145  */
146 function CommandLineAPIImpl()
147 {
148 }
149
150 CommandLineAPIImpl.prototype = {
151     /**
152      * @param {string} selector
153      * @param {Node=} start
154      */
155     $: function (selector, start)
156     {
157         if (this._canQuerySelectorOnNode(start))
158             return start.querySelector(selector);
159
160         var result = inspectedWindow.document.querySelector(selector);
161         if (result)
162             return result;
163         if (selector && selector[0] !== "#") {
164             result = inspectedWindow.document.getElementById(selector);
165             if (result) {
166                 inspectedWindow.console.warn("The console function $() has changed from $=getElementById(id) to $=querySelector(selector). You might try $(\"#%s\")", selector );
167                 return null;
168             }
169         }
170         return result;
171     },
172
173     /**
174      * @param {string} selector
175      * @param {Node=} start
176      */
177     $$: function (selector, start)
178     {
179         if (this._canQuerySelectorOnNode(start))
180             return start.querySelectorAll(selector);
181         return inspectedWindow.document.querySelectorAll(selector);
182     },
183
184     /**
185      * @param {Node=} node
186      * @return {boolean}
187      */
188     _canQuerySelectorOnNode: function(node)
189     {
190         return !!node && InjectedScriptHost.type(node) === "node" && (node.nodeType === Node.ELEMENT_NODE || node.nodeType === Node.DOCUMENT_NODE || node.nodeType === Node.DOCUMENT_FRAGMENT_NODE);
191     },
192
193     /**
194      * @param {string} xpath
195      * @param {Node=} context
196      */
197     $x: function(xpath, context)
198     {
199         var doc = (context && context.ownerDocument) || inspectedWindow.document;
200         var result = doc.evaluate(xpath, context || doc, null, XPathResult.ANY_TYPE, null);
201         switch (result.resultType) {
202         case XPathResult.NUMBER_TYPE:
203             return result.numberValue;
204         case XPathResult.STRING_TYPE:
205             return result.stringValue;
206         case XPathResult.BOOLEAN_TYPE:
207             return result.booleanValue;
208         default:
209             var nodes = [];
210             var node;
211             while (node = result.iterateNext())
212                 nodes.push(node);
213             return nodes;
214         }
215     },
216
217     dir: function()
218     {
219         return inspectedWindow.console.dir.apply(inspectedWindow.console, arguments)
220     },
221
222     dirxml: function()
223     {
224         return inspectedWindow.console.dirxml.apply(inspectedWindow.console, arguments)
225     },
226
227     keys: function(object)
228     {
229         return Object.keys(object);
230     },
231
232     values: function(object)
233     {
234         var result = [];
235         for (var key in object)
236             result.push(object[key]);
237         return result;
238     },
239
240     profile: function()
241     {
242         return inspectedWindow.console.profile.apply(inspectedWindow.console, arguments)
243     },
244
245     profileEnd: function()
246     {
247         return inspectedWindow.console.profileEnd.apply(inspectedWindow.console, arguments)
248     },
249
250     table: function()
251     {
252         return inspectedWindow.console.table.apply(inspectedWindow.console, arguments)
253     },
254
255     /**
256      * @param {Object} object
257      * @param {Array.<string>|string=} types
258      */
259     monitorEvents: function(object, types)
260     {
261         if (!object || !object.addEventListener || !object.removeEventListener)
262             return;
263         types = this._normalizeEventTypes(types);
264         for (var i = 0; i < types.length; ++i) {
265             object.removeEventListener(types[i], this._logEvent, false);
266             object.addEventListener(types[i], this._logEvent, false);
267         }
268     },
269
270     /**
271      * @param {Object} object
272      * @param {Array.<string>|string=} types
273      */
274     unmonitorEvents: function(object, types)
275     {
276         if (!object || !object.addEventListener || !object.removeEventListener)
277             return;
278         types = this._normalizeEventTypes(types);
279         for (var i = 0; i < types.length; ++i)
280             object.removeEventListener(types[i], this._logEvent, false);
281     },
282
283     /**
284      * @param {*} object
285      * @return {*}
286      */
287     inspect: function(object)
288     {
289         return this._inspect(object);
290     },
291
292     copy: function(object)
293     {
294         if (injectedScript._subtype(object) === "node")
295             object = object.outerHTML;
296         CommandLineAPIHost.copyText(object);
297     },
298
299     clear: function()
300     {
301         CommandLineAPIHost.clearConsoleMessages();
302     },
303
304     /**
305      * @param {Node} node
306      */
307     getEventListeners: function(node)
308     {
309         return CommandLineAPIHost.getEventListeners(node);
310     },
311
312     _inspectedObject: function()
313     {
314         return CommandLineAPIHost.inspectedObject();
315     },
316
317     /**
318      * @param {Array.<string>|string=} types
319      * @return {Array.<string>}
320      */
321     _normalizeEventTypes: function(types)
322     {
323         if (typeof types === "undefined")
324             types = [ "mouse", "key", "touch", "control", "load", "unload", "abort", "error", "select", "change", "submit", "reset", "focus", "blur", "resize", "scroll", "search", "devicemotion", "deviceorientation" ];
325         else if (typeof types === "string")
326             types = [ types ];
327
328         var result = [];
329         for (var i = 0; i < types.length; i++) {
330             if (types[i] === "mouse")
331                 result.splice(0, 0, "mousedown", "mouseup", "click", "dblclick", "mousemove", "mouseover", "mouseout", "mousewheel");
332             else if (types[i] === "key")
333                 result.splice(0, 0, "keydown", "keyup", "keypress", "textInput");
334             else if (types[i] === "touch")
335                 result.splice(0, 0, "touchstart", "touchmove", "touchend", "touchcancel");
336             else if (types[i] === "control")
337                 result.splice(0, 0, "resize", "scroll", "zoom", "focus", "blur", "select", "change", "submit", "reset");
338             else
339                 result.push(types[i]);
340         }
341         return result;
342     },
343
344     /**
345      * @param {Event} event
346      */
347     _logEvent: function(event)
348     {
349         inspectedWindow.console.log(event.type, event);
350     },
351
352     /**
353      * @param {*} object
354      * @return {*}
355      */
356     _inspect: function(object)
357     {
358         if (arguments.length === 0)
359             return;
360
361         var objectId = injectedScript._wrapObject(object, "");
362         var hints = {};
363
364         switch (injectedScript._describe(object)) {
365         case "Database":
366             var databaseId = CommandLineAPIHost.databaseId(object)
367             if (databaseId)
368                 hints.databaseId = databaseId;
369             break;
370         case "Storage":
371             var storageId = CommandLineAPIHost.storageId(object)
372             if (storageId)
373                 hints.domStorageId = InjectedScriptHost.evaluate("(" + storageId + ")");
374             break;
375         }
376
377         CommandLineAPIHost.inspect(objectId, hints);
378         return object;
379     }
380 }
381
382 injectedScript.CommandLineAPI = CommandLineAPI;
383 injectedScript._commandLineAPIImpl = new CommandLineAPIImpl();
384
385 // This Module doesn't expose an object, it just adds an extension that InjectedScript uses.
386 // However, we return an empty object, so that InjectedScript knows this module has been loaded.
387 return {};
388
389 })