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