3 # Copyright (c) 1995 Graham Barr & Nick Ing-Simmons. All rights reserved.
4 # This program is free software; you can redistribute it and/or modify it
5 # under the same terms as Perl itself.
9 FindBin - Locate directory of original perl script
14 use lib "$FindBin::Bin/../lib";
19 use lib "$Bin/../lib";
23 Locates the full path to the script bin directory to allow the use
24 of paths relative to the bin directory.
26 This allows a user to setup a directory tree for some software with
27 directories E<lt>rootE<gt>/bin and E<lt>rootE<gt>/lib and then the above example will allow
28 the use of modules in the lib directory without knowing where the software
31 If perl is invoked using the B<-e> option or the perl script is read from
32 C<STDIN> then FindBin sets both C<$Bin> and C<$RealBin> to the current
35 =head1 EXPORTABLE VARIABLES
37 $Bin - path to bin directory from where script was invoked
38 $Script - basename of script from which perl was invoked
39 $RealBin - $Bin with all links resolved
40 $RealScript - $Script with all links resolved
48 and I<filename> does not have executable rights and a program called I<filename>
49 exists in the users C<$ENV{PATH}> which satisfies both B<-x> and B<-T> then FindBin
50 assumes that it was invoked via the C<$ENV{PATH}>.
52 Workaround is to invoke perl as
58 Graham Barr E<lt>F<bodg@tiuk.ti.com>E<gt>
59 Nick Ing-Simmons E<lt>F<nik@tiuk.ti.com>E<gt>
63 Copyright (c) 1995 Graham Barr & Nick Ing-Simmons. All rights reserved.
64 This program is free software; you can redistribute it and/or modify it
65 under the same terms as Perl itself.
77 use Cwd qw(getcwd abs_path);
81 @EXPORT_OK = qw($Bin $Script $RealBin $RealScript $Dir $RealDir);
82 %EXPORT_TAGS = (ALL => [qw($Bin $Script $RealBin $RealScript $Dir $RealDir)]);
85 $VERSION = $VERSION = sprintf("%d.%02d", q$Revision: 1.4 $ =~ /(\d+)\.(\d+)/);
89 local $_ = shift if (@_);
92 return m#^[a-z]:[\\/]#i;
96 # If it's a logical name, expand it.
97 $_ = $ENV{$_} while /^[\w\$\-]+$/ and $ENV{$_};
98 return m!^/! or m![<\[][^.\-\]>]! or /:[^<\[]/;
109 *RealDir = \$RealBin;
111 if($0 eq '-e' || $0 eq '-')
113 # perl invoked with -e or script is on C<STDIN>
115 $Script = $RealScript = $0;
116 $Bin = $RealBin = getcwd();
124 ($Bin,$Script) = VMS::Filespec::rmsexpand($0) =~ /(.*\])(.*)/;
125 ($RealBin,$RealScript) = ($Bin,$Script);
129 my $IsWin32 = $^O eq 'MSWin32';
130 unless(($script =~ m#/# || ($IsWin32 && $script =~ m#\\#))
134 my $pathvar = ($IsWin32) ? 'Path' : 'PATH';
136 foreach $dir (split(/$Config{'path_sep'}/,$ENV{$pathvar}))
138 if(-r "$dir/$script" && (!$IsWin32 || -x _))
140 $script = "$dir/$script";
144 # $script has been found via PATH but perl could have
145 # been invoked as 'perl file'. Do a dumb check to see
146 # if $script is a perl program, if not then $script = $0
148 # well we actually only check that it is an ASCII file
149 # we know its executable so it is probably a script
152 $script = $0 unless(-T $script);
159 croak("Cannot find current script '$0'") unless(-f $script);
161 # Ensure $script contains the complete path incase we C<chdir>
163 $script = getcwd() . "/" . $script unless is_abs_path($script);
165 ($Script,$Bin) = fileparse($script);
167 # Resolve $script if it is a link
170 my $linktext = readlink($script);
172 ($RealScript,$RealBin) = fileparse($script);
173 last unless defined $linktext;
175 $script = (is_abs_path($linktext))
177 : $RealBin . "/" . $linktext;
180 # Get absolute paths to directories
181 $Bin = abs_path($Bin) if($Bin);
182 $RealBin = abs_path($RealBin) if($RealBin);
187 1; # Keep require happy