1 package File::Spec::Unix;
12 File::Spec::Unix - methods used by File::Spec
16 require File::Spec::Unix; # Done automatically by File::Spec
20 Methods for manipulating file specifications.
28 No physical check on the filesystem, but a logical cleanup of a
29 path. On UNIX eliminated successive slashes and successive "/.".
31 $cpath = File::Spec->canonpath( $path ) ;
36 my ($self,$path) = @_;
37 $path =~ s|/+|/|g unless($^O eq 'cygwin'); # xx////xx -> xx/xx
38 $path =~ s|(/\.)+/|/|g; # xx/././xx -> xx/xx
39 $path =~ s|^(\./)+||s unless $path eq "./"; # ./xx -> xx
40 $path =~ s|^/(\.\./)+|/|s; # /../../xx -> xx
41 $path =~ s|/\Z(?!\n)|| unless $path eq "/"; # xx/ -> xx
47 Concatenate two or more directory names to form a complete path ending
48 with a directory. But remove the trailing slash from the resulting
49 string, because it doesn't look good, isn't necessary and confuses
50 OS2. Of course, if this is the root directory, don't cut off the
59 # append a slash to each argument unless it has one there
60 $_ .= "/" if $_ eq '' || substr($_,-1) ne "/";
62 return $self->canonpath(join('', @args));
67 Concatenate one or more directory names and a filename to form a
68 complete path ending with a filename
75 return $file unless @_;
76 my $dir = $self->catdir(@_);
77 $dir .= "/" unless substr($dir,-1) eq "/";
83 Returns a string representation of the current directory. "." on UNIX.
93 Returns a string representation of the null device. "/dev/null" on UNIX.
103 Returns a string representation of the root directory. "/" on UNIX.
113 Returns a string representation of the first writable directory
114 from the following list or "" if none are writable:
123 return $tmpdir if defined $tmpdir;
124 foreach ($ENV{TMPDIR}, "/tmp") {
125 next unless defined && -d && -w _;
129 $tmpdir = '' unless defined $tmpdir;
135 Returns a string representation of the parent directory. ".." on UNIX.
145 Given a list of file names, strip out those that refer to a parent
146 directory. (Does not strip symlinks, only '.', '..', and equivalents.)
152 return grep(!/^\.{1,2}\Z(?!\n)/s, @_);
157 Returns a true or false value indicating, respectively, that alphabetic
158 is not or is significant when comparing file specifications.
166 =item file_name_is_absolute
168 Takes as argument a path and returns true if it is an absolute path.
170 This does not consult the local filesystem on Unix, Win32, or OS/2. It
171 does sometimes on MacOS (see L<File::Spec::MacOS/file_name_is_absolute>).
172 It does consult the working environment for VMS (see
173 L<File::Spec::VMS/file_name_is_absolute>).
177 sub file_name_is_absolute {
178 my ($self,$file) = @_;
179 return scalar($file =~ m:^/:s);
184 Takes no argument, returns the environment variable PATH as an array.
189 my @path = split(':', $ENV{PATH});
190 foreach (@path) { $_ = '.' if $_ eq '' }
196 join is the same as catfile.
202 return $self->catfile(@_);
207 ($volume,$directories,$file) = File::Spec->splitpath( $path );
208 ($volume,$directories,$file) = File::Spec->splitpath( $path, $no_file );
210 Splits a path in to volume, directory, and filename portions. On systems
211 with no concept of volume, returns undef for volume.
213 For systems with no syntax differentiating filenames from directories,
214 assumes that the last file is a path unless $no_file is true or a
215 trailing separator or /. or /.. is present. On Unix this means that $no_file
216 true makes this return ( '', $path, '' ).
218 The directory portion may or may not be returned with a trailing '/'.
220 The results can be passed to L</catpath()> to get back a path equivalent to
221 (usually identical to) the original path.
226 my ($self,$path, $nofile) = @_;
228 my ($volume,$directory,$file) = ('','','');
234 $path =~ m|^ ( (?: .* / (?: \.\.?\Z(?!\n) )? )? ) ([^/]*) |xs;
239 return ($volume,$directory,$file);
245 The opposite of L</catdir()>.
247 @dirs = File::Spec->splitdir( $directories );
249 $directories must be only the directory portion of the path on systems
250 that have the concept of a volume or that have path syntax that differentiates
251 files from directories.
253 Unlike just splitting the directories on the separator, empty
254 directory names (C<''>) can be returned, because these are significant
255 on some OSs (e.g. MacOS).
259 File::Spec->splitdir( "/a/b//c/" );
263 ( '', 'a', 'b', '', 'c', '' )
268 my ($self,$directories) = @_ ;
270 # split() likes to forget about trailing null fields, so here we
271 # check to be sure that there will not be any before handling the
274 if ( $directories !~ m|/\Z(?!\n)| ) {
275 return split( m|/|, $directories );
279 # since there was a trailing separator, add a file name to the end,
280 # then do the split, then replace it with ''.
282 my( @directories )= split( m|/|, "${directories}dummy" ) ;
283 $directories[ $#directories ]= '' ;
284 return @directories ;
291 Takes volume, directory and file portions and returns an entire path. Under
292 Unix, $volume is ignored, and directory and file are catenated. A '/' is
293 inserted if need be. On other OSs, $volume is significant.
298 my ($self,$volume,$directory,$file) = @_;
300 if ( $directory ne '' &&
302 substr( $directory, -1 ) ne '/' &&
303 substr( $file, 0, 1 ) ne '/'
305 $directory .= "/$file" ;
308 $directory .= $file ;
316 Takes a destination path and an optional base path returns a relative path
317 from the base path to the destination path:
319 $rel_path = File::Spec->abs2rel( $path ) ;
320 $rel_path = File::Spec->abs2rel( $path, $base ) ;
322 If $base is not present or '', then L<cwd()> is used. If $base is relative,
323 then it is converted to absolute form using L</rel2abs()>. This means that it
324 is taken to be relative to L<cwd()>.
326 On systems with the concept of a volume, this assumes that both paths
327 are on the $destination volume, and ignores the $base volume.
329 On systems that have a grammar that indicates filenames, this ignores the
330 $base filename as well. Otherwise all path components are assumed to be
333 If $path is relative, it is converted to absolute form using L</rel2abs()>.
334 This means that it is taken to be relative to L<cwd()>.
336 No checks against the filesystem are made on most systems. On MacOS,
337 the filesystem may be consulted (see
338 L<File::Spec::MacOS/file_name_is_absolute>). On VMS, there is
339 interaction with the working environment, as logicals and
342 Based on code written by Shigio Yamaguchi.
347 my($self,$path,$base) = @_;
350 if ( ! $self->file_name_is_absolute( $path ) ) {
351 $path = $self->rel2abs( $path ) ;
354 $path = $self->canonpath( $path ) ;
357 # Figure out the effective $base and clean it up.
358 if ( !defined( $base ) || $base eq '' ) {
361 elsif ( ! $self->file_name_is_absolute( $base ) ) {
362 $base = $self->rel2abs( $base ) ;
365 $base = $self->canonpath( $base ) ;
368 # Now, remove all leading components that are the same
369 my @pathchunks = $self->splitdir( $path);
370 my @basechunks = $self->splitdir( $base);
372 while (@pathchunks && @basechunks && $pathchunks[0] eq $basechunks[0]) {
377 $path = CORE::join( '/', @pathchunks );
378 $base = CORE::join( '/', @basechunks );
380 # $base now contains the directories the resulting relative path
381 # must ascend out of before it can descend to $path_directory. So,
382 # replace all names with $parentDir
383 $base =~ s|[^/]+|..|g ;
385 # Glue the two together, using a separator if necessary, and preventing an
387 if ( $path ne '' && $base ne '' ) {
388 $path = "$base/$path" ;
390 $path = "$base$path" ;
393 return $self->canonpath( $path ) ;
398 Converts a relative path to an absolute path.
400 $abs_path = File::Spec->rel2abs( $path ) ;
401 $abs_path = File::Spec->rel2abs( $path, $base ) ;
403 If $base is not present or '', then L<cwd()> is used. If $base is relative,
404 then it is converted to absolute form using L</rel2abs()>. This means that it
405 is taken to be relative to L<cwd()>.
407 On systems with the concept of a volume, this assumes that both paths
408 are on the $base volume, and ignores the $path volume.
410 On systems that have a grammar that indicates filenames, this ignores the
411 $base filename as well. Otherwise all path components are assumed to be
414 If $path is absolute, it is cleaned up and returned using L</canonpath()>.
416 No checks against the filesystem are made on most systems. On MacOS,
417 the filesystem may be consulted (see
418 L<File::Spec::MacOS/file_name_is_absolute>). On VMS, there is
419 interaction with the working environment, as logicals and
422 Based on code written by Shigio Yamaguchi.
427 my ($self,$path,$base ) = @_;
430 if ( ! $self->file_name_is_absolute( $path ) ) {
431 # Figure out the effective $base and clean it up.
432 if ( !defined( $base ) || $base eq '' ) {
435 elsif ( ! $self->file_name_is_absolute( $base ) ) {
436 $base = $self->rel2abs( $base ) ;
439 $base = $self->canonpath( $base ) ;
443 $path = $self->catdir( $base, $path ) ;
446 return $self->canonpath( $path ) ;