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