Module: GetText::TextDomainManager
- Extended by:
- TextDomainManager
- Included in:
- TextDomainManager
- Defined in:
- lib/gettext/runtime/textdomain_manager.rb
Constant Summary collapse
- @@textdomain_pool =
{}
- @@textdomain_group_pool =
{}
- @@output_charset =
nil
- @@gettext_classes =
[]
- @@singular_message_cache =
{}
- @@plural_message_cache =
{}
- @@cached =
! $DEBUG
Instance Method Summary collapse
-
#bind_to(klass, domainname, options = {}) ⇒ Object
bind textdomain to the class.
-
#cached=(val) ⇒ Object
Set the value whether cache messages or not.
-
#cached? ⇒ Boolean
Return the cached value.
-
#clear_all_textdomains ⇒ Object
for testing.
-
#clear_caches ⇒ Object
for testing.
-
#create_or_find_textdomain(name, path, charset) ⇒ Object
:nodoc:.
-
#create_or_find_textdomain_group(klass) ⇒ Object
:nodoc:.
-
#each_textdomains(klass) ⇒ Object
:nodoc:.
-
#output_charset ⇒ Object
Gets the output charset.
-
#output_charset=(charset) ⇒ Object
Sets the output charset.The program can have a output charset.
-
#textdomain_pool(domainname) ⇒ Object
Find textdomain by name.
-
#translate_plural_message(klass, arg1, arg2, arg3 = "|", arg4 = "|") ⇒ Object
This function is similar to the get_singluar_message function as it finds the message catalogs in the same way.
-
#translate_singluar_message(klass, msgid, div = nil) ⇒ Object
Translates msgid, but if there are no localized text, it returns a last part of msgid separeted “div” or whole of the msgid with no “div”.
Instance Method Details
#bind_to(klass, domainname, options = {}) ⇒ Object
bind textdomain to the class.
65 66 67 68 69 70 71 72 73 74 75 |
# File 'lib/gettext/runtime/textdomain_manager.rb', line 65 def bind_to(klass, domainname, = {}) warn "Bind the domain '#{domainname}' to '#{klass}'. " if $DEBUG charset = [:output_charset] || self.output_charset textdomain = create_or_find_textdomain(domainname,[:path],charset) target_klass = ClassInfo.normalize_class(klass) create_or_find_textdomain_group(target_klass).add(textdomain) @@gettext_classes << target_klass unless @@gettext_classes.include? target_klass textdomain end |
#cached=(val) ⇒ Object
Set the value whether cache messages or not. true to cache messages, otherwise false.
Default is true. If $DEBUG is false, messages are not checked even if this value is true.
41 42 43 44 |
# File 'lib/gettext/runtime/textdomain_manager.rb', line 41 def cached=(val) @@cached = val TextDomain.cached = val end |
#cached? ⇒ Boolean
Return the cached value.
47 48 49 |
# File 'lib/gettext/runtime/textdomain_manager.rb', line 47 def cached? TextDomain.cached? end |
#clear_all_textdomains ⇒ Object
for testing.
184 185 186 187 188 189 |
# File 'lib/gettext/runtime/textdomain_manager.rb', line 184 def clear_all_textdomains @@textdomain_pool = {} @@textdomain_group_pool = {} @@gettext_classes = [] clear_caches end |
#clear_caches ⇒ Object
for testing.
192 193 194 195 |
# File 'lib/gettext/runtime/textdomain_manager.rb', line 192 def clear_caches @@singular_message_cache = {} @@plural_message_cache = {} end |
#create_or_find_textdomain(name, path, charset) ⇒ Object
:nodoc:
204 205 206 207 208 209 |
# File 'lib/gettext/runtime/textdomain_manager.rb', line 204 def create_or_find_textdomain(name, path, charset)#:nodoc: textdomain = @@textdomain_pool[name] return textdomain if textdomain @@textdomain_pool[name] = TextDomain.new(name, path, charset) end |
#create_or_find_textdomain_group(klass) ⇒ Object
:nodoc:
197 198 199 200 201 202 |
# File 'lib/gettext/runtime/textdomain_manager.rb', line 197 def create_or_find_textdomain_group(klass) #:nodoc: group = @@textdomain_group_pool[klass] return group if group @@textdomain_group_pool[klass] = TextDomainGroup.new end |
#each_textdomains(klass) ⇒ Object
:nodoc:
77 78 79 80 81 82 83 84 85 86 87 |
# File 'lib/gettext/runtime/textdomain_manager.rb', line 77 def each_textdomains(klass) #:nodoc: lang = Locale.candidates[0] ClassInfo.(klass, @@gettext_classes).each do |target| msg = nil if group = @@textdomain_group_pool[target] group.textdomains.each do |textdomain| yield textdomain, lang end end end end |
#output_charset ⇒ Object
Gets the output charset.
52 53 54 |
# File 'lib/gettext/runtime/textdomain_manager.rb', line 52 def output_charset @@output_charset end |
#output_charset=(charset) ⇒ Object
Sets the output charset.The program can have a output charset.
57 58 59 60 61 62 |
# File 'lib/gettext/runtime/textdomain_manager.rb', line 57 def output_charset=(charset) @@output_charset = charset @@textdomain_pool.each do |key, textdomain| textdomain.output_charset = charset end end |
#textdomain_pool(domainname) ⇒ Object
Find textdomain by name
32 33 34 |
# File 'lib/gettext/runtime/textdomain_manager.rb', line 32 def textdomain_pool(domainname) @@textdomain_pool[domainname] end |
#translate_plural_message(klass, arg1, arg2, arg3 = "|", arg4 = "|") ⇒ Object
This function is similar to the get_singluar_message function as it finds the message catalogs in the same way. But it takes two extra arguments for plural form. The msgid parameter must contain the singular form of the string to be converted. It is also used as the key for the search in the catalog. The msgid_plural parameter is the plural form. The parameter n is used to determine the plural form. If no message catalog is found msgid1 is returned if n == 1, otherwise msgid2. And if msgid includes “div”, it returns a last part of msgid separeted “div”.
-
msgid: the singular form with “div”. (e.g. “Special|An apple”, “An apple”)
-
msgid_plural: the plural form. (e.g. “%num Apples”)
-
n: a number used to determine the plural form.
-
div: the separator. Default is “|”.
-
Returns: the localized text which key is msgid_plural if n is plural(follow plural-rule) or msgid. “plural-rule” is defined in po-file.
or
- msgid, msgid_plural
-
: msgid and msgid_plural an Array
-
n: a number used to determine the plural form.
-
div: the separator. Default is “|”.
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 |
# File 'lib/gettext/runtime/textdomain_manager.rb', line 139 def (klass, arg1, arg2, arg3 = "|", arg4 = "|") klass = ClassInfo.normalize_class(klass) # parse arguments if arg1.kind_of?(Array) msgid = arg1[0] msgid_plural = arg1[1] n = arg2 if arg3 and arg3.kind_of? Numeric raise ArgumentError, _("3rd parmeter is wrong: value = %{number}") % {:number => arg3} end div = arg3 else msgid = arg1 msgid_plural = arg2 n = arg3 div = arg4 end key = [Locale.current, klass, msgid, msgid_plural, div].hash msgs = @@plural_message_cache[key] unless (msgs and @@cached) # Find messages from related classes. msgs = nil each_textdomains(klass) do |textdomain, lang| msgs = textdomain.(lang, msgid, msgid_plural) break if msgs end msgs = [[msgid, msgid_plural], TextDomain::DEFAULT_PLURAL_CALC] unless msgs msgstrs = msgs[0] if div and msgstrs[0] == msgid and index = msgstrs[0].rindex(div) msgstrs[0] = msgstrs[0][(index + 1)..-1] end @@plural_message_cache[key] = msgs end # Return the singular or plural message. msgstrs = msgs[0] plural = msgs[1].call(n) return msgstrs[plural] if plural.kind_of?(Numeric) return plural ? msgstrs[1] : msgstrs[0] end |
#translate_singluar_message(klass, msgid, div = nil) ⇒ Object
Translates msgid, but if there are no localized text, it returns a last part of msgid separeted “div” or whole of the msgid with no “div”.
-
msgid: the message id.
-
div: separator or nil.
-
Returns: the localized text by msgid. If there are no localized text, it returns a last part of msgid separeted “div”.
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 |
# File 'lib/gettext/runtime/textdomain_manager.rb', line 96 def (klass, msgid, div = nil) klass = ClassInfo.normalize_class(klass) key = [Locale.current, klass, msgid, div].hash msg = @@singular_message_cache[key] return msg if msg and @@cached # Find messages from related classes. each_textdomains(klass) do |textdomain, lang| msg = textdomain.(lang, msgid) break if msg end # If not found, return msgid. msg ||= msgid if div and msg == msgid if index = msg.rindex(div) msg = msg[(index + 1)..-1] end end @@singular_message_cache[key] = msg end |