1ExtUtils::MM_Any(3) User Contributed Perl Documentation ExtUtils::MM_Any(3)
2
6 ExtUtils::MM_Any - Platform-agnostic MM methods
7
9 FOR INTERNAL USE ONLY!
10 package ExtUtils::MM_SomeOS;
12 # Temporarily, you have to subclass both. Put MM_Any first.
14 require ExtUtils::MM_Any;
15 require ExtUtils::MM_Unix;
16 @ISA = qw(ExtUtils::MM_Any ExtUtils::Unix);
17
19 FOR INTERNAL USE ONLY!
20 ExtUtils::MM_Any is a superclass for the ExtUtils::MM_* set of modules.
22 It contains methods which are either inherently cross-platform or are
23 written in a cross-platform manner.
24 Subclass off of ExtUtils::MM_Any and ExtUtils::MM_Unix. This is a
26 temporary solution.
27 THIS MAY BE TEMPORARY!
29
31 Any methods marked Abstract must be implemented by subclasses.
32 Cross-platform helper methods
34 These are methods which help writing cross-platform code.
35 os_flavor Abstract
37 my @os_flavor = $mm->os_flavor;
39 @os_flavor is the style of operating system this is, usually
41 corresponding to the MM_*.pm file we're using.
42 The first element of @os_flavor is the major family (ie. Unix, Windows,
44 VMS, OS/2, etc...) and the rest are sub families.
45 Some examples:
47 Cygwin98 ('Unix', 'Cygwin', 'Cygwin9x')
49 Windows ('Win32')
50 Win98 ('Win32', 'Win9x')
51 Linux ('Unix', 'Linux')
52 MacOS X ('Unix', 'Darwin', 'MacOS', 'MacOS X')
53 OS/2 ('OS/2')
54 This is used to write code for styles of operating system. See
56 os_flavor_is() for use.
57 os_flavor_is
59 my $is_this_flavor = $mm->os_flavor_is($this_flavor);
61 my $is_this_flavor = $mm->os_flavor_is(@one_of_these_flavors);
62 Checks to see if the current operating system is one of the given
64 flavors.
65 This is useful for code like:
67 if( $mm->os_flavor_is('Unix') ) {
69 $out = `foo 2>&1`;
70 }
71 else {
72 $out = `foo`;
73 }
74 can_load_xs
76 my $can_load_xs = $self->can_load_xs;
78 Returns true if we have the ability to load XS.
80 This is important because miniperl, used to build XS modules in the
82 core, can not load XS.
83 split_command
85 my @cmds = $MM->split_command($cmd, @args);
87 Most OS have a maximum command length they can execute at once. Large
89 modules can easily generate commands well past that limit. Its
90 necessary to split long commands up into a series of shorter commands.
91 "split_command" will return a series of @cmds each processing part of
93 the args. Collectively they will process all the arguments. Each
94 individual line in @cmds will not be longer than the
95 $self->max_exec_len being careful to take into account macro expansion.
96 $cmd should include any switches and repeated initial arguments.
98 If no @args are given, no @cmds will be returned.
100 Pairs of arguments will always be preserved in a single command, this
102 is a heuristic for things like pm_to_blib and pod2man which work on
103 pairs of arguments. This makes things like this safe:
104 $self->split_command($cmd, %pod2man);
106 echo
108 my @commands = $MM->echo($text);
110 my @commands = $MM->echo($text, $file);
111 my @commands = $MM->echo($text, $file, \%opts);
112 Generates a set of @commands which print the $text to a $file.
114 If $file is not given, output goes to STDOUT.
116 If $opts{append} is true the $file will be appended to rather than
118 overwritten. Default is to overwrite.
119 If $opts{allow_variables} is true, make variables of the form "$(...)"
121 will not be escaped. Other "$" will. Default is to escape all "$".
122 Example of use:
124 my $make = map "\t$_\n", $MM->echo($text, $file);
126 wraplist
128 my $args = $mm->wraplist(@list);
130 Takes an array of items and turns them into a well-formatted list of
132 arguments. In most cases this is simply something like:
133 FOO \
135 BAR \
136 BAZ
137 maketext_filter
139 my $filter_make_text = $mm->maketext_filter($make_text);
141 The text of the Makefile is run through this method before writing to
143 disk. It allows systems a chance to make portability fixes to the
144 Makefile.
145 By default it does nothing.
147 This method is protected and not intended to be called outside of
149 MakeMaker.
150 cd Abstract
152 my $subdir_cmd = $MM->cd($subdir, @cmds);
154 This will generate a make fragment which runs the @cmds in the given
156 $dir. The rough equivalent to this, except cross platform.
157 cd $subdir && $cmd
159 Currently $dir can only go down one level. "foo" is fine. "foo/bar"
161 is not. "../foo" is right out.
162 The resulting $subdir_cmd has no leading tab nor trailing newline.
164 This makes it easier to embed in a make string. For example.
165 my $make = sprintf <<'CODE', $subdir_cmd;
167 foo :
168 $(ECHO) what
169 %s
170 $(ECHO) mouche
171 CODE
172 oneliner Abstract
174 my $oneliner = $MM->oneliner($perl_code);
176 my $oneliner = $MM->oneliner($perl_code, \@switches);
177 This will generate a perl one-liner safe for the particular platform
179 you're on based on the given $perl_code and @switches (a -e is assumed)
180 suitable for using in a make target. It will use the proper shell
181 quoting and escapes.
182 $(PERLRUN) will be used as perl.
184 Any newlines in $perl_code will be escaped. Leading and trailing
186 newlines will be stripped. Makes this idiom much easier:
187 my $code = $MM->oneliner(<<'CODE', [...switches...]);
189 some code here
190 another line here
191 CODE
192 Usage might be something like:
194 # an echo emulation
196 $oneliner = $MM->oneliner('print "Foo\n"');
197 $make = '$oneliner > somefile';
198 All dollar signs must be doubled in the $perl_code if you expect them
200 to be interpreted normally, otherwise it will be considered a make
201 macro. Also remember to quote make macros else it might be used as a
202 bareword. For example:
203 # Assign the value of the $(VERSION_FROM) make macro to $vf.
205 $oneliner = $MM->oneliner('$$vf = "$(VERSION_FROM)"');
206 Its currently very simple and may be expanded sometime in the figure to
208 include more flexible code and switches.
209 quote_literal Abstract
211 my $safe_text = $MM->quote_literal($text);
213 my $safe_text = $MM->quote_literal($text, \%options);
214 This will quote $text so it is interpreted literally in the shell.
216 For example, on Unix this would escape any single-quotes in $text and
218 put single-quotes around the whole thing.
219 If $options{allow_variables} is true it will leave '$(FOO)' make
221 variables untouched. If false they will be escaped like any other "$".
222 Defaults to true.
223 escape_dollarsigns
225 my $escaped_text = $MM->escape_dollarsigns($text);
227 Escapes stray "$" so they are not interpreted as make variables.
229 It lets by "$(...)".
231 escape_all_dollarsigns
233 my $escaped_text = $MM->escape_all_dollarsigns($text);
235 Escapes all "$" so they are not interpreted as make variables.
237 escape_newlines Abstract
239 my $escaped_text = $MM->escape_newlines($text);
241 Shell escapes newlines in $text.
243 max_exec_len Abstract
245 my $max_exec_len = $MM->max_exec_len;
247 Calculates the maximum command size the OS can exec. Effectively, this
249 is the max size of a shell command line.
250 make
252 my $make = $MM->make;
254 Returns the make variant we're generating the Makefile for. This
256 attempts to do some normalization on the information from %Config or
257 the user.
258 Targets
260 These are methods which produce make targets.
261 all_target
263 Generate the default target 'all'.
265 blibdirs_target
267 my $make_frag = $mm->blibdirs_target;
269 Creates the blibdirs target which creates all the directories we use in
271 blib/.
272 The blibdirs.ts target is deprecated. Depend on blibdirs instead.
274 clean (o)
276 Defines the clean target.
278 clean_subdirs_target
280 my $make_frag = $MM->clean_subdirs_target;
282 Returns the clean_subdirs target. This is used by the clean target to
284 call clean on any subdirectories which contain Makefiles.
285 dir_target
287 my $make_frag = $mm->dir_target(@directories);
289 Generates targets to create the specified directories and set its
291 permission to PERM_DIR.
292 Because depending on a directory to just ensure it exists doesn't work
294 too well (the modified time changes too often) dir_target() creates a
295 .exists file in the created directory. It is this you should depend
296 on. For portability purposes you should use the $(DIRFILESEP) macro
297 rather than a '/' to separate the directory from the file.
298 yourdirectory$(DIRFILESEP).exists
300 distdir
302 Defines the scratch directory target that will hold the distribution
304 before tar-ing (or shar-ing).
305 dist_test
307 Defines a target that produces the distribution in the scratch
309 directory, and runs 'perl Makefile.PL; make ;make test' in that
310 subdirectory.
311 dynamic (o)
313 Defines the dynamic target.
315 makemakerdflt_target
317 my $make_frag = $mm->makemakerdflt_target
319 Returns a make fragment with the makemakerdeflt_target specified. This
321 target is the first target in the Makefile, is the default target and
322 simply points off to 'all' just in case any make variant gets confused
323 or something gets snuck in before the real 'all' target.
324 manifypods_target
326 my $manifypods_target = $self->manifypods_target;
328 Generates the manifypods target. This target generates man pages from
330 all POD files in MAN1PODS and MAN3PODS.
331 metafile_target
333 my $target = $mm->metafile_target;
335 Generate the metafile target.
337 Writes the file META.yml YAML encoded meta-data about the module in the
339 distdir. The format follows Module::Build's as closely as possible.
340 metafile_data
342 my @metadata_pairs = $mm->metafile_data(\%meta_add, \%meta_merge);
344 Returns the data which MakeMaker turns into the META.yml file.
346 Values of %meta_add will overwrite any existing metadata in those keys.
348 %meta_merge will be merged with them.
349 metafile_file
351 my $meta_yml = $mm->metafile_file(@metadata_pairs);
353 Turns the @metadata_pairs into YAML.
355 This method does not implement a complete YAML dumper, being limited to
357 dump a hash with values which are strings, undef's or nested hashes and
358 arrays of strings. No quoting/escaping is done.
359 distmeta_target
361 my $make_frag = $mm->distmeta_target;
363 Generates the distmeta target to add META.yml to the MANIFEST in the
365 distdir.
366 mymeta
368 my $mymeta = $mm->mymeta;
370 Generate MYMETA information as a hash either from an existing META.yml
372 or from internal data.
373 write_mymeta
375 $self->write_mymeta( $mymeta );
377 Write MYMETA information to MYMETA.yml.
379 This will probably be refactored into a more generic YAML dumping
381 method.
382 realclean (o)
384 Defines the realclean target.
386 realclean_subdirs_target
388 my $make_frag = $MM->realclean_subdirs_target;
390 Returns the realclean_subdirs target. This is used by the realclean
392 target to call realclean on any subdirectories which contain Makefiles.
393 signature_target
395 my $target = $mm->signature_target;
397 Generate the signature target.
399 Writes the file SIGNATURE with "cpansign -s".
401 distsignature_target
403 my $make_frag = $mm->distsignature_target;
405 Generates the distsignature target to add SIGNATURE to the MANIFEST in
407 the distdir.
408 special_targets
410 my $make_frag = $mm->special_targets
412 Returns a make fragment containing any targets which have special
414 meaning to make. For example, .SUFFIXES and .PHONY.
415 Init methods
417 Methods which help initialize the MakeMaker object and macros.
418 init_ABSTRACT
420 $mm->init_ABSTRACT
422 init_INST
424 $mm->init_INST;
426 Called by init_main. Sets up all INST_* variables except those related
428 to XS code. Those are handled in init_xs.
429 init_INSTALL
431 $mm->init_INSTALL;
433 Called by init_main. Sets up all INSTALL_* variables (except
435 INSTALLDIRS) and *PREFIX.
436 init_INSTALL_from_PREFIX
438 $mm->init_INSTALL_from_PREFIX;
440 init_from_INSTALL_BASE
442 $mm->init_from_INSTALL_BASE
444 init_VERSION Abstract
446 $mm->init_VERSION
448 Initialize macros representing versions of MakeMaker and other tools
450 MAKEMAKER: path to the MakeMaker module.
452 MM_VERSION: ExtUtils::MakeMaker Version
454 MM_REVISION: ExtUtils::MakeMaker version control revision (for
456 backwards
457 compat)
458 VERSION: version of your module
460 VERSION_MACRO: which macro represents the version (usually 'VERSION')
462 VERSION_SYM: like version but safe for use as an RCS revision number
464 DEFINE_VERSION: -D line to set the module version when compiling
466 XS_VERSION: version in your .xs file. Defaults to $(VERSION)
468 XS_VERSION_MACRO: which macro represents the XS version.
470 XS_DEFINE_VERSION: -D line to set the xs version when compiling.
472 Called by init_main.
474 init_tools
476 $MM->init_tools();
478 Initializes the simple macro definitions used by tools_other() and
480 places them in the $MM object. These use conservative cross platform
481 versions and should be overridden with platform specific versions for
482 performance.
483 Defines at least these macros.
485 Macro Description
487 NOOP Do nothing
489 NOECHO Tell make not to display the command itself
490 SHELL Program used to run shell commands
492 ECHO Print text adding a newline on the end
494 RM_F Remove a file
495 RM_RF Remove a directory
496 TOUCH Update a file's timestamp
497 TEST_F Test for a file's existence
498 CP Copy a file
499 MV Move a file
500 CHMOD Change permissions on a file
501 FALSE Exit with non-zero
502 TRUE Exit with zero
503 UMASK_NULL Nullify umask
505 DEV_NULL Suppress all command output
506 init_others
508 $MM->init_others();
510 Initializes the macro definitions having to do with compiling and
512 linking used by tools_other() and places them in the $MM object.
513 If there is no description, its the same as the parameter to
515 WriteMakefile() documented in ExtUtils::MakeMaker.
516 tools_other
518 my $make_frag = $MM->tools_other;
520 Returns a make fragment containing definitions for the macros
522 init_others() initializes.
523 init_DIRFILESEP Abstract
525 $MM->init_DIRFILESEP;
527 my $dirfilesep = $MM->{DIRFILESEP};
528 Initializes the DIRFILESEP macro which is the separator between the
530 directory and filename in a filepath. ie. / on Unix, \ on Win32 and
531 nothing on VMS.
532 For example:
534 # instead of $(INST_ARCHAUTODIR)/extralibs.ld
536 $(INST_ARCHAUTODIR)$(DIRFILESEP)extralibs.ld
537 Something of a hack but it prevents a lot of code duplication between
539 MM_* variants.
540 Do not use this as a separator between directories. Some operating
542 systems use different separators between subdirectories as between
543 directories and filenames (for example: VOLUME:[dir1.dir2]file on
544 VMS).
545 init_linker Abstract
547 $mm->init_linker;
549 Initialize macros which have to do with linking.
551 PERL_ARCHIVE: path to libperl.a equivalent to be linked to dynamic
553 extensions.
554 PERL_ARCHIVE_AFTER: path to a library which should be put on the linker
556 command line after the external libraries to be linked to dynamic
557 extensions. This may be needed if the linker is one-pass, and Perl
558 includes some overrides for C RTL functions, such as malloc().
559 EXPORT_LIST: name of a file that is passed to linker to define symbols
561 to be exported.
562 Some OSes do not need these in which case leave it blank.
564 init_platform
566 $mm->init_platform
568 Initialize any macros which are for platform specific use only.
570 A typical one is the version number of your OS specific module. (ie.
572 MM_Unix_VERSION or MM_VMS_VERSION).
573 init_MAKE
575 $mm->init_MAKE
577 Initialize MAKE from either a MAKE environment variable or
579 $Config{make}.
580 Tools
582 A grab bag of methods to generate specific macros and commands.
583 manifypods
585 Defines targets and routines to translate the pods into manpages and
587 put them into the INST_* directories.
588 POD2MAN_macro
590 my $pod2man_macro = $self->POD2MAN_macro
592 Returns a definition for the POD2MAN macro. This is a program which
594 emulates the pod2man utility. You can add more switches to the command
595 by simply appending them on the macro.
596 Typical usage:
598 $(POD2MAN) --section=3 --perm_rw=$(PERM_RW) podfile1 man_page1 ...
600 test_via_harness
602 my $command = $mm->test_via_harness($perl, $tests);
604 Returns a $command line which runs the given set of $tests with
606 Test::Harness and the given $perl.
607 Used on the t/*.t files.
609 test_via_script
611 my $command = $mm->test_via_script($perl, $script);
613 Returns a $command line which just runs a single test without
615 Test::Harness. No checks are done on the results, they're just
616 printed.
617 Used for test.pl, since they don't always follow Test::Harness
619 formatting.
620 tool_autosplit
622 Defines a simple perl call that runs autosplit. May be deprecated by
624 pm_to_blib soon.
625 arch_check
627 my $arch_ok = $mm->arch_check(
629 $INC{"Config.pm"},
630 File::Spec->catfile($Config{archlibexp}, "Config.pm")
631 );
632 A sanity check that what Perl thinks the architecture is and what
634 Config thinks the architecture is are the same. If they're not it will
635 return false and show a diagnostic message.
636 When building Perl it will always return true, as nothing is installed
638 yet.
639 The interface is a bit odd because this is the result of a quick
641 refactoring. Don't rely on it.
642 File::Spec wrappers
644 ExtUtils::MM_Any is a subclass of File::Spec. The methods noted here
645 override File::Spec.
646 catfile
648 File::Spec <= 0.83 has a bug where the file part of catfile is not
650 canonicalized. This override fixes that bug.
651 Misc
653 Methods I can't really figure out where they should go yet.
654 find_tests
656 my $test = $mm->find_tests;
658 Returns a string suitable for feeding to the shell to return all tests
660 in t/*.t.
661 extra_clean_files
663 my @files_to_clean = $MM->extra_clean_files;
665 Returns a list of OS specific files to be removed in the clean target
667 in addition to the usual set.
668 installvars
670 my @installvars = $mm->installvars;
672 A list of all the INSTALL* variables without the INSTALL prefix.
674 Useful for iteration or building related variable sets.
675 libscan
677 my $wanted = $self->libscan($path);
679 Takes a path to a file or dir and returns an empty string if we don't
681 want to include this file in the library. Otherwise it returns the the
682 $path unchanged.
683 Mainly used to exclude version control administrative directories from
685 installation.
686 platform_constants
688 my $make_frag = $mm->platform_constants
690 Returns a make fragment defining all the macros initialized in
692 init_platform() rather than put them in constants().
693
695 Michael G Schwern <schwern@pobox.com> and the denizens of
696 makemaker@perl.org with code from ExtUtils::MM_Unix and
697 ExtUtils::MM_Win32.
698perl v5.16.3 2013-06-14 ExtUtils::MM_Any(3)