10 @EXPORT = qw(&autosplit &autosplit_lib_modules);
11 @EXPORT_OK = qw($Verbose $Keep $Maxlen $CheckForAutoloader $CheckModTime);
15 AutoSplit - split a package for autoloading
19 perl -e 'use AutoSplit; autosplit_lib_modules(@ARGV)' ...
21 use AutoSplit; autosplit($file, $dir, $keep, $check, $modtime);
23 for perl versions 5.002 and later:
25 perl -MAutoSplit -e 'autosplit($ARGV[0], $ARGV[1], $k, $chk, $modtime)' ...
29 This function will split up your program into files that the AutoLoader
30 module can handle. It is used by both the standard perl libraries and by
31 the MakeMaker utility, to automatically configure libraries for autoloading.
33 The C<autosplit> interface splits the specified file into a hierarchy
34 rooted at the directory C<$dir>. It creates directories as needed to reflect
35 class hierarchy, and creates the file F<autosplit.ix>. This file acts as
36 both forward declaration of all package routines, and as timestamp for the
37 last update of the hierarchy.
39 The remaining three arguments to C<autosplit> govern other options to the
40 autosplitter. If the third argument, I<$keep>, is false, then any pre-existing
41 C<.al> files in the autoload directory are removed if they are no longer
42 part of the module (obsoleted functions). The fourth argument, I<$check>,
43 instructs C<autosplit> to check the module currently being split to ensure
44 that it does include a C<use> specification for the AutoLoader module, and
45 skips the module if AutoLoader is not detected. Lastly, the I<$modtime>
46 argument specifies that C<autosplit> is to check the modification time of the
47 module against that of the C<autosplit.ix> file, and only split the module
50 Typical use of AutoSplit in the perl MakeMaker utility is via the command-line
53 perl -e 'use AutoSplit; autosplit($ARGV[0], $ARGV[1], 0, 1, 1)'
55 Defined as a Make macro, it is invoked with file and directory arguments;
56 C<autosplit> will split the specified file into the specified directory and
57 delete obsolete C<.al> files, after checking first that the module does use
58 the AutoLoader, and ensuring that the module is not already currently split
59 in its current form (the modtime test).
61 The C<autosplit_lib_modules> form is used in the building of perl. It takes
62 as input a list of files (modules) that are assumed to reside in a directory
63 B<lib> relative to the current directory. Each file is sent to the
64 autosplitter one at a time, to be split into the directory B<lib/auto>.
66 In both usages of the autosplitter, only subroutines defined following the
67 perl special marker I<__END__> are split out into separate files. Some
68 routines may be placed prior to this marker to force their immediate loading
73 Currently, C<AutoSplit> cannot handle multiple package specifications
78 C<AutoSplit> will inform the user if it is necessary to create the top-level
79 directory specified in the invocation. It is preferred that the script or
80 installation process that invokes C<AutoSplit> have created the full directory
81 path ahead of time. This warning may indicate that the module is being split
82 into an incorrect path.
84 C<AutoSplit> will warn the user of all subroutines whose name causes potential
85 file naming conflicts on machines with drastically limited (8 characters or
86 less) file name length. Since the subroutine name is used as the file name,
87 these warnings can aid in portability to such systems.
89 Warnings are issued and the file skipped if C<AutoSplit> cannot locate either
90 the I<__END__> marker or a "package Name;"-style specification.
92 C<AutoSplit> will also emit general diagnostics for inability to create
97 # for portability warn about names longer than $maxlen
98 $Maxlen = 8; # 8 for dos, 11 (14-".al") for SYSVR3
99 $Verbose = 1; # 0=none, 1=minimal, 2=list .al files
101 $CheckForAutoloader = 1;
104 $IndexFile = "autosplit.ix"; # file also serves as timestamp
106 $maxflen = 14 if $Config{'d_flexfnam'} ne 'define';
107 $Is_VMS = ($^O eq 'VMS');
111 my($file, $autodir, $k, $ckal, $ckmt) = @_;
112 # $file - the perl source file to be split (after __END__)
113 # $autodir - the ".../auto" dir below which to write split subs
114 # Handle optional flags:
115 $keep = $Keep unless defined $k;
116 $ckal = $CheckForAutoloader unless defined $ckal;
117 $ckmt = $CheckModTime unless defined $ckmt;
118 autosplit_file($file, $autodir, $keep, $ckal, $ckmt);
122 # This function is used during perl building/installation
123 # ./miniperl -e 'use AutoSplit; autosplit_lib_modules(@ARGV)' ...
125 sub autosplit_lib_modules{
126 my(@modules) = @_; # list of Module names
129 s#::#/#g; # incase specified as ABC::XYZ
130 s|\\|/|g; # bug in ksh OS/2
131 s#^lib/##; # incase specified as lib/*.pm
132 if ($Is_VMS && /[:>\]]/) { # may need to convert VMS-style filespecs
133 my ($dir,$name) = (/(.*])(.*)/);
134 $dir =~ s/.*lib[\.\]]//;
135 $dir =~ s#[\.\]]#/#g;
138 autosplit_file("lib/$_", "lib/auto", $Keep, $CheckForAutoloader, $CheckModTime);
147 my($filename, $autodir, $keep, $check_for_autoloader, $check_mod_time) = @_;
150 # where to write output files
151 $autodir = "lib/auto" unless $autodir;
152 ($autodir = VMS::Filespec::unixpath($autodir)) =~ s#/$## if $Is_VMS;
153 unless (-d $autodir){
155 foreach(split(/\//,$autodir)){
158 mkdir("@p",0755) or die "AutoSplit unable to mkdir @p: $!";
160 # We should never need to create the auto dir here. installperl
161 # (or similar) should have done it. Expecting it to exist is a valuable
162 # sanity check against autosplitting into some random directory by mistake.
163 print "Warning: AutoSplit had to create top-level $autodir unexpectedly.\n";
166 # allow just a package name to be used
167 $filename .= ".pm" unless ($filename =~ m/\.pm$/);
169 open(IN, "<$filename") || die "AutoSplit: Can't open $filename: $!\n";
170 my($pm_mod_time) = (stat($filename))[9];
171 my($autoloader_seen) = 0;
176 $in_pod = 0 if /^=cut/;
177 next if ($in_pod || /^=cut/);
179 # record last package name seen
180 $package = $1 if (m/^\s*package\s+([\w:]+)\s*;/);
181 ++$autoloader_seen if m/^\s*(use|require)\s+AutoLoader\b/;
182 ++$autoloader_seen if m/\bISA\s*=.*\bAutoLoader\b/;
185 if ($check_for_autoloader && !$autoloader_seen){
186 print "AutoSplit skipped $filename: no AutoLoader used\n" if ($Verbose>=2);
189 $_ or die "Can't find __END__ in $filename\n";
191 $package or die "Can't find 'package Name;' in $filename\n";
193 my($modpname) = $package; $modpname =~ s#::#/#g;
194 my($al_idx_file) = "$autodir/$modpname/$IndexFile";
196 die "Package $package does not match filename $filename"
197 unless ($filename =~ m/$modpname.pm$/ or
198 $Is_VMS && $filename =~ m/$modpname.pm/i);
200 if ($check_mod_time){
201 my($al_ts_time) = (stat("$al_idx_file"))[9] || 1;
202 if ($al_ts_time >= $pm_mod_time){
203 print "AutoSplit skipped ($al_idx_file newer that $filename)\n"
205 return undef; # one undef, not a list
209 my($from) = ($Verbose>=2) ? "$filename => " : "";
210 print "AutoSplitting $package ($from$autodir/$modpname)\n"
213 unless (-d "$autodir/$modpname"){
215 foreach(split(/\//,"$autodir/$modpname")){
218 mkdir("@p",0777) or die "AutoSplit unable to mkdir @p: $!";
222 # We must try to deal with some SVR3 systems with a limit of 14
223 # characters for file names. Sadly we *cannot* simply truncate all
224 # file names to 14 characters on these systems because we *must*
225 # create filenames which exactly match the names used by AutoLoader.pm.
226 # This is a problem because some systems silently truncate the file
227 # names while others treat long file names as an error.
229 # We do not yet deal with multiple packages within one file.
230 # Ideally both of these styles should work.
235 # package NAME::option1;
237 # package NAME::option2;
243 # sub NAME::option1::BBB { ... }
244 # sub NAME::option2::BBB { ... }
246 # For now both of these produce warnings.
248 open(OUT,">/dev/null") || open(OUT,">nla0:"); # avoid 'not opened' warning
249 my(@subnames, %proto);
251 if (/^package ([\w:]+)\s*;/) {
252 warn "package $1; in AutoSplit section ignored. Not currently supported.";
254 if (/^sub\s+([\w:]+)(\s*\(.*?\))?/) {
257 $proto{$1} = $2 or '';
258 if ($subname =~ m/::/){
259 warn "subs with package names not currently supported in AutoSplit section";
261 push(@subnames, $subname);
262 my($lname, $sname) = ($subname, substr($subname,0,$maxflen-3));
263 my($lpath) = "$autodir/$modpname/$lname.al";
264 my($spath) = "$autodir/$modpname/$sname.al";
265 unless(open(OUT, ">$lpath")){
266 open(OUT, ">$spath") or die "Can't create $spath: $!\n";
267 push(@names, $sname);
268 print " writing $spath (with truncated name)\n"
271 push(@names, $lname);
272 print " writing $lpath\n" if ($Verbose>=2);
274 print OUT "# NOTE: Derived from $filename. ",
275 "Changes made here will be lost.\n";
276 print OUT "package $package;\n\n";
284 if (!$keep){ # don't keep any obsolete *.al files in the directory
286 @names{@names} = @names;
287 opendir(OUTDIR,"$autodir/$modpname");
288 foreach(sort readdir(OUTDIR)){
290 my($subname) = m/(.*)\.al$/;
291 next if $names{substr($subname,0,$maxflen-3)};
292 my($file) = "$autodir/$modpname/$_";
293 print " deleting $file\n" if ($Verbose>=2);
294 my($deleted,$thistime); # catch all versions on VMS
295 do { $deleted += ($thistime = unlink $file) } while ($thistime);
296 carp "Unable to delete $file: $!" unless $deleted;
301 open(TS,">$al_idx_file") or
302 carp "AutoSplit: unable to create timestamp file ($al_idx_file): $!";
303 print TS "# Index created by AutoSplit for $filename (file acts as timestamp)\n";
304 print TS "package $package;\n";
305 print TS map("sub $_$proto{$_} ;\n", @subnames);
309 check_unique($package, $Maxlen, 1, @names);
316 my($module, $maxlen, $warn, @names) = @_;
319 my(@toolong) = grep(length > $maxlen, @names);
322 my($trunc) = substr($_,0,$maxlen);
323 $notuniq{$trunc}=1 if $shorts{$trunc};
324 $shorts{$trunc} = ($shorts{$trunc}) ? "$shorts{$trunc}, $_" : $_;
326 if (%notuniq && $warn){
327 print "$module: some names are not unique when truncated to $maxlen characters:\n";
328 foreach(keys %notuniq){
329 print " $shorts{$_} truncate to $_\n";
338 # test functions so AutoSplit.pm can be applied to itself:
339 sub test1{ "test 1\n"; }
340 sub test2{ "test 2\n"; }
341 sub test3{ "test 3\n"; }
342 sub test4{ "test 4\n"; }