diff options
Diffstat (limited to 'devtools/client/inspector/shared/tooltips-overlay.js')
| -rw-r--r-- | devtools/client/inspector/shared/tooltips-overlay.js | 546 |
1 files changed, 546 insertions, 0 deletions
diff --git a/devtools/client/inspector/shared/tooltips-overlay.js b/devtools/client/inspector/shared/tooltips-overlay.js new file mode 100644 index 0000000000..3bfed4677d --- /dev/null +++ b/devtools/client/inspector/shared/tooltips-overlay.js @@ -0,0 +1,546 @@ +/* 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"; + +/** + * The tooltip overlays are tooltips that appear when hovering over property values and + * editor tooltips that appear when clicking swatch based editors. + */ + +const flags = require("resource://devtools/shared/flags.js"); +const { + VIEW_NODE_CSS_QUERY_CONTAINER, + VIEW_NODE_FONT_TYPE, + VIEW_NODE_IMAGE_URL_TYPE, + VIEW_NODE_INACTIVE_CSS, + VIEW_NODE_VALUE_TYPE, + VIEW_NODE_VARIABLE_TYPE, +} = require("resource://devtools/client/inspector/shared/node-types.js"); + +loader.lazyRequireGetter( + this, + "getColor", + "resource://devtools/client/shared/theme.js", + true +); +loader.lazyRequireGetter( + this, + "HTMLTooltip", + "resource://devtools/client/shared/widgets/tooltip/HTMLTooltip.js", + true +); +loader.lazyRequireGetter( + this, + ["getImageDimensions", "setImageTooltip", "setBrokenImageTooltip"], + "resource://devtools/client/shared/widgets/tooltip/ImageTooltipHelper.js", + true +); +loader.lazyRequireGetter( + this, + "setVariableTooltip", + "resource://devtools/client/shared/widgets/tooltip/VariableTooltipHelper.js", + true +); +loader.lazyRequireGetter( + this, + "InactiveCssTooltipHelper", + "resource://devtools/client/shared/widgets/tooltip/inactive-css-tooltip-helper.js", + false +); +loader.lazyRequireGetter( + this, + "CssCompatibilityTooltipHelper", + "resource://devtools/client/shared/widgets/tooltip/css-compatibility-tooltip-helper.js", + false +); +loader.lazyRequireGetter( + this, + "CssQueryContainerTooltipHelper", + "resource://devtools/client/shared/widgets/tooltip/css-query-container-tooltip-helper.js", + false +); + +const PREF_IMAGE_TOOLTIP_SIZE = "devtools.inspector.imagePreviewTooltipSize"; + +// Types of existing tooltips +const TOOLTIP_CSS_COMPATIBILITY = "css-compatibility"; +const TOOLTIP_CSS_QUERY_CONTAINER = "css-query-info"; +const TOOLTIP_FONTFAMILY_TYPE = "font-family"; +const TOOLTIP_IMAGE_TYPE = "image"; +const TOOLTIP_INACTIVE_CSS = "inactive-css"; +const TOOLTIP_VARIABLE_TYPE = "variable"; + +// Telemetry +const TOOLTIP_SHOWN_SCALAR = "devtools.tooltip.shown"; + +/** + * Manages all tooltips in the style-inspector. + * + * @param {CssRuleView|CssComputedView} view + * Either the rule-view or computed-view panel + */ +function TooltipsOverlay(view) { + this.view = view; + this._instances = new Map(); + + this._onNewSelection = this._onNewSelection.bind(this); + this.view.inspector.selection.on("new-node-front", this._onNewSelection); + + this.addToView(); +} + +TooltipsOverlay.prototype = { + get isEditing() { + for (const [, tooltip] of this._instances) { + if (typeof tooltip.isEditing == "function" && tooltip.isEditing()) { + return true; + } + } + return false; + }, + + /** + * Add the tooltips overlay to the view. This will start tracking mouse + * movements and display tooltips when needed + */ + addToView() { + if (this._isStarted || this._isDestroyed) { + return; + } + + this._isStarted = true; + + this.inactiveCssTooltipHelper = new InactiveCssTooltipHelper(); + this.compatibilityTooltipHelper = new CssCompatibilityTooltipHelper(); + this.cssQueryContainerTooltipHelper = new CssQueryContainerTooltipHelper(); + + // Instantiate the interactiveTooltip and preview tooltip when the + // rule/computed view is hovered over in order to call + // `tooltip.startTogglingOnHover`. This will allow the tooltip to be shown + // when an appropriate element is hovered over. + for (const type of ["interactiveTooltip", "previewTooltip"]) { + if (flags.testing) { + this.getTooltip(type); + } else { + // Lazily get the preview tooltip to avoid loading HTMLTooltip. + this.view.element.addEventListener( + "mousemove", + () => { + this.getTooltip(type); + }, + { once: true } + ); + } + } + }, + + /** + * Lazily fetch and initialize the different tooltips that are used in the inspector. + * These tooltips are attached to the toolbox document if they require a popup panel. + * Otherwise, it is attached to the inspector panel document if it is an inline editor. + * + * @param {String} name + * Identifier name for the tooltip + */ + getTooltip(name) { + let tooltip = this._instances.get(name); + if (tooltip) { + return tooltip; + } + const { doc } = this.view.inspector.toolbox; + switch (name) { + case "colorPicker": + const SwatchColorPickerTooltip = require("resource://devtools/client/shared/widgets/tooltip/SwatchColorPickerTooltip.js"); + tooltip = new SwatchColorPickerTooltip(doc, this.view.inspector); + break; + case "cubicBezier": + const SwatchCubicBezierTooltip = require("resource://devtools/client/shared/widgets/tooltip/SwatchCubicBezierTooltip.js"); + tooltip = new SwatchCubicBezierTooltip(doc); + break; + case "linearEaseFunction": + const SwatchLinearEasingFunctionTooltip = require("devtools/client/shared/widgets/tooltip/SwatchLinearEasingFunctionTooltip"); + tooltip = new SwatchLinearEasingFunctionTooltip(doc); + break; + case "filterEditor": + const SwatchFilterTooltip = require("resource://devtools/client/shared/widgets/tooltip/SwatchFilterTooltip.js"); + tooltip = new SwatchFilterTooltip(doc); + break; + case "interactiveTooltip": + tooltip = new HTMLTooltip(doc, { + type: "doorhanger", + useXulWrapper: true, + noAutoHide: true, + }); + tooltip.startTogglingOnHover( + this.view.element, + this.onInteractiveTooltipTargetHover.bind(this), + { + interactive: true, + } + ); + break; + case "previewTooltip": + tooltip = new HTMLTooltip(doc, { + type: "arrow", + useXulWrapper: true, + }); + tooltip.startTogglingOnHover( + this.view.element, + this._onPreviewTooltipTargetHover.bind(this) + ); + break; + default: + throw new Error(`Unsupported tooltip '${name}'`); + } + this._instances.set(name, tooltip); + return tooltip; + }, + + /** + * Remove the tooltips overlay from the view. This will stop tracking mouse + * movements and displaying tooltips + */ + removeFromView() { + if (!this._isStarted || this._isDestroyed) { + return; + } + + for (const [, tooltip] of this._instances) { + tooltip.destroy(); + } + + this.inactiveCssTooltipHelper.destroy(); + this.compatibilityTooltipHelper.destroy(); + + this._isStarted = false; + }, + + /** + * Given a hovered node info, find out which type of tooltip should be shown, + * if any + * + * @param {Object} nodeInfo + * @return {String} The tooltip type to be shown, or null + */ + _getTooltipType({ type, value: prop }) { + let tooltipType = null; + + // Image preview tooltip + if (type === VIEW_NODE_IMAGE_URL_TYPE) { + tooltipType = TOOLTIP_IMAGE_TYPE; + } + + // Font preview tooltip + if ( + (type === VIEW_NODE_VALUE_TYPE && prop.property === "font-family") || + type === VIEW_NODE_FONT_TYPE + ) { + const value = prop.value.toLowerCase(); + if (value !== "inherit" && value !== "unset" && value !== "initial") { + tooltipType = TOOLTIP_FONTFAMILY_TYPE; + } + } + + // Inactive CSS tooltip + if (type === VIEW_NODE_INACTIVE_CSS) { + tooltipType = TOOLTIP_INACTIVE_CSS; + } + + // Variable preview tooltip + if (type === VIEW_NODE_VARIABLE_TYPE) { + tooltipType = TOOLTIP_VARIABLE_TYPE; + } + + // Container info tooltip + if (type === VIEW_NODE_CSS_QUERY_CONTAINER) { + tooltipType = TOOLTIP_CSS_QUERY_CONTAINER; + } + + return tooltipType; + }, + + /** + * Executed by the tooltip when the pointer hovers over an element of the + * view. Used to decide whether the tooltip should be shown or not and to + * actually put content in it. + * Checks if the hovered target is a css value we support tooltips for. + * + * @param {DOMNode} target The currently hovered node + * @return {Promise} + */ + async _onPreviewTooltipTargetHover(target) { + const nodeInfo = this.view.getNodeInfo(target); + if (!nodeInfo) { + // The hovered node isn't something we care about + return false; + } + + const type = this._getTooltipType(nodeInfo); + if (!type) { + // There is no tooltip type defined for the hovered node + return false; + } + + for (const [, tooltip] of this._instances) { + if (tooltip.isVisible()) { + tooltip.revert(); + tooltip.hide(); + } + } + + const inspector = this.view.inspector; + + if (type === TOOLTIP_IMAGE_TYPE) { + try { + await this._setImagePreviewTooltip(nodeInfo.value.url); + } catch (e) { + await setBrokenImageTooltip( + this.getTooltip("previewTooltip"), + this.view.inspector.panelDoc + ); + } + + this.sendOpenScalarToTelemetry(type); + + return true; + } + + if (type === TOOLTIP_FONTFAMILY_TYPE) { + const font = nodeInfo.value.value; + const nodeFront = inspector.selection.nodeFront; + await this._setFontPreviewTooltip(font, nodeFront); + + this.sendOpenScalarToTelemetry(type); + + if (nodeInfo.type === VIEW_NODE_FONT_TYPE) { + // If the hovered element is on the font family span, anchor + // the tooltip on the whole property value instead. + return target.parentNode; + } + return true; + } + + if ( + type === TOOLTIP_VARIABLE_TYPE && + nodeInfo.value.value.startsWith("--") + ) { + const variable = nodeInfo.value.variable; + await this._setVariablePreviewTooltip(variable); + + this.sendOpenScalarToTelemetry(type); + + return true; + } + + return false; + }, + + /** + * Executed by the tooltip when the pointer hovers over an element of the + * view. Used to decide whether the tooltip should be shown or not and to + * actually put content in it. + * Checks if the hovered target is a css value we support tooltips for. + * + * @param {DOMNode} target + * The currently hovered node + * @return {Boolean} + * true if shown, false otherwise. + */ + async onInteractiveTooltipTargetHover(target) { + if (target.classList.contains("ruleview-compatibility-warning")) { + const nodeCompatibilityInfo = await this.view.getNodeCompatibilityInfo( + target + ); + + await this.compatibilityTooltipHelper.setContent( + nodeCompatibilityInfo, + this.getTooltip("interactiveTooltip") + ); + + this.sendOpenScalarToTelemetry(TOOLTIP_CSS_COMPATIBILITY); + return true; + } + + const nodeInfo = this.view.getNodeInfo(target); + if (!nodeInfo) { + // The hovered node isn't something we care about. + return false; + } + + const type = this._getTooltipType(nodeInfo); + if (!type) { + // There is no tooltip type defined for the hovered node. + return false; + } + + // Remove previous tooltip instances. + for (const [, tooltip] of this._instances) { + if (tooltip.isVisible()) { + if (tooltip.revert) { + tooltip.revert(); + } + tooltip.hide(); + } + } + + if (type === TOOLTIP_INACTIVE_CSS) { + // Ensure this is the correct node and not a parent. + if (!target.classList.contains("ruleview-unused-warning")) { + return false; + } + + await this.inactiveCssTooltipHelper.setContent( + nodeInfo.value, + this.getTooltip("interactiveTooltip") + ); + + this.sendOpenScalarToTelemetry(type); + + return true; + } + + if (type === TOOLTIP_CSS_QUERY_CONTAINER) { + // Ensure this is the correct node and not a parent. + if (!target.closest(".container-query .container-query-declaration")) { + return false; + } + + await this.cssQueryContainerTooltipHelper.setContent( + nodeInfo.value, + this.getTooltip("interactiveTooltip") + ); + + this.sendOpenScalarToTelemetry(type); + + return true; + } + + return false; + }, + + /** + * Send a telemetry Scalar showing that a tooltip of `type` has been opened. + * + * @param {String} type + * The node type from `devtools/client/inspector/shared/node-types` or the Tooltip type. + */ + sendOpenScalarToTelemetry(type) { + this.view.inspector.telemetry.keyedScalarAdd(TOOLTIP_SHOWN_SCALAR, type, 1); + }, + + /** + * Set the content of the preview tooltip to display an image preview. The image URL can + * be relative, a call will be made to the debuggee to retrieve the image content as an + * imageData URI. + * + * @param {String} imageUrl + * The image url value (may be relative or absolute). + * @return {Promise} A promise that resolves when the preview tooltip content is ready + */ + async _setImagePreviewTooltip(imageUrl) { + const doc = this.view.inspector.panelDoc; + const maxDim = Services.prefs.getIntPref(PREF_IMAGE_TOOLTIP_SIZE); + + let naturalWidth, naturalHeight; + if (imageUrl.startsWith("data:")) { + // If the imageUrl already is a data-url, save ourselves a round-trip + const size = await getImageDimensions(doc, imageUrl); + naturalWidth = size.naturalWidth; + naturalHeight = size.naturalHeight; + } else { + const inspectorFront = this.view.inspector.inspectorFront; + const { data, size } = await inspectorFront.getImageDataFromURL( + imageUrl, + maxDim + ); + imageUrl = await data.string(); + naturalWidth = size.naturalWidth; + naturalHeight = size.naturalHeight; + } + + await setImageTooltip(this.getTooltip("previewTooltip"), doc, imageUrl, { + maxDim, + naturalWidth, + naturalHeight, + }); + }, + + /** + * Set the content of the preview tooltip to display a font family preview. + * + * @param {String} font + * The font family value. + * @param {object} nodeFront + * The NodeActor that will used to retrieve the dataURL for the font + * family tooltip contents. + * @return {Promise} A promise that resolves when the preview tooltip content is ready + */ + async _setFontPreviewTooltip(font, nodeFront) { + if ( + !font || + !nodeFront || + typeof nodeFront.getFontFamilyDataURL !== "function" + ) { + throw new Error("Unable to create font preview tooltip content."); + } + + font = font.replace(/"/g, "'"); + font = font.replace("!important", ""); + font = font.trim(); + + const fillStyle = getColor("body-color"); + const { data, size: maxDim } = await nodeFront.getFontFamilyDataURL( + font, + fillStyle + ); + + const imageUrl = await data.string(); + const doc = this.view.inspector.panelDoc; + const { naturalWidth, naturalHeight } = await getImageDimensions( + doc, + imageUrl + ); + + await setImageTooltip(this.getTooltip("previewTooltip"), doc, imageUrl, { + hideDimensionLabel: true, + hideCheckeredBackground: true, + maxDim, + naturalWidth, + naturalHeight, + }); + }, + + /** + * Set the content of the preview tooltip to display a variable preview. + * + * @param {String} text + * The text to display for the variable tooltip + * @return {Promise} A promise that resolves when the preview tooltip content is ready + */ + async _setVariablePreviewTooltip(text) { + const doc = this.view.inspector.panelDoc; + await setVariableTooltip(this.getTooltip("previewTooltip"), doc, text); + }, + + _onNewSelection() { + for (const [, tooltip] of this._instances) { + tooltip.hide(); + } + }, + + /** + * Destroy this overlay instance, removing it from the view + */ + destroy() { + this.removeFromView(); + + this.view.inspector.selection.off("new-node-front", this._onNewSelection); + this.view = null; + + this._isDestroyed = true; + }, +}; + +module.exports = TooltipsOverlay; |