1 package MooseX::Getopt::Basic;
2 # ABSTRACT: MooseX::Getopt::Basic - role to implement the Getopt::Long functionality
6 use MooseX::Getopt::OptionTypeMap;
7 use MooseX::Getopt::Meta::Attribute;
8 use MooseX::Getopt::Meta::Attribute::NoGetopt;
9 use MooseX::Getopt::ProcessedArgv;
12 use Getopt::Long 2.37 ();
14 has ARGV => (is => 'rw', isa => 'ArrayRef', metaclass => "NoGetopt");
15 has extra_argv => (is => 'rw', isa => 'ArrayRef', metaclass => "NoGetopt");
18 my ($class, @params) = @_;
21 if($class->meta->does_role('MooseX::ConfigFromFile')) {
24 # just get the configfile arg now; the rest of the args will be
27 my $opt_parser = Getopt::Long::Parser->new( config => [ qw( no_auto_help pass_through ) ] );
28 $opt_parser->getoptions( "configfile=s" => \$configfile );
30 if(!defined $configfile) {
31 my $cfmeta = $class->meta->find_attribute_by_name('configfile');
32 $configfile = $cfmeta->default if $cfmeta->has_default;
33 if (ref $configfile eq 'CODE') {
34 # not sure theres a lot you can do with the class and may break some assumptions
36 $configfile = &$configfile($class);
38 if (defined $configfile) {
39 $config_from_file = eval {
40 $class->get_config_from_file($configfile);
43 die $@ unless $@ =~ /Specified configfile '\Q$configfile\E' does not exist/;
48 $config_from_file = $class->get_config_from_file($configfile);
52 my $constructor_params = ( @params == 1 ? $params[0] : {@params} );
54 Carp::croak("Single parameters to new_with_options() must be a HASH ref")
55 unless ref($constructor_params) eq 'HASH';
57 my %processed = $class->_parse_argv(
59 $class->_attrs_to_options( $config_from_file )
61 params => $constructor_params,
64 my $params = $config_from_file ? { %$config_from_file, %{$processed{params}} } : $processed{params};
66 # did the user request usage information?
67 if ( $processed{usage} and $params->{help_flag} ) {
68 $class->_getopt_full_usage($processed{usage});
71 return MooseX::Getopt::ProcessedArgv->new(
72 argv_copy => $processed{argv_copy},
73 extra_argv => $processed{argv},
74 usage => $processed{usage},
75 constructor_params => $constructor_params, # explicit params to ->new
76 cli_params => $params, # params from CLI
80 sub new_with_options {
81 my ($class, @params) = @_;
83 my $pa = $class->process_argv(@params);
86 ARGV => $pa->argv_copy,
87 extra_argv => $pa->extra_argv,
88 ( $pa->usage ? ( usage => $pa->usage ) : () ),
89 %{ $pa->constructor_params }, # explicit params to ->new
90 %{ $pa->cli_params }, # params from CLI
94 sub _getopt_spec { shift->_traditional_spec(@_); }
97 my ( $class, %params ) = @_;
99 local @ARGV = @{ $params{params}{argv} || \@ARGV };
101 my ( $opt_spec, $name_to_init_arg ) = $class->_getopt_spec(%params);
103 # Get a clean copy of the original @ARGV
104 my $argv_copy = [ @ARGV ];
107 my ( $parsed_options, $usage ) = eval {
108 local $SIG{__WARN__} = sub { push @warnings, @_ };
110 return $class->_getopt_get_options(\%params, $opt_spec);
113 $class->_getopt_spec_warnings(@warnings) if @warnings;
114 $class->_getopt_spec_exception(\@warnings, $@) if $@;
116 # Get a copy of the Getopt::Long-mangled @ARGV
117 my $argv_mangled = [ @ARGV ];
119 my %constructor_args = (
121 $name_to_init_arg->{$_} => $parsed_options->{$_}
122 } keys %$parsed_options,
126 params => \%constructor_args,
127 argv_copy => $argv_copy,
128 argv => $argv_mangled,
129 ( defined($usage) ? ( usage => $usage ) : () ),
133 sub _getopt_get_options {
134 my ($class, $params, $opt_spec) = @_;
136 Getopt::Long::GetOptions(\%options, @$opt_spec);
137 return ( \%options, undef );
140 sub _getopt_spec_warnings { }
142 sub _getopt_spec_exception {
143 my ($self, $warnings, $exception) = @_;
144 die @$warnings, $exception;
147 sub _getopt_full_usage {
148 my ($self, $usage) = @_;
153 return "usage: %c %o";
156 sub _traditional_spec {
157 my ( $class, %params ) = @_;
159 my ( @options, %name_to_init_arg, %options );
161 foreach my $opt ( @{ $params{options} } ) {
162 push @options, $opt->{opt_string};
164 my $identifier = $opt->{name};
165 $identifier =~ s/\W/_/g; # Getopt::Long does this to all option names
167 $name_to_init_arg{$identifier} = $opt->{init_arg};
170 return ( \@options, \%name_to_init_arg );
173 sub _compute_getopt_attrs {
175 sort { $a->insertion_order <=> $b->insertion_order }
177 $_->does("MooseX::Getopt::Meta::Attribute::Trait")
181 !$_->does('MooseX::Getopt::Meta::Attribute::Trait::NoGetopt')
182 } $class->meta->get_all_attributes
185 sub _get_cmd_flags_for_attr {
186 my ( $class, $attr ) = @_;
188 my $flag = $attr->name;
192 if ($attr->does('MooseX::Getopt::Meta::Attribute::Trait')) {
193 $flag = $attr->cmd_flag if $attr->has_cmd_flag;
194 @aliases = @{ $attr->cmd_aliases } if $attr->has_cmd_aliases;
197 return ( $flag, @aliases );
200 sub _attrs_to_options {
202 my $config_from_file = shift || {};
206 foreach my $attr ($class->_compute_getopt_attrs) {
207 my ( $flag, @aliases ) = $class->_get_cmd_flags_for_attr($attr);
209 my $opt_string = join(q{|}, $flag, @aliases);
211 if ($attr->name eq 'configfile') {
214 elsif ($attr->has_type_constraint) {
215 my $type = $attr->type_constraint;
216 if (MooseX::Getopt::OptionTypeMap->has_option_type($type)) {
217 $opt_string .= MooseX::Getopt::OptionTypeMap->get_option_type($type)
223 init_arg => $attr->init_arg,
224 opt_string => $opt_string,
225 required => $attr->is_required && !$attr->has_default && !$attr->has_builder && !exists $config_from_file->{$attr->name},
227 # this "feature" was breaking because
228 # Getopt::Long::Descriptive would return
229 # the default value as if it was a command
230 # line flag, which would then override the
231 # one passed into a constructor.
232 # See 100_gld_default_bug.t for an example
234 #( ( $attr->has_default && ( $attr->is_default_a_coderef xor $attr->is_lazy ) ) ? ( default => $attr->default({}) ) : () ),
235 ( $attr->has_documentation ? ( doc => $attr->documentation ) : () ),
251 with 'MooseX::Getopt::Basic';
253 has 'out' => (is => 'rw', isa => 'Str', required => 1);
254 has 'in' => (is => 'rw', isa => 'Str', required => 1);
256 # ... rest of the class here
263 my $app = My::App->new_with_options();
264 # ... rest of the script here
266 ## on the command line
267 % perl my_app_script.pl --in file.input --out file.dump
271 This is like L<MooseX::Getopt> and can be used instead except that it
272 doesn't make use of L<Getopt::Long::Descriptive> (or "GLD" for short).
274 =method new_with_options
276 See L<MooseX::Getopt/new_with_options>.
280 See L<MooseX::Getopt/process_agv>.