File: utils.js

package info (click to toggle)
webkit2gtk 2.42.2-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 362,452 kB
  • sloc: cpp: 2,881,971; javascript: 282,447; ansic: 134,088; python: 43,789; ruby: 18,308; perl: 15,872; asm: 14,389; xml: 4,395; yacc: 2,350; sh: 2,074; java: 1,734; lex: 1,323; makefile: 288; pascal: 60
file content (335 lines) | stat: -rw-r--r-- 13,064 bytes parent folder | download | duplicates (14)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
/*
 * Copyright (C) 2022 Igalia S.L.
 * Copyright (C) 2017 Apple Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 */

var utils = { };

utils.nodeIsElement = function(node) {
    return !!node && node.nodeType === Node.ELEMENT_NODE;
}

utils.enclosingNodeOrSelfMatchingPredicate = function(targetNode, predicate) {
    for (let node = targetNode; node && node !== targetNode.getRootNode(); node = node.parentNode)
        if (predicate(node))
            return node;

    return null;
}

utils.parentElementForElement = function(element) {
    if (!element)
        return null;

    return utils.enclosingNodeOrSelfMatchingPredicate(element.parentNode, utils.nodeIsElement);
}

utils.cascadedStylePropertyForElement = function(element, property) {
    if (!element || !property)
        return null;

    let computedStyle = window.getComputedStyle(element);
    let computedStyleProperty = computedStyle.getPropertyValue(property);
    if (computedStyleProperty && computedStyleProperty !== "inherit")
        return computedStyleProperty;

    // Ideally getPropertyValue would return the 'used' or 'actual' value, but
    // it doesn't for legacy reasons. So we need to do our own poor man's cascade.
    // Fall back to the first non-'inherit' value found in an ancestor.
    // In any case, getPropertyValue will not return 'initial'.

    // FIXME: will this incorrectly inherit non-inheritable CSS properties?
    // I think all important non-inheritable properties (width, height, etc.)
    // for our purposes here are specially resolved, so this may not be an issue.
    // Specification is here: https://drafts.csswg.org/cssom/#resolved-values
    let parentElement = utils.parentElementForElement(element);
    return utils.cascadedStylePropertyForElement(parentElement, property);
}

utils.isShown = function(element) {
    function enclosingElementOrSelfMatchingPredicate(targetElement, predicate) {
        for (let element = targetElement; element && element !== targetElement.getRootNode(); element = utils.parentElementForElement(element))
            if (predicate(element))
                return element;

        return null;
    }

    function elementSubtreeHasNonZeroDimensions(element) {
        let boundingBox = element.getBoundingClientRect();
        if (boundingBox.width > 0 && boundingBox.height > 0)
            return true;

        // Paths can have a zero width or height. Treat them as shown if the stroke width is positive.
        if (element.tagName.toUpperCase() === "PATH" && boundingBox.width + boundingBox.height > 0) {
            let strokeWidth = utils.cascadedStylePropertyForElement(element, "stroke-width");
            return !!strokeWidth && (parseInt(strokeWidth, 10) > 0);
        }

        let cascadedOverflow = utils.cascadedStylePropertyForElement(element, "overflow");
        if (cascadedOverflow === "hidden")
            return false;

        // If the container's overflow is not hidden and it has zero size, consider the
        // container to have non-zero dimensions if a child node has non-zero dimensions.
        return Array.from(element.childNodes).some((childNode) => {
            if (childNode.nodeType === Node.TEXT_NODE)
                return true;

            if (utils.nodeIsElement(childNode))
                return elementSubtreeHasNonZeroDimensions(childNode);

            return false;
        });
    }

    function elementOverflowsContainer(element) {
        let cascadedOverflow = utils.cascadedStylePropertyForElement(element, "overflow");
        if (cascadedOverflow !== "hidden")
            return false;

        // FIXME: this needs to take into account the scroll position of the element,
        // the display modes of it and its ancestors, and the container it overflows.
        // See Selenium's bot.dom.getOverflowState atom for an exhaustive list of edge cases.
        return true;
    }

    function isElementSubtreeHiddenByOverflow(element) {
        if (!element)
            return false;

        if (!elementOverflowsContainer(element))
            return false;

        if (!element.childNodes.length)
            return false;

        // This element's subtree is hidden by overflow if all child subtrees are as well.
        return Array.from(element.childNodes).every((childNode) => {
            // Returns true if the child node is overflowed or otherwise hidden.
            // Base case: not an element, has zero size, scrolled out, or doesn't overflow container.
            if (!utils.nodeIsElement(childNode))
                return true;

            if (!elementSubtreeHasNonZeroDimensions(childNode))
                return true;

            // Recurse.
            return isElementSubtreeHiddenByOverflow(childNode);
        });
    }

    // This is a partial reimplementation of Selenium's "element is displayed" algorithm.
    // When the W3C specification's algorithm stabilizes, we should implement that.

    if (!(element instanceof Element))
        throw new Error("Cannot check the displayedness of a non-Element argument.");

    // Special cases for specific tag names.
    switch (element.tagName.toUpperCase()) {
    case "BODY":
        return true;

    case "SCRIPT":
    case "NOSCRIPT":
        return false;

    case "OPTGROUP":
    case "OPTION":
        // Option/optgroup are considered shown if the containing <select> is shown.
        let enclosingSelectElement = utils.enclosingNodeOrSelfMatchingPredicate(element, (e) => e.tagName.toUpperCase() === "SELECT");
        return utils.isShown(enclosingSelectElement);

    case "INPUT":
        // <input type="hidden"> is considered not shown.
        if (element.type === "hidden")
            return false;
        break;

    case "MAP":
        // FIXME: Selenium has special handling for <map> elements. We don't do anything now.

    default:
        break;
    }

    if (utils.cascadedStylePropertyForElement(element, "visibility") !== "visible")
        return false;

    let hasAncestorWithZeroOpacity = !!enclosingElementOrSelfMatchingPredicate(element, (e) => {
        return Number(utils.cascadedStylePropertyForElement(e, "opacity")) === 0;
    });
    let hasAncestorWithDisplayNone = !!enclosingElementOrSelfMatchingPredicate(element, (e) => {
        return utils.cascadedStylePropertyForElement(e, "display") === "none";
    });
    if (hasAncestorWithZeroOpacity || hasAncestorWithDisplayNone)
        return false;

    if (!elementSubtreeHasNonZeroDimensions(element))
        return false;

    if (isElementSubtreeHiddenByOverflow(element))
        return false;

    return true;
}

