lib/File/Spec.pm

   1 package File::Spec;
   2
   3 use strict;
   4 our(@ISA, $VERSION);
   5
   6 $VERSION = 0.83 ;
   7
   8 my %module = (MacOS   => 'Mac',
   9               MSWin32 => 'Win32',
  10               os2     => 'OS2',
  11               VMS     => 'VMS',
  12               epoc    => 'Epoc',
  13               NetWare => 'Win32', # Yes, File::Spec::Win32 works on NetWare.
  14               dos     => 'OS2',   # Yes, File::Spec::OS2 works on DJGPP.
  15               cygwin  => 'Cygwin');
  16
  17
  18 my $module = $module{$^O} || 'Unix';
  19
  20 require "File/Spec/$module.pm";
  21 @ISA = ("File::Spec::$module");
  22
  23 1;
  24
  25 __END__
  26
  27 =head1 NAME
  28
  29 File::Spec - portably perform operations on file names
  30
  31 =head1 SYNOPSIS
  32
  33         use File::Spec;
  34
  35         $x=File::Spec->catfile('a', 'b', 'c');
  36
  37 which returns 'a/b/c' under Unix. Or:
  38
  39         use File::Spec::Functions;
  40
  41         $x = catfile('a', 'b', 'c');
  42
  43 =head1 DESCRIPTION
  44
  45 This module is designed to support operations commonly performed on file
  46 specifications (usually called "file names", but not to be confused with the
  47 contents of a file, or Perl's file handles), such as concatenating several
  48 directory and file names into a single path, or determining whether a path
  49 is rooted. It is based on code directly taken from MakeMaker 5.17, code
  50 written by Andreas KE<ouml>nig, Andy Dougherty, Charles Bailey, Ilya
  51 Zakharevich, Paul Schinder, and others.
  52
  53 Since these functions are different for most operating systems, each set of
  54 OS specific routines is available in a separate module, including:
  55
  56         File::Spec::Unix
  57         File::Spec::Mac
  58         File::Spec::OS2
  59         File::Spec::Win32
  60         File::Spec::VMS
  61
  62 The module appropriate for the current OS is automatically loaded by
  63 File::Spec. Since some modules (like VMS) make use of facilities available
  64 only under that OS, it may not be possible to load all modules under all
  65 operating systems.
  66
  67 Since File::Spec is object oriented, subroutines should not be called directly,
  68 as in:
  69
  70         File::Spec::catfile('a','b');
  71
  72 but rather as class methods:
  73
  74         File::Spec->catfile('a','b');
  75
  76 For simple uses, L<File::Spec::Functions> provides convenient functional
  77 forms of these methods.
  78
  79 =head1 METHODS
  80
  81 =over 2
  82
  83 =item canonpath
  84
  85 No physical check on the filesystem, but a logical cleanup of a
  86 path.
  87
  88     $cpath = File::Spec->canonpath( $path ) ;
  89
  90 =item catdir
  91
  92 Concatenate two or more directory names to form a complete path ending
  93 with a directory. But remove the trailing slash from the resulting
  94 string, because it doesn't look good, isn't necessary and confuses
  95 OS2. Of course, if this is the root directory, don't cut off the
  96 trailing slash :-)
  97
  98     $path = File::Spec->catdir( @directories );
  99
 100 =item catfile
 101
 102 Concatenate one or more directory names and a filename to form a
 103 complete path ending with a filename
 104
 105     $path = File::Spec->catfile( @directories, $filename );
 106
 107 =item curdir
 108
 109 Returns a string representation of the current directory.
 110
 111     $curdir = File::Spec->curdir();
 112
 113 =item devnull
 114
 115 Returns a string representation of the null device.
 116
 117     $devnull = File::Spec->devnull();
 118
 119 =item rootdir
 120
 121 Returns a string representation of the root directory.
 122
 123     $rootdir = File::Spec->rootdir();
 124
 125 =item tmpdir
 126
 127 Returns a string representation of the first writable directory from a
 128 list of possible temporary directories.  Returns "" if no writable
 129 temporary directories are found.  The list of directories checked
 130 depends on the platform; e.g. File::Spec::Unix checks $ENV{TMPDIR} and
 131 /tmp.
 132
 133     $tmpdir = File::Spec->tmpdir();
 134
 135 =item updir
 136
 137 Returns a string representation of the parent directory.
 138
 139     $updir = File::Spec->updir();
 140
 141 =item no_upwards
 142
 143 Given a list of file names, strip out those that refer to a parent
 144 directory. (Does not strip symlinks, only '.', '..', and equivalents.)
 145
 146     @paths = File::Spec->no_upwards( @paths );
 147
 148 =item case_tolerant
 149
 150 Returns a true or false value indicating, respectively, that alphabetic
 151 is not or is significant when comparing file specifications.
 152
 153     $is_case_tolerant = File::Spec->case_tolerant();
 154
 155 =item file_name_is_absolute
 156
 157 Takes as argument a path and returns true if it is an absolute path.
 158
 159     $is_absolute = File::Spec->file_name_is_absolute( $path );
 160
 161 This does not consult the local filesystem on Unix, Win32, OS/2, or
 162 Mac OS (Classic).  It does consult the working environment for VMS
 163 (see L<File::Spec::VMS/file_name_is_absolute>).
 164
 165 =item path
 166
 167 Takes no argument, returns the environment variable PATH as an array.
 168
 169     @PATH = File::Spec->path();
 170
 171 =item join
 172
 173 join is the same as catfile.
 174
 175 =item splitpath
 176
 177 Splits a path in to volume, directory, and filename portions. On systems
 178 with no concept of volume, returns undef for volume.
 179
 180     ($volume,$directories,$file) = File::Spec->splitpath( $path );
 181     ($volume,$directories,$file) = File::Spec->splitpath( $path, $no_file );
 182
 183 For systems with no syntax differentiating filenames from directories,
 184 assumes that the last file is a path unless $no_file is true or a
 185 trailing separator or /. or /.. is present. On Unix this means that $no_file
 186 true makes this return ( '', $path, '' ).
 187
 188 The directory portion may or may not be returned with a trailing '/'.
 189
 190 The results can be passed to L</catpath()> to get back a path equivalent to
 191 (usually identical to) the original path.
 192
 193 =item splitdir
 194
 195 The opposite of L</catdir()>.
 196
 197     @dirs = File::Spec->splitdir( $directories );
 198
 199 $directories must be only the directory portion of the path on systems
 200 that have the concept of a volume or that have path syntax that differentiates
 201 files from directories.
 202
 203 Unlike just splitting the directories on the separator, empty
 204 directory names (C<''>) can be returned, because these are significant
 205 on some OSs.
 206
 207 =item catpath()
 208
 209 Takes volume, directory and file portions and returns an entire path. Under
 210 Unix, $volume is ignored, and directory and file are catenated.  A '/' is
 211 inserted if need be.  On other OSs, $volume is significant.
 212
 213     $full_path = File::Spec->catpath( $volume, $directory, $file );
 214
 215 =item abs2rel
 216
 217 Takes a destination path and an optional base path returns a relative path
 218 from the base path to the destination path:
 219
 220     $rel_path = File::Spec->abs2rel( $path ) ;
 221     $rel_path = File::Spec->abs2rel( $path, $base ) ;
 222
 223 If $base is not present or '', then L<cwd()|Cwd> is used. If $base is relative,
 224 then it is converted to absolute form using L</rel2abs()>. This means that it
 225 is taken to be relative to L<cwd()|Cwd>.
 226
 227 On systems with the concept of a volume, this assumes that both paths
 228 are on the $destination volume, and ignores the $base volume.
 229
 230 On systems that have a grammar that indicates filenames, this ignores the
 231 $base filename as well. Otherwise all path components are assumed to be
 232 directories.
 233
 234 If $path is relative, it is converted to absolute form using L</rel2abs()>.
 235 This means that it is taken to be relative to L<cwd()|Cwd>.
 236
 237 No checks against the filesystem are made.  On VMS, there is
 238 interaction with the working environment, as logicals and
 239 macros are expanded.
 240
 241 Based on code written by Shigio Yamaguchi.
 242
 243 =item rel2abs()
 244
 245 Converts a relative path to an absolute path.
 246
 247     $abs_path = File::Spec->rel2abs( $path ) ;
 248     $abs_path = File::Spec->rel2abs( $path, $base ) ;
 249
 250 If $base is not present or '', then L<cwd()|Cwd> is used. If $base is relative,
 251 then it is converted to absolute form using L</rel2abs()>. This means that it
 252 is taken to be relative to L<cwd()|Cwd>.
 253
 254 On systems with the concept of a volume, this assumes that both paths
 255 are on the $base volume, and ignores the $path volume.
 256
 257 On systems that have a grammar that indicates filenames, this ignores the
 258 $base filename as well. Otherwise all path components are assumed to be
 259 directories.
 260
 261 If $path is absolute, it is cleaned up and returned using L</canonpath()>.
 262
 263 No checks against the filesystem are made.  On VMS, there is
 264 interaction with the working environment, as logicals and
 265 macros are expanded.
 266
 267 Based on code written by Shigio Yamaguchi.
 268
 269 =back
 270
 271 For further information, please see L<File::Spec::Unix>,
 272 L<File::Spec::Mac>, L<File::Spec::OS2>, L<File::Spec::Win32>, or
 273 L<File::Spec::VMS>.
 274
 275 =head1 SEE ALSO
 276
 277 L<File::Spec::Unix>, L<File::Spec::Mac>, L<File::Spec::OS2>,
 278 L<File::Spec::Win32>, L<File::Spec::VMS>, L<File::Spec::Functions>,
 279 L<ExtUtils::MakeMaker>
 280
 281 =head1 AUTHORS
 282
 283 Kenneth Albanowski <kjahds@kjahds.com>, Andy Dougherty
 284 <doughera@lafcol.lafayette.edu>, Andreas KE<ouml>nig
 285 <A.Koenig@franz.ww.TU-Berlin.DE>, Tim Bunce <Tim.Bunce@ig.co.uk.
 286 VMS support by Charles Bailey <bailey@newman.upenn.edu>.
 287 OS/2 support by Ilya Zakharevich <ilya@math.ohio-state.edu>.
 288 Mac support by Paul Schinder <schinder@pobox.com>, and Thomas Wegner
 289 <wegner_thomas@yahoo.com>.  abs2rel() and rel2abs() written by Shigio
 290 Yamaguchi <shigio@tamacom.com>, modified by Barrie Slaymaker
 291 <barries@slaysys.com>.  splitpath(), splitdir(), catpath() and
 292 catdir() by Barrie Slaymaker.