2 use File::Basename qw(&basename &dirname);
8 my $file = basename($0, '.PL');
9 $file =~ s/_(pm)$/.$1/i;
14 my $Config_inc_version_list;
16 # Expand the variables only if explicitly requested
17 # or if a previously installed lib.pm does this, too
18 # because otherwise relocating Perl becomes much harder.
20 my $expand_config_vars = 0;
21 if ($ENV{PERL_BUILD_EXPAND_CONFIG_VARS}) {
22 $expand_config_vars = 1;
24 elsif (exists $ENV{PERL_BUILD_EXPAND_CONFIG_VARS}) {
25 $expand_config_vars = 0;
30 my $lib_file = $INC{"lib.pm"};
31 open my $fh, '<', $lib_file
32 or die "Could not open file '$lib_file' for reading: $!";
33 my $ConfigRegex = qr/(?:use|require)\s+Config(?:\s+|;)/;
35 while (defined($_ = <$fh>)) {
36 # crude heuristics to check that we were using Config
37 if (/^\s*$ConfigRegex/ || /^\s*eval.*$ConfigRegex/) {
42 $expand_config_vars = $found_config ? 0 : 1;
44 $expand_config_vars = 0 if $@;
47 if ($expand_config_vars) {
49 $Config_archname = qq('$Config{archname}');
50 $Config_version = qq('$Config{version}');
51 my @Config_inc_version_list =
52 reverse split / /, $Config{inc_version_list};
53 $Config_inc_version_list =
54 @Config_inc_version_list ?
55 qq(qw(@Config_inc_version_list)) : q(());
57 $useConfig = 'use Config;';
58 $Config_archname = q($Config{archname});
59 $Config_version = q($Config{version});
60 $Config_inc_version_list =
61 q(reverse split / /, $Config{inc_version_list});
64 open OUT,">$file" or die "Can't create $file: $!";
66 print "Extracting $file (with variable substitutions)\n";
68 # In this section, perl variables will be expanded during extraction.
69 # You can use $Config{...} to use Configure variables.
71 print OUT <<"!GROK!THIS!";
74 # THIS FILE IS AUTOMATICALLY GENERATED FROM lib_pm.PL.
75 # ANY CHANGES TO THIS FILE WILL BE OVERWRITTEN BY THE NEXT PERL BUILD.
81 my \$archname = $Config_archname;
82 my \$version = $Config_version;
83 my \@inc_version_list = $Config_inc_version_list;
86 print OUT <<'!NO!SUBS!';
88 our @ORIG_INC = @INC; # take a handy copy of 'original' value
89 our $VERSION = '0.57';
90 my $Is_MacOS = $^O eq 'MacOS';
94 $Mac_FS = eval { require Mac::FileSpec::Unixish };
101 foreach (reverse @_) {
102 my $path = $_; # we'll be modifying it, so break the alias
105 Carp::carp("Empty compile time value given to use lib");
108 $path = _nativize($path);
110 if ($path !~ /\.par$/i && -e $path && ! -d _) {
112 Carp::carp("Parameter to use lib must be directory, not file");
114 unshift(@INC, $path);
115 # Add any previous version directories we found at configure time
116 foreach my $incver (@inc_version_list)
119 ? File::Spec->catdir( $path, $incver )
121 unshift(@INC, $dir) if -d $dir;
123 # Put a corresponding archlib directory in front of $path if it
124 # looks like $path has an archlib directory below it.
125 my($arch_auto_dir, $arch_dir, $version_dir, $version_arch_dir)
127 unshift(@INC, $arch_dir) if -d $arch_auto_dir;
128 unshift(@INC, $version_dir) if -d $version_dir;
129 unshift(@INC, $version_arch_dir) if -d $version_arch_dir;
132 # remove trailing duplicates
133 @INC = grep { ++$names{$_} == 1 } @INC;
143 my $path = _nativize($_);
145 my($arch_auto_dir, $arch_dir, $version_dir, $version_arch_dir)
148 ++$names{$arch_dir} if -d $arch_auto_dir;
149 ++$names{$version_dir} if -d $version_dir;
150 ++$names{$version_arch_dir} if -d $version_arch_dir;
153 # Remove ALL instances of each named directory.
154 @INC = grep { !exists $names{$_} } @INC;
160 my($arch_auto_dir, $arch_dir, $version_dir, $version_arch_dir);
162 # we could use this for all platforms in the future, but leave it
163 # Mac-only for now, until there is more time for testing it.
165 $arch_auto_dir = File::Spec->catdir( $dir, $archname, 'auto' );
166 $arch_dir = File::Spec->catdir( $dir, $archname, );
167 $version_dir = File::Spec->catdir( $dir, $version );
168 $version_arch_dir = File::Spec->catdir( $dir, $version, $archname );
170 $arch_auto_dir = "$dir/$archname/auto";
171 $arch_dir = "$dir/$archname";
172 $version_dir = "$dir/$version";
173 $version_arch_dir = "$dir/$version/$archname";
175 return($arch_auto_dir, $arch_dir, $version_dir, $version_arch_dir);
181 if ($Is_MacOS && $Mac_FS && ! -d $dir) {
182 $dir = Mac::FileSpec::Unixish::nativize($dir);
183 $dir .= ":" unless $dir =~ /:$/;
194 lib - manipulate @INC at compile time
204 This is a small simple module which simplifies the manipulation of @INC
207 It is typically used to add extra directories to perl's search path so
208 that later C<use> or C<require> statements will find modules which are
209 not located on perl's default search path.
211 =head2 Adding directories to @INC
213 The parameters to C<use lib> are added to the start of the perl search
218 is I<almost> the same as saying
220 BEGIN { unshift(@INC, LIST) }
222 For each directory in LIST (called $dir here) the lib module also
223 checks to see if a directory called $dir/$archname/auto exists.
224 If so the $dir/$archname directory is assumed to be a corresponding
225 architecture specific directory and is added to @INC in front of $dir.
227 The current value of C<$archname> can be found with this command:
231 To avoid memory leaks, all trailing duplicate entries in @INC are
234 =head2 Deleting directories from @INC
236 You should normally only add directories to @INC. If you need to
237 delete directories from @INC take care to only delete those which you
238 added yourself or which you are certain are not needed by other modules
239 in your script. Other modules may have added directories which they
240 need for correct operation.
242 The C<no lib> statement deletes all instances of each named directory
245 For each directory in LIST (called $dir here) the lib module also
246 checks to see if a directory called $dir/$archname/auto exists.
247 If so the $dir/$archname directory is assumed to be a corresponding
248 architecture specific directory and is also deleted from @INC.
250 =head2 Restoring original @INC
252 When the lib module is first loaded it records the current value of @INC
253 in an array C<@lib::ORIG_INC>. To restore @INC to that value you
256 @INC = @lib::ORIG_INC;
260 In order to keep lib.pm small and simple, it only works with Unix
261 filepaths. This doesn't mean it only works on Unix, but non-Unix
262 users must first translate their file paths to Unix conventions.
264 # VMS users wanting to put [.stuff.moo] into
265 # their @INC would write
270 In the future, this module will likely use File::Spec for determining
271 paths, as it does now for Mac OS (where Unix-style or Mac-style paths
272 work, and Unix-style paths are converted properly to Mac-style paths
273 before being added to @INC).
275 If you try to add a file to @INC as follows:
277 use lib 'this_is_a_file.txt';
279 C<lib> will warn about this. The sole exceptions are files with the
280 C<.par> extension which are intended to be used as libraries.
284 FindBin - optional module which deals with paths relative to the source file.
286 PAR - optional module which can treat C<.par> files as Perl libraries.
290 Tim Bunce, 2nd June 1995.
292 C<lib> is maintained by the perl5-porters. Please direct
293 any questions to the canonical mailing list. Anything that
294 is applicable to the CPAN release can be sent to its maintainer,
297 Maintainer: The Perl5-Porters <perl5-porters@perl.org>
299 Maintainer of the CPAN release: Steffen Mueller <smueller@cpan.org>
301 =head1 COPYRIGHT AND LICENSE
303 This package has been part of the perl core since perl 5.001.
304 It has been released separately to CPAN so older installations
305 can benefit from bug fixes.
307 This package has the same copyright and license as the perl core.
312 close OUT or die "Can't close $file: $!";