mediawiki-extensions-Visual.../modules/ve/dm/ve.dm.NodeFactory.js
Trevor Parscal d8ee3c2c29 After much research on error objects, native = good, custom = bad
Stack traces, line numbers, etc. All the approaches I've seen are bad hacks. This is the best way to go.

Change-Id: Ib12e9d2ecfe610bcc89d046005e35cc13efa3d99
2012-08-08 10:48:53 -07:00

139 lines
3.7 KiB
JavaScript

/**
* VisualEditor data model NodeFactory class.
*
* @copyright 2011-2012 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* DataModel node factory.
*
* @class
* @extends {ve.Factory}
* @constructor
*/
ve.dm.NodeFactory = function () {
// Inheritance
ve.Factory.call( this );
};
/* Methods */
/**
* Gets a list of allowed child node types for a given node.
*
* @method
* @param {String} type Node type
* @returns {String[]|null} List of node types allowed as children or null if any type is allowed
* @throws 'Unknown node type: {type}'
*/
ve.dm.NodeFactory.prototype.getChildNodeTypes = function ( type ) {
if ( type in this.registry ) {
return this.registry[type].rules.childNodeTypes;
}
throw new Error( 'Unknown node type: ' + type );
};
/**
* Gets a list of allowed parent node types for a given node.
*
* @method
* @param {String} type Node type
* @returns {String[]|null} List of node types allowed as parents or null if any type is allowed
* @throws 'Unknown node type: {type}'
*/
ve.dm.NodeFactory.prototype.getParentNodeTypes = function ( type ) {
if ( type in this.registry ) {
return this.registry[type].rules.parentNodeTypes;
}
throw new Error( 'Unknown node type: ' + type );
};
/**
* Checks if a given node type can have child nodes.
*
* @method
* @param {String} type Node type
* @returns {Boolean} The node can have children
* @throws 'Unknown node type: {type}'
*/
ve.dm.NodeFactory.prototype.canNodeHaveChildren = function ( type ) {
if ( type in this.registry ) {
// If childNodeTypes is null any child is allowed, if it's an array of at least one element
// than at least one kind of node is allowed
var types = this.registry[type].rules.childNodeTypes;
return types === null || ( ve.isArray( types ) && types.length > 0 );
}
throw new Error( 'Unknown node type: ' + type );
};
/**
* Checks if a given node type can have grandchild nodes.
*
* @method
* @param {String} type Node type
* @returns {Boolean} The node can have grandchildren
* @throws 'Unknown node type: {type}'
*/
ve.dm.NodeFactory.prototype.canNodeHaveGrandchildren = function ( type ) {
if ( type in this.registry ) {
return this.canNodeHaveChildren( type ) &&
!this.registry[type].rules.canContainContent &&
!this.registry[type].rules.isContent;
}
throw new Error( 'Unknown node type: ' + type );
};
/**
* Checks if a given node type has a wrapping element.
*
* @method
* @param {String} type Node type
* @returns {Boolean} Whether the node has a wrapping element
* @throws 'Unknown node type: {type}'
*/
ve.dm.NodeFactory.prototype.isNodeWrapped = function ( type ) {
if ( type in this.registry ) {
return this.registry[type].rules.isWrapped;
}
throw new Error( 'Unknown node type: ' + type );
};
/**
* Checks if a given node contains content.
*
* @method
* @param {String} type Node type
* @returns {Boolean} The node contains content
* @throws 'Unknown node type: {type}'
*/
ve.dm.NodeFactory.prototype.canNodeContainContent = function ( type ) {
if ( type in this.registry ) {
return this.registry[type].rules.canContainContent;
}
throw new Error( 'Unknown node type: ' + type );
};
/**
* Checks if a given node is content.
*
* @method
* @param {String} type Node type
* @returns {Boolean} The node is content
* @throws 'Unknown node type: {type}'
*/
ve.dm.NodeFactory.prototype.isNodeContent = function ( type ) {
if ( type in this.registry ) {
return this.registry[type].rules.isContent;
}
throw new Error( 'Unknown node type: ' + type );
};
/* Inheritance */
ve.extendClass( ve.dm.NodeFactory, ve.Factory );
/* Initialization */
ve.dm.nodeFactory = new ve.dm.NodeFactory();