Web Inspector: AXI: linkified refs to #document and #text are not usually navigable...
[WebKit-https.git] / Source / WebInspectorUI / UserInterface / Base / DOMUtilities.js
1 /*
2  * Copyright (C) 2011 Google Inc.  All rights reserved.
3  * Copyright (C) 2007, 2008, 2013 Apple Inc.  All rights reserved.
4  * Copyright (C) 2008 Matt Lilek <webkit@mattlilek.com>
5  * Copyright (C) 2009 Joseph Pecoraro
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1.  Redistributions of source code must retain the above copyright
12  *     notice, this list of conditions and the following disclaimer.
13  * 2.  Redistributions in binary form must reproduce the above copyright
14  *     notice, this list of conditions and the following disclaimer in the
15  *     documentation and/or other materials provided with the distribution.
16  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
17  *     its contributors may be used to endorse or promote products derived
18  *     from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
21  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
22  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
23  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
24  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
25  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
27  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
29  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31
32 WebInspector.roleSelectorForNode = function(node)
33 {
34     // This is proposed syntax for CSS 4 computed role selector :role(foo) and subject to change.
35     // See http://lists.w3.org/Archives/Public/www-style/2013Jul/0104.html
36     var title = "";
37     var role = node.computedRole();
38     if (role)
39         title = ":role(" + role + ")";
40     return title;
41 };
42
43 WebInspector.linkifyAccessibilityNodeReference = function(node)
44 {
45     if (!node)
46         return null;
47     // Same as linkifyNodeReference except the link text has the classnames removed...
48     // ...for list brevity, and both text and title have roleSelectorForNode appended.
49     var link = WebInspector.linkifyNodeReference(node);
50     var tagIdSelector = link.title;
51     var classSelectorIndex = tagIdSelector.indexOf(".");
52     if (classSelectorIndex > -1)
53         tagIdSelector = tagIdSelector.substring(0, classSelectorIndex);
54     var roleSelector = WebInspector.roleSelectorForNode(node);
55     link.textContent = tagIdSelector + roleSelector;
56     link.title += roleSelector;
57     return link;
58 };
59
60 WebInspector.linkifyNodeReference = function(node, maxLength)
61 {
62     let displayName = node.displayName;
63     if (!isNaN(maxLength))
64         displayName = displayName.truncate(maxLength);
65
66     let link = document.createElement("span");
67     link.append(displayName);
68     link.setAttribute("role", "link");
69     
70     link.title = displayName;
71     
72     let nodeType = node.nodeType();
73     if ((nodeType !== Node.DOCUMENT_NODE || node.parentNode) && nodeType !== Node.TEXT_NODE)
74         link.className = "node-link";
75
76     link.addEventListener("click", WebInspector.domTreeManager.inspectElement.bind(WebInspector.domTreeManager, node.id));
77     link.addEventListener("mouseover", WebInspector.domTreeManager.highlightDOMNode.bind(WebInspector.domTreeManager, node.id, "all"));
78     link.addEventListener("mouseout", WebInspector.domTreeManager.hideDOMNodeHighlight.bind(WebInspector.domTreeManager));
79
80     return link;
81 };
82
83 function createSVGElement(tagName)
84 {
85     return document.createElementNS("http://www.w3.org/2000/svg", tagName);
86 }
87
88 WebInspector.cssPath = function(node)
89 {
90     console.assert(node instanceof WebInspector.DOMNode, "Expected a DOMNode.");
91     if (node.nodeType() !== Node.ELEMENT_NODE)
92         return "";
93
94     let suffix = "";
95     if (node.isPseudoElement()) {
96         suffix = "::" + node.pseudoType();
97         node = node.parentNode;
98     }
99
100     let components = [];
101     while (node) {
102         let component = WebInspector.cssPathComponent(node);
103         if (!component)
104             break;
105         components.push(component);
106         if (component.done)
107             break;
108         node = node.parentNode;
109     }
110
111     components.reverse();
112     return components.map((x) => x.value).join(" > ") + suffix;
113 };
114
115 WebInspector.cssPathComponent = function(node)
116 {
117     console.assert(node instanceof WebInspector.DOMNode, "Expected a DOMNode.");
118     console.assert(!node.isPseudoElement());
119     if (node.nodeType() !== Node.ELEMENT_NODE)
120         return null;
121
122     let nodeName = node.nodeNameInCorrectCase();
123     let lowerNodeName = node.nodeName().toLowerCase();
124
125     // html, head, and body are unique nodes.
126     if (lowerNodeName === "body" || lowerNodeName === "head" || lowerNodeName === "html")
127         return {value: nodeName, done: true};
128
129     // #id is unique.
130     let id = node.getAttribute("id");
131     if (id)
132         return {value: node.escapedIdSelector, done: true};
133
134     // Root node does not have siblings.
135     if (!node.parentNode || node.parentNode.nodeType() === Node.DOCUMENT_NODE)
136         return {value: nodeName, done: true};
137
138     // Find uniqueness among siblings.
139     //   - look for a unique className
140     //   - look for a unique tagName
141     //   - fallback to nth-child()
142
143     function classNames(node) {
144         let classAttribute = node.getAttribute("class");
145         return classAttribute ? classAttribute.trim().split(/\s+/) : [];
146     }
147
148     let nthChildIndex = -1;
149     let hasUniqueTagName = true;
150     let uniqueClasses = new Set(classNames(node));
151
152     let siblings = node.parentNode.children;
153     let elementIndex = 0;
154     for (let sibling of siblings) {
155         if (sibling.nodeType() !== Node.ELEMENT_NODE)
156             continue;
157
158         elementIndex++;
159         if (sibling === node) {
160             nthChildIndex = elementIndex;
161             continue;
162         }
163
164         if (sibling.nodeNameInCorrectCase() === nodeName)
165             hasUniqueTagName = false;
166
167         if (uniqueClasses.size) {
168             let siblingClassNames = classNames(sibling);
169             for (let className of siblingClassNames)
170                 uniqueClasses.delete(className);
171         }
172     }
173
174     let selector = nodeName;
175     if (lowerNodeName === "input" && node.getAttribute("type") && !uniqueClasses.size)
176         selector += `[type="${node.getAttribute("type")}"]`;
177     if (!hasUniqueTagName) {
178         if (uniqueClasses.size)
179             selector += node.escapedClassSelector;
180         else
181             selector += `:nth-child(${nthChildIndex})`;
182     }
183
184     return {value: selector, done: false};
185 };
186
187 WebInspector.xpath = function(node)
188 {
189     console.assert(node instanceof WebInspector.DOMNode, "Expected a DOMNode.");
190
191     if (node.nodeType() === Node.DOCUMENT_NODE)
192         return "/";
193
194     let components = [];
195     while (node) {
196         let component = WebInspector.xpathComponent(node);
197         if (!component)
198             break;
199         components.push(component);
200         if (component.done)
201             break;
202         node = node.parentNode;
203     }
204
205     components.reverse();
206
207     let prefix = components.length && components[0].done ? "" : "/";
208     return prefix + components.map((x) => x.value).join("/");
209 };
210
211 WebInspector.xpathComponent = function(node)
212 {
213     console.assert(node instanceof WebInspector.DOMNode, "Expected a DOMNode.");
214
215     let index = WebInspector.xpathIndex(node);
216     if (index === -1)
217         return null;
218
219     let value;
220
221     switch (node.nodeType()) {
222     case Node.DOCUMENT_NODE:
223         return {value: "", done: true};
224     case Node.ELEMENT_NODE:
225         var id = node.getAttribute("id");
226         if (id)
227             return {value: `//*[@id="${id}"]`, done: true};
228         value = node.localName();
229         break;
230     case Node.ATTRIBUTE_NODE:
231         value = `@${node.nodeName()}`;
232         break;
233     case Node.TEXT_NODE:
234     case Node.CDATA_SECTION_NODE:
235         value = "text()";
236         break;
237     case Node.COMMENT_NODE:
238         value = "comment()";
239         break;
240     case Node.PROCESSING_INSTRUCTION_NODE:
241         value = "processing-instruction()";
242         break
243     default:
244         value = "";
245         break;
246     }
247
248     if (index > 0)
249         value += `[${index}]`;
250
251     return {value, done: false};
252 };
253
254 WebInspector.xpathIndex = function(node)
255 {
256     // Root node.
257     if (!node.parentNode)
258         return 0;
259
260     // No siblings.
261     let siblings = node.parentNode.children;
262     if (siblings.length <= 1)
263         return 0;
264
265     // Find uniqueness among siblings.
266     //   - look for a unique localName
267     //   - fallback to index
268
269     function isSimiliarNode(a, b) {
270         if (a === b)
271             return true;
272
273         let aType = a.nodeType();
274         let bType = b.nodeType();
275
276         if (aType === Node.ELEMENT_NODE && bType === Node.ELEMENT_NODE)
277             return a.localName() === b.localName();
278
279         // XPath CDATA and text() are the same.
280         if (aType === Node.CDATA_SECTION_NODE)
281             aType === Node.TEXT_NODE;
282         if (bType === Node.CDATA_SECTION_NODE)
283             bType === Node.TEXT_NODE;
284
285         return aType === bType;
286     }
287
288     let unique = true;
289     let xPathIndex = -1;
290
291     let xPathIndexCounter = 1; // XPath indices start at 1.
292     for (let sibling of siblings) {
293         if (!isSimiliarNode(node, sibling))
294             continue;
295
296         if (node === sibling) {
297             xPathIndex = xPathIndexCounter;
298             if (!unique)
299                 return xPathIndex;
300         } else {
301             unique = false;
302             if (xPathIndex !== -1)
303                 return xPathIndex;
304         }
305
306         xPathIndexCounter++;
307     }
308
309     if (unique)
310         return 0;
311
312     console.assert(xPathIndex > 0, "Should have found the node.");
313     return xPathIndex;
314 };