2013-12-03 19:48:24 +00:00
|
|
|
/*!
|
2015-03-19 01:47:12 +00:00
|
|
|
* OOjs v1.1.6 optimised for jQuery
|
2013-12-13 01:28:50 +00:00
|
|
|
* https://www.mediawiki.org/wiki/OOjs
|
2013-12-03 19:48:24 +00:00
|
|
|
*
|
2015-01-23 20:18:10 +00:00
|
|
|
* Copyright 2011-2015 OOjs Team and other contributors.
|
2013-12-03 19:48:24 +00:00
|
|
|
* Released under the MIT license
|
|
|
|
|
* http://oojs.mit-license.org
|
|
|
|
|
*
|
2015-03-19 01:47:12 +00:00
|
|
|
* Date: 2015-03-19T00:42:55Z
|
2013-12-03 19:48:24 +00:00
|
|
|
*/
|
|
|
|
|
( function ( global ) {
|
|
|
|
|
|
|
|
|
|
'use strict';
|
2014-07-23 20:53:29 +00:00
|
|
|
|
2014-06-26 23:55:15 +00:00
|
|
|
/*exported toString */
|
2013-12-03 19:48:24 +00:00
|
|
|
var
|
|
|
|
|
/**
|
|
|
|
|
* Namespace for all classes, static methods and static properties.
|
|
|
|
|
* @class OO
|
|
|
|
|
* @singleton
|
|
|
|
|
*/
|
|
|
|
|
oo = {},
|
2014-11-17 19:26:17 +00:00
|
|
|
// Optimisation: Local reference to Object.prototype.hasOwnProperty
|
2013-12-03 19:48:24 +00:00
|
|
|
hasOwn = oo.hasOwnProperty,
|
|
|
|
|
toString = oo.toString;
|
|
|
|
|
|
|
|
|
|
/* Class Methods */
|
|
|
|
|
|
2014-04-02 21:40:24 +00:00
|
|
|
/**
|
|
|
|
|
* Utility to initialize a class for OO inheritance.
|
|
|
|
|
*
|
|
|
|
|
* Currently this just initializes an empty static object.
|
|
|
|
|
*
|
|
|
|
|
* @param {Function} fn
|
|
|
|
|
*/
|
|
|
|
|
oo.initClass = function ( fn ) {
|
|
|
|
|
fn.static = fn.static || {};
|
|
|
|
|
};
|
|
|
|
|
|
2013-12-03 19:48:24 +00:00
|
|
|
/**
|
2014-08-31 21:26:08 +00:00
|
|
|
* Inherit from prototype to another using Object#create.
|
2013-12-03 19:48:24 +00:00
|
|
|
*
|
|
|
|
|
* Beware: This redefines the prototype, call before setting your prototypes.
|
2014-08-31 21:26:08 +00:00
|
|
|
*
|
2013-12-03 19:48:24 +00:00
|
|
|
* Beware: This redefines the prototype, can only be called once on a function.
|
2014-08-31 21:26:08 +00:00
|
|
|
* If called multiple times on the same function, the previous prototype is lost.
|
|
|
|
|
* This is how prototypal inheritance works, it can only be one straight chain
|
|
|
|
|
* (just like classical inheritance in PHP for example). If you need to work with
|
|
|
|
|
* multiple constructors consider storing an instance of the other constructor in a
|
|
|
|
|
* property instead, or perhaps use a mixin (see OO.mixinClass).
|
2013-12-03 19:48:24 +00:00
|
|
|
*
|
2014-02-15 01:54:19 +00:00
|
|
|
* function Thing() {}
|
|
|
|
|
* Thing.prototype.exists = function () {};
|
2013-12-03 19:48:24 +00:00
|
|
|
*
|
2014-02-15 01:54:19 +00:00
|
|
|
* function Person() {
|
2014-03-08 01:36:25 +00:00
|
|
|
* Person.super.apply( this, arguments );
|
2014-02-15 01:54:19 +00:00
|
|
|
* }
|
2014-03-08 01:36:25 +00:00
|
|
|
* OO.inheritClass( Person, Thing );
|
2014-02-15 01:54:19 +00:00
|
|
|
* Person.static.defaultEyeCount = 2;
|
|
|
|
|
* Person.prototype.walk = function () {};
|
2013-12-03 19:48:24 +00:00
|
|
|
*
|
2014-02-15 01:54:19 +00:00
|
|
|
* function Jumper() {
|
2014-03-08 01:36:25 +00:00
|
|
|
* Jumper.super.apply( this, arguments );
|
2014-02-15 01:54:19 +00:00
|
|
|
* }
|
|
|
|
|
* OO.inheritClass( Jumper, Person );
|
|
|
|
|
* Jumper.prototype.jump = function () {};
|
2013-12-03 19:48:24 +00:00
|
|
|
*
|
2014-02-15 01:54:19 +00:00
|
|
|
* Jumper.static.defaultEyeCount === 2;
|
|
|
|
|
* var x = new Jumper();
|
|
|
|
|
* x.jump();
|
|
|
|
|
* x.walk();
|
|
|
|
|
* x instanceof Thing && x instanceof Person && x instanceof Jumper;
|
2013-12-03 19:48:24 +00:00
|
|
|
*
|
|
|
|
|
* @param {Function} targetFn
|
|
|
|
|
* @param {Function} originFn
|
|
|
|
|
* @throws {Error} If target already inherits from origin
|
|
|
|
|
*/
|
|
|
|
|
oo.inheritClass = function ( targetFn, originFn ) {
|
|
|
|
|
if ( targetFn.prototype instanceof originFn ) {
|
|
|
|
|
throw new Error( 'Target already inherits from origin' );
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
var targetConstructor = targetFn.prototype.constructor;
|
|
|
|
|
|
2014-06-26 23:55:15 +00:00
|
|
|
// Using ['super'] instead of .super because 'super' is not supported
|
|
|
|
|
// by IE 8 and below (bug 63303).
|
|
|
|
|
// Provide .parent as alias for code supporting older browsers which
|
|
|
|
|
// allows people to comply with their style guide.
|
|
|
|
|
targetFn['super'] = targetFn.parent = originFn;
|
|
|
|
|
|
2013-12-03 19:48:24 +00:00
|
|
|
targetFn.prototype = Object.create( originFn.prototype, {
|
|
|
|
|
// Restore constructor property of targetFn
|
|
|
|
|
constructor: {
|
|
|
|
|
value: targetConstructor,
|
|
|
|
|
enumerable: false,
|
|
|
|
|
writable: true,
|
|
|
|
|
configurable: true
|
|
|
|
|
}
|
|
|
|
|
} );
|
|
|
|
|
|
|
|
|
|
// Extend static properties - always initialize both sides
|
2014-04-02 21:40:24 +00:00
|
|
|
oo.initClass( originFn );
|
2013-12-03 19:48:24 +00:00
|
|
|
targetFn.static = Object.create( originFn.static );
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/**
|
2014-08-31 21:26:08 +00:00
|
|
|
* Copy over *own* prototype properties of a mixin.
|
|
|
|
|
*
|
2013-12-03 19:48:24 +00:00
|
|
|
* The 'constructor' (whether implicit or explicit) is not copied over.
|
|
|
|
|
*
|
|
|
|
|
* This does not create inheritance to the origin. If inheritance is needed
|
|
|
|
|
* use oo.inheritClass instead.
|
|
|
|
|
*
|
|
|
|
|
* Beware: This can redefine a prototype property, call before setting your prototypes.
|
2014-08-31 21:26:08 +00:00
|
|
|
*
|
2013-12-03 19:48:24 +00:00
|
|
|
* Beware: Don't call before oo.inheritClass.
|
|
|
|
|
*
|
|
|
|
|
* function Foo() {}
|
|
|
|
|
* function Context() {}
|
|
|
|
|
*
|
|
|
|
|
* // Avoid repeating this code
|
|
|
|
|
* function ContextLazyLoad() {}
|
|
|
|
|
* ContextLazyLoad.prototype.getContext = function () {
|
|
|
|
|
* if ( !this.context ) {
|
|
|
|
|
* this.context = new Context();
|
|
|
|
|
* }
|
|
|
|
|
* return this.context;
|
|
|
|
|
* };
|
|
|
|
|
*
|
|
|
|
|
* function FooBar() {}
|
|
|
|
|
* OO.inheritClass( FooBar, Foo );
|
|
|
|
|
* OO.mixinClass( FooBar, ContextLazyLoad );
|
|
|
|
|
*
|
|
|
|
|
* @param {Function} targetFn
|
|
|
|
|
* @param {Function} originFn
|
|
|
|
|
*/
|
|
|
|
|
oo.mixinClass = function ( targetFn, originFn ) {
|
|
|
|
|
var key;
|
|
|
|
|
|
|
|
|
|
// Copy prototype properties
|
|
|
|
|
for ( key in originFn.prototype ) {
|
|
|
|
|
if ( key !== 'constructor' && hasOwn.call( originFn.prototype, key ) ) {
|
|
|
|
|
targetFn.prototype[key] = originFn.prototype[key];
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Copy static properties - always initialize both sides
|
2014-04-02 21:40:24 +00:00
|
|
|
oo.initClass( targetFn );
|
2013-12-03 19:48:24 +00:00
|
|
|
if ( originFn.static ) {
|
|
|
|
|
for ( key in originFn.static ) {
|
|
|
|
|
if ( hasOwn.call( originFn.static, key ) ) {
|
|
|
|
|
targetFn.static[key] = originFn.static[key];
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
} else {
|
2014-04-02 21:40:24 +00:00
|
|
|
oo.initClass( originFn );
|
2013-12-03 19:48:24 +00:00
|
|
|
}
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/* Object Methods */
|
|
|
|
|
|
2014-11-17 19:26:17 +00:00
|
|
|
/**
|
|
|
|
|
* Get a deeply nested property of an object using variadic arguments, protecting against
|
|
|
|
|
* undefined property errors.
|
|
|
|
|
*
|
|
|
|
|
* `quux = oo.getProp( obj, 'foo', 'bar', 'baz' );` is equivalent to `quux = obj.foo.bar.baz;`
|
|
|
|
|
* except that the former protects against JS errors if one of the intermediate properties
|
|
|
|
|
* is undefined. Instead of throwing an error, this function will return undefined in
|
|
|
|
|
* that case.
|
|
|
|
|
*
|
|
|
|
|
* @param {Object} obj
|
|
|
|
|
* @param {Mixed...} [keys]
|
2015-01-23 20:18:10 +00:00
|
|
|
* @return obj[arguments[1]][arguments[2]].... or undefined
|
2014-11-17 19:26:17 +00:00
|
|
|
*/
|
|
|
|
|
oo.getProp = function ( obj ) {
|
|
|
|
|
var i,
|
|
|
|
|
retval = obj;
|
|
|
|
|
for ( i = 1; i < arguments.length; i++ ) {
|
|
|
|
|
if ( retval === undefined || retval === null ) {
|
|
|
|
|
// Trying to access a property of undefined or null causes an error
|
|
|
|
|
return undefined;
|
|
|
|
|
}
|
|
|
|
|
retval = retval[arguments[i]];
|
|
|
|
|
}
|
|
|
|
|
return retval;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Set a deeply nested property of an object using variadic arguments, protecting against
|
|
|
|
|
* undefined property errors.
|
|
|
|
|
*
|
|
|
|
|
* `oo.setProp( obj, 'foo', 'bar', 'baz' );` is equivalent to `obj.foo.bar = baz;` except that
|
|
|
|
|
* the former protects against JS errors if one of the intermediate properties is
|
|
|
|
|
* undefined. Instead of throwing an error, undefined intermediate properties will be
|
|
|
|
|
* initialized to an empty object. If an intermediate property is not an object, or if obj itself
|
|
|
|
|
* is not an object, this function will silently abort.
|
|
|
|
|
*
|
|
|
|
|
* @param {Object} obj
|
|
|
|
|
* @param {Mixed...} [keys]
|
|
|
|
|
* @param {Mixed} [value]
|
|
|
|
|
*/
|
|
|
|
|
oo.setProp = function ( obj ) {
|
|
|
|
|
var i,
|
|
|
|
|
prop = obj;
|
|
|
|
|
if ( Object( obj ) !== obj ) {
|
|
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
for ( i = 1; i < arguments.length - 2; i++ ) {
|
|
|
|
|
if ( prop[arguments[i]] === undefined ) {
|
|
|
|
|
prop[arguments[i]] = {};
|
|
|
|
|
}
|
|
|
|
|
if ( Object( prop[arguments[i]] ) !== prop[arguments[i]] ) {
|
|
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
prop = prop[arguments[i]];
|
|
|
|
|
}
|
|
|
|
|
prop[arguments[arguments.length - 2]] = arguments[arguments.length - 1];
|
|
|
|
|
};
|
|
|
|
|
|
2013-12-03 19:48:24 +00:00
|
|
|
/**
|
|
|
|
|
* Create a new object that is an instance of the same
|
|
|
|
|
* constructor as the input, inherits from the same object
|
|
|
|
|
* and contains the same own properties.
|
|
|
|
|
*
|
|
|
|
|
* This makes a shallow non-recursive copy of own properties.
|
|
|
|
|
* To create a recursive copy of plain objects, use #copy.
|
|
|
|
|
*
|
|
|
|
|
* var foo = new Person( mom, dad );
|
|
|
|
|
* foo.setAge( 21 );
|
|
|
|
|
* var foo2 = OO.cloneObject( foo );
|
|
|
|
|
* foo.setAge( 22 );
|
|
|
|
|
*
|
|
|
|
|
* // Then
|
|
|
|
|
* foo2 !== foo; // true
|
|
|
|
|
* foo2 instanceof Person; // true
|
|
|
|
|
* foo2.getAge(); // 21
|
|
|
|
|
* foo.getAge(); // 22
|
|
|
|
|
*
|
|
|
|
|
* @param {Object} origin
|
|
|
|
|
* @return {Object} Clone of origin
|
|
|
|
|
*/
|
|
|
|
|
oo.cloneObject = function ( origin ) {
|
|
|
|
|
var key, r;
|
|
|
|
|
|
|
|
|
|
r = Object.create( origin.constructor.prototype );
|
|
|
|
|
|
|
|
|
|
for ( key in origin ) {
|
|
|
|
|
if ( hasOwn.call( origin, key ) ) {
|
|
|
|
|
r[key] = origin[key];
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return r;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/**
|
2014-03-08 01:36:25 +00:00
|
|
|
* Get an array of all property values in an object.
|
2013-12-03 19:48:24 +00:00
|
|
|
*
|
|
|
|
|
* @param {Object} Object to get values from
|
2014-03-08 01:36:25 +00:00
|
|
|
* @return {Array} List of object values
|
2013-12-03 19:48:24 +00:00
|
|
|
*/
|
|
|
|
|
oo.getObjectValues = function ( obj ) {
|
|
|
|
|
var key, values;
|
|
|
|
|
|
|
|
|
|
if ( obj !== Object( obj ) ) {
|
|
|
|
|
throw new TypeError( 'Called on non-object' );
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
values = [];
|
|
|
|
|
for ( key in obj ) {
|
|
|
|
|
if ( hasOwn.call( obj, key ) ) {
|
|
|
|
|
values[values.length] = obj[key];
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return values;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/**
|
2014-08-31 21:26:08 +00:00
|
|
|
* Recursively compare properties between two objects.
|
2013-12-03 19:48:24 +00:00
|
|
|
*
|
|
|
|
|
* A false result may be caused by property inequality or by properties in one object missing from
|
|
|
|
|
* the other. An asymmetrical test may also be performed, which checks only that properties in the
|
|
|
|
|
* first object are present in the second object, but not the inverse.
|
|
|
|
|
*
|
2014-08-20 22:35:43 +00:00
|
|
|
* If either a or b is null or undefined it will be treated as an empty object.
|
|
|
|
|
*
|
2014-08-31 21:26:08 +00:00
|
|
|
* @param {Object|undefined|null} a First object to compare
|
|
|
|
|
* @param {Object|undefined|null} b Second object to compare
|
2014-11-17 19:26:17 +00:00
|
|
|
* @param {boolean} [asymmetrical] Whether to check only that a's values are equal to b's
|
|
|
|
|
* (i.e. a is a subset of b)
|
2014-03-08 01:36:25 +00:00
|
|
|
* @return {boolean} If the objects contain the same values as each other
|
2013-12-03 19:48:24 +00:00
|
|
|
*/
|
|
|
|
|
oo.compare = function ( a, b, asymmetrical ) {
|
|
|
|
|
var aValue, bValue, aType, bType, k;
|
|
|
|
|
|
|
|
|
|
if ( a === b ) {
|
|
|
|
|
return true;
|
|
|
|
|
}
|
|
|
|
|
|
2014-08-20 22:35:43 +00:00
|
|
|
a = a || {};
|
|
|
|
|
b = b || {};
|
|
|
|
|
|
2015-02-26 01:59:38 +00:00
|
|
|
if ( typeof a.nodeType === 'number' && typeof a.isEqualNode === 'function' ) {
|
|
|
|
|
return a.isEqualNode( b );
|
|
|
|
|
}
|
|
|
|
|
|
2013-12-03 19:48:24 +00:00
|
|
|
for ( k in a ) {
|
2015-02-26 01:59:38 +00:00
|
|
|
if ( !hasOwn.call( a, k ) || a[k] === undefined || a[k] === b[k] ) {
|
2014-11-17 19:26:17 +00:00
|
|
|
// Support es3-shim: Without the hasOwn filter, comparing [] to {} will be false in ES3
|
2014-06-26 23:55:15 +00:00
|
|
|
// because the shimmed "forEach" is enumerable and shows up in Array but not Object.
|
2014-11-17 19:26:17 +00:00
|
|
|
// Also ignore undefined values, because there is no conceptual difference between
|
|
|
|
|
// a key that is absent and a key that is present but whose value is undefined.
|
2014-06-26 23:55:15 +00:00
|
|
|
continue;
|
|
|
|
|
}
|
|
|
|
|
|
2013-12-03 19:48:24 +00:00
|
|
|
aValue = a[k];
|
|
|
|
|
bValue = b[k];
|
|
|
|
|
aType = typeof aValue;
|
|
|
|
|
bType = typeof bValue;
|
|
|
|
|
if ( aType !== bType ||
|
2014-09-11 00:43:02 +00:00
|
|
|
(
|
|
|
|
|
( aType === 'string' || aType === 'number' || aType === 'boolean' ) &&
|
|
|
|
|
aValue !== bValue
|
|
|
|
|
) ||
|
2015-02-26 01:59:38 +00:00
|
|
|
( aValue === Object( aValue ) && !oo.compare( aValue, bValue, true ) ) ) {
|
2013-12-03 19:48:24 +00:00
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
// If the check is not asymmetrical, recursing with the arguments swapped will verify our result
|
|
|
|
|
return asymmetrical ? true : oo.compare( b, a, true );
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Create a plain deep copy of any kind of object.
|
|
|
|
|
*
|
|
|
|
|
* Copies are deep, and will either be an object or an array depending on `source`.
|
|
|
|
|
*
|
|
|
|
|
* @param {Object} source Object to copy
|
2014-08-20 22:35:43 +00:00
|
|
|
* @param {Function} [leafCallback] Applied to leaf values after they are cloned but before they are added to the clone
|
|
|
|
|
* @param {Function} [nodeCallback] Applied to all values before they are cloned. If the nodeCallback returns a value other than undefined, the returned value is used instead of attempting to clone.
|
2014-03-08 01:36:25 +00:00
|
|
|
* @return {Object} Copy of source object
|
2013-12-03 19:48:24 +00:00
|
|
|
*/
|
2014-08-20 22:35:43 +00:00
|
|
|
oo.copy = function ( source, leafCallback, nodeCallback ) {
|
|
|
|
|
var key, destination;
|
|
|
|
|
|
|
|
|
|
if ( nodeCallback ) {
|
|
|
|
|
// Extensibility: check before attempting to clone source.
|
|
|
|
|
destination = nodeCallback( source );
|
|
|
|
|
if ( destination !== undefined ) {
|
|
|
|
|
return destination;
|
|
|
|
|
}
|
2013-12-03 19:48:24 +00:00
|
|
|
}
|
|
|
|
|
|
2014-08-20 22:35:43 +00:00
|
|
|
if ( Array.isArray( source ) ) {
|
|
|
|
|
// Array (fall through)
|
|
|
|
|
destination = new Array( source.length );
|
|
|
|
|
} else if ( source && typeof source.clone === 'function' ) {
|
|
|
|
|
// Duck type object with custom clone method
|
|
|
|
|
return leafCallback ? leafCallback( source.clone() ) : source.clone();
|
|
|
|
|
} else if ( source && typeof source.cloneNode === 'function' ) {
|
|
|
|
|
// DOM Node
|
|
|
|
|
return leafCallback ?
|
|
|
|
|
leafCallback( source.cloneNode( true ) ) :
|
|
|
|
|
source.cloneNode( true );
|
|
|
|
|
} else if ( oo.isPlainObject( source ) ) {
|
|
|
|
|
// Plain objects (fall through)
|
|
|
|
|
destination = {};
|
|
|
|
|
} else {
|
|
|
|
|
// Non-plain objects (incl. functions) and primitive values
|
|
|
|
|
return leafCallback ? leafCallback( source ) : source;
|
|
|
|
|
}
|
2013-12-03 19:48:24 +00:00
|
|
|
|
2014-08-20 22:35:43 +00:00
|
|
|
// source is an array or a plain object
|
2013-12-03 19:48:24 +00:00
|
|
|
for ( key in source ) {
|
2014-08-20 22:35:43 +00:00
|
|
|
destination[key] = oo.copy( source[key], leafCallback, nodeCallback );
|
2013-12-03 19:48:24 +00:00
|
|
|
}
|
|
|
|
|
|
2014-08-20 22:35:43 +00:00
|
|
|
// This is an internal node, so we don't apply the leafCallback.
|
2013-12-03 19:48:24 +00:00
|
|
|
return destination;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/**
|
2014-03-08 01:36:25 +00:00
|
|
|
* Generate a hash of an object based on its name and data.
|
|
|
|
|
*
|
|
|
|
|
* Performance optimization: <http://jsperf.com/ve-gethash-201208#/toJson_fnReplacerIfAoForElse>
|
2013-12-03 19:48:24 +00:00
|
|
|
*
|
|
|
|
|
* To avoid two objects with the same values generating different hashes, we utilize the replacer
|
|
|
|
|
* argument of JSON.stringify and sort the object by key as it's being serialized. This may or may
|
|
|
|
|
* not be the fastest way to do this; we should investigate this further.
|
|
|
|
|
*
|
|
|
|
|
* Objects and arrays are hashed recursively. When hashing an object that has a .getHash()
|
|
|
|
|
* function, we call that function and use its return value rather than hashing the object
|
|
|
|
|
* ourselves. This allows classes to define custom hashing.
|
|
|
|
|
*
|
|
|
|
|
* @param {Object} val Object to generate hash for
|
2014-03-08 01:36:25 +00:00
|
|
|
* @return {string} Hash of object
|
2013-12-03 19:48:24 +00:00
|
|
|
*/
|
|
|
|
|
oo.getHash = function ( val ) {
|
|
|
|
|
return JSON.stringify( val, oo.getHash.keySortReplacer );
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/**
|
2014-08-31 21:26:08 +00:00
|
|
|
* Sort objects by key (helper function for OO.getHash).
|
2013-12-03 19:48:24 +00:00
|
|
|
*
|
|
|
|
|
* This is a callback passed into JSON.stringify.
|
|
|
|
|
*
|
2014-03-08 01:36:25 +00:00
|
|
|
* @method getHash_keySortReplacer
|
2013-12-03 19:48:24 +00:00
|
|
|
* @param {string} key Property name of value being replaced
|
|
|
|
|
* @param {Mixed} val Property value to replace
|
2014-03-08 01:36:25 +00:00
|
|
|
* @return {Mixed} Replacement value
|
2013-12-03 19:48:24 +00:00
|
|
|
*/
|
|
|
|
|
oo.getHash.keySortReplacer = function ( key, val ) {
|
|
|
|
|
var normalized, keys, i, len;
|
|
|
|
|
if ( val && typeof val.getHashObject === 'function' ) {
|
|
|
|
|
// This object has its own custom hash function, use it
|
|
|
|
|
val = val.getHashObject();
|
|
|
|
|
}
|
|
|
|
|
if ( !Array.isArray( val ) && Object( val ) === val ) {
|
|
|
|
|
// Only normalize objects when the key-order is ambiguous
|
|
|
|
|
// (e.g. any object not an array).
|
|
|
|
|
normalized = {};
|
|
|
|
|
keys = Object.keys( val ).sort();
|
|
|
|
|
i = 0;
|
|
|
|
|
len = keys.length;
|
|
|
|
|
for ( ; i < len; i += 1 ) {
|
|
|
|
|
normalized[keys[i]] = val[keys[i]];
|
|
|
|
|
}
|
|
|
|
|
return normalized;
|
|
|
|
|
|
|
|
|
|
// Primitive values and arrays get stable hashes
|
|
|
|
|
// by default. Lets those be stringified as-is.
|
|
|
|
|
} else {
|
|
|
|
|
return val;
|
|
|
|
|
}
|
|
|
|
|
};
|
|
|
|
|
|
2015-03-19 01:47:12 +00:00
|
|
|
/**
|
|
|
|
|
* Get the unique values of an array, removing duplicates
|
|
|
|
|
*
|
|
|
|
|
* @param {Array} arr Array
|
|
|
|
|
* @return {Array} Unique values in array
|
|
|
|
|
*/
|
|
|
|
|
oo.unique = function ( arr ) {
|
|
|
|
|
return arr.reduce( function ( result, current ) {
|
|
|
|
|
if ( result.indexOf( current ) === -1 ) {
|
|
|
|
|
result.push( current );
|
|
|
|
|
}
|
|
|
|
|
return result;
|
|
|
|
|
}, [] );
|
|
|
|
|
};
|
|
|
|
|
|
2013-12-03 19:48:24 +00:00
|
|
|
/**
|
|
|
|
|
* Compute the union (duplicate-free merge) of a set of arrays.
|
|
|
|
|
*
|
2014-03-08 01:36:25 +00:00
|
|
|
* Arrays values must be convertable to object keys (strings).
|
2013-12-03 19:48:24 +00:00
|
|
|
*
|
|
|
|
|
* By building an object (with the values for keys) in parallel with
|
2014-03-08 01:36:25 +00:00
|
|
|
* the array, a new item's existence in the union can be computed faster.
|
2013-12-03 19:48:24 +00:00
|
|
|
*
|
|
|
|
|
* @param {Array...} arrays Arrays to union
|
2014-03-08 01:36:25 +00:00
|
|
|
* @return {Array} Union of the arrays
|
2013-12-03 19:48:24 +00:00
|
|
|
*/
|
|
|
|
|
oo.simpleArrayUnion = function () {
|
|
|
|
|
var i, ilen, arr, j, jlen,
|
|
|
|
|
obj = {},
|
|
|
|
|
result = [];
|
|
|
|
|
|
|
|
|
|
for ( i = 0, ilen = arguments.length; i < ilen; i++ ) {
|
|
|
|
|
arr = arguments[i];
|
|
|
|
|
for ( j = 0, jlen = arr.length; j < jlen; j++ ) {
|
|
|
|
|
if ( !obj[ arr[j] ] ) {
|
|
|
|
|
obj[ arr[j] ] = true;
|
|
|
|
|
result.push( arr[j] );
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return result;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Combine arrays (intersection or difference).
|
|
|
|
|
*
|
|
|
|
|
* An intersection checks the item exists in 'b' while difference checks it doesn't.
|
|
|
|
|
*
|
2014-03-08 01:36:25 +00:00
|
|
|
* Arrays values must be convertable to object keys (strings).
|
2013-12-03 19:48:24 +00:00
|
|
|
*
|
|
|
|
|
* By building an object (with the values for keys) of 'b' we can
|
2014-03-08 01:36:25 +00:00
|
|
|
* compute the result faster.
|
2013-12-03 19:48:24 +00:00
|
|
|
*
|
|
|
|
|
* @private
|
|
|
|
|
* @param {Array} a First array
|
|
|
|
|
* @param {Array} b Second array
|
|
|
|
|
* @param {boolean} includeB Whether to items in 'b'
|
2014-03-08 01:36:25 +00:00
|
|
|
* @return {Array} Combination (intersection or difference) of arrays
|
2013-12-03 19:48:24 +00:00
|
|
|
*/
|
|
|
|
|
function simpleArrayCombine( a, b, includeB ) {
|
|
|
|
|
var i, ilen, isInB,
|
|
|
|
|
bObj = {},
|
|
|
|
|
result = [];
|
|
|
|
|
|
|
|
|
|
for ( i = 0, ilen = b.length; i < ilen; i++ ) {
|
|
|
|
|
bObj[ b[i] ] = true;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
for ( i = 0, ilen = a.length; i < ilen; i++ ) {
|
|
|
|
|
isInB = !!bObj[ a[i] ];
|
|
|
|
|
if ( isInB === includeB ) {
|
|
|
|
|
result.push( a[i] );
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return result;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Compute the intersection of two arrays (items in both arrays).
|
|
|
|
|
*
|
2014-03-08 01:36:25 +00:00
|
|
|
* Arrays values must be convertable to object keys (strings).
|
2013-12-03 19:48:24 +00:00
|
|
|
*
|
|
|
|
|
* @param {Array} a First array
|
|
|
|
|
* @param {Array} b Second array
|
2014-03-08 01:36:25 +00:00
|
|
|
* @return {Array} Intersection of arrays
|
2013-12-03 19:48:24 +00:00
|
|
|
*/
|
|
|
|
|
oo.simpleArrayIntersection = function ( a, b ) {
|
|
|
|
|
return simpleArrayCombine( a, b, true );
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Compute the difference of two arrays (items in 'a' but not 'b').
|
|
|
|
|
*
|
2014-03-08 01:36:25 +00:00
|
|
|
* Arrays values must be convertable to object keys (strings).
|
2013-12-03 19:48:24 +00:00
|
|
|
*
|
|
|
|
|
* @param {Array} a First array
|
|
|
|
|
* @param {Array} b Second array
|
2014-03-08 01:36:25 +00:00
|
|
|
* @return {Array} Intersection of arrays
|
2013-12-03 19:48:24 +00:00
|
|
|
*/
|
|
|
|
|
oo.simpleArrayDifference = function ( a, b ) {
|
|
|
|
|
return simpleArrayCombine( a, b, false );
|
|
|
|
|
};
|
2014-07-23 20:53:29 +00:00
|
|
|
|
2014-07-23 19:57:40 +00:00
|
|
|
/*global $ */
|
2014-06-26 23:55:15 +00:00
|
|
|
|
2014-07-23 19:57:40 +00:00
|
|
|
oo.isPlainObject = $.isPlainObject;
|
2014-07-23 20:53:29 +00:00
|
|
|
|
|
|
|
|
/*global hasOwn */
|
|
|
|
|
|
2014-08-31 21:26:08 +00:00
|
|
|
( function () {
|
2014-03-08 01:36:25 +00:00
|
|
|
|
|
|
|
|
/**
|
2014-08-31 21:26:08 +00:00
|
|
|
* @class OO.EventEmitter
|
2014-03-08 01:36:25 +00:00
|
|
|
*
|
2014-08-31 21:26:08 +00:00
|
|
|
* @constructor
|
2014-03-08 01:36:25 +00:00
|
|
|
*/
|
2014-08-31 21:26:08 +00:00
|
|
|
oo.EventEmitter = function OoEventEmitter() {
|
|
|
|
|
// Properties
|
2013-12-03 19:48:24 +00:00
|
|
|
|
2014-08-31 21:26:08 +00:00
|
|
|
/**
|
|
|
|
|
* Storage of bound event handlers by event name.
|
|
|
|
|
*
|
|
|
|
|
* @property
|
|
|
|
|
*/
|
|
|
|
|
this.bindings = {};
|
|
|
|
|
};
|
2014-08-20 22:35:43 +00:00
|
|
|
|
2014-08-31 21:26:08 +00:00
|
|
|
oo.initClass( oo.EventEmitter );
|
2013-12-03 19:48:24 +00:00
|
|
|
|
2014-08-31 21:26:08 +00:00
|
|
|
/* Private helper functions */
|
2014-08-20 22:35:43 +00:00
|
|
|
|
2014-08-31 21:26:08 +00:00
|
|
|
/**
|
|
|
|
|
* Validate a function or method call in a context
|
|
|
|
|
*
|
|
|
|
|
* For a method name, check that it names a function in the context object
|
|
|
|
|
*
|
|
|
|
|
* @private
|
|
|
|
|
* @param {Function|string} method Function or method name
|
|
|
|
|
* @param {Mixed} context The context of the call
|
|
|
|
|
* @throws {Error} A method name is given but there is no context
|
|
|
|
|
* @throws {Error} In the context object, no property exists with the given name
|
|
|
|
|
* @throws {Error} In the context object, the named property is not a function
|
|
|
|
|
*/
|
|
|
|
|
function validateMethod( method, context ) {
|
|
|
|
|
// Validate method and context
|
|
|
|
|
if ( typeof method === 'string' ) {
|
|
|
|
|
// Validate method
|
|
|
|
|
if ( context === undefined || context === null ) {
|
|
|
|
|
throw new Error( 'Method name "' + method + '" has no context.' );
|
|
|
|
|
}
|
|
|
|
|
if ( typeof context[method] !== 'function' ) {
|
|
|
|
|
// Technically the property could be replaced by a function before
|
|
|
|
|
// call time. But this probably signals a typo.
|
|
|
|
|
throw new Error( 'Property "' + method + '" is not a function' );
|
|
|
|
|
}
|
|
|
|
|
} else if ( typeof method !== 'function' ) {
|
|
|
|
|
throw new Error( 'Invalid callback. Function or method name expected.' );
|
|
|
|
|
}
|
2013-12-03 19:48:24 +00:00
|
|
|
}
|
|
|
|
|
|
2014-08-31 21:26:08 +00:00
|
|
|
/* Methods */
|
2013-12-03 19:48:24 +00:00
|
|
|
|
2014-08-31 21:26:08 +00:00
|
|
|
/**
|
|
|
|
|
* Add a listener to events of a specific event.
|
|
|
|
|
*
|
|
|
|
|
* The listener can be a function or the string name of a method; if the latter, then the
|
|
|
|
|
* name lookup happens at the time the listener is called.
|
|
|
|
|
*
|
|
|
|
|
* @param {string} event Type of event to listen to
|
|
|
|
|
* @param {Function|string} method Function or method name to call when event occurs
|
|
|
|
|
* @param {Array} [args] Arguments to pass to listener, will be prepended to emitted arguments
|
|
|
|
|
* @param {Object} [context=null] Context object for function or method call
|
|
|
|
|
* @throws {Error} Listener argument is not a function or a valid method name
|
|
|
|
|
* @chainable
|
|
|
|
|
*/
|
|
|
|
|
oo.EventEmitter.prototype.on = function ( event, method, args, context ) {
|
|
|
|
|
var bindings;
|
2013-12-03 19:48:24 +00:00
|
|
|
|
2014-08-31 21:26:08 +00:00
|
|
|
validateMethod( method, context );
|
|
|
|
|
|
|
|
|
|
if ( hasOwn.call( this.bindings, event ) ) {
|
|
|
|
|
bindings = this.bindings[event];
|
|
|
|
|
} else {
|
|
|
|
|
// Auto-initialize bindings list
|
|
|
|
|
bindings = this.bindings[event] = [];
|
|
|
|
|
}
|
|
|
|
|
// Add binding
|
|
|
|
|
bindings.push( {
|
|
|
|
|
method: method,
|
|
|
|
|
args: args,
|
|
|
|
|
context: ( arguments.length < 4 ) ? null : context
|
|
|
|
|
} );
|
2014-08-20 22:35:43 +00:00
|
|
|
return this;
|
2014-08-31 21:26:08 +00:00
|
|
|
};
|
2014-08-20 22:35:43 +00:00
|
|
|
|
2014-08-31 21:26:08 +00:00
|
|
|
/**
|
|
|
|
|
* Add a one-time listener to a specific event.
|
|
|
|
|
*
|
|
|
|
|
* @param {string} event Type of event to listen to
|
|
|
|
|
* @param {Function} listener Listener to call when event occurs
|
|
|
|
|
* @chainable
|
|
|
|
|
*/
|
|
|
|
|
oo.EventEmitter.prototype.once = function ( event, listener ) {
|
|
|
|
|
var eventEmitter = this,
|
2015-02-26 01:59:38 +00:00
|
|
|
wrapper = function () {
|
|
|
|
|
eventEmitter.off( event, wrapper );
|
|
|
|
|
return listener.apply( this, arguments );
|
2014-08-31 21:26:08 +00:00
|
|
|
};
|
2015-02-26 01:59:38 +00:00
|
|
|
return this.on( event, wrapper );
|
2014-08-31 21:26:08 +00:00
|
|
|
};
|
2014-08-20 22:35:43 +00:00
|
|
|
|
2014-08-31 21:26:08 +00:00
|
|
|
/**
|
|
|
|
|
* Remove a specific listener from a specific event.
|
|
|
|
|
*
|
|
|
|
|
* @param {string} event Type of event to remove listener from
|
|
|
|
|
* @param {Function|string} [method] Listener to remove. Must be in the same form as was passed
|
|
|
|
|
* to "on". Omit to remove all listeners.
|
|
|
|
|
* @param {Object} [context=null] Context object function or method call
|
|
|
|
|
* @chainable
|
|
|
|
|
* @throws {Error} Listener argument is not a function or a valid method name
|
|
|
|
|
*/
|
|
|
|
|
oo.EventEmitter.prototype.off = function ( event, method, context ) {
|
|
|
|
|
var i, bindings;
|
2014-08-20 22:35:43 +00:00
|
|
|
|
2014-08-31 21:26:08 +00:00
|
|
|
if ( arguments.length === 1 ) {
|
|
|
|
|
// Remove all bindings for event
|
|
|
|
|
delete this.bindings[event];
|
|
|
|
|
return this;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
validateMethod( method, context );
|
2014-08-20 22:35:43 +00:00
|
|
|
|
2014-11-06 18:47:13 +00:00
|
|
|
if ( !hasOwn.call( this.bindings, event ) || !this.bindings[event].length ) {
|
2014-08-31 21:26:08 +00:00
|
|
|
// No matching bindings
|
|
|
|
|
return this;
|
2013-12-03 19:48:24 +00:00
|
|
|
}
|
2014-08-20 22:35:43 +00:00
|
|
|
|
2014-08-31 21:26:08 +00:00
|
|
|
// Default to null context
|
|
|
|
|
if ( arguments.length < 3 ) {
|
|
|
|
|
context = null;
|
|
|
|
|
}
|
2013-12-03 19:48:24 +00:00
|
|
|
|
2014-08-31 21:26:08 +00:00
|
|
|
// Remove matching handlers
|
|
|
|
|
bindings = this.bindings[event];
|
|
|
|
|
i = bindings.length;
|
|
|
|
|
while ( i-- ) {
|
|
|
|
|
if ( bindings[i].method === method && bindings[i].context === context ) {
|
|
|
|
|
bindings.splice( i, 1 );
|
2014-08-20 22:35:43 +00:00
|
|
|
}
|
2013-12-03 19:48:24 +00:00
|
|
|
}
|
|
|
|
|
|
2014-08-31 21:26:08 +00:00
|
|
|
// Cleanup if now empty
|
|
|
|
|
if ( bindings.length === 0 ) {
|
|
|
|
|
delete this.bindings[event];
|
2013-12-03 19:48:24 +00:00
|
|
|
}
|
2014-08-31 21:26:08 +00:00
|
|
|
return this;
|
|
|
|
|
};
|
2013-12-03 19:48:24 +00:00
|
|
|
|
2014-08-31 21:26:08 +00:00
|
|
|
/**
|
|
|
|
|
* Emit an event.
|
|
|
|
|
*
|
|
|
|
|
* TODO: Should this be chainable? What is the usefulness of the boolean
|
|
|
|
|
* return value here?
|
|
|
|
|
*
|
|
|
|
|
* @param {string} event Type of event
|
|
|
|
|
* @param {Mixed} args First in a list of variadic arguments passed to event handler (optional)
|
|
|
|
|
* @return {boolean} If event was handled by at least one listener
|
|
|
|
|
*/
|
|
|
|
|
oo.EventEmitter.prototype.emit = function ( event ) {
|
2015-01-23 20:18:10 +00:00
|
|
|
var args = [],
|
|
|
|
|
i, len, binding, bindings, method;
|
2014-08-31 21:26:08 +00:00
|
|
|
|
2014-11-06 18:47:13 +00:00
|
|
|
if ( hasOwn.call( this.bindings, event ) ) {
|
2014-08-31 21:26:08 +00:00
|
|
|
// Slicing ensures that we don't get tripped up by event handlers that add/remove bindings
|
|
|
|
|
bindings = this.bindings[event].slice();
|
2015-01-23 20:18:10 +00:00
|
|
|
for ( i = 1, len = arguments.length; i < len; i++ ) {
|
|
|
|
|
args.push( arguments[i] );
|
|
|
|
|
}
|
2014-08-31 21:26:08 +00:00
|
|
|
for ( i = 0, len = bindings.length; i < len; i++ ) {
|
|
|
|
|
binding = bindings[i];
|
|
|
|
|
if ( typeof binding.method === 'string' ) {
|
|
|
|
|
// Lookup method by name (late binding)
|
|
|
|
|
method = binding.context[ binding.method ];
|
|
|
|
|
} else {
|
|
|
|
|
method = binding.method;
|
|
|
|
|
}
|
|
|
|
|
method.apply(
|
|
|
|
|
binding.context,
|
|
|
|
|
binding.args ? binding.args.concat( args ) : args
|
|
|
|
|
);
|
|
|
|
|
}
|
|
|
|
|
return true;
|
|
|
|
|
}
|
|
|
|
|
return false;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Connect event handlers to an object.
|
|
|
|
|
*
|
|
|
|
|
* @param {Object} context Object to call methods on when events occur
|
|
|
|
|
* @param {Object.<string,string>|Object.<string,Function>|Object.<string,Array>} methods List of
|
|
|
|
|
* event bindings keyed by event name containing either method names, functions or arrays containing
|
|
|
|
|
* method name or function followed by a list of arguments to be passed to callback before emitted
|
|
|
|
|
* arguments
|
|
|
|
|
* @chainable
|
|
|
|
|
*/
|
|
|
|
|
oo.EventEmitter.prototype.connect = function ( context, methods ) {
|
|
|
|
|
var method, args, event;
|
2013-12-03 19:48:24 +00:00
|
|
|
|
|
|
|
|
for ( event in methods ) {
|
2014-08-31 21:26:08 +00:00
|
|
|
method = methods[event];
|
|
|
|
|
// Allow providing additional args
|
|
|
|
|
if ( Array.isArray( method ) ) {
|
|
|
|
|
args = method.slice( 1 );
|
|
|
|
|
method = method[0];
|
|
|
|
|
} else {
|
|
|
|
|
args = [];
|
|
|
|
|
}
|
|
|
|
|
// Add binding
|
|
|
|
|
this.on( event, method, args, context );
|
2013-12-03 19:48:24 +00:00
|
|
|
}
|
2014-08-31 21:26:08 +00:00
|
|
|
return this;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Disconnect event handlers from an object.
|
|
|
|
|
*
|
|
|
|
|
* @param {Object} context Object to disconnect methods from
|
|
|
|
|
* @param {Object.<string,string>|Object.<string,Function>|Object.<string,Array>} [methods] List of
|
|
|
|
|
* event bindings keyed by event name. Values can be either method names or functions, but must be
|
|
|
|
|
* consistent with those used in the corresponding call to "connect".
|
|
|
|
|
* @chainable
|
|
|
|
|
*/
|
|
|
|
|
oo.EventEmitter.prototype.disconnect = function ( context, methods ) {
|
|
|
|
|
var i, event, bindings;
|
|
|
|
|
|
|
|
|
|
if ( methods ) {
|
|
|
|
|
// Remove specific connections to the context
|
|
|
|
|
for ( event in methods ) {
|
|
|
|
|
this.off( event, methods[event], context );
|
|
|
|
|
}
|
|
|
|
|
} else {
|
|
|
|
|
// Remove all connections to the context
|
|
|
|
|
for ( event in this.bindings ) {
|
|
|
|
|
bindings = this.bindings[event];
|
|
|
|
|
i = bindings.length;
|
|
|
|
|
while ( i-- ) {
|
|
|
|
|
// bindings[i] may have been removed by the previous step's
|
|
|
|
|
// this.off so check it still exists
|
|
|
|
|
if ( bindings[i] && bindings[i].context === context ) {
|
|
|
|
|
this.off( event, bindings[i].method, context );
|
|
|
|
|
}
|
2013-12-03 19:48:24 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2014-08-31 21:26:08 +00:00
|
|
|
return this;
|
|
|
|
|
};
|
2014-07-23 20:53:29 +00:00
|
|
|
|
2014-08-31 21:26:08 +00:00
|
|
|
}() );
|
2014-08-20 22:35:43 +00:00
|
|
|
|
|
|
|
|
/*global hasOwn */
|
|
|
|
|
|
2013-12-03 19:48:24 +00:00
|
|
|
/**
|
|
|
|
|
* @class OO.Registry
|
|
|
|
|
* @mixins OO.EventEmitter
|
|
|
|
|
*
|
|
|
|
|
* @constructor
|
|
|
|
|
*/
|
|
|
|
|
oo.Registry = function OoRegistry() {
|
|
|
|
|
// Mixin constructors
|
|
|
|
|
oo.EventEmitter.call( this );
|
|
|
|
|
|
|
|
|
|
// Properties
|
|
|
|
|
this.registry = {};
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/* Inheritance */
|
|
|
|
|
|
|
|
|
|
oo.mixinClass( oo.Registry, oo.EventEmitter );
|
|
|
|
|
|
|
|
|
|
/* Events */
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @event register
|
|
|
|
|
* @param {string} name
|
|
|
|
|
* @param {Mixed} data
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
/* Methods */
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Associate one or more symbolic names with some data.
|
|
|
|
|
*
|
|
|
|
|
* Only the base name will be registered, overriding any existing entry with the same base name.
|
|
|
|
|
*
|
|
|
|
|
* @param {string|string[]} name Symbolic name or list of symbolic names
|
|
|
|
|
* @param {Mixed} data Data to associate with symbolic name
|
|
|
|
|
* @fires register
|
|
|
|
|
* @throws {Error} Name argument must be a string or array
|
|
|
|
|
*/
|
|
|
|
|
oo.Registry.prototype.register = function ( name, data ) {
|
|
|
|
|
var i, len;
|
2014-03-08 01:36:25 +00:00
|
|
|
if ( typeof name === 'string' ) {
|
|
|
|
|
this.registry[name] = data;
|
|
|
|
|
this.emit( 'register', name, data );
|
|
|
|
|
} else if ( Array.isArray( name ) ) {
|
2013-12-03 19:48:24 +00:00
|
|
|
for ( i = 0, len = name.length; i < len; i++ ) {
|
|
|
|
|
this.register( name[i], data );
|
|
|
|
|
}
|
|
|
|
|
} else {
|
2014-03-08 01:36:25 +00:00
|
|
|
throw new Error( 'Name must be a string or array, cannot be a ' + typeof name );
|
2013-12-03 19:48:24 +00:00
|
|
|
}
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/**
|
2014-03-08 01:36:25 +00:00
|
|
|
* Get data for a given symbolic name.
|
2013-12-03 19:48:24 +00:00
|
|
|
*
|
|
|
|
|
* Lookups are done using the base name.
|
|
|
|
|
*
|
|
|
|
|
* @param {string} name Symbolic name
|
2014-03-08 01:36:25 +00:00
|
|
|
* @return {Mixed|undefined} Data associated with symbolic name
|
2013-12-03 19:48:24 +00:00
|
|
|
*/
|
|
|
|
|
oo.Registry.prototype.lookup = function ( name ) {
|
2014-08-20 22:35:43 +00:00
|
|
|
if ( hasOwn.call( this.registry, name ) ) {
|
|
|
|
|
return this.registry[name];
|
|
|
|
|
}
|
2013-12-03 19:48:24 +00:00
|
|
|
};
|
2014-07-23 20:53:29 +00:00
|
|
|
|
2013-12-03 19:48:24 +00:00
|
|
|
/**
|
|
|
|
|
* @class OO.Factory
|
|
|
|
|
* @extends OO.Registry
|
|
|
|
|
*
|
|
|
|
|
* @constructor
|
|
|
|
|
*/
|
|
|
|
|
oo.Factory = function OoFactory() {
|
2014-06-26 23:55:15 +00:00
|
|
|
oo.Factory.parent.call( this );
|
2013-12-03 19:48:24 +00:00
|
|
|
|
|
|
|
|
// Properties
|
|
|
|
|
this.entries = [];
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/* Inheritance */
|
|
|
|
|
|
|
|
|
|
oo.inheritClass( oo.Factory, oo.Registry );
|
|
|
|
|
|
|
|
|
|
/* Methods */
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Register a constructor with the factory.
|
|
|
|
|
*
|
|
|
|
|
* Classes must have a static `name` property to be registered.
|
|
|
|
|
*
|
|
|
|
|
* function MyClass() {};
|
2014-04-02 21:40:24 +00:00
|
|
|
* OO.initClass( MyClass );
|
2013-12-03 19:48:24 +00:00
|
|
|
* // Adds a static property to the class defining a symbolic name
|
2014-04-02 21:40:24 +00:00
|
|
|
* MyClass.static.name = 'mine';
|
2013-12-03 19:48:24 +00:00
|
|
|
* // Registers class with factory, available via symbolic name 'mine'
|
|
|
|
|
* factory.register( MyClass );
|
|
|
|
|
*
|
|
|
|
|
* @param {Function} constructor Constructor to use when creating object
|
|
|
|
|
* @throws {Error} Name must be a string and must not be empty
|
|
|
|
|
* @throws {Error} Constructor must be a function
|
|
|
|
|
*/
|
|
|
|
|
oo.Factory.prototype.register = function ( constructor ) {
|
|
|
|
|
var name;
|
|
|
|
|
|
|
|
|
|
if ( typeof constructor !== 'function' ) {
|
|
|
|
|
throw new Error( 'constructor must be a function, cannot be a ' + typeof constructor );
|
|
|
|
|
}
|
|
|
|
|
name = constructor.static && constructor.static.name;
|
|
|
|
|
if ( typeof name !== 'string' || name === '' ) {
|
|
|
|
|
throw new Error( 'Name must be a string and must not be empty' );
|
|
|
|
|
}
|
|
|
|
|
this.entries.push( name );
|
2014-03-08 01:36:25 +00:00
|
|
|
|
2014-06-26 23:55:15 +00:00
|
|
|
oo.Factory.parent.prototype.register.call( this, name, constructor );
|
2013-12-03 19:48:24 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Create an object based on a name.
|
|
|
|
|
*
|
|
|
|
|
* Name is used to look up the constructor to use, while all additional arguments are passed to the
|
|
|
|
|
* constructor directly, so leaving one out will pass an undefined to the constructor.
|
|
|
|
|
*
|
|
|
|
|
* @param {string} name Object name
|
|
|
|
|
* @param {Mixed...} [args] Arguments to pass to the constructor
|
2014-03-08 01:36:25 +00:00
|
|
|
* @return {Object} The new object
|
2013-12-03 19:48:24 +00:00
|
|
|
* @throws {Error} Unknown object name
|
|
|
|
|
*/
|
|
|
|
|
oo.Factory.prototype.create = function ( name ) {
|
2015-01-23 20:18:10 +00:00
|
|
|
var obj, i,
|
|
|
|
|
args = [],
|
2014-08-20 22:35:43 +00:00
|
|
|
constructor = this.lookup( name );
|
2013-12-03 19:48:24 +00:00
|
|
|
|
2014-08-20 22:35:43 +00:00
|
|
|
if ( !constructor ) {
|
2013-12-03 19:48:24 +00:00
|
|
|
throw new Error( 'No class registered by that name: ' + name );
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Convert arguments to array and shift the first argument (name) off
|
2015-01-23 20:18:10 +00:00
|
|
|
for ( i = 1; i < arguments.length; i++ ) {
|
|
|
|
|
args.push( arguments[i] );
|
|
|
|
|
}
|
2013-12-03 19:48:24 +00:00
|
|
|
|
|
|
|
|
// We can't use the "new" operator with .apply directly because apply needs a
|
|
|
|
|
// context. So instead just do what "new" does: create an object that inherits from
|
|
|
|
|
// the constructor's prototype (which also makes it an "instanceof" the constructor),
|
|
|
|
|
// then invoke the constructor with the object as context, and return it (ignoring
|
|
|
|
|
// the constructor's return value).
|
|
|
|
|
obj = Object.create( constructor.prototype );
|
|
|
|
|
constructor.apply( obj, args );
|
|
|
|
|
return obj;
|
|
|
|
|
};
|
2014-07-23 20:53:29 +00:00
|
|
|
|
2013-12-03 19:48:24 +00:00
|
|
|
/*jshint node:true */
|
|
|
|
|
if ( typeof module !== 'undefined' && module.exports ) {
|
|
|
|
|
module.exports = oo;
|
|
|
|
|
} else {
|
|
|
|
|
global.OO = oo;
|
|
|
|
|
}
|
2014-07-23 20:53:29 +00:00
|
|
|
|
2013-12-03 19:48:24 +00:00
|
|
|
}( this ) );
|