@doodad-js/xml
Version:
769 lines (700 loc) • 19.4 kB
JavaScript
// Copyright 2015-2018 Claude Petit, licensed under Apache License version 2.0
;
exports.add = function add(modules) {
modules = (modules || {});
modules['Doodad.Tools.Xml'] = {
version: '5.2.0b',
namespaces: ['Parsers'],
create: function create(root, /*optional*/_options, _shared) {
//===================================
// Get namespaces
//===================================
const doodad = root.Doodad,
types = doodad.Types,
tools = doodad.Tools,
//namespaces = doodad.Namespaces,
xml = tools.Xml;
//xmlParsers = xml.Parsers;
//===================================
// Internal
//===================================
// <FUTURE> Thread context
const __Internal__ = {
parsers: [],
};
tools.complete(_shared.Natives, {
symbolIterator: (types.isSymbol(global.Symbol.iterator) ? global.Symbol.iterator : undefined),
});
//===================================
// XML Types
//===================================
__Internal__.NodesListIterator = types.INIT(types.Iterator.$inherit(
/*typeProto*/
{
$TYPE_NAME: 'NodesListIterator',
$TYPE_UUID: '' +'1399e5ed-2a78-4e08-8bae-563bfc6c80ea',
},
/*instanceProto*/
{
__index: types.NOT_ENUMERABLE(0),
__nodes: types.NOT_ENUMERABLE(types.READ_ONLY(null)),
_new: types.SUPER(function _new(nodesList) {
this._super();
types.setAttribute(this, '__nodes', types.clone(nodesList.__nodes));
}),
next: function next() {
const ar = this.__nodes;
if (this.__index < ar.length) {
return {
value: ar[this.__index++],
};
} else {
return {
done: true,
};
};
},
}));
xml.ADD('NodesList', types.CustomEventTarget.$inherit(
/*typeProto*/
{
$TYPE_NAME: 'NodesList',
$TYPE_UUID: '' +'8281bddf-95b8-4a89-a64d-3d42e6867612',
},
/*instanceProto*/
{
__parentNode: null,
__nodeTypes: null,
__nodes: null,
__changed: false,
_new: types.SUPER(function _new(parentNode, nodeTypes) {
this._super();
this.__parentNode = parentNode;
this.__nodeTypes = nodeTypes;
this.__nodes = [];
}),
append: function append(node) {
if (!types._instanceof(node, this.__nodeTypes)) {
throw new types.ValueError("Invalid node type.");
};
this.__nodes.push(node);
node.__parentNode = this.__parentNode;
this.__changed = true;
this.dispatchEvent(new types.CustomEvent('add', {detail: {node: node}}));
return this;
},
prepend: function prepend(node) {
if (!types._instanceof(node, this.__nodeTypes)) {
throw new types.ValueError("Invalid node type.");
};
this.__nodes.unshift(node);
node.__parentNode = this.__parentNode;
this.__changed = true;
this.dispatchEvent(new types.CustomEvent('add', {detail: {node: node}}));
return this;
},
insertAt: function insertAt(pos, node) {
if (!types._instanceof(node, this.__nodeTypes)) {
throw new types.ValueError("Invalid node type.");
};
this.__nodes.splice(pos, 0, node);
node.__parentNode = this.__parentNode;
this.__changed = true;
this.dispatchEvent(new types.CustomEvent('add', {detail: {node: node}}));
return this;
},
remove: function remove(nodeOrName) {
const nodes = this.__nodes;
let len = nodes.length;
const isName = types.isString(nodeOrName);
for (let i = 0; i < len;) {
const node = nodes[i];
if (isName ? (node.__name === nodeOrName) : (node === nodeOrName)) {
nodes.splice(i, 1);
len--;
node.__parentNode = null;
this.__changed = true;
this.dispatchEvent(new types.CustomEvent('remove', {detail: {node: node}}));
if (!isName) {
break;
};
} else {
i++;
};
};
return this;
},
removeAt: function removeAt(pos) {
const node = this.__nodes.splice(pos, 1)[0];
if (node) {
node.__parentNode = null;
this.__changed = true;
this.dispatchEvent(new types.CustomEvent('remove', {detail: {node: node}}));
};
return this;
},
clear: function clear() {
const nodes = this.__nodes;
const len = nodes.length;
for (let i = 0; i < len; i++) {
const node = nodes[i];
node.__parentNode = null;
this.__changed = true;
this.dispatchEvent(new types.CustomEvent('remove', {detail: {node: node}}));
};
this.__nodes = [];
return this;
},
find: function find(name) {
const result = [];
const nodes = this.__nodes;
const len = nodes.length;
for (let i = 0; i < len; i++) {
const node = nodes[i];
if (node.__name === name) {
result.push(node);
};
};
return result;
},
findFirst: function findFirst(name) {
let result = null;
const nodes = this.__nodes;
const len = nodes.length;
for (let i = 0; i < len; i++) {
const node = nodes[i];
if (node.__name === name) {
result = node;
break;
};
};
return result;
},
forEach: function forEach(fn, /*optional*/thisObj) {
this.__changed = false;
const nodes = this.__nodes;
const len = nodes.length;
for (let i = 0; i < len; i++) {
fn.call(thisObj, nodes[i], i, nodes);
if (this.__changed) {
throw new types.Error('The list has been modified.');
};
};
return this;
},
items: function items() {
return new __Internal__.NodesListIterator(this);
},
getCount: function getCount() {
return this.__nodes.length;
},
getAt: function getAt(pos) {
return this.__nodes[pos];
},
getParent: function getParent() {
return this.__parentNode;
},
}
));
if (_shared.Natives.symbolIterator) {
types.setAttribute(xml.NodesList.prototype, _shared.Natives.symbolIterator, function() {
return this.items();
}, {});
};
xml.ADD('Node', types.Type.$inherit(
/*typeProto*/
{
$TYPE_NAME: 'Node',
$TYPE_UUID: '' +'ca61304f-0952-43fe-9a8f-d94735062389',
},
/*instanceProto*/
{
__parentNode: null,
line: 0,
column: 0,
getParent: function getParent() {
return this.__parentNode;
},
}
));
xml.ADD('Element', xml.Node.$inherit(
/*typeProto*/
{
$TYPE_NAME: 'Element',
$TYPE_UUID: '' +'d43eaa27-f6d1-4682-a5ee-265a22a7d370',
},
/*instanceProto*/
{
__prefix: null,
__baseURI: null,
__name: null,
__attributes: null,
__childNodes: null,
_new: types.SUPER(function _new(name, /*optional*/prefix, /*optional*/baseURI) {
this._super();
this.__prefix = prefix;
this.__baseURI = baseURI;
this.__name = name;
this.__attributes = new xml.NodesList(this, [xml.Attribute]);
this.__childNodes = new xml.NodesList(this, [xml.Element, xml.Text, xml.CDataSection, xml.Comment]);
}),
getName: function getName() {
return this.__name;
},
setName: function setName(name) {
this.__name = name;
},
hasAttr: function hasAttr(name) {
const result = this.__attributes.find(name);
return !!result.length;
},
getAttr: function getAttr(name) {
const result = this.__attributes.find(name);
if (result.length) {
return result[0].getValue();
};
return undefined;
},
removeAttr: function removeAttr(name) {
return this.__attributes.remove(name);
},
getAttrs: function getAttrs() {
return this.__attributes;
},
getChildren: function getChildren() {
return this.__childNodes;
},
getPrefix: function getPrefix() {
return this.__prefix;
},
setPrefix: function setPrefix(prefix) {
this.__prefix = prefix;
},
getBaseURI: function getBaseURI() {
return this.__baseURI;
},
setBaseURI: function setBaseURI(uri) {
this.__baseURI = uri;
},
//toString: function() {
//},
}
));
xml.ADD('Attribute', xml.Node.$inherit(
/*typeProto*/
{
$TYPE_NAME: 'Attribute',
$TYPE_UUID: '' +'18769041-ec80-4d1a-84bb-2efab8815c31',
},
/*instanceProto*/
{
__prefix: null,
__baseURI: null,
__name: null,
__value: null,
_new: types.SUPER(function _new(name, value, /*optional*/prefix, /*optional*/baseURI) {
this._super();
this.__prefix = prefix;
this.__baseURI = baseURI;
this.__name = name;
this.__value = value;
}),
getName: function getName() {
return this.__name;
},
setName: function setName(name) {
this.__name = name;
},
getValue: function getValue() {
return this.__value;
},
setValue: function setValue(value) {
this.__value = value;
},
getPrefix: function getPrefix() {
return this.__prefix;
},
setPrefix: function setPrefix(prefix) {
this.__prefix = prefix;
},
getBaseURI: function getBaseURI() {
return this.__baseURI;
},
setBaseURI: function setBaseURI(uri) {
this.__baseURI = uri;
},
//toString: function() {
//},
}
));
xml.ADD('Text', xml.Node.$inherit(
/*typeProto*/
{
$TYPE_NAME: 'Text',
$TYPE_UUID: '' +'6a28e113-c2d0-42b8-9619-583069556753',
},
/*instanceProto*/
{
__value: null,
_new: types.SUPER(function _new(text) {
this._super();
this.__value = text;
}),
getValue: function getValue() {
return this.__value;
},
setValue: function setValue(value) {
this.__value = value;
},
//toString: function() {
//},
}
));
xml.ADD('CDATASection', xml.Node.$inherit(
/*typeProto*/
{
$TYPE_NAME: 'CDATASection',
$TYPE_UUID: '' +'ef5480ab-0f7d-4427-bdfb-75cc84212aa1',
},
/*instanceProto*/
{
__value: null,
_new: types.SUPER(function _new(data) {
this._super();
this.__value = data;
}),
getValue: function getValue() {
return this.__value;
},
setValue: function setValue(value) {
this.__value = value;
},
//toString: function() {
//},
}
));
/*
xml.ADD('EntityReference', xml.Node.$inherit(
/ *typeProto* /
{
$TYPE_NAME: 'EntityReference',
$TYPE_UUID: '' /*! INJECT('+' + TO_SOURCE(UUID('EntityReference')), true) * /,
},
/ *instanceProto* /
{
__name: null,
__value: null,
_new: types.SUPER(function _new(name, value) {
this._super();
this.__name = name;
this.__value = value;
}),
getName: function getName() {
return this.__name;
},
setName: function setName(name) {
this.__name = name;
},
getValue: function getValue() {
return this.__value;
},
setValue: function setValue(value) {
this.__value = value;
},
//toString: function() {
//},
}
));
*/
xml.ADD('Entity', xml.Node.$inherit(
/*typeProto*/
{
$TYPE_NAME: 'Entity',
$TYPE_UUID: '' +'6963a73d-11bd-4339-81e2-111994cc0624',
},
/*instanceProto*/
{
__name: null,
__value: null,
_new: types.SUPER(function _new(name, value) {
this._super();
this.__name = name;
this.__value = value;
}),
getName: function getName() {
return this.__name;
},
setName: function setName(name) {
this.__name = name;
},
getValue: function getValue() {
return this.__value;
},
setValue: function setValue(value) {
this.__value = value;
},
//toString: function() {
//},
}
));
xml.ADD('ProcessingInstruction', xml.Node.$inherit(
/*typeProto*/
{
$TYPE_NAME: 'ProcessingInstruction',
$TYPE_UUID: '' +'a66ff95b-17a8-4289-838d-5d224fd3a4ac',
},
/*instanceProto*/
{
__name: null,
__value: null,
_new: types.SUPER(function _new(name, value) {
this._super();
this.__name = name;
this.__value = value;
}),
getName: function getName() {
return this.__name;
},
setName: function setName(name) {
this.__name = name;
},
getValue: function getValue() {
return this.__value;
},
setValue: function setValue(value) {
this.__value = value;
},
//toString: function() {
//},
}
));
xml.ADD('Comment', xml.Node.$inherit(
/*typeProto*/
{
$TYPE_NAME: 'Comment',
$TYPE_UUID: '' +'9cf4716e-f5d4-41df-9445-6c9bd967f196',
},
/*instanceProto*/
{
__value: null,
_new: types.SUPER(function _new(text) {
this._super();
this.__value = text;
}),
getValue: function getValue() {
return this.__value;
},
setValue: function setValue(value) {
this.__value = value;
},
//toString: function() {
//},
}
));
xml.ADD('DocumentType', xml.Node.$inherit(
/*typeProto*/
{
$TYPE_NAME: 'DocumentType',
$TYPE_UUID: '' +'ebdae7f4-dc64-4054-924c-0e6f5587a14a',
},
/*instanceProto*/
{
__value: null,
_new: types.SUPER(function _new(type) {
this._super();
this.__value = type;
}),
getValue: function getValue() {
return this.__value;
},
setValue: function setValue(value) {
this.__value = value;
},
//toString: function() {
//},
}
));
xml.ADD('DocumentFragment', xml.Node.$inherit(
/*typeProto*/
{
$TYPE_NAME: 'DocumentFragment',
$TYPE_UUID: '' +'91f1dc37-5b51-45d5-919d-7253bb9874bd',
},
/*instanceProto*/
{
__value: null,
_new: types.SUPER(function _new(value) {
this._super();
this.__value = value;
}),
getValue: function getValue() {
return this.__value;
},
setValue: function setValue(value) {
this.__value = value;
},
//toString: function() {
//},
}
));
/*
xml.ADD('Notation', xml.Node.$inherit(
/ *typeProto* /
{
$TYPE_NAME: 'Notation',
$TYPE_UUID: '' /*! INJECT('+' + TO_SOURCE(UUID('Notation')), true) * /,
},
/ *instanceProto* /
{
__name: null,
__value: null,
_new: types.SUPER(function _new(name, value) {
this._super();
this.__name = name;
this.__value = value;
}),
getName: function getName() {
return this.__name;
},
setName: function setName(name) {
this.__name = name;
},
getValue: function getValue() {
return this.__value;
},
setValue: function setValue(value) {
this.__value = value;
},
//toString: function() {
//},
}
));
*/
xml.ADD('Document', xml.Node.$inherit(
/*typeProto*/
{
$TYPE_NAME: 'Document',
$TYPE_UUID: '' +'db6d699a-d194-40af-a080-d88f03f1f826',
},
/*instanceProto*/
{
__childNodes: null,
__entities: null,
__instructions: null,
__doctype: null,
__root: null,
_new: types.SUPER(function _new() {
this._super();
this.__childNodes = new xml.NodesList(this, [xml.Element, xml.Text, xml.CDataSection, xml.Comment]);
this.__childNodes.addEventListener('add', types.bind(this, this.__onChildNodesAdd));
this.__childNodes.addEventListener('remove', types.bind(this, this.__onChildNodesRemove));
this.__instructions = new xml.NodesList(this, [xml.ProcessingInstruction]);
this.__entities = new xml.NodesList(this, [xml.EntityReference, xml.Entity]);
}),
__onChildNodesAdd: function __onChildNodesAdd(ev) {
if (!this.__root && (ev.detail.node instanceof xml.Element)) {
this.__root = ev.detail.node;
};
},
__onChildNodesRemove: function __onChildNodesRemove(ev) {
if (ev.detail.node === this.__root) {
this.__root = null;
for (let i = 0; i < this.__childNodes.__nodes.length; i++) {
const node = this.__childNodes.__nodes[i];
if (types._instanceof(node, xml.Element)) {
this.__root = node;
break;
};
};
};
},
getChildren: function getChildren() {
return this.__childNodes;
},
getDocumentType: function getDocumentType() {
return this.__doctype;
},
setDocumentType: function setDocumentType(node) {
if (!types.isNothing(node) && !types._instanceof(node, xml.DocumentType)) {
throw new types.ValueError("Invalid document type node.");
};
if (this.__doctype) {
this.__doctype.__parentNode = null;
};
this.__doctype = node;
node.__parentNode = this;
return this;
},
getRoot: function getRoot() {
return this.__root;
},
setRoot: function setRoot(node) {
if (!(node instanceof xml.Element)) {
throw new types.ValueError("Invalid root element.");
};
let ok = false;
if (this.__root) {
for (let i = 0; i < this.__childNodes.__nodes.length; i++) {
if (this.__childNodes.__nodes[i] === this.__root) {
this.__root.__parentNode = null;
this.__root = null;
this.__childNodes.removeAt(i);
this.__childNodes.insertAt(i, node);
ok = true;
break;
};
};
};
if (!ok) {
this.__root.__parentNode = null;
this.__root = null;
this.__childNodes.prepend(node);
};
},
getEntities: function getEntities() {
return this.__entities;
},
getInstructions: function getInstructions() {
return this.__instructions;
},
//toString: function() {
//},
}
));
//===================================
// XML Tools
//===================================
xml.ADD('registerParser', function registerParser(parser) {
__Internal__.parsers = tools.unique(__Internal__.parsers, [parser]);
});
xml.ADD('parse', function parse(stream, /*optional*/options, /*optional*/parser) {
// TODO: MemoryStream for Strings
const needSchemas = !!types.get(options, 'xsd', null);
if (parser) {
if ((tools.indexOf(__Internal__.parsers, parser) < 0)) {
throw new types.ParseError('Invalid XML parser.');
};
} else {
parser = tools.filter(__Internal__.parsers, function(parser) {
return parser.isAvailable() && (!needSchemas || parser.hasFeatures({schemas: true}));
})[0];
};
if (!parser || !parser.isAvailable() || (needSchemas && !parser.hasFeatures({schemas: true}))) {
throw new types.ParseError('The XML parser is not available.');
};
return parser.parse(stream, options);
});
xml.ADD('isAvailable', function isAvailable(/*optional*/features) {
return tools.some(__Internal__.parsers, function(parser) {
return parser.isAvailable() && parser.hasFeatures(features);
});
});
//===================================
// Init
//===================================
//return function init(/*optional*/options) {
//};
},
};
return modules;
};