Class: TkMsgCatalog

Inherits:
TkObject show all
Extended by:
Tk
Includes:
TkCore
Defined in:
lib/tk/msgcat.rb

Overview

class TkMsgCatalog

Constant Summary collapse

TkCommandNames =

extend TkMsgCatalog

[
  '::msgcat::mc'.freeze,
  '::msgcat::mcmax'.freeze,
  '::msgcat::mclocale'.freeze,
  '::msgcat::mcpreferences'.freeze,
  '::msgcat::mcload'.freeze,
  '::msgcat::mcset'.freeze,
  '::msgcat::mcmset'.freeze,
  '::msgcat::mcunknown'.freeze
].freeze
PACKAGE_NAME = 
'msgcat'.freeze
MSGCAT_EXT = 
'.msg'
UNKNOWN_CBTBL = 
TkUtil.untrust(Hash.new{|hash,key| hash[key] = {}})

Constants included from Tk

Tk::AUTO_PATH, Tk::Fontchooser, 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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance 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__, _replace_toplevel_aliases, add_kinsoku, backup_current_topdef, bell, bell_on_display, const_missing, current_grabs, cursor_display, default_widget_set, default_widget_set=, define_topalias, define_topobj, 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, regist_sym_for_loaded_file, replace_topalias, replace_topobj, root, set_topalias, 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, topalias_defined?, toplevel_aliases_on_widget_set, topobj_defined?, 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_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, #bool, eval_cmd, #hash_kv, hash_kv, install_cmd, num_or_nil, #num_or_nil, num_or_str, #num_or_str, number, #number, string, #string, uninstall_cmd, untrust

Methods inherited from TkObject

#destroy, #epath, #event_generate, #path, #tk_send, #tk_send_to_list, #tk_send_to_list_with_enc, #tk_send_to_list_without_enc, #tk_send_to_simplelist, #tk_send_to_simplelist_with_enc, #tk_send_to_simplelist_without_enc, #tk_send_with_enc, #tk_send_without_enc, #to_eval

Methods included from TkBindCore

#bind, #bind_append, #bind_remove, #bindinfo

Methods included from TkConfigMethod

#[]=, __IGNORE_UNKNOWN_CONFIGURE_OPTION__, #__check_available_configure_options, __set_IGNORE_UNKNOWN_CONFIGURE_OPTION__!, #cget, #cget_strict, #cget_tkstring, #config_hash_kv, #configinfo, #configure, #configure_cmd, #current_configinfo

Methods included from TkTreatFont

#font_configinfo, #font_configure, #font_copy, #kanjifont_configure, #kanjifont_copy, #latinfont_configure, #latinfont_copy

Methods inherited from TkKernel

new

Constructor Details

#initialize(namespace = nil) ⇒ TkMsgCatalog

Returns a new instance of TkMsgCatalog.



92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/tk/msgcat.rb', line 92

def initialize(namespace = nil)
  if namespace.kind_of?(TkNamespace)
    @namespace = namespace
  elsif namespace == nil
    @namespace = TkNamespace.new('::')  # global namespace
  else
    @namespace = TkNamespace.new(namespace)
  end
  @path = @namespace.path

  @msgcat_ext = '.msg'
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(id, *args) ⇒ 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
 
# File 'lib/tk/msgcat.rb', line 106

def method_missing(id, *args)
  # locale(src, trans) ==> set_translation(locale, src, trans)
  loc = id.id2name
  case args.length
  when 0 # set locale
    self.locale=(loc)

  when 1 # src only, or trans_list
    if args[0].kind_of?(Array)
      # trans_list
      #list = args[0].collect{|src, trans|
      #  [ Tk::UTF8_String.new(src), Tk::UTF8_String.new(trans) ]
      #}
      self.set_translation_list(loc, args[0])
    else
      # src
      #self.set_translation(loc, Tk::UTF8_String.new(args[0]))
      self.set_translation(loc, args[0])
    end

  when 2 # src and trans, or, trans_list and enc
    if args[0].kind_of?(Array)
      # trans_list
      self.set_translation_list(loc, *args)
    else
      #self.set_translation(loc, args[0], Tk::UTF8_String.new(args[1]))
      self.set_translation(loc, *args)
    end

  when 3 # src and trans and enc
    self.set_translation(loc, *args)

  else
    super(id, *args)
#      fail NameError, "undefined method `#{name}' for #{self.to_s}", error_at

  end
end

Instance Attribute Details

#msgcat_ext ⇒ Object

Returns the value of attribute msgcat_ext



104
105
106
 
# File 'lib/tk/msgcat.rb', line 104

