Module: TkComm

Extended by:
TkEvent, TkUtil
Includes:
TkEvent, TkUtil
Included in:
Tk::Tcllib::Crosshair, TkCore, TkCore, TkHTML_File_Viewer, TkValidateCommand, TkValidateCommand, TkcTagAccess
Defined in:
lib/tk.rb,
lib/tk.rb

Overview

define TkComm module (step 2: event binding)

Constant Summary collapse

WidgetClassNames = 
TkUtil.untrust({})
TkExtlibAutoloadModule = 
TkUtil.untrust([])
Tk_IDs =

Tk_CMDTBL = {} Tk_WINDOWS = {}

[
  TkUtil.untrust("00000"), # [0]-cmdid
  TkUtil.untrust("00000")  # [1]-winid
]
Tk_CMDTBL =

for backward compatibility

Object.new
Tk_WINDOWS = 
Object.new
GET_CONFIGINFO_AS_ARRAY =

GET_CONFIGINFO_AS_ARRAY = false => returns a Hash { opt =>val, … }

true  => returns an Array [[opt,val], ... ]

val is a list which includes resource info.

true
GET_CONFIGINFOwoRES_AS_ARRAY =

for configinfo without resource info; list of [opt, value] pair

false => returns a Hash { opt=>val, ... }
true  => returns an Array [[opt,val], ... ]

true
USE_TCLs_LIST_FUNCTIONS = 
true

Constants included from TkUtil

TkUtil::None, TkUtil::RELEASE_DATE

Class Method Summary collapse

Instance Method Summary collapse

Methods included from TkEvent

install_bind, install_bind_for_event_class

Methods included from TkUtil

_conv_args, _conv_args, _get_eval_enc_str, _get_eval_enc_str, _get_eval_string, _get_eval_string, _symbolkey2str, _symbolkey2str, callback, eval_cmd, hash_kv, hash_kv, untrust

Class Method Details

._at(x, y = nil) ⇒ Object 



222
223
224
225
226
227
228
 
# File 'lib/tk.rb', line 222

def _at(x,y=nil)
  if y
    "@#{Integer(x)},#{Integer(y)}"
  else
    "@#{Integer(x)}"
  end
end

._callback_entry?(obj) ⇒ Boolean

Returns:

  • (Boolean) 


690
691
692
 
# File 'lib/tk.rb', line 690

def _callback_entry?(obj)
  obj.kind_of?(Proc) || obj.kind_of?(Method) || obj.kind_of?(TkCallbackEntry)
end

._callback_entry_class?(cls) ⇒ Boolean

Returns:

  • (Boolean) 


684
685
686
 
# File 'lib/tk.rb', line 684

def _callback_entry_class?(cls)
  cls <= Proc || cls <= Method || cls <= TkCallbackEntry
end

._curr_cmd_id ⇒ Object

### –> definition is moved to TkUtil module

def _conv_args(args, enc_mode, *src_args)
  conv_args = []
  src_args.each{|arg|
    conv_args << _get_eval_string(arg, enc_mode) unless arg == None
    # if arg.kind_of?(Hash)
    # arg.each{|k, v|
    #   args << '-' + k.to_s
    #   args << _get_eval_string(v, enc_mode)
    # }
    # elsif arg != None
    #   args << _get_eval_string(arg, enc_mode)
    # end
  }
  args + conv_args
end
private :_conv_args



819
820
821
822
 
# File 'lib/tk.rb', line 819

def _curr_cmd_id
  #id = format("c%.4d", Tk_IDs[0])
  id = "c" + TkCore::INTERP._ip_id_ + TkComm::Tk_IDs[0]
end

._fromUTF8(str, encoding = nil) ⇒ Object 



678
679
680
 
# File 'lib/tk.rb', line 678

def _fromUTF8(str, encoding = nil)
  TkCore::INTERP._fromUTF8(str, encoding)
end

._genobj_for_tkwidget(path) ⇒ Object 



106
107
108
109
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
146
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
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/tk.rb', line 106

