-
Notifications
You must be signed in to change notification settings - Fork 2
/
Class.js
1702 lines (1450 loc) · 51 KB
/
Class.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* ************************************************************************
qooxdoo - the new era of web development
http://qooxdoo.org
Copyright:
2004-2008 1&1 Internet AG, Germany, http://www.1und1.de
License:
LGPL: http://www.gnu.org/licenses/lgpl.html
EPL: http://www.eclipse.org/org/documents/epl-v10.php
See the LICENSE file in the project's top-level directory for details.
Authors:
* Sebastian Werner (wpbasti)
* Andreas Ecker (ecker)
************************************************************************ */
/**
* This class is one of the most important parts of qooxdoo's
* object-oriented features.
*
* Its {@link #define} method is used to create qooxdoo classes.
*
* Each instance of a class defined by {@link #define} has
* the following keys attached to the constructor and the prototype:
*
* <table>
* <tr><th><code>classname</code></th><td>The fully-qualified name of the class (e.g. <code>"qx.ui.core.Widget"</code>).</td></tr>
* <tr><th><code>basename</code></th><td>The namespace part of the class name (e.g. <code>"qx.ui.core"</code>).</td></tr>
* <tr><th><code>constructor</code></th><td>A reference to the constructor of the class.</td></tr>
* <tr><th><code>superclass</code></th><td>A reference to the constructor of the super class.</td></tr>
* </table>
*
* Each method may access static members of the same class by using
* <code>this.self(arguments)</code> ({@link qx.core.Object#self}):
* <pre class='javascript'>
* statics : { FOO : "bar" },
* members: {
* baz: function(x) {
* this.self(arguments).FOO;
* ...
* }
* }
* </pre>
*
* Each overriding method may call the overridden method by using
* <code>this.base(arguments [, ...])</code> ({@link qx.core.Object#base}). This is also true for calling
* the constructor of the superclass.
* <pre class='javascript'>
* members: {
* foo: function(x) {
* this.base(arguments, x);
* ...
* }
* }
* </pre>
*
* By using <code>qx.Class</code> within an app, the native JS data types are
* conveniently polyfilled according to {@link qx.lang.normalize}.
*
* @require(qx.Interface)
* @require(qx.Mixin)
* @require(qx.lang.normalize.Array)
* @require(qx.lang.normalize.Date)
* @require(qx.lang.normalize.Error)
* @require(qx.lang.normalize.Function)
* @require(qx.lang.normalize.String)
* @require(qx.lang.normalize.Object)
*/
qx.Bootstrap.define("qx.Class",
{
statics :
{
/**
* A static reference to the property implementation in the case it
* should be included.
*/
__Property : qx.core.Environment.get("module.property") ? qx.core.Property : null,
/*
---------------------------------------------------------------------------
PUBLIC METHODS
---------------------------------------------------------------------------
*/
/**
* Define a new class using the qooxdoo class system. This sets up the
* namespace for the class and generates the class from the definition map.
*
* Example:
* <pre class='javascript'>
* qx.Class.define("name",
* {
* extend : Object, // superclass
* implement : [Interfaces],
* include : [Mixins],
*
* statics:
* {
* CONSTANT : 3.141,
*
* publicMethod: function() {},
* _protectedMethod: function() {},
* __privateMethod: function() {}
* },
*
* properties:
* {
* "tabIndex": { check: "Number", init : -1 }
* },
*
* members:
* {
* publicField: "foo",
* publicMethod: function() {},
*
* _protectedField: "bar",
* _protectedMethod: function() {},
*
* __privateField: "baz",
* __privateMethod: function() {}
* }
* });
* </pre>
*
* @param name {String?null} Name of the class. If <code>null</code>, the class
* will not be added to any namespace which could be handy for testing.
* @param config {Map ? null} Class definition structure. The configuration map has the following keys:
* <table>
* <tr><th>Name</th><th>Type</th><th>Description</th></tr>
* <tr><th>type</th><td>String</td><td>
* Type of the class. Valid types are "abstract", "static" and "singleton".
* If unset it defaults to a regular non-static class.
* </td></tr>
* <tr><th>extend</th><td>Class</td><td>The super class the current class inherits from.</td></tr>
* <tr><th>implement</th><td>Interface | Interface[]</td><td>Single interface or array of interfaces the class implements.</td></tr>
* <tr><th>include</th><td>Mixin | Mixin[]</td><td>Single mixin or array of mixins, which will be merged into the class.</td></tr>
* <tr><th>construct</th><td>Function</td><td>The constructor of the class.</td></tr>
* <tr><th>statics</th><td>Map</td><td>Map of static members of the class.</td></tr>
* <tr><th>properties</th><td>Map</td><td>Map of property definitions. For a description of the format of a property definition see
* {@link qx.core.Property}.</td></tr>
* <tr><th>members</th><td>Map</td><td>Map of instance members of the class.</td></tr>
* <tr><th>environment</th><td>Map</td><td>Map of environment settings for this class. For a description of the format of a setting see
* {@link qx.core.Environment}.</td></tr>
* <tr><th>events</th><td>Map</td><td>
* Map of events the class fires. The keys are the names of the events and the values are the
* corresponding event type class names.
* </td></tr>
* <tr><th>defer</th><td>Function</td><td>Function that is called at the end of processing the class declaration. It allows access to the declared statics, members and properties.</td></tr>
* <tr><th>destruct</th><td>Function</td><td>The destructor of the class.</td></tr>
* </table>
* @return {Class} The defined class
*/
define : function(name, config)
{
if (!config) {
config = {};
}
// Normalize include to array
if (config.include && !(qx.Bootstrap.getClass(config.include) === "Array")) {
config.include = [config.include];
}
// Normalize implement to array
if (config.implement && !(qx.Bootstrap.getClass(config.implement) === "Array")) {
config.implement = [config.implement];
}
// Normalize type
var implicitType = false;
if (!config.hasOwnProperty("extend") && !config.type) {
config.type = "static";
implicitType = true;
}
// Validate incoming data
if (qx.core.Environment.get("qx.debug")) {
try {
this.__validateConfig(name, config);
} catch(ex) {
if (implicitType) {
ex.message = 'Assumed static class because no "extend" key was found. ' + ex.message;
}
throw ex;
}
}
// Create the class
var clazz = this.__createClass(name, config.type, config.extend, config.statics, config.construct, config.destruct, config.include);
// Members, properties, events and mixins are only allowed for non-static classes
if (config.extend)
{
// Attach properties
if (config.properties) {
this.__addProperties(clazz, config.properties, true);
}
// Attach members
if (config.members) {
this.__addMembers(clazz, config.members, true, true, false);
}
// Process events
if (config.events) {
this.__addEvents(clazz, config.events, true);
}
// Include mixins
// Must be the last here to detect conflicts
if (config.include)
{
for (var i=0, l=config.include.length; i<l; i++) {
this.__addMixin(clazz, config.include[i], false);
}
}
}
// If config has a 'extend' key but it's null or undefined
else if (config.hasOwnProperty('extend') && qx.core.Environment.get("qx.debug"))
{
throw new Error('"extend" parameter is null or undefined');
}
// Process environment
if (config.environment)
{
for (var key in config.environment) {
qx.core.Environment.add(key, config.environment[key]);
}
}
// Interface support for non-static classes
if (config.implement)
{
for (var i=0, l=config.implement.length; i<l; i++) {
this.__addInterface(clazz, config.implement[i]);
}
}
if (qx.core.Environment.get("qx.debug")) {
this.__validateAbstractInterfaces(clazz);
}
// Process defer
if (config.defer)
{
config.defer.self = clazz;
config.defer(clazz, clazz.prototype,
{
add : function(name, config)
{
// build pseudo properties map
var properties = {};
properties[name] = config;
// execute generic property handler
qx.Class.__addProperties(clazz, properties, true);
}
});
}
return clazz;
},
/**
* Removes a class from qooxdoo defined by {@link #define}
*
* @param name {String} Name of the class
*/
undefine : function(name)
{
// first, delete the class from the registry
delete this.$$registry[name];
// delete the class reference from the namespaces and all empty namespaces
var ns = name.split(".");
// build up an array containing all namespace objects including window
var objects = [window];
for (var i = 0; i < ns.length; i++) {
objects.push(objects[i][ns[i]]);
}
// go through all objects and check for the constructor or empty namespaces
for (var i = objects.length - 1; i >= 1; i--) {
var last = objects[i];
var parent = objects[i - 1];
if (qx.Bootstrap.isFunction(last) || qx.Bootstrap.objectGetLength(last) === 0) {
delete parent[ns[i - 1]];
} else {
break;
}
}
},
/**
* Whether the given class exists
*
* @signature function(name)
* @param name {String} class name to check
* @return {Boolean} true if class exists
*/
isDefined : qx.util.OOUtil.classIsDefined,
/**
* Determine the total number of classes
*
* @return {Number} the total number of classes
*/
getTotalNumber : function() {
return qx.Bootstrap.objectGetLength(this.$$registry);
},
/**
* Find a class by its name
*
* @signature function(name)
* @param name {String} class name to resolve
* @return {Class} the class
*/
getByName : qx.Bootstrap.getByName,
/**
* Include all features of the given mixin into the class. The mixin must
* not include any methods or properties that are already available in the
* class. This would only be possible using the {@link #patch} method.
*
* @param clazz {Class} An existing class which should be augmented by including a mixin.
* @param mixin {Mixin} The mixin to be included.
*/
include : function(clazz, mixin)
{
if (qx.core.Environment.get("qx.debug"))
{
if (!mixin) {
throw new Error("The mixin to include into class '" + clazz.classname + "' is undefined/null!");
}
qx.Mixin.isCompatible(mixin, clazz);
}
qx.Class.__addMixin(clazz, mixin, false);
},
/**
* Include all features of the given mixin into the class. The mixin may
* include features, which are already defined in the target class. Existing
* features of equal name will be overwritten.
* Please keep in mind that this functionality is not intended for regular
* use, but as a formalized way (and a last resort) in order to patch
* existing classes.
*
* <b>WARNING</b>: You may break working classes and features.
*
* @param clazz {Class} An existing class which should be modified by including a mixin.
* @param mixin {Mixin} The mixin to be included.
*/
patch : function(clazz, mixin)
{
if (qx.core.Environment.get("qx.debug"))
{
if (!mixin) {
throw new Error("The mixin to patch class '" + clazz.classname + "' is undefined/null!");
}
qx.Mixin.isCompatible(mixin, clazz);
}
qx.Class.__addMixin(clazz, mixin, true);
},
/**
* Whether a class is a direct or indirect sub class of another class,
* or both classes coincide.
*
* @param clazz {Class} the class to check.
* @param superClass {Class} the potential super class
* @return {Boolean} whether clazz is a sub class of superClass.
*/
isSubClassOf : function(clazz, superClass)
{
if (!clazz) {
return false;
}
if (clazz == superClass) {
return true;
}
if (clazz.prototype instanceof superClass) {
return true;
}
return false;
},
/**
* Returns the definition of the given property. Returns null
* if the property does not exist.
*
* @signature function(clazz, name)
* @param clazz {Class} class to check
* @param name {String} name of the class to check for
* @return {Map|null} whether the object support the given event.
*/
getPropertyDefinition : qx.util.OOUtil.getPropertyDefinition,
/**
* Returns a list of all properties supported by the given class
*
* @param clazz {Class} Class to query
* @return {String[]} List of all property names
*/
getProperties : function(clazz)
{
var list = [];
while (clazz)
{
if (clazz.$$properties) {
list.push.apply(list, Object.keys(clazz.$$properties));
}
clazz = clazz.superclass;
}
return list;
},
/**
* Returns the class or one of its superclasses which contains the
* declaration for the given property in its class definition. Returns null
* if the property is not specified anywhere.
*
* @param clazz {Class} class to look for the property
* @param name {String} name of the property
* @return {Class | null} The class which includes the property
*/
getByProperty : function(clazz, name)
{
while (clazz)
{
if (clazz.$$properties && clazz.$$properties[name]) {
return clazz;
}
clazz = clazz.superclass;
}
return null;
},
/**
* Whether a class has the given property
*
* @signature function(clazz, name)
* @param clazz {Class} class to check
* @param name {String} name of the property to check for
* @return {Boolean} whether the class includes the given property.
*/
hasProperty : qx.util.OOUtil.hasProperty,
/**
* Returns the event type of the given event. Returns null if
* the event does not exist.
*
* @signature function(clazz, name)
* @param clazz {Class} class to check
* @param name {String} name of the event
* @return {String|null} Event type of the given event.
*/
getEventType : qx.util.OOUtil.getEventType,
/**
* Whether a class supports the given event type
*
* @signature function(clazz, name)
* @param clazz {Class} class to check
* @param name {String} name of the event to check for
* @return {Boolean} whether the class supports the given event.
*/
supportsEvent : qx.util.OOUtil.supportsEvent,
/**
* Whether a class directly includes a mixin.
*
* @param clazz {Class} class to check
* @param mixin {Mixin} the mixin to check for
* @return {Boolean} whether the class includes the mixin directly.
*/
hasOwnMixin : function(clazz, mixin) {
return clazz.$$includes && clazz.$$includes.indexOf(mixin) !== -1;
},
/**
* Returns the class or one of its superclasses which contains the
* declaration for the given mixin. Returns null if the mixin is not
* specified anywhere.
*
* @param clazz {Class} class to look for the mixin
* @param mixin {Mixin} mixin to look for
* @return {Class | null} The class which directly includes the given mixin
*/
getByMixin : function(clazz, mixin)
{
var list, i, l;
while (clazz)
{
if (clazz.$$includes)
{
list = clazz.$$flatIncludes;
for (i=0, l=list.length; i<l; i++)
{
if (list[i] === mixin) {
return clazz;
}
}
}
clazz = clazz.superclass;
}
return null;
},
/**
* Returns a list of all mixins available in a given class.
*
* @signature function(clazz)
* @param clazz {Class} class which should be inspected
* @return {Mixin[]} array of mixins this class uses
*/
getMixins : qx.util.OOUtil.getMixins,
/**
* Whether a given class or any of its superclasses includes a given mixin.
*
* @param clazz {Class} class to check
* @param mixin {Mixin} the mixin to check for
* @return {Boolean} whether the class includes the mixin.
*/
hasMixin: function(clazz, mixin) {
return !!this.getByMixin(clazz, mixin);
},
/**
* Whether a given class directly includes an interface.
*
* This function will only return "true" if the interface was defined
* in the class declaration ({@link qx.Class#define}) using the "implement"
* key.
*
* @param clazz {Class} class or instance to check
* @param iface {Interface} the interface to check for
* @return {Boolean} whether the class includes the mixin directly.
*/
hasOwnInterface : function(clazz, iface) {
return clazz.$$implements && clazz.$$implements.indexOf(iface) !== -1;
},
/**
* Returns the class or one of its super classes which contains the
* declaration of the given interface. Returns null if the interface is not
* specified anywhere.
*
* @signature function(clazz, iface)
* @param clazz {Class} class to look for the interface
* @param iface {Interface} interface to look for
* @return {Class | null} the class which directly implements the given interface
*/
getByInterface : qx.util.OOUtil.getByInterface,
/**
* Returns a list of all interfaces a given class has to implement.
*
* @param clazz {Class} class which should be inspected
* @return {Interface[]} array of interfaces this class implements
*/
getInterfaces : function(clazz)
{
var list = [];
while (clazz)
{
if (clazz.$$implements) {
list.push.apply(list, clazz.$$flatImplements);
}
clazz = clazz.superclass;
}
return list;
},
/**
* Whether a given class or any of its super classes includes a given interface.
*
* This function will return "true" if the interface was defined
* in the class declaration ({@link qx.Class#define}) of the class
* or any of its super classes using the "implement"
* key.
*
* @signature function(clazz, iface)
* @param clazz {Class} class to check
* @param iface {Interface} the interface to check for
* @return {Boolean} whether the class includes the interface.
*/
hasInterface : qx.util.OOUtil.hasInterface,
/**
* Whether a given class complies to an interface.
*
* Checks whether all methods defined in the interface are
* implemented. The class does not need to implement
* the interface explicitly in the <code>extend</code> key.
*
* @param obj {Object} class to check
* @param iface {Interface} the interface to check for
* @return {Boolean} whether the class conforms to the interface.
*/
implementsInterface : function(obj, iface)
{
var clazz = obj.constructor;
if (this.hasInterface(clazz, iface)) {
return true;
}
if (qx.Interface.objectImplements(obj, iface)) {
return true;
}
if (qx.Interface.classImplements(clazz, iface)) {
return true;
}
return false;
},
/**
* Helper method to handle singletons
*
* @internal
* @return {Object} The singleton instance
*/
getInstance : function()
{
// @ITG:Wisej: Singletons may get disposed.
if (!this.$$instance || this.$$instance.isDisposed())
{
this.$$allowconstruct = true;
this.$$instance = new this();
delete this.$$allowconstruct;
}
return this.$$instance;
},
/*
---------------------------------------------------------------------------
PRIVATE/INTERNAL BASICS
---------------------------------------------------------------------------
*/
/**
* This method will be attached to all classes to return
* a nice identifier for them.
*
* @internal
* @return {String} The class identifier
*/
genericToString : function() {
return "[Class " + this.classname + "]";
},
/** Stores all defined classes */
$$registry : qx.Bootstrap.$$registry,
/** @type {Map} allowed keys in non-static class definition */
__allowedKeys : qx.core.Environment.select("qx.debug",
{
"true":
{
"type" : "string", // String
"extend" : "function", // Function
"implement" : "object", // Interface[]
"include" : "object", // Mixin[]
"construct" : "function", // Function
"statics" : "object", // Map
"properties" : "object", // Map
"members" : "object", // Map
"environment" : "object", // Map
"events" : "object", // Map
"defer" : "function", // Function
"destruct" : "function" // Function
},
"default" : null
}),
/** @type {Map} allowed keys in static class definition */
__staticAllowedKeys : qx.core.Environment.select("qx.debug",
{
"true":
{
"type" : "string", // String
"statics" : "object", // Map
"environment" : "object", // Map
"defer" : "function" // Function
},
"default" : null
}),
/**
* Validates an incoming configuration and checks for proper keys and values
*
* @signature function(name, config)
* @param name {String} The name of the class
* @param config {Map} Configuration map
*/
__validateConfig : qx.core.Environment.select("qx.debug",
{
"true": function(name, config)
{
// Validate type
if (config.type && !(config.type === "static" || config.type === "abstract" || config.type === "singleton")) {
throw new Error('Invalid type "' + config.type + '" definition for class "' + name + '"!');
}
// Validate non-static class on the "extend" key
if (config.type && config.type !== "static" && !config.extend) {
throw new Error('Invalid config in class "' + name + '"! Every non-static class has to extend at least the "qx.core.Object" class.');
}
// Validate keys
var allowed = config.type === "static" ? this.__staticAllowedKeys : this.__allowedKeys;
for (var key in config)
{
if (!allowed[key]) {
throw new Error('The configuration key "' + key + '" in class "' + name + '" is not allowed!');
}
if (config[key] == null) {
throw new Error('Invalid key "' + key + '" in class "' + name + '"! The value is undefined/null!');
}
if (typeof config[key] !== allowed[key]) {
throw new Error('Invalid type of key "' + key + '" in class "' + name + '"! The type of the key must be "' + allowed[key] + '"!');
}
}
// Validate maps
var maps = [ "statics", "properties", "members", "environment", "settings", "variants", "events" ];
for (var i=0, l=maps.length; i<l; i++)
{
var key = maps[i];
if (config[key] !== undefined && (
config[key].$$hash !== undefined || !qx.Bootstrap.isObject(config[key])
)) {
throw new Error('Invalid key "' + key + '" in class "' + name + '"! The value needs to be a map!');
}
}
// Validate include definition
if (config.include)
{
if (qx.Bootstrap.getClass(config.include) === "Array")
{
for (var i=0, a=config.include, l=a.length; i<l; i++)
{
if (a[i] == null || a[i].$$type !== "Mixin") {
throw new Error('The include definition in class "' + name + '" contains an invalid mixin at position ' + i + ': ' + a[i]);
}
}
}
else
{
throw new Error('Invalid include definition in class "' + name + '"! Only mixins and arrays of mixins are allowed!');
}
}
// Validate implement definition
if (config.implement)
{
if (qx.Bootstrap.getClass(config.implement) === "Array")
{
for (var i=0, a=config.implement, l=a.length; i<l; i++)
{
if (a[i] == null || a[i].$$type !== "Interface") {
throw new Error('The implement definition in class "' + name + '" contains an invalid interface at position ' + i + ': ' + a[i]);
}
}
}
else
{
throw new Error('Invalid implement definition in class "' + name + '"! Only interfaces and arrays of interfaces are allowed!');
}
}
// Check mixin compatibility
if (config.include)
{
try {
qx.Mixin.checkCompatibility(config.include);
} catch(ex) {
throw new Error('Error in include definition of class "' + name + '"! ' + ex.message);
}
}
// Validate environment
if (config.environment)
{
for (var key in config.environment)
{
if (key.substr(0, key.indexOf(".")) != name.substr(0, name.indexOf("."))) {
throw new Error('Forbidden environment setting "' + key +
'" found in "' + name + '". It is forbidden to define a ' +
'environment setting for an external namespace!');
}
}
}
// Validate settings
if (config.settings)
{
for (var key in config.settings)
{
if (key.substr(0, key.indexOf(".")) != name.substr(0, name.indexOf("."))) {
throw new Error('Forbidden setting "' + key + '" found in "' + name + '". It is forbidden to define a default setting for an external namespace!');
}
}
}
// Validate variants
if (config.variants)
{
for (var key in config.variants)
{
if (key.substr(0, key.indexOf(".")) != name.substr(0, name.indexOf("."))) {
throw new Error('Forbidden variant "' + key + '" found in "' + name + '". It is forbidden to define a variant for an external namespace!');
}
}
}
},
"default" : function(name, config) {}
}),
/**
* Validates the interfaces required by abstract base classes
*
* @signature function(clazz)
* @param clazz {Class} The configured class.
*/
__validateAbstractInterfaces : qx.core.Environment.select("qx.debug",
{
"true": function(clazz)
{
var superclass = clazz.superclass;
while (superclass)
{
if (superclass.$$classtype !== "abstract") {
break;
}
var interfaces = superclass.$$implements;
if (interfaces)
{
for (var i=0; i<interfaces.length; i++) {
qx.Interface.assert(clazz, interfaces[i], true);
}
}
superclass = superclass.superclass;
}
},
"default" : function(clazz) {}
}),
/**
* Creates a class by type. Supports modern inheritance etc.
*
* @param name {String} Full name of the class
* @param type {String} type of the class, i.e. "static", "abstract" or "singleton"
* @param extend {Class} Superclass to inherit from
* @param statics {Map} Static methods or fields
* @param construct {Function} Constructor of the class
* @param destruct {Function} Destructor of the class
* @param mixins {Mixin[]} array of mixins of the class
* @return {Class} The generated class
*/
__createClass : function(name, type, extend, statics, construct, destruct, mixins)
{
var clazz;
if (!extend && qx.core.Environment.get("qx.aspects") == false)
{
// Create empty/non-empty class
clazz = statics || {};
qx.Bootstrap.setDisplayNames(clazz, name);
}
else
{
clazz = {};
if (extend)
{
// Create default constructor
if (!construct) {
construct = this.__createDefaultConstructor();
}
if (this.__needsConstructorWrapper(extend, mixins)) {
clazz = this.__wrapConstructor(construct, name, type);
} else {
clazz = construct;
}
// Add singleton getInstance()
if (type === "singleton") {
clazz.getInstance = this.getInstance;
}
qx.Bootstrap.setDisplayName(construct, name, "constructor");
}
// Copy statics
if (statics)
{
qx.Bootstrap.setDisplayNames(statics, name);
var key;
for (var i=0, a=Object.keys(statics), l=a.length; i<l; i++)
{
key = a[i];
var staticValue = statics[key];
if (qx.core.Environment.get("qx.aspects"))
{
if (staticValue instanceof Function) {
staticValue = qx.core.Aspect.wrap(name + "." + key, staticValue, "static");
}
clazz[key] = staticValue;
}
else
{
clazz[key] = staticValue;
}
}
}
}
// Create namespace
var basename = name ? qx.Bootstrap.createNamespace(name, clazz) : "";
// Store names in constructor/object