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