This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Use a buildcustomize.pl to set @INC in miniperl when building extensions.
[perl5.git] / make_ext.pl
index 04c2add..13a15b4 100644 (file)
@@ -3,21 +3,18 @@ use strict;
 use warnings;
 use Config;
 BEGIN {
-    unshift @INC, $^O eq 'MSWin32' ? '../ext/Cwd' : 'ext/Cwd';
+    if ($^O eq 'MSWin32') {
+       unshift @INC, '../dist/Cwd';
+       require FindExt;
+    } else {
+       unshift @INC, 'dist/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 @toolchain = qw(ext/constant/lib ext/Cwd ext/Cwd/lib ext/ExtUtils-Command/lib
-                  ext/ExtUtils-Install/lib ext/ExtUtils-MakeMaker/lib
-                  ext/ExtUtils-Manifest/lib ext/Text-ParseWords/lib
-                  cpan/File-Path/lib cpan/AutoLoader/lib);
+my $is_Win32 = $^O eq 'MSWin32';
+my $is_VMS = $^O eq 'VMS';
+my $is_Unix = !$is_Win32 && !$is_VMS;
 
 my @ext_dirs = qw(cpan dist ext);
 my $ext_dirs_re = '(?:' . join('|', @ext_dirs) . ')';
@@ -27,7 +24,7 @@ my $ext_dirs_re = '(?:' . join('|', @ext_dirs) . ')';
 # 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)
@@ -36,7 +33,7 @@ my $ext_dirs_re = '(?:' . join('|', @ext_dirs) . ')';
 # 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
@@ -61,12 +58,6 @@ my $ext_dirs_re = '(?:' . join('|', @ext_dirs) . ')';
 # 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) {
@@ -156,9 +147,11 @@ my $perl;
 my %extra_passthrough;
 
 if ($is_Win32) {
-    (my $here = getcwd()) =~ s{/}{\\}g;
+    my $build = getcwd();
     $perl = $^X;
     if ($perl =~ m#^\.\.#) {
+       my $here = $build;
+       $here =~ s{/}{\\}g;
        $perl = "$here\\$perl";
     }
     (my $topdir = $perl) =~ s/\\[^\\]+$//;
@@ -171,42 +164,42 @@ if ($is_Win32) {
        system(@args) unless defined $::Cross::platform;
     }
 
-    my $build = getcwd();
     print "In $build";
     foreach my $dir (@dirs) {
        chdir($dir) or die "Cannot cd to $dir: $!\n";
        (my $ext = 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;
-       push @ext, FindExt::dynamic_ext() if $dynamic;
-       push @ext, FindExt::nonxs_ext() if $nonxs;
-       push @ext, 'DynaLoader' if $dynaloader;
+    my @ext;
+    push @ext, FindExt::static_ext() if $static;
+    push @ext, FindExt::dynamic_ext() if $dynamic;
+    push @ext, FindExt::nonxs_ext() if $nonxs;
+    push @ext, 'DynaLoader' if $dynaloader;
 
-       foreach (sort @ext) {
-           if (%incl and !exists $incl{$_}) {
-               #warn "Skipping extension $ext\\$_, not in inclusion list\n";
-               next;
-           }
-           if (exists $excl{$_}) {
-               warn "Skipping extension $ext\\$_, not ported to current platform";
-               next;
-           }
-           push @extspec, $_;
-           if($_ eq 'DynaLoader') {
-               # 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';
-           }
+    foreach (sort @ext) {
+       if (%incl and !exists $incl{$_}) {
+           #warn "Skipping extension $_, not in inclusion list\n";
+           next;
+       }
+       if (exists $excl{$_}) {
+           warn "Skipping extension $_, not ported to current platform";
+           next;
+       }
+       push @extspec, $_;
+       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 $build
-           or die "Couldn't chdir to '$build': $!"; # restore our start directory
     }
+
     chdir '..'
-       or die "Couldn't chdir to build directory: $!"; # now in the Perl build directory
+       or die "Couldn't chdir to build directory: $!"; # now in the Perl build
 }
 elsif ($is_VMS) {
     $perl = $^X;
@@ -230,37 +223,36 @@ 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"
-       # Temporary hack to cope with smokers that are not clearing directories:
-       && $spec =~ m!/!
-       ) {
-       # Old style ext/Data/Dumper/
-       $ext_pathname = "ext/$spec";
-    } else {
-       # New style ext/Data-Dumper/
-       my $copy = $spec;
-       $copy =~ tr!/!-!;
-       foreach my $dir (@ext_dirs) {
-           if (-d "$dir/$copy") {
-               $ext_pathname = "$dir/$copy";
-               last;
-           }
+
+    # 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 (!defined $ext_pathname) {
+    }
+
+    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;
        }
     }
 
-    if ($Config{osname} eq 'catamount') {
-       # Snowball's chance of building extensions.
-       die "This is $Config{osname}, not building $mname, sorry.\n";
-    }
-
     print "\tMaking $mname ($target)\n";
 
     build_extension($ext_pathname, $perl, $mname,
@@ -270,23 +262,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';
@@ -302,39 +290,87 @@ sub build_extension {
     if (!-f $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");
+               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:
@@ -353,7 +389,7 @@ EOM
            @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";