class OptionParser::List

Parent:: Объект

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

Атрибуты

atype[R]

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

list[R]

List всех переключателей и сводной строки.

long[R]

Сопоставление между длинными стилями переключателей опций и фактическими объектами переключателей.

short[R]

Сопоставление между короткими стилями переключателей опций и фактическими объектами переключателей.

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

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

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

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

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

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

# File lib/optparse.rb, line 837
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 901
def append(*args)
  update(*args)
  @list.push(args[0])
end

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

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

append(switch, short_opts, long_opts, nolong_opts)

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

# File lib/optparse.rb, line 923
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 934
def each_option(&block)
  list.each(&block)
end

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

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

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

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

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

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

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

prepend(switch, short_opts, long_opts, nolong_opts)

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

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

См. OptionParser.reject.

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

# File lib/optparse.rb, line 910
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 943
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, который вызывается для каждой опции.

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