lib/trollop.rb -- trollop command-line processing library
William Morgan (mailto: wmorgan-trollop@masanjin.net)
Copyright 2007 William Morgan
GNU GPL version 2
Regex for floating point numbers
Regex for parameters
Informs the user that their usage of 'arg' was wrong, as detailed by 'msg', and dies. Example:
options do opt :volume, :default => 0.0 end die :volume, "too loud" if opts[:volume] > 10.0 die :volume, "too soft" if opts[:volume] < 0.1
In the one-argument case, simply print that message, a notice about -h, and die. Example:
options do opt :whatever # ... end Trollop::die "need at least one filename" if ARGV.empty?
# File lib/trollop.rb, line 602 def die arg, msg=nil if msg $stderr.puts "Error: argument --#{@p.specs[arg][:long]} #{msg}." else $stderr.puts "Error: #{arg}." end $stderr.puts "Try --help for help." exit(-1) end
The top-level entry method into Trollop. Creates
a Parser object, passes the block to it,
then parses args
with it, handling any errors or requests for
help or version information appropriately (and then exiting). Modifies
args
in place. Returns a hash of option values.
The block passed in should contain one or more calls to opt (Trollop::Parser#opt), one or more calls to text (Trollop::Parser#text), and probably a call to version (Trollop::Parser#version).
See the synopsis in README.txt for examples.
# File lib/trollop.rb, line 564 def options args = ARGV, *a, &b @p = Parser.new(*a, &b) begin vals = @p.parse args args.clear @p.leftovers.each { |l| args << l } vals rescue CommandlineError => e $stderr.puts "Error: #{e.message}." $stderr.puts "Try --help for help." exit(-1) rescue HelpNeeded @p.educate exit rescue VersionNeeded puts @p.version exit end end