This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Remove support for building in vms/ext, as it's not needed post 26dd53a23187.
[perl5.git] / make_ext.pl
CommitLineData
61edc683 1#!./miniperl
a2f19a19
SM
2use strict;
3use warnings;
b8d39eba 4use Config;
286d62c2 5use Cwd;
75f92628 6
a0d0e21e 7# This script acts as a simple interface for building extensions.
286d62c2
NC
8
9# It's actually a cut and shut of the Unix version ext/utils/makeext and the
10# Windows version win32/build_ext.pl hence the two invocation styles.
11
12# On Unix, it primarily used by the perl Makefile one extention at a time:
a0d0e21e
LW
13#
14# d_dummy $(dynamic_ext): miniperl preplibrary FORCE
e2fabae1 15# @$(RUN) ./miniperl make_ext.pl --target=dynamic $@ MAKE=$(MAKE) LIBPERL_A=$(LIBPERL)
a0d0e21e 16#
902aaf3e 17# On Windows or VMS,
286d62c2
NC
18# If '--static' is specified, static extensions will be built.
19# If '--dynamic' is specified, dynamic (and nonxs) extensions will be built.
20# If '--all' is specified, all extensions will be built.
21#
22# make_ext.pl "MAKE=make [-make_opts]" --dir=directory [--target=target] [--static|--dynamic|--all] +ext2 !ext1
23#
24# E.g.
25#
26# make_ext.pl "MAKE=nmake -nologo" --dir=..\ext
27#
28# make_ext.pl "MAKE=nmake -nologo" --dir=..\ext --target=clean
29#
30# make_ext.pl MAKE=dmake --dir=..\ext
31#
32# make_ext.pl MAKE=dmake --dir=..\ext --target=clean
33#
34# Will skip building extensions which are marked with an '!' char.
35# Mostly because they still not ported to specified platform.
36#
37# If any extensions are listed with a '+' char then only those
38# extensions will be built, but only if they arent countermanded
39# by an '!ext' and are appropriate to the type of building being done.
40
a0d0e21e
LW
41# It may be deleted in a later release of perl so try to
42# avoid using it for other purposes.
43
e3b84025
NC
44my $is_Win32 = $^O eq 'MSWin32';
45my $is_VMS = $^O eq 'VMS';
46my $is_Unix = !$is_Win32 && !$is_VMS;
47
286d62c2
NC
48require FindExt if $is_Win32;
49
fc678412 50my (%excl, %incl, %opts, @extspec, @pass_through);
97a26ad9
NC
51
52foreach (@ARGV) {
53 if (/^!(.*)$/) {
54 $excl{$1} = 1;
55 } elsif (/^\+(.*)$/) {
56 $incl{$1} = 1;
57 } elsif (/^--([\w\-]+)$/) {
58 $opts{$1} = 1;
e2fabae1
NC
59 } elsif (/^--([\w\-]+)=(.*)$/) {
60 $opts{$1} = $2;
e2fabae1 61 } elsif (/=/) {
fc678412 62 push @pass_through, $_;
ca5de986 63 } elsif (length) {
e2fabae1 64 push @extspec, $_;
97a26ad9
NC
65 }
66}
67
286d62c2
NC
68my $static = $opts{static} || $opts{all};
69my $dynamic = $opts{dynamic} || $opts{all};
70
ca5de986
NC
71# The Perl Makefile.SH will expand all extensions to
72# lib/auto/X/X.a (or lib/auto/X/Y/Y.a if nested)
73# A user wishing to run make_ext might use
74# X (or X/Y or X::Y if nested)
75
76# canonise into X/Y form (pname)
77
78foreach (@extspec) {
7ad017a8 79 if (s{^lib/auto/}{}) {
ca5de986 80 # Remove lib/auto prefix and /*.* suffix
c5aac6ab 81 s{/[^/]+\.[^/]+$}{};
7ad017a8 82 } elsif (s{^ext/}{}) {
ca5de986 83 # Remove ext/ prefix and /pm_to_blib suffix
ca5de986 84 s{/pm_to_blib$}{};
57df1c46
NC
85 # Targets are given as files on disk, but the extension spec is still
86 # written using /s for each ::
87 tr!-!/!;
7ad017a8 88 } elsif (s{::}{\/}g) {
ca5de986 89 # Convert :: to /
7ad017a8 90 } else {
ca5de986
NC
91 s/\..*o//;
92 }
93}
94
fc678412
NC
95my $makecmd = shift @pass_through; # Should be something like MAKE=make
96unshift @pass_through, 'PERL_CORE=1';
97
286d62c2 98my $dir = $opts{dir} || 'ext';
e2fabae1 99my $target = $opts{target};
07f3cc2a 100$target = 'all' unless defined $target;
a0d0e21e 101
fb73857a
PP
102# Previously, $make was taken from config.sh. However, the user might
103# instead be running a possibly incompatible make. This might happen if
104# the user types "gmake" instead of a plain "make", for example. The
105# correct current value of MAKE will come through from the main perl
106# makefile as MAKE=/whatever/make in $makecmd. We'll be cautious in
107# case third party users of this script (are there any?) don't have the
108# MAKE=$(MAKE) argument, which was added after 5.004_03.
ca5de986
NC
109unless(defined $makecmd and $makecmd =~ /^MAKE=(.*)$/) {
110 die "$0: WARNING: Please include MAKE=\$(MAKE) in \@ARGV\n";
a2f19a19
SM
111}
112
eb1f8df7
NC
113# This isn't going to cope with anything fancy, such as spaces inside command
114# names, but neither did what it replaced. Once there is a use case that needs
115# it, please supply patches. Until then, I'm sticking to KISS
116my @make = split ' ', $1 || $Config{make} || $ENV{MAKE};
ca5de986 117# Using an array of 0 or 1 elements makes the subsequent code simpler.
fc678412
NC
118my @run = $Config{run};
119@run = () if not defined $run[0] or $run[0] eq '';
a2f19a19 120
a0d0e21e 121
07f3cc2a 122if ($target eq '') {
ca5de986
NC
123 die "make_ext: no make target specified (eg all or clean)\n";
124} elsif ($target !~ /(?:^all|clean)$/) {
125 # for the time being we are strict about what make_ext is used for
126 die "$0: unknown make target '$target'\n";
a2f19a19
SM
127}
128
286d62c2
NC
129if (!@extspec and !$static and !$dynamic) {
130 die "$0: no extension specified\n";
131}
132
133my $perl;
134my %extra_passthrough;
135
136if ($is_Win32) {
137 (my $here = getcwd()) =~ s{/}{\\}g;
138 $perl = $^X;
139 if ($perl =~ m#^\.\.#) {
140 $perl = "$here\\$perl";
141 }
142 (my $topdir = $perl) =~ s/\\[^\\]+$//;
143 # miniperl needs to find perlglob and pl2bat
144 $ENV{PATH} = "$topdir;$topdir\\win32\\bin;$ENV{PATH}";
145 my $pl2bat = "$topdir\\win32\\bin\\pl2bat";
146 unless (-f "$pl2bat.bat") {
147 my @args = ($perl, ("$pl2bat.pl") x 2);
148 print "@args\n";
149 system(@args) unless defined $::Cross::platform;
150 }
151
152 print "In ", getcwd();
153 chdir($dir) || die "Cannot cd to $dir\n";
154 (my $ext = getcwd()) =~ s{/}{\\}g;
155 FindExt::scan_ext($ext);
156 FindExt::set_static_extensions(split ' ', $Config{static_ext});
157
158 my @ext;
159 push @ext, FindExt::static_ext() if $static;
160 push @ext, FindExt::dynamic_ext(), FindExt::nonxs_ext() if $dynamic;
161
162 foreach (sort @ext) {
163 if (%incl and !exists $incl{$_}) {
164 #warn "Skipping extension $ext\\$_, not in inclusion list\n";
165 next;
166 }
167 if (exists $excl{$_}) {
168 warn "Skipping extension $ext\\$_, not ported to current platform";
169 next;
170 }
171 push @extspec, $_;
172 if(FindExt::is_static($_)) {
173 push @{$extra_passthrough{$_}}, 'LINKTYPE=static';
174 }
175 }
176 chdir '..'; # now in the Perl build directory
177}
902aaf3e
CB
178elsif ($is_VMS) {
179 $perl = $^X;
180 push @extspec, (split ' ', $Config{static_ext}) if $static;
181 push @extspec, (split ' ', $Config{dynamic_ext}) if $dynamic;
182}
286d62c2 183
e08c66ce
NC
184foreach my $spec (@extspec) {
185 my $mname = $spec;
ca5de986 186 $mname =~ s!/!::!g;
238a6851
NC
187 my $ext_pathname;
188 if (-d "ext/$spec") {
189 # Old style ext/Data/Dumper/
190 $ext_pathname = "ext/$spec";
191 } else {
192 # New style ext/Data-Dumper/
193 my $copy = $spec;
194 $copy =~ tr!/!-!;
195 $ext_pathname = "ext/$copy";
196 }
e08c66ce
NC
197 my $up = $ext_pathname;
198 $up =~ s![^/]+!..!g;
a2f19a19 199
ca5de986 200 if ($Config{osname} eq 'catamount') {
a2f19a19 201 # Snowball's chance of building extensions.
ca5de986
NC
202 die "This is $Config{osname}, not building $mname, sorry.\n";
203 }
a2f19a19 204
ca5de986 205 print "\tMaking $mname ($target)\n";
a2f19a19 206
e08c66ce 207 build_extension('ext', $ext_pathname, $up, $perl || "$up/miniperl",
e74f76b2 208 "$up/lib", $mname,
e08c66ce 209 [@pass_through, @{$extra_passthrough{$spec} || []}]);
ca5de986 210}
a0d0e21e 211
fc678412 212sub build_extension {
e74f76b2
NC
213 my ($ext, $ext_dir, $return_dir, $perl, $lib_dir, $mname, $pass_through)
214 = @_;
fc678412
NC
215 unless (chdir "$ext_dir") {
216 warn "Cannot cd to $ext_dir: $!";
217 return;
218 }
902aaf3e
CB
219 my $makefile;
220 if ($is_VMS) {
221 $makefile = 'descrip.mms';
222 if ($target =~ /clean$/
223 && !-f $makefile
224 && -f "${makefile}_old") {
225 $makefile = "${makefile}_old";
226 }
227 } else {
228 $makefile = 'Makefile';
229 }
fc678412 230
902aaf3e 231 if (!-f $makefile) {
e74f76b2
NC
232 if (!-f 'Makefile.PL') {
233 print "\nCreating Makefile.PL in $ext_dir for $mname\n";
234 # We need to cope well with various possible layouts
235 my @dirs = split /::/, $mname;
236 my $leaf = pop @dirs;
237 my $leafname = "$leaf.pm";
238 my $pathname = join '/', @dirs, $leafname;
239 my @locations = ($leafname, $pathname, "lib/$pathname");
240 my $fromname;
241 foreach (@locations) {
242 if (-f $_) {
243 $fromname = $_;
244 last;
245 }
246 }
247
248 unless ($fromname) {
249 die "For $mname tried @locations in in $ext_dir but can't find source";
250 }
251 open my $fh, '>', 'Makefile.PL'
252 or die "Can't open Makefile.PL for writing: $!";
253 print $fh <<"EOM";
254#-*- buffer-read-only: t -*-
255
256# This Makefile.PL was written by $0.
257# It will be deleted automatically by make realclean
258
259use strict;
260use ExtUtils::MakeMaker;
261
262WriteMakefile(
263 NAME => '$mname',
264 VERSION_FROM => '$fromname',
265 ABSTRACT_FROM => '$fromname',
266 realclean => {FILES => 'Makefile.PL'},
267);
268
269# ex: set ro:
270EOM
271 close $fh or die "Can't close Makefile.PL: $!";
272 }
fc678412
NC
273 print "\nRunning Makefile.PL in $ext_dir\n";
274
275 # Presumably this can be simplified
276 my @cross;
277 if (defined $::Cross::platform) {
278 # Inherited from win32/buildext.pl
279 @cross = "-MCross=$::Cross::platform";
280 } elsif ($opts{cross}) {
281 # Inherited from make_ext.pl
282 @cross = '-MCross';
a2f19a19 283 }
fc678412 284
902aaf3e
CB
285 my @args = ("-I$lib_dir", @cross, 'Makefile.PL');
286 if ($is_VMS) {
287 my $libd = VMS::Filespec::vmspath($lib_dir);
288 push @args, "INST_LIB=$libd", "INST_ARCHLIB=$libd";
289 } else {
a2b175af
NC
290 push @args, 'INSTALLDIRS=perl', 'INSTALLMAN1DIR=none',
291 'INSTALLMAN3DIR=none';
902aaf3e
CB
292 }
293 push @args, @$pass_through;
294 _quote_args(\@args) if $is_VMS;
295 print join(' ', @run, $perl, @args), "\n";
296 my $code = system @run, $perl, @args;
fc678412
NC
297 warn "$code from $ext_dir\'s Makefile.PL" if $code;
298
61edc683
NC
299 # Right. The reason for this little hack is that we're sitting inside
300 # a program run by ./miniperl, but there are tasks we need to perform
301 # when the 'realclean', 'distclean' or 'veryclean' targets are run.
302 # Unfortunately, they can be run *after* 'clean', which deletes
303 # ./miniperl
304 # So we do our best to leave a set of instructions identical to what
305 # we would do if we are run directly as 'realclean' etc
306 # Whilst we're perfect, unfortunately the targets we call are not, as
307 # some of them rely on a $(PERL) for their own distclean targets.
308 # But this always used to be a problem with the old /bin/sh version of
309 # this.
e3b84025 310 if ($is_Unix) {
fc678412
NC
311 my $suffix = '.sh';
312 foreach my $clean_target ('realclean', 'veryclean') {
ca5de986 313 my $file = "$return_dir/$clean_target$suffix";
fc678412
NC
314 open my $fh, '>>', $file or die "open $file: $!";
315 # Quite possible that we're being run in parallel here.
316 # Can't use Fcntl this early to get the LOCK_EX
317 flock $fh, 2 or warn "flock $file: $!";
318 print $fh <<"EOS";
319cd $ext_dir
320if test ! -f Makefile -a -f Makefile.old; then
61edc683 321 echo "Note: Using Makefile.old"
eb1f8df7 322 make -f Makefile.old $clean_target MAKE='@make' @pass_through
61edc683 323else
fc678412 324 if test ! -f Makefile ; then
61edc683
NC
325 echo "Warning: No Makefile!"
326 fi
eb1f8df7 327 make $clean_target MAKE='@make' @pass_through
61edc683 328fi
fc678412 329cd $return_dir
61edc683 330EOS
fc678412
NC
331 close $fh or die "close $file: $!";
332 }
61edc683 333 }
fc678412 334 }
a2f19a19 335
902aaf3e 336 if (not -f $makefile) {
a2f19a19 337 print "Warning: No Makefile!\n";
fc678412 338 }
a2f19a19 339
902aaf3e
CB
340 if ($is_VMS) {
341 _macroify_passthrough($pass_through);
342 unshift @$pass_through, "/DESCRIPTION=$makefile";
343 }
344
fc678412 345 if (!$target or $target !~ /clean$/) {
a2f19a19 346 # Give makefile an opportunity to rewrite itself.
75f92628 347 # reassure users that life goes on...
902aaf3e
CB
348 my @args = ('config', @$pass_through);
349 _quote_args(\@args) if $is_VMS;
350 system(@run, @make, @args) and print "@run @make @args failed, continuing anyway...\n";
fc678412 351 }
902aaf3e
CB
352 my @targ = ($target, @$pass_through);
353 _quote_args(\@targ) if $is_VMS;
354 print "Making $target in $ext_dir\n@run @make @targ\n";
355 my $code = system(@run, @make, @targ);
fc678412 356 die "Unsuccessful make($ext_dir): code=$code" if $code != 0;
a2f19a19 357
fc678412
NC
358 chdir $return_dir || die "Cannot cd to $return_dir: $!";
359}
902aaf3e
CB
360
361sub _quote_args {
362 my $args = shift; # must be array reference
363
364 # Do not quote qualifiers that begin with '/'.
365 map { if (!/^\//) {
366 $_ =~ s/\"/""/g; # escape C<"> by doubling
367 $_ = q(").$_.q(");
368 }
369 } @{$args}
370 ;
371}
372
373sub _macroify_passthrough {
374 my $passthrough = shift;
375 _quote_args($passthrough);
376 my $macro = '/MACRO=(' . join(',',@$passthrough) . ')';
377 @$passthrough = ();
378 @$passthrough[0] = $macro;
379}