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