mirror of
https://github.com/google/blockly.git
synced 2026-01-09 10:00:09 +01:00
d8fbe1b05b
* Add annotations to files under core/events * Add annotations to files under core/interfaces * Add annotations to files under core/keyboard_nav * Add annotations to files under core/renderers * Add annotations to files under core/serialization * Add annotations to files under core/theme * Add annotations to files under core/toolbox * Add annotations to files under core/utils * Add annotations to files under core
109 lines
2.9 KiB
JavaScript
109 lines
2.9 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';
|
|
|
|
/**
|
|
* XML element manipulation.
|
|
* These methods are not specific to Blockly, and could be factored out into
|
|
* a JavaScript framework such as Closure.
|
|
* @namespace Blockly.utils.xml
|
|
*/
|
|
goog.module('Blockly.utils.xml');
|
|
|
|
const {globalThis} = goog.require('Blockly.utils.global');
|
|
|
|
|
|
/**
|
|
* Namespace for Blockly's XML.
|
|
* @alias Blockly.utils.xml.NAME_SPACE
|
|
*/
|
|
const NAME_SPACE = 'https://developers.google.com/blockly/xml';
|
|
exports.NAME_SPACE = NAME_SPACE;
|
|
|
|
/**
|
|
* The Document object to use. By default this is just document, but
|
|
* the Node.js build of Blockly (see scripts/package/node/core.js)
|
|
* calls setDocument to supply a Document implementation from the
|
|
* jsdom package instead.
|
|
* @type {!Document}
|
|
*/
|
|
let xmlDocument = globalThis.document;
|
|
|
|
/**
|
|
* Get the document object to use for XML serialization.
|
|
* @return {!Document} The document object.
|
|
* @alias Blockly.utils.xml.getDocument
|
|
*/
|
|
const getDocument = function() {
|
|
return xmlDocument;
|
|
};
|
|
exports.getDocument = getDocument;
|
|
|
|
/**
|
|
* Get the document object to use for XML serialization.
|
|
* @param {!Document} document The document object to use.
|
|
* @alias Blockly.utils.xml.setDocument
|
|
*/
|
|
const setDocument = function(document) {
|
|
xmlDocument = document;
|
|
};
|
|
exports.setDocument = setDocument;
|
|
|
|
/**
|
|
* Create DOM element for XML.
|
|
* @param {string} tagName Name of DOM element.
|
|
* @return {!Element} New DOM element.
|
|
* @alias Blockly.utils.xml.createElement
|
|
*/
|
|
const createElement = function(tagName) {
|
|
return xmlDocument.createElementNS(NAME_SPACE, tagName);
|
|
};
|
|
exports.createElement = createElement;
|
|
|
|
/**
|
|
* Create text element for XML.
|
|
* @param {string} text Text content.
|
|
* @return {!Text} New DOM text node.
|
|
* @alias Blockly.utils.xml.createTextNode
|
|
*/
|
|
const createTextNode = function(text) {
|
|
return xmlDocument.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.
|
|
* @alias Blockly.utils.xml.textToDomDocument
|
|
*/
|
|
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.
|
|
* @alias Blockly.utils.xml.domToText
|
|
*/
|
|
const domToText = function(dom) {
|
|
const oSerializer = new XMLSerializer();
|
|
return oSerializer.serializeToString(dom);
|
|
};
|
|
exports.domToText = domToText;
|