Class: TkTimer
Constant Summary
collapse
- TkCommandNames =
['after'.freeze].freeze
- Tk_CBTBL =
TkUtil.untrust({})
- DEFAULT_IGNORE_EXCEPTIONS =
[ NameError, RuntimeError ].freeze
Constants included
from TkCore
TkCore::EventFlag, TkCore::INTERP, TkCore::INTERP_MUTEX, TkCore::INTERP_ROOT_CHECK, TkCore::INTERP_THREAD, TkCore::INTERP_THREAD_STATUS, TkCore::RUN_EVENTLOOP_ON_MAIN_THREAD, TkCore::WIDGET_DESTROY_HOOK, TkCore::WITH_ENCODING, TkCore::WITH_RUBY_VM
Constants included
from TkComm
TkComm::GET_CONFIGINFO_AS_ARRAY, TkComm::GET_CONFIGINFOwoRES_AS_ARRAY, TkComm::TkExtlibAutoloadModule, TkComm::Tk_CMDTBL, TkComm::Tk_IDs, TkComm::Tk_WINDOWS, TkComm::USE_TCLs_LIST_FUNCTIONS, TkComm::WidgetClassNames
Constants included
from TkUtil
TkUtil::None, TkUtil::RELEASE_DATE
Instance Attribute Summary collapse
Class Method Summary
collapse
Instance Method Summary
collapse
-
#add_procs(*procs) ⇒ Object
-
#at_end(*arg, &b) ⇒ Object
-
#cancel ⇒ Object
(also: #stop)
-
#cancel_on_exception=(mode) ⇒ Object
-
#cancel_on_exception? ⇒ Boolean
-
#cb_call ⇒ Object
-
#continue(wait = nil) ⇒ Object
-
#current_status ⇒ Object
-
#delete_at(n) ⇒ Object
-
#delete_procs(*procs) ⇒ Object
-
#do_callback ⇒ Object
-
#eventloop_tkwait ⇒ Object
-
#eventloop_wait(check_root = false) ⇒ Object
-
#get_procs ⇒ Object
-
#info ⇒ Object
-
#initialize(*args, &b) ⇒ TkTimer
constructor
A new instance of TkTimer.
-
#loop_rest ⇒ Object
-
#loop_rest=(rest) ⇒ Object
-
#reset(*reset_args) ⇒ Object
-
#restart(*restart_args, &b) ⇒ Object
-
#running? ⇒ Boolean
-
#set_callback(sleep, args = nil) ⇒ Object
-
#set_interval(interval) ⇒ Object
-
#set_next_callback(args) ⇒ Object
-
#set_procs(interval, loop_exec, *procs) ⇒ Object
-
#set_start_proc(sleep = nil, init_proc = nil, *init_args, &b) ⇒ Object
-
#skip ⇒ Object
-
#start(*init_args, &b) ⇒ Object
-
#thread_tkwait ⇒ Object
-
#thread_wait(check_root = false) ⇒ Object
-
#tkwait(on_thread = true) ⇒ Object
-
#wait(on_thread = true, check_root = false) ⇒ Object
Methods included from TkCore
_tk_call_to_list_core, after, after_cancel, after_idle, appname, appsend, appsend_deny, appsend_displayof, callback_break, callback_continue, callback_return, chooseColor, chooseDirectory, do_one_event, event_generate, getMultipleOpenFile, getMultipleSaveFile, getOpenFile, getSaveFile, get_eventloop_tick, get_eventloop_weight, get_no_event_wait, inactive, inactive_displayof, ip_eval, ip_eval_with_enc, ip_eval_without_enc, ip_invoke, ip_invoke_with_enc, ip_invoke_without_enc, is_mainloop?, load_cmd_on_ip, mainloop, mainloop_exist?, mainloop_thread?, mainloop_watchdog, messageBox, rb_appsend, rb_appsend_displayof, reset_inactive, reset_inactive_displayof, scaling, scaling_displayof, set_eventloop_tick, set_eventloop_weight, set_no_event_wait, tk_call, tk_call_to_list, tk_call_to_list_with_enc, tk_call_to_list_without_enc, tk_call_to_simplelist, tk_call_to_simplelist_with_enc, tk_call_to_simplelist_without_enc, tk_call_with_enc, tk_call_without_enc, windowingsystem
Methods included from TkComm
_at, _callback_entry?, _callback_entry_class?, _curr_cmd_id, _fromUTF8, _genobj_for_tkwidget, _next_cmd_id, _toUTF8, array2tk_list, #bind, #bind_all, #bind_append, #bind_append_all, #bind_remove, #bind_remove_all, #bindinfo, #bindinfo_all, bool, image_obj, #install_cmd, install_cmd, list, num_or_nil, num_or_str, number, procedure, simplelist, slice_ary, string, #subst, tk_tcl2ruby, uninstall_cmd, #uninstall_cmd, window
Methods included from TkEvent
#install_bind, #install_bind_for_event_class
Methods included from TkUtil
_conv_args, #_conv_args, #_fromUTF8, #_get_eval_enc_str, _get_eval_enc_str, #_get_eval_string, _get_eval_string, _symbolkey2str, #_symbolkey2str, #_toUTF8, bool, #bool, eval_cmd, #hash_kv, hash_kv, install_cmd, num_or_nil, #num_or_nil, num_or_str, #num_or_str, number, #number, string, #string, uninstall_cmd, untrust
Constructor Details
#initialize(*args, &b) ⇒ TkTimer
Returns a new instance of TkTimer.
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
# File 'lib/tk/timer.rb', line 147
def initialize(*args, &b)
Tk_CBID.mutex.synchronize{
@id = Tk_CBID.join(TkCore::INTERP._ip_id_)
Tk_CBID[1].succ!
}
@wait_var = TkVariable.new(0)
@at_end_proc = nil
@cb_cmd = TkCore::INTERP.get_cb_entry(self.method(:do_callback))
@set_next = true
@init_sleep = 0
@init_proc = nil
@init_args = []
@current_script = []
@current_proc = nil
@current_args = nil
@return_value = nil
@sleep_time = 0
@current_sleep = 0
@loop_exec = 0
@do_loop = 0
@loop_proc = []
@proc_max = 0
@current_pos = 0
@after_id = nil
@after_script = nil
@cancel_on_exception = DEFAULT_IGNORE_EXCEPTIONS
if b
case args.size
when 0
add_procs(b)
when 1
args << -1 << b
else
args << b
end
end
set_procs(*args) if args != []
@running = false
@in_callback = false
end
|
Instance Attribute Details
Returns the value of attribute after_id
207
208
209
|
# File 'lib/tk/timer.rb', line 207
def after_id
@after_id
end
|
#after_script ⇒ Object
Returns the value of attribute after_script
208
209
210
|
# File 'lib/tk/timer.rb', line 208
def after_script
@after_script
end
|
#current_args ⇒ Object
Returns the value of attribute current_args
210
211
212
|
# File 'lib/tk/timer.rb', line 210
def current_args
@current_args
end
|
#current_proc ⇒ Object
Returns the value of attribute current_proc
209
210
211
|
# File 'lib/tk/timer.rb', line 209
def current_proc
@current_proc
end
|
#current_sleep ⇒ Object
Also known as:
current_interval
Returns the value of attribute current_sleep
211
212
213
|
# File 'lib/tk/timer.rb', line 211
def current_sleep
@current_sleep
end
|
#loop_exec ⇒ Object
Returns the value of attribute loop_exec
215
216
217
|
# File 'lib/tk/timer.rb', line 215
def loop_exec
@loop_exec
end
|
#return_value ⇒ Object
Returns the value of attribute return_value
213
214
215
|
# File 'lib/tk/timer.rb', line 213
def return_value
@return_value
end
|
Class Method Details
.callback(obj_id) ⇒ Object
39
40
41
42
43
|
# File 'lib/tk/timer.rb', line 39
def self.callback(obj_id)
ex_obj = Tk_CBTBL[obj_id]
return "" if ex_obj == nil; ex_obj.cb_call
end
|
.info(obj = nil) ⇒ Object
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
|
# File 'lib/tk/timer.rb', line 45
def self.info(obj = nil)
if obj
if obj.kind_of?(TkTimer)
if obj.after_id
inf = tk_split_list(tk_call_without_enc('after','info',obj.after_id))
[Tk_CBTBL[inf[0][1]], inf[1]]
else
nil
end
else
fail ArgumentError, "TkTimer object is expected"
end
else
tk_call_without_enc('after', 'info').split(' ').collect!{|id|
ret = Tk_CBTBL.find{|key,val| val.after_id == id}
(ret == nil)? id: ret[1]
}
end
end
|
.start(*args, &b) ⇒ Object
35
36
37
|
# File 'lib/tk/timer.rb', line 35
def self.start(*args, &b)
self.new(*args, &b).start
end
|
Instance Method Details
#add_procs(*procs) ⇒ Object
312
313
314
315
316
317
318
319
320
321
322
323
324
|
# File 'lib/tk/timer.rb', line 312
def add_procs(*procs)
procs.each{|e|
if TkComm._callback_entry?(e)
@loop_proc.push([e])
else
@loop_proc.push(e)
end
}
@proc_max = @loop_proc.size
self
end
|
#at_end(*arg, &b) ⇒ Object
485
486
487
488
489
490
491
492
493
494
495
496
497
498
|
# File 'lib/tk/timer.rb', line 485
def at_end(*arg, &b)
if arg.empty?
if b
@at_end_proc = b
else
return @at_end_proc
end
else
fail ArgumentError, "wrong number of arguments" if arg.length != 1 || b
@at_end_proc = arg[0]
end
self
end
|
#cancel ⇒ Object
Also known as:
stop
438
439
440
441
442
443
444
445
446
447
|
# File 'lib/tk/timer.rb', line 438
def cancel
@running = false
__at_end__
tk_call 'after', 'cancel', @after_id if @after_id
@after_id = nil
Tk_CBTBL.delete(@id) ; self
end
|
#cancel_on_exception=(mode) ⇒ Object
240
241
242
243
244
245
246
247
248
249
|
# File 'lib/tk/timer.rb', line 240
def cancel_on_exception=(mode)
if mode.kind_of?(Array)
@cancel_on_exception = mode
elsif mode
@cancel_on_exception = DEFAULT_IGNORE_EXCEPTIONS
else
@cancel_on_exception = false
end
end
|
#cancel_on_exception? ⇒ Boolean
236
237
238
|
# File 'lib/tk/timer.rb', line 236
def cancel_on_exception?
@cancel_on_exception
end
|
223
224
225
|
# File 'lib/tk/timer.rb', line 223
def cb_call
@cb_cmd.call
end
|
#continue(wait = nil) ⇒ Object
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
|
# File 'lib/tk/timer.rb', line 450
def continue(wait=nil)
fail RuntimeError, "is already running" if @running
return restart() if @current_script.empty?
sleep, cmd = @current_script
fail RuntimeError, "no procedure to continue" unless cmd
if wait
unless wait.kind_of?(Integer)
fail ArgumentError, "expect Integer for 1st argument"
end
sleep = wait
end
Tk_CBTBL[@id] = self
@running = true
@after_id = tk_call_without_enc('after', sleep, cmd)
self
end
|
#current_status ⇒ Object
231
232
233
234
|
# File 'lib/tk/timer.rb', line 231
def current_status
[@running, @current_sleep, @current_proc, @current_args,
@do_loop, @cancel_on_exception]
end
|
#delete_at(n) ⇒ Object
342
343
344
345
346
347
|
# File 'lib/tk/timer.rb', line 342
def delete_at(n)
@loop_proc.delete_at(n)
@proc_max = @loop_proc.size
cancel if @proc_max == 0
self
end
|
#delete_procs(*procs) ⇒ Object
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
|
# File 'lib/tk/timer.rb', line 326
def delete_procs(*procs)
procs.each{|e|
if TkComm._callback_entry?(e)
@loop_proc.delete([e])
else
@loop_proc.delete(e)
end
}
@proc_max = @loop_proc.size
cancel if @proc_max == 0
self
end
|
#do_callback ⇒ Object
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
|
# File 'lib/tk/timer.rb', line 69
def do_callback
@in_callback = true
@after_id = nil
begin
@return_value = @current_proc.call(self)
rescue SystemExit
exit(0)
rescue Interrupt
exit!(1)
rescue Exception => e
if @cancel_on_exception &&
@cancel_on_exception.find{|exc| e.kind_of?(exc)}
cancel
@return_value = e
@in_callback = false
return e
else
fail e
end
end
if @set_next
set_next_callback(@current_args)
else
@set_next = true
end
@in_callback = false
@return_value
end
|
#eventloop_tkwait ⇒ Object
529
530
531
|
# File 'lib/tk/timer.rb', line 529
def eventloop_tkwait
wait(false, true)
end
|
#eventloop_wait(check_root = false) ⇒ Object
520
521
522
|
# File 'lib/tk/timer.rb', line 520
def eventloop_wait(check_root = false)
wait(false, check_root)
end
|
#get_procs ⇒ Object
227
228
229
|
# File 'lib/tk/timer.rb', line 227
def get_procs
[@init_sleep, @init_proc, @init_args, @sleep_time, @loop_exec, @loop_proc]
end
|
476
477
478
479
480
481
482
483
|
# File 'lib/tk/timer.rb', line 476
def info
if @after_id
inf = tk_split_list(tk_call_without_enc('after', 'info', @after_id))
[Tk_CBTBL[inf[0][1]], inf[1]]
else
nil
end
end
|
#loop_rest ⇒ Object
255
256
257
|
# File 'lib/tk/timer.rb', line 255
def loop_rest
@do_loop
end
|
#loop_rest=(rest) ⇒ Object
259
260
261
262
|
# File 'lib/tk/timer.rb', line 259
def loop_rest=(rest)
@do_loop = rest
end
|
#reset(*reset_args) ⇒ Object
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
|
# File 'lib/tk/timer.rb', line 411
def reset(*reset_args)
restart() if @running
if @init_proc
@return_value = @init_proc.call(self)
else
@return_value = nil
end
@current_pos = 0
@current_args = @init_args
@current_script = []
@set_next = false if @in_callback
self
end
|
#restart(*restart_args, &b) ⇒ Object
429
430
431
432
433
434
435
436
|
# File 'lib/tk/timer.rb', line 429
def restart(*restart_args, &b)
cancel if @running
if restart_args.empty? && !b
start(@init_sleep, @init_proc, *@init_args)
else
start(*restart_args, &b)
end
end
|
#running? ⇒ Boolean
251
252
253
|
# File 'lib/tk/timer.rb', line 251
def running?
@running
end
|
#set_callback(sleep, args = nil) ⇒ Object
98
99
100
101
102
103
104
105
106
107
108
|
# File 'lib/tk/timer.rb', line 98
def set_callback(sleep, args=nil)
if TkCore::INTERP.deleted?
self.cancel
return self
end
@after_script = "rb_after #{@id}"
@current_args = args
@current_script = [sleep, @after_script]
@after_id = tk_call_without_enc('after', sleep, @after_script)
self
end
|
#set_interval(interval) ⇒ Object
264
265
266
267
268
269
270
271
272
|
# File 'lib/tk/timer.rb', line 264
def set_interval(interval)
if interval != 'idle' && interval != :idle \
&& !interval.kind_of?(Integer) && !TkComm._callback_entry?(interval)
fail ArgumentError, "expect Integer or Proc"
end
@sleep_time = interval
end
|
#set_next_callback(args) ⇒ Object
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
# File 'lib/tk/timer.rb', line 110
def set_next_callback(args)
if @running == false || @proc_max == 0 || @do_loop == 0
Tk_CBTBL.delete(@id) ; @running = false
__at_end__
return
end
if @current_pos >= @proc_max
if @do_loop < 0 || (@do_loop -= 1) > 0
@current_pos = 0
else
Tk_CBTBL.delete(@id) ; @running = false
__at_end__
return
end
end
@current_args = args
if TkComm._callback_entry?(@sleep_time)
sleep = @sleep_time.call(self)
else
sleep = @sleep_time
end
@current_sleep = sleep
cmd, *cmd_args = @loop_proc[@current_pos]
@current_pos += 1
@current_proc = cmd
set_callback(sleep, cmd_args)
end
|
#set_procs(interval, loop_exec, *procs) ⇒ Object
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
|
# File 'lib/tk/timer.rb', line 274
def set_procs(interval, loop_exec, *procs)
if interval != 'idle' && interval != :idle \
&& !interval.kind_of?(Integer) && !TkComm._callback_entry?(interval)
fail ArgumentError, "expect Integer or Proc for 1st argument"
end
@sleep_time = interval
@loop_proc = []
procs.each{|e|
if TkComm._callback_entry?(e)
@loop_proc.push([e])
else
@loop_proc.push(e)
end
}
@proc_max = @loop_proc.size
@current_pos = 0
if loop_exec.kind_of?(Integer) && loop_exec < 0
@loop_exec = -1
elsif loop_exec == true
@loop_exec = -1
elsif loop_exec == nil || loop_exec == false || loop_exec == 0
@loop_exec = 0
else
if not loop_exec.kind_of?(Integer)
fail ArgumentError, "expect Integer for 2nd argument"
end
@loop_exec = loop_exec
end
@do_loop = @loop_exec
self
end
|
#set_start_proc(sleep = nil, init_proc = nil, *init_args, &b) ⇒ Object
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
|
# File 'lib/tk/timer.rb', line 349
def set_start_proc(sleep=nil, init_proc=nil, *init_args, &b)
sleep = @init_sleep unless sleep
if sleep != 'idle' && sleep != :idle && !sleep.kind_of?(Integer)
fail ArgumentError, "expect Integer or 'idle' for 1st argument"
end
@init_sleep = sleep
@init_proc = init_proc
@init_args = init_args
@init_proc = b if !@init_proc && b
@init_proc = proc{|*args| } if @init_sleep > 0 && !@init_proc
self
end
|
467
468
469
470
471
472
473
474
|
# File 'lib/tk/timer.rb', line 467
def skip
fail RuntimeError, "is not running now" unless @running
cancel
Tk_CBTBL[@id] = self
@running = true
set_next_callback(@current_args)
self
end
|
#start(*init_args, &b) ⇒ Object
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
|
# File 'lib/tk/timer.rb', line 367
def start(*init_args, &b)
return nil if @running
Tk_CBTBL[@id] = self
@do_loop = @loop_exec
@current_pos = 0
@return_value = nil
@after_id = nil
@init_sleep = 0
@init_proc = nil
@init_args = nil
argc = init_args.size
if argc > 0
sleep = init_args.shift
if sleep != 'idle' && sleep != :idle && !sleep.kind_of?(Integer)
fail ArgumentError, "expect Integer or 'idle' for 1st argument"
end
@init_sleep = sleep
end
@init_proc = init_args.shift if argc > 1
@init_args = init_args if argc > 2
@init_proc = b if !@init_proc && b
@init_proc = proc{|*args| } if @init_sleep > 0 && !@init_proc
@current_sleep = @init_sleep
@running = true
if @init_proc
if !TkComm._callback_entry?(@init_proc)
fail ArgumentError, "Argument '#{@init_proc}' need to be Proc"
end
@current_proc = @init_proc
set_callback(@init_sleep, @init_args)
@set_next = false if @in_callback
else
set_next_callback(@init_args)
end
self
end
|
#thread_tkwait ⇒ Object
532
533
534
|
# File 'lib/tk/timer.rb', line 532
def thread_tkwait
wait(true, true)
end
|
#thread_wait(check_root = false) ⇒ Object
523
524
525
|
# File 'lib/tk/timer.rb', line 523
def thread_wait(check_root = false)
wait(true, check_root)
end
|
#tkwait(on_thread = true) ⇒ Object
526
527
528
|
# File 'lib/tk/timer.rb', line 526
def tkwait(on_thread = true)
wait(on_thread, true)
end
|
#wait(on_thread = true, check_root = false) ⇒ Object
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
|
# File 'lib/tk/timer.rb', line 500
def wait(on_thread = true, check_root = false)
if $SAFE >= 4
fail SecurityError, "can't wait timer at $SAFE >= 4"
end
unless @running
if @return_value.kind_of?(Exception)
fail @return_value
else
return @return_value
end
end
@wait_var.wait(on_thread, check_root)
if @return_value.kind_of?(Exception)
fail @return_value
else
@return_value
end
end
|