Class: OptionParser::List

Inherits:
Object show all
Defined in:
opal/stdlib/optparse.rb

Overview

Simple option list providing mapping from short and/or long option string to OptionParser::Switch and mapping from acceptable argument to matching pattern and converter pair. Also provides summary feature.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ List

Just initializes all instance variables.



775
776
777
778
779
780
 
# File 'opal/stdlib/optparse.rb', line 775

def initialize
  @atype = {}
  @short = OptionMap.new
  @long = OptionMap.new
  @list = []
end

Instance Attribute Details

#atype ⇒ Object (readonly)

Map from acceptable argument types to pattern and converter pairs.



761
762
763
 
# File 'opal/stdlib/optparse.rb', line 761

def atype
  @atype
end

#list ⇒ Object (readonly)

List of all switches and summary string.



770
771
772
 
# File 'opal/stdlib/optparse.rb', line 770

def list
  @list
end

#long ⇒ Object (readonly)

Map from long style option switches to actual switch objects.



767
768
769
 
# File 'opal/stdlib/optparse.rb', line 767

def long
  @long
end

#short ⇒ Object (readonly)

Map from short style option switches to actual switch objects.



764
765
766
 
# File 'opal/stdlib/optparse.rb', line 764

def short
  @short
end

Instance Method Details

#accept(t, pat = /.*/m, &block) ⇒ Object

See OptionParser.accept.



785
786
787
788
789
790
791
792
793
794
795
796
 
# File 'opal/stdlib/optparse.rb', line 785

def accept(t, pat = /.*/m, &block)
  if pat
    pat.respond_to?(:match) ||
      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

#add_banner(to) ⇒ Object

:nodoc:



909
910
911
912
913
914
915
916
 
# File 'opal/stdlib/optparse.rb', line 909

def add_banner(to) # :nodoc:
  list.each do |opt|
    if opt.respond_to?(:add_banner)
      opt.add_banner(to)
    end
  end
  to
end

#append(*args) ⇒ Object

Appends +switch+ at the tail of the list, and associates short, long and negated long options. Arguments are:

+switch+:: OptionParser::Switch instance to be inserted. +short_opts+:: List of short style options. +long_opts+:: List of long style options. +nolong_opts+:: List of long style options with "no-" prefix.

append(switch, short_opts, long_opts, nolong_opts)



849
850
851
852
 
# File 'opal/stdlib/optparse.rb', line 849

def append(*args)
  update(*args)
  @list.push(args[0])
end

#complete(id, opt, icase = false, *pat, &block) ⇒ Object

Searches list +id+ for +opt+ and the optional patterns for completion +pat+. If +icase+ is true, the search is case insensitive. The result is returned or yielded if a block is given. If it isn't found, nil is returned.



871
872
873
 
# File 'opal/stdlib/optparse.rb', line 871

def complete(id, opt, icase = false, *pat, &block)
  __send__(id).complete(opt, icase, *pat, &block)
end

#compsys(*args, &block) ⇒ Object

:nodoc:



918
919
920
921
922
923
924
 
# File 'opal/stdlib/optparse.rb', line 918

def compsys(*args, &block) # :nodoc:
  list.each do |opt|
    if opt.respond_to?(:compsys)
      opt.compsys(*args, &block)
    end
  end
end

#each_option(&block) ⇒ Object

Iterates over each option, passing the option to the +block+.



882
883
884
 
# File 'opal/stdlib/optparse.rb', line 882

def each_option(&block)
  list.each(&block)
end

#get_candidates(id) {|__send__(id).keys| ... } ⇒ Object

Yields:

  • (__send__(id).keys) 


875
876
877
 
# File 'opal/stdlib/optparse.rb', line 875

def get_candidates(id)
  yield __send__(id).keys
end

#prepend(*args) ⇒ Object

Inserts +switch+ at the head of the list, and associates short, long and negated long options. Arguments are:

+switch+:: OptionParser::Switch instance to be inserted. +short_opts+:: List of short style options. +long_opts+:: List of long style options. +nolong_opts+:: List of long style options with "no-" prefix.

prepend(switch, short_opts, long_opts, nolong_opts)



833
834
835
836
 
# File 'opal/stdlib/optparse.rb', line 833

def prepend(*args)
  update(*args)
  @list.unshift(args[0])
end

#reject(t) ⇒ Object

See OptionParser.reject.



801
802
803
 
# File 'opal/stdlib/optparse.rb', line 801

def reject(t)
  @atype.delete(t)
end

#search(id, key) ⇒ Object

Searches +key+ in +id+ list. The result is returned or yielded if a block is given. If it isn't found, nil is returned.



858
859
860
861
862
863
 
# File 'opal/stdlib/optparse.rb', line 858

def search(id, key)
  if list = __send__(id)
    val = list.fetch(key) { return nil }
    block_given? ? yield(val) : val
  end
end

#summarize(*args, &block) ⇒ Object

Creates the summary table, passing each line to the +block+ (without newline). The arguments +args+ are passed along to the summarize method which is called on every option.



891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
 
# File 'opal/stdlib/optparse.rb', line 891

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 || 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