0.6.x/js/core/04_XClass.js

   1 /**\r
   2  * Class を定義し システムの管理下に置く．\r
   3  * 全てのクラスと pool が有効の場合インスタンスへの参照が保持される．\r
   4  *  1. X.Class.create( def, opt_final, opt_pool, opt_abstract ) でクラスを登録．\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 X.Class = ( function(){\r
  13         var CLASS_LIST         = [],\r
  14                 DEF_LIST           = [],\r
  15                 PRIVATE_CLASS_LIST = [],\r
  16                 PRIVATE_DEF_LIST   = [],\r
  17                 CONSTRUCTOR        = 'Constructor',\r
  18                 killPrivateFlag    = false,\r
  19                 traits             = null,\r
  20                 _slice             = Array.prototype.slice;\r
  21                 \r
  22         function copyArray( list ){\r
  23         //return _slice.call( list, 0 );\r
  24         var i = list.length, ret = new Array( i );\r
  25         for( ; i; ){\r
  26                 ret[ --i ] = list[ i ];\r
  27         };\r
  28         return ret;\r
  29         };\r
  30         \r
  31         /* サブクラスを作るメソッド  \r
  32          * var subClass = superClass.inherits( ... ) \r
  33          * http://d.hatena.ne.jp/m-hiyama/20051018/1129605002\r
  34          */\r
  35         function inherits( /* displayName, classSetting, opt_PrivateClass, props */ ){\r
  36                 var args        = copyArray( arguments ),\r
  37                         params      = [],\r
  38                         Super       = this,\r
  39                         superDef    = X.Class._getClassDef( Super ),\r
  40                         displayName = args[ 0 ],\r
  41                         classSetting,\r
  42                         opt_super,\r
  43                         klass, def;\r
  44                 if( superDef.Final === true ) X.Notification.critical( 'X.Class inherits, Class is final!' );\r
  45                 \r
  46                 if( X.Type.isString( displayName ) === true ){\r
  47                         args.shift();\r
  48                 } else {\r
  49                         displayName = 'SubClass of ' + superDef.displayName;\r
  50                 };\r
  51                 params.push( displayName );\r
  52                 \r
  53                 classSetting = args[ 0 ];\r
  54                 if( X.Type.isNumber( classSetting ) === true ){\r
  55                         if( superDef.isPrivate === true ) classSetting = classSetting | X.Class.PRIVATE_DATA;\r
  56                         opt_super = !!( classSetting & X.Class.SUPER_ACCESS );\r
  57                         params.push( classSetting );\r
  58                         args.shift();\r
  59                 };\r
  60                 if( X.Class._getClass( args[ 0 ] ) ){\r
  61                         params.push( args.shift() );\r
  62                 } else\r
  63                 if( superDef.privateClass ){\r
  64                         params.push( superDef.privateClass );\r
  65                 };\r
  66                 params.push( args[ 0 ] ); /* props */\r
  67                 Super.__new = null;\r
  68                 traits = new Super();\r
  69                 Super.__new = C;\r
  70                 klass  = X.Class.create.apply( null, params );\r
  71                 traits = null;\r
  72                 if( opt_super === true ){\r
  73                         def = X.Class._getClassDef( klass );\r
  74                         def.Super = Super;\r
  75                         def.SuperProto = Super.prototype;\r
  76                         def.SuperConstructor = superDef[ CONSTRUCTOR ];\r
  77                 };\r
  78                 return klass;\r
  79         };\r
  80         \r
  81         /* X.Class.create で作られたクラスのインスタンスが共通で備えるメソッド */\r
  82         var CommonProps = {\r
  83                 kill : function(){\r
  84                         var instance = this,\r
  85                                 klass    = X.Class._getClass( instance ),\r
  86                                 def      = X.Class._getClassDef( klass ),\r
  87                                 data, p, i;\r
  88                         if( def.isPrivate === true && killPrivateFlag === false ){\r
  89                                 X.Notification.critical( 'PrivateInstance.kill() work in PrivateUser.kill().' );\r
  90                                 return;\r
  91                         };\r
  92                         killPrivateFlag = false; // onKill 内で PrivateInstance.kill() を防ぐため\r
  93                         X.Type.isFunction( instance.onKill ) === true && instance.onKill();\r
  94                         for( p in instance ){\r
  95                                 if( instance.hasOwnProperty && !instance.hasOwnProperty( p ) ) continue;\r
  96                                 delete instance[ p ];\r
  97                         };\r
  98                         if( def.pool ){\r
  99                                 def.live && def.live.splice( def.live.indexOf( instance ), 1 );\r
 100                                 def.pool[ def.pool.length ] = instance;\r
 101                         };\r
 102                         if( def.privateClass ){\r
 103                                 i = def.userList.indexOf( instance );\r
 104                                 if( i !== -1 ){\r
 105                                         data            = X.Class._getPrivate( instance );\r
 106                                         killPrivateFlag = true;\r
 107                                         data.kill();\r
 108                                         def.dataList.splice( i, 1 );\r
 109                                         def.userList.splice( i, 1 );\r
 110                                 };\r
 111                         };\r
 112                         // myCallback の削除\r
 113                         // myCallback を受け取った API への通知\r
 114                 },\r
 115                 instanceOf : function( klass ){\r
 116                         var Super = this;\r
 117                         if( this.constructor === klass ) return true;\r
 118                         while( Super = X.Class._getClassDef( Super ).Super ){\r
 119                                 if( Super === klass ) return true;\r
 120                         };\r
 121                         return false;\r
 122                 }\r
 123         };\r
 124         \r
 125         /*\r
 126          * new の実体．コンストラクタの機能は instance.Constructor に書く．\r
 127          * これにより pool された オブジェクト（破棄されたインスタンス） を再利用できる\r
 128          */\r
 129         /* Constructor Real for GeneralClass */\r
 130         function C( args ){\r
 131                 var klass    = this,\r
 132                         def      = X.Class._getClassDef( klass ),\r
 133                         dataUser = def._tempUser,\r
 134                         instance,\r
 135                         userDef;\r
 136                 if( def.Abstract === true ){\r
 137                         X.Notification.critical( 'AbstractClass!' );\r
 138                         return;\r
 139                 };\r
 140                 if( def.isPrivate === true && dataUser === null ){\r
 141                         X.Notification.critical( 'use myClass.newPrivate( instance, ...args )!' );\r
 142                         return;\r
 143                 };\r
 144                 klass.__new = null;\r
 145                 instance = def.pool && def.pool.length > 0 ? def.pool.pop() : new klass();\r
 146                 klass.__new = C;\r
 147                 if( def.isPrivate === true ){\r
 148                         userDef = X.Class._getClassDef( dataUser );\r
 149                         userDef.dataList.push( instance );\r
 150                         userDef.userList.push( dataUser );\r
 151                         instance.User = dataUser;\r
 152                         def._tempUser = null;\r
 153                 } else {\r
 154                         def.live && def.live.push( instance );\r
 155                 };\r
 156                 if( def.Super ){\r
 157                         instance.Super = def.SuperProto;\r
 158                         instance.SuperConstructor = superConstructor;\r
 159                 };\r
 160                 def[ CONSTRUCTOR ] && def[ CONSTRUCTOR ].apply( instance, args );\r
 161                 return instance;\r
 162         };\r
 163         \r
 164         function superConstructor(){\r
 165                 X.Class._getClassDef( this ).SuperConstructor.apply( this, arguments );\r
 166         };\r
 167         \r
 168         return {\r
 169                 POOL_OBJECT  : 1,\r
 170                 ABSTRACT     : 2,\r
 171                 FINAL        : 4,\r
 172                 SUPER_ACCESS : 8,\r
 173                 PRIVATE_DATA : 16,\r
 174                 create : function( /* displayName, classSetting, opt_PrivateClass, props */ ){\r
 175                         var args        = copyArray( arguments ),\r
 176                                 displayName = args[ 0 ],\r
 177                                 classSetting,\r
 178                                 opt_pool, opt_abstract, opt_final, opt_private,\r
 179                                 privateDef,\r
 180                                 props,\r
 181                                 klass,\r
 182                                 classDef = {};\r
 183                         if( X.Type.isString( displayName ) === true ){\r
 184                                 classDef.displayName = displayName;\r
 185                                 args.shift();\r
 186                         };\r
 187                         classSetting = args[ 0 ];\r
 188                         if( X.Type.isNumber( classSetting ) === true ){\r
 189                                 opt_pool     = !!( classSetting & X.Class.POOL_OBJECT  );\r
 190                                 opt_abstract = !!( classSetting & X.Class.ABSTRACT     );\r
 191                                 opt_final    = !!( classSetting & X.Class.FINAL        );\r
 192                                 opt_private  = !!( classSetting & X.Class.PRIVATE_DATA );\r
 193                                 if( opt_final === true && opt_abstract === true ){\r
 194                                         X.Notification.critical( 'final & Abstract!' );\r
 195                                         return;\r
 196                                 };                              \r
 197                                 args.shift();\r
 198                         };\r
 199                         \r
 200                         if( PRIVATE_CLASS_LIST.indexOf( args[ 0 ] ) !== -1 ){\r
 201                                 privateDef = X.Class._getClassDef( args[ 0 ] );\r
 202                                 if( privateDef.isPrivate !== true ){\r
 203                                         X.Notification.critical( 'PrivateClass not found! please, X.Class.create( X.Class.PRIVATE, {...} ).' );\r
 204                                         return;\r
 205                                 } else\r
 206                                 if( privateDef.Abstract === true ){\r
 207                                         X.Notification.critical( 'PrivateClass is Abstract!' );\r
 208                                         return;\r
 209                                 };\r
 210                                 classDef.privateClass = args.shift();\r
 211                         };\r
 212                         props = args[ 0 ];\r
 213                         if( props === null || X.Type.isObject( props ) === false ){\r
 214                                 X.Notification.critical( 'No Class Def!' );\r
 215                                 return;\r
 216                         };\r
 217                         \r
 218                         if( props[ CONSTRUCTOR ] && X.Type.isFunction( props[ CONSTRUCTOR ] ) === true ){\r
 219                                 classDef[ CONSTRUCTOR ] = props[ CONSTRUCTOR ];\r
 220                         };\r
 221                         \r
 222                         klass = new Function( 'var a=arguments,f=a.callee;if(f.__new)return f.__new(a)' );\r
 223                         klass.__new = C;\r
 224                         klass.prototype = X.Class._override( X.Class._override( traits || klass.prototype, props, true ), CommonProps, false );\r
 225                         klass.prototype.constructor = klass;\r
 226                         klass.name = displayName;\r
 227                         \r
 228                         if( opt_abstract === true ){\r
 229                                 classDef.Abstract = true;\r
 230                         } else\r
 231                         if( opt_pool === true ){\r
 232                                 classDef.pool = [];\r
 233                                 if( opt_private === false ) classDef.live = [];\r
 234                         };                      \r
 235                         if( opt_final === true ){\r
 236                                 classDef.Final = true;\r
 237                         } else {\r
 238                                 klass.inherits = inherits;\r
 239                         };                      \r
 240                         if( opt_private === true ){\r
 241                                 if( classDef.privateClass ){\r
 242                                         X.Notification.critical( 'Private Data Class has no PrivateClass!' );\r
 243                                         return;\r
 244                                 };\r
 245                                 classDef.isPrivate = true;\r
 246                                 PRIVATE_CLASS_LIST.push( klass );\r
 247                                 PRIVATE_DEF_LIST.push( classDef );\r
 248                         } else {\r
 249                                 CLASS_LIST.push( klass );\r
 250                                 DEF_LIST.push( classDef );                              \r
 251                         };\r
 252                         return klass;\r
 253                 },\r
 254                 sys_shutdown : function(){\r
 255                         \r
 256                 },\r
 257                 _getClass : function( instance ){\r
 258                         var cList    = CLASS_LIST,\r
 259                                 i        = cList.length,\r
 260                                 klass;\r
 261                         for( ; i; ){\r
 262                                 klass = cList[ --i ];\r
 263                                 if( instance.constructor === klass ) return klass;\r
 264                         };\r
 265                         cList = PRIVATE_CLASS_LIST;\r
 266                         i     = cList.length;\r
 267                         for( ; i; ){\r
 268                                 klass = cList[ --i ];\r
 269                                 if( instance.constructor === klass ) return klass;\r
 270                         };\r
 271                         \r
 272                         if( cList.indexOf( instance ) !== -1 ) return instance;\r
 273                         if( CLASS_LIST.indexOf( instance ) !== -1 ) return instance;\r
 274                 },\r
 275                 _getClassDef : function( KlassOrInstance ){\r
 276                         var i = CLASS_LIST.indexOf( KlassOrInstance );\r
 277                         if( i === -1 ) i = CLASS_LIST.indexOf( X.Class._getClass( KlassOrInstance ) );\r
 278                         if( i !== -1 ) return DEF_LIST[ i ];\r
 279                         \r
 280                         i = PRIVATE_CLASS_LIST.indexOf( KlassOrInstance );\r
 281                         if( i === -1 ) i = PRIVATE_CLASS_LIST.indexOf( X.Class._getClass( KlassOrInstance ) );\r
 282                         if( i !== -1 ) return PRIVATE_DEF_LIST[ i ];\r
 283                         \r
 284                         if( DEF_LIST.indexOf( KlassOrInstance ) !== -1 ) return KlassOrInstance;\r
 285                         if( PRIVATE_DEF_LIST.indexOf( KlassOrInstance ) !== -1 ) return KlassOrInstance;\r
 286                 },\r
 287                 _newPrivate : function( /* instance, args */ ){\r
 288                         var args         = copyArray( arguments ),\r
 289                                 user         = args.shift(),\r
 290                                 def          = X.Class._getClassDef( user ),\r
 291                                 privateClass = def.privateClass,\r
 292                                 privateDef   = X.Class._getClassDef( privateClass ),\r
 293                                 i            = -1;\r
 294                         if( def.userList ){\r
 295                                 i = def.userList.indexOf( user );\r
 296                         } else {\r
 297                                 def.userList = [];\r
 298                                 def.dataList = [];\r
 299                         };\r
 300                         if( i !== -1 ){\r
 301                                 X.Notification.critical( 'PrivateData already exist!' );\r
 302                                 return;\r
 303                         };\r
 304                         if( privateDef._tempUser ){\r
 305                                 X.Notification.critical( 'newPrivate を連続呼び出しされたところ破綻' );\r
 306                                 return;\r
 307                         };\r
 308                         privateDef._tempUser = user;\r
 309                         return privateClass.__new( args );\r
 310                 },\r
 311                 _getPrivate : function( instance ){\r
 312                         var def = X.Class._getClassDef( instance ),\r
 313                                 i   = def.userList.indexOf( instance );\r
 314                         if( i !== -1 ) return def.dataList[ i ];\r
 315                 },\r
 316                 /* over のプロパティを target にコピーする．ただし target の プロパティが優先, force で解除 */\r
 317                 _override : function ( target, src, force ){\r
 318                         for( var p in src ){\r
 319                                 if( p === 'Super' || p === 'SuperConstructor' ){\r
 320                                         X.Notification.critical( 'Super & SuperConstructor is reserved!' );\r
 321                                         return;\r
 322                                 };\r
 323                                 if( force === true || target[ p ] === void 0 ){\r
 324                                         target[ p ] = src[ p ];\r
 325                                 };\r
 326                         };\r
 327                         return target;\r
 328                 }\r
 329         };\r
 330 })();