This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
ad846ffbb77ce1511e48043abac71dfd55f2bae9
[perl5.git] / lib / ExtUtils / MakeMaker.pm
1 BEGIN {require 5.002;} # MakeMaker 5.17 was the last MakeMaker that was compatible with perl5.001m
2
3 package ExtUtils::MakeMaker;
4
5 $Version = $VERSION = "5.40";
6 $Version_OK = "5.17";   # Makefiles older than $Version_OK will die
7                         # (Will be checked from MakeMaker version 4.13 onwards)
8 ($Revision = substr(q$Revision: 1.211 $, 10)) =~ s/\s+$//;
9
10
11
12 require Exporter;
13 use Config;
14 use Carp ();
15 #use FileHandle ();
16
17 use vars qw(
18
19             @ISA @EXPORT @EXPORT_OK $AUTOLOAD
20             $ISA_TTY $Is_Mac $Is_OS2 $Is_VMS $Revision $Setup_done
21             $VERSION $Verbose $Version_OK %Config %Keep_after_flush
22             %MM_Sections %Prepend_dot_dot %Recognized_Att_Keys
23             @Get_from_Config @MM_Sections @Overridable @Parent
24
25            );
26 # use strict;
27
28 # &DynaLoader::mod2fname should be available to miniperl, thus 
29 # should be a pseudo-builtin (cmp. os2.c).
30 #eval {require DynaLoader;};
31
32 #
33 # Set up the inheritance before we pull in the MM_* packages, because they
34 # import variables and functions from here
35 #
36 @ISA = qw(Exporter);
37 @EXPORT = qw(&WriteMakefile &writeMakefile $Verbose &prompt);
38 @EXPORT_OK = qw($VERSION &Version_check &neatvalue &mkbootstrap &mksymlists
39                 $Version);
40                 # $Version in mixed case will go away!
41
42 #
43 # Dummy package MM inherits actual methods from OS-specific
44 # default packages.  We use this intermediate package so
45 # MY::XYZ->func() can call MM->func() and get the proper
46 # default routine without having to know under what OS
47 # it's running.
48 #
49 @MM::ISA = qw[ExtUtils::MM_Unix ExtUtils::Liblist ExtUtils::MakeMaker];
50
51 #
52 # Setup dummy package:
53 # MY exists for overriding methods to be defined within
54 #
55 {
56     package MY;
57     @MY::ISA = qw(MM);
58 ###    sub AUTOLOAD { use Devel::Symdump; print Devel::Symdump->rnew->as_string; Carp::confess "hey why? $AUTOLOAD" }
59     package MM;
60     sub DESTROY {}
61 }
62
63 # "predeclare the package: we only load it via AUTOLOAD
64 # but we have already mentioned it in @ISA
65 package ExtUtils::Liblist;
66
67 package ExtUtils::MakeMaker;
68 #
69 # Now we can can pull in the friends
70 #
71 $Is_VMS = $^O eq 'VMS';
72 $Is_OS2 = $^O eq 'os2';
73 $Is_Mac = $^O eq 'MacOS';
74
75 require ExtUtils::MM_Unix;
76
77 if ($Is_VMS) {
78     require ExtUtils::MM_VMS;
79     require VMS::Filespec; # is a noop as long as we require it within MM_VMS
80 }
81 if ($Is_OS2) {
82     require ExtUtils::MM_OS2;
83 }
84 if ($Is_Mac) {
85     require ExtUtils::MM_Mac;
86 }
87
88 # The SelfLoader would bring a lot of overhead for MakeMaker, because
89 # we know for sure we will use most of the autoloaded functions once
90 # we have to use one of them. So we write our own loader
91
92 sub AUTOLOAD {
93     my $code;
94     if (defined fileno(DATA)) {
95         my $fh = select DATA;
96         my $o = $/;                     # For future reads from the file.
97         $/ = "\n__END__\n";
98         $code = <DATA>;
99         $/ = $o;
100         select $fh;
101         close DATA;
102         eval $code;
103         if ($@) {
104             $@ =~ s/ at .*\n//;
105             Carp::croak $@;
106         }
107     } else {
108         warn "AUTOLOAD called unexpectedly for $AUTOLOAD"; 
109     }
110     defined(&$AUTOLOAD) or die "Myloader inconsistency error";
111     goto &$AUTOLOAD;
112 }
113
114 # The only subroutine we do not SelfLoad is Version_Check because it's
115 # called so often. Loading this minimum still requires 1.2 secs on my
116 # Indy :-(
117
118 sub Version_check {
119     my($checkversion) = @_;
120     die "Your Makefile was built with ExtUtils::MakeMaker v $checkversion.
121 Current Version is $ExtUtils::MakeMaker::VERSION. There have been considerable
122 changes in the meantime.
123 Please rerun 'perl Makefile.PL' to regenerate the Makefile.\n"
124     if $checkversion < $Version_OK;
125     printf STDOUT "%s %s %s %s.\n", "Makefile built with ExtUtils::MakeMaker v",
126     $checkversion, "Current Version is", $VERSION
127         unless $checkversion == $VERSION;
128 }
129
130 sub warnhandler {
131     $_[0] =~ /^Use of uninitialized value/ && return;
132     $_[0] =~ /used only once/ && return;
133     $_[0] =~ /^Subroutine\s+[\w:]+\s+redefined/ && return;
134     warn @_;
135 }
136
137 sub ExtUtils::MakeMaker::eval_in_subdirs ;
138 sub ExtUtils::MakeMaker::eval_in_x ;
139 sub ExtUtils::MakeMaker::full_setup ;
140 sub ExtUtils::MakeMaker::writeMakefile ;
141 sub ExtUtils::MakeMaker::new ;
142 sub ExtUtils::MakeMaker::check_manifest ;
143 sub ExtUtils::MakeMaker::parse_args ;
144 sub ExtUtils::MakeMaker::check_hints ;
145 sub ExtUtils::MakeMaker::mv_all_methods ;
146 sub ExtUtils::MakeMaker::skipcheck ;
147 sub ExtUtils::MakeMaker::flush ;
148 sub ExtUtils::MakeMaker::mkbootstrap ;
149 sub ExtUtils::MakeMaker::mksymlists ;
150 sub ExtUtils::MakeMaker::neatvalue ;
151 sub ExtUtils::MakeMaker::selfdocument ;
152 sub ExtUtils::MakeMaker::WriteMakefile ;
153 sub ExtUtils::MakeMaker::prompt ;
154
155 1;
156
157 __DATA__
158
159 package ExtUtils::MakeMaker;
160
161 sub WriteMakefile {
162     Carp::croak "WriteMakefile: Need even number of args" if @_ % 2;
163     local $SIG{__WARN__} = \&warnhandler;
164
165     unless ($Setup_done++){
166         full_setup();
167         undef &ExtUtils::MakeMaker::full_setup; #safe memory
168     }
169     my %att = @_;
170     MM->new(\%att)->flush;
171 }
172
173 sub prompt ($;$) {
174     my($mess,$def)=@_;
175     $ISA_TTY = -t STDIN && -t STDOUT ;
176     Carp::confess("prompt function called without an argument") unless defined $mess;
177     my $dispdef = defined $def ? "[$def] " : " ";
178     $def = defined $def ? $def : "";
179     my $ans;
180     if ($ISA_TTY) {
181         local $|=1;
182         print "$mess $dispdef";
183         chomp($ans = <STDIN>);
184     }
185     return $ans || $def;
186 }
187
188 sub eval_in_subdirs {
189     my($self) = @_;
190     my($dir);
191     use Cwd 'cwd';
192     my $pwd = cwd();
193
194     foreach $dir (@{$self->{DIR}}){
195         my($abs) = $self->catdir($pwd,$dir);
196         $self->eval_in_x($abs);
197     }
198     chdir $pwd;
199 }
200
201 sub eval_in_x {
202     my($self,$dir) = @_;
203     package main;
204     chdir $dir or Carp::carp("Couldn't change to directory $dir: $!");
205 #    use FileHandle ();
206 #    my $fh = new FileHandle;
207 #    $fh->open("Makefile.PL") or Carp::carp("Couldn't open Makefile.PL in $dir");
208     local *FH;
209     open(FH,"Makefile.PL") or Carp::carp("Couldn't open Makefile.PL in $dir");
210 #    my $eval = join "", <$fh>;
211     my $eval = join "", <FH>;
212 #    $fh->close;
213     close FH;
214     eval $eval;
215     if ($@) {
216 #         if ($@ =~ /prerequisites/) {
217 #             die "MakeMaker WARNING: $@";
218 #         } else {
219 #             warn "WARNING from evaluation of $dir/Makefile.PL: $@";
220 #         }
221         warn "WARNING from evaluation of $dir/Makefile.PL: $@";
222     }
223 }
224
225 sub full_setup {
226     $Verbose ||= 0;
227     $^W=1;
228
229     # package name for the classes into which the first object will be blessed
230     $PACKNAME = "PACK000";
231
232     @Attrib_help = qw/
233
234     C CONFIG CONFIGURE DEFINE DIR DISTNAME DL_FUNCS DL_VARS EXE_FILES
235     EXCLUDE_EXT INCLUDE_EXT NO_VC FIRST_MAKEFILE FULLPERL H INC
236     INSTALLARCHLIB INSTALLBIN INSTALLDIRS INSTALLMAN1DIR
237     INSTALLMAN3DIR INSTALLPRIVLIB INSTALLSCRIPT INSTALLSITEARCH
238     INSTALLSITELIB INST_ARCHLIB INST_BIN INST_EXE INST_LIB
239     INST_MAN1DIR INST_MAN3DIR INST_SCRIPT LDFROM LIBPERL_A LIB LIBS
240     LINKTYPE MAKEAPERL MAKEFILE MAN1PODS MAN3PODS MAP_TARGET MYEXTLIB
241     NAME NEEDS_LINKING NOECHO NORECURS OBJECT OPTIMIZE PERL PERLMAINCC
242     PERL_ARCHLIB PERL_LIB PERL_SRC PL_FILES PM PMLIBDIRS PREFIX
243     PREREQ_PM SKIP TYPEMAPS VERSION VERSION_FROM XS XSOPT XSPROTOARG
244     XS_VERSION clean depend dist dynamic_lib linkext macro realclean
245     tool_autosplit
246
247     installpm
248
249         /;
250
251     # ^^^ installpm is deprecated, will go about Summer 96
252
253     # @Overridable is close to @MM_Sections but not identical.  The
254     # order is important. Many subroutines declare macros. These
255     # depend on each other. Let's try to collect the macros up front,
256     # then pasthru, then the rules.
257
258     # MM_Sections are the sections we have to call explicitly
259     # in Overridable we have subroutines that are used indirectly
260
261
262     @MM_Sections = 
263         qw(
264
265  post_initialize const_config constants tool_autosplit tool_xsubpp
266  tools_other dist macro depend cflags const_loadlibs const_cccmd
267  post_constants
268
269  pasthru
270
271  c_o xs_c xs_o top_targets linkext dlsyms dynamic dynamic_bs
272  dynamic_lib static static_lib manifypods processPL installbin subdirs
273  clean realclean dist_basics dist_core dist_dir dist_test dist_ci
274  install force perldepend makefile staticmake test
275
276           ); # loses section ordering
277
278     @Overridable = @MM_Sections;
279     push @Overridable, qw[
280
281  dir_target libscan makeaperl needs_linking subdir_x test_via_harness
282  test_via_script
283
284                          ];
285
286     push @MM_Sections, qw[
287
288  pm_to_blib selfdocument
289
290                          ];
291
292     # Postamble needs to be the last that was always the case
293     push @MM_Sections, "postamble";
294     push @Overridable, "postamble";
295
296     # All sections are valid keys.
297     @Recognized_Att_Keys{@MM_Sections} = (1) x @MM_Sections;
298
299     # we will use all these variables in the Makefile
300     @Get_from_Config = 
301         qw(
302            ar cc cccdlflags ccdlflags dlext dlsrc ld lddlflags ldflags libc
303            lib_ext obj_ext ranlib sitelibexp sitearchexp so
304           );
305
306     my $item;
307     foreach $item (@Attrib_help){
308         $Recognized_Att_Keys{$item} = 1;
309     }
310     foreach $item (@Get_from_Config) {
311         $Recognized_Att_Keys{uc $item} = $Config{$item};
312         print "Attribute '\U$item\E' => '$Config{$item}'\n"
313             if ($Verbose >= 2);
314     }
315
316     #
317     # When we eval a Makefile.PL in a subdirectory, that one will ask
318     # us (the parent) for the values and will prepend "..", so that
319     # all files to be installed end up below OUR ./blib
320     #
321     %Prepend_dot_dot = 
322         qw(
323
324            INST_BIN 1 INST_EXE 1 INST_LIB 1 INST_ARCHLIB 1 INST_SCRIPT
325            1 MAP_TARGET 1 INST_MAN1DIR 1 INST_MAN3DIR 1 PERL_SRC 1
326            PERL 1 FULLPERL 1
327
328           );
329
330     my @keep = qw/
331         NEEDS_LINKING HAS_LINK_CODE
332         /;
333     @Keep_after_flush{@keep} = (1) x @keep;
334 }
335
336 sub writeMakefile {
337     die <<END;
338
339 The extension you are trying to build apparently is rather old and
340 most probably outdated. We detect that from the fact, that a
341 subroutine "writeMakefile" is called, and this subroutine is not
342 supported anymore since about October 1994.
343
344 Please contact the author or look into CPAN (details about CPAN can be
345 found in the FAQ and at http:/www.perl.com) for a more recent version
346 of the extension. If you're really desperate, you can try to change
347 the subroutine name from writeMakefile to WriteMakefile and rerun
348 'perl Makefile.PL', but you're most probably left alone, when you do
349 so.
350
351 The MakeMaker team
352
353 END
354 }
355
356 sub ExtUtils::MakeMaker::new {
357     my($class,$self) = @_;
358     my($key);
359
360     print STDOUT "MakeMaker (v$VERSION)\n" if $Verbose;
361     if (-f "MANIFEST" && ! -f "Makefile"){
362         check_manifest();
363     }
364
365     $self = {} unless (defined $self);
366
367     check_hints($self);
368
369     my(%initial_att) = %$self; # record initial attributes
370
371     my($prereq);
372     foreach $prereq (sort keys %{$self->{PREREQ_PM}}) {
373         my $eval = "use $prereq $self->{PREREQ_PM}->{$prereq}";
374         eval $eval;
375         if ($@){
376             warn "Warning: prerequisite $prereq $self->{PREREQ_PM}->{$prereq} not found";
377         } else {
378             delete $self->{PREREQ_PM}{$prereq};
379         }
380     }
381 #    if (@unsatisfied){
382 #         unless (defined $ExtUtils::MakeMaker::useCPAN) {
383 #             print qq{MakeMaker WARNING: prerequisites not found (@unsatisfied)
384 # Please install these modules first and rerun 'perl Makefile.PL'.\n};
385 #             if ($ExtUtils::MakeMaker::hasCPAN) {
386 #                 $ExtUtils::MakeMaker::useCPAN = prompt(qq{Should I try to use the CPAN module to fetch them for you?},"yes");
387 #             } else {
388 #                 print qq{Hint: You may want to install the CPAN module to autofetch the needed modules\n};
389 #                 $ExtUtils::MakeMaker::useCPAN=0;
390 #             }
391 #         }
392 #         if ($ExtUtils::MakeMaker::useCPAN) {
393 #             require CPAN;
394 #             CPAN->import(@unsatisfied);
395 #         } else {
396 #             die qq{prerequisites not found (@unsatisfied)};
397 #         }
398 #       warn qq{WARNING: prerequisites not found (@unsatisfied)};
399 #    }
400
401     if (defined $self->{CONFIGURE}) {
402         if (ref $self->{CONFIGURE} eq 'CODE') {
403             $self = { %$self, %{&{$self->{CONFIGURE}}}};
404         } else {
405             Carp::croak "Attribute 'CONFIGURE' to WriteMakefile() not a code reference\n";
406         }
407     }
408
409     # This is for old Makefiles written pre 5.00, will go away
410     if ( Carp::longmess("") =~ /runsubdirpl/s ){
411         Carp::carp("WARNING: Please rerun 'perl Makefile.PL' to regenerate your Makefiles\n");
412     }
413
414     my $newclass = ++$PACKNAME;
415     {
416 #       no strict;
417         print "Blessing Object into class [$newclass]\n" if $Verbose>=2;
418         mv_all_methods("MY",$newclass);
419         bless $self, $newclass;
420         push @Parent, $self;
421         @{"$newclass\:\:ISA"} = 'MM';
422     }
423
424     if (defined $Parent[-2]){
425         $self->{PARENT} = $Parent[-2];
426         my $key;
427         for $key (keys %Prepend_dot_dot) {
428             next unless defined $self->{PARENT}{$key};
429             $self->{$key} = $self->{PARENT}{$key};
430                 # PERL and FULLPERL may be command verbs instead of full
431                 # file specifications under VMS.  If so, don't turn them
432                 # into a filespec.
433             $self->{$key} = $self->catdir("..",$self->{$key})
434                 unless $self->file_name_is_absolute($self->{$key})
435                 || ($^O eq 'VMS' and ($key =~ /PERL$/ && $self->{$key} =~ /^[\w\-\$]+$/));
436         }
437         $self->{PARENT}->{CHILDREN}->{$newclass} = $self if $self->{PARENT};
438     } else {
439         parse_args($self,@ARGV);
440     }
441
442     $self->{NAME} ||= $self->guess_name;
443
444     ($self->{NAME_SYM} = $self->{NAME}) =~ s/\W+/_/g;
445
446     $self->init_main();
447
448     if (! $self->{PERL_SRC} ) {
449         my($pthinks) = $INC{'Config.pm'};
450         $pthinks = VMS::Filespec::vmsify($pthinks) if $Is_VMS;
451         if ($pthinks ne $self->catfile($Config{archlibexp},'Config.pm')){
452             $pthinks =~ s!/Config\.pm$!!;
453             $pthinks =~ s!.*/!!;
454             print STDOUT <<END;
455 Your perl and your Config.pm seem to have different ideas about the architecture
456 they are running on.
457 Perl thinks: [$pthinks]
458 Config says: [$Config{archname}]
459 This may or may not cause problems. Please check your installation of perl if you
460 have problems building this extension.
461 END
462         }
463     }
464
465     $self->init_dirscan();
466     $self->init_others();
467
468     push @{$self->{RESULT}}, <<END;
469 # This Makefile is for the $self->{NAME} extension to perl.
470 #
471 # It was generated automatically by MakeMaker version
472 # $VERSION (Revision: $Revision) from the contents of
473 # Makefile.PL. Don't edit this file, edit Makefile.PL instead.
474 #
475 #       ANY CHANGES MADE HERE WILL BE LOST!
476 #
477 #   MakeMaker Parameters:
478 END
479
480     foreach $key (sort keys %initial_att){
481         my($v) = neatvalue($initial_att{$key});
482         $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
483         $v =~ tr/\n/ /s;
484         push @{$self->{RESULT}}, "#     $key => $v";
485     }
486
487     # turn the SKIP array into a SKIPHASH hash
488     my (%skip,$skip);
489     for $skip (@{$self->{SKIP} || []}) {
490         $self->{SKIPHASH}{$skip} = 1;
491     }
492     delete $self->{SKIP}; # free memory
493
494     if ($self->{PARENT}) {
495         for (qw/install dist dist_basics dist_core dist_dir dist_test dist_ci/) {
496             $self->{SKIPHASH}{$_} = 1;
497         }
498     }
499
500     # We run all the subdirectories now. They don't have much to query
501     # from the parent, but the parent has to query them: if they need linking!
502     unless ($self->{NORECURS}) {
503         $self->eval_in_subdirs if @{$self->{DIR}};
504     }
505
506     my $section;
507     foreach $section ( @MM_Sections ){
508         print "Processing Makefile '$section' section\n" if ($Verbose >= 2);
509         my($skipit) = $self->skipcheck($section);
510         if ($skipit){
511             push @{$self->{RESULT}}, "\n# --- MakeMaker $section section $skipit.";
512         } else {
513             my(%a) = %{$self->{$section} || {}};
514             push @{$self->{RESULT}}, "\n# --- MakeMaker $section section:";
515             push @{$self->{RESULT}}, "# " . join ", ", %a if $Verbose && %a;
516             push @{$self->{RESULT}}, $self->nicetext($self->$section( %a ));
517         }
518     }
519
520     push @{$self->{RESULT}}, "\n# End.";
521     pop @Parent;
522
523     $self;
524 }
525
526 sub check_manifest {
527     print STDOUT "Checking if your kit is complete...\n";
528     require ExtUtils::Manifest;
529     $ExtUtils::Manifest::Quiet=$ExtUtils::Manifest::Quiet=1; #avoid warning
530     my(@missed)=ExtUtils::Manifest::manicheck();
531     if (@missed){
532         print STDOUT "Warning: the following files are missing in your kit:\n";
533         print "\t", join "\n\t", @missed;
534         print STDOUT "\n";
535         print STDOUT "Please inform the author.\n";
536     } else {
537         print STDOUT "Looks good\n";
538     }
539 }
540
541 sub parse_args{
542     my($self, @args) = @_;
543     foreach (@args){
544         unless (m/(.*?)=(.*)/){
545             help(),exit 1 if m/^help$/;
546             ++$Verbose if m/^verb/;
547             next;
548         }
549         my($name, $value) = ($1, $2);
550         if ($value =~ m/^~(\w+)?/){ # tilde with optional username
551             $value =~ s [^~(\w*)]
552                 [$1 ?
553                  ((getpwnam($1))[7] || "~$1") :
554                  (getpwuid($>))[7]
555                  ]ex;
556         }
557         $self->{uc($name)} = $value;
558     }
559
560     # catch old-style 'potential_libs' and inform user how to 'upgrade'
561     if (defined $self->{potential_libs}){
562         my($msg)="'potential_libs' => '$self->{potential_libs}' should be";
563         if ($self->{potential_libs}){
564             print STDOUT "$msg changed to:\n\t'LIBS' => ['$self->{potential_libs}']\n";
565         } else {
566             print STDOUT "$msg deleted.\n";
567         }
568         $self->{LIBS} = [$self->{potential_libs}];
569         delete $self->{potential_libs};
570     }
571     # catch old-style 'ARMAYBE' and inform user how to 'upgrade'
572     if (defined $self->{ARMAYBE}){
573         my($armaybe) = $self->{ARMAYBE};
574         print STDOUT "ARMAYBE => '$armaybe' should be changed to:\n",
575                         "\t'dynamic_lib' => {ARMAYBE => '$armaybe'}\n";
576         my(%dl) = %{$self->{dynamic_lib} || {}};
577         $self->{dynamic_lib} = { %dl, ARMAYBE => $armaybe};
578         delete $self->{ARMAYBE};
579     }
580     if (defined $self->{LDTARGET}){
581         print STDOUT "LDTARGET should be changed to LDFROM\n";
582         $self->{LDFROM} = $self->{LDTARGET};
583         delete $self->{LDTARGET};
584     }
585     # Turn a DIR argument on the command line into an array
586     if (defined $self->{DIR} && ref \$self->{DIR} eq 'SCALAR') {
587         # So they can choose from the command line, which extensions they want
588         # the grep enables them to have some colons too much in case they
589         # have to build a list with the shell
590         $self->{DIR} = [grep $_, split ":", $self->{DIR}];
591     }
592     # Turn a INCLUDE_EXT argument on the command line into an array
593     if (defined $self->{INCLUDE_EXT} && ref \$self->{INCLUDE_EXT} eq 'SCALAR') {
594         $self->{INCLUDE_EXT} = [grep $_, split '\s+', $self->{INCLUDE_EXT}];
595     }
596     # Turn a EXCLUDE_EXT argument on the command line into an array
597     if (defined $self->{EXCLUDE_EXT} && ref \$self->{EXCLUDE_EXT} eq 'SCALAR') {
598         $self->{EXCLUDE_EXT} = [grep $_, split '\s+', $self->{EXCLUDE_EXT}];
599     }
600     my $mmkey;
601     foreach $mmkey (sort keys %$self){
602         print STDOUT "  $mmkey => ", neatvalue($self->{$mmkey}), "\n" if $Verbose;
603         print STDOUT "'$mmkey' is not a known MakeMaker parameter name.\n"
604             unless exists $Recognized_Att_Keys{$mmkey};
605     }
606     $| = 1 if $Verbose;
607 }
608
609 sub check_hints {
610     my($self) = @_;
611     # We allow extension-specific hints files.
612
613     return unless -d "hints";
614
615     # First we look for the best hintsfile we have
616     my(@goodhints);
617     my($hint)="${^O}_$Config{osvers}";
618     $hint =~ s/\./_/g;
619     $hint =~ s/_$//;
620     return unless $hint;
621
622     # Also try without trailing minor version numbers.
623     while (1) {
624         last if -f "hints/$hint.pl";      # found
625     } continue {
626         last unless $hint =~ s/_[^_]*$//; # nothing to cut off
627     }
628     return unless -f "hints/$hint.pl";    # really there
629
630     # execute the hintsfile:
631 #    use FileHandle ();
632 #    my $fh = new FileHandle;
633 #    $fh->open("hints/$hint.pl");
634     local *FH;
635     open(FH,"hints/$hint.pl");
636 #    @goodhints = <$fh>;
637     @goodhints = <FH>;
638 #    $fh->close;
639     close FH;
640     print STDOUT "Processing hints file hints/$hint.pl\n";
641     eval join('',@goodhints);
642     print STDOUT $@ if $@;
643 }
644
645 sub mv_all_methods {
646     my($from,$to) = @_;
647     my($method);
648     my($symtab) = \%{"${from}::"};
649 #    no strict;
650
651     # Here you see the *current* list of methods that are overridable
652     # from Makefile.PL via MY:: subroutines. As of VERSION 5.07 I'm
653     # still trying to reduce the list to some reasonable minimum --
654     # because I want to make it easier for the user. A.K.
655
656     foreach $method (@Overridable) {
657
658         # We cannot say "next" here. Nick might call MY->makeaperl
659         # which isn't defined right now
660
661         # Above statement was written at 4.23 time when Tk-b8 was
662         # around. As Tk-b9 only builds with 5.002something and MM 5 is
663         # standard, we try to enable the next line again. It was
664         # commented out until MM 5.23
665
666         next unless defined &{"${from}::$method"};
667
668         *{"${to}::$method"} = \&{"${from}::$method"};
669
670         # delete would do, if we were sure, nobody ever called
671         # MY->makeaperl directly
672         
673         # delete $symtab->{$method};
674         
675         # If we delete a method, then it will be undefined and cannot
676         # be called.  But as long as we have Makefile.PLs that rely on
677         # %MY:: being intact, we have to fill the hole with an
678         # inheriting method:
679
680         eval "package MY; sub $method { shift->SUPER::$method(\@_); }";
681     }
682
683     # We have to clean out %INC also, because the current directory is
684     # changed frequently and Graham Barr prefers to get his version
685     # out of a History.pl file which is "required" so woudn't get
686     # loaded again in another extension requiring a History.pl
687
688     # With perl5.002_01 the deletion of entries in %INC caused Tk-b11
689     # to core dump in the middle of a require statement. The required
690     # file was Tk/MMutil.pm.  The consequence is, we have to be
691     # extremely careful when we try to give perl a reason to reload a
692     # library with same name.  The workaround prefers to drop nothing
693     # from %INC and teach the writers not to use such libraries.
694
695 #    my $inc;
696 #    foreach $inc (keys %INC) {
697 #       #warn "***$inc*** deleted";
698 #       delete $INC{$inc};
699 #    }
700 }
701
702 sub skipcheck {
703     my($self) = shift;
704     my($section) = @_;
705     if ($section eq 'dynamic') {
706         print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
707         "in skipped section 'dynamic_bs'\n"
708             if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
709         print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
710         "in skipped section 'dynamic_lib'\n"
711             if $self->{SKIPHASH}{dynamic_lib} && $Verbose;
712     }
713     if ($section eq 'dynamic_lib') {
714         print STDOUT "Warning (non-fatal): Target '\$(INST_DYNAMIC)' depends on ",
715         "targets in skipped section 'dynamic_bs'\n"
716             if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
717     }
718     if ($section eq 'static') {
719         print STDOUT "Warning (non-fatal): Target 'static' depends on targets ",
720         "in skipped section 'static_lib'\n"
721             if $self->{SKIPHASH}{static_lib} && $Verbose;
722     }
723     return 'skipped' if $self->{SKIPHASH}{$section};
724     return '';
725 }
726
727 sub flush {
728     my $self = shift;
729     my($chunk);
730 #    use FileHandle ();
731 #    my $fh = new FileHandle;
732     local *FH;
733     print STDOUT "Writing $self->{MAKEFILE} for $self->{NAME}\n";
734
735     unlink($self->{MAKEFILE}, "MakeMaker.tmp", $Is_VMS ? 'Descrip.MMS' : '');
736 #    $fh->open(">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
737     open(FH,">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
738
739     for $chunk (@{$self->{RESULT}}) {
740 #       print $fh "$chunk\n";
741         print FH "$chunk\n";
742     }
743
744 #    $fh->close;
745     close FH;
746     my($finalname) = $self->{MAKEFILE};
747     rename("MakeMaker.tmp", $finalname);
748     chmod 0644, $finalname unless $Is_VMS;
749
750     if ($self->{PARENT}) {
751         foreach (keys %$self) { # safe memory
752             delete $self->{$_} unless $Keep_after_flush{$_};
753         }
754     }
755
756     system("$Config::Config{eunicefix} $finalname") unless $Config::Config{eunicefix} eq ":";
757 }
758
759 # The following mkbootstrap() is only for installations that are calling
760 # the pre-4.1 mkbootstrap() from their old Makefiles. This MakeMaker
761 # writes Makefiles, that use ExtUtils::Mkbootstrap directly.
762 sub mkbootstrap {
763     die <<END;
764 !!! Your Makefile has been built such a long time ago, !!!
765 !!! that is unlikely to work with current MakeMaker.   !!!
766 !!! Please rebuild your Makefile                       !!!
767 END
768 }
769
770 # Ditto for mksymlists() as of MakeMaker 5.17
771 sub mksymlists {
772     die <<END;
773 !!! Your Makefile has been built such a long time ago, !!!
774 !!! that is unlikely to work with current MakeMaker.   !!!
775 !!! Please rebuild your Makefile                       !!!
776 END
777 }
778
779 sub neatvalue {
780     my($v) = @_;
781     return "undef" unless defined $v;
782     my($t) = ref $v;
783     return "q[$v]" unless $t;
784     if ($t eq 'ARRAY') {
785         my(@m, $elem, @neat);
786         push @m, "[";
787         foreach $elem (@$v) {
788             push @neat, "q[$elem]";
789         }
790         push @m, join ", ", @neat;
791         push @m, "]";
792         return join "", @m;
793     }
794     return "$v" unless $t eq 'HASH';
795     my(@m, $key, $val);
796     while (($key,$val) = each %$v){
797         last unless defined $key; # cautious programming in case (undef,undef) is true
798         push(@m,"$key=>".neatvalue($val)) ;
799     }
800     return "{ ".join(', ',@m)." }";
801 }
802
803 sub selfdocument {
804     my($self) = @_;
805     my(@m);
806     if ($Verbose){
807         push @m, "\n# Full list of MakeMaker attribute values:";
808         foreach $key (sort keys %$self){
809             next if $key eq 'RESULT' || $key =~ /^[A-Z][a-z]/;
810             my($v) = neatvalue($self->{$key});
811             $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
812             $v =~ tr/\n/ /s;
813             push @m, "# $key => $v";
814         }
815     }
816     join "\n", @m;
817 }
818
819 package ExtUtils::MakeMaker;
820 1;
821
822 __END__
823
824 =head1 NAME
825
826 ExtUtils::MakeMaker - create an extension Makefile
827
828 =head1 SYNOPSIS
829
830 C<use ExtUtils::MakeMaker;>
831
832 C<WriteMakefile( ATTRIBUTE =E<gt> VALUE [, ...] );>
833
834 which is really
835
836 C<MM-E<gt>new(\%att)-E<gt>flush;>
837
838 =head1 DESCRIPTION
839
840 This utility is designed to write a Makefile for an extension module
841 from a Makefile.PL. It is based on the Makefile.SH model provided by
842 Andy Dougherty and the perl5-porters.
843
844 It splits the task of generating the Makefile into several subroutines
845 that can be individually overridden.  Each subroutine returns the text
846 it wishes to have written to the Makefile.
847
848 MakeMaker is object oriented. Each directory below the current
849 directory that contains a Makefile.PL. Is treated as a separate
850 object. This makes it possible to write an unlimited number of
851 Makefiles with a single invocation of WriteMakefile().
852
853 =head2 How To Write A Makefile.PL
854
855 The short answer is: Don't.
856
857         Always begin with h2xs.
858         Always begin with h2xs!
859         ALWAYS BEGIN WITH H2XS!
860
861 even if you're not building around a header file, and even if you
862 don't have an XS component.
863
864 Run h2xs(1) before you start thinking about writing a module. For so
865 called pm-only modules that consist of C<*.pm> files only, h2xs has
866 the C<-X> switch. This will generate dummy files of all kinds that are
867 useful for the module developer.
868
869 The medium answer is:
870
871     use ExtUtils::MakeMaker;
872     WriteMakefile( NAME => "Foo::Bar" );
873
874 The long answer is the rest of the manpage :-)
875
876 =head2 Default Makefile Behaviour
877
878 The generated Makefile enables the user of the extension to invoke
879
880   perl Makefile.PL # optionally "perl Makefile.PL verbose"
881   make
882   make test        # optionally set TEST_VERBOSE=1
883   make install     # See below
884
885 The Makefile to be produced may be altered by adding arguments of the
886 form C<KEY=VALUE>. E.g.
887
888   perl Makefile.PL PREFIX=/tmp/myperl5
889
890 Other interesting targets in the generated Makefile are
891
892   make config     # to check if the Makefile is up-to-date
893   make clean      # delete local temp files (Makefile gets renamed)
894   make realclean  # delete derived files (including ./blib)
895   make ci         # check in all the files in the MANIFEST file
896   make dist       # see below the Distribution Support section
897
898 =head2 make test
899
900 MakeMaker checks for the existence of a file named F<test.pl> in the
901 current directory and if it exists it adds commands to the test target
902 of the generated Makefile that will execute the script with the proper
903 set of perl C<-I> options.
904
905 MakeMaker also checks for any files matching glob("t/*.t"). It will
906 add commands to the test target of the generated Makefile that execute
907 all matching files via the L<Test::Harness> module with the C<-I>
908 switches set correctly.
909
910 =head2 make testdb
911
912 A useful variation of the above is the target C<testdb>. It runs the
913 test under the Perl debugger (see L<perldebug>). If the file
914 F<test.pl> exists in the current directory, it is used for the test.
915
916 If you want to debug some other testfile, set C<TEST_FILE> variable
917 thusly:
918
919   make testdb TEST_FILE=t/mytest.t
920
921 By default the debugger is called using C<-d> option to perl. If you
922 want to specify some other option, set C<TESTDB_SW> variable:
923
924   make testdb TESTDB_SW=-Dx
925
926 =head2 make install
927
928 make alone puts all relevant files into directories that are named by
929 the macros INST_LIB, INST_ARCHLIB, INST_SCRIPT, INST_MAN1DIR, and
930 INST_MAN3DIR. All these default to something below ./blib if you are
931 I<not> building below the perl source directory. If you I<are>
932 building below the perl source, INST_LIB and INST_ARCHLIB default to
933  ../../lib, and INST_SCRIPT is not defined.
934
935 The I<install> target of the generated Makefile copies the files found
936 below each of the INST_* directories to their INSTALL*
937 counterparts. Which counterparts are chosen depends on the setting of
938 INSTALLDIRS according to the following table:
939
940                            INSTALLDIRS set to
941                         perl              site
942
943     INST_ARCHLIB    INSTALLARCHLIB    INSTALLSITEARCH
944     INST_LIB        INSTALLPRIVLIB    INSTALLSITELIB
945     INST_BIN                  INSTALLBIN
946     INST_SCRIPT              INSTALLSCRIPT
947     INST_MAN1DIR             INSTALLMAN1DIR
948     INST_MAN3DIR             INSTALLMAN3DIR
949
950 The INSTALL... macros in turn default to their %Config
951 ($Config{installprivlib}, $Config{installarchlib}, etc.) counterparts.
952
953 You can check the values of these variables on your system with
954
955     perl '-V:install.*'
956
957 And to check the sequence in which the library directories are
958 searched by perl, run
959
960     perl -le 'print join $/, @INC'
961
962
963 =head2 PREFIX and LIB attribute
964
965 PREFIX and LIB can be used to set several INSTALL* attributes in one
966 go. The quickest way to install a module in a non-standard place might
967 be
968
969     perl Makefile.PL LIB=~/lib
970
971 This will install the module's architecture-independent files into
972 ~/lib, the architecture-dependent files into ~/lib/$archname/auto.
973
974 Another way to specify many INSTALL directories with a single
975 parameter is PREFIX.
976
977     perl Makefile.PL PREFIX=~
978
979 This will replace the string specified by $Config{prefix} in all
980 $Config{install*} values.
981
982 Note, that in both cases the tilde expansion is done by MakeMaker, not
983 by perl by default, nor by make. Conflicts between parmeters LIB,
984 PREFIX and the various INSTALL* arguments are resolved so that 
985 XXX
986
987 If the user has superuser privileges, and is not working on AFS
988 (Andrew File System) or relatives, then the defaults for
989 INSTALLPRIVLIB, INSTALLARCHLIB, INSTALLSCRIPT, etc. will be appropriate,
990 and this incantation will be the best:
991
992     perl Makefile.PL; make; make test
993     make install
994
995 make install per default writes some documentation of what has been
996 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This feature
997 can be bypassed by calling make pure_install.
998
999 =head2 AFS users
1000
1001 will have to specify the installation directories as these most
1002 probably have changed since perl itself has been installed. They will
1003 have to do this by calling
1004
1005     perl Makefile.PL INSTALLSITELIB=/afs/here/today \
1006         INSTALLSCRIPT=/afs/there/now INSTALLMAN3DIR=/afs/for/manpages
1007     make
1008
1009 Be careful to repeat this procedure every time you recompile an
1010 extension, unless you are sure the AFS installation directories are
1011 still valid.
1012
1013 =head2 Static Linking of a new Perl Binary
1014
1015 An extension that is built with the above steps is ready to use on
1016 systems supporting dynamic loading. On systems that do not support
1017 dynamic loading, any newly created extension has to be linked together
1018 with the available resources. MakeMaker supports the linking process
1019 by creating appropriate targets in the Makefile whenever an extension
1020 is built. You can invoke the corresponding section of the makefile with
1021
1022     make perl
1023
1024 That produces a new perl binary in the current directory with all
1025 extensions linked in that can be found in INST_ARCHLIB , SITELIBEXP,
1026 and PERL_ARCHLIB. To do that, MakeMaker writes a new Makefile, on
1027 UNIX, this is called Makefile.aperl (may be system dependent). If you
1028 want to force the creation of a new perl, it is recommended, that you
1029 delete this Makefile.aperl, so the directories are searched-through
1030 for linkable libraries again.
1031
1032 The binary can be installed into the directory where perl normally
1033 resides on your machine with
1034
1035     make inst_perl
1036
1037 To produce a perl binary with a different name than C<perl>, either say
1038
1039     perl Makefile.PL MAP_TARGET=myperl
1040     make myperl
1041     make inst_perl
1042
1043 or say
1044
1045     perl Makefile.PL
1046     make myperl MAP_TARGET=myperl
1047     make inst_perl MAP_TARGET=myperl
1048
1049 In any case you will be prompted with the correct invocation of the
1050 C<inst_perl> target that installs the new binary into INSTALLBIN.
1051
1052 make inst_perl per default writes some documentation of what has been
1053 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This
1054 can be bypassed by calling make pure_inst_perl.
1055
1056 Warning: the inst_perl: target will most probably overwrite your
1057 existing perl binary. Use with care!
1058
1059 Sometimes you might want to build a statically linked perl although
1060 your system supports dynamic loading. In this case you may explicitly
1061 set the linktype with the invocation of the Makefile.PL or make:
1062
1063     perl Makefile.PL LINKTYPE=static    # recommended
1064
1065 or
1066
1067     make LINKTYPE=static                # works on most systems
1068
1069 =head2 Determination of Perl Library and Installation Locations
1070
1071 MakeMaker needs to know, or to guess, where certain things are
1072 located.  Especially INST_LIB and INST_ARCHLIB (where to put the files
1073 during the make(1) run), PERL_LIB and PERL_ARCHLIB (where to read
1074 existing modules from), and PERL_INC (header files and C<libperl*.*>).
1075
1076 Extensions may be built either using the contents of the perl source
1077 directory tree or from the installed perl library. The recommended way
1078 is to build extensions after you have run 'make install' on perl
1079 itself. You can do that in any directory on your hard disk that is not
1080 below the perl source tree. The support for extensions below the ext
1081 directory of the perl distribution is only good for the standard
1082 extensions that come with perl.
1083
1084 If an extension is being built below the C<ext/> directory of the perl
1085 source then MakeMaker will set PERL_SRC automatically (e.g.,
1086 C<../..>).  If PERL_SRC is defined and the extension is recognized as
1087 a standard extension, then other variables default to the following:
1088
1089   PERL_INC     = PERL_SRC
1090   PERL_LIB     = PERL_SRC/lib
1091   PERL_ARCHLIB = PERL_SRC/lib
1092   INST_LIB     = PERL_LIB
1093   INST_ARCHLIB = PERL_ARCHLIB
1094
1095 If an extension is being built away from the perl source then MakeMaker
1096 will leave PERL_SRC undefined and default to using the installed copy
1097 of the perl library. The other variables default to the following:
1098
1099   PERL_INC     = $archlibexp/CORE
1100   PERL_LIB     = $privlibexp
1101   PERL_ARCHLIB = $archlibexp
1102   INST_LIB     = ./blib/lib
1103   INST_ARCHLIB = ./blib/arch
1104
1105 If perl has not yet been installed then PERL_SRC can be defined on the
1106 command line as shown in the previous section.
1107
1108
1109 =head2 Which architecture dependent directory?
1110
1111 If you don't want to keep the defaults for the INSTALL* macros,
1112 MakeMaker helps you to minimize the typing needed: the usual
1113 relationship between INSTALLPRIVLIB and INSTALLARCHLIB is determined
1114 by Configure at perl compilation time. MakeMaker supports the user who
1115 sets INSTALLPRIVLIB. If INSTALLPRIVLIB is set, but INSTALLARCHLIB not,
1116 then MakeMaker defaults the latter to be the same subdirectory of
1117 INSTALLPRIVLIB as Configure decided for the counterparts in %Config ,
1118 otherwise it defaults to INSTALLPRIVLIB. The same relationship holds
1119 for INSTALLSITELIB and INSTALLSITEARCH.
1120
1121 MakeMaker gives you much more freedom than needed to configure
1122 internal variables and get different results. It is worth to mention,
1123 that make(1) also lets you configure most of the variables that are
1124 used in the Makefile. But in the majority of situations this will not
1125 be necessary, and should only be done, if the author of a package
1126 recommends it (or you know what you're doing).
1127
1128 =head2 Using Attributes and Parameters
1129
1130 The following attributes can be specified as arguments to WriteMakefile()
1131 or as NAME=VALUE pairs on the command line:
1132
1133 =cut
1134
1135 # The following "=item C" is used by the attrib_help routine
1136 # likewise the "=back" below. So be careful when changing it!
1137
1138 =over 2
1139
1140 =item C
1141
1142 Ref to array of *.c file names. Initialised from a directory scan
1143 and the values portion of the XS attribute hash. This is not
1144 currently used by MakeMaker but may be handy in Makefile.PLs.
1145
1146 =item CONFIG
1147
1148 Arrayref. E.g. [qw(archname manext)] defines ARCHNAME & MANEXT from
1149 config.sh. MakeMaker will add to CONFIG the following values anyway:
1150 ar
1151 cc
1152 cccdlflags
1153 ccdlflags
1154 dlext
1155 dlsrc
1156 ld
1157 lddlflags
1158 ldflags
1159 libc
1160 lib_ext
1161 obj_ext
1162 ranlib
1163 sitelibexp
1164 sitearchexp
1165 so
1166
1167 =item CONFIGURE
1168
1169 CODE reference. The subroutine should return a hash reference. The
1170 hash may contain further attributes, e.g. {LIBS =E<gt> ...}, that have to
1171 be determined by some evaluation method.
1172
1173 =item DEFINE
1174
1175 Something like C<"-DHAVE_UNISTD_H">
1176
1177 =item DIR
1178
1179 Ref to array of subdirectories containing Makefile.PLs e.g. [ 'sdbm'
1180 ] in ext/SDBM_File
1181
1182 =item DISTNAME
1183
1184 Your name for distributing the package (by tar file). This defaults to
1185 NAME above.
1186
1187 =item DL_FUNCS
1188
1189 Hashref of symbol names for routines to be made available as
1190 universal symbols.  Each key/value pair consists of the package name
1191 and an array of routine names in that package.  Used only under AIX
1192 (export lists) and VMS (linker options) at present.  The routine
1193 names supplied will be expanded in the same way as XSUB names are
1194 expanded by the XS() macro.  Defaults to
1195
1196   {"$(NAME)" => ["boot_$(NAME)" ] }
1197
1198 e.g.
1199
1200   {"RPC" => [qw( boot_rpcb rpcb_gettime getnetconfigent )],
1201    "NetconfigPtr" => [ 'DESTROY'] }
1202
1203 =item DL_VARS
1204
1205 Array of symbol names for variables to be made available as
1206 universal symbols.  Used only under AIX (export lists) and VMS
1207 (linker options) at present.  Defaults to [].  (e.g. [ qw(
1208 Foo_version Foo_numstreams Foo_tree ) ])
1209
1210 =item EXCLUDE_EXT
1211
1212 Array of extension names to exclude when doing a static build.  This
1213 is ignored if INCLUDE_EXT is present.  Consult INCLUDE_EXT for more
1214 details.  (e.g.  [ qw( Socket POSIX ) ] )
1215
1216 This attribute may be most useful when specified as a string on the
1217 commandline:  perl Makefile.PL EXCLUDE_EXT='Socket Safe'
1218
1219 =item EXE_FILES
1220
1221 Ref to array of executable files. The files will be copied to the
1222 INST_SCRIPT directory. Make realclean will delete them from there
1223 again.
1224
1225 =item NO_VC
1226
1227 In general any generated Makefile checks for the current version of
1228 MakeMaker and the version the Makefile was built under. If NO_VC is
1229 set, the version check is neglected. Do not write this into your
1230 Makefile.PL, use it interactively instead.
1231
1232 =item FIRST_MAKEFILE
1233
1234 The name of the Makefile to be produced. Defaults to the contents of
1235 MAKEFILE, but can be overridden. This is used for the second Makefile
1236 that will be produced for the MAP_TARGET.
1237
1238 =item FULLPERL
1239
1240 Perl binary able to run this extension.
1241
1242 =item H
1243
1244 Ref to array of *.h file names. Similar to C.
1245
1246 =item INC
1247
1248 Include file dirs eg: C<"-I/usr/5include -I/path/to/inc">
1249
1250 =item INCLUDE_EXT
1251
1252 Array of extension names to be included when doing a static build.
1253 MakeMaker will normally build with all of the installed extensions when
1254 doing a static build, and that is usually the desired behavior.  If
1255 INCLUDE_EXT is present then MakeMaker will build only with those extensions
1256 which are explicitly mentioned. (e.g.  [ qw( Socket POSIX ) ])
1257
1258 It is not necessary to mention DynaLoader or the current extension when
1259 filling in INCLUDE_EXT.  If the INCLUDE_EXT is mentioned but is empty then
1260 only DynaLoader and the current extension will be included in the build.
1261
1262 This attribute may be most useful when specified as a string on the
1263 commandline:  perl Makefile.PL INCLUDE_EXT='POSIX Socket Devel::Peek'
1264
1265 =item INSTALLARCHLIB
1266
1267 Used by 'make install', which copies files from INST_ARCHLIB to this
1268 directory if INSTALLDIRS is set to perl.
1269
1270 =item INSTALLBIN
1271
1272 Directory to install binary files (e.g. tkperl) into.
1273
1274 =item INSTALLDIRS
1275
1276 Determines which of the two sets of installation directories to
1277 choose: installprivlib and installarchlib versus installsitelib and
1278 installsitearch. The first pair is chosen with INSTALLDIRS=perl, the
1279 second with INSTALLDIRS=site. Default is site.
1280
1281 =item INSTALLMAN1DIR
1282
1283 This directory gets the man pages at 'make install' time. Defaults to
1284 $Config{installman1dir}.
1285
1286 =item INSTALLMAN3DIR
1287
1288 This directory gets the man pages at 'make install' time. Defaults to
1289 $Config{installman3dir}.
1290
1291 =item INSTALLPRIVLIB
1292
1293 Used by 'make install', which copies files from INST_LIB to this
1294 directory if INSTALLDIRS is set to perl.
1295
1296 =item INSTALLSCRIPT
1297
1298 Used by 'make install' which copies files from INST_SCRIPT to this
1299 directory.
1300
1301 =item INSTALLSITELIB
1302
1303 Used by 'make install', which copies files from INST_LIB to this
1304 directory if INSTALLDIRS is set to site (default).
1305
1306 =item INSTALLSITEARCH
1307
1308 Used by 'make install', which copies files from INST_ARCHLIB to this
1309 directory if INSTALLDIRS is set to site (default).
1310
1311 =item INST_ARCHLIB
1312
1313 Same as INST_LIB for architecture dependent files.
1314
1315 =item INST_BIN
1316
1317 Directory to put real binary files during 'make'. These will be copied
1318 to INSTALLBIN during 'make install'
1319
1320 =item INST_EXE
1321
1322 Old name for INST_SCRIPT. Deprecated. Please use INST_SCRIPT if you
1323 need to use it.
1324
1325 =item INST_LIB
1326
1327 Directory where we put library files of this extension while building
1328 it.
1329
1330 =item INST_MAN1DIR
1331
1332 Directory to hold the man pages at 'make' time
1333
1334 =item INST_MAN3DIR
1335
1336 Directory to hold the man pages at 'make' time
1337
1338 =item INST_SCRIPT
1339
1340 Directory, where executable files should be installed during
1341 'make'. Defaults to "./blib/bin", just to have a dummy location during
1342 testing. make install will copy the files in INST_SCRIPT to
1343 INSTALLSCRIPT.
1344
1345 =item LDFROM
1346
1347 defaults to "$(OBJECT)" and is used in the ld command to specify
1348 what files to link/load from (also see dynamic_lib below for how to
1349 specify ld flags)
1350
1351 =item LIBPERL_A
1352
1353 The filename of the perllibrary that will be used together with this
1354 extension. Defaults to libperl.a.
1355
1356 =item LIB
1357
1358 LIB can only be set at C<perl Makefile.PL> time. It has the effect of
1359 setting both INSTALLPRIVLIB and INSTALLSITELIB to that value regardless any
1360
1361 =item LIBS
1362
1363 An anonymous array of alternative library
1364 specifications to be searched for (in order) until
1365 at least one library is found. E.g.
1366
1367   'LIBS' => ["-lgdbm", "-ldbm -lfoo", "-L/path -ldbm.nfs"]
1368
1369 Mind, that any element of the array
1370 contains a complete set of arguments for the ld
1371 command. So do not specify
1372
1373   'LIBS' => ["-ltcl", "-ltk", "-lX11"]
1374
1375 See ODBM_File/Makefile.PL for an example, where an array is needed. If
1376 you specify a scalar as in
1377
1378   'LIBS' => "-ltcl -ltk -lX11"
1379
1380 MakeMaker will turn it into an array with one element.
1381
1382 =item LINKTYPE
1383
1384 'static' or 'dynamic' (default unless usedl=undef in
1385 config.sh). Should only be used to force static linking (also see
1386 linkext below).
1387
1388 =item MAKEAPERL
1389
1390 Boolean which tells MakeMaker, that it should include the rules to
1391 make a perl. This is handled automatically as a switch by
1392 MakeMaker. The user normally does not need it.
1393
1394 =item MAKEFILE
1395
1396 The name of the Makefile to be produced.
1397
1398 =item MAN1PODS
1399
1400 Hashref of pod-containing files. MakeMaker will default this to all
1401 EXE_FILES files that include POD directives. The files listed
1402 here will be converted to man pages and installed as was requested
1403 at Configure time.
1404
1405 =item MAN3PODS
1406
1407 Hashref of .pm and .pod files. MakeMaker will default this to all
1408  .pod and any .pm files that include POD directives. The files listed
1409 here will be converted to man pages and installed as was requested
1410 at Configure time.
1411
1412 =item MAP_TARGET
1413
1414 If it is intended, that a new perl binary be produced, this variable
1415 may hold a name for that binary. Defaults to perl
1416
1417 =item MYEXTLIB
1418
1419 If the extension links to a library that it builds set this to the
1420 name of the library (see SDBM_File)
1421
1422 =item NAME
1423
1424 Perl module name for this extension (DBD::Oracle). This will default
1425 to the directory name but should be explicitly defined in the
1426 Makefile.PL.
1427
1428 =item NEEDS_LINKING
1429
1430 MakeMaker will figure out, if an extension contains linkable code
1431 anywhere down the directory tree, and will set this variable
1432 accordingly, but you can speed it up a very little bit, if you define
1433 this boolean variable yourself.
1434
1435 =item NOECHO
1436
1437 Defaults to C<@>. By setting it to an empty string you can generate a
1438 Makefile that echos all commands. Mainly used in debugging MakeMaker
1439 itself.
1440
1441 =item NORECURS
1442
1443 Boolean.  Attribute to inhibit descending into subdirectories.
1444
1445 =item OBJECT
1446
1447 List of object files, defaults to '$(BASEEXT)$(OBJ_EXT)', but can be a long
1448 string containing all object files, e.g. "tkpBind.o
1449 tkpButton.o tkpCanvas.o"
1450
1451 =item OPTIMIZE
1452
1453 Defaults to C<-O>. Set it to C<-g> to turn debugging on. The flag is
1454 passed to subdirectory makes.
1455
1456 =item PERL
1457
1458 Perl binary for tasks that can be done by miniperl
1459
1460 =item PERLMAINCC
1461
1462 The call to the program that is able to compile perlmain.c. Defaults
1463 to $(CC).
1464
1465 =item PERL_ARCHLIB
1466
1467 Same as above for architecture dependent files
1468
1469 =item PERL_LIB
1470
1471 Directory containing the Perl library to use.
1472
1473 =item PERL_SRC
1474
1475 Directory containing the Perl source code (use of this should be
1476 avoided, it may be undefined)
1477
1478 =item PL_FILES
1479
1480 Ref to hash of files to be processed as perl programs. MakeMaker
1481 will default to any found *.PL file (except Makefile.PL) being keys
1482 and the basename of the file being the value. E.g.
1483
1484   {'foobar.PL' => 'foobar'}
1485
1486 The *.PL files are expected to produce output to the target files
1487 themselves.
1488
1489 =item PM
1490
1491 Hashref of .pm files and *.pl files to be installed.  e.g.
1492
1493   {'name_of_file.pm' => '$(INST_LIBDIR)/install_as.pm'}
1494
1495 By default this will include *.pm and *.pl. If a lib directory
1496 exists and is not listed in DIR (above) then any *.pm and *.pl files
1497 it contains will also be included by default.  Defining PM in the
1498 Makefile.PL will override PMLIBDIRS.
1499
1500 =item PMLIBDIRS
1501
1502 Ref to array of subdirectories containing library files.  Defaults to
1503 [ 'lib', $(BASEEXT) ]. The directories will be scanned and any files
1504 they contain will be installed in the corresponding location in the
1505 library.  A libscan() method can be used to alter the behaviour.
1506 Defining PM in the Makefile.PL will override PMLIBDIRS.
1507
1508 =item PREFIX
1509
1510 Can be used to set the three INSTALL* attributes in one go (except for
1511 probably INSTALLMAN1DIR, if it is not below PREFIX according to
1512 %Config).  They will have PREFIX as a common directory node and will
1513 branch from that node into lib/, lib/ARCHNAME or whatever Configure
1514 decided at the build time of your perl (unless you override one of
1515 them, of course).
1516
1517 =item PREREQ_PM
1518
1519 Hashref: Names of modules that need to be available to run this
1520 extension (e.g. Fcntl for SDBM_File) are the keys of the hash and the
1521 desired version is the value. If the required version number is 0, we
1522 only check if any version is installed already.
1523
1524 =item SKIP
1525
1526 Arryref. E.g. [qw(name1 name2)] skip (do not write) sections of the
1527 Makefile. Caution! Do not use the SKIP attribute for the neglectible
1528 speedup. It may seriously damage the resulting Makefile. Only use it,
1529 if you really need it.
1530
1531 =item TYPEMAPS
1532
1533 Ref to array of typemap file names.  Use this when the typemaps are
1534 in some directory other than the current directory or when they are
1535 not named B<typemap>.  The last typemap in the list takes
1536 precedence.  A typemap in the current directory has highest
1537 precedence, even if it isn't listed in TYPEMAPS.  The default system
1538 typemap has lowest precedence.
1539
1540 =item VERSION
1541
1542 Your version number for distributing the package.  This defaults to
1543 0.1.
1544
1545 =item VERSION_FROM
1546
1547 Instead of specifying the VERSION in the Makefile.PL you can let
1548 MakeMaker parse a file to determine the version number. The parsing
1549 routine requires that the file named by VERSION_FROM contains one
1550 single line to compute the version number. The first line in the file
1551 that contains the regular expression
1552
1553     /\$(([\w\:\']*)\bVERSION)\b.*\=/
1554
1555 will be evaluated with eval() and the value of the named variable
1556 B<after> the eval() will be assigned to the VERSION attribute of the
1557 MakeMaker object. The following lines will be parsed o.k.:
1558
1559     $VERSION = '1.00';
1560     ( $VERSION ) = '$Revision: 1.211 $ ' =~ /\$Revision:\s+([^\s]+)/;
1561     $FOO::VERSION = '1.10';
1562
1563 but these will fail:
1564
1565     my $VERSION = '1.01';
1566     local $VERSION = '1.02';
1567     local $FOO::VERSION = '1.30';
1568
1569 The file named in VERSION_FROM is added as a dependency to Makefile to
1570 guarantee, that the Makefile contains the correct VERSION macro after
1571 a change of the file.
1572
1573 =item XS
1574
1575 Hashref of .xs files. MakeMaker will default this.  e.g.
1576
1577   {'name_of_file.xs' => 'name_of_file.c'}
1578
1579 The .c files will automatically be included in the list of files
1580 deleted by a make clean.
1581
1582 =item XSOPT
1583
1584 String of options to pass to xsubpp.  This might include C<-C++> or
1585 C<-extern>.  Do not include typemaps here; the TYPEMAP parameter exists for
1586 that purpose.
1587
1588 =item XSPROTOARG
1589
1590 May be set to an empty string, which is identical to C<-prototypes>, or
1591 C<-noprototypes>. See the xsubpp documentation for details. MakeMaker
1592 defaults to the empty string.
1593
1594 =item XS_VERSION
1595
1596 Your version number for the .xs file of this package.  This defaults
1597 to the value of the VERSION attribute.
1598
1599 =back
1600
1601 =head2 Additional lowercase attributes
1602
1603 can be used to pass parameters to the methods which implement that
1604 part of the Makefile.
1605
1606 =over 2
1607
1608 =item clean
1609
1610   {FILES => "*.xyz foo"}
1611
1612 =item depend
1613
1614   {ANY_TARGET => ANY_DEPENDECY, ...}
1615
1616 =item dist
1617
1618   {TARFLAGS => 'cvfF', COMPRESS => 'gzip', SUFFIX => 'gz',
1619   SHAR => 'shar -m', DIST_CP => 'ln', ZIP => '/bin/zip',
1620   ZIPFLAGS => '-rl', DIST_DEFAULT => 'private tardist' }
1621
1622 If you specify COMPRESS, then SUFFIX should also be altered, as it is
1623 needed to tell make the target file of the compression. Setting
1624 DIST_CP to ln can be useful, if you need to preserve the timestamps on
1625 your files. DIST_CP can take the values 'cp', which copies the file,
1626 'ln', which links the file, and 'best' which copies symbolic links and
1627 links the rest. Default is 'best'.
1628
1629 =item dynamic_lib
1630
1631   {ARMAYBE => 'ar', OTHERLDFLAGS => '...', INST_DYNAMIC_DEP => '...'}
1632
1633 =item installpm
1634
1635 Deprecated as of MakeMaker 5.23. See L<ExtUtils::MM_Unix/pm_to_blib>.
1636
1637 =item linkext
1638
1639   {LINKTYPE => 'static', 'dynamic' or ''}
1640
1641 NB: Extensions that have nothing but *.pm files had to say
1642
1643   {LINKTYPE => ''}
1644
1645 with Pre-5.0 MakeMakers. Since version 5.00 of MakeMaker such a line
1646 can be deleted safely. MakeMaker recognizes, when there's nothing to
1647 be linked.
1648
1649 =item macro
1650
1651   {ANY_MACRO => ANY_VALUE, ...}
1652
1653 =item realclean
1654
1655   {FILES => '$(INST_ARCHAUTODIR)/*.xyz'}
1656
1657 =item tool_autosplit
1658
1659   {MAXLEN =E<gt> 8}
1660
1661 =back
1662
1663 =cut
1664
1665 # bug in pod2html, so leave the =back
1666
1667 # Don't delete this cut, MM depends on it!
1668
1669 =head2 Overriding MakeMaker Methods
1670
1671 If you cannot achieve the desired Makefile behaviour by specifying
1672 attributes you may define private subroutines in the Makefile.PL.
1673 Each subroutines returns the text it wishes to have written to
1674 the Makefile. To override a section of the Makefile you can
1675 either say:
1676
1677         sub MY::c_o { "new literal text" }
1678
1679 or you can edit the default by saying something like:
1680
1681         sub MY::c_o {
1682             my($inherited) = shift->SUPER::c_o(@_);
1683             $inherited =~ s/old text/new text/;
1684             $inherited;
1685         }
1686
1687 If you running experiments with embedding perl as a library into other
1688 applications, you might find MakeMaker not sufficient. You'd better
1689 have a look at ExtUtils::embed which is a collection of utilities for
1690 embedding.
1691
1692 If you still need a different solution, try to develop another
1693 subroutine, that fits your needs and submit the diffs to
1694 F<perl5-porters@nicoh.com> or F<comp.lang.perl.misc> as appropriate.
1695
1696 For a complete description of all MakeMaker methods see L<ExtUtils::MM_Unix>.
1697
1698 Here is a simple example of how to add a new target to the generated
1699 Makefile:
1700
1701     sub MY::postamble {
1702         '
1703     $(MYEXTLIB): sdbm/Makefile
1704             cd sdbm && $(MAKE) all
1705     ';
1706     }
1707
1708
1709 =head2 Hintsfile support
1710
1711 MakeMaker.pm uses the architecture specific information from
1712 Config.pm. In addition it evaluates architecture specific hints files
1713 in a C<hints/> directory. The hints files are expected to be named
1714 like their counterparts in C<PERL_SRC/hints>, but with an C<.pl> file
1715 name extension (eg. C<next_3_2.pl>). They are simply C<eval>ed by
1716 MakeMaker within the WriteMakefile() subroutine, and can be used to
1717 execute commands as well as to include special variables. The rules
1718 which hintsfile is chosen are the same as in Configure.
1719
1720 The hintsfile is eval()ed immediately after the arguments given to
1721 WriteMakefile are stuffed into a hash reference $self but before this
1722 reference becomes blessed. So if you want to do the equivalent to
1723 override or create an attribute you would say something like
1724
1725     $self->{LIBS} = ['-ldbm -lucb -lc'];
1726
1727 =head2 Distribution Support
1728
1729 For authors of extensions MakeMaker provides several Makefile
1730 targets. Most of the support comes from the ExtUtils::Manifest module,
1731 where additional documentation can be found.
1732
1733 =over 4
1734
1735 =item    make distcheck
1736
1737 reports which files are below the build directory but not in the
1738 MANIFEST file and vice versa. (See ExtUtils::Manifest::fullcheck() for
1739 details)
1740
1741 =item    make skipcheck
1742
1743 reports which files are skipped due to the entries in the
1744 C<MANIFEST.SKIP> file (See ExtUtils::Manifest::skipcheck() for
1745 details)
1746
1747 =item    make distclean
1748
1749 does a realclean first and then the distcheck. Note that this is not
1750 needed to build a new distribution as long as you are sure, that the
1751 MANIFEST file is ok.
1752
1753 =item    make manifest
1754
1755 rewrites the MANIFEST file, adding all remaining files found (See
1756 ExtUtils::Manifest::mkmanifest() for details)
1757
1758 =item    make distdir
1759
1760 Copies all the files that are in the MANIFEST file to a newly created
1761 directory with the name C<$(DISTNAME)-$(VERSION)>. If that directory
1762 exists, it will be removed first.
1763
1764 =item   make disttest
1765
1766 Makes a distdir first, and runs a C<perl Makefile.PL>, a make, and
1767 a make test in that directory.
1768
1769 =item    make tardist
1770
1771 First does a distdir. Then a command $(PREOP) which defaults to a null
1772 command, followed by $(TOUNIX), which defaults to a null command under
1773 UNIX, and will convert files in distribution directory to UNIX format
1774 otherwise. Next it runs C<tar> on that directory into a tarfile and
1775 deletes the directory. Finishes with a command $(POSTOP) which
1776 defaults to a null command.
1777
1778 =item    make dist
1779
1780 Defaults to $(DIST_DEFAULT) which in turn defaults to tardist.
1781
1782 =item    make uutardist
1783
1784 Runs a tardist first and uuencodes the tarfile.
1785
1786 =item    make shdist
1787
1788 First does a distdir. Then a command $(PREOP) which defaults to a null
1789 command. Next it runs C<shar> on that directory into a sharfile and
1790 deletes the intermediate directory again. Finishes with a command
1791 $(POSTOP) which defaults to a null command.  Note: For shdist to work
1792 properly a C<shar> program that can handle directories is mandatory.
1793
1794 =item    make zipdist
1795
1796 First does a distdir. Then a command $(PREOP) which defaults to a null
1797 command. Runs C<$(ZIP) $(ZIPFLAGS)> on that directory into a
1798 zipfile. Then deletes that directory. Finishes with a command
1799 $(POSTOP) which defaults to a null command.
1800
1801 =item    make ci
1802
1803 Does a $(CI) and a $(RCS_LABEL) on all files in the MANIFEST file.
1804
1805 =back
1806
1807 Customization of the dist targets can be done by specifying a hash
1808 reference to the dist attribute of the WriteMakefile call. The
1809 following parameters are recognized:
1810
1811     CI           ('ci -u')
1812     COMPRESS     ('compress')
1813     POSTOP       ('@ :')
1814     PREOP        ('@ :')
1815     TO_UNIX      (depends on the system)
1816     RCS_LABEL    ('rcs -q -Nv$(VERSION_SYM):')
1817     SHAR         ('shar')
1818     SUFFIX       ('Z')
1819     TAR          ('tar')
1820     TARFLAGS     ('cvf')
1821     ZIP          ('zip')
1822     ZIPFLAGS     ('-r')
1823
1824 An example:
1825
1826     WriteMakefile( 'dist' => { COMPRESS=>"gzip", SUFFIX=>"gz" })
1827
1828 =head1 SEE ALSO
1829
1830 ExtUtils::MM_Unix, ExtUtils::Manifest, ExtUtils::testlib,
1831 ExtUtils::Install, ExtUtils::embed
1832
1833 =head1 AUTHORS
1834
1835 Andy Dougherty F<E<lt>doughera@lafcol.lafayette.eduE<gt>>, Andreas
1836 KE<ouml>nig F<E<lt>A.Koenig@franz.ww.TU-Berlin.DEE<gt>>, Tim Bunce
1837 F<E<lt>Tim.Bunce@ig.co.ukE<gt>>.  VMS support by Charles Bailey
1838 F<E<lt>bailey@genetics.upenn.eduE<gt>>. OS/2 support by Ilya
1839 Zakharevich F<E<lt>ilya@math.ohio-state.eduE<gt>>. Contact the
1840 makemaker mailing list C<mailto:makemaker@franz.ww.tu-berlin.de>, if
1841 you have any questions.
1842
1843 =cut