def msgcat_ext
  @msgcat_ext
end

Class Method Details

.[] ⇒ Object

*args ::= form, arg, arg, …



154
155
156
157
158
159
 
# File 'lib/tk/msgcat.rb', line 154

def self.translate(*args)
  dst = args.collect{|src|
    tk_call_without_enc('::msgcat::mc', _get_eval_string(src, true))
  }
  Tk.UTF8_String(sprintf(*dst))
end

.callback(namespace, locale, src_str, *args) ⇒ Object 



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

def self.callback(namespace, locale, src_str, *args)
  src_str = sprintf(src_str, *args) unless args.empty?
  cmd_tbl = TkMsgCatalog::UNKNOWN_CBTBL[TkCore::INTERP.__getip]
  cmd = cmd_tbl[namespace]
  cmd = cmd_tbl['::'] unless cmd  # use global scope as interp default
  return src_str unless cmd       # no cmd -> return src-str (default action)
  begin
    cmd.call(locale, src_str)
  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
end

.def_unknown_proc(cmd = Proc.new) ⇒ Object 



291
292
293
 
# File 'lib/tk/msgcat.rb', line 291

def self.def_unknown_proc(cmd=Proc.new)
  TkMsgCatalog::UNKNOWN_CBTBL[TkCore::INTERP.__getip]['::'] = cmd
end

.load(dir) ⇒ Object 



234
235
236
 
# File 'lib/tk/msgcat.rb', line 234

def self.load(dir)
  self.load_rb(dir)
end

.load_rb(dir) ⇒ Object 



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/tk/msgcat.rb', line 198

def self.load_rb(dir)
  count = 0
  preferences().each{|loc|
    file = File.join(dir, loc + self::MSGCAT_EXT)
    if File.readable?(file)
      count += 1
      if TkCore::WITH_ENCODING
        eval(IO.read(file, :encoding=>"ASCII-8BIT"))
      else
        eval(IO.read(file))
      end
    end
  }
  count
end

.load_tk(dir) ⇒ Object 



194
195
196
 
# File 'lib/tk/msgcat.rb', line 194

def self.load_tk(dir)
  number(tk_call('::msgcat::mcload', dir))
end

.locale ⇒ Object 



173
174
175
 
# File 'lib/tk/msgcat.rb', line 173

def self.locale
  tk_call('::msgcat::mclocale')
end

.locale=(locale) ⇒ Object 



180
181
182
 
# File 'lib/tk/msgcat.rb', line 180

def self.locale=(locale)
  tk_call('::msgcat::mclocale', locale)
end

.maxlen(*src_strings) ⇒ Object 



166
167
168
 
# File 'lib/tk/msgcat.rb', line 166

def self.maxlen(*src_strings)
  tk_call('::msgcat::mcmax', *src_strings).to_i
end

.mc ⇒ Object

*args ::= form, arg, arg, …



153
154
155
156
157
158
 
# File 'lib/tk/msgcat.rb', line 153

def self.translate(*args)
  dst = args.collect{|src|
    tk_call_without_enc('::msgcat::mc', _get_eval_string(src, true))
  }
  Tk.UTF8_String(sprintf(*dst))
end

.package_name ⇒ Object 



27
28
29
 
# File 'lib/tk/msgcat.rb', line 27

def self.package_name
  PACKAGE_NAME
end

.preferences ⇒ Object 



187
188
189
 
# File 'lib/tk/msgcat.rb', line 187

def self.preferences
  tk_split_simplelist(tk_call('::msgcat::mcpreferences'))
end

.set_translation(locale, src_str, trans_str = None, enc = 'utf-8') ⇒ Object 



239
240
241
242
243
244
245
246
 
# File 'lib/tk/msgcat.rb', line 239

def self.set_translation(locale, src_str, trans_str=None, enc='utf-8')
  if trans_str && trans_str != None
    trans_str = Tk.UTF8_String(_toUTF8(trans_str, enc))
    Tk.UTF8_String(ip_eval_without_enc("::msgcat::mcset {#{locale}} {#{_get_eval_string(src_str, true)}} {#{trans_str}}"))
  else
    Tk.UTF8_String(ip_eval_without_enc("::msgcat::mcset {#{locale}} {#{_get_eval_string(src_str, true)}}"))
  end
end

.set_translation_list(locale, trans_list, enc = 'utf-8') ⇒ Object 



260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/tk/msgcat.rb', line 260

