Merge branch 'master' of http://repo.or.cz/r/msysgit into devel
[msysgit/historical-msysgit.git] / lib / perl5 / 5.6.1 / ExtUtils / MakeMaker.pm
blob50a9a2c380c31742e00983444822c3071b2e4e81
1 BEGIN {require 5.002;} # MakeMaker 5.17 was the last MakeMaker that was compatible with perl5.001m
3 package ExtUtils::MakeMaker;
5 $VERSION = "5.45";
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+$//;
12 require Exporter;
13 use Config;
14 use Carp ();
15 #use FileHandle ();
17 use vars qw(
19 @ISA @EXPORT @EXPORT_OK $AUTOLOAD
20 $ISA_TTY $Is_Mac $Is_OS2 $Is_VMS $Revision
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
26 # use strict;
28 # &DynaLoader::mod2fname should be available to miniperl, thus
29 # should be a pseudo-builtin (cmp. os2.c).
30 #eval {require DynaLoader;};
33 # Set up the inheritance before we pull in the MM_* packages, because they
34 # import variables and functions from here
36 @ISA = qw(Exporter);
37 @EXPORT = qw(&WriteMakefile &writeMakefile $Verbose &prompt);
38 @EXPORT_OK = qw($VERSION &Version_check &neatvalue &mkbootstrap &mksymlists);
41 # Dummy package MM inherits actual methods from OS-specific
42 # default packages. We use this intermediate package so
43 # MY::XYZ->func() can call MM->func() and get the proper
44 # default routine without having to know under what OS
45 # it's running.
47 @MM::ISA = qw[ExtUtils::MM_Unix ExtUtils::Liblist::Kid ExtUtils::MakeMaker];
50 # Setup dummy package:
51 # MY exists for overriding methods to be defined within
54 package MY;
55 @MY::ISA = qw(MM);
56 ### sub AUTOLOAD { use Devel::Symdump; print Devel::Symdump->rnew->as_string; Carp::confess "hey why? $AUTOLOAD" }
57 package MM;
58 sub DESTROY {}
61 # "predeclare the package: we only load it via AUTOLOAD
62 # but we have already mentioned it in @ISA
63 package ExtUtils::Liblist::Kid;
65 package ExtUtils::MakeMaker;
67 # Now we can pull in the friends
69 $Is_VMS = $^O eq 'VMS';
70 $Is_OS2 = $^O eq 'os2';
71 $Is_Mac = $^O eq 'MacOS';
72 $Is_Win32 = $^O eq 'MSWin32';
73 $Is_Cygwin= $^O eq 'cygwin';
74 $Is_Msys = $^O eq 'msys';
76 require ExtUtils::MM_Unix;
78 if ($Is_VMS) {
79 require ExtUtils::MM_VMS;
80 require VMS::Filespec; # is a noop as long as we require it within MM_VMS
82 if ($Is_OS2) {
83 require ExtUtils::MM_OS2;
85 if ($Is_Mac) {
86 require ExtUtils::MM_MacOS;
88 if ($Is_Win32) {
89 require ExtUtils::MM_Win32;
91 if ($Is_Cygwin) {
92 require ExtUtils::MM_Cygwin;
94 if ($Is_Msys) {
95 require ExtUtils::MM_Msys;
98 full_setup();
100 # The use of the Version_check target has been dropped between perl
101 # 5.5.63 and 5.5.64. We must keep the subroutine for a while so that
102 # old Makefiles can satisfy the Version_check target.
104 sub Version_check {
105 my($checkversion) = @_;
106 die "Your Makefile was built with ExtUtils::MakeMaker v $checkversion.
107 Current Version is $ExtUtils::MakeMaker::VERSION. There have been considerable
108 changes in the meantime.
109 Please rerun 'perl Makefile.PL' to regenerate the Makefile.\n"
110 if $checkversion < $Version_OK;
111 printf STDOUT "%s %s %s %s.\n", "Makefile built with ExtUtils::MakeMaker v",
112 $checkversion, "Current Version is", $VERSION
113 unless $checkversion == $VERSION;
116 sub warnhandler {
117 $_[0] =~ /^Use of uninitialized value/ && return;
118 $_[0] =~ /used only once/ && return;
119 $_[0] =~ /^Subroutine\s+[\w:]+\s+redefined/ && return;
120 warn @_;
123 sub WriteMakefile {
124 Carp::croak "WriteMakefile: Need even number of args" if @_ % 2;
125 local $SIG{__WARN__} = \&warnhandler;
127 my %att = @_;
128 MM->new(\%att)->flush;
131 sub prompt ($;$) {
132 my($mess,$def)=@_;
133 $ISA_TTY = -t STDIN && (-t STDOUT || !(-f STDOUT || -c STDOUT)) ; # Pipe?
134 Carp::confess("prompt function called without an argument") unless defined $mess;
135 my $dispdef = defined $def ? "[$def] " : " ";
136 $def = defined $def ? $def : "";
137 my $ans;
138 local $|=1;
139 print "$mess $dispdef";
140 if ($ISA_TTY) {
141 chomp($ans = <STDIN>);
142 } else {
143 print "$def\n";
145 return ($ans ne '') ? $ans : $def;
148 sub eval_in_subdirs {
149 my($self) = @_;
150 my($dir);
151 use Cwd 'cwd';
152 my $pwd = cwd();
154 foreach $dir (@{$self->{DIR}}){
155 my($abs) = $self->catdir($pwd,$dir);
156 $self->eval_in_x($abs);
158 chdir $pwd;
161 sub eval_in_x {
162 my($self,$dir) = @_;
163 package main;
164 chdir $dir or Carp::carp("Couldn't change to directory $dir: $!");
165 # use FileHandle ();
166 # my $fh = new FileHandle;
167 # $fh->open("Makefile.PL") or Carp::carp("Couldn't open Makefile.PL in $dir");
168 local *FH;
169 open(FH,"Makefile.PL") or Carp::carp("Couldn't open Makefile.PL in $dir");
170 # my $eval = join "", <$fh>;
171 my $eval = join "", <FH>;
172 # $fh->close;
173 close FH;
174 eval $eval;
175 if ($@) {
176 # if ($@ =~ /prerequisites/) {
177 # die "MakeMaker WARNING: $@";
178 # } else {
179 # warn "WARNING from evaluation of $dir/Makefile.PL: $@";
181 warn "WARNING from evaluation of $dir/Makefile.PL: $@";
185 sub full_setup {
186 $Verbose ||= 0;
188 # package name for the classes into which the first object will be blessed
189 $PACKNAME = "PACK000";
191 @Attrib_help = qw/
193 AUTHOR ABSTRACT ABSTRACT_FROM BINARY_LOCATION
194 C CAPI CCFLAGS CONFIG CONFIGURE DEFINE DIR DISTNAME DL_FUNCS DL_VARS
195 EXCLUDE_EXT EXE_FILES FIRST_MAKEFILE FULLPERL FUNCLIST H
196 HTMLLIBPODS HTMLSCRIPTPODS IMPORTS
197 INC INCLUDE_EXT INSTALLARCHLIB INSTALLBIN INSTALLDIRS INSTALLHTMLPRIVLIBDIR
198 INSTALLHTMLSCRIPTDIR INSTALLHTMLSITELIBDIR INSTALLMAN1DIR
199 INSTALLMAN3DIR INSTALLPRIVLIB INSTALLSCRIPT INSTALLSITEARCH
200 INSTALLSITELIB INST_ARCHLIB INST_BIN INST_EXE INST_LIB
201 INST_HTMLLIBDIR INST_HTMLSCRIPTDIR
202 INST_MAN1DIR INST_MAN3DIR INST_SCRIPT LDFROM LIB LIBPERL_A LIBS
203 LINKTYPE MAKEAPERL MAKEFILE MAN1PODS MAN3PODS MAP_TARGET MYEXTLIB
204 PERL_MALLOC_OK
205 NAME NEEDS_LINKING NOECHO NORECURS NO_VC OBJECT OPTIMIZE PERL PERLMAINCC
206 PERL_ARCHLIB PERL_LIB PERL_SRC PERM_RW PERM_RWX
207 PL_FILES PM PM_FILTER PMLIBDIRS POLLUTE PPM_INSTALL_EXEC
208 PPM_INSTALL_SCRIPT PREFIX
209 PREREQ_PM SKIP TYPEMAPS VERSION VERSION_FROM XS XSOPT XSPROTOARG
210 XS_VERSION clean depend dist dynamic_lib linkext macro realclean
211 tool_autosplit
213 MACPERL_SRC MACPERL_LIB MACLIBS_68K MACLIBS_PPC MACLIBS_SC MACLIBS_MRC
214 MACLIBS_ALL_68K MACLIBS_ALL_PPC MACLIBS_SHARED
217 # IMPORTS is used under OS/2 and Win32
219 # @Overridable is close to @MM_Sections but not identical. The
220 # order is important. Many subroutines declare macros. These
221 # depend on each other. Let's try to collect the macros up front,
222 # then pasthru, then the rules.
224 # MM_Sections are the sections we have to call explicitly
225 # in Overridable we have subroutines that are used indirectly
228 @MM_Sections =
231 post_initialize const_config constants tool_autosplit tool_xsubpp
232 tools_other dist macro depend cflags const_loadlibs const_cccmd
233 post_constants
235 pasthru
237 c_o xs_c xs_o top_targets linkext dlsyms dynamic dynamic_bs
238 dynamic_lib static static_lib htmlifypods manifypods processPL
239 installbin subdirs
240 clean realclean dist_basics dist_core dist_dir dist_test dist_ci
241 install force perldepend makefile staticmake test ppd
243 ); # loses section ordering
245 @Overridable = @MM_Sections;
246 push @Overridable, qw[
248 dir_target libscan makeaperl needs_linking perm_rw perm_rwx
249 subdir_x test_via_harness test_via_script
252 push @MM_Sections, qw[
254 pm_to_blib selfdocument
258 # Postamble needs to be the last that was always the case
259 push @MM_Sections, "postamble";
260 push @Overridable, "postamble";
262 # All sections are valid keys.
263 @Recognized_Att_Keys{@MM_Sections} = (1) x @MM_Sections;
265 # we will use all these variables in the Makefile
266 @Get_from_Config =
268 ar cc cccdlflags ccdlflags dlext dlsrc ld lddlflags ldflags libc
269 lib_ext obj_ext osname osvers ranlib sitelibexp sitearchexp so
270 exe_ext full_ar
273 my $item;
274 foreach $item (@Attrib_help){
275 $Recognized_Att_Keys{$item} = 1;
277 foreach $item (@Get_from_Config) {
278 $Recognized_Att_Keys{uc $item} = $Config{$item};
279 print "Attribute '\U$item\E' => '$Config{$item}'\n"
280 if ($Verbose >= 2);
284 # When we eval a Makefile.PL in a subdirectory, that one will ask
285 # us (the parent) for the values and will prepend "..", so that
286 # all files to be installed end up below OUR ./blib
288 %Prepend_dot_dot =
291 INST_BIN 1 INST_EXE 1 INST_LIB 1 INST_ARCHLIB 1 INST_SCRIPT 1
292 MAP_TARGET 1 INST_HTMLLIBDIR 1 INST_HTMLSCRIPTDIR 1
293 INST_MAN1DIR 1 INST_MAN3DIR 1 PERL_SRC 1 PERL 1 FULLPERL 1
297 my @keep = qw/
298 NEEDS_LINKING HAS_LINK_CODE
300 @Keep_after_flush{@keep} = (1) x @keep;
303 sub writeMakefile {
304 die <<END;
306 The extension you are trying to build apparently is rather old and
307 most probably outdated. We detect that from the fact, that a
308 subroutine "writeMakefile" is called, and this subroutine is not
309 supported anymore since about October 1994.
311 Please contact the author or look into CPAN (details about CPAN can be
312 found in the FAQ and at http:/www.perl.com) for a more recent version
313 of the extension. If you're really desperate, you can try to change
314 the subroutine name from writeMakefile to WriteMakefile and rerun
315 'perl Makefile.PL', but you're most probably left alone, when you do
318 The MakeMaker team
323 sub ExtUtils::MakeMaker::new {
324 my($class,$self) = @_;
325 my($key);
327 print STDOUT "MakeMaker (v$VERSION)\n" if $Verbose;
328 if (-f "MANIFEST" && ! -f "Makefile"){
329 check_manifest();
332 $self = {} unless (defined $self);
334 check_hints($self);
336 my(%initial_att) = %$self; # record initial attributes
338 my($prereq);
339 foreach $prereq (sort keys %{$self->{PREREQ_PM}}) {
340 my $eval = "require $prereq";
341 eval $eval;
343 if ($@) {
344 warn "Warning: prerequisite $prereq failed to load: $@";
346 elsif ($prereq->VERSION < $self->{PREREQ_PM}->{$prereq} ){
347 warn "Warning: prerequisite $prereq $self->{PREREQ_PM}->{$prereq} not found";
348 # Why is/was this 'delete' here? We need PREREQ_PM later to make PPDs.
349 # } else {
350 # delete $self->{PREREQ_PM}{$prereq};
353 # if (@unsatisfied){
354 # unless (defined $ExtUtils::MakeMaker::useCPAN) {
355 # print qq{MakeMaker WARNING: prerequisites not found (@unsatisfied)
356 # Please install these modules first and rerun 'perl Makefile.PL'.\n};
357 # if ($ExtUtils::MakeMaker::hasCPAN) {
358 # $ExtUtils::MakeMaker::useCPAN = prompt(qq{Should I try to use the CPAN module to fetch them for you?},"yes");
359 # } else {
360 # print qq{Hint: You may want to install the CPAN module to autofetch the needed modules\n};
361 # $ExtUtils::MakeMaker::useCPAN=0;
364 # if ($ExtUtils::MakeMaker::useCPAN) {
365 # require CPAN;
366 # CPAN->import(@unsatisfied);
367 # } else {
368 # die qq{prerequisites not found (@unsatisfied)};
370 # warn qq{WARNING: prerequisites not found (@unsatisfied)};
373 if (defined $self->{CONFIGURE}) {
374 if (ref $self->{CONFIGURE} eq 'CODE') {
375 $self = { %$self, %{&{$self->{CONFIGURE}}}};
376 } else {
377 Carp::croak "Attribute 'CONFIGURE' to WriteMakefile() not a code reference\n";
381 # This is for old Makefiles written pre 5.00, will go away
382 if ( Carp::longmess("") =~ /runsubdirpl/s ){
383 Carp::carp("WARNING: Please rerun 'perl Makefile.PL' to regenerate your Makefiles\n");
386 my $newclass = ++$PACKNAME;
387 local @Parent = @Parent; # Protect against non-local exits
389 # no strict;
390 print "Blessing Object into class [$newclass]\n" if $Verbose>=2;
391 mv_all_methods("MY",$newclass);
392 bless $self, $newclass;
393 push @Parent, $self;
394 @{"$newclass\:\:ISA"} = 'MM';
397 if (defined $Parent[-2]){
398 $self->{PARENT} = $Parent[-2];
399 my $key;
400 for $key (keys %Prepend_dot_dot) {
401 next unless defined $self->{PARENT}{$key};
402 $self->{$key} = $self->{PARENT}{$key};
403 # PERL and FULLPERL may be command verbs instead of full
404 # file specifications under VMS. If so, don't turn them
405 # into a filespec.
406 $self->{$key} = $self->catdir("..",$self->{$key})
407 unless $self->file_name_is_absolute($self->{$key})
408 || ($^O eq 'VMS' and ($key =~ /PERL$/ && $self->{$key} =~ /^[\w\-\$]+$/));
410 if ($self->{PARENT}) {
411 $self->{PARENT}->{CHILDREN}->{$newclass} = $self;
412 foreach my $opt (qw(CAPI POLLUTE)) {
413 if (exists $self->{PARENT}->{$opt}
414 and not exists $self->{$opt})
416 # inherit, but only if already unspecified
417 $self->{$opt} = $self->{PARENT}->{$opt};
421 } else {
422 parse_args($self,split(' ', $ENV{PERL_MM_OPT} || ''),@ARGV);
425 $self->{NAME} ||= $self->guess_name;
427 ($self->{NAME_SYM} = $self->{NAME}) =~ s/\W+/_/g;
429 $self->init_main();
431 if (! $self->{PERL_SRC} ) {
432 my($pthinks) = $self->canonpath($INC{'Config.pm'});
433 my($cthinks) = $self->catfile($Config{'archlibexp'},'Config.pm');
434 $pthinks = VMS::Filespec::vmsify($pthinks) if $Is_VMS;
435 if ($pthinks ne $cthinks &&
436 !($Is_Win32 and lc($pthinks) eq lc($cthinks))) {
437 print "Have $pthinks expected $cthinks\n";
438 if ($Is_Win32) {
439 $pthinks =~ s![/\\]Config\.pm$!!i; $pthinks =~ s!.*[/\\]!!;
441 else {
442 $pthinks =~ s!/Config\.pm$!!; $pthinks =~ s!.*/!!;
444 print STDOUT <<END unless $self->{UNINSTALLED_PERL};
445 Your perl and your Config.pm seem to have different ideas about the architecture
446 they are running on.
447 Perl thinks: [$pthinks]
448 Config says: [$Config{archname}]
449 This may or may not cause problems. Please check your installation of perl if you
450 have problems building this extension.
455 $self->init_dirscan();
456 $self->init_others();
457 my($argv) = neatvalue(\@ARGV);
458 $argv =~ s/^\[/(/;
459 $argv =~ s/\]$/)/;
461 push @{$self->{RESULT}}, <<END;
462 # This Makefile is for the $self->{NAME} extension to perl.
464 # It was generated automatically by MakeMaker version
465 # $VERSION (Revision: $Revision) from the contents of
466 # Makefile.PL. Don't edit this file, edit Makefile.PL instead.
468 # ANY CHANGES MADE HERE WILL BE LOST!
470 # MakeMaker ARGV: $argv
472 # MakeMaker Parameters:
475 foreach $key (sort keys %initial_att){
476 my($v) = neatvalue($initial_att{$key});
477 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
478 $v =~ tr/\n/ /s;
479 push @{$self->{RESULT}}, "# $key => $v";
482 # turn the SKIP array into a SKIPHASH hash
483 my (%skip,$skip);
484 for $skip (@{$self->{SKIP} || []}) {
485 $self->{SKIPHASH}{$skip} = 1;
487 delete $self->{SKIP}; # free memory
489 if ($self->{PARENT}) {
490 for (qw/install dist dist_basics dist_core dist_dir dist_test dist_ci/) {
491 $self->{SKIPHASH}{$_} = 1;
495 # We run all the subdirectories now. They don't have much to query
496 # from the parent, but the parent has to query them: if they need linking!
497 unless ($self->{NORECURS}) {
498 $self->eval_in_subdirs if @{$self->{DIR}};
501 my $section;
502 foreach $section ( @MM_Sections ){
503 print "Processing Makefile '$section' section\n" if ($Verbose >= 2);
504 my($skipit) = $self->skipcheck($section);
505 if ($skipit){
506 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section $skipit.";
507 } else {
508 my(%a) = %{$self->{$section} || {}};
509 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section:";
510 push @{$self->{RESULT}}, "# " . join ", ", %a if $Verbose && %a;
511 push @{$self->{RESULT}}, $self->nicetext($self->$section( %a ));
515 push @{$self->{RESULT}}, "\n# End.";
517 $self;
520 sub WriteEmptyMakefile {
521 if (-f 'Makefile.old') {
522 chmod 0666, 'Makefile.old';
523 unlink 'Makefile.old' or warn "unlink Makefile.old: $!";
525 rename 'Makefile', 'Makefile.old' or warn "rename Makefile Makefile.old: $!"
526 if -f 'Makefile';
527 open MF, '> Makefile' or die "open Makefile for write: $!";
528 print MF <<'EOP';
529 all:
531 clean:
533 install:
535 makemakerdflt:
537 test:
540 close MF or die "close Makefile for write: $!";
543 sub check_manifest {
544 print STDOUT "Checking if your kit is complete...\n";
545 require ExtUtils::Manifest;
546 $ExtUtils::Manifest::Quiet=$ExtUtils::Manifest::Quiet=1; #avoid warning
547 my(@missed)=ExtUtils::Manifest::manicheck();
548 if (@missed){
549 print STDOUT "Warning: the following files are missing in your kit:\n";
550 print "\t", join "\n\t", @missed;
551 print STDOUT "\n";
552 print STDOUT "Please inform the author.\n";
553 } else {
554 print STDOUT "Looks good\n";
558 sub parse_args{
559 my($self, @args) = @_;
560 foreach (@args){
561 unless (m/(.*?)=(.*)/){
562 help(),exit 1 if m/^help$/;
563 ++$Verbose if m/^verb/;
564 next;
566 my($name, $value) = ($1, $2);
567 if ($value =~ m/^~(\w+)?/){ # tilde with optional username
568 $value =~ s [^~(\w*)]
569 [$1 ?
570 ((getpwnam($1))[7] || "~$1") :
571 (getpwuid($>))[7]
572 ]ex;
574 $self->{uc($name)} = $value;
577 # catch old-style 'potential_libs' and inform user how to 'upgrade'
578 if (defined $self->{potential_libs}){
579 my($msg)="'potential_libs' => '$self->{potential_libs}' should be";
580 if ($self->{potential_libs}){
581 print STDOUT "$msg changed to:\n\t'LIBS' => ['$self->{potential_libs}']\n";
582 } else {
583 print STDOUT "$msg deleted.\n";
585 $self->{LIBS} = [$self->{potential_libs}];
586 delete $self->{potential_libs};
588 # catch old-style 'ARMAYBE' and inform user how to 'upgrade'
589 if (defined $self->{ARMAYBE}){
590 my($armaybe) = $self->{ARMAYBE};
591 print STDOUT "ARMAYBE => '$armaybe' should be changed to:\n",
592 "\t'dynamic_lib' => {ARMAYBE => '$armaybe'}\n";
593 my(%dl) = %{$self->{dynamic_lib} || {}};
594 $self->{dynamic_lib} = { %dl, ARMAYBE => $armaybe};
595 delete $self->{ARMAYBE};
597 if (defined $self->{LDTARGET}){
598 print STDOUT "LDTARGET should be changed to LDFROM\n";
599 $self->{LDFROM} = $self->{LDTARGET};
600 delete $self->{LDTARGET};
602 # Turn a DIR argument on the command line into an array
603 if (defined $self->{DIR} && ref \$self->{DIR} eq 'SCALAR') {
604 # So they can choose from the command line, which extensions they want
605 # the grep enables them to have some colons too much in case they
606 # have to build a list with the shell
607 $self->{DIR} = [grep $_, split ":", $self->{DIR}];
609 # Turn a INCLUDE_EXT argument on the command line into an array
610 if (defined $self->{INCLUDE_EXT} && ref \$self->{INCLUDE_EXT} eq 'SCALAR') {
611 $self->{INCLUDE_EXT} = [grep $_, split '\s+', $self->{INCLUDE_EXT}];
613 # Turn a EXCLUDE_EXT argument on the command line into an array
614 if (defined $self->{EXCLUDE_EXT} && ref \$self->{EXCLUDE_EXT} eq 'SCALAR') {
615 $self->{EXCLUDE_EXT} = [grep $_, split '\s+', $self->{EXCLUDE_EXT}];
617 my $mmkey;
618 foreach $mmkey (sort keys %$self){
619 print STDOUT " $mmkey => ", neatvalue($self->{$mmkey}), "\n" if $Verbose;
620 print STDOUT "'$mmkey' is not a known MakeMaker parameter name.\n"
621 unless exists $Recognized_Att_Keys{$mmkey};
623 $| = 1 if $Verbose;
626 sub check_hints {
627 my($self) = @_;
628 # We allow extension-specific hints files.
630 return unless -d "hints";
632 # First we look for the best hintsfile we have
633 my(@goodhints);
634 my($hint)="${^O}_$Config{osvers}";
635 $hint =~ s/\./_/g;
636 $hint =~ s/_$//;
637 return unless $hint;
639 # Also try without trailing minor version numbers.
640 while (1) {
641 last if -f "hints/$hint.pl"; # found
642 } continue {
643 last unless $hint =~ s/_[^_]*$//; # nothing to cut off
645 return unless -f "hints/$hint.pl"; # really there
647 # execute the hintsfile:
648 # use FileHandle ();
649 # my $fh = new FileHandle;
650 # $fh->open("hints/$hint.pl");
651 local *FH;
652 open(FH,"hints/$hint.pl");
653 # @goodhints = <$fh>;
654 @goodhints = <FH>;
655 # $fh->close;
656 close FH;
657 print STDOUT "Processing hints file hints/$hint.pl\n";
658 eval join('',@goodhints);
659 print STDOUT $@ if $@;
662 sub mv_all_methods {
663 my($from,$to) = @_;
664 my($method);
665 my($symtab) = \%{"${from}::"};
666 # no strict;
668 # Here you see the *current* list of methods that are overridable
669 # from Makefile.PL via MY:: subroutines. As of VERSION 5.07 I'm
670 # still trying to reduce the list to some reasonable minimum --
671 # because I want to make it easier for the user. A.K.
673 foreach $method (@Overridable) {
675 # We cannot say "next" here. Nick might call MY->makeaperl
676 # which isn't defined right now
678 # Above statement was written at 4.23 time when Tk-b8 was
679 # around. As Tk-b9 only builds with 5.002something and MM 5 is
680 # standard, we try to enable the next line again. It was
681 # commented out until MM 5.23
683 next unless defined &{"${from}::$method"};
685 *{"${to}::$method"} = \&{"${from}::$method"};
687 # delete would do, if we were sure, nobody ever called
688 # MY->makeaperl directly
690 # delete $symtab->{$method};
692 # If we delete a method, then it will be undefined and cannot
693 # be called. But as long as we have Makefile.PLs that rely on
694 # %MY:: being intact, we have to fill the hole with an
695 # inheriting method:
697 eval "package MY; sub $method { shift->SUPER::$method(\@_); }";
700 # We have to clean out %INC also, because the current directory is
701 # changed frequently and Graham Barr prefers to get his version
702 # out of a History.pl file which is "required" so woudn't get
703 # loaded again in another extension requiring a History.pl
705 # With perl5.002_01 the deletion of entries in %INC caused Tk-b11
706 # to core dump in the middle of a require statement. The required
707 # file was Tk/MMutil.pm. The consequence is, we have to be
708 # extremely careful when we try to give perl a reason to reload a
709 # library with same name. The workaround prefers to drop nothing
710 # from %INC and teach the writers not to use such libraries.
712 # my $inc;
713 # foreach $inc (keys %INC) {
714 # #warn "***$inc*** deleted";
715 # delete $INC{$inc};
719 sub skipcheck {
720 my($self) = shift;
721 my($section) = @_;
722 if ($section eq 'dynamic') {
723 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
724 "in skipped section 'dynamic_bs'\n"
725 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
726 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
727 "in skipped section 'dynamic_lib'\n"
728 if $self->{SKIPHASH}{dynamic_lib} && $Verbose;
730 if ($section eq 'dynamic_lib') {
731 print STDOUT "Warning (non-fatal): Target '\$(INST_DYNAMIC)' depends on ",
732 "targets in skipped section 'dynamic_bs'\n"
733 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
735 if ($section eq 'static') {
736 print STDOUT "Warning (non-fatal): Target 'static' depends on targets ",
737 "in skipped section 'static_lib'\n"
738 if $self->{SKIPHASH}{static_lib} && $Verbose;
740 return 'skipped' if $self->{SKIPHASH}{$section};
741 return '';
744 sub flush {
745 my $self = shift;
746 my($chunk);
747 # use FileHandle ();
748 # my $fh = new FileHandle;
749 local *FH;
750 print STDOUT "Writing $self->{MAKEFILE} for $self->{NAME}\n";
752 unlink($self->{MAKEFILE}, "MakeMaker.tmp", $Is_VMS ? 'Descrip.MMS' : '');
753 # $fh->open(">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
754 open(FH,">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
756 for $chunk (@{$self->{RESULT}}) {
757 # print $fh "$chunk\n";
758 print FH "$chunk\n";
761 # $fh->close;
762 close FH;
763 my($finalname) = $self->{MAKEFILE};
764 rename("MakeMaker.tmp", $finalname);
765 chmod 0644, $finalname unless $Is_VMS;
767 if ($self->{PARENT}) {
768 foreach (keys %$self) { # safe memory
769 delete $self->{$_} unless $Keep_after_flush{$_};
773 system("$Config::Config{eunicefix} $finalname") unless $Config::Config{eunicefix} eq ":";
776 # The following mkbootstrap() is only for installations that are calling
777 # the pre-4.1 mkbootstrap() from their old Makefiles. This MakeMaker
778 # writes Makefiles, that use ExtUtils::Mkbootstrap directly.
779 sub mkbootstrap {
780 die <<END;
781 !!! Your Makefile has been built such a long time ago, !!!
782 !!! that is unlikely to work with current MakeMaker. !!!
783 !!! Please rebuild your Makefile !!!
787 # Ditto for mksymlists() as of MakeMaker 5.17
788 sub mksymlists {
789 die <<END;
790 !!! Your Makefile has been built such a long time ago, !!!
791 !!! that is unlikely to work with current MakeMaker. !!!
792 !!! Please rebuild your Makefile !!!
796 sub neatvalue {
797 my($v) = @_;
798 return "undef" unless defined $v;
799 my($t) = ref $v;
800 return "q[$v]" unless $t;
801 if ($t eq 'ARRAY') {
802 my(@m, $elem, @neat);
803 push @m, "[";
804 foreach $elem (@$v) {
805 push @neat, "q[$elem]";
807 push @m, join ", ", @neat;
808 push @m, "]";
809 return join "", @m;
811 return "$v" unless $t eq 'HASH';
812 my(@m, $key, $val);
813 while (($key,$val) = each %$v){
814 last unless defined $key; # cautious programming in case (undef,undef) is true
815 push(@m,"$key=>".neatvalue($val)) ;
817 return "{ ".join(', ',@m)." }";
820 sub selfdocument {
821 my($self) = @_;
822 my(@m);
823 if ($Verbose){
824 push @m, "\n# Full list of MakeMaker attribute values:";
825 foreach $key (sort keys %$self){
826 next if $key eq 'RESULT' || $key =~ /^[A-Z][a-z]/;
827 my($v) = neatvalue($self->{$key});
828 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
829 $v =~ tr/\n/ /s;
830 push @m, "# $key => $v";
833 join "\n", @m;
836 package ExtUtils::MakeMaker;
839 __END__
841 =head1 NAME
843 ExtUtils::MakeMaker - create an extension Makefile
845 =head1 SYNOPSIS
847 C<use ExtUtils::MakeMaker;>
849 C<WriteMakefile( ATTRIBUTE =E<gt> VALUE [, ...] );>
851 which is really
853 C<MM-E<gt>new(\%att)-E<gt>flush;>
855 =head1 DESCRIPTION
857 This utility is designed to write a Makefile for an extension module
858 from a Makefile.PL. It is based on the Makefile.SH model provided by
859 Andy Dougherty and the perl5-porters.
861 It splits the task of generating the Makefile into several subroutines
862 that can be individually overridden. Each subroutine returns the text
863 it wishes to have written to the Makefile.
865 MakeMaker is object oriented. Each directory below the current
866 directory that contains a Makefile.PL. Is treated as a separate
867 object. This makes it possible to write an unlimited number of
868 Makefiles with a single invocation of WriteMakefile().
870 =head2 How To Write A Makefile.PL
872 The short answer is: Don't.
874 Always begin with h2xs.
875 Always begin with h2xs!
876 ALWAYS BEGIN WITH H2XS!
878 even if you're not building around a header file, and even if you
879 don't have an XS component.
881 Run h2xs(1) before you start thinking about writing a module. For so
882 called pm-only modules that consist of C<*.pm> files only, h2xs has
883 the C<-X> switch. This will generate dummy files of all kinds that are
884 useful for the module developer.
886 The medium answer is:
888 use ExtUtils::MakeMaker;
889 WriteMakefile( NAME => "Foo::Bar" );
891 The long answer is the rest of the manpage :-)
893 =head2 Default Makefile Behaviour
895 The generated Makefile enables the user of the extension to invoke
897 perl Makefile.PL # optionally "perl Makefile.PL verbose"
898 make
899 make test # optionally set TEST_VERBOSE=1
900 make install # See below
902 The Makefile to be produced may be altered by adding arguments of the
903 form C<KEY=VALUE>. E.g.
905 perl Makefile.PL PREFIX=/tmp/myperl5
907 Other interesting targets in the generated Makefile are
909 make config # to check if the Makefile is up-to-date
910 make clean # delete local temp files (Makefile gets renamed)
911 make realclean # delete derived files (including ./blib)
912 make ci # check in all the files in the MANIFEST file
913 make dist # see below the Distribution Support section
915 =head2 make test
917 MakeMaker checks for the existence of a file named F<test.pl> in the
918 current directory and if it exists it adds commands to the test target
919 of the generated Makefile that will execute the script with the proper
920 set of perl C<-I> options.
922 MakeMaker also checks for any files matching glob("t/*.t"). It will
923 add commands to the test target of the generated Makefile that execute
924 all matching files via the L<Test::Harness> module with the C<-I>
925 switches set correctly.
927 =head2 make testdb
929 A useful variation of the above is the target C<testdb>. It runs the
930 test under the Perl debugger (see L<perldebug>). If the file
931 F<test.pl> exists in the current directory, it is used for the test.
933 If you want to debug some other testfile, set C<TEST_FILE> variable
934 thusly:
936 make testdb TEST_FILE=t/mytest.t
938 By default the debugger is called using C<-d> option to perl. If you
939 want to specify some other option, set C<TESTDB_SW> variable:
941 make testdb TESTDB_SW=-Dx
943 =head2 make install
945 make alone puts all relevant files into directories that are named by
946 the macros INST_LIB, INST_ARCHLIB, INST_SCRIPT, INST_HTMLLIBDIR,
947 INST_HTMLSCRIPTDIR, INST_MAN1DIR, and INST_MAN3DIR. All these default
948 to something below ./blib if you are I<not> building below the perl
949 source directory. If you I<are> building below the perl source,
950 INST_LIB and INST_ARCHLIB default to ../../lib, and INST_SCRIPT is not
951 defined.
953 The I<install> target of the generated Makefile copies the files found
954 below each of the INST_* directories to their INSTALL*
955 counterparts. Which counterparts are chosen depends on the setting of
956 INSTALLDIRS according to the following table:
958 INSTALLDIRS set to
959 perl site
961 INST_ARCHLIB INSTALLARCHLIB INSTALLSITEARCH
962 INST_LIB INSTALLPRIVLIB INSTALLSITELIB
963 INST_HTMLLIBDIR INSTALLHTMLPRIVLIBDIR INSTALLHTMLSITELIBDIR
964 INST_HTMLSCRIPTDIR INSTALLHTMLSCRIPTDIR
965 INST_BIN INSTALLBIN
966 INST_SCRIPT INSTALLSCRIPT
967 INST_MAN1DIR INSTALLMAN1DIR
968 INST_MAN3DIR INSTALLMAN3DIR
970 The INSTALL... macros in turn default to their %Config
971 ($Config{installprivlib}, $Config{installarchlib}, etc.) counterparts.
973 You can check the values of these variables on your system with
975 perl '-V:install.*'
977 And to check the sequence in which the library directories are
978 searched by perl, run
980 perl -le 'print join $/, @INC'
983 =head2 PREFIX and LIB attribute
985 PREFIX and LIB can be used to set several INSTALL* attributes in one
986 go. The quickest way to install a module in a non-standard place might
989 perl Makefile.PL LIB=~/lib
991 This will install the module's architecture-independent files into
992 ~/lib, the architecture-dependent files into ~/lib/$archname.
994 Another way to specify many INSTALL directories with a single
995 parameter is PREFIX.
997 perl Makefile.PL PREFIX=~
999 This will replace the string specified by C<$Config{prefix}> in all
1000 C<$Config{install*}> values.
1002 Note, that in both cases the tilde expansion is done by MakeMaker, not
1003 by perl by default, nor by make.
1005 Conflicts between parameters LIB,
1006 PREFIX and the various INSTALL* arguments are resolved so that:
1008 =over 4
1010 =item *
1012 setting LIB overrides any setting of INSTALLPRIVLIB, INSTALLARCHLIB,
1013 INSTALLSITELIB, INSTALLSITEARCH (and they are not affected by PREFIX);
1015 =item *
1017 without LIB, setting PREFIX replaces the initial C<$Config{prefix}>
1018 part of those INSTALL* arguments, even if the latter are explicitly
1019 set (but are set to still start with C<$Config{prefix}>).
1021 =back
1023 If the user has superuser privileges, and is not working on AFS
1024 or relatives, then the defaults for
1025 INSTALLPRIVLIB, INSTALLARCHLIB, INSTALLSCRIPT, etc. will be appropriate,
1026 and this incantation will be the best:
1028 perl Makefile.PL; make; make test
1029 make install
1031 make install per default writes some documentation of what has been
1032 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This feature
1033 can be bypassed by calling make pure_install.
1035 =head2 AFS users
1037 will have to specify the installation directories as these most
1038 probably have changed since perl itself has been installed. They will
1039 have to do this by calling
1041 perl Makefile.PL INSTALLSITELIB=/afs/here/today \
1042 INSTALLSCRIPT=/afs/there/now INSTALLMAN3DIR=/afs/for/manpages
1043 make
1045 Be careful to repeat this procedure every time you recompile an
1046 extension, unless you are sure the AFS installation directories are
1047 still valid.
1049 =head2 Static Linking of a new Perl Binary
1051 An extension that is built with the above steps is ready to use on
1052 systems supporting dynamic loading. On systems that do not support
1053 dynamic loading, any newly created extension has to be linked together
1054 with the available resources. MakeMaker supports the linking process
1055 by creating appropriate targets in the Makefile whenever an extension
1056 is built. You can invoke the corresponding section of the makefile with
1058 make perl
1060 That produces a new perl binary in the current directory with all
1061 extensions linked in that can be found in INST_ARCHLIB , SITELIBEXP,
1062 and PERL_ARCHLIB. To do that, MakeMaker writes a new Makefile, on
1063 UNIX, this is called Makefile.aperl (may be system dependent). If you
1064 want to force the creation of a new perl, it is recommended, that you
1065 delete this Makefile.aperl, so the directories are searched-through
1066 for linkable libraries again.
1068 The binary can be installed into the directory where perl normally
1069 resides on your machine with
1071 make inst_perl
1073 To produce a perl binary with a different name than C<perl>, either say
1075 perl Makefile.PL MAP_TARGET=myperl
1076 make myperl
1077 make inst_perl
1079 or say
1081 perl Makefile.PL
1082 make myperl MAP_TARGET=myperl
1083 make inst_perl MAP_TARGET=myperl
1085 In any case you will be prompted with the correct invocation of the
1086 C<inst_perl> target that installs the new binary into INSTALLBIN.
1088 make inst_perl per default writes some documentation of what has been
1089 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This
1090 can be bypassed by calling make pure_inst_perl.
1092 Warning: the inst_perl: target will most probably overwrite your
1093 existing perl binary. Use with care!
1095 Sometimes you might want to build a statically linked perl although
1096 your system supports dynamic loading. In this case you may explicitly
1097 set the linktype with the invocation of the Makefile.PL or make:
1099 perl Makefile.PL LINKTYPE=static # recommended
1103 make LINKTYPE=static # works on most systems
1105 =head2 Determination of Perl Library and Installation Locations
1107 MakeMaker needs to know, or to guess, where certain things are
1108 located. Especially INST_LIB and INST_ARCHLIB (where to put the files
1109 during the make(1) run), PERL_LIB and PERL_ARCHLIB (where to read
1110 existing modules from), and PERL_INC (header files and C<libperl*.*>).
1112 Extensions may be built either using the contents of the perl source
1113 directory tree or from the installed perl library. The recommended way
1114 is to build extensions after you have run 'make install' on perl
1115 itself. You can do that in any directory on your hard disk that is not
1116 below the perl source tree. The support for extensions below the ext
1117 directory of the perl distribution is only good for the standard
1118 extensions that come with perl.
1120 If an extension is being built below the C<ext/> directory of the perl
1121 source then MakeMaker will set PERL_SRC automatically (e.g.,
1122 C<../..>). If PERL_SRC is defined and the extension is recognized as
1123 a standard extension, then other variables default to the following:
1125 PERL_INC = PERL_SRC
1126 PERL_LIB = PERL_SRC/lib
1127 PERL_ARCHLIB = PERL_SRC/lib
1128 INST_LIB = PERL_LIB
1129 INST_ARCHLIB = PERL_ARCHLIB
1131 If an extension is being built away from the perl source then MakeMaker
1132 will leave PERL_SRC undefined and default to using the installed copy
1133 of the perl library. The other variables default to the following:
1135 PERL_INC = $archlibexp/CORE
1136 PERL_LIB = $privlibexp
1137 PERL_ARCHLIB = $archlibexp
1138 INST_LIB = ./blib/lib
1139 INST_ARCHLIB = ./blib/arch
1141 If perl has not yet been installed then PERL_SRC can be defined on the
1142 command line as shown in the previous section.
1145 =head2 Which architecture dependent directory?
1147 If you don't want to keep the defaults for the INSTALL* macros,
1148 MakeMaker helps you to minimize the typing needed: the usual
1149 relationship between INSTALLPRIVLIB and INSTALLARCHLIB is determined
1150 by Configure at perl compilation time. MakeMaker supports the user who
1151 sets INSTALLPRIVLIB. If INSTALLPRIVLIB is set, but INSTALLARCHLIB not,
1152 then MakeMaker defaults the latter to be the same subdirectory of
1153 INSTALLPRIVLIB as Configure decided for the counterparts in %Config ,
1154 otherwise it defaults to INSTALLPRIVLIB. The same relationship holds
1155 for INSTALLSITELIB and INSTALLSITEARCH.
1157 MakeMaker gives you much more freedom than needed to configure
1158 internal variables and get different results. It is worth to mention,
1159 that make(1) also lets you configure most of the variables that are
1160 used in the Makefile. But in the majority of situations this will not
1161 be necessary, and should only be done if the author of a package
1162 recommends it (or you know what you're doing).
1164 =head2 Using Attributes and Parameters
1166 The following attributes can be specified as arguments to WriteMakefile()
1167 or as NAME=VALUE pairs on the command line:
1169 =over 2
1171 =item ABSTRACT
1173 One line description of the module. Will be included in PPD file.
1175 =item ABSTRACT_FROM
1177 Name of the file that contains the package description. MakeMaker looks
1178 for a line in the POD matching /^($package\s-\s)(.*)/. This is typically
1179 the first line in the "=head1 NAME" section. $2 becomes the abstract.
1181 =item AUTHOR
1183 String containing name (and email address) of package author(s). Is used
1184 in PPD (Perl Package Description) files for PPM (Perl Package Manager).
1186 =item BINARY_LOCATION
1188 Used when creating PPD files for binary packages. It can be set to a
1189 full or relative path or URL to the binary archive for a particular
1190 architecture. For example:
1192 perl Makefile.PL BINARY_LOCATION=x86/Agent.tar.gz
1194 builds a PPD package that references a binary of the C<Agent> package,
1195 located in the C<x86> directory relative to the PPD itself.
1197 =item C
1199 Ref to array of *.c file names. Initialised from a directory scan
1200 and the values portion of the XS attribute hash. This is not
1201 currently used by MakeMaker but may be handy in Makefile.PLs.
1203 =item CAPI
1205 [This attribute is obsolete in Perl 5.6. PERL_OBJECT builds are C-compatible
1206 by default.]
1208 Switch to force usage of the Perl C API even when compiling for PERL_OBJECT.
1210 Note that this attribute is passed through to any recursive build,
1211 but if and only if the submodule's Makefile.PL itself makes no mention
1212 of the 'CAPI' attribute.
1214 =item CCFLAGS
1216 String that will be included in the compiler call command line between
1217 the arguments INC and OPTIMIZE.
1219 =item CONFIG
1221 Arrayref. E.g. [qw(archname manext)] defines ARCHNAME & MANEXT from
1222 config.sh. MakeMaker will add to CONFIG the following values anyway:
1225 cccdlflags
1226 ccdlflags
1227 dlext
1228 dlsrc
1230 lddlflags
1231 ldflags
1232 libc
1233 lib_ext
1234 obj_ext
1235 ranlib
1236 sitelibexp
1237 sitearchexp
1240 =item CONFIGURE
1242 CODE reference. The subroutine should return a hash reference. The
1243 hash may contain further attributes, e.g. {LIBS =E<gt> ...}, that have to
1244 be determined by some evaluation method.
1246 =item DEFINE
1248 Something like C<"-DHAVE_UNISTD_H">
1250 =item DIR
1252 Ref to array of subdirectories containing Makefile.PLs e.g. [ 'sdbm'
1253 ] in ext/SDBM_File
1255 =item DISTNAME
1257 Your name for distributing the package (by tar file). This defaults to
1258 NAME above.
1260 =item DL_FUNCS
1262 Hashref of symbol names for routines to be made available as universal
1263 symbols. Each key/value pair consists of the package name and an
1264 array of routine names in that package. Used only under AIX, OS/2,
1265 VMS and Win32 at present. The routine names supplied will be expanded
1266 in the same way as XSUB names are expanded by the XS() macro.
1267 Defaults to
1269 {"$(NAME)" => ["boot_$(NAME)" ] }
1271 e.g.
1273 {"RPC" => [qw( boot_rpcb rpcb_gettime getnetconfigent )],
1274 "NetconfigPtr" => [ 'DESTROY'] }
1276 Please see the L<ExtUtils::Mksymlists> documentation for more information
1277 about the DL_FUNCS, DL_VARS and FUNCLIST attributes.
1279 =item DL_VARS
1281 Array of symbol names for variables to be made available as universal symbols.
1282 Used only under AIX, OS/2, VMS and Win32 at present. Defaults to [].
1283 (e.g. [ qw(Foo_version Foo_numstreams Foo_tree ) ])
1285 =item EXCLUDE_EXT
1287 Array of extension names to exclude when doing a static build. This
1288 is ignored if INCLUDE_EXT is present. Consult INCLUDE_EXT for more
1289 details. (e.g. [ qw( Socket POSIX ) ] )
1291 This attribute may be most useful when specified as a string on the
1292 command line: perl Makefile.PL EXCLUDE_EXT='Socket Safe'
1294 =item EXE_FILES
1296 Ref to array of executable files. The files will be copied to the
1297 INST_SCRIPT directory. Make realclean will delete them from there
1298 again.
1300 =item FIRST_MAKEFILE
1302 The name of the Makefile to be produced. Defaults to the contents of
1303 MAKEFILE, but can be overridden. This is used for the second Makefile
1304 that will be produced for the MAP_TARGET.
1306 =item FULLPERL
1308 Perl binary able to run this extension.
1310 =item FUNCLIST
1312 This provides an alternate means to specify function names to be
1313 exported from the extension. Its value is a reference to an
1314 array of function names to be exported by the extension. These
1315 names are passed through unaltered to the linker options file.
1317 =item H
1319 Ref to array of *.h file names. Similar to C.
1321 =item HTMLLIBPODS
1323 Hashref of .pm and .pod files. MakeMaker will default this to all
1324 .pod and any .pm files that include POD directives. The files listed
1325 here will be converted to HTML format and installed as was requested
1326 at Configure time.
1328 =item HTMLSCRIPTPODS
1330 Hashref of pod-containing files. MakeMaker will default this to all
1331 EXE_FILES files that include POD directives. The files listed
1332 here will be converted to HTML format and installed as was requested
1333 at Configure time.
1335 =item IMPORTS
1337 This attribute is used to specify names to be imported into the
1338 extension. It is only used on OS/2 and Win32.
1340 =item INC
1342 Include file dirs eg: C<"-I/usr/5include -I/path/to/inc">
1344 =item INCLUDE_EXT
1346 Array of extension names to be included when doing a static build.
1347 MakeMaker will normally build with all of the installed extensions when
1348 doing a static build, and that is usually the desired behavior. If
1349 INCLUDE_EXT is present then MakeMaker will build only with those extensions
1350 which are explicitly mentioned. (e.g. [ qw( Socket POSIX ) ])
1352 It is not necessary to mention DynaLoader or the current extension when
1353 filling in INCLUDE_EXT. If the INCLUDE_EXT is mentioned but is empty then
1354 only DynaLoader and the current extension will be included in the build.
1356 This attribute may be most useful when specified as a string on the
1357 command line: perl Makefile.PL INCLUDE_EXT='POSIX Socket Devel::Peek'
1359 =item INSTALLARCHLIB
1361 Used by 'make install', which copies files from INST_ARCHLIB to this
1362 directory if INSTALLDIRS is set to perl.
1364 =item INSTALLBIN
1366 Directory to install binary files (e.g. tkperl) into.
1368 =item INSTALLDIRS
1370 Determines which of the two sets of installation directories to
1371 choose: installprivlib and installarchlib versus installsitelib and
1372 installsitearch. The first pair is chosen with INSTALLDIRS=perl, the
1373 second with INSTALLDIRS=site. Default is site.
1375 =item INSTALLHTMLPRIVLIBDIR
1377 This directory gets the HTML pages at 'make install' time. Defaults to
1378 $Config{installhtmlprivlibdir}.
1380 =item INSTALLHTMLSCRIPTDIR
1382 This directory gets the HTML pages at 'make install' time. Defaults to
1383 $Config{installhtmlscriptdir}.
1385 =item INSTALLHTMLSITELIBDIR
1387 This directory gets the HTML pages at 'make install' time. Defaults to
1388 $Config{installhtmlsitelibdir}.
1391 =item INSTALLMAN1DIR
1393 This directory gets the man pages at 'make install' time. Defaults to
1394 $Config{installman1dir}.
1396 =item INSTALLMAN3DIR
1398 This directory gets the man pages at 'make install' time. Defaults to
1399 $Config{installman3dir}.
1401 =item INSTALLPRIVLIB
1403 Used by 'make install', which copies files from INST_LIB to this
1404 directory if INSTALLDIRS is set to perl.
1406 =item INSTALLSCRIPT
1408 Used by 'make install' which copies files from INST_SCRIPT to this
1409 directory.
1411 =item INSTALLSITEARCH
1413 Used by 'make install', which copies files from INST_ARCHLIB to this
1414 directory if INSTALLDIRS is set to site (default).
1416 =item INSTALLSITELIB
1418 Used by 'make install', which copies files from INST_LIB to this
1419 directory if INSTALLDIRS is set to site (default).
1421 =item INST_ARCHLIB
1423 Same as INST_LIB for architecture dependent files.
1425 =item INST_BIN
1427 Directory to put real binary files during 'make'. These will be copied
1428 to INSTALLBIN during 'make install'
1430 =item INST_EXE
1432 Old name for INST_SCRIPT. Deprecated. Please use INST_SCRIPT if you
1433 need to use it.
1435 =item INST_HTMLLIBDIR
1437 Directory to hold the man pages in HTML format at 'make' time
1439 =item INST_HTMLSCRIPTDIR
1441 Directory to hold the man pages in HTML format at 'make' time
1443 =item INST_LIB
1445 Directory where we put library files of this extension while building
1448 =item INST_MAN1DIR
1450 Directory to hold the man pages at 'make' time
1452 =item INST_MAN3DIR
1454 Directory to hold the man pages at 'make' time
1456 =item INST_SCRIPT
1458 Directory, where executable files should be installed during
1459 'make'. Defaults to "./blib/script", just to have a dummy location during
1460 testing. make install will copy the files in INST_SCRIPT to
1461 INSTALLSCRIPT.
1463 =item LDFROM
1465 defaults to "$(OBJECT)" and is used in the ld command to specify
1466 what files to link/load from (also see dynamic_lib below for how to
1467 specify ld flags)
1469 =item LIB
1471 LIB should only be set at C<perl Makefile.PL> time but is allowed as a
1472 MakeMaker argument. It has the effect of
1473 setting both INSTALLPRIVLIB and INSTALLSITELIB to that value regardless any
1474 explicit setting of those arguments (or of PREFIX).
1475 INSTALLARCHLIB and INSTALLSITEARCH are set to the corresponding
1476 architecture subdirectory.
1478 =item LIBPERL_A
1480 The filename of the perllibrary that will be used together with this
1481 extension. Defaults to libperl.a.
1483 =item LIBS
1485 An anonymous array of alternative library
1486 specifications to be searched for (in order) until
1487 at least one library is found. E.g.
1489 'LIBS' => ["-lgdbm", "-ldbm -lfoo", "-L/path -ldbm.nfs"]
1491 Mind, that any element of the array
1492 contains a complete set of arguments for the ld
1493 command. So do not specify
1495 'LIBS' => ["-ltcl", "-ltk", "-lX11"]
1497 See ODBM_File/Makefile.PL for an example, where an array is needed. If
1498 you specify a scalar as in
1500 'LIBS' => "-ltcl -ltk -lX11"
1502 MakeMaker will turn it into an array with one element.
1504 =item LINKTYPE
1506 'static' or 'dynamic' (default unless usedl=undef in
1507 config.sh). Should only be used to force static linking (also see
1508 linkext below).
1510 =item MAKEAPERL
1512 Boolean which tells MakeMaker, that it should include the rules to
1513 make a perl. This is handled automatically as a switch by
1514 MakeMaker. The user normally does not need it.
1516 =item MAKEFILE
1518 The name of the Makefile to be produced.
1520 =item MAN1PODS
1522 Hashref of pod-containing files. MakeMaker will default this to all
1523 EXE_FILES files that include POD directives. The files listed
1524 here will be converted to man pages and installed as was requested
1525 at Configure time.
1527 =item MAN3PODS
1529 Hashref of .pm and .pod files. MakeMaker will default this to all
1530 .pod and any .pm files that include POD directives. The files listed
1531 here will be converted to man pages and installed as was requested
1532 at Configure time.
1534 =item MAP_TARGET
1536 If it is intended, that a new perl binary be produced, this variable
1537 may hold a name for that binary. Defaults to perl
1539 =item MYEXTLIB
1541 If the extension links to a library that it builds set this to the
1542 name of the library (see SDBM_File)
1544 =item NAME
1546 Perl module name for this extension (DBD::Oracle). This will default
1547 to the directory name but should be explicitly defined in the
1548 Makefile.PL.
1550 =item NEEDS_LINKING
1552 MakeMaker will figure out if an extension contains linkable code
1553 anywhere down the directory tree, and will set this variable
1554 accordingly, but you can speed it up a very little bit if you define
1555 this boolean variable yourself.
1557 =item NOECHO
1559 Defaults to C<@>. By setting it to an empty string you can generate a
1560 Makefile that echos all commands. Mainly used in debugging MakeMaker
1561 itself.
1563 =item NORECURS
1565 Boolean. Attribute to inhibit descending into subdirectories.
1567 =item NO_VC
1569 In general, any generated Makefile checks for the current version of
1570 MakeMaker and the version the Makefile was built under. If NO_VC is
1571 set, the version check is neglected. Do not write this into your
1572 Makefile.PL, use it interactively instead.
1574 =item OBJECT
1576 List of object files, defaults to '$(BASEEXT)$(OBJ_EXT)', but can be a long
1577 string containing all object files, e.g. "tkpBind.o
1578 tkpButton.o tkpCanvas.o"
1580 (Where BASEEXT is the last component of NAME, and OBJ_EXT is $Config{obj_ext}.)
1582 =item OPTIMIZE
1584 Defaults to C<-O>. Set it to C<-g> to turn debugging on. The flag is
1585 passed to subdirectory makes.
1587 =item PERL
1589 Perl binary for tasks that can be done by miniperl
1591 =item PERLMAINCC
1593 The call to the program that is able to compile perlmain.c. Defaults
1594 to $(CC).
1596 =item PERL_ARCHLIB
1598 Same as below, but for architecture dependent files.
1600 =item PERL_LIB
1602 Directory containing the Perl library to use.
1604 =item PERL_MALLOC_OK
1606 defaults to 0. Should be set to TRUE if the extension can work with
1607 the memory allocation routines substituted by the Perl malloc() subsystem.
1608 This should be applicable to most extensions with exceptions of those
1610 =over 4
1612 =item *
1614 with bugs in memory allocations which are caught by Perl's malloc();
1616 =item *
1618 which interact with the memory allocator in other ways than via
1619 malloc(), realloc(), free(), calloc(), sbrk() and brk();
1621 =item *
1623 which rely on special alignment which is not provided by Perl's malloc().
1625 =back
1627 B<NOTE.> Negligence to set this flag in I<any one> of loaded extension
1628 nullifies many advantages of Perl's malloc(), such as better usage of
1629 system resources, error detection, memory usage reporting, catchable failure
1630 of memory allocations, etc.
1632 =item PERL_SRC
1634 Directory containing the Perl source code (use of this should be
1635 avoided, it may be undefined)
1637 =item PERM_RW
1639 Desired permission for read/writable files. Defaults to C<644>.
1640 See also L<MM_Unix/perm_rw>.
1642 =item PERM_RWX
1644 Desired permission for executable files. Defaults to C<755>.
1645 See also L<MM_Unix/perm_rwx>.
1647 =item PL_FILES
1649 Ref to hash of files to be processed as perl programs. MakeMaker
1650 will default to any found *.PL file (except Makefile.PL) being keys
1651 and the basename of the file being the value. E.g.
1653 {'foobar.PL' => 'foobar'}
1655 The *.PL files are expected to produce output to the target files
1656 themselves. If multiple files can be generated from the same *.PL
1657 file then the value in the hash can be a reference to an array of
1658 target file names. E.g.
1660 {'foobar.PL' => ['foobar1','foobar2']}
1662 =item PM
1664 Hashref of .pm files and *.pl files to be installed. e.g.
1666 {'name_of_file.pm' => '$(INST_LIBDIR)/install_as.pm'}
1668 By default this will include *.pm and *.pl and the files found in
1669 the PMLIBDIRS directories. Defining PM in the
1670 Makefile.PL will override PMLIBDIRS.
1672 =item PMLIBDIRS
1674 Ref to array of subdirectories containing library files. Defaults to
1675 [ 'lib', $(BASEEXT) ]. The directories will be scanned and I<any> files
1676 they contain will be installed in the corresponding location in the
1677 library. A libscan() method can be used to alter the behaviour.
1678 Defining PM in the Makefile.PL will override PMLIBDIRS.
1680 (Where BASEEXT is the last component of NAME.)
1682 =item PM_FILTER
1684 A filter program, in the traditional Unix sense (input from stdin, output
1685 to stdout) that is passed on each .pm file during the build (in the
1686 pm_to_blib() phase). It is empty by default, meaning no filtering is done.
1688 Great care is necessary when defining the command if quoting needs to be
1689 done. For instance, you would need to say:
1691 {'PM_FILTER' => 'grep -v \\"^\\#\\"'}
1693 to remove all the leading coments on the fly during the build. The
1694 extra \\ are necessary, unfortunately, because this variable is interpolated
1695 within the context of a Perl program built on the command line, and double
1696 quotes are what is used with the -e switch to build that command line. The
1697 # is escaped for the Makefile, since what is going to be generated will then
1700 PM_FILTER = grep -v \"^\#\"
1702 Without the \\ before the #, we'd have the start of a Makefile comment,
1703 and the macro would be incorrectly defined.
1705 =item POLLUTE
1707 Release 5.005 grandfathered old global symbol names by providing preprocessor
1708 macros for extension source compatibility. As of release 5.6, these
1709 preprocessor definitions are not available by default. The POLLUTE flag
1710 specifies that the old names should still be defined:
1712 perl Makefile.PL POLLUTE=1
1714 Please inform the module author if this is necessary to successfully install
1715 a module under 5.6 or later.
1717 =item PPM_INSTALL_EXEC
1719 Name of the executable used to run C<PPM_INSTALL_SCRIPT> below. (e.g. perl)
1721 =item PPM_INSTALL_SCRIPT
1723 Name of the script that gets executed by the Perl Package Manager after
1724 the installation of a package.
1726 =item PREFIX
1728 Can be used to set the three INSTALL* attributes in one go (except for
1729 probably INSTALLMAN1DIR, if it is not below PREFIX according to
1730 %Config). They will have PREFIX as a common directory node and will
1731 branch from that node into lib/, lib/ARCHNAME or whatever Configure
1732 decided at the build time of your perl (unless you override one of
1733 them, of course).
1735 =item PREREQ_PM
1737 Hashref: Names of modules that need to be available to run this
1738 extension (e.g. Fcntl for SDBM_File) are the keys of the hash and the
1739 desired version is the value. If the required version number is 0, we
1740 only check if any version is installed already.
1742 =item SKIP
1744 Arryref. E.g. [qw(name1 name2)] skip (do not write) sections of the
1745 Makefile. Caution! Do not use the SKIP attribute for the negligible
1746 speedup. It may seriously damage the resulting Makefile. Only use it
1747 if you really need it.
1749 =item TYPEMAPS
1751 Ref to array of typemap file names. Use this when the typemaps are
1752 in some directory other than the current directory or when they are
1753 not named B<typemap>. The last typemap in the list takes
1754 precedence. A typemap in the current directory has highest
1755 precedence, even if it isn't listed in TYPEMAPS. The default system
1756 typemap has lowest precedence.
1758 =item VERSION
1760 Your version number for distributing the package. This defaults to
1761 0.1.
1763 =item VERSION_FROM
1765 Instead of specifying the VERSION in the Makefile.PL you can let
1766 MakeMaker parse a file to determine the version number. The parsing
1767 routine requires that the file named by VERSION_FROM contains one
1768 single line to compute the version number. The first line in the file
1769 that contains the regular expression
1771 /([\$*])(([\w\:\']*)\bVERSION)\b.*\=/
1773 will be evaluated with eval() and the value of the named variable
1774 B<after> the eval() will be assigned to the VERSION attribute of the
1775 MakeMaker object. The following lines will be parsed o.k.:
1777 $VERSION = '1.00';
1778 *VERSION = \'1.01';
1779 ( $VERSION ) = '$Revision: 1.222 $ ' =~ /\$Revision:\s+([^\s]+)/;
1780 $FOO::VERSION = '1.10';
1781 *FOO::VERSION = \'1.11';
1782 our $VERSION = 1.2.3; # new for perl5.6.0
1784 but these will fail:
1786 my $VERSION = '1.01';
1787 local $VERSION = '1.02';
1788 local $FOO::VERSION = '1.30';
1790 (Putting C<my> or C<local> on the preceding line will work o.k.)
1792 The file named in VERSION_FROM is not added as a dependency to
1793 Makefile. This is not really correct, but it would be a major pain
1794 during development to have to rewrite the Makefile for any smallish
1795 change in that file. If you want to make sure that the Makefile
1796 contains the correct VERSION macro after any change of the file, you
1797 would have to do something like
1799 depend => { Makefile => '$(VERSION_FROM)' }
1801 See attribute C<depend> below.
1803 =item XS
1805 Hashref of .xs files. MakeMaker will default this. e.g.
1807 {'name_of_file.xs' => 'name_of_file.c'}
1809 The .c files will automatically be included in the list of files
1810 deleted by a make clean.
1812 =item XSOPT
1814 String of options to pass to xsubpp. This might include C<-C++> or
1815 C<-extern>. Do not include typemaps here; the TYPEMAP parameter exists for
1816 that purpose.
1818 =item XSPROTOARG
1820 May be set to an empty string, which is identical to C<-prototypes>, or
1821 C<-noprototypes>. See the xsubpp documentation for details. MakeMaker
1822 defaults to the empty string.
1824 =item XS_VERSION
1826 Your version number for the .xs file of this package. This defaults
1827 to the value of the VERSION attribute.
1829 =back
1831 =head2 Additional lowercase attributes
1833 can be used to pass parameters to the methods which implement that
1834 part of the Makefile.
1836 =over 2
1838 =item clean
1840 {FILES => "*.xyz foo"}
1842 =item depend
1844 {ANY_TARGET => ANY_DEPENDECY, ...}
1846 (ANY_TARGET must not be given a double-colon rule by MakeMaker.)
1848 =item dist
1850 {TARFLAGS => 'cvfF', COMPRESS => 'gzip', SUFFIX => '.gz',
1851 SHAR => 'shar -m', DIST_CP => 'ln', ZIP => '/bin/zip',
1852 ZIPFLAGS => '-rl', DIST_DEFAULT => 'private tardist' }
1854 If you specify COMPRESS, then SUFFIX should also be altered, as it is
1855 needed to tell make the target file of the compression. Setting
1856 DIST_CP to ln can be useful, if you need to preserve the timestamps on
1857 your files. DIST_CP can take the values 'cp', which copies the file,
1858 'ln', which links the file, and 'best' which copies symbolic links and
1859 links the rest. Default is 'best'.
1861 =item dynamic_lib
1863 {ARMAYBE => 'ar', OTHERLDFLAGS => '...', INST_DYNAMIC_DEP => '...'}
1865 =item linkext
1867 {LINKTYPE => 'static', 'dynamic' or ''}
1869 NB: Extensions that have nothing but *.pm files had to say
1871 {LINKTYPE => ''}
1873 with Pre-5.0 MakeMakers. Since version 5.00 of MakeMaker such a line
1874 can be deleted safely. MakeMaker recognizes when there's nothing to
1875 be linked.
1877 =item macro
1879 {ANY_MACRO => ANY_VALUE, ...}
1881 =item realclean
1883 {FILES => '$(INST_ARCHAUTODIR)/*.xyz'}
1885 =item test
1887 {TESTS => 't/*.t'}
1889 =item tool_autosplit
1891 {MAXLEN => 8}
1893 =back
1895 =head2 Overriding MakeMaker Methods
1897 If you cannot achieve the desired Makefile behaviour by specifying
1898 attributes you may define private subroutines in the Makefile.PL.
1899 Each subroutines returns the text it wishes to have written to
1900 the Makefile. To override a section of the Makefile you can
1901 either say:
1903 sub MY::c_o { "new literal text" }
1905 or you can edit the default by saying something like:
1907 sub MY::c_o {
1908 package MY; # so that "SUPER" works right
1909 my $inherited = shift->SUPER::c_o(@_);
1910 $inherited =~ s/old text/new text/;
1911 $inherited;
1914 If you are running experiments with embedding perl as a library into
1915 other applications, you might find MakeMaker is not sufficient. You'd
1916 better have a look at ExtUtils::Embed which is a collection of utilities
1917 for embedding.
1919 If you still need a different solution, try to develop another
1920 subroutine that fits your needs and submit the diffs to
1921 F<perl5-porters@perl.org> or F<comp.lang.perl.moderated> as appropriate.
1923 For a complete description of all MakeMaker methods see L<ExtUtils::MM_Unix>.
1925 Here is a simple example of how to add a new target to the generated
1926 Makefile:
1928 sub MY::postamble {
1930 $(MYEXTLIB): sdbm/Makefile
1931 cd sdbm && $(MAKE) all
1936 =head2 Hintsfile support
1938 MakeMaker.pm uses the architecture specific information from
1939 Config.pm. In addition it evaluates architecture specific hints files
1940 in a C<hints/> directory. The hints files are expected to be named
1941 like their counterparts in C<PERL_SRC/hints>, but with an C<.pl> file
1942 name extension (eg. C<next_3_2.pl>). They are simply C<eval>ed by
1943 MakeMaker within the WriteMakefile() subroutine, and can be used to
1944 execute commands as well as to include special variables. The rules
1945 which hintsfile is chosen are the same as in Configure.
1947 The hintsfile is eval()ed immediately after the arguments given to
1948 WriteMakefile are stuffed into a hash reference $self but before this
1949 reference becomes blessed. So if you want to do the equivalent to
1950 override or create an attribute you would say something like
1952 $self->{LIBS} = ['-ldbm -lucb -lc'];
1954 =head2 Distribution Support
1956 For authors of extensions MakeMaker provides several Makefile
1957 targets. Most of the support comes from the ExtUtils::Manifest module,
1958 where additional documentation can be found.
1960 =over 4
1962 =item make distcheck
1964 reports which files are below the build directory but not in the
1965 MANIFEST file and vice versa. (See ExtUtils::Manifest::fullcheck() for
1966 details)
1968 =item make skipcheck
1970 reports which files are skipped due to the entries in the
1971 C<MANIFEST.SKIP> file (See ExtUtils::Manifest::skipcheck() for
1972 details)
1974 =item make distclean
1976 does a realclean first and then the distcheck. Note that this is not
1977 needed to build a new distribution as long as you are sure that the
1978 MANIFEST file is ok.
1980 =item make manifest
1982 rewrites the MANIFEST file, adding all remaining files found (See
1983 ExtUtils::Manifest::mkmanifest() for details)
1985 =item make distdir
1987 Copies all the files that are in the MANIFEST file to a newly created
1988 directory with the name C<$(DISTNAME)-$(VERSION)>. If that directory
1989 exists, it will be removed first.
1991 =item make disttest
1993 Makes a distdir first, and runs a C<perl Makefile.PL>, a make, and
1994 a make test in that directory.
1996 =item make tardist
1998 First does a distdir. Then a command $(PREOP) which defaults to a null
1999 command, followed by $(TOUNIX), which defaults to a null command under
2000 UNIX, and will convert files in distribution directory to UNIX format
2001 otherwise. Next it runs C<tar> on that directory into a tarfile and
2002 deletes the directory. Finishes with a command $(POSTOP) which
2003 defaults to a null command.
2005 =item make dist
2007 Defaults to $(DIST_DEFAULT) which in turn defaults to tardist.
2009 =item make uutardist
2011 Runs a tardist first and uuencodes the tarfile.
2013 =item make shdist
2015 First does a distdir. Then a command $(PREOP) which defaults to a null
2016 command. Next it runs C<shar> on that directory into a sharfile and
2017 deletes the intermediate directory again. Finishes with a command
2018 $(POSTOP) which defaults to a null command. Note: For shdist to work
2019 properly a C<shar> program that can handle directories is mandatory.
2021 =item make zipdist
2023 First does a distdir. Then a command $(PREOP) which defaults to a null
2024 command. Runs C<$(ZIP) $(ZIPFLAGS)> on that directory into a
2025 zipfile. Then deletes that directory. Finishes with a command
2026 $(POSTOP) which defaults to a null command.
2028 =item make ci
2030 Does a $(CI) and a $(RCS_LABEL) on all files in the MANIFEST file.
2032 =back
2034 Customization of the dist targets can be done by specifying a hash
2035 reference to the dist attribute of the WriteMakefile call. The
2036 following parameters are recognized:
2038 CI ('ci -u')
2039 COMPRESS ('gzip --best')
2040 POSTOP ('@ :')
2041 PREOP ('@ :')
2042 TO_UNIX (depends on the system)
2043 RCS_LABEL ('rcs -q -Nv$(VERSION_SYM):')
2044 SHAR ('shar')
2045 SUFFIX ('.gz')
2046 TAR ('tar')
2047 TARFLAGS ('cvf')
2048 ZIP ('zip')
2049 ZIPFLAGS ('-r')
2051 An example:
2053 WriteMakefile( 'dist' => { COMPRESS=>"bzip2", SUFFIX=>".bz2" })
2055 =head2 Disabling an extension
2057 If some events detected in F<Makefile.PL> imply that there is no way
2058 to create the Module, but this is a normal state of things, then you
2059 can create a F<Makefile> which does nothing, but succeeds on all the
2060 "usual" build targets. To do so, use
2062 ExtUtils::MakeMaker::WriteEmptyMakefile();
2064 instead of WriteMakefile().
2066 This may be useful if other modules expect this module to be I<built>
2067 OK, as opposed to I<work> OK (say, this system-dependent module builds
2068 in a subdirectory of some other distribution, or is listed as a
2069 dependency in a CPAN::Bundle, but the functionality is supported by
2070 different means on the current architecture).
2072 =head1 ENVIRONMENT
2074 =over 8
2076 =item PERL_MM_OPT
2078 Command line options used by C<MakeMaker-E<gt>new()>, and thus by
2079 C<WriteMakefile()>. The string is split on whitespace, and the result
2080 is processed before any actual command line arguments are processed.
2082 =back
2084 =head1 SEE ALSO
2086 ExtUtils::MM_Unix, ExtUtils::Manifest, ExtUtils::testlib,
2087 ExtUtils::Install, ExtUtils::Embed
2089 =head1 AUTHORS
2091 Andy Dougherty <F<doughera@lafcol.lafayette.edu>>, Andreas KE<ouml>nig
2092 <F<A.Koenig@franz.ww.TU-Berlin.DE>>, Tim Bunce <F<Tim.Bunce@ig.co.uk>>.
2093 VMS support by Charles Bailey <F<bailey@newman.upenn.edu>>. OS/2
2094 support by Ilya Zakharevich <F<ilya@math.ohio-state.edu>>. Contact the
2095 makemaker mailing list C<mailto:makemaker@franz.ww.tu-berlin.de>, if
2096 you have any questions.
2098 =cut