mirror of
https://github.com/google/blockly.git
synced 2026-01-07 00:50:27 +01:00
ff9320f8d9
* Migrate core/utils/xml.js to ES6 const/let * Migrate core/utils/xml.js to goog.module The document() function is renamed to getDocument() so as to avoid shadowing the global of the same name. * clang-format core/utils/xml.js * Call monkey-patchable exports.global internally too This fixes Node test failures due to the monkey-patching of Blockly.utils.xml.global in scripts/package/node/core.js not being able to affect the target calls in createElement and createTextNode.
87 lines
2.2 KiB
JavaScript
87 lines
2.2 KiB
JavaScript
/**
|
|
* @license
|
|
* Copyright 2018 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* @fileoverview XML element manipulation.
|
|
* These methods are not specific to Blockly, and could be factored out into
|
|
* a JavaScript framework such as Closure.
|
|
* @author fraser@google.com (Neil Fraser)
|
|
*/
|
|
'use strict';
|
|
|
|
/**
|
|
* @name Blockly.utils.xml
|
|
* @namespace
|
|
*/
|
|
goog.module('Blockly.utils.xml');
|
|
goog.module.declareLegacyNamespace();
|
|
|
|
|
|
/**
|
|
* Namespace for Blockly's XML.
|
|
*/
|
|
const NAME_SPACE = 'https://developers.google.com/blockly/xml';
|
|
exports.NAME_SPACE = NAME_SPACE;
|
|
|
|
/**
|
|
* Get the document object. This method is overridden in the Node.js build of
|
|
* Blockly. See gulpfile.js, package-blockly-node task.
|
|
*
|
|
* Note that this function is named getDocument so as to not shadow the
|
|
* global of the same name, but (for now) exported as .document to not
|
|
* break existing importers.
|
|
*
|
|
* @return {!Document} The document object.
|
|
*/
|
|
const getDocument = function() {
|
|
return document;
|
|
};
|
|
exports.document = getDocument;
|
|
|
|
/**
|
|
* Create DOM element for XML.
|
|
* @param {string} tagName Name of DOM element.
|
|
* @return {!Element} New DOM element.
|
|
*/
|
|
const createElement = function(tagName) {
|
|
return exports.document().createElementNS(NAME_SPACE, tagName);
|
|
};
|
|
exports.createElement = createElement;
|
|
|
|
/**
|
|
* Create text element for XML.
|
|
* @param {string} text Text content.
|
|
* @return {!Text} New DOM text node.
|
|
*/
|
|
const createTextNode = function(text) {
|
|
return exports.document().createTextNode(text);
|
|
};
|
|
exports.createTextNode = createTextNode;
|
|
|
|
/**
|
|
* Converts an XML string into a DOM tree.
|
|
* @param {string} text XML string.
|
|
* @return {Document} The DOM document.
|
|
* @throws if XML doesn't parse.
|
|
*/
|
|
const textToDomDocument = function(text) {
|
|
const oParser = new DOMParser();
|
|
return oParser.parseFromString(text, 'text/xml');
|
|
};
|
|
exports.textToDomDocument = textToDomDocument;
|
|
|
|
/**
|
|
* Converts a DOM structure into plain text.
|
|
* Currently the text format is fairly ugly: all one line with no whitespace.
|
|
* @param {!Node} dom A tree of XML nodes.
|
|
* @return {string} Text representation.
|
|
*/
|
|
const domToText = function(dom) {
|
|
const oSerializer = new XMLSerializer();
|
|
return oSerializer.serializeToString(dom);
|
|
};
|
|
exports.domToText = domToText;
|