This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
This is my patch patch.1m for perl5.001.
[perl5.git] / lib / ExtUtils / MakeMaker.pm
CommitLineData
a0d0e21e
LW
1package ExtUtils::MakeMaker;
2
e50aee73 3$Version = 4.16; # Last edited $Date: 1995/06/18 16:04:00 $ by Tim Bunce
005c1a0e
AD
4
5$Version_OK = 4.13; # Makefiles older than $Version_OK will die
6 # (Will be checked from MakeMaker version 4.13 onwards)
7
8# $Id: MakeMaker.pm,v 1.21 1995/06/06 06:14:16 k Exp k $
a0d0e21e
LW
9
10use Config;
42793c05
TB
11use Carp;
12use Cwd;
13
a0d0e21e
LW
14require Exporter;
15@ISA = qw(Exporter);
005c1a0e
AD
16@EXPORT = qw(&WriteMakefile $Verbose &prompt);
17@EXPORT_OK = qw($Version &Version_check %att %skip %Recognized_Att_Keys
3edbfbe5 18 @MM_Sections %MM_Sections
005c1a0e 19 &help &neatvalue &mkbootstrap &mksymlists);
a0d0e21e 20
42793c05
TB
21$Is_VMS = $Config{'osname'} eq 'VMS';
22require ExtUtils::MM_VMS if $Is_VMS;
a0d0e21e 23
42793c05 24use strict qw(refs);
a0d0e21e 25
42793c05 26$Version = $Version;# avoid typo warning
a0d0e21e 27$Verbose = 0;
a0d0e21e
LW
28$^W=1;
29
005c1a0e
AD
30sub prompt {
31 my($mess,$def)=@_;
32 local $\="";
33 local $/="\n";
34 local $|=1;
35 die "prompt function called without an argument" unless defined $mess;
36 $def = "" unless defined $def;
37 my $dispdef = "[$def] ";
38 print "$mess $dispdef";
39 chop(my $ans = <STDIN>);
40 $ans || $def;
41}
42793c05 42
1aef975c 43sub check_hints {
5d94fbed 44 # We allow extension-specific hints files.
1aef975c
AD
45
46 # First we look for the best hintsfile we have
47 my(@goodhints);
48 my($hint)="$Config{'osname'}_$Config{'osvers'}";
49 $hint =~ s/\./_/g;
50 $hint =~ s/_$//;
005c1a0e 51 local(*DIR);
1aef975c
AD
52 opendir DIR, "hints";
53 while (defined ($_ = readdir DIR)) {
54 next if /^\./;
fed7345c 55 next unless s/\.pl$//;
1aef975c
AD
56 next unless /^$Config{'osname'}/;
57 # Don't trust a hintfile for a later OS version:
58 next if $_ gt $hint;
59 push @goodhints, $_;
60 if ($_ eq $hint){
61 @goodhints=$_;
62 last;
63 }
64 }
65 closedir DIR;
66 return unless @goodhints; # There was no hintsfile
67 # the last one in lexical ordering is our choice:
5d94fbed 68 $hint=(sort @goodhints)[-1];
1aef975c
AD
69
70 # execute the hintsfile:
748a9306
LW
71 open HINTS, "hints/$hint.pl";
72 @goodhints = <HINTS>;
73 close HINTS;
5d94fbed 74 print STDOUT "Processing hints file hints/$hint.pl";
748a9306 75 eval join('',@goodhints);
5d94fbed 76 print STDOUT $@ if $@;
1aef975c 77}
42793c05
TB
78
79# Setup dummy package:
80# MY exists for overriding methods to be defined within
81unshift(@MY::ISA, qw(MM));
82
83# Dummy package MM inherits actual methods from OS-specific
84# default packages. We use this intermediate package so
85# MY->func() can call MM->func() and get the proper
86# default routine without having to know under what OS
87# it's running.
88unshift(@MM::ISA, $Is_VMS ? qw(ExtUtils::MM_VMS MM_Unix) : qw(MM_Unix));
89
90$Attrib_Help = <<'END';
91 NAME: Perl module name for this extension (DBD::Oracle)
75f92628
AD
92 This will default to the directory name but should
93 be explicitly defined in the Makefile.PL.
42793c05
TB
94
95 DISTNAME: Your name for distributing the package (by tar file)
96 This defaults to NAME above.
97
98 VERSION: Your version number for distributing the package.
99 This defaults to 0.1.
100
005c1a0e
AD
101 INST_LIB: Perl library directory to directly install
102 into during 'make'.
103
104 INSTALLPRIVLIB:Used by 'make install', which sets INST_LIB to this value.
105
106 INST_ARCHLIB: Perl architecture-dependent library to directly install
107 into during 'make'.
108
109 INSTALLARCHLIB:Used by 'make install', which sets INST_ARCHLIB to this value.
110
111 INST_EXE: Directory, where executable scripts should be installed during
112 'make'. Defaults to "./blib", just to have a dummy location
113 during testing. C<make install> will set INST_EXE to INSTALLBIN.
114
115 INSTALLBIN: Used by 'make install' which sets INST_EXE to this value.
42793c05
TB
116
117 PERL_LIB: Directory containing the Perl library to use.
005c1a0e
AD
118
119 PERL_ARCHLIB: Architectur dependent directory containing the Perl library to use.
120
42793c05 121 PERL_SRC: Directory containing the Perl source code
e1666bf5 122 (use of this should be avoided, it may be undefined)
42793c05
TB
123
124 INC: Include file dirs eg: '-I/usr/5include -I/path/to/inc'
005c1a0e 125
42793c05 126 DEFINE: something like "-DHAVE_UNISTD_H"
005c1a0e 127
42793c05
TB
128 OBJECT: List of object files, defaults to '$(BASEEXT).o',
129 but can be a long string containing all object files,
130 e.g. "tkpBind.o tkpButton.o tkpCanvas.o"
005c1a0e 131
42793c05
TB
132 MYEXTLIB: If the extension links to a library that it builds
133 set this to the name of the library (see SDBM_File)
134
135 LIBS: An anonymous array of alternative library specifications
136 to be searched for (in order) until at least one library
137 is found.
138 'LIBS' => [ "-lgdbm", "-ldbm -lfoo", "-L/path -ldbm.nfs" ]
139 Mind, that any element of the array contains a complete
140 set of arguments for the ld command. So do not specify
141 'LIBS' => ["-ltcl", "-ltk", "-lX11" ], #wrong
142 See ODBM_File/Makefile.PL for an example, where an
143 array is needed. If you specify a scalar as in
144 'LIBS' => "-ltcl -ltk -lX11"
145 MakeMaker will turn it into an array with one element.
146
3edbfbe5
TB
147 LDFROM: defaults to "$(OBJECT)" and is used in the ld command
148 to specify what files to link/load from
149 (also see dynamic_lib below for how to specify ld flags)
42793c05
TB
150
151 DIR: Ref to array of subdirectories containing Makefile.PLs
152 e.g. [ 'sdbm' ] in ext/SDBM_File
153
75f92628
AD
154 PMLIBDIRS: Ref to array of subdirectories containing library files.
155 Defaults to [ 'lib', $(BASEEXT) ]. The directories will
40000a8c 156 be scanned and any files they contain will
75f92628
AD
157 be installed in the corresponding location in the library.
158 A MY::libscan() function can be used to alter the behaviour.
159 Defining PM in the Makefile.PL will override PMLIBDIRS.
160
42793c05
TB
161 PM: Hashref of .pm files and *.pl files to be installed.
162 e.g. { 'name_of_file.pm' => '$(INST_LIBDIR)/install_as.pm' }
163 By default this will include *.pm and *.pl. If a lib directory
164 exists and is not listed in DIR (above) then any *.pm and
165 *.pl files it contains will also be included by default.
75f92628 166 Defining PM in the Makefile.PL will override PMLIBDIRS.
42793c05
TB
167
168 XS: Hashref of .xs files. MakeMaker will default this.
169 e.g. { 'name_of_file.xs' => 'name_of_file.c' }
170 The .c files will automatically be included in the list
171 of files deleted by a make clean.
172
173 C: Ref to array of *.c file names. Initialised from a directory scan
174 and the values portion of the XS attribute hash. This is not
175 currently used by MakeMaker but may be handy in Makefile.PLs.
176
177 H: Ref to array of *.h file names. Similar to C: above.
178
232e078e
AD
179 PL_FILES: Ref to hash of files to be processed as perl programs. MakeMaker
180 will default to any found C<*.PL> file (except C<Makefile.PL>) being
181 keys and the basename of the file being the value. E.g.
182 C<{ 'foobar.PL' => 'foobar' }>. The C<*.PL> files are expected to
183 produce output to the target files themselves.
184
40000a8c 185 EXE_FILES: Ref to array of executable files. The files will be copied to
005c1a0e
AD
186 the INST_EXE directory. Make realclean will delete them from
187 there again.
40000a8c 188
42793c05
TB
189 LINKTYPE: =>'static' or 'dynamic' (default unless usedl=undef in config.sh)
190 Should only be used to force static linking (also see linkext below).
191
1aef975c
AD
192 DL_FUNCS: Hashref of symbol names for routines to be made available as
193 universal symbols. Each key/value pair consists of the package
194 name and an array of routine names in that package. Used only
195 under AIX (export lists) and VMS (linker options) at present.
196 The routine names supplied will be expanded in the same way
197 as XSUB names are expanded by the XS() macro.
198 Defaults to { "$(NAME)" => [ "boot_$(NAME)" ] }.
199 (e.g. { "RPC" => [qw( boot_rpcb rpcb_gettime getnetconfigent )],
200 "NetconfigPtr" => [ 'DESTROY'] } )
201
202 DL_VARS: Array of symbol names for variables to be made available as
203 universal symbols. Used only under AIX (export lists) and VMS
204 (linker options) at present. Defaults to [].
205 (e.g. [ qw( Foo_version Foo_numstreams Foo_tree ) ])
fed7345c 206
42793c05 207 CONFIG: =>[qw(archname manext)] defines ARCHNAME & MANEXT from config.sh
005c1a0e 208
42793c05
TB
209 SKIP: =>[qw(name1 name2)] skip (do not write) sections of the Makefile
210
40000a8c
AD
211 MAP_TARGET: If it is intended, that a new perl binary be produced, this variable
212 may hold a name for that binary. Defaults to C<perl>
213
214 LIBPERL_A: The filename of the perllibrary that will be used together
215 with this extension. Defaults to C<libperl.a>.
216
42793c05
TB
217 PERL:
218 FULLPERL:
219
220Additional lowercase attributes can be used to pass parameters to the
221methods which implement that part of the Makefile. These are not
222normally required:
223
005c1a0e 224 macro: {ANY_MACRO => ANY_VALUE, ...}
42793c05
TB
225 installpm: {SPLITLIB => '$(INST_LIB)' (default) or '$(INST_ARCHLIB)'}
226 linkext: {LINKTYPE => 'static', 'dynamic' or ''}
75f92628 227 dynamic_lib: {ARMAYBE => 'ar', OTHERLDFLAGS => '...'}
42793c05 228 clean: {FILES => "*.xyz foo"}
3edbfbe5 229 realclean: {FILES => '$(INST_ARCHAUTODIR)/*.xyz'}
005c1a0e 230 dist: {TARFLAGS=>'cvfF', COMPRESS=>'gzip', SUFFIX=>'gz', SHAR=>'shar -m'}
42793c05
TB
231 tool_autosplit: {MAXLEN => 8}
232END
233
3edbfbe5
TB
234sub help {print $Attrib_Help;}
235
42793c05
TB
236@MM_Sections_spec = (
237 'post_initialize' => {},
42793c05 238 'const_config' => {},
1aef975c 239 'constants' => {},
42793c05
TB
240 'const_loadlibs' => {},
241 'const_cccmd' => {},
242 'tool_autosplit' => {},
243 'tool_xsubpp' => {},
244 'tools_other' => {},
005c1a0e 245 'macro' => {},
42793c05 246 'post_constants' => {},
232e078e 247 'pasthru' => {},
42793c05
TB
248 'c_o' => {},
249 'xs_c' => {},
250 'xs_o' => {},
251 'top_targets' => {},
252 'linkext' => {},
1aef975c 253 'dlsyms' => {},
42793c05
TB
254 'dynamic' => {},
255 'dynamic_bs' => {},
256 'dynamic_lib' => {},
257 'static' => {},
258 'static_lib' => {},
259 'installpm' => {},
232e078e 260 'processPL' => {},
40000a8c 261 'installbin' => {},
42793c05
TB
262 'subdirs' => {},
263 'clean' => {},
264 'realclean' => {},
5d94fbed 265 'dist' => {},
42793c05
TB
266 'install' => {},
267 'force' => {},
268 'perldepend' => {},
269 'makefile' => {},
e50aee73
AD
270 'staticmake' => {}, # Sadly this defines more macros
271 'test' => {},
272 'postamble' => {}, # should always be last
42793c05
TB
273);
274%MM_Sections = @MM_Sections_spec; # looses section ordering
275@MM_Sections = grep(!ref, @MM_Sections_spec); # keeps order
276
277%Recognized_Att_Keys = %MM_Sections; # All sections are valid keys.
278foreach(split(/\n/,$Attrib_Help)){
279 chomp;
280 next unless m/^\s*(\w+):\s*(.*)/;
281 $Recognized_Att_Keys{$1} = $2;
282 print "Attribute '$1' => '$2'\n" if ($Verbose >= 2);
283}
284
285%att = ();
286%skip = ();
287
288sub skipcheck{
289 my($section) = @_;
1aef975c 290 if ($section eq 'dynamic') {
fed7345c 291 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets "
1aef975c
AD
292 . "in skipped section 'dynamic_bs'\n"
293 if $skip{'dynamic_bs'} && $Verbose;
fed7345c 294 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets "
1aef975c
AD
295 . "in skipped section 'dynamic_lib'\n"
296 if $skip{'dynamic_lib'} && $Verbose;
297 }
298 if ($section eq 'dynamic_lib') {
fed7345c 299 print STDOUT "Warning (non-fatal): Target '\$(INST_DYNAMIC)' depends on "
1aef975c
AD
300 . "targets in skipped section 'dynamic_bs'\n"
301 if $skip{'dynamic_bs'} && $Verbose;
302 }
303 if ($section eq 'static') {
fed7345c 304 print STDOUT "Warning (non-fatal): Target 'static' depends on targets "
1aef975c
AD
305 . "in skipped section 'static_lib'\n"
306 if $skip{'static_lib'} && $Verbose;
307 }
42793c05
TB
308 return 'skipped' if $skip{$section};
309 return '';
310}
311
312
313sub WriteMakefile {
a0d0e21e
LW
314 %att = @_;
315 local($\)="\n";
316
005c1a0e
AD
317 print STDOUT "MakeMaker (v$Version)" if $Verbose;
318
319 if ( Carp::longmess("") =~ "runsubdirpl" ){
320 $Correct_relativ_directories++;
321 } else {
322 $Correct_relativ_directories=0;
323 }
324
325 if (-f "MANIFEST"){
326 eval {require ExtUtils::Manifest};
327 if ($@){
328 print STDOUT "Warning: you have not installed the ExtUtils::Manifest
329 module -- skipping check of the MANIFEST file";
330 } else {
331 print STDOUT "Checking if your kit is complete...";
332 $ExtUtils::Manifest::Quiet=$ExtUtils::Manifest::Quiet=1; #avoid warning
333 my(@missed)=ExtUtils::Manifest::manicheck();
334 if (@missed){
335 print STDOUT "Warning: the following files are missing in your kit:";
336 print "\t", join "\n\t", @missed;
337 print STDOUT "Please inform the author.\n";
338 } else {
339 print STDOUT "Looks good";
340 }
341 }
342 }
a0d0e21e 343
42793c05
TB
344 parse_args(\%att, @ARGV);
345 my(%initial_att) = %att; # record initial attributes
5d94fbed
AD
346
347 check_hints();
348
232e078e 349 my($key);
a0d0e21e 350
75f92628 351 MY->init_main();
a0d0e21e 352
42793c05 353 print STDOUT "Writing Makefile for $att{NAME}";
a0d0e21e 354
005c1a0e
AD
355 if (! $att{PERL_SRC} &&
356 $INC{'Config.pm'} ne "$Config{'archlib'}/Config.pm"){
357 (my $pthinks = $INC{'Config.pm'}) =~ s!/Config\.pm$!!;
358 $pthinks =~ s!.*/!!;
359 print STDOUT <<END;
360Your perl and your Config.pm seem to have different ideas about the architecture
361they are running on.
362Perl thinks: $pthinks
363Config says: $Config{"archname"}
364This may or may not cause problems. Please check your installation of perl if you
365have problems building this extension.
366END
367 }
368
75f92628
AD
369 MY->init_dirscan();
370 MY->init_others();
371
42793c05
TB
372 unlink("Makefile", "MakeMaker.tmp", $Is_VMS ? 'Descrip.MMS' : '');
373 open MAKE, ">MakeMaker.tmp" or die "Unable to open MakeMaker.tmp: $!";
374 select MAKE; $|=1; select STDOUT;
a0d0e21e 375
42793c05 376 print MAKE "# This Makefile is for the $att{NAME} extension to perl.\n#";
75f92628 377 print MAKE "# It was generated automatically by MakeMaker version $Version from the contents";
42793c05
TB
378 print MAKE "# of Makefile.PL. Don't edit this file, edit Makefile.PL instead.";
379 print MAKE "#\n# ANY CHANGES MADE HERE WILL BE LOST! \n#";
380 print MAKE "# MakeMaker Parameters: ";
381 foreach $key (sort keys %initial_att){
382 my($v) = neatvalue($initial_att{$key});
383 $v =~ tr/\n/ /s;
384 print MAKE "# $key => $v";
385 }
a0d0e21e 386
42793c05
TB
387 # build hash for SKIP to make testing easy
388 %skip = map( ($_,1), @{$att{'SKIP'} || []});
389
232e078e 390 my $section;
42793c05
TB
391 foreach $section ( @MM_Sections ){
392 print "Processing Makefile '$section' section" if ($Verbose >= 2);
393 my($skipit) = skipcheck($section);
394 if ($skipit){
395 print MAKE "\n# --- MakeMaker $section section $skipit.";
396 } else {
397 my(%a) = %{$att{$section} || {}};
398 print MAKE "\n# --- MakeMaker $section section:";
5d94fbed 399 print MAKE "# ", join ", ", %a if $Verbose;
42793c05
TB
400 print(MAKE MY->nicetext(MY->$section( %a )));
401 }
402 }
a0d0e21e 403
42793c05
TB
404 if ($Verbose){
405 print MAKE "\n# Full list of MakeMaker attribute values:";
406 foreach $key (sort keys %att){
407 my($v) = neatvalue($att{$key});
408 $v =~ tr/\n/ /s;
409 print MAKE "# $key => $v";
410 }
411 }
a0d0e21e 412
42793c05 413 print MAKE "\n# End.";
a0d0e21e 414 close MAKE;
42793c05
TB
415 my($finalname) = $Is_VMS ? "Descrip.MMS" : "Makefile";
416 rename("MakeMaker.tmp", $finalname);
417
418 chmod 0644, $finalname;
419 system("$Config{'eunicefix'} $finalname") unless $Config{'eunicefix'} eq ":";
a0d0e21e
LW
420
421 1;
422}
423
005c1a0e
AD
424sub Version_check {
425 my($checkversion) = @_;
426 die "Your Makefile was built with ExtUtils::MakeMaker v $checkversion.
427Current Version is $Version. There have been considerable changes in the meantime.
428Please rerun 'perl Makefile.PL' to regenerate the Makefile.\n" if $checkversion < $Version_OK;
429 print STDOUT "Makefile built with ExtUtils::MakeMaker v $checkversion. Current Version is $Version." unless $checkversion == $Version;
a0d0e21e
LW
430}
431
1aef975c
AD
432sub mksymlists{
433 %att = @_;
434 parse_args(\%att, @ARGV);
435 MY->mksymlists(@_);
436}
a0d0e21e 437
005c1a0e
AD
438# The following mkbootstrap() is only for installations that are calling
439# the pre-4.1 mkbootstrap() from their old Makefiles. This MakeMaker
440# write Makefiles, that use ExtUtils::Mkbootstrap directly.
441sub mkbootstrap{
442 parse_args(\%att, @ARGV);
443 MY->init_main() unless defined $att{BASEEXT};
444 eval {require ExtUtils::Mkbootstrap};
445 if ($@){
446 # Very difficult to arrive here, I suppose
447 carp "Error: $@\nVersion mismatch: This MakeMaker (v$Version) needs the ExtUtils::Mkbootstrap package. Please check your installation.";
448 }
449 ExtUtils::Mkbootstrap::Mkbootstrap($att{BASEEXT},@_);
450}
451
42793c05
TB
452sub parse_args{
453 my($attr, @args) = @_;
454 foreach (@args){
75f92628
AD
455 unless (m/(.*?)=(.*)/){
456 help(),exit 1 if m/^help$/;
457 ++$Verbose if m/^verb/;
458 next;
459 }
460 my($name, $value) = ($1, $2);
461 if ($value =~ m/^~(\w+)?/){ # tilde with optional username
005c1a0e
AD
462 $value =~ s [^~(\w*)]
463 [$1 ?
464 ((getpwnam($1))[7] || "~$1") :
465 (getpwuid($>))[7]
466 ]ex;
467 }
468 if ($Correct_relativ_directories){
469 # This is experimental, so we don't care for efficiency
470 my @dirs = qw(INST_LIB INST_ARCHLIB INST_EXE);
471 my %dirs;
472 @dirs{@dirs}=@dirs;
473 if ($dirs{$name} && $value !~ m!^/!){ # a relativ directory
474 $value = "../$value";
475 }
75f92628 476 }
005c1a0e 477
75f92628 478 $$attr{$name} = $value;
42793c05
TB
479 }
480 # catch old-style 'potential_libs' and inform user how to 'upgrade'
481 if (defined $$attr{'potential_libs'}){
482 my($msg)="'potential_libs' => '$$attr{potential_libs}' should be";
483 if ($$attr{'potential_libs'}){
fed7345c 484 print STDOUT "$msg changed to:\n\t'LIBS' => ['$$attr{potential_libs}']\n";
42793c05 485 } else {
fed7345c 486 print STDOUT "$msg deleted.\n";
42793c05
TB
487 }
488 $$attr{LIBS} = [$$attr{'potential_libs'}];
489 delete $$attr{'potential_libs'};
490 }
491 # catch old-style 'ARMAYBE' and inform user how to 'upgrade'
492 if (defined $$attr{'ARMAYBE'}){
493 my($armaybe) = $$attr{'ARMAYBE'};
fed7345c 494 print STDOUT "ARMAYBE => '$armaybe' should be changed to:\n",
42793c05
TB
495 "\t'dynamic_lib' => {ARMAYBE => '$armaybe'}\n";
496 my(%dl) = %{$$attr{'dynamic_lib'} || {}};
497 $$attr{'dynamic_lib'} = { %dl, ARMAYBE => $armaybe};
498 delete $$attr{'ARMAYBE'};
499 }
75f92628 500 if (defined $$attr{'LDTARGET'}){
fed7345c 501 print STDOUT "LDTARGET should be changed to LDFROM\n";
75f92628
AD
502 $$attr{'LDFROM'} = $$attr{'LDTARGET'};
503 delete $$attr{'LDTARGET'};
504 }
42793c05
TB
505 foreach(sort keys %{$attr}){
506 print STDOUT " $_ => ".neatvalue($$attr{$_}) if ($Verbose);
fed7345c 507 print STDOUT "'$_' is not a known MakeMaker parameter name.\n"
42793c05
TB
508 unless exists $Recognized_Att_Keys{$_};
509 }
a0d0e21e
LW
510}
511
512
42793c05
TB
513sub neatvalue{
514 my($v) = @_;
fed7345c 515 return "undef" unless defined $v;
42793c05
TB
516 my($t) = ref $v;
517 return "'$v'" unless $t;
518 return "[ ".join(', ',map("'$_'",@$v))." ]" if ($t eq 'ARRAY');
519 return "$v" unless $t eq 'HASH';
520 my(@m, $key, $val);
521 push(@m,"$key=>".neatvalue($val)) while (($key,$val) = each %$v);
522 return "{ ".join(', ',@m)." }";
523}
524
42793c05 525# ------ Define the MakeMaker default methods in package MM_Unix ------
a0d0e21e 526
42793c05 527package MM_Unix;
a0d0e21e
LW
528
529use Config;
42793c05
TB
530use Cwd;
531use File::Basename;
a0d0e21e
LW
532require Exporter;
533
42793c05
TB
534Exporter::import('ExtUtils::MakeMaker',
535 qw(%att %skip %Recognized_Att_Keys $Verbose));
a0d0e21e 536
42793c05
TB
537# These attributes cannot be overridden externally
538@Other_Att_Keys{qw(EXTRALIBS BSLOADLIBS LDLOADLIBS)} = (1) x 3;
a0d0e21e 539
42793c05 540if ($Is_VMS = $Config{'osname'} eq 'VMS') {
748a9306
LW
541 require VMS::Filespec;
542 import VMS::Filespec 'vmsify';
a0d0e21e
LW
543}
544
545
75f92628 546sub init_main {
005c1a0e
AD
547 my($self) = @_;
548
42793c05
TB
549 # Find out directory name. This may contain the extension name.
550 my($pwd) = fastcwd(); # from Cwd.pm
005c1a0e
AD
551 # --- Initialize Module Name and Paths
552
553 # NAME = The perl module name for this extension (eg DBD::Oracle).
554 # FULLEXT = Pathname for extension directory (eg DBD/Oracle).
555 # BASEEXT = Basename part of FULLEXT. May be just equal FULLEXT.
556 # ROOTEXT = Directory part of FULLEXT with leading /.
557 unless($att{NAME}){ # we have to guess our name
558 my($name) = $pwd;
559 if ($Is_VMS) {
560 $name =~ s:.*?([^.\]]+)\]:$1: unless ($name =~ s:.*[.\[]ext\.(.*)\]:$1:i);
561 ($att{NAME}=$name) =~ s#[.\]]#::#g;
562 } else {
563 $name =~ s:.*/:: unless ($name =~ s:^.*/ext/::);
564 ($att{NAME} =$name) =~ s#/#::#g;
565 }
566 }
567 ($att{FULLEXT} =$att{NAME}) =~ s#::#/#g ; #eg. BSD/Foo/Socket
568 ($att{BASEEXT} =$att{NAME}) =~ s#.*::##; #eg. Socket
569 ($att{ROOTEXT} =$att{FULLEXT}) =~ s#/?\Q$att{BASEEXT}\E$## ; # eg. /BSD/Foo
570 $att{ROOTEXT} = ($Is_VMS ? '' : '/') . $att{ROOTEXT} if $att{ROOTEXT};
42793c05 571
005c1a0e
AD
572
573 # --- Initialize PERL_LIB, INST_LIB, PERL_SRC
574
575 # *Real* information: where did we get these two from? ...
576 my $inc_config_dir = dirname($INC{'Config.pm'});
577 my $inc_carp_dir = dirname($INC{'Carp.pm'});
578
579 # Typically PERL_* and INST_* will be identical but that need
580 # not be the case (e.g., installing into project libraries etc).
42793c05
TB
581
582 # Perl Macro: With source No source
583 # PERL_LIB ../../lib /usr/local/lib/perl5
584 # PERL_ARCHLIB ../../lib /usr/local/lib/perl5/sun4-sunos
e1666bf5 585 # PERL_SRC ../.. (undefined)
42793c05 586
005c1a0e
AD
587 # INST Macro: For standard for any other
588 # modules module
3edbfbe5
TB
589 # INST_LIB ../../lib ./blib
590 # INST_ARCHLIB ../../lib ./blib
42793c05
TB
591
592 unless ($att{PERL_SRC}){
005c1a0e
AD
593 foreach (qw(../.. ../../.. ../../../..)){
594 if ( -f "$_/config.sh"
595 && -f "$_/perl.h"
596 && -f "$_/lib/Exporter.pm") {
232e078e
AD
597 $att{PERL_SRC}=$_ ;
598 last;
599 }
a0d0e21e 600 }
a0d0e21e 601 }
42793c05 602 unless ($att{PERL_SRC}){
42793c05
TB
603 # we should also consider $ENV{PERL5LIB} here
604 $att{PERL_LIB} = $Config{'privlib'} unless $att{PERL_LIB};
605 $att{PERL_ARCHLIB} = $Config{'archlib'} unless $att{PERL_ARCHLIB};
e1666bf5 606 $att{PERL_INC} = "$att{PERL_ARCHLIB}/CORE"; # wild guess for now
005c1a0e
AD
607 die <<EOM unless (-f "$att{PERL_INC}/perl.h");
608Error: Unable to locate installed Perl libraries or Perl source code.
609
610It is recommended that you install perl in a standard location before
611building extensions. You can say:
612
613 $^X Makefile.PL PERL_SRC=/path/to/perl/source/directory
614
615if you have not yet installed perl but still want to build this
616extension now.
617EOM
618
619 print STDOUT "Using header files found in $att{PERL_INC}" if $Verbose && $self->needs_linking;
620
621 } else { # PERL_SRC is defined here...
622
42793c05
TB
623 $att{PERL_LIB} = "$att{PERL_SRC}/lib" unless $att{PERL_LIB};
624 $att{PERL_ARCHLIB} = $att{PERL_LIB};
e1666bf5 625 $att{PERL_INC} = $att{PERL_SRC};
232e078e
AD
626 # catch an situation that has occurred a few times in the past:
627 warn <<EOM unless -s "$att{PERL_SRC}/cflags";
628You cannot build extensions below the perl source tree after executing
629a 'make clean' in the perl source tree.
630
631To rebuild extensions distributed with the perl source you should
632simply Configure (to include those extensions) and then build perl as
633normal. After installing perl the source tree can be deleted. It is not
634needed for building extensions.
635
636It is recommended that you unpack and build additional extensions away
637from the perl source tree.
638EOM
42793c05
TB
639 }
640
641 # INST_LIB typically pre-set if building an extension after
642 # perl has been built and installed. Setting INST_LIB allows
005c1a0e 643 # you to build directly into, say $Config{'privlib'}.
3edbfbe5
TB
644 unless ($att{INST_LIB}){
645 if (defined $att{PERL_SRC}) {
005c1a0e
AD
646# require ExtUtils::Manifest;
647# my $file;
648 my $standard = 0;
649# my $mani = ExtUtils::Manifest::maniread("$att{PERL_SRC}/MANIFEST");
650# foreach $file (keys %$mani){
651# if ($file =~ m!^ext/\Q$att{FULLEXT}!){
652# $standard++;
653# last;
654# }
655# }
656
657#### Temporary solution for perl5.001f:
658$standard = 1;
659#### This is just the same as was MakeMaker 4.094, but everything's prepared to
660#### switch to a different behaviour after 5.001f
661
662 if ($standard){
663 $att{INST_LIB} = $att{PERL_LIB};
664 } else {
665 $att{INST_LIB} = "./blib";
666 print STDOUT <<END;
667Warning: The $att{NAME} extension will not be installed by 'make install' in the
668perl source directory. Please install it with 'make install' from the
669 $pwd
670directory.
671END
672 }
3edbfbe5 673 } else {
232e078e 674 $att{INST_LIB} = "./blib";
3edbfbe5
TB
675 }
676 }
42793c05
TB
677 # Try to work out what INST_ARCHLIB should be if not set:
678 unless ($att{INST_ARCHLIB}){
679 my(%archmap) = (
232e078e 680 "./blib" => "./blib", # our private build lib
42793c05
TB
681 $att{PERL_LIB} => $att{PERL_ARCHLIB},
682 $Config{'privlib'} => $Config{'archlib'},
42793c05
TB
683 $inc_carp_dir => $inc_config_dir,
684 );
685 $att{INST_ARCHLIB} = $archmap{$att{INST_LIB}};
75f92628
AD
686 unless($att{INST_ARCHLIB}){
687 # Oh dear, we'll have to default it and warn the user
688 my($archname) = $Config{'archname'};
689 if (-d "$att{INST_LIB}/$archname"){
690 $att{INST_ARCHLIB} = "$att{INST_LIB}/$archname";
fed7345c 691 print STDOUT "Defaulting INST_ARCHLIB to INST_LIB/$archname\n";
75f92628
AD
692 } else {
693 $att{INST_ARCHLIB} = $att{INST_LIB};
fed7345c 694 print STDOUT "Warning: Defaulting INST_ARCHLIB to INST_LIB ",
75f92628
AD
695 "(not architecture independent).\n";
696 }
697 }
42793c05 698 }
005c1a0e 699 $att{INST_EXE} = "./blib" unless $att{INST_EXE};
42793c05 700
005c1a0e
AD
701 if( $att{INSTALLPRIVLIB} && ! $att{INSTALLARCHLIB} ){
702 my($archname) = $Config{'archname'};
703 if (-d "$att{INSTALLPRIVLIB}/$archname"){
704 $att{INSTALLARCHLIB} = "$att{INSTALLPRIVLIB}/$archname";
705 print STDOUT "Defaulting INSTALLARCHLIB to INSTALLPRIVLIB/$archname\n";
42793c05 706 } else {
005c1a0e
AD
707 $att{INSTALLARCHLIB} = $att{INSTALLPRIVLIB};
708 print STDOUT "Warning: Defaulting INSTALLARCHLIB to INSTALLPRIVLIB ",
709 "(not architecture independent).\n";
42793c05
TB
710 }
711 }
005c1a0e
AD
712 $att{INSTALLPRIVLIB} ||= $Config{'installprivlib'};
713 $att{INSTALLARCHLIB} ||= $Config{'installarchlib'};
714 $att{INSTALLBIN} ||= $Config{'installbin'};
715
716 $att{MAP_TARGET} = "perl" unless $att{MAP_TARGET};
717 $att{LIBPERL_A} = $Is_VMS ? 'libperl.olb' : 'libperl.a'
718 unless $att{LIBPERL_A};
719
720 # make a few simple checks
721 warn "Warning: PERL_LIB ($att{PERL_LIB}) seems not to be a perl library directory
722 (Exporter.pm not found)"
723 unless (-f "$att{PERL_LIB}/Exporter.pm");
42793c05 724
fed7345c 725 ($att{DISTNAME}=$att{NAME}) =~ s#(::)#-#g unless $att{DISTNAME};
42793c05 726 $att{VERSION} = "0.1" unless $att{VERSION};
005c1a0e 727 ($att{VERSION_SYM} = $att{VERSION}) =~ s/\W/_/g;
42793c05
TB
728
729
730 # --- Initialize Perl Binary Locations
731
732 # Find Perl 5. The only contract here is that both 'PERL' and 'FULLPERL'
75f92628
AD
733 # will be working versions of perl 5. miniperl has priority over perl
734 # for PERL to ensure that $(PERL) is usable while building ./ext/*
005c1a0e
AD
735 $att{'PERL'} =
736 MY->find_perl(5.0, ['miniperl','perl','perl5',"perl$]" ],
737 [ grep defined $_, $att{PERL_SRC}, split(":", $ENV{PATH}),
738 $Config{'bin'} ], $Verbose )
739 unless ($att{'PERL'}); # don't check, if perl is executable, maybe they
740 # they have decided to supply switches with perl
a0d0e21e 741
42793c05
TB
742 # Define 'FULLPERL' to be a non-miniperl (used in test: target)
743 ($att{'FULLPERL'} = $att{'PERL'}) =~ s/miniperl/perl/
744 unless ($att{'FULLPERL'} && -x $att{'FULLPERL'});
a0d0e21e 745
42793c05 746 if ($Is_VMS) {
1aef975c
AD
747 $att{'PERL'} = 'MCR ' . vmsify($att{'PERL'});
748 $att{'FULLPERL'} = 'MCR ' . vmsify($att{'FULLPERL'});
42793c05 749 }
75f92628 750}
42793c05 751
42793c05 752
f06db76b 753sub init_dirscan { # --- File and Directory Lists (.xs .pm .pod etc)
75f92628 754
232e078e 755 my($name, %dir, %xs, %c, %h, %ignore, %pl_files);
75f92628
AD
756 local(%pm); #the sub in find() has to see this hash
757 $ignore{'test.pl'} = 1;
758 $ignore{'makefile.pl'} = 1 if $Is_VMS;
759 foreach $name (lsdir(".")){
760 next if ($name =~ /^\./ or $ignore{$name});
761 if (-d $name){
762 $dir{$name} = $name if (-f "$name/Makefile.PL");
763 } elsif ($name =~ /\.xs$/){
764 my($c); ($c = $name) =~ s/\.xs$/.c/;
765 $xs{$name} = $c;
766 $c{$c} = 1;
767 } elsif ($name =~ /\.c$/){
e50aee73
AD
768 $c{$name} = 1
769 unless $name =~ m/perlmain\.c/; # See MAP_TARGET
75f92628
AD
770 } elsif ($name =~ /\.h$/){
771 $h{$name} = 1;
f06db76b 772 } elsif ($name =~ /\.(p[ml]|pod)$/){
75f92628 773 $pm{$name} = "\$(INST_LIBDIR)/$name";
232e078e
AD
774 } elsif ($name =~ /\.PL$/ && $name ne "Makefile.PL") {
775 ($pl_files{$name} = $name) =~ s/\.PL$// ;
3edbfbe5 776 }
75f92628 777 }
3edbfbe5 778
75f92628
AD
779 # Some larger extensions often wish to install a number of *.pm/pl
780 # files into the library in various locations.
781
782 # The attribute PMLIBDIRS holds an array reference which lists
783 # subdirectories which we should search for library files to
784 # install. PMLIBDIRS defaults to [ 'lib', $att{BASEEXT} ].
785 # We recursively search through the named directories (skipping
786 # any which don't exist or contain Makefile.PL files).
787
788 # For each *.pm or *.pl file found MY->libscan() is called with
789 # the default installation path in $_. The return value of libscan
790 # defines the actual installation location.
791 # The default libscan function simply returns $_.
792 # The file is skipped if libscan returns false.
793
794 # The default installation location passed to libscan in $_ is:
795 #
796 # ./*.pm => $(INST_LIBDIR)/*.pm
797 # ./xyz/... => $(INST_LIBDIR)/xyz/...
798 # ./lib/... => $(INST_LIB)/...
799 #
800 # In this way the 'lib' directory is seen as the root of the actual
801 # perl library whereas the others are relative to INST_LIBDIR
802 # (which includes ROOTEXT). This is a subtle distinction but one
803 # that's important for nested modules.
804
805 $att{PMLIBDIRS} = [ 'lib', $att{BASEEXT} ] unless $att{PMLIBDIRS};
806
807 #only existing directories that aren't in $dir are allowed
808 @{$att{PMLIBDIRS}} = grep -d && !$dir{$_}, @{$att{PMLIBDIRS}};
809
810 if (@{$att{PMLIBDIRS}}){
811 print "Searching PMLIBDIRS: @{$att{PMLIBDIRS}}"
812 if ($Verbose >= 2);
813 use File::Find; # try changing to require !
814 File::Find::find(sub {
fed7345c
AD
815# We now allow any file in PMLIBDIRS to be installed. nTk needs that, and
816# we should allow it.
817# return unless m/\.p[ml]$/;
818 return if -d $_; # anything else that Can't be copied?
75f92628 819 my($path, $prefix) = ($File::Find::name, '$(INST_LIBDIR)');
40000a8c
AD
820 my $striplibpath;
821 $prefix = '$(INST_LIB)' if (($striplibpath = $path) =~ s:^lib/::);
822 local($_) = "$prefix/$striplibpath";
75f92628
AD
823 my($inst) = MY->libscan();
824 print "libscan($path) => '$inst'" if ($Verbose >= 2);
825 return unless $inst;
1aef975c 826 $pm{$path} = $inst;
75f92628 827 }, @{$att{PMLIBDIRS}});
42793c05
TB
828 }
829
75f92628
AD
830 $att{DIR} = [sort keys %dir] unless $att{DIRS};
831 $att{XS} = \%xs unless $att{XS};
832 $att{PM} = \%pm unless $att{PM};
833 $att{C} = [sort keys %c] unless $att{C};
1aef975c
AD
834 my(@o_files) = @{$att{C}};
835 my($sufx) = $Is_VMS ? '.obj' : '.o';
836 $att{O_FILES} = [grep s/\.c$/$sufx/, @o_files] ;
75f92628 837 $att{H} = [sort keys %h] unless $att{H};
232e078e 838 $att{PL_FILES} = \%pl_files unless $att{PL_FILES};
75f92628
AD
839}
840
841
842sub libscan {
005c1a0e 843 return '' if m:/RCS/: ; # return undef triggered warnings with $Verbose>=2
75f92628
AD
844 $_;
845}
846
75f92628 847sub init_others { # --- Initialize Other Attributes
232e078e 848 my($key);
42793c05 849 for $key (keys(%Recognized_Att_Keys), keys(%Other_Att_Keys)){
a0d0e21e 850 # avoid warnings for uninitialized vars
42793c05
TB
851 next if exists $att{$key};
852 $att{$key} = "";
a0d0e21e
LW
853 }
854
42793c05
TB
855 # Compute EXTRALIBS, BSLOADLIBS and LDLOADLIBS from $att{'LIBS'}
856 # Lets look at $att{LIBS} carefully: It may be an anon array, a string or
857 # undefined. In any case we turn it into an anon array:
858 $att{LIBS}=[] unless $att{LIBS};
859 $att{LIBS}=[$att{LIBS}] if ref \$att{LIBS} eq SCALAR;
005c1a0e 860 $att{LD_RUN_PATH} = "";
42793c05
TB
861 foreach ( @{$att{'LIBS'}} ){
862 s/^\s*(.*\S)\s*$/$1/; # remove leading and trailing whitespace
863 my(@libs) = MY->extliblist($_);
864 if ($libs[0] or $libs[1] or $libs[2]){
865 @att{EXTRALIBS, BSLOADLIBS, LDLOADLIBS} = @libs;
005c1a0e
AD
866 if ($libs[2]) {
867 $att{LD_RUN_PATH} = join(":",grep($_=~s/^-L//,split(" ", $libs[2])));
868 }
42793c05
TB
869 last;
870 }
871 }
a0d0e21e 872
fed7345c 873 print STDOUT "CONFIG must be an array ref\n"
42793c05
TB
874 if ($att{CONFIG} and ref $att{CONFIG} ne 'ARRAY');
875 $att{CONFIG} = [] unless (ref $att{CONFIG});
876 push(@{$att{CONFIG}},
005c1a0e
AD
877 qw(cc libc ldflags lddlflags ccdlflags cccdlflags
878 ranlib so dlext dlsrc
42793c05
TB
879 ));
880 push(@{$att{CONFIG}}, 'shellflags') if $Config{'shellflags'};
881
882 if ($Is_VMS) {
42793c05
TB
883 $att{OBJECT} = '$(BASEEXT).obj' unless $att{OBJECT};
884 $att{OBJECT} =~ s/[^,\s]\s+/, /g;
885 $att{OBJECT} =~ s/\n+/, /g;
1aef975c 886 $att{OBJECT} =~ s#\.o,#\.obj,#;
42793c05
TB
887 } else {
888 $att{OBJECT} = '$(BASEEXT).o' unless $att{OBJECT};
889 $att{OBJECT} =~ s/\n+/ \\\n\t/g;
a0d0e21e 890 }
42793c05 891 $att{BOOTDEP} = (-f "$att{BASEEXT}_BS") ? "$att{BASEEXT}_BS" : "";
e1666bf5 892 $att{LD} = ($Config{'ld'} || 'ld') unless $att{LD};
3edbfbe5 893 $att{LDFROM} = '$(OBJECT)' unless $att{LDFROM};
1aef975c
AD
894 # Sanity check: don't define LINKTYPE = dynamic if we're skipping
895 # the 'dynamic' section of MM. We don't have this problem with
896 # 'static', since we either must use it (%Config says we can't
897 # use dynamic loading) or the caller asked for it explicitly.
898 if (!$att{LINKTYPE}) {
899 $att{LINKTYPE} = grep(/dynamic/,@{$att{SKIP} || []})
900 ? 'static'
901 : ($Config{'usedl'} ? 'dynamic' : 'static');
902 };
42793c05 903
3edbfbe5
TB
904 # These get overridden for VMS and maybe some other systems
905 $att{NOOP} = "";
1aef975c 906 $att{MAKEFILE} = "Makefile";
3edbfbe5
TB
907 $att{RM_F} = "rm -f";
908 $att{RM_RF} = "rm -rf";
909 $att{TOUCH} = "touch";
910 $att{CP} = "cp";
75f92628 911 $att{MV} = "mv";
005c1a0e 912 $att{CHMOD} = "chmod";
a0d0e21e
LW
913}
914
915
42793c05 916sub lsdir{
3edbfbe5 917 my($dir, $regex) = @_;
42793c05
TB
918 local(*DIR, @ls);
919 opendir(DIR, $_[0] || ".") or die "opendir: $!";
920 @ls = readdir(DIR);
921 closedir(DIR);
3edbfbe5 922 @ls = grep(/$regex/, @ls) if $regex;
42793c05
TB
923 @ls;
924}
925
926
927sub find_perl{
928 my($self, $ver, $names, $dirs, $trace) = @_;
929 my($name, $dir);
5d94fbed 930 if ($trace >= 2){
fed7345c
AD
931 print "Looking for perl $ver by these names: ";
932 print "@$names, ";
933 print "in these dirs:";
934 print "@$dirs";
935 }
42793c05 936 foreach $dir (@$dirs){
3edbfbe5 937 next unless defined $dir; # $att{PERL_SRC} may be undefined
42793c05 938 foreach $name (@$names){
748a9306 939 print "Checking $dir/$name " if ($trace >= 2);
42793c05
TB
940 if ($Is_VMS) {
941 $name .= ".exe" unless -x "$dir/$name";
942 }
943 next unless -x "$dir/$name";
5d94fbed 944 print "Executing $dir/$name" if ($trace >= 2);
42793c05
TB
945 my($out);
946 if ($Is_VMS) {
947 my($vmscmd) = 'MCR ' . vmsify("$dir/$name");
948 $out = `$vmscmd -e "require $ver; print ""VER_OK\n"""`;
949 } else {
950 $out = `$dir/$name -e 'require $ver; print "VER_OK\n" ' 2>&1`;
951 }
5d94fbed 952 if ($out =~ /VER_OK/) {
005c1a0e 953 print "Using PERL=$dir/$name" if $trace;
5d94fbed
AD
954 return "$dir/$name";
955 }
a0d0e21e
LW
956 }
957 }
fed7345c 958 print STDOUT "Unable to find a perl $ver (by these names: @$names, in these dirs: @$dirs)\n";
42793c05 959 0; # false and not empty
a0d0e21e
LW
960}
961
962
963sub post_initialize{
964 "";
965}
fed7345c 966
005c1a0e
AD
967sub needs_linking { # Does this module need linking?
968 return 1 if $att{OBJECT} or @{$att{C} || []} or $att{MYEXTLIB};
969 return 0;
970}
a0d0e21e
LW
971
972sub constants {
005c1a0e 973 my($self) = @_;
a0d0e21e
LW
974 my(@m);
975
a0d0e21e 976 push @m, "
42793c05 977NAME = $att{NAME}
a0d0e21e
LW
978DISTNAME = $att{DISTNAME}
979VERSION = $att{VERSION}
005c1a0e 980VERSION_SYM = $att{VERSION_SYM}
a0d0e21e 981
005c1a0e
AD
982# In which directory should we put this extension during 'make'?
983# This is typically ./blib.
42793c05
TB
984# (also see INST_LIBDIR and relationship to ROOTEXT)
985INST_LIB = $att{INST_LIB}
986INST_ARCHLIB = $att{INST_ARCHLIB}
40000a8c 987INST_EXE = $att{INST_EXE}
42793c05 988
005c1a0e
AD
989# AFS users will want to set the installation directories for
990# the final 'make install' early without setting INST_LIB,
991# INST_ARCHLIB, and INST_EXE for the testing phase
992INSTALLPRIVLIB = $att{INSTALLPRIVLIB}
993INSTALLARCHLIB = $att{INSTALLARCHLIB}
994INSTALLBIN = $att{INSTALLBIN}
995
42793c05
TB
996# Perl library to use when building the extension
997PERL_LIB = $att{PERL_LIB}
998PERL_ARCHLIB = $att{PERL_ARCHLIB}
40000a8c 999LIBPERL_A = $att{LIBPERL_A}
005c1a0e
AD
1000
1001MAKEMAKER = \$(PERL_LIB)/ExtUtils/MakeMaker.pm
1002MM_VERSION = $ExtUtils::MakeMaker::Version
75f92628 1003";
42793c05 1004
75f92628
AD
1005 # Define I_PERL_LIBS to include the required -Ipaths
1006 # To be cute we only include PERL_ARCHLIB if different
005c1a0e
AD
1007
1008 #### Deprecated from Version 4.11: We want to avoid different
1009 #### behavior for variables with make(1) and perl(1)
1010
75f92628
AD
1011 # To be portable we add quotes for VMS
1012 my(@i_perl_libs) = qw{-I$(PERL_ARCHLIB) -I$(PERL_LIB)};
1013 shift(@i_perl_libs) if ($att{PERL_ARCHLIB} eq $att{PERL_LIB});
1014 if ($Is_VMS){
1015 push @m, "I_PERL_LIBS = \"".join('" "',@i_perl_libs)."\"\n";
1016 } else {
1017 push @m, "I_PERL_LIBS = ".join(' ',@i_perl_libs)."\n";
1018 }
1019
1020 push @m, "
fed7345c
AD
1021# Where is the perl source code located?
1022PERL_SRC = $att{PERL_SRC}\n" if $att{PERL_SRC};
1023
1024 push @m, "
42793c05 1025# Perl header files (will eventually be under PERL_LIB)
e1666bf5 1026PERL_INC = $att{PERL_INC}
42793c05
TB
1027# Perl binaries
1028PERL = $att{'PERL'}
1029FULLPERL = $att{'FULLPERL'}
75f92628
AD
1030";
1031 push @m, "
42793c05
TB
1032# FULLEXT = Pathname for extension directory (eg DBD/Oracle).
1033# BASEEXT = Basename part of FULLEXT. May be just equal FULLEXT.
1034# ROOTEXT = Directory part of FULLEXT with leading slash (eg /DBD)
1035FULLEXT = $att{FULLEXT}
1036BASEEXT = $att{BASEEXT}
1037ROOTEXT = $att{ROOTEXT}
75f92628
AD
1038";
1039 push @m, "
a0d0e21e
LW
1040INC = $att{INC}
1041DEFINE = $att{DEFINE}
1042OBJECT = $att{OBJECT}
3edbfbe5 1043LDFROM = $att{LDFROM}
a0d0e21e 1044LINKTYPE = $att{LINKTYPE}
a0d0e21e 1045
75f92628
AD
1046# Handy lists of source code files:
1047XS_FILES= ".join(" \\\n\t", sort keys %{$att{XS}})."
1048C_FILES = ".join(" \\\n\t", @{$att{C}})."
1aef975c 1049O_FILES = ".join(" \\\n\t", @{$att{O_FILES}})."
75f92628 1050H_FILES = ".join(" \\\n\t", @{$att{H}})."
a0d0e21e 1051
42793c05 1052.SUFFIXES: .xs
a0d0e21e 1053
42793c05
TB
1054.PRECIOUS: Makefile
1055
005c1a0e
AD
1056.NO_PARALLEL:
1057
75f92628 1058.PHONY: all config static dynamic test linkext
42793c05
TB
1059
1060# This extension may link to it's own library (see SDBM_File)
1061MYEXTLIB = $att{MYEXTLIB}
1062
75f92628
AD
1063# Where is the Config information that we are using/depend on
1064CONFIGDEP = \$(PERL_ARCHLIB)/Config.pm \$(PERL_INC)/config.h
a0d0e21e
LW
1065";
1066
1067 push @m, '
1068# Where to put things:
42793c05
TB
1069INST_LIBDIR = $(INST_LIB)$(ROOTEXT)
1070INST_ARCHLIBDIR = $(INST_ARCHLIB)$(ROOTEXT)
1071
3edbfbe5
TB
1072INST_AUTODIR = $(INST_LIB)/auto/$(FULLEXT)
1073INST_ARCHAUTODIR = $(INST_ARCHLIB)/auto/$(FULLEXT)
1074';
42793c05 1075
005c1a0e
AD
1076 if ($self->needs_linking) {
1077 push @m, '
75f92628 1078INST_STATIC = $(INST_ARCHAUTODIR)/$(BASEEXT).a
42793c05 1079INST_DYNAMIC = $(INST_ARCHAUTODIR)/$(BASEEXT).$(DLEXT)
75f92628 1080INST_BOOT = $(INST_ARCHAUTODIR)/$(BASEEXT).bs
005c1a0e
AD
1081';
1082 } else {
1083 push @m, '
1084INST_STATIC =
1085INST_DYNAMIC =
1086INST_BOOT =
1087';
1088 }
1089
1090 push @m, '
42793c05
TB
1091INST_PM = '.join(" \\\n\t", sort values %{$att{PM}}).'
1092';
1093
1094 join('',@m);
1095}
1096
232e078e 1097$Const_cccmd=0; # package global
42793c05
TB
1098
1099sub const_cccmd{
40000a8c
AD
1100 my($self,$libperl)=@_;
1101 $libperl or $libperl = $att{LIBPERL_A} || "libperl.a" ;
75f92628
AD
1102 # This is implemented in the same manner as extliblist,
1103 # e.g., do both and compare results during the transition period.
1104 my($cc,$ccflags,$optimize,$large,$split, $shflags)
1105 = @Config{qw(cc ccflags optimize large split shellflags)};
232e078e
AD
1106 my($optdebug)="";
1107
75f92628 1108 $shflags = '' unless $shflags;
40000a8c 1109 my($prog, $old, $uc, $perltype);
75f92628 1110
232e078e
AD
1111 unless ($Const_cccmd++){
1112 chop($old = `cd $att{PERL_SRC}; sh $shflags ./cflags $libperl $att{BASEEXT}.c`)
1113 if $att{PERL_SRC};
1114 $Const_cccmd++; # shut up typo warning
1115 }
e1666bf5 1116
40000a8c
AD
1117 my(%map) = (
1118 D => '-DDEBUGGING',
1119 E => '-DEMBED',
1120 DE => '-DDEBUGGING -DEMBED',
1121 M => '-DEMBED -DMULTIPLICITY',
1122 DM => '-DDEBUGGING -DEMBED -DMULTIPLICITY',
1123 );
1124
1125 if ($libperl =~ /libperl(\w*)\.a/){
1126 $uc = uc($1);
1127 } else {
1128 $uc = ""; # avoid warning
1129 }
1130 $perltype = $map{$uc} ? $map{$uc} : "";
1131
1132 if ($uc =~ /^D/) {
1133 $optdebug = "-g";
1134 }
1135
1136
1aef975c
AD
1137 my($name);
1138 ( $name = $att{NAME} . "_cflags" ) =~ s/:/_/g ;
1139 if ($prog = $Config{$name}) {
75f92628 1140 # Expand hints for this extension via the shell
fed7345c 1141 print STDOUT "Processing $name hint:\n" if $Verbose;
75f92628
AD
1142 my(@o)=`cc=\"$cc\"
1143 ccflags=\"$ccflags\"
1144 optimize=\"$optimize\"
40000a8c
AD
1145 perltype=\"$perltype\"
1146 optdebug=\"$optdebug\"
75f92628
AD
1147 large=\"$large\"
1148 split=\"$split\"
1149 eval '$prog'
1150 echo cc=\$cc
1151 echo ccflags=\$ccflags
1152 echo optimize=\$optimize
40000a8c
AD
1153 echo perltype=\$perltype
1154 echo optdebug=\$optdebug
75f92628
AD
1155 echo large=\$large
1156 echo split=\$split
1157 `;
232e078e 1158 my(%cflags,$line);
75f92628
AD
1159 foreach $line (@o){
1160 chomp $line;
1161 if ($line =~ /(.*?)=\s*(.*)\s*$/){
1162 $cflags{$1} = $2;
fed7345c 1163 print STDOUT " $1 = $2" if $Verbose;
75f92628 1164 } else {
fed7345c 1165 print STDOUT "Unrecognised result from hint: '$line'\n";
75f92628
AD
1166 }
1167 }
40000a8c
AD
1168 ( $cc,$ccflags,$perltype,$optdebug,$optimize,$large,$split )=@cflags{
1169 qw( cc ccflags perltype optdebug optimize large split)};
1170 }
1171
1172 if ($optdebug) {
1173 $optimize = $optdebug;
75f92628
AD
1174 }
1175
40000a8c 1176 my($new) = "$cc -c $ccflags $optimize $perltype $large $split";
005c1a0e
AD
1177 $new =~ s/^\s+//; $new =~ s/\s+/ /g; $new =~ s/\s+$//;
1178 if (defined($old)){
1179 $old =~ s/^\s+//; $old =~ s/\s+/ /g; $old =~ s/\s+$//;
1180 if ($new ne $old) {
1181 print STDOUT "Warning (non-fatal): cflags evaluation in "
1182 ."MakeMaker ($ExtUtils::MakeMaker::Version) "
1183 ."differs from shell output\n"
1184 ." package: $att{NAME}\n"
1185 ." old: $old\n"
1186 ." new: $new\n"
1187 ." Using 'old' set.\n"
1188 . Config::myconfig()
1189 ."\nPlease send these details to perl5-porters\@nicoh.com\n";
1190 }
42793c05 1191 }
75f92628 1192 my($cccmd)=($old) ? $old : $new;
f0b7e567 1193 $cccmd =~ s/^\s*\Q$Config{'cc'}\E\s/\$(CC) /;
75f92628 1194 "CCCMD = $cccmd\n";
42793c05
TB
1195}
1196
1197
1198# --- Constants Sections ---
1199
1200sub const_config{
1201 my(@m,$m);
1202 push(@m,"\n# These definitions are from config.sh (via $INC{'Config.pm'})\n");
1203 my(%once_only);
1204 foreach $m (@{$att{'CONFIG'}}){
1205 next if $once_only{$m};
fed7345c 1206 print STDOUT "CONFIG key '$m' does not exist in Config.pm\n"
42793c05
TB
1207 unless exists $Config{$m};
1208 push @m, "\U$m\E = $Config{$m}\n";
1209 $once_only{$m} = 1;
1210 }
1211 join('', @m);
1212}
1213
1214
1215sub const_loadlibs{
1216 "
1217# $att{NAME} might depend on some other libraries:
1218# (These comments may need revising:)
1219#
1220# Dependent libraries can be linked in one of three ways:
1221#
1222# 1. (For static extensions) by the ld command when the perl binary
1223# is linked with the extension library. See EXTRALIBS below.
1224#
1225# 2. (For dynamic extensions) by the ld command when the shared
1226# object is built/linked. See LDLOADLIBS below.
1227#
1228# 3. (For dynamic extensions) by the DynaLoader when the shared
1229# object is loaded. See BSLOADLIBS below.
1230#
1231# EXTRALIBS = List of libraries that need to be linked with when
1232# linking a perl binary which includes this extension
1233# Only those libraries that actually exist are included.
1234# These are written to a file and used when linking perl.
1235#
1236# LDLOADLIBS = List of those libraries which can or must be linked into
1237# the shared library when created using ld. These may be
1238# static or dynamic libraries.
005c1a0e
AD
1239# LD_RUN_PATH is a colon separated list of the directories
1240# in LDLOADLIBS. It is passed as an environment variable to
1241# the process that links the shared library.
42793c05
TB
1242#
1243# BSLOADLIBS = List of those libraries that are needed but can be
1244# linked in dynamically at run time on this platform.
1245# SunOS/Solaris does not need this because ld records
1246# the information (from LDLOADLIBS) into the object file.
1247# This list is used to create a .bs (bootstrap) file.
42793c05
TB
1248#
1249EXTRALIBS = $att{'EXTRALIBS'}
1250LDLOADLIBS = $att{'LDLOADLIBS'}
1251BSLOADLIBS = $att{'BSLOADLIBS'}
005c1a0e 1252LD_RUN_PATH= $att{'LD_RUN_PATH'}
a0d0e21e 1253";
42793c05 1254}
a0d0e21e 1255
a0d0e21e 1256
42793c05 1257# --- Tool Sections ---
a0d0e21e 1258
42793c05
TB
1259sub tool_autosplit{
1260 my($self, %attribs) = @_;
1261 my($asl) = "";
1262 $asl = "\$AutoSplit::Maxlen=$attribs{MAXLEN};" if $attribs{MAXLEN};
1263 q{
42793c05 1264# Usage: $(AUTOSPLITFILE) FileToSplit AutoDirToSplitInto
005c1a0e 1265AUTOSPLITFILE = $(PERL) "-I$(PERL_ARCHLIB)" "-I$(PERL_LIB)" -e 'use AutoSplit;}.$asl.q{autosplit($$ARGV[0], $$ARGV[1], 0, 1, 1) ;'
42793c05
TB
1266};
1267}
a0d0e21e 1268
a0d0e21e 1269
42793c05 1270sub tool_xsubpp{
e1666bf5
TB
1271 my($xsdir) = '$(PERL_LIB)/ExtUtils';
1272 # drop back to old location if xsubpp is not in new location yet
1273 $xsdir = '$(PERL_SRC)/ext' unless (-f "$att{PERL_LIB}/ExtUtils/xsubpp");
1274 my(@tmdeps) = ('$(XSUBPPDIR)/typemap');
42793c05
TB
1275 push(@tmdeps, "typemap") if -f "typemap";
1276 my(@tmargs) = map("-typemap $_", @tmdeps);
1277 "
e1666bf5
TB
1278XSUBPPDIR = $xsdir
1279XSUBPP = \$(XSUBPPDIR)/xsubpp
42793c05
TB
1280XSUBPPDEPS = @tmdeps
1281XSUBPPARGS = @tmargs
1282";
1283};
a0d0e21e 1284
a0d0e21e 1285
42793c05 1286sub tools_other{
e1666bf5 1287 "
42793c05 1288SHELL = /bin/sh
e1666bf5 1289LD = $att{LD}
3edbfbe5
TB
1290TOUCH = $att{TOUCH}
1291CP = $att{CP}
75f92628 1292MV = $att{MV}
3edbfbe5
TB
1293RM_F = $att{RM_F}
1294RM_RF = $att{RM_RF}
005c1a0e 1295CHMOD = $att{CHMOD}
e1666bf5 1296".q{
42793c05 1297# The following is a portable way to say mkdir -p
75f92628 1298MKPATH = $(PERL) -wle '$$"="/"; foreach $$p (@ARGV){ next if -d $$p; my(@p); foreach(split(/\//,$$p)){ push(@p,$$_); next if -d "@p/"; print "mkdir @p"; mkdir("@p",0777)||die $$! }} exit 0;'
42793c05 1299};
a0d0e21e
LW
1300}
1301
1302
1303sub post_constants{
1304 "";
1305}
1306
005c1a0e
AD
1307sub macro {
1308 my($self,%attribs) = @_;
1309 my(@m,$key,$val);
1310 while (($key,$val) = each %attribs){
1311 push @m, "$key = $val\n";
1312 }
1313 join "", @m;
1314}
1315
232e078e 1316sub pasthru {
005c1a0e
AD
1317 my(@m,$key);
1318 # It has to be considered carefully, which variables are apt
1319 # to be passed through, e.g. ALL RELATIV DIRECTORIES are
1320 # not suited for PASTHRU to subdirectories.
1321 # Moreover: No directories at all have a chance, because we
1322 # don't know yet, if the directories are absolute or relativ
1323
1324 # PASTHRU2 is a conservative approach, that hardly changed
232e078e 1325 # MakeMaker between version 4.086 and 4.09.
005c1a0e
AD
1326
1327 # PASTHRU1 is a revolutionary approach :), it cares for having
1328 # a prepended "../" whenever runsubdirpl is called, but only
1329 # for the three crucial INST_* directories.
1330
1331 my(@pasthru1,@pasthru2); # 1 for runsubdirpl, 2 for the rest
1332
1333 foreach $key (qw(INST_LIB INST_ARCHLIB INST_EXE)){
1334 push @pasthru1, "$key=\"\$($key)\"";
1335 }
1336
1337 foreach $key (qw(INSTALLPRIVLIB INSTALLARCHLIB INSTALLBIN LIBPERL_A LINKTYPE)){
1338 push @pasthru1, "$key=\"\$($key)\"";
1339 push @pasthru2, "$key=\"\$($key)\"";
232e078e 1340 }
005c1a0e
AD
1341
1342 push @m, "\nPASTHRU1 = ", join ("\\\n\t", @pasthru1), "\n";
1343 push @m, "\nPASTHRU2 = ", join ("\\\n\t", @pasthru2), "\n";
232e078e
AD
1344 join "", @m;
1345}
a0d0e21e 1346
42793c05 1347# --- Translation Sections ---
a0d0e21e 1348
42793c05 1349sub c_o {
40000a8c 1350 my(@m);
fed7345c 1351 push @m, '
42793c05
TB
1352.c.o:
1353 $(CCCMD) $(CCCDLFLAGS) -I$(PERL_INC) $(DEFINE) $(INC) $*.c
1354';
fed7345c 1355 join "", @m;
a0d0e21e
LW
1356}
1357
42793c05
TB
1358sub xs_c {
1359 '
1360.xs.c:
005c1a0e 1361 $(PERL) -I$(PERL_ARCHLIB) -I$(PERL_LIB) $(XSUBPP) $(XSUBPPARGS) $*.xs >$*.tc && mv $*.tc $@
42793c05
TB
1362';
1363}
a0d0e21e 1364
42793c05 1365sub xs_o { # many makes are too dumb to use xs_c then c_o
a0d0e21e 1366 '
42793c05 1367.xs.o:
005c1a0e 1368 $(PERL) -I$(PERL_ARCHLIB) -I$(PERL_LIB) $(XSUBPP) $(XSUBPPARGS) $*.xs >xstmp.c && mv xstmp.c $*.c
42793c05 1369 $(CCCMD) $(CCCDLFLAGS) -I$(PERL_INC) $(DEFINE) $(INC) $*.c
a0d0e21e
LW
1370';
1371}
1372
1373
42793c05
TB
1374# --- Target Sections ---
1375
1376sub top_targets{
40000a8c 1377 my(@m);
fed7345c 1378 push @m, '
42793c05 1379all :: config linkext $(INST_PM)
3edbfbe5 1380'.$att{NOOP}.'
42793c05 1381
005c1a0e 1382config :: '.$att{MAKEFILE}.' $(INST_LIBDIR)/.exists $(INST_ARCHAUTODIR)/.exists Version_check
a0d0e21e 1383';
fed7345c 1384
005c1a0e 1385 push @m, MM->dir_target('$(INST_LIBDIR)', '$(INST_ARCHAUTODIR)', '$(INST_EXE)');
232e078e 1386
fed7345c
AD
1387 push @m, '
1388$(O_FILES): $(H_FILES)
1389' if @{$att{O_FILES} || []} && @{$att{H} || []};
005c1a0e
AD
1390
1391 push @m, q{
1392help:
1393 $(PERL) -I$(PERL_LIB) -e 'use ExtUtils::MakeMaker "&help"; &help;'
1394};
1395
1396 push @m, q{
1397Version_check:
1398 @$(PERL) -I$(PERL_LIB) -e 'use ExtUtils::MakeMaker qw($$Version &Version_check);' \
1399 -e '&Version_check($(MM_VERSION))'
1400};
1401
fed7345c 1402 join('',@m);
a0d0e21e
LW
1403}
1404
42793c05
TB
1405sub linkext {
1406 my($self, %attribs) = @_;
005c1a0e
AD
1407 # LINKTYPE => static or dynamic or ''
1408 my($linktype) = defined $attribs{LINKTYPE} ?
1409 $attribs{LINKTYPE} : '$(LINKTYPE)';
42793c05
TB
1410 "
1411linkext :: $linktype
3edbfbe5 1412$att{NOOP}
42793c05
TB
1413";
1414}
1415
1aef975c
AD
1416sub dlsyms {
1417 my($self,%attribs) = @_;
1418
40000a8c 1419 return '' if ($Config{'osname'} ne 'aix');
1aef975c
AD
1420
1421 my($funcs) = $attribs{DL_FUNCS} || $att{DL_FUNCS} || {};
1422 my($vars) = $attribs{DL_VARS} || $att{DL_VARS} || [];
1423 my(@m);
1424
1425 push(@m,"
1426dynamic :: $att{BASEEXT}.exp
1427
1428") unless $skip{'dynamic'};
1429
1430 push(@m,"
1431static :: $att{BASEEXT}.exp
1432
1433") unless $skip{'static'};
1434
1435 push(@m,"
1436$att{BASEEXT}.exp: Makefile.PL
005c1a0e 1437",' $(PERL) "-I$(PERL_ARCHLIB)" "-I$(PERL_LIB)" -e \'use ExtUtils::MakeMaker qw(&mksymlists); \\
232e078e 1438 &mksymlists(DL_FUNCS => ',
40000a8c 1439 %$funcs ? neatvalue($funcs) : '""',', DL_VARS => ',
fec02dd3 1440 @$vars ? neatvalue($vars) : '""', ", NAME => \"$att{NAME}\")'
fed7345c 1441");
1aef975c
AD
1442
1443 join('',@m);
1444}
42793c05
TB
1445
1446# --- Dynamic Loading Sections ---
a0d0e21e
LW
1447
1448sub dynamic {
1449 '
42793c05
TB
1450# $(INST_PM) has been moved to the all: target.
1451# It remains here for awhile to allow for old usage: "make dynamic"
1aef975c 1452dynamic :: '.$att{MAKEFILE}.' $(INST_DYNAMIC) $(INST_BOOT) $(INST_PM)
3edbfbe5 1453'.$att{NOOP}.'
42793c05
TB
1454';
1455}
a0d0e21e 1456
42793c05
TB
1457sub dynamic_bs {
1458 my($self, %attribs) = @_;
005c1a0e 1459 return '' unless $self->needs_linking;
42793c05
TB
1460 '
1461BOOTSTRAP = '."$att{BASEEXT}.bs".'
a0d0e21e 1462
005c1a0e 1463# As Mkbootstrap might not write a file (if none is required)
42793c05
TB
1464# we use touch to prevent make continually trying to remake it.
1465# The DynaLoader only reads a non-empty file.
1aef975c 1466$(BOOTSTRAP): '."$att{MAKEFILE} $att{BOOTDEP}".'
005c1a0e
AD
1467 @ echo "Running Mkbootstrap for $(NAME) ($(BSLOADLIBS))"
1468 @ $(PERL) "-I$(PERL_ARCHLIB)" "-I$(PERL_LIB)" \
1469 -e \'use ExtUtils::Mkbootstrap;\' \
1470 -e \'Mkbootstrap("$(BASEEXT)","$(BSLOADLIBS)");\'
fed7345c 1471 @ $(TOUCH) $(BOOTSTRAP)
005c1a0e
AD
1472 $(CHMOD) 644 $@
1473 @echo $@ >> $(INST_ARCHAUTODIR)/.packlist
a0d0e21e
LW
1474
1475$(INST_BOOT): $(BOOTSTRAP)
fed7345c 1476 @ '.$att{RM_RF}.' $(INST_BOOT)
40000a8c 1477 -'.$att{CP}.' $(BOOTSTRAP) $(INST_BOOT)
005c1a0e
AD
1478 $(CHMOD) 644 $@
1479 @echo $@ >> $(INST_ARCHAUTODIR)/.packlist
a0d0e21e
LW
1480';
1481}
1482
75f92628 1483
42793c05
TB
1484sub dynamic_lib {
1485 my($self, %attribs) = @_;
1486 my($otherldflags) = $attribs{OTHERLDFLAGS} || "";
1487 my($armaybe) = $attribs{ARMAYBE} || $att{ARMAYBE} || ":";
3edbfbe5 1488 my($ldfrom) = '$(LDFROM)';
005c1a0e 1489 return '' unless $self->needs_linking;
75f92628
AD
1490 my($osname) = $Config{'osname'};
1491 $armaybe = 'ar' if ($osname eq 'dec_osf' and $armaybe eq ':');
3edbfbe5
TB
1492 my(@m);
1493 push(@m,'
75f92628
AD
1494# This section creates the dynamically loadable $(INST_DYNAMIC)
1495# from $(OBJECT) and possibly $(MYEXTLIB).
42793c05
TB
1496ARMAYBE = '.$armaybe.'
1497OTHERLDFLAGS = '.$otherldflags.'
a0d0e21e 1498
232e078e 1499$(INST_DYNAMIC): $(OBJECT) $(MYEXTLIB) $(BOOTSTRAP) $(INST_ARCHAUTODIR)/.exists
3edbfbe5
TB
1500');
1501 if ($armaybe ne ':'){
1502 $ldfrom = "tmp.a";
1503 push(@m,' $(ARMAYBE) cr '.$ldfrom.' $(OBJECT)'."\n");
1504 push(@m,' $(RANLIB) '."$ldfrom\n");
1505 }
75f92628 1506 $ldfrom = "-all $ldfrom -none" if ($osname eq 'dec_osf');
005c1a0e
AD
1507 push(@m,' LD_RUN_PATH="$(LD_RUN_PATH)" $(LD) -o $@ $(LDDLFLAGS) '.$ldfrom.
1508 ' $(OTHERLDFLAGS) $(MYEXTLIB) $(LDLOADLIBS)');
1509 push @m, '
1510 $(CHMOD) 755 $@
1511 @echo $@ >> $(INST_ARCHAUTODIR)/.packlist
1512';
232e078e
AD
1513
1514 push @m, MM->dir_target('$(INST_ARCHAUTODIR)');
3edbfbe5 1515 join('',@m);
a0d0e21e
LW
1516}
1517
1518
42793c05
TB
1519# --- Static Loading Sections ---
1520
1521sub static {
a0d0e21e 1522 '
42793c05
TB
1523# $(INST_PM) has been moved to the all: target.
1524# It remains here for awhile to allow for old usage: "make static"
fed7345c 1525static :: '.$att{MAKEFILE}.' $(INST_STATIC) $(INST_PM)
3edbfbe5 1526'.$att{NOOP}.'
a0d0e21e
LW
1527';
1528}
1529
42793c05 1530sub static_lib{
005c1a0e
AD
1531 my($self) = @_;
1532 return '' unless $self->needs_linking;
42793c05
TB
1533 my(@m);
1534 push(@m, <<'END');
232e078e 1535$(INST_STATIC): $(OBJECT) $(MYEXTLIB) $(INST_ARCHAUTODIR)/.exists
42793c05
TB
1536END
1537 # If this extension has it's own library (eg SDBM_File)
1538 # then copy that to $(INST_STATIC) and add $(OBJECT) into it.
3edbfbe5 1539 push(@m, " $att{CP} \$(MYEXTLIB) \$\@\n") if $att{MYEXTLIB};
42793c05
TB
1540
1541 push(@m, <<'END');
1542 ar cr $@ $(OBJECT) && $(RANLIB) $@
75f92628 1543 @echo "$(EXTRALIBS)" > $(INST_ARCHAUTODIR)/extralibs.ld
005c1a0e
AD
1544 $(CHMOD) 755 $@
1545 @echo $@ >> $(INST_ARCHAUTODIR)/.packlist
42793c05 1546END
fed7345c
AD
1547
1548# Old mechanism - still available:
1549
e1666bf5 1550 push(@m, <<'END') if $att{PERL_SRC};
fed7345c 1551 @ echo "$(EXTRALIBS)" >> $(PERL_SRC)/ext.libs
e1666bf5 1552END
005c1a0e 1553
232e078e 1554 push @m, MM->dir_target('$(INST_ARCHAUTODIR)');
42793c05
TB
1555 join('', "\n",@m);
1556}
1557
a0d0e21e
LW
1558
1559sub installpm {
42793c05
TB
1560 my($self, %attribs) = @_;
1561 # By default .pm files are split into the architecture independent
1562 # library. This is a good thing. If a specific module requires that
1563 # it's .pm files are split into the architecture specific library
1564 # then it should use: installpm => {SPLITLIB=>'$(INST_ARCHLIB)'}
1565 # Note that installperl currently interferes with this (Config.pm)
1566 # User can disable split by saying: installpm => {SPLITLIB=>''}
1567 my($splitlib) = '$(INST_LIB)'; # NOT arch specific by default
1568 $splitlib = $attribs{SPLITLIB} if exists $attribs{SPLITLIB};
1569 my(@m, $dist);
1570 foreach $dist (sort keys %{$att{PM}}){
1571 my($inst) = $att{PM}->{$dist};
1572 push(@m, "\n# installpm: $dist => $inst, splitlib=$splitlib\n");
1573 push(@m, MY->installpm_x($dist, $inst, $splitlib));
1574 push(@m, "\n");
1575 }
1576 join('', @m);
a0d0e21e
LW
1577}
1578
42793c05
TB
1579sub installpm_x { # called by installpm per file
1580 my($self, $dist, $inst, $splitlib) = @_;
005c1a0e
AD
1581 warn "Warning: Most probably 'make' will have problems processing this file: $inst\n"
1582 if $inst =~ m![:#]!;
42793c05
TB
1583 my($instdir) = $inst =~ m|(.*)/|;
1584 my(@m);
1585 push(@m,"
005c1a0e 1586$inst: $dist $att{MAKEFILE} $instdir/.exists
fed7345c 1587".' @ '.$att{RM_F}.' $@
fed7345c 1588 '."$att{CP} $dist".' $@
005c1a0e
AD
1589 $(CHMOD) 644 $@
1590 @echo $@ >> $(INST_ARCHAUTODIR)/.packlist
42793c05 1591');
40000a8c 1592 push(@m, "\t\@\$(AUTOSPLITFILE) \$@ $splitlib/auto\n")
42793c05 1593 if ($splitlib and $inst =~ m/\.pm$/);
232e078e
AD
1594
1595 push @m, MM->dir_target($instdir);
42793c05
TB
1596 join('', @m);
1597}
a0d0e21e 1598
232e078e
AD
1599sub processPL {
1600 return "" unless $att{PL_FILES};
1601 my(@m, $plfile);
1602 foreach $plfile (sort keys %{$att{PL_FILES}}) {
1603 push @m, "
1604all :: $att{PL_FILES}->{$plfile}
1605
1606$att{PL_FILES}->{$plfile} :: $plfile
1607 \$(PERL) -I\$(INST_ARCHLIB) -I\$(INST_LIB) -I\$(PERL_ARCHLIB) -I\$(PERL_LIB) $plfile
1608";
1609 }
1610 join "", @m;
1611}
1612
40000a8c
AD
1613sub installbin {
1614 return "" unless $att{EXE_FILES} && ref $att{EXE_FILES} eq "ARRAY";
1615 my(@m, $from, $to, %fromto, @to);
1616 for $from (@{$att{EXE_FILES}}) {
1617 local($_)= '$(INST_EXE)/' . basename($from);
1618 $to = MY->exescan();
1619 print "exescan($from) => '$to'" if ($Verbose >=2);
1620 $fromto{$from}=$to;
1621 }
1622 @to = values %fromto;
1623 push(@m, "
1624EXE_FILES = @{$att{EXE_FILES}}
1625
1626all :: @to
1627
1628realclean ::
1629 $att{RM_F} @to
1630");
1631
1632 while (($from,$to) = each %fromto) {
005c1a0e 1633 my $todir = dirname($to);
40000a8c 1634 push @m, "
005c1a0e 1635$to: $from $att{MAKEFILE} $todir/.exists
40000a8c
AD
1636 $att{CP} $from $to
1637";
1638 }
1639 join "", @m;
1640}
42793c05 1641
40000a8c
AD
1642sub exescan {
1643 $_;
1644}
42793c05
TB
1645# --- Sub-directory Sections ---
1646
1647sub subdirs {
1648 my(@m);
1649 # This method provides a mechanism to automatically deal with
1650 # subdirectories containing further Makefile.PL scripts.
1651 # It calls the subdir_x() method for each subdirectory.
5d94fbed
AD
1652 foreach(grep -d, &lsdir()){
1653 next if /^\./;
1654 next unless -f "$_/Makefile\.PL" ;
42793c05
TB
1655 print "Including $_ subdirectory" if ($Verbose);
1656 push(@m, MY->subdir_x($_));
1657 }
1658 if (@m){
1659 unshift(@m, "
1660# The default clean, realclean and test targets in this Makefile
1661# have automatically been given entries for each subdir.
1662
1663all :: subdirs
1664");
1665 } else {
1666 push(@m, "\n# none")
1667 }
1668 join('',@m);
1669}
1670
1671sub runsubdirpl{ # Experimental! See subdir_x section
1672 my($self,$subdir) = @_;
1673 chdir($subdir) or die "chdir($subdir): $!";
1aef975c 1674 ExtUtils::MakeMaker::check_hints();
005c1a0e 1675 package main;
42793c05 1676 require "Makefile.PL";
a0d0e21e
LW
1677}
1678
42793c05
TB
1679sub subdir_x {
1680 my($self, $subdir) = @_;
1681 my(@m);
1682 # The intention is that the calling Makefile.PL should define the
1683 # $(SUBDIR_MAKEFILE_PL_ARGS) make macro to contain whatever
1684 # information needs to be passed down to the other Makefile.PL scripts.
1685 # If this does not suit your needs you'll need to write your own
1686 # MY::subdir_x() method to override this one.
1687 qq{
1aef975c 1688config :: $subdir/$att{MAKEFILE}
005c1a0e 1689 cd $subdir && \$(MAKE) config \$(PASTHRU2) \$(SUBDIR_MAKEFILE_PL_ARGS)
42793c05 1690
1aef975c 1691$subdir/$att{MAKEFILE}: $subdir/Makefile.PL \$(CONFIGDEP)
42793c05 1692}.' @echo "Rebuilding $@ ..."
005c1a0e 1693 @$(PERL) -I"$(PERL_ARCHLIB)" -I"$(PERL_LIB)" \\
42793c05 1694 -e "use ExtUtils::MakeMaker; MM->runsubdirpl(qw('.$subdir.'))" \\
232e078e 1695 $(PASTHRU1) $(SUBDIR_MAKEFILE_PL_ARGS)
42793c05
TB
1696 @echo "Rebuild of $@ complete."
1697'.qq{
1698
1699subdirs ::
005c1a0e 1700 cd $subdir && \$(MAKE) all \$(PASTHRU2)
42793c05
TB
1701
1702};
1703}
1704
1705
1706# --- Cleanup and Distribution Sections ---
1707
1708sub clean {
1709 my($self, %attribs) = @_;
1710 my(@m);
1711 push(@m, '
1712# Delete temporary files but do not touch installed files. We don\'t delete
1713# the Makefile here so a later make realclean still has a makefile to use.
1714
1715clean ::
1716');
1717 # clean subdirectories first
1aef975c 1718 push(@m, map("\t-cd $_ && test -f $att{MAKEFILE} && \$(MAKE) clean\n",@{$att{DIR}}));
75f92628 1719 my(@otherfiles) = values %{$att{XS}}; # .c files from *.xs files
42793c05 1720 push(@otherfiles, $attribs{FILES}) if $attribs{FILES};
1aef975c 1721 push(@otherfiles, "./blib");
75f92628 1722 push(@m, " -$att{RM_RF} *~ t/*~ *.o *.a mon.out core so_locations "
40000a8c 1723 ."\$(BOOTSTRAP) \$(BASEEXT).bso \$(BASEEXT).exp @otherfiles\n");
75f92628 1724 # See realclean and ext/utils/make_ext for usage of Makefile.old
1aef975c 1725 push(@m, " -$att{MV} $att{MAKEFILE} $att{MAKEFILE}.old 2>/dev/null\n");
42793c05
TB
1726 push(@m, " $attribs{POSTOP}\n") if $attribs{POSTOP};
1727 join("", @m);
1728}
a0d0e21e
LW
1729
1730sub realclean {
42793c05
TB
1731 my($self, %attribs) = @_;
1732 my(@m);
1733 push(@m,'
1734# Delete temporary files (via clean) and also delete installed files
1735realclean purge :: clean
1736');
75f92628 1737 # realclean subdirectories first (already cleaned)
232e078e 1738 my $sub = "\t-cd %s && test -f %s && \$(MAKE) %s realclean\n";
75f92628 1739 foreach(@{$att{DIR}}){
1aef975c
AD
1740 push(@m, sprintf($sub,$_,"$att{MAKEFILE}.old","-f $att{MAKEFILE}.old"));
1741 push(@m, sprintf($sub,$_,"$att{MAKEFILE}",''));
75f92628 1742 }
3edbfbe5 1743 push(@m, " $att{RM_RF} \$(INST_AUTODIR) \$(INST_ARCHAUTODIR)\n");
75f92628
AD
1744 push(@m, " $att{RM_F} \$(INST_DYNAMIC) \$(INST_BOOT)\n");
1745 push(@m, " $att{RM_F} \$(INST_STATIC) \$(INST_PM)\n");
fed7345c 1746 my(@otherfiles) = ($att{MAKEFILE},
40000a8c 1747 "$att{MAKEFILE}.old"); # Makefiles last
42793c05 1748 push(@otherfiles, $attribs{FILES}) if $attribs{FILES};
3edbfbe5 1749 push(@m, " $att{RM_RF} @otherfiles\n") if @otherfiles;
42793c05
TB
1750 push(@m, " $attribs{POSTOP}\n") if $attribs{POSTOP};
1751 join("", @m);
1752}
a0d0e21e 1753
42793c05 1754
5d94fbed 1755sub dist {
42793c05 1756 my($self, %attribs) = @_;
005c1a0e 1757 my(@m);
42793c05 1758 # VERSION should be sanitised before use as a file name
005c1a0e
AD
1759 if ($attribs{TARNAME}){
1760 print STDOUT "Error (fatal): Attribute TARNAME for target dist is deprecated
1761Please use DISTNAME and VERSION";
1762 }
1763 my($name) = $attribs{NAME} || '$(DISTNAME)-$(VERSION)';
1764 my($tar) = $attribs{TAR} || 'tar'; # eg /usr/bin/gnutar
1765 my($tarflags) = $attribs{TARFLAGS} || 'cvf';
1766 my($compress) = $attribs{COMPRESS} || 'compress'; # eg gzip
1767 my($suffix) = $attribs{SUFFIX} || 'Z'; # eg gz
1768 my($shar) = $attribs{SHAR} || 'shar'; # eg "shar --gzip"
1769 my($preop) = $attribs{PREOP} || '@ :'; # eg update MANIFEST
1770 my($postop) = $attribs{POSTOP} || '@ :'; # eg remove the distdir
1771 my($ci) = $attribs{CI} || 'ci -u';
1772 my($rcs) = $attribs{RCS} || 'rcs -Nv$(VERSION_SYM):';
1773 my($dist_default) = $attribs{DIST_DEFAULT} || 'tardist';
1774
1775 push @m, "
1776TAR = $tar
1777TARFLAGS = $tarflags
1778COMPRESS = $compress
1779SUFFIX = $suffix
1780SHAR = $shar
1781PREOP = $preop
1782POSTOP = $postop
1783CI = $ci
1784RCS = $rcs
1785DIST_DEFAULT = $dist_default
42793c05 1786";
005c1a0e
AD
1787
1788 push @m, q{
1789distclean :: realclean distcheck
1790
1791distcheck :
1792 $(PERL) -I$(PERL_LIB) -e 'use ExtUtils::Manifest "&fullcheck";' \\
1793 -e 'fullcheck();'
1794
1795manifest :
1796 $(PERL) -I$(PERL_LIB) -e 'use ExtUtils::Manifest "&mkmanifest";' \\
1797 -e 'mkmanifest();'
1798
1799dist : $(DIST_DEFAULT)
1800
1801tardist : $(DISTNAME)-$(VERSION).tar.$(SUFFIX)
1802
1803$(DISTNAME)-$(VERSION).tar.$(SUFFIX) : distdir
1804 $(PREOP)
1805 $(TAR) $(TARFLAGS) $(DISTNAME)-$(VERSION).tar $(DISTNAME)-$(VERSION)
1806 $(COMPRESS) $(DISTNAME)-$(VERSION).tar
1807 $(RM_RF) $(DISTNAME)-$(VERSION)
1808 $(POSTOP)
1809
1810uutardist : $(DISTNAME)-$(VERSION).tar.$(SUFFIX)
1811 uuencode $(DISTNAME)-$(VERSION).tar.$(SUFFIX) \\
1812 $(DISTNAME)-$(VERSION).tar.$(SUFFIX) > \\
1813 $(DISTNAME)-$(VERSION).tar.$(SUFFIX).uu
1814
1815shdist : distdir
1816 $(PREOP)
1817 $(SHAR) $(DISTNAME)-$(VERSION) > $(DISTNAME)-$(VERSION).shar
1818 $(RM_RF) $(DISTNAME)-$(VERSION)
1819 $(POSTOP)
1820
1821distdir :
1822 $(RM_RF) $(DISTNAME)-$(VERSION)
1823 $(PERL) -I$(PERL_LIB) -e 'use ExtUtils::Manifest "/mani/";' \\
1824 -e 'manicopy(maniread(),"$(DISTNAME)-$(VERSION)");'
1825
1826
1827ci :
1828 $(PERL) -I$(PERL_LIB) -e 'use ExtUtils::Manifest "&maniread";' \\
1829 -e '@all = keys %{maniread()};' \\
1830 -e 'print("Executing $(CI) @all\n"); system("$(CI) @all");' \\
1831 -e 'print("Executing $(RCS) ...\n"); system("$(RCS) @all");'
1832
1833};
1834 join "", @m;
a0d0e21e
LW
1835}
1836
1837
42793c05
TB
1838# --- Test and Installation Sections ---
1839
a0d0e21e 1840sub test {
42793c05
TB
1841 my($self, %attribs) = @_;
1842 my($tests) = $attribs{TESTS} || (-d "t" ? "t/*.t" : "");
1843 my(@m);
1844 push(@m,"
40000a8c 1845TEST_VERBOSE=0
e50aee73 1846TEST_TYPE=test_$att{LINKTYPE}
40000a8c 1847
e50aee73 1848test :: \$(TEST_TYPE)
42793c05 1849");
005c1a0e 1850 push(@m, map("\tcd $_ && test -f $att{MAKEFILE} && \$(MAKE) test \$(PASTHRU2)\n",
40000a8c 1851 @{$att{DIR}}));
e50aee73
AD
1852 push(@m, "\t\@echo 'No tests defined for \$(NAME) extension.'\n")
1853 unless $tests or -f "test.pl" or @{$att{DIR}};
1854 push(@m, "\n");
1855
1856 push(@m, "test_dynamic :: all\n");
1857 push(@m, $self->test_via_harness('$(FULLPERL)', $tests)) if $tests;
1858 push(@m, $self->test_via_script('$(FULLPERL)', 'test.pl')) if -f "test.pl";
1859 push(@m, "\n");
1860
1861 push(@m, "test_static :: all \$(MAP_TARGET)\n");
1862 push(@m, $self->test_via_harness('./$(MAP_TARGET)', $tests)) if $tests;
1863 push(@m, $self->test_via_script('./$(MAP_TARGET)', 'test.pl')) if -f "test.pl";
1864 push(@m, "\n");
1865
42793c05 1866 join("", @m);
a0d0e21e
LW
1867}
1868
e50aee73
AD
1869sub test_via_harness {
1870 my($self, $perl, $tests) = @_;
1871 "\t$perl".q! -I$(INST_ARCHLIB) -I$(INST_LIB) -I$(PERL_ARCHLIB) -I$(PERL_LIB) -e 'use Test::Harness qw(&runtests $$verbose); $$verbose=$(TEST_VERBOSE); runtests @ARGV;' !."$tests\n";
1872}
1873
1874sub test_via_script {
1875 my($self, $perl, $script) = @_;
1876 "\t$perl".' -I$(INST_ARCHLIB) -I$(INST_LIB) -I$(PERL_ARCHLIB) -I$(PERL_LIB) test.pl
1877';
1878}
1879
a0d0e21e
LW
1880
1881sub install {
3edbfbe5
TB
1882 my($self, %attribs) = @_;
1883 my(@m);
40000a8c
AD
1884 push @m, q{
1885doc_install ::
005c1a0e 1886 @ echo Appending installation info to $(INSTALLARCHLIB)/perllocal.pod
40000a8c 1887 @ $(PERL) -I$(INST_ARCHLIB) -I$(INST_LIB) -I$(PERL_ARCHLIB) -I$(PERL_LIB) \\
232e078e 1888 -e "use ExtUtils::MakeMaker; MM->writedoc('Module', '$(NAME)', \\
005c1a0e
AD
1889 'LINKTYPE=$(LINKTYPE)', 'VERSION=$(VERSION)', \\
1890 'EXE_FILES=$(EXE_FILES)')" >> $(INSTALLARCHLIB)/perllocal.pod
40000a8c
AD
1891};
1892
3edbfbe5 1893 push(@m, "
40000a8c
AD
1894install :: pure_install doc_install
1895
005c1a0e 1896pure_install ::
3edbfbe5
TB
1897");
1898 # install subdirectories first
005c1a0e
AD
1899 push(@m, map("\tcd $_ && test -f $att{MAKEFILE} && \$(MAKE) install\n",
1900 @{$att{DIR}}));
3edbfbe5 1901
005c1a0e
AD
1902 push(@m, "\t\@\$(PERL) -e 'foreach (\@ARGV){die qq{You do not have permissions to install into \$\$_\\n} unless -w \$\$_}' \$(INSTALLPRIVLIB) \$(INSTALLARCHLIB)
1903 : perl5.000 and MM pre 3.8 autosplit into INST_ARCHLIB, we delete these old files here
1904 $att{RM_F} \$(INSTALLARCHLIB)/auto/\$(FULLEXT)/*.al
1905 $att{RM_F} \$(INSTALLARCHLIB)/auto/\$(FULLEXT)/*.ix
1906 \$(MAKE) INST_LIB=\$(INSTALLPRIVLIB) INST_ARCHLIB=\$(INSTALLARCHLIB) INST_EXE=\$(INSTALLBIN)
1907 \@\$(PERL) -i.bak -lne 'print unless \$\$seen{\$\$_}++' \$(INSTALLARCHLIB)/auto/\$(FULLEXT)/.packlist
3edbfbe5 1908");
a0d0e21e 1909
005c1a0e
AD
1910 push @m, '
1911#### UNINSTALL IS STILL EXPERIMENTAL ####
1912uninstall ::
1913';
1914
1915 push(@m, map("\tcd $_ && test -f $att{MAKEFILE} && \$(MAKE) uninstall\n",
1916 @{$att{DIR}}));
1917 push @m, "\t".'$(RM_RF) `cat $(INSTALLARCHLIB)/auto/$(FULLEXT)/.packlist`
1918';
1919
3edbfbe5
TB
1920 join("",@m);
1921}
a0d0e21e 1922
42793c05
TB
1923sub force {
1924 '# Phony target to force checking subdirectories.
1925FORCE:
a0d0e21e
LW
1926';
1927}
1928
1929
1930sub perldepend {
005c1a0e 1931 my(@m);
42793c05
TB
1932 push(@m,'
1933PERL_HDRS = $(PERL_INC)/EXTERN.h $(PERL_INC)/INTERN.h \
1934 $(PERL_INC)/XSUB.h $(PERL_INC)/av.h $(PERL_INC)/cop.h \
1935 $(PERL_INC)/cv.h $(PERL_INC)/dosish.h $(PERL_INC)/embed.h \
1936 $(PERL_INC)/form.h $(PERL_INC)/gv.h $(PERL_INC)/handy.h \
1937 $(PERL_INC)/hv.h $(PERL_INC)/keywords.h $(PERL_INC)/mg.h \
1938 $(PERL_INC)/op.h $(PERL_INC)/opcode.h $(PERL_INC)/patchlevel.h \
1939 $(PERL_INC)/perl.h $(PERL_INC)/perly.h $(PERL_INC)/pp.h \
1940 $(PERL_INC)/proto.h $(PERL_INC)/regcomp.h $(PERL_INC)/regexp.h \
1941 $(PERL_INC)/scope.h $(PERL_INC)/sv.h $(PERL_INC)/unixish.h \
75f92628 1942 $(PERL_INC)/util.h $(PERL_INC)/config.h
42793c05 1943
42793c05 1944');
e1666bf5 1945
005c1a0e
AD
1946 push @m, '
1947$(OBJECT) : $(PERL_HDRS)
1948' if $att{OBJECT};
1949
42793c05 1950 push(@m,'
75f92628
AD
1951# Check for unpropogated config.sh changes. Should never happen.
1952# We do NOT just update config.h because that is not sufficient.
1953# An out of date config.h is not fatal but complains loudly!
1954$(PERL_INC)/config.h: $(PERL_SRC)/config.sh
1955 -@echo "Warning: $(PERL_INC)/config.h out of date with $(PERL_SRC)/config.sh"; false
1956
75f92628 1957$(PERL_ARCHLIB)/Config.pm: $(PERL_SRC)/config.sh
1aef975c 1958 @echo "Warning: $(PERL_ARCHLIB)/Config.pm may be out of date with $(PERL_SRC)/config.sh"
232e078e 1959 cd $(PERL_SRC) && $(MAKE) lib/Config.pm
e1666bf5
TB
1960') if $att{PERL_SRC};
1961
42793c05
TB
1962 push(@m, join(" ", values %{$att{XS}})." : \$(XSUBPPDEPS)\n")
1963 if %{$att{XS}};
1964 join("\n",@m);
1965}
1966
1967
1968sub makefile {
005c1a0e 1969 my @m;
42793c05 1970 # We do not know what target was originally specified so we
75f92628 1971 # must force a manual rerun to be sure. But as it should only
42793c05 1972 # happen very rarely it is not a significant problem.
005c1a0e 1973 push @m, '
1aef975c 1974$(OBJECT) : '.$att{MAKEFILE}.'
75f92628
AD
1975
1976# We take a very conservative approach here, but it\'s worth it.
1977# We move Makefile to Makefile.old here to avoid gnu make looping.
005c1a0e 1978'.$att{MAKEFILE}.' : Makefile.PL $(CONFIGDEP)
75f92628
AD
1979 @echo "Makefile out-of-date with respect to $?"
1980 @echo "Cleaning current config before rebuilding Makefile..."
1aef975c
AD
1981 -@mv '."$att{MAKEFILE} $att{MAKEFILE}.old".'
1982 -$(MAKE) -f '.$att{MAKEFILE}.'.old clean >/dev/null 2>&1 || true
005c1a0e 1983 $(PERL) "-I$(PERL_ARCHLIB)" "-I$(PERL_LIB)" Makefile.PL '."@ARGV".'
42793c05 1984 @echo "Now you must rerun make."; false
a0d0e21e 1985';
005c1a0e
AD
1986
1987 join "", @m;
a0d0e21e
LW
1988}
1989
a0d0e21e
LW
1990sub postamble{
1991 "";
1992}
1993
232e078e
AD
1994# --- Make-Directories section (internal method) ---
1995# dir_target(@array) returns a Makefile entry for the file .exists in each
1996# named directory. Returns nothing, if the entry has already been processed.
1997# We're helpless though, if the same directory comes as $(FOO) _and_ as "bar".
1998# Both of them get an entry, that's why we use "::". I chose '$(PERL)' as the
1999# prerequisite, because there has to be one, something that doesn't change
2000# too often :)
2001%Dir_Target = (); # package global
2002
2003sub dir_target {
005c1a0e 2004 my($self,@dirs) = @_;
232e078e
AD
2005 my(@m,$dir);
2006 foreach $dir (@dirs) {
2007 next if $Dir_Target{$dir};
2008 push @m, "
2009$dir/.exists :: \$(PERL)
2010 \@ \$(MKPATH) $dir
2011 \@ \$(TOUCH) $dir/.exists
2012";
2013 $Dir_Target{$dir}++;
2014 }
2015 join "", @m;
2016}
2017
fed7345c
AD
2018# --- Make-A-Perl section ---
2019
2020sub staticmake {
2021 my($self, %attribs) = @_;
2022
2023 my(%searchdirs)=($att{PERL_ARCHLIB} => 1, $att{INST_ARCHLIB} => 1);
2024 my(@searchdirs)=keys %searchdirs;
2025 # And as it's not yet built, we add the current extension
2026 my(@static)="$att{INST_ARCHLIB}/auto/$att{FULLEXT}/$att{BASEEXT}.a";
fed7345c
AD
2027 my(@perlinc) = ($att{INST_ARCHLIB}, $att{INST_LIB}, $att{PERL_ARCHLIB}, $att{PERL_LIB});
2028 MY->makeaperl('MAKE' => $att{MAKEFILE},
2029 'DIRS' => \@searchdirs,
2030 'STAT' => \@static,
fed7345c 2031 'INCL' => \@perlinc,
40000a8c 2032 'TARGET' => $att{MAP_TARGET},
fed7345c 2033 'TMP' => "",
40000a8c 2034 'LIBPERL' => $att{LIBPERL_A}
fed7345c
AD
2035 );
2036}
2037
2038sub makeaperl {
2039 my($self, %attribs) = @_;
2040 my($makefilename, $searchdirs, $static, $extra, $perlinc, $target, $tmp, $libperl) =
2041 @attribs{qw(MAKE DIRS STAT EXTRA INCL TARGET TMP LIBPERL)};
2042 my(@m);
40000a8c 2043 my($cccmd, $linkcmd);
fed7345c
AD
2044
2045 # This emulates cflags to get the compiler invocation...
40000a8c 2046 $cccmd = MY->const_cccmd($libperl);
fed7345c
AD
2047 $cccmd =~ s/^CCCMD\s*=\s*//;
2048 chomp $cccmd;
2049 $cccmd =~ s/\s/ -I$att{PERL_INC} /;
2050 $cccmd .= " $Config{'cccdlflags'}" if ($Config{'d_shrplib'});
2051
2052 # The front matter of the linkcommand...
5d94fbed 2053 $linkcmd = join ' ', "\$(CC)",
fed7345c
AD
2054 grep($_, @Config{qw(large split ldflags ccdlflags)});
2055 $linkcmd =~ s/\s+/ /g;
2056
2057 # Which *.a files could we make use of...
40000a8c 2058 local(%static);
fed7345c
AD
2059 File::Find::find(sub {
2060 return unless m/\.a$/;
40000a8c 2061 return if m/^libperl/;
232e078e
AD
2062 # don't include the installed version of this extension
2063 return if $File::Find::name =~ m:auto/$att{FULLEXT}/$att{BASEEXT}.a$:;
40000a8c 2064 $static{fastcwd() . "/" . $_}++;
fed7345c
AD
2065 }, grep( -d $_, @{$searchdirs || []}) );
2066
40000a8c
AD
2067 # We trust that what has been handed in as argument, will be buildable
2068 $static = [] unless $static;
2069 @static{@{$static}} = (1) x @{$static};
2070
fed7345c
AD
2071 $extra = [] unless $extra && ref $extra eq 'ARRAY';
2072 for (sort keys %static) {
2073 next unless /\.a$/;
40000a8c 2074 $_ = dirname($_) . "/extralibs.ld";
5d94fbed 2075 push @$extra, $_;
fed7345c
AD
2076 }
2077
fed7345c
AD
2078 grep(s/^/-I/, @$perlinc);
2079
2080 $target = "perl" unless $target;
2081 $tmp = "." unless $tmp;
2082
2083 push @m, "
40000a8c 2084# --- MakeMaker makeaperl section ---
fed7345c
AD
2085MAP_TARGET = $target
2086FULLPERL = $att{'FULLPERL'}
2087MAP_LINKCMD = $linkcmd
2088MAP_PERLINC = @{$perlinc}
2089MAP_STATIC = ",
2090join(" ", sort keys %static), "
fed7345c
AD
2091MAP_PRELIBS = $Config{'libs'} $Config{'cryptlib'}
2092";
232e078e
AD
2093
2094 unless ($libperl && -f $libperl) {
005c1a0e
AD
2095 my $dir = $att{PERL_SRC} || "$att{PERL_ARCHLIB}/CORE";
2096 $libperl ||= "libperl.a";
232e078e
AD
2097 $libperl = "$dir/$libperl";
2098 print STDOUT "Warning: $libperl not found"
2099 unless (-f $libperl || defined($att{PERL_SRC}));
40000a8c 2100 }
fed7345c 2101
40000a8c
AD
2102 push @m, "
2103MAP_LIBPERL = $libperl
fed7345c 2104";
fed7345c 2105
40000a8c 2106 push @m, "
5d94fbed
AD
2107extralibs.ld: @$extra
2108 \@ $att{RM_F} \$\@
2109 \@ \$(TOUCH) \$\@
2110";
2111
2112 foreach (@$extra){
2113 push @m, "\tcat $_ >> \$\@\n";
2114 }
2115
2116 push @m, "
2117\$(MAP_TARGET): $tmp/perlmain.o \$(MAP_LIBPERL) \$(MAP_STATIC) extralibs.ld
2118 \$(MAP_LINKCMD) -o \$\@ $tmp/perlmain.o \$(MAP_LIBPERL) \$(MAP_STATIC) `cat extralibs.ld` \$(MAP_PRELIBS)
40000a8c
AD
2119 @ echo 'To install the new \"\$(MAP_TARGET)\" binary, call'
2120 @ echo ' make -f $makefilename inst_perl MAP_TARGET=\$(MAP_TARGET)'
2121 @ echo 'To remove the intermediate files say'
2122 @ echo ' make -f $makefilename map_clean'
2123
2124$tmp/perlmain.o: $tmp/perlmain.c
2125";
2126 push @m, "\tcd $tmp && $cccmd perlmain.c\n";
fed7345c
AD
2127
2128 push @m, qq{
2129$tmp/perlmain.c: $makefilename}, q{
40000a8c
AD
2130 @ echo Writing $@
2131 @ $(FULLPERL) $(MAP_PERLINC) -e 'use ExtUtils::Miniperl; \\
2132 writemain(grep s#.*/auto/##, qw|$(MAP_STATIC)|)' > $@.tmp && mv $@.tmp $@
2133
2134};
fed7345c 2135
5d94fbed 2136# We write EXTRA outside the perl program to have it eval'd by the shell
40000a8c
AD
2137 push @m, q{
2138doc_inst_perl:
005c1a0e 2139 @ echo Appending installation info to $(INSTALLARCHLIB)/perllocal.pod
232e078e
AD
2140 @ $(FULLPERL) -e 'use ExtUtils::MakeMaker; MM->writedoc("Perl binary",' \\
2141 -e '"$(MAP_TARGET)", "MAP_STATIC=$(MAP_STATIC)",' \\
005c1a0e
AD
2142 -e '"MAP_EXTRA=@ARGV", "MAP_LIBPERL=$(MAP_LIBPERL)")' \\
2143 -- `cat extralibs.ld` >> $(INSTALLARCHLIB)/perllocal.pod
fed7345c
AD
2144};
2145
2146 push @m, qq{
40000a8c
AD
2147inst_perl: pure_inst_perl doc_inst_perl
2148
2149pure_inst_perl: \$(MAP_TARGET)
005c1a0e 2150 $att{CP} \$(MAP_TARGET) \$(INSTALLBIN)/\$(MAP_TARGET)
fed7345c 2151
e50aee73 2152clean :: map_clean
40000a8c
AD
2153
2154map_clean :
e50aee73 2155 $att{RM_F} $tmp/perlmain.o $tmp/perlmain.c \$(MAP_TARGET) extralibs.ld
fed7345c
AD
2156};
2157
2158 join '', @m;
2159}
a0d0e21e 2160
005c1a0e
AD
2161sub extliblist {
2162 my($self,$libs) = @_;
2163 require ExtUtils::Liblist;
2164 ExtUtils::Liblist::ext($libs, $Verbose);
a0d0e21e
LW
2165}
2166
1aef975c
AD
2167sub mksymlists {
2168 my($self) = shift;
232e078e 2169 my($pkg);
1aef975c
AD
2170
2171 # only AIX requires a symbol list at this point
2172 # (so does VMS, but that's handled by the MM_VMS package)
40000a8c 2173 return '' unless $Config{'osname'} eq 'aix';
1aef975c
AD
2174
2175 init_main(@ARGV) unless defined $att{'BASEEXT'};
94b6baf5 2176 if (! $att{DL_FUNCS}) {
40000a8c
AD
2177 my($bootfunc);
2178 ($bootfunc = $att{NAME}) =~ s/\W/_/g;
2179 $att{DL_FUNCS} = {$att{BASEEXT} => ["boot_$bootfunc"]};
1aef975c
AD
2180 }
2181 rename "$att{BASEEXT}.exp", "$att{BASEEXT}.exp_old";
2182
2183 open(EXP,">$att{BASEEXT}.exp") or die $!;
40000a8c
AD
2184 print EXP join("\n",@{$att{DL_VARS}}) if $att{DL_VARS};
2185 foreach $pkg (keys %{$att{DL_FUNCS}}) {
1aef975c 2186 (my($prefix) = $pkg) =~ s/\W/_/g;
232e078e 2187 my $func;
40000a8c 2188 foreach $func (@{$att{DL_FUNCS}->{$pkg}}) {
1aef975c
AD
2189 $func = "XS_${prefix}_$func" unless $func =~ /^boot_/;
2190 print EXP "$func\n";
2191 }
2192 }
2193 close EXP;
2194}
42793c05
TB
2195
2196# --- Output postprocessing section ---
2197#nicetext is included to make VMS support easier
2198sub nicetext { # Just return the input - no action needed
2199 my($self,$text) = @_;
2200 $text;
2201}
fed7345c 2202
40000a8c
AD
2203# --- perllocal.pod section ---
2204sub writedoc {
2205 my($self,$what,$name,@attribs)=@_;
005c1a0e
AD
2206# the following would have to move to a ExtUtils::Perllocal.pm, if we want it
2207# it's dangerous wrt AFS, and it's against the philosophy that MakeMaker
2208# should never write to files. We write to stdout and append to the file
2209# during make install, but we cannot rely on '-f $Config{"installarchlib"},
2210# as there is a time window between the WriteMakefile and the make.
2211# -w $Config{'installarchlib'} or die "No write permission to $Config{'installarchlib'}";
2212# my($localpod) = "$Config{'installarchlib'}/perllocal.pod";
40000a8c 2213 my($time);
005c1a0e
AD
2214# if (-f $localpod) {
2215# print "Appending installation info to $localpod\n";
2216# open POD, ">>$localpod" or die "Couldn't open $localpod";
2217# } else {
2218# print "Writing new file $localpod\n";
2219# open POD, ">$localpod" or die "Couldn't open $localpod";
2220# print POD "=head1 NAME
2221#
2222#perllocal - locally installed modules and perl binaries
2223#\n=head1 HISTORY OF LOCAL INSTALLATIONS
2224#
2225#";
2226# }
40000a8c
AD
2227 require "ctime.pl";
2228 chop($time = ctime(time));
005c1a0e
AD
2229 print "=head2 $time: $what C<$name>\n\n=over 4\n\n=item *\n\n";
2230 print join "\n\n=item *\n\n", map("C<$_>",@attribs);
2231 print "\n\n=back\n\n";
2232# close POD;
40000a8c
AD
2233}
2234
232e078e 2235
005c1a0e
AD
2236
2237# the following keeps AutoSplit happy
2238package ExtUtils::MakeMaker;
22391;
2240
2241__END__
2242
2243=head1 NAME
2244
2245ExtUtils::MakeMaker - create an extension Makefile
2246
2247=head1 SYNOPSIS
2248
2249C<use ExtUtils::MakeMaker;>
2250
2251C<WriteMakefile( ATTRIBUTE =E<gt> VALUE [, ...] );>
2252
2253=head1 DESCRIPTION
2254
2255This utility is designed to write a Makefile for an extension module
2256from a Makefile.PL. It is based on the Makefile.SH model provided by
2257Andy Dougherty and the perl5-porters.
2258
2259It splits the task of generating the Makefile into several subroutines
2260that can be individually overridden. Each subroutine returns the text
2261it wishes to have written to the Makefile.
2262
2263MakeMaker.pm uses the architecture specific information from
2264Config.pm. In addition the extension may contribute to the C<%Config>
2265hash table of Config.pm by supplying hints files in a C<hints/>
2266directory. The hints files are expected to be named like their
2267counterparts in C<PERL_SRC/hints>, but with an C<.pl> file name
2268extension (eg. C<next_3_2.pl>). They are simply C<eval>ed by MakeMaker
2269within the WriteMakefile() subroutine, and can be used to execute
2270commands as well as to include special variables. If there is no
2271hintsfile for the actual system, but for some previous releases of the
2272same operating system, the latest one of those is used.
2273
2274=head2 Default Makefile Behaviour
2275
2276The automatically generated Makefile enables the user of the extension
2277to invoke
2278
2279 perl Makefile.PL # optionally "perl Makefile.PL verbose"
2280 make
2281 make test # optionally set TEST_VERBOSE=1
2282 make install # See below
2283
2284The Makefile to be produced may be altered by adding arguments of the
2285form C<KEY=VALUE>. If the user wants to work with a different perl
2286than the default, this is achieved by specifying
2287
2288 perl Makefile.PL PERL=/tmp/myperl5
2289
2290Other interesting targets in the generated Makefile are
2291
2292 make config # to check if the Makefile is up-to-date
2293 make clean # delete local temporary files (Makefile gets renamed)
2294 make realclean # delete all derived files (including installed files)
2295 make dist # see below the Distribution Support section
2296
2297=head2 Special case C<make install>
2298
2299C<make> alone puts all relevant files into directories that are named
2300by the macros INST_LIB, INST_ARCHLIB, and INST_EXE. All three default
2301to ./blib if you are I<not> building below the perl source directory. If
2302you I<are> building below the perl source, INST_LIB and INST_ARCHLIB
2303default to ../../lib, and INST_EXE is not defined.
2304
2305The I<install> target of the generated Makefile is a recursive call to
2306make which sets
2307
2308 INST_LIB to INSTALLPRIVLIB
2309 INST_ARCHLIB to INSTALLARCHLIB
2310 INST_EXE to INSTALLBIN
2311
2312The three INSTALL... macros in turn default to
2313$Config{installprivlib}, $Config{installarchlib}, and
2314$Config{installbin} respectively.
2315
2316The recommended way to proceed is to set only the INSTALL* macros, not
2317the INST_* targets. In doing so, you give room to the compilation
2318process without affecting important directories. Usually a 'make test'
2319will succeed after the make, and a 'make install' can finish the game.
2320
2321MakeMaker gives you much more freedom than needed to configure
2322internal variables and get different results. It is worth to mention,
2323that make(1) also lets you configure most of the variables that are
2324used in the Makefile. But in the majority of situations this will not
2325be necessary, and should only be done, if the author of a package
2326recommends it.
2327
2328The usual relationship between INSTALLPRIVLIB and INSTALLARCHLIB is
2329that the latter is a subdirectory of the former with the name
2330C<$Config{'archname'}>, MakeMaker supports the user who sets
2331INSTALLPRIVLIB. If INSTALLPRIVLIB is set, but INSTALLARCHLIB not, then
2332MakeMaker defaults the latter to be INSTALLPRIVLIB/ARCHNAME if that
2333directory exists, otherwise it defaults to INSTALLPRIVLIB.
2334
2335Previous versions of MakeMaker suggested to use the INST_* macros. For
2336backwards compatibility, these are still supported but deprecated in
2337favor of the INSTALL* macros.
2338
2339Here is the description, what they are used for: If the user specifies
2340the final destination for the INST_... macros, then there is no need
2341to call 'make install', because 'make' will already put all files in
2342place.
2343
2344If there is a need to first build everything in the C<./blib>
2345directory and test the product, then it's appropriate to use the
2346INSTALL... macros. So the users have the choice to either say
2347
2348 # case: trust the module
2349 perl Makefile.PL INST_LIB=~/perllib INST_EXE=~/bin
2350 make
2351 make test
2352
2353or
2354
2355 perl Makefile.PL INSTALLPRIVLIB=~/foo \
2356 INSTALLARCHLIB=~/foo/bar INSTALLBIN=~/bin
2357 make
2358 make test
2359 make install
2360
2361Note, that the tilde expansion is done by MakeMaker, not by perl by
2362default, nor by make. So be careful to use the tilde only with the
2363C<perl Makefile.PL> call.
2364
2365It is important to know, that the INSTALL* macros should be absolute
2366paths, never relativ ones. Packages with multiple Makefile.PLs in
2367different directories get the contents of the INSTALL* macros
2368propagated verbatim. (The INST_* macros will be corrected, if they are
2369relativ paths, but not the INSTALL* macros.)
2370
2371If the user has superuser privileges, and is not working on AFS
2372(Andrew File System) or relatives, then the defaults for
2373INSTALLPRIVLIB, INSTALLARCHLIB, and INSTALLBIN will be appropriate,
2374and this incantation will be the best:
2375
2376 perl Makefile.PL; make; make test
2377 make install
2378
2379(I<make test> is not necessarily supported for all modules.)
2380
2381C<make install> per default writes some documentation of what has been
2382done into the file C<$Config{'installarchlib'}/perllocal.pod>. This is
2383an experimental feature. It can be bypassed by calling C<make
2384pure_install>.
2385
2386=head2 Support to Link a new Perl Binary (eg dynamic loading not available)
2387
2388An extension that is built with the above steps is ready to use on
2389systems supporting dynamic loading. On systems that do not support
2390dynamic loading, any newly created extension has to be linked together
2391with the available resources. MakeMaker supports the linking process
2392by creating appropriate targets in the Makefile whenever an extension
2393is built. You can invoke the corresponding section of the makefile with
2394
2395 make perl
2396
2397That produces a new perl binary in the current directory with all
2398extensions linked in that can be found in INST_ARCHLIB (usually
2399C<./blib>) and PERL_ARCHLIB.
2400
2401The binary can be installed into the directory where perl normally
2402resides on your machine with
2403
2404 make inst_perl
2405
2406To produce a perl binary with a different name than C<perl>, either say
2407
2408 perl Makefile.PL MAP_TARGET=myperl
2409 make myperl
2410 make inst_perl
2411
2412or say
2413
2414 perl Makefile.PL
2415 make myperl MAP_TARGET=myperl
2416 make inst_perl MAP_TARGET=myperl
2417
2418In any case you will be prompted with the correct invocation of the
2419C<inst_perl> target that installs the new binary into INSTALLBIN.
2420
2421Note, that there is a C<makeaperl> scipt in the perl distribution,
2422that supports the linking of a new perl binary in a similar fashion,
2423but with more options.
2424
2425C<make inst_perl> per default writes some documentation of what has been
2426done into the file C<$Config{'installarchlib'}/perllocal.pod>. This
2427can be bypassed by calling C<make pure_inst_perl>.
2428
2429Warning: the inst_perl: target is rather mighty and will probably
2430overwrite your existing perl binary. Use with care!
2431
2432=head2 Determination of Perl Library and Installation Locations
2433
2434MakeMaker needs to know, or to guess, where certain things are
2435located. Especially INST_LIB and INST_ARCHLIB (where to install files
2436into), PERL_LIB and PERL_ARCHLIB (where to read existing modules
2437from), and PERL_INC (header files and C<libperl*.*>).
2438
2439Extensions may be built either using the contents of the perl source
2440directory tree or from an installed copy of the perl library.
2441
2442If an extension is being built below the C<ext/> directory of the perl
2443source then MakeMaker will set PERL_SRC automatically (e.g., C<../..>).
2444If PERL_SRC is defined then other variables default to the following:
2445
2446 PERL_INC = PERL_SRC
2447 PERL_LIB = PERL_SRC/lib
2448 PERL_ARCHLIB = PERL_SRC/lib
2449 INST_LIB = PERL_LIB
2450 INST_ARCHLIB = PERL_ARCHLIB
2451
2452If an extension is being built away from the perl source then MakeMaker
2453will leave PERL_SRC undefined and default to using the installed copy
2454of the perl library. The other variables default to the following:
2455
2456 PERL_INC = $archlib/CORE
2457 PERL_LIB = $privlib
2458 PERL_ARCHLIB = $archlib
2459 INST_LIB = ./blib
2460 INST_ARCHLIB = ./blib
2461
2462If perl has not yet been installed then PERL_SRC can be defined on the
2463command line as shown in the previous section.
2464
2465=head2 Useful Default Makefile Macros
2466
2467FULLEXT = Pathname for extension directory (eg DBD/Oracle).
2468
2469BASEEXT = Basename part of FULLEXT. May be just equal FULLEXT.
2470
2471ROOTEXT = Directory part of FULLEXT with leading slash (eg /DBD)
2472
2473PERL_LIB = Directory where we read the perl library files
2474
2475PERL_ARCHLIB = Same as above for architecture dependent files
2476
2477INST_LIB = Directory where we put library files of this extension
2478while building it. If we are building below PERL_SRC/ext
2479we default to PERL_SRC/lib, else we default to ./blib.
2480
2481INST_ARCHLIB = Same as above for architecture dependent files
2482
2483INST_LIBDIR = C<$(INST_LIB)$(ROOTEXT)>
2484
2485INST_AUTODIR = C<$(INST_LIB)/auto/$(FULLEXT)>
2486
2487INST_ARCHAUTODIR = C<$(INST_ARCHLIB)/auto/$(FULLEXT)>
2488
2489=head2 Customizing The Generated Makefile
2490
2491If the Makefile generated does not fit your purpose you can change it
2492using the mechanisms described below.
2493
2494=head2 Using Attributes (and Parameters)
2495
2496The following attributes can be specified as arguments to WriteMakefile()
2497or as NAME=VALUE pairs on the command line:
2498
2499This description is not yet documented; you can get at the description
2500with one of the commands
2501
2502=over 4
2503
2504=item C<perl Makefile.PL help>
2505(if you already have a basic Makefile.PL)
2506
2507=item C<make help>
2508(if you already have a Makefile)
2509
2510=item C<perl -e 'use ExtUtils::MakeMaker "&help"; &help;'>
2511(if you have neither nor)
2512
2513=back
2514
2515=head2 Overriding MakeMaker Methods
2516
2517If you cannot achieve the desired Makefile behaviour by specifying
2518attributes you may define private subroutines in the Makefile.PL.
2519Each subroutines returns the text it wishes to have written to
2520the Makefile. To override a section of the Makefile you can
2521either say:
2522
2523 sub MY::c_o { "new literal text" }
2524
2525or you can edit the default by saying something like:
2526
2527 sub MY::c_o { $_=MM->c_o; s/old text/new text/; $_ }
2528
2529If you still need a different solution, try to develop another
2530subroutine, that fits your needs and submit the diffs to
2531F<perl5-porters@nicoh.com> or F<comp.lang.perl> as appropriate.
2532
2533=head2 Distribution Support
2534
2535For authors of extensions MakeMaker provides several Makefile
2536targets. Most of the support comes from the ExtUtils::Manifest module,
2537where additional documentation can be found.
2538
2539=over 4
2540
2541=item make distcheck
2542reports which files are below the build directory but not in the
2543MANIFEST file and vice versa. (See ExtUtils::Manifest::fullcheck() for
2544details)
2545
2546=item make distclean
2547does a realclean first and then the distcheck. Note that this is not
2548needed to build a new distribution as long as you are sure, that the
2549MANIFEST file is ok.
2550
2551=item make manifest
2552rewrites the MANIFEST file, adding all remaining files found (See
2553ExtUtils::Manifest::mkmanifest() for details)
2554
2555=item make distdir
2556Copies all the files that are in the MANIFEST file to a newly created
2557directory with the name C<$(DISTNAME)-$(VERSION)>. If that directory
2558exists, it will be removed first.
2559
2560=item make tardist
2561First does a command $(PREOP) which defaults to a null command. Does a
2562distdir next and runs C<tar> on that directory into a tarfile. Then
2563deletes the distdir. Finishes with a command $(POSTOP) which defaults
2564to a null command.
2565
2566=item make dist
2567Defaults to $(DIST_DEFAULT) which in turn defaults to tardist.
2568
2569=item make uutardist
2570Runs a tardist first and uuencodes the tarfile.
2571
2572=item make shdist
2573First does a command $(PREOP) which defaults to a null command. Does a
2574distdir next and runs C<shar> on that directory into a sharfile. Then
2575deletes the distdir. Finishes with a command $(POSTOP) which defaults
2576to a null command. Note: For shdist to work properly a C<shar>
2577program that can handle directories is mandatory.
2578
2579=item make ci
2580Does a $(CI) (defaults to C<ci -u>) and a $(RCS) (C<rcs -q
2581-Nv$(VERSION_SYM):>) on all files in the MANIFEST file
2582
2583Customization of the dist targets can be done by specifying a hash
2584reference to the dist attribute of the WriteMakefile call. The
2585following parameters are recognized:
2586
2587 TAR ('tar')
2588 TARFLAGS ('cvf')
2589 COMPRESS ('compress')
2590 SUFFIX ('Z')
2591 SHAR ('shar')
2592 PREOP ('@ :')
2593 POSTOP ('@ :')
2594
2595An example:
2596
2597 WriteMakefile( 'dist' => { COMPRESS=>"gzip", SUFFIX=>"gz" })
2598
2599=back
2600
fed7345c
AD
2601=head1 AUTHORS
2602
2603Andy Dougherty F<E<lt>doughera@lafcol.lafayette.eduE<gt>>, Andreas
2604Koenig F<E<lt>k@franz.ww.TU-Berlin.DEE<gt>>, Tim Bunce
2605F<E<lt>Tim.Bunce@ig.co.ukE<gt>>. VMS support by Charles Bailey
005c1a0e
AD
2606F<E<lt>bailey@HMIVAX.HUMGEN.UPENN.EDUE<gt>>. Contact the makemaker
2607mailing list L<mailto:makemaker@franz.ww.tu-berlin.de>, if you have any
2608questions.
fed7345c
AD
2609
2610=head1 MODIFICATION HISTORY
2611
2612v1, August 1994; by Andreas Koenig. Based on Andy Dougherty's Makefile.SH.
2613v2, September 1994 by Tim Bunce.
2614v3.0 October 1994 by Tim Bunce.
2615v3.1 November 11th 1994 by Tim Bunce.
2616v3.2 November 18th 1994 by Tim Bunce.
2617v3.3 November 27th 1994 by Andreas Koenig.
2618v3.4 December 7th 1994 by Andreas Koenig and Tim Bunce.
2619v3.5 December 15th 1994 by Tim Bunce.
2620v3.6 December 15th 1994 by Tim Bunce.
2621v3.7 December 30th 1994 By Tim Bunce
2622v3.8 January 17th 1995 By Andreas Koenig and Tim Bunce
2623v3.9 January 19th 1995 By Tim Bunce
fed7345c 2624v3.10 January 23rd 1995 By Tim Bunce
fed7345c 2625v3.11 January 24th 1995 By Andreas Koenig
fed7345c 2626v4.00 January 24th 1995 By Tim Bunce
fed7345c 2627v4.01 January 25th 1995 By Tim Bunce
fed7345c 2628v4.02 January 29th 1995 By Andreas Koenig
40000a8c
AD
2629v4.03 January 30th 1995 By Andreas Koenig
2630v4.04 Februeary 5th 1995 By Andreas Koenig
2631v4.05 February 8th 1995 By Andreas Koenig
2632v4.06 February 10th 1995 By Andreas Koenig
40000a8c 2633v4.061 February 12th 1995 By Andreas Koenig
40000a8c 2634v4.08 - 4.085 February 14th-21st 1995 by Andreas Koenig
005c1a0e
AD
2635v4.086 March 9 1995 by Andy Dougherty
2636v4.09 March 31 1995 by Andreas Koenig
2637v4.091 April 3 1995 by Andy Dougherty
2638v4.092 April 11 1995 by Andreas Koenig
2639v4.093 April 12 1995 by Andy Dougherty
2640v4.094 April 12 1995 by Andy Dougherty
fed7345c 2641
005c1a0e 2642v4.100 May 10 1995 by Andreas Koenig
fed7345c 2643
005c1a0e
AD
2644Broken out Mkbootstrap to make the file smaller and easier to manage,
2645and to speed up the build process.
fed7345c 2646
005c1a0e
AD
2647Added ExtUtils::Manifest as an extra module that is used to streamline
2648distributions. (See pod section I<distribution support>).
fed7345c 2649
005c1a0e
AD
2650Added a VERSION_SYM macro, that is derived from VERSION but all C<\W>
2651characters replaced by an underscore.
fed7345c 2652
005c1a0e 2653Moved the whole documentation below __END__ for easier maintanance.
fed7345c 2654
005c1a0e 2655linkext =E<gt> { LINKTYPE =E<gt> '' } should work now as expected.
fed7345c 2656
005c1a0e
AD
2657Rechecked the use of INST_LIB, INST_ARCHLIB, and INST_EXE from the
2658perspective of an AFS user (thanks to Rudolph T Maceyko for the
2659hint). With full backward compatiblity it is now possible, to set
2660INSTALLPRIVLIB, INSTALLARCHLIB, and INSTALLBIN either with 'perl
2661Makefile.PL' or with 'make install'. A bare 'make' ignores these
2662settings. The effect of this change is that it is no longer
2663recommended to set the INST_* attributes directly, although it doesn't
2664hurt, if they do so. The PASTHRU variables (now PASTHRU1 and PASTHRU2)
2665are fully aware of their duty: the INST_* attributes are only
2666propagated to runsubdirpl, not to 'cd subdir && make config' and 'cd
2667subdir && make all'.
fed7345c 2668
005c1a0e 2669Included Tim's "Unable to locate Perl library" patch.
fed7345c 2670
005c1a0e
AD
2671Eliminated any excess of spaces in the $old/$new comparison in
2672const_cccmd().
fed7345c 2673
005c1a0e 2674Added a prompt function with usage $answer = prompt $message, $default.
fed7345c 2675
005c1a0e
AD
2676Included Tim's patch that searches for perl5 and perl$] as well as
2677perl and miniperl.
fec02dd3 2678
005c1a0e
AD
2679Added .NO_PARALLEL for the time until I have a multiple cpu machine
2680myself :)
fec02dd3 2681
005c1a0e
AD
2682Introduced a macro() subroutine. WriteMakefile("macro" =E<gt> { FOO
2683=E<gt> BAR }) defines the macro FOO = BAR in the generated Makefile.
232e078e 2684
005c1a0e 2685Rolled in Tim's patch for needs_linking.
232e078e 2686
005c1a0e
AD
2687writedoc now tries to be less clever. It was trying to determine, if a
2688perllocal.pod had to be created or appended to. As we have now the
2689possibility, that INSTALLARCHLIB is determined at make's runtime, we
2690cannot do this anymore. We append to that file in any case.
232e078e 2691
005c1a0e 2692Added Kenneth's pod installation patch.
232e078e 2693
005c1a0e 2694v4.110 May 19 1995 by Andreas Koenig
232e078e 2695
005c1a0e 2696=head1 NEW in 4.11
232e078e 2697
005c1a0e
AD
2698MANIFEST.SKIP now contains only regular expressions. RCS directories
2699are no longer skipped by default, as this may be configured in the
2700SKIP file.
232e078e 2701
005c1a0e 2702The manifest target now does no realclean anymore.
232e078e 2703
005c1a0e
AD
2704I_PERL_LIBS depreciated (no longer used). (unless you speak up, of
2705course)
232e078e 2706
005c1a0e
AD
2707I could not justify that we rebuild the Makefile when MakeMaker has
2708changed (as Kenneth suggested). If this is really a strong desire,
2709please convince me. But a minor change of the MakeMaker should not
2710trigger a 60 minutes rebuild of Tk, IMO.
232e078e 2711
005c1a0e
AD
2712Broken out extliblist into the new module ExtUtils::Liblist. Should
2713help extension writers for their own Configure scripts. The breaking
2714into pieces should be done now, I suppose.
232e078e 2715
005c1a0e
AD
2716Added an (experimenta!!) uninstall target that works with a
2717packlist. AutoSplit files are not yet in the packlist. This needs a
2718patch to AutoSplit, doesn't it? The packlist file is installed in
2719INST_ARCHAUTODIR/.packlist. It doesn't have means to decide, if a file
2720is architecture dependent or not, we just collect as much as we can
2721get. make -n recommended before actually executing. (I leave this
2722target undocumented in the pod section). Suggestions welcome!
232e078e 2723
005c1a0e
AD
2724Added basic chmod support. Nothing spectacular. *.so and *.a files get
2725permission 755, because I seem to recall, that some systems need
2726execute permissions in some weird constellations. The rest becomes
2727644. What else do we need to make this flexible?
232e078e 2728
005c1a0e
AD
2729Then I took Tim's word serious: no bloat. No turning all packages into
2730perl scripts. Leaving shar, tar, uu be what they are... Sorry,
2731Kenneth, we still have to convince Larry that a growing MakeMaker
2732makes sense :)
232e078e 2733
005c1a0e
AD
2734Added an extra check whenever they install below the perl source tree:
2735is this extension a standard extension? If it is, everything behaves
2736as we are used to. If it is not, the three INST_ macros are set to
2737./blib, and they get a warning that this extension has to be
2738installed manually with 'make install'.
232e078e 2739
005c1a0e
AD
2740Added a warning for targets that have a colon or a hashmark within
2741their names, because most make(1)s will not be able to process them.
232e078e 2742
005c1a0e
AD
2743Applied Hallvard's patch to ~user evaluation for cases where user does
2744not exist.
5d94fbed 2745
005c1a0e 2746Added a ci target that checks in all files from the MANIFEST into rcs.
5d94fbed 2747
005c1a0e 2748=head1 new in 4.12/4.13
5d94fbed 2749
005c1a0e
AD
2750"Please notify perl5-porters" message is now accompanied by
2751Config::myconfig().
5d94fbed 2752
005c1a0e
AD
2753(Manifest.pm) Change delimiter for the evaluation of the regexes from
2754MANIFEST.SKIP to from "!" to "/". I had overlooked the fact, that ! no
2755has a meaning in regular expressions.
5d94fbed 2756
005c1a0e
AD
2757Disabled the new logic that prevents non-standard extensions from
2758writing to PERL_SRC/lib to give Andy room for 5.001f.
5d94fbed 2759
005c1a0e
AD
2760Added a Version_check target that calls MakeMaker for a simple Version
2761control function on every invocation of 'make' in the future. Doesn't
2762have an effect currently.
5d94fbed 2763
005c1a0e
AD
2764Target dist is still defaulting to tardist, but the level of
2765indirection has changed. The Makefile macro DIST_DEFAULT takes it's
2766place. This allows me to make dist dependent from whatever I intend as
2767my standard distribution.
5d94fbed 2768
005c1a0e 2769Made sure that INST_EXE is created for extensions that need it.
5d94fbed 2770
005c1a0e 27714.13 is just a cleanup/documentation patch. And it adds a MakeMaker FAQ :)
5d94fbed 2772
005c1a0e 2773=head v4.14 June 5, 1995, by Andreas Koenig
5d94fbed 2774
005c1a0e
AD
2775Reintroduces the LD_RUN_PATH macro. LD_RUN_PATH is passed as an
2776environment variable to the ld run. It is needed on Sun OS, and does
2777no harm on other systems. It is a colon seperated list of the
2778directories in LDLOADLIBS.
f0b7e567 2779
005c1a0e 2780=head v4.15 June 6, 1995, by Andreas Koenig
5d94fbed 2781
005c1a0e 2782Add -I$(PERL_ARCHLIB) -I$(PERL_LIB) to calls to xsubpp.
f06db76b 2783
e50aee73
AD
2784=head v4.16 June 18, 1995, by Tim Bunce
2785
2786Split test: target into test_static: and test_dynamic: with automatic
2787selection based on LINKTYPE. The test_static: target automatically
2788builds a local ./perl binary containing the extension and executes the
2789tests using that binary. This fixes problems that users were having
2790dealing with building and testing static extensions. It also simplifies
2791the process down to the standard: make + make test.
2792
2793MakeMaker no longer incorrectly considers a perlmain.c file to be part
2794of an extensions source files. The map_clean target is now invoked by
2795clean not realclean and now deletes MAP_TARGET but does not delete
2796Makefile (since that's done properly elsewhere).
2797
2798Since the staticmake section defines macros that the test target now
2799needs the test section is written into the makefile after the
2800staticmake section. The postamble section has been made last again, as
2801it should be.
2802
005c1a0e 2803=head1 TODO
f06db76b 2804
005c1a0e 2805Needs more complete documentation.
f06db76b 2806
005c1a0e
AD
2807Add a C<html:> target when there has been found a general solution to
2808installing html files.
fed7345c 2809
005c1a0e
AD
2810Add a FLAVOR variable that makes it easier to build debugging,
2811embedded or multiplicity perls. Currently the easiest way to produce a
2812debugging perl seems to be (after haveing built perl):
2813 make clobber
2814 ./Configure -D"archname=IP22-irix-d" -des
2815 make perllib=libperld.a
2816 make test perllib=libperld.a
2817 mv /usr/local/bin/perl /usr/local/bin/perl/O_perl5.001e
2818 make install perllib=libperld.a
2819 cp /usr/local/bin/perl/O_perl5.001e /usr/local/bin/perl
2820It would be nice, if the Configure step could be dropped. Also nice, but
2821maybe expensive, if 'make clobber' wouldn't be needed.
fed7345c 2822
005c1a0e 2823The uninstall target has to be completed, it's just a sketch.
fed7345c 2824
005c1a0e
AD
2825Reconsider Makefile macros. The output of macro() should be the last
2826before PASTHRU and none should come after that -- tough work.
fed7345c 2827
005c1a0e
AD
2828Think about Nick's desire, that the pTk subdirectory needs a special
2829treatment.
5d94fbed 2830
005c1a0e
AD
2831Find a way to have multiple MYEXTLIB archive files combined into
2832one. Actually I need some scenario, where this problem can be
2833illustrated. I currently don't see the problem.
5d94fbed 2834
005c1a0e 2835Test if .NOPARALLEL can be omitted.
fed7345c 2836
005c1a0e
AD
2837Don't let extensions write to PERL_SRC/lib anymore, build perl from
2838the extensions found below ext, run 'make test' and 'make install' on
2839each extension (giving room for letting them fail). Move some of the
2840tests from t/lib/* to the libraries.
a0d0e21e 2841
005c1a0e
AD
2842Streamline the production of a new perl binary on systems that DO have
2843dynamic loading (especially make test needs further support, as test
2844most probably needs the new binary).
2845
2846=cut