def self.set_translation_list(locale, trans_list, enc='utf-8')
  # trans_list ::= [ [src, trans], [src, trans], ... ]
  list = []
  trans_list.each{|src, trans|
    if trans && trans != None
      list << _get_eval_string(src, true)
      list << Tk.UTF8_String(_toUTF8(trans, enc))
    else
      list << _get_eval_string(src, true) << ''
    end
  }
  #number(tk_call_without_enc('::msgcat::mcmset', locale, list))
  number(ip_eval_without_enc("::msgcat::mcmset {#{locale}} {#{_get_eval_string(list)}}"))
end

.translate(*args) ⇒ Object

*args ::= form, arg, arg, …



146
147
148
149
150
151
 
# File 'lib/tk/msgcat.rb', line 146

def self.translate(*args)
  dst = args.collect{|src|
    tk_call_without_enc('::msgcat::mc', _get_eval_string(src, true))
  }
  Tk.UTF8_String(sprintf(*dst))
end

Instance Method Details

#def_unknown_proc(cmd = Proc.new) ⇒ Object 



294
295
296
 
# File 'lib/tk/msgcat.rb', line 294

def def_unknown_proc(cmd=Proc.new)
  TkMsgCatalog::UNKNOWN_CBTBL[TkCore::INTERP.__getip][@namespace.path] = cmd
end

#load_rb(dir) ⇒ Object Also known as: load 



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/tk/msgcat.rb', line 218

def load_rb(dir)
  count = 0
  preferences().each{|loc|
    file = File.join(dir, loc + @msgcat_ext)
    if File.readable?(file)
      count += 1
      if TkCore::WITH_ENCODING
        @namespace.eval(IO.read(file, :encoding=>"ASCII-8BIT"))
      else
        @namespace.eval(IO.read(file))
      end
    end
  }
  count
end

#load_tk(dir) ⇒ Object 



214
215
216
 
# File 'lib/tk/msgcat.rb', line 214

def load_tk(dir)
  number(@namespace.eval{tk_call('::msgcat::mcload', dir)})
end

#locale ⇒ Object 



176
177
178
 
# File 'lib/tk/msgcat.rb', line 176

def locale
  @namespace.eval{tk_call('::msgcat::mclocale')}
end

#locale=(locale) ⇒ Object 



183
184
185
 
# File 'lib/tk/msgcat.rb', line 183

def locale=(locale)
  @namespace.eval{tk_call('::msgcat::mclocale', locale)}
end

#maxlen(*src_strings) ⇒ Object 



169
170
171
 
# File 'lib/tk/msgcat.rb', line 169

def maxlen(*src_strings)
  @namespace.eval{tk_call('::msgcat::mcmax', *src_strings).to_i}
end

#preferences ⇒ Object 



190
191
192
 
# File 'lib/tk/msgcat.rb', line 190

def preferences
  tk_split_simplelist(@namespace.eval{tk_call('::msgcat::mcpreferences')})
end

#set_translation(locale, src_str, trans_str = None, enc = 'utf-8') ⇒ Object 



247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/tk/msgcat.rb', line 247

def set_translation(locale, src_str, trans_str=None, enc='utf-8')
  if trans_str && trans_str != None
    trans_str = Tk.UTF8_String(_toUTF8(trans_str, enc))
    Tk.UTF8_String(@namespace.eval{
                     ip_eval_without_enc("::msgcat::mcset {#{locale}} {#{_get_eval_string(src_str, true)}} {#{trans_str}}")
                   })
  else
    Tk.UTF8_String(@namespace.eval{
                     ip_eval_without_enc("::msgcat::mcset {#{locale}} {#{_get_eval_string(src_str, true)}}")
                   })
  end
end

#set_translation_list(locale, trans_list, enc = 'utf-8') ⇒ Object 



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/tk/msgcat.rb', line 274

def set_translation_list(locale, trans_list, enc='utf-8')
  # trans_list ::= [ [src, trans], [src, trans], ... ]
  list = []
  trans_list.each{|src, trans|
    if trans && trans != None
      list << _get_eval_string(src, true)
      list << Tk.UTF8_String(_toUTF8(trans, enc))
    else
      list << _get_eval_string(src, true) << ''
    end
  }
  number(@namespace.eval{
           #tk_call_without_enc('::msgcat::mcmset', locale, list)
           ip_eval_without_enc("::msgcat::mcmset {#{locale}} {#{_get_eval_string(list)}}")
         })
end

#translate(*args) ⇒ Object Also known as: mc, [] 



156
157
158
159
160
161
162
 
# File 'lib/tk/msgcat.rb', line 156

def translate(*args)
  dst = args.collect{|src|
    @namespace.eval{tk_call_without_enc('::msgcat::mc',
                                        _get_eval_string(src, true))}
  }
  Tk.UTF8_String(sprintf(*dst))
end