mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-09-27 20:26:46 +00:00
7233ea8f1b
The EventEmitter API we inherited from Node.js and then bastardized was getting awkward and cumbersome. The number of uses of ve.bind was getting out of control, and removing events meant caching the bound method in a property. Many of the "features" of EventEmitter wasn't even being used, some causing overhead, others just causing bloat. This change cleans up how EventEmitter is used throughout the codebase. The new event emitter API includes: * emit - identical to the previous API, no longer throws an error if you emit error without a handler * once - identical to the previous API, still introduces a wrapper* on - compatible with the previous API but has some new features * off - identical to removeListener in the previous API * connect - very similar to addListenerMethods but doesn't wrap callbacks in closures anymore * disconnect - new, basically the opposite of addListenerMethods Another change that is made in this commit is mixing in rather than inheriting from EventEmitter. Finally, there are changes throughout the codebase anywhere connect/disconnect could be used. Change-Id: Ic3085d39172a8a719ce7f036690f673e59848d3a
118 lines
2.9 KiB
JavaScript
118 lines
2.9 KiB
JavaScript
/*!
|
|
* VisualEditor Initialization Platform class.
|
|
*
|
|
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
*/
|
|
|
|
/**
|
|
* Generic Initialization platform.
|
|
*
|
|
* @abstract
|
|
* @mixins ve.EventEmitter
|
|
*
|
|
* @constructor
|
|
*/
|
|
ve.init.Platform = function VeInitPlatform() {
|
|
// Mixin constructors
|
|
ve.EventEmitter.call( this );
|
|
};
|
|
|
|
/* Inheritance */
|
|
|
|
ve.mixinClass( ve.init.Platform, ve.EventEmitter );
|
|
|
|
/* Methods */
|
|
|
|
/**
|
|
* Get a regular expression that matches allowed external link URLs.
|
|
*
|
|
* @method
|
|
* @abstract
|
|
* @returns {RegExp} Regular expression object
|
|
*/
|
|
ve.init.Platform.prototype.getExternalLinkUrlProtocolsRegExp = function () {
|
|
throw new Error( 've.init.Platform.getExternalLinkUrlProtocolsRegExp must be overridden in subclass' );
|
|
};
|
|
|
|
/**
|
|
* Get a remotely accessible URL to the modules directory.
|
|
*
|
|
* @method
|
|
* @abstract
|
|
* @returns {string} Remote modules URL
|
|
*/
|
|
ve.init.Platform.prototype.getModulesUrl = function () {
|
|
throw new Error( 've.init.Platform.getModulesUrl must be overridden in subclass' );
|
|
};
|
|
|
|
/**
|
|
* Add multiple messages to the localization system.
|
|
*
|
|
* @method
|
|
* @abstract
|
|
* @param {Object} messages Containing plain message values
|
|
*/
|
|
ve.init.Platform.prototype.addMessages = function () {
|
|
throw new Error( 've.init.Platform.addMessages must be overridden in subclass' );
|
|
};
|
|
|
|
/**
|
|
* Get a message from the localization system.
|
|
*
|
|
* @method
|
|
* @abstract
|
|
* @param {string} key Message key
|
|
* @param {Mixed...} [args] List of arguments which will be injected at $1, $2, etc. in the messaage
|
|
* @returns {string} Localized message
|
|
*/
|
|
ve.init.Platform.prototype.getMessage = function () {
|
|
throw new Error( 've.init.Platform.getMessage must be overridden in subclass' );
|
|
};
|
|
|
|
/**
|
|
* Add multiple parsed messages to the localization system.
|
|
*
|
|
* @method
|
|
* @abstract
|
|
* @param {Object} messages Containing parsed html strings
|
|
*/
|
|
ve.init.Platform.prototype.addParsedMessages = function () {
|
|
throw new Error( 've.init.Platform.addParsedMessages must be overridden in subclass' );
|
|
};
|
|
|
|
/**
|
|
* Get a parsed message as HTML string.
|
|
* Does not support $# replacements.
|
|
*
|
|
* @method
|
|
* @abstract
|
|
* @param {string} key Message key
|
|
* @returns {string} Parsed localized message as HTML string
|
|
*/
|
|
ve.init.Platform.prototype.getParsedMessage = function () {
|
|
throw new Error( 've.init.Platform.getParsedMessage must be overridden in subclass' );
|
|
};
|
|
|
|
/**
|
|
* Gets client platform string from browser.
|
|
*
|
|
* @method
|
|
* @abstract
|
|
* @returns {string} Client platform string
|
|
*/
|
|
ve.init.Platform.prototype.getSystemPlatform = function () {
|
|
throw new Error( 've.init.Platform.getSystemPlatform must be overridden in subclass' );
|
|
};
|
|
|
|
/**
|
|
* Gets the user language from the browser.
|
|
*
|
|
* @method
|
|
* @abstract
|
|
* @returns {string} User language string
|
|
*/
|
|
ve.init.Platform.prototype.getUserLanguage = function () {
|
|
throw new Error( 've.init.Platform.getUserLanugage must be overridden in subclass' );
|
|
};
|