Module: Locale

Defined in:
lib/locale.rb,
lib/locale/tag.rb,
lib/locale/driver.rb,
lib/locale/taglist.rb,
lib/locale/version.rb,
lib/locale/tag/rfc.rb,
lib/locale/tag/cldr.rb,
lib/locale/tag/posix.rb,
lib/locale/middleware.rb,
lib/locale/driver/cgi.rb,
lib/locale/driver/env.rb,
lib/locale/tag/simple.rb,
lib/locale/tag/common.rb,
lib/locale/info/region.rb,
lib/locale/driver/win32.rb,
lib/locale/driver/jruby.rb,
lib/locale/driver/posix.rb,
lib/locale/info/language.rb,
lib/locale/tag/irregular.rb,
lib/locale/driver/win32_table.rb

Overview

win32_table.rb - Locale table for win32

Copyright (C) 2008 Masao Mutoh <mutomasa at gmail.com>

You may redistribute it and/or modify it under the same
license terms as Ruby.

Original: Ruby-GetText-Package-1.92.0.

$Id: win32_table.rb 27 2008-12-03 15:06:50Z mutoh $

Defined Under Namespace

Modules: Driver, Info, Tag Classes: Middleware, TagList

Constant Summary

DEFAULT_LANGUAGE_TAG =

:nodoc:

Locale::Tag::Simple.new("en")
VERSION =
"2.1.2"
@@default_tag =
nil
@@driver_name =
nil
@@app_language_tags =
nil

Class Method Summary collapse

Class Method Details

.app_language_tagsObject

Returns the app_language_tags. Default is nil. See set_app_language_tags for more details.



323
324
325
# File 'lib/locale.rb', line 323

def app_language_tags
  @@app_language_tags
end

.candidates(options = {}) ⇒ Object

Returns the language tags which are variations of the current locales order by priority.

For example, if the current locales are [“fr”, “ja_JP”, “en_US”, “en-Latn-GB-VARIANT”], then returns [“fr”, “ja_JP”, “en_US”, “en-Latn-GB-VARIANT”, “en_Latn_GB”, “en_GB”, “ja”, “en”]. “en” is the default locale(You can change it using set_default). The default locale is added at the end of the list even if it isn't exist.

Usually, this method is used to find the locale data as the path(or a kind of IDs).

  • options: options as a Hash or nil.

    • :supported_language_tags - An Array of the language tags order by the priority. This option restricts the locales which are supported by the library/application. Default is nil if you don't need to restrict the locales.

      (e.g.1) ["fr_FR", "en_GB", "en_US", ...]
    • :type - The type of language tag. :common, :rfc, :cldr, :posix and :simple are available. Default value is :common



212
213
214
215
216
217
218
219
220
221
222
223
# File 'lib/locale.rb', line 212

def candidates(options = {})
  opts = {
    :supported_language_tags => nil,
    :current                 => current,
    :type                    => :common,
  }.merge(options)

  Thread.current[:candidates_caches] ||= {}
  Thread.current[:candidates_caches][opts] ||=
    collect_candidates(opts[:type], opts[:current],
                       opts[:supported_language_tags])
end

.cgi=(cgi) ⇒ Object

Sets a CGI object.This is the convenient function of set_request().

This method is appeared when Locale.init(:driver => :cgi) is called.

  • cgi: CGI object

  • Returns: cgi



146
147
148
149
# File 'lib/locale/driver/cgi.rb', line 146

def cgi=(cgi)
  set_cgi(cgi)
  cgi
end

.charsetObject

Gets the current charset.

This returns the current user/system charset. This value is read only, so you can't set it by yourself.

  • Returns: the current charset.



270
271
272
# File 'lib/locale.rb', line 270

def charset
  driver_module.charset || "UTF-8"
end

.clearObject

Clear current locale.

  • Returns: self



276
277
278
279
280
# File 'lib/locale.rb', line 276

def clear
  Thread.current[:current_languages] = nil
  Thread.current[:candidates_caches] = nil
  self
end

.clear_allObject

Clear all locales and charsets of all threads. This doesn't clear the default and app_language_tags. Use Locale.default = nil to unset the default locale.

  • Returns: self



286
287
288
289
290
291
292
# File 'lib/locale.rb', line 286

def clear_all
  Thread.list.each do |thread|
    thread[:current_languages] = nil
    thread[:candidates_caches] = nil
  end
  self