utils.getText = function(element) {
    var lines = [];

    function appendLinesFromTextNode(textNode, whitespace, textTransform) {
        // Remove zero-width characters.
        let text = textNode.nodeValue.replace(/[\u200b\u200e\u200f]/g, '');

        // Canonicalize the new lines.
        text = text.replace(/(\r\n|\r|\n)/g, '\n');

        let collapseAll = true;
        switch (whitespace) {
        case "normal":
        case "nowrap":
            // Collapse new lines.
            text = text.replace(/\n/g, ' ');
            break;
        case "pre":
        case "pre-wrap":
            // Convert all breaking spaces to be non-breaking.
            text = text.replace(/[ \f\t\v\u2028\u2029]/g, '\xa0');
            collapseAll = false;
            break;
        }

        if (collapseAll) {
            // Collapse all breaking spaces.
            text = text.replace(/[\ \f\t\v\u2028\u2029]+/g, ' ');
        }

        switch (textTransform) {
        case "capitalize":
            text = text.replace(/(^|[^\d\p{L}\p{S}])([\p{Ll}|\p{S}])/gu, function() {
                return arguments[1] + arguments[2].toUpperCase();
            });
            break;
        case "uppercase":
            text = text.toUpperCase();
            break;
        case "lowercase":
            text = text.toLowerCase();
            break;
        }

        let currentLine = lines.pop() || '';
        if (currentLine.endsWith(' ') && text.startsWith(' '))
            text = text.substr(1);
        lines.push(currentLine + text);
    }

    function appendLinesFromNode(node, shown, whitespace, textTransform) {
        switch (node.nodeType) {
        case Node.TEXT_NODE:
            if (shown)
                appendLinesFromTextNode(node, whitespace, textTransform);
            break;
        case Node.ELEMENT_NODE:
            if (node.tagName.toUpperCase() == "SLOT") {
                let parentNode = node;
                while (parentNode.parentNode)
                    parentNode = parentNode.parentNode;
                if (parentNode instanceof ShadowRoot) {
                    Array.from(node.assignedNodes()).forEach((childNode) => {
                        appendLinesFromNode(childNode, shown, whitespace, textTransform);
                    });
                    return;
                }
            }
            appendLinesFromElement(node);
            break;
        }
    }

    function appendLines(element) {
        function currentLine() {
            return lines[lines.length - 1] || '';
        }

        let isTableCell = false, display = null, isBlock = false;
        if (element.tagName.toUpperCase() === "BR")
            lines.push('');
        else {
            isTableCell = element.tagName.toUpperCase() === "TD";
            display = utils.cascadedStylePropertyForElement(element, "display");
            isBlock = !isTableCell
                && !(display === "inline"
                     || display === "inline-block"
                     || display === "inline-table"
                     || display === "none"
                     || display === "table-cell"
                     || display === "table-column"
                     || display === "table-column-group");
            let previousElementSibling = element.previousElementSibling;
            let previousDisplay = previousElementSibling ? utils.cascadedStylePropertyForElement(previousElementSibling, "display") : '';
            let elementFloat = utils.cascadedStylePropertyForElement(element, "float") || utils.cascadedStylePropertyForElement(element, "cssFloat");
            let runIntoThis = previousDisplay == "run-in" && elementFloat == "none";
            if (isBlock && !runIntoThis && /^[\s\xa0]*$/.test(currentLine()))
                lines.push('');
        }

        let shown = utils.isShown(element);
        let whitespace = null, textTransform = null;
        if (shown) {
            whitespace = utils.cascadedStylePropertyForElement(element, "white-space");
            textTransform = utils.cascadedStylePropertyForElement(element, "text-transform");
        }

        Array.from(element.childNodes).forEach((childNode) => {
            if (!childNode.assignedSlot)
                appendLinesFromNode(childNode, shown, whitespace, textTransform);
        });

        let line = currentLine();
        if ((isTableCell || display == "table-cell") && line && line.endsWith(' '))
            lines[lines.length - 1] += ' ';

        if (isBlock && display != "run-in" && /^[\s\xa0]*$/.test(line))
            lines.push('');
    }

    function appendLinesFromElement(element) {
        if (element.shadowRoot) {
            Array.from(element.shadowRoot.childNodes).forEach((childNode) => {
                appendLinesFromNode(childNode, true, null, null);
            });
        }

        appendLines(element);
    }

    appendLinesFromElement(element);

    lines = lines.map((str) => str.replace(/^[^\S\xa0]+|[^\S\xa0]+$/g, ''));
    let trimmed = lines.join('\n').replace(/^[^\S\xa0]+|[^\S\xa0]+$/g, '');

    // Replace non-breakable spaces with regular ones.
    return trimmed.replace(/\xa0/g, ' ');
}