def _genobj_for_tkwidget(path)
  return TkRoot.new if path == '.'

  begin
    #tk_class = TkCore::INTERP._invoke('winfo', 'class', path)
    tk_class = Tk.ip_invoke_without_enc('winfo', 'class', path)
  rescue
    return path
  end

  if ruby_class = WidgetClassNames[tk_class]
    ruby_class_name = ruby_class.name
    # gen_class_name = ruby_class_name + 'GeneratedOnTk'
    gen_class_name = ruby_class_name
    classname_def = ''
  else # ruby_class == nil
    if Tk.const_defined?(tk_class)
      Tk.const_get(tk_class)  # auto_load
      ruby_class = WidgetClassNames[tk_class]
    end

    unless ruby_class
      mods = TkExtlibAutoloadModule.find_all{|m| m.const_defined?(tk_class)}
      mods.each{|mod|
        begin
          mod.const_get(tk_class)  # auto_load
          break if (ruby_class = WidgetClassNames[tk_class])
        rescue LoadError
          # ignore load error
        end
      }
    end

    unless ruby_class
      std_class = 'Tk' << tk_class
      if Object.const_defined?(std_class)
        Object.const_get(std_class)  # auto_load
        ruby_class = WidgetClassNames[tk_class]
      end
    end

    unless ruby_class
      if Tk.const_defined?('TOPLEVEL_ALIASES') &&
          Tk::TOPLEVEL_ALIASES.const_defined?(std_class)
        Tk::TOPLEVEL_ALIASES.const_get(std_class)  # auto_load
        ruby_class = WidgetClassNames[tk_class]
      end
    end

    if ruby_class
      # found
      ruby_class_name = ruby_class.name
      gen_class_name = ruby_class_name
      classname_def = ''
    else
      # unknown
      ruby_class_name = 'TkWindow'
      gen_class_name = 'TkWidget_' + tk_class
      classname_def = "WidgetClassName = '#{tk_class}'.freeze"
    end
  end

###################################
=begin
  if ruby_class = WidgetClassNames[tk_class]
    ruby_class_name = ruby_class.name
    # gen_class_name = ruby_class_name + 'GeneratedOnTk'
    gen_class_name = ruby_class_name
    classname_def = ''
  else
    mod = TkExtlibAutoloadModule.find{|m| m.const_defined?(tk_class)}
    if mod
      ruby_class_name = mod.name + '::' + tk_class
      gen_class_name = ruby_class_name
      classname_def = ''
    elsif Object.const_defined?('Tk' + tk_class)
      ruby_class_name = 'Tk' + tk_class
      # gen_class_name = ruby_class_name + 'GeneratedOnTk'
      gen_class_name = ruby_class_name
      classname_def = ''
    else
      ruby_class_name = 'TkWindow'
      # gen_class_name = ruby_class_name + tk_class + 'GeneratedOnTk'
      gen_class_name = 'TkWidget_' + tk_class
      classname_def = "WidgetClassName = '#{tk_class}'.freeze"
    end
  end
=end

=begin
  unless Object.const_defined? gen_class_name
    Object.class_eval "class #{gen_class_name}<#{ruby_class_name}
                         #{classname_def}
                       end"
  end
  Object.class_eval "#{gen_class_name}.new('widgetname'=>'#{path}',
                                           'without_creating'=>true)"
=end
  base = Object
  gen_class_name.split('::').each{|klass|
    next if klass == ''
    if base.const_defined?(klass)
      base = base.class_eval klass
    else
      base = base.class_eval "class #{klass}<#{ruby_class_name}
                                #{classname_def}
                              end
                              #{klass}"
    end
  }
  base.class_eval "#{gen_class_name}.new('widgetname'=>'#{path}',
                                         'without_creating'=>true)"
end

._next_cmd_id ⇒ Object 



823
824
825
826
827
828
829
830
 
# File 'lib/tk.rb', line 823

def _next_cmd_id
  TkComm::Tk_IDs.mutex.synchronize{
    id = _curr_cmd_id
    #Tk_IDs[0] += 1
    TkComm::Tk_IDs[0].succ!
    id
  }
end

._toUTF8(str, encoding = nil) ⇒ Object 



675
676
677
 
# File 'lib/tk.rb', line 675

def _toUTF8(str, encoding = nil)
  TkCore::INTERP._toUTF8(str, encoding)
end

.array2tk_list(ary, enc = nil) ⇒ Object 



356
357
358
359
360
361
362
363
364
365
366
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
410
411
412
 
# File 'lib/tk.rb', line 356