end

.collect_candidates(type, tags, supported_tags) ⇒ Object

collect tag candidates. The result is shared from all threads.



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
# File 'lib/locale.rb', line 227

def collect_candidates(type, tags, supported_tags) # :nodoc:
  candidate_tags = tags.collect{|v| v.send("to_#{type}").candidates}
  default_tags = default.send("to_#{type}").candidates
  if app_language_tags
    app_tags = app_language_tags.collect{|v| v.send("to_#{type}")}.flatten.uniq
  end
  if supported_tags
    supported_tags = supported_tags.collect{|v| Locale::Tag.parse(v).send("to_#{type}")}.flatten.uniq
  end

  tags = []
  unless candidate_tags.empty?
    (0...candidate_tags[0].size).each {|i|
      tags += candidate_tags.collect{|v| v[i]}
    }
  end
  tags += default_tags
  tags.uniq!

  all_tags = nil
  if app_tags
    if supported_tags
      all_tags = app_tags & supported_tags
    else
      all_tags = app_tags
    end
  elsif supported_tags
    all_tags = supported_tags
  end
  if all_tags
    tags &= all_tags
    tags = default_tags.uniq if tags.size == 0
  end

  Locale::TagList.new(tags)
end

.create_language_tag(tag) ⇒ Object

:nodoc:



33
34
35
36
37
38
39
40
41
42
43
# File 'lib/locale.rb', line 33

def create_language_tag(tag)  #:nodoc:
  case tag
  when nil
  when Locale::Tag::Simple
    tag
  when Locale::TagList
    tag[0]
  else
    Locale::Tag.parse(tag)
  end
end

.currentObject

