Web Inspector: [Extensions API] add audit formatters for remote objects and DOM elements
[WebKit-https.git] / Source / WebCore / inspector / front-end / AuditFormatters.js
1 /*
2  * Copyright (C) 2012 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 WebInspector.applyFormatters = function(value)
32 {
33     var formatter;
34     var type = typeof value;
35     var args;
36
37     switch (type) {
38         case "string":
39         case "boolean":
40         case "number":
41             formatter = WebInspector.AuditFormatters.text;
42             args = [ value.toString() ];
43             break;
44
45         case "object":
46             if (value instanceof Node)
47                 return value;
48             if (value instanceof Array) {
49                 formatter = WebInspector.AuditFormatters.concat;
50                 args = value;
51             } else if (value.type && value.arguments) {
52                 formatter = WebInspector.AuditFormatters[value.type];
53                 args = value.arguments;
54             }
55     }
56     if (!formatter)
57         throw "Invalid value or formatter: " + type + JSON.stringify(value);
58
59     return formatter.apply(null, args);
60 }
61
62 WebInspector.AuditFormatters = {
63     text: function(text)
64     {
65         return document.createTextNode(text);
66     },
67
68     snippet: function(snippetText)
69     {
70         var div = document.createElement("div");
71         div.textContent = snippetText;
72         div.className = "source-code";
73         return div;
74     },
75
76     concat: function()
77     {
78         var parent = document.createElement("span");
79         for (var arg = 0; arg < arguments.length; ++arg)
80             parent.appendChild(WebInspector.applyFormatters(arguments[arg]));
81         return parent;
82     },
83
84     url: function(url, displayText, allowExternalNavigation)
85     {
86         var a = document.createElement("a");
87         a.href = url;
88         a.title = url;
89         a.textContent = displayText || url;
90         if (allowExternalNavigation)
91             a.target = "_blank";
92         return a;
93     },
94
95     resourceLink: function(url, line)
96     {
97         // FIXME: use WebInspector.DebuggerPresentationModel.Linkifier
98         return WebInspector.linkifyResourceAsNode(url, line, "console-message-url webkit-html-resource-link");
99     },
100
101     /**
102      * @param {string} expression
103      * @param {string} title
104      */
105     object: function(expression, title)
106     {
107         var parentElement = document.createElement("div");
108         function onEvaluate(remoteObject)
109         {
110             var section = new WebInspector.ObjectPropertiesSection(remoteObject, title);
111             section.expanded = true;
112             section.editable = false;
113             parentElement.appendChild(section.element);
114         }
115         WebInspector.AuditFormatters.Utilities.evaluate(expression, onEvaluate);
116         return parentElement;
117     },
118
119     /**
120      * @param {string} expression
121      */
122     node: function(expression)
123     {
124         var treeOutline = new WebInspector.ElementsTreeOutline(false, false, true);
125         /**
126          * @param {?number} nodeId
127          */
128         function onNodeAvailable(nodeId)
129         {
130             if (!nodeId)
131                 return;
132             treeOutline.rootDOMNode = WebInspector.domAgent.nodeForId(nodeId);
133             treeOutline.element.addStyleClass("outline-disclosure");
134             treeOutline.setVisible(true);
135         }
136         /**
137          * @param {WebInspector.RemoteObject} remoteObject
138          */
139         function onEvaluate(remoteObject)
140         {
141             remoteObject.pushNodeToFrontend(onNodeAvailable);
142         }
143         WebInspector.AuditFormatters.Utilities.evaluate(expression, onEvaluate);
144         return treeOutline.element;
145     }
146 };
147
148 WebInspector.AuditFormatters.Utilities = {
149     /**
150      * @param {string} expression
151      * @param {function(WebInspector.RemoteObject)} callback
152      */
153     evaluate: function(expression, callback)
154     {
155         /**
156          * @param {?string} error
157          * @param {?RuntimeAgent.RemoteObject} result
158          * @param {boolean=} wasThrown
159          */
160         function onEvaluate(error, result, wasThrown)
161         {
162             if (wasThrown)
163                 return;
164             var object = WebInspector.RemoteObject.fromPayload(result);
165             callback(object);
166         }
167         RuntimeAgent.evaluate(expression, "extension-watch", true, undefined, undefined, undefined, onEvaluate);
168     }
169 };
170