def array2tk_list(ary, enc=nil)
  return "" if ary.size == 0

  sys_enc = TkCore::INTERP.encoding
  sys_enc = TclTkLib.encoding_system unless sys_enc

  dst_enc = (enc == nil)? sys_enc: enc

  dst = ary.collect{|e|
    if e.kind_of? Array
      s = array2tk_list(e, enc)
    elsif e.kind_of? Hash
      tmp_ary = []
      #e.each{|k,v| tmp_ary << k << v }
      e.each{|k,v| tmp_ary << "-#{_get_eval_string(k)}" << v }
      s = array2tk_list(tmp_ary, enc)
    else
      s = _get_eval_string(e, enc)
    end

    if dst_enc != true && dst_enc != false
      if (s_enc = s.instance_variable_get(:@encoding))
        s_enc = s_enc.to_s
      elsif TkCore::WITH_ENCODING
        s_enc = s.encoding.name
      else
        s_enc = sys_enc
      end
      dst_enc = true if s_enc != dst_enc
    end

    s
  }

  if sys_enc && dst_enc
    dst.map!{|s| _toUTF8(s)}
    ret = TkCore::INTERP._merge_tklist(*dst)
    if TkCore::WITH_ENCODING
      if dst_enc.kind_of?(String)
        ret = _fromUTF8(ret, dst_enc)
        ret.force_encoding(dst_enc)
      else
        ret.force_encoding('utf-8')
      end
    else # without encoding
      if dst_enc.kind_of?(String)
        ret = _fromUTF8(ret, dst_enc)
        ret.instance_variable_set(:@encoding, dst_enc)
      else
        ret.instance_variable_set(:@encoding, 'utf-8')
      end
    end
    ret
  else
    TkCore::INTERP._merge_tklist(*dst)
  end
end

.bool ⇒ Object

.image_obj(val) ⇒ Object 



614
615
616
617
618
619
620
621
622
 
# File 'lib/tk.rb', line 614

def image_obj(val)
  if val =~ /^i(_\d+_)?\d+$/
    TkImage::Tk_IMGTBL.mutex.synchronize{
      TkImage::Tk_IMGTBL[val]? TkImage::Tk_IMGTBL[val] : val
    }
  else
    val
  end
end

.install_cmd(cmd, local_cmdtbl = nil) ⇒ Object 



834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
 
# File 'lib/tk.rb', line 834

def TkComm.install_cmd(cmd, local_cmdtbl=nil)
  return '' if cmd == ''
  begin
    ns = TkCore::INTERP._invoke_without_enc('namespace', 'current')
    ns = nil if ns == '::' # for backward compatibility
  rescue
    # probably, Tcl7.6
    ns = nil
  end
  id = _next_cmd_id
  #Tk_CMDTBL[id] = cmd
  if cmd.kind_of?(TkCallbackEntry)
    TkCore::INTERP.tk_cmd_tbl[id] = cmd
  else
    TkCore::INTERP.tk_cmd_tbl[id] = TkCore::INTERP.get_cb_entry(cmd)
  end
  @cmdtbl = [] unless defined? @cmdtbl
  TkUtil.untrust(@cmdtbl) unless @cmdtbl.tainted?
  @cmdtbl.push id

  if local_cmdtbl && local_cmdtbl.kind_of?(Array)
    begin
      local_cmdtbl << id
    rescue Exception
      # ignore
    end
  end

  #return Kernel.format("rb_out %s", id);
  if ns
    'rb_out' << TkCore::INTERP._ip_id_ << ' ' << ns << ' ' << id
  else
    'rb_out' << TkCore::INTERP._ip_id_ << ' ' << id
  end
end

.list(val, depth = 0, enc = true) ⇒ Object

### –> definition is moved to TkUtil module

def bool(val)
  case val
  when "1", 1, 'yes', 'true'
    true
  else
    false
  end
end

def number(val)
  case val
  when /^-?\d+$/
    val.to_i
  when /^-?\d+\.?\d*(e[-+]?\d+)?$/
    val.to_f
  else
    fail(ArgumentError, "invalid value for Number:'#{val}'")
  end
end
def string(val)
  if val == "{}"
    ''
  elsif val[0] == ?{ && val[-1] == ?}
    val[1..-2]
  else
    val
  end
end
def num_or_str(val)
  begin
    number(val)
  rescue ArgumentError
    string(val)
  end
end



599
600
601
 
# File 'lib/tk.rb', line 599

def list(val, depth=0, enc=true)
  tk_split_list(val, depth, enc, enc)
end

.num_or_nil ⇒ Object

.num_or_str ⇒ Object

.number ⇒ Object

.procedure(val) ⇒ Object 



623
624
625
626
627
628
629
630
631
632
633
634
635
636
 
# File 'lib/tk.rb', line 623

def procedure(val)
=begin
  if val =~ /^rb_out\S* (c(_\d+_)?\d+)/
    #Tk_CMDTBL[$1]
    #TkCore::INTERP.tk_cmd_tbl[$1]
    TkCore::INTERP.tk_cmd_tbl[$1].cmd
