X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FExtUtils%2FMakeMaker.pm;h=168c98d7f2c66bccbc6f688fccd6af9f67c4f6c7;hb=26ca90b622247714396690e385249f8ca1417aa0;hp=e6b96ef5624317592dca37ed5bd13ee558b6d722;hpb=ecfc54246c2a6f42dc95b17a964a6048192067d2;p=p5sagit%2Fp5-mst-13.2.git diff --git a/lib/ExtUtils/MakeMaker.pm b/lib/ExtUtils/MakeMaker.pm index e6b96ef..168c98d 100644 --- a/lib/ExtUtils/MakeMaker.pm +++ b/lib/ExtUtils/MakeMaker.pm @@ -1,1715 +1,1916 @@ +BEGIN {require 5.002;} # MakeMaker 5.17 was the last MakeMaker that was compatible with perl5.001m + +package ExtUtils::MakeMaker; + +$Version = $VERSION = "5.42"; +$Version_OK = "5.17"; # Makefiles older than $Version_OK will die + # (Will be checked from MakeMaker version 4.13 onwards) +($Revision = substr(q$Revision: 1.216 $, 10)) =~ s/\s+$//; + + + +require Exporter; +use Config; +use Carp (); +#use FileHandle (); + +use vars qw( + + @ISA @EXPORT @EXPORT_OK $AUTOLOAD + $ISA_TTY $Is_Mac $Is_OS2 $Is_VMS $Revision $Setup_done + $VERSION $Verbose $Version_OK %Config %Keep_after_flush + %MM_Sections %Prepend_dot_dot %Recognized_Att_Keys + @Get_from_Config @MM_Sections @Overridable @Parent + + ); +# use strict; + +# &DynaLoader::mod2fname should be available to miniperl, thus +# should be a pseudo-builtin (cmp. os2.c). +#eval {require DynaLoader;}; + +# +# Set up the inheritance before we pull in the MM_* packages, because they +# import variables and functions from here +# +@ISA = qw(Exporter); +@EXPORT = qw(&WriteMakefile &writeMakefile $Verbose &prompt); +@EXPORT_OK = qw($VERSION &Version_check &neatvalue &mkbootstrap &mksymlists + $Version); + # $Version in mixed case will go away! + +# +# Dummy package MM inherits actual methods from OS-specific +# default packages. We use this intermediate package so +# MY::XYZ->func() can call MM->func() and get the proper +# default routine without having to know under what OS +# it's running. +# +@MM::ISA = qw[ExtUtils::MM_Unix ExtUtils::Liblist ExtUtils::MakeMaker]; + +# +# Setup dummy package: +# MY exists for overriding methods to be defined within +# +{ + package MY; + @MY::ISA = qw(MM); +### sub AUTOLOAD { use Devel::Symdump; print Devel::Symdump->rnew->as_string; Carp::confess "hey why? $AUTOLOAD" } + package MM; + sub DESTROY {} +} + +# "predeclare the package: we only load it via AUTOLOAD +# but we have already mentioned it in @ISA +package ExtUtils::Liblist; + +package ExtUtils::MakeMaker; +# +# Now we can pull in the friends +# +$Is_VMS = $^O eq 'VMS'; +$Is_OS2 = $^O eq 'os2'; +$Is_Mac = $^O eq 'MacOS'; +$Is_Win32 = $^O eq 'MSWin32'; + +require ExtUtils::MM_Unix; + +if ($Is_VMS) { + require ExtUtils::MM_VMS; + require VMS::Filespec; # is a noop as long as we require it within MM_VMS +} +if ($Is_OS2) { + require ExtUtils::MM_OS2; +} +if ($Is_Mac) { + require ExtUtils::MM_Mac; +} +if ($Is_Win32) { + require ExtUtils::MM_Win32; +} + +# The SelfLoader would bring a lot of overhead for MakeMaker, because +# we know for sure we will use most of the autoloaded functions once +# we have to use one of them. So we write our own loader + +sub AUTOLOAD { + my $code; + if (defined fileno(DATA)) { + my $fh = select DATA; + my $o = $/; # For future reads from the file. + $/ = "\n__END__\n"; + $code = ; + $/ = $o; + select $fh; + close DATA; + eval $code; + if ($@) { + $@ =~ s/ at .*\n//; + Carp::croak $@; + } + } else { + warn "AUTOLOAD called unexpectedly for $AUTOLOAD"; + } + defined(&$AUTOLOAD) or die "Myloader inconsistency error"; + goto &$AUTOLOAD; +} + +# The only subroutine we do not SelfLoad is Version_Check because it's +# called so often. Loading this minimum still requires 1.2 secs on my +# Indy :-( + +sub Version_check { + my($checkversion) = @_; + die "Your Makefile was built with ExtUtils::MakeMaker v $checkversion. +Current Version is $ExtUtils::MakeMaker::VERSION. There have been considerable +changes in the meantime. +Please rerun 'perl Makefile.PL' to regenerate the Makefile.\n" + if $checkversion < $Version_OK; + printf STDOUT "%s %s %s %s.\n", "Makefile built with ExtUtils::MakeMaker v", + $checkversion, "Current Version is", $VERSION + unless $checkversion == $VERSION; +} + +sub warnhandler { + $_[0] =~ /^Use of uninitialized value/ && return; + $_[0] =~ /used only once/ && return; + $_[0] =~ /^Subroutine\s+[\w:]+\s+redefined/ && return; + warn @_; +} + +sub ExtUtils::MakeMaker::eval_in_subdirs ; +sub ExtUtils::MakeMaker::eval_in_x ; +sub ExtUtils::MakeMaker::full_setup ; +sub ExtUtils::MakeMaker::writeMakefile ; +sub ExtUtils::MakeMaker::new ; +sub ExtUtils::MakeMaker::check_manifest ; +sub ExtUtils::MakeMaker::parse_args ; +sub ExtUtils::MakeMaker::check_hints ; +sub ExtUtils::MakeMaker::mv_all_methods ; +sub ExtUtils::MakeMaker::skipcheck ; +sub ExtUtils::MakeMaker::flush ; +sub ExtUtils::MakeMaker::mkbootstrap ; +sub ExtUtils::MakeMaker::mksymlists ; +sub ExtUtils::MakeMaker::neatvalue ; +sub ExtUtils::MakeMaker::selfdocument ; +sub ExtUtils::MakeMaker::WriteMakefile ; +sub ExtUtils::MakeMaker::prompt ($;$) ; + +1; + +__DATA__ + +package ExtUtils::MakeMaker; + +sub WriteMakefile { + Carp::croak "WriteMakefile: Need even number of args" if @_ % 2; + local $SIG{__WARN__} = \&warnhandler; + + unless ($Setup_done++){ + full_setup(); + undef &ExtUtils::MakeMaker::full_setup; #safe memory + } + my %att = @_; + MM->new(\%att)->flush; +} + +sub prompt ($;$) { + my($mess,$def)=@_; + $ISA_TTY = -t STDIN && -t STDOUT ; + Carp::confess("prompt function called without an argument") unless defined $mess; + my $dispdef = defined $def ? "[$def] " : " "; + $def = defined $def ? $def : ""; + my $ans; + if ($ISA_TTY) { + local $|=1; + print "$mess $dispdef"; + chomp($ans = ); + } + return $ans || $def; +} + +sub eval_in_subdirs { + my($self) = @_; + my($dir); + use Cwd 'cwd'; + my $pwd = cwd(); + + foreach $dir (@{$self->{DIR}}){ + my($abs) = $self->catdir($pwd,$dir); + $self->eval_in_x($abs); + } + chdir $pwd; +} + +sub eval_in_x { + my($self,$dir) = @_; + package main; + chdir $dir or Carp::carp("Couldn't change to directory $dir: $!"); +# use FileHandle (); +# my $fh = new FileHandle; +# $fh->open("Makefile.PL") or Carp::carp("Couldn't open Makefile.PL in $dir"); + local *FH; + open(FH,"Makefile.PL") or Carp::carp("Couldn't open Makefile.PL in $dir"); +# my $eval = join "", <$fh>; + my $eval = join "", ; +# $fh->close; + close FH; + eval $eval; + if ($@) { +# if ($@ =~ /prerequisites/) { +# die "MakeMaker WARNING: $@"; +# } else { +# warn "WARNING from evaluation of $dir/Makefile.PL: $@"; +# } + warn "WARNING from evaluation of $dir/Makefile.PL: $@"; + } +} + +sub full_setup { + $Verbose ||= 0; + $^W=1; + + # package name for the classes into which the first object will be blessed + $PACKNAME = "PACK000"; + + @Attrib_help = qw/ + + AUTHOR ABSTRACT ABSTRACT_FROM BINARY_LOCATION LICENSE_HREF CAPI + C CCFLAGS CONFIG CONFIGURE DEFINE DIR DISTNAME DL_FUNCS DL_VARS + EXE_FILES EXCLUDE_EXT INCLUDE_EXT NO_VC FIRST_MAKEFILE FULLPERL H + INC INSTALLARCHLIB INSTALLBIN INSTALLDIRS INSTALLMAN1DIR + INSTALLMAN3DIR INSTALLPRIVLIB INSTALLSCRIPT INSTALLSITEARCH + INSTALLSITELIB INST_ARCHLIB INST_BIN INST_EXE INST_LIB + INST_MAN1DIR INST_MAN3DIR INST_SCRIPT LDFROM LIBPERL_A LIB LIBS + LINKTYPE MAKEAPERL MAKEFILE MAN1PODS MAN3PODS MAP_TARGET MYEXTLIB + NAME NEEDS_LINKING NOECHO NORECURS OBJECT OPTIMIZE PERL PERLMAINCC + PERL_ARCHLIB PERL_LIB PERL_SRC PL_FILES PM PMLIBDIRS PREFIX + PREREQ_PM SKIP TYPEMAPS VERSION VERSION_FROM XS XSOPT XSPROTOARG + XS_VERSION clean depend dist dynamic_lib linkext macro realclean + tool_autosplit + + IMPORTS + + installpm + /; + + # IMPORTS is used under OS/2 + + # ^^^ installpm is deprecated, will go about Summer 96 + + # @Overridable is close to @MM_Sections but not identical. The + # order is important. Many subroutines declare macros. These + # depend on each other. Let's try to collect the macros up front, + # then pasthru, then the rules. + + # MM_Sections are the sections we have to call explicitly + # in Overridable we have subroutines that are used indirectly + + + @MM_Sections = + qw( + + post_initialize const_config constants tool_autosplit tool_xsubpp + tools_other dist macro depend cflags const_loadlibs const_cccmd + post_constants + + pasthru + + c_o xs_c xs_o top_targets linkext dlsyms dynamic dynamic_bs + dynamic_lib static static_lib manifypods processPL installbin subdirs + clean realclean dist_basics dist_core dist_dir dist_test dist_ci + install force perldepend makefile staticmake test ppd + + ); # loses section ordering + + @Overridable = @MM_Sections; + push @Overridable, qw[ + + dir_target libscan makeaperl needs_linking subdir_x test_via_harness + test_via_script + + ]; + + push @MM_Sections, qw[ + + pm_to_blib selfdocument + + ]; + + # Postamble needs to be the last that was always the case + push @MM_Sections, "postamble"; + push @Overridable, "postamble"; + + # All sections are valid keys. + @Recognized_Att_Keys{@MM_Sections} = (1) x @MM_Sections; + + # we will use all these variables in the Makefile + @Get_from_Config = + qw( + ar cc cccdlflags ccdlflags dlext dlsrc ld lddlflags ldflags libc + lib_ext obj_ext osname osvers ranlib sitelibexp sitearchexp so exe_ext + ); + + my $item; + foreach $item (@Attrib_help){ + $Recognized_Att_Keys{$item} = 1; + } + foreach $item (@Get_from_Config) { + $Recognized_Att_Keys{uc $item} = $Config{$item}; + print "Attribute '\U$item\E' => '$Config{$item}'\n" + if ($Verbose >= 2); + } + + # + # When we eval a Makefile.PL in a subdirectory, that one will ask + # us (the parent) for the values and will prepend "..", so that + # all files to be installed end up below OUR ./blib + # + %Prepend_dot_dot = + qw( + + INST_BIN 1 INST_EXE 1 INST_LIB 1 INST_ARCHLIB 1 INST_SCRIPT + 1 MAP_TARGET 1 INST_MAN1DIR 1 INST_MAN3DIR 1 PERL_SRC 1 + PERL 1 FULLPERL 1 + + ); + + my @keep = qw/ + NEEDS_LINKING HAS_LINK_CODE + /; + @Keep_after_flush{@keep} = (1) x @keep; +} + +sub writeMakefile { + die <{PREREQ_PM}}) { + my $eval = "use $prereq $self->{PREREQ_PM}->{$prereq}"; + eval $eval; + if ($@){ + warn "Warning: prerequisite $prereq $self->{PREREQ_PM}->{$prereq} not found"; +# mjn +# } else { +# delete $self->{PREREQ_PM}{$prereq}; + } + } +# if (@unsatisfied){ +# unless (defined $ExtUtils::MakeMaker::useCPAN) { +# print qq{MakeMaker WARNING: prerequisites not found (@unsatisfied) +# Please install these modules first and rerun 'perl Makefile.PL'.\n}; +# if ($ExtUtils::MakeMaker::hasCPAN) { +# $ExtUtils::MakeMaker::useCPAN = prompt(qq{Should I try to use the CPAN module to fetch them for you?},"yes"); +# } else { +# print qq{Hint: You may want to install the CPAN module to autofetch the needed modules\n}; +# $ExtUtils::MakeMaker::useCPAN=0; +# } +# } +# if ($ExtUtils::MakeMaker::useCPAN) { +# require CPAN; +# CPAN->import(@unsatisfied); +# } else { +# die qq{prerequisites not found (@unsatisfied)}; +# } +# warn qq{WARNING: prerequisites not found (@unsatisfied)}; +# } + + if (defined $self->{CONFIGURE}) { + if (ref $self->{CONFIGURE} eq 'CODE') { + $self = { %$self, %{&{$self->{CONFIGURE}}}}; + } else { + Carp::croak "Attribute 'CONFIGURE' to WriteMakefile() not a code reference\n"; + } + } + + # This is for old Makefiles written pre 5.00, will go away + if ( Carp::longmess("") =~ /runsubdirpl/s ){ + Carp::carp("WARNING: Please rerun 'perl Makefile.PL' to regenerate your Makefiles\n"); + } + + my $newclass = ++$PACKNAME; + { +# no strict; + print "Blessing Object into class [$newclass]\n" if $Verbose>=2; + mv_all_methods("MY",$newclass); + bless $self, $newclass; + push @Parent, $self; + @{"$newclass\:\:ISA"} = 'MM'; + } + + if (defined $Parent[-2]){ + $self->{PARENT} = $Parent[-2]; + my $key; + for $key (keys %Prepend_dot_dot) { + next unless defined $self->{PARENT}{$key}; + $self->{$key} = $self->{PARENT}{$key}; + # PERL and FULLPERL may be command verbs instead of full + # file specifications under VMS. If so, don't turn them + # into a filespec. + $self->{$key} = $self->catdir("..",$self->{$key}) + unless $self->file_name_is_absolute($self->{$key}) + || ($^O eq 'VMS' and ($key =~ /PERL$/ && $self->{$key} =~ /^[\w\-\$]+$/)); + } + $self->{PARENT}->{CHILDREN}->{$newclass} = $self if $self->{PARENT}; + } else { + parse_args($self,@ARGV); + } + + $self->{NAME} ||= $self->guess_name; + + ($self->{NAME_SYM} = $self->{NAME}) =~ s/\W+/_/g; + + $self->init_main(); + + if (! $self->{PERL_SRC} ) { + my($pthinks) = $self->canonpath($INC{'Config.pm'}); + my($cthinks) = $self->catfile($Config{'archlibexp'},'Config.pm'); + $pthinks = VMS::Filespec::vmsify($pthinks) if $Is_VMS; + if ($pthinks ne $cthinks && + !($Is_Win32 and lc($pthinks) eq lc($cthinks))) { + print "Have $pthinks expected $cthinks\n"; + if ($Is_Win32) { + $pthinks =~ s![/\\]Config\.pm$!!i; $pthinks =~ s!.*[/\\]!!; + } + else { + $pthinks =~ s!/Config\.pm$!!; $pthinks =~ s!.*/!!; + } + print STDOUT <init_dirscan(); + $self->init_others(); + + push @{$self->{RESULT}}, <{NAME} extension to perl. +# +# It was generated automatically by MakeMaker version +# $VERSION (Revision: $Revision) from the contents of +# Makefile.PL. Don't edit this file, edit Makefile.PL instead. +# +# ANY CHANGES MADE HERE WILL BE LOST! +# +# MakeMaker Parameters: +END + + foreach $key (sort keys %initial_att){ + my($v) = neatvalue($initial_att{$key}); + $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/; + $v =~ tr/\n/ /s; + push @{$self->{RESULT}}, "# $key => $v"; + } + + # turn the SKIP array into a SKIPHASH hash + my (%skip,$skip); + for $skip (@{$self->{SKIP} || []}) { + $self->{SKIPHASH}{$skip} = 1; + } + delete $self->{SKIP}; # free memory + + if ($self->{PARENT}) { + for (qw/install dist dist_basics dist_core dist_dir dist_test dist_ci/) { + $self->{SKIPHASH}{$_} = 1; + } + } + + # We run all the subdirectories now. They don't have much to query + # from the parent, but the parent has to query them: if they need linking! + unless ($self->{NORECURS}) { + $self->eval_in_subdirs if @{$self->{DIR}}; + } + + my $section; + foreach $section ( @MM_Sections ){ + print "Processing Makefile '$section' section\n" if ($Verbose >= 2); + my($skipit) = $self->skipcheck($section); + if ($skipit){ + push @{$self->{RESULT}}, "\n# --- MakeMaker $section section $skipit."; + } else { + my(%a) = %{$self->{$section} || {}}; + push @{$self->{RESULT}}, "\n# --- MakeMaker $section section:"; + push @{$self->{RESULT}}, "# " . join ", ", %a if $Verbose && %a; + push @{$self->{RESULT}}, $self->nicetext($self->$section( %a )); + } + } + + push @{$self->{RESULT}}, "\n# End."; + pop @Parent; + + $self; +} + +sub WriteEmptyMakefile { + if (-f 'Makefile.old') { + chmod 0666, 'Makefile.old'; + unlink 'Makefile.old' or warn "unlink Makefile.old: $!"; + } + rename 'Makefile', 'Makefile.old' or warn "rename Makefile Makefile.old: $!" + if -f 'Makefile'; + open MF, '> Makefile' or die "open Makefile for write: $!"; + print MF <<'EOP'; +all: + +clean: + +install: + +makemakerdflt: + +test: + +EOP + close MF or die "close Makefile for write: $!"; +} + +sub check_manifest { + print STDOUT "Checking if your kit is complete...\n"; + require ExtUtils::Manifest; + $ExtUtils::Manifest::Quiet=$ExtUtils::Manifest::Quiet=1; #avoid warning + my(@missed)=ExtUtils::Manifest::manicheck(); + if (@missed){ + print STDOUT "Warning: the following files are missing in your kit:\n"; + print "\t", join "\n\t", @missed; + print STDOUT "\n"; + print STDOUT "Please inform the author.\n"; + } else { + print STDOUT "Looks good\n"; + } +} + +sub parse_args{ + my($self, @args) = @_; + foreach (@args){ + unless (m/(.*?)=(.*)/){ + help(),exit 1 if m/^help$/; + ++$Verbose if m/^verb/; + next; + } + my($name, $value) = ($1, $2); + if ($value =~ m/^~(\w+)?/){ # tilde with optional username + $value =~ s [^~(\w*)] + [$1 ? + ((getpwnam($1))[7] || "~$1") : + (getpwuid($>))[7] + ]ex; + } + $self->{uc($name)} = $value; + } + + # catch old-style 'potential_libs' and inform user how to 'upgrade' + if (defined $self->{potential_libs}){ + my($msg)="'potential_libs' => '$self->{potential_libs}' should be"; + if ($self->{potential_libs}){ + print STDOUT "$msg changed to:\n\t'LIBS' => ['$self->{potential_libs}']\n"; + } else { + print STDOUT "$msg deleted.\n"; + } + $self->{LIBS} = [$self->{potential_libs}]; + delete $self->{potential_libs}; + } + # catch old-style 'ARMAYBE' and inform user how to 'upgrade' + if (defined $self->{ARMAYBE}){ + my($armaybe) = $self->{ARMAYBE}; + print STDOUT "ARMAYBE => '$armaybe' should be changed to:\n", + "\t'dynamic_lib' => {ARMAYBE => '$armaybe'}\n"; + my(%dl) = %{$self->{dynamic_lib} || {}}; + $self->{dynamic_lib} = { %dl, ARMAYBE => $armaybe}; + delete $self->{ARMAYBE}; + } + if (defined $self->{LDTARGET}){ + print STDOUT "LDTARGET should be changed to LDFROM\n"; + $self->{LDFROM} = $self->{LDTARGET}; + delete $self->{LDTARGET}; + } + # Turn a DIR argument on the command line into an array + if (defined $self->{DIR} && ref \$self->{DIR} eq 'SCALAR') { + # So they can choose from the command line, which extensions they want + # the grep enables them to have some colons too much in case they + # have to build a list with the shell + $self->{DIR} = [grep $_, split ":", $self->{DIR}]; + } + # Turn a INCLUDE_EXT argument on the command line into an array + if (defined $self->{INCLUDE_EXT} && ref \$self->{INCLUDE_EXT} eq 'SCALAR') { + $self->{INCLUDE_EXT} = [grep $_, split '\s+', $self->{INCLUDE_EXT}]; + } + # Turn a EXCLUDE_EXT argument on the command line into an array + if (defined $self->{EXCLUDE_EXT} && ref \$self->{EXCLUDE_EXT} eq 'SCALAR') { + $self->{EXCLUDE_EXT} = [grep $_, split '\s+', $self->{EXCLUDE_EXT}]; + } + my $mmkey; + foreach $mmkey (sort keys %$self){ + print STDOUT " $mmkey => ", neatvalue($self->{$mmkey}), "\n" if $Verbose; + print STDOUT "'$mmkey' is not a known MakeMaker parameter name.\n" + unless exists $Recognized_Att_Keys{$mmkey}; + } + $| = 1 if $Verbose; +} + +sub check_hints { + my($self) = @_; + # We allow extension-specific hints files. + + return unless -d "hints"; + + # First we look for the best hintsfile we have + my(@goodhints); + my($hint)="${^O}_$Config{osvers}"; + $hint =~ s/\./_/g; + $hint =~ s/_$//; + return unless $hint; + + # Also try without trailing minor version numbers. + while (1) { + last if -f "hints/$hint.pl"; # found + } continue { + last unless $hint =~ s/_[^_]*$//; # nothing to cut off + } + return unless -f "hints/$hint.pl"; # really there + + # execute the hintsfile: +# use FileHandle (); +# my $fh = new FileHandle; +# $fh->open("hints/$hint.pl"); + local *FH; + open(FH,"hints/$hint.pl"); +# @goodhints = <$fh>; + @goodhints = ; +# $fh->close; + close FH; + print STDOUT "Processing hints file hints/$hint.pl\n"; + eval join('',@goodhints); + print STDOUT $@ if $@; +} + +sub mv_all_methods { + my($from,$to) = @_; + my($method); + my($symtab) = \%{"${from}::"}; +# no strict; + + # Here you see the *current* list of methods that are overridable + # from Makefile.PL via MY:: subroutines. As of VERSION 5.07 I'm + # still trying to reduce the list to some reasonable minimum -- + # because I want to make it easier for the user. A.K. + + foreach $method (@Overridable) { + + # We cannot say "next" here. Nick might call MY->makeaperl + # which isn't defined right now + + # Above statement was written at 4.23 time when Tk-b8 was + # around. As Tk-b9 only builds with 5.002something and MM 5 is + # standard, we try to enable the next line again. It was + # commented out until MM 5.23 + + next unless defined &{"${from}::$method"}; + + *{"${to}::$method"} = \&{"${from}::$method"}; + + # delete would do, if we were sure, nobody ever called + # MY->makeaperl directly + + # delete $symtab->{$method}; + + # If we delete a method, then it will be undefined and cannot + # be called. But as long as we have Makefile.PLs that rely on + # %MY:: being intact, we have to fill the hole with an + # inheriting method: + + eval "package MY; sub $method { shift->SUPER::$method(\@_); }"; + } + + # We have to clean out %INC also, because the current directory is + # changed frequently and Graham Barr prefers to get his version + # out of a History.pl file which is "required" so woudn't get + # loaded again in another extension requiring a History.pl + + # With perl5.002_01 the deletion of entries in %INC caused Tk-b11 + # to core dump in the middle of a require statement. The required + # file was Tk/MMutil.pm. The consequence is, we have to be + # extremely careful when we try to give perl a reason to reload a + # library with same name. The workaround prefers to drop nothing + # from %INC and teach the writers not to use such libraries. + +# my $inc; +# foreach $inc (keys %INC) { +# #warn "***$inc*** deleted"; +# delete $INC{$inc}; +# } +} + +sub skipcheck { + my($self) = shift; + my($section) = @_; + if ($section eq 'dynamic') { + print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ", + "in skipped section 'dynamic_bs'\n" + if $self->{SKIPHASH}{dynamic_bs} && $Verbose; + print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ", + "in skipped section 'dynamic_lib'\n" + if $self->{SKIPHASH}{dynamic_lib} && $Verbose; + } + if ($section eq 'dynamic_lib') { + print STDOUT "Warning (non-fatal): Target '\$(INST_DYNAMIC)' depends on ", + "targets in skipped section 'dynamic_bs'\n" + if $self->{SKIPHASH}{dynamic_bs} && $Verbose; + } + if ($section eq 'static') { + print STDOUT "Warning (non-fatal): Target 'static' depends on targets ", + "in skipped section 'static_lib'\n" + if $self->{SKIPHASH}{static_lib} && $Verbose; + } + return 'skipped' if $self->{SKIPHASH}{$section}; + return ''; +} + +sub flush { + my $self = shift; + my($chunk); +# use FileHandle (); +# my $fh = new FileHandle; + local *FH; + print STDOUT "Writing $self->{MAKEFILE} for $self->{NAME}\n"; + + unlink($self->{MAKEFILE}, "MakeMaker.tmp", $Is_VMS ? 'Descrip.MMS' : ''); +# $fh->open(">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!"; + open(FH,">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!"; + + for $chunk (@{$self->{RESULT}}) { +# print $fh "$chunk\n"; + print FH "$chunk\n"; + } + +# $fh->close; + close FH; + my($finalname) = $self->{MAKEFILE}; + rename("MakeMaker.tmp", $finalname); + chmod 0644, $finalname unless $Is_VMS; + + if ($self->{PARENT}) { + foreach (keys %$self) { # safe memory + delete $self->{$_} unless $Keep_after_flush{$_}; + } + } + + system("$Config::Config{eunicefix} $finalname") unless $Config::Config{eunicefix} eq ":"; +} + +# The following mkbootstrap() is only for installations that are calling +# the pre-4.1 mkbootstrap() from their old Makefiles. This MakeMaker +# writes Makefiles, that use ExtUtils::Mkbootstrap directly. +sub mkbootstrap { + die <".neatvalue($val)) ; + } + return "{ ".join(', ',@m)." }"; +} + +sub selfdocument { + my($self) = @_; + my(@m); + if ($Verbose){ + push @m, "\n# Full list of MakeMaker attribute values:"; + foreach $key (sort keys %$self){ + next if $key eq 'RESULT' || $key =~ /^[A-Z][a-z]/; + my($v) = neatvalue($self->{$key}); + $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/; + $v =~ tr/\n/ /s; + push @m, "# $key => $v"; + } + } + join "\n", @m; +} + package ExtUtils::MakeMaker; +1; + +__END__ + +=head1 NAME + +ExtUtils::MakeMaker - create an extension Makefile + +=head1 SYNOPSIS + +C + +C VALUE [, ...] );> + +which is really + +Cnew(\%att)-Eflush;> + +=head1 DESCRIPTION + +This utility is designed to write a Makefile for an extension module +from a Makefile.PL. It is based on the Makefile.SH model provided by +Andy Dougherty and the perl5-porters. + +It splits the task of generating the Makefile into several subroutines +that can be individually overridden. Each subroutine returns the text +it wishes to have written to the Makefile. + +MakeMaker is object oriented. Each directory below the current +directory that contains a Makefile.PL. Is treated as a separate +object. This makes it possible to write an unlimited number of +Makefiles with a single invocation of WriteMakefile(). + +=head2 How To Write A Makefile.PL + +The short answer is: Don't. + + Always begin with h2xs. + Always begin with h2xs! + ALWAYS BEGIN WITH H2XS! + +even if you're not building around a header file, and even if you +don't have an XS component. + +Run h2xs(1) before you start thinking about writing a module. For so +called pm-only modules that consist of C<*.pm> files only, h2xs has +the C<-X> switch. This will generate dummy files of all kinds that are +useful for the module developer. + +The medium answer is: + + use ExtUtils::MakeMaker; + WriteMakefile( NAME => "Foo::Bar" ); + +The long answer is the rest of the manpage :-) + +=head2 Default Makefile Behaviour + +The generated Makefile enables the user of the extension to invoke + + perl Makefile.PL # optionally "perl Makefile.PL verbose" + make + make test # optionally set TEST_VERBOSE=1 + make install # See below + +The Makefile to be produced may be altered by adding arguments of the +form C. E.g. + + perl Makefile.PL PREFIX=/tmp/myperl5 + +Other interesting targets in the generated Makefile are + + make config # to check if the Makefile is up-to-date + make clean # delete local temp files (Makefile gets renamed) + make realclean # delete derived files (including ./blib) + make ci # check in all the files in the MANIFEST file + make dist # see below the Distribution Support section + +=head2 make test + +MakeMaker checks for the existence of a file named F in the +current directory and if it exists it adds commands to the test target +of the generated Makefile that will execute the script with the proper +set of perl C<-I> options. + +MakeMaker also checks for any files matching glob("t/*.t"). It will +add commands to the test target of the generated Makefile that execute +all matching files via the L module with the C<-I> +switches set correctly. + +=head2 make testdb + +A useful variation of the above is the target C. It runs the +test under the Perl debugger (see L). If the file +F exists in the current directory, it is used for the test. + +If you want to debug some other testfile, set C variable +thusly: + + make testdb TEST_FILE=t/mytest.t + +By default the debugger is called using C<-d> option to perl. If you +want to specify some other option, set C variable: + + make testdb TESTDB_SW=-Dx + +=head2 make install + +make alone puts all relevant files into directories that are named by +the macros INST_LIB, INST_ARCHLIB, INST_SCRIPT, INST_MAN1DIR, and +INST_MAN3DIR. All these default to something below ./blib if you are +I building below the perl source directory. If you I +building below the perl source, INST_LIB and INST_ARCHLIB default to + ../../lib, and INST_SCRIPT is not defined. + +The I target of the generated Makefile copies the files found +below each of the INST_* directories to their INSTALL* +counterparts. Which counterparts are chosen depends on the setting of +INSTALLDIRS according to the following table: + + INSTALLDIRS set to + perl site + + INST_ARCHLIB INSTALLARCHLIB INSTALLSITEARCH + INST_LIB INSTALLPRIVLIB INSTALLSITELIB + INST_BIN INSTALLBIN + INST_SCRIPT INSTALLSCRIPT + INST_MAN1DIR INSTALLMAN1DIR + INST_MAN3DIR INSTALLMAN3DIR + +The INSTALL... macros in turn default to their %Config +($Config{installprivlib}, $Config{installarchlib}, etc.) counterparts. + +You can check the values of these variables on your system with + + perl '-V:install.*' + +And to check the sequence in which the library directories are +searched by perl, run + + perl -le 'print join $/, @INC' + + +=head2 PREFIX and LIB attribute + +PREFIX and LIB can be used to set several INSTALL* attributes in one +go. The quickest way to install a module in a non-standard place might +be + + perl Makefile.PL LIB=~/lib + +This will install the module's architecture-independent files into +~/lib, the architecture-dependent files into ~/lib/$archname/auto. + +Another way to specify many INSTALL directories with a single +parameter is PREFIX. + + perl Makefile.PL PREFIX=~ + +This will replace the string specified by $Config{prefix} in all +$Config{install*} values. + +Note, that in both cases the tilde expansion is done by MakeMaker, not +by perl by default, nor by make. Conflicts between parmeters LIB, +PREFIX and the various INSTALL* arguments are resolved so that +XXX + +If the user has superuser privileges, and is not working on AFS +(Andrew File System) or relatives, then the defaults for +INSTALLPRIVLIB, INSTALLARCHLIB, INSTALLSCRIPT, etc. will be appropriate, +and this incantation will be the best: + + perl Makefile.PL; make; make test + make install -$Version = 3.8; # Last edited 17th Jan 1995 by Andreas Koenig +make install per default writes some documentation of what has been +done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This feature +can be bypassed by calling make pure_install. -use Config; -use Carp; -use Cwd; +=head2 AFS users -require Exporter; -@ISA = qw(Exporter); -@EXPORT = qw(&WriteMakefile &mkbootstrap $Verbose); -@EXPORT_OK = qw($Version %att %skip %Recognized_Att_Keys - @MM_Sections %MM_Sections - &help &lsdir); +will have to specify the installation directories as these most +probably have changed since perl itself has been installed. They will +have to do this by calling -$Is_VMS = $Config{'osname'} eq 'VMS'; -require ExtUtils::MM_VMS if $Is_VMS; + perl Makefile.PL INSTALLSITELIB=/afs/here/today \ + INSTALLSCRIPT=/afs/there/now INSTALLMAN3DIR=/afs/for/manpages + make -use strict qw(refs); +Be careful to repeat this procedure every time you recompile an +extension, unless you are sure the AFS installation directories are +still valid. -$Version = $Version;# avoid typo warning -$Verbose = 0; -$^W=1; +=head2 Static Linking of a new Perl Binary +An extension that is built with the above steps is ready to use on +systems supporting dynamic loading. On systems that do not support +dynamic loading, any newly created extension has to be linked together +with the available resources. MakeMaker supports the linking process +by creating appropriate targets in the Makefile whenever an extension +is built. You can invoke the corresponding section of the makefile with -=head1 NAME + make perl -ExtUtils::MakeMaker - create an extension Makefile +That produces a new perl binary in the current directory with all +extensions linked in that can be found in INST_ARCHLIB , SITELIBEXP, +and PERL_ARCHLIB. To do that, MakeMaker writes a new Makefile, on +UNIX, this is called Makefile.aperl (may be system dependent). If you +want to force the creation of a new perl, it is recommended, that you +delete this Makefile.aperl, so the directories are searched-through +for linkable libraries again. -=head1 SYNOPSIS +The binary can be installed into the directory where perl normally +resides on your machine with -use ExtUtils::MakeMaker; + make inst_perl -WriteMakefile( ATTRIBUTE => VALUE [, ...] ); +To produce a perl binary with a different name than C, either say -=head1 DESCRIPTION + perl Makefile.PL MAP_TARGET=myperl + make myperl + make inst_perl -This utility is designed to write a Makefile for an extension module -from a Makefile.PL. It is based on the Makefile.SH model provided by -Andy Dougherty and the perl5-porters. +or say -It splits the task of generating the Makefile into several subroutines -that can be individually overridden. Each subroutine returns the text -it wishes to have written to the Makefile. + perl Makefile.PL + make myperl MAP_TARGET=myperl + make inst_perl MAP_TARGET=myperl -=head2 Default Makefile Behaviour +In any case you will be prompted with the correct invocation of the +C target that installs the new binary into INSTALLBIN. -The automatically generated Makefile enables the user of the extension -to invoke +make inst_perl per default writes some documentation of what has been +done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This +can be bypassed by calling make pure_inst_perl. - perl Makefile.PL - make - make test - make install +Warning: the inst_perl: target will most probably overwrite your +existing perl binary. Use with care! + +Sometimes you might want to build a statically linked perl although +your system supports dynamic loading. In this case you may explicitly +set the linktype with the invocation of the Makefile.PL or make: -(This section is yet to be completed ...) + perl Makefile.PL LINKTYPE=static # recommended + +or + + make LINKTYPE=static # works on most systems =head2 Determination of Perl Library and Installation Locations -MakeMaker needs to know, or to guess, where certain things are located. -Especially INST_LIB, INST_ARCHLIB, PERL_LIB, PERL_ARCHLIB and PERL_SRC. +MakeMaker needs to know, or to guess, where certain things are +located. Especially INST_LIB and INST_ARCHLIB (where to put the files +during the make(1) run), PERL_LIB and PERL_ARCHLIB (where to read +existing modules from), and PERL_INC (header files and C). + +Extensions may be built either using the contents of the perl source +directory tree or from the installed perl library. The recommended way +is to build extensions after you have run 'make install' on perl +itself. You can do that in any directory on your hard disk that is not +below the perl source tree. The support for extensions below the ext +directory of the perl distribution is only good for the standard +extensions that come with perl. + +If an extension is being built below the C directory of the perl +source then MakeMaker will set PERL_SRC automatically (e.g., +C<../..>). If PERL_SRC is defined and the extension is recognized as +a standard extension, then other variables default to the following: + + PERL_INC = PERL_SRC + PERL_LIB = PERL_SRC/lib + PERL_ARCHLIB = PERL_SRC/lib + INST_LIB = PERL_LIB + INST_ARCHLIB = PERL_ARCHLIB + +If an extension is being built away from the perl source then MakeMaker +will leave PERL_SRC undefined and default to using the installed copy +of the perl library. The other variables default to the following: + + PERL_INC = $archlibexp/CORE + PERL_LIB = $privlibexp + PERL_ARCHLIB = $archlibexp + INST_LIB = ./blib/lib + INST_ARCHLIB = ./blib/arch + +If perl has not yet been installed then PERL_SRC can be defined on the +command line as shown in the previous section. + + +=head2 Which architecture dependent directory? + +If you don't want to keep the defaults for the INSTALL* macros, +MakeMaker helps you to minimize the typing needed: the usual +relationship between INSTALLPRIVLIB and INSTALLARCHLIB is determined +by Configure at perl compilation time. MakeMaker supports the user who +sets INSTALLPRIVLIB. If INSTALLPRIVLIB is set, but INSTALLARCHLIB not, +then MakeMaker defaults the latter to be the same subdirectory of +INSTALLPRIVLIB as Configure decided for the counterparts in %Config , +otherwise it defaults to INSTALLPRIVLIB. The same relationship holds +for INSTALLSITELIB and INSTALLSITEARCH. + +MakeMaker gives you much more freedom than needed to configure +internal variables and get different results. It is worth to mention, +that make(1) also lets you configure most of the variables that are +used in the Makefile. But in the majority of situations this will not +be necessary, and should only be done, if the author of a package +recommends it (or you know what you're doing). + +=head2 Using Attributes and Parameters -Extensions may be built anywhere within the file system after perl has -been installed correctly. Before perl is installed extensions have to -be built below the C directory within the tree of the perl -source, i.e. where all the standard extensions are being built. The -generated Makefile will recognize, which of the two is the current -configuration and will set some variables accordingly. +The following attributes can be specified as arguments to WriteMakefile() +or as NAME=VALUE pairs on the command line: -Only if the extension is being built in PERL_SRC/ext, the variable -PERL_SRC is defined, otherwise it is undefined. Consequently -MakeMaker will default PERL_LIB and PERL_ARCHLIB to PERL_SRC/lib only -if PERL_SRC is defined, otherwise PERL_*LIB will default to the public -library locations. +=cut -INST_LIB and INST_ARCHLIB default to PERL_LIB and PERL_ARCHLIB if we -are building below the PERL_SRC/ext directory. Else they default to -./blib. +# The following "=item C" is used by the attrib_help routine +# likewise the "=back" below. So be careful when changing it! -=head2 Useful Default Makefile Macros +=over 2 -FULLEXT = Pathname for extension directory (eg DBD/Oracle). +=item C -BASEEXT = Basename part of FULLEXT. May be just equal FULLEXT. +Ref to array of *.c file names. Initialised from a directory scan +and the values portion of the XS attribute hash. This is not +currently used by MakeMaker but may be handy in Makefile.PLs. -ROOTEXT = Directory part of FULLEXT with leading slash (eg /DBD) +=item CCFLAGS -PERL_LIB = Directory where we read the perl library files +String that will be included in the compiler call command line between +the arguments INC and OPTIMIZE. -PERL_ARCHLIB = Same as above for architecture dependent files +=item CONFIG -INST_LIB = Directory where we put library files of this extension - while building it. If we are building below PERL_SRC/ext - we default to PERL_SRC/lib, else we default to ./blib. +Arrayref. E.g. [qw(archname manext)] defines ARCHNAME & MANEXT from +config.sh. MakeMaker will add to CONFIG the following values anyway: +ar +cc +cccdlflags +ccdlflags +dlext +dlsrc +ld +lddlflags +ldflags +libc +lib_ext +obj_ext +ranlib +sitelibexp +sitearchexp +so -INST_ARCHLIB = Same as above for architecture dependent files +=item CONFIGURE -INST_LIBDIR = $(INST_LIB)$(ROOTEXT) +CODE reference. The subroutine should return a hash reference. The +hash may contain further attributes, e.g. {LIBS =E ...}, that have to +be determined by some evaluation method. -INST_AUTODIR = $(INST_LIB)/auto/$(FULLEXT) +=item DEFINE -INST_ARCHAUTODIR = $(INST_ARCHLIB)/auto/$(FULLEXT) +Something like C<"-DHAVE_UNISTD_H"> -=head2 Customizing The Generated Makefile +=item DIR -If the Makefile generated does not fit your purpose you can change it -using the mechanisms described below. +Ref to array of subdirectories containing Makefile.PLs e.g. [ 'sdbm' +] in ext/SDBM_File -=head2 Using Attributes (and Parameters) +=item DISTNAME -The following attributes can be specified as arguments to WriteMakefile() -or as NAME=VALUE pairs on the command line: +Your name for distributing the package (by tar file). This defaults to +NAME above. -This description is not yet documented; you can get at the description -with the command - perl -e 'use ExtUtils::MakeMaker qw(&help); &help;' +=item DL_FUNCS -=head2 Overriding MakeMaker Methods +Hashref of symbol names for routines to be made available as +universal symbols. Each key/value pair consists of the package name +and an array of routine names in that package. Used only under AIX +(export lists) and VMS (linker options) at present. The routine +names supplied will be expanded in the same way as XSUB names are +expanded by the XS() macro. Defaults to -If you cannot achieve the desired Makefile behaviour by specifying -attributes you may define private subroutines in the Makefile.PL. -Each subroutines returns the text it wishes to have written to -the Makefile. To override a section of the Makefile you can -either say: + {"$(NAME)" => ["boot_$(NAME)" ] } - sub MY::c_o { "new literal text" } +e.g. -or you can edit the default by saying something like: + {"RPC" => [qw( boot_rpcb rpcb_gettime getnetconfigent )], + "NetconfigPtr" => [ 'DESTROY'] } - sub MY::c_o { $_=MM->c_o; s/old text/new text/; $_ } +=item DL_VARS -If you still need a different solution, try to develop another -subroutine, that fits your needs and submit the diffs to -perl5-porters@nicoh.com or comp.lang.perl as appropriate. +Array of symbol names for variables to be made available as +universal symbols. Used only under AIX (export lists) and VMS +(linker options) at present. Defaults to []. (e.g. [ qw( +Foo_version Foo_numstreams Foo_tree ) ]) +=item EXCLUDE_EXT -=head1 AUTHORS +Array of extension names to exclude when doing a static build. This +is ignored if INCLUDE_EXT is present. Consult INCLUDE_EXT for more +details. (e.g. [ qw( Socket POSIX ) ] ) -Andy Dougherty , Andreas Koenig -, Tim Bunce - -=head1 MODIFICATION HISTORY - -v1, August 1994; by Andreas Koenig. Based on Andy Dougherty's Makefile.SH. -v2, September 1994 by Tim Bunce. -v3.0 October 1994 by Tim Bunce. -v3.1 November 11th 1994 by Tim Bunce. -v3.2 November 18th 1994 by Tim Bunce. -v3.3 November 27th 1994 by Andreas Koenig. -v3.4 December 7th 1994 by Andreas Koenig and Tim Bunce. -v3.5 December 15th 1994 by Tim Bunce. -v3.6 December 15th 1994 by Tim Bunce. +This attribute may be most useful when specified as a string on the +commandline: perl Makefile.PL EXCLUDE_EXT='Socket Safe' -Added C and H attributes and corresponding macros. These default to the -list of *.c and *.h files in the directory. C also includes *.c file -names corresponding to any *.xs files in the directory. ARMAYBE should -now be specified as an attribute of the dynamic_lib section. The installpm -section now accepts a SPLITLIB attribute. This defaults to '$(INST_LIB)'. -Improved automatic setting of INST_ARCHLIB. Newlines in OBJECT now translate -into for better formatting. Improved -descriptive comments for EXTRALIBS, LDLOADLIBS and BSLOADLIBS. Bootstrap -files are now always installed - (after a small patch) the DynaLoader will -only read a non-empty bootstrap file. Subdirectory dependencies have -been improved. The .c files produced from .xs files now depend on -XSUBPPDEPS (the typemaps). +=item EXE_FILES -v3.7 December 30th By Tim Bunce +Ref to array of executable files. The files will be copied to the +INST_SCRIPT directory. Make realclean will delete them from there +again. -Most, if not all, the MakeMaker support for no perl source is now -included. Recent ld and mkbootstrap patches applied. -lX11_s suffix -fix applied. +=item NO_VC -Also contained patches to Makefile.SH, ext/DynaLoader/DynaLoader.pm, -ext/util/make_ext, and h2xs +In general any generated Makefile checks for the current version of +MakeMaker and the version the Makefile was built under. If NO_VC is +set, the version check is neglected. Do not write this into your +Makefile.PL, use it interactively instead. -v3.8 January 9th By Andreas Koenig and Tim Bunce +=item FIRST_MAKEFILE -- Introduces ./blib as the directory, where the ready-to-use module -will live for the time of the building process if PERL_SRC/lib is not -available. ./blib is turned into an absolute pathname and gets passed -to subdirectories when writing the Makefile. +The name of the Makefile to be produced. Defaults to the contents of +MAKEFILE, but can be overridden. This is used for the second Makefile +that will be produced for the MAP_TARGET. -- INST_ARCHLIB will now be set equal to INST_LIB if we cannot -determine it with the methods near line 620 (in the intialize -subroutine). +=item FULLPERL -- Introduced the install subroutine, that calls another make -recursively with INST_LIB, and INST_ARCHLIB set according to the local -conventions. +Perl binary able to run this extension. -- Since version 3.6 all *.al and *.ix files are installed into -$installprivlib. In perl5.000 they were installed into -$installarchlib. Version 3.8 takes precautions to delete old *.{al,ix} -files that are left over in $installarchlib. Installperl is also -patched to both delete old *.al and *.ix files, that were put into -$installarchlib, and to install them properly from now on. +=item H -- h2xs is patched by Dean Roehrich to reintroduce the C<-A> option and -reconsiders the use of the AutoLoader. Also podifies h2xs. +Ref to array of *.h file names. Similar to C. -- Patches to {DB_File,Fcntl,GDBM_File,POSIX,Socket}.pm, eliminating -AutoLoader from @ISA (by Dean Roehrich). +=item IMPORTS -- A patch to AutoSplit.pm makes sure, the target directory of the -split exists. +IMPORTS is only used on OS/2. -- installperl now installs all *.h files into $installarchlib/CORE. +=item INC -- added a simple help function +Include file dirs eg: C<"-I/usr/5include -I/path/to/inc"> -- AutoSplit: +=item INCLUDE_EXT - Turned two constants into package variables. - Modified the default for &autosplit to be $CheckModTime=1. - Added warning and comment if auto dir does not exist. - Enhanced AutoLoader check (POSIX.pm was not getting AutoSplit!) - Improved logging if $Verbose>=2. +Array of extension names to be included when doing a static build. +MakeMaker will normally build with all of the installed extensions when +doing a static build, and that is usually the desired behavior. If +INCLUDE_EXT is present then MakeMaker will build only with those extensions +which are explicitly mentioned. (e.g. [ qw( Socket POSIX ) ]) -- MakeMaker: +It is not necessary to mention DynaLoader or the current extension when +filling in INCLUDE_EXT. If the INCLUDE_EXT is mentioned but is empty then +only DynaLoader and the current extension will be included in the build. - EXPORT_OK lsdir(), it's very handy. - Deleted much of the early revision history. - Changed LDTARGET (bad name) to LDFROM (better, but not great :) - INST_ARCHLIB for ./blib found via mapping from INST_LIB ./blib - (this allows error message if INST_ARCHLIB still undefined) - Added optional regex filter to &lsdir. - Added cute auto handling of a ./$(BASEEXT)/*.pm directory as - per recent messages with Nick re ext/nTk/nTk/Text.pm - Added NOOP, RM_F, RM_RF, TOUCH, CP to %att. - NOOP is now "" on Unix, "" caused problems (see makefile section) - RM_F etc now expanded when Makefile written. - Old AUTOSPLITLIB definition deleted. - See new dynamic_lib section for new ARMAYBE handling. - install section now uses $(INSTALLPRIVLIB) because on some - systems INSTALLPRIVLIB != PRIVLIB (ditto for archlib) +This attribute may be most useful when specified as a string on the +commandline: perl Makefile.PL INCLUDE_EXT='POSIX Socket Devel::Peek' -=head1 NOTES +=item INSTALLARCHLIB -MakeMaker development work still to be done: - -Needs more complete documentation. - -The ext.libs file mechanism will need to be revised to allow a -make-a-perl [list-of-static-extensions] script to work. - -Add method to take a list of files and wrap it in a Makefile -compatible way (). +Used by 'make install', which copies files from INST_ARCHLIB to this +directory if INSTALLDIRS is set to perl. -=cut +=item INSTALLBIN +Directory to install binary files (e.g. tkperl) into. -# Setup dummy package: -# MY exists for overriding methods to be defined within -unshift(@MY::ISA, qw(MM)); +=item INSTALLDIRS -# Dummy package MM inherits actual methods from OS-specific -# default packages. We use this intermediate package so -# MY->func() can call MM->func() and get the proper -# default routine without having to know under what OS -# it's running. -unshift(@MM::ISA, $Is_VMS ? qw(ExtUtils::MM_VMS MM_Unix) : qw(MM_Unix)); - -$Attrib_Help = <<'END'; - NAME: Perl module name for this extension (DBD::Oracle) - This defaults to the directory name. - - DISTNAME: Your name for distributing the package (by tar file) - This defaults to NAME above. - - VERSION: Your version number for distributing the package. - This defaults to 0.1. - - INST_LIB: Perl library directory to install the module into. - INST_ARCHLIB: Perl architecture-dependent library to install into - (defaults to INST_LIB) - - PERL_LIB: Directory containing the Perl library to use. - PERL_SRC: Directory containing the Perl source code - (use of this should be avoided, it may be undefined) - - INC: Include file dirs eg: '-I/usr/5include -I/path/to/inc' - DEFINE: something like "-DHAVE_UNISTD_H" - OBJECT: List of object files, defaults to '$(BASEEXT).o', - but can be a long string containing all object files, - e.g. "tkpBind.o tkpButton.o tkpCanvas.o" - MYEXTLIB: If the extension links to a library that it builds - set this to the name of the library (see SDBM_File) - - LIBS: An anonymous array of alternative library specifications - to be searched for (in order) until at least one library - is found. - 'LIBS' => [ "-lgdbm", "-ldbm -lfoo", "-L/path -ldbm.nfs" ] - Mind, that any element of the array contains a complete - set of arguments for the ld command. So do not specify - 'LIBS' => ["-ltcl", "-ltk", "-lX11" ], #wrong - See ODBM_File/Makefile.PL for an example, where an - array is needed. If you specify a scalar as in - 'LIBS' => "-ltcl -ltk -lX11" - MakeMaker will turn it into an array with one element. - - LDFROM: defaults to "$(OBJECT)" and is used in the ld command - to specify what files to link/load from - (also see dynamic_lib below for how to specify ld flags) - - DIR: Ref to array of subdirectories containing Makefile.PLs - e.g. [ 'sdbm' ] in ext/SDBM_File - - PM: Hashref of .pm files and *.pl files to be installed. - e.g. { 'name_of_file.pm' => '$(INST_LIBDIR)/install_as.pm' } - By default this will include *.pm and *.pl. If a lib directory - exists and is not listed in DIR (above) then any *.pm and - *.pl files it contains will also be included by default. - - XS: Hashref of .xs files. MakeMaker will default this. - e.g. { 'name_of_file.xs' => 'name_of_file.c' } - The .c files will automatically be included in the list - of files deleted by a make clean. - - C: Ref to array of *.c file names. Initialised from a directory scan - and the values portion of the XS attribute hash. This is not - currently used by MakeMaker but may be handy in Makefile.PLs. - - H: Ref to array of *.h file names. Similar to C: above. - - LINKTYPE: =>'static' or 'dynamic' (default unless usedl=undef in config.sh) - Should only be used to force static linking (also see linkext below). - - CONFIG: =>[qw(archname manext)] defines ARCHNAME & MANEXT from config.sh - SKIP: =>[qw(name1 name2)] skip (do not write) sections of the Makefile - - PERL: - FULLPERL: - -Additional lowercase attributes can be used to pass parameters to the -methods which implement that part of the Makefile. These are not -normally required: - - installpm: {SPLITLIB => '$(INST_LIB)' (default) or '$(INST_ARCHLIB)'} - linkext: {LINKTYPE => 'static', 'dynamic' or ''} - dynamic_lib {ARMAYBE => 'ar', OTHERLDFLAGS => '...'} - clean: {FILES => "*.xyz foo"} - realclean: {FILES => '$(INST_ARCHAUTODIR)/*.xyz'} - distclean: {TARNAME=>'MyTarFile', TARFLAGS=>'cvfF', COMPRESS=>'gzip'} - tool_autosplit: {MAXLEN => 8} -END +Determines which of the two sets of installation directories to +choose: installprivlib and installarchlib versus installsitelib and +installsitearch. The first pair is chosen with INSTALLDIRS=perl, the +second with INSTALLDIRS=site. Default is site. -sub help {print $Attrib_Help;} - -@MM_Sections_spec = ( - 'post_initialize' => {}, - 'constants' => {}, - 'const_config' => {}, - 'const_loadlibs' => {}, - 'const_cccmd' => {}, - 'tool_autosplit' => {}, - 'tool_xsubpp' => {}, - 'tools_other' => {}, - 'post_constants' => {}, - 'c_o' => {}, - 'xs_c' => {}, - 'xs_o' => {}, - 'top_targets' => {}, - 'linkext' => {}, - 'dynamic' => {}, - 'dynamic_bs' => {}, - 'dynamic_lib' => {}, - 'static' => {}, - 'static_lib' => {}, - 'installpm' => {}, - 'subdirs' => {}, - 'clean' => {}, - 'realclean' => {}, - 'distclean' => {}, - 'test' => {}, - 'install' => {}, - 'force' => {}, - 'perldepend' => {}, - 'makefile' => {}, - 'postamble' => {}, -); -%MM_Sections = @MM_Sections_spec; # looses section ordering -@MM_Sections = grep(!ref, @MM_Sections_spec); # keeps order - -%Recognized_Att_Keys = %MM_Sections; # All sections are valid keys. -foreach(split(/\n/,$Attrib_Help)){ - chomp; - next unless m/^\s*(\w+):\s*(.*)/; - $Recognized_Att_Keys{$1} = $2; - print "Attribute '$1' => '$2'\n" if ($Verbose >= 2); -} +=item INSTALLMAN1DIR -%att = (); -%skip = (); +This directory gets the man pages at 'make install' time. Defaults to +$Config{installman1dir}. -sub skipcheck{ - my($section) = @_; - return 'skipped' if $skip{$section}; - return ''; -} +=item INSTALLMAN3DIR +This directory gets the man pages at 'make install' time. Defaults to +$Config{installman3dir}. -sub WriteMakefile { - %att = @_; - local($\)="\n"; +=item INSTALLPRIVLIB - print STDOUT "MakeMaker" if $Verbose; +Used by 'make install', which copies files from INST_LIB to this +directory if INSTALLDIRS is set to perl. - parse_args(\%att, @ARGV); - my(%initial_att) = %att; # record initial attributes +=item INSTALLSCRIPT - MY->initialize(@ARGV); +Used by 'make install' which copies files from INST_SCRIPT to this +directory. - print STDOUT "Writing Makefile for $att{NAME}"; +=item INSTALLSITELIB - unlink("Makefile", "MakeMaker.tmp", $Is_VMS ? 'Descrip.MMS' : ''); - open MAKE, ">MakeMaker.tmp" or die "Unable to open MakeMaker.tmp: $!"; - select MAKE; $|=1; select STDOUT; +Used by 'make install', which copies files from INST_LIB to this +directory if INSTALLDIRS is set to site (default). - print MAKE "# This Makefile is for the $att{NAME} extension to perl.\n#"; - print MAKE "# It was generated automatically by MakeMaker from the contents"; - print MAKE "# of Makefile.PL. Don't edit this file, edit Makefile.PL instead."; - print MAKE "#\n# ANY CHANGES MADE HERE WILL BE LOST! \n#"; - print MAKE "# MakeMaker Parameters: "; - foreach $key (sort keys %initial_att){ - my($v) = neatvalue($initial_att{$key}); - $v =~ tr/\n/ /s; - print MAKE "# $key => $v"; - } +=item INSTALLSITEARCH - # build hash for SKIP to make testing easy - %skip = map( ($_,1), @{$att{'SKIP'} || []}); +Used by 'make install', which copies files from INST_ARCHLIB to this +directory if INSTALLDIRS is set to site (default). - foreach $section ( @MM_Sections ){ - print "Processing Makefile '$section' section" if ($Verbose >= 2); - my($skipit) = skipcheck($section); - if ($skipit){ - print MAKE "\n# --- MakeMaker $section section $skipit."; - } else { - my(%a) = %{$att{$section} || {}}; - print MAKE "\n# --- MakeMaker $section section:"; - print MAKE "# ",%a if ($Verbose >= 2); - print(MAKE MY->nicetext(MY->$section( %a ))); - } - } +=item INST_ARCHLIB - if ($Verbose){ - print MAKE "\n# Full list of MakeMaker attribute values:"; - foreach $key (sort keys %att){ - my($v) = neatvalue($att{$key}); - $v =~ tr/\n/ /s; - print MAKE "# $key => $v"; - } - } +Same as INST_LIB for architecture dependent files. - print MAKE "\n# End."; - close MAKE; - my($finalname) = $Is_VMS ? "Descrip.MMS" : "Makefile"; - rename("MakeMaker.tmp", $finalname); +=item INST_BIN - chmod 0644, $finalname; - system("$Config{'eunicefix'} $finalname") unless $Config{'eunicefix'} eq ":"; +Directory to put real binary files during 'make'. These will be copied +to INSTALLBIN during 'make install' - 1; -} +=item INST_EXE +Old name for INST_SCRIPT. Deprecated. Please use INST_SCRIPT if you +need to use it. -sub mkbootstrap{ - parse_args(\%att, @ARGV); - MY->mkbootstrap(@_); -} +=item INST_LIB +Directory where we put library files of this extension while building +it. -sub parse_args{ - my($attr, @args) = @_; - foreach (@args){ - next unless m/(.*?)=(.*)/; - $$attr{$1} = $2; - } - # catch old-style 'potential_libs' and inform user how to 'upgrade' - if (defined $$attr{'potential_libs'}){ - my($msg)="'potential_libs' => '$$attr{potential_libs}' should be"; - if ($$attr{'potential_libs'}){ - print STDERR "$msg changed to:\n\t'LIBS' => ['$$attr{potential_libs}']\n"; - } else { - print STDERR "$msg deleted.\n"; - } - $$attr{LIBS} = [$$attr{'potential_libs'}]; - delete $$attr{'potential_libs'}; - } - # catch old-style 'ARMAYBE' and inform user how to 'upgrade' - if (defined $$attr{'ARMAYBE'}){ - my($armaybe) = $$attr{'ARMAYBE'}; - print STDERR "ARMAYBE => '$armaybe' should be changed to:\n", - "\t'dynamic_lib' => {ARMAYBE => '$armaybe'}\n"; - my(%dl) = %{$$attr{'dynamic_lib'} || {}}; - $$attr{'dynamic_lib'} = { %dl, ARMAYBE => $armaybe}; - delete $$attr{'ARMAYBE'}; - } - foreach(sort keys %{$attr}){ - print STDOUT " $_ => ".neatvalue($$attr{$_}) if ($Verbose); - warn "'$_' is not a known MakeMaker parameter name.\n" - unless exists $Recognized_Att_Keys{$_}; - } -} +=item INST_MAN1DIR +Directory to hold the man pages at 'make' time -sub neatvalue{ - my($v) = @_; - my($t) = ref $v; - return "'$v'" unless $t; - return "[ ".join(', ',map("'$_'",@$v))." ]" if ($t eq 'ARRAY'); - return "$v" unless $t eq 'HASH'; - my(@m, $key, $val); - push(@m,"$key=>".neatvalue($val)) while (($key,$val) = each %$v); - return "{ ".join(', ',@m)." }"; -} +=item INST_MAN3DIR +Directory to hold the man pages at 'make' time -# ------ Define the MakeMaker default methods in package MM_Unix ------ +=item INST_SCRIPT -package MM_Unix; +Directory, where executable files should be installed during +'make'. Defaults to "./blib/bin", just to have a dummy location during +testing. make install will copy the files in INST_SCRIPT to +INSTALLSCRIPT. -use Config; -use Cwd; -use File::Basename; -require Exporter; +=item LDFROM -Exporter::import('ExtUtils::MakeMaker', - qw(%att %skip %Recognized_Att_Keys $Verbose)); +defaults to "$(OBJECT)" and is used in the ld command to specify +what files to link/load from (also see dynamic_lib below for how to +specify ld flags) -# These attributes cannot be overridden externally -@Other_Att_Keys{qw(EXTRALIBS BSLOADLIBS LDLOADLIBS)} = (1) x 3; +=item LIBPERL_A -if ($Is_VMS = $Config{'osname'} eq 'VMS') { - require File::VMSspec; - import File::VMSspec 'vmsify'; -} +The filename of the perllibrary that will be used together with this +extension. Defaults to libperl.a. +=item LIB -sub initialize { - # Find out directory name. This may contain the extension name. - my($pwd) = fastcwd(); # from Cwd.pm +LIB can only be set at C time. It has the effect of +setting both INSTALLPRIVLIB and INSTALLSITELIB to that value regardless any - # --- Initialize PERL_LIB, INST_LIB, PERL_SRC +=item LIBS - # *Real* information: where did we get these two from? ... - $inc_config_dir = dirname($INC{'Config.pm'}); - $inc_carp_dir = dirname($INC{'Carp.pm'}); +An anonymous array of alternative library +specifications to be searched for (in order) until +at least one library is found. E.g. - # Typically PERL_* and INST_* will be identical but that need - # not be the case (e.g., installing into project libraries etc). + 'LIBS' => ["-lgdbm", "-ldbm -lfoo", "-L/path -ldbm.nfs"] - # Perl Macro: With source No source - # PERL_LIB ../../lib /usr/local/lib/perl5 - # PERL_ARCHLIB ../../lib /usr/local/lib/perl5/sun4-sunos - # PERL_SRC ../.. (undefined) +Mind, that any element of the array +contains a complete set of arguments for the ld +command. So do not specify - # INST Macro: Locally Publically - # INST_LIB ../../lib ./blib - # INST_ARCHLIB ../../lib ./blib + 'LIBS' => ["-ltcl", "-ltk", "-lX11"] - unless ($att{PERL_SRC}){ - foreach(qw(../.. ../../.. ../../../..)){ - ($att{PERL_SRC}=$_, last) if -f "$_/config.sh"; - } - } - unless ($att{PERL_SRC}){ - warn "Unable to locate perl source.\n"; - # we should also consider $ENV{PERL5LIB} here - $att{PERL_LIB} = $Config{'privlib'} unless $att{PERL_LIB}; - $att{PERL_ARCHLIB} = $Config{'archlib'} unless $att{PERL_ARCHLIB}; - $att{PERL_INC} = "$att{PERL_ARCHLIB}/CORE"; # wild guess for now - die "Try setting PERL_SRC in Makefile.PL or on command line.\n" - unless (-f "$att{PERL_INC}/perl.h"); - } else { - $att{PERL_LIB} = "$att{PERL_SRC}/lib" unless $att{PERL_LIB}; - $att{PERL_ARCHLIB} = $att{PERL_LIB}; - $att{PERL_INC} = $att{PERL_SRC}; - } +See ODBM_File/Makefile.PL for an example, where an array is needed. If +you specify a scalar as in - # INST_LIB typically pre-set if building an extension after - # perl has been built and installed. Setting INST_LIB allows - # you to build directly into privlib and avoid installperl. - unless ($att{INST_LIB}){ - if (defined $att{PERL_SRC}) { - $att{INST_LIB} = $att{PERL_LIB}; - } else { - $att{INST_LIB} = "$pwd/blib"; - } - } - # Try to work out what INST_ARCHLIB should be if not set: - unless ($att{INST_ARCHLIB}){ - my(%archmap) = ( - "$pwd/blib" => "$pwd/blib", # our private build lib - $att{PERL_LIB} => $att{PERL_ARCHLIB}, - $Config{'privlib'} => $Config{'archlib'}, - $Config{'installprivlib'} => $Config{'installarchlib'}, - $inc_carp_dir => $inc_config_dir, - ); - $att{INST_ARCHLIB} = $archmap{$att{INST_LIB}}; - die "Unable to determine INST_ARCHLIB. Please define it explicitly.\n" - unless $att{INST_ARCHLIB}; - } + 'LIBS' => "-ltcl -ltk -lX11" - # make a few simple checks - die "PERL_LIB ($att{PERL_LIB}) is not a perl library directory" - unless (-f "$att{PERL_LIB}/Exporter.pm"); - - # --- Initialize Module Name and Paths - - # NAME = The perl module name for this extension (eg DBD::Oracle). - # FULLEXT = Pathname for extension directory (eg DBD/Oracle). - # BASEEXT = Basename part of FULLEXT. May be just equal FULLEXT. - # ROOTEXT = Directory part of FULLEXT with leading /. - unless($att{NAME}){ # we have to guess our name - my($name) = $pwd; - if ($Is_VMS) { - $name =~ s:.*?([^.\]]+)\]:$1: unless ($name =~ s:.*[.\[]ext\.::); - ($att{NAME}=$name) =~ s#[.\]]#::#g; - } else { - $name =~ s:.*/:: unless ($name =~ s:^.*/ext/::); - ($att{NAME} =$name) =~ s#/#::#g; - } - } - ($att{FULLEXT} =$att{NAME}) =~ s#::#/#g ; #eg. BSD/Foo/Socket - ($att{BASEEXT} =$att{NAME}) =~ s#.*::##; #eg. Socket - ($att{ROOTEXT} =$att{FULLEXT}) =~ s#/?\Q$att{BASEEXT}\E$## ; # eg. /BSD/Foo - $att{ROOTEXT} = "/$att{ROOTEXT}" if $att{ROOTEXT}; - $att{ROOTEXT} = "" if $Is_VMS; +MakeMaker will turn it into an array with one element. - ($att{DISTNAME}=$att{NAME}) =~ s#(::)#-#g; - $att{VERSION} = "0.1" unless $att{VERSION}; +=item LINKTYPE +'static' or 'dynamic' (default unless usedl=undef in +config.sh). Should only be used to force static linking (also see +linkext below). - # --- Initialize Perl Binary Locations +=item MAKEAPERL - # Find Perl 5. The only contract here is that both 'PERL' and 'FULLPERL' - # will be working versions of perl 5. - $att{'PERL'} = MY->find_perl(5.0, [ qw(perl5 perl miniperl) ], - [ $att{PERL_SRC}, split(":", $ENV{PATH}), $Config{'bin'} ], 0 ) - unless ($att{'PERL'} && -x $att{'PERL'}); +Boolean which tells MakeMaker, that it should include the rules to +make a perl. This is handled automatically as a switch by +MakeMaker. The user normally does not need it. - # Define 'FULLPERL' to be a non-miniperl (used in test: target) - ($att{'FULLPERL'} = $att{'PERL'}) =~ s/miniperl/perl/ - unless ($att{'FULLPERL'} && -x $att{'FULLPERL'}); +=item MAKEFILE - if ($Is_VMS) { - ($att{'PERL'} = 'MCR ' . vmsify($att{'PERL'})) =~ s:.*/::; - ($att{'FULLPERL'} = 'MCR ' . vmsify($att{'FULLPERL'})) =~ s:.*/::; - } +The name of the Makefile to be produced. - # --- Initialize File and Directory Lists (.xs .pm etc) +=item MAN1PODS - { - my($name, %dir, %xs, %pm, %c, %h, %ignore); - $ignore{'test.pl'} = 1; - $ignore{'makefile.pl'} = 1 if $Is_VMS; - foreach $name (lsdir(".")){ - next if ($name =~ /^\./ or $ignore{$name}); - if (-d $name){ - $dir{$name} = $name if (-f "$name/Makefile.PL"); - }elsif ($name =~ /\.xs$/){ - my($c); ($c = $name) =~ s/\.xs$/.c/; - $xs{$name} = $c; - $c{$c} = 1; - }elsif ($name =~ /\.c$/){ - $c{$name} = 1; - }elsif ($name =~ /\.h$/){ - $h{$name} = 1; - }elsif ($name =~ /\.p[ml]$/){ - $pm{$name} = "\$(INST_LIBDIR)/$name"; - } - } +Hashref of pod-containing files. MakeMaker will default this to all +EXE_FILES files that include POD directives. The files listed +here will be converted to man pages and installed as was requested +at Configure time. - # If we have a ./lib dir that does NOT contain a Makefile.PL - # then add in any .pm and .pl files in that directory. - # This makes it easy and tidy to ship a number of perl files. - if (-d "lib" and !$dir{'lib'}){ - foreach $name (lsdir("lib", '\.p[ml]$')){ - # next unless ($name =~ /\.p[ml]$/); - $pm{"lib/$name"} = "\$(INST_LIBDIR)/$name"; - } - } +=item MAN3PODS - # Similarly, if we have a ./$(BASEEXT) dir without a Makefile.PL - # we treat it as a directory containing *.pm files for modules - # which are nested below this one. E.g., ./Tk.pm & ./Tk/Text.pm - if (-d $att{BASEEXT} and !$dir{$att{BASEEXT}}){ - foreach $name (lsdir($att{BASEEXT}, '\.p[ml]$')){ - # next unless ($name =~ /\.p[ml]$/); - $pm{"$att{BASEEXT}/$name"} = "\$(INST_LIBDIR)/$att{BASEEXT}/$name"; - } - } +Hashref of .pm and .pod files. MakeMaker will default this to all + .pod and any .pm files that include POD directives. The files listed +here will be converted to man pages and installed as was requested +at Configure time. - $att{DIR} = [sort keys %dir] unless $att{DIRS}; - $att{XS} = \%xs unless $att{XS}; - $att{PM} = \%pm unless $att{PM}; - $att{C} = [sort keys %c] unless $att{C}; - $att{H} = [sort keys %h] unless $att{H}; - } +=item MAP_TARGET - # --- Initialize Other Attributes +If it is intended, that a new perl binary be produced, this variable +may hold a name for that binary. Defaults to perl - for $key (keys(%Recognized_Att_Keys), keys(%Other_Att_Keys)){ - # avoid warnings for uninitialized vars - next if exists $att{$key}; - $att{$key} = ""; - } +=item MYEXTLIB - # Compute EXTRALIBS, BSLOADLIBS and LDLOADLIBS from $att{'LIBS'} - # Lets look at $att{LIBS} carefully: It may be an anon array, a string or - # undefined. In any case we turn it into an anon array: - $att{LIBS}=[] unless $att{LIBS}; - $att{LIBS}=[$att{LIBS}] if ref \$att{LIBS} eq SCALAR; - foreach ( @{$att{'LIBS'}} ){ - s/^\s*(.*\S)\s*$/$1/; # remove leading and trailing whitespace - my(@libs) = MY->extliblist($_); - if ($libs[0] or $libs[1] or $libs[2]){ - @att{EXTRALIBS, BSLOADLIBS, LDLOADLIBS} = @libs; - last; - } - } +If the extension links to a library that it builds set this to the +name of the library (see SDBM_File) - warn "CONFIG must be an array ref\n" - if ($att{CONFIG} and ref $att{CONFIG} ne 'ARRAY'); - $att{CONFIG} = [] unless (ref $att{CONFIG}); - push(@{$att{CONFIG}}, - qw( cc libc ldflags lddlflags ccdlflags cccdlflags - ranlib so dlext dlsrc installprivlib installarchlib - )); - push(@{$att{CONFIG}}, 'shellflags') if $Config{'shellflags'}; - - if ($Is_VMS) { - # This will not make other Makefile.PLs portable. Any Makefile.PL - # which says OBJECT => "foo.o bar.o" will fail on VMS. It might - # be better to fix the c_o section to produce .o files. - $att{OBJECT} = '$(BASEEXT).obj' unless $att{OBJECT}; - $att{OBJECT} =~ s/[^,\s]\s+/, /g; - $att{OBJECT} =~ s/\n+/, /g; - } else { - $att{OBJECT} = '$(BASEEXT).o' unless $att{OBJECT}; - $att{OBJECT} =~ s/\n+/ \\\n\t/g; - } - $att{BOOTDEP} = (-f "$att{BASEEXT}_BS") ? "$att{BASEEXT}_BS" : ""; - $att{LD} = ($Config{'ld'} || 'ld') unless $att{LD}; - $att{LDFROM} = '$(OBJECT)' unless $att{LDFROM}; - $att{LINKTYPE} = ($Config{'usedl'}) ? 'dynamic' : 'static' - unless $att{LINKTYPE}; - - # These get overridden for VMS and maybe some other systems - $att{NOOP} = ""; - $att{RM_F} = "rm -f"; - $att{RM_RF} = "rm -rf"; - $att{TOUCH} = "touch"; - $att{CP} = "cp"; -} +=item NAME +Perl module name for this extension (DBD::Oracle). This will default +to the directory name but should be explicitly defined in the +Makefile.PL. -sub lsdir{ - my($dir, $regex) = @_; - local(*DIR, @ls); - opendir(DIR, $_[0] || ".") or die "opendir: $!"; - @ls = readdir(DIR); - closedir(DIR); - @ls = grep(/$regex/, @ls) if $regex; - @ls; -} +=item NEEDS_LINKING +MakeMaker will figure out, if an extension contains linkable code +anywhere down the directory tree, and will set this variable +accordingly, but you can speed it up a very little bit, if you define +this boolean variable yourself. -sub find_perl{ - my($self, $ver, $names, $dirs, $trace) = @_; - my($name, $dir); - print "Looking for perl $ver by these names: @$names, in these dirs: @$dirs\n" - if ($trace); - foreach $dir (@$dirs){ - next unless defined $dir; # $att{PERL_SRC} may be undefined - foreach $name (@$names){ - print "checking $dir/$name\n" if ($trace >= 2); - if ($Is_VMS) { - $name .= ".exe" unless -x "$dir/$name"; - } - next unless -x "$dir/$name"; - print "executing $dir/$name\n" if ($trace); - my($out); - if ($Is_VMS) { - my($vmscmd) = 'MCR ' . vmsify("$dir/$name"); - $out = `$vmscmd -e "require $ver; print ""VER_OK\n"""`; - } else { - $out = `$dir/$name -e 'require $ver; print "VER_OK\n" ' 2>&1`; - } - return "$dir/$name" if $out =~ /VER_OK/; - } - } - warn "Unable to find a perl $ver (by these names: @$names, in these dirs: @$dirs)\n"; - 0; # false and not empty -} +=item NOECHO +Defaults to C<@>. By setting it to an empty string you can generate a +Makefile that echos all commands. Mainly used in debugging MakeMaker +itself. -sub post_initialize{ - ""; -} - +=item NORECURS -sub constants { - my(@m); +Boolean. Attribute to inhibit descending into subdirectories. - push @m, " -NAME = $att{NAME} -DISTNAME = $att{DISTNAME} -VERSION = $att{VERSION} - -# In which library should we install this extension? -# This is typically the same as PERL_LIB. -# (also see INST_LIBDIR and relationship to ROOTEXT) -INST_LIB = $att{INST_LIB} -INST_ARCHLIB = $att{INST_ARCHLIB} - -# Perl library to use when building the extension -PERL_LIB = $att{PERL_LIB} -PERL_ARCHLIB = $att{PERL_ARCHLIB} - -# Where is the perl source code located? (Eventually we should -# be able to build extensions without requiring the perl source -# but that's a way off yet). -PERL_SRC = $att{PERL_SRC} -# Perl header files (will eventually be under PERL_LIB) -PERL_INC = $att{PERL_INC} -# Perl binaries -PERL = $att{'PERL'} -FULLPERL = $att{'FULLPERL'} - -# FULLEXT = Pathname for extension directory (eg DBD/Oracle). -# BASEEXT = Basename part of FULLEXT. May be just equal FULLEXT. -# ROOTEXT = Directory part of FULLEXT with leading slash (eg /DBD) -FULLEXT = $att{FULLEXT} -BASEEXT = $att{BASEEXT} -ROOTEXT = $att{ROOTEXT} - -# These will be removed later. Use PERL_SRC and BASEEXT instead. -TOP = \$(PERL_SRC) -EXT = CHANGE_EXT_TO_BASEEXT - -INC = $att{INC} -DEFINE = $att{DEFINE} -OBJECT = $att{OBJECT} -LDFROM = $att{LDFROM} -LINKTYPE = $att{LINKTYPE} - -# Source code: -XS= ".join(" \\\n\t", sort keys %{$att{XS}})." -C = ".join(" \\\n\t", @{$att{C}})." -H = ".join(" \\\n\t", @{$att{H}})." - -.SUFFIXES: .xs - -.PRECIOUS: Makefile - -.PHONY: all config static dynamic test - -# This extension may link to it's own library (see SDBM_File) -MYEXTLIB = $att{MYEXTLIB} - -# Where is the Config.pm that we are using/depend on -CONFIGDEP = \$(PERL_ARCHLIB)/Config.pm -"; - - push @m, ' -# Where to put things: -INST_LIBDIR = $(INST_LIB)$(ROOTEXT) -INST_ARCHLIBDIR = $(INST_ARCHLIB)$(ROOTEXT) - -'; - - push @m, ' -INST_AUTODIR = $(INST_LIB)/auto/$(FULLEXT) -INST_ARCHAUTODIR = $(INST_ARCHLIB)/auto/$(FULLEXT) -'; - - push @m, ' -INST_BOOT = $(INST_ARCHAUTODIR)/$(BASEEXT).bs -INST_DYNAMIC = $(INST_ARCHAUTODIR)/$(BASEEXT).$(DLEXT) -INST_STATIC = $(BASEEXT).a -INST_PM = '.join(" \\\n\t", sort values %{$att{PM}}).' -'; - - join('',@m); -} +=item OBJECT +List of object files, defaults to '$(BASEEXT)$(OBJ_EXT)', but can be a long +string containing all object files, e.g. "tkpBind.o +tkpButton.o tkpCanvas.o" -sub const_cccmd{ - # This is implemented in the - # same manner as extliblist, e.g., do both and compare results during - # the transition period. - my($cc,$ccflags,$optimize,$large,$split)=@Config{qw(cc ccflags optimize large split)}; - my($prog, $old); - - chop($old = `cd $att{PERL_SRC}; sh $Config{'shellflags'} ./cflags $att{BASEEXT}.c`) - if $att{PERL_SRC}; - - # Why is this written this way ? - if ($prog = $Config{"$att{BASEEXT}_cflags"}) { - my(@o)=`cc=\"$cc\" - ccflags=\"$ccflags\" - optimize=\"$optimize\" - large=\"$large\" - split=\"$split\" - eval '$prog' - echo cc=\$cc - echo ccflags=\$ccflags - echo optimize=\$optimize - echo large=\$large - echo split=\$split - `; - my(%cflags); - foreach $line (@o){ - chomp $line; - if ($line =~ /(.*?)\s*=\s*(.*)\s*$/){ - $cflags{$1} = $2; - print STDERR " $1 = $2" if $Verbose; - } - } - ($cc,$ccflags,$optimize,$large,$split)=@cflags{qw(cc ccflags optimize large split)}; - } +=item OPTIMIZE - my($new) = "$cc -c $ccflags $optimize $large $split"; - if (defined($old) and $new ne $old) { - warn "Warning (non-fatal): cflags evaluation in MakeMaker differs from shell output\n" - ." package: $att{NAME}\n" - ." old: $old\n" - ." new: $new\n" - ." Using 'old' set.\n" - ."Please notify perl5-porters\@nicoh.com\n"; - } - my($cccmd)=($old) ? $old : $new; - "CCCMD = $cccmd\n"; -} +Defaults to C<-O>. Set it to C<-g> to turn debugging on. The flag is +passed to subdirectory makes. +=item PERL -# --- Constants Sections --- +Perl binary for tasks that can be done by miniperl -sub const_config{ - my(@m,$m); - push(@m,"\n# These definitions are from config.sh (via $INC{'Config.pm'})\n"); - my(%once_only); - foreach $m (@{$att{'CONFIG'}}){ - next if $once_only{$m}; - warn "CONFIG key '$m' does not exist in Config.pm\n" - unless exists $Config{$m}; - push @m, "\U$m\E = $Config{$m}\n"; - $once_only{$m} = 1; - } - join('', @m); -} +=item PERLMAINCC +The call to the program that is able to compile perlmain.c. Defaults +to $(CC). -sub const_loadlibs{ - " -# $att{NAME} might depend on some other libraries: -# (These comments may need revising:) -# -# Dependent libraries can be linked in one of three ways: -# -# 1. (For static extensions) by the ld command when the perl binary -# is linked with the extension library. See EXTRALIBS below. -# -# 2. (For dynamic extensions) by the ld command when the shared -# object is built/linked. See LDLOADLIBS below. -# -# 3. (For dynamic extensions) by the DynaLoader when the shared -# object is loaded. See BSLOADLIBS below. -# -# EXTRALIBS = List of libraries that need to be linked with when -# linking a perl binary which includes this extension -# Only those libraries that actually exist are included. -# These are written to a file and used when linking perl. -# -# LDLOADLIBS = List of those libraries which can or must be linked into -# the shared library when created using ld. These may be -# static or dynamic libraries. -# -# BSLOADLIBS = List of those libraries that are needed but can be -# linked in dynamically at run time on this platform. -# SunOS/Solaris does not need this because ld records -# the information (from LDLOADLIBS) into the object file. -# This list is used to create a .bs (bootstrap) file. -# The bootstrap file is installed only if it's not empty. -# -EXTRALIBS = $att{'EXTRALIBS'} -LDLOADLIBS = $att{'LDLOADLIBS'} -BSLOADLIBS = $att{'BSLOADLIBS'} -"; -} +=item PERL_ARCHLIB +Same as above for architecture dependent files -# --- Tool Sections --- +=item PERL_LIB -sub tool_autosplit{ - my($self, %attribs) = @_; - my($asl) = ""; - $asl = "\$AutoSplit::Maxlen=$attribs{MAXLEN};" if $attribs{MAXLEN}; - q{ -# Usage: $(AUTOSPLITFILE) FileToSplit AutoDirToSplitInto -# Remark: the "" around the -I switches are helpful for the VMS support -AUTOSPLITFILE = $(PERL) "-I$(PERL_ARCHLIB)" "-I$(PERL_LIB)" -e 'use AutoSplit;}.$asl.q{ AutoSplit::autosplit_file($$ARGV[0], $$ARGV[1], 0, 1, 1) ;' -}; -} +Directory containing the Perl library to use. +=item PERL_SRC -sub tool_xsubpp{ - my($xsdir) = '$(PERL_LIB)/ExtUtils'; - # drop back to old location if xsubpp is not in new location yet - $xsdir = '$(PERL_SRC)/ext' unless (-f "$att{PERL_LIB}/ExtUtils/xsubpp"); - my(@tmdeps) = ('$(XSUBPPDIR)/typemap'); - push(@tmdeps, "typemap") if -f "typemap"; - my(@tmargs) = map("-typemap $_", @tmdeps); - " -XSUBPPDIR = $xsdir -XSUBPP = \$(XSUBPPDIR)/xsubpp -XSUBPPDEPS = @tmdeps -XSUBPPARGS = @tmargs -"; -}; - - -sub tools_other{ - " -SHELL = /bin/sh -LD = $att{LD} -TOUCH = $att{TOUCH} -CP = $att{CP} -RM_F = $att{RM_F} -RM_RF = $att{RM_RF} -".q{ -# The following is a portable way to say mkdir -p -MKPATH = $(PERL) -wle '$$"="/"; foreach $$p (@ARGV){ my(@p); foreach(split(/\//,$$p)){ push(@p,$$_); next if -d "@p/"; print "mkdir @p"; mkdir("@p",0777)||die $$! }} exit 0;' -}; -} +Directory containing the Perl source code (use of this should be +avoided, it may be undefined) +=item PL_FILES -sub post_constants{ - ""; -} +Ref to hash of files to be processed as perl programs. MakeMaker +will default to any found *.PL file (except Makefile.PL) being keys +and the basename of the file being the value. E.g. + {'foobar.PL' => 'foobar'} -# --- Translation Sections --- +The *.PL files are expected to produce output to the target files +themselves. -sub c_o { - ' -.c.o: - $(CCCMD) $(CCCDLFLAGS) -I$(PERL_INC) $(DEFINE) $(INC) $*.c -'; -} +=item PM -sub xs_c { - ' -.xs.c: - $(PERL) $(XSUBPP) $(XSUBPPARGS) $*.xs >xstmp.c && mv xstmp.c $@ -'; -} +Hashref of .pm files and *.pl files to be installed. e.g. -sub xs_o { # many makes are too dumb to use xs_c then c_o - ' -.xs.o: - $(PERL) $(XSUBPP) $(XSUBPPARGS) $*.xs >xstmp.c && mv xstmp.c $*.c - $(CCCMD) $(CCCDLFLAGS) -I$(PERL_INC) $(DEFINE) $(INC) $*.c -'; -} + {'name_of_file.pm' => '$(INST_LIBDIR)/install_as.pm'} +By default this will include *.pm and *.pl and the files found in +the PMLIBDIRS directories. Defining PM in the +Makefile.PL will override PMLIBDIRS. -# --- Target Sections --- +=item PMLIBDIRS -sub top_targets{ - ' -all :: config linkext $(INST_PM) -'.$att{NOOP}.' +Ref to array of subdirectories containing library files. Defaults to +[ 'lib', $(BASEEXT) ]. The directories will be scanned and I files +they contain will be installed in the corresponding location in the +library. A libscan() method can be used to alter the behaviour. +Defining PM in the Makefile.PL will override PMLIBDIRS. -config :: Makefile - @$(MKPATH) $(INST_LIBDIR) - @$(MKPATH) $(INST_ARCHAUTODIR) -'; -} +=item PREFIX -sub linkext { - my($self, %attribs) = @_; - # LINKTYPE => static or dynamic - my($linktype) = $attribs{LINKTYPE} || '$(LINKTYPE)'; - " -linkext :: $linktype -$att{NOOP} -"; -} +Can be used to set the three INSTALL* attributes in one go (except for +probably INSTALLMAN1DIR, if it is not below PREFIX according to +%Config). They will have PREFIX as a common directory node and will +branch from that node into lib/, lib/ARCHNAME or whatever Configure +decided at the build time of your perl (unless you override one of +them, of course). +=item PREREQ_PM -# --- Dynamic Loading Sections --- +Hashref: Names of modules that need to be available to run this +extension (e.g. Fcntl for SDBM_File) are the keys of the hash and the +desired version is the value. If the required version number is 0, we +only check if any version is installed already. -sub dynamic { - ' -# $(INST_PM) has been moved to the all: target. -# It remains here for awhile to allow for old usage: "make dynamic" -dynamic :: $(INST_DYNAMIC) $(INST_BOOT) $(INST_PM) -'.$att{NOOP}.' -'; -} +=item SKIP -sub dynamic_bs { - my($self, %attribs) = @_; - ' -BOOTSTRAP = '."$att{BASEEXT}.bs".' - -# As MakeMaker mkbootstrap might not write a file (if none is required) -# we use touch to prevent make continually trying to remake it. -# The DynaLoader only reads a non-empty file. -$(BOOTSTRAP): '.$att{BOOTDEP}.' $(CONFIGDEP) Makefile.PL - $(PERL) -I$(PERL_ARCHLIB) -I$(PERL_LIB) \ - -e \'use ExtUtils::MakeMaker; &mkbootstrap("$(BSLOADLIBS)");\' \ - INST_LIB=$(INST_LIB) INST_ARCHLIB=$(INST_ARCHLIB) PERL_SRC=$(PERL_SRC) NAME=$(NAME) - @$(TOUCH) $(BOOTSTRAP) - -$(INST_BOOT): $(BOOTSTRAP) - @'.$att{RM_RF}.' $(INST_BOOT) - '.$att{CP}.' $(BOOTSTRAP) $(INST_BOOT) -'; -} +Arryref. E.g. [qw(name1 name2)] skip (do not write) sections of the +Makefile. Caution! Do not use the SKIP attribute for the neglectible +speedup. It may seriously damage the resulting Makefile. Only use it, +if you really need it. -sub dynamic_lib { - my($self, %attribs) = @_; - my($otherldflags) = $attribs{OTHERLDFLAGS} || ""; - my($armaybe) = $attribs{ARMAYBE} || $att{ARMAYBE} || ":"; - my($ldfrom) = '$(LDFROM)'; - my(@m); - push(@m,' -ARMAYBE = '.$armaybe.' -OTHERLDFLAGS = '.$otherldflags.' - -$(INST_DYNAMIC): $(OBJECT) $(MYEXTLIB) $(BOOTSTRAP) - @$(MKPATH) $(INST_ARCHAUTODIR) -'); - if ($armaybe ne ':'){ - $ldfrom = "tmp.a"; - push(@m,' $(ARMAYBE) cr '.$ldfrom.' $(OBJECT)'."\n"); - push(@m,' $(RANLIB) '."$ldfrom\n"); - } - push(@m,' $(LD) $(LDDLFLAGS) -o $@ '.$ldfrom. - ' $(OTHERLDFLAGS) $(MYEXTLIB) $(LDLOADLIBS)'."\n"); - join('',@m); -} +=item TYPEMAPS +Ref to array of typemap file names. Use this when the typemaps are +in some directory other than the current directory or when they are +not named B. The last typemap in the list takes +precedence. A typemap in the current directory has highest +precedence, even if it isn't listed in TYPEMAPS. The default system +typemap has lowest precedence. -# --- Static Loading Sections --- +=item VERSION -sub static { - ' -# $(INST_PM) has been moved to the all: target. -# It remains here for awhile to allow for old usage: "make static" -static :: $(INST_STATIC) $(INST_PM) -'.$att{NOOP}.' -'; -} +Your version number for distributing the package. This defaults to +0.1. -sub static_lib{ - my(@m); - push(@m, <<'END'); -$(INST_STATIC): $(OBJECT) $(MYEXTLIB) -END - # If this extension has it's own library (eg SDBM_File) - # then copy that to $(INST_STATIC) and add $(OBJECT) into it. - push(@m, " $att{CP} \$(MYEXTLIB) \$\@\n") if $att{MYEXTLIB}; - - push(@m, <<'END'); - ar cr $@ $(OBJECT) && $(RANLIB) $@ - @: New mechanism - not yet used: - @echo $(EXTRALIBS) > $(INST_ARCHAUTODIR)/extralibs.ld - $(CP) $@ $(INST_ARCHAUTODIR)/ -END - push(@m, <<'END') if $att{PERL_SRC}; - @: Old mechanism - still needed: - @echo $(EXTRALIBS) >> $(PERL_SRC)/ext.libs -END - join('', "\n",@m); -} +=item VERSION_FROM +Instead of specifying the VERSION in the Makefile.PL you can let +MakeMaker parse a file to determine the version number. The parsing +routine requires that the file named by VERSION_FROM contains one +single line to compute the version number. The first line in the file +that contains the regular expression -sub installpm { - my($self, %attribs) = @_; - # By default .pm files are split into the architecture independent - # library. This is a good thing. If a specific module requires that - # it's .pm files are split into the architecture specific library - # then it should use: installpm => {SPLITLIB=>'$(INST_ARCHLIB)'} - # Note that installperl currently interferes with this (Config.pm) - # User can disable split by saying: installpm => {SPLITLIB=>''} - my($splitlib) = '$(INST_LIB)'; # NOT arch specific by default - $splitlib = $attribs{SPLITLIB} if exists $attribs{SPLITLIB}; - my(@m, $dist); - foreach $dist (sort keys %{$att{PM}}){ - my($inst) = $att{PM}->{$dist}; - push(@m, "\n# installpm: $dist => $inst, splitlib=$splitlib\n"); - push(@m, MY->installpm_x($dist, $inst, $splitlib)); - push(@m, "\n"); - } - join('', @m); -} + /([\$*])(([\w\:\']*)\bVERSION)\b.*\=/ -sub installpm_x { # called by installpm per file - my($self, $dist, $inst, $splitlib) = @_; - my($instdir) = $inst =~ m|(.*)/|; - my(@m); - push(@m," -$inst: $dist -".' @'.$att{RM_F}.' $@ - @$(MKPATH) '.$instdir.' - '.$att{CP}.' $? $@ -'); - push(@m, "\t\$(AUTOSPLITFILE) \$@ $splitlib/auto\n") - if ($splitlib and $inst =~ m/\.pm$/); - join('', @m); -} +will be evaluated with eval() and the value of the named variable +B the eval() will be assigned to the VERSION attribute of the +MakeMaker object. The following lines will be parsed o.k.: + $VERSION = '1.00'; + *VERSION = \'1.01'; + ( $VERSION ) = '$Revision: 1.216 $ ' =~ /\$Revision:\s+([^\s]+)/; + $FOO::VERSION = '1.10'; + *FOO::VERSION = \'1.11'; -# --- Sub-directory Sections --- +but these will fail: -sub subdirs { - my(@m); - # This method provides a mechanism to automatically deal with - # subdirectories containing further Makefile.PL scripts. - # It calls the subdir_x() method for each subdirectory. - foreach(<*/Makefile.PL>){ - s:/Makefile\.PL$:: ; - print "Including $_ subdirectory" if ($Verbose); - push(@m, MY->subdir_x($_)); - } - if (@m){ - unshift(@m, " -# The default clean, realclean and test targets in this Makefile -# have automatically been given entries for each subdir. + my $VERSION = '1.01'; + local $VERSION = '1.02'; + local $FOO::VERSION = '1.30'; -all :: subdirs -"); - } else { - push(@m, "\n# none") - } - join('',@m); -} +The file named in VERSION_FROM is not added as a dependency to +Makefile. This is not really correct, but it would be a major pain +during development to have to rewrite the Makefile for any smallish +change in that file. If you want to make sure that the Makefile +contains the correct VERSION macro after any change of the file, you +would have to do something like -sub runsubdirpl{ # Experimental! See subdir_x section - my($self,$subdir) = @_; - chdir($subdir) or die "chdir($subdir): $!"; - require "Makefile.PL"; -} + depend => { Makefile => '$(VERSION_FROM)' } -sub subdir_x { - my($self, $subdir) = @_; - my(@m); - # The intention is that the calling Makefile.PL should define the - # $(SUBDIR_MAKEFILE_PL_ARGS) make macro to contain whatever - # information needs to be passed down to the other Makefile.PL scripts. - # If this does not suit your needs you'll need to write your own - # MY::subdir_x() method to override this one. - qq{ -config :: $subdir/Makefile - cd $subdir ; \$(MAKE) config INST_LIB=\$(INST_LIB) INST_ARCHLIB=\$(INST_ARCHLIB) LINKTYPE=\$(LINKTYPE) - -$subdir/Makefile: $subdir/Makefile.PL \$(CONFIGDEP) -}.' @echo "Rebuilding $@ ..." - $(PERL) -I$(PERL_ARCHLIB) -I$(PERL_LIB) \\ - -e "use ExtUtils::MakeMaker; MM->runsubdirpl(qw('.$subdir.'))" \\ - INST_LIB=$(INST_LIB) INST_ARCHLIB=$(INST_ARCHLIB) \\ - $(SUBDIR_MAKEFILE_PL_ARGS) - @echo "Rebuild of $@ complete." -'.qq{ - -subdirs :: - cd $subdir ; \$(MAKE) all LINKTYPE=\$(LINKTYPE) - -}; -} +See attribute C below. +=item XS -# --- Cleanup and Distribution Sections --- +Hashref of .xs files. MakeMaker will default this. e.g. -sub clean { - my($self, %attribs) = @_; - my(@m); - push(@m, ' -# Delete temporary files but do not touch installed files. We don\'t delete -# the Makefile here so a later make realclean still has a makefile to use. - -clean :: -'); - # clean subdirectories first - push(@m, map("\t-cd $_ && test -f Makefile && \$(MAKE) clean\n",@{$att{DIR}})); - push(@m, " $att{RM_F} *~ t/*~ *.o *.a mon.out core so_locations \$(BOOTSTRAP) \$(BASEEXT).bso\n"); - my(@otherfiles); - # Automatically delete the .c files generated from *.xs files: - push(@otherfiles, values %{$att{XS}}); - push(@otherfiles, $attribs{FILES}) if $attribs{FILES}; - push(@m, " $att{RM_RF} @otherfiles\n") if @otherfiles; - push(@m, " $attribs{POSTOP}\n") if $attribs{POSTOP}; - join("", @m); -} + {'name_of_file.xs' => 'name_of_file.c'} -sub realclean { - my($self, %attribs) = @_; - my(@m); - push(@m,' -# Delete temporary files (via clean) and also delete installed files -realclean purge :: clean -'); - # clean subdirectories first - push(@m, map("\t-cd $_ && test -f Makefile && \$(MAKE) realclean\n",@{$att{DIR}})); - # try to clean those files first, where we might have no permissions, so Makefile won't be lost - push(@m, " $att{RM_RF} \$(INST_AUTODIR) \$(INST_ARCHAUTODIR)\n"); - push(@m, " $att{RM_F} \$(INST_DYNAMIC) \$(INST_BOOT) \$(INST_PM)\n"); - push(@m, " $att{RM_F} Makefile \$(INST_STATIC)\n"); - my(@otherfiles); - push(@otherfiles, $attribs{FILES}) if $attribs{FILES}; - push(@m, " $att{RM_RF} @otherfiles\n") if @otherfiles; - push(@m, " $attribs{POSTOP}\n") if $attribs{POSTOP}; - join("", @m); -} +The .c files will automatically be included in the list of files +deleted by a make clean. +=item XSOPT -sub distclean { - my($self, %attribs) = @_; - # VERSION should be sanitised before use as a file name - my($tarname) = $attribs{TARNAME} || '$(DISTNAME)-$(VERSION)'; - my($tarflags) = $attribs{TARFLAGS} || 'cvf'; - my($compress) = $attribs{COMPRESS} || 'compress'; # eg gzip - my($preop) = $attribs{PREOP} || '@:'; # e.g., update MANIFEST - my($postop) = $attribs{POSTOP} || '@:'; - my($mkfiles) = join(' ', map("$_/Makefile", ".", @{$att{DIR}})); - " -distclean: clean - $preop - $att{RM_F} $mkfiles - cd ..; tar $tarflags $tarname.tar \$(BASEEXT) - cd ..; $compress $tarname.tar - $postop -"; -} +String of options to pass to xsubpp. This might include C<-C++> or +C<-extern>. Do not include typemaps here; the TYPEMAP parameter exists for +that purpose. +=item XSPROTOARG -# --- Test and Installation Sections --- +May be set to an empty string, which is identical to C<-prototypes>, or +C<-noprototypes>. See the xsubpp documentation for details. MakeMaker +defaults to the empty string. -sub test { - my($self, %attribs) = @_; - my($tests) = $attribs{TESTS} || (-d "t" ? "t/*.t" : ""); - my(@m); - push(@m," -test :: all -"); - push(@m, <<"END") if $tests; - \$(FULLPERL) -I\$(INST_ARCHLIB) -I\$(INST_LIB) -I\$(PERL_ARCHLIB) -I\$(PERL_LIB) -e 'use Test::Harness; runtests \@ARGV;' $tests -END - push(@m, <<'END') if -f "test.pl"; - $(FULLPERL) -I$(INST_ARCHLIB) -I$(INST_LIB) -I$(PERL_ARCHLIB) -I$(PERL_LIB) test.pl -END - push(@m, map("\tcd $_ && test -f Makefile && \$(MAKE) test LINKTYPE=\$(LINKTYPE)\n",@{$att{DIR}})); - push(@m, "\t\@echo 'No tests defined for \$(NAME) extension.'\n") unless @m > 1; - join("", @m); -} +=item XS_VERSION +Your version number for the .xs file of this package. This defaults +to the value of the VERSION attribute. -sub install { - my($self, %attribs) = @_; - my(@m); - push(@m, " -install :: all -"); - # install subdirectories first - push(@m, map("\tcd $_ && test -f Makefile && \$(MAKE) install\n",@{$att{DIR}})); - - push(@m, "\t: perl5.000 used to autosplit into INST_ARCHLIB, we delete these old files here - $att{RM_F} \$(INSTALLARCHLIB)/auto/\$(FULLEXT)/*.al \$(INSTALLARCHLIB)/auto/\$(FULLEXT)/*.ix - make INST_LIB=\$(INSTALLPRIVLIB) INST_ARCHLIB=\$(INSTALLARCHLIB) -"); - - join("",@m); -} +=back -sub force { - '# Phony target to force checking subdirectories. -FORCE: -'; -} +=head2 Additional lowercase attributes +can be used to pass parameters to the methods which implement that +part of the Makefile. -sub perldepend { - my(@m); - push(@m,' -PERL_HDRS = $(PERL_INC)/EXTERN.h $(PERL_INC)/INTERN.h \ - $(PERL_INC)/XSUB.h $(PERL_INC)/av.h $(PERL_INC)/cop.h \ - $(PERL_INC)/cv.h $(PERL_INC)/dosish.h $(PERL_INC)/embed.h \ - $(PERL_INC)/form.h $(PERL_INC)/gv.h $(PERL_INC)/handy.h \ - $(PERL_INC)/hv.h $(PERL_INC)/keywords.h $(PERL_INC)/mg.h \ - $(PERL_INC)/op.h $(PERL_INC)/opcode.h $(PERL_INC)/patchlevel.h \ - $(PERL_INC)/perl.h $(PERL_INC)/perly.h $(PERL_INC)/pp.h \ - $(PERL_INC)/proto.h $(PERL_INC)/regcomp.h $(PERL_INC)/regexp.h \ - $(PERL_INC)/scope.h $(PERL_INC)/sv.h $(PERL_INC)/unixish.h \ - $(PERL_INC)/util.h - -$(OBJECT) : $(PERL_HDRS) -'); - - push(@m,' -$(PERL_INC)/config.h: $(PERL_SRC)/config.sh; cd $(PERL_SRC); /bin/sh config_h.SH -') if $att{PERL_SRC}; - - # This needs a better home: - push(@m, join(" ", values %{$att{XS}})." : \$(XSUBPPDEPS)\n") - if %{$att{XS}}; - join("\n",@m); -} +=over 2 +=item clean -sub makefile { - # We do not know what target was originally specified so we - # must force a manual rerun to be sure. But as it would only - # happen very rarely it is not a significant problem. + {FILES => "*.xyz foo"} -# This dependency, with no_op, causes problems. Make tries to build OBJECT via no_op! -# So we'll just drop it for now. -#$(OBJECT) : Makefile -#'.$att{NOOP}.' +=item depend - ' -Makefile: Makefile.PL $(CONFIGDEP) - $(PERL) -I$(PERL_ARCHLIB) -I$(PERL_LIB) Makefile.PL - @echo "Now you must rerun make."; false -'; -} + {ANY_TARGET => ANY_DEPENDECY, ...} +=item dist -sub postamble{ - ""; -} + {TARFLAGS => 'cvfF', COMPRESS => 'gzip', SUFFIX => 'gz', + SHAR => 'shar -m', DIST_CP => 'ln', ZIP => '/bin/zip', + ZIPFLAGS => '-rl', DIST_DEFAULT => 'private tardist' } +If you specify COMPRESS, then SUFFIX should also be altered, as it is +needed to tell make the target file of the compression. Setting +DIST_CP to ln can be useful, if you need to preserve the timestamps on +your files. DIST_CP can take the values 'cp', which copies the file, +'ln', which links the file, and 'best' which copies symbolic links and +links the rest. Default is 'best'. -# --- Determine libraries to use and how to use them --- +=item dynamic_lib -sub extliblist{ - my($self, $libs) = @_; - return ("", "", "") unless $libs; - print STDERR "Potential libraries are '$libs':" if $Verbose; - my(@new) = MY->new_extliblist($libs); + {ARMAYBE => 'ar', OTHERLDFLAGS => '...', INST_DYNAMIC_DEP => '...'} - if ($att{PERL_SRC}){ - my(@old) = MY->old_extliblist($libs); - my($oldlibs) = join(" : ",@old); - my($newlibs) = join(" : ",@new); - warn "Warning (non-fatal): $att{NAME} extliblist consistency check failed:\n". - " old: $oldlibs\n". - " new: $newlibs\n". - "Using 'new' set. Please notify perl5-porters\@nicoh.com.\n" - if ("$newlibs" ne "$oldlibs"); - } - @new; -} +=item installpm +Deprecated as of MakeMaker 5.23. See L. -sub old_extliblist { - my($self, $potential_libs)=@_; - return ("", "", "") unless $potential_libs; - die "old_extliblist requires PERL_SRC" unless $att{PERL_SRC}; - - my(%attrib, @w); - # Now run ext/util/extliblist to discover what *libs definitions - # are required for the needs of $potential_libs - $ENV{'potential_libs'} = $potential_libs; - my(@o)=`. $att{PERL_SRC}/config.sh - . $att{PERL_SRC}/ext/util/extliblist; - echo EXTRALIBS=\$extralibs - echo BSLOADLIBS=\$dynaloadlibs - echo LDLOADLIBS=\$statloadlibs - `; - foreach $line (@o){ - chomp $line; - if ($line =~ /(.*)\s*=\s*(.*)\s*$/){ - $attrib{$1} = $2; - print STDERR " $1 = $2" if $Verbose; - }else{ - push(@w, $line); - } - } - print STDERR "Messages from extliblist:\n", join("\n",@w,'') - if @w ; - @attrib{qw(EXTRALIBS BSLOADLIBS LDLOADLIBS)}; -} +=item linkext + {LINKTYPE => 'static', 'dynamic' or ''} -sub new_extliblist { - my($self, $potential_libs)=@_; - return ("", "", "") unless $potential_libs; +NB: Extensions that have nothing but *.pm files had to say - my($so) = $Config{'so'}; - my($libs) = $Config{'libs'}; + {LINKTYPE => ''} - # compute $extralibs, $bsloadlibs and $ldloadlibs from - # $potential_libs - # this is a rewrite of Andy Dougherty's extliblist in perl - # its home is in /ext/util +with Pre-5.0 MakeMakers. Since version 5.00 of MakeMaker such a line +can be deleted safely. MakeMaker recognizes, when there's nothing to +be linked. - my(@searchpath); # from "-L/path" entries in $potential_libs - my(@libpath) = split " ", $Config{'libpth'}; - my(@ldloadlibs); - my(@bsloadlibs); - my(@extralibs); - my($fullname); - my($pwd) = fastcwd(); # from Cwd.pm +=item macro - foreach $thislib (split ' ', $potential_libs){ + {ANY_MACRO => ANY_VALUE, ...} - # Handle possible linker path arguments. - if ($thislib =~ s/^(-[LR])//){ # save path flag type - my($ptype) = $1; - unless (-d $thislib){ - warn "$ptype$thislib ignored, directory does not exist\n" - if $Verbose; - next; - } - if ($thislib !~ m|^/|) { - warn "Warning: $ptype$thislib changed to $ptype$pwd/$thislib\n"; - $thislib = "$pwd/$thislib"; - } - push(@searchpath, $thislib); - push(@extralibs, "$ptype$thislib"); - push(@ldloadlibs, "$ptype$thislib"); - next; - } +=item realclean - # Handle possible library arguments. - unless ($thislib =~ s/^-l//){ - warn "Unrecognized argument in LIBS ignored: '$thislib'\n"; - next; - } + {FILES => '$(INST_ARCHAUTODIR)/*.xyz'} - my($found_lib)=0; - foreach $thispth (@searchpath, @libpath){ - - if (@fullname=<${thispth}/lib${thislib}.${so}.[0-9]*>){ - $fullname=$fullname[-1]; #ATTN: 10 looses against 9! - } elsif (-f ($fullname="$thispth/lib$thislib.$so")){ - } elsif (-f ($fullname="$thispth/lib${thislib}_s.a") - && ($thislib .= "_s") ){ # we must explicitly ask for _s version - } elsif (-f ($fullname="$thispth/lib$thislib.a")){ - } elsif (-f ($fullname="$thispth/Slib$thislib.a")){ - } else { - warn "$thislib not found in $thispth\n" if $Verbose; - next; - } - warn "'-l$thislib' found at $fullname\n" if $Verbose; - $found_lib++; +=item tool_autosplit - # Now update library lists + {MAXLEN =E 8} - # what do we know about this library... - my $is_dyna = ($fullname !~ /\.a$/); - my $in_perl = ($libs =~ /\B-l${thislib}\b/s); +=back - # Do not add it into the list if it is already linked in - # with the main perl executable. - # We have to special-case the NeXT, because all the math is also in libsys_s - unless ( $in_perl || ($Config{'osname'} eq 'next' && $thislib eq 'm') ){ - push(@extralibs, "-l$thislib"); - } - - - # We might be able to load this archive file dynamically - if ( $Config{'dlsrc'} =~ /dl_next|dl_dld/){ - # We push -l$thislib instead of $fullname because - # it avoids hardwiring a fixed path into the .bs file. - # mkbootstrap will automatically add dl_findfile() to - # the .bs file if it sees a name in the -l format. - # USE THIS LATER: push(@bsloadlibs, "-l$thislib"); # " $fullname"; - # USE THIS while checking results against old_extliblist - push(@bsloadlibs, "$fullname"); - } else { - if ($is_dyna){ - # For SunOS4, do not add in this shared library if - # it is already linked in the main perl executable - push(@ldloadlibs, "-l$thislib") - unless ($in_perl and $Config{'osname'} eq 'sunos'); - } else { - push(@ldloadlibs, "-l$thislib"); - } - } - last; # found one here so don't bother looking further +=cut + +# bug in pod2html, so leave the =back + +# Don't delete this cut, MM depends on it! + +=head2 Overriding MakeMaker Methods + +If you cannot achieve the desired Makefile behaviour by specifying +attributes you may define private subroutines in the Makefile.PL. +Each subroutines returns the text it wishes to have written to +the Makefile. To override a section of the Makefile you can +either say: + + sub MY::c_o { "new literal text" } + +or you can edit the default by saying something like: + + sub MY::c_o { + package MY; # so that "SUPER" works right + my $inherited = shift->SUPER::c_o(@_); + $inherited =~ s/old text/new text/; + $inherited; } - warn "Warning (non-fatal): No library found for -l$thislib\n" unless $found_lib>0; + +If you running experiments with embedding perl as a library into other +applications, you might find MakeMaker not sufficient. You'd better +have a look at ExtUtils::embed which is a collection of utilities for +embedding. + +If you still need a different solution, try to develop another +subroutine, that fits your needs and submit the diffs to +F or F as appropriate. + +For a complete description of all MakeMaker methods see L. + +Here is a simple example of how to add a new target to the generated +Makefile: + + sub MY::postamble { + ' + $(MYEXTLIB): sdbm/Makefile + cd sdbm && $(MAKE) all + '; } - ("@extralibs", "@bsloadlibs", "@ldloadlibs"); -} -# --- Write a DynaLoader bootstrap file if required +=head2 Hintsfile support -sub mkbootstrap { +MakeMaker.pm uses the architecture specific information from +Config.pm. In addition it evaluates architecture specific hints files +in a C directory. The hints files are expected to be named +like their counterparts in C, but with an C<.pl> file +name extension (eg. C). They are simply Ced by +MakeMaker within the WriteMakefile() subroutine, and can be used to +execute commands as well as to include special variables. The rules +which hintsfile is chosen are the same as in Configure. -=head1 NAME +The hintsfile is eval()ed immediately after the arguments given to +WriteMakefile are stuffed into a hash reference $self but before this +reference becomes blessed. So if you want to do the equivalent to +override or create an attribute you would say something like -mkbootstrap + $self->{LIBS} = ['-ldbm -lucb -lc']; -=head1 DESCRIPTION +=head2 Distribution Support -Make a bootstrap file for use by this system's DynaLoader. -It typically gets called from an extension Makefile. +For authors of extensions MakeMaker provides several Makefile +targets. Most of the support comes from the ExtUtils::Manifest module, +where additional documentation can be found. -There is no .bs file supplied with the extension. Instead a _BS file -which has code for the special cases, like posix for berkeley db on the -NeXT. +=over 4 -This file will get parsed, and produce a maybe empty -@DynaLoader::dl_resolve_using array for the current architecture. -That will be extended by $BSLOADLIBS, which was computed by Andy's -extliblist script. If this array still is empty, we do nothing, else -we write a .bs file with an @DynaLoader::dl_resolve_using array, but -without any Cs, because there is no longer a need to deal with -special cases. +=item make distcheck -The _BS file can put some code into the generated .bs file by placing -it in $bscode. This is a handy 'escape' mechanism that may prove -useful in complex situations. +reports which files are below the build directory but not in the +MANIFEST file and vice versa. (See ExtUtils::Manifest::fullcheck() for +details) -If @DynaLoader::dl_resolve_using contains C<-L*> or C<-l*> entries then -mkbootstrap will automatically add a dl_findfile() call to the -generated .bs file. +=item make skipcheck -=head1 AUTHORS +reports which files are skipped due to the entries in the +C file (See ExtUtils::Manifest::skipcheck() for +details) -Andreas Koenig , Tim Bunce -, Andy Dougherty +=item make distclean -=cut +does a realclean first and then the distcheck. Note that this is not +needed to build a new distribution as long as you are sure, that the +MANIFEST file is ok. - my($self, @bsloadlibs)=@_; +=item make manifest - @bsloadlibs = grep($_, @bsloadlibs); # strip empty libs +rewrites the MANIFEST file, adding all remaining files found (See +ExtUtils::Manifest::mkmanifest() for details) - print STDERR " bsloadlibs=@bsloadlibs\n" if $Verbose; +=item make distdir - # We need DynaLoader here because we and/or the *_BS file may - # call dl_findfile(). We don't say `use' here because when - # first building perl extensions the DynaLoader will not have - # been built when MakeMaker gets first used. - require DynaLoader; - import DynaLoader; +Copies all the files that are in the MANIFEST file to a newly created +directory with the name C<$(DISTNAME)-$(VERSION)>. If that directory +exists, it will be removed first. - initialize(@ARGV) unless defined $att{'BASEEXT'}; +=item make disttest - rename "$att{BASEEXT}.bs", "$att{BASEEXT}.bso"; +Makes a distdir first, and runs a C, a make, and +a make test in that directory. - if (-f "$att{BASEEXT}_BS"){ - $_ = "$att{BASEEXT}_BS"; - package DynaLoader; # execute code as if in DynaLoader - local($osname, $dlsrc) = (); # avoid warnings - ($osname, $dlsrc) = @Config::Config{qw(osname dlsrc)}; - $bscode = ""; - unshift @INC, "."; - require $_; - shift @INC; - } +=item make tardist - if ($Config{'dlsrc'} =~ /^dl_dld/){ - package DynaLoader; - push(@dl_resolve_using, dl_findfile('-lc')); - } +First does a distdir. Then a command $(PREOP) which defaults to a null +command, followed by $(TOUNIX), which defaults to a null command under +UNIX, and will convert files in distribution directory to UNIX format +otherwise. Next it runs C on that directory into a tarfile and +deletes the directory. Finishes with a command $(POSTOP) which +defaults to a null command. - my(@all) = (@bsloadlibs, @DynaLoader::dl_resolve_using); - my($method) = ''; - if (@all){ - open BS, ">$att{BASEEXT}.bs" - or die "Unable to open $att{BASEEXT}.bs: $!"; - print STDOUT "Writing $att{BASEEXT}.bs\n"; - print STDOUT " containing: @all" if $Verbose; - print BS "# $att{BASEEXT} DynaLoader bootstrap file for $Config{'osname'} architecture.\n"; - print BS "# Do not edit this file, changes will be lost.\n"; - print BS "# This file was automatically generated by the\n"; - print BS "# mkbootstrap routine in ExtUtils/MakeMaker.pm.\n"; - print BS "\@DynaLoader::dl_resolve_using = "; - # If @all contains names in the form -lxxx or -Lxxx then it's asking for - # runtime library location so we automatically add a call to dl_findfile() - if (" @all" =~ m/ -[lLR]/){ - print BS " dl_findfile(qw(\n @all\n ));\n"; - }else{ - print BS " qw(@all);\n"; - } - # write extra code if *_BS says so - print BS $DynaLoader::bscode if $DynaLoader::bscode; - print BS "\n1;\n"; - close BS; - } +=item make dist - # special handling for systems which needs a list of all global - # symbols exported by a modules to be dynamically linked. - if ($Config{'dlsrc'} =~ /^dl_aix/){ - my($bootfunc); - ($bootfunc = $att{NAME}) =~ s/\W/_/g; - open EXP, ">$att{BASEEXT}.exp"; - print EXP "#!\nboot_$bootfunc\n"; - close EXP; - } -} +Defaults to $(DIST_DEFAULT) which in turn defaults to tardist. +=item make uutardist -# --- Output postprocessing section --- -#nicetext is included to make VMS support easier -sub nicetext { # Just return the input - no action needed - my($self,$text) = @_; - $text; -} - -# the following keeps AutoSplit happy -package ExtUtils::MakeMaker; -1; +Runs a tardist first and uuencodes the tarfile. -__END__ +=item make shdist + +First does a distdir. Then a command $(PREOP) which defaults to a null +command. Next it runs C on that directory into a sharfile and +deletes the intermediate directory again. Finishes with a command +$(POSTOP) which defaults to a null command. Note: For shdist to work +properly a C program that can handle directories is mandatory. + +=item make zipdist + +First does a distdir. Then a command $(PREOP) which defaults to a null +command. Runs C<$(ZIP) $(ZIPFLAGS)> on that directory into a +zipfile. Then deletes that directory. Finishes with a command +$(POSTOP) which defaults to a null command. + +=item make ci + +Does a $(CI) and a $(RCS_LABEL) on all files in the MANIFEST file. + +=back + +Customization of the dist targets can be done by specifying a hash +reference to the dist attribute of the WriteMakefile call. The +following parameters are recognized: + + CI ('ci -u') + COMPRESS ('compress') + POSTOP ('@ :') + PREOP ('@ :') + TO_UNIX (depends on the system) + RCS_LABEL ('rcs -q -Nv$(VERSION_SYM):') + SHAR ('shar') + SUFFIX ('Z') + TAR ('tar') + TARFLAGS ('cvf') + ZIP ('zip') + ZIPFLAGS ('-r') + +An example: + + WriteMakefile( 'dist' => { COMPRESS=>"gzip", SUFFIX=>"gz" }) + +=head2 Disabling an extension + +If some events detected in F imply that there is no way +to create the Module, but this is a normal state of things, then you +can create a F which does nothing, but succeeds on all the +"usual" build targets. To do so, use + + ExtUtils::MakeMaker::WriteEmptyMakefile(); + +instead of WriteMakefile(). + +This may be useful if other modules expect this module to be I +OK, as opposed to I OK (say, this system-dependent module builds +in a subdirectory of some other distribution, or is listed as a +dependency in a CPAN::Bundle, but the functionality is supported by +different means on the current architecture). + +=head1 SEE ALSO + +ExtUtils::MM_Unix, ExtUtils::Manifest, ExtUtils::testlib, +ExtUtils::Install, ExtUtils::embed + +=head1 AUTHORS + +Andy Dougherty >, Andreas KEnig +>, Tim Bunce >. +VMS support by Charles Bailey >. OS/2 +support by Ilya Zakharevich >. Contact the +makemaker mailing list C, if +you have any questions. + +=cut