class IRB::Locale - Documentation for Ruby 3.3

# class IRB::Locale

### Constants

LEGACY_ENCODING_ALIAS_MAP
LOCALE_DIR
LOCALE_NAME_RE

### Attributes

lang[R]
modifier[R]
territory[R]

### Public Class Methods

new(locale = nil) click to toggle source

    # File lib/irb/locale.rb, line 25
    def initialize(locale = nil)
      @override_encoding = nil
      @lang = @territory = @encoding_name = @modifier = nil
      @locale = locale || ENV["IRB_LANG"] || ENV["LC_MESSAGES"] || ENV["LC_ALL"] || ENV["LANG"] || "C"
      if m = LOCALE_NAME_RE.match(@locale)
        @lang, @territory, @encoding_name, @modifier = m[:language], m[:territory], m[:codeset], m[:modifier]

        if @encoding_name
          if @encoding = LEGACY_ENCODING_ALIAS_MAP[@encoding_name]
            warn(("%s is obsolete. use %s" % ["#{@lang}_#{@territory}.#{@encoding_name}", "#{@lang}_#{@territory}.#{@encoding.name}"]), uplevel: 1)
          else
            @encoding = Encoding.find(@encoding_name) rescue nil
          end
        end
      end
      @encoding ||= (Encoding.find('locale') rescue Encoding::ASCII_8BIT)
    end

### Public Instance Methods

String(mes) click to toggle source
Calls superclass method `Kernel#String`

    # File lib/irb/locale.rb, line 49
    def String(mes)
      mes = super(mes)
      if encoding
        mes.encode(encoding, undef: :replace)
      else
        mes
      end
    end

each_localized_path(dir, file) { |nil? ? join(dir, LOCALE_DIR, file) : join(dir, LOCALE_DIR, lc, file)| ... } click to toggle source

    # File lib/irb/locale.rb, line 126
    def each_localized_path(dir, file)
      return enum_for(:each_localized_path) unless block_given?
      each_sublocale do |lc|
        yield lc.nil? ? File.join(dir, LOCALE_DIR, file) : File.join(dir, LOCALE_DIR, lc, file)
      end
    end

each_sublocale() { |"#{lang}_#{territory}.#{encoding_name}@#{modifier}"| ... } click to toggle source

    # File lib/irb/locale.rb, line 133
    def each_sublocale
      if @lang
        if @territory
          if @encoding_name
            yield "#{@lang}_#{@territory}.#{@encoding_name}@#{@modifier}" if @modifier
            yield "#{@lang}_#{@territory}.#{@encoding_name}"
          end
          yield "#{@lang}_#{@territory}@#{@modifier}" if @modifier
          yield "#{@lang}_#{@territory}"
        end
        if @encoding_name
          yield "#{@lang}.#{@encoding_name}@#{@modifier}" if @modifier
          yield "#{@lang}.#{@encoding_name}"
        end
        yield "#{@lang}@#{@modifier}" if @modifier
        yield "#{@lang}"
      end
      yield nil
    end

encoding() click to toggle source

    # File lib/irb/locale.rb, line 45
    def encoding
      @override_encoding || @encoding
    end

find(file, paths = $:) click to toggle source

    # File lib/irb/locale.rb, line 97
    def find(file, paths = $:)
      dir = File.dirname(file)
      dir = "" if dir == "."
      base = File.basename(file)

      if dir.start_with?('/')
        return each_localized_path(dir, base).find{|full_path| File.readable? full_path}
      else
        return search_file(paths, dir, base)
      end
    end

format(*opts) click to toggle source
Calls superclass method `Kernel#format`

    # File lib/irb/locale.rb, line 58
    def format(*opts)
      String(super(*opts))
    end

gets(*rs) click to toggle source
Calls superclass method `Kernel#gets`

    # File lib/irb/locale.rb, line 62
    def gets(*rs)
      String(super(*rs))
    end

load(file) click to toggle source

    # File lib/irb/locale.rb, line 85
    def load(file)
      found = find(file)
      if found
        unless @@loaded.include?(found)
          @@loaded << found # cache
          Kernel.load(found)
        end
      else
        raise LoadError, "No such file to load -- #{file}"
      end
    end

print(*opts) click to toggle source
Calls superclass method `Kernel#print`

    # File lib/irb/locale.rb, line 70
    def print(*opts)
      ary = opts.collect{|opt| String(opt)}
      super(*ary)
    end

printf(*opts) click to toggle source

    # File lib/irb/locale.rb, line 75
    def printf(*opts)
      s = format(*opts)
      print s
    end

puts(*opts) click to toggle source
Calls superclass method `Kernel#puts`

    # File lib/irb/locale.rb, line 80
    def puts(*opts)
      ary = opts.collect{|opt| String(opt)}
      super(*ary)
    end

readline(*rs) click to toggle source
Calls superclass method `Kernel#readline`

    # File lib/irb/locale.rb, line 66
    def readline(*rs)
      String(super(*rs))
    end

search_file(lib_paths, dir, file) click to toggle source

@param paths load paths in which `IRB` find a localized file. @param dir directory @param file basename to be localized

typically, for the parameters and a <path> in paths, it searches

    <path>/<dir>/<locale>/<file>

    # File lib/irb/locale.rb, line 115
    def search_file(lib_paths, dir, file)
      each_localized_path(dir, file) do |lc_path|
        lib_paths.each do |libpath|
          full_path = File.join(libpath, lc_path)
          return full_path if File.readable?(full_path)
        end
        redo if defined?(Gem) and Gem.try_activate(lc_path)
      end
      nil
    end