=end
  if val =~ /rb_out\S*(?:\s+(::\S*|[{](::.*)[}]|["](::.*)["]))? (c(_\d+_)?(\d+))/
    return TkCore::INTERP.tk_cmd_tbl[$4].cmd
  else
    #nil
    val
  end
end

.simplelist(val, src_enc = true, dst_enc = true) ⇒ Object 



602
603
604
 
# File 'lib/tk.rb', line 602

def simplelist(val, src_enc=true, dst_enc=true)
  tk_split_simplelist(val, src_enc, dst_enc)
end

.slice_ary(ary, size, &b) ⇒ Object 



643
644
645
646
647
648
649
650
651
652
653
 
# File 'lib/tk.rb', line 643

def slice_ary(ary, size)
  sliced = []
  wk_ary = ary.dup
  until wk_ary.size.zero?
    sub_ary = []
    size.times{ sub_ary << wk_ary.shift }
    yield(sub_ary) if block_given?
    sliced << sub_ary
  end
  (block_given?)? ary: sliced
end

.string ⇒ Object

.tk_tcl2ruby(val, enc_mode = false, listobj = true) ⇒ Object 



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/tk.rb', line 231

def tk_tcl2ruby(val, enc_mode = false, listobj = true)
=begin
  if val =~ /^rb_out\S* (c(_\d+_)?\d+)/
    #return Tk_CMDTBL[$1]
    return TkCore::INTERP.tk_cmd_tbl[$1]
    #cmd_obj = TkCore::INTERP.tk_cmd_tbl[$1]
    #if cmd_obj.kind_of?(Proc) || cmd_obj.kind_of?(Method)
    #  cmd_obj
    #else
    #  cmd_obj.cmd
    #end
  end
=end
  if val =~ /rb_out\S*(?:\s+(::\S*|[{](::.*)[}]|["](::.*)["]))? (c(_\d+_)?(\d+))/
    return TkCore::INTERP.tk_cmd_tbl[$4]
  end
  #if val.include? ?\s
  #  return val.split.collect{|v| tk_tcl2ruby(v)}
  #end
  case val
  when /\A@font\S+\z/
    TkFont.get_obj(val)
  when /\A-?\d+\z/
    val.to_i
  when /\A\.\S*\z/
    #Tk_WINDOWS[val] ? Tk_WINDOWS[val] : _genobj_for_tkwidget(val)
    TkCore::INTERP.tk_windows[val]?
         TkCore::INTERP.tk_windows[val] : _genobj_for_tkwidget(val)
  when /\Ai(_\d+_)?\d+\z/
    TkImage::Tk_IMGTBL.mutex.synchronize{
      TkImage::Tk_IMGTBL[val]? TkImage::Tk_IMGTBL[val] : val
    }
  when /\A-?\d+\.?\d*(e[-+]?\d+)?\z/
    val.to_f
  when /\\ /
    val.gsub(/\\ /, ' ')
  when /[^\\] /
    if listobj
      #tk_split_escstr(val).collect{|elt|
      #  tk_tcl2ruby(elt, enc_mode, listobj)
      #}
      val = _toUTF8(val) unless enc_mode
      tk_split_escstr(val, false, false).collect{|elt|
        tk_tcl2ruby(elt, true, listobj)
      }
    elsif enc_mode
      _fromUTF8(val)
    else
      val
    end
  else
    if enc_mode
      _fromUTF8(val)
    else
      val
    end
  end
end

.uninstall_cmd(id, local_cmdtbl = nil) ⇒ Object 



869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
 
# File 'lib/tk.rb', line 869

def TkComm.uninstall_cmd(id, local_cmdtbl=nil)
  #id = $1 if /rb_out\S* (c(_\d+_)?\d+)/ =~ id
  id = $4 if id =~ /rb_out\S*(?:\s+(::\S*|[{](::.*)[}]|["](::.*)["]))? (c(_\d+_)?(\d+))/

  if local_cmdtbl && local_cmdtbl.kind_of?(Array)
    begin
      local_cmdtbl.delete(id)
    rescue Exception
      # ignore
    end
  end
  @cmdtbl.delete(id)

  #Tk_CMDTBL.delete(id)
  TkCore::INTERP.tk_cmd_tbl.delete(id)
end

.window(val) ⇒ Object 



605
606
607
608
609
610
611
612
613
 
# File 'lib/tk.rb', line 605

def window(val)
  if val =~ /^\./
    #Tk_WINDOWS[val]? Tk_WINDOWS[val] : _genobj_for_tkwidget(val)
    TkCore::INTERP.tk_windows[val]?
         TkCore::INTERP.tk_windows[val] : _genobj_for_tkwidget(val)
  else
    nil
  end
