1 package Module::Build::Base;
4 BEGIN { require 5.00503 }
10 use File::Spec 0.82 ();
14 use Text::ParseWords ();
17 use Module::Build::ModuleInfo;
18 use Module::Build::Notes;
21 #################### Constructors ###########################
23 my $self = shift()->_construct(@_);
25 $self->{invoked_action} = $self->{action} ||= 'Build_PL';
26 $self->cull_args(@ARGV);
28 die "Too early to specify a build action '$self->{action}'. Do 'Build $self->{action}' instead.\n"
29 if $self->{action} && $self->{action} ne 'Build_PL';
34 $self->check_manifest;
36 $self->check_autofeatures;
38 $self->_set_install_paths;
39 $self->_find_nested_builds;
46 my $self = $package->_construct(@_);
49 # If someone called Module::Build->current() or
50 # Module::Build->new_from_context() and the correct class to use is
51 # actually a *subclass* of Module::Build, we may need to load that
52 # subclass here and re-delegate the resume() method to it.
53 unless ( UNIVERSAL::isa($package, $self->build_class) ) {
54 my $build_class = $self->build_class;
55 my $config_dir = $self->config_dir || '_build';
56 my $build_lib = File::Spec->catdir( $config_dir, 'lib' );
57 unshift( @INC, $build_lib );
58 unless ( $build_class->can('new') ) {
59 eval "require $build_class; 1" or die "Failed to re-load '$build_class': $@";
61 return $build_class->resume(@_);
64 unless ($self->_perl_is_same($self->{properties}{perl})) {
65 my $perl = $self->find_perl_interpreter;
66 $self->log_warn(" * WARNING: Configuration was initially created with '$self->{properties}{perl}',\n".
67 " but we are now using '$perl'.\n");
70 my $mb_version = $Module::Build::VERSION;
71 die(" * ERROR: Configuration was initially created with Module::Build version '$self->{properties}{mb_version}',\n".
72 " but we are now using version '$mb_version'. Please re-run the Build.PL or Makefile.PL script.\n")
73 unless $mb_version eq $self->{properties}{mb_version};
75 $self->cull_args(@ARGV);
76 $self->{invoked_action} = $self->{action} ||= 'build';
81 sub new_from_context {
82 my ($package, %args) = @_;
84 # XXX Read the META.yml and see whether we need to run the Build.PL?
86 # Run the Build.PL. We use do() rather than run_perl_script() so
87 # that it runs in this process rather than a subprocess, because we
88 # need to make sure that the environment is the same during Build.PL
89 # as it is during resume() (and thereafter).
91 local @ARGV = $package->unparse_args(\%args);
95 return $package->resume;
99 # hmm, wonder what the right thing to do here is
101 return shift()->resume;
105 my ($package, %input) = @_;
107 my $args = delete $input{args} || {};
108 my $config = delete $input{config} || {};
112 config => {%Config, %$config},
114 base_dir => $package->cwd,
115 mb_version => $Module::Build::VERSION,
121 $self->_set_defaults;
122 my ($p, $c, $ph) = ($self->{properties}, $self->{config}, $self->{phash});
124 foreach (qw(notes config_data features runtime_params cleanup auto_features)) {
125 my $file = File::Spec->catfile($self->config_dir, $_);
126 $ph->{$_} = Module::Build::Notes->new(file => $file);
127 $ph->{$_}->restore if -e $file;
128 if (exists $p->{$_}) {
129 my $vals = delete $p->{$_};
130 while (my ($k, $v) = each %$vals) {
136 # The following warning could be unnecessary if the user is running
137 # an embedded perl, but there aren't too many of those around, and
138 # embedded perls aren't usually used to install modules, and the
139 # installation process sometimes needs to run external scripts
140 # (e.g. to run tests).
141 $p->{perl} = $self->find_perl_interpreter
142 or $self->log_warn("Warning: Can't locate your perl binary");
144 my $blibdir = sub { File::Spec->catdir($p->{blib}, @_) };
145 $p->{bindoc_dirs} ||= [ $blibdir->("script") ];
146 $p->{libdoc_dirs} ||= [ $blibdir->("lib"), $blibdir->("arch") ];
148 $p->{dist_author} = [ $p->{dist_author} ] if defined $p->{dist_author} and not ref $p->{dist_author};
151 $p->{requires} = delete $p->{prereq} if defined $p->{prereq};
152 $p->{script_files} = delete $p->{scripts} if defined $p->{scripts};
155 for ('extra_compiler_flags', 'extra_linker_flags') {
156 $p->{$_} = [ $self->split_like_shell($p->{$_}) ] if exists $p->{$_};
159 $self->add_to_cleanup( @{delete $p->{add_to_cleanup}} )
160 if $p->{add_to_cleanup};
165 ################## End constructors #########################
167 sub log_info { print @_ unless shift()->quiet }
168 sub log_verbose { shift()->log_info(@_) if $_[0]->verbose }
170 # Try to make our call stack invisible
172 if (@_ and $_[-1] !~ /\n$/) {
173 my (undef, $file, $line) = caller();
174 warn @_, " at $file line $line.\n";
181 sub _set_install_paths {
183 my $c = $self->config;
184 my $p = $self->{properties};
186 my @libstyle = $c->{installstyle} ?
187 File::Spec->splitdir($c->{installstyle}) : qw(lib perl5);
188 my $arch = $c->{archname};
189 my $version = $c->{version};
191 my $bindoc = $c->{installman1dir} || undef;
192 my $libdoc = $c->{installman3dir} || undef;
194 my $binhtml = $c->{installhtml1dir} || $c->{installhtmldir} || undef;
195 my $libhtml = $c->{installhtml3dir} || $c->{installhtmldir} || undef;
200 lib => $c->{installprivlib},
201 arch => $c->{installarchlib},
202 bin => $c->{installbin},
203 script => $c->{installscript},
210 lib => $c->{installsitelib},
211 arch => $c->{installsitearch},
212 bin => $c->{installsitebin} || $c->{installbin},
213 script => $c->{installsitescript} ||
214 $c->{installsitebin} || $c->{installscript},
215 bindoc => $c->{installsiteman1dir} || $bindoc,
216 libdoc => $c->{installsiteman3dir} || $libdoc,
217 binhtml => $c->{installsitehtml1dir} || $binhtml,
218 libhtml => $c->{installsitehtml3dir} || $libhtml,
221 lib => $c->{installvendorlib},
222 arch => $c->{installvendorarch},
223 bin => $c->{installvendorbin} || $c->{installbin},
224 script => $c->{installvendorscript} ||
225 $c->{installvendorbin} || $c->{installscript},
226 bindoc => $c->{installvendorman1dir} || $bindoc,
227 libdoc => $c->{installvendorman3dir} || $libdoc,
228 binhtml => $c->{installvendorhtml1dir} || $binhtml,
229 libhtml => $c->{installvendorhtml3dir} || $libhtml,
233 $p->{original_prefix} =
235 core => $c->{installprefixexp} || $c->{installprefix} ||
236 $c->{prefixexp} || $c->{prefix} || '',
237 site => $c->{siteprefixexp},
238 vendor => $c->{usevendorprefix} ? $c->{vendorprefixexp} : '',
240 $p->{original_prefix}{site} ||= $p->{original_prefix}{core};
242 # Note: you might be tempted to use $Config{installstyle} here
243 # instead of hard-coding lib/perl5, but that's been considered and
244 # (at least for now) rejected. `perldoc Config` has some wisdom
246 $p->{install_base_relpaths} =
248 lib => ['lib', 'perl5'],
249 arch => ['lib', 'perl5', $arch],
252 bindoc => ['man', 'man1'],
253 libdoc => ['man', 'man3'],
258 $p->{prefix_relpaths} =
262 arch => [@libstyle, $version, $arch],
265 bindoc => ['man', 'man1'],
266 libdoc => ['man', 'man3'],
272 arch => [@libstyle, $version, $arch],
275 bindoc => ['man', 'man1'],
276 libdoc => ['man', 'man3'],
281 lib => [@libstyle, 'site_perl'],
282 arch => [@libstyle, 'site_perl', $version, $arch],
285 bindoc => ['man', 'man1'],
286 libdoc => ['man', 'man3'],
294 sub _find_nested_builds {
296 my $r = $self->recurse_into or return;
299 if (!ref($r) && $r eq 'auto') {
301 opendir DH, $self->base_dir
302 or die "Can't scan directory " . $self->base_dir . " for nested builds: $!";
303 while (defined($file = readdir DH)) {
304 my $subdir = File::Spec->catdir( $self->base_dir, $file );
305 next unless -d $subdir;
306 push @r, $subdir if -e File::Spec->catfile( $subdir, 'Build.PL' );
310 $self->recurse_into(\@r);
319 my ($self, $perl) = @_;
320 return `$perl -MConfig=myconfig -e print -e myconfig` eq Config->myconfig;
323 sub find_perl_interpreter {
324 return $^X if File::Spec->file_name_is_absolute($^X);
326 my $c = ref($proto) ? $proto->config : \%Config::Config;
327 my $exe = $c->{exe_ext};
330 if ($proto->os_type eq 'VMS') {
331 # VMS might have a file version at the end
332 $thisperl .= $exe unless $thisperl =~ m/$exe(;\d+)?$/i;
333 } elsif (defined $exe) {
334 $thisperl .= $exe unless $thisperl =~ m/$exe$/i;
337 foreach my $perl ( $c->{perlpath},
338 map File::Spec->catfile($_, $thisperl), File::Spec->path()
340 return $perl if -f $perl and $proto->_perl_is_same($perl);
345 sub _is_interactive {
346 return -t STDIN && (-t STDOUT || !(-f STDOUT || -c STDOUT)) ; # Pipe?
351 my ($mess, $def) = @_;
352 die "prompt() called without a prompt message" unless @_;
354 ($def, my $dispdef) = defined $def ? ($def, "[$def] ") : ('', ' ');
358 print "$mess $dispdef";
361 if ( ! $ENV{PERL_MM_USE_DEFAULT} &&
362 ( $self->_is_interactive || ! eof STDIN ) ) {
364 if ( defined $ans ) {
366 } else { # user hit ctrl-D
371 unless (defined($ans) and length($ans)) {
381 die "y_n() called without a prompt message" unless @_;
382 die "y_n() called without y or n default" unless ($_[1]||"")=~/^[yn]/i;
384 my $interactive = $self->_is_interactive;
387 $answer = $self->prompt(@_);
388 return 1 if $answer =~ /^y/i;
389 return 0 if $answer =~ /^n/i;
390 print "Please answer 'y' or 'n'.\n";
394 sub current_action { shift->{action} }
395 sub invoked_action { shift->{invoked_action} }
397 sub notes { shift()->{phash}{notes}->access(@_) }
398 sub config_data { shift()->{phash}{config_data}->access(@_) }
399 sub runtime_params { shift->{phash}{runtime_params}->read( @_ ? shift : () ) } # Read-only
400 sub auto_features { shift()->{phash}{auto_features}->access(@_) }
404 my $ph = $self->{phash};
408 if ($ph->{features}->exists($key)) {
409 return $ph->{features}->access($key, @_);
412 if (my $info = $ph->{auto_features}->access($key)) {
413 my $failures = $self->prereq_failures($info);
414 my $disabled = grep( /^(?:\w+_)?(?:requires|conflicts)$/,
415 keys %$failures ) ? 1 : 0;
419 return $ph->{features}->access($key, @_);
422 # No args - get the auto_features & overlay the regular features
424 my %auto_features = $ph->{auto_features}->access();
425 while (my ($name, $info) = each %auto_features) {
426 my $failures = $self->prereq_failures($info);
427 my $disabled = grep( /^(?:\w+_)?(?:requires|conflicts)$/,
428 keys %$failures ) ? 1 : 0;
429 $features{$name} = $disabled ? 0 : 1;
431 %features = (%features, $ph->{features}->access());
433 return wantarray ? %features : \%features;
435 BEGIN { *feature = \&features }
440 if (($self->module_name || '') eq 'Module::Build') {
441 # We're building Module::Build itself, so ...::ConfigData isn't
442 # valid, but $self->features() should be.
443 return $self->feature(@_);
445 require Module::Build::ConfigData;
446 return Module::Build::ConfigData->feature(@_);
451 sub add_build_element {
452 my ($self, $elem) = @_;
453 my $elems = $self->build_elements;
454 push @$elems, $elem unless grep { $_ eq $elem } @$elems;
457 sub ACTION_config_data {
459 return unless $self->has_config_data;
461 my $module_name = $self->module_name
462 or die "The config_data feature requires that 'module_name' be set";
463 my $notes_name = $module_name . '::ConfigData'; # TODO: Customize name ???
464 my $notes_pm = File::Spec->catfile($self->blib, 'lib', split /::/, "$notes_name.pm");
466 return if $self->up_to_date(['Build.PL',
467 $self->config_file('config_data'),
468 $self->config_file('features')
471 $self->log_info("Writing config notes to $notes_pm\n");
472 File::Path::mkpath(File::Basename::dirname($notes_pm));
474 Module::Build::Notes->write_config_data
477 module => $module_name,
478 config_module => $notes_name,
479 config_data => scalar $self->config_data,
480 feature => scalar $self->{phash}{features}->access(),
481 auto_features => scalar $self->auto_features,
486 my %valid_properties = ( __PACKAGE__, {} );
487 my %additive_properties;
490 my $class = ref($_[0]) || $_[0];
491 return ($class, $class->mb_parents);
495 my ($class, $prop) = @_;
496 return grep exists( $valid_properties{$_}{$prop} ), $class->_mb_classes;
499 sub valid_properties {
500 return keys %{ shift->valid_properties_defaults() };
503 sub valid_properties_defaults {
505 for (reverse shift->_mb_classes) {
506 @out{ keys %{ $valid_properties{$_} } } = values %{ $valid_properties{$_} };
511 sub array_properties {
512 for (shift->_mb_classes) {
513 return @{$additive_properties{$_}->{ARRAY}}
514 if exists $additive_properties{$_}->{ARRAY};
518 sub hash_properties {
519 for (shift->_mb_classes) {
520 return @{$additive_properties{$_}->{'HASH'}}
521 if exists $additive_properties{$_}->{'HASH'};
526 my ($class, $property, $default) = @_;
527 die "Property '$property' already exists" if $class->valid_property($property);
529 $valid_properties{$class}{$property} = $default;
531 my $type = ref $default;
533 push @{$additive_properties{$class}->{$type}}, $property;
536 unless ($class->can($property)) {
538 if ( $type eq 'HASH' ) {
539 *{"$class\::$property"} = sub {
541 my $x = ( $property eq 'config' ) ? $self : $self->{properties};
542 return $x->{$property} unless @_;
544 if ( defined($_[0]) && !ref($_[0]) ) {
546 return exists( $x->{$property}{$_[0]} ) ?
547 $x->{$property}{$_[0]} : undef;
548 } elsif ( @_ % 2 == 0 ) {
550 while ( my($k, $v) = each %args ) {
551 $x->{$property}{$k} = $v;
554 die "Unexpected arguments for property '$property'\n";
557 $x->{$property} = $_[0];
562 *{"$class\::$property"} = sub {
564 $self->{properties}{$property} = shift if @_;
565 return $self->{properties}{$property};
576 # Set the build class.
577 $self->{properties}{build_class} ||= ref $self;
579 # If there was no orig_dir, set to the same as base_dir
580 $self->{properties}{orig_dir} ||= $self->{properties}{base_dir};
582 my $defaults = $self->valid_properties_defaults;
584 foreach my $prop (keys %$defaults) {
585 $self->{properties}{$prop} = $defaults->{$prop}
586 unless exists $self->{properties}{$prop};
589 # Copy defaults for arrays any arrays.
590 for my $prop ($self->array_properties) {
591 $self->{properties}{$prop} = [@{$defaults->{$prop}}]
592 unless exists $self->{properties}{$prop};
594 # Copy defaults for arrays any hashes.
595 for my $prop ($self->hash_properties) {
596 $self->{properties}{$prop} = {%{$defaults->{$prop}}}
597 unless exists $self->{properties}{$prop};
603 # Add the default properties.
604 __PACKAGE__->add_property(blib => 'blib');
605 __PACKAGE__->add_property(build_class => 'Module::Build');
606 __PACKAGE__->add_property(build_elements => [qw(PL support pm xs pod script)]);
607 __PACKAGE__->add_property(build_script => 'Build');
608 __PACKAGE__->add_property(build_bat => 0);
609 __PACKAGE__->add_property(config_dir => '_build');
610 __PACKAGE__->add_property(include_dirs => []);
611 __PACKAGE__->add_property(installdirs => 'site');
612 __PACKAGE__->add_property(metafile => 'META.yml');
613 __PACKAGE__->add_property(recurse_into => []);
614 __PACKAGE__->add_property(use_rcfile => 1);
617 my $Is_ActivePerl = eval {require ActivePerl::DocTools};
618 __PACKAGE__->add_property(html_css => $Is_ActivePerl ? 'Active.css' : '');
622 my @prereq_action_types = qw(requires build_requires conflicts recommends);
623 foreach my $type (@prereq_action_types) {
624 __PACKAGE__->add_property($type => {});
626 __PACKAGE__->add_property(prereq_action_types => \@prereq_action_types);
629 __PACKAGE__->add_property($_ => {}) for qw(
632 install_base_relpaths
641 __PACKAGE__->add_property($_) for qw(
682 # Code borrowed from Class::ISA.
683 my @in_stack = (shift);
684 my %seen = ($in_stack[0] => 1);
688 next unless defined($current = shift @in_stack)
689 && $current->isa('Module::Build::Base');
691 next if $current eq 'Module::Build::Base';
695 my $c = $_; # copy, to avoid being destructive
696 substr($c,0,2) = "main::" if substr($c,0,2) eq '::';
697 # Canonize the :: -> main::, ::foo -> main::foo thing.
698 # Should I ever canonize the Foo'Bar = Foo::Bar thing?
699 $seen{$c}++ ? () : $c;
700 } @{"$current\::ISA"};
702 # I.e., if this class has any parents (at least, ones I've never seen
703 # before), push them, in order, onto the stack of classes I need to
710 sub extra_linker_flags { shift->_list_accessor('extra_linker_flags', @_) }
711 sub extra_compiler_flags { shift->_list_accessor('extra_compiler_flags', @_) }
714 (my $self, local $_) = (shift, shift);
715 my $p = $self->{properties};
716 $p->{$_} = [@_] if @_;
717 $p->{$_} = [] unless exists $p->{$_};
718 return ref($p->{$_}) ? $p->{$_} : [$p->{$_}];
721 # XXX Problem - if Module::Build is loaded from a different directory,
722 # it'll look for (and perhaps destroy/create) a _build directory.
724 my ($pack, %opts) = @_;
726 my $build_dir = '_build'; # XXX The _build directory is ostensibly settable by the user. Shouldn't hard-code here.
727 $pack->delete_filetree($build_dir) if -e $build_dir;
729 die "Must provide 'code' or 'class' option to subclass()\n"
730 unless $opts{code} or $opts{class};
733 $opts{class} ||= 'MyModuleBuilder';
735 my $filename = File::Spec->catfile($build_dir, 'lib', split '::', $opts{class}) . '.pm';
736 my $filedir = File::Basename::dirname($filename);
737 $pack->log_info("Creating custom builder $filename in $filedir\n");
739 File::Path::mkpath($filedir);
740 die "Can't create directory $filedir: $!" unless -d $filedir;
742 my $fh = IO::File->new("> $filename") or die "Can't create $filename: $!";
744 package $opts{class};
752 unshift @INC, File::Spec->catdir(File::Spec->rel2abs($build_dir), 'lib');
753 eval "use $opts{class}";
761 my $p = $self->{properties};
762 return $p->{dist_name} if defined $p->{dist_name};
764 die "Can't determine distribution name, must supply either 'dist_name' or 'module_name' parameter"
765 unless $p->{module_name};
767 ($p->{dist_name} = $p->{module_name}) =~ s/::/-/g;
769 return $p->{dist_name};
772 sub _find_dist_version_from {
774 my $p = $self->{properties};
775 if ($self->module_name) {
776 return $p->{dist_version_from} ||=
777 join( '/', 'lib', split(/::/, $self->module_name) ) . '.pm';
785 my $p = $self->{properties};
787 return $p->{dist_version} if defined $p->{dist_version};
789 $self->_find_dist_version_from;
791 if ( $p->{dist_version_from} ) {
792 my $version_from = File::Spec->catfile( split( qr{/}, $p->{dist_version_from} ) );
793 my $pm_info = Module::Build::ModuleInfo->new_from_file( $version_from )
794 or die "Can't find file $version_from to determine version";
795 $p->{dist_version} = $pm_info->version();
798 die ("Can't determine distribution version, must supply either 'dist_version',\n".
799 "'dist_version_from', or 'module_name' parameter")
800 unless $p->{dist_version};
802 return $p->{dist_version};
805 sub dist_author { shift->_pod_parse('author') }
806 sub dist_abstract { shift->_pod_parse('abstract') }
809 my ($self, $part) = @_;
810 my $p = $self->{properties};
811 my $member = "dist_$part";
812 return $p->{$member} if defined $p->{$member};
814 my $docfile = $self->_main_docfile
816 my $fh = IO::File->new($docfile)
819 require Module::Build::PodParser;
820 my $parser = Module::Build::PodParser->new(fh => $fh);
821 my $method = "get_$part";
822 return $p->{$member} = $parser->$method();
825 sub version_from_file { # Method provided for backwards compatability
826 return Module::Build::ModuleInfo->new_from_file($_[1])->version();
829 sub find_module_by_name { # Method provided for backwards compatability
830 return Module::Build::ModuleInfo->find_module_by_name(@_[1,2]);
835 my %files = map {$self->localize_file_path($_), 1} @_;
836 $self->{phash}{cleanup}->write(\%files);
841 my $all = $self->{phash}{cleanup}->read;
847 return unless -d $self->config_dir;
848 return File::Spec->catfile($self->config_dir, @_);
854 my $file = $self->config_file('build_params')
855 or die "No build_params?";
856 my $fh = IO::File->new($file) or die "Can't read '$file': $!";
857 my $ref = eval do {local $/; <$fh>};
859 ($self->{args}, $self->{config}, $self->{properties}) = @$ref;
863 sub has_config_data {
865 return scalar grep $self->{phash}{$_}->has_data(), qw(config_data features auto_features);
869 my ($self, $filename, $data) = @_;
871 my $file = $self->config_file($filename);
872 my $fh = IO::File->new("> $file") or die "Can't create '$file': $!";
873 local $Data::Dumper::Terse = 1;
874 print $fh ref($data) ? Data::Dumper::Dumper($data) : $data;
880 File::Path::mkpath($self->{properties}{config_dir});
881 -d $self->{properties}{config_dir} or die "Can't mkdir $self->{properties}{config_dir}: $!";
883 my @items = @{ $self->prereq_action_types };
884 $self->_write_data('prereqs', { map { $_, $self->$_() } @items });
885 $self->_write_data('build_params', [$self->{args}, $self->{config}, $self->{properties}]);
887 # Set a new magic number and write it to a file
888 $self->_write_data('magicnum', $self->magic_number(int rand 1_000_000));
890 $self->{phash}{$_}->write() foreach qw(notes cleanup features auto_features config_data runtime_params);
893 sub check_autofeatures {
895 my $features = $self->auto_features;
897 return unless %$features;
899 $self->log_info("Checking features:\n");
902 $max_name_len = ( length($_) > $max_name_len ) ?
903 length($_) : $max_name_len
906 while (my ($name, $info) = each %$features) {
907 $self->log_info(" $name" . '.' x ($max_name_len - length($name) + 4));
909 if ( my $failures = $self->prereq_failures($info) ) {
910 my $disabled = grep( /^(?:\w+_)?(?:requires|conflicts)$/,
911 keys %$failures ) ? 1 : 0;
912 $self->log_info( $disabled ? "disabled\n" : "enabled\n" );
915 while (my ($type, $prereqs) = each %$failures) {
916 while (my ($module, $status) = each %$prereqs) {
918 ($type =~ /^(?:\w+_)?(?:requires|conflicts)$/) ? 1 : 0;
919 my $prefix = ($required) ? '-' : '*';
920 $log_text .= " $prefix $status->{message}\n";
923 $self->log_warn("$log_text") unless $self->quiet;
925 $self->log_info("enabled\n");
929 $self->log_warn("\n");
932 sub prereq_failures {
933 my ($self, $info) = @_;
935 my @types = @{ $self->prereq_action_types };
936 $info ||= {map {$_, $self->$_()} @types};
940 foreach my $type (@types) {
941 my $prereqs = $info->{$type};
942 while ( my ($modname, $spec) = each %$prereqs ) {
943 my $status = $self->check_installed_status($modname, $spec);
945 if ($type =~ /^(?:\w+_)?conflicts$/) {
946 next if !$status->{ok};
947 $status->{conflicts} = delete $status->{need};
948 $status->{message} = "$modname ($status->{have}) conflicts with this distribution";
950 } elsif ($type =~ /^(?:\w+_)?recommends$/) {
951 next if $status->{ok};
952 $status->{message} = ($status->{have} eq '<none>'
953 ? "Optional prerequisite $modname is not installed"
954 : "$modname ($status->{have}) is installed, but we prefer to have $spec");
956 next if $status->{ok};
959 $out->{$type}{$modname} = $status;
966 # returns a hash of defined prerequisites; i.e. only prereq types with values
970 foreach my $type ( @{ $self->prereq_action_types } ) {
971 if ( $self->can( $type ) ) {
972 my $prereq = $self->$type() || {};
973 $prereqs{$type} = $prereq if %$prereq;
982 # If we have XS files, make sure we can process them.
983 my $xs_files = $self->find_xs_files;
984 if (keys %$xs_files && !$self->_mb_feature('C_support')) {
985 $self->log_warn("Warning: this distribution contains XS files, ".
986 "but Module::Build is not configured with C_support");
989 # Check to see if there are any prereqs to check
990 my $info = $self->_enum_prereqs;
991 return 1 unless $info;
993 $self->log_info("Checking prerequisites...\n");
995 my $failures = $self->prereq_failures($info);
999 while (my ($type, $prereqs) = each %$failures) {
1000 while (my ($module, $status) = each %$prereqs) {
1001 my $prefix = ($type =~ /^(?:\w+_)?recommends$/) ? '*' : '- ERROR:';
1002 $self->log_warn(" $prefix $status->{message}\n");
1006 $self->log_warn(<<EOF);
1008 ERRORS/WARNINGS FOUND IN PREREQUISITES. You may wish to install the versions
1009 of the modules indicated above before proceeding with this installation
1016 $self->log_info("Looks good\n\n");
1024 # Check the current perl interpreter
1025 # It's much more convenient to use $] here than $^V, but 'man
1026 # perlvar' says I'm not supposed to. Bloody tyrant.
1027 return $^V ? $self->perl_version_to_float(sprintf "%vd", $^V) : $];
1030 sub perl_version_to_float {
1031 my ($self, $version) = @_;
1032 $version =~ s/\./../;
1033 $version =~ s/\.(\d+)/sprintf '%03d', $1/eg;
1037 sub _parse_conditions {
1038 my ($self, $spec) = @_;
1040 if ($spec =~ /^\s*([\w.]+)\s*$/) { # A plain number, maybe with dots, letters, and underscores
1041 return (">= $spec");
1043 return split /\s*,\s*/, $spec;
1047 sub check_installed_status {
1048 my ($self, $modname, $spec) = @_;
1049 my %status = (need => $spec);
1051 if ($modname eq 'perl') {
1052 $status{have} = $self->perl_version;
1054 } elsif (eval { no strict; $status{have} = ${"${modname}::VERSION"} }) {
1055 # Don't try to load if it's already loaded
1058 my $pm_info = Module::Build::ModuleInfo->new_from_module( $modname );
1059 unless (defined( $pm_info )) {
1060 @status{ qw(have message) } = ('<none>', "$modname is not installed");
1064 $status{have} = $pm_info->version();
1065 if ($spec and !$status{have}) {
1066 @status{ qw(have message) } = (undef, "Couldn't find a \$VERSION in prerequisite $modname");
1071 my @conditions = $self->_parse_conditions($spec);
1073 foreach (@conditions) {
1074 my ($op, $version) = /^\s* (<=?|>=?|==|!=) \s* ([\w.]+) \s*$/x
1075 or die "Invalid prerequisite condition '$_' for $modname";
1077 $version = $self->perl_version_to_float($version)
1078 if $modname eq 'perl';
1080 next if $op eq '>=' and !$version; # Module doesn't have to actually define a $VERSION
1082 unless ($self->compare_versions( $status{have}, $op, $version )) {
1083 $status{message} = "$modname ($status{have}) is installed, but we need version $op $version";
1092 sub compare_versions {
1094 my ($v1, $op, $v2) = @_;
1096 # for alpha versions - this doesn't cover all cases, but should work for most:
1097 $v1 =~ s/_(\d+)\z/$1/;
1098 $v2 =~ s/_(\d+)\z/$1/;
1100 my $eval_str = "\$v1 $op \$v2";
1101 my $result = eval $eval_str;
1102 $self->log_warn("error comparing versions: '$eval_str' $@") if $@;
1107 # I wish I could set $! to a string, but I can't, so I use $@
1108 sub check_installed_version {
1109 my ($self, $modname, $spec) = @_;
1111 my $status = $self->check_installed_status($modname, $spec);
1113 if ($status->{ok}) {
1114 return $status->{have} if $status->{have} and $status->{have} ne '<none>';
1115 return '0 but true';
1118 $@ = $status->{message};
1122 sub make_executable {
1123 # Perl's chmod() is mapped to useful things on various non-Unix
1124 # platforms, so we use it in the base class even though it looks
1129 my $current_mode = (stat $_)[2];
1130 chmod $current_mode | 0111, $_;
1134 sub _startperl { shift()->config('startperl') }
1136 # Return any directories in @INC which are not in the default @INC for
1137 # this perl. For example, stuff passed in with -I or loaded with "use lib".
1142 $seen{$_}++ foreach $self->_default_INC;
1143 return grep !$seen{$_}++, @INC;
1146 # Determine the default @INC for this Perl
1148 my @default_inc; # Memoize
1151 return @default_inc if @default_inc;
1153 local $ENV{PERL5LIB}; # this is not considered part of the default.
1155 my $perl = ref($self) ? $self->perl : $self->find_perl_interpreter;
1157 my @inc = `$perl -le "print for \@INC"`;
1160 return @default_inc = @inc;
1164 sub print_build_script {
1165 my ($self, $fh) = @_;
1167 my $build_package = $self->build_class;
1171 my %q = map {$_, $self->$_()} qw(config_dir base_dir);
1173 my $case_tolerant = 0+(File::Spec->can('case_tolerant')
1174 && File::Spec->case_tolerant);
1175 $q{base_dir} = uc $q{base_dir} if $case_tolerant;
1176 $q{base_dir} = Win32::GetShortPathName($q{base_dir}) if $^O eq 'MSWin32';
1178 $q{magic_numfile} = $self->config_file('magicnum');
1180 my @myINC = $self->_added_to_INC;
1181 for (@myINC, values %q) {
1182 $_ = File::Spec->canonpath( $_ );
1186 my $quoted_INC = join ",\n", map " '$_'", @myINC;
1187 my $shebang = $self->_startperl;
1188 my $magic_number = $self->magic_number;
1198 sub magic_number_matches {
1199 return 0 unless -e '$q{magic_numfile}';
1201 open FH, '$q{magic_numfile}' or return 0;
1202 my \$filenum = <FH>;
1204 return \$filenum == $magic_number;
1210 \$^W = 1; # Use warnings
1211 \$progname = basename(\$0);
1212 \$orig_dir = Cwd::cwd();
1213 my \$base_dir = '$q{base_dir}';
1214 if (!magic_number_matches()) {
1215 unless (chdir(\$base_dir)) {
1216 die ("Couldn't chdir(\$base_dir), aborting\\n");
1218 unless (magic_number_matches()) {
1219 die ("Configuration seems to be out of date, please re-run 'perl Build.PL' again.\\n");
1228 close(*DATA) unless eof(*DATA); # ensure no open handles to this script
1232 # Some platforms have problems setting \$^X in shebang contexts, fix it up here
1233 \$^X = Module::Build->find_perl_interpreter
1234 unless File::Spec->file_name_is_absolute(\$^X);
1236 if (-e 'Build.PL' and not $build_package->up_to_date('Build.PL', \$progname)) {
1237 warn "Warning: Build.PL has been altered. You may need to run 'perl Build.PL' again.\\n";
1240 # This should have just enough arguments to be able to bootstrap the rest.
1241 my \$build = $build_package->resume (
1243 config_dir => '$q{config_dir}',
1244 orig_dir => \$orig_dir,
1252 sub create_build_script {
1254 $self->write_config;
1256 my ($build_script, $dist_name, $dist_version)
1257 = map $self->$_(), qw(build_script dist_name dist_version);
1259 if ( $self->delete_filetree($build_script) ) {
1260 $self->log_info("Removed previous script '$build_script'\n\n");
1263 $self->log_info("Creating new '$build_script' script for ",
1264 "'$dist_name' version '$dist_version'\n");
1265 my $fh = IO::File->new(">$build_script") or die "Can't create '$build_script': $!";
1266 $self->print_build_script($fh);
1269 $self->make_executable($build_script);
1274 sub check_manifest {
1276 return unless -e 'MANIFEST';
1278 # Stolen nearly verbatim from MakeMaker. But ExtUtils::Manifest
1279 # could easily be re-written into a modern Perl dialect.
1281 require ExtUtils::Manifest; # ExtUtils::Manifest is not warnings clean.
1282 local ($^W, $ExtUtils::Manifest::Quiet) = (0,1);
1284 $self->log_info("Checking whether your kit is complete...\n");
1285 if (my @missed = ExtUtils::Manifest::manicheck()) {
1286 $self->log_warn("WARNING: the following files are missing in your kit:\n",
1287 "\t", join("\n\t", @missed), "\n",
1288 "Please inform the author.\n\n");
1290 $self->log_info("Looks good\n\n");
1296 local $self->{_completed_actions} = {};
1299 my ($action, %p) = @_;
1300 my $args = $p{args} ? delete($p{args}) : {};
1302 local $self->{invoked_action} = $action;
1303 local $self->{args} = {%{$self->{args}}, %$args};
1304 local $self->{properties} = {%{$self->{properties}}, %p};
1305 return $self->_call_action($action);
1308 die "No build action specified" unless $self->{action};
1309 local $self->{invoked_action} = $self->{action};
1310 $self->_call_action($self->{action});
1314 my ($self, $action) = @_;
1316 return if $self->{_completed_actions}{$action}++;
1318 local $self->{action} = $action;
1319 my $method = "ACTION_$action";
1320 die "No action '$action' defined, try running the 'help' action.\n" unless $self->can($method);
1321 return $self->$method();
1326 my $specs = $self->get_options or return ({}, @_);
1327 require Getopt::Long;
1328 # XXX Should we let Getopt::Long handle M::B's options? That would
1329 # be easy-ish to add to @specs right here, but wouldn't handle options
1330 # passed without "--" as M::B currently allows. We might be able to
1331 # get around this by setting the "prefix_pattern" Configure option.
1334 # Construct the specifications for GetOptions.
1335 while (my ($k, $v) = each %$specs) {
1336 # Throw an error if specs conflict with our own.
1337 die "Option specification '$k' conflicts with a " . ref $self
1338 . " option of the same name"
1339 if $self->valid_property($k);
1340 push @specs, $k . (defined $v->{type} ? $v->{type} : '');
1341 push @specs, $v->{store} if exists $v->{store};
1342 $args->{$k} = $v->{default} if exists $v->{default};
1345 local @ARGV = @_; # No other way to dupe Getopt::Long
1347 # Get the options values and return them.
1348 # XXX Add option to allow users to set options?
1350 Getopt::Long::Configure('pass_through');
1351 Getopt::Long::GetOptions($args, @specs);
1354 return $args, @ARGV;
1358 my ($self, $args) = @_;
1360 while (my ($k, $v) = each %$args) {
1361 push @out, (UNIVERSAL::isa($v, 'HASH') ? map {+"--$k", "$_=$v->{$_}"} keys %$v :
1362 UNIVERSAL::isa($v, 'ARRAY') ? map {+"--$k", $_} @$v :
1370 return wantarray ? %{ $self->{args} } : $self->{args} unless @_;
1372 $self->{args}{$key} = shift if @_;
1373 return $self->{args}{$key};
1376 sub _translate_option {
1380 (my $tr_opt = $opt) =~ tr/-/_/;
1382 return $tr_opt if grep $tr_opt =~ /^(?:no_?)?$_$/, qw(
1385 extra_compiler_flags
1394 ); # normalize only selected option names
1400 my ($self, $args, $key, $val) = @_;
1402 $key = $self->_translate_option($key);
1404 if ( exists $args->{$key} ) {
1405 $args->{$key} = [ $args->{$key} ] unless ref $args->{$key};
1406 push @{$args->{$key}}, $val;
1408 $args->{$key} = $val;
1417 $opt = $self->_translate_option($opt);
1429 # inverted boolean options; eg --noverbose or --no-verbose
1430 # converted to proper name & returned with false value (verbose, 0)
1431 if ( grep $opt =~ /^no[-_]?$_$/, @bool_opts ) {
1436 # non-boolean option; return option unchanged along with its argument
1437 return ($opt, shift(@$argv)) unless grep $_ eq $opt, @bool_opts;
1439 # we're punting a bit here, if an option appears followed by a digit
1440 # we take the digit as the argument for the option. If there is
1441 # nothing that looks like a digit, we pretent the option is a flag
1442 # that is being set and has no argument.
1444 $arg = shift(@$argv) if @$argv && $argv->[0] =~ /^\d+$/;
1446 return ($opt, $arg);
1451 my ($action, @argv);
1452 (my $args, @_) = $self->cull_options(@_);
1455 my $opt_re = qr/[\w\-]+/;
1459 if ( /^(?:--)?($opt_re)=(.*)$/ ) {
1460 $self->_read_arg(\%args, $1, $2);
1461 } elsif ( /^--($opt_re)$/ ) {
1462 my($opt, $arg) = $self->_optional_arg($1, \@_);
1463 $self->_read_arg(\%args, $opt, $arg);
1464 } elsif ( /^($opt_re)$/ and !defined($action)) {
1470 $args{ARGV} = \@argv;
1472 # Hashify these parameters
1473 for ($self->hash_properties) {
1474 next unless exists $args{$_};
1477 $args{$_} = [ $args{$_} ] unless ref $args{$_};
1478 foreach my $arg ( @{$args{$_}} ) {
1479 $arg =~ /(\w+)=(.*)/
1480 or die "Malformed '$_' argument: '$arg' should be something like 'foo=bar'";
1486 # De-tilde-ify any path parameters
1487 for my $key (qw(prefix install_base destdir)) {
1488 next if !defined $args{$key};
1489 $args{$key} = _detildefy($args{$key});
1492 for my $key (qw(install_path)) {
1493 next if !defined $args{$key};
1495 for my $subkey (keys %{$args{$key}}) {
1496 next if !defined $args{$key}{$subkey};
1497 my $subkey_ext = _detildefy($args{$key}{$subkey});
1498 if ( $subkey eq 'html' ) { # translate for compatability
1499 $args{$key}{binhtml} = $subkey_ext;
1500 $args{$key}{libhtml} = $subkey_ext;
1502 $args{$key}{$subkey} = $subkey_ext;
1507 if ($args{makefile_env_macros}) {
1508 require Module::Build::Compat;
1509 %args = (%args, Module::Build::Compat->makefile_to_build_macros);
1512 return \%args, $action;
1519 my($new_arg) = glob($arg) if $arg =~ /^~/;
1521 return defined($new_arg) ? $new_arg : $arg;
1525 # merge Module::Build argument lists that have already been parsed
1526 # by read_args(). Takes two references to option hashes and merges
1527 # the contents, giving priority to the first.
1528 sub _merge_arglist {
1529 my( $self, $opts1, $opts2 ) = @_;
1531 my %new_opts = %$opts1;
1532 while (my ($key, $val) = each %$opts2) {
1533 if ( exists( $opts1->{$key} ) ) {
1534 if ( ref( $val ) eq 'HASH' ) {
1535 while (my ($k, $v) = each %$val) {
1536 $new_opts{$key}{$k} = $v unless exists( $opts1->{$key}{$k} );
1540 $new_opts{$key} = $val
1547 # Look for a home directory on various systems. CPANPLUS does something like this.
1549 my @os_home_envs = qw( APPDATA HOME USERPROFILE WINDIR SYS$LOGIN );
1551 foreach ( @os_home_envs ) {
1552 return $ENV{$_} if exists $ENV{$_} && defined $ENV{$_} && length $ENV{$_} && -d $ENV{$_};
1558 # read ~/.modulebuildrc returning global options '*' and
1559 # options specific to the currently executing $action.
1560 sub read_modulebuildrc {
1561 my( $self, $action ) = @_;
1563 return () unless $self->use_rcfile;
1566 if ( exists($ENV{MODULEBUILDRC}) && $ENV{MODULEBUILDRC} eq 'NONE' ) {
1568 } elsif ( exists($ENV{MODULEBUILDRC}) && -e $ENV{MODULEBUILDRC} ) {
1569 $modulebuildrc = $ENV{MODULEBUILDRC};
1570 } elsif ( exists($ENV{MODULEBUILDRC}) ) {
1571 $self->log_warn("WARNING: Can't find resource file " .
1572 "'$ENV{MODULEBUILDRC}' defined in environment.\n" .
1573 "No options loaded\n");
1576 my $home = $self->_home_dir;
1577 return () unless defined $home;
1578 $modulebuildrc = File::Spec->catfile( $home, '.modulebuildrc' );
1579 return () unless -e $modulebuildrc;
1582 my $fh = IO::File->new( $modulebuildrc )
1583 or die "Can't open $modulebuildrc: $!";
1585 my %options; my $buffer = '';
1586 while (defined( my $line = <$fh> )) {
1589 next unless length( $line );
1591 if ( $line =~ /^\S/ ) {
1593 my( $action, $options ) = split( /\s+/, $buffer, 2 );
1594 $options{$action} .= $options . ' ';
1603 if ( $buffer ) { # anything left in $buffer ?
1604 my( $action, $options ) = split( /\s+/, $buffer, 2 );
1605 $options{$action} .= $options . ' '; # merge if more than one line
1609 $self->read_args( $self->split_like_shell( $options{'*'} || '' ) );
1611 $self->read_args( $self->split_like_shell( $options{$action} || '' ) );
1613 # specific $action options take priority over global options '*'
1614 return $self->_merge_arglist( $action_opts, $global_opts );
1617 # merge the relevant options in ~/.modulebuildrc into Module::Build's
1618 # option list where they do not conflict with commandline options.
1619 sub merge_modulebuildrc {
1620 my( $self, $action, %cmdline_opts ) = @_;
1621 my %rc_opts = $self->read_modulebuildrc( $action || $self->{action} || 'build' );
1622 my %new_opts = $self->_merge_arglist( \%cmdline_opts, \%rc_opts );
1623 $self->merge_args( $action, %new_opts );
1627 my ($self, $action, %args) = @_;
1628 $self->{action} = $action if defined $action;
1630 my %additive = map { $_ => 1 } $self->hash_properties;
1632 # Extract our 'properties' from $cmd_args, the rest are put in 'args'.
1633 while (my ($key, $val) = each %args) {
1634 $self->{phash}{runtime_params}->access( $key => $val )
1635 if $self->valid_property($key);
1636 my $add_to = ( $key eq 'config' ? $self->{config}
1637 : $additive{$key} ? $self->{properties}{$key}
1638 : $self->valid_property($key) ? $self->{properties}
1641 if ($additive{$key}) {
1642 $add_to->{$_} = $val->{$_} foreach keys %$val;
1644 $add_to->{$key} = $val;
1651 my ($args, $action) = $self->read_args(@_);
1652 $self->merge_args($action, %$args);
1653 $self->merge_modulebuildrc( $action, %$args );
1657 my ($self, $class, $seen) = @_;
1658 $class ||= ref($self) || $self;
1662 my @super = grep {not $seen->{$_}++} $class, @{ $class . '::ISA' };
1663 return @super, map {$self->super_classes($_,$seen)} @super;
1672 foreach my $class ($self->super_classes) {
1673 foreach ( keys %{ $class . '::' } ) {
1674 $actions{$1}++ if /^ACTION_(\w+)/;
1678 return wantarray ? sort keys %actions : \%actions;
1681 sub get_action_docs {
1682 my ($self, $action, $actions) = @_;
1683 $actions ||= $self->known_actions;
1685 ($@ = "No known action '$action'\n"), return
1686 unless $actions->{$action};
1688 my ($files_found, @docs) = (0);
1689 foreach my $class ($self->super_classes) {
1690 (my $file = $class) =~ s{::}{/}g;
1691 $file = $INC{$file . '.pm'} or next;
1692 my $fh = IO::File->new("< $file") or next;
1695 # Code below modified from /usr/bin/perldoc
1697 # Skip to ACTIONS section
1700 last if /^=head1 ACTIONS\s/;
1703 # Look for our action
1704 my ($found, $inlist) = (0, 0);
1706 if (/^=item\s+\Q$action\E\b/) {
1708 } elsif (/^=(item|back)/) {
1709 last if $found > 1 and not $inlist;
1713 ++$inlist if /^=over/;
1714 --$inlist if /^=back/;
1715 ++$found if /^\w/; # Found descriptive text
1719 unless ($files_found) {
1720 $@ = "Couldn't find any documentation to search";
1724 $@ = "Couldn't find any docs for action '$action'";
1728 return join '', @docs;
1731 sub ACTION_prereq_report {
1733 $self->log_info( $self->prereq_report );
1738 my @types = @{ $self->prereq_action_types };
1739 my $info = { map { $_ => $self->$_() } @types };
1742 foreach my $type (@types) {
1743 my $prereqs = $info->{$type};
1744 next unless %$prereqs;
1745 $output .= "\n$type:\n";
1749 while ( my ($modname, $spec) = each %$prereqs ) {
1750 my $len = length $modname;
1751 $mod_len = $len if $len > $mod_len;
1753 $len = length $spec;
1754 $ver_len = $len if $len > $ver_len;
1756 my $mod = $self->check_installed_status($modname, $spec);
1757 $mod->{name} = $modname;
1759 $mod->{ok} = ! $mod->{ok} if $type =~ /^(\w+_)?conflicts$/;
1761 $mods{lc $modname} = $mod;
1764 my $space = q{ } x ($mod_len - 3);
1765 my $vspace = q{ } x ($ver_len - 3);
1766 my $sline = q{-} x ($mod_len - 3);
1767 my $vline = q{-} x ($ver_len - 3);
1768 my $disposition = ($type =~ /^(\w+_)?conflicts$/) ?
1771 " Module $space $disposition $vspace Have\n".
1772 " ------$sline+------$vline-+----------\n";
1775 for my $k (sort keys %mods) {
1776 my $mod = $mods{$k};
1777 my $space = q{ } x ($mod_len - length $k);
1778 my $vspace = q{ } x ($ver_len - length $mod->{need});
1779 my $f = $mod->{ok} ? ' ' : '!';
1781 " $f $mod->{name} $space $mod->{need} $vspace $mod->{have}\n";
1789 my $actions = $self->known_actions;
1791 if (@{$self->{args}{ARGV}}) {
1792 my $msg = $self->get_action_docs($self->{args}{ARGV}[0], $actions) || "$@\n";
1799 Usage: $0 <action> arg1=value arg2=value ...
1800 Example: $0 test verbose=1
1805 print $self->_action_listing($actions);
1807 print "\nRun `Build help <action>` for details on an individual action.\n";
1808 print "See `perldoc Module::Build` for complete documentation.\n";
1811 sub _action_listing {
1812 my ($self, $actions) = @_;
1814 # Flow down columns, not across rows
1815 my @actions = sort keys %$actions;
1816 @actions = map $actions[($_ + ($_ % 2) * @actions) / 2], 0..$#actions;
1819 while (my ($one, $two) = splice @actions, 0, 2) {
1820 $out .= sprintf(" %-12s %-12s\n", $one, $two||'');
1827 my $p = $self->{properties};
1828 require Test::Harness;
1830 $self->depends_on('code');
1832 # Do everything in our power to work with all versions of Test::Harness
1833 my @harness_switches = $p->{debugger} ? qw(-w -d) : ();
1834 local $Test::Harness::switches = join ' ', grep defined, $Test::Harness::switches, @harness_switches;
1835 local $Test::Harness::Switches = join ' ', grep defined, $Test::Harness::Switches, @harness_switches;
1836 local $ENV{HARNESS_PERL_SWITCHES} = join ' ', grep defined, $ENV{HARNESS_PERL_SWITCHES}, @harness_switches;
1838 $Test::Harness::switches = undef unless length $Test::Harness::switches;
1839 $Test::Harness::Switches = undef unless length $Test::Harness::Switches;
1840 delete $ENV{HARNESS_PERL_SWITCHES} unless length $ENV{HARNESS_PERL_SWITCHES};
1842 local ($Test::Harness::verbose,
1843 $Test::Harness::Verbose,
1845 $ENV{HARNESS_VERBOSE}) = ($p->{verbose} || 0) x 4;
1847 # Make sure we test the module in blib/
1848 local @INC = (File::Spec->catdir($p->{base_dir}, $self->blib, 'lib'),
1849 File::Spec->catdir($p->{base_dir}, $self->blib, 'arch'),
1852 # Filter out nonsensical @INC entries - some versions of
1853 # Test::Harness will really explode the number of entries here
1854 @INC = grep {ref() || -d} @INC if @INC > 100;
1856 my $tests = $self->find_test_files;
1859 # Work around a Test::Harness bug that loses the particular perl
1860 # we're running under. $self->perl is trustworthy, but $^X isn't.
1861 local $^X = $self->perl;
1862 Test::Harness::runtests(@$tests);
1864 $self->log_info("No tests defined.\n");
1867 # This will get run and the user will see the output. It doesn't
1868 # emit Test::Harness-style output.
1869 if (-e 'visual.pl') {
1870 $self->run_perl_script('visual.pl', '-Mblib='.$self->blib);
1876 my $p = $self->{properties};
1878 return $p->{test_files} = (@_ == 1 ? shift : [@_]);
1880 return $self->find_test_files;
1883 sub expand_test_dir {
1884 my ($self, $dir) = @_;
1885 return sort @{$self->rscan_dir($dir, qr{^[^.].*\.t$})} if $self->recursive_test_files;
1886 return sort glob File::Spec->catfile($dir, "*.t");
1891 local $self->{properties}{debugger} = 1;
1892 $self->depends_on('test');
1895 sub ACTION_testcover {
1898 unless (Module::Build::ModuleInfo->find_module_by_name('Devel::Cover')) {
1899 warn("Cannot run testcover action unless Devel::Cover is installed.\n");
1903 $self->add_to_cleanup('coverage', 'cover_db');
1904 $self->depends_on('code');
1906 # See whether any of the *.pm files have changed since last time
1907 # testcover was run. If so, start over.
1908 if (-e 'cover_db') {
1909 my $pm_files = $self->rscan_dir(File::Spec->catdir($self->blib, 'lib'), qr{\.pm$} );
1910 my $cover_files = $self->rscan_dir('cover_db', sub {-f $_ and not /\.html$/});
1912 $self->do_system(qw(cover -delete))
1913 unless $self->up_to_date($pm_files, $cover_files);
1916 local $Test::Harness::switches =
1917 local $Test::Harness::Switches =
1918 local $ENV{HARNESS_PERL_SWITCHES} = "-MDevel::Cover";
1920 $self->depends_on('test');
1921 $self->do_system('cover');
1927 # All installable stuff gets created in blib/ .
1928 # Create blib/arch to keep blib.pm happy
1929 my $blib = $self->blib;
1930 $self->add_to_cleanup($blib);
1931 File::Path::mkpath( File::Spec->catdir($blib, 'arch') );
1933 if (my $split = $self->autosplit) {
1934 $self->autosplit_file($_, $blib) for ref($split) ? @$split : ($split);
1937 foreach my $element (@{$self->build_elements}) {
1938 my $method = "process_${element}_files";
1939 $method = "process_files_by_extension" unless $self->can($method);
1940 $self->$method($element);
1943 $self->depends_on('config_data');
1948 $self->depends_on('code');
1949 $self->depends_on('docs');
1952 sub process_files_by_extension {
1953 my ($self, $ext) = @_;
1955 my $method = "find_${ext}_files";
1956 my $files = $self->can($method) ? $self->$method() : $self->_find_file_by_type($ext, 'lib');
1958 while (my ($file, $dest) = each %$files) {
1959 $self->copy_if_modified(from => $file, to => File::Spec->catfile($self->blib, $dest) );
1963 sub process_support_files {
1965 my $p = $self->{properties};
1966 return unless $p->{c_source};
1968 push @{$p->{include_dirs}}, $p->{c_source};
1970 my $files = $self->rscan_dir($p->{c_source}, qr{\.c(pp)?$});
1971 foreach my $file (@$files) {
1972 push @{$p->{objects}}, $self->compile_c($file);
1976 sub process_PL_files {
1978 my $files = $self->find_PL_files;
1980 while (my ($file, $to) = each %$files) {
1981 unless ($self->up_to_date( $file, $to )) {
1982 $self->run_perl_script($file, [], [@$to]);
1983 $self->add_to_cleanup(@$to);
1988 sub process_xs_files {
1990 my $files = $self->find_xs_files;
1991 while (my ($from, $to) = each %$files) {
1992 unless ($from eq $to) {
1993 $self->add_to_cleanup($to);
1994 $self->copy_if_modified( from => $from, to => $to );
1996 $self->process_xs($to);
2000 sub process_pod_files { shift()->process_files_by_extension(shift()) }
2001 sub process_pm_files { shift()->process_files_by_extension(shift()) }
2003 sub process_script_files {
2005 my $files = $self->find_script_files;
2006 return unless keys %$files;
2008 my $script_dir = File::Spec->catdir($self->blib, 'script');
2009 File::Path::mkpath( $script_dir );
2011 foreach my $file (keys %$files) {
2012 my $result = $self->copy_if_modified($file, $script_dir, 'flatten') or next;
2013 $self->fix_shebang_line($result);
2014 $self->make_executable($result);
2020 if (my $files = $self->{properties}{PL_files}) {
2021 # 'PL_files' is given as a Unix file spec, so we localize_file_path().
2023 if (UNIVERSAL::isa($files, 'ARRAY')) {
2024 return { map {$_, [/^(.*)\.PL$/]}
2025 map $self->localize_file_path($_),
2028 } elsif (UNIVERSAL::isa($files, 'HASH')) {
2030 while (my ($file, $to) = each %$files) {
2031 $out{ $self->localize_file_path($file) } = [ map $self->localize_file_path($_),
2032 ref $to ? @$to : ($to) ];
2037 die "'PL_files' must be a hash reference or array reference";
2041 return unless -d 'lib';
2042 return { map {$_, [/^(.*)\.PL$/]} @{ $self->rscan_dir('lib', qr{\.PL$}) } };
2045 sub find_pm_files { shift->_find_file_by_type('pm', 'lib') }
2046 sub find_pod_files { shift->_find_file_by_type('pod', 'lib') }
2047 sub find_xs_files { shift->_find_file_by_type('xs', 'lib') }
2049 sub find_script_files {
2051 if (my $files = $self->script_files) {
2052 # Always given as a Unix file spec. Values in the hash are
2053 # meaningless, but we preserve if present.
2054 return { map {$self->localize_file_path($_), $files->{$_}} keys %$files };
2057 # No default location for script files
2061 sub find_test_files {
2063 my $p = $self->{properties};
2065 if (my $files = $p->{test_files}) {
2066 $files = [keys %$files] if UNIVERSAL::isa($files, 'HASH');
2067 $files = [map { -d $_ ? $self->expand_test_dir($_) : $_ }
2069 $self->split_like_shell($files)];
2071 # Always given as a Unix file spec.
2072 return [ map $self->localize_file_path($_), @$files ];
2075 # Find all possible tests in t/ or test.pl
2077 push @tests, 'test.pl' if -e 'test.pl';
2078 push @tests, $self->expand_test_dir('t') if -e 't' and -d _;
2083 sub _find_file_by_type {
2084 my ($self, $type, $dir) = @_;
2086 if (my $files = $self->{properties}{"${type}_files"}) {
2087 # Always given as a Unix file spec
2088 return { map $self->localize_file_path($_), %$files };
2091 return {} unless -d $dir;
2092 return { map {$_, $_}
2093 map $self->localize_file_path($_),
2095 @{ $self->rscan_dir($dir, qr{\.$type$}) } };
2098 sub localize_file_path {
2099 my ($self, $path) = @_;
2100 return File::Spec->catfile( split m{/}, $path );
2103 sub localize_dir_path {
2104 my ($self, $path) = @_;
2105 return File::Spec->catdir( split m{/}, $path );
2108 sub fix_shebang_line { # Adapted from fixin() in ExtUtils::MM_Unix 1.35
2109 my ($self, @files) = @_;
2110 my $c = $self->config;
2112 my ($does_shbang) = $c->{sharpbang} =~ /^\s*\#\!/;
2113 for my $file (@files) {
2114 my $FIXIN = IO::File->new($file) or die "Can't process '$file': $!";
2116 chomp(my $line = <$FIXIN>);
2117 next unless $line =~ s/^\s*\#!\s*//; # Not a shbang file.
2119 my ($cmd, $arg) = (split(' ', $line, 2), '');
2120 next unless $cmd =~ /perl/i;
2121 my $interpreter = $self->{properties}{perl};
2123 $self->log_verbose("Changing sharpbang in $file to $interpreter");
2125 $shb .= "$c->{sharpbang}$interpreter $arg\n" if $does_shbang;
2127 # I'm not smart enough to know the ramifications of changing the
2128 # embedded newlines here to \n, so I leave 'em in.
2130 eval 'exec $interpreter $arg -S \$0 \${1+"\$\@"}'
2131 if 0; # not running under some shell
2132 } unless $self->os_type eq 'Windows'; # this won't work on win32, so don't
2134 my $FIXOUT = IO::File->new(">$file.new")
2135 or die "Can't create new $file: $!\n";
2137 # Print out the new #! line (or equivalent).
2139 undef $/; # Was localized above
2140 print $FIXOUT $shb, <$FIXIN>;
2144 rename($file, "$file.bak")
2145 or die "Can't rename $file to $file.bak: $!";
2147 rename("$file.new", $file)
2148 or die "Can't rename $file.new to $file: $!";
2151 or $self->log_warn("Couldn't clean up $file.bak, leaving it there");
2153 $self->do_system($c->{eunicefix}, $file) if $c->{eunicefix} ne ':';
2158 sub ACTION_testpod {
2160 $self->depends_on('docs');
2162 eval q{use Test::Pod 0.95; 1}
2163 or die "The 'testpod' action requires Test::Pod version 0.95";
2165 my @files = sort keys %{$self->_find_pods($self->libdoc_dirs)},
2166 keys %{$self->_find_pods($self->bindoc_dirs, exclude => [ qr/\.bat$/ ])}
2167 or die "Couldn't find any POD files to test\n";
2169 { package Module::Build::PodTester; # Don't want to pollute the main namespace
2170 Test::Pod->import( tests => scalar @files );
2171 pod_file_ok($_) foreach @files;
2178 $self->depends_on('code');
2179 $self->depends_on('manpages', 'html');
2182 # Given a file type, will return true if the file type would normally
2183 # be installed when neither install-base nor prefix has been set.
2184 # I.e. it will be true only if the path is set from Config.pm or
2185 # set explicitly by the user via install-path.
2186 sub _is_default_installable {
2189 return ( $self->install_destination($type) &&
2190 ( $self->install_path($type) ||
2191 $self->install_sets($self->installdirs)->{$type} )
2195 sub ACTION_manpages {
2198 return unless $self->_mb_feature('manpage_support');
2200 $self->depends_on('code');
2202 foreach my $type ( qw(bin lib) ) {
2203 my $files = $self->_find_pods( $self->{properties}{"${type}doc_dirs"},
2204 exclude => [ qr/\.bat$/ ] );
2205 next unless %$files;
2207 my $sub = $self->can("manify_${type}_pods");
2208 next unless defined( $sub );
2210 if ( $self->invoked_action eq 'manpages' ) {
2212 } elsif ( $self->_is_default_installable("${type}doc") ) {
2219 sub manify_bin_pods {
2222 my $files = $self->_find_pods( $self->{properties}{bindoc_dirs},
2223 exclude => [ qr/\.bat$/ ] );
2224 return unless keys %$files;
2226 my $mandir = File::Spec->catdir( $self->blib, 'bindoc' );
2227 File::Path::mkpath( $mandir, 0, 0777 );
2230 foreach my $file (keys %$files) {
2231 # Pod::Simple based parsers only support one document per instance.
2232 # This is expected to change in a future version (Pod::Simple > 3.03).
2233 my $parser = Pod::Man->new( section => 1 ); # binaries go in section 1
2234 my $manpage = $self->man1page_name( $file ) . '.' .
2235 $self->config( 'man1ext' );
2236 my $outfile = File::Spec->catfile($mandir, $manpage);
2237 next if $self->up_to_date( $file, $outfile );
2238 $self->log_info("Manifying $file -> $outfile\n");
2239 $parser->parse_from_file( $file, $outfile );
2240 $files->{$file} = $outfile;
2244 sub manify_lib_pods {
2247 my $files = $self->_find_pods($self->{properties}{libdoc_dirs});
2248 return unless keys %$files;
2250 my $mandir = File::Spec->catdir( $self->blib, 'libdoc' );
2251 File::Path::mkpath( $mandir, 0, 0777 );
2254 while (my ($file, $relfile) = each %$files) {
2255 # Pod::Simple based parsers only support one document per instance.
2256 # This is expected to change in a future version (Pod::Simple > 3.03).
2257 my $parser = Pod::Man->new( section => 3 ); # libraries go in section 3
2258 my $manpage = $self->man3page_name( $relfile ) . '.' .
2259 $self->config( 'man3ext' );
2260 my $outfile = File::Spec->catfile( $mandir, $manpage);
2261 next if $self->up_to_date( $file, $outfile );
2262 $self->log_info("Manifying $file -> $outfile\n");
2263 $parser->parse_from_file( $file, $outfile );
2264 $files->{$file} = $outfile;
2269 my ($self, $dirs, %args) = @_;
2271 foreach my $spec (@$dirs) {
2272 my $dir = $self->localize_dir_path($spec);
2273 next unless -e $dir;
2274 FILE: foreach my $file ( @{ $self->rscan_dir( $dir ) } ) {
2275 foreach my $regexp ( @{ $args{exclude} } ) {
2276 next FILE if $file =~ $regexp;
2278 $files{$file} = File::Spec->abs2rel($file, $dir) if $self->contains_pod( $file )
2285 my ($self, $file) = @_;
2286 return '' unless -T $file; # Only look at text files
2288 my $fh = IO::File->new( $file ) or die "Can't open $file: $!";
2289 while (my $line = <$fh>) {
2290 return 1 if $line =~ /^\=(?:head|pod|item)/;
2299 return unless $self->_mb_feature('HTML_support');
2301 $self->depends_on('code');
2303 foreach my $type ( qw(bin lib) ) {
2304 my $files = $self->_find_pods( $self->{properties}{"${type}doc_dirs"},
2305 exclude => [ qr/\.(?:bat|com|html)$/ ] );
2306 next unless %$files;
2308 if ( $self->invoked_action eq 'html' ) {
2309 $self->htmlify_pods( $type );
2310 } elsif ( $self->_is_default_installable("${type}html") ) {
2311 $self->htmlify_pods( $type );
2318 # 1) If it's an ActiveState perl install, we need to run
2319 # ActivePerl::DocTools->UpdateTOC;
2320 # 2) Links to other modules are not being generated
2324 my $htmldir = shift || File::Spec->catdir($self->blib, "${type}html");
2326 require Module::Build::PodParser;
2329 $self->add_to_cleanup('pod2htm*');
2331 my $pods = $self->_find_pods( $self->{properties}{"${type}doc_dirs"},
2332 exclude => [ qr/\.(?:bat|com|html)$/ ] );
2333 next unless %$pods; # nothing to do
2335 unless ( -d $htmldir ) {
2336 File::Path::mkpath($htmldir, 0, 0755)
2337 or die "Couldn't mkdir $htmldir: $!";
2340 my @rootdirs = ($type eq 'bin') ? qw(bin) :
2341 $self->installdirs eq 'core' ? qw(lib) : qw(site lib);
2343 my $podpath = join ':',
2346 map [File::Spec->catdir($self->blib, $_), $_],
2349 foreach my $pod ( keys %$pods ) {
2351 my ($name, $path) = File::Basename::fileparse($pods->{$pod},
2352 qr{\.(?:pm|plx?|pod)$});
2353 my @dirs = File::Spec->splitdir( File::Spec->canonpath( $path ) );
2354 pop( @dirs ) if $dirs[-1] eq File::Spec->curdir;
2356 my $fulldir = File::Spec->catfile($htmldir, @rootdirs, @dirs);
2357 my $outfile = File::Spec->catfile($fulldir, "${name}.html");
2358 my $infile = File::Spec->abs2rel($pod);
2360 next if $self->up_to_date($infile, $outfile);
2362 unless ( -d $fulldir ){
2363 File::Path::mkpath($fulldir, 0, 0755)
2364 or die "Couldn't mkdir $fulldir: $!";
2367 my $path2root = join( '/', ('..') x (@rootdirs+@dirs) );
2368 my $htmlroot = join( '/',
2370 $self->installdirs eq 'core' ? () : qw(site) ) );
2372 my $fh = IO::File->new($infile);
2373 my $abstract = Module::Build::PodParser->new(fh => $fh)->get_abstract();
2375 my $title = join( '::', (@dirs, $name) );
2376 $title .= " - $abstract" if $abstract;
2381 "--podpath=$podpath",
2383 "--outfile=$outfile",
2384 '--podroot=' . $self->blib,
2385 "--htmlroot=$htmlroot",
2388 if ( eval{Pod::Html->VERSION(1.03)} ) {
2389 push( @opts, ('--header', '--backlink=Back to Top') );
2390 push( @opts, "--css=$path2root/" . $self->html_css) if $self->html_css;
2393 $self->log_info("HTMLifying $infile -> $outfile\n");
2394 $self->log_verbose("pod2html @opts\n");
2395 Pod::Html::pod2html(@opts); # or warn "pod2html @opts failed: $!";
2400 # Adapted from ExtUtils::MM_Unix
2403 return File::Basename::basename( shift );
2406 # Adapted from ExtUtils::MM_Unix and Pod::Man
2407 # Depending on M::B's dependency policy, it might make more sense to refactor
2408 # Pod::Man::begin_pod() to extract a name() methods, and use them...
2412 my ($vol, $dirs, $file) = File::Spec->splitpath( shift );
2413 my @dirs = File::Spec->splitdir( File::Spec->canonpath($dirs) );
2415 # Remove known exts from the base name
2416 $file =~ s/\.p(?:od|m|l)\z//i;
2418 return join( $self->manpage_separator, @dirs, $file );
2421 sub manpage_separator {
2425 # For systems that don't have 'diff' executable, should use Algorithm::Diff
2428 $self->depends_on('build');
2429 my $local_lib = File::Spec->rel2abs('lib');
2430 my @myINC = grep {$_ ne $local_lib} @INC;
2432 # The actual install destination might not be in @INC, so check there too.
2433 push @myINC, map $self->install_destination($_), qw(lib arch);
2435 my @flags = @{$self->{args}{ARGV}};
2436 @flags = $self->split_like_shell($self->{args}{flags} || '') unless @flags;
2438 my $installmap = $self->install_map;
2439 delete $installmap->{read};
2440 delete $installmap->{write};
2442 my $text_suffix = qr{\.(pm|pod)$};
2444 while (my $localdir = each %$installmap) {
2445 my @localparts = File::Spec->splitdir($localdir);
2446 my $files = $self->rscan_dir($localdir, sub {-f});
2448 foreach my $file (@$files) {
2449 my @parts = File::Spec->splitdir($file);
2450 @parts = @parts[@localparts .. $#parts]; # Get rid of blib/lib or similar
2452 my $installed = Module::Build::ModuleInfo->find_module_by_name(
2453 join('::', @parts), \@myINC );
2454 if (not $installed) {
2455 print "Only in lib: $file\n";
2459 my $status = File::Compare::compare($installed, $file);
2460 next if $status == 0; # Files are the same
2461 die "Can't compare $installed and $file: $!" if $status == -1;
2463 if ($file =~ $text_suffix) {
2464 $self->do_system('diff', @flags, $installed, $file);
2466 print "Binary files $file and $installed differ\n";
2472 sub ACTION_pure_install {
2473 shift()->depends_on('install');
2476 sub ACTION_install {
2478 require ExtUtils::Install;
2479 $self->depends_on('build');
2480 ExtUtils::Install::install($self->install_map, !$self->quiet, 0, $self->{args}{uninst}||0);
2483 sub ACTION_fakeinstall {
2485 require ExtUtils::Install;
2486 $self->depends_on('build');
2487 ExtUtils::Install::install($self->install_map, !$self->quiet, 1, $self->{args}{uninst}||0);
2490 sub ACTION_versioninstall {
2493 die "You must have only.pm 0.25 or greater installed for this operation: $@\n"
2494 unless eval { require only; 'only'->VERSION(0.25); 1 };
2496 $self->depends_on('build');
2498 my %onlyargs = map {exists($self->{args}{$_}) ? ($_ => $self->{args}{$_}) : ()}
2499 qw(version versionlib);
2500 only::install::install(%onlyargs);
2505 foreach my $item (map glob($_), $self->cleanup) {
2506 $self->delete_filetree($item);
2510 sub ACTION_realclean {
2512 $self->depends_on('clean');
2513 $self->delete_filetree($self->config_dir, $self->build_script);
2518 require Module::Build::PPMMaker;
2519 my $ppd = Module::Build::PPMMaker->new();
2520 my $file = $ppd->make_ppd(%{$self->{args}}, build => $self);
2521 $self->add_to_cleanup($file);
2524 sub ACTION_ppmdist {
2527 $self->depends_on( 'build' );
2529 my $ppm = $self->ppm_name;
2530 $self->delete_filetree( $ppm );
2531 $self->log_info( "Creating $ppm\n" );
2532 $self->add_to_cleanup( $ppm, "$ppm.tar.gz" );
2534 my %types = ( # translate types/dirs to those expected by ppm
2545 foreach my $type ($self->install_types) {
2546 next if exists( $types{$type} ) && !defined( $types{$type} );
2548 my $dir = File::Spec->catdir( $self->blib, $type );
2549 next unless -e $dir;
2551 my $files = $self->rscan_dir( $dir );
2552 foreach my $file ( @$files ) {
2553 next unless -f $file;
2555 File::Spec->abs2rel( File::Spec->rel2abs( $file ),
2556 File::Spec->rel2abs( $dir ) );
2558 File::Spec->catdir( $ppm, 'blib',
2559 exists( $types{$type} ) ? $types{$type} : $type,
2561 $self->copy_if_modified( from => $file, to => $to_file );
2565 foreach my $type ( qw(bin lib) ) {
2566 local $self->{properties}{html_css} = 'Active.css';
2567 $self->htmlify_pods( $type, File::Spec->catdir($ppm, 'blib', 'html') );
2571 # the directory tar'ed must be blib so we need to do a chdir first
2572 my $start_wd = $self->cwd;
2573 chdir( $ppm ) or die "Can't chdir to $ppm";
2574 $self->make_tarball( 'blib', File::Spec->catfile( $start_wd, $ppm ) );
2575 chdir( $start_wd ) or die "Can't chdir to $start_wd";
2577 $self->depends_on( 'ppd' );
2579 $self->delete_filetree( $ppm );
2585 $self->depends_on('distdir');
2587 my $dist_dir = $self->dist_dir;
2589 $self->make_tarball($dist_dir);
2590 $self->delete_filetree($dist_dir);
2593 sub ACTION_distcheck {
2596 require ExtUtils::Manifest;
2597 local $^W; # ExtUtils::Manifest is not warnings clean.
2598 my ($missing, $extra) = ExtUtils::Manifest::fullcheck();
2599 die "MANIFEST appears to be out of sync with the distribution\n"
2600 if @$missing || @$extra;
2603 sub _add_to_manifest {
2604 my ($self, $manifest, $lines) = @_;
2605 $lines = [$lines] unless ref $lines;
2607 my $existing_files = $self->_read_manifest($manifest);
2608 return unless defined( $existing_files );
2610 @$lines = grep {!exists $existing_files->{$_}} @$lines
2613 my $mode = (stat $manifest)[2];
2614 chmod($mode | 0222, $manifest) or die "Can't make $manifest writable: $!";
2616 my $fh = IO::File->new("< $manifest") or die "Can't read $manifest: $!";
2617 my $last_line = (<$fh>)[-1] || "\n";
2618 my $has_newline = $last_line =~ /\n$/;
2621 $fh = IO::File->new(">> $manifest") or die "Can't write to $manifest: $!";
2622 print $fh "\n" unless $has_newline;
2623 print $fh map "$_\n", @$lines;
2625 chmod($mode, $manifest);
2627 $self->log_info(map "Added to $manifest: $_\n", @$lines);
2631 my ($self, $dir) = @_;
2633 unless (eval { require Module::Signature; 1 }) {
2634 $self->log_warn("Couldn't load Module::Signature for 'distsign' action:\n $@\n");
2638 # Add SIGNATURE to the MANIFEST
2640 my $manifest = File::Spec->catfile($dir, 'MANIFEST');
2641 die "Signing a distribution requires a MANIFEST file" unless -e $manifest;
2642 $self->_add_to_manifest($manifest, "SIGNATURE Added here by Module::Build");
2645 # We protect the signing with an eval{} to make sure we get back to
2646 # the right directory after a signature failure. Would be nice if
2647 # Module::Signature took a directory argument.
2649 my $start_dir = $self->cwd;
2650 chdir $dir or die "Can't chdir() to $dir: $!";
2651 eval {local $Module::Signature::Quiet = 1; Module::Signature::sign()};
2652 my @err = $@ ? ($@) : ();
2653 chdir $start_dir or push @err, "Can't chdir() back to $start_dir: $!";
2654 die join "\n", @err if @err;
2657 sub ACTION_distsign {
2660 local $self->{properties}{sign} = 0; # We'll sign it ourselves
2661 $self->depends_on('distdir') unless -d $self->dist_dir;
2663 $self->_sign_dir($self->dist_dir);
2666 sub ACTION_skipcheck {
2669 require ExtUtils::Manifest;
2670 local $^W; # ExtUtils::Manifest is not warnings clean.
2671 ExtUtils::Manifest::skipcheck();
2674 sub ACTION_distclean {
2677 $self->depends_on('realclean');
2678 $self->depends_on('distcheck');
2681 sub do_create_makefile_pl {
2683 require Module::Build::Compat;
2684 $self->delete_filetree('Makefile.PL');
2685 $self->log_info("Creating Makefile.PL\n");
2686 Module::Build::Compat->create_makefile_pl($self->create_makefile_pl, $self, @_);
2687 $self->_add_to_manifest('MANIFEST', 'Makefile.PL');
2690 sub do_create_readme {
2692 $self->delete_filetree('README');
2694 my $docfile = $self->_main_docfile;
2695 unless ( $docfile ) {
2696 $self->log_warn(<<EOF);
2697 Cannot create README: can't determine which file contains documentation;
2698 Must supply either 'dist_version_from', or 'module_name' parameter.
2703 if ( eval {require Pod::Readme; 1} ) {
2704 $self->log_info("Creating README using Pod::Readme\n");
2706 my $parser = Pod::Readme->new;
2707 $parser->parse_from_file($docfile, 'README', @_);
2709 } elsif ( eval {require Pod::Text; 1} ) {
2710 $self->log_info("Creating README using Pod::Text\n");
2712 my $fh = IO::File->new('> README');
2713 if ( defined($fh) ) {
2717 # work around bug in Pod::Text 3.01, which expects
2718 # Pod::Simple::parse_file to take input and output filehandles
2719 # when it actually only takes an input filehandle
2722 $old_parse_file = \&{"Pod::Simple::parse_file"}
2724 local *{"Pod::Simple::parse_file"} = sub {
2726 $self->output_fh($_[1]) if $_[1];
2727 $self->$old_parse_file($_[0]);
2729 if $Pod::Text::VERSION
2730 == 3.01; # Split line to avoid evil version-finder
2732 Pod::Text::pod2text( $docfile, $fh );
2737 "Cannot create 'README' file: Can't open file for writing\n" );
2742 $self->log_warn("Can't load Pod::Readme or Pod::Text to create README\n");
2746 $self->_add_to_manifest('MANIFEST', 'README');
2751 $self->_find_dist_version_from;
2752 if ( my $pm_file = $self->dist_version_from ) {
2753 (my $pod_file = $pm_file) =~ s/.pm$/.pod/;
2754 return (-e $pod_file ? $pod_file : $pm_file);
2760 sub ACTION_distdir {
2763 $self->depends_on('distmeta');
2765 my $dist_files = $self->_read_manifest('MANIFEST')
2766 or die "Can't create distdir without a MANIFEST file - run 'manifest' action first";
2767 delete $dist_files->{SIGNATURE}; # Don't copy, create a fresh one
2768 die "No files found in MANIFEST - try running 'manifest' action?\n"
2769 unless ($dist_files and keys %$dist_files);
2770 my $metafile = $self->metafile;
2771 $self->log_warn("*** Did you forget to add $metafile to the MANIFEST?\n")
2772 unless exists $dist_files->{$metafile};
2774 my $dist_dir = $self->dist_dir;
2775 $self->delete_filetree($dist_dir);
2776 $self->log_info("Creating $dist_dir\n");
2777 $self->add_to_cleanup($dist_dir);
2779 foreach my $file (keys %$dist_files) {
2780 my $new = $self->copy_if_modified(from => $file, to_dir => $dist_dir, verbose => 0);
2781 chmod +(stat $file)[2], $new
2782 or $self->log_warn("Couldn't set permissions on $new: $!");
2785 $self->_sign_dir($dist_dir) if $self->{properties}{sign};
2788 sub ACTION_disttest {
2791 $self->depends_on('distdir');
2793 my $start_dir = $self->cwd;
2794 my $dist_dir = $self->dist_dir;
2795 chdir $dist_dir or die "Cannot chdir to $dist_dir: $!";
2796 # XXX could be different names for scripts
2798 $self->run_perl_script('Build.PL') # XXX Should this be run w/ --nouse-rcfile
2799 or die "Error executing 'Build.PL' in dist directory: $!";
2800 $self->run_perl_script('Build')
2801 or die "Error executing 'Build' in dist directory: $!";
2802 $self->run_perl_script('Build', [], ['test'])
2803 or die "Error executing 'Build test' in dist directory";
2807 sub _write_default_maniskip {
2809 my $file = shift || 'MANIFEST.SKIP';
2810 my $fh = IO::File->new("> $file")
2811 or die "Can't open $file: $!";
2813 # This is derived from MakeMaker's default MANIFEST.SKIP file with
2817 # Avoid version control files.
2824 # Avoid Makemaker generated and utility files.
2832 # Avoid Module::Build generated and utility files.
2836 # Avoid Devel::Cover generated files
2839 # Avoid temp and backup files.
2848 # Avoid OS-specific files/dirs
2851 # Mac OSX SMB mount metadata files
2853 # Avoid archives of this distribution
2856 # Skip, for example, 'Module-Build-0.27.tar.gz'
2857 print $fh '\b'.$self->dist_name.'-[\d\.\_]+'."\n";
2862 sub ACTION_manifest {
2865 my $maniskip = 'MANIFEST.SKIP';
2866 unless ( -e 'MANIFEST' || -e $maniskip ) {
2867 $self->log_warn("File '$maniskip' does not exist: Creating a default '$maniskip'\n");
2868 $self->_write_default_maniskip($maniskip);
2871 require ExtUtils::Manifest; # ExtUtils::Manifest is not warnings clean.
2872 local ($^W, $ExtUtils::Manifest::Quiet) = (0,1);
2873 ExtUtils::Manifest::mkmanifest();
2878 return "$self->{properties}{dist_name}-$self->{properties}{dist_version}";
2883 return 'PPM-' . $self->dist_dir;
2887 my ($self, $dir) = @_;
2888 return unless -d $dir;
2891 opendir DH, $dir or die "Can't read directory $dir: $!";
2894 while (defined (my $file = readdir DH)) {
2895 my $full_path = File::Spec->catfile($dir, $file);
2896 next if -d $full_path;
2897 push @files, $full_path;
2905 for ($self->{properties}{script_files}) {
2909 # Always coerce into a hash
2910 return $_ if UNIVERSAL::isa($_, 'HASH');
2911 return $_ = { map {$_,1} @$_ } if UNIVERSAL::isa($_, 'ARRAY');
2913 die "'script_files' must be a hashref, arrayref, or string" if ref();
2915 return $_ = { map {$_,1} $self->_files_in( $_ ) } if -d $_;
2916 return $_ = {$_ => 1};
2919 return $_ = { map {$_,1} $self->_files_in( File::Spec->catdir( $self->base_dir, 'bin' ) ) };
2921 BEGIN { *scripts = \&script_files; }
2926 perl => 'http://dev.perl.org/licenses/',
2927 gpl => 'http://www.opensource.org/licenses/gpl-license.php',
2928 apache => 'http://apache.org/licenses/LICENSE-2.0',
2929 artistic => 'http://opensource.org/licenses/artistic-license.php',
2930 lgpl => 'http://opensource.org/licenses/artistic-license.php',
2931 bsd => 'http://www.opensource.org/licenses/bsd-license.php',
2932 gpl => 'http://www.opensource.org/licenses/gpl-license.php',
2933 mit => 'http://opensource.org/licenses/mit-license.php',
2934 mozilla => 'http://opensource.org/licenses/mozilla1.1.php',
2935 open_source => undef,
2936 unrestricted => undef,
2937 restrictive => undef,
2940 sub valid_licenses {
2946 my ($self, $h, $k, $v) = @_;
2947 if (ref $h->{$k} eq 'ARRAY') {
2948 push @{$h->{$k}}, ref $v ? @$v : $v;
2949 } elsif (ref $h->{$k} eq 'HASH') {
2950 $h->{$k}{$_} = $v->{$_} foreach keys %$v;
2956 sub _yaml_quote_string {
2957 # XXX doesn't handle embedded newlines
2959 my ($self, $string) = @_;
2960 if ($string !~ /\"/) {
2961 $string =~ s{\\}{\\\\}g;
2962 return qq{"$string"};
2964 $string =~ s{([\\'])}{\\$1}g;
2965 return qq{'$string'};
2969 sub _write_minimal_metadata {
2971 my $p = $self->{properties};
2973 my $file = $self->metafile;
2974 my $fh = IO::File->new("> $file")
2975 or die "Can't open $file: $!";
2977 my @author = map $self->_yaml_quote_string($_), @{$self->dist_author};
2978 my $abstract = $self->_yaml_quote_string($self->dist_abstract);
2980 # XXX Add the meta_add & meta_merge stuff
2984 name: $p->{dist_name}
2985 version: $p->{dist_version}
2987 @{[ join "\n", map " - $_", @author ]}
2989 license: $p->{license}
2990 generated_by: Module::Build version $Module::Build::VERSION, without YAML.pm
2994 sub ACTION_distmeta {
2997 $self->do_create_makefile_pl if $self->create_makefile_pl;
2998 $self->do_create_readme if $self->create_readme;
2999 $self->do_create_metafile;
3002 sub do_create_metafile {
3004 return if $self->{wrote_metadata};
3006 my $p = $self->{properties};
3007 my $metafile = $self->metafile;
3009 unless ($p->{license}) {
3010 $self->log_warn("No license specified, setting license = 'unknown'\n");
3011 $p->{license} = 'unknown';
3013 unless (exists $self->valid_licenses->{ $p->{license} }) {
3014 die "Unknown license type '$p->{license}'";
3017 # If we're in the distdir, the metafile may exist and be non-writable.
3018 $self->delete_filetree($metafile);
3019 $self->log_info("Creating $metafile\n");
3021 # Since we're building ourself, we have to do some special stuff
3022 # here: the ConfigData module is found in blib/lib.
3024 if (($self->module_name || '') eq 'Module::Build') {
3025 $self->depends_on('config_data');
3026 push @INC, File::Spec->catdir($self->blib, 'lib');
3029 $self->write_metafile;
3032 sub write_metafile {
3034 my $metafile = $self->metafile;
3036 if ($self->_mb_feature('YAML_support')) {
3040 # We use YAML::Node to get the order nice in the YAML file.
3041 $self->prepare_metadata( my $node = YAML::Node->new({}) );
3043 # YAML API changed after version 0.30
3044 my $yaml_sub = $YAML::VERSION le '0.30' ? \&YAML::StoreFile : \&YAML::DumpFile;
3045 $self->{wrote_metadata} = $yaml_sub->($metafile, $node );
3048 $self->log_warn(<<EOF);
3050 Couldn't load YAML.pm, generating a minimal META.yml without it.
3051 Please check and edit the generated metadata, or consider installing YAML.pm.
3055 $self->_write_minimal_metadata;
3058 $self->_add_to_manifest('MANIFEST', $metafile);
3061 sub prepare_metadata {
3062 my ($self, $node) = @_;
3063 my $p = $self->{properties};
3065 foreach (qw(dist_name dist_version dist_author dist_abstract license)) {
3066 (my $name = $_) =~ s/^dist_//;
3067 $node->{$name} = $self->$_();
3068 die "ERROR: Missing required field '$name' for META.yml\n"
3069 unless defined($node->{$name}) && length($node->{$name});
3072 if (defined( $self->license ) &&
3073 defined( my $url = $self->valid_licenses->{ $self->license } )) {
3074 $node->{resources}{license} = $url;
3077 foreach ( @{$self->prereq_action_types} ) {
3078 $node->{$_} = $p->{$_} if exists $p->{$_} and keys %{ $p->{$_} };
3081 $node->{dynamic_config} = $p->{dynamic_config} if exists $p->{dynamic_config};
3082 my $pkgs = eval { $self->find_dist_packages };
3084 $self->log_warn("WARNING: Possible missing or corrupt 'MANIFEST' file.\n" .
3085 "Nothing to enter for 'provides' field in META.yml\n");
3087 $node->{provides} = $pkgs if %$pkgs;
3090 $node->{no_index} = $p->{no_index} if exists $p->{no_index};
3092 $node->{generated_by} = "Module::Build version $Module::Build::VERSION";
3094 $node->{'meta-spec'} = {
3096 url => 'http://module-build.sourceforge.net/META-spec-v1.2.html',
3100 while (my($k, $v) = each %{$self->meta_add}) {
3104 while (my($k, $v) = each %{$self->meta_merge}) {
3105 $self->_hash_merge($node, $k, $v);
3111 sub _read_manifest {
3112 my ($self, $file) = @_;
3113 return undef unless -e $file;
3115 require ExtUtils::Manifest; # ExtUtils::Manifest is not warnings clean.
3116 local ($^W, $ExtUtils::Manifest::Quiet) = (0,1);
3117 return scalar ExtUtils::Manifest::maniread($file);
3120 sub find_dist_packages {
3123 # Only packages in .pm files are candidates for inclusion here.
3124 # Only include things in the MANIFEST, not things in developer's
3127 my $manifest = $self->_read_manifest('MANIFEST')
3128 or die "Can't find dist packages without a MANIFEST file - run 'manifest' action first";
3131 my %dist_files = map { $self->localize_file_path($_) => $_ }
3134 my @pm_files = grep {exists $dist_files{$_}} keys %{ $self->find_pm_files };
3136 # First, we enumerate all packages & versions,
3137 # seperating into primary & alternative candidates
3139 foreach my $file (@pm_files) {
3140 next if $dist_files{$file} =~ m{^t/}; # Skip things in t/
3142 my @path = split( /\//, $dist_files{$file} );
3143 (my $prime_package = join( '::', @path[1..$#path] )) =~ s/\.pm$//;
3145 my $pm_info = Module::Build::ModuleInfo->new_from_file( $file );
3147 foreach my $package ( $pm_info->packages_inside ) {
3148 next if $package eq 'main'; # main can appear numerous times, ignore
3149 next if grep /^_/, split( /::/, $package ); # private package, ignore
3151 my $version = $pm_info->version( $package );
3153 if ( $package eq $prime_package ) {
3154 if ( exists( $prime{$package} ) ) {
3155 # M::B::ModuleInfo will handle this conflict
3156 die "Unexpected conflict in '$package'; multiple versions found.\n";
3158 $prime{$package}{file} = $dist_files{$file};
3159 $prime{$package}{version} = $version if defined( $version );
3162 push( @{$alt{$package}}, {
3163 file => $dist_files{$file},
3164 version => $version,
3170 # Then we iterate over all the packages found above, identifying conflicts
3171 # and selecting the "best" candidate for recording the file & version
3173 foreach my $package ( keys( %alt ) ) {
3174 my $result = $self->_resolve_module_versions( $alt{$package} );
3176 if ( exists( $prime{$package} ) ) { # primary package selected
3178 if ( $result->{err} ) {
3179 # Use the selected primary package, but there are conflicting
3180 # errors amoung multiple alternative packages that need to be
3183 "Found conflicting versions for package '$package'\n" .
3184 " $prime{$package}{file} ($prime{$package}{version})\n" .
3188 } elsif ( defined( $result->{version} ) ) {
3189 # There is a primary package selected, and exactly one
3190 # alternative package
3192 if ( exists( $prime{$package}{version} ) &&
3193 defined( $prime{$package}{version} ) ) {
3194 # Unless the version of the primary package agrees with the
3195 # version of the alternative package, report a conflict
3196 if ( $self->compare_versions( $prime{$package}{version}, '!=',
3197 $result->{version} ) ) {
3199 "Found conflicting versions for package '$package'\n" .
3200 " $prime{$package}{file} ($prime{$package}{version})\n" .
3201 " $result->{file} ($result->{version})\n"
3206 # The prime package selected has no version so, we choose to
3207 # use any alternative package that does have a version
3208 $prime{$package}{file} = $result->{file};
3209 $prime{$package}{version} = $result->{version};
3213 # no alt package found with a version, but we have a prime
3214 # package so we use it whether it has a version or not
3217 } else { # No primary package was selected, use the best alternative
3219 if ( $result->{err} ) {
3221 "Found conflicting versions for package '$package'\n" .
3226 # Despite possible conflicting versions, we choose to record
3227 # something rather than nothing
3228 $prime{$package}{file} = $result->{file};
3229 $prime{$package}{version} = $result->{version}
3230 if defined( $result->{version} );
3237 # seperate out some of the conflict resolution logic from
3238 # $self->find_dist_packages(), above, into a helper function.
3240 sub _resolve_module_versions {
3243 my $packages = shift;
3245 my( $file, $version );
3247 foreach my $p ( @$packages ) {
3248 if ( defined( $p->{version} ) ) {
3249 if ( defined( $version ) ) {
3250 if ( $self->compare_versions( $version, '!=', $p->{version} ) ) {
3251 $err .= " $p->{file} ($p->{version})\n";
3253 # same version declared multiple times, ignore
3257 $version = $p->{version};
3260 $file ||= $p->{file} if defined( $p->{file} );
3264 $err = " $file ($version)\n" . $err;
3269 version => $version,
3277 my ($self, $dir, $file) = @_;
3280 $self->log_info("Creating $file.tar.gz\n");
3282 if ($self->{args}{tar}) {
3283 my $tar_flags = $self->verbose ? 'cvf' : 'cf';
3284 $self->do_system($self->split_like_shell($self->{args}{tar}), $tar_flags, "$file.tar", $dir);
3285 $self->do_system($self->split_like_shell($self->{args}{gzip}), "$file.tar") if $self->{args}{gzip};
3287 require Archive::Tar;
3288 # Archive::Tar versions >= 1.09 use the following to enable a compatibility
3289 # hack so that the resulting archive is compatible with older clients.
3290 $Archive::Tar::DO_NOT_USE_PREFIX = 0;
3291 my $files = $self->rscan_dir($dir);
3292 Archive::Tar->create_archive("$file.tar.gz", 1, @$files);
3296 sub install_base_relpaths {
3297 # Usage: install_base_relpaths('lib') or install_base_relpaths();
3299 my $map = $self->{properties}{install_base_relpaths};
3300 return $map unless @_;
3303 return unless exists $map->{$type};
3304 return File::Spec->catdir(@{$map->{$type}});
3308 # Translated from ExtUtils::MM_Any::init_INSTALL_from_PREFIX
3309 sub prefix_relative {
3310 my ($self, $type) = @_;
3311 my $installdirs = $self->installdirs;
3313 my $relpath = $self->install_sets($installdirs)->{$type};
3315 return $self->_prefixify($relpath,
3316 $self->original_prefix($installdirs),
3322 # Defaults to use in case the config install paths cannot be prefixified.
3323 sub prefix_relpaths {
3324 # Usage: prefix_relpaths('site', 'lib') or prefix_relpaths('site');
3326 my $installdirs = shift || $self->installdirs;
3327 my $map = $self->{properties}{prefix_relpaths}{$installdirs};
3328 return $map unless @_;
3331 return unless exists $map->{$type};
3332 return File::Spec->catdir(@{$map->{$type}});
3336 # Translated from ExtUtils::MM_Unix::prefixify()
3338 my($self, $path, $sprefix, $type) = @_;
3340 my $rprefix = $self->prefix;
3341 $rprefix .= '/' if $sprefix =~ m|/$|;
3343 $self->log_verbose(" prefixify $path from $sprefix to $rprefix\n")
3344 if defined( $path ) && length( $path );
3346 if( !defined( $path ) || ( length( $path ) == 0 ) ) {
3347 $self->log_verbose(" no path to prefixify, falling back to default.\n");
3348 return $self->_prefixify_default( $type, $rprefix );
3349 } elsif( !File::Spec->file_name_is_absolute($path) ) {
3350 $self->log_verbose(" path is relative, not prefixifying.\n");
3351 } elsif( $sprefix eq $rprefix ) {
3352 $self->log_verbose(" no new prefix.\n");
3353 } elsif( $path !~ s{^\Q$sprefix\E\b}{}s ) {
3354 $self->log_verbose(" cannot prefixify, falling back to default.\n");
3355 return $self->_prefixify_default( $type, $rprefix );
3358 $self->log_verbose(" now $path in $rprefix\n");
3363 sub _prefixify_default {
3366 my $rprefix = shift;
3368 my $default = $self->prefix_relpaths($self->installdirs, $type);
3370 $self->log_verbose(" no default install location for type '$type', using prefix '$rprefix'.\n");
3377 sub install_destination {
3378 my ($self, $type) = @_;
3380 return $self->install_path($type) if $self->install_path($type);
3382 if ( $self->install_base ) {
3383 my $relpath = $self->install_base_relpaths($type);
3384 return $relpath ? File::Spec->catdir($self->install_base, $relpath) : undef;
3387 if ( $self->prefix ) {
3388 my $relpath = $self->prefix_relative($type);
3389 return $relpath ? File::Spec->catdir($self->prefix, $relpath) : undef;
3392 return $self->install_sets($self->installdirs)->{$type};
3397 my %types = (%{$self->install_path}, %{ $self->install_sets($self->installdirs) });
3398 return sort keys %types;
3402 my ($self, $blib) = @_;
3403 $blib ||= $self->blib;
3405 my( %map, @skipping );
3406 foreach my $type ($self->install_types) {
3407 my $localdir = File::Spec->catdir( $blib, $type );
3408 next unless -e $localdir;
3410 if (my $dest = $self->install_destination($type)) {
3411 $map{$localdir} = $dest;
3413 push( @skipping, $type );
3418 "WARNING: Can't figure out install path for types: @skipping\n" .
3419 "Files will not be installed.\n"
3422 # Write the packlist into the same place as ExtUtils::MakeMaker.
3423 my $archdir = $self->install_destination('arch');
3424 my @ext = split /::/, $self->module_name;
3425 $map{write} = File::Spec->catdir($archdir, 'auto', @ext, '.packlist');
3428 if (length(my $destdir = $self->destdir || '')) {
3429 foreach (keys %map) {
3430 # Need to remove volume from $map{$_} using splitpath, or else
3431 # we'll create something crazy like C:\Foo\Bar\E:\Baz\Quux
3432 my ($volume, $path) = File::Spec->splitpath( $map{$_}, 1 );
3433 $map{$_} = File::Spec->catdir($destdir, $path);
3437 $map{read} = ''; # To keep ExtUtils::Install quiet
3444 foreach my $action (@_) {
3445 $self->_call_action($action);
3450 my ($self, $dir, $pattern) = @_;
3452 local $_; # find() can overwrite $_, so protect ourselves
3453 my $subr = !$pattern ? sub {push @result, $File::Find::name} :
3454 !ref($pattern) || (ref $pattern eq 'Regexp') ? sub {push @result, $File::Find::name if /$pattern/} :
3455 ref($pattern) eq 'CODE' ? sub {push @result, $File::Find::name if $pattern->()} :
3456 die "Unknown pattern type";
3458 File::Find::find({wanted => $subr, no_chdir => 1}, $dir);
3462 sub delete_filetree {
3467 $self->log_info("Deleting $_\n");
3468 File::Path::rmtree($_, 0, 0);
3469 die "Couldn't remove '$_': $!\n" if -e $_;
3475 sub autosplit_file {
3476 my ($self, $file, $to) = @_;
3478 my $dir = File::Spec->catdir($to, 'lib', 'auto');
3479 AutoSplit::autosplit($file, $dir);
3483 # Returns a CBuilder object
3486 my $p = $self->{properties};
3487 return $p->{_cbuilder} if $p->{_cbuilder};
3488 return unless $self->_mb_feature('C_support');
3490 require ExtUtils::CBuilder;
3491 return $p->{_cbuilder} = ExtUtils::CBuilder->new(config => $self->config);
3494 sub have_c_compiler {
3497 my $p = $self->{properties};
3498 return $p->{have_compiler} if defined $p->{have_compiler};
3500 $self->log_verbose("Checking if compiler tools configured... ");
3501 my $b = $self->_cbuilder;
3502 my $have = $b && $b->have_compiler;
3503 $self->log_verbose($have ? "ok.\n" : "failed.\n");
3504 return $p->{have_compiler} = $have;
3508 my ($self, $file, %args) = @_;
3509 my $b = $self->_cbuilder
3510 or die "Module::Build is not configured with C_support";
3512 my $obj_file = $b->object_file($file);
3513 $self->add_to_cleanup($obj_file);
3514 return $obj_file if $self->up_to_date($file, $obj_file);
3516 $b->compile(source => $file,
3517 defines => $args{defines},
3518 object_file => $obj_file,
3519 include_dirs => $self->include_dirs,
3520 extra_compiler_flags => $self->extra_compiler_flags,
3527 my ($self, $to, $file_base) = @_;
3528 my $p = $self->{properties}; # For convenience
3530 my $spec = $self->_infer_xs_spec($file_base);
3532 $self->add_to_cleanup($spec->{lib_file});
3534 my $objects = $p->{objects} || [];
3536 return $spec->{lib_file}
3537 if $self->up_to_date([$spec->{obj_file}, @$objects],
3540 my $module_name = $self->module_name;
3541 $module_name ||= $spec->{module_name};
3543 my $b = $self->_cbuilder
3544 or die "Module::Build is not configured with C_support";
3546 module_name => $module_name,
3547 objects => [$spec->{obj_file}, @$objects],
3548 lib_file => $spec->{lib_file},
3549 extra_linker_flags => $p->{extra_linker_flags} );
3551 return $spec->{lib_file};
3555 my ($self, $file, %args) = @_;
3557 $self->log_info("$file -> $args{outfile}\n");
3559 if (eval {require ExtUtils::ParseXS; 1}) {
3561 ExtUtils::ParseXS::process_file(
3564 output => $args{outfile},
3567 # Ok, I give up. Just use backticks.
3569 my $xsubpp = Module::Build::ModuleInfo->find_module_by_name('ExtUtils::xsubpp')
3570 or die "Can't find ExtUtils::xsubpp in INC (@INC)";
3573 push @typemaps, Module::Build::ModuleInfo->find_module_by_name('ExtUtils::typemap', \@INC);
3574 my $lib_typemap = Module::Build::ModuleInfo->find_module_by_name('typemap', ['lib']);
3575 if (defined $lib_typemap and -e $lib_typemap) {
3576 push @typemaps, 'typemap';
3578 my $typemaps = join ' ', map qq{-typemap "$_"}, @typemaps;
3580 my $cf = $self->config;
3581 my $perl = $self->{properties}{perl};
3583 my $command = (qq{$perl "-I$cf->{installarchlib}" "-I$cf->{installprivlib}" "$xsubpp" -noprototypes } .
3584 qq{$typemaps "$file"});
3586 $self->log_info("$command\n");
3587 my $fh = IO::File->new("> $args{outfile}") or die "Couldn't write $args{outfile}: $!";
3588 print $fh `$command`;
3593 sub split_like_shell {
3594 my ($self, $string) = @_;
3596 return () unless defined($string);
3597 return @$string if UNIVERSAL::isa($string, 'ARRAY');
3598 $string =~ s/^\s+|\s+$//g;
3599 return () unless length($string);
3601 return Text::ParseWords::shellwords($string);
3604 sub run_perl_script {
3605 my ($self, $script, $preargs, $postargs) = @_;
3606 foreach ($preargs, $postargs) {
3607 $_ = [ $self->split_like_shell($_) ] unless ref();
3609 return $self->run_perl_command([@$preargs, $script, @$postargs]);
3612 sub run_perl_command {
3613 # XXX Maybe we should accept @args instead of $args? Must resolve
3614 # this before documenting.
3615 my ($self, $args) = @_;
3616 $args = [ $self->split_like_shell($args) ] unless ref($args);
3617 my $perl = ref($self) ? $self->perl : $self->find_perl_interpreter;
3619 # Make sure our local additions to @INC are propagated to the subprocess
3620 my $c = ref $self ? $self->config : \%Config::Config;
3621 local $ENV{PERL5LIB} = join $c->{path_sep}, $self->_added_to_INC;
3623 return $self->do_system($perl, @$args);
3626 # Infer various data from the path of the input filename
3627 # that is needed to create output files.
3628 # The input filename is expected to be of the form:
3629 # lib/Module/Name.ext or Module/Name.ext
3630 sub _infer_xs_spec {
3634 my $cf = $self->{config};
3638 my( $v, $d, $f ) = File::Spec->splitpath( $file );
3639 my @d = File::Spec->splitdir( $d );
3640 (my $file_base = $f) =~ s/\.[^.]+$//i;
3642 $spec{base_name} = $file_base;
3644 $spec{src_dir} = File::Spec->catpath( $v, $d, '' );
3647 shift( @d ) while @d && ($d[0] eq 'lib' || $d[0] eq '');
3648 pop( @d ) while @d && $d[-1] eq '';
3649 $spec{module_name} = join( '::', (@d, $file_base) );
3651 $spec{archdir} = File::Spec->catdir($self->blib, 'arch', 'auto',
3654 $spec{bs_file} = File::Spec->catfile($spec{archdir}, "${file_base}.bs");
3656 $spec{lib_file} = File::Spec->catfile($spec{archdir},
3657 "${file_base}.$cf->{dlext}");
3659 $spec{c_file} = File::Spec->catfile( $spec{src_dir},
3662 $spec{obj_file} = File::Spec->catfile( $spec{src_dir},
3663 "${file_base}$cf->{obj_ext}" );
3669 my ($self, $file) = @_;
3670 my $cf = $self->config; # For convenience
3672 my $spec = $self->_infer_xs_spec($file);
3674 # File name, minus the suffix
3675 (my $file_base = $file) =~ s/\.[^.]+$//;
3678 $self->add_to_cleanup($spec->{c_file});
3680 unless ($self->up_to_date($file, $spec->{c_file})) {
3681 $self->compile_xs($file, outfile => $spec->{c_file});
3685 my $v = $self->dist_version;
3686 $self->compile_c($spec->{c_file},
3687 defines => {VERSION => qq{"$v"}, XS_VERSION => qq{"$v"}});
3690 File::Path::mkpath($spec->{archdir}, 0, 0777) unless -d $spec->{archdir};
3693 $self->add_to_cleanup($spec->{bs_file});
3694 unless ($self->up_to_date($file, $spec->{bs_file})) {
3695 require ExtUtils::Mkbootstrap;
3696 $self->log_info("ExtUtils::Mkbootstrap::Mkbootstrap('$spec->{bs_file}')\n");
3697 ExtUtils::Mkbootstrap::Mkbootstrap($spec->{bs_file}); # Original had $BSLOADLIBS - what's that?
3698 {my $fh = IO::File->new(">> $spec->{bs_file}")} # create
3699 utime((time)x2, $spec->{bs_file}); # touch
3703 $self->link_c($spec->{archdir}, $file_base);
3707 my ($self, @cmd) = @_;
3708 $self->log_info("@cmd\n");
3709 return !system(@cmd);
3712 sub copy_if_modified {
3716 : ( from => shift, to_dir => shift, flatten => shift )
3718 $args{verbose} = !$self->quiet
3719 unless exists $args{verbose};
3721 my $file = $args{from};
3722 unless (defined $file and length $file) {
3723 die "No 'from' parameter given to copy_if_modified";
3727 if (defined $args{to} and length $args{to}) {
3728 $to_path = $args{to};
3729 } elsif (defined $args{to_dir} and length $args{to_dir}) {
3730 $to_path = File::Spec->catfile( $args{to_dir}, $args{flatten}
3731 ? File::Basename::basename($file)
3734 die "No 'to' or 'to_dir' parameter given to copy_if_modified";
3737 return if $self->up_to_date($file, $to_path); # Already fresh
3739 # Create parent directories
3740 File::Path::mkpath(File::Basename::dirname($to_path), 0, 0777);
3742 $self->log_info("$file -> $to_path\n") if $args{verbose};
3743 File::Copy::copy($file, $to_path) or die "Can't copy('$file', '$to_path'): $!";
3748 my ($self, $source, $derived) = @_;
3749 $source = [$source] unless ref $source;
3750 $derived = [$derived] unless ref $derived;
3752 return 0 if grep {not -e} @$derived;
3754 my $most_recent_source = time / (24*60*60);
3755 foreach my $file (@$source) {
3757 $self->log_warn("Can't find source file $file for up-to-date check");
3760 $most_recent_source = -M _ if -M _ < $most_recent_source;
3763 foreach my $derived (@$derived) {
3764 return 0 if -M $derived > $most_recent_source;
3770 my ($self, $first, $second) = @_;
3771 # File::Spec doesn't have an easy way to check whether one directory
3772 # is inside another, unfortunately.
3774 ($first, $second) = map File::Spec->canonpath($_), ($first, $second);
3775 my @first_dirs = File::Spec->splitdir($first);
3776 my @second_dirs = File::Spec->splitdir($second);
3778 return 0 if @second_dirs < @first_dirs;
3780 my $is_same = ( File::Spec->case_tolerant
3781 ? sub {lc(shift()) eq lc(shift())}
3782 : sub {shift() eq shift()} );
3784 while (@first_dirs) {
3785 return 0 unless $is_same->(shift @first_dirs, shift @second_dirs);
3797 Module::Build::Base - Default methods for Module::Build
3801 Please see the Module::Build documentation.
3805 The C<Module::Build::Base> module defines the core functionality of
3806 C<Module::Build>. Its methods may be overridden by any of the
3807 platform-dependent modules in the C<Module::Build::Platform::>
3808 namespace, but the intention here is to make this base module as
3809 platform-neutral as possible. Nicely enough, Perl has several core
3810 tools available in the C<File::> namespace for doing this, so the task
3811 isn't very difficult.
3813 Please see the C<Module::Build> documentation for more details.
3817 Ken Williams <ken@cpan.org>
3821 Copyright (c) 2001-2005 Ken Williams. All rights reserved.
3823 This library is free software; you can redistribute it and/or
3824 modify it under the same terms as Perl itself.
3828 perl(1), Module::Build(3)