mediawiki-extensions-VisualEditor/modules/ve/ui/ve.ui.InspectorFactory.js

/*!
 * VisualEditor UserInterface InspectorFactory class.
 *
 * @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
 * @license The MIT License (MIT); see LICENSE.txt
 */

/**
 * UserInterface inspector factory.
 *
 * @class
 * @extends ve.Factory
 * @constructor
 */
ve.ui.InspectorFactory = function VeUiInspectorFactory() {
	// Parent constructor
	ve.Factory.call( this );
};

/* Inheritance */

ve.inheritClass( ve.ui.InspectorFactory, ve.Factory );

/* Methods */

/**
 * Get an inspector constructor for a given annotation type.
 *
 * @method
 * @param {string} name Symbolic name of inspector to get pattern for
 * @returns {RegExp} Regular expression matching annotations relevant to a given inspector
 * @throws {Error} Unknown inspector
 */
ve.ui.InspectorFactory.prototype.getTypePattern = function ( name ) {
	if ( name in this.registry ) {
		return this.registry[name].static.typePattern;
	}
	throw new Error( 'Unknown inspector: ' + name );
};

/**
 * Reduce an annotation set to only those which can be inspected by given inspector.
 *
 * @method
 * @param {ve.dm.AnnotationSet} annotations Annotations to be inspected
 * @returns {string[]} Symbolic names of inspectors that can be used to inspect annotations
 */
ve.ui.InspectorFactory.prototype.getInspectorsForAnnotations = function ( annotations ) {
	if ( annotations.isEmpty() ) {
		return [];
	}

	var i, len, j, annotation,
		matches = [],
		inspectors = this.entries.slice( 0 ),
		inspector,
		arr = annotations.get();

	for ( i = 0, len = arr.length; i < len; i++ ) {
		annotation = arr[i];
		j = inspectors.length;
		while ( inspectors[--j] ) {
			inspector = inspectors[j];
			if ( this.registry[inspector].static.typePattern.test( annotation.name ) ) {
				matches.push( inspector );
				break;
			}
		}
	}
	return matches;
};

/* Initialization */

ve.ui.inspectorFactory = new ve.ui.InspectorFactory();