Sys::Hostname fails under Solaris 2.5 when setuid
[p5sagit/p5-mst-13.2.git] / lib / AutoSplit.pm
CommitLineData
a0d0e21e 1package AutoSplit;
2
3require 5.000;
4require Exporter;
5
6use Config;
7use Carp;
68dc0745 8use File::Path qw(mkpath);
a0d0e21e 9
10@ISA = qw(Exporter);
11@EXPORT = qw(&autosplit &autosplit_lib_modules);
3edbfbe5 12@EXPORT_OK = qw($Verbose $Keep $Maxlen $CheckForAutoloader $CheckModTime);
a0d0e21e 13
f06db76b 14=head1 NAME
15
16AutoSplit - split a package for autoloading
17
cb1a09d0 18=head1 SYNOPSIS
19
21c92a1d 20 perl -e 'use AutoSplit; autosplit_lib_modules(@ARGV)' ...
21
22 use AutoSplit; autosplit($file, $dir, $keep, $check, $modtime);
23
24for perl versions 5.002 and later:
84dc3c4d 25
21c92a1d 26 perl -MAutoSplit -e 'autosplit($ARGV[0], $ARGV[1], $k, $chk, $modtime)' ...
cb1a09d0 27
f06db76b 28=head1 DESCRIPTION
29
30This function will split up your program into files that the AutoLoader
21c92a1d 31module can handle. It is used by both the standard perl libraries and by
32the MakeMaker utility, to automatically configure libraries for autoloading.
33
34The C<autosplit> interface splits the specified file into a hierarchy
35rooted at the directory C<$dir>. It creates directories as needed to reflect
36class hierarchy, and creates the file F<autosplit.ix>. This file acts as
37both forward declaration of all package routines, and as timestamp for the
38last update of the hierarchy.
39
40The remaining three arguments to C<autosplit> govern other options to the
41autosplitter. If the third argument, I<$keep>, is false, then any pre-existing
edb45e35 42C<*.al> files in the autoload directory are removed if they are no longer
21c92a1d 43part of the module (obsoleted functions). The fourth argument, I<$check>,
44instructs C<autosplit> to check the module currently being split to ensure
45that it does include a C<use> specification for the AutoLoader module, and
46skips the module if AutoLoader is not detected. Lastly, the I<$modtime>
47argument specifies that C<autosplit> is to check the modification time of the
48module against that of the C<autosplit.ix> file, and only split the module
49if it is newer.
50
51Typical use of AutoSplit in the perl MakeMaker utility is via the command-line
52with:
53
54 perl -e 'use AutoSplit; autosplit($ARGV[0], $ARGV[1], 0, 1, 1)'
55
56Defined as a Make macro, it is invoked with file and directory arguments;
57C<autosplit> will split the specified file into the specified directory and
58delete obsolete C<.al> files, after checking first that the module does use
59the AutoLoader, and ensuring that the module is not already currently split
60in its current form (the modtime test).
61
62The C<autosplit_lib_modules> form is used in the building of perl. It takes
63as input a list of files (modules) that are assumed to reside in a directory
64B<lib> relative to the current directory. Each file is sent to the
65autosplitter one at a time, to be split into the directory B<lib/auto>.
66
67In both usages of the autosplitter, only subroutines defined following the
68perl special marker I<__END__> are split out into separate files. Some
69routines may be placed prior to this marker to force their immediate loading
70and parsing.
71
72=head1 CAVEATS
73
74Currently, C<AutoSplit> cannot handle multiple package specifications
75within one file.
76
77=head1 DIAGNOSTICS
78
79C<AutoSplit> will inform the user if it is necessary to create the top-level
80directory specified in the invocation. It is preferred that the script or
81installation process that invokes C<AutoSplit> have created the full directory
82path ahead of time. This warning may indicate that the module is being split
83into an incorrect path.
84
85C<AutoSplit> will warn the user of all subroutines whose name causes potential
86file naming conflicts on machines with drastically limited (8 characters or
87less) file name length. Since the subroutine name is used as the file name,
88these warnings can aid in portability to such systems.
89
90Warnings are issued and the file skipped if C<AutoSplit> cannot locate either
91the I<__END__> marker or a "package Name;"-style specification.
92
93C<AutoSplit> will also emit general diagnostics for inability to create
94directories or files.
f06db76b 95
96=cut
97
a0d0e21e 98# for portability warn about names longer than $maxlen
99$Maxlen = 8; # 8 for dos, 11 (14-".al") for SYSVR3
100$Verbose = 1; # 0=none, 1=minimal, 2=list .al files
101$Keep = 0;
3edbfbe5 102$CheckForAutoloader = 1;
103$CheckModTime = 1;
a0d0e21e 104
3edbfbe5 105$IndexFile = "autosplit.ix"; # file also serves as timestamp
a0d0e21e 106$maxflen = 255;
107$maxflen = 14 if $Config{'d_flexfnam'} ne 'define';
c6538b72 108$Is_VMS = ($^O eq 'VMS');
a0d0e21e 109
3edbfbe5 110
a0d0e21e 111sub autosplit{
75f92628 112 my($file, $autodir, $k, $ckal, $ckmt) = @_;
113 # $file - the perl source file to be split (after __END__)
114 # $autodir - the ".../auto" dir below which to write split subs
115 # Handle optional flags:
116 $keep = $Keep unless defined $k;
117 $ckal = $CheckForAutoloader unless defined $ckal;
118 $ckmt = $CheckModTime unless defined $ckmt;
119 autosplit_file($file, $autodir, $keep, $ckal, $ckmt);
a0d0e21e 120}
121
122
a0d0e21e 123# This function is used during perl building/installation
21c92a1d 124# ./miniperl -e 'use AutoSplit; autosplit_lib_modules(@ARGV)' ...
a0d0e21e 125
126sub autosplit_lib_modules{
127 my(@modules) = @_; # list of Module names
128
3e3baf6d 129 while(defined($_ = shift @modules)){
a0d0e21e 130 s#::#/#g; # incase specified as ABC::XYZ
4633a7c4 131 s|\\|/|g; # bug in ksh OS/2
a0d0e21e 132 s#^lib/##; # incase specified as lib/*.pm
c6538b72 133 if ($Is_VMS && /[:>\]]/) { # may need to convert VMS-style filespecs
a0d0e21e 134 my ($dir,$name) = (/(.*])(.*)/);
135 $dir =~ s/.*lib[\.\]]//;
136 $dir =~ s#[\.\]]#/#g;
137 $_ = $dir . $name;
138 }
3edbfbe5 139 autosplit_file("lib/$_", "lib/auto", $Keep, $CheckForAutoloader, $CheckModTime);
a0d0e21e 140 }
141 0;
142}
143
144
145# private functions
146
147sub autosplit_file{
148 my($filename, $autodir, $keep, $check_for_autoloader, $check_mod_time) = @_;
149 my(@names);
6e7678af 150 local($_);
a0d0e21e 151
152 # where to write output files
153 $autodir = "lib/auto" unless $autodir;
f86702cc 154 if ($Is_VMS) {
155 ($autodir = VMS::Filespec::unixpath($autodir)) =~ s{/$}{};
156 $filename = VMS::Filespec::unixify($filename); # may have dirs
157 }
3edbfbe5 158 unless (-d $autodir){
68dc0745 159 mkpath($autodir,0,0755);
3edbfbe5 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";
164 }
a0d0e21e 165
166 # allow just a package name to be used
167 $filename .= ".pm" unless ($filename =~ m/\.pm$/);
168
169 open(IN, "<$filename") || die "AutoSplit: Can't open $filename: $!\n";
170 my($pm_mod_time) = (stat($filename))[9];
171 my($autoloader_seen) = 0;
f06db76b 172 my($in_pod) = 0;
a0d0e21e 173 while (<IN>) {
f06db76b 174 # Skip pod text.
175 $in_pod = 1 if /^=/;
176 $in_pod = 0 if /^=cut/;
177 next if ($in_pod || /^=cut/);
178
a0d0e21e 179 # record last package name seen
180 $package = $1 if (m/^\s*package\s+([\w:]+)\s*;/);
3edbfbe5 181 ++$autoloader_seen if m/^\s*(use|require)\s+AutoLoader\b/;
a0d0e21e 182 ++$autoloader_seen if m/\bISA\s*=.*\bAutoLoader\b/;
183 last if /^__END__/;
184 }
3edbfbe5 185 if ($check_for_autoloader && !$autoloader_seen){
186 print "AutoSplit skipped $filename: no AutoLoader used\n" if ($Verbose>=2);
187 return 0
188 }
a0d0e21e 189 $_ or die "Can't find __END__ in $filename\n";
190
191 $package or die "Can't find 'package Name;' in $filename\n";
192
68dc0745 193 my($modpname) = $package;
194 if ($^O eq 'MSWin32') {
195 $modpname =~ s#::#\\#g;
196 } else {
197 $modpname =~ s#::#/#g;
198 }
a0d0e21e 199
68dc0745 200 die "Package $package ($modpname.pm) does not match filename $filename"
201 unless ($filename =~ m/\Q$modpname.pm\E$/ or
10dd38fc 202 ($^O eq "msdos") or ($^O eq 'MSWin32') or
c6538b72 203 $Is_VMS && $filename =~ m/$modpname.pm/i);
a0d0e21e 204
68dc0745 205 my($al_idx_file) = "$autodir/$modpname/$IndexFile";
206
a0d0e21e 207 if ($check_mod_time){
208 my($al_ts_time) = (stat("$al_idx_file"))[9] || 1;
209 if ($al_ts_time >= $pm_mod_time){
210 print "AutoSplit skipped ($al_idx_file newer that $filename)\n"
211 if ($Verbose >= 2);
212 return undef; # one undef, not a list
213 }
214 }
215
216 my($from) = ($Verbose>=2) ? "$filename => " : "";
217 print "AutoSplitting $package ($from$autodir/$modpname)\n"
218 if $Verbose;
219
220 unless (-d "$autodir/$modpname"){
68dc0745 221 mkpath("$autodir/$modpname",0,0777);
a0d0e21e 222 }
223
224 # We must try to deal with some SVR3 systems with a limit of 14
225 # characters for file names. Sadly we *cannot* simply truncate all
226 # file names to 14 characters on these systems because we *must*
227 # create filenames which exactly match the names used by AutoLoader.pm.
228 # This is a problem because some systems silently truncate the file
229 # names while others treat long file names as an error.
230
231 # We do not yet deal with multiple packages within one file.
232 # Ideally both of these styles should work.
233 #
234 # package NAME;
235 # __END__
236 # sub AAA { ... }
237 # package NAME::option1;
238 # sub BBB { ... }
239 # package NAME::option2;
240 # sub BBB { ... }
241 #
242 # package NAME;
243 # __END__
244 # sub AAA { ... }
245 # sub NAME::option1::BBB { ... }
246 # sub NAME::option2::BBB { ... }
247 #
248 # For now both of these produce warnings.
249
250 open(OUT,">/dev/null") || open(OUT,">nla0:"); # avoid 'not opened' warning
4633a7c4 251 my(@subnames, %proto);
96bc026d 252 my @cache = ();
253 my $caching = 1;
a0d0e21e 254 while (<IN>) {
96bc026d 255 next if /^=\w/ .. /^=cut/;
a0d0e21e 256 if (/^package ([\w:]+)\s*;/) {
257 warn "package $1; in AutoSplit section ignored. Not currently supported.";
258 }
4633a7c4 259 if (/^sub\s+([\w:]+)(\s*\(.*?\))?/) {
a0d0e21e 260 print OUT "1;\n";
4633a7c4 261 my $subname = $1;
40da2db3 262 $proto{$1} = $2 || '';
a0d0e21e 263 if ($subname =~ m/::/){
264 warn "subs with package names not currently supported in AutoSplit section";
265 }
266 push(@subnames, $subname);
267 my($lname, $sname) = ($subname, substr($subname,0,$maxflen-3));
268 my($lpath) = "$autodir/$modpname/$lname.al";
269 my($spath) = "$autodir/$modpname/$sname.al";
270 unless(open(OUT, ">$lpath")){
271 open(OUT, ">$spath") or die "Can't create $spath: $!\n";
272 push(@names, $sname);
273 print " writing $spath (with truncated name)\n"
274 if ($Verbose>=1);
275 }else{
276 push(@names, $lname);
277 print " writing $lpath\n" if ($Verbose>=2);
278 }
279 print OUT "# NOTE: Derived from $filename. ",
280 "Changes made here will be lost.\n";
281 print OUT "package $package;\n\n";
96bc026d 282 print OUT @cache;
283 @cache = ();
284 $caching = 0;
285 }
286 if($caching) {
287 push(@cache, $_) if @cache || /\S/;
288 }
289 else {
290 print OUT $_;
291 }
292 if(/^}/) {
293 if($caching) {
294 print OUT @cache;
295 @cache = ();
296 }
297 print OUT "\n";
298 $caching = 1;
a0d0e21e 299 }
a0d0e21e 300 }
96bc026d 301 print OUT @cache,"1;\n";
a0d0e21e 302 close(OUT);
303 close(IN);
304
305 if (!$keep){ # don't keep any obsolete *.al files in the directory
306 my(%names);
307 @names{@names} = @names;
308 opendir(OUTDIR,"$autodir/$modpname");
309 foreach(sort readdir(OUTDIR)){
310 next unless /\.al$/;
311 my($subname) = m/(.*)\.al$/;
312 next if $names{substr($subname,0,$maxflen-3)};
313 my($file) = "$autodir/$modpname/$_";
314 print " deleting $file\n" if ($Verbose>=2);
f06db76b 315 my($deleted,$thistime); # catch all versions on VMS
316 do { $deleted += ($thistime = unlink $file) } while ($thistime);
317 carp "Unable to delete $file: $!" unless $deleted;
a0d0e21e 318 }
319 closedir(OUTDIR);
320 }
321
322 open(TS,">$al_idx_file") or
323 carp "AutoSplit: unable to create timestamp file ($al_idx_file): $!";
324 print TS "# Index created by AutoSplit for $filename (file acts as timestamp)\n";
f06db76b 325 print TS "package $package;\n";
4633a7c4 326 print TS map("sub $_$proto{$_} ;\n", @subnames);
f06db76b 327 print TS "1;\n";
a0d0e21e 328 close(TS);
329
330 check_unique($package, $Maxlen, 1, @names);
331
332 @names;
333}
334
335
336sub check_unique{
337 my($module, $maxlen, $warn, @names) = @_;
338 my(%notuniq) = ();
339 my(%shorts) = ();
340 my(@toolong) = grep(length > $maxlen, @names);
341
342 foreach(@toolong){
343 my($trunc) = substr($_,0,$maxlen);
344 $notuniq{$trunc}=1 if $shorts{$trunc};
345 $shorts{$trunc} = ($shorts{$trunc}) ? "$shorts{$trunc}, $_" : $_;
346 }
347 if (%notuniq && $warn){
348 print "$module: some names are not unique when truncated to $maxlen characters:\n";
349 foreach(keys %notuniq){
350 print " $shorts{$_} truncate to $_\n";
351 }
352 }
353 %notuniq;
354}
355
3561;
357__END__
358
359# test functions so AutoSplit.pm can be applied to itself:
360sub test1{ "test 1\n"; }
361sub test2{ "test 2\n"; }
362sub test3{ "test 3\n"; }
363sub test4{ "test 4\n"; }
364
365