X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FExtUtils%2FMakeMaker.pm;h=78175f9aaf0946afb82f683d9a21c4b14231dd27;hb=cb49b31f4c369cd12097a08c45c1d3cba3657976;hp=06b4ab59e5f690b22619e87322b75d13f1dd3201;hpb=005c1a0e007f6f2f3efe461d6a5930a88ccb88fb;p=p5sagit%2Fp5-mst-13.2.git diff --git a/lib/ExtUtils/MakeMaker.pm b/lib/ExtUtils/MakeMaker.pm index 06b4ab5..78175f9 100644 --- a/lib/ExtUtils/MakeMaker.pm +++ b/lib/ExtUtils/MakeMaker.pm @@ -1,456 +1,555 @@ -package ExtUtils::MakeMaker; +BEGIN {require 5.002;} # MakeMaker 5.17 was the last MakeMaker that was compatible with perl5.001m -$Version = 4.15; # Last edited $Date: 1995/06/06 14:04:00 $ by Andreas Koenig +package ExtUtils::MakeMaker; -$Version_OK = 4.13; # Makefiles older than $Version_OK will die +$VERSION = "5.45"; +$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.222 $, 10)) =~ s/\s+$//; -# $Id: MakeMaker.pm,v 1.21 1995/06/06 06:14:16 k Exp k $ -use Config; -use Carp; -use Cwd; 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 + $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 $Verbose &prompt); -@EXPORT_OK = qw($Version &Version_check %att %skip %Recognized_Att_Keys - @MM_Sections %MM_Sections - &help &neatvalue &mkbootstrap &mksymlists); +@EXPORT = qw(&WriteMakefile &writeMakefile $Verbose &prompt); +@EXPORT_OK = qw($VERSION &Version_check &neatvalue &mkbootstrap &mksymlists); -$Is_VMS = $Config{'osname'} eq 'VMS'; -require ExtUtils::MM_VMS if $Is_VMS; +# +# 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::Kid 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 {} +} -use strict qw(refs); +# "predeclare the package: we only load it via AUTOLOAD +# but we have already mentioned it in @ISA +package ExtUtils::Liblist::Kid; -$Version = $Version;# avoid typo warning -$Verbose = 0; -$^W=1; +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'; +$Is_Cygwin= $^O eq 'cygwin'; -sub prompt { +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_MacOS; +} +if ($Is_Win32) { + require ExtUtils::MM_Win32; +} +if ($Is_Cygwin) { + require ExtUtils::MM_Cygwin; +} + +full_setup(); + +# The use of the Version_check target has been dropped between perl +# 5.5.63 and 5.5.64. We must keep the subroutine for a while so that +# old Makefiles can satisfy the Version_check target. + +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 WriteMakefile { + Carp::croak "WriteMakefile: Need even number of args" if @_ % 2; + local $SIG{__WARN__} = \&warnhandler; + + my %att = @_; + MM->new(\%att)->flush; +} + +sub prompt ($;$) { my($mess,$def)=@_; - local $\=""; - local $/="\n"; + $ISA_TTY = -t STDIN && (-t STDOUT || !(-f STDOUT || -c STDOUT)) ; # Pipe? + Carp::confess("prompt function called without an argument") unless defined $mess; + my $dispdef = defined $def ? "[$def] " : " "; + $def = defined $def ? $def : ""; + my $ans; local $|=1; - die "prompt function called without an argument" unless defined $mess; - $def = "" unless defined $def; - my $dispdef = "[$def] "; print "$mess $dispdef"; - chop(my $ans = ); - $ans || $def; + if ($ISA_TTY) { + chomp($ans = ); + } else { + print "$def\n"; + } + return ($ans ne '') ? $ans : $def; } -sub check_hints { - # We allow extension-specific hints files. +sub eval_in_subdirs { + my($self) = @_; + my($dir); + use Cwd 'cwd'; + my $pwd = cwd(); - # First we look for the best hintsfile we have - my(@goodhints); - my($hint)="$Config{'osname'}_$Config{'osvers'}"; - $hint =~ s/\./_/g; - $hint =~ s/_$//; - local(*DIR); - opendir DIR, "hints"; - while (defined ($_ = readdir DIR)) { - next if /^\./; - next unless s/\.pl$//; - next unless /^$Config{'osname'}/; - # Don't trust a hintfile for a later OS version: - next if $_ gt $hint; - push @goodhints, $_; - if ($_ eq $hint){ - @goodhints=$_; - last; - } + foreach $dir (@{$self->{DIR}}){ + my($abs) = $self->catdir($pwd,$dir); + $self->eval_in_x($abs); } - closedir DIR; - return unless @goodhints; # There was no hintsfile - # the last one in lexical ordering is our choice: - $hint=(sort @goodhints)[-1]; + chdir $pwd; +} - # execute the hintsfile: - open HINTS, "hints/$hint.pl"; - @goodhints = ; - close HINTS; - print STDOUT "Processing hints file hints/$hint.pl"; - eval join('',@goodhints); - print STDOUT $@ if $@; +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: $@"; + } } -# Setup dummy package: -# MY exists for overriding methods to be defined within -unshift(@MY::ISA, qw(MM)); +sub full_setup { + $Verbose ||= 0; -# 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)); + # package name for the classes into which the first object will be blessed + $PACKNAME = "PACK000"; -$Attrib_Help = <<'END'; - 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. + @Attrib_help = qw/ - DISTNAME: Your name for distributing the package (by tar file) - This defaults to NAME above. + AUTHOR ABSTRACT ABSTRACT_FROM BINARY_LOCATION + C CAPI CCFLAGS CONFIG CONFIGURE DEFINE DIR DISTNAME DL_FUNCS DL_VARS + EXCLUDE_EXT EXE_FILES FIRST_MAKEFILE FULLPERL FUNCLIST H + HTMLLIBPODS HTMLSCRIPTPODS IMPORTS + INC INCLUDE_EXT INSTALLARCHLIB INSTALLBIN INSTALLDIRS INSTALLHTMLPRIVLIBDIR + INSTALLHTMLSCRIPTDIR INSTALLHTMLSITELIBDIR INSTALLMAN1DIR + INSTALLMAN3DIR INSTALLPRIVLIB INSTALLSCRIPT INSTALLSITEARCH + INSTALLSITELIB INST_ARCHLIB INST_BIN INST_EXE INST_LIB + INST_HTMLLIBDIR INST_HTMLSCRIPTDIR + INST_MAN1DIR INST_MAN3DIR INST_SCRIPT LDFROM LIB LIBPERL_A LIBS + LINKTYPE MAKEAPERL MAKEFILE MAN1PODS MAN3PODS MAP_TARGET MYEXTLIB + PERL_MALLOC_OK + NAME NEEDS_LINKING NOECHO NORECURS NO_VC OBJECT OPTIMIZE PERL PERLMAINCC + PERL_ARCHLIB PERL_LIB PERL_SRC PERM_RW PERM_RWX + PL_FILES PM PMLIBDIRS POLLUTE PPM_INSTALL_EXEC PPM_INSTALL_SCRIPT PREFIX + PREREQ_PM SKIP TYPEMAPS VERSION VERSION_FROM XS XSOPT XSPROTOARG + XS_VERSION clean depend dist dynamic_lib linkext macro realclean + tool_autosplit + /; - VERSION: Your version number for distributing the package. - This defaults to 0.1. + # IMPORTS is used under OS/2 and Win32 - INST_LIB: Perl library directory to directly install - into during 'make'. + # @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. - INSTALLPRIVLIB:Used by 'make install', which sets INST_LIB to this value. + # MM_Sections are the sections we have to call explicitly + # in Overridable we have subroutines that are used indirectly - INST_ARCHLIB: Perl architecture-dependent library to directly install - into during 'make'. - INSTALLARCHLIB:Used by 'make install', which sets INST_ARCHLIB to this value. + @MM_Sections = + qw( - INST_EXE: Directory, where executable scripts should be installed during - 'make'. Defaults to "./blib", just to have a dummy location - during testing. C will set INST_EXE to INSTALLBIN. + post_initialize const_config constants tool_autosplit tool_xsubpp + tools_other dist macro depend cflags const_loadlibs const_cccmd + post_constants - INSTALLBIN: Used by 'make install' which sets INST_EXE to this value. + pasthru - PERL_LIB: Directory containing the Perl library to use. + c_o xs_c xs_o top_targets linkext dlsyms dynamic dynamic_bs + dynamic_lib static static_lib htmlifypods manifypods processPL + installbin subdirs + clean realclean dist_basics dist_core dist_dir dist_test dist_ci + install force perldepend makefile staticmake test ppd - PERL_ARCHLIB: Architectur dependent directory containing the Perl library to use. + ); # loses section ordering - PERL_SRC: Directory containing the Perl source code - (use of this should be avoided, it may be undefined) + @Overridable = @MM_Sections; + push @Overridable, qw[ - INC: Include file dirs eg: '-I/usr/5include -I/path/to/inc' + dir_target libscan makeaperl needs_linking perm_rw perm_rwx + subdir_x test_via_harness test_via_script - 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" + push @MM_Sections, qw[ - MYEXTLIB: If the extension links to a library that it builds - set this to the name of the library (see SDBM_File) + pm_to_blib selfdocument - 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) + # Postamble needs to be the last that was always the case + push @MM_Sections, "postamble"; + push @Overridable, "postamble"; - DIR: Ref to array of subdirectories containing Makefile.PLs - e.g. [ 'sdbm' ] in ext/SDBM_File + # All sections are valid keys. + @Recognized_Att_Keys{@MM_Sections} = (1) x @MM_Sections; - PMLIBDIRS: Ref to array of subdirectories containing library files. - Defaults to [ 'lib', $(BASEEXT) ]. The directories will - be scanned and any files they contain will - be installed in the corresponding location in the library. - A MY::libscan() function can be used to alter the behaviour. - Defining PM in the Makefile.PL will override PMLIBDIRS. + # 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 full_ar + ); + + 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); + } - 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. - Defining PM in the Makefile.PL will override PMLIBDIRS. + # + # 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( - 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. + INST_BIN 1 INST_EXE 1 INST_LIB 1 INST_ARCHLIB 1 INST_SCRIPT 1 + MAP_TARGET 1 INST_HTMLLIBDIR 1 INST_HTMLSCRIPTDIR 1 + INST_MAN1DIR 1 INST_MAN3DIR 1 PERL_SRC 1 PERL 1 FULLPERL 1 - 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. + my @keep = qw/ + NEEDS_LINKING HAS_LINK_CODE + /; + @Keep_after_flush{@keep} = (1) x @keep; +} - PL_FILES: Ref to hash of files to be processed as perl programs. MakeMaker - will default to any found C<*.PL> file (except C) being - keys and the basename of the file being the value. E.g. - C<{ 'foobar.PL' => 'foobar' }>. The C<*.PL> files are expected to - produce output to the target files themselves. +sub writeMakefile { + die <'static' or 'dynamic' (default unless usedl=undef in config.sh) - Should only be used to force static linking (also see linkext below). +Please contact the author or look into CPAN (details about CPAN can be +found in the FAQ and at http:/www.perl.com) for a more recent version +of the extension. If you're really desperate, you can try to change +the subroutine name from writeMakefile to WriteMakefile and rerun +'perl Makefile.PL', but you're most probably left alone, when you do +so. - DL_FUNCS: 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 { "$(NAME)" => [ "boot_$(NAME)" ] }. - (e.g. { "RPC" => [qw( boot_rpcb rpcb_gettime getnetconfigent )], - "NetconfigPtr" => [ 'DESTROY'] } ) +The MakeMaker team - DL_VARS: 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 ) ]) - - CONFIG: =>[qw(archname manext)] defines ARCHNAME & MANEXT from config.sh - - SKIP: =>[qw(name1 name2)] skip (do not write) sections of the Makefile - - MAP_TARGET: If it is intended, that a new perl binary be produced, this variable - may hold a name for that binary. Defaults to C - - LIBPERL_A: The filename of the perllibrary that will be used together - with this extension. Defaults to C. - - 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: - - macro: {ANY_MACRO => ANY_VALUE, ...} - 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'} - dist: {TARFLAGS=>'cvfF', COMPRESS=>'gzip', SUFFIX=>'gz', SHAR=>'shar -m'} - tool_autosplit: {MAXLEN => 8} END - -sub help {print $Attrib_Help;} - -@MM_Sections_spec = ( - 'post_initialize' => {}, - 'const_config' => {}, - 'constants' => {}, - 'const_loadlibs' => {}, - 'const_cccmd' => {}, - 'tool_autosplit' => {}, - 'tool_xsubpp' => {}, - 'tools_other' => {}, - 'macro' => {}, - 'post_constants' => {}, - 'pasthru' => {}, - 'c_o' => {}, - 'xs_c' => {}, - 'xs_o' => {}, - 'top_targets' => {}, - 'linkext' => {}, - 'dlsyms' => {}, - 'dynamic' => {}, - 'dynamic_bs' => {}, - 'dynamic_lib' => {}, - 'static' => {}, - 'static_lib' => {}, - 'installpm' => {}, - 'processPL' => {}, - 'installbin' => {}, - 'subdirs' => {}, - 'clean' => {}, - 'realclean' => {}, - 'dist' => {}, - 'test' => {}, - 'install' => {}, - 'force' => {}, - 'perldepend' => {}, - 'makefile' => {}, - 'postamble' => {}, - 'staticmake' => {}, -); -%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); } -%att = (); -%skip = (); +sub ExtUtils::MakeMaker::new { + my($class,$self) = @_; + my($key); -sub skipcheck{ - my($section) = @_; - if ($section eq 'dynamic') { - print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets " - . "in skipped section 'dynamic_bs'\n" - if $skip{'dynamic_bs'} && $Verbose; - print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets " - . "in skipped section 'dynamic_lib'\n" - if $skip{'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 $skip{'dynamic_bs'} && $Verbose; + print STDOUT "MakeMaker (v$VERSION)\n" if $Verbose; + if (-f "MANIFEST" && ! -f "Makefile"){ + check_manifest(); } - if ($section eq 'static') { - print STDOUT "Warning (non-fatal): Target 'static' depends on targets " - . "in skipped section 'static_lib'\n" - if $skip{'static_lib'} && $Verbose; - } - return 'skipped' if $skip{$section}; - return ''; -} + $self = {} unless (defined $self); -sub WriteMakefile { - %att = @_; - local($\)="\n"; + check_hints($self); - print STDOUT "MakeMaker (v$Version)" if $Verbose; + my(%initial_att) = %$self; # record initial attributes - if ( Carp::longmess("") =~ "runsubdirpl" ){ - $Correct_relativ_directories++; - } else { - $Correct_relativ_directories=0; + my($prereq); + foreach $prereq (sort keys %{$self->{PREREQ_PM}}) { + my $eval = "require $prereq"; + eval $eval; + + if ($@) { + warn "Warning: prerequisite $prereq failed to load: $@"; + } + elsif ($prereq->VERSION < $self->{PREREQ_PM}->{$prereq} ){ + warn "Warning: prerequisite $prereq $self->{PREREQ_PM}->{$prereq} not found"; +# Why is/was this 'delete' here? We need PREREQ_PM later to make PPDs. +# } 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 (-f "MANIFEST"){ - eval {require ExtUtils::Manifest}; - if ($@){ - print STDOUT "Warning: you have not installed the ExtUtils::Manifest - module -- skipping check of the MANIFEST file"; + if (defined $self->{CONFIGURE}) { + if (ref $self->{CONFIGURE} eq 'CODE') { + $self = { %$self, %{&{$self->{CONFIGURE}}}}; } else { - print STDOUT "Checking if your kit is complete..."; - $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:"; - print "\t", join "\n\t", @missed; - print STDOUT "Please inform the author.\n"; - } else { - print STDOUT "Looks good"; - } + Carp::croak "Attribute 'CONFIGURE' to WriteMakefile() not a code reference\n"; } } - parse_args(\%att, @ARGV); - my(%initial_att) = %att; # record initial attributes + # 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"); + } - check_hints(); + my $newclass = ++$PACKNAME; + local @Parent = @Parent; # Protect against non-local exits + { +# 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'; + } - my($key); + 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\-\$]+$/)); + } + if ($self->{PARENT}) { + $self->{PARENT}->{CHILDREN}->{$newclass} = $self; + foreach my $opt (qw(CAPI POLLUTE)) { + if (exists $self->{PARENT}->{$opt} + and not exists $self->{$opt}) + { + # inherit, but only if already unspecified + $self->{$opt} = $self->{PARENT}->{$opt}; + } + } + } + } else { + parse_args($self,split(' ', $ENV{PERL_MM_OPT} || ''),@ARGV); + } + + $self->{NAME} ||= $self->guess_name; - MY->init_main(); + ($self->{NAME_SYM} = $self->{NAME}) =~ s/\W+/_/g; - print STDOUT "Writing Makefile for $att{NAME}"; + $self->init_main(); - if (! $att{PERL_SRC} && - $INC{'Config.pm'} ne "$Config{'archlib'}/Config.pm"){ - (my $pthinks = $INC{'Config.pm'}) =~ s!/Config\.pm$!!; - $pthinks =~ s!.*/!!; - print STDOUT <{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 <{UNINSTALLED_PERL}; Your perl and your Config.pm seem to have different ideas about the architecture they are running on. -Perl thinks: $pthinks -Config says: $Config{"archname"} +Perl thinks: [$pthinks] +Config says: [$Config{archname}] This may or may not cause problems. Please check your installation of perl if you have problems building this extension. END + } } - MY->init_dirscan(); - MY->init_others(); + $self->init_dirscan(); + $self->init_others(); + my($argv) = neatvalue(\@ARGV); + $argv =~ s/^\[/(/; + $argv =~ s/\]$/)/; - unlink("Makefile", "MakeMaker.tmp", $Is_VMS ? 'Descrip.MMS' : ''); - open MAKE, ">MakeMaker.tmp" or die "Unable to open MakeMaker.tmp: $!"; - select MAKE; $|=1; select STDOUT; + 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 ARGV: $argv +# +# MakeMaker Parameters: +END - print MAKE "# This Makefile is for the $att{NAME} extension to perl.\n#"; - print MAKE "# It was generated automatically by MakeMaker version $Version 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 =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/; $v =~ tr/\n/ /s; - print MAKE "# $key => $v"; + 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; + } } - # build hash for SKIP to make testing easy - %skip = map( ($_,1), @{$att{'SKIP'} || []}); + # 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" if ($Verbose >= 2); - my($skipit) = skipcheck($section); + print "Processing Makefile '$section' section\n" if ($Verbose >= 2); + my($skipit) = $self->skipcheck($section); if ($skipit){ - print MAKE "\n# --- MakeMaker $section section $skipit."; + push @{$self->{RESULT}}, "\n# --- MakeMaker $section section $skipit."; } else { - my(%a) = %{$att{$section} || {}}; - print MAKE "\n# --- MakeMaker $section section:"; - print MAKE "# ", join ", ", %a if $Verbose; - print(MAKE MY->nicetext(MY->$section( %a ))); + 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 )); } } - 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"; - } - } + push @{$self->{RESULT}}, "\n# End."; - print MAKE "\n# End."; - close MAKE; - my($finalname) = $Is_VMS ? "Descrip.MMS" : "Makefile"; - rename("MakeMaker.tmp", $finalname); + $self; +} - chmod 0644, $finalname; - system("$Config{'eunicefix'} $finalname") unless $Config{'eunicefix'} eq ":"; +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: - 1; -} +clean: -sub Version_check { - my($checkversion) = @_; - die "Your Makefile was built with ExtUtils::MakeMaker v $checkversion. -Current Version is $Version. There have been considerable changes in the meantime. -Please rerun 'perl Makefile.PL' to regenerate the Makefile.\n" if $checkversion < $Version_OK; - print STDOUT "Makefile built with ExtUtils::MakeMaker v $checkversion. Current Version is $Version." unless $checkversion == $Version; -} +install: + +makemakerdflt: + +test: -sub mksymlists{ - %att = @_; - parse_args(\%att, @ARGV); - MY->mksymlists(@_); +EOP + close MF or die "close Makefile for write: $!"; } -# The following mkbootstrap() is only for installations that are calling -# the pre-4.1 mkbootstrap() from their old Makefiles. This MakeMaker -# write Makefiles, that use ExtUtils::Mkbootstrap directly. -sub mkbootstrap{ - parse_args(\%att, @ARGV); - MY->init_main() unless defined $att{BASEEXT}; - eval {require ExtUtils::Mkbootstrap}; - if ($@){ - # Very difficult to arrive here, I suppose - carp "Error: $@\nVersion mismatch: This MakeMaker (v$Version) needs the ExtUtils::Mkbootstrap package. Please check your installation."; +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"; } - ExtUtils::Mkbootstrap::Mkbootstrap($att{BASEEXT},@_); } sub parse_args{ - my($attr, @args) = @_; + my($self, @args) = @_; foreach (@args){ unless (m/(.*?)=(.*)/){ help(),exit 1 if m/^help$/; @@ -460,2035 +559,1307 @@ sub parse_args{ my($name, $value) = ($1, $2); if ($value =~ m/^~(\w+)?/){ # tilde with optional username $value =~ s [^~(\w*)] - [$1 ? - ((getpwnam($1))[7] || "~$1") : + [$1 ? + ((getpwnam($1))[7] || "~$1") : (getpwuid($>))[7] ]ex; } - if ($Correct_relativ_directories){ - # This is experimental, so we don't care for efficiency - my @dirs = qw(INST_LIB INST_ARCHLIB INST_EXE); - my %dirs; - @dirs{@dirs}=@dirs; - if ($dirs{$name} && $value !~ m!^/!){ # a relativ directory - $value = "../$value"; - } - } - - $$attr{$name} = $value; + $self->{uc($name)} = $value; } + # 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 STDOUT "$msg changed to:\n\t'LIBS' => ['$$attr{potential_libs}']\n"; + 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"; } - $$attr{LIBS} = [$$attr{'potential_libs'}]; - delete $$attr{'potential_libs'}; + $self->{LIBS} = [$self->{potential_libs}]; + delete $self->{potential_libs}; } # catch old-style 'ARMAYBE' and inform user how to 'upgrade' - if (defined $$attr{'ARMAYBE'}){ - my($armaybe) = $$attr{'ARMAYBE'}; + 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) = %{$$attr{'dynamic_lib'} || {}}; - $$attr{'dynamic_lib'} = { %dl, ARMAYBE => $armaybe}; - delete $$attr{'ARMAYBE'}; + my(%dl) = %{$self->{dynamic_lib} || {}}; + $self->{dynamic_lib} = { %dl, ARMAYBE => $armaybe}; + delete $self->{ARMAYBE}; } - if (defined $$attr{'LDTARGET'}){ + if (defined $self->{LDTARGET}){ print STDOUT "LDTARGET should be changed to LDFROM\n"; - $$attr{'LDFROM'} = $$attr{'LDTARGET'}; - delete $$attr{'LDTARGET'}; + $self->{LDFROM} = $self->{LDTARGET}; + delete $self->{LDTARGET}; } - foreach(sort keys %{$attr}){ - print STDOUT " $_ => ".neatvalue($$attr{$_}) if ($Verbose); - print STDOUT "'$_' is not a known MakeMaker parameter name.\n" - unless exists $Recognized_Att_Keys{$_}; + # 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. -sub neatvalue{ - my($v) = @_; - return "undef" unless defined $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)." }"; + 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 $@; } -# ------ Define the MakeMaker default methods in package MM_Unix ------ +sub mv_all_methods { + my($from,$to) = @_; + my($method); + my($symtab) = \%{"${from}::"}; +# no strict; -package MM_Unix; + # 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. -use Config; -use Cwd; -use File::Basename; -require Exporter; + foreach $method (@Overridable) { -Exporter::import('ExtUtils::MakeMaker', - qw(%att %skip %Recognized_Att_Keys $Verbose)); + # We cannot say "next" here. Nick might call MY->makeaperl + # which isn't defined right now -# These attributes cannot be overridden externally -@Other_Att_Keys{qw(EXTRALIBS BSLOADLIBS LDLOADLIBS)} = (1) x 3; + # 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 -if ($Is_VMS = $Config{'osname'} eq 'VMS') { - require VMS::Filespec; - import VMS::Filespec 'vmsify'; -} + next unless defined &{"${from}::$method"}; + *{"${to}::$method"} = \&{"${from}::$method"}; -sub init_main { - my($self) = @_; + # 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: - # Find out directory name. This may contain the extension name. - my($pwd) = fastcwd(); # from Cwd.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\.(.*)\]:$1:i); - ($att{NAME}=$name) =~ s#[.\]]#::#g; - } else { - $name =~ s:.*/:: unless ($name =~ s:^.*/ext/::); - ($att{NAME} =$name) =~ s#/#::#g; - } + eval "package MY; sub $method { shift->SUPER::$method(\@_); }"; } - ($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} = ($Is_VMS ? '' : '/') . $att{ROOTEXT} if $att{ROOTEXT}; - - - # --- Initialize PERL_LIB, INST_LIB, PERL_SRC - - # *Real* information: where did we get these two from? ... - my $inc_config_dir = dirname($INC{'Config.pm'}); - my $inc_carp_dir = dirname($INC{'Carp.pm'}); - - # Typically PERL_* and INST_* will be identical but that need - # not be the case (e.g., installing into project libraries etc). - - # 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) - - # INST Macro: For standard for any other - # modules module - # INST_LIB ../../lib ./blib - # INST_ARCHLIB ../../lib ./blib - - unless ($att{PERL_SRC}){ - foreach (qw(../.. ../../.. ../../../..)){ - if ( -f "$_/config.sh" - && -f "$_/perl.h" - && -f "$_/lib/Exporter.pm") { - $att{PERL_SRC}=$_ ; - last; - } - } + + # 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; } - unless ($att{PERL_SRC}){ - # 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 <needs_linking; - - } else { # PERL_SRC is defined here... - - $att{PERL_LIB} = "$att{PERL_SRC}/lib" unless $att{PERL_LIB}; - $att{PERL_ARCHLIB} = $att{PERL_LIB}; - $att{PERL_INC} = $att{PERL_SRC}; - # catch an situation that has occurred a few times in the past: - warn <{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 ''; +} - # 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, say $Config{'privlib'}. - unless ($att{INST_LIB}){ - if (defined $att{PERL_SRC}) { -# require ExtUtils::Manifest; -# my $file; - my $standard = 0; -# my $mani = ExtUtils::Manifest::maniread("$att{PERL_SRC}/MANIFEST"); -# foreach $file (keys %$mani){ -# if ($file =~ m!^ext/\Q$att{FULLEXT}!){ -# $standard++; -# last; -# } -# } - -#### Temporary solution for perl5.001f: -$standard = 1; -#### This is just the same as was MakeMaker 4.094, but everything's prepared to -#### switch to a different behaviour after 5.001f - - if ($standard){ - $att{INST_LIB} = $att{PERL_LIB}; - } else { - $att{INST_LIB} = "./blib"; - print STDOUT <{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"; } - # Try to work out what INST_ARCHLIB should be if not set: - unless ($att{INST_ARCHLIB}){ - my(%archmap) = ( - "./blib" => "./blib", # our private build lib - $att{PERL_LIB} => $att{PERL_ARCHLIB}, - $Config{'privlib'} => $Config{'archlib'}, - $inc_carp_dir => $inc_config_dir, - ); - $att{INST_ARCHLIB} = $archmap{$att{INST_LIB}}; - unless($att{INST_ARCHLIB}){ - # Oh dear, we'll have to default it and warn the user - my($archname) = $Config{'archname'}; - if (-d "$att{INST_LIB}/$archname"){ - $att{INST_ARCHLIB} = "$att{INST_LIB}/$archname"; - print STDOUT "Defaulting INST_ARCHLIB to INST_LIB/$archname\n"; - } else { - $att{INST_ARCHLIB} = $att{INST_LIB}; - print STDOUT "Warning: Defaulting INST_ARCHLIB to INST_LIB ", - "(not architecture independent).\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{$_}; } } - $att{INST_EXE} = "./blib" unless $att{INST_EXE}; - if( $att{INSTALLPRIVLIB} && ! $att{INSTALLARCHLIB} ){ - my($archname) = $Config{'archname'}; - if (-d "$att{INSTALLPRIVLIB}/$archname"){ - $att{INSTALLARCHLIB} = "$att{INSTALLPRIVLIB}/$archname"; - print STDOUT "Defaulting INSTALLARCHLIB to INSTALLPRIVLIB/$archname\n"; - } else { - $att{INSTALLARCHLIB} = $att{INSTALLPRIVLIB}; - print STDOUT "Warning: Defaulting INSTALLARCHLIB to INSTALLPRIVLIB ", - "(not architecture independent).\n"; + 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 <find_perl(5.0, ['miniperl','perl','perl5',"perl$]" ], - [ grep defined $_, $att{PERL_SRC}, split(":", $ENV{PATH}), - $Config{'bin'} ], $Verbose ) - unless ($att{'PERL'}); # don't check, if perl is executable, maybe they - # they have decided to supply switches with perl - - # Define 'FULLPERL' to be a non-miniperl (used in test: target) - ($att{'FULLPERL'} = $att{'PERL'}) =~ s/miniperl/perl/ - unless ($att{'FULLPERL'} && -x $att{'FULLPERL'}); - - if ($Is_VMS) { - $att{'PERL'} = 'MCR ' . vmsify($att{'PERL'}); - $att{'FULLPERL'} = 'MCR ' . vmsify($att{'FULLPERL'}); + return "$v" unless $t eq 'HASH'; + my(@m, $key, $val); + while (($key,$val) = each %$v){ + last unless defined $key; # cautious programming in case (undef,undef) is true + push(@m,"$key=>".neatvalue($val)) ; } + return "{ ".join(', ',@m)." }"; } - -sub init_dirscan { # --- File and Directory Lists (.xs .pm .pod etc) - - my($name, %dir, %xs, %c, %h, %ignore, %pl_files); - local(%pm); #the sub in find() has to see this hash - $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]|pod)$/){ - $pm{$name} = "\$(INST_LIBDIR)/$name"; - } elsif ($name =~ /\.PL$/ && $name ne "Makefile.PL") { - ($pl_files{$name} = $name) =~ s/\.PL$// ; +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; +} - # Some larger extensions often wish to install a number of *.pm/pl - # files into the library in various locations. +package ExtUtils::MakeMaker; +1; - # The attribute PMLIBDIRS holds an array reference which lists - # subdirectories which we should search for library files to - # install. PMLIBDIRS defaults to [ 'lib', $att{BASEEXT} ]. - # We recursively search through the named directories (skipping - # any which don't exist or contain Makefile.PL files). +__END__ - # For each *.pm or *.pl file found MY->libscan() is called with - # the default installation path in $_. The return value of libscan - # defines the actual installation location. - # The default libscan function simply returns $_. - # The file is skipped if libscan returns false. +=head1 NAME - # The default installation location passed to libscan in $_ is: - # - # ./*.pm => $(INST_LIBDIR)/*.pm - # ./xyz/... => $(INST_LIBDIR)/xyz/... - # ./lib/... => $(INST_LIB)/... - # - # In this way the 'lib' directory is seen as the root of the actual - # perl library whereas the others are relative to INST_LIBDIR - # (which includes ROOTEXT). This is a subtle distinction but one - # that's important for nested modules. +ExtUtils::MakeMaker - create an extension Makefile - $att{PMLIBDIRS} = [ 'lib', $att{BASEEXT} ] unless $att{PMLIBDIRS}; +=head1 SYNOPSIS - #only existing directories that aren't in $dir are allowed - @{$att{PMLIBDIRS}} = grep -d && !$dir{$_}, @{$att{PMLIBDIRS}}; +C - if (@{$att{PMLIBDIRS}}){ - print "Searching PMLIBDIRS: @{$att{PMLIBDIRS}}" - if ($Verbose >= 2); - use File::Find; # try changing to require ! - File::Find::find(sub { -# We now allow any file in PMLIBDIRS to be installed. nTk needs that, and -# we should allow it. -# return unless m/\.p[ml]$/; - return if -d $_; # anything else that Can't be copied? - my($path, $prefix) = ($File::Find::name, '$(INST_LIBDIR)'); - my $striplibpath; - $prefix = '$(INST_LIB)' if (($striplibpath = $path) =~ s:^lib/::); - local($_) = "$prefix/$striplibpath"; - my($inst) = MY->libscan(); - print "libscan($path) => '$inst'" if ($Verbose >= 2); - return unless $inst; - $pm{$path} = $inst; - }, @{$att{PMLIBDIRS}}); - } +C VALUE [, ...] );> - $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}; - my(@o_files) = @{$att{C}}; - my($sufx) = $Is_VMS ? '.obj' : '.o'; - $att{O_FILES} = [grep s/\.c$/$sufx/, @o_files] ; - $att{H} = [sort keys %h] unless $att{H}; - $att{PL_FILES} = \%pl_files unless $att{PL_FILES}; -} +which is really +Cnew(\%att)-Eflush;> -sub libscan { - return '' if m:/RCS/: ; # return undef triggered warnings with $Verbose>=2 - $_; -} +=head1 DESCRIPTION -sub init_others { # --- Initialize Other Attributes - my($key); - for $key (keys(%Recognized_Att_Keys), keys(%Other_Att_Keys)){ - # avoid warnings for uninitialized vars - next if exists $att{$key}; - $att{$key} = ""; - } +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. - # 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; - $att{LD_RUN_PATH} = ""; - 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; - if ($libs[2]) { - $att{LD_RUN_PATH} = join(":",grep($_=~s/^-L//,split(" ", $libs[2]))); - } - last; - } - } +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. - print STDOUT "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 - )); - push(@{$att{CONFIG}}, 'shellflags') if $Config{'shellflags'}; - - if ($Is_VMS) { - $att{OBJECT} = '$(BASEEXT).obj' unless $att{OBJECT}; - $att{OBJECT} =~ s/[^,\s]\s+/, /g; - $att{OBJECT} =~ s/\n+/, /g; - $att{OBJECT} =~ s#\.o,#\.obj,#; - } 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}; - # Sanity check: don't define LINKTYPE = dynamic if we're skipping - # the 'dynamic' section of MM. We don't have this problem with - # 'static', since we either must use it (%Config says we can't - # use dynamic loading) or the caller asked for it explicitly. - if (!$att{LINKTYPE}) { - $att{LINKTYPE} = grep(/dynamic/,@{$att{SKIP} || []}) - ? 'static' - : ($Config{'usedl'} ? 'dynamic' : 'static'); - }; - - # These get overridden for VMS and maybe some other systems - $att{NOOP} = ""; - $att{MAKEFILE} = "Makefile"; - $att{RM_F} = "rm -f"; - $att{RM_RF} = "rm -rf"; - $att{TOUCH} = "touch"; - $att{CP} = "cp"; - $att{MV} = "mv"; - $att{CHMOD} = "chmod"; -} +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 -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; -} +The short answer is: Don't. + Always begin with h2xs. + Always begin with h2xs! + ALWAYS BEGIN WITH H2XS! -sub find_perl{ - my($self, $ver, $names, $dirs, $trace) = @_; - my($name, $dir); - if ($trace >= 2){ - print "Looking for perl $ver by these names: "; - print "@$names, "; - print "in these dirs:"; - print "@$dirs"; - } - foreach $dir (@$dirs){ - next unless defined $dir; # $att{PERL_SRC} may be undefined - foreach $name (@$names){ - print "Checking $dir/$name " if ($trace >= 2); - if ($Is_VMS) { - $name .= ".exe" unless -x "$dir/$name"; - } - next unless -x "$dir/$name"; - print "Executing $dir/$name" if ($trace >= 2); - 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`; - } - if ($out =~ /VER_OK/) { - print "Using PERL=$dir/$name" if $trace; - return "$dir/$name"; - } - } - } - print STDOUT "Unable to find a perl $ver (by these names: @$names, in these dirs: @$dirs)\n"; - 0; # false and not empty -} +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. -sub post_initialize{ - ""; -} +The medium answer is: -sub needs_linking { # Does this module need linking? - return 1 if $att{OBJECT} or @{$att{C} || []} or $att{MYEXTLIB}; - return 0; -} + use ExtUtils::MakeMaker; + WriteMakefile( NAME => "Foo::Bar" ); -sub constants { - my($self) = @_; - my(@m); +The long answer is the rest of the manpage :-) - push @m, " -NAME = $att{NAME} -DISTNAME = $att{DISTNAME} -VERSION = $att{VERSION} -VERSION_SYM = $att{VERSION_SYM} - -# In which directory should we put this extension during 'make'? -# This is typically ./blib. -# (also see INST_LIBDIR and relationship to ROOTEXT) -INST_LIB = $att{INST_LIB} -INST_ARCHLIB = $att{INST_ARCHLIB} -INST_EXE = $att{INST_EXE} - -# AFS users will want to set the installation directories for -# the final 'make install' early without setting INST_LIB, -# INST_ARCHLIB, and INST_EXE for the testing phase -INSTALLPRIVLIB = $att{INSTALLPRIVLIB} -INSTALLARCHLIB = $att{INSTALLARCHLIB} -INSTALLBIN = $att{INSTALLBIN} - -# Perl library to use when building the extension -PERL_LIB = $att{PERL_LIB} -PERL_ARCHLIB = $att{PERL_ARCHLIB} -LIBPERL_A = $att{LIBPERL_A} - -MAKEMAKER = \$(PERL_LIB)/ExtUtils/MakeMaker.pm -MM_VERSION = $ExtUtils::MakeMaker::Version -"; - - # Define I_PERL_LIBS to include the required -Ipaths - # To be cute we only include PERL_ARCHLIB if different - - #### Deprecated from Version 4.11: We want to avoid different - #### behavior for variables with make(1) and perl(1) - - # To be portable we add quotes for VMS - my(@i_perl_libs) = qw{-I$(PERL_ARCHLIB) -I$(PERL_LIB)}; - shift(@i_perl_libs) if ($att{PERL_ARCHLIB} eq $att{PERL_LIB}); - if ($Is_VMS){ - push @m, "I_PERL_LIBS = \"".join('" "',@i_perl_libs)."\"\n"; - } else { - push @m, "I_PERL_LIBS = ".join(' ',@i_perl_libs)."\n"; - } +=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_HTMLLIBDIR, +INST_HTMLSCRIPTDIR, 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_HTMLLIBDIR INSTALLHTMLPRIVLIBDIR INSTALLHTMLSITELIBDIR + INST_HTMLSCRIPTDIR INSTALLHTMLSCRIPTDIR + 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. + +Another way to specify many INSTALL directories with a single +parameter is PREFIX. + + perl Makefile.PL PREFIX=~ + +This will replace the string specified by C<$Config{prefix}> in all +C<$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 parameters LIB, +PREFIX and the various INSTALL* arguments are resolved so that: + +=over 4 + +=item * + +setting LIB overrides any setting of INSTALLPRIVLIB, INSTALLARCHLIB, +INSTALLSITELIB, INSTALLSITEARCH (and they are not affected by PREFIX); + +=item * + +without LIB, setting PREFIX replaces the initial C<$Config{prefix}> +part of those INSTALL* arguments, even if the latter are explicitly +set (but are set to still start with C<$Config{prefix}>). + +=back + +If the user has superuser privileges, and is not working on AFS +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 + +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. + +=head2 AFS users + +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 + + perl Makefile.PL INSTALLSITELIB=/afs/here/today \ + INSTALLSCRIPT=/afs/there/now INSTALLMAN3DIR=/afs/for/manpages + make + +Be careful to repeat this procedure every time you recompile an +extension, unless you are sure the AFS installation directories are +still valid. + +=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 + + make perl + +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. + +The binary can be installed into the directory where perl normally +resides on your machine with + + make inst_perl + +To produce a perl binary with a different name than C, either say + + perl Makefile.PL MAP_TARGET=myperl + make myperl + make inst_perl + +or say + + perl Makefile.PL + make myperl MAP_TARGET=myperl + make inst_perl MAP_TARGET=myperl + +In any case you will be prompted with the correct invocation of the +C target that installs the new binary into INSTALLBIN. + +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. + +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: + + 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 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 + +The following attributes can be specified as arguments to WriteMakefile() +or as NAME=VALUE pairs on the command line: + +=over 2 + +=item ABSTRACT + +One line description of the module. Will be included in PPD file. + +=item ABSTRACT_FROM + +Name of the file that contains the package description. MakeMaker looks +for a line in the POD matching /^($package\s-\s)(.*)/. This is typically +the first line in the "=head1 NAME" section. $2 becomes the abstract. + +=item AUTHOR + +String containing name (and email address) of package author(s). Is used +in PPD (Perl Package Description) files for PPM (Perl Package Manager). + +=item BINARY_LOCATION + +Used when creating PPD files for binary packages. It can be set to a +full or relative path or URL to the binary archive for a particular +architecture. For example: + + perl Makefile.PL BINARY_LOCATION=x86/Agent.tar.gz + +builds a PPD package that references a binary of the C package, +located in the C directory relative to the PPD itself. + +=item 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. + +=item CAPI + +[This attribute is obsolete in Perl 5.6. PERL_OBJECT builds are C-compatible +by default.] + +Switch to force usage of the Perl C API even when compiling for PERL_OBJECT. + +Note that this attribute is passed through to any recursive build, +but if and only if the submodule's Makefile.PL itself makes no mention +of the 'CAPI' attribute. + +=item CCFLAGS + +String that will be included in the compiler call command line between +the arguments INC and OPTIMIZE. + +=item CONFIG + +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 + +=item CONFIGURE + +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. + +=item DEFINE + +Something like C<"-DHAVE_UNISTD_H"> + +=item DIR + +Ref to array of subdirectories containing Makefile.PLs e.g. [ 'sdbm' +] in ext/SDBM_File + +=item DISTNAME + +Your name for distributing the package (by tar file). This defaults to +NAME above. + +=item DL_FUNCS + +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, OS/2, +VMS and Win32 at present. The routine names supplied will be expanded +in the same way as XSUB names are expanded by the XS() macro. +Defaults to + + {"$(NAME)" => ["boot_$(NAME)" ] } + +e.g. + + {"RPC" => [qw( boot_rpcb rpcb_gettime getnetconfigent )], + "NetconfigPtr" => [ 'DESTROY'] } + +Please see the L documentation for more information +about the DL_FUNCS, DL_VARS and FUNCLIST attributes. + +=item DL_VARS + +Array of symbol names for variables to be made available as universal symbols. +Used only under AIX, OS/2, VMS and Win32 at present. Defaults to []. +(e.g. [ qw(Foo_version Foo_numstreams Foo_tree ) ]) + +=item EXCLUDE_EXT + +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 ) ] ) + +This attribute may be most useful when specified as a string on the +command line: perl Makefile.PL EXCLUDE_EXT='Socket Safe' + +=item EXE_FILES + +Ref to array of executable files. The files will be copied to the +INST_SCRIPT directory. Make realclean will delete them from there +again. + +=item FIRST_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. + +=item FULLPERL + +Perl binary able to run this extension. + +=item FUNCLIST + +This provides an alternate means to specify function names to be +exported from the extension. Its value is a reference to an +array of function names to be exported by the extension. These +names are passed through unaltered to the linker options file. + +=item H + +Ref to array of *.h file names. Similar to C. + +=item HTMLLIBPODS + +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 HTML format and installed as was requested +at Configure time. + +=item HTMLSCRIPTPODS + +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 HTML format and installed as was requested +at Configure time. + +=item IMPORTS + +This attribute is used to specify names to be imported into the +extension. It is only used on OS/2 and Win32. + +=item INC + +Include file dirs eg: C<"-I/usr/5include -I/path/to/inc"> + +=item INCLUDE_EXT + +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 ) ]) + +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. + +This attribute may be most useful when specified as a string on the +command line: perl Makefile.PL INCLUDE_EXT='POSIX Socket Devel::Peek' - push @m, " -# Where is the perl source code located? -PERL_SRC = $att{PERL_SRC}\n" if $att{PERL_SRC}; - - push @m, " -# Perl header files (will eventually be under PERL_LIB) -PERL_INC = $att{PERL_INC} -# Perl binaries -PERL = $att{'PERL'} -FULLPERL = $att{'FULLPERL'} -"; - push @m, " -# 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} -"; - push @m, " -INC = $att{INC} -DEFINE = $att{DEFINE} -OBJECT = $att{OBJECT} -LDFROM = $att{LDFROM} -LINKTYPE = $att{LINKTYPE} - -# Handy lists of source code files: -XS_FILES= ".join(" \\\n\t", sort keys %{$att{XS}})." -C_FILES = ".join(" \\\n\t", @{$att{C}})." -O_FILES = ".join(" \\\n\t", @{$att{O_FILES}})." -H_FILES = ".join(" \\\n\t", @{$att{H}})." - -.SUFFIXES: .xs - -.PRECIOUS: Makefile - -.NO_PARALLEL: - -.PHONY: all config static dynamic test linkext - -# This extension may link to it's own library (see SDBM_File) -MYEXTLIB = $att{MYEXTLIB} - -# Where is the Config information that we are using/depend on -CONFIGDEP = \$(PERL_ARCHLIB)/Config.pm \$(PERL_INC)/config.h -"; - - push @m, ' -# Where to put things: -INST_LIBDIR = $(INST_LIB)$(ROOTEXT) -INST_ARCHLIBDIR = $(INST_ARCHLIB)$(ROOTEXT) - -INST_AUTODIR = $(INST_LIB)/auto/$(FULLEXT) -INST_ARCHAUTODIR = $(INST_ARCHLIB)/auto/$(FULLEXT) -'; - - if ($self->needs_linking) { - push @m, ' -INST_STATIC = $(INST_ARCHAUTODIR)/$(BASEEXT).a -INST_DYNAMIC = $(INST_ARCHAUTODIR)/$(BASEEXT).$(DLEXT) -INST_BOOT = $(INST_ARCHAUTODIR)/$(BASEEXT).bs -'; - } else { - push @m, ' -INST_STATIC = -INST_DYNAMIC = -INST_BOOT = -'; - } +=item INSTALLARCHLIB - push @m, ' -INST_PM = '.join(" \\\n\t", sort values %{$att{PM}}).' -'; +Used by 'make install', which copies files from INST_ARCHLIB to this +directory if INSTALLDIRS is set to perl. - join('',@m); -} +=item INSTALLBIN -$Const_cccmd=0; # package global +Directory to install binary files (e.g. tkperl) into. -sub const_cccmd{ - my($self,$libperl)=@_; - $libperl or $libperl = $att{LIBPERL_A} || "libperl.a" ; - # 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, $shflags) - = @Config{qw(cc ccflags optimize large split shellflags)}; - my($optdebug)=""; +=item INSTALLDIRS - $shflags = '' unless $shflags; - my($prog, $old, $uc, $perltype); +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. - unless ($Const_cccmd++){ - chop($old = `cd $att{PERL_SRC}; sh $shflags ./cflags $libperl $att{BASEEXT}.c`) - if $att{PERL_SRC}; - $Const_cccmd++; # shut up typo warning - } +=item INSTALLHTMLPRIVLIBDIR - my(%map) = ( - D => '-DDEBUGGING', - E => '-DEMBED', - DE => '-DDEBUGGING -DEMBED', - M => '-DEMBED -DMULTIPLICITY', - DM => '-DDEBUGGING -DEMBED -DMULTIPLICITY', - ); +This directory gets the HTML pages at 'make install' time. Defaults to +$Config{installhtmlprivlibdir}. - if ($libperl =~ /libperl(\w*)\.a/){ - $uc = uc($1); - } else { - $uc = ""; # avoid warning - } - $perltype = $map{$uc} ? $map{$uc} : ""; +=item INSTALLHTMLSCRIPTDIR - if ($uc =~ /^D/) { - $optdebug = "-g"; - } +This directory gets the HTML pages at 'make install' time. Defaults to +$Config{installhtmlscriptdir}. +=item INSTALLHTMLSITELIBDIR - my($name); - ( $name = $att{NAME} . "_cflags" ) =~ s/:/_/g ; - if ($prog = $Config{$name}) { - # Expand hints for this extension via the shell - print STDOUT "Processing $name hint:\n" if $Verbose; - my(@o)=`cc=\"$cc\" - ccflags=\"$ccflags\" - optimize=\"$optimize\" - perltype=\"$perltype\" - optdebug=\"$optdebug\" - large=\"$large\" - split=\"$split\" - eval '$prog' - echo cc=\$cc - echo ccflags=\$ccflags - echo optimize=\$optimize - echo perltype=\$perltype - echo optdebug=\$optdebug - echo large=\$large - echo split=\$split - `; - my(%cflags,$line); - foreach $line (@o){ - chomp $line; - if ($line =~ /(.*?)=\s*(.*)\s*$/){ - $cflags{$1} = $2; - print STDOUT " $1 = $2" if $Verbose; - } else { - print STDOUT "Unrecognised result from hint: '$line'\n"; - } - } - ( $cc,$ccflags,$perltype,$optdebug,$optimize,$large,$split )=@cflags{ - qw( cc ccflags perltype optdebug optimize large split)}; - } +This directory gets the HTML pages at 'make install' time. Defaults to +$Config{installhtmlsitelibdir}. - if ($optdebug) { - $optimize = $optdebug; - } - my($new) = "$cc -c $ccflags $optimize $perltype $large $split"; - $new =~ s/^\s+//; $new =~ s/\s+/ /g; $new =~ s/\s+$//; - if (defined($old)){ - $old =~ s/^\s+//; $old =~ s/\s+/ /g; $old =~ s/\s+$//; - if ($new ne $old) { - print STDOUT "Warning (non-fatal): cflags evaluation in " - ."MakeMaker ($ExtUtils::MakeMaker::Version) " - ."differs from shell output\n" - ." package: $att{NAME}\n" - ." old: $old\n" - ." new: $new\n" - ." Using 'old' set.\n" - . Config::myconfig() - ."\nPlease send these details to perl5-porters\@nicoh.com\n"; - } - } - my($cccmd)=($old) ? $old : $new; - $cccmd =~ s/^\s*\Q$Config{'cc'}\E\s/\$(CC) /; - "CCCMD = $cccmd\n"; -} +=item INSTALLMAN1DIR +This directory gets the man pages at 'make install' time. Defaults to +$Config{installman1dir}. -# --- Constants Sections --- +=item INSTALLMAN3DIR -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}; - print STDOUT "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); -} +This directory gets the man pages at 'make install' time. Defaults to +$Config{installman3dir}. +=item INSTALLPRIVLIB -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. -# LD_RUN_PATH is a colon separated list of the directories -# in LDLOADLIBS. It is passed as an environment variable to -# the process that links the shared library. -# -# 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. -# -EXTRALIBS = $att{'EXTRALIBS'} -LDLOADLIBS = $att{'LDLOADLIBS'} -BSLOADLIBS = $att{'BSLOADLIBS'} -LD_RUN_PATH= $att{'LD_RUN_PATH'} -"; -} +Used by 'make install', which copies files from INST_LIB to this +directory if INSTALLDIRS is set to perl. +=item INSTALLSCRIPT -# --- Tool Sections --- +Used by 'make install' which copies files from INST_SCRIPT to this +directory. -sub tool_autosplit{ - my($self, %attribs) = @_; - my($asl) = ""; - $asl = "\$AutoSplit::Maxlen=$attribs{MAXLEN};" if $attribs{MAXLEN}; - q{ -# Usage: $(AUTOSPLITFILE) FileToSplit AutoDirToSplitInto -AUTOSPLITFILE = $(PERL) "-I$(PERL_ARCHLIB)" "-I$(PERL_LIB)" -e 'use AutoSplit;}.$asl.q{autosplit($$ARGV[0], $$ARGV[1], 0, 1, 1) ;' -}; -} +=item INSTALLSITEARCH +Used by 'make install', which copies files from INST_ARCHLIB to this +directory if INSTALLDIRS is set to site (default). -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} -MV = $att{MV} -RM_F = $att{RM_F} -RM_RF = $att{RM_RF} -CHMOD = $att{CHMOD} -".q{ -# The following is a portable way to say mkdir -p -MKPATH = $(PERL) -wle '$$"="/"; foreach $$p (@ARGV){ next if -d $$p; my(@p); foreach(split(/\//,$$p)){ push(@p,$$_); next if -d "@p/"; print "mkdir @p"; mkdir("@p",0777)||die $$! }} exit 0;' -}; -} +=item INSTALLSITELIB +Used by 'make install', which copies files from INST_LIB to this +directory if INSTALLDIRS is set to site (default). -sub post_constants{ - ""; -} +=item INST_ARCHLIB -sub macro { - my($self,%attribs) = @_; - my(@m,$key,$val); - while (($key,$val) = each %attribs){ - push @m, "$key = $val\n"; - } - join "", @m; -} +Same as INST_LIB for architecture dependent files. -sub pasthru { - my(@m,$key); - # It has to be considered carefully, which variables are apt - # to be passed through, e.g. ALL RELATIV DIRECTORIES are - # not suited for PASTHRU to subdirectories. - # Moreover: No directories at all have a chance, because we - # don't know yet, if the directories are absolute or relativ +=item INST_BIN - # PASTHRU2 is a conservative approach, that hardly changed - # MakeMaker between version 4.086 and 4.09. +Directory to put real binary files during 'make'. These will be copied +to INSTALLBIN during 'make install' - # PASTHRU1 is a revolutionary approach :), it cares for having - # a prepended "../" whenever runsubdirpl is called, but only - # for the three crucial INST_* directories. +=item INST_EXE - my(@pasthru1,@pasthru2); # 1 for runsubdirpl, 2 for the rest +Old name for INST_SCRIPT. Deprecated. Please use INST_SCRIPT if you +need to use it. - foreach $key (qw(INST_LIB INST_ARCHLIB INST_EXE)){ - push @pasthru1, "$key=\"\$($key)\""; - } +=item INST_HTMLLIBDIR - foreach $key (qw(INSTALLPRIVLIB INSTALLARCHLIB INSTALLBIN LIBPERL_A LINKTYPE)){ - push @pasthru1, "$key=\"\$($key)\""; - push @pasthru2, "$key=\"\$($key)\""; - } +Directory to hold the man pages in HTML format at 'make' time - push @m, "\nPASTHRU1 = ", join ("\\\n\t", @pasthru1), "\n"; - push @m, "\nPASTHRU2 = ", join ("\\\n\t", @pasthru2), "\n"; - join "", @m; -} +=item INST_HTMLSCRIPTDIR -# --- Translation Sections --- +Directory to hold the man pages in HTML format at 'make' time -sub c_o { - my(@m); - push @m, ' -.c.o: - $(CCCMD) $(CCCDLFLAGS) -I$(PERL_INC) $(DEFINE) $(INC) $*.c -'; - join "", @m; -} +=item INST_LIB -sub xs_c { - ' -.xs.c: - $(PERL) -I$(PERL_ARCHLIB) -I$(PERL_LIB) $(XSUBPP) $(XSUBPPARGS) $*.xs >$*.tc && mv $*.tc $@ -'; -} +Directory where we put library files of this extension while building +it. -sub xs_o { # many makes are too dumb to use xs_c then c_o - ' -.xs.o: - $(PERL) -I$(PERL_ARCHLIB) -I$(PERL_LIB) $(XSUBPP) $(XSUBPPARGS) $*.xs >xstmp.c && mv xstmp.c $*.c - $(CCCMD) $(CCCDLFLAGS) -I$(PERL_INC) $(DEFINE) $(INC) $*.c -'; -} +=item INST_MAN1DIR +Directory to hold the man pages at 'make' time -# --- Target Sections --- +=item INST_MAN3DIR -sub top_targets{ - my(@m); - push @m, ' -all :: config linkext $(INST_PM) -'.$att{NOOP}.' +Directory to hold the man pages at 'make' time -config :: '.$att{MAKEFILE}.' $(INST_LIBDIR)/.exists $(INST_ARCHAUTODIR)/.exists Version_check -'; +=item INST_SCRIPT - push @m, MM->dir_target('$(INST_LIBDIR)', '$(INST_ARCHAUTODIR)', '$(INST_EXE)'); +Directory, where executable files should be installed during +'make'. Defaults to "./blib/script", just to have a dummy location during +testing. make install will copy the files in INST_SCRIPT to +INSTALLSCRIPT. - push @m, ' -$(O_FILES): $(H_FILES) -' if @{$att{O_FILES} || []} && @{$att{H} || []}; +=item LDFROM - push @m, q{ -help: - $(PERL) -I$(PERL_LIB) -e 'use ExtUtils::MakeMaker "&help"; &help;' -}; +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) - push @m, q{ -Version_check: - @$(PERL) -I$(PERL_LIB) -e 'use ExtUtils::MakeMaker qw($$Version &Version_check);' \ - -e '&Version_check($(MM_VERSION))' -}; +=item LIB - join('',@m); -} +LIB should only be set at C time but is allowed as a +MakeMaker argument. It has the effect of +setting both INSTALLPRIVLIB and INSTALLSITELIB to that value regardless any +explicit setting of those arguments (or of PREFIX). +INSTALLARCHLIB and INSTALLSITEARCH are set to the corresponding +architecture subdirectory. -sub linkext { - my($self, %attribs) = @_; - # LINKTYPE => static or dynamic or '' - my($linktype) = defined $attribs{LINKTYPE} ? - $attribs{LINKTYPE} : '$(LINKTYPE)'; - " -linkext :: $linktype -$att{NOOP} -"; -} +=item LIBPERL_A -sub dlsyms { - my($self,%attribs) = @_; +The filename of the perllibrary that will be used together with this +extension. Defaults to libperl.a. - return '' if ($Config{'osname'} ne 'aix'); +=item LIBS - my($funcs) = $attribs{DL_FUNCS} || $att{DL_FUNCS} || {}; - my($vars) = $attribs{DL_VARS} || $att{DL_VARS} || []; - my(@m); +An anonymous array of alternative library +specifications to be searched for (in order) until +at least one library is found. E.g. - push(@m," -dynamic :: $att{BASEEXT}.exp + 'LIBS' => ["-lgdbm", "-ldbm -lfoo", "-L/path -ldbm.nfs"] -") unless $skip{'dynamic'}; +Mind, that any element of the array +contains a complete set of arguments for the ld +command. So do not specify - push(@m," -static :: $att{BASEEXT}.exp + 'LIBS' => ["-ltcl", "-ltk", "-lX11"] -") unless $skip{'static'}; +See ODBM_File/Makefile.PL for an example, where an array is needed. If +you specify a scalar as in - push(@m," -$att{BASEEXT}.exp: Makefile.PL -",' $(PERL) "-I$(PERL_ARCHLIB)" "-I$(PERL_LIB)" -e \'use ExtUtils::MakeMaker qw(&mksymlists); \\ - &mksymlists(DL_FUNCS => ', - %$funcs ? neatvalue($funcs) : '""',', DL_VARS => ', - @$vars ? neatvalue($vars) : '""', ", NAME => \"$att{NAME}\")' -"); + 'LIBS' => "-ltcl -ltk -lX11" - join('',@m); -} +MakeMaker will turn it into an array with one element. -# --- Dynamic Loading Sections --- +=item LINKTYPE -sub dynamic { - ' -# $(INST_PM) has been moved to the all: target. -# It remains here for awhile to allow for old usage: "make dynamic" -dynamic :: '.$att{MAKEFILE}.' $(INST_DYNAMIC) $(INST_BOOT) $(INST_PM) -'.$att{NOOP}.' -'; -} +'static' or 'dynamic' (default unless usedl=undef in +config.sh). Should only be used to force static linking (also see +linkext below). -sub dynamic_bs { - my($self, %attribs) = @_; - return '' unless $self->needs_linking; - ' -BOOTSTRAP = '."$att{BASEEXT}.bs".' - -# As 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{MAKEFILE} $att{BOOTDEP}".' - @ echo "Running Mkbootstrap for $(NAME) ($(BSLOADLIBS))" - @ $(PERL) "-I$(PERL_ARCHLIB)" "-I$(PERL_LIB)" \ - -e \'use ExtUtils::Mkbootstrap;\' \ - -e \'Mkbootstrap("$(BASEEXT)","$(BSLOADLIBS)");\' - @ $(TOUCH) $(BOOTSTRAP) - $(CHMOD) 644 $@ - @echo $@ >> $(INST_ARCHAUTODIR)/.packlist - -$(INST_BOOT): $(BOOTSTRAP) - @ '.$att{RM_RF}.' $(INST_BOOT) - -'.$att{CP}.' $(BOOTSTRAP) $(INST_BOOT) - $(CHMOD) 644 $@ - @echo $@ >> $(INST_ARCHAUTODIR)/.packlist -'; -} +=item MAKEAPERL +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. -sub dynamic_lib { - my($self, %attribs) = @_; - my($otherldflags) = $attribs{OTHERLDFLAGS} || ""; - my($armaybe) = $attribs{ARMAYBE} || $att{ARMAYBE} || ":"; - my($ldfrom) = '$(LDFROM)'; - return '' unless $self->needs_linking; - my($osname) = $Config{'osname'}; - $armaybe = 'ar' if ($osname eq 'dec_osf' and $armaybe eq ':'); - my(@m); - push(@m,' -# This section creates the dynamically loadable $(INST_DYNAMIC) -# from $(OBJECT) and possibly $(MYEXTLIB). -ARMAYBE = '.$armaybe.' -OTHERLDFLAGS = '.$otherldflags.' - -$(INST_DYNAMIC): $(OBJECT) $(MYEXTLIB) $(BOOTSTRAP) $(INST_ARCHAUTODIR)/.exists -'); - if ($armaybe ne ':'){ - $ldfrom = "tmp.a"; - push(@m,' $(ARMAYBE) cr '.$ldfrom.' $(OBJECT)'."\n"); - push(@m,' $(RANLIB) '."$ldfrom\n"); - } - $ldfrom = "-all $ldfrom -none" if ($osname eq 'dec_osf'); - push(@m,' LD_RUN_PATH="$(LD_RUN_PATH)" $(LD) -o $@ $(LDDLFLAGS) '.$ldfrom. - ' $(OTHERLDFLAGS) $(MYEXTLIB) $(LDLOADLIBS)'); - push @m, ' - $(CHMOD) 755 $@ - @echo $@ >> $(INST_ARCHAUTODIR)/.packlist -'; - - push @m, MM->dir_target('$(INST_ARCHAUTODIR)'); - join('',@m); -} +=item MAKEFILE +The name of the Makefile to be produced. -# --- Static Loading Sections --- +=item MAN1PODS -sub static { - ' -# $(INST_PM) has been moved to the all: target. -# It remains here for awhile to allow for old usage: "make static" -static :: '.$att{MAKEFILE}.' $(INST_STATIC) $(INST_PM) -'.$att{NOOP}.' -'; -} +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. -sub static_lib{ - my($self) = @_; - return '' unless $self->needs_linking; - my(@m); - push(@m, <<'END'); -$(INST_STATIC): $(OBJECT) $(MYEXTLIB) $(INST_ARCHAUTODIR)/.exists -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) $@ - @echo "$(EXTRALIBS)" > $(INST_ARCHAUTODIR)/extralibs.ld - $(CHMOD) 755 $@ - @echo $@ >> $(INST_ARCHAUTODIR)/.packlist -END +=item MAN3PODS -# Old mechanism - still available: +Hashref that assigns to *.pm and *.pod files the files into which the +manpages are to be written. MakeMaker parses all *.pod and *.pm files +for POD directives. Files that contain POD will be the default keys of +the MAN3PODS hashref. These will then be converted to man pages during +C and will be installed during C. - push(@m, <<'END') if $att{PERL_SRC}; - @ echo "$(EXTRALIBS)" >> $(PERL_SRC)/ext.libs -END +=item MAP_TARGET - push @m, MM->dir_target('$(INST_ARCHAUTODIR)'); - join('', "\n",@m); -} +If it is intended, that a new perl binary be produced, this variable +may hold a name for that binary. Defaults to perl +=item MYEXTLIB -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); -} +If the extension links to a library that it builds set this to the +name of the library (see SDBM_File) -sub installpm_x { # called by installpm per file - my($self, $dist, $inst, $splitlib) = @_; - warn "Warning: Most probably 'make' will have problems processing this file: $inst\n" - if $inst =~ m![:#]!; - my($instdir) = $inst =~ m|(.*)/|; - my(@m); - push(@m," -$inst: $dist $att{MAKEFILE} $instdir/.exists -".' @ '.$att{RM_F}.' $@ - '."$att{CP} $dist".' $@ - $(CHMOD) 644 $@ - @echo $@ >> $(INST_ARCHAUTODIR)/.packlist -'); - push(@m, "\t\@\$(AUTOSPLITFILE) \$@ $splitlib/auto\n") - if ($splitlib and $inst =~ m/\.pm$/); - - push @m, MM->dir_target($instdir); - join('', @m); -} +=item NAME -sub processPL { - return "" unless $att{PL_FILES}; - my(@m, $plfile); - foreach $plfile (sort keys %{$att{PL_FILES}}) { - push @m, " -all :: $att{PL_FILES}->{$plfile} +Perl module name for this extension (DBD::Oracle). This will default +to the directory name but should be explicitly defined in the +Makefile.PL. -$att{PL_FILES}->{$plfile} :: $plfile - \$(PERL) -I\$(INST_ARCHLIB) -I\$(INST_LIB) -I\$(PERL_ARCHLIB) -I\$(PERL_LIB) $plfile -"; - } - join "", @m; -} +=item NEEDS_LINKING -sub installbin { - return "" unless $att{EXE_FILES} && ref $att{EXE_FILES} eq "ARRAY"; - my(@m, $from, $to, %fromto, @to); - for $from (@{$att{EXE_FILES}}) { - local($_)= '$(INST_EXE)/' . basename($from); - $to = MY->exescan(); - print "exescan($from) => '$to'" if ($Verbose >=2); - $fromto{$from}=$to; - } - @to = values %fromto; - push(@m, " -EXE_FILES = @{$att{EXE_FILES}} - -all :: @to - -realclean :: - $att{RM_F} @to -"); - - while (($from,$to) = each %fromto) { - my $todir = dirname($to); - push @m, " -$to: $from $att{MAKEFILE} $todir/.exists - $att{CP} $from $to -"; - } - join "", @m; -} +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 exescan { - $_; -} -# --- Sub-directory Sections --- +=item NOECHO -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(grep -d, &lsdir()){ - next if /^\./; - next unless -f "$_/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. +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. -all :: subdirs -"); - } else { - push(@m, "\n# none") - } - join('',@m); -} +=item NORECURS -sub runsubdirpl{ # Experimental! See subdir_x section - my($self,$subdir) = @_; - chdir($subdir) or die "chdir($subdir): $!"; - ExtUtils::MakeMaker::check_hints(); - package main; - require "Makefile.PL"; -} +Boolean. Attribute to inhibit descending into subdirectories. -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/$att{MAKEFILE} - cd $subdir && \$(MAKE) config \$(PASTHRU2) \$(SUBDIR_MAKEFILE_PL_ARGS) - -$subdir/$att{MAKEFILE}: $subdir/Makefile.PL \$(CONFIGDEP) -}.' @echo "Rebuilding $@ ..." - @$(PERL) -I"$(PERL_ARCHLIB)" -I"$(PERL_LIB)" \\ - -e "use ExtUtils::MakeMaker; MM->runsubdirpl(qw('.$subdir.'))" \\ - $(PASTHRU1) $(SUBDIR_MAKEFILE_PL_ARGS) - @echo "Rebuild of $@ complete." -'.qq{ - -subdirs :: - cd $subdir && \$(MAKE) all \$(PASTHRU2) - -}; -} +=item NO_VC +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. -# --- Cleanup and Distribution Sections --- +=item OBJECT -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 $att{MAKEFILE} && \$(MAKE) clean\n",@{$att{DIR}})); - my(@otherfiles) = values %{$att{XS}}; # .c files from *.xs files - push(@otherfiles, $attribs{FILES}) if $attribs{FILES}; - push(@otherfiles, "./blib"); - push(@m, " -$att{RM_RF} *~ t/*~ *.o *.a mon.out core so_locations " - ."\$(BOOTSTRAP) \$(BASEEXT).bso \$(BASEEXT).exp @otherfiles\n"); - # See realclean and ext/utils/make_ext for usage of Makefile.old - push(@m, " -$att{MV} $att{MAKEFILE} $att{MAKEFILE}.old 2>/dev/null\n"); - push(@m, " $attribs{POSTOP}\n") if $attribs{POSTOP}; - join("", @m); -} +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 realclean { - my($self, %attribs) = @_; - my(@m); - push(@m,' -# Delete temporary files (via clean) and also delete installed files -realclean purge :: clean -'); - # realclean subdirectories first (already cleaned) - my $sub = "\t-cd %s && test -f %s && \$(MAKE) %s realclean\n"; - foreach(@{$att{DIR}}){ - push(@m, sprintf($sub,$_,"$att{MAKEFILE}.old","-f $att{MAKEFILE}.old")); - push(@m, sprintf($sub,$_,"$att{MAKEFILE}",'')); - } - push(@m, " $att{RM_RF} \$(INST_AUTODIR) \$(INST_ARCHAUTODIR)\n"); - push(@m, " $att{RM_F} \$(INST_DYNAMIC) \$(INST_BOOT)\n"); - push(@m, " $att{RM_F} \$(INST_STATIC) \$(INST_PM)\n"); - my(@otherfiles) = ($att{MAKEFILE}, - "$att{MAKEFILE}.old"); # Makefiles last - 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); -} +(Where BASEEXT is the last component of NAME, and OBJ_EXT is $Config{obj_ext}.) +=item OPTIMIZE -sub dist { - my($self, %attribs) = @_; - my(@m); - # VERSION should be sanitised before use as a file name - if ($attribs{TARNAME}){ - print STDOUT "Error (fatal): Attribute TARNAME for target dist is deprecated -Please use DISTNAME and VERSION"; - } - my($name) = $attribs{NAME} || '$(DISTNAME)-$(VERSION)'; - my($tar) = $attribs{TAR} || 'tar'; # eg /usr/bin/gnutar - my($tarflags) = $attribs{TARFLAGS} || 'cvf'; - my($compress) = $attribs{COMPRESS} || 'compress'; # eg gzip - my($suffix) = $attribs{SUFFIX} || 'Z'; # eg gz - my($shar) = $attribs{SHAR} || 'shar'; # eg "shar --gzip" - my($preop) = $attribs{PREOP} || '@ :'; # eg update MANIFEST - my($postop) = $attribs{POSTOP} || '@ :'; # eg remove the distdir - my($ci) = $attribs{CI} || 'ci -u'; - my($rcs) = $attribs{RCS} || 'rcs -Nv$(VERSION_SYM):'; - my($dist_default) = $attribs{DIST_DEFAULT} || 'tardist'; - - push @m, " -TAR = $tar -TARFLAGS = $tarflags -COMPRESS = $compress -SUFFIX = $suffix -SHAR = $shar -PREOP = $preop -POSTOP = $postop -CI = $ci -RCS = $rcs -DIST_DEFAULT = $dist_default -"; - - push @m, q{ -distclean :: realclean distcheck - -distcheck : - $(PERL) -I$(PERL_LIB) -e 'use ExtUtils::Manifest "&fullcheck";' \\ - -e 'fullcheck();' - -manifest : - $(PERL) -I$(PERL_LIB) -e 'use ExtUtils::Manifest "&mkmanifest";' \\ - -e 'mkmanifest();' - -dist : $(DIST_DEFAULT) - -tardist : $(DISTNAME)-$(VERSION).tar.$(SUFFIX) - -$(DISTNAME)-$(VERSION).tar.$(SUFFIX) : distdir - $(PREOP) - $(TAR) $(TARFLAGS) $(DISTNAME)-$(VERSION).tar $(DISTNAME)-$(VERSION) - $(COMPRESS) $(DISTNAME)-$(VERSION).tar - $(RM_RF) $(DISTNAME)-$(VERSION) - $(POSTOP) - -uutardist : $(DISTNAME)-$(VERSION).tar.$(SUFFIX) - uuencode $(DISTNAME)-$(VERSION).tar.$(SUFFIX) \\ - $(DISTNAME)-$(VERSION).tar.$(SUFFIX) > \\ - $(DISTNAME)-$(VERSION).tar.$(SUFFIX).uu - -shdist : distdir - $(PREOP) - $(SHAR) $(DISTNAME)-$(VERSION) > $(DISTNAME)-$(VERSION).shar - $(RM_RF) $(DISTNAME)-$(VERSION) - $(POSTOP) - -distdir : - $(RM_RF) $(DISTNAME)-$(VERSION) - $(PERL) -I$(PERL_LIB) -e 'use ExtUtils::Manifest "/mani/";' \\ - -e 'manicopy(maniread(),"$(DISTNAME)-$(VERSION)");' - - -ci : - $(PERL) -I$(PERL_LIB) -e 'use ExtUtils::Manifest "&maniread";' \\ - -e '@all = keys %{maniread()};' \\ - -e 'print("Executing $(CI) @all\n"); system("$(CI) @all");' \\ - -e 'print("Executing $(RCS) ...\n"); system("$(RCS) @all");' - -}; - join "", @m; -} +Defaults to C<-O>. Set it to C<-g> to turn debugging on. The flag is +passed to subdirectory makes. +=item PERL -# --- Test and Installation Sections --- +Perl binary for tasks that can be done by miniperl -sub test { - my($self, %attribs) = @_; - my($tests) = $attribs{TESTS} || (-d "t" ? "t/*.t" : ""); - my(@m); - push(@m," -TEST_VERBOSE=0 +=item PERLMAINCC -test :: all -"); - push(@m, <<"END") if $tests; - \$(FULLPERL) -I\$(INST_ARCHLIB) -I\$(INST_LIB) -I\$(PERL_ARCHLIB) -I\$(PERL_LIB) -e 'use Test::Harness qw(&runtests \$\$verbose); \$\$verbose=\$(TEST_VERBOSE); 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 $att{MAKEFILE} && \$(MAKE) test \$(PASTHRU2)\n", - @{$att{DIR}})); - push(@m, "\t\@echo 'No tests defined for \$(NAME) extension.'\n") unless @m > 1; - join("", @m); -} +The call to the program that is able to compile perlmain.c. Defaults +to $(CC). +=item PERL_ARCHLIB -sub install { - my($self, %attribs) = @_; - my(@m); - push @m, q{ -doc_install :: - @ echo Appending installation info to $(INSTALLARCHLIB)/perllocal.pod - @ $(PERL) -I$(INST_ARCHLIB) -I$(INST_LIB) -I$(PERL_ARCHLIB) -I$(PERL_LIB) \\ - -e "use ExtUtils::MakeMaker; MM->writedoc('Module', '$(NAME)', \\ - 'LINKTYPE=$(LINKTYPE)', 'VERSION=$(VERSION)', \\ - 'EXE_FILES=$(EXE_FILES)')" >> $(INSTALLARCHLIB)/perllocal.pod -}; - - push(@m, " -install :: pure_install doc_install - -pure_install :: -"); - # install subdirectories first - push(@m, map("\tcd $_ && test -f $att{MAKEFILE} && \$(MAKE) install\n", - @{$att{DIR}})); - - push(@m, "\t\@\$(PERL) -e 'foreach (\@ARGV){die qq{You do not have permissions to install into \$\$_\\n} unless -w \$\$_}' \$(INSTALLPRIVLIB) \$(INSTALLARCHLIB) - : perl5.000 and MM pre 3.8 autosplit into INST_ARCHLIB, we delete these old files here - $att{RM_F} \$(INSTALLARCHLIB)/auto/\$(FULLEXT)/*.al - $att{RM_F} \$(INSTALLARCHLIB)/auto/\$(FULLEXT)/*.ix - \$(MAKE) INST_LIB=\$(INSTALLPRIVLIB) INST_ARCHLIB=\$(INSTALLARCHLIB) INST_EXE=\$(INSTALLBIN) - \@\$(PERL) -i.bak -lne 'print unless \$\$seen{\$\$_}++' \$(INSTALLARCHLIB)/auto/\$(FULLEXT)/.packlist -"); - - push @m, ' -#### UNINSTALL IS STILL EXPERIMENTAL #### -uninstall :: -'; - - push(@m, map("\tcd $_ && test -f $att{MAKEFILE} && \$(MAKE) uninstall\n", - @{$att{DIR}})); - push @m, "\t".'$(RM_RF) `cat $(INSTALLARCHLIB)/auto/$(FULLEXT)/.packlist` -'; - - join("",@m); -} +Same as below, but for architecture dependent files. -sub force { - '# Phony target to force checking subdirectories. -FORCE: -'; -} +=item PERL_LIB +Directory containing the Perl library to use. -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 $(PERL_INC)/config.h - -'); - - push @m, ' -$(OBJECT) : $(PERL_HDRS) -' if $att{OBJECT}; - - push(@m,' -# Check for unpropogated config.sh changes. Should never happen. -# We do NOT just update config.h because that is not sufficient. -# An out of date config.h is not fatal but complains loudly! -$(PERL_INC)/config.h: $(PERL_SRC)/config.sh - -@echo "Warning: $(PERL_INC)/config.h out of date with $(PERL_SRC)/config.sh"; false - -$(PERL_ARCHLIB)/Config.pm: $(PERL_SRC)/config.sh - @echo "Warning: $(PERL_ARCHLIB)/Config.pm may be out of date with $(PERL_SRC)/config.sh" - cd $(PERL_SRC) && $(MAKE) lib/Config.pm -') if $att{PERL_SRC}; - - push(@m, join(" ", values %{$att{XS}})." : \$(XSUBPPDEPS)\n") - if %{$att{XS}}; - join("\n",@m); -} +=item PERL_MALLOC_OK +defaults to 0. Should be set to TRUE if the extension can work with +the memory allocation routines substituted by the Perl malloc() subsystem. +This should be applicable to most extensions with exceptions of those -sub makefile { - my @m; - # We do not know what target was originally specified so we - # must force a manual rerun to be sure. But as it should only - # happen very rarely it is not a significant problem. - push @m, ' -$(OBJECT) : '.$att{MAKEFILE}.' - -# We take a very conservative approach here, but it\'s worth it. -# We move Makefile to Makefile.old here to avoid gnu make looping. -'.$att{MAKEFILE}.' : Makefile.PL $(CONFIGDEP) - @echo "Makefile out-of-date with respect to $?" - @echo "Cleaning current config before rebuilding Makefile..." - -@mv '."$att{MAKEFILE} $att{MAKEFILE}.old".' - -$(MAKE) -f '.$att{MAKEFILE}.'.old clean >/dev/null 2>&1 || true - $(PERL) "-I$(PERL_ARCHLIB)" "-I$(PERL_LIB)" Makefile.PL '."@ARGV".' - @echo "Now you must rerun make."; false -'; - - join "", @m; -} +=over 4 -sub postamble{ - ""; -} +=item * -# --- Make-Directories section (internal method) --- -# dir_target(@array) returns a Makefile entry for the file .exists in each -# named directory. Returns nothing, if the entry has already been processed. -# We're helpless though, if the same directory comes as $(FOO) _and_ as "bar". -# Both of them get an entry, that's why we use "::". I chose '$(PERL)' as the -# prerequisite, because there has to be one, something that doesn't change -# too often :) -%Dir_Target = (); # package global - -sub dir_target { - my($self,@dirs) = @_; - my(@m,$dir); - foreach $dir (@dirs) { - next if $Dir_Target{$dir}; - push @m, " -$dir/.exists :: \$(PERL) - \@ \$(MKPATH) $dir - \@ \$(TOUCH) $dir/.exists -"; - $Dir_Target{$dir}++; - } - join "", @m; -} +with bugs in memory allocations which are caught by Perl's malloc(); -# --- Make-A-Perl section --- - -sub staticmake { - my($self, %attribs) = @_; - - my(%searchdirs)=($att{PERL_ARCHLIB} => 1, $att{INST_ARCHLIB} => 1); - my(@searchdirs)=keys %searchdirs; - # And as it's not yet built, we add the current extension - my(@static)="$att{INST_ARCHLIB}/auto/$att{FULLEXT}/$att{BASEEXT}.a"; - my(@perlinc) = ($att{INST_ARCHLIB}, $att{INST_LIB}, $att{PERL_ARCHLIB}, $att{PERL_LIB}); - MY->makeaperl('MAKE' => $att{MAKEFILE}, - 'DIRS' => \@searchdirs, - 'STAT' => \@static, - 'INCL' => \@perlinc, - 'TARGET' => $att{MAP_TARGET}, - 'TMP' => "", - 'LIBPERL' => $att{LIBPERL_A} - ); -} +=item * -sub makeaperl { - my($self, %attribs) = @_; - my($makefilename, $searchdirs, $static, $extra, $perlinc, $target, $tmp, $libperl) = - @attribs{qw(MAKE DIRS STAT EXTRA INCL TARGET TMP LIBPERL)}; - my(@m); - my($cccmd, $linkcmd); - - # This emulates cflags to get the compiler invocation... - $cccmd = MY->const_cccmd($libperl); - $cccmd =~ s/^CCCMD\s*=\s*//; - chomp $cccmd; - $cccmd =~ s/\s/ -I$att{PERL_INC} /; - $cccmd .= " $Config{'cccdlflags'}" if ($Config{'d_shrplib'}); - - # The front matter of the linkcommand... - $linkcmd = join ' ', "\$(CC)", - grep($_, @Config{qw(large split ldflags ccdlflags)}); - $linkcmd =~ s/\s+/ /g; - - # Which *.a files could we make use of... - local(%static); - File::Find::find(sub { - return unless m/\.a$/; - return if m/^libperl/; - # don't include the installed version of this extension - return if $File::Find::name =~ m:auto/$att{FULLEXT}/$att{BASEEXT}.a$:; - $static{fastcwd() . "/" . $_}++; - }, grep( -d $_, @{$searchdirs || []}) ); - - # We trust that what has been handed in as argument, will be buildable - $static = [] unless $static; - @static{@{$static}} = (1) x @{$static}; - - $extra = [] unless $extra && ref $extra eq 'ARRAY'; - for (sort keys %static) { - next unless /\.a$/; - $_ = dirname($_) . "/extralibs.ld"; - push @$extra, $_; - } +which interact with the memory allocator in other ways than via +malloc(), realloc(), free(), calloc(), sbrk() and brk(); - grep(s/^/-I/, @$perlinc); - - $target = "perl" unless $target; - $tmp = "." unless $tmp; - - push @m, " -# --- MakeMaker makeaperl section --- -MAP_TARGET = $target -FULLPERL = $att{'FULLPERL'} -MAP_LINKCMD = $linkcmd -MAP_PERLINC = @{$perlinc} -MAP_STATIC = ", -join(" ", sort keys %static), " -MAP_PRELIBS = $Config{'libs'} $Config{'cryptlib'} -"; - - unless ($libperl && -f $libperl) { - my $dir = $att{PERL_SRC} || "$att{PERL_ARCHLIB}/CORE"; - $libperl ||= "libperl.a"; - $libperl = "$dir/$libperl"; - print STDOUT "Warning: $libperl not found" - unless (-f $libperl || defined($att{PERL_SRC})); - } +=item * - push @m, " -MAP_LIBPERL = $libperl -"; +which rely on special alignment which is not provided by Perl's malloc(). - push @m, " -extralibs.ld: @$extra - \@ $att{RM_F} \$\@ - \@ \$(TOUCH) \$\@ -"; +=back - foreach (@$extra){ - push @m, "\tcat $_ >> \$\@\n"; - } +B Negligence to set this flag in I of loaded extension +nullifies many advantages of Perl's malloc(), such as better usage of +system resources, error detection, memory usage reporting, catchable failure +of memory allocations, etc. - push @m, " -\$(MAP_TARGET): $tmp/perlmain.o \$(MAP_LIBPERL) \$(MAP_STATIC) extralibs.ld - \$(MAP_LINKCMD) -o \$\@ $tmp/perlmain.o \$(MAP_LIBPERL) \$(MAP_STATIC) `cat extralibs.ld` \$(MAP_PRELIBS) - @ echo 'To install the new \"\$(MAP_TARGET)\" binary, call' - @ echo ' make -f $makefilename inst_perl MAP_TARGET=\$(MAP_TARGET)' - @ echo 'To remove the intermediate files say' - @ echo ' make -f $makefilename map_clean' - -$tmp/perlmain.o: $tmp/perlmain.c -"; - push @m, "\tcd $tmp && $cccmd perlmain.c\n"; - - push @m, qq{ -$tmp/perlmain.c: $makefilename}, q{ - @ echo Writing $@ - @ $(FULLPERL) $(MAP_PERLINC) -e 'use ExtUtils::Miniperl; \\ - writemain(grep s#.*/auto/##, qw|$(MAP_STATIC)|)' > $@.tmp && mv $@.tmp $@ - -}; - -# We write EXTRA outside the perl program to have it eval'd by the shell - push @m, q{ -doc_inst_perl: - @ echo Appending installation info to $(INSTALLARCHLIB)/perllocal.pod - @ $(FULLPERL) -e 'use ExtUtils::MakeMaker; MM->writedoc("Perl binary",' \\ - -e '"$(MAP_TARGET)", "MAP_STATIC=$(MAP_STATIC)",' \\ - -e '"MAP_EXTRA=@ARGV", "MAP_LIBPERL=$(MAP_LIBPERL)")' \\ - -- `cat extralibs.ld` >> $(INSTALLARCHLIB)/perllocal.pod -}; - - push @m, qq{ -inst_perl: pure_inst_perl doc_inst_perl - -pure_inst_perl: \$(MAP_TARGET) - $att{CP} \$(MAP_TARGET) \$(INSTALLBIN)/\$(MAP_TARGET) - -realclean :: map_clean - -map_clean : - $att{RM_F} $tmp/perlmain.o $tmp/perlmain.c $makefilename extralibs.ld -}; - - join '', @m; -} +=item PERL_SRC -sub extliblist { - my($self,$libs) = @_; - require ExtUtils::Liblist; - ExtUtils::Liblist::ext($libs, $Verbose); -} +Directory containing the Perl source code (use of this should be +avoided, it may be undefined) -sub mksymlists { - my($self) = shift; - my($pkg); +=item PERM_RW - # only AIX requires a symbol list at this point - # (so does VMS, but that's handled by the MM_VMS package) - return '' unless $Config{'osname'} eq 'aix'; +Desired permission for read/writable files. Defaults to C<644>. +See also L. - init_main(@ARGV) unless defined $att{'BASEEXT'}; - if (! $att{DL_FUNCS}) { - my($bootfunc); - ($bootfunc = $att{NAME}) =~ s/\W/_/g; - $att{DL_FUNCS} = {$att{BASEEXT} => ["boot_$bootfunc"]}; - } - rename "$att{BASEEXT}.exp", "$att{BASEEXT}.exp_old"; - - open(EXP,">$att{BASEEXT}.exp") or die $!; - print EXP join("\n",@{$att{DL_VARS}}) if $att{DL_VARS}; - foreach $pkg (keys %{$att{DL_FUNCS}}) { - (my($prefix) = $pkg) =~ s/\W/_/g; - my $func; - foreach $func (@{$att{DL_FUNCS}->{$pkg}}) { - $func = "XS_${prefix}_$func" unless $func =~ /^boot_/; - print EXP "$func\n"; - } - } - close EXP; -} +=item PERM_RWX -# --- Output postprocessing section --- -#nicetext is included to make VMS support easier -sub nicetext { # Just return the input - no action needed - my($self,$text) = @_; - $text; -} +Desired permission for executable files. Defaults to C<755>. +See also L. -# --- perllocal.pod section --- -sub writedoc { - my($self,$what,$name,@attribs)=@_; -# the following would have to move to a ExtUtils::Perllocal.pm, if we want it -# it's dangerous wrt AFS, and it's against the philosophy that MakeMaker -# should never write to files. We write to stdout and append to the file -# during make install, but we cannot rely on '-f $Config{"installarchlib"}, -# as there is a time window between the WriteMakefile and the make. -# -w $Config{'installarchlib'} or die "No write permission to $Config{'installarchlib'}"; -# my($localpod) = "$Config{'installarchlib'}/perllocal.pod"; - my($time); -# if (-f $localpod) { -# print "Appending installation info to $localpod\n"; -# open POD, ">>$localpod" or die "Couldn't open $localpod"; -# } else { -# print "Writing new file $localpod\n"; -# open POD, ">$localpod" or die "Couldn't open $localpod"; -# print POD "=head1 NAME -# -#perllocal - locally installed modules and perl binaries -#\n=head1 HISTORY OF LOCAL INSTALLATIONS -# -#"; -# } - require "ctime.pl"; - chop($time = ctime(time)); - print "=head2 $time: $what C<$name>\n\n=over 4\n\n=item *\n\n"; - print join "\n\n=item *\n\n", map("C<$_>",@attribs); - print "\n\n=back\n\n"; -# close POD; -} +=item PL_FILES +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'} -# the following keeps AutoSplit happy -package ExtUtils::MakeMaker; -1; +The *.PL files are expected to produce output to the target files +themselves. If multiple files can be generated from the same *.PL +file then the value in the hash can be a reference to an array of +target file names. E.g. -__END__ + {'foobar.PL' => ['foobar1','foobar2']} -=head1 NAME +=item PM -ExtUtils::MakeMaker - create an extension Makefile +Hashref of .pm files and *.pl files to be installed. e.g. -=head1 SYNOPSIS + {'name_of_file.pm' => '$(INST_LIBDIR)/install_as.pm'} -C +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. -C VALUE [, ...] );> +=item PMLIBDIRS -=head1 DESCRIPTION +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. -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. +(Where BASEEXT is the last component of NAME.) -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. +=item POLLUTE -MakeMaker.pm uses the architecture specific information from -Config.pm. In addition the extension may contribute to the C<%Config> -hash table of Config.pm by supplying 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. If there is no -hintsfile for the actual system, but for some previous releases of the -same operating system, the latest one of those is used. +Release 5.005 grandfathered old global symbol names by providing preprocessor +macros for extension source compatibility. As of release 5.6, these +preprocessor definitions are not available by default. The POLLUTE flag +specifies that the old names should still be defined: -=head2 Default Makefile Behaviour + perl Makefile.PL POLLUTE=1 -The automatically generated Makefile enables the user of the extension -to invoke +Please inform the module author if this is necessary to successfully install +a module under 5.6 or later. - perl Makefile.PL # optionally "perl Makefile.PL verbose" - make - make test # optionally set TEST_VERBOSE=1 - make install # See below +=item PPM_INSTALL_EXEC -The Makefile to be produced may be altered by adding arguments of the -form C. If the user wants to work with a different perl -than the default, this is achieved by specifying +Name of the executable used to run C below. (e.g. perl) - perl Makefile.PL PERL=/tmp/myperl5 +=item PPM_INSTALL_SCRIPT -Other interesting targets in the generated Makefile are +Name of the script that gets executed by the Perl Package Manager after +the installation of a package. - make config # to check if the Makefile is up-to-date - make clean # delete local temporary files (Makefile gets renamed) - make realclean # delete all derived files (including installed files) - make dist # see below the Distribution Support section +=item PREFIX -=head2 Special case C +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). -C alone puts all relevant files into directories that are named -by the macros INST_LIB, INST_ARCHLIB, and INST_EXE. All three default -to ./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_EXE is not defined. +=item PREREQ_PM -The I target of the generated Makefile is a recursive call to -make which sets +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. - INST_LIB to INSTALLPRIVLIB - INST_ARCHLIB to INSTALLARCHLIB - INST_EXE to INSTALLBIN +=item SKIP -The three INSTALL... macros in turn default to -$Config{installprivlib}, $Config{installarchlib}, and -$Config{installbin} respectively. +Arryref. E.g. [qw(name1 name2)] skip (do not write) sections of the +Makefile. Caution! Do not use the SKIP attribute for the negligible +speedup. It may seriously damage the resulting Makefile. Only use it +if you really need it. -The recommended way to proceed is to set only the INSTALL* macros, not -the INST_* targets. In doing so, you give room to the compilation -process without affecting important directories. Usually a 'make test' -will succeed after the make, and a 'make install' can finish the game. +=item TYPEMAPS -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. - -The usual relationship between INSTALLPRIVLIB and INSTALLARCHLIB is -that the latter is a subdirectory of the former with the name -C<$Config{'archname'}>, MakeMaker supports the user who sets -INSTALLPRIVLIB. If INSTALLPRIVLIB is set, but INSTALLARCHLIB not, then -MakeMaker defaults the latter to be INSTALLPRIVLIB/ARCHNAME if that -directory exists, otherwise it defaults to INSTALLPRIVLIB. - -Previous versions of MakeMaker suggested to use the INST_* macros. For -backwards compatibility, these are still supported but deprecated in -favor of the INSTALL* macros. - -Here is the description, what they are used for: If the user specifies -the final destination for the INST_... macros, then there is no need -to call 'make install', because 'make' will already put all files in -place. - -If there is a need to first build everything in the C<./blib> -directory and test the product, then it's appropriate to use the -INSTALL... macros. So the users have the choice to either say - - # case: trust the module - perl Makefile.PL INST_LIB=~/perllib INST_EXE=~/bin - make - make test +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. -or +=item VERSION - perl Makefile.PL INSTALLPRIVLIB=~/foo \ - INSTALLARCHLIB=~/foo/bar INSTALLBIN=~/bin - make - make test - make install +Your version number for distributing the package. This defaults to +0.1. -Note, that the tilde expansion is done by MakeMaker, not by perl by -default, nor by make. So be careful to use the tilde only with the -C call. +=item VERSION_FROM -It is important to know, that the INSTALL* macros should be absolute -paths, never relativ ones. Packages with multiple Makefile.PLs in -different directories get the contents of the INSTALL* macros -propagated verbatim. (The INST_* macros will be corrected, if they are -relativ paths, but not the INSTALL* macros.) +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 -If the user has superuser privileges, and is not working on AFS -(Andrew File System) or relatives, then the defaults for -INSTALLPRIVLIB, INSTALLARCHLIB, and INSTALLBIN will be appropriate, -and this incantation will be the best: + /([\$*])(([\w\:\']*)\bVERSION)\b.*\=/ - perl Makefile.PL; make; make test - make install +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.: -(I is not necessarily supported for all modules.) + $VERSION = '1.00'; + *VERSION = \'1.01'; + ( $VERSION ) = '$Revision: 1.222 $ ' =~ /\$Revision:\s+([^\s]+)/; + $FOO::VERSION = '1.10'; + *FOO::VERSION = \'1.11'; + our $VERSION = 1.2.3; # new for perl5.6.0 -C per default writes some documentation of what has been -done into the file C<$Config{'installarchlib'}/perllocal.pod>. This is -an experimental feature. It can be bypassed by calling C. +but these will fail: -=head2 Support to Link a new Perl Binary (eg dynamic loading not available) + my $VERSION = '1.01'; + local $VERSION = '1.02'; + local $FOO::VERSION = '1.30'; -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 +(Putting C or C on the preceding line will work o.k.) - make perl +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 -That produces a new perl binary in the current directory with all -extensions linked in that can be found in INST_ARCHLIB (usually -C<./blib>) and PERL_ARCHLIB. + depend => { Makefile => '$(VERSION_FROM)' } -The binary can be installed into the directory where perl normally -resides on your machine with +See attribute C below. - make inst_perl +=item XS -To produce a perl binary with a different name than C, either say +Hashref of .xs files. MakeMaker will default this. e.g. - perl Makefile.PL MAP_TARGET=myperl - make myperl - make inst_perl + {'name_of_file.xs' => 'name_of_file.c'} -or say +The .c files will automatically be included in the list of files +deleted by a make clean. - perl Makefile.PL - make myperl MAP_TARGET=myperl - make inst_perl MAP_TARGET=myperl +=item XSOPT -In any case you will be prompted with the correct invocation of the -C target that installs the new binary into INSTALLBIN. +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. -Note, that there is a C scipt in the perl distribution, -that supports the linking of a new perl binary in a similar fashion, -but with more options. +=item XSPROTOARG -C per default writes some documentation of what has been -done into the file C<$Config{'installarchlib'}/perllocal.pod>. This -can be bypassed by calling C. +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. -Warning: the inst_perl: target is rather mighty and will probably -overwrite your existing perl binary. Use with care! +=item XS_VERSION -=head2 Determination of Perl Library and Installation Locations +Your version number for the .xs file of this package. This defaults +to the value of the VERSION attribute. -MakeMaker needs to know, or to guess, where certain things are -located. Especially INST_LIB and INST_ARCHLIB (where to install files -into), PERL_LIB and PERL_ARCHLIB (where to read existing modules -from), and PERL_INC (header files and C). +=back -Extensions may be built either using the contents of the perl source -directory tree or from an installed copy of the perl library. +=head2 Additional lowercase attributes -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 then other variables default to the following: +can be used to pass parameters to the methods which implement that +part of the Makefile. - PERL_INC = PERL_SRC - PERL_LIB = PERL_SRC/lib - PERL_ARCHLIB = PERL_SRC/lib - INST_LIB = PERL_LIB - INST_ARCHLIB = PERL_ARCHLIB +=over 2 -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: +=item clean - PERL_INC = $archlib/CORE - PERL_LIB = $privlib - PERL_ARCHLIB = $archlib - INST_LIB = ./blib - INST_ARCHLIB = ./blib + {FILES => "*.xyz foo"} -If perl has not yet been installed then PERL_SRC can be defined on the -command line as shown in the previous section. +=item depend -=head2 Useful Default Makefile Macros + {ANY_TARGET => ANY_DEPENDECY, ...} -FULLEXT = Pathname for extension directory (eg DBD/Oracle). +(ANY_TARGET must not be given a double-colon rule by MakeMaker.) -BASEEXT = Basename part of FULLEXT. May be just equal FULLEXT. +=item dist -ROOTEXT = Directory part of FULLEXT with leading slash (eg /DBD) + {TARFLAGS => 'cvfF', COMPRESS => 'gzip', SUFFIX => '.gz', + SHAR => 'shar -m', DIST_CP => 'ln', ZIP => '/bin/zip', + ZIPFLAGS => '-rl', DIST_DEFAULT => 'private tardist' } -PERL_LIB = Directory where we read the perl library files +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'. -PERL_ARCHLIB = Same as above for architecture dependent files +=item dynamic_lib -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. + {ARMAYBE => 'ar', OTHERLDFLAGS => '...', INST_DYNAMIC_DEP => '...'} -INST_ARCHLIB = Same as above for architecture dependent files +=item linkext -INST_LIBDIR = C<$(INST_LIB)$(ROOTEXT)> + {LINKTYPE => 'static', 'dynamic' or ''} -INST_AUTODIR = C<$(INST_LIB)/auto/$(FULLEXT)> +NB: Extensions that have nothing but *.pm files had to say -INST_ARCHAUTODIR = C<$(INST_ARCHLIB)/auto/$(FULLEXT)> + {LINKTYPE => ''} -=head2 Customizing The Generated Makefile +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. -If the Makefile generated does not fit your purpose you can change it -using the mechanisms described below. +=item macro -=head2 Using Attributes (and Parameters) + {ANY_MACRO => ANY_VALUE, ...} -The following attributes can be specified as arguments to WriteMakefile() -or as NAME=VALUE pairs on the command line: +=item realclean -This description is not yet documented; you can get at the description -with one of the commands + {FILES => '$(INST_ARCHAUTODIR)/*.xyz'} -=over 4 +=item test -=item C -(if you already have a basic Makefile.PL) + {TESTS => 't/*.t'} -=item C -(if you already have a Makefile) +=item tool_autosplit -=item C -(if you have neither nor) + {MAXLEN => 8} =back @@ -2504,11 +1875,52 @@ either say: or you can edit the default by saying something like: - sub MY::c_o { $_=MM->c_o; s/old text/new text/; $_ } + sub MY::c_o { + package MY; # so that "SUPER" works right + my $inherited = shift->SUPER::c_o(@_); + $inherited =~ s/old text/new text/; + $inherited; + } + +If you are running experiments with embedding perl as a library into +other applications, you might find MakeMaker is 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. +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 + '; + } + + +=head2 Hintsfile support + +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. + +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 + + $self->{LIBS} = ['-ldbm -lucb -lc']; =head2 Distribution Support @@ -2519,289 +1931,139 @@ where additional documentation can be found. =over 4 =item make distcheck + reports which files are below the build directory but not in the MANIFEST file and vice versa. (See ExtUtils::Manifest::fullcheck() for details) +=item make skipcheck + +reports which files are skipped due to the entries in the +C file (See ExtUtils::Manifest::skipcheck() for +details) + =item make distclean + 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 +needed to build a new distribution as long as you are sure that the MANIFEST file is ok. =item make manifest + rewrites the MANIFEST file, adding all remaining files found (See ExtUtils::Manifest::mkmanifest() for details) =item make distdir + 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. +=item make disttest + +Makes a distdir first, and runs a C, a make, and +a make test in that directory. + =item make tardist -First does a command $(PREOP) which defaults to a null command. Does a -distdir next and runs C on that directory into a tarfile. Then -deletes the distdir. Finishes with a command $(POSTOP) which defaults -to a null command. + +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. =item make dist + Defaults to $(DIST_DEFAULT) which in turn defaults to tardist. =item make uutardist + Runs a tardist first and uuencodes the tarfile. =item make shdist -First does a command $(PREOP) which defaults to a null command. Does a -distdir next and runs C on that directory into a sharfile. Then -deletes the distdir. 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. + +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) (defaults to C) and a $(RCS) (C) on all files in the MANIFEST file + +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 ('gzip --best') + POSTOP ('@ :') + PREOP ('@ :') + TO_UNIX (depends on the system) + RCS_LABEL ('rcs -q -Nv$(VERSION_SYM):') + SHAR ('shar') + SUFFIX ('.gz') TAR ('tar') TARFLAGS ('cvf') - COMPRESS ('compress') - SUFFIX ('Z') - SHAR ('shar') - PREOP ('@ :') - POSTOP ('@ :') + ZIP ('zip') + ZIPFLAGS ('-r') An example: - WriteMakefile( 'dist' => { COMPRESS=>"gzip", SUFFIX=>"gz" }) + WriteMakefile( 'dist' => { COMPRESS=>"bzip2", SUFFIX=>".bz2" }) -=back - -=head1 AUTHORS - -Andy Dougherty Fdoughera@lafcol.lafayette.eduE>, Andreas -Koenig Fk@franz.ww.TU-Berlin.DEE>, Tim Bunce -FTim.Bunce@ig.co.ukE>. VMS support by Charles Bailey -Fbailey@HMIVAX.HUMGEN.UPENN.EDUE>. Contact the makemaker -mailing list L, if you have any -questions. - -=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. -v3.7 December 30th 1994 By Tim Bunce -v3.8 January 17th 1995 By Andreas Koenig and Tim Bunce -v3.9 January 19th 1995 By Tim Bunce -v3.10 January 23rd 1995 By Tim Bunce -v3.11 January 24th 1995 By Andreas Koenig -v4.00 January 24th 1995 By Tim Bunce -v4.01 January 25th 1995 By Tim Bunce -v4.02 January 29th 1995 By Andreas Koenig -v4.03 January 30th 1995 By Andreas Koenig -v4.04 Februeary 5th 1995 By Andreas Koenig -v4.05 February 8th 1995 By Andreas Koenig -v4.06 February 10th 1995 By Andreas Koenig -v4.061 February 12th 1995 By Andreas Koenig -v4.08 - 4.085 February 14th-21st 1995 by Andreas Koenig -v4.086 March 9 1995 by Andy Dougherty -v4.09 March 31 1995 by Andreas Koenig -v4.091 April 3 1995 by Andy Dougherty -v4.092 April 11 1995 by Andreas Koenig -v4.093 April 12 1995 by Andy Dougherty -v4.094 April 12 1995 by Andy Dougherty - -v4.100 May 10 1995 by Andreas Koenig - -Broken out Mkbootstrap to make the file smaller and easier to manage, -and to speed up the build process. - -Added ExtUtils::Manifest as an extra module that is used to streamline -distributions. (See pod section I). - -Added a VERSION_SYM macro, that is derived from VERSION but all C<\W> -characters replaced by an underscore. - -Moved the whole documentation below __END__ for easier maintanance. - -linkext =E { LINKTYPE =E '' } should work now as expected. - -Rechecked the use of INST_LIB, INST_ARCHLIB, and INST_EXE from the -perspective of an AFS user (thanks to Rudolph T Maceyko for the -hint). With full backward compatiblity it is now possible, to set -INSTALLPRIVLIB, INSTALLARCHLIB, and INSTALLBIN either with 'perl -Makefile.PL' or with 'make install'. A bare 'make' ignores these -settings. The effect of this change is that it is no longer -recommended to set the INST_* attributes directly, although it doesn't -hurt, if they do so. The PASTHRU variables (now PASTHRU1 and PASTHRU2) -are fully aware of their duty: the INST_* attributes are only -propagated to runsubdirpl, not to 'cd subdir && make config' and 'cd -subdir && make all'. - -Included Tim's "Unable to locate Perl library" patch. - -Eliminated any excess of spaces in the $old/$new comparison in -const_cccmd(). - -Added a prompt function with usage $answer = prompt $message, $default. - -Included Tim's patch that searches for perl5 and perl$] as well as -perl and miniperl. - -Added .NO_PARALLEL for the time until I have a multiple cpu machine -myself :) - -Introduced a macro() subroutine. WriteMakefile("macro" =E { FOO -=E BAR }) defines the macro FOO = BAR in the generated Makefile. - -Rolled in Tim's patch for needs_linking. - -writedoc now tries to be less clever. It was trying to determine, if a -perllocal.pod had to be created or appended to. As we have now the -possibility, that INSTALLARCHLIB is determined at make's runtime, we -cannot do this anymore. We append to that file in any case. - -Added Kenneth's pod installation patch. - -v4.110 May 19 1995 by Andreas Koenig - -=head1 NEW in 4.11 - -MANIFEST.SKIP now contains only regular expressions. RCS directories -are no longer skipped by default, as this may be configured in the -SKIP file. - -The manifest target now does no realclean anymore. - -I_PERL_LIBS depreciated (no longer used). (unless you speak up, of -course) - -I could not justify that we rebuild the Makefile when MakeMaker has -changed (as Kenneth suggested). If this is really a strong desire, -please convince me. But a minor change of the MakeMaker should not -trigger a 60 minutes rebuild of Tk, IMO. - -Broken out extliblist into the new module ExtUtils::Liblist. Should -help extension writers for their own Configure scripts. The breaking -into pieces should be done now, I suppose. - -Added an (experimenta!!) uninstall target that works with a -packlist. AutoSplit files are not yet in the packlist. This needs a -patch to AutoSplit, doesn't it? The packlist file is installed in -INST_ARCHAUTODIR/.packlist. It doesn't have means to decide, if a file -is architecture dependent or not, we just collect as much as we can -get. make -n recommended before actually executing. (I leave this -target undocumented in the pod section). Suggestions welcome! - -Added basic chmod support. Nothing spectacular. *.so and *.a files get -permission 755, because I seem to recall, that some systems need -execute permissions in some weird constellations. The rest becomes -644. What else do we need to make this flexible? +=head2 Disabling an extension -Then I took Tim's word serious: no bloat. No turning all packages into -perl scripts. Leaving shar, tar, uu be what they are... Sorry, -Kenneth, we still have to convince Larry that a growing MakeMaker -makes sense :) +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 -Added an extra check whenever they install below the perl source tree: -is this extension a standard extension? If it is, everything behaves -as we are used to. If it is not, the three INST_ macros are set to -./blib, and they get a warning that this extension has to be -installed manually with 'make install'. + ExtUtils::MakeMaker::WriteEmptyMakefile(); -Added a warning for targets that have a colon or a hashmark within -their names, because most make(1)s will not be able to process them. +instead of WriteMakefile(). -Applied Hallvard's patch to ~user evaluation for cases where user does -not exist. +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). -Added a ci target that checks in all files from the MANIFEST into rcs. +=head1 ENVIRONMENT -=head1 new in 4.12/4.13 +=over 8 -"Please notify perl5-porters" message is now accompanied by -Config::myconfig(). +=item PERL_MM_OPT -(Manifest.pm) Change delimiter for the evaluation of the regexes from -MANIFEST.SKIP to from "!" to "/". I had overlooked the fact, that ! no -has a meaning in regular expressions. +Command line options used by Cnew()>, and thus by +C. The string is split on whitespace, and the result +is processed before any actual command line arguments are processed. -Disabled the new logic that prevents non-standard extensions from -writing to PERL_SRC/lib to give Andy room for 5.001f. - -Added a Version_check target that calls MakeMaker for a simple Version -control function on every invocation of 'make' in the future. Doesn't -have an effect currently. - -Target dist is still defaulting to tardist, but the level of -indirection has changed. The Makefile macro DIST_DEFAULT takes it's -place. This allows me to make dist dependent from whatever I intend as -my standard distribution. - -Made sure that INST_EXE is created for extensions that need it. - -4.13 is just a cleanup/documentation patch. And it adds a MakeMaker FAQ :) - -=head v4.14 June 5, 1995, by Andreas Koenig - -Reintroduces the LD_RUN_PATH macro. LD_RUN_PATH is passed as an -environment variable to the ld run. It is needed on Sun OS, and does -no harm on other systems. It is a colon seperated list of the -directories in LDLOADLIBS. - -=head v4.15 June 6, 1995, by Andreas Koenig - -Add -I$(PERL_ARCHLIB) -I$(PERL_LIB) to calls to xsubpp. - -=head1 TODO - -Needs more complete documentation. - -Add a C target when there has been found a general solution to -installing html files. - -Add a FLAVOR variable that makes it easier to build debugging, -embedded or multiplicity perls. Currently the easiest way to produce a -debugging perl seems to be (after haveing built perl): - make clobber - ./Configure -D"archname=IP22-irix-d" -des - make perllib=libperld.a - make test perllib=libperld.a - mv /usr/local/bin/perl /usr/local/bin/perl/O_perl5.001e - make install perllib=libperld.a - cp /usr/local/bin/perl/O_perl5.001e /usr/local/bin/perl -It would be nice, if the Configure step could be dropped. Also nice, but -maybe expensive, if 'make clobber' wouldn't be needed. - -The uninstall target has to be completed, it's just a sketch. - -Reconsider Makefile macros. The output of macro() should be the last -before PASTHRU and none should come after that -- tough work. +=back -Think about Nick's desire, that the pTk subdirectory needs a special -treatment. +=head1 SEE ALSO -Find a way to have multiple MYEXTLIB archive files combined into -one. Actually I need some scenario, where this problem can be -illustrated. I currently don't see the problem. +ExtUtils::MM_Unix, ExtUtils::Manifest, ExtUtils::testlib, +ExtUtils::Install, ExtUtils::Embed -Test if .NOPARALLEL can be omitted. +=head1 AUTHORS -Don't let extensions write to PERL_SRC/lib anymore, build perl from -the extensions found below ext, run 'make test' and 'make install' on -each extension (giving room for letting them fail). Move some of the -tests from t/lib/* to the libraries. +Andy Dougherty >, Andreas KEnig +>, Tim Bunce >. VMS +support by Charles Bailey >. OS/2 support +by Ilya Zakharevich >. -Streamline the production of a new perl binary on systems that DO have -dynamic loading (especially make test needs further support, as test -most probably needs the new binary). +Send patches and bug reports to >. =cut