This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Remove some unnecessary Makefile.PLs from cpan/ and ext/
[perl5.git] / make_ext.pl
index 9263945..a5ece30 100644 (file)
@@ -1,30 +1,22 @@
 #!./miniperl
 use strict;
 use warnings;
+use constant IS_CROSS => defined $::Cross::platform ? 1 : 0;
 use Config;
-BEGIN {
-    unshift @INC, $^O eq 'MSWin32' ? '../ext/Cwd' : 'ext/Cwd';
-}
-use Cwd;
 
-# To clarify, this isn't the entire suite of modules considered "toolchain"
-# It's not even all modules needed to build ext/
-# It's just the source paths of the (minimum complete set of) modules in ext/
-# needed to build the nonxs modules
-# After which, all nonxs modules are in lib, which was always sufficient to
-# allow miniperl to build everything else.
+my $is_Win32 = $^O eq 'MSWin32';
+my $is_VMS = $^O eq 'VMS';
+my $is_Unix = !$is_Win32 && !$is_VMS;
 
-my @toolchain = qw(ext/constant/lib ext/Cwd ext/ExtUtils-Command/lib
-                  ext/ExtUtils-Install/lib ext/ExtUtils-MakeMaker/lib
-                  ext/ExtUtils-Manifest/lib ext/Text-ParseWords/lib
-       ext/File-Path/lib ext/AutoLoader/lib);
+my @ext_dirs = qw(cpan dist ext);
+my $ext_dirs_re = '(?:' . join('|', @ext_dirs) . ')';
 
 # This script acts as a simple interface for building extensions.
 
 # It's actually a cut and shut of the Unix version ext/utils/makeext and the
 # Windows version win32/build_ext.pl hence the two invocation styles.
 
-# On Unix, it primarily used by the perl Makefile one extention at a time:
+# On Unix, it primarily used by the perl Makefile one extension at a time:
 #
 # d_dummy $(dynamic_ext): miniperl preplibrary FORCE
 #      @$(RUN) ./miniperl make_ext.pl --target=dynamic $@ MAKE=$(MAKE) LIBPERL_A=$(LIBPERL)
