Class: OptionParser::Switch

Inherits:
Object
  • Object
show all
Defined in:
lib/optparse.rb

Overview

Individual switch class. Not important to the user.

Defined within Switch are several Switch-derived classes: NoArgument, RequiredArgument, etc.

Defined Under Namespace

Classes: NoArgument, OptionalArgument, PlacedArgument, RequiredArgument

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(pattern = nil, conv = nil, short = nil, long = nil, arg = nil, desc = ([] if short or long), block = nil, &_block) ⇒ Switch

Returns a new instance of Switch.



537
538
539
540
541
542
543
544
 
# File 'lib/optparse.rb', line 537

def initialize(pattern = nil, conv = nil,
               short = nil, long = nil, arg = nil,
               desc = ([] if short or long), block = nil, &_block)
  raise if Array === pattern
  block ||= _block
  @pattern, @conv, @short, @long, @arg, @desc, @block =
    pattern, conv, short, long, arg, desc, block
end

Instance Attribute Details

#arg ⇒ Object (readonly)

Returns the value of attribute arg.



507
508
509
 
# File 'lib/optparse.rb', line 507

def arg
  @arg
end

#block ⇒ Object (readonly)

Returns the value of attribute block.



507
508
509
 
# File 'lib/optparse.rb', line 507

def block
  @block
end

#conv ⇒ Object (readonly)

Returns the value of attribute conv.



507
508
509
 
# File 'lib/optparse.rb', line 507

def conv
  @conv
end

#desc ⇒ Object (readonly)

Returns the value of attribute desc.



507
508
509
 
# File 'lib/optparse.rb', line 507

def desc
  @desc
end

#long ⇒ Object (readonly)

Returns the value of attribute long.



507
508
509
 
# File 'lib/optparse.rb', line 507

def long
  @long
end

#pattern ⇒ Object (readonly)

Returns the value of attribute pattern.



507
508
509
 
# File 'lib/optparse.rb', line 507

def pattern
  @pattern
end

#short ⇒ Object (readonly)

Returns the value of attribute short.



507
508
509
 
# File 'lib/optparse.rb', line 507

def short
  @short
end

Class Method Details

.guess(arg) ⇒ Object

Guesses argument style from arg. Returns corresponding OptionParser::Switch class (OptionalArgument, etc.).



513
514
515
516
517
518
519
520
521
522
523
524
525
526
 
# File 'lib/optparse.rb', line 513

def self.guess(arg)
  case arg
  when ""
    t = self
  when /\A=?\[/
    t = Switch::OptionalArgument
  when /\A\s+\[/
    t = Switch::PlacedArgument
  else
    t = Switch::RequiredArgument
  end
  self >= t or incompatible_argument_styles(arg, t)
  t
end

.incompatible_argument_styles(arg, t) ⇒ Object

Raises:

  • (ArgumentError) 


528
529
530
531
 
# File 'lib/optparse.rb', line 528

def self.incompatible_argument_styles(arg, t)
  raise(ArgumentError, "#{arg}: incompatible argument styles\n  #{self}, #{t}",
        ParseError.filter_backtrace(caller(2)))
end

.pattern ⇒ Object 



533
534
535
 
# File 'lib/optparse.rb', line 533

def self.pattern
  NilClass
end

Instance Method Details

#add_banner(to) ⇒ Object

:nodoc:



634
635
636
637
638
639
640
 
# File 'lib/optparse.rb', line 634

def add_banner(to)  # :nodoc:
  unless @short or @long
    s = desc.join
    to << " [" + s + "]..." unless s.empty?
  end
  to
end

#compsys(sdone, ldone) ⇒ Object

:nodoc:



653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
 
# File 'lib/optparse.rb', line 653

def compsys(sdone, ldone)   # :nodoc:
  sopts, lopts = [], []
  @short.each {|s| sdone.fetch(s) {sopts << s}; sdone[s] = true} if @short
  @long.each {|s| ldone.fetch(s) {lopts << s}; ldone[s] = true} if @long
  return if sopts.empty? and lopts.empty? # completely hidden

  (sopts+lopts).each do |opt|
    # "(-x -c -r)-l[left justify]"
    if /^--\[no-\](.+)$/ =~ opt
      o = $1
      yield("--#{o}", desc.join(""))
      yield("--no-#{o}", desc.join(""))
    else
      yield("#{opt}", desc.join(""))
    end
  end
end

#match_nonswitch?(str) ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


642
643
644
 
# File 'lib/optparse.rb', line 642

def match_nonswitch?(str)  # :nodoc:
  @pattern =~ str unless @short or @long
end

#summarize(sdone = {}, ldone = {}, width = 1, max = width - 1, indent = "") ⇒ Object

Produces the summary text. Each line of the summary is yielded to the block (without newline).

sdone

Already summarized short style options keyed hash.

ldone

Already summarized long style options keyed hash.

width

Width of left side (option part). In other words, the right side (description part) starts after width columns.

max

Maximum width of left side -> the options are filled within max columns.

indent

Prefix string indents all summarized lines.



597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
 
# File 'lib/optparse.rb', line 597

def summarize(sdone = {}, ldone = {}, width = 1, max = width - 1, indent = "")
  sopts, lopts = [], [], nil
  @short.each {|s| sdone.fetch(s) {sopts << s}; sdone[s] = true} if @short
  @long.each {|s| ldone.fetch(s) {lopts << s}; ldone[s] = true} if @long
  return if sopts.empty? and lopts.empty? # completely hidden

  left = [sopts.join(', ')]
  right = desc.dup

  while s = lopts.shift
    l = left[-1].length + s.length
    l += arg.length if left.size == 1 && arg
    l < max or sopts.empty? or left << +''
    left[-1] << (left[-1].empty? ? ' ' * 4 : ', ') << s
  end

  if arg
    left[0] << (left[1] ? arg.sub(/\A(\[?)=/, '\1') + ',' : arg)
  end
  mlen = left.collect {|ss| ss.length}.max.to_i
  while mlen > width and l = left.shift
    mlen = left.collect {|ss| ss.length}.max.to_i if l.length == mlen
    if l.length < width and (r = right[0]) and !r.empty?
      l = l.to_s.ljust(width) + ' ' + r
      right.shift
    end
    yield(indent + l)
  end

  while begin l = left.shift; r = right.shift; l or r end
    l = l.to_s.ljust(width) + ' ' + r if r and !r.empty?
    yield(indent + l)
  end

  self
end

#switch_name ⇒ Object

Main name of the switch.



649
650
651
 
# File 'lib/optparse.rb', line 649

def switch_name
  (long.first || short.first).sub(/\A-+(?:\[no-\])?/, '')
end