This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
b09ed6b1a236318788c874d57c504594ec34702c
[perl5.git] / dist / PathTools / lib / File / Spec.pm
1 package File::Spec;
2
3 use strict;
4
5 our $VERSION = '3.70';
6 $VERSION =~ tr/_//d;
7
8 my %module = (MacOS   => 'Mac',
9               MSWin32 => 'Win32',
10               os2     => 'OS2',
11               VMS     => 'VMS',
12               NetWare => 'Win32', # Yes, File::Spec::Win32 works on NetWare.
13               symbian => 'Win32', # Yes, File::Spec::Win32 works on symbian.
14               dos     => 'OS2',   # Yes, File::Spec::OS2 works on DJGPP.
15               cygwin  => 'Cygwin',
16               amigaos => 'AmigaOS');
17
18
19 my $module = $module{$^O} || 'Unix';
20
21 require "File/Spec/$module.pm";
22 our @ISA = ("File::Spec::$module");
23
24 1;
25
26 __END__
27
28 =head1 NAME
29
30 File::Spec - portably perform operations on file names
31
32 =head1 SYNOPSIS
33
34         use File::Spec;
35
36         $x=File::Spec->catfile('a', 'b', 'c');
37
38 which returns 'a/b/c' under Unix. Or:
39
40         use File::Spec::Functions;
41
42         $x = catfile('a', 'b', 'c');
43
44 =head1 DESCRIPTION
45
46 This module is designed to support operations commonly performed on file
47 specifications (usually called "file names", but not to be confused with the
48 contents of a file, or Perl's file handles), such as concatenating several
49 directory and file names into a single path, or determining whether a path
50 is rooted. It is based on code directly taken from MakeMaker 5.17, code
51 written by Andreas KE<ouml>nig, Andy Dougherty, Charles Bailey, Ilya
52 Zakharevich, Paul Schinder, and others.
53
54 Since these functions are different for most operating systems, each set of
55 OS specific routines is available in a separate module, including:
56
57         File::Spec::Unix
58         File::Spec::Mac
59         File::Spec::OS2
60         File::Spec::Win32
61         File::Spec::VMS
62
63 The module appropriate for the current OS is automatically loaded by
64 File::Spec. Since some modules (like VMS) make use of facilities available
65 only under that OS, it may not be possible to load all modules under all
66 operating systems.
67
68 Since File::Spec is object oriented, subroutines should not be called directly,
69 as in:
70
71         File::Spec::catfile('a','b');
72
73 but rather as class methods:
74
75         File::Spec->catfile('a','b');
76
77 For simple uses, L<File::Spec::Functions> provides convenient functional
78 forms of these methods.
79
80 =head1 METHODS
81
82 =over 2
83
84 =item canonpath
85 X<canonpath>
86
87 No physical check on the filesystem, but a logical cleanup of a
88 path.
89
90     $cpath = File::Spec->canonpath( $path ) ;
91
92 Note that this does *not* collapse F<x/../y> sections into F<y>.  This
93 is by design.  If F</foo> on your system is a symlink to F</bar/baz>,
94 then F</foo/../quux> is actually F</bar/quux>, not F</quux> as a naive
95 F<../>-removal would give you.  If you want to do this kind of
96 processing, you probably want C<Cwd>'s C<realpath()> function to
97 actually traverse the filesystem cleaning up paths like this.
98
99 =item catdir
100 X<catdir>
101
102 Concatenate two or more directory names to form a complete path ending
103 with a directory. But remove the trailing slash from the resulting
104 string, because it doesn't look good, isn't necessary and confuses
105 OS/2. Of course, if this is the root directory, don't cut off the
106 trailing slash :-)
107
108     $path = File::Spec->catdir( @directories );
109
110 =item catfile
111 X<catfile>
112
113 Concatenate one or more directory names and a filename to form a
114 complete path ending with a filename
115
116     $path = File::Spec->catfile( @directories, $filename );
117
118 =item curdir
119 X<curdir>
120
121 Returns a string representation of the current directory.
122
123     $curdir = File::Spec->curdir();
124
125 =item devnull
126 X<devnull>
127
128 Returns a string representation of the null device.
129
130     $devnull = File::Spec->devnull();
131
132 =item rootdir
133 X<rootdir>
134
135 Returns a string representation of the root directory.
136
137     $rootdir = File::Spec->rootdir();
138
139 =item tmpdir
140 X<tmpdir>
141
142 Returns a string representation of the first writable directory from a
143 list of possible temporary directories.  Returns the current directory
144 if no writable temporary directories are found.  The list of directories
145 checked depends on the platform; e.g. File::Spec::Unix checks C<$ENV{TMPDIR}>
146 (unless taint is on) and F</tmp>.
147
148     $tmpdir = File::Spec->tmpdir();
149
150 =item updir
151 X<updir>
152
153 Returns a string representation of the parent directory.
154
155     $updir = File::Spec->updir();
156
157 =item no_upwards
158
159 Given a list of files in a directory (such as from C<readdir()>),
160 strip out C<'.'> and C<'..'>.
161
162 B<SECURITY NOTE:> This does NOT filter paths containing C<'..'>, like
163 C<'../../../../etc/passwd'>, only literal matches to C<'.'> and C<'..'>.
164
165     @paths = File::Spec->no_upwards( readdir $dirhandle );
166
167 =item case_tolerant
168
169 Returns a true or false value indicating, respectively, that alphabetic
170 case is not or is significant when comparing file specifications.
171 Cygwin and Win32 accept an optional drive argument.
172
173     $is_case_tolerant = File::Spec->case_tolerant();
174
175 =item file_name_is_absolute
176
177 Takes as its argument a path, and returns true if it is an absolute path.
178
179     $is_absolute = File::Spec->file_name_is_absolute( $path );
180
181 This does not consult the local filesystem on Unix, Win32, OS/2, or
182 Mac OS (Classic).  It does consult the working environment for VMS
183 (see L<File::Spec::VMS/file_name_is_absolute>).
184
185 =item path
186 X<path>
187
188 Takes no argument.  Returns the environment variable C<PATH> (or the local
189 platform's equivalent) as a list.
190
191     @PATH = File::Spec->path();
192
193 =item join
194 X<join, path>
195
196 join is the same as catfile.
197
198 =item splitpath
199 X<splitpath> X<split, path>
200
201 Splits a path in to volume, directory, and filename portions. On systems
202 with no concept of volume, returns '' for volume. 
203
204     ($volume,$directories,$file) =
205                        File::Spec->splitpath( $path );
206     ($volume,$directories,$file) =
207                        File::Spec->splitpath( $path, $no_file );
208
209 For systems with no syntax differentiating filenames from directories, 
210 assumes that the last file is a path unless C<$no_file> is true or a
211 trailing separator or F</.> or F</..> is present. On Unix, this means that C<$no_file>
212 true makes this return ( '', $path, '' ).
213
214 The directory portion may or may not be returned with a trailing '/'.
215
216 The results can be passed to L</catpath()> to get back a path equivalent to
217 (usually identical to) the original path.
218
219 =item splitdir
220 X<splitdir> X<split, dir>
221
222 The opposite of L</catdir>.
223
224     @dirs = File::Spec->splitdir( $directories );
225
226 C<$directories> must be only the directory portion of the path on systems 
227 that have the concept of a volume or that have path syntax that differentiates
228 files from directories.
229
230 Unlike just splitting the directories on the separator, empty
231 directory names (C<''>) can be returned, because these are significant
232 on some OSes.
233
234 =item catpath()
235
236 Takes volume, directory and file portions and returns an entire path. Under
237 Unix, C<$volume> is ignored, and directory and file are concatenated.  A '/' is
238 inserted if need be.  On other OSes, C<$volume> is significant.
239
240     $full_path = File::Spec->catpath( $volume, $directory, $file );
241
242 =item abs2rel
243 X<abs2rel> X<absolute, path> X<relative, path>
244
245 Takes a destination path and an optional base path returns a relative path
246 from the base path to the destination path:
247
248     $rel_path = File::Spec->abs2rel( $path ) ;
249     $rel_path = File::Spec->abs2rel( $path, $base ) ;
250
251 If C<$base> is not present or '', then L<Cwd::cwd()|Cwd> is used. If C<$base> is
252 relative, then it is converted to absolute form using
253 L</rel2abs()>. This means that it is taken to be relative to
254 L<Cwd::cwd()|Cwd>.
255
256 On systems with the concept of volume, if C<$path> and C<$base> appear to be
257 on two different volumes, we will not attempt to resolve the two
258 paths, and we will instead simply return C<$path>.  Note that previous
259 versions of this module ignored the volume of C<$base>, which resulted in
260 garbage results part of the time.
261
262 On systems that have a grammar that indicates filenames, this ignores the 
263 C<$base> filename as well. Otherwise all path components are assumed to be
264 directories.
265
266 If C<$path> is relative, it is converted to absolute form using L</rel2abs()>.
267 This means that it is taken to be relative to L<Cwd::cwd()|Cwd>.
268
269 No checks against the filesystem are made.  On VMS, there is
270 interaction with the working environment, as logicals and
271 macros are expanded.
272
273 Based on code written by Shigio Yamaguchi.
274
275 =item rel2abs()
276 X<rel2abs> X<absolute, path> X<relative, path>
277
278 Converts a relative path to an absolute path. 
279
280     $abs_path = File::Spec->rel2abs( $path ) ;
281     $abs_path = File::Spec->rel2abs( $path, $base ) ;
282
283 If C<$base> is not present or '', then L<Cwd::cwd()|Cwd> is used. If C<$base> is relative,
284 then it is converted to absolute form using L</rel2abs()>. This means that it
285 is taken to be relative to L<Cwd::cwd()|Cwd>.
286
287 On systems with the concept of volume, if C<$path> and C<$base> appear to be
288 on two different volumes, we will not attempt to resolve the two
289 paths, and we will instead simply return C<$path>.  Note that previous
290 versions of this module ignored the volume of C<$base>, which resulted in
291 garbage results part of the time.
292
293 On systems that have a grammar that indicates filenames, this ignores the 
294 C<$base> filename as well. Otherwise all path components are assumed to be
295 directories.
296
297 If C<$path> is absolute, it is cleaned up and returned using L</canonpath>.
298
299 No checks against the filesystem are made.  On VMS, there is
300 interaction with the working environment, as logicals and
301 macros are expanded.
302
303 Based on code written by Shigio Yamaguchi.
304
305 =back
306
307 For further information, please see L<File::Spec::Unix>,
308 L<File::Spec::Mac>, L<File::Spec::OS2>, L<File::Spec::Win32>, or
309 L<File::Spec::VMS>.
310
311 =head1 SEE ALSO
312
313 L<File::Spec::Unix>, L<File::Spec::Mac>, L<File::Spec::OS2>,
314 L<File::Spec::Win32>, L<File::Spec::VMS>, L<File::Spec::Functions>,
315 L<ExtUtils::MakeMaker>
316
317 =head1 AUTHOR
318
319 Currently maintained by Ken Williams C<< <KWILLIAMS@cpan.org> >>.
320
321 The vast majority of the code was written by
322 Kenneth Albanowski C<< <kjahds@kjahds.com> >>,
323 Andy Dougherty C<< <doughera@lafayette.edu> >>,
324 Andreas KE<ouml>nig C<< <A.Koenig@franz.ww.TU-Berlin.DE> >>,
325 Tim Bunce C<< <Tim.Bunce@ig.co.uk> >>.
326 VMS support by Charles Bailey C<< <bailey@newman.upenn.edu> >>.
327 OS/2 support by Ilya Zakharevich C<< <ilya@math.ohio-state.edu> >>.
328 Mac support by Paul Schinder C<< <schinder@pobox.com> >>, and
329 Thomas Wegner C<< <wegner_thomas@yahoo.com> >>.
330 abs2rel() and rel2abs() written by Shigio Yamaguchi C<< <shigio@tamacom.com> >>,
331 modified by Barrie Slaymaker C<< <barries@slaysys.com> >>.
332 splitpath(), splitdir(), catpath() and catdir() by Barrie Slaymaker.
333
334 =head1 COPYRIGHT
335
336 Copyright (c) 2004-2013 by the Perl 5 Porters.  All rights reserved.
337
338 This program is free software; you can redistribute it and/or modify
339 it under the same terms as Perl itself.
340
341 =cut