Class: TkVariable

Inherits:
Object show all
Extended by:
TkCore
Includes:
Comparable, Tk
Defined in:
lib/tk/variable.rb

Direct Known Subclasses

Tk::BLT::Vector, TkVarAccess

Constant Summary collapse

TkCommandNames =

TkCommandNames = ['tkwait'.freeze].freeze

['vwait'.freeze].freeze
TkVar_CB_TBL =

TkVar_CB_TBL = {} TkVar_ID_TBL = {}

TkCore::INTERP.create_table
TkVar_ID_TBL =
TkCore::INTERP.create_table
USE_OLD_TRACE_OPTION_STYLE =
(major < 8) || (major == 8 && minor < 4)
USE_TCLs_SET_VARIABLE_FUNCTIONS =
true

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

Constants included from Tk

Tk::AUTO_PATH, Tk::INTERP, Tk::JAPANIZED_TK, Tk::LIBRARY_PATH, Tk::MAINLOOP, Tk::PACKAGE_PATH, Tk::RELEASE_DATE, Tk::TCL_LIBRARY_PATH, Tk::TCL_MAJOR_VERSION, Tk::TCL_MINOR_VERSION, Tk::TCL_PACKAGE_PATH, Tk::TCL_PATCHLEVEL, Tk::TCL_PRECISION, Tk::TCL_VERSION, Tk::TK_MAJOR_VERSION, Tk::TK_MINOR_VERSION, Tk::TK_PATCHLEVEL, Tk::TK_VERSION, Tk::Tkextlib_RELEASE_DATE, Tk::TreeCtrl_Widget, Tk::X_Scrollable, Tk::Y_Scrollable

Constants included from Tk::Encoding

Tk::Encoding::BINARY, Tk::Encoding::BINARY_NAME, Tk::Encoding::DEFAULT_EXTERNAL_NAME, Tk::Encoding::DEFAULT_INTERNAL_NAME, Tk::Encoding::ENCODING_TABLE, Tk::Encoding::RubyEncoding, Tk::Encoding::UNKNOWN, Tk::Encoding::UTF8_NAME

Class Method Summary collapse

Instance Method Summary collapse

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, info, 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, restart, 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, eval_cmd, hash_kv, #hash_kv, install_cmd, num_or_nil, #num_or_nil, #num_or_str, num_or_str, #number, number, string, uninstall_cmd, untrust

Methods included from Tk

BinaryString, EncodedString, #Grid, #Pack, #Place, UTF8_String, __create_widget_set__, __disable_toplevel_control__, __import_toplevel_aliases__, __regist_toplevel_aliases__, __remove_toplevel_aliases__, __reset_toplevel_owner__, __set_loaded_toplevel_aliases__, __set_toplevel_aliases__, __toplevel_alias_setup_proc__, add_kinsoku, bell, bell_on_display, const_missing, current_grabs, cursor_display, default_widget_set, default_widget_set=, delete_kinsoku, destroy, #encoding, #encoding=, errorCode, errorInfo, exit, focus, focus_lastfor, focus_next, focus_prev, focus_to, fromUTF8, grid, grid_forget, has_mainwindow?, load_tcllibrary, load_tclscript, load_tclscript_rsrc, load_tclscript_rsrcid, lower_window, pack, pack_forget, pkgconfig_get, pkgconfig_list, place, place_forget, raise_window, #root, show_kinsoku, sleep, strictMotif, subst_tk_backslash, subst_utf_backslash, tcl_pkgconfig_get, tcl_pkgconfig_list, thread_update, thread_update_idletasks, tk_pkgconfig_get, tk_pkgconfig_list, toUTF8, to_backslash_sequence, toplevel_aliases_on_widget_set, ungrid, unload_tcllibrary, unpack, unplace, update, update_idletasks, utf_to_backslash, utf_to_backslash_sequence, wakeup, widget_set_symbols

Methods included from Tk::Encoding

#default_encoding=, #encoding=, #encoding_convertfrom, #encoding_convertto, #encoding_dirs, #encoding_dirs=, #encoding_name, #encoding_names, #encoding_obj, #encoding_objs, #encoding_system=, #encoding_system_name, #encoding_system_obj, #force_default_encoding, #force_default_encoding=, #force_default_encoding?, #tk_encoding_names

Constructor Details

#initialize(val = "", type = nil) ⇒ TkVariable

Returns a new instance of TkVariable.


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
311
312
313
314
315
316
317
318
319
320
321
322
323
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
# File 'lib/tk/variable.rb', line 282

def initialize(val="", type=nil)
  # @id = Tk_VARIABLE_ID.join('')
  begin
    Tk_VARIABLE_ID.mutex.synchronize{
      @id = Tk_VARIABLE_ID.join(TkCore::INTERP._ip_id_)
      Tk_VARIABLE_ID[1].succ!
    }
  end until INTERP._invoke_without_enc('info', 'globals', @id).empty?

  TkVar_ID_TBL.mutex.synchronize{
    TkVar_ID_TBL[@id] = self
  }

  @var  = @id
  @elem = nil

  @def_default = false
  @default_val = nil

  @trace_var  = nil
  @trace_elem = nil
  @trace_opts = nil

  @type = nil
  var = self
  @element_type = Hash.new{|k,v| var.default_value_type }

  self.default_value_type = type

  # teach Tk-ip that @id is global var
  INTERP._invoke_without_enc('global', @id)
  #INTERP._invoke('global', @id)

  # create and init
  if val.kind_of?(Hash)
    # assoc-array variable
    self[''] = 0
    self.clear
  end
  self.value = val

