Module: TkComm

Extended by:
TkEvent, TkUtil
Includes:
TkEvent, TkUtil
Included in:
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 = 
{}.taint
TkExtlibAutoloadModule = 
[].taint
Tk_IDs =

Tk_CMDTBL = {} Tk_WINDOWS = {}

["00000".taint, "00000".taint]
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 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

Methods included from TkEvent

install_bind, install_bind_for_event_class

Class Method Details

._at(x, y = nil) ⇒ Object 



190
191
192
193
194
195
196
 
# File 'lib/tk.rb', line 190

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

._callback_entry?(obj) ⇒ Boolean

Returns:

  • (Boolean) 


634
635
636
 
# File 'lib/tk.rb', line 634

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

._callback_entry_class?(cls) ⇒ Boolean

Returns:

  • (Boolean) 


628
629
630
 
# File 'lib/tk.rb', line 628

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



763
764
765
766
 
# File 'lib/tk.rb', line 763

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 



622
623
624
 
# File 'lib/tk.rb', line 622

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

._genobj_for_tkwidget(path) ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
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
 
# File 'lib/tk.rb', line 89

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
    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
    }

    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

    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 



767
768
769
770
771
772
773
774
 
# File 'lib/tk.rb', line 767

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 



619
620
621
 
# File 'lib/tk.rb', line 619

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

.array2tk_list(ary, enc = nil) ⇒ Object 



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
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
 
# File 'lib/tk.rb', line 324

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 



582
583
584
585
586
587
588
589
590
 
# File 'lib/tk.rb', line 582

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 



778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
 
# File 'lib/tk.rb', line 778

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
  @cmdtbl.taint 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



567
568
569
 
# File 'lib/tk.rb', line 567

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

.num_or_str ⇒ Object

.number ⇒ Object

.procedure(val) ⇒ Object 



591
592
593
594
595
596
597
598
599
600
601
602
603
604
 
# File 'lib/tk.rb', line 591

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 



570
571
572
 
# File 'lib/tk.rb', line 570

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

.string ⇒ Object

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



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
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
 
# File 'lib/tk.rb', line 199

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 



813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
 
# File 'lib/tk.rb', line 813

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 



573
574
575
576
577
578
579
580
581
 
# File 'lib/tk.rb', line 573

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



1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
 
# File 'lib/tk.rb', line 1021

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



1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
 
# File 'lib/tk.rb', line 1060

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



1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
 
# File 'lib/tk.rb', line 1036

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



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

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 



1047
1048
1049
1050
 
# File 'lib/tk.rb', line 1047

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

#bind_remove_all(context) ⇒ Object 



1086
1087
1088
1089
 
# File 'lib/tk.rb', line 1086

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

#bindinfo(tagOrClass, context = nil) ⇒ Object 



1052
1053
1054
 
# File 'lib/tk.rb', line 1052

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

#bindinfo_all(context = nil) ⇒ Object 



1091
1092
1093
 
# File 'lib/tk.rb', line 1091

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



831
832
833
 
# File 'lib/tk.rb', line 831

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

#subst(str, *opts) ⇒ Object 



610
611
612
613
614
615
616
617
 
# File 'lib/tk.rb', line 610

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 



834
835
836
 
# File 'lib/tk.rb', line 834

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