1 package ExtUtils::MM_Any;
4 use vars qw($VERSION @ISA);
9 BEGIN { @ISA = qw(File::Spec); }
12 use ExtUtils::MakeMaker qw($Verbose);
14 use ExtUtils::MakeMaker::Config;
17 # So we don't have to keep calling the methods over and over again,
18 # we have these globals to cache the values. Faster and shrtr.
19 my $Curdir = __PACKAGE__->curdir;
20 my $Rootdir = __PACKAGE__->rootdir;
21 my $Updir = __PACKAGE__->updir;
26 ExtUtils::MM_Any - Platform-agnostic MM methods
30 FOR INTERNAL USE ONLY!
32 package ExtUtils::MM_SomeOS;
34 # Temporarily, you have to subclass both. Put MM_Any first.
35 require ExtUtils::MM_Any;
36 require ExtUtils::MM_Unix;
37 @ISA = qw(ExtUtils::MM_Any ExtUtils::Unix);
41 B<FOR INTERNAL USE ONLY!>
43 ExtUtils::MM_Any is a superclass for the ExtUtils::MM_* set of
44 modules. It contains methods which are either inherently
45 cross-platform or are written in a cross-platform manner.
47 Subclass off of ExtUtils::MM_Any I<and> ExtUtils::MM_Unix. This is a
50 B<THIS MAY BE TEMPORARY!>
55 Any methods marked I<Abstract> must be implemented by subclasses.
58 =head2 Cross-platform helper methods
60 These are methods which help writing cross-platform code.
64 =head3 os_flavor I<Abstract>
66 my @os_flavor = $mm->os_flavor;
68 @os_flavor is the style of operating system this is, usually
69 corresponding to the MM_*.pm file we're using.
71 The first element of @os_flavor is the major family (ie. Unix,
72 Windows, VMS, OS/2, etc...) and the rest are sub families.
76 Cygwin98 ('Unix', 'Cygwin', 'Cygwin9x')
77 Windows NT ('Win32', 'WinNT')
78 Win98 ('Win32', 'Win9x')
79 Linux ('Unix', 'Linux')
80 MacOS X ('Unix', 'Darwin', 'MacOS', 'MacOS X')
83 This is used to write code for styles of operating system.
84 See os_flavor_is() for use.
89 my $is_this_flavor = $mm->os_flavor_is($this_flavor);
90 my $is_this_flavor = $mm->os_flavor_is(@one_of_these_flavors);
92 Checks to see if the current operating system is one of the given flavors.
94 This is useful for code like:
96 if( $mm->os_flavor_is('Unix') ) {
107 my %flavors = map { ($_ => 1) } $self->os_flavor;
108 return (grep { $flavors{$_} } @_) ? 1 : 0;
114 my @cmds = $MM->split_command($cmd, @args);
116 Most OS have a maximum command length they can execute at once. Large
117 modules can easily generate commands well past that limit. Its
118 necessary to split long commands up into a series of shorter commands.
120 C<split_command> will return a series of @cmds each processing part of
121 the args. Collectively they will process all the arguments. Each
122 individual line in @cmds will not be longer than the
123 $self->max_exec_len being careful to take into account macro expansion.
125 $cmd should include any switches and repeated initial arguments.
127 If no @args are given, no @cmds will be returned.
129 Pairs of arguments will always be preserved in a single command, this
130 is a heuristic for things like pm_to_blib and pod2man which work on
131 pairs of arguments. This makes things like this safe:
133 $self->split_command($cmd, %pod2man);
139 my($self, $cmd, @args) = @_;
142 return(@cmds) unless @args;
144 # If the command was given as a here-doc, there's probably a trailing
148 # set aside 20% for macro expansion.
149 my $len_left = int($self->max_exec_len * 0.80);
150 $len_left -= length $self->_expand_macros($cmd);
155 while( @next_args = splice(@args, 0, 2) ) {
156 # Two at a time to preserve pairs.
157 my $next_arg_str = "\t ". join ' ', @next_args, "\n";
159 if( !length $arg_str ) {
160 $arg_str .= $next_arg_str
162 elsif( length($arg_str) + length($next_arg_str) > $len_left ) {
163 unshift @args, @next_args;
167 $arg_str .= $next_arg_str;
172 push @cmds, $self->escape_newlines("$cmd \n$arg_str");
180 my($self, $cmd) = @_;
182 $cmd =~ s{\$\((\w+)\)}{
183 defined $self->{$1} ? $self->{$1} : "\$($1)"
191 my @commands = $MM->echo($text);
192 my @commands = $MM->echo($text, $file);
193 my @commands = $MM->echo($text, $file, $appending);
195 Generates a set of @commands which print the $text to a $file.
197 If $file is not given, output goes to STDOUT.
199 If $appending is true the $file will be appended to rather than
205 my($self, $text, $file, $appending) = @_;
208 my @cmds = map { '$(NOECHO) $(ECHO) '.$self->quote_literal($_) }
211 my $redirect = $appending ? '>>' : '>';
212 $cmds[0] .= " $redirect $file";
213 $_ .= " >> $file" foreach @cmds[1..$#cmds];
222 my $args = $mm->wraplist(@list);
224 Takes an array of items and turns them into a well-formatted list of
225 arguments. In most cases this is simply something like:
235 return join " \\\n\t", @_;
239 =head3 cd I<Abstract>
241 my $subdir_cmd = $MM->cd($subdir, @cmds);
243 This will generate a make fragment which runs the @cmds in the given
244 $dir. The rough equivalent to this, except cross platform.
248 Currently $dir can only go down one level. "foo" is fine. "foo/bar" is
249 not. "../foo" is right out.
251 The resulting $subdir_cmd has no leading tab nor trailing newline. This
252 makes it easier to embed in a make string. For example.
254 my $make = sprintf <<'CODE', $subdir_cmd;
262 =head3 oneliner I<Abstract>
264 my $oneliner = $MM->oneliner($perl_code);
265 my $oneliner = $MM->oneliner($perl_code, \@switches);
267 This will generate a perl one-liner safe for the particular platform
268 you're on based on the given $perl_code and @switches (a -e is
269 assumed) suitable for using in a make target. It will use the proper
270 shell quoting and escapes.
272 $(PERLRUN) will be used as perl.
274 Any newlines in $perl_code will be escaped. Leading and trailing
275 newlines will be stripped. Makes this idiom much easier:
277 my $code = $MM->oneliner(<<'CODE', [...switches...]);
282 Usage might be something like:
285 $oneliner = $MM->oneliner('print "Foo\n"');
286 $make = '$oneliner > somefile';
288 All dollar signs must be doubled in the $perl_code if you expect them
289 to be interpreted normally, otherwise it will be considered a make
290 macro. Also remember to quote make macros else it might be used as a
291 bareword. For example:
293 # Assign the value of the $(VERSION_FROM) make macro to $vf.
294 $oneliner = $MM->oneliner('$$vf = "$(VERSION_FROM)"');
296 Its currently very simple and may be expanded sometime in the figure
297 to include more flexible code and switches.
300 =head3 quote_literal I<Abstract>
302 my $safe_text = $MM->quote_literal($text);
304 This will quote $text so it is interpreted literally in the shell.
306 For example, on Unix this would escape any single-quotes in $text and
307 put single-quotes around the whole thing.
310 =head3 escape_newlines I<Abstract>
312 my $escaped_text = $MM->escape_newlines($text);
314 Shell escapes newlines in $text.
317 =head3 max_exec_len I<Abstract>
319 my $max_exec_len = $MM->max_exec_len;
321 Calculates the maximum command size the OS can exec. Effectively,
322 this is the max size of a shell command line.
325 $self->{_MAX_EXEC_LEN} is set by this method, but only for testing purposes.
330 my $make = $MM->make;
332 Returns the make variant we're generating the Makefile for. This attempts
333 to do some normalization on the information from %Config or the user.
340 my $make = lc $self->{MAKE};
342 # Truncate anything like foomake6 to just foomake.
343 $make =~ s/^(\w+make).*/$1/;
345 # Turn gnumake into gmake.
354 These are methods which produce make targets.
359 Generate the default target 'all'.
374 =head3 blibdirs_target
376 my $make_frag = $mm->blibdirs_target;
378 Creates the blibdirs target which creates all the directories we use
381 The blibdirs.ts target is deprecated. Depend on blibdirs instead.
386 sub blibdirs_target {
389 my @dirs = map { uc "\$(INST_$_)" } qw(libdir archlib
395 my @exists = map { $_.'$(DFSEP).exists' } @dirs;
397 my $make = sprintf <<'MAKE', join(' ', @exists);
401 # Backwards compat with 6.18 through 6.25
402 blibdirs.ts : blibdirs
407 $make .= $self->dir_target(@dirs);
415 Defines the clean target.
420 # --- Cleanup and Distribution Sections ---
422 my($self, %attribs) = @_;
425 # Delete temporary files but do not touch installed files. We don\'t delete
426 # the Makefile here so a later make realclean still has a makefile to use.
428 clean :: clean_subdirs
431 my @files = values %{$self->{XS}}; # .c files from *.xs files
434 # Normally these are all under blib but they might have been
436 # XXX normally this would be a good idea, but the Perl core sets
437 # INST_LIB = ../../lib rather than actually installing the files.
438 # So a "make clean" in an ext/ directory would blow away lib.
439 # Until the core is adjusted let's leave this out.
440 # push @dirs, qw($(INST_ARCHLIB) $(INST_LIB)
441 # $(INST_BIN) $(INST_SCRIPT)
442 # $(INST_MAN1DIR) $(INST_MAN3DIR)
443 # $(INST_LIBDIR) $(INST_ARCHLIBDIR) $(INST_AUTODIR)
444 # $(INST_STATIC) $(INST_DYNAMIC) $(INST_BOOT)
448 if( $attribs{FILES} ) {
449 # Use @dirs because we don't know what's in here.
450 push @dirs, ref $attribs{FILES} ?
452 split /\s+/, $attribs{FILES} ;
455 push(@files, qw[$(MAKE_APERL_FILE)
456 perlmain.c tmon.out mon.out so_locations
457 blibdirs.ts pm_to_blib pm_to_blib.ts
458 *$(OBJ_EXT) *$(LIB_EXT) perl.exe perl perl$(EXE_EXT)
459 $(BOOTSTRAP) $(BASEEXT).bso
460 $(BASEEXT).def lib$(BASEEXT).def
461 $(BASEEXT).exp $(BASEEXT).x
464 push(@files, $self->catfile('$(INST_ARCHAUTODIR)','extralibs.all'));
465 push(@files, $self->catfile('$(INST_ARCHAUTODIR)','extralibs.ld'));
468 push(@files, qw[core core.*perl.*.? *perl.core]);
469 push(@files, map { "core." . "[0-9]"x$_ } (1..5));
471 # OS specific things to clean up. Use @dirs since we don't know
472 # what might be in here.
473 push @dirs, $self->extra_clean_files;
475 # Occasionally files are repeated several times from different sources
476 { my(%f) = map { ($_ => 1) } @files; @files = keys %f; }
477 { my(%d) = map { ($_ => 1) } @dirs; @dirs = keys %d; }
479 push @m, map "\t$_\n", $self->split_command('- $(RM_F)', @files);
480 push @m, map "\t$_\n", $self->split_command('- $(RM_RF)', @dirs);
482 # Leave Makefile.old around for realclean
484 - $(MV) $(FIRST_MAKEFILE) $(MAKEFILE_OLD) $(DEV_NULL)
487 push(@m, "\t$attribs{POSTOP}\n") if $attribs{POSTOP};
493 =head3 clean_subdirs_target
495 my $make_frag = $MM->clean_subdirs_target;
497 Returns the clean_subdirs target. This is used by the clean target to
498 call clean on any subdirectories which contain Makefiles.
502 sub clean_subdirs_target {
505 # No subdirectories, no cleaning.
506 return <<'NOOP_FRAG' unless @{$self->{DIR}};
512 my $clean = "clean_subdirs :\n";
514 for my $dir (@{$self->{DIR}}) {
515 my $subclean = $self->oneliner(sprintf <<'CODE', $dir);
516 chdir '%s'; system '$(MAKE) clean' if -f '$(FIRST_MAKEFILE)';
519 $clean .= "\t$subclean\n";
528 my $make_frag = $mm->dir_target(@directories);
530 Generates targets to create the specified directories and set its
533 Because depending on a directory to just ensure it exists doesn't work
534 too well (the modified time changes too often) dir_target() creates a
535 .exists file in the created directory. It is this you should depend on.
536 For portability purposes you should use the $(DIRFILESEP) macro rather
537 than a '/' to seperate the directory from the file.
539 yourdirectory$(DIRFILESEP).exists
544 my($self, @dirs) = @_;
547 foreach my $dir (@dirs) {
548 $make .= sprintf <<'MAKE', ($dir) x 7;
549 %s$(DFSEP).exists :: Makefile.PL
550 $(NOECHO) $(MKPATH) %s
551 $(NOECHO) $(CHMOD) 755 %s
552 $(NOECHO) $(TOUCH) %s$(DFSEP).exists
564 Defines the scratch directory target that will hold the distribution
565 before tar-ing (or shar-ing).
569 # For backwards compatibility.
570 *dist_dir = *distdir;
575 my $meta_target = $self->{NO_META} ? '' : 'distmeta';
576 my $sign_target = !$self->{SIGN} ? '' : 'distsignature';
578 return sprintf <<'MAKE_FRAG', $meta_target, $sign_target;
580 $(RM_RF) $(DISTVNAME)
581 $(PERLRUN) "-MExtUtils::Manifest=manicopy,maniread" \
582 -e "manicopy(maniread(),'$(DISTVNAME)', '$(DIST_CP)');"
584 distdir : create_distdir %s %s
594 Defines a target that produces the distribution in the
595 scratchdirectory, and runs 'perl Makefile.PL; make ;make test' in that
603 my $mpl_args = join " ", map qq["$_"], @ARGV;
605 my $test = $self->cd('$(DISTVNAME)',
606 '$(ABSPERLRUN) Makefile.PL '.$mpl_args,
607 '$(MAKE) $(PASTHRU)',
608 '$(MAKE) test $(PASTHRU)'
611 return sprintf <<'MAKE_FRAG', $test;
623 Defines the dynamic target.
628 # --- Dynamic Loading Sections ---
632 dynamic :: $(FIRST_MAKEFILE) $(INST_DYNAMIC) $(INST_BOOT)
638 =head3 makemakerdflt_target
640 my $make_frag = $mm->makemakerdflt_target
642 Returns a make fragment with the makemakerdeflt_target specified.
643 This target is the first target in the Makefile, is the default target
644 and simply points off to 'all' just in case any make variant gets
645 confused or something gets snuck in before the real 'all' target.
649 sub makemakerdflt_target {
650 return <<'MAKE_FRAG';
658 =head3 manifypods_target
660 my $manifypods_target = $self->manifypods_target;
662 Generates the manifypods target. This target generates man pages from
663 all POD files in MAN1PODS and MAN3PODS.
667 sub manifypods_target {
672 my $dependencies = '';
674 # populate manXpods & dependencies:
675 foreach my $name (keys %{$self->{MAN1PODS}}, keys %{$self->{MAN3PODS}}) {
676 $dependencies .= " \\\n\t$name";
679 foreach my $name (keys %{$self->{MAN3PODS}}) {
680 $dependencies .= " \\\n\t$name"
684 manifypods : pure_all $dependencies
688 foreach my $section (qw(1 3)) {
689 my $pods = $self->{"MAN${section}PODS"};
690 push @man_cmds, $self->split_command(<<CMD, %$pods);
691 \$(NOECHO) \$(POD2MAN) --section=$section --perm_rw=\$(PERM_RW)
695 $manify .= "\t\$(NOECHO) \$(NOOP)\n" unless @man_cmds;
696 $manify .= join '', map { "$_\n" } @man_cmds;
702 =head3 metafile_target
704 my $target = $mm->metafile_target;
706 Generate the metafile target.
708 Writes the file META.yml YAML encoded meta-data about the module in
709 the distdir. The format follows Module::Build's as closely as
714 sub metafile_target {
717 return <<'MAKE_FRAG' if $self->{NO_META};
723 foreach my $mod ( sort { lc $a cmp lc $b } keys %{$self->{PREREQ_PM}} ) {
724 my $ver = $self->{PREREQ_PM}{$mod};
725 $prereq_pm .= sprintf "\n %-30s %s", "$mod:", $ver;
728 # Use a list to preserve order.
730 name => $self->{DISTNAME},
731 version => $self->{VERSION},
732 abstract => $self->{ABSTRACT},
733 license => $self->{LICENSE},
735 "ExtUtils::MakeMaker version $ExtUtils::MakeMaker::VERSION",
736 distribution_type => $self->{PM} ? 'module' : 'script',
739 my $meta = "--- #YAML:1.0\n";
741 while( @meta_to_mm ) {
742 my($key, $val) = splice @meta_to_mm, 0, 2;
744 $val = '~' unless defined $val;
746 $meta .= sprintf "%-20s %s\n", "$key:", $val;
752 url: http://module-build.sourceforge.net/META-spec-v1.2.html
756 $meta .= <<"YAML" if defined $self->{AUTHOR};
761 $meta .= $self->{EXTRA_META} if $self->{EXTRA_META};
763 my @write_meta = $self->echo($meta, 'META_new.yml');
765 return sprintf <<'MAKE_FRAG', join("\n\t", @write_meta);
766 metafile : create_distdir
767 $(NOECHO) $(ECHO) Generating META.yml
769 -$(NOECHO) $(MV) META_new.yml $(DISTVNAME)/META.yml
775 =head3 distmeta_target
777 my $make_frag = $mm->distmeta_target;
779 Generates the distmeta target to add META.yml to the MANIFEST in the
784 sub distmeta_target {
787 my $add_meta = $self->oneliner(<<'CODE', ['-MExtUtils::Manifest=maniadd']);
788 eval { maniadd({q{META.yml} => q{Module meta-data (added by MakeMaker)}}) }
789 or print "Could not add META.yml to MANIFEST: $${'@'}\n"
792 my $add_meta_to_distdir = $self->cd('$(DISTVNAME)', $add_meta);
794 return sprintf <<'MAKE', $add_meta_to_distdir;
795 distmeta : create_distdir metafile
805 Defines the realclean target.
810 my($self, %attribs) = @_;
812 my @dirs = qw($(DISTVNAME));
813 my @files = qw($(FIRST_MAKEFILE) $(MAKEFILE_OLD));
815 # Special exception for the perl core where INST_* is not in blib.
816 # This cleans up the files built from the ext/ directory (all XS).
817 if( $self->{PERL_CORE} ) {
818 push @dirs, qw($(INST_AUTODIR) $(INST_ARCHAUTODIR));
819 push @files, values %{$self->{PM}};
822 if( $self->has_link_code ){
823 push @files, qw($(OBJECT));
826 if( $attribs{FILES} ) {
827 if( ref $attribs{FILES} ) {
828 push @dirs, @{ $attribs{FILES} };
831 push @dirs, split /\s+/, $attribs{FILES};
835 # Occasionally files are repeated several times from different sources
836 { my(%f) = map { ($_ => 1) } @files; @files = keys %f; }
837 { my(%d) = map { ($_ => 1) } @dirs; @dirs = keys %d; }
839 my $rm_cmd = join "\n\t", map { "$_" }
840 $self->split_command('- $(RM_F)', @files);
841 my $rmf_cmd = join "\n\t", map { "$_" }
842 $self->split_command('- $(RM_RF)', @dirs);
844 my $m = sprintf <<'MAKE', $rm_cmd, $rmf_cmd;
845 # Delete temporary files (via clean) and also delete dist files
846 realclean purge :: clean realclean_subdirs
851 $m .= "\t$attribs{POSTOP}\n" if $attribs{POSTOP};
857 =head3 realclean_subdirs_target
859 my $make_frag = $MM->realclean_subdirs_target;
861 Returns the realclean_subdirs target. This is used by the realclean
862 target to call realclean on any subdirectories which contain Makefiles.
866 sub realclean_subdirs_target {
869 return <<'NOOP_FRAG' unless @{$self->{DIR}};
874 my $rclean = "realclean_subdirs :\n";
876 foreach my $dir (@{$self->{DIR}}) {
877 foreach my $makefile ('$(MAKEFILE_OLD)', '$(FIRST_MAKEFILE)' ) {
878 my $subrclean .= $self->oneliner(sprintf <<'CODE', $dir, ($makefile) x 2);
879 chdir '%s'; system '$(MAKE) $(USEMAKEFILE) %s realclean' if -f '%s';
882 $rclean .= sprintf <<'RCLEAN', $subrclean;
893 =head3 signature_target
895 my $target = $mm->signature_target;
897 Generate the signature target.
899 Writes the file SIGNATURE with "cpansign -s".
903 sub signature_target {
906 return <<'MAKE_FRAG';
914 =head3 distsignature_target
916 my $make_frag = $mm->distsignature_target;
918 Generates the distsignature target to add SIGNATURE to the MANIFEST in the
923 sub distsignature_target {
926 my $add_sign = $self->oneliner(<<'CODE', ['-MExtUtils::Manifest=maniadd']);
927 eval { maniadd({q{SIGNATURE} => q{Public-key signature (added by MakeMaker)}}) }
928 or print "Could not add SIGNATURE to MANIFEST: $${'@'}\n"
931 my $sign_dist = $self->cd('$(DISTVNAME)' => 'cpansign -s');
933 # cpansign -s complains if SIGNATURE is in the MANIFEST yet does not
935 my $touch_sig = $self->cd('$(DISTVNAME)' => '$(TOUCH) SIGNATURE');
936 my $add_sign_to_dist = $self->cd('$(DISTVNAME)' => $add_sign );
938 return sprintf <<'MAKE', $add_sign_to_dist, $touch_sig, $sign_dist
939 distsignature : create_distdir
949 =head3 special_targets
951 my $make_frag = $mm->special_targets
953 Returns a make fragment containing any targets which have special
954 meaning to make. For example, .SUFFIXES and .PHONY.
958 sub special_targets {
959 my $make_frag = <<'MAKE_FRAG';
960 .SUFFIXES : .xs .c .C .cpp .i .s .cxx .cc $(OBJ_EXT)
962 .PHONY: all config static dynamic test linkext manifest blibdirs clean realclean disttest distdir
966 $make_frag .= <<'MAKE_FRAG' if $ENV{CLEARCASE_ROOT};
967 .NO_CONFIG_REC: Makefile
979 Methods which help initialize the MakeMaker object and macros.
991 if( $self->{ABSTRACT_FROM} and $self->{ABSTRACT} ) {
992 warn "Both ABSTRACT_FROM and ABSTRACT are set. ".
993 "Ignoring ABSTRACT_FROM.\n";
997 if ($self->{ABSTRACT_FROM}){
998 $self->{ABSTRACT} = $self->parse_abstract($self->{ABSTRACT_FROM}) or
999 carp "WARNING: Setting ABSTRACT via file ".
1000 "'$self->{ABSTRACT_FROM}' failed\n";
1008 Called by init_main. Sets up all INST_* variables except those related
1009 to XS code. Those are handled in init_xs.
1016 $self->{INST_ARCHLIB} ||= $self->catdir($Curdir,"blib","arch");
1017 $self->{INST_BIN} ||= $self->catdir($Curdir,'blib','bin');
1019 # INST_LIB typically pre-set if building an extension after
1020 # perl has been built and installed. Setting INST_LIB allows
1021 # you to build directly into, say $Config{privlibexp}.
1022 unless ($self->{INST_LIB}){
1023 if ($self->{PERL_CORE}) {
1024 if (defined $Cross::platform) {
1025 $self->{INST_LIB} = $self->{INST_ARCHLIB} =
1026 $self->catdir($self->{PERL_LIB},"..","xlib",
1030 $self->{INST_LIB} = $self->{INST_ARCHLIB} = $self->{PERL_LIB};
1033 $self->{INST_LIB} = $self->catdir($Curdir,"blib","lib");
1037 my @parentdir = split(/::/, $self->{PARENT_NAME});
1038 $self->{INST_LIBDIR} = $self->catdir('$(INST_LIB)', @parentdir);
1039 $self->{INST_ARCHLIBDIR} = $self->catdir('$(INST_ARCHLIB)', @parentdir);
1040 $self->{INST_AUTODIR} = $self->catdir('$(INST_LIB)', 'auto',
1042 $self->{INST_ARCHAUTODIR} = $self->catdir('$(INST_ARCHLIB)', 'auto',
1045 $self->{INST_SCRIPT} ||= $self->catdir($Curdir,'blib','script');
1047 $self->{INST_MAN1DIR} ||= $self->catdir($Curdir,'blib','man1');
1048 $self->{INST_MAN3DIR} ||= $self->catdir($Curdir,'blib','man3');
1058 Called by init_main. Sets up all INSTALL_* variables (except
1059 INSTALLDIRS) and *PREFIX.
1066 if( $self->{ARGS}{INSTALL_BASE} and $self->{ARGS}{PREFIX} ) {
1067 die "Only one of PREFIX or INSTALL_BASE can be given. Not both.\n";
1070 if( $self->{ARGS}{INSTALL_BASE} ) {
1071 $self->init_INSTALL_from_INSTALL_BASE;
1074 $self->init_INSTALL_from_PREFIX;
1079 =head3 init_INSTALL_from_PREFIX
1081 $mm->init_INSTALL_from_PREFIX;
1085 sub init_INSTALL_from_PREFIX {
1088 $self->init_lib2arch;
1090 # There are often no Config.pm defaults for these new man variables so
1091 # we fall back to the old behavior which is to use installman*dir
1092 foreach my $num (1, 3) {
1093 my $k = 'installsiteman'.$num.'dir';
1095 $self->{uc $k} ||= uc "\$(installman${num}dir)"
1099 foreach my $num (1, 3) {
1100 my $k = 'installvendorman'.$num.'dir';
1102 unless( $Config{$k} ) {
1103 $self->{uc $k} ||= $Config{usevendorprefix}
1104 ? uc "\$(installman${num}dir)"
1109 $self->{INSTALLSITEBIN} ||= '$(INSTALLBIN)'
1110 unless $Config{installsitebin};
1111 $self->{INSTALLSITESCRIPT} ||= '$(INSTALLSCRIPT)'
1112 unless $Config{installsitescript};
1114 unless( $Config{installvendorbin} ) {
1115 $self->{INSTALLVENDORBIN} ||= $Config{usevendorprefix}
1116 ? $Config{installbin}
1119 unless( $Config{installvendorscript} ) {
1120 $self->{INSTALLVENDORSCRIPT} ||= $Config{usevendorprefix}
1121 ? $Config{installscript}
1126 my $iprefix = $Config{installprefixexp} || $Config{installprefix} ||
1127 $Config{prefixexp} || $Config{prefix} || '';
1128 my $vprefix = $Config{usevendorprefix} ? $Config{vendorprefixexp} : '';
1129 my $sprefix = $Config{siteprefixexp} || '';
1131 # 5.005_03 doesn't have a siteprefix.
1132 $sprefix = $iprefix unless $sprefix;
1135 $self->{PREFIX} ||= '';
1137 if( $self->{PREFIX} ) {
1138 @{$self}{qw(PERLPREFIX SITEPREFIX VENDORPREFIX)} =
1142 $self->{PERLPREFIX} ||= $iprefix;
1143 $self->{SITEPREFIX} ||= $sprefix;
1144 $self->{VENDORPREFIX} ||= $vprefix;
1146 # Lots of MM extension authors like to use $(PREFIX) so we
1147 # put something sensible in there no matter what.
1148 $self->{PREFIX} = '$('.uc $self->{INSTALLDIRS}.'PREFIX)';
1151 my $arch = $Config{archname};
1152 my $version = $Config{version};
1155 my $libstyle = $Config{installstyle} || 'lib/perl5';
1158 if( $self->{LIBSTYLE} ) {
1159 $libstyle = $self->{LIBSTYLE};
1160 $manstyle = $self->{LIBSTYLE} eq 'lib/perl5' ? 'lib/perl5' : '';
1163 # Some systems, like VOS, set installman*dir to '' if they can't
1165 for my $num (1, 3) {
1166 $self->{'INSTALLMAN'.$num.'DIR'} ||= 'none'
1167 unless $Config{'installman'.$num.'dir'};
1172 bin => { s => $iprefix,
1175 vendorbin => { s => $vprefix,
1178 sitebin => { s => $sprefix,
1181 script => { s => $iprefix,
1184 vendorscript=> { s => $vprefix,
1187 sitescript => { s => $sprefix,
1194 man1dir => { s => $iprefix,
1197 style => $manstyle, },
1198 siteman1dir => { s => $sprefix,
1201 style => $manstyle, },
1202 vendorman1dir => { s => $vprefix,
1205 style => $manstyle, },
1207 man3dir => { s => $iprefix,
1210 style => $manstyle, },
1211 siteman3dir => { s => $sprefix,
1214 style => $manstyle, },
1215 vendorman3dir => { s => $vprefix,
1218 style => $manstyle, },
1223 privlib => { s => $iprefix,
1226 style => $libstyle, },
1227 vendorlib => { s => $vprefix,
1230 style => $libstyle, },
1231 sitelib => { s => $sprefix,
1234 style => $libstyle, },
1236 archlib => { s => $iprefix,
1238 d => "$version/$arch",
1239 style => $libstyle },
1240 vendorarch => { s => $vprefix,
1242 d => "$version/$arch",
1243 style => $libstyle },
1244 sitearch => { s => $sprefix,
1246 d => "site_perl/$version/$arch",
1247 style => $libstyle },
1251 # Special case for LIB.
1252 if( $self->{LIB} ) {
1253 foreach my $var (keys %lib_layouts) {
1254 my $Installvar = uc "install$var";
1256 if( $var =~ /arch/ ) {
1257 $self->{$Installvar} ||=
1258 $self->catdir($self->{LIB}, $Config{archname});
1261 $self->{$Installvar} ||= $self->{LIB};
1266 my %type2prefix = ( perl => 'PERLPREFIX',
1267 site => 'SITEPREFIX',
1268 vendor => 'VENDORPREFIX'
1271 my %layouts = (%bin_layouts, %man_layouts, %lib_layouts);
1272 while( my($var, $layout) = each(%layouts) ) {
1273 my($s, $t, $d, $style) = @{$layout}{qw(s t d style)};
1274 my $r = '$('.$type2prefix{$t}.')';
1276 print STDERR "Prefixing $var\n" if $Verbose >= 2;
1278 my $installvar = "install$var";
1279 my $Installvar = uc $installvar;
1280 next if $self->{$Installvar};
1282 $d = "$style/$d" if $style;
1283 $self->prefixify($installvar, $s, $r, $d);
1285 print STDERR " $Installvar == $self->{$Installvar}\n"
1289 # Generate these if they weren't figured out.
1290 $self->{VENDORARCHEXP} ||= $self->{INSTALLVENDORARCH};
1291 $self->{VENDORLIBEXP} ||= $self->{INSTALLVENDORLIB};
1297 =head3 init_from_INSTALL_BASE
1299 $mm->init_from_INSTALL_BASE
1304 lib => [qw(lib perl5)],
1305 arch => [('lib', 'perl5', $Config{archname})],
1307 man1dir => [qw(man man1)],
1308 man3dir => [qw(man man3)]
1310 $map{script} = $map{bin};
1312 sub init_INSTALL_from_INSTALL_BASE {
1315 @{$self}{qw(PREFIX VENDORPREFIX SITEPREFIX PERLPREFIX)} =
1319 foreach my $thing (keys %map) {
1320 foreach my $dir (('', 'SITE', 'VENDOR')) {
1321 my $uc_thing = uc $thing;
1322 my $key = "INSTALL".$dir.$uc_thing;
1325 $self->catdir('$(INSTALL_BASE)', @{$map{$thing}});
1329 # Adjust for variable quirks.
1330 $install{INSTALLARCHLIB} ||= delete $install{INSTALLARCH};
1331 $install{INSTALLPRIVLIB} ||= delete $install{INSTALLLIB};
1333 foreach my $key (keys %install) {
1334 $self->{$key} ||= $install{$key};
1341 =head3 init_VERSION I<Abstract>
1345 Initialize macros representing versions of MakeMaker and other tools
1347 MAKEMAKER: path to the MakeMaker module.
1349 MM_VERSION: ExtUtils::MakeMaker Version
1351 MM_REVISION: ExtUtils::MakeMaker version control revision (for backwards
1354 VERSION: version of your module
1356 VERSION_MACRO: which macro represents the version (usually 'VERSION')
1358 VERSION_SYM: like version but safe for use as an RCS revision number
1360 DEFINE_VERSION: -D line to set the module version when compiling
1362 XS_VERSION: version in your .xs file. Defaults to $(VERSION)
1364 XS_VERSION_MACRO: which macro represents the XS version.
1366 XS_DEFINE_VERSION: -D line to set the xs version when compiling.
1368 Called by init_main.
1375 $self->{MAKEMAKER} = $ExtUtils::MakeMaker::Filename;
1376 $self->{MM_VERSION} = $ExtUtils::MakeMaker::VERSION;
1377 $self->{MM_REVISION}= $ExtUtils::MakeMaker::Revision;
1378 $self->{VERSION_FROM} ||= '';
1380 if ($self->{VERSION_FROM}){
1381 $self->{VERSION} = $self->parse_version($self->{VERSION_FROM});
1382 if( $self->{VERSION} eq 'undef' ) {
1383 carp("WARNING: Setting VERSION via file ".
1384 "'$self->{VERSION_FROM}' failed\n");
1389 if (defined $self->{VERSION}) {
1390 $self->{VERSION} =~ s/^\s+//;
1391 $self->{VERSION} =~ s/\s+$//;
1394 $self->{VERSION} = '';
1398 $self->{VERSION_MACRO} = 'VERSION';
1399 ($self->{VERSION_SYM} = $self->{VERSION}) =~ s/\W/_/g;
1400 $self->{DEFINE_VERSION} = '-D$(VERSION_MACRO)=\"$(VERSION)\"';
1403 # Graham Barr and Paul Marquess had some ideas how to ensure
1404 # version compatibility between the *.pm file and the
1405 # corresponding *.xs file. The bottomline was, that we need an
1406 # XS_VERSION macro that defaults to VERSION:
1407 $self->{XS_VERSION} ||= $self->{VERSION};
1409 $self->{XS_VERSION_MACRO} = 'XS_VERSION';
1410 $self->{XS_DEFINE_VERSION} = '-D$(XS_VERSION_MACRO)=\"$(XS_VERSION)\"';
1415 =head3 init_others I<Abstract>
1419 Initializes the macro definitions used by tools_other() and places them
1422 If there is no description, its the same as the parameter to
1423 WriteMakefile() documented in ExtUtils::MakeMaker.
1425 Defines at least these macros.
1430 NOECHO Tell make not to display the command itself
1435 MAKE_APERL_FILE File used by MAKE_APERL
1437 SHELL Program used to run shell commands
1439 ECHO Print text adding a newline on the end
1441 RM_RF Remove a directory
1442 TOUCH Update a file's timestamp
1443 TEST_F Test for a file's existence
1446 CHMOD Change permissions on a
1449 UMASK_NULL Nullify umask
1450 DEV_NULL Suppress all command output
1453 =head3 init_DIRFILESEP I<Abstract>
1455 $MM->init_DIRFILESEP;
1456 my $dirfilesep = $MM->{DIRFILESEP};
1458 Initializes the DIRFILESEP macro which is the seperator between the
1459 directory and filename in a filepath. ie. / on Unix, \ on Win32 and
1464 # instead of $(INST_ARCHAUTODIR)/extralibs.ld
1465 $(INST_ARCHAUTODIR)$(DIRFILESEP)extralibs.ld
1467 Something of a hack but it prevents a lot of code duplication between
1470 Do not use this as a seperator between directories. Some operating
1471 systems use different seperators between subdirectories as between
1472 directories and filenames (for example: VOLUME:[dir1.dir2]file on VMS).
1474 =head3 init_linker I<Abstract>
1478 Initialize macros which have to do with linking.
1480 PERL_ARCHIVE: path to libperl.a equivalent to be linked to dynamic
1483 PERL_ARCHIVE_AFTER: path to a library which should be put on the
1484 linker command line I<after> the external libraries to be linked to
1485 dynamic extensions. This may be needed if the linker is one-pass, and
1486 Perl includes some overrides for C RTL functions, such as malloc().
1488 EXPORT_LIST: name of a file that is passed to linker to define symbols
1491 Some OSes do not need these in which case leave it blank.
1494 =head3 init_platform
1498 Initialize any macros which are for platform specific use only.
1500 A typical one is the version number of your OS specific mocule.
1501 (ie. MM_Unix_VERSION or MM_VMS_VERSION).
1514 Initialize MAKE from either a MAKE environment variable or $Config{make}.
1521 $self->{MAKE} ||= $ENV{MAKE} || $Config{make};
1527 A grab bag of methods to generate specific macros and commands.
1533 Defines targets and routines to translate the pods into manpages and
1534 put them into the INST_* directories.
1541 my $POD2MAN_macro = $self->POD2MAN_macro();
1542 my $manifypods_target = $self->manifypods_target();
1544 return <<END_OF_TARGET;
1555 =head3 POD2MAN_macro
1557 my $pod2man_macro = $self->POD2MAN_macro
1559 Returns a definition for the POD2MAN macro. This is a program
1560 which emulates the pod2man utility. You can add more switches to the
1561 command by simply appending them on the macro.
1565 $(POD2MAN) --section=3 --perm_rw=$(PERM_RW) podfile1 man_page1 ...
1572 # Need the trailing '--' so perl stops gobbling arguments and - happens
1573 # to be an alternative end of line seperator on VMS so we quote it
1574 return <<'END_OF_DEF';
1575 POD2MAN_EXE = $(PERLRUN) "-MExtUtils::Command::MM" -e pod2man "--"
1576 POD2MAN = $(POD2MAN_EXE)
1581 =head3 test_via_harness
1583 my $command = $mm->test_via_harness($perl, $tests);
1585 Returns a $command line which runs the given set of $tests with
1586 Test::Harness and the given $perl.
1588 Used on the t/*.t files.
1592 sub test_via_harness {
1593 my($self, $perl, $tests) = @_;
1595 return qq{\t$perl "-MExtUtils::Command::MM" }.
1596 qq{"-e" "test_harness(\$(TEST_VERBOSE), '\$(INST_LIB)', '\$(INST_ARCHLIB)')" $tests\n};
1599 =head3 test_via_script
1601 my $command = $mm->test_via_script($perl, $script);
1603 Returns a $command line which just runs a single test without
1604 Test::Harness. No checks are done on the results, they're just
1607 Used for test.pl, since they don't always follow Test::Harness
1612 sub test_via_script {
1613 my($self, $perl, $script) = @_;
1614 return qq{\t$perl "-I\$(INST_LIB)" "-I\$(INST_ARCHLIB)" $script\n};
1618 =head3 tool_autosplit
1620 Defines a simple perl call that runs autosplit. May be deprecated by
1625 sub tool_autosplit {
1626 my($self, %attribs) = @_;
1628 my $maxlen = $attribs{MAXLEN} ? '$$AutoSplit::Maxlen=$attribs{MAXLEN};'
1631 my $asplit = $self->oneliner(sprintf <<'PERL_CODE', $maxlen);
1632 use AutoSplit; %s autosplit($$ARGV[0], $$ARGV[1], 0, 1, 1)
1635 return sprintf <<'MAKE_FRAG', $asplit;
1636 # Usage: $(AUTOSPLITFILE) FileToSplit AutoDirToSplitInto
1646 =head2 File::Spec wrappers
1648 ExtUtils::MM_Any is a subclass of File::Spec. The methods noted here
1649 override File::Spec.
1655 File::Spec <= 0.83 has a bug where the file part of catfile is not
1656 canonicalized. This override fixes that bug.
1662 return $self->canonpath($self->SUPER::catfile(@_));
1669 Methods I can't really figure out where they should go yet.
1674 my $test = $mm->find_tests;
1676 Returns a string suitable for feeding to the shell to return all
1683 return -d 't' ? 't/*.t' : '';
1687 =head3 extra_clean_files
1689 my @files_to_clean = $MM->extra_clean_files;
1691 Returns a list of OS specific files to be removed in the clean target in
1692 addition to the usual set.
1696 # An empty method here tickled a perl 5.8.1 bug and would return its object.
1697 sub extra_clean_files {
1704 my @installvars = $mm->installvars;
1706 A list of all the INSTALL* variables without the INSTALL prefix. Useful
1707 for iteration or building related variable sets.
1712 return qw(PRIVLIB SITELIB VENDORLIB
1713 ARCHLIB SITEARCH VENDORARCH
1714 BIN SITEBIN VENDORBIN
1715 SCRIPT SITESCRIPT VENDORSCRIPT
1716 MAN1DIR SITEMAN1DIR VENDORMAN1DIR
1717 MAN3DIR SITEMAN3DIR VENDORMAN3DIR
1724 my $wanted = $self->libscan($path);
1726 Takes a path to a file or dir and returns an empty string if we don't
1727 want to include this file in the library. Otherwise it returns the
1728 the $path unchanged.
1730 Mainly used to exclude version control administrative directories from
1736 my($self,$path) = @_;
1737 my($dirs,$file) = ($self->splitpath($path))[1,2];
1738 return '' if grep /^(?:RCS|CVS|SCCS|\.svn|_darcs)$/,
1739 $self->splitdir($dirs), $file;
1745 =head3 platform_constants
1747 my $make_frag = $mm->platform_constants
1749 Returns a make fragment defining all the macros initialized in
1750 init_platform() rather than put them in constants().
1754 sub platform_constants {
1761 Michael G Schwern <schwern@pobox.com> and the denizens of
1762 makemaker@perl.org with code from ExtUtils::MM_Unix and