Module: TkOptionDB

Extended by:
Tk
Includes:
Tk
Defined in:
lib/tk/optiondb.rb

Defined Under Namespace

Modules: Priority

Constant Summary collapse

TkCommandNames =
['option'.freeze].freeze
RAND_BASE_CNT =
[0]
RAND_BASE_HEAD =
'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
RAND_BASE_CHAR =
RAND_BASE_HEAD + 'abcdefghijklmnopqrstuvwxyz0123456789_'
@@resource_proc_class =

support procs on the resource database

Class.new

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

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

Class Method Summary collapse

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

Methods included from TkCore

#_tk_call_to_list_core, #after, #after_cancel, #after_idle, #appname, #appsend, #appsend_deny, #appsend_displayof, callback, #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_split_escstr, tk_split_list, tk_split_simplelist, tk_split_sublist, 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, callback, 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

Class Method Details

.__create_new_class(klass, func, safe = 4, add = false, parent = nil) ⇒ Object

def __create_new_class(klass, func, safe = 4, add = false, parent = nil)

  klass = klass.to_s if klass.kind_of? Symbol
  unless (?A..?Z) === klass[0]
    fail ArgumentError, "bad string '#{klass}' for class name"
  end
  unless func.kind_of? Array
    fail ArgumentError, "method-list must be Array"
  end
  func_str = func.join(' ')
  if parent == nil
    install_win(parent)
  elsif parent <= @@resource_proc_class
    install_win(parent::CARRIER)
  else
    fail ArgumentError, "parent must be Resource-Proc class"
  end
  carrier = Tk.tk_call_without_enc('frame', @path, '-class', klass)

  body = <<-"EOD"
    class #{klass} < TkOptionDB.module_eval('@@resource_proc_class')
      CARRIER    = '#{carrier}'.freeze
      METHOD_TBL = TkCore::INTERP.create_table
      ADD_METHOD = #{add}
      SAFE_MODE  = #{safe}
      %w(#{func_str}).each{|f| METHOD_TBL[f.intern] = nil }
    end
  EOD

  if parent.kind_of?(Class) && parent <= @@resource_proc_class
    parent.class_eval(body)
    eval(parent.name + '::' + klass)
  else
    eval(body)
    eval('TkOptionDB::' + klass)
  end
end


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
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
# File 'lib/tk/optiondb.rb', line 254

def __create_new_class(klass, func, safe = 4, add = false, parent = nil)
  if klass.kind_of?(TkWindow)
    carrier = klass.path
    CmdClassID.mutex.synchronize{
      klass = CmdClassID.join(TkCore::INTERP._ip_id_)
      CmdClassID[1].succ!
    }
    parent = nil # ignore parent
  else
    klass = klass.to_s if klass.kind_of?(Symbol)
    unless (?A..?Z) === klass[0]
      fail ArgumentError, "bad string '#{klass}' for class name"
    end
    if parent == nil
      install_win(nil)
    elsif parent.kind_of?(TkWindow)
      install_win(parent.path)
    elsif parent <= @@resource_proc_class
      install_win(parent::CARRIER)
    else
      fail ArgumentError, "parent must be Resource-Proc class"
    end
    carrier = Tk.tk_call_without_enc('frame', @path, '-class', klass)
  end

  unless func.kind_of?(Array)
    fail ArgumentError, "method-list must be Array"
  end
  func_str = func.join(' ')

  if parent.kind_of?(Class) && parent <= @@resource_proc_class
    cmd_klass = Class.new(parent)
  else
    cmd_klass = Class.new(TkOptionDB.module_eval('@@resource_proc_class'))
  end
  cmd_klass.const_set(:CARRIER, carrier.dup.freeze)

  cmd_klass.instance_variable_set('@method_tbl', TkCore::INTERP.create_table)
  cmd_klass.instance_variable_set('@add_method', add)
  cmd_klass.instance_variable_set('@safe_mode', safe)
  func.each{|f|
    cmd_klass.instance_variable_get('@method_tbl')[f.to_s.intern] = nil
  }
=begin
  cmd_klass.const_set(:METHOD_TBL, TkCore::INTERP.create_table)
  cmd_klass.const_set(:ADD_METHOD, add)
  cmd_klass.const_set(:SAFE_MODE, safe)
  func.each{|f| cmd_klass::METHOD_TBL[f.to_s.intern] = nil }
=end

  cmd_klass
end

.__get_random_basenameObject



333
334
335
336
337
338
339
340
341
342
# File 'lib/tk/optiondb.rb', line 333

def __get_random_basename
  name = '%s%03d' % [RAND_BASE_HEAD[rand(RAND_BASE_HEAD.size),1],
                     RAND_BASE_CNT[0]]
  len = RAND_BASE_CHAR.size
  (6+rand(10)).times{
    name << RAND_BASE_CHAR[rand(len),1]
  }
  RAND_BASE_CNT[0] = RAND_BASE_CNT[0] + 1
  name
end

.__remove_methods_of_proc_class(klass) ⇒ Object



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
# File 'lib/tk/optiondb.rb', line 309

def __remove_methods_of_proc_class(klass)
  # for security, make these methods invalid
  class << klass
    def __null_method(*args); nil; end
    [ :class_eval, :name, :superclass, :clone, :dup, :autoload, :autoload?,
      :ancestors, :const_defined?, :const_get, :const_set, :const_missing,
      :class_variables, :constants, :included_modules, :instance_methods,
      :method_defined?, :module_eval, :private_instance_methods,
      :protected_instance_methods, :public_instance_methods,
      :singleton_methods, :remove_const, :remove_method, :undef_method,
      :to_s, :inspect, :display, :method, :methods, :respond_to?,
      :instance_variable_get, :instance_variable_set, :instance_method,
      :instance_eval, :instance_exec, :instance_variables, :kind_of?, :is_a?,
      :private_methods, :protected_methods, :public_methods ].each{|m|
      alias_method(m, :__null_method)
    }
  end
end

.add(pat, value, pri = None) ⇒ Object



24
25
26
27
28
29
# File 'lib/tk/optiondb.rb', line 24

def add(pat, value, pri=None)
  # if $SAFE >= 4
  #   fail SecurityError, "can't call 'TkOptionDB.add' at $SAFE >= 4"
  # end
  tk_call('option', 'add', pat, value, pri)
end

.clearObject



30
31
32
33
34
35
# File 'lib/tk/optiondb.rb', line 30

def clear
  # if $SAFE >= 4
  #   fail SecurityError, "can't call 'TkOptionDB.crear' at $SAFE >= 4"
  # end
  tk_call_without_enc('option', 'clear')
end

.eval_under_random_base(parent = nil, &b) ⇒ Object



359
360
361
362
363
364
365
366
# File 'lib/tk/optiondb.rb', line 359

def eval_under_random_base(parent = nil, &b)
  new_klass = __create_new_class(__get_random_basename(),
                                 [], 4, false, parent)
  ret = new_klass.class_eval(&b) if block_given?
  __remove_methods_of_proc_class(new_klass)
  new_klass.freeze
  ret
end

.get(win, name, klass) ⇒ Object



36
37
38
# File 'lib/tk/optiondb.rb', line 36

def get(win, name, klass)
  tk_call('option', 'get', win ,name, klass)
end

.new_proc_class(klass, func, safe = 4, add = false, parent = nil, &b) ⇒ Object

define new proc class : If you want to modify the new class or create a new subclass, you must do such operation in the block parameter. Because the created class is flozen after evaluating the block.



350
351
352
353
354
355
356
# File 'lib/tk/optiondb.rb', line 350

def new_proc_class(klass, func, safe = 4, add = false, parent = nil, &b)
  new_klass = __create_new_class(klass, func, safe, add, parent)
  new_klass.class_eval(&b) if block_given?
  __remove_methods_of_proc_class(new_klass)
  new_klass.freeze
  new_klass
end

.new_proc_class_random(klass, func, safe = 4, add = false, &b) ⇒ Object



369
370
371
372
373
# File 'lib/tk/optiondb.rb', line 369

def new_proc_class_random(klass, func, safe = 4, add = false, &b)
  eval_under_random_base(){
    TkOptionDB.new_proc_class(klass, func, safe, add, self, &b)
  }
end

.read_entries(file, f_enc = nil) ⇒ Object



45
46
47
48
49
50
51
52
53
54
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
# File 'lib/tk/optiondb.rb', line 45

def read_entries(file, f_enc=nil)
  if TkCore::INTERP.safe?
    fail SecurityError,
      "can't call 'TkOptionDB.read_entries' on a safe interpreter"
  end

  i_enc = ((Tk.encoding)? Tk.encoding : Tk.encoding_system)

  unless f_enc
    f_enc = i_enc
  end

  ent = []
  cline = ''
  open(file, 'r') {|f|
    while line = f.gets
      #cline += line.chomp!
      cline.concat(line.chomp!)
      case cline
      when /\\$/    # continue
        cline.chop!
        next
      when /^\s*(!|#)/     # coment
        cline = ''
        next
      when /^([^:]+):(.*)$/
        pat = $1.strip
        val = $2.lstrip
        p "ResourceDB: #{[pat, val].inspect}" if $DEBUG
        pat = TkCore::INTERP._toUTF8(pat, f_enc)
        pat = TkCore::INTERP._fromUTF8(pat, i_enc)
        val = TkCore::INTERP._toUTF8(val, f_enc)
        val = TkCore::INTERP._fromUTF8(val, i_enc)
        ent << [pat, val]
        cline = ''
      else          # unknown --> ignore
        cline = ''
        next
      end
    end
  }
  ent
end

.read_fileObject



42
43
44
# File 'lib/tk/optiondb.rb', line 42

def readfile(file, pri=None)
  tk_call('option', 'readfile', file, pri)
end

.read_with_encoding(file, f_enc = nil, pri = None) ⇒ Object



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
# File 'lib/tk/optiondb.rb', line 90

def read_with_encoding(file, f_enc=nil, pri=None)
  # try to read the file as an OptionDB file
  read_entries(file, f_enc).each{|pat, val|
    add(pat, val, pri)
  }

=begin
  i_enc = Tk.encoding()

  unless f_enc
    f_enc = i_enc
  end

  cline = ''
  open(file, 'r') {|f|
    while line = f.gets
      cline += line.chomp!
      case cline
      when /\\$/    # continue
        cline.chop!
        next
      when /^\s*!/     # coment
        cline = ''
        next
      when /^([^:]+):\s(.*)$/
        pat = $1
        val = $2
        p "ResourceDB: #{[pat, val].inspect}" if $DEBUG
        pat = TkCore::INTERP._toUTF8(pat, f_enc)
        pat = TkCore::INTERP._fromUTF8(pat, i_enc)
        val = TkCore::INTERP._toUTF8(val, f_enc)
        val = TkCore::INTERP._fromUTF8(val, i_enc)
        add(pat, val, pri)
        cline = ''
      else          # unknown --> ignore
        cline = ''
        next
      end
    end
  }
=end
end

.readfile(file, pri = None) ⇒ Object



39
40
41
# File 'lib/tk/optiondb.rb', line 39

def readfile(file, pri=None)
  tk_call('option', 'readfile', file, pri)
end