X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=gitmo%2FMooseX-Getopt.git;a=blobdiff_plain;f=lib%2FMooseX%2FGetopt.pm;h=fc48b571b4412c7294bd4af52539088deb4b1781;hp=e57c141b9d61806c38080efab0d1f18b3241c397;hb=986fb4690bc00c860b1f728b986e39b412100854;hpb=30ed85f7fc94f619d46a7430aff840b334c0ebce diff --git a/lib/MooseX/Getopt.pm b/lib/MooseX/Getopt.pm index e57c141..fc48b57 100644 --- a/lib/MooseX/Getopt.pm +++ b/lib/MooseX/Getopt.pm @@ -1,23 +1,13 @@ - package MooseX::Getopt; -use Moose::Role; - -use constant HAVE_GLD => not not eval { require Getopt::Long::Descriptive }; - -my @roles = ('MooseX::Getopt::Basic'); -if (HAVE_GLD()) { push @roles, 'MooseX::Getopt::GLD' } - -with @roles; +# ABSTRACT: A Moose role for processing command line options -no Moose::Role; 1; +use Moose::Role 0.56; -__END__ +with 'MooseX::Getopt::GLD'; -=pod +no Moose::Role; -=head1 NAME - -MooseX::Getopt - A Moose role for processing command line options +1; =head1 SYNOPSIS @@ -64,8 +54,8 @@ to have C ignore your attribute in the commandline options. By default, attributes which start with an underscore are not given commandline argument support, unless the attribute's metaclass is set -to L. If you don't want you accessors -to have the leading underscore in thier name, you can do this: +to L. If you don't want your accessors +to have the leading underscore in their name, you can do this: # for read/write attributes has '_foo' => (accessor => 'foo', ...); @@ -83,7 +73,7 @@ specified by the C<--configfile> option (or the default you've given for the configfile attribute) for you. Options specified in multiple places follow the following -precendence order: commandline overrides configfile, which +precedence order: commandline overrides configfile, which overrides explicit new_with_options parameters. =head2 Supported Type Constraints @@ -192,85 +182,89 @@ type for it to the C, it would be treated just like a normal C type for Getopt purposes (that is, C<=s@>). -=head1 METHODS - -=over 4 - -=item B +=method B 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 +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 +command line params are passed, the program will exit with usage +information (and the option's state will be stored in the help_flag +attribute). You can add descriptions for each option by including a B option for each attribute to document. + -? --? + -h --help --usage -If you have L a the C param is also passed to -C. +If you have L the C param is also passed to +C as the usage option. -=item B +=method B This accessor contains a reference to a copy of the C<@ARGV> array as it originally existed at the time of C. -=item B +=method B This accessor contains an arrayref of leftover C<@ARGV> elements that L did not parse. Note that the real C<@ARGV> is left un-mangled. -=item B - -This returns the role meta object. - -=item B +B: By default, L will reject unrecognized I +(that is, options that do not correspond with attributes using the Getopt +trait). To disable this, and allow options to also be saved in C (for example to pass along to another class's C), you can either enable the +C option of L for your class: C<< use Getopt::Long +qw(:config pass_through); >> or specify a value for for L's C parameter. -A constant for internal use. +=method B -=back +This accessor contains the L object (if +L is used). -=head1 BUGS +=method B -All complex software has bugs lurking in it, and this module is no -exception. If you find a bug please either email me, or add the bug -to cpan-RT. +This accessor contains the boolean state of the --help, --usage and --? +options (true if any of these options were passed on the command line). -=head1 AUTHOR +=method B -Stevan Little Estevan@iinteractive.comE +This method is called internally when the C state is true. +It prints the text from the C object (see above) to stdout and then the +program terminates normally. You can apply a method modification (see +L) if different behaviour is desired, for +example to include additional text. -Brandon L. Black, Eblblack@gmail.comE +=method B -Yuval Kogman, Enothingmuch@woobling.orgE +This returns the role meta object. -=head1 CONTRIBUTORS +=method B -Ryan D Johnson, Eryan@innerfence.comE +This does most of the work of C, analyzing the parameters +and argv, except for actually calling the constructor. It returns a +L object. C uses this +method internally, so modifying this method via subclasses/roles will affect +C. -Drew Taylor, Edrew@drewtaylor.comE +=head2 More Customization Options -=head1 COPYRIGHT AND LICENSE +See L for many other customizations you +can make to how options are parsed. Simply C in your class to set these. -Copyright 2007-2008 by Infinity Interactive, Inc. +=cut -L +=head1 SEE ALSO -This library is free software; you can redistribute it and/or modify -it under the same terms as Perl itself. +L, an extension to generate man pages, with colour -=cut