end

Instance Method Details

#bind(tagOrClass, context, *args) ⇒ Object

def bind(tagOrClass, context, cmd=Proc.new, *args)

_bind(["bind", tagOrClass], context, cmd, *args)
tagOrClass

end



1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
 
# File 'lib/tk.rb', line 1077

def bind(tagOrClass, context, *args)
  # if args[0].kind_of?(Proc) || args[0].kind_of?(Method)
  if TkComm._callback_entry?(args[0]) || !block_given?
    cmd = args.shift
  else
    cmd = Proc.new
  end
  _bind(["bind", tagOrClass], context, cmd, *args)
  tagOrClass
end

#bind_all(context, *args) ⇒ Object

def bind_all(context, cmd=Proc.new, *args)

_bind(['bind', 'all'], context, cmd, *args)
TkBindTag::ALL

end



1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
 
# File 'lib/tk.rb', line 1116

def bind_all(context, *args)
  # if args[0].kind_of?(Proc) || args[0].kind_of?(Method)
  if TkComm._callback_entry?(args[0]) || !block_given?
    cmd = args.shift
  else
    cmd = Proc.new
  end
  _bind(['bind', 'all'], context, cmd, *args)
  TkBindTag::ALL
end

#bind_append(tagOrClass, context, *args) ⇒ Object

def bind_append(tagOrClass, context, cmd=Proc.new, *args)

_bind_append(["bind", tagOrClass], context, cmd, *args)
tagOrClass

end



1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
 
# File 'lib/tk.rb', line 1092

def bind_append(tagOrClass, context, *args)
  # if args[0].kind_of?(Proc) || args[0].kind_of?(Method)
  if TkComm._callback_entry?(args[0]) || !block_given?
    cmd = args.shift
  else
    cmd = Proc.new
  end
  _bind_append(["bind", tagOrClass], context, cmd, *args)
  tagOrClass
end

#bind_append_all(context, *args) ⇒ Object

def bind_append_all(context, cmd=Proc.new, *args)

_bind_append(['bind', 'all'], context, cmd, *args)
TkBindTag::ALL

end



1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
 
# File 'lib/tk.rb', line 1131

def bind_append_all(context, *args)
  # if args[0].kind_of?(Proc) || args[0].kind_of?(Method)
  if TkComm._callback_entry?(args[0]) || !block_given?
    cmd = args.shift
  else
    cmd = Proc.new
  end
  _bind_append(['bind', 'all'], context, cmd, *args)
  TkBindTag::ALL
end

#bind_remove(tagOrClass, context) ⇒ Object 



1103
1104
1105
1106
 
# File 'lib/tk.rb', line 1103

def bind_remove(tagOrClass, context)
  _bind_remove(['bind', tagOrClass], context)
  tagOrClass
end

#bind_remove_all(context) ⇒ Object 



1142
1143
1144
1145
 
# File 'lib/tk.rb', line 1142

def bind_remove_all(context)
  _bind_remove(['bind', 'all'], context)
  TkBindTag::ALL
end

#bindinfo(tagOrClass, context = nil) ⇒ Object 



1108
1109
1110
 
# File 'lib/tk.rb', line 1108

def bindinfo(tagOrClass, context=nil)
  _bindinfo(['bind', tagOrClass], context)
end

#bindinfo_all(context = nil) ⇒ Object 



1147
1148
1149
 
# File 'lib/tk.rb', line 1147

def bindinfo_all(context=nil)
  _bindinfo(['bind', 'all'], context)
end

#install_cmd(cmd) ⇒ Object

private :install_cmd, :uninstall_cmd module_function :install_cmd, :uninstall_cmd



887
888
889
 
# File 'lib/tk.rb', line 887

def install_cmd(cmd)
  TkComm.install_cmd(cmd, @cmdtbl)
end

#subst(str, *opts) ⇒ Object 



666
667
668
669
670
671
672
673
 
# File 'lib/tk.rb', line 666

def subst(str, *opts)
  # opts := :nobackslashes | :nocommands | novariables
  tk_call('subst',
          *(opts.collect{|opt|
              opt = opt.to_s
              (opt[0] == ?-)? opt: '-' << opt
            } << str))
end

#uninstall_cmd(id) ⇒ Object 



890
891
892
 
# File 'lib/tk.rb', line 890

def uninstall_cmd(id)
  TkComm.uninstall_cmd(id, @cmdtbl)
end