=begin
  if val == []
    # INTERP._eval(format('global %s; set %s(0) 0; unset %s(0)',
    #                     @id, @id, @id))
  elsif val.kind_of?(Array)
    a = []
    # val.each_with_index{|e,i| a.push(i); a.push(array2tk_list(e))}
    # s = '"' + a.join(" ").gsub(/[\[\]$"]/, '\\\\\&') + '"'
    val.each_with_index{|e,i| a.push(i); a.push(e)}
    #s = '"' + array2tk_list(a).gsub(/[\[\]$"]/, '\\\\\&') + '"'
    s = '"' + array2tk_list(a).gsub(/[\[\]$"\\]/, '\\\\\&') + '"'
    INTERP._eval(format('global %s; array set %s %s', @id, @id, s))
  elsif  val.kind_of?(Hash)
    #s = '"' + val.to_a.collect{|e| array2tk_list(e)}.join(" ")\
    #             .gsub(/[\[\]$"]/, '\\\\\&') + '"'
    s = '"' + val.to_a.collect{|e| array2tk_list(e)}.join(" ")\
                 .gsub(/[\[\]$"\\]/, '\\\\\&') + '"'
    INTERP._eval(format('global %s; array set %s %s', @id, @id, s))
  else
    #s = '"' + _get_eval_string(val).gsub(/[\[\]$"]/, '\\\\\&') + '"'
    s = '"' + _get_eval_string(val).gsub(/[\[\]$"\\]/, '\\\\\&') + '"'
    INTERP._eval(format('global %s; set %s %s', @id, @id, s))
  end
=end
=begin
  if  val.kind_of?(Hash)
    #s = '"' + val.to_a.collect{|e| array2tk_list(e)}.join(" ")\
    #             .gsub(/[\[\]$"]/, '\\\\\&') + '"'
    s = '"' + val.to_a.collect{|e| array2tk_list(e)}.join(" ")\
                 .gsub(/[\[\]$"\\]/, '\\\\\&') + '"'
    INTERP._eval(Kernel.format('global %s; array set %s %s', @id, @id, s))
  else
    #s = '"' + _get_eval_string(val).gsub(/[\[\]$"]/, '\\\\\&') + '"'
    s = '"' + _get_eval_string(val).gsub(/[\[\]$"\\]/, '\\\\\&') + '"'
    INTERP._eval(Kernel.format('global %s; set %s %s', @id, @id, s))
  end
=end
end

Class Method Details

.callback(id, name1, name2, op) ⇒ Object

def TkVariable.callback(args)


55
56
57
58
59
60
61
62
63
64
65
66
67
68
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
97
98
99
100
101
102
103
104
# File 'lib/tk/variable.rb', line 55

def TkVariable.callback(id, name1, name2, op)
  #name1,name2,op = tk_split_list(args)
  #name1,name2,op = tk_split_simplelist(args)
  if cb_obj = TkVar_CB_TBL[id]
    #_get_eval_string(TkVar_CB_TBL[name1].trace_callback(name2,op))
    begin
      _get_eval_string(cb_obj.trace_callback(name2, op))
    rescue SystemExit
      exit(0)
    rescue Interrupt
      exit!(1)
    rescue Exception => e
      begin
        msg = _toUTF8(e.class.inspect) + ': ' +
              _toUTF8(e.message) + "\n" +
              "\n---< backtrace of Ruby side >-----\n" +
              _toUTF8(e.backtrace.join("\n")) +
              "\n---< backtrace of Tk side >-------"
        if TkCore::WITH_ENCODING
          msg.force_encoding('utf-8')
        else
          msg.instance_variable_set(:@encoding, 'utf-8')
        end
      rescue Exception
        msg = e.class.inspect + ': ' + e.message + "\n" +
              "\n---< backtrace of Ruby side >-----\n" +
              e.backtrace.join("\n") +
              "\n---< backtrace of Tk side >-------"
      end
      fail(e, msg)
    end
=begin
    begin
      raise 'check backtrace'
    rescue
      # ignore backtrace before 'callback'
      pos = -($!.backtrace.size)
    end
    begin
      _get_eval_string(TkVar_CB_TBL[name1].trace_callback(name2,op))
    rescue
      trace = $!.backtrace
      raise $!, "\n#{trace[0]}: #{$!.message} (#{$!.class})\n" +
                "\tfrom #{trace[1..pos].join("\n\tfrom ")}"
    end
=end
  else
    ''
  end
end

.new_hash(val = {}) ⇒ Object


106
107
108
109
110
111
112
# File 'lib/tk/variable.rb', line 106

def self.new_hash(val = {})
  if val.kind_of?(Hash)
    self.new(val)
  else
    fail ArgumentError, 'Hash is expected'
  end
end

Instance Method Details

#%(other) ⇒ Object


1229
1230
1231
1232
1233
1234
1235
1236
# File 'lib/tk/variable.rb', line 1229

def %(other)
  num_or_str(self._value) % other
  #begin
  #  number(self._value) % other
  #rescue
  #  self._value % other
  #end
end

#&(other) ⇒ Object


1183
1184
1185
1186
1187
1188
1189
# File 'lib/tk/variable.rb', line 1183

def &(other)
  if other.kind_of?(Array)
    self.to_a & other.to_a
  else
    self.to_i & other.to_i
  end
end

#*(other) ⇒ Object


1218
1219
1220
1221
1222
1223
1224
1225
# File 'lib/tk/variable.rb', line 1218

def *(other)
  num_or_str(self._value) * other
  #begin
  #  number(self._value) * other
  #rescue
  #  self._value * other
  #end
end

#**(other) ⇒ Object

begin

number(self._value) % other

rescue

self._value % other

end


1237
1238
1239
# File 'lib/tk/variable.rb', line 1237

def **(other)
  number(self._value) ** other
end

#+(other) ⇒ Object


1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
# File 'lib/tk/variable.rb', line 1197

def +(other)
  case other
  when Array
    self.to_a + other
  when String
    self._value + other
  else
    begin
      number(self._value) + other
    rescue
      self._value + other.to_s
    end
  end
end

#[email protected]Object


1176
1177
1178
# File 'lib/tk/variable.rb', line 1176

def [email protected]
  self.numeric
end

#-(other) ⇒ Object


1211
1212
1213
1214
1215
1216
1217
# File 'lib/tk/variable.rb', line 1211

def -(other)
  if other.kind_of?(Array)
    self.to_a - other
  else
    number(self._value) - other
  end
end

#[email protected]Object


1179
1180
1181
# File 'lib/tk/variable.rb', line 1179

def [email protected]
  -(self.numeric)
end

#/(other) ⇒ Object

begin

number(self._value) * other

rescue

self._value * other

end


1226
1227
1228
# File 'lib/tk/variable.rb', line 1226

def /(other)
  number(self._value) / other
end

#<=>(other) ⇒ Object


1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
# File 'lib/tk/variable.rb', line 1283

def <=>(other)
  if other.kind_of?(TkVariable)
    begin
      val = other.numeric
      other = val
    rescue
      other = other._value
    end
  elsif other.kind_of?(Numeric)
    begin
      return self.numeric <=> other
    rescue
      return self._value <=> other.to_s
    end
  elsif other.kind_of?(Array)
    return self.list <=> other
  else
    return self._value <=> other
  end
end

#==(other) ⇒ Object


1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
# File 'lib/tk/variable.rb', line 1244

def ==(other)
  case other
  when TkVariable
    #self.equal?(other)
    self._value == other._value
  when String
    self.to_s == other
  when Symbol
    self.to_sym == other
  when Integer
    self.to_i == other
  when Float
    self.to_f == other
  when Array
    self.to_a == other
  when Hash
    # false if self is not an assoc array
    self._value == other
  else
    # false
    self._value == _get_eval_string(other)
  end
end

#===(other) ⇒ Object


1268
1269
1270
1271
1272
1273
1274
# File 'lib/tk/variable.rb', line 1268

def ===(other)
  if other.kind_of?(TkVariable)
    self.id == other.id
  else
    super
  end
end

#=~(other) ⇒ Object


1240
1241
1242
# File 'lib/tk/variable.rb', line 1240

def =~(other)
  self._value =~ other
end

#[](*idxs) ⇒ Object


688
689
690
# File 'lib/tk/variable.rb', line 688

def [](*idxs)
  _to_default_element_type(idxs, _element_value(*idxs))
end

#[]=(*args) ⇒ Object


532
533
534
535
536
537
538
539
540
541
542
# File 'lib/tk/variable.rb', line 532

def []=(*args)
  val = args.pop
  type = default_element_value_type(args)
  val = val._value if !type && type != :variable && val.kind_of?(TkVariable)
  index = args.collect{|idx| _get_eval_string(idx, true)}.join(',')
  _fromUTF8(INTERP._set_global_var2(@id, index, _get_eval_string(val, true)))
  #_fromUTF8(INTERP._set_global_var2(@id, _toUTF8(_get_eval_string(index)),
  #                                 _toUTF8(_get_eval_string(val))))
  #_fromUTF8(INTERP._set_global_var2(@id, _get_eval_string(index, true),
  #                                 _get_eval_string(val, true)))
end

#boolObject


777
778
779
780
781
782
783
784
785
786
787
788
# File 'lib/tk/variable.rb', line 777

def bool
  TkComm.bool(_value)
=begin
  # see Tcl_GetBoolean man-page
  case _value.downcase
  when '0', 'false', 'no', 'off'
    false
  else
    true
  end
=end
end

#bool_element(*idxs) ⇒ Object

# see Tcl_GetBoolean man-page

case _value.downcase
when '0', 'false', 'no', 'off'
  false
else
  true
end

789
790
791
# File 'lib/tk/variable.rb', line 789

def bool_element(*idxs)
  TkComm.bool(_element_value(*idxs))
end

#clearObject


445
446
447
448
449
450
451
# File 'lib/tk/variable.rb', line 445

def clear
  if (is_scalar?)
    fail RuntimeError, 'cannot clear a scalar variable'
  end
  keys.each{|k| unset(k)}
  self
end

#coerce(other) ⇒ Object


1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
# File 'lib/tk/variable.rb', line 1159

def coerce(other)
  case other
  when TkVariable
    [other._value, self._value]
  when String
    [other, self.to_s]
  when Symbol
    [other, self.to_sym]
  when Numeric
    [other, self.numeric]
  when Array
    [other, self.to_a]
  else
    [other, self._value]
  end
end

#default_element_value_type(idxs) ⇒ Object


148
149
150
151
152
153
154
155
# File 'lib/tk/variable.rb', line 148

def default_element_value_type(idxs)
  if idxs.kind_of?(Array)
    index = idxs.collect{|idx| _get_eval_string(idx, true)}.join(',')
  else
    index = _get_eval_string(idxs, true)
  end
  @element_type[index]
end

#default_proc(cmd = Proc.new) ⇒ Object


133
134
135
136
137
# File 'lib/tk/variable.rb', line 133

def default_proc(cmd = Proc.new)
  @def_default = :proc
  @default_val = cmd
  self
end

#default_value(val = nil, &b) ⇒ Object

default_value is available only when the variable is an assoc array.


117
118
119
120
121
122
123
124
125
126
# File 'lib/tk/variable.rb', line 117

def default_value(val=nil, &b)
  if b
    @def_default = :proc
    @default_val = proc(&b)
  else
    @def_default = :val
    @default_val = val
  end
  self
end

#default_value_typeObject


145
146
147
# File 'lib/tk/variable.rb', line 145

def default_value_type
  @type
end

#element_lappend(idxs, *elems) ⇒ Object


1106
1107
1108
1109
1110
1111
1112
# File 'lib/tk/variable.rb', line 1106

def element_lappend(idxs, *elems)
  if idxs.kind_of?(Array)
    idxs = idxs.collect{|idx| _get_eval_string(idx, true)}.join(',')
  end
  tk_call('lappend', "#{@id}(#{idxs})", *elems)
  self
end

#element_lget_f(elem_idxs, idx) ⇒ Object


1138
1139
1140
# File 'lib/tk/variable.rb', line 1138

def element_lget_f(elem_idxs, idx)
  number(element_lget(elem_idxs, idx)).to_f
end

#element_lget_i(elem_idxs, idx) ⇒ Object


1131
1132
1133
# File 'lib/tk/variable.rb', line 1131

def element_lget_i(elem_idxs, idx)
  number(element_lget(elem_idxs, idx)).to_i
end

#element_lindex(elem_idxs, idx) ⇒ Object Also known as: element_lget


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

def element_lindex(elem_idxs, idx)
  if elem_idxs.kind_of?(Array)
    val = _element_value(*elem_idxs)
  else
    val = _element_value(elem_idxs)
  end
  tk_call('lindex', val, idx)
end

#element_lset(elem_idxs, idx, val) ⇒ Object


1146
1147
1148
1149
1150
1151
1152
# File 'lib/tk/variable.rb', line 1146

def element_lset(elem_idxs, idx, val)
  if elem_idxs.kind_of?(Array)
    idxs = elem_idxs.collect{|i| _get_eval_string(i, true)}.join(',')
  end
  tk_call('lset', "#{@id}(#{idxs})", idx, val)
  self
end

#element_to_f(*idxs) ⇒ Object


953
954
955
# File 'lib/tk/variable.rb', line 953

def element_to_f(*idxs)
  number(_element_value(*idxs)).to_f
end

#element_to_i(*idxs) ⇒ Object


946
947
948
# File 'lib/tk/variable.rb', line 946

def element_to_i(*idxs)
  number(_element_value(*idxs)).to_i
end

#element_to_s(*idxs) ⇒ Object


963
964
965
# File 'lib/tk/variable.rb', line 963

def element_to_s(*idxs)
  _element_value(*idxs)
end

#element_to_sym(*idxs) ⇒ Object Also known as: symbol_element


999
1000
1001
# File 'lib/tk/variable.rb', line 999

def element_to_sym(*idxs)
  _element_value(*idxs).intern
end

#eventloop_tkwaitObject


390
391
392
# File 'lib/tk/variable.rb', line 390

def eventloop_tkwait
  wait(false, true)
end

#eventloop_wait(check_root = false) ⇒ Object


381
382
383
# File 'lib/tk/variable.rb', line 381

def eventloop_wait(check_root = false)
  wait(false, check_root)
end

#exist?(*elems) ⇒ Boolean

Returns:

  • (Boolean)

417
418
419
420
421
422
423
424
425
426
427
# File 'lib/tk/variable.rb', line 417

def exist?(*elems)
  INTERP._invoke_without_enc('global', @id)
  if elems.empty?
    TkComm.bool(tk_call('info', 'exist', @id))
  else
    # array
    index = elems.collect{|idx| _get_eval_string(idx, true)}.join(',')
    TkComm.bool(tk_call('info', 'exist', "#{@id}")) &&
      TkComm.bool(tk_call('info', 'exist', "#{@id}(#{index})"))
  end
end

#idObject


397
398
399
# File 'lib/tk/variable.rb', line 397

def id
  @id
end

#inspectObject


1154
1155
1156
1157
# File 'lib/tk/variable.rb', line 1154

def inspect
  #Kernel.format "#<TkVariable: %s>", @id
  '#<TkVariable: ' + @id + '>'
end

#is_hash?Boolean

Returns:

  • (Boolean)

406
407
408
409
410
411
# File 'lib/tk/variable.rb', line 406

def is_hash?
  #ITNERP._eval("global #{@id}; array exist #{@id}") == '1'
  INTERP._invoke_without_enc('global', @id)
  # INTERP._invoke_without_enc('array', 'exist', @id) == '1'
  TkComm.bool(INTERP._invoke_without_enc('array', 'exist', @id))
end

#is_scalar?Boolean

Returns:

  • (Boolean)

413
414
415
# File 'lib/tk/variable.rb', line 413

def is_scalar?
  ! is_hash?
end

#keysObject


429
430
431
432
433
434
435
436
437
438
# File 'lib/tk/variable.rb', line 429

def keys
  if (is_scalar?)
    fail RuntimeError, 'cannot get keys from a scalar variable'
  end
  #tk_split_simplelist(INTERP._eval("global #{@id}; array get #{@id}"))
  INTERP._invoke_without_enc('global', @id)
  #tk_split_simplelist(INTERP._fromUTF8(INTERP._invoke_without_enc('array', 'names', @id)))
  tk_split_simplelist(INTERP._invoke_without_enc('array', 'names', @id),
                      false, true)
end

#lappend(*elems) ⇒ Object


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

def lappend(*elems)
  tk_call('lappend', @id, *elems)
  self
end

#lget_f(idx) ⇒ Object


1135
1136
1137
# File 'lib/tk/variable.rb', line 1135

def lget_f(idx)
  number(lget(idx)).to_f
end

#lget_i(idx) ⇒ Object


1128
1129
1130
# File 'lib/tk/variable.rb', line 1128

def lget_i(idx)
  number(lget(idx)).to_i
end

#lindex(idx) ⇒ Object Also known as: lget


1114
1115
1116
# File 'lib/tk/variable.rb', line 1114

def lindex(idx)
  tk_call('lindex', self._value, idx)
end

#listObject Also known as: to_a, to_ary


1029
1030
1031
1032
# File 'lib/tk/variable.rb', line 1029

def list
  #tk_split_list(value)
  tk_split_simplelist(_value)
end

#list_element(*idxs) ⇒ Object Also known as: element_to_a


1035
1036
1037
# File 'lib/tk/variable.rb', line 1035

def list_element(*idxs)
  tk_split_simplelist(_element_value(*idxs))
end

#lset(idx, val) ⇒ Object


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

def lset(idx, val)
  tk_call('lset', @id, idx, val)
  self
end

#nonzero?Boolean

Returns:

  • (Boolean)

1279
1280
1281
# File 'lib/tk/variable.rb', line 1279

def nonzero?
  !(numeric.zero?)
end

#numericObject


732
733
734
# File 'lib/tk/variable.rb', line 732

def numeric
  number(_value)
end

#numeric_element(*idxs) ⇒ Object


735
736
737
# File 'lib/tk/variable.rb', line 735

def numeric_element(*idxs)
  number(_element_value(*idxs))
end

#numlistObject


1040
1041
1042
# File 'lib/tk/variable.rb', line 1040

def numlist
  list.collect!{|val| number(val)}
end

#numlist_element(*idxs) ⇒ Object


1043
1044
1045
# File 'lib/tk/variable.rb', line 1043

def numlist_element(*idxs)
  list_element(*idxs).collect!{|val| number(val)}
end

#procedureObject


901
902
903
# File 'lib/tk/variable.rb', line 901

def procedure
  TkComm.procedure(self._value)
end

#procedure_element(*idxs) ⇒ Object


904
905
906
# File 'lib/tk/variable.rb', line 904

def procedure_element(*idxs)
  TkComm.procedure(_element_value(*idxs))
end

#ref(*idxs) ⇒ Object


401
402
403
404
# File 'lib/tk/variable.rb', line 401

def ref(*idxs)
  # "#{@id}(#{idxs.collect{|idx| _get_eval_string(idx)}.join(',')})"
  TkVarAccess.new("#{@id}(#{idxs.collect{|idx| _get_eval_string(idx)}.join(',')})")
end

#set_bool(val) ⇒ Object Also known as: bool=


792
793
794
795
796
797
798
799
800
801
802
803
804
# File 'lib/tk/variable.rb', line 792

def set_bool(val)
  if ! val
    self.value = '0'
  else
    case val.to_s.downcase
    when 'false', '0', 'no', 'off'
      self.value = '0'
    else
      self.value = '1'
    end
  end
  self
end

#set_bool_element(idxs, val) ⇒ Object


806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
# File 'lib/tk/variable.rb', line 806

def set_bool_element(idxs, val)
  if ! val
    val = '0'
  else
    case val.to_s.downcase
    when 'false', '0', 'no', 'off'
      val = '0'
    else
      val = '1'
    end
  end
  if idxs.kind_of?(Array)
    self[*idxs]=val
  else
    self[idxs]=val
  end
  self
end

#set_bool_element_type(idxs, val) ⇒ Object


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

def set_bool_element_type(idxs, val)
  self.set_default_element_value_type(idxs, :bool)
  self.set_bool_element(idxs, val)
end

#set_bool_type(val) ⇒ Object Also known as: bool_type=


824
825
826
827
828
# File 'lib/tk/variable.rb', line 824

def set_bool_type(val)
  @type = :bool
  self.bool=(val)
  self
end

#set_default_element_value_type(idxs, type) ⇒ Object


226
227
228
229
# File 'lib/tk/variable.rb', line 226

def set_default_element_value_type(idxs, type)
  _set_default_value_type_core(type, idxs)
  self
end

#set_default_value(val) ⇒ Object Also known as: default_value=


127
128
129
130
131
# File 'lib/tk/variable.rb', line 127

def set_default_value(val)
  @def_default = :val
  @default_val = val
  self
end

#set_default_value_type(type) ⇒ Object Also known as: default_value_type=


220
221
222
223
# File 'lib/tk/variable.rb', line 220

def set_default_value_type(type)
  _set_default_value_type_core(type, nil)
  self
end

#set_element_value(idxs, val) ⇒ Object


705
706
707
708
709
710
711
712
# File 'lib/tk/variable.rb', line 705

def set_element_value(idxs, val)
  if idxs.kind_of?(Array)
    self[*idxs]=val
  else
    self[idxs]=val
  end
  self
end

#set_element_value_type(idxs, val) ⇒ Object


722
723
724
725
726
727
728
729
730
# File 'lib/tk/variable.rb', line 722

def set_element_value_type(idxs, val)
  self.set_default_element_value_type(idxs, val.class)
  if idxs.kind_of?(Array)
    self[*idxs]=val
  else
    self[idxs]=val
  end
  self
end

#set_list(val) ⇒ Object Also known as: list=, set_numlist


1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
# File 'lib/tk/variable.rb', line 1047

def set_list(val)
  case val
  when Array
    self.value=(val)
  when TkVariable
    self.value=(val.list)
  else
    raise ArgumentError, "Array is expected"
  end
  self
end

#set_list_element(idxs, val) ⇒ Object Also known as: set_numlist_element


1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
# File 'lib/tk/variable.rb', line 1063

def set_list_element(idxs, val)
  case val
  when Array
    val
  when TkVariable
    val = val.list
  else
    raise ArgumentError, "Array is expected"
  end
  if idxs.kind_of?(Array)
    self[*idxs]=val
  else
    self[idxs]=val
  end
  self
end

#set_list_element_type(idxs, val) ⇒ Object


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

def set_list_element_type(idxs, val)
  self.set_default_element_value_type(idxs, :list)
  self.set_list_element(idxs, val)
end

#set_list_type(val) ⇒ Object Also known as: list_type=


1081
1082
1083
1084
1085
# File 'lib/tk/variable.rb', line 1081

def set_list_type(val)
  @type = :list
  self.list=(val)
  self
end

#set_numeric(val) ⇒ Object Also known as: numeric=


738
739
740
741
742
743
744
745
746
747
748
# File 'lib/tk/variable.rb', line 738

def set_numeric(val)
  case val
  when Numeric
    self.value=(val)
  when TkVariable
    self.value=(val.numeric)
  else
    raise ArgumentError, "Numeric is expected"
  end
  self
end

#set_numeric_element(idxs, val) ⇒ Object


750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
# File 'lib/tk/variable.rb', line 750

def set_numeric_element(idxs, val)
  case val
  when Numeric
    val
  when TkVariable
    val = val.numeric
  else
    raise ArgumentError, "Numeric is expected"
  end
  if idxs.kind_of?(Array)
    self[*idxs]=val
  else
    self[idxs]=val
  end
  self
end

#set_numeric_element_type(idxs, val) ⇒ Object


772
773
774
775
# File 'lib/tk/variable.rb', line 772

def set_numeric_element_type(idxs, val)
  self.set_default_element_value_type(idxs, :numeric)
  self.set_numeric_element(idxs, val)
end

#set_numeric_type(val) ⇒ Object Also known as: numeric_type=


766
767
768
769
770
# File 'lib/tk/variable.rb', line 766

def set_numeric_type(val)
  @type = :numeric
  self.numeric=(val)
  self
end

#set_numlist_element_type(idxs, val) ⇒ Object


1097
1098
1099
1100
# File 'lib/tk/variable.rb', line 1097

def set_numlist_element_type(idxs, val)
  self.set_default_element_value_type(idxs, :numlist)
  self.set_numlist_element(idxs, val)
end

#set_numlist_type(val) ⇒ Object Also known as: numlist_type=


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

def set_numlist_type(val)
  @type = :numlist
  self.numlist=(val)
  self
end

#set_procedure(cmd) ⇒ Object Also known as: procedure=


907
908
909
910
# File 'lib/tk/variable.rb', line 907

def set_procedure(cmd)
  self.value = cmd
  self
end

#set_procedure_element(idxs, cmd) ⇒ Object


912
913
914
915
916
917
918
919
920
# File 'lib/tk/variable.rb', line 912

def set_procedure_element(idxs, cmd)
  cmd = cmd._value if cmd.kind_of?(TkVariable)
  if idxs.kind_of?(Array)
    self[*idxs]=cmd
  else
    self[idxs]=cmd
  end
  self
end

#set_procedure_element_type(idxs, cmd) ⇒ Object


927
928
929
930
# File 'lib/tk/variable.rb', line 927

def set_procedure_element_type(idxs, cmd)
  self.set_default_element_value_type(idxs, :procedure)
  self.set_proceure_element(idxs, cmd)
end

#set_procedure_type(cmd) ⇒ Object Also known as: procedure_type=


921
922
923
924
925
# File 'lib/tk/variable.rb', line 921

def set_procedure_type(cmd)
  @type = :procedure
  self.procedure=(cmd)
  self
end

#set_string(val) ⇒ Object Also known as: string=


969
970
971
972
973
# File 'lib/tk/variable.rb', line 969

def set_string(val)
  val = val._value if val.kind_of?(TkVariable)
  self.value=val
  self
end

#set_string_element(idxs, val) ⇒ Object


975
976
977
978
979
980
981
982
983
# File 'lib/tk/variable.rb', line 975

def set_string_element(idxs, val)
  val = val._value if val.kind_of?(TkVariable)
  if idxs.kind_of?(Array)
    self[*idxs]=val
  else
    self[idxs]=val
  end
  self
end

#set_string_element_type(idxs, val) ⇒ Object


990
991
992
993
# File 'lib/tk/variable.rb', line 990

def set_string_element_type(idxs, val)
  self.set_default_element_value_type(idxs, :string)
  self.set_string_element(idxs, val)
end

#set_string_type(val) ⇒ Object Also known as: string_type=


984
985
986
987
988
# File 'lib/tk/variable.rb', line 984

def set_string_type(val)
  @type = :string
  self.string=(val)
  self
end

#set_symbol(val) ⇒ Object Also known as: symbol=


1003
1004
1005
1006
1007
# File 'lib/tk/variable.rb', line 1003

def set_symbol(val)
  val = val._value if val.kind_of?(TkVariable)
  self.value=val
  self
end

#set_symbol_element(idxs, val) ⇒ Object


1009
1010
1011
1012
1013
1014
1015
1016
1017
# File 'lib/tk/variable.rb', line 1009

def set_symbol_element(idxs, val)
  val = val._value if val.kind_of?(TkVariable)
  if idxs.kind_of?(Array)
    self[*idxs]=val
  else
    self[idxs]=val
  end
  self
end

#set_symbol_element_type(idxs, val) ⇒ Object


1024
1025
1026
1027
# File 'lib/tk/variable.rb', line 1024

def set_symbol_element_type(idxs, val)
  self.set_default_element_value_type(idxs, :symbol)
  self.set_symbol_element(idxs, val)
end

#set_symbol_type(val) ⇒ Object Also known as: symbol_type=


1018
1019
1020
1021
1022
# File 'lib/tk/variable.rb', line 1018

def set_symbol_type(val)
  @type = :symbol
  self.value=(val)
  self
end

#set_value(val) ⇒ Object


692
693
694
695
# File 'lib/tk/variable.rb', line 692

def set_value(val)
  self.value = val
  self
end

#set_value_type(val) ⇒ Object Also known as: value_type=


714
715
716
717
718
# File 'lib/tk/variable.rb', line 714

def set_value_type(val)
  self.default_value_type = val.class
  self.value = val
  self
end

#set_variable(var) ⇒ Object Also known as: variable=


842
843
844
845
846
# File 'lib/tk/variable.rb', line 842

def set_variable(var)
  var = var.id if var.kind_of?(TkVariable)
  self.value = var
  self
end

#set_variable_element(idxs, var) ⇒ Object


848
849
850
851
852
853
854
855
856
# File 'lib/tk/variable.rb', line 848

def set_variable_element(idxs, var)
  var = var.id if var.kind_of?(TkVariable)
  if idxs.kind_of?(Array)
    self[*idxs]=var
  else
    self[idxs]=var
  end
  self
end

#set_variable_element_type(idxs, var) ⇒ Object


864
865
866
867
# File 'lib/tk/variable.rb', line 864

def set_variable_element_type(idxs, var)
  self.set_default_element_value_type(idxs, :variable)
  self.set_variable_element(idxs, var)
end

#set_variable_type(var) ⇒ Object Also known as: variable_type=


857
858
859
860
861
862
# File 'lib/tk/variable.rb', line 857

def set_variable_type(var)
  @type = :variable
  var = var.id if var.kind_of?(TkVariable)
  self.value = var
  self
end

#set_window(win) ⇒ Object Also known as: window=


875
876
877
878
879
# File 'lib/tk/variable.rb', line 875

def set_window(win)
  win = win._value if win.kind_of?(TkVariable)
  self.value = win
  self
end

#set_window_element(idxs, win) ⇒ Object


881
882
883
884
885
886
887
888
889
# File 'lib/tk/variable.rb', line 881

def set_window_element(idxs, win)
  win = win._value if win.kind_of?(TkVariable)
  if idxs.kind_of?(Array)
    self[*idxs]=win
  else
    self[idxs]=win
  end
  self
end

#set_window_element_type(idxs, win) ⇒ Object


896
897
898
899
# File 'lib/tk/variable.rb', line 896

def set_window_element_type(idxs, win)
  self.set_default_element_value_type(idxs, :window)
  self.set_window_element(idxs, win)
end

#set_window_type(win) ⇒ Object Also known as: window_type=


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

def set_window_type(win)
  @type = :window
  self.window=(win)
  self
end

#sizeObject


440
441
442
443
# File 'lib/tk/variable.rb', line 440

def size
  INTERP._invoke_without_enc('global', @id)
  TkComm.number(INTERP._invoke_without_enc('array', 'size', @id))
end

#string_element(*idxs) ⇒ Object


966
967
968
# File 'lib/tk/variable.rb', line 966

def string_element(*idxs)
  _element_value(*idxs)
end

#thread_tkwaitObject


393
394
395
# File 'lib/tk/variable.rb', line 393

def thread_tkwait
  wait(true, true)
end

#thread_wait(check_root = false) ⇒ Object


384
385
386
# File 'lib/tk/variable.rb', line 384

def thread_wait(check_root = false)
  wait(true, check_root)
end

#tkwait(on_thread = true) ⇒ Object


387
388
389
# File 'lib/tk/variable.rb', line 387

def tkwait(on_thread = true)
  wait(on_thread, true)
end

#to_evalObject


1304
1305
1306
# File 'lib/tk/variable.rb', line 1304

def to_eval
  @id
end

#to_fObject


950
951
952
# File 'lib/tk/variable.rb', line 950

def to_f
  number(_value).to_f
end

#to_hashObject


697
698
699
700
701
702
703
# File 'lib/tk/variable.rb', line 697

def to_hash
  hash = {}
  self.keys.each{|k|
    hash[k] = self[k]
  }
  hash
end

#to_iObject Also known as: to_int


942
943
944
# File 'lib/tk/variable.rb', line 942

def to_i
  number(_value).to_i
end

#to_procObject


932
933
934
935
936
937
938
939
940
# File 'lib/tk/variable.rb', line 932

def to_proc
  cmd = self.procedure
  if cmd.respond_to?(:call)
    cmd
  else
    # cmd is a String
    cmd.to_sym.to_proc
  end
end

#to_sObject Also known as: string, to_str


957
958
959
960
# File 'lib/tk/variable.rb', line 957

def to_s
  #string(value).to_s
  _value
end

#to_symObject Also known as: symbol


995
996
997
# File 'lib/tk/variable.rb', line 995

def to_sym
  _value.intern
end

#trace(opts, cmd = Proc.new) ⇒ Object


1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
# File 'lib/tk/variable.rb', line 1377

def trace(opts, cmd = Proc.new)
  opts = _check_trace_opt(opts)
  (@trace_var ||= []).unshift([opts,cmd])

  if @trace_opts == nil
    TkVar_CB_TBL[@id] = self
    @trace_opts = opts.dup
    if USE_OLD_TRACE_OPTION_STYLE
      Tk.tk_call_without_enc('trace', 'variable',
                             @id, @trace_opts, 'rb_var ' << @id)
    else
      Tk.tk_call_without_enc('trace', 'add', 'variable',
                             @id, @trace_opts, 'rb_var ' << @id)
    end
  else
    newopts = @trace_opts.dup
    if USE_OLD_TRACE_OPTION_STYLE
      opts.each_byte{|c| newopts.concat(c.chr) unless newopts.index(c.chr)}
      if newopts != @trace_opts
        Tk.tk_call_without_enc('trace', 'vdelete',
                               @id, @trace_opts, 'rb_var ' << @id)
        @trace_opts.replace(newopts)
        Tk.tk_call_without_enc('trace', 'variable',
                               @id, @trace_opts, 'rb_var ' << @id)
      end
    else
      newopts |= opts
      unless (newopts - @trace_opts).empty?
        Tk.tk_call_without_enc('trace', 'remove', 'variable',
                               @id, @trace_opts, 'rb_var ' << @id)
        @trace_opts.replace(newopts)
        Tk.tk_call_without_enc('trace', 'add', 'variable',
                               @id, @trace_opts, 'rb_var ' << @id)
      end
    end
  end

  self
end

#trace_callback(elem, op) ⇒ Object


1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
# File 'lib/tk/variable.rb', line 1308

def trace_callback(elem, op)
  if @trace_var.kind_of? Array
    @trace_var.each{|m,e| e.call(self,elem,op) if m.index(op)}
  end
  if elem.kind_of?(String) && elem != ''
    if @trace_elem.kind_of?(Hash) && @trace_elem[elem].kind_of?(Array)
      @trace_elem[elem].each{|m,e| e.call(self,elem,op) if m.index(op)}
    end
  end
end

#trace_element(elem, opts, cmd = Proc.new) ⇒ Object


1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
# File 'lib/tk/variable.rb', line 1417

def trace_element(elem, opts, cmd = Proc.new)
  if @elem
    fail(RuntimeError,
         "invalid for a TkVariable which denotes an element of Tcl's array")
  end

  opts = _check_trace_opt(opts)

  ((@trace_elem ||= {})[elem] ||= []).unshift([opts,cmd])

  if @trace_opts == nil
    TkVar_CB_TBL[@id] = self
    @trace_opts = opts.dup
    if USE_OLD_TRACE_OPTION_STYLE
      Tk.tk_call_without_enc('trace', 'add', 'variable',
                             @id, @trace_opts, 'rb_var ' << @id)
    else
      Tk.tk_call_without_enc('trace', 'variable',
                             @id, @trace_opts, 'rb_var ' << @id)
    end
  else
    newopts = @trace_opts.dup
    if USE_OLD_TRACE_OPTION_STYLE
      opts.each_byte{|c| newopts.concat(c.chr) unless newopts.index(c.chr)}
      if newopts != @trace_opts
        Tk.tk_call_without_enc('trace', 'vdelete',
                               @id, @trace_opts, 'rb_var ' << @id)
        @trace_opts.replace(newopts)
        Tk.tk_call_without_enc('trace', 'variable',
                               @id, @trace_opts, 'rb_var ' << @id)
      end
    else
      newopts |= opts
      unless (newopts - @trace_opts).empty?
        Tk.tk_call_without_enc('trace', 'remove', 'variable',
                               @id, @trace_opts, 'rb_var ' << @id)
        @trace_opts.replace(newopts)
        Tk.tk_call_without_enc('trace', 'add', 'variable',
                               @id, @trace_opts, 'rb_var ' << @id)
      end
    end
  end

  self
end

#trace_infoObject Also known as: trace_vinfo


1463
1464
1465
1466
# File 'lib/tk/variable.rb', line 1463

def trace_info
  return [] unless @trace_var
  @trace_var.dup
end

#trace_info_for_element(elem) ⇒ Object Also known as: trace_vinfo_for_element


1469
1470
1471
1472
1473
1474
1475
1476
1477
# File 'lib/tk/variable.rb', line 1469

def trace_info_for_element(elem)
  if @elem
    fail(RuntimeError,
         "invalid for a TkVariable which denotes an element of Tcl's array")
  end
  return [] unless @trace_elem
  return [] unless @trace_elem[elem]
  @trace_elem[elem].dup
end

#trace_remove(opts, cmd) ⇒ Object Also known as: trace_delete, trace_vdelete


1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
# File 'lib/tk/variable.rb', line 1480

def trace_remove(opts,cmd)
  return self unless @trace_var.kind_of? Array

  opts = _check_trace_opt(opts)

  idx = -1
  if USE_OLD_TRACE_OPTION_STYLE
    newopts = ''
    @trace_var.each_with_index{|e, i|
      if idx < 0 && e[1] == cmd
        diff = false
        ['a', 'r', 'w', 'u'].each{|c|
          break if (diff = e[0].index(c) ^ opts.index(c))
        }
        unless diff
          #find
          idx = i
          next
        end
      end
      e[0].each_byte{|c| newopts.concat(c.chr) unless newopts.index(c.chr)}
    }
  else
    newopts = []
    @trace_var.each_with_index{|e, i|
      if idx < 0 && e[1] == cmd &&
          e[0].size == opts.size && (e[0] - opts).empty?
        # find
        idx = i
        next
      end
      newopts |= e[0]
    }
  end

  if idx >= 0
    @trace_var.delete_at(idx)
  else
    return self
  end

  (@trace_elem ||= {}).each{|elem|
    @trace_elem[elem].each{|e|
      if USE_OLD_TRACE_OPTION_STYLE
        e[0].each_byte{|c| newopts.concat(c.chr) unless newopts.index(c.chr)}
      else
        newopts |= e[0]
      end
    }
  }

  if USE_OLD_TRACE_OPTION_STYLE
    diff = false
    @trace_opts.each_byte{|c| break if (diff = ! newopts.index(c))}
    if diff
      Tk.tk_call_without_enc('trace', 'vdelete',
                             @id, @trace_opts, 'rb_var ' << @id)
      @trace_opts.replace(newopts)
      unless @trace_opts.empty?
        Tk.tk_call_without_enc('trace', 'variable',
                               @id, @trace_opts, 'rb_var ' << @id)
      end
    end
  else
    unless (@trace_opts - newopts).empty?
      Tk.tk_call_without_enc('trace', 'remove', 'variable',
                             @id, @trace_opts, 'rb_var ' << @id)
      @trace_opts.replace(newopts)
      unless @trace_opts.empty?
        Tk.tk_call_without_enc('trace', 'add', 'variable',
                               @id, @trace_opts, 'rb_var ' << @id)
      end
    end
  end

  self
end

#trace_remove_for_element(elem, opts, cmd) ⇒ Object Also known as: trace_delete_for_element, trace_vdelete_for_element


1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
# File 'lib/tk/variable.rb', line 1560

def trace_remove_for_element(elem,opts,cmd)
  if @elem
    fail(RuntimeError,
         "invalid for a TkVariable which denotes an element of Tcl's array")
  end
  return self unless @trace_elem.kind_of? Hash
  return self unless @trace_elem[elem].kind_of? Array

  opts = _check_trace_opt(opts)

  idx = -1
  if USE_OLD_TRACE_OPTION_STYLE
    @trace_elem[elem].each_with_index{|e, i|
      if idx < 0 && e[1] == cmd
        diff = false
        ['a', 'r', 'w', 'u'].each{|c|
          break if (diff = e[0].index(c) ^ opts.index(c))
        }
        unless diff
          #find
          idx = i
          next
        end
      end
    }
  else
    @trace_elem[elem].each_with_index{|e, i|
      if idx < 0 && e[1] == cmd &&
          e[0].size == opts.size && (e[0] - opts).empty?
        # find
        idx = i
        next
      end
    }
  end

  if idx >= 0
    @trace_elem[elem].delete_at(idx)
  else
    return self
  end

  if USE_OLD_TRACE_OPTION_STYLE
    newopts = ''
    @trace_var.each{|e|
      e[0].each_byte{|c| newopts.concat(c.chr) unless newopts.index(c.chr)}
    }
    @trace_elem.each{|elem|
      @trace_elem[elem].each{|e|
        e[0].each_byte{|c| newopts.concat(c.chr) unless newopts.index(c.chr)}
      }
    }
  else
    newopts = []
    @trace_var.each{|e|
      newopts |= e[0]
    }
    @trace_elem.each{|elem|
      @trace_elem[elem].each{|e|
        e[0].each_byte{|c| newopts.concat(c.chr) unless newopts.index(c.chr)}
      }
    }
  end

  if USE_OLD_TRACE_OPTION_STYLE
    diff = false
    @trace_opts.each_byte{|c| break if (diff = ! newopts.index(c))}
    if diff
      Tk.tk_call_without_enc('trace', 'vdelete',
                             @id, @trace_opts, 'rb_var ' << @id)
      @trace_opts.replace(newopts)
      unless @trace_opts.empty?
        Tk.tk_call_without_enc('trace', 'variable',
                               @id, @trace_opts, 'rb_var ' << @id)
      end
    end
  else
    unless (@trace_opts - newopts).empty?
      Tk.tk_call_without_enc('trace', 'remove', 'variable',
                             @id, @trace_opts, 'rb_var ' << @id)
      @trace_opts.replace(newopts)
      unless @trace_opts.empty?
        Tk.tk_call_without_enc('trace', 'add', 'variable',
                               @id, @trace_opts, 'rb_var ' << @id)
      end
    end
  end

  self
end

#undef_defaultObject


139
140
141
142
143
# File 'lib/tk/variable.rb', line 139

def undef_default
  @default_val = nil
  @def_default = false
  self
end

#unset(*elems) ⇒ Object Also known as: remove


544
545
546
547
548
549
550
551
# File 'lib/tk/variable.rb', line 544

def unset(*elems)
  if elems.empty?
    INTERP._unset_global_var(@id)
  else
    index = elems.collect{|idx| _get_eval_string(idx, true)}.join(',')
    INTERP._unset_global_var2(@id, index)
  end
end

#update(hash) ⇒ Object


453
454
455
456
457
458
459
# File 'lib/tk/variable.rb', line 453

def update(hash)
  if (is_scalar?)
    fail RuntimeError, 'cannot update a scalar variable'
  end
  hash.each{|k,v| self[k] = v}
  self
end

#valueObject


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

def value
  _to_default_type(_value)
end

#value=(val) ⇒ Object


482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
# File 'lib/tk/variable.rb', line 482

def value=(val)
  val = val._value if !@type && @type != :variable && val.kind_of?(TkVariable)
  if val.kind_of?(Hash)
    self.clear
    val.each{|k, v|
      #INTERP._set_global_var2(@id, _toUTF8(_get_eval_string(k)),
      #                       _toUTF8(_get_eval_string(v)))
      INTERP._set_global_var2(@id, _get_eval_string(k, true),
                              _get_eval_string(v, true))
    }
    self.value
#    elsif val.kind_of?(Array)
=begin
    INTERP._set_global_var(@id, '')
    val.each{|v|
      #INTERP._set_variable(@id, _toUTF8(_get_eval_string(v)),
      INTERP._set_variable(@id, _get_eval_string(v, true),
                           TclTkLib::VarAccessFlag::GLOBAL_ONLY   |
                           TclTkLib::VarAccessFlag::LEAVE_ERR_MSG |
                           TclTkLib::VarAccessFlag::APPEND_VALUE  |
                           TclTkLib::VarAccessFlag::LIST_ELEMENT)
    }
    self.value
=end
#      _fromUTF8(INTERP._set_global_var(@id, array2tk_list(val, true)))
  else
    #_fromUTF8(INTERP._set_global_var(@id, _toUTF8(_get_eval_string(val))))
    _fromUTF8(INTERP._set_global_var(@id, _get_eval_string(val, true)))
  end
end

#variableObject


835
836
837
838
# File 'lib/tk/variable.rb', line 835

def variable
  # keeps a Tcl's variable name
  TkVarAccess.new(self._value)
end

#variable_element(*idxs) ⇒ Object


839
840
841
# File 'lib/tk/variable.rb', line 839

def variable_element(*idxs)
  TkVarAccess.new(_element_value(*idxs))
end

#wait(on_thread = false, check_root = false) ⇒ Object


362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
# File 'lib/tk/variable.rb', line 362

def wait(on_thread = false, check_root = false)
  if $SAFE >= 4
    fail SecurityError, "can't wait variable at $SAFE >= 4"
  end
  on_thread &= (Thread.list.size != 1)
  if on_thread
    if check_root
      INTERP._thread_tkwait('variable', @id)
    else
      INTERP._thread_vwait(@id)
    end
  else
    if check_root
      INTERP._invoke_without_enc('tkwait', 'variable', @id)
    else
      INTERP._invoke_without_enc('vwait', @id)
    end
  end
end

#windowObject


869
870
871
# File 'lib/tk/variable.rb', line 869

def window
  TkComm.window(self._value)
end

#window_element(*idxs) ⇒ Object


872
873
874
# File 'lib/tk/variable.rb', line 872

def window_element(*idxs)
  TkComm.window(_element_value(*idxs))
end

#zero?Boolean

Returns:

  • (Boolean)

1276
1277
1278
# File 'lib/tk/variable.rb', line 1276

def zero?
  numeric.zero?
end

#|(other) ⇒ Object


1190
1191
1192
1193
1194
1195
1196
# File 'lib/tk/variable.rb', line 1190

def |(other)
  if other.kind_of?(Array)
    self.to_a | other.to_a
  else
    self.to_i | other.to_i
  end
end