X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMooseX%2FGetopt.pm;h=01904f30fcece7aa1cc159e5e95f957f1632e443;hb=ef47fe440114bcfc790464f79e476ef7defb0a67;hp=74b8be02320a10f322243986847eb989567e9874;hpb=f4308031a6f638c55439e3071af124f79eacd2ca;p=gitmo%2FMooseX-Getopt.git diff --git a/lib/MooseX/Getopt.pm b/lib/MooseX/Getopt.pm index 74b8be0..01904f3 100644 --- a/lib/MooseX/Getopt.pm +++ b/lib/MooseX/Getopt.pm @@ -11,9 +11,14 @@ use Carp (); use Getopt::Long (); # GLD uses it anyway, doesn't hurt use constant HAVE_GLD => not not eval { require Getopt::Long::Descriptive }; -our $VERSION = '0.18'; +our $VERSION = '0.20'; our $AUTHORITY = 'cpan:STEVAN'; +my @roles = ('MooseX::Getopt::Basic'); +if (HAVE_GLD) { push @roles, 'MooseX::Getopt::GLD' } + +with @roles; + has ARGV => (is => 'rw', isa => 'ArrayRef', metaclass => "NoGetopt"); has extra_argv => (is => 'rw', isa => 'ArrayRef', metaclass => "NoGetopt"); @@ -52,10 +57,16 @@ sub new_with_options { my $params = $config_from_file ? { %$config_from_file, %{$processed{params}} } : $processed{params}; + # did the user request usage information? + if ( $processed{usage} && ($params->{'?'} or $params->{help} or $params->{usage}) ) + { + $processed{usage}->die(); + } + $class->new( ARGV => $processed{argv_copy}, extra_argv => $processed{argv}, - @params, # explicit params to ->new + %$constructor_params, # explicit params to ->new %$params, # params from CLI ); } @@ -63,9 +74,9 @@ sub new_with_options { sub _parse_argv { my ( $class, %params ) = @_; - local @ARGV = @{ $params{argv} || \@ARGV }; + local @ARGV = @{ $params{params}{argv} || \@ARGV }; - my ( $opt_spec, $name_to_init_arg ) = ( HAVE_GLD ? $class->_gld_spec(%params) : $class->_traditional_spec(%params) ); + my ( $opt_spec, $name_to_init_arg ) = $class->_getopt_spec(%params); # Get a clean copy of the original @ARGV my $argv_copy = [ @ARGV ]; @@ -75,13 +86,7 @@ sub _parse_argv { my ( $parsed_options, $usage ) = eval { local $SIG{__WARN__} = sub { push @err, @_ }; - if ( HAVE_GLD ) { - return Getopt::Long::Descriptive::describe_options($class->_usage_format(%params), @$opt_spec); - } else { - my %options; - Getopt::Long::GetOptions(\%options, @$opt_spec); - return ( \%options, undef ); - } + return $class->_get_options(\%params, $opt_spec); }; die join "", grep { defined } @err, $@ if @err or $@; @@ -417,9 +422,24 @@ This method will take a set of default C<%params> and then collect params from the command line (possibly overriding those in C<%params>) and then return a newly constructed object. +The special parameter C, if specified should point to an array +reference with an array to use instead of C<@ARGV>. + +The paramater C, if specified and a true value will disable +the use of L . + If L fails (due to invalid arguments), C will throw an exception. +If L is installed and any of the following +command line params are passed, the program will exit with usage +information. You can add descriptions for each option by including a +B option for each attribute to document. + + --? + --help + --usage + If you have L a the C param is also passed to C. @@ -438,6 +458,10 @@ un-mangled. This returns the role meta object. +=item B + +A constant for internal use. + =back =head1 BUGS @@ -458,6 +482,8 @@ Yuval Kogman, Enothingmuch@woobling.orgE Ryan D Johnson, Eryan@innerfence.comE +Drew Taylor, Edrew@drewtaylor.comE + =head1 COPYRIGHT AND LICENSE Copyright 2007-2008 by Infinity Interactive, Inc.