Gets the current locales (Locale::Tag's class). If the current locale is not set, this returns system/default locale.

This method returns the current language tags even if it isn't included in app_language_tags.

Usually, the programs should use Locale.candidates to find the correct locale, not this method.

  • Returns: an Array of the current locales (Locale::Tag's class).



177
178
179
180
181
182
183
# File 'lib/locale.rb', line 177

def current
  unless Thread.current[:current_languages]
    loc = driver_module.locales
    Thread.current[:current_languages] = loc ? loc : Locale::TagList.new([default])
  end
  Thread.current[:current_languages]
end

.current=(tag) ⇒ Object

Sets a current locale. This is a single argument version of Locale.set_current.

  • tag: the language tag such as “ja-JP”

  • Returns: an Array of the current locale (Locale::Tag's class).

    Locale.current = "ja-JP"
    Locale.current = "ja_JP.eucJP"


164
165
166
167
# File 'lib/locale.rb', line 164

def current=(tag)
  set_current(tag)
  Thread.current[:current_languages]
end

.defaultObject

Gets the default locale(language tag).

If the default language tag is not set, this returns nil.

  • Returns: the default locale (Locale::Tag's class).



121
122
123
# File 'lib/locale.rb', line 121

def default
  @@default_tag || DEFAULT_LANGUAGE_TAG
end

.default=(tag) ⇒ Object

Same as Locale.set_default.

  • locale: the default locale (Locale::Tag's class) or a String such as “ja-JP”.

  • Returns: locale.



111
112
113
114
# File 'lib/locale.rb', line 111

def default=(tag)
  set_default(tag)
  @@default_tag
end

.driver_moduleObject

Gets the driver module.

Usually you don't need to call this method.

  • Returns: the driver module.



86
87
88
89
# File 'lib/locale.rb', line 86

def driver_module 
  Locale.init if @@driver_name.nil?
  Driver::MODULES[@@driver_name]
end

.getObject

Deprecated.



186
187
188
# File 'lib/locale.rb', line 186

def get #:nodoc: 
  current
end

.init(opts = {}) ⇒ Object

Initialize Locale library. Usually, you don't need to call this directly, because this is called when Locale's methods are called.

If you use this library with CGI or the kind of CGI. You need to call Locale.init(:driver => :cgi).

For Framework designers/programers:

If your framework is for WWW, call this once like: Locale.init(:driver => :cgi).

To Application programers:

If your framework doesn't use ruby-locale and the application is for WWW, call this once like: Locale.init(:driver => :cgi).

To Library authors:

Don't call this, even if your application is only for WWW.

  • opts: Options as a Hash.

    • :driver - The driver. :cgi if you use Locale module with CGI, nil if you use system locale.

      (ex) Locale.init(:driver => :cgi)


67
68
69
70
71
72
73
74
75
76
77
78
79
# File 'lib/locale.rb', line 67

def init(opts = {})
  if opts[:driver]
    require_driver opts[:driver]
  else
    if /cygwin|mingw|win32/ =~ RUBY_PLATFORM
      require_driver 'win32' 
    elsif /java/ =~ RUBY_PLATFORM
      require_driver 'jruby' 
    else
      require_driver 'posix' 
    end
  end
end

.require_driver(name) ⇒ Object

:nodoc:



28
29
30
31
# File 'lib/locale.rb', line 28

def require_driver(name)  #:nodoc:
  require "locale/driver/#{name}"
  @@driver_name = name.to_sym
end

.set(tag) ⇒ Object

Deprecated.



191
192
193
# File 'lib/locale.rb', line 191

def set(tag)  #:nodoc:
  set_current(tag)
end

.set_app_language_tags(*tags) ⇒ Object

Set the language tags which is supported by the Application. This value is same with supported_language_tags in Locale.candidates to restrict the result but is the global setting. If you set a language tag, the application works as the single locale application.

If the current locale is not included in app_language_tags, Locale.default value is used. Use Locale.set_default() to set correct language if “en” is not included in the language tags.

Set nil if clear the value.

Note that the libraries/plugins shouldn't set this value.

(e.g.) Locale.set_app_language_tags("fr_FR", "en-GB", "en_US", ...)


311
312
313
314
315
316
317
318
319
320
# File 'lib/locale.rb', line 311

def set_app_language_tags(*tags)
  if tags[0]
    @@app_language_tags = tags.collect{|v| Locale::Tag.parse(v)}
  else
    @@app_language_tags = nil
  end
  
  clear_all
  self
end

.set_cgi(cgi) ⇒ Object

Sets a CGI object. This is the convenient function of set_request().

This method is appeared when Locale.init(:driver => :cgi) is called.

  • cgi: CGI object

  • Returns: self



134
135
136
137
138
# File 'lib/locale/driver/cgi.rb', line 134

def set_cgi(cgi)
  set_request(cgi.params["lang"], cgi.cookies["lang"],
              cgi.accept_language, cgi.accept_charset)
  self
end

.set_current(*tags) ⇒ Object

Sets the locales of the current thread order by the priority. Each thread has a current locales. The system locale/default locale is used if the thread doesn't have current locales.

  • tag: Locale::Language::Tag's class or the language tag as a String. nil if you need to clear current locales.

  • charset: the charset (override the charset even if the locale name has charset) or nil.

  • Returns: self

(e.g.)

Locale.set_current("ja_JP.eucJP")
Locale.set_current("ja-JP")
Locale.set_current("en_AU", "en_US", ...)
Locale.set_current(Locale::Tag::Simple.new("ja", "JP"), ...)


139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
# File 'lib/locale.rb', line 139

def set_current(*tags)
  languages = nil
  if tags[0]
    languages = Locale::TagList.new
    tags.each do |tag|
      case tag
      when Locale::TagList
        languages.concat(tag)
      else
        languages << create_language_tag(tag)
      end
    end
  end
  Thread.current[:current_languages] = languages
  Thread.current[:candidates_caches] = nil
  self
end

.set_default(tag) ⇒ Object

Sets the default locale as the language tag (Locale::Tag's class or String(such as “ja_JP”)).

  • tag: the default language_tag

  • Returns: self.



98
99
100
101
102
103
104
105
# File 'lib/locale.rb', line 98

def set_default(tag)
  Thread.list.each do |thread|
    thread[:current_languages] = nil
    thread[:candidates_caches] = nil
  end
  @@default_tag = create_language_tag(tag)
  self
end

.set_request(query_langs, cookie_langs, accept_language, accept_charset) ⇒ Object

Sets a request values for lang/charset.

  • query_langs: An Array of QUERY_STRING value “lang”.

  • cookie_langs: An Array of cookie value “lang”.

  • accept_language: The value of HTTP_ACCEPT_LANGUAGE

  • accept_charset: The value of HTTP_ACCEPT_CHARSET



123
124
125
126
# File 'lib/locale/driver/cgi.rb', line 123

def set_request(query_langs, cookie_langs, accept_language, accept_charset)
  driver_module.set_request(query_langs, cookie_langs, accept_language, accept_charset)
  self
end