mediawiki-extensions-Visual.../modules/ve/dm/ve.dm.NodeFactory.js

178 lines
4.9 KiB
JavaScript
Raw Normal View History

/**
* 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 VeDmNodeFactory() {
Object management: Object create/inherit/clone utilities * For the most common case: - replace ve.extendClass with ve.inheritClass (chose slightly different names to detect usage of the old/new one, and I like 'inherit' better). - move it up to below the constructor, see doc block for why. * Cases where more than 2 arguments were passed to ve.extendClass are handled differently depending on the case. In case of a longer inheritance tree, the other arguments could be omitted (like in "ve.ce.FooBar, ve.FooBar, ve.Bar". ve.ce.FooBar only needs to inherit from ve.FooBar, because ve.ce.FooBar inherits from ve.Bar). In the case of where it previously had two mixins with ve.extendClass(), either one becomes inheritClass and one a mixin, both to mixinClass(). No visible changes should come from this commit as the instances still all have the same visible properties in the end. No more or less than before. * Misc.: - Be consistent in calling parent constructors in the same order as the inheritance. - Add missing @extends and @param documentation. - Replace invalid {Integer} type hint with {Number}. - Consistent doc comments order: @class, @abstract, @constructor, @extends, @params. - Fix indentation errors A fairly common mistake was a superfluous space before the identifier on the assignment line directly below the documentation comment. $ ack "^ [^*]" --js modules/ve - Typo "Inhertiance" -> "Inheritance". - Replacing the other confusing comment "Inheritance" (inside the constructor) with "Parent constructor". - Add missing @abstract for ve.ui.Tool. - Corrected ve.FormatDropdownTool to ve.ui.FormatDropdownTool.js - Add function names to all @constructor functions. Now that we have inheritance it is important and useful to have these functions not be anonymous. Example of debug shot: http://cl.ly/image/1j3c160w3D45 Makes the difference between < documentNode; > ve_dm_DocumentNode ... : ve_dm_BranchNode ... : ve_dm_Node ... : ve_dm_Node ... : Object ... without names (current situation): < documentNode; > Object ... : Object ... : Object ... : Object ... : Object ... though before this commit, it really looks like this (flattened since ve.extendClass really did a mixin): < documentNode; > Object ... ... ... Pattern in Sublime (case-sensitive) to find nameless constructor functions: "^ve\..*\.([A-Z])([^\.]+) = function \(" Change-Id: Iab763954fb8cf375900d7a9a92dec1c755d5407e
2012-09-05 06:07:47 +00:00
// Parent constructor
ve.Factory.call( this );
};
Object management: Object create/inherit/clone utilities * For the most common case: - replace ve.extendClass with ve.inheritClass (chose slightly different names to detect usage of the old/new one, and I like 'inherit' better). - move it up to below the constructor, see doc block for why. * Cases where more than 2 arguments were passed to ve.extendClass are handled differently depending on the case. In case of a longer inheritance tree, the other arguments could be omitted (like in "ve.ce.FooBar, ve.FooBar, ve.Bar". ve.ce.FooBar only needs to inherit from ve.FooBar, because ve.ce.FooBar inherits from ve.Bar). In the case of where it previously had two mixins with ve.extendClass(), either one becomes inheritClass and one a mixin, both to mixinClass(). No visible changes should come from this commit as the instances still all have the same visible properties in the end. No more or less than before. * Misc.: - Be consistent in calling parent constructors in the same order as the inheritance. - Add missing @extends and @param documentation. - Replace invalid {Integer} type hint with {Number}. - Consistent doc comments order: @class, @abstract, @constructor, @extends, @params. - Fix indentation errors A fairly common mistake was a superfluous space before the identifier on the assignment line directly below the documentation comment. $ ack "^ [^*]" --js modules/ve - Typo "Inhertiance" -> "Inheritance". - Replacing the other confusing comment "Inheritance" (inside the constructor) with "Parent constructor". - Add missing @abstract for ve.ui.Tool. - Corrected ve.FormatDropdownTool to ve.ui.FormatDropdownTool.js - Add function names to all @constructor functions. Now that we have inheritance it is important and useful to have these functions not be anonymous. Example of debug shot: http://cl.ly/image/1j3c160w3D45 Makes the difference between < documentNode; > ve_dm_DocumentNode ... : ve_dm_BranchNode ... : ve_dm_Node ... : ve_dm_Node ... : Object ... without names (current situation): < documentNode; > Object ... : Object ... : Object ... : Object ... : Object ... though before this commit, it really looks like this (flattened since ve.extendClass really did a mixin): < documentNode; > Object ... ... ... Pattern in Sublime (case-sensitive) to find nameless constructor functions: "^ve\..*\.([A-Z])([^\.]+) = function \(" Change-Id: Iab763954fb8cf375900d7a9a92dec1c755d5407e
2012-09-05 06:07:47 +00:00
/* Inheritance */
ve.inheritClass( ve.dm.NodeFactory, ve.Factory );
/* Methods */
/**
* Gets a data element with fallback attributes.
*
* @method
* @param {String} type Node type
* @param {Object} attributes Node attributes, defaults will be used where needed
* @returns {Object} Data element
* @throws 'Unknown node type: {type}'
*/
ve.dm.NodeFactory.prototype.getDataElement = function ( type, attributes ) {
var element = { 'type': type };
if ( type in this.registry ) {
if ( this.registry[type].defaultAttributes ) {
attributes = ve.extendObject( {}, this.registry[type].defaultAttributes, attributes );
}
if ( ve.isPlainObject( attributes ) && !ve.isEmptyObject( attributes ) ) {
element.attributes = ve.copyObject( attributes );
}
return element;
}
throw new Error( 'Unknown node type: ' + type );
};
/**
* 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 );
};
/**
* Checks if a given node has significant whitespace. Can only be true if canContainContent is
* also true.
*
* @method
* @param {String} type Node type
* @returns {Boolean} The node has significant whitespace
* @throws 'Unknown node type: {type}'
*/
ve.dm.NodeFactory.prototype.doesNodeHaveSignificantWhitespace = function ( type ) {
if ( type in this.registry ) {
return this.registry[type].rules.hasSignificantWhitespace;
}
throw new Error( 'Unknown node type: ' + type );
};
/* Initialization */
ve.dm.nodeFactory = new ve.dm.NodeFactory();