類別 OptionParser::List
提供簡單的選項清單,將短選項和/或長選項字串對應到 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) 按一下以切換來源
請參閱 OptionParser.accept
。
# 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
append(*args) 按一下以切換來源
將 switch
附加在清單的尾端,並關聯短式、長式和否定長式選項。引數為
switch
-
要插入的
OptionParser::Switch
執行個體。 short_opts
-
List
的短式選項。 long_opts
-
List
的長式選項。 nolong_opts
-
帶有「no-」前綴的
List
的長式選項。
append(switch, short_opts, long_opts, nolong_opts)
# File lib/optparse.rb, line 901 def append(*args) update(*args) @list.push(args[0]) end
complete(id, opt, icase = false, *pat, &block) 按一下以切換來源
在清單 id
中搜尋 opt
和完成的選用模式 pat
。如果 icase
為 true,則搜尋不區分大小寫。如果提供區塊,則會傳回或產生結果。如果找不到,則傳回 nil。
# File lib/optparse.rb, line 923 def complete(id, opt, icase = false, *pat, &block) __send__(id).complete(opt, icase, *pat, &block) end
each_option(&block) 按一下以切換來源
逐一反覆處理每個選項,將選項傳遞給 block
。
# File lib/optparse.rb, line 934 def each_option(&block) list.each(&block) end
get_candidates(id) { |__send__(id).keys| ... } 按一下以切換來源
# File lib/optparse.rb, line 927 def get_candidates(id) yield __send__(id).keys end
prepend(*args) 按一下以切換來源
將 switch
插入清單開頭,並關聯短選項、長選項和否定長選項。參數為
switch
-
要插入的
OptionParser::Switch
執行個體。 short_opts
-
List
的短式選項。 long_opts
-
List
的長式選項。 nolong_opts
-
帶有「no-」前綴的
List
的長式選項。
prepend(switch, short_opts, long_opts, nolong_opts)
# File lib/optparse.rb, line 885 def prepend(*args) update(*args) @list.unshift(args[0]) end
reject(t) 按一下以切換來源
請參閱 OptionParser.reject
。
# File lib/optparse.rb, line 853 def reject(t) @atype.delete(t) end
search(id, key) { |val| ... } 按一下以切換來源
在 id
清單中搜尋 key
。如果提供區塊,則會傳回或產生結果。如果找不到,則會傳回 nil。
# 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
summarize(*args, &block) 按一下以切換來源
建立摘要表格,將每一行傳遞給 block
(不含換行符號)。參數 args
會傳遞給摘要方法,而摘要方法會呼叫每個選項。
# 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