класс OptionParser::List

Родитель:: Объект

Простой список опций, обеспечивающий сопоставление строки короткой и/или длинной опции со OptionParser::Switch, а также сопоставление допустимого аргумента с соответствующей парой шаблона и преобразователя. Также предоставляет функцию обобщения.

Атрибуты

atype[R]

Отображение допустимых типов аргументов на пары шаблона и преобразователя.

list[R]

Список всех переключателей и строку обобщения.

long[R]

Отображение длинных стилей опций-переключателей на фактические объекты переключателей.

short[R]

Отображение коротких стилей опций-переключателей на фактические объекты переключателей.

Публичные методы класса

new() Показать исходный код

# File lib/optparse.rb, line 769
def initialize
  @atype = {}
  @short = OptionMap.new
  @long = OptionMap.new
  @list = []
end

Просто инициализирует все переменные экземпляра.

Публичные методы экземпляра

accept(t, pat = /.*/m, &block) Показать исходный код

# File lib/optparse.rb, line 779
def accept(t, pat = /.*/m, &block)
  if pat
    pat.respond_to?(:match) or
      raise TypeError, "has no `match'", ParseError.filter_backtrace(caller(2))
  else
    pat = t if t.respond_to?(:match)
  end
  unless block
    block = pat.method(:convert).to_proc if pat.respond_to?(:convert)
  end
  @atype[t] = [pat, block]
end

См. OptionParser.accept.

append(*args) Показать исходный код

# File lib/optparse.rb, line 843
def append(*args)
  update(*args)
  @list.push(args[0])
end

Добавляет switch в конец списка и связывает короткие, длинные и отрицательные длинные опции. Аргументы:

switch: Экземпляр OptionParser::Switch для вставки.
short_opts: Список коротких опций.
long_opts: Список длинных опций.
nolong_opts: Список длинных опций с префиксом «no-».

append(switch, short_opts, long_opts, nolong_opts)

complete(id, opt, icase = false, *pat, &block) Показать исходный код

# File lib/optparse.rb, line 865
def complete(id, opt, icase = false, *pat, &block)
  __send__(id).complete(opt, icase, *pat, &block)
end

Ищет в списке id значения opt и необязательные шаблоны для завершения pat. Если icase имеет значение true, поиск выполняется без учета регистра. Результат возвращается или передается в блок, если он задан. Если значение не найдено, возвращается nil.

each_option(&block) Показать исходный код

# File lib/optparse.rb, line 876
def each_option(&block)
  list.each(&block)
end

Итерируется по каждой опции, передавая опцию в block.

get_candidates(id) { |__send__(id).keys| ... } Показать исходный код

# File lib/optparse.rb, line 869
def get_candidates(id)
  yield __send__(id).keys
end

prepend(*args) Показать исходный код

# File lib/optparse.rb, line 827
def prepend(*args)
  update(*args)
  @list.unshift(args[0])
end

Вставляет switch в начало списка и связывает короткие, длинные и отрицательные длинные опции. Аргументы:

switch: Экземпляр OptionParser::Switch для вставки.
short_opts: Список коротких опций.
long_opts: Список длинных опций.
nolong_opts: Список длинных опций с префиксом «no-».

prepend(switch, short_opts, long_opts, nolong_opts)

reject(t) Показать исходный код

# File lib/optparse.rb, line 795
def reject(t)
  @atype.delete(t)
end

См. OptionParser.reject.

search(id, key) { |val| ... } Показать исходный код

# File lib/optparse.rb, line 852
def search(id, key)
  if list = __send__(id)
    val = list.fetch(key) {return nil}
    block_given? ? yield(val) : val
  end
end

Ищет key в списке id. Результат возвращается или передается в блок, если он задан. Если значение не найдено, возвращается nil.

summarize(*args, &block) Показать исходный код

# File lib/optparse.rb, line 885
def summarize(*args, &block)
  sum = []
  list.reverse_each do |opt|
    if opt.respond_to?(:summarize) # perhaps OptionParser::Switch
      s = []
      opt.summarize(*args) {|l| s << l}
      sum.concat(s.reverse)
    elsif !opt or opt.empty?
      sum << ""
    elsif opt.respond_to?(:each_line)
      sum.concat([*opt.each_line].reverse)
    else
      sum.concat([*opt.each].reverse)
    end
  end
  sum.reverse_each(&block)
end

Создает таблицу сводки, передавая каждую строку в block (без новой строки). Аргументы args передаются методу summarize, который вызывается для каждой опции.

Приватные методы экземпляра

update(sw, sopts, lopts, nsw = nil, nlopts = nil) Показать исходный код

# File lib/optparse.rb, line 807
def update(sw, sopts, lopts, nsw = nil, nlopts = nil)
  sopts.each {|o| @short[o] = sw} if sopts
  lopts.each {|o| @long[o] = sw} if lopts
  nlopts.each {|o| @long[o] = nsw} if nsw and nlopts
  used = @short.invert.update(@long.invert)
  @list.delete_if {|o| Switch === o and !used[o]}
end

Добавляет sw в соответствии с sopts, lopts и nlopts.

sw: Экземпляр OptionParser::Switch для добавления.
sopts: Список коротких опций.
lopts: Список длинных опций.
nlopts: Список длинных опций с префиксом «no-».

Ruby Core © 1993–2017 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.