| blob | 6e7851a50700f17e883c754b02feec2816b8d495 |
1 /*!
2 * OOjs v1.1.8 optimised for jQuery
3 * https://www.mediawiki.org/wiki/OOjs
4 *
5 * Copyright 2011-2015 OOjs Team and other contributors.
6 * Released under the MIT license
7 * http://oojs.mit-license.org
8 *
9 * Date: 2015-07-23T19:16:00Z
10 */
11 ( function ( global ) {
13 'use strict';
15 /*exported toString */
16 var
17 /**
18 * Namespace for all classes, static methods and static properties.
19 * @class OO
20 * @singleton
21 */
22 oo = {},
23 // Optimisation: Local reference to Object.prototype.hasOwnProperty
24 hasOwn = oo.hasOwnProperty,
25 toString = oo.toString;
27 /* Class Methods */
29 /**
30 * Utility to initialize a class for OO inheritance.
31 *
32 * Currently this just initializes an empty static object.
33 *
34 * @param {Function} fn
35 */
36 oo.initClass = function ( fn ) {
37 fn.static = fn.static || {};
38 };
40 /**
41 * Inherit from prototype to another using Object#create.
42 *
43 * Beware: This redefines the prototype, call before setting your prototypes.
44 *
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).
51 *
52 * function Thing() {}
53 * Thing.prototype.exists = function () {};
54 *
55 * function Person() {
56 * Person.super.apply( this, arguments );
57 * }
58 * OO.inheritClass( Person, Thing );
59 * Person.static.defaultEyeCount = 2;
60 * Person.prototype.walk = function () {};
61 *
62 * function Jumper() {
63 * Jumper.super.apply( this, arguments );
64 * }
65 * OO.inheritClass( Jumper, Person );
66 * Jumper.prototype.jump = function () {};
67 *
68 * Jumper.static.defaultEyeCount === 2;
69 * var x = new Jumper();
70 * x.jump();
71 * x.walk();
72 * x instanceof Thing && x instanceof Person && x instanceof Jumper;
73 *
74 * @param {Function} targetFn
75 * @param {Function} originFn
76 * @throws {Error} If target already inherits from origin
77 */
78 oo.inheritClass = function ( targetFn, originFn ) {
79 if ( targetFn.prototype instanceof originFn ) {
80 throw new Error( 'Target already inherits from origin' );
81 }
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
93 constructor: {
94 value: targetConstructor,
95 enumerable: false,
96 writable: true,
97 configurable: true
98 }
99 } );
101 // Extend static properties - always initialize both sides
102 oo.initClass( originFn );
103 targetFn.static = Object.create( originFn.static );
104 };
106 /**
107 * Copy over *own* prototype properties of a mixin.
108 *
109 * The 'constructor' (whether implicit or explicit) is not copied over.
110 *
111 * This does not create inheritance to the origin. If you need inheritance,
112 * use OO.inheritClass instead.
113 *
114 * Beware: This can redefine a prototype property, call before setting your prototypes.
115 *
116 * Beware: Don't call before OO.inheritClass.
117 *
118 * function Foo() {}
119 * function Context() {}
120 *
121 * // Avoid repeating this code
122 * function ContextLazyLoad() {}
123 * ContextLazyLoad.prototype.getContext = function () {
124 * if ( !this.context ) {
125 * this.context = new Context();
126 * }
127 * return this.context;
128 * };
129 *
130 * function FooBar() {}
131 * OO.inheritClass( FooBar, Foo );
132 * OO.mixinClass( FooBar, ContextLazyLoad );
133 *
134 * @param {Function} targetFn
135 * @param {Function} originFn
136 */
137 oo.mixinClass = function ( targetFn, originFn ) {
138 var key;
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];
144 }
145 }
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];
153 }
154 }
155 } else {
156 oo.initClass( originFn );
157 }
158 };
160 /* Object Methods */
162 /**
163 * Get a deeply nested property of an object using variadic arguments, protecting against
164 * undefined property errors.
165 *
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
169 * that case.
170 *
171 * @param {Object} obj
172 * @param {Mixed...} [keys]
173 * @return obj[arguments[1]][arguments[2]].... or undefined
174 */
175 oo.getProp = function ( obj ) {
176 var i,
177 retval = 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
181 return undefined;
182 }
183 retval = retval[arguments[i]];
184 }
185 return retval;
186 };
188 /**
189 * Set a deeply nested property of an object using variadic arguments, protecting against
190 * undefined property errors.
191 *
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.
197 *
198 * @param {Object} obj
199 * @param {Mixed...} [keys]
200 * @param {Mixed} [value]
201 */
202 oo.setProp = function ( obj ) {
203 var i,
204 prop = obj;
205 if ( Object( obj ) !== obj ) {
206 return;
207 }
208 for ( i = 1; i < arguments.length - 2; i++ ) {
209 if ( prop[arguments[i]] === undefined ) {
210 prop[arguments[i]] = {};
211 }
212 if ( Object( prop[arguments[i]] ) !== prop[arguments[i]] ) {
213 return;
214 }
215 prop = prop[arguments[i]];
216 }
217 prop[arguments[arguments.length - 2]] = arguments[arguments.length - 1];
218 };
220 /**
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.
224 *
225 * This makes a shallow non-recursive copy of own properties.
226 * To create a recursive copy of plain objects, use #copy.
227 *
228 * var foo = new Person( mom, dad );
229 * foo.setAge( 21 );
230 * var foo2 = OO.cloneObject( foo );
231 * foo.setAge( 22 );
232 *
233 * // Then
234 * foo2 !== foo; // true
235 * foo2 instanceof Person; // true
236 * foo2.getAge(); // 21
237 * foo.getAge(); // 22
238 *
239 * @param {Object} origin
240 * @return {Object} Clone of origin
241 */
242 oo.cloneObject = function ( origin ) {
243 var key, r;
245 r = Object.create( origin.constructor.prototype );
247 for ( key in origin ) {
248 if ( hasOwn.call( origin, key ) ) {
249 r[key] = origin[key];
250 }
251 }
253 return r;
254 };
256 /**
257 * Get an array of all property values in an object.
258 *
259 * @param {Object} Object to get values from
260 * @return {Array} List of object values
261 */
262 oo.getObjectValues = function ( obj ) {
263 var key, values;
265 if ( obj !== Object( obj ) ) {
266 throw new TypeError( 'Called on non-object' );
267 }
269 values = [];
270 for ( key in obj ) {
271 if ( hasOwn.call( obj, key ) ) {
272 values[values.length] = obj[key];
273 }
274 }
276 return values;
277 };
279 /**
280 * Recursively compare properties between two objects.
281 *
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.
285 *
286 * If either a or b is null or undefined it will be treated as an empty object.
287 *
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
293 */
294 oo.compare = function ( a, b, asymmetrical ) {
295 var aValue, bValue, aType, bType, k;
297 if ( a === b ) {
298 return true;
299 }
301 a = a || {};
302 b = b || {};
304 if ( typeof a.nodeType === 'number' && typeof a.isEqualNode === 'function' ) {
305 return a.isEqualNode( b );
306 }
308 for ( k in a ) {
309 if ( !hasOwn.call( a, k ) || a[k] === undefined || a[k] === b[k] ) {
310 // Support es3-shim: Without the hasOwn filter, comparing [] to {} will be false in ES3
311 // because the shimmed "forEach" is enumerable and shows up in Array but not Object.
312 // Also ignore undefined values, because there is no conceptual difference between
313 // a key that is absent and a key that is present but whose value is undefined.
314 continue;
315 }
317 aValue = a[k];
318 bValue = b[k];
319 aType = typeof aValue;
320 bType = typeof bValue;
321 if ( aType !== bType ||
322 (
323 ( aType === 'string' || aType === 'number' || aType === 'boolean' ) &&
324 aValue !== bValue
325 ) ||
326 ( aValue === Object( aValue ) && !oo.compare( aValue, bValue, true ) ) ) {
327 return false;
328 }
329 }
330 // If the check is not asymmetrical, recursing with the arguments swapped will verify our result
331 return asymmetrical ? true : oo.compare( b, a, true );
332 };
334 /**
335 * Create a plain deep copy of any kind of object.
336 *
337 * Copies are deep, and will either be an object or an array depending on `source`.
338 *
339 * @param {Object} source Object to copy
340 * @param {Function} [leafCallback] Applied to leaf values after they are cloned but before they are added to the clone
341 * @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.
342 * @return {Object} Copy of source object
343 */
344 oo.copy = function ( source, leafCallback, nodeCallback ) {
345 var key, destination;
347 if ( nodeCallback ) {
348 // Extensibility: check before attempting to clone source.
349 destination = nodeCallback( source );
350 if ( destination !== undefined ) {
351 return destination;
352 }
353 }
355 if ( Array.isArray( source ) ) {
356 // Array (fall through)
357 destination = new Array( source.length );
358 } else if ( source && typeof source.clone === 'function' ) {
359 // Duck type object with custom clone method
360 return leafCallback ? leafCallback( source.clone() ) : source.clone();
361 } else if ( source && typeof source.cloneNode === 'function' ) {
362 // DOM Node
363 return leafCallback ?
364 leafCallback( source.cloneNode( true ) ) :
365 source.cloneNode( true );
366 } else if ( oo.isPlainObject( source ) ) {
367 // Plain objects (fall through)
368 destination = {};
369 } else {
370 // Non-plain objects (incl. functions) and primitive values
371 return leafCallback ? leafCallback( source ) : source;
372 }
374 // source is an array or a plain object
375 for ( key in source ) {
376 destination[key] = oo.copy( source[key], leafCallback, nodeCallback );
377 }
379 // This is an internal node, so we don't apply the leafCallback.
380 return destination;
381 };
383 /**
384 * Generate a hash of an object based on its name and data.
385 *
386 * Performance optimization: <http://jsperf.com/ve-gethash-201208#/toJson_fnReplacerIfAoForElse>
387 *
388 * To avoid two objects with the same values generating different hashes, we utilize the replacer
389 * argument of JSON.stringify and sort the object by key as it's being serialized. This may or may
390 * not be the fastest way to do this; we should investigate this further.
391 *
392 * Objects and arrays are hashed recursively. When hashing an object that has a .getHash()
393 * function, we call that function and use its return value rather than hashing the object
394 * ourselves. This allows classes to define custom hashing.
395 *
396 * @param {Object} val Object to generate hash for
397 * @return {string} Hash of object
398 */
399 oo.getHash = function ( val ) {
400 return JSON.stringify( val, oo.getHash.keySortReplacer );
401 };
403 /**
404 * Sort objects by key (helper function for OO.getHash).
405 *
406 * This is a callback passed into JSON.stringify.
407 *
408 * @method getHash_keySortReplacer
409 * @param {string} key Property name of value being replaced
410 * @param {Mixed} val Property value to replace
411 * @return {Mixed} Replacement value
412 */
413 oo.getHash.keySortReplacer = function ( key, val ) {
414 var normalized, keys, i, len;
415 if ( val && typeof val.getHashObject === 'function' ) {
416 // This object has its own custom hash function, use it
417 val = val.getHashObject();
418 }
419 if ( !Array.isArray( val ) && Object( val ) === val ) {
420 // Only normalize objects when the key-order is ambiguous
421 // (e.g. any object not an array).
422 normalized = {};
423 keys = Object.keys( val ).sort();
424 i = 0;
425 len = keys.length;
426 for ( ; i < len; i += 1 ) {
427 normalized[keys[i]] = val[keys[i]];
428 }
429 return normalized;
431 // Primitive values and arrays get stable hashes
432 // by default. Lets those be stringified as-is.
433 } else {
434 return val;
435 }
436 };
438 /**
439 * Get the unique values of an array, removing duplicates
440 *
441 * @param {Array} arr Array
442 * @return {Array} Unique values in array
443 */
444 oo.unique = function ( arr ) {
445 return arr.reduce( function ( result, current ) {
446 if ( result.indexOf( current ) === -1 ) {
447 result.push( current );
448 }
449 return result;
450 }, [] );
451 };
453 /**
454 * Compute the union (duplicate-free merge) of a set of arrays.
455 *
456 * Arrays values must be convertable to object keys (strings).
457 *
458 * By building an object (with the values for keys) in parallel with
459 * the array, a new item's existence in the union can be computed faster.
460 *
461 * @param {Array...} arrays Arrays to union
462 * @return {Array} Union of the arrays
463 */
464 oo.simpleArrayUnion = function () {
465 var i, ilen, arr, j, jlen,
466 obj = {},
467 result = [];
469 for ( i = 0, ilen = arguments.length; i < ilen; i++ ) {
470 arr = arguments[i];
471 for ( j = 0, jlen = arr.length; j < jlen; j++ ) {
472 if ( !obj[ arr[j] ] ) {
473 obj[ arr[j] ] = true;
474 result.push( arr[j] );
475 }
476 }
477 }
479 return result;
480 };
482 /**
483 * Combine arrays (intersection or difference).
484 *
485 * An intersection checks the item exists in 'b' while difference checks it doesn't.
486 *
487 * Arrays values must be convertable to object keys (strings).
488 *
489 * By building an object (with the values for keys) of 'b' we can
490 * compute the result faster.
491 *
492 * @private
493 * @param {Array} a First array
494 * @param {Array} b Second array
495 * @param {boolean} includeB Whether to items in 'b'
496 * @return {Array} Combination (intersection or difference) of arrays
497 */
498 function simpleArrayCombine( a, b, includeB ) {
499 var i, ilen, isInB,
500 bObj = {},
501 result = [];
503 for ( i = 0, ilen = b.length; i < ilen; i++ ) {
504 bObj[ b[i] ] = true;
505 }
507 for ( i = 0, ilen = a.length; i < ilen; i++ ) {
508 isInB = !!bObj[ a[i] ];
509 if ( isInB === includeB ) {
510 result.push( a[i] );
511 }
512 }
514 return result;
515 }
517 /**
518 * Compute the intersection of two arrays (items in both arrays).
519 *
520 * Arrays values must be convertable to object keys (strings).
521 *
522 * @param {Array} a First array
523 * @param {Array} b Second array
524 * @return {Array} Intersection of arrays
525 */
526 oo.simpleArrayIntersection = function ( a, b ) {
527 return simpleArrayCombine( a, b, true );
528 };
530 /**
531 * Compute the difference of two arrays (items in 'a' but not 'b').
532 *
533 * Arrays values must be convertable to object keys (strings).
534 *
535 * @param {Array} a First array
536 * @param {Array} b Second array
537 * @return {Array} Intersection of arrays
538 */
539 oo.simpleArrayDifference = function ( a, b ) {
540 return simpleArrayCombine( a, b, false );
541 };
543 /*global $ */
545 oo.isPlainObject = $.isPlainObject;
547 /*global hasOwn */
549 ( function () {
551 /**
552 * @class OO.EventEmitter
553 *
554 * @constructor
555 */
556 oo.EventEmitter = function OoEventEmitter() {
557 // Properties
559 /**
560 * Storage of bound event handlers by event name.
561 *
562 * @property
563 */
564 this.bindings = {};
565 };
567 oo.initClass( oo.EventEmitter );
569 /* Private helper functions */
571 /**
572 * Validate a function or method call in a context
573 *
574 * For a method name, check that it names a function in the context object
575 *
576 * @private
577 * @param {Function|string} method Function or method name
578 * @param {Mixed} context The context of the call
579 * @throws {Error} A method name is given but there is no context
580 * @throws {Error} In the context object, no property exists with the given name
581 * @throws {Error} In the context object, the named property is not a function
582 */
583 function validateMethod( method, context ) {
584 // Validate method and context
585 if ( typeof method === 'string' ) {
586 // Validate method
587 if ( context === undefined || context === null ) {
588 throw new Error( 'Method name "' + method + '" has no context.' );
589 }
590 if ( typeof context[method] !== 'function' ) {
591 // Technically the property could be replaced by a function before
592 // call time. But this probably signals a typo.
593 throw new Error( 'Property "' + method + '" is not a function' );
594 }
595 } else if ( typeof method !== 'function' ) {
596 throw new Error( 'Invalid callback. Function or method name expected.' );
597 }
598 }
600 /* Methods */
602 /**
603 * Add a listener to events of a specific event.
604 *
605 * The listener can be a function or the string name of a method; if the latter, then the
606 * name lookup happens at the time the listener is called.
607 *
608 * @param {string} event Type of event to listen to
609 * @param {Function|string} method Function or method name to call when event occurs
610 * @param {Array} [args] Arguments to pass to listener, will be prepended to emitted arguments
611 * @param {Object} [context=null] Context object for function or method call
612 * @throws {Error} Listener argument is not a function or a valid method name
613 * @chainable
614 */
615 oo.EventEmitter.prototype.on = function ( event, method, args, context ) {
616 var bindings;
618 validateMethod( method, context );
620 if ( hasOwn.call( this.bindings, event ) ) {
621 bindings = this.bindings[event];
622 } else {
623 // Auto-initialize bindings list
624 bindings = this.bindings[event] = [];
625 }
626 // Add binding
627 bindings.push( {
628 method: method,
629 args: args,
630 context: ( arguments.length < 4 ) ? null : context
631 } );
632 return this;
633 };
635 /**
636 * Add a one-time listener to a specific event.
637 *
638 * @param {string} event Type of event to listen to
639 * @param {Function} listener Listener to call when event occurs
640 * @chainable
641 */
642 oo.EventEmitter.prototype.once = function ( event, listener ) {
643 var eventEmitter = this,
644 wrapper = function () {
645 eventEmitter.off( event, wrapper );
646 return listener.apply( this, arguments );
647 };
648 return this.on( event, wrapper );
649 };
651 /**
652 * Remove a specific listener from a specific event.
653 *
654 * @param {string} event Type of event to remove listener from
655 * @param {Function|string} [method] Listener to remove. Must be in the same form as was passed
656 * to "on". Omit to remove all listeners.
657 * @param {Object} [context=null] Context object function or method call
658 * @chainable
659 * @throws {Error} Listener argument is not a function or a valid method name
660 */
661 oo.EventEmitter.prototype.off = function ( event, method, context ) {
662 var i, bindings;
664 if ( arguments.length === 1 ) {
665 // Remove all bindings for event
666 delete this.bindings[event];
667 return this;
668 }
670 validateMethod( method, context );
672 if ( !hasOwn.call( this.bindings, event ) || !this.bindings[event].length ) {
673 // No matching bindings
674 return this;
675 }
677 // Default to null context
678 if ( arguments.length < 3 ) {
679 context = null;
680 }
682 // Remove matching handlers
683 bindings = this.bindings[event];
684 i = bindings.length;
685 while ( i-- ) {
686 if ( bindings[i].method === method && bindings[i].context === context ) {
687 bindings.splice( i, 1 );
688 }
689 }
691 // Cleanup if now empty
692 if ( bindings.length === 0 ) {
693 delete this.bindings[event];
694 }
695 return this;
696 };
698 /**
699 * Emit an event.
700 *
701 * @param {string} event Type of event
702 * @param {Mixed} args First in a list of variadic arguments passed to event handler (optional)
703 * @return {boolean} Whether the event was handled by at least one listener
704 */
705 oo.EventEmitter.prototype.emit = function ( event ) {
706 var args = [],
707 i, len, binding, bindings, method;
709 if ( hasOwn.call( this.bindings, event ) ) {
710 // Slicing ensures that we don't get tripped up by event handlers that add/remove bindings
711 bindings = this.bindings[event].slice();
712 for ( i = 1, len = arguments.length; i < len; i++ ) {
713 args.push( arguments[i] );
714 }
715 for ( i = 0, len = bindings.length; i < len; i++ ) {
716 binding = bindings[i];
717 if ( typeof binding.method === 'string' ) {
718 // Lookup method by name (late binding)
719 method = binding.context[ binding.method ];
720 } else {
721 method = binding.method;
722 }
723 method.apply(
724 binding.context,
725 binding.args ? binding.args.concat( args ) : args
726 );
727 }
728 return true;
729 }
730 return false;
731 };
733 /**
734 * Connect event handlers to an object.
735 *
736 * @param {Object} context Object to call methods on when events occur
737 * @param {Object.<string,string>|Object.<string,Function>|Object.<string,Array>} methods List of
738 * event bindings keyed by event name containing either method names, functions or arrays containing
739 * method name or function followed by a list of arguments to be passed to callback before emitted
740 * arguments
741 * @chainable
742 */
743 oo.EventEmitter.prototype.connect = function ( context, methods ) {
744 var method, args, event;
746 for ( event in methods ) {
747 method = methods[event];
748 // Allow providing additional args
749 if ( Array.isArray( method ) ) {
750 args = method.slice( 1 );
751 method = method[0];
752 } else {
753 args = [];
754 }
755 // Add binding
756 this.on( event, method, args, context );
757 }
758 return this;
759 };
761 /**
762 * Disconnect event handlers from an object.
763 *
764 * @param {Object} context Object to disconnect methods from
765 * @param {Object.<string,string>|Object.<string,Function>|Object.<string,Array>} [methods] List of
766 * event bindings keyed by event name. Values can be either method names or functions, but must be
767 * consistent with those used in the corresponding call to "connect".
768 * @chainable
769 */
770 oo.EventEmitter.prototype.disconnect = function ( context, methods ) {
771 var i, event, bindings;
773 if ( methods ) {
774 // Remove specific connections to the context
775 for ( event in methods ) {
776 this.off( event, methods[event], context );
777 }
778 } else {
779 // Remove all connections to the context
780 for ( event in this.bindings ) {
781 bindings = this.bindings[event];
782 i = bindings.length;
783 while ( i-- ) {
784 // bindings[i] may have been removed by the previous step's
785 // this.off so check it still exists
786 if ( bindings[i] && bindings[i].context === context ) {
787 this.off( event, bindings[i].method, context );
788 }
789 }
790 }
791 }
793 return this;
794 };
796 }() );
798 /*global hasOwn */
800 /**
801 * @class OO.Registry
802 * @mixins OO.EventEmitter
803 *
804 * @constructor
805 */
806 oo.Registry = function OoRegistry() {
807 // Mixin constructors
808 oo.EventEmitter.call( this );
810 // Properties
811 this.registry = {};
812 };
814 /* Inheritance */
816 oo.mixinClass( oo.Registry, oo.EventEmitter );
818 /* Events */
820 /**
821 * @event register
822 * @param {string} name
823 * @param {Mixed} data
824 */
826 /**
827 * @event unregister
828 * @param {string} name
829 * @param {Mixed} data Data removed from registry
830 */
832 /* Methods */
834 /**
835 * Associate one or more symbolic names with some data.
836 *
837 * Any existing entry with the same name will be overridden.
838 *
839 * @param {string|string[]} name Symbolic name or list of symbolic names
840 * @param {Mixed} data Data to associate with symbolic name
841 * @fires register
842 * @throws {Error} Name argument must be a string or array
843 */
844 oo.Registry.prototype.register = function ( name, data ) {
845 var i, len;
846 if ( typeof name === 'string' ) {
847 this.registry[name] = data;
848 this.emit( 'register', name, data );
849 } else if ( Array.isArray( name ) ) {
850 for ( i = 0, len = name.length; i < len; i++ ) {
851 this.register( name[i], data );
852 }
853 } else {
854 throw new Error( 'Name must be a string or array, cannot be a ' + typeof name );
855 }
856 };
858 /**
859 * Remove one or more symbolic names from the registry
860 *
861 * @param {string|string[]} name Symbolic name or list of symbolic names
862 * @fires unregister
863 * @throws {Error} Name argument must be a string or array
864 */
865 oo.Registry.prototype.unregister = function ( name ) {
866 var i, len, data;
867 if ( typeof name === 'string' ) {
868 data = this.lookup( name );
869 if ( data !== undefined ) {
870 delete this.registry[name];
871 this.emit( 'unregister', name, data );
872 }
873 } else if ( Array.isArray( name ) ) {
874 for ( i = 0, len = name.length; i < len; i++ ) {
875 this.unregister( name[i] );
876 }
877 } else {
878 throw new Error( 'Name must be a string or array, cannot be a ' + typeof name );
879 }
880 };
882 /**
883 * Get data for a given symbolic name.
884 *
885 * @param {string} name Symbolic name
886 * @return {Mixed|undefined} Data associated with symbolic name
887 */
888 oo.Registry.prototype.lookup = function ( name ) {
889 if ( hasOwn.call( this.registry, name ) ) {
890 return this.registry[name];
891 }
892 };
894 /**
895 * @class OO.Factory
896 * @extends OO.Registry
897 *
898 * @constructor
899 */
900 oo.Factory = function OoFactory() {
901 // Parent constructor
902 oo.Factory.parent.call( this );
903 };
905 /* Inheritance */
907 oo.inheritClass( oo.Factory, oo.Registry );
909 /* Methods */
911 /**
912 * Register a constructor with the factory.
913 *
914 * Classes must have a static `name` property to be registered.
915 *
916 * function MyClass() {};
917 * OO.initClass( MyClass );
918 * // Adds a static property to the class defining a symbolic name
919 * MyClass.static.name = 'mine';
920 * // Registers class with factory, available via symbolic name 'mine'
921 * factory.register( MyClass );
922 *
923 * @param {Function} constructor Constructor to use when creating object
924 * @throws {Error} Name must be a string and must not be empty
925 * @throws {Error} Constructor must be a function
926 */
927 oo.Factory.prototype.register = function ( constructor ) {
928 var name;
930 if ( typeof constructor !== 'function' ) {
931 throw new Error( 'constructor must be a function, cannot be a ' + typeof constructor );
932 }
933 name = constructor.static && constructor.static.name;
934 if ( typeof name !== 'string' || name === '' ) {
935 throw new Error( 'Name must be a string and must not be empty' );
936 }
938 // Parent method
939 oo.Factory.parent.prototype.register.call( this, name, constructor );
940 };
942 /**
943 * Unregister a constructor from the factory.
944 *
945 * @param {Function} constructor Constructor to unregister
946 * @throws {Error} Name must be a string and must not be empty
947 * @throws {Error} Constructor must be a function
948 */
949 oo.Factory.prototype.unregister = function ( constructor ) {
950 var name;
952 if ( typeof constructor !== 'function' ) {
953 throw new Error( 'constructor must be a function, cannot be a ' + typeof constructor );
954 }
955 name = constructor.static && constructor.static.name;
956 if ( typeof name !== 'string' || name === '' ) {
957 throw new Error( 'Name must be a string and must not be empty' );
958 }
960 // Parent method
961 oo.Factory.parent.prototype.unregister.call( this, name );
962 };
964 /**
965 * Create an object based on a name.
966 *
967 * Name is used to look up the constructor to use, while all additional arguments are passed to the
968 * constructor directly, so leaving one out will pass an undefined to the constructor.
969 *
970 * @param {string} name Object name
971 * @param {Mixed...} [args] Arguments to pass to the constructor
972 * @return {Object} The new object
973 * @throws {Error} Unknown object name
974 */
975 oo.Factory.prototype.create = function ( name ) {
976 var obj, i,
977 args = [],
978 constructor = this.lookup( name );
980 if ( !constructor ) {
981 throw new Error( 'No class registered by that name: ' + name );
982 }
984 // Convert arguments to array and shift the first argument (name) off
985 for ( i = 1; i < arguments.length; i++ ) {
986 args.push( arguments[i] );
987 }
989 // We can't use the "new" operator with .apply directly because apply needs a
990 // context. So instead just do what "new" does: create an object that inherits from
991 // the constructor's prototype (which also makes it an "instanceof" the constructor),
992 // then invoke the constructor with the object as context, and return it (ignoring
993 // the constructor's return value).
994 obj = Object.create( constructor.prototype );
995 constructor.apply( obj, args );
996 return obj;
997 };
999 /*jshint node:true */
1000 if ( typeof module !== 'undefined' && module.exports ) {
1001 module.exports = oo;
1002 } else {
1003 global.OO = oo;
1004 }
1006 }( this ) );