0.6.x/js/01_core/14_XTimer.js

   1 /*\r
   2  * use X.Callback\r
   3  */\r
   4 \r
   5 /*\r
   6  * \r
   7  * http://please-sleep.cou929.nu/script-yielding-with-setimmediate.html\r
   8  * setImmediate での script yielding\r
   9  * \r
  10  * http://ie.microsoft.com/testdrive/Performance/setImmediateSorting/Default.html\r
  11  * setImmediate API\r
  12  * \r
  13  * if( timer < 4ms ) useSetImmediate\r
  14  * \r
  15  *         if (window.msSetImmediate)\r
  16         {\r
  17             this.timer = msSetImmediate(function () { t.stepper(); });        \r
  18         }\r
  19         else if (window.MozSetImmediate)\r
  20         {\r
  21             this.timer = MozSetImmediate(function () { t.stepper(); });        \r
  22         }\r
  23         else if (window.WebkitSetImmediate) {\r
  24             this.timer = WebkitSetImmediate(function () { t.stepper(); });\r
  25         }\r
  26         else if (window.OSetImmediate)\r
  27         {\r
  28             this.timer = OSetImmediate(function () { t.stepper(); });        \r
  29         }\r
  30  */\r
  31 \r
  32 \r
  33 // ------------------------------------------------------------------------- //\r
  34 // ------------ local variables -------------------------------------------- //\r
  35 // ------------------------------------------------------------------------- //\r
  36 \r
  37 var\r
  38 \r
  39         /**\r
  40          * 現在時の ms を返します。 new Date().getTime() の値です。\r
  41          * @alias X.Timer.now\r
  42          * @function\r
  43          * @return {number} ミリ秒\r
  44          */\r
  45         X_Timer_now = Date.now || ( function(){ return +new Date; } ),\r
  46 \r
  47         X_Timer_SET_TIMEOUT   = window.setTimeout,\r
  48         X_Timer_CLEAR_TIMEOUT = window.clearTimeout,\r
  49 \r
  50         // http://uupaa.hatenablog.com/entry/2012/02/01/083607\r
  51         // Firefox 4 partial (request only), Mobile Firefox5 ready (request only), Firefox 11 ready (cancel impl)       \r
  52         X_Timer_REQ_ANIME_FRAME =\r
  53                 window.requestAnimationFrame ||\r
  54                 window.webkitRequestAnimationFrame ||\r
  55                 window.mozRequestAnimationFrame ||\r
  56                 window.oRequestAnimationFrame ||\r
  57                 window.msRequestAnimationFrame ||\r
  58                 false,\r
  59 \r
  60         X_Timer_CANCEL_ANIME_FRAME =\r
  61                 window.cancelRequestAnimationFrame ||\r
  62                 window.webkitCancelAnimationFrame ||\r
  63                 window.webkitCancelRequestAnimationFrame ||\r
  64                 window.mozCancelRequestAnimationFrame ||\r
  65                 window.oCancelRequestAnimationFrame ||\r
  66                 window.msCancelRequestAnimationFrame ||\r
  67                 false,\r
  68                 \r
  69         X_Timer_INTERVAL_TIME  = 16,\r
  70         X_Timer_TICKET_LIST    = [],\r
  71         X_Timer_removal        = null,\r
  72         X_Timer_skipUpdate     = false,\r
  73         X_Timer_uid            = 0,\r
  74         X_Timer_timerId        = 0,\r
  75         X_Timer_busyTimeout    = false,\r
  76         X_Timer_timeStamp      = 0, // setTimeout に登録した時間\r
  77         X_Timer_waitTime       = 0,     // 待ち時間\r
  78         X_Timer_currentUID     = 0, // 現在発火中の uid\r
  79         \r
  80         X_Timer_REQ_FRAME_LIST = [],\r
  81         X_Timer_requestID      = 0,\r
  82         X_Timer_busyOnFrame    = false,\r
  83 \r
  84         /**\r
  85          * requestAnimationFrame をセットします。\r
  86          * @alias X.Timer.requestFrame\r
  87          * @function\r
  88          * @param {*} args1 コールバックのための最大で 3 つの引数を指定します。参考:__CallbackHash__\r
  89          * @param {*} args2\r
  90          * @param {*} args3\r
  91          * @return {number} タイマーID。1 以上の数値。タイマーの解除に使用。\r
  92          */\r
  93         X_Timer_requestFrame = X_Timer_REQ_ANIME_FRAME ?\r
  94                 (function( args1, args2, args3 ){\r
  95                         var i = X_Timer_REQ_FRAME_LIST.length,\r
  96                                 f;\r
  97                         i === 0 && ( X_Timer_requestID = X_Timer_REQ_ANIME_FRAME( X_Timer_onEnterFrame ) );\r
  98                         f = X_Callback_classifyCallbackArgs( args1, args2, args3 );\r
  99                         if( !f.kind ) f = { func : f };\r
 100                         X_Timer_REQ_FRAME_LIST[ i ] = f;\r
 101                         return f.uid = ++X_Timer_uid;\r
 102                 }) :\r
 103                 (function( args1, args2, args3 ){\r
 104                         var i = X_Timer_REQ_FRAME_LIST.length,\r
 105                                 f;\r
 106                         i === 0 && ( X_Timer_requestID = X_Timer_add( 0, 1, X_Timer_onEnterFrame ) );\r
 107                         f = X_Callback_classifyCallbackArgs( args1, args2, args3 );\r
 108                         if( !f.kind ) f = { func : f };\r
 109                         X_Timer_REQ_FRAME_LIST[ i ] = f;\r
 110                         return f.uid = ++X_Timer_uid;\r
 111                 }),\r
 112 \r
 113         /**\r
 114          * requestAnimationFrame を解除します。登録時に受け取ったタイマーIDを使用します。\r
 115          * @alias X.Timer.cancelFrame\r
 116          * @function\r
 117          * @param {number|string} タイマーID, 数字文字の場合もある！\r
 118          * @return {number} 0 が返る\r
 119          * @example if( timerID ) timerID = X.Timer.cancelFrame( timerID );\r
 120          */\r
 121         X_Timer_cancelFrame = X_Timer_CANCEL_ANIME_FRAME ?\r
 122                 (function( uid ){\r
 123                         var list = X_Timer_REQ_FRAME_LIST,\r
 124                                 l    = list.length,\r
 125                                 i    = l,\r
 126                                 f;\r
 127 \r
 128                         if( X_Timer_busyOnFrame ){\r
 129                                 // fire 中の cancel\r
 130                                 if( !X_Timer_removal ) X_Timer_removal = {};\r
 131                                 X_Timer_removal[ uid ] = true;\r
 132                         } else {\r
 133                                 for( ; i; ){\r
 134                                         if( ( f = list[ --i ] ).uid < uid ) break;\r
 135                                         if( f.uid === uid ){\r
 136                                                 list.splice( i, 1 );\r
 137                                                 // gecko では cancelRequestAnimationFrame が無い場合がある\r
 138                                                 l === 1 && X_Timer_CANCEL_ANIME_FRAME && X_Timer_CANCEL_ANIME_FRAME( X_Timer_requestID );\r
 139                                                 break;\r
 140                                         };\r
 141                                 };                              \r
 142                         };\r
 143                         return 0;\r
 144                 }) :\r
 145                 (function( uid ){\r
 146                         var list = X_Timer_REQ_FRAME_LIST,\r
 147                                 l    = list.length,\r
 148                                 i    = l,\r
 149                                 f;\r
 150 \r
 151                         if( X_Timer_busyOnFrame ){\r
 152                                 // fire 中の cancel\r
 153                                 if( !X_Timer_removal ) X_Timer_removal = {};\r
 154                                 X_Timer_removal[ uid ] = true;\r
 155                         } else {\r
 156                                 for( ; i; ){\r
 157                                         if( ( f = list[ --i ] ).uid < uid ) break;\r
 158                                         if( f.uid === uid ){\r
 159                                                 list.splice( i, 1 );\r
 160                                                 l === 1 && X_Timer_remove( X_Timer_requestID );\r
 161                                                 break;\r
 162                                         };\r
 163                                 };\r
 164                         };\r
 165                         return 0;\r
 166                 });\r
 167 \r
 168 \r
 169 // ------------------------------------------------------------------------- //\r
 170 // --- interface ----------------------------------------------------------- //\r
 171 // ------------------------------------------------------------------------- //\r
 172 \r
 173 /**\r
 174  * <p>setTimeout をラップします。複数のタイマーを登録しても Web ブラウザにはひとつのタイマーを登録します。\r
 175  * <p>参考:<a href="http://d.hatena.ne.jp/amachang/20060924/1159084608" target="_blank">複雑で重くなった JavaScript を超高速化する方法３</a>,\r
 176  * <a href="http://d.hatena.ne.jp/sawat/20070329" target="_blank">[JavaScript]setIntervalを実験する</a>\r
 177  * <p>指定時間の経過したタイマーは、より過去のものから順番にコールバックされます。\r
 178  * <p>setTimeout のコールバックに文字列しか指定できないブラウザがあり対策しています。\r
 179  * <p>requestAnimationFrame をラップします。ベンダープレフィックス付の requestAnimationFrame もない場合、setTimeout にフォールバックします。\r
 180  * \r
 181  * @namespace X.Timer\r
 182  * @alias X.Timer\r
 183  */ \r
 184 X[ 'Timer' ] = {\r
 185 \r
 186         'now'          : X_Timer_now,\r
 187         \r
 188         'add'          : X_Timer_add,\r
 189         \r
 190         'once'         : X_Timer_once,\r
 191         \r
 192         'remove'       : X_Timer_remove,\r
 193         \r
 194         'requestFrame' : X_Timer_requestFrame,\r
 195         \r
 196         'cancelFrame'  : X_Timer_cancelFrame\r
 197         \r
 198 };\r
 199 \r
 200 // ------------------------------------------------------------------------- //\r
 201 // --- implements ---------------------------------------------------------- //\r
 202 // ------------------------------------------------------------------------- //\r
 203 \r
 204         /**\r
 205          * タイマーをセットします。\r
 206          * @alias X.Timer.add\r
 207          * @param {number} time ミリ秒\r
 208          * @param {number} opt_count 回数。省略可能。指定回数で自動でタイマーを破棄します。0 を指定した場合無限にタイマーが呼ばれます。省略した場合 0 と同じです。\r
 209          * @param {*} args1 コールバックのための最大で 3 つの引数を指定します。参考:__CallbackHash__\r
 210          * @param {*} args2\r
 211          * @param {*} args3\r
 212          * @return {number} タイマーID。1 以上の数値。タイマーの解除に使用。\r
 213          * @example timerID = X.Timer.add( 1000, 5, thisContext, onTimer );\r
 214          */\r
 215         function X_Timer_add( time, opt_count, args1, args2, args3 ){\r
 216                 var list = X_Timer_TICKET_LIST,\r
 217                         hash, obj;\r
 218                 time = time < X_Timer_INTERVAL_TIME ? 1 : time / X_Timer_INTERVAL_TIME | 0; // 正の数で使える「Math.floor(x)」を「(x | 0)」に;\r
 219                 \r
 220                 if( !X_Type_isNumber( opt_count ) ){\r
 221                         args3 = args2;\r
 222                         args2 = args1;\r
 223                         args1 = opt_count;\r
 224                         opt_count = 0;\r
 225                 };\r
 226                 \r
 227                 hash = X_Callback_classifyCallbackArgs( args1, args2, args3 );\r
 228                 if( !hash ) return -1; // dev only\r
 229                 \r
 230                 if( !hash.kind ) hash = { func : hash };\r
 231                 hash.time  = time;\r
 232                 hash.last  = time;\r
 233                 hash.count = opt_count;\r
 234                 hash.uid   = ++X_Timer_uid;\r
 235                 list[ list.length ] = hash;\r
 236                 \r
 237             !X_Timer_busyTimeout && X_Timer_update();\r
 238             return X_Timer_uid;\r
 239         };\r
 240         \r
 241         /**\r
 242          * 1 回呼ばれたら解除されるタイマーをセットします。\r
 243          * @alias X.Timer.once\r
 244          * @param {number} time ミリ秒\r
 245          * @param {*} args1 コールバックのための最大で 3 つの引数を指定します。参考:__CallbackHash__\r
 246          * @param {*} args2\r
 247          * @param {*} args3\r
 248          * @return {number} タイマーID。1 以上の数値。タイマーの解除に使用。\r
 249          */\r
 250         function X_Timer_once( time, args1, args2, args3 ){\r
 251                 return X_Timer_add( time, 1, args1, args2, args3 );\r
 252         };\r
 253         \r
 254         /**\r
 255          * タイマーを解除します。登録時に受け取ったタイマーIDを使用します。\r
 256          * @alias X.Timer.remove\r
 257          * @param {number} タイマーID\r
 258          * @return {number} 0 が返る\r
 259          * @example if( timerID ) timerID = X.Timer.remove( timerID );\r
 260          */\r
 261         function X_Timer_remove( uid ){\r
 262                 var list = X_Timer_TICKET_LIST,\r
 263                         i    = list.length,\r
 264                         l    = i,\r
 265                         f, q, eventDispatcher, lazy, listeners;\r
 266                 \r
 267                 if( X_Timer_busyTimeout ){\r
 268                         // fire 中の cancel\r
 269                         if( !X_Timer_removal ) X_Timer_removal = {};\r
 270                         X_Timer_removal[ uid ] = true;\r
 271                 } else {\r
 272                         for( ; i; ){\r
 273                                 if( ( q = list[ --i ] ).uid === uid ){\r
 274                                         list.splice( i, 1 );\r
 275                                         \r
 276                                         /*\r
 277                                          * lazyDispatch 中の EventDispatcher の有無を調べる\r
 278                                          */\r
 279                                         if( X_EventDispatcher_LAZY_TIMERS[ uid ] ){\r
 280                                                 delete X_EventDispatcher_LAZY_TIMERS[ uid ];\r
 281                                         };\r
 282                                         \r
 283                                         !X_Timer_skipUpdate && ( q.last <= X_Timer_waitTime || l === 1 ) && X_Timer_update();\r
 284                                         break;\r
 285                                 };\r
 286                         };                              \r
 287                 };\r
 288                 return 0;\r
 289         };\r
 290 \r
 291 if( X_UA[ 'IE4' ] || X_UA[ 'MacIE' ] ){\r
 292         X.Timer[ '_' ] = X_Timer_onTimeout;\r
 293         X_Timer_onTimeout = 'X.Timer._()';\r
 294 };\r
 295 \r
 296 function X_Timer_onTimeout(){\r
 297         var now   = X_Timer_now(),\r
 298                 minus = ( ( now - X_Timer_timeStamp ) / X_Timer_INTERVAL_TIME | 0 ) || 1,\r
 299                 list  = X_Timer_TICKET_LIST,\r
 300                 i     = 0,\r
 301                 l     = list.length,\r
 302                 limit = now + X_Timer_INTERVAL_TIME / 2,\r
 303                 heavy,\r
 304                 q, f, c, r, uid;\r
 305         \r
 306         //console.log( '予定時間と発火時間の差:' + ( now - X_Timer_timeStamp - X_Timer_waitTime * X_Timer_INTERVAL_TIME ) + ' -:' + minus + ' next:' + X_Timer_waitTime );\r
 307         \r
 308         if( X_Timer_busyTimeout ){\r
 309                 alert( 'X_Timer_busyTimeout フラグが立ったまま!エラーの可能性' );\r
 310         };\r
 311         \r
 312         X_Timer_busyTimeout = true;\r
 313         \r
 314     for( ; i < l; ++i ){\r
 315         q = list[ i ];\r
 316         if(\r
 317                 ( X_Timer_removal && X_Timer_removal[ q.uid ] ) || // timerId は remove 登録されている\r
 318                         0 < ( q.last -= minus ) || // 時間が経過していない\r
 319                         heavy && ( q.last = 1 ) // 時間は経過したが、ヘビーフラグが立っている\r
 320                 ){\r
 321                         continue;\r
 322                 };\r
 323                 c = q.count;\r
 324                 \r
 325                 X_Timer_currentUID = q.uid;\r
 326                 \r
 327                 if( q.kind ){\r
 328                         r = X_Callback_proxyCallback( q, [] );\r
 329                 } else {\r
 330                         r = q.func();\r
 331                 };\r
 332                 \r
 333                 //console.log( 'fire....' );\r
 334                 \r
 335                 if( limit <= X_Timer_now() ){\r
 336                         //console.log( '******* heavy!' );\r
 337                         // 関数の実行に時間がかかる場合、次のタイミングに\r
 338                         heavy = true;\r
 339                 };\r
 340                 \r
 341                 if( r & X_Callback_UN_LISTEN || c === 1 ){\r
 342                         list.splice( i, 1 );\r
 343                         --i;\r
 344                         --l;\r
 345                         continue;\r
 346                 } else\r
 347                 if( 1 < c ) --q.count;\r
 348                 q.last = q.time;\r
 349     };\r
 350     X_Timer_timerId     = X_Timer_currentUID = 0;\r
 351     X_Timer_busyTimeout = false;\r
 352     \r
 353     if( X_Timer_removal ){\r
 354         X_Timer_skipUpdate = true;\r
 355         for( uid in X_Timer_removal ){\r
 356                 //if( X_EMPTY_OBJECT[ uid ] ) continue;\r
 357                 X_Timer_remove( uid );\r
 358         };\r
 359         X_Timer_skipUpdate = false;\r
 360         X_Timer_removal = null;\r
 361     };\r
 362     X_Timer_update();\r
 363 };\r
 364 \r
 365 function X_Timer_update(){\r
 366         var list = X_Timer_TICKET_LIST,\r
 367                 i    = list.length,\r
 368                 n;\r
 369         if( i === 0 ){\r
 370                 X_Timer_timerId && X_Timer_CLEAR_TIMEOUT( X_Timer_timerId );\r
 371                 X_Timer_timerId = 0;\r
 372                 return;\r
 373         };\r
 374         \r
 375         1 < i && list.sort( X_Timer_compareQueue );\r
 376         \r
 377     n = list[ i - 1 ].last;\r
 378     \r
 379     if( n < X_Timer_waitTime || X_Timer_timerId === 0 ){\r
 380         if( X_Timer_timerId ){\r
 381                 X_Timer_CLEAR_TIMEOUT( X_Timer_timerId );\r
 382                 n -= ( X_Timer_now() - X_Timer_timeStamp ) / X_Timer_INTERVAL_TIME | 0;\r
 383                 0 <= n || ( n = 0 ); // 負の数は 0 に\r
 384         };\r
 385         X_Timer_timeStamp = X_Timer_now();\r
 386         X_Timer_timerId   = X_Timer_SET_TIMEOUT( X_Timer_onTimeout, X_Timer_INTERVAL_TIME * n );\r
 387         X_Timer_waitTime  = n;\r
 388     };\r
 389 };\r
 390 \r
 391 // 大きい -> 小さい\r
 392 function X_Timer_compareQueue( a, b ){\r
 393         return a.last < b.last ? 1 : a.last === b.last ? 0 : -1;\r
 394 };\r
 395 \r
 396 // http://havelog.ayumusato.com/develop/javascript/e528-ios6_scrolling_timer_notcall.html\r
 397 // iOS6 スクロール中のタイマー発火絡みのバグ備忘\r
 398 if( X_UA[ 'iOS' ] ){\r
 399         window.addEventListener( 'scroll', function(){\r
 400                 var last, now;\r
 401                 if( X_Timer_timerId ){\r
 402                         X_Timer_CLEAR_TIMEOUT( X_Timer_timerId );\r
 403                         now               = X_Timer_now();\r
 404                         last              = X_Timer_timeStamp + X_Timer_INTERVAL_TIME * X_Timer_waitTime - now;\r
 405                         X_Timer_timerId   = X_Timer_SET_TIMEOUT( X_Timer_onTimeout, 0 < last ? last : 0 );\r
 406                         // 更新\r
 407                         X_Timer_timeStamp = now;\r
 408                         X_Timer_waitTime  = last / X_Timer_INTERVAL_TIME | 0;\r
 409                 };\r
 410         });\r
 411 };\r
 412 \r
 413 \r
 414 // ページを読み込んでからの時間\r
 415 function X_Timer_onEnterFrame( time ){\r
 416         var list = X_Timer_REQ_FRAME_LIST,\r
 417                 l    = list.length,\r
 418                 i    = 0, q, uid, args;\r
 419 \r
 420         time = time || X_Timer_now();\r
 421         X_Timer_busyOnFrame = true;\r
 422         // console.log( X_Timer_now() + ' , ' + time );\r
 423     for( ; i < l; ++i ){\r
 424         q = list[ i ];\r
 425         \r
 426         if( X_Timer_removal && X_Timer_removal[ q.uid ] ) continue;\r
 427         \r
 428                 if( q.kind ){\r
 429                         X_Callback_proxyCallback( q, args || ( args = [ time ] ) );\r
 430                 } else {\r
 431                         q.func( time );\r
 432                 };\r
 433     };\r
 434 \r
 435     list.splice( 0, l );\r
 436     if( list.length ){\r
 437         X_Timer_requestID = X_Timer_REQ_ANIME_FRAME ? X_Timer_REQ_ANIME_FRAME( X_Timer_onEnterFrame ) : X_Timer_add( 0, 1, X_Timer_onEnterFrame );\r
 438     };\r
 439     \r
 440     X_Timer_busyOnFrame = false;\r
 441     if( X_Timer_removal ){\r
 442         for( uid in X_Timer_removal ){\r
 443                 //if( X_EMPTY_OBJECT[ uid ] ) continue;\r
 444                 X_Timer_cancelFrame( X_Timer_removal[ uid ] );\r
 445         };\r
 446         X_Timer_removal = null;\r
 447     };\r
 448 };\r
 449 \r
 450 console.log( 'X.Core.Timer' );\r