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