2 * OOjs v1.1.3 optimised for jQuery
3 * https://www.mediawiki.org/wiki/OOjs
5 * Copyright 2011-2014 OOjs Team and other contributors.
6 * Released under the MIT license
7 * http://oojs.mit-license.org
9 * Date: 2014-11-17T19:17:29Z
11 ( function ( global
) {
15 /*exported toString */
18 * Namespace for all classes, static methods and static properties.
23 // Optimisation: Local reference to Object.prototype.hasOwnProperty
24 hasOwn
= oo
.hasOwnProperty
,
25 toString
= oo
.toString
;
30 * Utility to initialize a class for OO inheritance.
32 * Currently this just initializes an empty static object.
34 * @param {Function} fn
36 oo
.initClass = function ( fn
) {
37 fn
.static = fn
.static || {};
41 * Inherit from prototype to another using Object#create.
43 * Beware: This redefines the prototype, call before setting your prototypes.
45 * Beware: This redefines the prototype, can only be called once on a function.
46 * If called multiple times on the same function, the previous prototype is lost.
47 * This is how prototypal inheritance works, it can only be one straight chain
48 * (just like classical inheritance in PHP for example). If you need to work with
49 * multiple constructors consider storing an instance of the other constructor in a
50 * property instead, or perhaps use a mixin (see OO.mixinClass).
53 * Thing.prototype.exists = function () {};
56 * Person.super.apply( this, arguments );
58 * OO.inheritClass( Person, Thing );
59 * Person.static.defaultEyeCount = 2;
60 * Person.prototype.walk = function () {};
63 * Jumper.super.apply( this, arguments );
65 * OO.inheritClass( Jumper, Person );
66 * Jumper.prototype.jump = function () {};
68 * Jumper.static.defaultEyeCount === 2;
69 * var x = new Jumper();
72 * x instanceof Thing && x instanceof Person && x instanceof Jumper;
74 * @param {Function} targetFn
75 * @param {Function} originFn
76 * @throws {Error} If target already inherits from origin
78 oo
.inheritClass = function ( targetFn
, originFn
) {
79 if ( targetFn
.prototype instanceof originFn
) {
80 throw new Error( 'Target already inherits from origin' );
83 var targetConstructor
= targetFn
.prototype.constructor;
85 // Using ['super'] instead of .super because 'super' is not supported
86 // by IE 8 and below (bug 63303).
87 // Provide .parent as alias for code supporting older browsers which
88 // allows people to comply with their style guide.
89 targetFn
['super'] = targetFn
.parent
= originFn
;
91 targetFn
.prototype = Object
.create( originFn
.prototype, {
92 // Restore constructor property of targetFn
94 value
: targetConstructor
,
101 // Extend static properties - always initialize both sides
102 oo
.initClass( originFn
);
103 targetFn
.static = Object
.create( originFn
.static );
107 * Copy over *own* prototype properties of a mixin.
109 * The 'constructor' (whether implicit or explicit) is not copied over.
111 * This does not create inheritance to the origin. If inheritance is needed
112 * use oo.inheritClass instead.
114 * Beware: This can redefine a prototype property, call before setting your prototypes.
116 * Beware: Don't call before oo.inheritClass.
119 * function Context() {}
121 * // Avoid repeating this code
122 * function ContextLazyLoad() {}
123 * ContextLazyLoad.prototype.getContext = function () {
124 * if ( !this.context ) {
125 * this.context = new Context();
127 * return this.context;
130 * function FooBar() {}
131 * OO.inheritClass( FooBar, Foo );
132 * OO.mixinClass( FooBar, ContextLazyLoad );
134 * @param {Function} targetFn
135 * @param {Function} originFn
137 oo
.mixinClass = function ( targetFn
, originFn
) {
140 // Copy prototype properties
141 for ( key
in originFn
.prototype ) {
142 if ( key
!== 'constructor' && hasOwn
.call( originFn
.prototype, key
) ) {
143 targetFn
.prototype[key
] = originFn
.prototype[key
];
147 // Copy static properties - always initialize both sides
148 oo
.initClass( targetFn
);
149 if ( originFn
.static ) {
150 for ( key
in originFn
.static ) {
151 if ( hasOwn
.call( originFn
.static, key
) ) {
152 targetFn
.static[key
] = originFn
.static[key
];
156 oo
.initClass( originFn
);
163 * Get a deeply nested property of an object using variadic arguments, protecting against
164 * undefined property errors.
166 * `quux = oo.getProp( obj, 'foo', 'bar', 'baz' );` is equivalent to `quux = obj.foo.bar.baz;`
167 * except that the former protects against JS errors if one of the intermediate properties
168 * is undefined. Instead of throwing an error, this function will return undefined in
171 * @param {Object} obj
172 * @param {Mixed...} [keys]
173 * @returns obj[arguments[1]][arguments[2]].... or undefined
175 oo
.getProp = function ( obj
) {
178 for ( i
= 1; i
< arguments
.length
; i
++ ) {
179 if ( retval
=== undefined || retval
=== null ) {
180 // Trying to access a property of undefined or null causes an error
183 retval
= retval
[arguments
[i
]];
189 * Set a deeply nested property of an object using variadic arguments, protecting against
190 * undefined property errors.
192 * `oo.setProp( obj, 'foo', 'bar', 'baz' );` is equivalent to `obj.foo.bar = baz;` except that
193 * the former protects against JS errors if one of the intermediate properties is
194 * undefined. Instead of throwing an error, undefined intermediate properties will be
195 * initialized to an empty object. If an intermediate property is not an object, or if obj itself
196 * is not an object, this function will silently abort.
198 * @param {Object} obj
199 * @param {Mixed...} [keys]
200 * @param {Mixed} [value]
202 oo
.setProp = function ( obj
) {
205 if ( Object( obj
) !== obj
) {
208 for ( i
= 1; i
< arguments
.length
- 2; i
++ ) {
209 if ( prop
[arguments
[i
]] === undefined ) {
210 prop
[arguments
[i
]] = {};
212 if ( Object( prop
[arguments
[i
]] ) !== prop
[arguments
[i
]] ) {
215 prop
= prop
[arguments
[i
]];
217 prop
[arguments
[arguments
.length
- 2]] = arguments
[arguments
.length
- 1];
221 * Create a new object that is an instance of the same
222 * constructor as the input, inherits from the same object
223 * and contains the same own properties.
225 * This makes a shallow non-recursive copy of own properties.
226 * To create a recursive copy of plain objects, use #copy.
228 * var foo = new Person( mom, dad );
230 * var foo2 = OO.cloneObject( foo );
234 * foo2 !== foo; // true
235 * foo2 instanceof Person; // true
236 * foo2.getAge(); // 21
237 * foo.getAge(); // 22
239 * @param {Object} origin
240 * @return {Object} Clone of origin
242 oo
.cloneObject = function ( origin
) {
245 r
= Object
.create( origin
.constructor.prototype );
247 for ( key
in origin
) {
248 if ( hasOwn
.call( origin
, key
) ) {
249 r
[key
] = origin
[key
];
257 * Get an array of all property values in an object.
259 * @param {Object} Object to get values from
260 * @return {Array} List of object values
262 oo
.getObjectValues = function ( obj
) {
265 if ( obj
!== Object( obj
) ) {
266 throw new TypeError( 'Called on non-object' );
271 if ( hasOwn
.call( obj
, key
) ) {
272 values
[values
.length
] = obj
[key
];
280 * Recursively compare properties between two objects.
282 * A false result may be caused by property inequality or by properties in one object missing from
283 * the other. An asymmetrical test may also be performed, which checks only that properties in the
284 * first object are present in the second object, but not the inverse.
286 * If either a or b is null or undefined it will be treated as an empty object.
288 * @param {Object|undefined|null} a First object to compare
289 * @param {Object|undefined|null} b Second object to compare
290 * @param {boolean} [asymmetrical] Whether to check only that a's values are equal to b's
291 * (i.e. a is a subset of b)
292 * @return {boolean} If the objects contain the same values as each other
294 oo
.compare = function ( a
, b
, asymmetrical
) {
295 var aValue
, bValue
, aType
, bType
, k
;
305 if ( !hasOwn
.call( a
, k
) || a
[k
] === undefined ) {
306 // Support es3-shim: Without the hasOwn filter, comparing [] to {} will be false in ES3
307 // because the shimmed "forEach" is enumerable and shows up in Array but not Object.
308 // Also ignore undefined values, because there is no conceptual difference between
309 // a key that is absent and a key that is present but whose value is undefined.
315 aType
= typeof aValue
;
316 bType
= typeof bValue
;
317 if ( aType
!== bType
||
319 ( aType
=== 'string' || aType
=== 'number' || aType
=== 'boolean' ) &&
322 ( aValue
=== Object( aValue
) && !oo
.compare( aValue
, bValue
, asymmetrical
) ) ) {
326 // If the check is not asymmetrical, recursing with the arguments swapped will verify our result
327 return asymmetrical
? true : oo
.compare( b
, a
, true );
331 * Create a plain deep copy of any kind of object.
333 * Copies are deep, and will either be an object or an array depending on `source`.
335 * @param {Object} source Object to copy
336 * @param {Function} [leafCallback] Applied to leaf values after they are cloned but before they are added to the clone
337 * @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.
338 * @return {Object} Copy of source object
340 oo
.copy = function ( source
, leafCallback
, nodeCallback
) {
341 var key
, destination
;
343 if ( nodeCallback
) {
344 // Extensibility: check before attempting to clone source.
345 destination
= nodeCallback( source
);
346 if ( destination
!== undefined ) {
351 if ( Array
.isArray( source
) ) {
352 // Array (fall through)
353 destination
= new Array( source
.length
);
354 } else if ( source
&& typeof source
.clone
=== 'function' ) {
355 // Duck type object with custom clone method
356 return leafCallback
? leafCallback( source
.clone() ) : source
.clone();
357 } else if ( source
&& typeof source
.cloneNode
=== 'function' ) {
359 return leafCallback
?
360 leafCallback( source
.cloneNode( true ) ) :
361 source
.cloneNode( true );
362 } else if ( oo
.isPlainObject( source
) ) {
363 // Plain objects (fall through)
366 // Non-plain objects (incl. functions) and primitive values
367 return leafCallback
? leafCallback( source
) : source
;
370 // source is an array or a plain object
371 for ( key
in source
) {
372 destination
[key
] = oo
.copy( source
[key
], leafCallback
, nodeCallback
);
375 // This is an internal node, so we don't apply the leafCallback.
380 * Generate a hash of an object based on its name and data.
382 * Performance optimization: <http://jsperf.com/ve-gethash-201208#/toJson_fnReplacerIfAoForElse>
384 * To avoid two objects with the same values generating different hashes, we utilize the replacer
385 * argument of JSON.stringify and sort the object by key as it's being serialized. This may or may
386 * not be the fastest way to do this; we should investigate this further.
388 * Objects and arrays are hashed recursively. When hashing an object that has a .getHash()
389 * function, we call that function and use its return value rather than hashing the object
390 * ourselves. This allows classes to define custom hashing.
392 * @param {Object} val Object to generate hash for
393 * @return {string} Hash of object
395 oo
.getHash = function ( val
) {
396 return JSON
.stringify( val
, oo
.getHash
.keySortReplacer
);
400 * Sort objects by key (helper function for OO.getHash).
402 * This is a callback passed into JSON.stringify.
404 * @method getHash_keySortReplacer
405 * @param {string} key Property name of value being replaced
406 * @param {Mixed} val Property value to replace
407 * @return {Mixed} Replacement value
409 oo
.getHash
.keySortReplacer = function ( key
, val
) {
410 var normalized
, keys
, i
, len
;
411 if ( val
&& typeof val
.getHashObject
=== 'function' ) {
412 // This object has its own custom hash function, use it
413 val
= val
.getHashObject();
415 if ( !Array
.isArray( val
) && Object( val
) === val
) {
416 // Only normalize objects when the key-order is ambiguous
417 // (e.g. any object not an array).
419 keys
= Object
.keys( val
).sort();
422 for ( ; i
< len
; i
+= 1 ) {
423 normalized
[keys
[i
]] = val
[keys
[i
]];
427 // Primitive values and arrays get stable hashes
428 // by default. Lets those be stringified as-is.
435 * Compute the union (duplicate-free merge) of a set of arrays.
437 * Arrays values must be convertable to object keys (strings).
439 * By building an object (with the values for keys) in parallel with
440 * the array, a new item's existence in the union can be computed faster.
442 * @param {Array...} arrays Arrays to union
443 * @return {Array} Union of the arrays
445 oo
.simpleArrayUnion = function () {
446 var i
, ilen
, arr
, j
, jlen
,
450 for ( i
= 0, ilen
= arguments
.length
; i
< ilen
; i
++ ) {
452 for ( j
= 0, jlen
= arr
.length
; j
< jlen
; j
++ ) {
453 if ( !obj
[ arr
[j
] ] ) {
454 obj
[ arr
[j
] ] = true;
455 result
.push( arr
[j
] );
464 * Combine arrays (intersection or difference).
466 * An intersection checks the item exists in 'b' while difference checks it doesn't.
468 * Arrays values must be convertable to object keys (strings).
470 * By building an object (with the values for keys) of 'b' we can
471 * compute the result faster.
474 * @param {Array} a First array
475 * @param {Array} b Second array
476 * @param {boolean} includeB Whether to items in 'b'
477 * @return {Array} Combination (intersection or difference) of arrays
479 function simpleArrayCombine( a
, b
, includeB
) {
484 for ( i
= 0, ilen
= b
.length
; i
< ilen
; i
++ ) {
488 for ( i
= 0, ilen
= a
.length
; i
< ilen
; i
++ ) {
489 isInB
= !!bObj
[ a
[i
] ];
490 if ( isInB
=== includeB
) {
499 * Compute the intersection of two arrays (items in both arrays).
501 * Arrays values must be convertable to object keys (strings).
503 * @param {Array} a First array
504 * @param {Array} b Second array
505 * @return {Array} Intersection of arrays
507 oo
.simpleArrayIntersection = function ( a
, b
) {
508 return simpleArrayCombine( a
, b
, true );
512 * Compute the difference of two arrays (items in 'a' but not 'b').
514 * Arrays values must be convertable to object keys (strings).
516 * @param {Array} a First array
517 * @param {Array} b Second array
518 * @return {Array} Intersection of arrays
520 oo
.simpleArrayDifference = function ( a
, b
) {
521 return simpleArrayCombine( a
, b
, false );
526 oo
.isPlainObject
= $.isPlainObject
;
533 * @class OO.EventEmitter
537 oo
.EventEmitter
= function OoEventEmitter() {
541 * Storage of bound event handlers by event name.
548 oo
.initClass( oo
.EventEmitter
);
550 /* Private helper functions */
553 * Validate a function or method call in a context
555 * For a method name, check that it names a function in the context object
558 * @param {Function|string} method Function or method name
559 * @param {Mixed} context The context of the call
560 * @throws {Error} A method name is given but there is no context
561 * @throws {Error} In the context object, no property exists with the given name
562 * @throws {Error} In the context object, the named property is not a function
564 function validateMethod( method
, context
) {
565 // Validate method and context
566 if ( typeof method
=== 'string' ) {
568 if ( context
=== undefined || context
=== null ) {
569 throw new Error( 'Method name "' + method
+ '" has no context.' );
571 if ( typeof context
[method
] !== 'function' ) {
572 // Technically the property could be replaced by a function before
573 // call time. But this probably signals a typo.
574 throw new Error( 'Property "' + method
+ '" is not a function' );
576 } else if ( typeof method
!== 'function' ) {
577 throw new Error( 'Invalid callback. Function or method name expected.' );
584 * Add a listener to events of a specific event.
586 * The listener can be a function or the string name of a method; if the latter, then the
587 * name lookup happens at the time the listener is called.
589 * @param {string} event Type of event to listen to
590 * @param {Function|string} method Function or method name to call when event occurs
591 * @param {Array} [args] Arguments to pass to listener, will be prepended to emitted arguments
592 * @param {Object} [context=null] Context object for function or method call
593 * @throws {Error} Listener argument is not a function or a valid method name
596 oo
.EventEmitter
.prototype.on = function ( event
, method
, args
, context
) {
599 validateMethod( method
, context
);
601 if ( hasOwn
.call( this.bindings
, event
) ) {
602 bindings
= this.bindings
[event
];
604 // Auto-initialize bindings list
605 bindings
= this.bindings
[event
] = [];
611 context
: ( arguments
.length
< 4 ) ? null : context
617 * Add a one-time listener to a specific event.
619 * @param {string} event Type of event to listen to
620 * @param {Function} listener Listener to call when event occurs
623 oo
.EventEmitter
.prototype.once = function ( event
, listener
) {
624 var eventEmitter
= this,
625 listenerWrapper = function () {
626 eventEmitter
.off( event
, listenerWrapper
);
627 listener
.apply( eventEmitter
, Array
.prototype.slice
.call( arguments
, 0 ) );
629 return this.on( event
, listenerWrapper
);
633 * Remove a specific listener from a specific event.
635 * @param {string} event Type of event to remove listener from
636 * @param {Function|string} [method] Listener to remove. Must be in the same form as was passed
637 * to "on". Omit to remove all listeners.
638 * @param {Object} [context=null] Context object function or method call
640 * @throws {Error} Listener argument is not a function or a valid method name
642 oo
.EventEmitter
.prototype.off = function ( event
, method
, context
) {
645 if ( arguments
.length
=== 1 ) {
646 // Remove all bindings for event
647 delete this.bindings
[event
];
651 validateMethod( method
, context
);
653 if ( !hasOwn
.call( this.bindings
, event
) || !this.bindings
[event
].length
) {
654 // No matching bindings
658 // Default to null context
659 if ( arguments
.length
< 3 ) {
663 // Remove matching handlers
664 bindings
= this.bindings
[event
];
667 if ( bindings
[i
].method
=== method
&& bindings
[i
].context
=== context
) {
668 bindings
.splice( i
, 1 );
672 // Cleanup if now empty
673 if ( bindings
.length
=== 0 ) {
674 delete this.bindings
[event
];
682 * TODO: Should this be chainable? What is the usefulness of the boolean
685 * @param {string} event Type of event
686 * @param {Mixed} args First in a list of variadic arguments passed to event handler (optional)
687 * @return {boolean} If event was handled by at least one listener
689 oo
.EventEmitter
.prototype.emit = function ( event
) {
690 var i
, len
, binding
, bindings
, args
, method
;
692 if ( hasOwn
.call( this.bindings
, event
) ) {
693 // Slicing ensures that we don't get tripped up by event handlers that add/remove bindings
694 bindings
= this.bindings
[event
].slice();
695 args
= Array
.prototype.slice
.call( arguments
, 1 );
696 for ( i
= 0, len
= bindings
.length
; i
< len
; i
++ ) {
697 binding
= bindings
[i
];
698 if ( typeof binding
.method
=== 'string' ) {
699 // Lookup method by name (late binding)
700 method
= binding
.context
[ binding
.method
];
702 method
= binding
.method
;
706 binding
.args
? binding
.args
.concat( args
) : args
715 * Connect event handlers to an object.
717 * @param {Object} context Object to call methods on when events occur
718 * @param {Object.<string,string>|Object.<string,Function>|Object.<string,Array>} methods List of
719 * event bindings keyed by event name containing either method names, functions or arrays containing
720 * method name or function followed by a list of arguments to be passed to callback before emitted
724 oo
.EventEmitter
.prototype.connect = function ( context
, methods
) {
725 var method
, args
, event
;
727 for ( event
in methods
) {
728 method
= methods
[event
];
729 // Allow providing additional args
730 if ( Array
.isArray( method
) ) {
731 args
= method
.slice( 1 );
737 this.on( event
, method
, args
, context
);
743 * Disconnect event handlers from an object.
745 * @param {Object} context Object to disconnect methods from
746 * @param {Object.<string,string>|Object.<string,Function>|Object.<string,Array>} [methods] List of
747 * event bindings keyed by event name. Values can be either method names or functions, but must be
748 * consistent with those used in the corresponding call to "connect".
751 oo
.EventEmitter
.prototype.disconnect = function ( context
, methods
) {
752 var i
, event
, bindings
;
755 // Remove specific connections to the context
756 for ( event
in methods
) {
757 this.off( event
, methods
[event
], context
);
760 // Remove all connections to the context
761 for ( event
in this.bindings
) {
762 bindings
= this.bindings
[event
];
765 // bindings[i] may have been removed by the previous step's
766 // this.off so check it still exists
767 if ( bindings
[i
] && bindings
[i
].context
=== context
) {
768 this.off( event
, bindings
[i
].method
, context
);
783 * @mixins OO.EventEmitter
787 oo
.Registry
= function OoRegistry() {
788 // Mixin constructors
789 oo
.EventEmitter
.call( this );
797 oo
.mixinClass( oo
.Registry
, oo
.EventEmitter
);
803 * @param {string} name
804 * @param {Mixed} data
810 * Associate one or more symbolic names with some data.
812 * Only the base name will be registered, overriding any existing entry with the same base name.
814 * @param {string|string[]} name Symbolic name or list of symbolic names
815 * @param {Mixed} data Data to associate with symbolic name
817 * @throws {Error} Name argument must be a string or array
819 oo
.Registry
.prototype.register = function ( name
, data
) {
821 if ( typeof name
=== 'string' ) {
822 this.registry
[name
] = data
;
823 this.emit( 'register', name
, data
);
824 } else if ( Array
.isArray( name
) ) {
825 for ( i
= 0, len
= name
.length
; i
< len
; i
++ ) {
826 this.register( name
[i
], data
);
829 throw new Error( 'Name must be a string or array, cannot be a ' + typeof name
);
834 * Get data for a given symbolic name.
836 * Lookups are done using the base name.
838 * @param {string} name Symbolic name
839 * @return {Mixed|undefined} Data associated with symbolic name
841 oo
.Registry
.prototype.lookup = function ( name
) {
842 if ( hasOwn
.call( this.registry
, name
) ) {
843 return this.registry
[name
];
849 * @extends OO.Registry
853 oo
.Factory
= function OoFactory() {
854 oo
.Factory
.parent
.call( this );
862 oo
.inheritClass( oo
.Factory
, oo
.Registry
);
867 * Register a constructor with the factory.
869 * Classes must have a static `name` property to be registered.
871 * function MyClass() {};
872 * OO.initClass( MyClass );
873 * // Adds a static property to the class defining a symbolic name
874 * MyClass.static.name = 'mine';
875 * // Registers class with factory, available via symbolic name 'mine'
876 * factory.register( MyClass );
878 * @param {Function} constructor Constructor to use when creating object
879 * @throws {Error} Name must be a string and must not be empty
880 * @throws {Error} Constructor must be a function
882 oo
.Factory
.prototype.register = function ( constructor ) {
885 if ( typeof constructor !== 'function' ) {
886 throw new Error( 'constructor must be a function, cannot be a ' + typeof constructor );
888 name
= constructor.static && constructor.static.name
;
889 if ( typeof name
!== 'string' || name
=== '' ) {
890 throw new Error( 'Name must be a string and must not be empty' );
892 this.entries
.push( name
);
894 oo
.Factory
.parent
.prototype.register
.call( this, name
, constructor );
898 * Create an object based on a name.
900 * Name is used to look up the constructor to use, while all additional arguments are passed to the
901 * constructor directly, so leaving one out will pass an undefined to the constructor.
903 * @param {string} name Object name
904 * @param {Mixed...} [args] Arguments to pass to the constructor
905 * @return {Object} The new object
906 * @throws {Error} Unknown object name
908 oo
.Factory
.prototype.create = function ( name
) {
910 constructor = this.lookup( name
);
912 if ( !constructor ) {
913 throw new Error( 'No class registered by that name: ' + name
);
916 // Convert arguments to array and shift the first argument (name) off
917 args
= Array
.prototype.slice
.call( arguments
, 1 );
919 // We can't use the "new" operator with .apply directly because apply needs a
920 // context. So instead just do what "new" does: create an object that inherits from
921 // the constructor's prototype (which also makes it an "instanceof" the constructor),
922 // then invoke the constructor with the object as context, and return it (ignoring
923 // the constructor's return value).
924 obj
= Object
.create( constructor.prototype );
925 constructor.apply( obj
, args
);
929 /*jshint node:true */
930 if ( typeof module
!== 'undefined' && module
.exports
) {