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 can_run
85 use ExtUtils::MM;
87 my $runnable = MM->can_run($Config{make});
88 If called in a scalar context it will return the full path to the
90 binary you asked for if it was found, or "undef" if it was not.
91 If called in a list context, it will return a list of the full paths to
93 instances of the binary where found in "PATH", or an empty list if it
94 was not found.
95 Copied from IPC::Cmd, but modified into a method (and removed
97 $INSTANCES capability).
98 can_redirect_error
100 $useredirect = MM->can_redirect_error;
102 True if on an OS where qx operator (or backticks) can redirect "STDERR"
104 onto "STDOUT".
105 is_make_type
107 my $is_dmake = $self->is_make_type('dmake');
109 Returns true if "$self->make" is the given type; possibilities are:
111 gmake GNU make
113 dmake
114 nmake
115 bsdmake BSD pmake-derived
116 can_dep_space
118 my $can_dep_space = $self->can_dep_space;
120 Returns true if "make" can handle (probably by quoting) dependencies
122 that contain a space. Currently known true for GNU make, false for BSD
123 pmake derivative.
124 quote_dep
126 $text = $mm->quote_dep($text);
128 Method that protects Makefile single-value constants (mainly
130 filenames), so that make will still treat them as single values even if
131 they inconveniently have spaces in. If the make program being used
132 cannot achieve such protection and the given text would need it, throws
133 an exception.
134 split_command
136 my @cmds = $MM->split_command($cmd, @args);
138 Most OS have a maximum command length they can execute at once. Large
140 modules can easily generate commands well past that limit. Its
141 necessary to split long commands up into a series of shorter commands.
142 "split_command" will return a series of @cmds each processing part of
144 the args. Collectively they will process all the arguments. Each
145 individual line in @cmds will not be longer than the
146 $self->max_exec_len being careful to take into account macro expansion.
147 $cmd should include any switches and repeated initial arguments.
149 If no @args are given, no @cmds will be returned.
151 Pairs of arguments will always be preserved in a single command, this
153 is a heuristic for things like pm_to_blib and pod2man which work on
154 pairs of arguments. This makes things like this safe:
155 $self->split_command($cmd, %pod2man);
157 make_type
159 Returns a suitable string describing the type of makefile being
161 written.
162 stashmeta
164 my @recipelines = $MM->stashmeta($text, $file);
166 Generates a set of @recipelines which will result in the literal $text
168 ending up in literal $file when the recipe is executed. Call it once,
169 with all the text you want in $file. Make macros will not be expanded,
170 so the locations will be fixed at configure-time, not at build-time.
171 echo
173 my @commands = $MM->echo($text);
175 my @commands = $MM->echo($text, $file);
176 my @commands = $MM->echo($text, $file, \%opts);
177 Generates a set of @commands which print the $text to a $file.
179 If $file is not given, output goes to STDOUT.
181 If $opts{append} is true the $file will be appended to rather than
183 overwritten. Default is to overwrite.
184 If $opts{allow_variables} is true, make variables of the form "$(...)"
186 will not be escaped. Other "$" will. Default is to escape all "$".
187 Example of use:
189 my $make = join '', map "\t$_\n", $MM->echo($text, $file);
191 wraplist
193 my $args = $mm->wraplist(@list);
195 Takes an array of items and turns them into a well-formatted list of
197 arguments. In most cases this is simply something like:
198 FOO \
200 BAR \
201 BAZ
202 maketext_filter
204 my $filter_make_text = $mm->maketext_filter($make_text);
206 The text of the Makefile is run through this method before writing to
208 disk. It allows systems a chance to make portability fixes to the
209 Makefile.
210 By default it does nothing.
212 This method is protected and not intended to be called outside of
214 MakeMaker.
215 cd Abstract
217 my $subdir_cmd = $MM->cd($subdir, @cmds);
219 This will generate a make fragment which runs the @cmds in the given
221 $dir. The rough equivalent to this, except cross platform.
222 cd $subdir && $cmd
224 Currently $dir can only go down one level. "foo" is fine. "foo/bar"
226 is not. "../foo" is right out.
227 The resulting $subdir_cmd has no leading tab nor trailing newline.
229 This makes it easier to embed in a make string. For example.
230 my $make = sprintf <<'CODE', $subdir_cmd;
232 foo :
233 $(ECHO) what
234 %s
235 $(ECHO) mouche
236 CODE
237 oneliner Abstract
239 my $oneliner = $MM->oneliner($perl_code);
241 my $oneliner = $MM->oneliner($perl_code, \@switches);
242 This will generate a perl one-liner safe for the particular platform
244 you're on based on the given $perl_code and @switches (a -e is assumed)
245 suitable for using in a make target. It will use the proper shell
246 quoting and escapes.
247 $(PERLRUN) will be used as perl.
249 Any newlines in $perl_code will be escaped. Leading and trailing
251 newlines will be stripped. Makes this idiom much easier:
252 my $code = $MM->oneliner(<<'CODE', [...switches...]);
254 some code here
255 another line here
256 CODE
257 Usage might be something like:
259 # an echo emulation
261 $oneliner = $MM->oneliner('print "Foo\n"');
262 $make = '$oneliner > somefile';
263 Dollar signs in the $perl_code will be protected from make using the
265 "quote_literal" method, unless they are recognised as being a make
266 variable, "$(varname)", in which case they will be left for make to
267 expand. Remember to quote make macros else it might be used as a
268 bareword. For example:
269 # Assign the value of the $(VERSION_FROM) make macro to $vf.
271 $oneliner = $MM->oneliner('$vf = "$(VERSION_FROM)"');
272 Its currently very simple and may be expanded sometime in the figure to
274 include more flexible code and switches.
275 quote_literal Abstract
277 my $safe_text = $MM->quote_literal($text);
279 my $safe_text = $MM->quote_literal($text, \%options);
280 This will quote $text so it is interpreted literally in the shell.
282 For example, on Unix this would escape any single-quotes in $text and
284 put single-quotes around the whole thing.
285 If $options{allow_variables} is true it will leave '$(FOO)' make
287 variables untouched. If false they will be escaped like any other "$".
288 Defaults to true.
289 escape_dollarsigns
291 my $escaped_text = $MM->escape_dollarsigns($text);
293 Escapes stray "$" so they are not interpreted as make variables.
295 It lets by "$(...)".
297 escape_all_dollarsigns
299 my $escaped_text = $MM->escape_all_dollarsigns($text);
301 Escapes all "$" so they are not interpreted as make variables.
303 escape_newlines Abstract
305 my $escaped_text = $MM->escape_newlines($text);
307 Shell escapes newlines in $text.
309 max_exec_len Abstract
311 my $max_exec_len = $MM->max_exec_len;
313 Calculates the maximum command size the OS can exec. Effectively, this
315 is the max size of a shell command line.
316 make
318 my $make = $MM->make;
320 Returns the make variant we're generating the Makefile for. This
322 attempts to do some normalization on the information from %Config or
323 the user.
324 Targets
326 These are methods which produce make targets.
327 all_target
329 Generate the default target 'all'.
331 blibdirs_target
333 my $make_frag = $mm->blibdirs_target;
335 Creates the blibdirs target which creates all the directories we use in
337 blib/.
338 The blibdirs.ts target is deprecated. Depend on blibdirs instead.
340 clean (o)
342 Defines the clean target.
344 clean_subdirs_target
346 my $make_frag = $MM->clean_subdirs_target;
348 Returns the clean_subdirs target. This is used by the clean target to
350 call clean on any subdirectories which contain Makefiles.
351 dir_target
353 my $make_frag = $mm->dir_target(@directories);
355 Generates targets to create the specified directories and set its
357 permission to PERM_DIR.
358 Because depending on a directory to just ensure it exists doesn't work
360 too well (the modified time changes too often) dir_target() creates a
361 .exists file in the created directory. It is this you should depend
362 on. For portability purposes you should use the $(DIRFILESEP) macro
363 rather than a '/' to separate the directory from the file.
364 yourdirectory$(DIRFILESEP).exists
366 distdir
368 Defines the scratch directory target that will hold the distribution
370 before tar-ing (or shar-ing).
371 dist_test
373 Defines a target that produces the distribution in the scratch
375 directory, and runs 'perl Makefile.PL; make ;make test' in that
376 subdirectory.
377 xs_dlsyms_arg
379 Returns command-line arg(s) to linker for file listing dlsyms to
381 export. Defaults to returning empty string, can be overridden by e.g.
382 AIX.
383 xs_dlsyms_ext
385 Returns file-extension for "xs_make_dlsyms" method's output file,
387 including any "." character.
388 xs_dlsyms_extra
390 Returns any extra text to be prepended to the $extra argument of
392 "xs_make_dlsyms".
393 xs_dlsyms_iterator
395 Iterates over necessary shared objects, calling "xs_make_dlsyms" method
397 for each with appropriate arguments.
398 xs_make_dlsyms
400 $self->xs_make_dlsyms(
402 \%attribs, # hashref from %attribs in caller
403 "$self->{BASEEXT}.def", # output file for Makefile target
404 'Makefile.PL', # dependency
405 $self->{NAME}, # shared object's "name"
406 $self->{DLBASE}, # last ::-separated part of name
407 $attribs{DL_FUNCS} || $self->{DL_FUNCS} || {}, # various params
408 $attribs{FUNCLIST} || $self->{FUNCLIST} || [],
409 $attribs{IMPORTS} || $self->{IMPORTS} || {},
410 $attribs{DL_VARS} || $self->{DL_VARS} || [],
411 # optional extra param that will be added as param to Mksymlists
412 );
413 Utility method that returns Makefile snippet to call "Mksymlists".
415 dynamic (o)
417 Defines the dynamic target.
419 makemakerdflt_target
421 my $make_frag = $mm->makemakerdflt_target
423 Returns a make fragment with the makemakerdeflt_target specified. This
425 target is the first target in the Makefile, is the default target and
426 simply points off to 'all' just in case any make variant gets confused
427 or something gets snuck in before the real 'all' target.
428 manifypods_target
430 my $manifypods_target = $self->manifypods_target;
432 Generates the manifypods target. This target generates man pages from
434 all POD files in MAN1PODS and MAN3PODS.
435 metafile_target
437 my $target = $mm->metafile_target;
439 Generate the metafile target.
441 Writes the file META.yml (YAML encoded meta-data) and META.json (JSON
443 encoded meta-data) about the module in the distdir. The format follows
444 Module::Build's as closely as possible.
445 metafile_data
447 my $metadata_hashref = $mm->metafile_data(\%meta_add, \%meta_merge);
449 Returns the data which MakeMaker turns into the META.yml file and the
451 META.json file. It is always in version 2.0 of the format.
452 Values of %meta_add will overwrite any existing metadata in those keys.
454 %meta_merge will be merged with them.
455 metafile_file
457 my $meta_yml = $mm->metafile_file(@metadata_pairs);
459 Turns the @metadata_pairs into YAML.
461 This method does not implement a complete YAML dumper, being limited to
463 dump a hash with values which are strings, undef's or nested hashes and
464 arrays of strings. No quoting/escaping is done.
465 distmeta_target
467 my $make_frag = $mm->distmeta_target;
469 Generates the distmeta target to add META.yml and META.json to the
471 MANIFEST in the distdir.
472 mymeta
474 my $mymeta = $mm->mymeta;
476 Generate MYMETA information as a hash either from an existing CPAN Meta
478 file (META.json or META.yml) or from internal data.
479 write_mymeta
481 $self->write_mymeta( $mymeta );
483 Write MYMETA information to MYMETA.json and MYMETA.yml.
485 realclean (o)
487 Defines the realclean target.
489 realclean_subdirs_target
491 my $make_frag = $MM->realclean_subdirs_target;
493 Returns the realclean_subdirs target. This is used by the realclean
495 target to call realclean on any subdirectories which contain Makefiles.
496 signature_target
498 my $target = $mm->signature_target;
500 Generate the signature target.
502 Writes the file SIGNATURE with "cpansign -s".
504 distsignature_target
506 my $make_frag = $mm->distsignature_target;
508 Generates the distsignature target to add SIGNATURE to the MANIFEST in
510 the distdir.
511 special_targets
513 my $make_frag = $mm->special_targets
515 Returns a make fragment containing any targets which have special
517 meaning to make. For example, .SUFFIXES and .PHONY.
518 Init methods
520 Methods which help initialize the MakeMaker object and macros.
521 init_ABSTRACT
523 $mm->init_ABSTRACT
525 init_INST
527 $mm->init_INST;
529 Called by init_main. Sets up all INST_* variables except those related
531 to XS code. Those are handled in init_xs.
532 init_INSTALL
534 $mm->init_INSTALL;
536 Called by init_main. Sets up all INSTALL_* variables (except
538 INSTALLDIRS) and *PREFIX.
539 init_INSTALL_from_PREFIX
541 $mm->init_INSTALL_from_PREFIX;
543 init_from_INSTALL_BASE
545 $mm->init_from_INSTALL_BASE
547 init_VERSION Abstract
549 $mm->init_VERSION
551 Initialize macros representing versions of MakeMaker and other tools
553 MAKEMAKER: path to the MakeMaker module.
555 MM_VERSION: ExtUtils::MakeMaker Version
557 MM_REVISION: ExtUtils::MakeMaker version control revision (for
559 backwards
560 compat)
561 VERSION: version of your module
563 VERSION_MACRO: which macro represents the version (usually 'VERSION')
565 VERSION_SYM: like version but safe for use as an RCS revision number
567 DEFINE_VERSION: -D line to set the module version when compiling
569 XS_VERSION: version in your .xs file. Defaults to $(VERSION)
571 XS_VERSION_MACRO: which macro represents the XS version.
573 XS_DEFINE_VERSION: -D line to set the xs version when compiling.
575 Called by init_main.
577 init_tools
579 $MM->init_tools();
581 Initializes the simple macro definitions used by tools_other() and
583 places them in the $MM object. These use conservative cross platform
584 versions and should be overridden with platform specific versions for
585 performance.
586 Defines at least these macros.
588 Macro Description
590 NOOP Do nothing
592 NOECHO Tell make not to display the command itself
593 SHELL Program used to run shell commands
595 ECHO Print text adding a newline on the end
597 RM_F Remove a file
598 RM_RF Remove a directory
599 TOUCH Update a file's timestamp
600 TEST_F Test for a file's existence
601 TEST_S Test the size of a file
602 CP Copy a file
603 CP_NONEMPTY Copy a file if it is not empty
604 MV Move a file
605 CHMOD Change permissions on a file
606 FALSE Exit with non-zero
607 TRUE Exit with zero
608 UMASK_NULL Nullify umask
610 DEV_NULL Suppress all command output
611 init_others
613 $MM->init_others();
615 Initializes the macro definitions having to do with compiling and
617 linking used by tools_other() and places them in the $MM object.
618 If there is no description, its the same as the parameter to
620 WriteMakefile() documented in ExtUtils::MakeMaker.
621 tools_other
623 my $make_frag = $MM->tools_other;
625 Returns a make fragment containing definitions for the macros
627 init_others() initializes.
628 init_DIRFILESEP Abstract
630 $MM->init_DIRFILESEP;
632 my $dirfilesep = $MM->{DIRFILESEP};
633 Initializes the DIRFILESEP macro which is the separator between the
635 directory and filename in a filepath. ie. / on Unix, \ on Win32 and
636 nothing on VMS.
637 For example:
639 # instead of $(INST_ARCHAUTODIR)/extralibs.ld
641 $(INST_ARCHAUTODIR)$(DIRFILESEP)extralibs.ld
642 Something of a hack but it prevents a lot of code duplication between
644 MM_* variants.
645 Do not use this as a separator between directories. Some operating
647 systems use different separators between subdirectories as between
648 directories and filenames (for example: VOLUME:[dir1.dir2]file on
649 VMS).
650 init_linker Abstract
652 $mm->init_linker;
654 Initialize macros which have to do with linking.
656 PERL_ARCHIVE: path to libperl.a equivalent to be linked to dynamic
658 extensions.
659 PERL_ARCHIVE_AFTER: path to a library which should be put on the linker
661 command line after the external libraries to be linked to dynamic
662 extensions. This may be needed if the linker is one-pass, and Perl
663 includes some overrides for C RTL functions, such as malloc().
664 EXPORT_LIST: name of a file that is passed to linker to define symbols
666 to be exported.
667 Some OSes do not need these in which case leave it blank.
669 init_platform
671 $mm->init_platform
673 Initialize any macros which are for platform specific use only.
675 A typical one is the version number of your OS specific module. (ie.
677 MM_Unix_VERSION or MM_VMS_VERSION).
678 init_MAKE
680 $mm->init_MAKE
682 Initialize MAKE from either a MAKE environment variable or
684 $Config{make}.
685 Tools
687 A grab bag of methods to generate specific macros and commands.
688 manifypods
690 Defines targets and routines to translate the pods into manpages and
692 put them into the INST_* directories.
693 POD2MAN_macro
695 my $pod2man_macro = $self->POD2MAN_macro
697 Returns a definition for the POD2MAN macro. This is a program which
699 emulates the pod2man utility. You can add more switches to the command
700 by simply appending them on the macro.
701 Typical usage:
703 $(POD2MAN) --section=3 --perm_rw=$(PERM_RW) podfile1 man_page1 ...
705 test_via_harness
707 my $command = $mm->test_via_harness($perl, $tests);
709 Returns a $command line which runs the given set of $tests with
711 Test::Harness and the given $perl.
712 Used on the t/*.t files.
714 test_via_script
716 my $command = $mm->test_via_script($perl, $script);
718 Returns a $command line which just runs a single test without
720 Test::Harness. No checks are done on the results, they're just
721 printed.
722 Used for test.pl, since they don't always follow Test::Harness
724 formatting.
725 tool_autosplit
727 Defines a simple perl call that runs autosplit. May be deprecated by
729 pm_to_blib soon.
730 arch_check
732 my $arch_ok = $mm->arch_check(
734 $INC{"Config.pm"},
735 File::Spec->catfile($Config{archlibexp}, "Config.pm")
736 );
737 A sanity check that what Perl thinks the architecture is and what
739 Config thinks the architecture is are the same. If they're not it will
740 return false and show a diagnostic message.
741 When building Perl it will always return true, as nothing is installed
743 yet.
744 The interface is a bit odd because this is the result of a quick
746 refactoring. Don't rely on it.
747 File::Spec wrappers
749 ExtUtils::MM_Any is a subclass of File::Spec. The methods noted here
750 override File::Spec.
751 catfile
753 File::Spec <= 0.83 has a bug where the file part of catfile is not
755 canonicalized. This override fixes that bug.
756 Misc
758 Methods I can't really figure out where they should go yet.
759 find_tests
761 my $test = $mm->find_tests;
763 Returns a string suitable for feeding to the shell to return all tests
765 in t/*.t.
766 find_tests_recursive
768 my $tests = $mm->find_tests_recursive;
770 Returns a string suitable for feeding to the shell to return all tests
772 in t/ but recursively. Equivalent to
773 my $tests = $mm->find_tests_recursive_in('t');
775 find_tests_recursive_in
777 my $tests = $mm->find_tests_recursive_in($dir);
779 Returns a string suitable for feeding to the shell to return all tests
781 in $dir recursively.
782 extra_clean_files
784 my @files_to_clean = $MM->extra_clean_files;
786 Returns a list of OS specific files to be removed in the clean target
788 in addition to the usual set.
789 installvars
791 my @installvars = $mm->installvars;
793 A list of all the INSTALL* variables without the INSTALL prefix.
795 Useful for iteration or building related variable sets.
796 libscan
798 my $wanted = $self->libscan($path);
800 Takes a path to a file or dir and returns an empty string if we don't
802 want to include this file in the library. Otherwise it returns the the
803 $path unchanged.
804 Mainly used to exclude version control administrative directories and
806 base-level README.pod from installation.
807 platform_constants
809 my $make_frag = $mm->platform_constants
811 Returns a make fragment defining all the macros initialized in
813 init_platform() rather than put them in constants().
814 post_constants (o)
816 Returns an empty string per default. Dedicated to overrides from within
818 Makefile.PL after all constants have been defined.
819 post_initialize (o)
821 Returns an empty string per default. Used in Makefile.PLs to add some
823 chunk of text to the Makefile after the object is initialized.
824 postamble (o)
826 Returns an empty string. Can be used in Makefile.PLs to write some text
828 to the Makefile at the end.
829
831 Michael G Schwern <schwern@pobox.com> and the denizens of
832 makemaker@perl.org with code from ExtUtils::MM_Unix and
833 ExtUtils::MM_Win32.
834perl v5.34.0 2021-07-22 ExtUtils::MM_Any(3)