This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Make the VERSION of File::Spec be 0.86, otherwise File::Temp's
[perl5.git] / lib / File / Spec.pm
1 package File::Spec;
2
3 use strict;
4 use vars qw(@ISA $VERSION);
5
6 $VERSION = '0.86';
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 the current directory
129 if no writable temporary directories are found.  The list of directories
130 checked depends on the platform; e.g. File::Spec::Unix checks $ENV{TMPDIR}
131 (unless taint is on) and /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 (or the local
168 platform's equivalent) as a list.
169
170     @PATH = File::Spec->path();
171
172 =item join
173
174 join is the same as catfile.
175
176 =item splitpath
177
178 Splits a path in to volume, directory, and filename portions. On systems
179 with no concept of volume, returns '' for volume. 
180
181     ($volume,$directories,$file) = File::Spec->splitpath( $path );
182     ($volume,$directories,$file) = File::Spec->splitpath( $path, $no_file );
183
184 For systems with no syntax differentiating filenames from directories, 
185 assumes that the last file is a path unless $no_file is true or a 
186 trailing separator or /. or /.. is present. On Unix this means that $no_file
187 true makes this return ( '', $path, '' ).
188
189 The directory portion may or may not be returned with a trailing '/'.
190
191 The results can be passed to L</catpath()> to get back a path equivalent to
192 (usually identical to) the original path.
193
194 =item splitdir
195
196 The opposite of L</catdir()>.
197
198     @dirs = File::Spec->splitdir( $directories );
199
200 $directories must be only the directory portion of the path on systems 
201 that have the concept of a volume or that have path syntax that differentiates
202 files from directories.
203
204 Unlike just splitting the directories on the separator, empty
205 directory names (C<''>) can be returned, because these are significant
206 on some OSs.
207
208 =item catpath()
209
210 Takes volume, directory and file portions and returns an entire path. Under
211 Unix, $volume is ignored, and directory and file are concatenated.  A '/' is
212 inserted if need be.  On other OSs, $volume is significant.
213
214     $full_path = File::Spec->catpath( $volume, $directory, $file );
215
216 =item abs2rel
217
218 Takes a destination path and an optional base path returns a relative path
219 from the base path to the destination path:
220
221     $rel_path = File::Spec->abs2rel( $path ) ;
222     $rel_path = File::Spec->abs2rel( $path, $base ) ;
223
224 If $base is not present or '', then L<cwd()|Cwd> is used. If $base is
225 relative, then it is converted to absolute form using
226 L</rel2abs()>. This means that it is taken to be relative to
227 L<cwd()|Cwd>.
228
229 On systems with the concept of volume, if $path and $base appear to be
230 on two different volumes, we will not attempt to resolve the two
231 paths, and we will instead simply return $path.  Note that previous
232 versions of this module ignored the volume of $base, which resulted in
233 garbage results part of the time.
234
235 On systems that have a grammar that indicates filenames, this ignores the 
236 $base filename as well. Otherwise all path components are assumed to be
237 directories.
238
239 If $path is relative, it is converted to absolute form using L</rel2abs()>.
240 This means that it is taken to be relative to L<cwd()|Cwd>.
241
242 No checks against the filesystem are made.  On VMS, there is
243 interaction with the working environment, as logicals and
244 macros are expanded.
245
246 Based on code written by Shigio Yamaguchi.
247
248 =item rel2abs()
249
250 Converts a relative path to an absolute path. 
251
252     $abs_path = File::Spec->rel2abs( $path ) ;
253     $abs_path = File::Spec->rel2abs( $path, $base ) ;
254
255 If $base is not present or '', then L<cwd()|Cwd> is used. If $base is relative, 
256 then it is converted to absolute form using L</rel2abs()>. This means that it
257 is taken to be relative to L<cwd()|Cwd>.
258
259 On systems with the concept of volume, if $path and $base appear to be
260 on two different volumes, we will not attempt to resolve the two
261 paths, and we will instead simply return $path.  Note that previous
262 versions of this module ignored the volume of $base, which resulted in
263 garbage results part of the time.
264
265 On systems that have a grammar that indicates filenames, this ignores the 
266 $base filename as well. Otherwise all path components are assumed to be
267 directories.
268
269 If $path is absolute, it is cleaned up and returned using L</canonpath()>.
270
271 No checks against the filesystem are made.  On VMS, there is
272 interaction with the working environment, as logicals and
273 macros are expanded.
274
275 Based on code written by Shigio Yamaguchi.
276
277 =back
278
279 For further information, please see L<File::Spec::Unix>,
280 L<File::Spec::Mac>, L<File::Spec::OS2>, L<File::Spec::Win32>, or
281 L<File::Spec::VMS>.
282
283 =head1 SEE ALSO
284
285 L<File::Spec::Unix>, L<File::Spec::Mac>, L<File::Spec::OS2>,
286 L<File::Spec::Win32>, L<File::Spec::VMS>, L<File::Spec::Functions>,
287 L<ExtUtils::MakeMaker>
288
289 =head1 AUTHORS
290
291 Kenneth Albanowski <kjahds@kjahds.com>, Andy Dougherty
292 <doughera@lafayette.edu>, Andreas KE<ouml>nig
293 <A.Koenig@franz.ww.TU-Berlin.DE>, Tim Bunce <Tim.Bunce@ig.co.uk.
294 VMS support by Charles Bailey <bailey@newman.upenn.edu>.
295 OS/2 support by Ilya Zakharevich <ilya@math.ohio-state.edu>.
296 Mac support by Paul Schinder <schinder@pobox.com>, and Thomas Wegner
297 <wegner_thomas@yahoo.com>.  abs2rel() and rel2abs() written by Shigio
298 Yamaguchi <shigio@tamacom.com>, modified by Barrie Slaymaker
299 <barries@slaysys.com>.  splitpath(), splitdir(), catpath() and
300 catdir() by Barrie Slaymaker.
301
302 =cut