5 use Config qw(%Config);
8 use File::Path qw(mkpath);
9 use File::Spec::Functions qw(curdir catfile);
11 our($VERSION, @ISA, @EXPORT, @EXPORT_OK, $Verbose, $Keep, $Maxlen,
12 $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 includes 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{ \( (?: (?> [^()]+ ) | (??{ $nested }) )* \) }x;
153 my $one_attr = qr{ (?> (?! \d) \w+ (?:$nested)? ) (?:\s*\:\s*|\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 while (m#(.*?[^:])::([^:].*)#) { # in case specified as ABC::XYZ
178 $_ = catfile($1, $2);
180 s|\\|/|g; # bug in ksh OS/2
181 s#^lib/##s; # incase specified as lib/*.pm
182 my($lib) = catfile(curdir(), "lib");
183 if ($Is_VMS) { # may need to convert VMS-style filespecs
184 $lib =~ s#^\[\]#.\/#;
186 s#^$lib\W+##s; # incase specified as ./lib/*.pm
187 if ($Is_VMS && /[:>\]]/) { # may need to convert VMS-style filespecs
188 my ($dir,$name) = (/(.*])(.*)/s);
189 $dir =~ s/.*lib[\.\]]//s;
190 $dir =~ s#[\.\]]#/#g;
193 autosplit_file(catfile($lib, $_), catfile($lib, "auto"),
194 $Keep, $CheckForAutoloader, $CheckModTime);
202 my $self_mod_time = (stat __FILE__)[9];
205 my($filename, $autodir, $keep, $check_for_autoloader, $check_mod_time)
211 # where to write output files
212 $autodir ||= catfile(curdir(), "lib", "auto");
214 ($autodir = VMS::Filespec::unixpath($autodir)) =~ s|/\z||;
215 $filename = VMS::Filespec::unixify($filename); # may have dirs
217 unless (-d $autodir){
218 mkpath($autodir,0,0755);
219 # We should never need to create the auto dir
220 # here. installperl (or similar) should have done
221 # it. Expecting it to exist is a valuable sanity check against
222 # autosplitting into some random directory by mistake.
223 print "Warning: AutoSplit had to create top-level " .
224 "$autodir unexpectedly.\n";
227 # allow just a package name to be used
228 $filename .= ".pm" unless ($filename =~ m/\.pm\z/);
230 open(IN, "<$filename") or die "AutoSplit: Can't open $filename: $!\n";
231 my($pm_mod_time) = (stat($filename))[9];
232 my($autoloader_seen) = 0;
234 my($def_package,$last_package,$this_package,$fnr);
238 $in_pod = 1 if /^=\w/;
239 $in_pod = 0 if /^=cut/;
240 next if ($in_pod || /^=cut/);
242 # record last package name seen
243 $def_package = $1 if (m/^\s*package\s+([\w:]+)\s*;/);
244 ++$autoloader_seen if m/^\s*(use|require)\s+AutoLoader\b/;
245 ++$autoloader_seen if m/\bISA\s*=.*\bAutoLoader\b/;
248 if ($check_for_autoloader && !$autoloader_seen){
249 print "AutoSplit skipped $filename: no AutoLoader used\n"
253 $_ or die "Can't find __END__ in $filename\n";
255 $def_package or die "Can't find 'package Name;' in $filename\n";
257 my($modpname) = _modpname($def_package);
259 $modpname = VMS::Filespec::unixify($modpname); # may have dirs
262 # this _has_ to match so we have a reasonable timestamp file
263 die "Package $def_package ($modpname.pm) does not ".
264 "match filename $filename"
265 unless ($filename =~ m/\Q$modpname.pm\E$/ or
266 ($^O eq 'dos') or ($^O eq 'MSWin32') or
267 $Is_VMS && $filename =~ m/$modpname.pm/i);
269 my($al_idx_file) = catfile($autodir, $modpname, $IndexFile);
271 if ($check_mod_time){
272 my($al_ts_time) = (stat("$al_idx_file"))[9] || 1;
273 if ($al_ts_time >= $pm_mod_time and
274 $al_ts_time >= $self_mod_time){
275 print "AutoSplit skipped ($al_idx_file newer than $filename)\n"
277 return undef; # one undef, not a list
281 my($modnamedir) = catfile($autodir, $modpname);
282 print "AutoSplitting $filename ($modnamedir)\n"
285 unless (-d $modnamedir){
286 mkpath($modnamedir,0,0777);
289 # We must try to deal with some SVR3 systems with a limit of 14
290 # characters for file names. Sadly we *cannot* simply truncate all
291 # file names to 14 characters on these systems because we *must*
292 # create filenames which exactly match the names used by AutoLoader.pm.
293 # This is a problem because some systems silently truncate the file
294 # names while others treat long file names as an error.
296 my $Is83 = $maxflen==11; # plain, case INSENSITIVE dos filenames
298 my(@subnames, $subname, %proto, %package);
304 $in_pod = 1 if /^=\w/;
305 $in_pod = 0 if /^=cut/;
306 next if ($in_pod || /^=cut/);
307 # the following (tempting) old coding gives big troubles if a
308 # cut is forgotten at EOF:
309 # next if /^=\w/ .. /^=cut/;
310 if (/^package\s+([\w:]+)\s*;/) {
311 $this_package = $def_package = $1;
313 if (/^sub\s+([\w:]+)(\s*(?:\(.*?\))?(?:$attr_list)?)/) {
314 print OUT "# end of $last_package\::$subname\n1;\n"
317 my $proto = $2 || '';
318 if ($subname =~ s/(.*):://){
321 $this_package = $def_package;
323 my $fq_subname = "$this_package\::$subname";
324 $package{$fq_subname} = $this_package;
325 $proto{$fq_subname} = $proto;
326 push(@subnames, $fq_subname);
327 my($lname, $sname) = ($subname, substr($subname,0,$maxflen-3));
328 $modpname = _modpname($this_package);
329 my($modnamedir) = catfile($autodir, $modpname);
330 mkpath($modnamedir,0,0777);
331 my($lpath) = catfile($modnamedir, "$lname.al");
332 my($spath) = catfile($modnamedir, "$sname.al");
334 if (!$Is83 and open(OUT, ">$lpath")){
336 print " writing $lpath\n" if ($Verbose>=2);
338 open(OUT, ">$spath") or die "Can't create $spath: $!\n";
340 print " writing $spath (with truncated name)\n"
343 push(@outfiles, $path);
344 my $lineno = $fnr - @cache;
346 # NOTE: Derived from $filename.
347 # Changes made here will be lost when autosplit is run again.
349 package $this_package;
351 #line $lineno "$filename (autosplit into $path)"
358 push(@cache, $_) if @cache || /\S/;
370 $last_package = $this_package if defined $this_package;
373 print OUT @cache,"1;\n# end of $last_package\::$subname\n";
378 if (!$keep){ # don't keep any obsolete *.al files in the directory
380 # @outfiles{@outfiles} = @outfiles;
381 # perl downcases all filenames on VMS (which upcases all filenames) so
382 # we'd better downcase the sub name list too, or subs with upper case
383 # letters in them will get their .al files deleted right after they're
384 # created. (The mixed case sub name won't match the all-lowercase
385 # filename, and so be cleaned up as a scrap file)
386 if ($Is_VMS or $Is83) {
387 %outfiles = map {lc($_) => lc($_) } @outfiles;
389 @outfiles{@outfiles} = @outfiles;
391 my(%outdirs,@outdirs);
393 $outdirs{File::Basename::dirname($_)}||=1;
395 for my $dir (keys %outdirs) {
396 opendir(OUTDIR,$dir);
397 foreach (sort readdir(OUTDIR)){
398 next unless /\.al\z/;
399 my($file) = catfile($dir, $_);
400 $file = lc $file if $Is83 or $Is_VMS;
401 next if $outfiles{$file};
402 print " deleting $file\n" if ($Verbose>=2);
403 my($deleted,$thistime); # catch all versions on VMS
404 do { $deleted += ($thistime = unlink $file) } while ($thistime);
405 carp "Unable to delete $file: $!" unless $deleted;
411 open(TS,">$al_idx_file") or
412 carp "AutoSplit: unable to create timestamp file ($al_idx_file): $!";
413 print TS "# Index created by AutoSplit for $filename\n";
414 print TS "# (file acts as timestamp)\n";
416 for my $fqs (@subnames) {
418 $subname =~ s/.*:://;
419 print TS "package $package{$fqs};\n"
420 unless $last_package eq $package{$fqs};
421 print TS "sub $subname $proto{$fqs};\n";
422 $last_package = $package{$fqs};
427 _check_unique($filename, $Maxlen, 1, @outfiles);
434 my $modpname = $package;
435 if ($^O eq 'MSWin32') {
436 $modpname =~ s#::#\\#g;
438 while ($modpname =~ m#(.*?[^:])::([^:].*)#) {
439 $modpname = catfile($1, $2);
446 my($filename, $maxlen, $warn, @outfiles) = @_;
450 length(File::Basename::basename($_))
456 my($dir) = File::Basename::dirname($_);
457 my($file) = File::Basename::basename($_);
458 my($trunc) = substr($file,0,$maxlen);
459 $notuniq{$dir}{$trunc} = 1 if $shorts{$dir}{$trunc};
460 $shorts{$dir}{$trunc} = $shorts{$dir}{$trunc} ?
461 "$shorts{$dir}{$trunc}, $file" : $file;
463 if (%notuniq && $warn){
464 print "$filename: some names are not unique when " .
465 "truncated to $maxlen characters:\n";
466 foreach my $dir (sort keys %notuniq){
467 print " directory $dir:\n";
468 foreach my $trunc (sort keys %{$notuniq{$dir}}) {
469 print " $shorts{$dir}{$trunc} truncate to $trunc\n";
478 # test functions so AutoSplit.pm can be applied to itself:
479 sub test1 ($) { "test 1\n"; }
480 sub test2 ($$) { "test 2\n"; }
481 sub test3 ($$$) { "test 3\n"; }
482 sub testtesttesttest4_1 { "test 4\n"; }
483 sub testtesttesttest4_2 { "duplicate test 4\n"; }
484 sub Just::Another::test5 { "another test 5\n"; }
485 sub test6 { return join ":", __FILE__,__LINE__; }
486 package Yet::Another::AutoSplit;
487 sub testtesttesttest4_1 ($) { "another test 4\n"; }
488 sub testtesttesttest4_2 ($$) { "another duplicate test 4\n"; }
489 package Yet::More::Attributes;
490 sub test_a1 ($) : locked :locked { 1; }
491 sub test_a2 : locked { 1; }