summaryrefslogtreecommitdiffstats
path: root/devtools/server/actors/highlighters/selector.js
diff options
context:
space:
mode:
authorMatt A. Tobin <mattatobin@localhost.localdomain>2018-02-02 04:16:08 -0500
committerMatt A. Tobin <mattatobin@localhost.localdomain>2018-02-02 04:16:08 -0500
commit5f8de423f190bbb79a62f804151bc24824fa32d8 (patch)
tree10027f336435511475e392454359edea8e25895d /devtools/server/actors/highlighters/selector.js
parent49ee0794b5d912db1f95dce6eb52d781dc210db5 (diff)
downloadUXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar
UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.gz
UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.lz
UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.xz
UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.zip
Add m-esr52 at 52.6.0
Diffstat (limited to 'devtools/server/actors/highlighters/selector.js')
-rw-r--r--devtools/server/actors/highlighters/selector.js83
1 files changed, 83 insertions, 0 deletions
diff --git a/devtools/server/actors/highlighters/selector.js b/devtools/server/actors/highlighters/selector.js
new file mode 100644
index 000000000..557a6d541
--- /dev/null
+++ b/devtools/server/actors/highlighters/selector.js
@@ -0,0 +1,83 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+"use strict";
+
+const { isNodeValid } = require("./utils/markup");
+const { BoxModelHighlighter } = require("./box-model");
+
+// How many maximum nodes can be highlighted at the same time by the
+// SelectorHighlighter
+const MAX_HIGHLIGHTED_ELEMENTS = 100;
+
+/**
+ * The SelectorHighlighter runs a given selector through querySelectorAll on the
+ * document of the provided context node and then uses the BoxModelHighlighter
+ * to highlight the matching nodes
+ */
+function SelectorHighlighter(highlighterEnv) {
+ this.highlighterEnv = highlighterEnv;
+ this._highlighters = [];
+}
+
+SelectorHighlighter.prototype = {
+ typeName: "SelectorHighlighter",
+
+ /**
+ * Show BoxModelHighlighter on each node that matches that provided selector.
+ * @param {DOMNode} node A context node that is used to get the document on
+ * which querySelectorAll should be executed. This node will NOT be
+ * highlighted.
+ * @param {Object} options Should at least contain the 'selector' option, a
+ * string that will be used in querySelectorAll. On top of this, all of the
+ * valid options to BoxModelHighlighter.show are also valid here.
+ */
+ show: function (node, options = {}) {
+ this.hide();
+
+ if (!isNodeValid(node) || !options.selector) {
+ return false;
+ }
+
+ let nodes = [];
+ try {
+ nodes = [...node.ownerDocument.querySelectorAll(options.selector)];
+ } catch (e) {
+ // It's fine if the provided selector is invalid, nodes will be an empty
+ // array.
+ }
+
+ delete options.selector;
+
+ let i = 0;
+ for (let matchingNode of nodes) {
+ if (i >= MAX_HIGHLIGHTED_ELEMENTS) {
+ break;
+ }
+
+ let highlighter = new BoxModelHighlighter(this.highlighterEnv);
+ if (options.fill) {
+ highlighter.regionFill[options.region || "border"] = options.fill;
+ }
+ highlighter.show(matchingNode, options);
+ this._highlighters.push(highlighter);
+ i++;
+ }
+
+ return true;
+ },
+
+ hide: function () {
+ for (let highlighter of this._highlighters) {
+ highlighter.destroy();
+ }
+ this._highlighters = [];
+ },
+
+ destroy: function () {
+ this.hide();
+ this.highlighterEnv = null;
+ }
+};
+exports.SelectorHighlighter = SelectorHighlighter;