0.6.x/js/01_core/10_XCallback.js

   1 \r
   2 // ------------------------------------------------------------------------- //\r
   3 // ------------ local variables -------------------------------------------- //\r
   4 // ------------------------------------------------------------------------- //\r
   5 \r
   6 var /** @const */\r
   7         X_Callback_LIVE_LIST        = [],\r
   8         /** @const */\r
   9         X_Callback_POOL_LIST        = [],\r
  10         /** @const */\r
  11         X_Closure_COMMAND_BACK      = X_Callback_LIVE_LIST,\r
  12         /** @const */\r
  13         X_Closure_COMMAND_DROP      = X_Callback_POOL_LIST,\r
  14         \r
  15         /** @const */\r
  16         X_Callback_THIS_FUNC        = 1,\r
  17         /** @const */\r
  18         X_Callback_HANDLEEVENT      = 2,\r
  19         /** @const */\r
  20         X_Callback_FUNC_ONLY        = 3,\r
  21 \r
  22         /** @const */\r
  23         X_Callback_NONE             =  0,\r
  24         /** @const */\r
  25         X_Callback_UN_LISTEN        =  1,\r
  26         /** @const */\r
  27         X_Callback_STOP_PROPAGATION =  2,\r
  28         /** @const */\r
  29         X_Callback_STOP_NOW         =  4 | 2,  // 同一階層のリスナーのキャンセル(上位へもキャンセル)\r
  30         /** @const */\r
  31         X_Callback_PREVENT_DEFAULT  =  8,  // 結果動作のキャンセル,\r
  32         /** @const */\r
  33         X_Callback_MONOPOLY         = 16,  // move event を独占する\r
  34         /** @const */\r
  35         X_Callback_SYS_CANCEL       = 32 | 4 | 2;\r
  36 \r
  37 /*\r
  38  * handleEvent という関数のメンバーを持つオブジェクト\r
  39  * @typedef {{ handleEvent : function }}\r
  40  */\r
  41 var listener;\r
  42 \r
  43 /**\r
  44  * <h4>クロージャについて</h4>\r
  45  * javascript 開発で多用されるクロージャですが、次の理由によりその使用は慎重になるべきです。\r
  46  * <ol>\r
  47  * <li>正しく参照を切ってガベージコレクトされる条件を満たしたか？プログラマが見落としやすく、結果メモリリークを起こしやすい。特にコードがコールバック地獄になると目も当てられない。\r
  48  * </ol>\r
  49  * \r
  50  * とくに次のようなページでは、クロージャの使用を極力避けるべきです。破棄が行われることが確実で即時関数によって新しい名前を追加したくない場合と、次項で紹介する絶対に必要なケース以外で使わないようにします。\r
  51  * <ol>\r
  52  * <li>ajax によりデータ取得がたびたび起こり、合わせて不要なデータの破棄も行う。\r
  53  * <li>シングルページアプリケーションで画面の生成と破棄が繰り返される。\r
  54  * <li>Web アプリケーションで、一度開いたら一日中操作し続けるユーザーも想定される。\r
  55  * </ol>\r
  56  * \r
  57  * <h4>クロージャが絶対に必要な場合</h4>\r
  58  * IE5 ～ IE8 の独自イベントモデルに於いて、イベントオブジェクトに event.currentTarget に相当するものがなく、現在どの HTML 要素でイベントが起こっているか分かりません。<br>\r
  59  * そのため HTML 要素とコールバック関数を束縛するクロージャを使う必要があります。<br>\r
  60  * 参照:『Javascript 第5版』 オライリー p430 17.3.6 attachEvent() と this キーワード<br>\r
  61  * \r
  62  * このほかに IE8 以下と Opera11 以下の XHR ではイベントオブジェクトが用意されないため、eventType が分からない問題があります。このために eventType とコールバック関数を束縛するクロージャが必要です。<br>\r
  63  * \r
  64  * このように、Web ブラウザと javascript の接点では、どうしてもクロージャが必要なケースがあります。<br>\r
  65  * さて、クロージャの使用を最小限に留め、残った僅かなクロージャのメモリリークをチェックし、といくら慎重に開発を行っても、そもそもクロージャが破棄されるのか？ガベージコレクションの怪しいブラウザもあり問題はまだ続きます。\r
  66  * \r
  67  * <h4>再利用可能なクロージャ</h4>\r
  68  * クロージャの使用を最小限にしたうえで、なおかつクロージャがガベージコレクションされない可能性を考慮して、pettanR フレームワークでは再利用可能なクロージャを用意します。<br>\r
  69  * 再利用可能クロージャはフレームワーク内で生成・破棄されるため、ユーザーが直接触ることはありません。しかし debug ツールのコールスタックには登場するため、知識を持っておくことは有益です。<br>\r
  70  * \r
  71  * <h5>再利用可能クロージャの作成</h5>\r
  72  * X_Callback_create() で再利用可能なクロージャの作成。次のパターンで呼び出します。<br>\r
  73  * 最大で三つの引数を並べる一連のパターンは、 EventDispatcher.listen unlisten, listening や X.Timer.add, once でも使われますので、ここでよく目を通しておきます。\r
  74  * \r
  75  * <table>\r
  76  * <tr><th>this コンテキスト+関数<td>X_Callback_create( thisObject, func )<td>func.call( thisObject );\r
  77  * <tr><th>this コンテキスト+関数+追加引数<td>X_Callback_create( thisObject, func, [ arg1, ...args ] )<td>func.apply( thisObject, [ arg1, ...args ] );\r
  78  * <tr><th>listener オブジェクト<td>X_Callback_create( listener )<td>listener.handleEvent(); コールバックに関数でなく handleEvent 関数をメンバに持つオブジェクトを渡すのは NN4 からある javascript のお約束です。\r
  79  * <tr><th>listener オブジェクト+追加引数<td>X_Callback_create( listener, [ arg1, ...args ] )<td>listener.handleEvent.apply( listener, [ arg1, ...args ] );\r
  80  * <tr><th>関数<td>X_Callback_create( func )<td>特別な操作は不要なので再利用可能クロージャは作られません。func をそのまま利用します。\r
  81  * <tr><th>関数+引数<td>X_Callback_create( func, [ arg1, ...args ] )<td>func.apply( ?, [ arg1, ...args ] );\r
  82  * </table>\r
  83  * \r
  84  * <h5>再利用可能クロージャの破棄と再利用</h5>\r
  85  * X_Callback_correct() によってクロージャは回収され再利用に備えます。<br>\r
  86  * 実は、クロージャが束縛するのは、this コンテキストやコールバック関数といった、<strong>そのもの</strong>ではなく、それらを一定のルールで格納したハッシュです。<br>\r
  87  * このハッシュはクロージャに与えた後も、適宜に取得が可能です。このハッシュのメンバーを書き換えることで、クロージャの this コンテキストやコールバック関数を書き換えています。\r
  88  * \r
  89  * @class __CallbackHash__\r
  90  * @classdesc コールバック関数に this コンテキストや、追加の引数を設定するための情報を収めたハッシュです。<br>\r
  91  * フレームワークユーザは直接触ることにはないが、重要な情報なので書いておきます。\r
  92  * @private\r
  93  */\r
  94 var __CallbackHash__ =\r
  95 /** @lends __CallbackHash__.prototype */\r
  96 {\r
  97         /**\r
  98          * コールバックの種類を表す数値。 this + function, this.handleEvent, function only がある。\r
  99          * @type {number} \r
 100          */\r
 101         kind : X_Callback_THIS_FUNC,\r
 102         /**\r
 103          * コールバック。\r
 104          * @type {funciton|undefined} \r
 105          */\r
 106         func : undefined,\r
 107         /**\r
 108          * コールバックの this コンテキスト。 \r
 109          * @type {listener|object|undefined}\r
 110          */\r
 111         context : undefined,\r
 112         /**\r
 113          * コールバックに追加する引数。イベントのコールバックでは event オブジェクトのあとに追加されるため supplement[0] が第一引数にならない点に注意。\r
 114          * @type {Array|undefined}\r
 115          */\r
 116         supplement : undefined,\r
 117         /**\r
 118          * __CallbackHash__ の情報を元に、コールバックを実施するプロキシ。\r
 119          * @type {Function}\r
 120          */\r
 121         proxy : X_Callback_proxyCallback\r
 122 };\r
 123 \r
 124 /**\r
 125  * X.Timer と X.EventDispaｔcher からのコールバックの返り値を定義。\r
 126  * @namespace X.Callback\r
 127  * @alias X.Callback\r
 128  */\r
 129 X.Callback = {\r
 130         /**\r
 131          * このコールバックでは返り値による操作は無い。\r
 132          */\r
 133         'NONE'             : X_Callback_NONE,\r
 134         /**\r
 135          * X.Timer, X.EventDispaｔcher のコールバックでタイマーやイベントリスナの解除に使用。\r
 136          */\r
 137         'UN_LISTEN'        : X_Callback_UN_LISTEN,\r
 138         /**\r
 139          * 上位階層へのイベント伝播のキャンセル。DOM イベントのコールバックの戻り値に指定すると e.stopPropagation() が呼ばれる。\r
 140          */\r
 141         'STOP_PROPAGATION' : X_Callback_STOP_PROPAGATION,\r
 142         /**\r
 143          * 以降のイベントのディスパッチを中断する。STOP_PROPAGATION との違いは、次に控えているコールバックもキャンセルされる点。但し system によって追加されたイベントはキャンセルされない。\r
 144          */\r
 145         'STOP_NOW'         : X_Callback_STOP_NOW,\r
 146         /**\r
 147          * DOM イベントのコールバックの戻り値に指定すると e.preventDefault() が呼ばれる。\r
 148          * またフレームワーク内で定義されたデフォルト動作の回避にも使用される。\r
 149          */\r
 150         'PREVENT_DEFAULT'  : X_Callback_PREVENT_DEFAULT,\r
 151         /**\r
 152          * X.UI に於いて、ポインターイベントの戻り値に指定すると、以降のポインターベントを独占する。\r
 153          */\r
 154         'MONOPOLY'         : X_Callback_MONOPOLY\r
 155 };\r
 156 \r
 157 // ------------------------------------------------------------------------- //\r
 158 // --- implements ---------------------------------------------------------- //\r
 159 // ------------------------------------------------------------------------- //\r
 160 \r
 161 function X_Callback_create( thisObject, opt_callback, opt_args /* [ listener || ( context + function ) || function ][ args... ] */ ){\r
 162         var obj = X_Callback_classifyCallbackArgs( thisObject, opt_callback, opt_args ),\r
 163                 l, ret, _obj;\r
 164         \r
 165         if( !obj.kind ) return obj;\r
 166         \r
 167         if( l = X_Callback_POOL_LIST.length ){\r
 168                 ret  = X_Callback_POOL_LIST[ l - 1 ]; --X_Callback_POOL_LIST.length; // ret = X_Callback_POOL_LIST.pop();\r
 169                 _obj = ret( X_Closure_COMMAND_BACK );\r
 170                 \r
 171                 _obj.kind       = obj.kind;\r
 172                 _obj.func       = obj.func;\r
 173                 _obj.context    = obj.context;\r
 174                 _obj.supplement = obj.supplement;\r
 175                 _obj.proxy      = X_Callback_proxyCallback;\r
 176         } else {\r
 177                 ret             = X_Callback_actualClosure( obj );\r
 178                 obj.proxy       = X_Callback_proxyCallback;\r
 179         };\r
 180         X_Callback_LIVE_LIST[ X_Callback_LIVE_LIST.length ] = ret;\r
 181         return ret;\r
 182 };\r
 183 \r
 184 \r
 185 function X_Callback_classifyCallbackArgs( arg1, arg2, arg3, alt_context ){\r
 186         var obj;\r
 187         \r
 188         if( arg1 && X_Type_isFunction( arg2 ) ){\r
 189                 obj  = { context : arg1, func : arg2, kind : X_Callback_THIS_FUNC };\r
 190         } else\r
 191         if( arg1 && X_Type_isFunction( arg1[ 'handleEvent' ] ) ){\r
 192                 obj  = { context : arg1, kind : X_Callback_HANDLEEVENT };\r
 193                 arg3 = arg2;\r
 194         } else\r
 195         if( X_Type_isFunction( arg1 ) ){\r
 196                 arg3 = arg2;\r
 197                 if( alt_context ){\r
 198                         obj  = { context : alt_context, func : arg1, kind : X_Callback_THIS_FUNC };\r
 199                 } else {\r
 200                         obj  = { func : arg1, kind : X_Callback_FUNC_ONLY };\r
 201                 };\r
 202         } else\r
 203         if( X_Type_isFunction( arg2 ) ){\r
 204                 //console.log( 'X_Callback_classifyCallbackArgs : arg1 が ' + arg1 + 'です' ); ie4 で error\r
 205                 if( alt_context ){\r
 206                         obj  = { context : alt_context, func : arg2, kind : X_Callback_THIS_FUNC };\r
 207                 } else {\r
 208                         obj  = { func : arg2, kind : X_Callback_FUNC_ONLY };\r
 209                 };\r
 210         } else\r
 211         if( alt_context ){\r
 212                 obj  = { context : alt_context, kind : X_Callback_HANDLEEVENT };\r
 213                 arg3 = arg1;\r
 214         } else {\r
 215                 console.log( '不正 ' + arg1 );\r
 216                 console.dir( arg1 );\r
 217                 return;\r
 218         };\r
 219         \r
 220         if( X_Type_isArray( arg3 )){\r
 221                 obj.supplement = arg3;\r
 222         };\r
 223         return ( obj.context || obj.supplement ) ? obj : arg1;\r
 224 };\r
 225 \r
 226 function X_Callback_actualClosure( obj ){\r
 227         return function(){\r
 228                 if( arguments[ 0 ] === X_Closure_COMMAND_BACK ) return obj;\r
 229                 if( arguments[ 0 ] !== X_Closure_COMMAND_DROP ) return obj.proxy( obj, arguments );\r
 230         };\r
 231 };\r
 232 \r
 233 function X_Callback_proxyCallback( xfunc, _args ){\r
 234         var args    = _args || [],\r
 235                 thisObj = xfunc.context,\r
 236                 func    = xfunc.func,\r
 237                 supp    = xfunc.supplement,\r
 238                 temp, ret;      \r
 239         \r
 240         if( supp && supp.length ){\r
 241                 temp = [];\r
 242                 args.length &&\r
 243                         (\r
 244                                 args.length === 1 ?\r
 245                                         ( temp[ 0 ] = args[ 0 ] ) :\r
 246                                         temp.push.apply( temp, args )\r
 247                         );\r
 248                 supp.length === 1 ?\r
 249                         ( temp[ temp.length ] = supp[ 0 ] ) :\r
 250                         temp.push.apply( temp, supp );\r
 251                 args = temp;\r
 252         };\r
 253         \r
 254         switch( xfunc.kind ){\r
 255 \r
 256                 case X_Callback_THIS_FUNC :\r
 257                         return args.length === 0 ? func.call( thisObj ) : func.apply( thisObj, args );\r
 258                         \r
 259                 case X_Callback_HANDLEEVENT :\r
 260                         temp = thisObj[ 'handleEvent' ];\r
 261                         if( X_Type_isFunction( temp ) ){\r
 262                                 return args.length === 0 ? thisObj[ 'handleEvent' ]() :\r
 263                                            args.length === 1 ? thisObj[ 'handleEvent' ]( args[ 0 ] ) : temp.apply( thisObj, args );\r
 264                         };\r
 265                         break;\r
 266                         /*\r
 267                         if( temp !== func && X_Type_isFunction( temp ) ){\r
 268                                 return args.length === 0 ? thisObj[ 'handleEvent' ]() : temp.apply( thisObj, args );\r
 269                         } else\r
 270                         if( X_Type_isFunction( thisObj ) ){\r
 271                                 return args.length === 0 ? thisObj.call( thisObj ) : thisObj.apply( thisObj, args );\r
 272                         };\r
 273                         return args.length === 0 ? func.call( thisObj ) : func.apply( thisObj, args );*/\r
 274                                                 \r
 275                 case X_Callback_FUNC_ONLY :\r
 276                         return args.length === 0 ?\r
 277                                         func() :\r
 278                                 args.length === 1 ?\r
 279                                         func( args[ 0 ] ) :\r
 280                                         func.apply( null, args );\r
 281         };\r
 282         return X_Callback_NONE;\r
 283 };\r
 284 \r
 285 function X_Callback_correct( f ){\r
 286         var i = X_Callback_LIVE_LIST.indexOf( f ),\r
 287                 obj;\r
 288         if( i !== -1 ){\r
 289                 X_Callback_LIVE_LIST.splice( i, 1 );\r
 290                 X_Callback_POOL_LIST[ X_Callback_POOL_LIST.length ] = f;\r
 291                 obj = f( X_Closure_COMMAND_BACK );\r
 292                 delete obj.kind;\r
 293                 if( obj.func ) delete obj.func;\r
 294                 if( obj.context ) delete obj.context;\r
 295                 if( obj.supplement ) delete obj.supplement;\r
 296                 delete obj.proxy;\r
 297                 return true;\r
 298         };\r
 299         return false;\r
 300 };\r
 301 \r
 302 function X_Callback_monitor(){\r
 303         return {\r
 304                 'Callback:Live' : X_Callback_LIVE_LIST.length,\r
 305                 'Callback:Pool' : X_Callback_POOL_LIST.length\r
 306         };\r
 307 };\r
 308 function X_Callback_gc(){\r
 309         X_Callback_POOL_LIST.length = 0; // ?\r
 310 };\r
 311 \r
 312 X_TEMP.onSystemReady.push( function( sys ){\r
 313         sys.monitor( X_Callback_monitor );\r
 314         sys.gc( X_Callback_gc );\r
 315 });\r
 316 \r
 317 \r
 318 console.log( 'X.Core.Callback' );\r
 319 \r