@@ -33,7 +25,7 @@ my @toolchain = qw(ext/constant/lib ext/Cwd ext/ExtUtils-Command/lib
 # If '--static' is specified, static extensions will be built.
 # If '--dynamic' is specified, dynamic extensions will be built.
 # If '--nonxs' is specified, nonxs extensions will be built.
-# If '--dynaloader' is specificied, DynaLoader will be built.
+# If '--dynaloader' is specified, DynaLoader will be built.
 # If '--all' is specified, all extensions will be built.
 #
 #    make_ext.pl "MAKE=make [-make_opts]" --dir=directory [--target=target] [--static|--dynamic|--all] +ext2 !ext1
@@ -52,18 +44,13 @@ my @toolchain = qw(ext/constant/lib ext/Cwd ext/ExtUtils-Command/lib
 # Mostly because they still not ported to specified platform.
 # 
 # If any extensions are listed with a '+' char then only those
-# extensions will be built, but only if they arent countermanded
+# extensions will be built, but only if they aren't countermanded
 # by an '!ext' and are appropriate to the type of building being done.
+# An extensions follows the format of Foo/Bar, which would be extension Foo::Bar
 
 # It may be deleted in a later release of perl so try to
 # avoid using it for other purposes.
 
-my $is_Win32 = $^O eq 'MSWin32';
-my $is_VMS = $^O eq 'VMS';
-my $is_Unix = !$is_Win32 && !$is_VMS;
-
-require FindExt if $is_Win32;
-
 my (%excl, %incl, %opts, @extspec, @pass_through);
 
 foreach (@ARGV) {
@@ -74,7 +61,7 @@ foreach (@ARGV) {
     } elsif (/^--([\w\-]+)$/) {
        $opts{$1} = 1;
     } elsif (/^--([\w\-]+)=(.*)$/) {
-       $opts{$1} = $2;
+       push @{$opts{$1}}, $2;
     } elsif (/=/) {
        push @pass_through, $_;
     } elsif (length) {
@@ -98,7 +85,7 @@ foreach (@extspec) {
     if (s{^lib/auto/}{}) {
        # Remove lib/auto prefix and /*.* suffix
        s{/[^/]+\.[^/]+$}{};
-    } elsif (s{^ext/}{}) {
+    } elsif (s{^$ext_dirs_re/}{}) {
        # Remove ext/ prefix and /pm_to_blib suffix
        s{/pm_to_blib$}{};
        # Targets are given as files on disk, but the extension spec is still
@@ -114,8 +101,8 @@ foreach (@extspec) {
 my $makecmd  = shift @pass_through; # Should be something like MAKE=make
 unshift @pass_through, 'PERL_CORE=1';
 
-my $dir  = $opts{dir} || 'ext';
-my $target   = $opts{target};
+my @dirs  = @{$opts{dir} || \@ext_dirs};
+my $target   = $opts{target}[0];
 $target = 'all' unless defined $target;
 
 # Previously, $make was taken from config.sh.  However, the user might
@@ -153,9 +140,13 @@ my $perl;
 my %extra_passthrough;
 
 if ($is_Win32) {
-    (my $here = getcwd()) =~ s{/}{\\}g;
+    require Cwd;
+    require FindExt;
+    my $build = Cwd::getcwd();
     $perl = $^X;
     if ($perl =~ m#^\.\.#) {
+       my $here = $build;
+       $here =~ s{/}{\\}g;
        $perl = "$here\\$perl";
     }
     (my $topdir = $perl) =~ s/\\[^\\]+$//;
@@ -163,16 +154,20 @@ if ($is_Win32) {
     $ENV{PATH} = "$topdir;$topdir\\win32\\bin;$ENV{PATH}";
     my $pl2bat = "$topdir\\win32\\bin\\pl2bat";
     unless (-f "$pl2bat.bat") {
-       my @args = ($perl, ("$pl2bat.pl") x 2);
+       my @args = ($perl, "-I$topdir\\lib", ("$pl2bat.pl") x 2);
        print "@args\n";
-       system(@args) unless defined $::Cross::platform;
+       system(@args) unless IS_CROSS;
     }
 
-    print "In ", getcwd();
-    chdir($dir) || die "Cannot cd to $dir\n";
-    (my $ext = getcwd()) =~ s{/}{\\}g;
-    FindExt::scan_ext($ext);
-    FindExt::set_static_extensions(split ' ', $Config{static_ext});
+    print "In $build";
+    foreach my $dir (@dirs) {
+       chdir($dir) or die "Cannot cd to $dir: $!\n";
+       (my $ext = Cwd::getcwd()) =~ s{/}{\\}g;
+       FindExt::scan_ext($ext);
+       FindExt::set_static_extensions(split ' ', $Config{static_ext});
+       chdir $build
+           or die "Couldn't chdir to '$build': $!"; # restore our start directory
+    }
 
     my @ext;
     push @ext, FindExt::static_ext() if $static;
@@ -182,22 +177,24 @@ if ($is_Win32) {
 
     foreach (sort @ext) {
        if (%incl and !exists $incl{$_}) {
-           #warn "Skipping extension $ext\\$_, not in inclusion list\n";
+           #warn "Skipping extension $_, not in inclusion list\n";
            next;
        }
        if (exists $excl{$_}) {
-           warn "Skipping extension $ext\\$_, not ported to current platform";
+           warn "Skipping extension $_, not ported to current platform";
            next;
        }
        push @extspec, $_;
-       if($_ eq 'DynaLoader') {
+       if($_ eq 'DynaLoader' and $target !~ /clean$/) {
            # No, we don't know why nmake can't work out the dependency chain
            push @{$extra_passthrough{$_}}, 'DynaLoader.c';
        } elsif(FindExt::is_static($_)) {
            push @{$extra_passthrough{$_}}, 'LINKTYPE=static';
        }
     }
-    chdir '..'; # now in the Perl build directory
+
+    chdir '..'
+       or die "Couldn't chdir to build directory: $!"; # now in the Perl build
 }
 elsif ($is_VMS) {
     $perl = $^X;
@@ -209,10 +206,11 @@ elsif ($is_VMS) {
 
 {
     # Cwd needs to be built before Encode recurses into subdirectories.
+    # Pod::Simple needs to be built before Pod::Functions
     # This seems to be the simplest way to ensure this ordering:
     my (@first, @other);
     foreach (@extspec) {
-       if ($_ eq 'Cwd') {
+       if ($_ eq 'Cwd' || $_ eq 'Pod/Simple') {
            push @first, $_;
        } else {
            push @other, $_;
@@ -221,23 +219,34 @@ elsif ($is_VMS) {
     @extspec = (@first, @other);
 }
 
+if ($Config{osname} eq 'catamount' and @extspec) {
+    # Snowball's chance of building extensions.
+    die "This is $Config{osname}, not building $extspec[0], sorry.\n";
+}
+
 foreach my $spec (@extspec)  {
     my $mname = $spec;
     $mname =~ s!/!::!g;
     my $ext_pathname;
-    if (-d "ext/$spec") {
-       # Old style ext/Data/Dumper/
-       $ext_pathname = "ext/$spec";
-    } else {
-       # New style ext/Data-Dumper/
-       my $copy = $spec;
-       $copy =~ tr!/!-!;
-       $ext_pathname = "ext/$copy";
+
+    # Try new style ext/Data-Dumper/ first
+    my $copy = $spec;
+    $copy =~ tr!/!-!;
+    foreach my $dir (@ext_dirs) {
+       if (-d "$dir/$copy") {
+           $ext_pathname = "$dir/$copy";
+           last;
+       }
     }
 
-    if ($Config{osname} eq 'catamount') {
-       # Snowball's chance of building extensions.
-       die "This is $Config{osname}, not building $mname, sorry.\n";
+    if (!defined $ext_pathname) {
+       if (-d "ext/$spec") {
+           # Old style ext/Data/Dumper/
+           $ext_pathname = "ext/$spec";
+       } else {
+           warn "Can't find extension $spec in any of @ext_dirs";
+           next;
+       }
     }
 
     print "\tMaking $mname ($target)\n";
@@ -249,23 +258,19 @@ foreach my $spec (@extspec)  {
 sub build_extension {
     my ($ext_dir, $perl, $mname, $pass_through) = @_;
 
+    unless (chdir "$ext_dir") {
+       warn "Cannot cd to $ext_dir: $!";
+       return;
+    }
+
     my $up = $ext_dir;
     $up =~ s![^/]+!..!g;
 
     $perl ||= "$up/miniperl";
     my $return_dir = $up;
     my $lib_dir = "$up/lib";
-    # $lib_dir must be last, as we're copying files into it, and in a parallel
-    # make there's a race condition if one process tries to open a module that
-    # another process has half-written.
-    $ENV{PERL5LIB}
-       = join $Config{path_sep}, (map {"$up/$_"} @toolchain), $lib_dir;
     $ENV{PERL_CORE} = 1;
 
-    unless (chdir "$ext_dir") {
-       warn "Cannot cd to $ext_dir: $!";
-       return;
-    }
     my $makefile;
     if ($is_VMS) {
        $makefile = 'descrip.mms';
@@ -278,61 +283,173 @@ sub build_extension {
        $makefile = 'Makefile';
     }
     
+    if (-f $makefile) {
+       open my $mfh, $makefile or die "Cannot open $makefile: $!";
+       while (<$mfh>) {
+           # Plagiarised from CPAN::Distribution
+           last if /MakeMaker post_initialize section/;
+           next unless /^#\s+VERSION_FROM\s+=>\s+(.+)/;
+           my $vmod = eval $1;
+           my $oldv;
+           while (<$mfh>) {
+               next unless /^XS_VERSION = (\S+)/;
+               $oldv = $1;
+               last;
+           }
+           last unless defined $oldv;
+           require ExtUtils::MM_Unix;
+           defined (my $newv = parse_version MM $vmod) or last;
+           if ($newv ne $oldv) {
+               close $mfh or die "close $makefile: $!";
+               _unlink($makefile);
+               {
+                   no warnings 'deprecated';
+                   goto NO_MAKEFILE;
+               }
+           }
+       }
+       if(IS_CROSS){
+           seek($mfh, 0, 0) or die "Cannot seek $makefile: $!";
+           while (<$mfh>) {
+               #this is used to stop the while loop early for efficiency when
+               #the line is reached, and possibly match a cross build
+               my $header = quotemeta '# These definitions are from config.sh (via ';
+               if(/^$header.+?
+                   (xlib[\/\\]
+                   $::Cross::platform\Q\/Config.pm\E)?\)\./x) {
+                   unless (defined $1){
+                       print "Deleting non-Cross makefile\n";
+                       close $mfh or die "close $makefile: $!";
+                       _unlink($makefile);
+                       {
+                           no warnings 'deprecated';
+                           goto NO_MAKEFILE;
+                       }
+                   } else { #have a cross makefile
+                       goto CROSS_OK_MF;
+                   }
+               }
+           } #catch breakage from future changes
+           die "non-standard makefile found in $mname";
+           CROSS_OK_MF:
+       }
+    }
+
     if (!-f $makefile) {
+       NO_MAKEFILE:
        if (!-f 'Makefile.PL') {
            print "\nCreating Makefile.PL in $ext_dir for $mname\n";
-           # We need to cope well with various possible layouts
-           my @dirs = split /::/, $mname;
-           my $leaf = pop @dirs;
-           my $leafname = "$leaf.pm";
-           my $pathname = join '/', @dirs, $leafname;
-           my @locations = ($leafname, $pathname, "lib/$pathname");
-           my $fromname;
-           foreach (@locations) {
-               if (-f $_) {
-                   $fromname = $_;
-                   last;
+           my ($fromname, $key, $value);
+           if ($mname eq 'podlators') {
+               # We need to special case this somewhere, and this is fewer
+               # lines of code than a core-only Makefile.PL, and no more
+               # complex
+               $fromname = 'VERSION';
+               $key = 'DISTNAME';
+               $value = 'podlators';
+               $mname = 'Pod';
+           } else {
+               $key = 'ABSTRACT_FROM';
+               # We need to cope well with various possible layouts
+               my @dirs = split /::/, $mname;
+               my $leaf = pop @dirs;
+               my $leafname = "$leaf.pm";
+               my $pathname = join '/', @dirs, $leafname;
+               my @locations = ($leafname, $pathname, "lib/$pathname");
+               unshift @locations, 'lib/IO/Compress/Base.pm' if $mname eq 'IO::Compress';
+               foreach (@locations) {
+                   if (-f $_) {
+                       $fromname = $_;
+                       last;
+                   }
                }
-           }
 
-           unless ($fromname) {
-               die "For $mname tried @locations in in $ext_dir but can't find source";
+               unless ($fromname) {
+                   die "For $mname tried @locations in in $ext_dir but can't find source";
+               }
+               ($value = $fromname) =~ s/\.pm\z/.pod/;
+               $value = $fromname unless -e $value;
            }
            open my $fh, '>', 'Makefile.PL'
                or die "Can't open Makefile.PL for writing: $!";
-           print $fh <<"EOM";
+           printf $fh <<'EOM', $0, $mname, $fromname, $key, $value;
 #-*- buffer-read-only: t -*-
 
-# This Makefile.PL was written by $0.
+# This Makefile.PL was written by %s.
 # It will be deleted automatically by make realclean
 
 use strict;
 use ExtUtils::MakeMaker;
 
+# This is what the .PL extracts to. Not the ultimate file that is installed.
+# (ie Win32 runs pl2bat after this)
+
+# Doing this here avoids all sort of quoting issues that would come from
+# attempting to write out perl source with literals to generate the arrays and
+# hash.
+my @temps = 'Makefile.PL';
+foreach (glob('scripts/pod*.PL')) {
+    # The various pod*.PL extractors change directory. Doing that with relative
+    # paths in @INC breaks. It seems the lesser of two evils to copy (to avoid)
+    # the chdir doing anything, than to attempt to convert lib paths to
+    # absolute, and potentially run into problems with quoting special
+    # characters in the path to our build dir (such as spaces)
+    require File::Copy;
+
+    my $temp = $_;
+    $temp =~ s!scripts/!!;
+    File::Copy::copy($_, $temp) or die "Can't copy $temp to $_: $!";
+    push @temps, $temp;
+}
+
+my $script_ext = $^O eq 'VMS' ? '.com' : '';
+my %%pod_scripts;
+foreach (glob('pod*.PL')) {
+    my $script = $_;
+    s/.PL$/$script_ext/i;
+    $pod_scripts{$script} = $_;
+}
+my @exe_files = values %%pod_scripts;
+
 WriteMakefile(
-    NAME          => '$mname',
-    VERSION_FROM  => '$fromname',
-    ABSTRACT_FROM => '$fromname',
-    realclean     => {FILES => 'Makefile.PL'},
+    NAME          => '%s',
+    VERSION_FROM  => '%s',
+    %-13s => '%s',
+    realclean     => { FILES => "@temps" },
+    (%%pod_scripts ? (
+        PL_FILES  => \%%pod_scripts,
+        EXE_FILES => \@exe_files,
+        clean     => { FILES => "@exe_files" },
+    ) : ()),
 );
 
 # ex: set ro:
 EOM
            close $fh or die "Can't close Makefile.PL: $!";
+           # As described in commit 23525070d6c0e51f:
+           # Push the atime and mtime of generated Makefile.PLs back 4
+           # seconds. In certain circumstances ( on virtual machines ) the
+           # generated Makefile.PL can produce a Makefile that is older than
+           # the Makefile.PL. Altering the atime and mtime backwards by 4
+           # seconds seems to resolve the issue.
+           eval {
+               my $ftime = time - 4;
+               utime $ftime, $ftime, 'Makefile.PL';
+           };
        }
        print "\nRunning Makefile.PL in $ext_dir\n";
 
        # Presumably this can be simplified
        my @cross;
-       if (defined $::Cross::platform) {
+       if (IS_CROSS) {
            # Inherited from win32/buildext.pl
            @cross = "-MCross=$::Cross::platform";
        } elsif ($opts{cross}) {
            # Inherited from make_ext.pl
            @cross = '-MCross';
        }
-           
-       my @args = (@cross, 'Makefile.PL');
+
+       my @args = ("-I$lib_dir", @cross, 'Makefile.PL');
        if ($is_VMS) {
            my $libd = VMS::Filespec::vmspath($lib_dir);
            push @args, "INST_LIB=$libd", "INST_ARCHLIB=$libd";
@@ -388,19 +505,20 @@ EOS
     }
 
     if ($is_VMS) {
-       _macroify_passthrough($pass_through);
-       unshift @$pass_through, "/DESCRIPTION=$makefile";
+       _quote_args($pass_through);
+       @$pass_through = (
+                         "/DESCRIPTION=$makefile",
+                         '/MACRO=(' . join(',',@$pass_through) . ')'
+                        );
     }
 
     if (!$target or $target !~ /clean$/) {
        # Give makefile an opportunity to rewrite itself.
        # reassure users that life goes on...
        my @args = ('config', @$pass_through);
-       _quote_args(\@args) if $is_VMS;
        system(@run, @make, @args) and print "@run @make @args failed, continuing anyway...\n";
     }
     my @targ = ($target, @$pass_through);
-    _quote_args(\@targ) if $is_VMS;
     print "Making $target in $ext_dir\n@run @make @targ\n";
     my $code = system(@run, @make, @targ);
     die "Unsuccessful make($ext_dir): code=$code" if $code != 0;
@@ -420,10 +538,10 @@ sub _quote_args {
     ;
 }
 
-sub _macroify_passthrough {
-    my $passthrough = shift;
-    _quote_args($passthrough);
-    my $macro = '/MACRO=(' . join(',',@$passthrough) . ')';
-    @$passthrough = ();
-    @$passthrough[0] = $macro;  
+#guarentee that a file is deleted or die, void _unlink($filename)
+#xxx replace with _unlink_or_rename from EU::Install?
+sub _unlink {
+    1 while unlink $_[0];
+    my $err = $!;
+    die "Can't unlink $_[0]: $err" if -f $_[0];
 }