0.6.x/js/01_core/11_XClass.js

   1 /**\r
   2  * Class を定義し システムの管理下に置く．\r
   3  * 全てのクラスと pool が有効の場合インスタンスへの参照が保持される．\r
   4  *  1. X.Class.create( opt_settings, opt_name, opt_privateClass, opt_props ) でクラスを登録．\r
   5  *  2. コンストラクタ となるメソッドは、Constructor : function( arg ){ ... }, に書く．\r
   6  *  3. 通常通り new で インスタンス生成\r
   7  *  4. kill() でオブジェクトをクリーンして削除、pool が有効の場合は pool される．\r
   8  *  5. pool が有効の場合、new で pool されたインスタンスが返される．\r
   9  *  6. \r
  10  * \r
  11  */\r
  12 \r
  13 // ------------------------------------------------------------------------- //\r
  14 // ------------ local variables -------------------------------------------- //\r
  15 // ------------------------------------------------------------------------- //\r
  16 var X_Class_CLASS_LIST         = [],\r
  17         X_Class_DEF_LIST           = [],\r
  18         X_Class_PRIVATE_CLASS_LIST = [],\r
  19         X_Class_PRIVATE_DEF_LIST   = [],\r
  20         X_Class_CALLING_SUPER      = [],\r
  21         X_Class_CALL_SUPER_STACK   = [],\r
  22         X_Class_killPrivateFlag    = false,\r
  23         X_Class_traits             = null,\r
  24         X_Class_useObjectCreate    = false, // !!Object.create, http://jsperf.com/prototype-vs-object-create-perf\r
  25         X_Class_use_proto_         = !!X.emptyFunction.prototype.__proto__;\r
  26 \r
  27 /* \r
  28  * X.Class.create で作られたクラスのインスタンスが共通で備えるメソッド \r
  29  */\r
  30 var X_Class_CommonProps = {\r
  31         kill : function(){\r
  32                 var instance = this,\r
  33                         klass    = X_Class_getClass( instance ),\r
  34                         def      = X_Class_getClassDef( klass ),\r
  35                         data, p, i;\r
  36                 if( def.isPrivate && !X_Class_killPrivateFlag ){\r
  37                         X.Logger.critical( 'PrivateInstance.kill() work in PrivateUser.kill().' );\r
  38                         return;\r
  39                 };\r
  40                 X_Class_killPrivateFlag = false; // onKill 内で PrivateInstance.kill() を防ぐため\r
  41                 \r
  42                 // onKill() === false の場合、kill のキャンセル\r
  43                 // private      は false での キャンセル は無視される\r
  44                 \r
  45                 if( this.instanceOf( X.EventDispatcher ) ){\r
  46                         //console.log( 'this.instanceOf( X.EventDispatcher )! ' + this._dispatching );\r
  47                         if( !def.isPrivate ){\r
  48                                 if( this._dispatching ){\r
  49                                         this.dispatch( X.Event.BEFORE_KILL_INSTANCE );\r
  50                                         this._killReserved = true;\r
  51                                         this.dispatch( X.Event.KILL_INSTANCE_CANCELED );\r
  52                                         return;\r
  53                                 } else\r
  54                                 if( this.dispatch( X.Event.BEFORE_KILL_INSTANCE ) & X.Callback.PREVENT_DEFAULT ){\r
  55                                         this.dispatch( X.Event.KILL_INSTANCE_CANCELED );\r
  56                                         return;\r
  57                                 };\r
  58                         } else {\r
  59                                 this.dispatch( X.Event.BEFORE_KILL_INSTANCE );  \r
  60                         };\r
  61                         this.dispatch( X.Event.KILL_INSTANCE );\r
  62                         this._listeners && X_EventDispatcher_systemUnlisten( this ); //.unlisten();\r
  63                 } else\r
  64                 if( X.Type.isFunction( instance.onKill ) && instance.onKill() === false && !def.isPrivate ){\r
  65                         return;\r
  66                 };\r
  67                 \r
  68                 for( p in instance ){\r
  69                         if( instance.hasOwnProperty && !instance.hasOwnProperty( p ) ) continue;\r
  70                         delete instance[ p ];\r
  71                 };\r
  72                 if( def.pool ){\r
  73                         def.live && def.live.splice( def.live.indexOf( instance ), 1 );\r
  74                         def.pool[ def.pool.length ] = instance;\r
  75                 };\r
  76                 if( def.privateClass ){\r
  77                         i = def.userList.indexOf( instance );\r
  78                         if( i !== -1 ){\r
  79                                 data = X_Class_getPrivate( instance );\r
  80                                 X_Class_killPrivateFlag = true;\r
  81                                 if( data._dispatching && data.instanceOf( X.EventDispatcher ) ){\r
  82                                         data._killReserved = true;\r
  83                                 } else {\r
  84                                         data.kill();\r
  85                                 };\r
  86                                 def.dataList.splice( i, 1 );\r
  87                                 def.userList.splice( i, 1 );\r
  88                         };\r
  89                 };\r
  90         },\r
  91         \r
  92         // TODO Super\r
  93         // superCall\r
  94         \r
  95         instanceOf : function( klass ){\r
  96                 var Super = this;\r
  97                 if( this.constructor === klass ) return true;\r
  98                 while( Super = X_Class_getClassDef( Super ).SuperClass ){\r
  99                         if( Super === klass ) return true;\r
 100                 };\r
 101                 return false;\r
 102         }\r
 103 };\r
 104 // ------------------------------------------------------------------------- //\r
 105 // --- interface ----------------------------------------------------------- //\r
 106 // ------------------------------------------------------------------------- //\r
 107 X.Class = {\r
 108         \r
 109         POOL_OBJECT  :  1,\r
 110         ABSTRACT     :  2,\r
 111         FINAL        :  4,\r
 112         SUPER_ACCESS :  8,\r
 113         PRIVATE_DATA : 16,\r
 114         \r
 115         SINGLETON    : 32, // 未実装\r
 116         \r
 117         create : function( /* displayName, classSetting, opt_PrivateClass, props */ ){\r
 118                 var args        = X_Object_cloneArray( arguments ),\r
 119                         displayName = args[ 0 ],\r
 120                         classSetting,\r
 121                         opt_pool, opt_abstract, opt_final, opt_private,\r
 122                         privateDef,\r
 123                         props,\r
 124                         klass,\r
 125                         classDef = {};\r
 126                 if( X.Type.isString( displayName ) === true ){\r
 127                         classDef.displayName = displayName;\r
 128                         args.shift();\r
 129                 };\r
 130                 \r
 131                 // クラス設定\r
 132                 classDef.setting = classSetting = args[ 0 ];\r
 133                 if( X.Type.isNumber( classSetting ) ){\r
 134                         opt_pool     = !!( classSetting & X.Class.POOL_OBJECT  );\r
 135                         opt_abstract = !!( classSetting & X.Class.ABSTRACT     );\r
 136                         opt_final    = !!( classSetting & X.Class.FINAL        );\r
 137                         opt_private  = !!( classSetting & X.Class.PRIVATE_DATA );\r
 138                         if( opt_final && opt_abstract ){\r
 139                                 X.Logger.critical( 'final & Abstract!' );\r
 140                                 return;\r
 141                         };      \r
 142                         args.shift();\r
 143                 } else {\r
 144                         classDef.setting = 0;\r
 145                 };\r
 146                 \r
 147                 // シャドウクラス\r
 148                 if( X_Class_PRIVATE_CLASS_LIST.indexOf( args[ 0 ] ) !== -1 ){\r
 149                         privateDef = X_Class_getClassDef( args[ 0 ] );\r
 150                         if( privateDef.isPrivate !== true ){\r
 151                                 X.Logger.critical( 'PrivateClass not found! please, X.Class.create( X.Class.PRIVATE, {...} ).' );\r
 152                                 return;\r
 153                         } else\r
 154                         if( privateDef.Abstract === true ){\r
 155                                 X.Logger.critical( 'PrivateClass is Abstract!' );\r
 156                                 return;\r
 157                         };\r
 158                         classDef.privateClass = args.shift();\r
 159                 };\r
 160                 \r
 161                 // インスタンスのメンバー\r
 162                 props = args[ 0 ];\r
 163                 if( !X.Type.isObject( props ) ){\r
 164                         // サブクラスの場合、クラス定義の上書きがなくても作成可能\r
 165                         // サブクラスでなくても、クラスメンバ用オブジェクトが無しでも作成可能\r
 166                         //if( !X_Class_traits ){\r
 167                         //      X.Logger.critical( 'No Class Def!' );\r
 168                         //      return;\r
 169                         //};\r
 170                         props = {};\r
 171                 } else\r
 172                 if( props.Constructor && X.Type.isFunction( props.Constructor ) ){\r
 173                         classDef.Constructor = props.Constructor;\r
 174                 };\r
 175 \r
 176                 // TODO use X.Function\r
 177                 klass = new Function( 'var a=arguments,f=a.callee;if(f.__new)return f.__new(a)' );\r
 178                 klass.__new = X_Class_actualConstructor;\r
 179                 klass.superClassOf = X_Class_superClassOf;\r
 180                 klass.subClassOf   = X_Class_subClassOf;\r
 181                 \r
 182                 if( X_Class_useObjectCreate ){\r
 183                         klass.prototype = X_Class_override( X_Class_override( X_Class_traits || klass.prototype, props, true ), X_Class_CommonProps, false );\r
 184                         klass.prototype.constructor = klass;\r
 185                 } else\r
 186                 if( X_Class_use_proto_ ){\r
 187                         X_Class_override( klass.prototype, props, true );\r
 188                         if( X_Class_traits ){\r
 189                                 klass.prototype.__proto__ = X_Class_traits;\r
 190                         } else {\r
 191                                 X_Class_override( klass.prototype, X_Class_CommonProps, false );\r
 192                         };\r
 193                 } else {\r
 194                         klass.prototype = X_Class_override( X_Class_override( X_Class_traits || klass.prototype, props, true ), X_Class_CommonProps, false );\r
 195                         klass.prototype.constructor = klass;\r
 196                 };\r
 197                 klass.name = displayName;\r
 198                 \r
 199                 if( opt_abstract === true ){\r
 200                         classDef.Abstract = true;\r
 201                 } else\r
 202                 if( opt_pool === true ){\r
 203                         classDef.pool = [];\r
 204                         if( opt_private === false ) classDef.live = [];\r
 205                 };                      \r
 206                 if( opt_final === true ){\r
 207                         classDef.Final = true;\r
 208                 } else {\r
 209                         klass.inherits = X_Class_inherits;\r
 210                 };                      \r
 211                 if( opt_private === true ){\r
 212                         if( classDef.privateClass ){\r
 213                                 X.Logger.critical( 'Private Data Class has no PrivateClass!' );\r
 214                                 return;\r
 215                         };\r
 216                         classDef.isPrivate = true;\r
 217                         X_Class_PRIVATE_CLASS_LIST.push( klass );\r
 218                         X_Class_PRIVATE_DEF_LIST.push( classDef );\r
 219                 } else {\r
 220                         X_Class_CLASS_LIST.push( klass );\r
 221                         X_Class_DEF_LIST.push( classDef );                              \r
 222                 };\r
 223                 return klass;\r
 224         },\r
 225         \r
 226         _getClass    : X_Class_getClass,\r
 227         \r
 228         _getClassDef : X_Class_getClassDef,\r
 229         \r
 230         _newPrivate  : X_Class_newPrivate,\r
 231         \r
 232         _getPrivate  : X_Class_getPrivate,\r
 233         \r
 234         _override    : X_Class_override\r
 235         \r
 236 };\r
 237 \r
 238 // ------------------------------------------------------------------------- //\r
 239 // --- implements ---------------------------------------------------------- //\r
 240 // ------------------------------------------------------------------------- //\r
 241 function X_Class_getClass( instance ){\r
 242         var cList    = X_Class_CLASS_LIST,\r
 243                 i        = cList.length,\r
 244                 klass;\r
 245         for( ; i; ){\r
 246                 klass = cList[ --i ];\r
 247                 if( instance.constructor === klass ) return klass;\r
 248         };\r
 249         cList = X_Class_PRIVATE_CLASS_LIST;\r
 250         i     = cList.length;\r
 251         for( ; i; ){\r
 252                 klass = cList[ --i ];\r
 253                 if( instance.constructor === klass ) return klass;\r
 254         };\r
 255         \r
 256         if( cList.indexOf( instance ) !== -1 ) return instance;\r
 257         if( X_Class_CLASS_LIST.indexOf( instance ) !== -1 ) return instance;\r
 258 };\r
 259 \r
 260 function X_Class_getClassDef( KlassOrInstance ){\r
 261         var i = X_Class_CLASS_LIST.indexOf( KlassOrInstance );\r
 262         if( i === -1 ) i = X_Class_CLASS_LIST.indexOf( X_Class_getClass( KlassOrInstance ) );\r
 263         if( i !== -1 ) return X_Class_DEF_LIST[ i ];\r
 264         \r
 265         i = X_Class_PRIVATE_CLASS_LIST.indexOf( KlassOrInstance );\r
 266         if( i === -1 ) i = X_Class_PRIVATE_CLASS_LIST.indexOf( X_Class_getClass( KlassOrInstance ) );\r
 267         if( i !== -1 ) return X_Class_PRIVATE_DEF_LIST[ i ];\r
 268         \r
 269         if( X_Class_DEF_LIST.indexOf( KlassOrInstance ) !== -1 ) return KlassOrInstance;\r
 270         if( X_Class_PRIVATE_DEF_LIST.indexOf( KlassOrInstance ) !== -1 ) return KlassOrInstance;\r
 271 };\r
 272 \r
 273 function X_Class_newPrivate( /* instance, args */ ){\r
 274         var args         = X_Object_cloneArray( arguments ),\r
 275                 user         = args.shift(),\r
 276                 def          = X_Class_getClassDef( user ),\r
 277                 privateClass = def.privateClass,\r
 278                 privateDef   = X_Class_getClassDef( privateClass ),\r
 279                 i            = -1;\r
 280         if( def.userList ){\r
 281                 i = def.userList.indexOf( user );\r
 282         } else {\r
 283                 def.userList = [];\r
 284                 def.dataList = [];\r
 285         };\r
 286         if( i !== -1 ){\r
 287                 X.Logger.critical( 'PrivateData already exist!' );\r
 288                 return;\r
 289         };\r
 290         if( privateDef._tempUser ){\r
 291                 X.Logger.critical( 'newPrivate を連続呼び出しされたところ破綻' );\r
 292                 return;\r
 293         };\r
 294         privateDef._tempUser = user;\r
 295         return privateClass.__new( args );\r
 296 };\r
 297 \r
 298 function X_Class_getPrivate( instance ){\r
 299         var def = X_Class_getClassDef( instance ),\r
 300                 i   = def.userList.indexOf( instance );\r
 301         if( i !== -1 ) return def.dataList[ i ];\r
 302 };\r
 303 \r
 304 /* over のプロパティを target にコピーする．ただし target の プロパティが優先, force で解除 */\r
 305 function X_Class_override( target, src, force ){\r
 306         var p;\r
 307         for( p in src ){\r
 308                 if( p === 'Super' || p === 'SuperConstructor' || p === '__proto__' || p === 'prototype' || p === 'constructor' ){\r
 309                         X.Logger.critical( 'Super & SuperConstructor is reserved!' );\r
 310                         return;\r
 311                 };\r
 312                 if( force || target[ p ] === void 0 ){\r
 313                         target[ p ] = src[ p ];\r
 314                 };\r
 315         };\r
 316         return target;\r
 317 };\r
 318 \r
 319 function X_Class_superClassOf( klass ){\r
 320         var myDef      = X_Class_getClassDef( this ),\r
 321                 targetDef  = X_Class_getClassDef( klass ),\r
 322                 SuperClass = klass;\r
 323 \r
 324         if( !myDef || !targetDef || this === klass ) return false;\r
 325         \r
 326         while( SuperClass = X_Class_getClassDef( SuperClass ).SuperClass ){\r
 327                 if( SuperClass === this ) return true;\r
 328         };\r
 329         \r
 330         return false;\r
 331 };\r
 332 \r
 333 function X_Class_subClassOf( klass ){\r
 334         return X_Class_superClassOf.call( klass, this );\r
 335 };\r
 336         \r
 337 /* サブクラスを作るメソッド  \r
 338  * var subClass = superClass.inherits( ... ) \r
 339  * http://d.hatena.ne.jp/m-hiyama/20051018/1129605002\r
 340  */\r
 341 function X_Class_inherits( /* displayName, classSetting, opt_PrivateClass, props */ ){\r
 342         var args        = X_Object_cloneArray( arguments ),\r
 343                 params      = [],\r
 344                 Super       = this,\r
 345                 superDef    = X_Class_getClassDef( Super ),\r
 346                 displayName = args[ 0 ],\r
 347                 classSetting,\r
 348                 opt_super,\r
 349                 klass, def;\r
 350         if( superDef.Final ) X.Logger.critical( 'X.Class inherits, Class is final!' );\r
 351         \r
 352         // サブクラス名\r
 353         if( X.Type.isString( displayName ) ){\r
 354                 args.shift();\r
 355         } else {\r
 356                 displayName = 'SubClass of ' + superDef.displayName;\r
 357         };\r
 358         params.push( displayName );\r
 359         \r
 360         // サブクラス設定\r
 361         classSetting = args[ 0 ];\r
 362         if( X.Type.isNumber( classSetting ) ){\r
 363                 args.shift();\r
 364         } else {\r
 365                 // クラス設定がない場合、親からコピーして、Abstract flag は落とす??\r
 366                 classSetting = superDef.setting;// &= ~X.Class.ABSTRACT;\r
 367         };\r
 368         if( superDef.isPrivate ) classSetting = classSetting | X.Class.PRIVATE_DATA;\r
 369         opt_super = !!( classSetting & X.Class.SUPER_ACCESS );\r
 370         params.push( classSetting );\r
 371 \r
 372         // サブクラスのシャドウ\r
 373         if( args[ 0 ] && X_Class_getClass( args[ 0 ] ) ){\r
 374                 params.push( args.shift() );\r
 375         } else\r
 376         if( superDef.privateClass ){\r
 377                 params.push( superDef.privateClass );\r
 378         };\r
 379         params.push( args[ 0 ] ); /* props サブクラスでは未定義でも可 */\r
 380         \r
 381         // 継承クラスの作成\r
 382         if( X_Class_useObjectCreate ){\r
 383                 X_Class_traits = Object.create( Super.prototype );\r
 384         } else\r
 385         if( X_Class_use_proto_ ){\r
 386                 X_Class_traits = Super.prototype;\r
 387         } else {\r
 388                 Super.__new = null;\r
 389                 X_Class_traits = new Super();\r
 390                 Super.__new = X_Class_actualConstructor;                        \r
 391         };\r
 392         klass  = X.Class.create.apply( X.Class, params );\r
 393         X_Class_traits = null;\r
 394         \r
 395         def    = X_Class_getClassDef( klass );\r
 396         // 継承用プロパティを控える\r
 397         if( opt_super === true ){\r
 398                 def.superAccess = true;\r
 399                 def.SuperClass  = Super;\r
 400                 def.SuperProto  = Super.prototype;\r
 401                 def.SuperConstructor = superDef.Constructor || superDef.SuperConstructor;\r
 402         } else {\r
 403                 def.SuperClass = Super; // instanceOf() で親クラスを調べる！\r
 404         };\r
 405         \r
 406         return klass;\r
 407 };\r
 408         \r
 409 /*\r
 410  * new の実体．コンストラクタの機能は instance.Constructor に書く．\r
 411  * これにより pool された オブジェクト（破棄されたインスタンス） を再利用できる\r
 412  */\r
 413 function X_Class_actualConstructor( args ){\r
 414         var klass    = this,\r
 415                 def      = X_Class_getClassDef( klass ),\r
 416                 dataUser = def._tempUser,\r
 417                 instance, obj,\r
 418                 userDef;\r
 419         if( def.Abstract ){\r
 420                 X.Logger.critical( 'AbstractClass!' );\r
 421                 return;\r
 422         };\r
 423         if( def.isPrivate && !dataUser ){\r
 424                 X.Logger.critical( 'use myClass.newPrivate( instance, ...args )!' );\r
 425                 return;\r
 426         };\r
 427         klass.__new = null;\r
 428         instance = def.pool && def.pool.length > 0 ?\r
 429                                         def.pool.pop() :\r
 430                                 X_Class_useObjectCreate ?\r
 431                                         Object.create( klass.prototype ) :\r
 432                                         new klass();\r
 433         klass.__new = X_Class_actualConstructor;\r
 434         \r
 435         if( def.isPrivate ){\r
 436                 userDef = X_Class_getClassDef( dataUser );\r
 437                 userDef.dataList.push( instance );\r
 438                 userDef.userList.push( dataUser );\r
 439                 instance.User = dataUser;\r
 440                 def._tempUser = null;\r
 441         } else {\r
 442                 def.live && def.live.push( instance );\r
 443         };\r
 444         if( def.superAccess ){\r
 445                 // TODO klass.prototype に移動\r
 446                 instance.Super = def.SuperProto;\r
 447                 instance.SuperConstructor = X_Class_superConstructor;\r
 448         };\r
 449         obj = def.Constructor ?\r
 450                         def.Constructor.apply( instance, args ) :\r
 451                 def.SuperConstructor &&\r
 452                         def.SuperConstructor.apply( instance, args );\r
 453         if( ( X.Type.isObject( obj ) && obj !== instance ) || X.Type.isFunction( obj ) ){ // Class\r
 454                 instance.kill();\r
 455                 return obj;\r
 456         };\r
 457         return instance;\r
 458 };\r
 459 /*  クラス定義を辿ってスーパークラスのコンストラクタを探す。\r
 460  *  呼び出したコンストラクタは配列に控える。\r
 461  *  さらに呼ばれた場合、配列を元にさらに奥のコンストラクタを取得\r
 462  *  TODO 現在 new しているインスタンスを保持してチェックする\r
 463  */\r
 464 function X_Class_superConstructor(){\r
 465         var sClass = this,\r
 466                 i      = X_Class_CALLING_SUPER.indexOf( sClass ),\r
 467                 n      = -1,\r
 468                 l, sList, def, sConst, ret;\r
 469 \r
 470         if( i === -1 ){\r
 471                 X_Class_CALLING_SUPER[ l = X_Class_CALLING_SUPER.length ] = sClass;\r
 472                 X_Class_CALL_SUPER_STACK[ l ] = sList = [];\r
 473         } else {\r
 474                 sList = X_Class_CALL_SUPER_STACK[ i ];\r
 475         };\r
 476         \r
 477         while( sClass ){\r
 478                 def    = X_Class_getClassDef( sClass );\r
 479                 sClass = def.SuperClass;\r
 480                 sConst = def.SuperConstructor;\r
 481                 if( sConst && sList[ ++n ] !== sConst ){\r
 482                         sList[ n ] = sConst;\r
 483                         ret = sConst.apply( this, arguments );\r
 484                         --sList.length;\r
 485                         if( !sList.length ){\r
 486                                 X_Class_CALLING_SUPER.splice( i, 1 );\r
 487                                 X_Class_CALL_SUPER_STACK.splice( i, 1 );\r
 488                         };\r
 489                         return ret;\r
 490                 };\r
 491         };\r
 492 };\r
 493 \r
 494 console.log( 'X.Core.Class' );\r