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 = 
Hash.new{|hash,key| hash[key] = {}}.taint

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 TkCore

TkCore::EventFlag, TkCore::INTERP, TkCore::WIDGET_DESTROY_HOOK

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, UTF8_String, add_kinsoku, bell, bell_on_display, const_missing, current_grabs, cursor_display, 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, 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, ungrid, unload_tcllibrary, unpack, unplace, update, update, update_idletasks, utf_to_backslash, utf_to_backslash_sequence

Methods included from Tk::Encoding

#encoding, #encoding=, #encoding_convertfrom, #encoding_convertto, #encoding_dirs, #encoding_dirs=, #encoding_names, #encoding_system, #encoding_system=

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, #bind, #bind_all, #bind_append, #bind_append_all, #bind_remove, #bind_remove_all, #bindinfo, #bindinfo_all, #image_obj, #install_cmd, #subst, #uninstall_cmd

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_str, #num_or_str, number, #number, string, #string, uninstall_cmd

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

#[]=, #cget, #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.



88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/tk/msgcat.rb', line 88

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 



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

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



100
101
102
 
# File 'lib/tk/msgcat.rb', line 100

def msgcat_ext
  @msgcat_ext
end

Class Method Details

.[] ⇒ Object

*args ::= form, arg, arg, ...



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

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
 
# 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 >-------"
      msg.instance_variable_set(:@encoding, 'utf-8')
    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 



284
285
286
 
# File 'lib/tk/msgcat.rb', line 284

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

.load(dir) ⇒ Object 



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

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

.load_rb(dir) ⇒ Object 



192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/tk/msgcat.rb', line 192

def self.load_rb(dir)
  count = 0
  preferences().each{|loc|
    file = File.join(dir, loc + self::MSGCAT_EXT)
    if File.readable?(file)
      count += 1
      eval(open(file){|f| f.read})
    end
  }
  count
end

.load_tk(dir) ⇒ Object 



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

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

.locale ⇒ Object 



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

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

.locale=(locale) ⇒ Object 



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

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

.maxlen(*src_strings) ⇒ Object 



160
161
162
 
# File 'lib/tk/msgcat.rb', line 160

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

.mc ⇒ Object

*args ::= form, arg, arg, ...



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

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 



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

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

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



225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/tk/msgcat.rb', line 225

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(tk_call_without_enc('::msgcat::mcset', 
                                       locale, 
                                       _get_eval_string(src_str, true), 
                                       trans_str))
  else
    Tk.UTF8_String(tk_call_without_enc('::msgcat::mcset', 
                                       locale, 
                                       _get_eval_string(src_str, true)))
  end
end

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



255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/tk/msgcat.rb', line 255

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_Stirng(_toUTF8(trans, enc))
    else
      list << _get_eval_string(src, true) << ''
    end
  }
  number(tk_call_without_enc('::msgcat::mcmset', locale, list))
end

.translate(*args) ⇒ Object

*args ::= form, arg, arg, ...



140
141
142
143
144
145
 
# File 'lib/tk/msgcat.rb', line 140

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 



287
288
289
 
# File 'lib/tk/msgcat.rb', line 287

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 



208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/tk/msgcat.rb', line 208

def load_rb(dir)
  count = 0
  preferences().each{|loc|
    file = File.join(dir, loc + @msgcat_ext)
    if File.readable?(file)
      count += 1
      @namespace.eval(open(file){|f| f.read})
    end
  }
  count
end

#load_tk(dir) ⇒ Object 



204
205
206
 
# File 'lib/tk/msgcat.rb', line 204

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

#locale ⇒ Object 



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

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

#locale=(locale) ⇒ Object 



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

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

#maxlen(*src_strings) ⇒ Object 



163
164
165
 
# File 'lib/tk/msgcat.rb', line 163

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

#preferences ⇒ Object 



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

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

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



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/tk/msgcat.rb', line 238

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{
                     tk_call_without_enc('::msgcat::mcset', 
                                         locale, 
                                         _get_eval_string(src_str, true), 
                                         trans_str)
                   })
  else
    Tk.UTF8_String(@namespace.eval{
                     tk_call_without_enc('::msgcat::mcset', 
                                         locale, 
                                         _get_eval_string(src_str, true))})
  end
end

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



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/tk/msgcat.rb', line 268

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

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



150
151
152
153
154
155
156
 
# File 'lib/tk/msgcat.rb', line 150

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