AutoSplit - split a package for autoloading
autosplit($file, $dir, $keep, $check, $modtime);autosplit_lib_modules(@modules);This function will split up your program into files that the AutoLoader module can handle. It is used by both the standard perl libraries and by the MakeMaker utility, to automatically configure libraries for autoloading.
Theautosplit interface splits the specified file into a hierarchy rooted at the directory$dir. It creates directories as needed to reflect class hierarchy, and creates the fileautosplit.ix. This file acts as both forward declaration of all package routines, and as timestamp for the last update of the hierarchy.
The remaining three arguments toautosplit govern other options to the autosplitter.
If the third argument,$keep, is false, then any pre-existing*.al files in the autoload directory are removed if they are no longer part of the module (obsoleted functions). $keep defaults to 0.
The fourth argument,$check, instructsautosplit to check the module currently being split to ensure that it includes ause specification for the AutoLoader module, and skips the module if AutoLoader is not detected. $check defaults to 1.
Lastly, the$modtime argument specifies thatautosplit is to check the modification time of the module against that of theautosplit.ix file, and only split the module if it is newer. $modtime defaults to 1.
Typical use of AutoSplit in the perl MakeMaker utility is via the command-line with:
perl -e 'use AutoSplit; autosplit($ARGV[0], $ARGV[1], 0, 1, 1)'Defined as a Make macro, it is invoked with file and directory arguments;autosplit will split the specified file into the specified directory and delete obsolete.al files, after checking first that the module does use the AutoLoader, and ensuring that the module is not already currently split in its current form (the modtime test).
Theautosplit_lib_modules form is used in the building of perl. It takes as input a list of files (modules) that are assumed to reside in a directorylib relative to the current directory. Each file is sent to the autosplitter one at a time, to be split into the directorylib/auto.
In both usages of the autosplitter, only subroutines defined following the perl__END__ token are split out into separate files. Some routines may be placed prior to this marker to force their immediate loading and parsing.
As of version 1.01 of the AutoSplit module it is possible to have multiple packages within a single file. Both of the following cases are supported:
package NAME;__END__sub AAA { ... }package NAME::option1;sub BBB { ... }package NAME::option2;sub BBB { ... }package NAME;__END__sub AAA { ... }sub NAME::option1::BBB { ... }sub NAME::option2::BBB { ... }AutoSplit will inform the user if it is necessary to create the top-level directory specified in the invocation. It is preferred that the script or installation process that invokesAutoSplit have created the full directory path ahead of time. This warning may indicate that the module is being split into an incorrect path.
AutoSplit will warn the user of all subroutines whose name causes potential file naming conflicts on machines with drastically limited (8 characters or less) file name length. Since the subroutine name is used as the file name, these warnings can aid in portability to such systems.
Warnings are issued and the file skipped ifAutoSplit cannot locate either the__END__ marker or a "package Name;"-style specification.
AutoSplit will also emit general diagnostics for inability to create directories or files.
Perldoc Browser is maintained by Dan Book (DBOOK). Please contact him via theGitHub issue tracker oremail regarding any issues with the site itself, search, or rendering of documentation.
The Perl documentation is maintained by the Perl 5 Porters in the development of Perl. Please contact them via thePerl issue tracker, themailing list, orIRC to report any issues with the contents or format of the documentation.