4 use Config qw(%Config);
7 use File::Path qw(mkpath);
10 $VERSION @ISA @EXPORT @EXPORT_OK
11 $Verbose $Keep $Maxlen $CheckForAutoloader $CheckModTime
16 @EXPORT = qw(&autosplit &autosplit_lib_modules);
17 @EXPORT_OK = qw($Verbose $Keep $Maxlen $CheckForAutoloader $CheckModTime);
21 AutoSplit - split a package for autoloading
25 autosplit($file, $dir, $keep, $check, $modtime);
27 autosplit_lib_modules(@modules);
31 This function will split up your program into files that the AutoLoader
32 module can handle. It is used by both the standard perl libraries and by
33 the MakeMaker utility, to automatically configure libraries for autoloading.
35 The C<autosplit> interface splits the specified file into a hierarchy
36 rooted at the directory C<$dir>. It creates directories as needed to reflect
37 class hierarchy, and creates the file F<autosplit.ix>. This file acts as
38 both forward declaration of all package routines, and as timestamp for the
39 last update of the hierarchy.
41 The remaining three arguments to C<autosplit> govern other options to
48 If the third argument, I<$keep>, is false, then any
49 pre-existing C<*.al> files in the autoload directory are removed if
50 they are no longer part of the module (obsoleted functions).
56 fourth argument, I<$check>, instructs C<autosplit> to check the module
57 currently being split to ensure that it does include a C<use>
58 specification for the AutoLoader module, and skips the module if
59 AutoLoader is not detected.
64 Lastly, the I<$modtime> argument specifies
65 that C<autosplit> is to check the modification time of the module
66 against that of the C<autosplit.ix> file, and only split the module if
68 $modtime defaults to 1.
72 Typical use of AutoSplit in the perl MakeMaker utility is via the command-line
75 perl -e 'use AutoSplit; autosplit($ARGV[0], $ARGV[1], 0, 1, 1)'
77 Defined as a Make macro, it is invoked with file and directory arguments;
78 C<autosplit> will split the specified file into the specified directory and
79 delete obsolete C<.al> files, after checking first that the module does use
80 the AutoLoader, and ensuring that the module is not already currently split
81 in its current form (the modtime test).
83 The C<autosplit_lib_modules> form is used in the building of perl. It takes
84 as input a list of files (modules) that are assumed to reside in a directory
85 B<lib> relative to the current directory. Each file is sent to the
86 autosplitter one at a time, to be split into the directory B<lib/auto>.
88 In both usages of the autosplitter, only subroutines defined following the
89 perl I<__END__> token are split out into separate files. Some
90 routines may be placed prior to this marker to force their immediate loading
93 =head2 Multiple packages
95 As of version 1.01 of the AutoSplit module it is possible to have
96 multiple packages within a single file. Both of the following cases
102 package NAME::option1;
104 package NAME::option2;
110 sub NAME::option1::BBB { ... }
111 sub NAME::option2::BBB { ... }
115 C<AutoSplit> will inform the user if it is necessary to create the
116 top-level directory specified in the invocation. It is preferred that
117 the script or installation process that invokes C<AutoSplit> have
118 created the full directory path ahead of time. This warning may
119 indicate that the module is being split into an incorrect path.
121 C<AutoSplit> will warn the user of all subroutines whose name causes
122 potential file naming conflicts on machines with drastically limited
123 (8 characters or less) file name length. Since the subroutine name is
124 used as the file name, these warnings can aid in portability to such
127 Warnings are issued and the file skipped if C<AutoSplit> cannot locate
128 either the I<__END__> marker or a "package Name;"-style specification.
130 C<AutoSplit> will also emit general diagnostics for inability to
131 create directories or files.
135 # for portability warn about names longer than $maxlen
136 $Maxlen = 8; # 8 for dos, 11 (14-".al") for SYSVR3
137 $Verbose = 1; # 0=none, 1=minimal, 2=list .al files
139 $CheckForAutoloader = 1;
142 my $IndexFile = "autosplit.ix"; # file also serves as timestamp
144 $maxflen = 14 if $Config{'d_flexfnam'} ne 'define';
145 if (defined (&Dos::UseLFN)) {
146 $maxflen = Dos::UseLFN() ? 255 : 11;
148 my $Is_VMS = ($^O eq 'VMS');
150 # allow checking for valid ': attrlist' attachments
152 $nested = qr{ \( (?: (?> [^()]+ ) | (?p{ $nested }) )* \) }x;
153 my $one_attr = qr{ (?> (?! \d) \w+ (?:$nested)? ) [\s,]* }x;
154 my $attr_list = qr{ \s* : \s* (?: $one_attr )* }x;
159 my($file, $autodir, $keep, $ckal, $ckmt) = @_;
160 # $file - the perl source file to be split (after __END__)
161 # $autodir - the ".../auto" dir below which to write split subs
162 # Handle optional flags:
163 $keep = $Keep unless defined $keep;
164 $ckal = $CheckForAutoloader unless defined $ckal;
165 $ckmt = $CheckModTime unless defined $ckmt;
166 autosplit_file($file, $autodir, $keep, $ckal, $ckmt);
170 # This function is used during perl building/installation
171 # ./miniperl -e 'use AutoSplit; autosplit_lib_modules(@ARGV)' ...
173 sub autosplit_lib_modules{
174 my(@modules) = @_; # list of Module names
176 while(defined($_ = shift @modules)){
177 s#::#/#g; # incase specified as ABC::XYZ
178 s|\\|/|g; # bug in ksh OS/2
179 s#^lib/##; # incase specified as lib/*.pm
180 if ($Is_VMS && /[:>\]]/) { # may need to convert VMS-style filespecs
181 my ($dir,$name) = (/(.*])(.*)/);
182 $dir =~ s/.*lib[\.\]]//;
183 $dir =~ s#[\.\]]#/#g;
186 autosplit_file("lib/$_", "lib/auto",
187 $Keep, $CheckForAutoloader, $CheckModTime);
196 my($filename, $autodir, $keep, $check_for_autoloader, $check_mod_time)
202 # where to write output files
203 $autodir ||= "lib/auto";
205 ($autodir = VMS::Filespec::unixpath($autodir)) =~ s|/$||;
206 $filename = VMS::Filespec::unixify($filename); # may have dirs
208 unless (-d $autodir){
209 mkpath($autodir,0,0755);
210 # We should never need to create the auto dir
211 # here. installperl (or similar) should have done
212 # it. Expecting it to exist is a valuable sanity check against
213 # autosplitting into some random directory by mistake.
214 print "Warning: AutoSplit had to create top-level " .
215 "$autodir unexpectedly.\n";
218 # allow just a package name to be used
219 $filename .= ".pm" unless ($filename =~ m/\.pm$/);
221 open(IN, "<$filename") or die "AutoSplit: Can't open $filename: $!\n";
222 my($pm_mod_time) = (stat($filename))[9];
223 my($autoloader_seen) = 0;
225 my($def_package,$last_package,$this_package,$fnr);
229 $in_pod = 1 if /^=\w/;
230 $in_pod = 0 if /^=cut/;
231 next if ($in_pod || /^=cut/);
233 # record last package name seen
234 $def_package = $1 if (m/^\s*package\s+([\w:]+)\s*;/);
235 ++$autoloader_seen if m/^\s*(use|require)\s+AutoLoader\b/;
236 ++$autoloader_seen if m/\bISA\s*=.*\bAutoLoader\b/;
239 if ($check_for_autoloader && !$autoloader_seen){
240 print "AutoSplit skipped $filename: no AutoLoader used\n"
244 $_ or die "Can't find __END__ in $filename\n";
246 $def_package or die "Can't find 'package Name;' in $filename\n";
248 my($modpname) = _modpname($def_package);
250 # this _has_ to match so we have a reasonable timestamp file
251 die "Package $def_package ($modpname.pm) does not ".
252 "match filename $filename"
253 unless ($filename =~ m/\Q$modpname.pm\E$/ or
254 ($^O eq 'dos') or ($^O eq 'MSWin32') or
255 $Is_VMS && $filename =~ m/$modpname.pm/i);
257 my($al_idx_file) = "$autodir/$modpname/$IndexFile";
259 if ($check_mod_time){
260 my($al_ts_time) = (stat("$al_idx_file"))[9] || 1;
261 if ($al_ts_time >= $pm_mod_time){
262 print "AutoSplit skipped ($al_idx_file newer than $filename)\n"
264 return undef; # one undef, not a list
268 print "AutoSplitting $filename ($autodir/$modpname)\n"
271 unless (-d "$autodir/$modpname"){
272 mkpath("$autodir/$modpname",0,0777);
275 # We must try to deal with some SVR3 systems with a limit of 14
276 # characters for file names. Sadly we *cannot* simply truncate all
277 # file names to 14 characters on these systems because we *must*
278 # create filenames which exactly match the names used by AutoLoader.pm.
279 # This is a problem because some systems silently truncate the file
280 # names while others treat long file names as an error.
282 my $Is83 = $maxflen==11; # plain, case INSENSITIVE dos filenames
284 my(@subnames, $subname, %proto, %package);
290 $in_pod = 1 if /^=\w/;
291 $in_pod = 0 if /^=cut/;
292 next if ($in_pod || /^=cut/);
293 # the following (tempting) old coding gives big troubles if a
294 # cut is forgotten at EOF:
295 # next if /^=\w/ .. /^=cut/;
296 if (/^package\s+([\w:]+)\s*;/) {
297 $this_package = $def_package = $1;
299 if (/^sub\s+([\w:]+)(\s*(?:\(.*?\))?(?:$attr_list)?)/) {
300 print OUT "# end of $last_package\::$subname\n1;\n"
303 my $proto = $2 || '';
304 if ($subname =~ s/(.*):://){
307 $this_package = $def_package;
309 my $fq_subname = "$this_package\::$subname";
310 $package{$fq_subname} = $this_package;
311 $proto{$fq_subname} = $proto;
312 push(@subnames, $fq_subname);
313 my($lname, $sname) = ($subname, substr($subname,0,$maxflen-3));
314 $modpname = _modpname($this_package);
315 mkpath("$autodir/$modpname",0,0777);
316 my($lpath) = "$autodir/$modpname/$lname.al";
317 my($spath) = "$autodir/$modpname/$sname.al";
319 if (!$Is83 and open(OUT, ">$lpath")){
321 print " writing $lpath\n" if ($Verbose>=2);
323 open(OUT, ">$spath") or die "Can't create $spath: $!\n";
325 print " writing $spath (with truncated name)\n"
328 push(@outfiles, $path);
330 # NOTE: Derived from $filename.
331 # Changes made here will be lost when autosplit again.
333 package $this_package;
335 #line $fnr "$filename (autosplit into $path)"
342 push(@cache, $_) if @cache || /\S/;
354 $last_package = $this_package if defined $this_package;
356 print OUT @cache,"1;\n# end of $last_package\::$subname\n";
360 if (!$keep){ # don't keep any obsolete *.al files in the directory
362 # @outfiles{@outfiles} = @outfiles;
363 # perl downcases all filenames on VMS (which upcases all filenames) so
364 # we'd better downcase the sub name list too, or subs with upper case
365 # letters in them will get their .al files deleted right after they're
366 # created. (The mixed case sub name won't match the all-lowercase
367 # filename, and so be cleaned up as a scrap file)
368 if ($Is_VMS or $Is83) {
369 %outfiles = map {lc($_) => lc($_) } @outfiles;
371 @outfiles{@outfiles} = @outfiles;
373 my(%outdirs,@outdirs);
375 $outdirs{File::Basename::dirname($_)}||=1;
377 for my $dir (keys %outdirs) {
378 opendir(OUTDIR,$dir);
379 foreach (sort readdir(OUTDIR)){
381 my($file) = "$dir/$_";
382 $file = lc $file if $Is83 or $Is_VMS;
383 next if $outfiles{$file};
384 print " deleting $file\n" if ($Verbose>=2);
385 my($deleted,$thistime); # catch all versions on VMS
386 do { $deleted += ($thistime = unlink $file) } while ($thistime);
387 carp "Unable to delete $file: $!" unless $deleted;
393 open(TS,">$al_idx_file") or
394 carp "AutoSplit: unable to create timestamp file ($al_idx_file): $!";
395 print TS "# Index created by AutoSplit for $filename\n";
396 print TS "# (file acts as timestamp)\n";
398 for my $fqs (@subnames) {
400 $subname =~ s/.*:://;
401 print TS "package $package{$fqs};\n"
402 unless $last_package eq $package{$fqs};
403 print TS "sub $subname $proto{$fqs};\n";
404 $last_package = $package{$fqs};
409 _check_unique($filename, $Maxlen, 1, @outfiles);
416 my $modpname = $package;
417 if ($^O eq 'MSWin32') {
418 $modpname =~ s#::#\\#g;
420 $modpname =~ s#::#/#g;
426 my($filename, $maxlen, $warn, @outfiles) = @_;
430 length(File::Basename::basename($_))
436 my($dir) = File::Basename::dirname($_);
437 my($file) = File::Basename::basename($_);
438 my($trunc) = substr($file,0,$maxlen);
439 $notuniq{$dir}{$trunc} = 1 if $shorts{$dir}{$trunc};
440 $shorts{$dir}{$trunc} = $shorts{$dir}{$trunc} ?
441 "$shorts{$dir}{$trunc}, $file" : $file;
443 if (%notuniq && $warn){
444 print "$filename: some names are not unique when " .
445 "truncated to $maxlen characters:\n";
446 foreach my $dir (sort keys %notuniq){
447 print " directory $dir:\n";
448 foreach my $trunc (sort keys %{$notuniq{$dir}}) {
449 print " $shorts{$dir}{$trunc} truncate to $trunc\n";
458 # test functions so AutoSplit.pm can be applied to itself:
459 sub test1 ($) { "test 1\n"; }
460 sub test2 ($$) { "test 2\n"; }
461 sub test3 ($$$) { "test 3\n"; }
462 sub testtesttesttest4_1 { "test 4\n"; }
463 sub testtesttesttest4_2 { "duplicate test 4\n"; }
464 sub Just::Another::test5 { "another test 5\n"; }
465 sub test6 { return join ":", __FILE__,__LINE__; }
466 package Yet::Another::AutoSplit;
467 sub testtesttesttest4_1 ($) { "another test 4\n"; }
468 sub testtesttesttest4_2 ($$) { "another duplicate test 4\n"; }
469 package Yet::More::Attributes;
470 sub test_a1 ($) : locked { 1; }
471 sub test_a2 : locked { 1; }