OSDN Git Service

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