Commit | Line | Data |
270d1e39 |
1 | package File::Spec; |
2 | |
270d1e39 |
3 | use strict; |
07824bd1 |
4 | use vars qw(@ISA $VERSION); |
270d1e39 |
5 | |
ff235dd6 |
6 | $VERSION = '3.18'; |
5b287435 |
7 | $VERSION = eval $VERSION; |
270d1e39 |
8 | |
cbc7acb0 |
9 | my %module = (MacOS => 'Mac', |
10 | MSWin32 => 'Win32', |
11 | os2 => 'OS2', |
fa6a1c44 |
12 | VMS => 'VMS', |
ecf68df6 |
13 | epoc => 'Epoc', |
ffa8448b |
14 | NetWare => 'Win32', # Yes, File::Spec::Win32 works on NetWare. |
27da23d5 |
15 | symbian => 'Win32', # Yes, File::Spec::Win32 works on symbian. |
60598624 |
16 | dos => 'OS2', # Yes, File::Spec::OS2 works on DJGPP. |
ecf68df6 |
17 | cygwin => 'Cygwin'); |
18 | |
cbc7acb0 |
19 | |
20 | my $module = $module{$^O} || 'Unix'; |
ecf68df6 |
21 | |
cbc7acb0 |
22 | require "File/Spec/$module.pm"; |
23 | @ISA = ("File::Spec::$module"); |
270d1e39 |
24 | |
25 | 1; |
ae1c33a1 |
26 | |
270d1e39 |
27 | __END__ |
28 | |
29 | =head1 NAME |
30 | |
31 | File::Spec - portably perform operations on file names |
32 | |
33 | =head1 SYNOPSIS |
34 | |
5c609535 |
35 | use File::Spec; |
270d1e39 |
36 | |
5c609535 |
37 | $x=File::Spec->catfile('a', 'b', 'c'); |
270d1e39 |
38 | |
5c609535 |
39 | which returns 'a/b/c' under Unix. Or: |
40 | |
41 | use File::Spec::Functions; |
42 | |
43 | $x = catfile('a', 'b', 'c'); |
270d1e39 |
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 |
5c609535 |
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. |
270d1e39 |
68 | |
2586ba89 |
69 | Since File::Spec is object oriented, subroutines should not be called directly, |
270d1e39 |
70 | as in: |
71 | |
72 | File::Spec::catfile('a','b'); |
5c609535 |
73 | |
270d1e39 |
74 | but rather as class methods: |
75 | |
76 | File::Spec->catfile('a','b'); |
77 | |
5c609535 |
78 | For simple uses, L<File::Spec::Functions> provides convenient functional |
79 | forms of these methods. |
80 | |
ae1c33a1 |
81 | =head1 METHODS |
82 | |
83 | =over 2 |
84 | |
5813de03 |
85 | =item canonpath |
ae1c33a1 |
86 | |
87 | No physical check on the filesystem, but a logical cleanup of a |
88 | path. |
89 | |
90 | $cpath = File::Spec->canonpath( $path ) ; |
91 | |
60598624 |
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 | |
5813de03 |
99 | =item catdir |
ae1c33a1 |
100 | |
101 | Concatenate two or more directory names to form a complete path ending |
102 | with a directory. But remove the trailing slash from the resulting |
103 | string, because it doesn't look good, isn't necessary and confuses |
5b287435 |
104 | OS/2. Of course, if this is the root directory, don't cut off the |
ae1c33a1 |
105 | trailing slash :-) |
106 | |
107 | $path = File::Spec->catdir( @directories ); |
108 | |
109 | =item catfile |
110 | |
111 | Concatenate one or more directory names and a filename to form a |
112 | complete path ending with a filename |
113 | |
114 | $path = File::Spec->catfile( @directories, $filename ); |
115 | |
116 | =item curdir |
117 | |
118 | Returns a string representation of the current directory. |
119 | |
120 | $curdir = File::Spec->curdir(); |
121 | |
122 | =item devnull |
123 | |
124 | Returns a string representation of the null device. |
125 | |
126 | $devnull = File::Spec->devnull(); |
127 | |
128 | =item rootdir |
129 | |
130 | Returns a string representation of the root directory. |
131 | |
132 | $rootdir = File::Spec->rootdir(); |
133 | |
134 | =item tmpdir |
135 | |
136 | Returns a string representation of the first writable directory from a |
07824bd1 |
137 | list of possible temporary directories. Returns the current directory |
138 | if no writable temporary directories are found. The list of directories |
5b287435 |
139 | checked depends on the platform; e.g. File::Spec::Unix checks C<$ENV{TMPDIR}> |
140 | (unless taint is on) and F</tmp>. |
ae1c33a1 |
141 | |
142 | $tmpdir = File::Spec->tmpdir(); |
143 | |
144 | =item updir |
145 | |
146 | Returns a string representation of the parent directory. |
147 | |
148 | $updir = File::Spec->updir(); |
149 | |
150 | =item no_upwards |
151 | |
152 | Given a list of file names, strip out those that refer to a parent |
153 | directory. (Does not strip symlinks, only '.', '..', and equivalents.) |
154 | |
155 | @paths = File::Spec->no_upwards( @paths ); |
156 | |
157 | =item case_tolerant |
158 | |
159 | Returns a true or false value indicating, respectively, that alphabetic |
5b287435 |
160 | case is not or is significant when comparing file specifications. |
ae1c33a1 |
161 | |
162 | $is_case_tolerant = File::Spec->case_tolerant(); |
163 | |
164 | =item file_name_is_absolute |
165 | |
5b287435 |
166 | Takes as its argument a path, and returns true if it is an absolute path. |
ae1c33a1 |
167 | |
168 | $is_absolute = File::Spec->file_name_is_absolute( $path ); |
169 | |
2586ba89 |
170 | This does not consult the local filesystem on Unix, Win32, OS/2, or |
171 | Mac OS (Classic). It does consult the working environment for VMS |
172 | (see L<File::Spec::VMS/file_name_is_absolute>). |
ae1c33a1 |
173 | |
174 | =item path |
175 | |
5b287435 |
176 | Takes no argument. Returns the environment variable C<PATH> (or the local |
638113eb |
177 | platform's equivalent) as a list. |
ae1c33a1 |
178 | |
179 | @PATH = File::Spec->path(); |
180 | |
181 | =item join |
182 | |
183 | join is the same as catfile. |
184 | |
185 | =item splitpath |
186 | |
187 | Splits a path in to volume, directory, and filename portions. On systems |
40d020d9 |
188 | with no concept of volume, returns '' for volume. |
ae1c33a1 |
189 | |
190 | ($volume,$directories,$file) = File::Spec->splitpath( $path ); |
191 | ($volume,$directories,$file) = File::Spec->splitpath( $path, $no_file ); |
192 | |
193 | For systems with no syntax differentiating filenames from directories, |
5b287435 |
194 | assumes that the last file is a path unless C<$no_file> is true or a |
195 | trailing separator or F</.> or F</..> is present. On Unix, this means that C<$no_file> |
ae1c33a1 |
196 | true makes this return ( '', $path, '' ). |
197 | |
198 | The directory portion may or may not be returned with a trailing '/'. |
199 | |
200 | The results can be passed to L</catpath()> to get back a path equivalent to |
201 | (usually identical to) the original path. |
202 | |
203 | =item splitdir |
204 | |
205 | The opposite of L</catdir()>. |
206 | |
207 | @dirs = File::Spec->splitdir( $directories ); |
208 | |
5b287435 |
209 | C<$directories> must be only the directory portion of the path on systems |
ae1c33a1 |
210 | that have the concept of a volume or that have path syntax that differentiates |
211 | files from directories. |
212 | |
213 | Unlike just splitting the directories on the separator, empty |
214 | directory names (C<''>) can be returned, because these are significant |
5b287435 |
215 | on some OSes. |
ae1c33a1 |
216 | |
59605c55 |
217 | =item catpath() |
ae1c33a1 |
218 | |
219 | Takes volume, directory and file portions and returns an entire path. Under |
5b287435 |
220 | Unix, C<$volume> is ignored, and directory and file are concatenated. A '/' is |
221 | inserted if need be. On other OSes, C<$volume> is significant. |
ae1c33a1 |
222 | |
223 | $full_path = File::Spec->catpath( $volume, $directory, $file ); |
224 | |
225 | =item abs2rel |
226 | |
227 | Takes a destination path and an optional base path returns a relative path |
228 | from the base path to the destination path: |
229 | |
230 | $rel_path = File::Spec->abs2rel( $path ) ; |
231 | $rel_path = File::Spec->abs2rel( $path, $base ) ; |
232 | |
23bb49fa |
233 | If C<$base> is not present or '', then L<Cwd::cwd()|Cwd> is used. If C<$base> is |
8d48b1f5 |
234 | relative, then it is converted to absolute form using |
235 | L</rel2abs()>. This means that it is taken to be relative to |
23bb49fa |
236 | L<Cwd::cwd()|Cwd>. |
8d48b1f5 |
237 | |
5b287435 |
238 | On systems with the concept of volume, if C<$path> and C<$base> appear to be |
638113eb |
239 | on two different volumes, we will not attempt to resolve the two |
5b287435 |
240 | paths, and we will instead simply return C<$path>. Note that previous |
241 | versions of this module ignored the volume of C<$base>, which resulted in |
638113eb |
242 | garbage results part of the time. |
ae1c33a1 |
243 | |
244 | On systems that have a grammar that indicates filenames, this ignores the |
5b287435 |
245 | C<$base> filename as well. Otherwise all path components are assumed to be |
ae1c33a1 |
246 | directories. |
247 | |
5b287435 |
248 | If C<$path> is relative, it is converted to absolute form using L</rel2abs()>. |
23bb49fa |
249 | This means that it is taken to be relative to L<Cwd::cwd()|Cwd>. |
ae1c33a1 |
250 | |
2586ba89 |
251 | No checks against the filesystem are made. On VMS, there is |
ae1c33a1 |
252 | interaction with the working environment, as logicals and |
253 | macros are expanded. |
254 | |
255 | Based on code written by Shigio Yamaguchi. |
256 | |
59605c55 |
257 | =item rel2abs() |
ae1c33a1 |
258 | |
259 | Converts a relative path to an absolute path. |
260 | |
261 | $abs_path = File::Spec->rel2abs( $path ) ; |
262 | $abs_path = File::Spec->rel2abs( $path, $base ) ; |
263 | |
23bb49fa |
264 | If C<$base> is not present or '', then L<Cwd::cwd()|Cwd> is used. If C<$base> is relative, |
ae1c33a1 |
265 | then it is converted to absolute form using L</rel2abs()>. This means that it |
23bb49fa |
266 | is taken to be relative to L<Cwd::cwd()|Cwd>. |
ae1c33a1 |
267 | |
5b287435 |
268 | On systems with the concept of volume, if C<$path> and C<$base> appear to be |
638113eb |
269 | on two different volumes, we will not attempt to resolve the two |
5b287435 |
270 | paths, and we will instead simply return C<$path>. Note that previous |
271 | versions of this module ignored the volume of C<$base>, which resulted in |
638113eb |
272 | garbage results part of the time. |
ae1c33a1 |
273 | |
274 | On systems that have a grammar that indicates filenames, this ignores the |
5b287435 |
275 | C<$base> filename as well. Otherwise all path components are assumed to be |
ae1c33a1 |
276 | directories. |
277 | |
5b287435 |
278 | If C<$path> is absolute, it is cleaned up and returned using L</canonpath()>. |
ae1c33a1 |
279 | |
2586ba89 |
280 | No checks against the filesystem are made. On VMS, there is |
ae1c33a1 |
281 | interaction with the working environment, as logicals and |
282 | macros are expanded. |
283 | |
284 | Based on code written by Shigio Yamaguchi. |
285 | |
286 | =back |
287 | |
288 | For further information, please see L<File::Spec::Unix>, |
289 | L<File::Spec::Mac>, L<File::Spec::OS2>, L<File::Spec::Win32>, or |
290 | L<File::Spec::VMS>. |
270d1e39 |
291 | |
292 | =head1 SEE ALSO |
293 | |
ae1c33a1 |
294 | L<File::Spec::Unix>, L<File::Spec::Mac>, L<File::Spec::OS2>, |
295 | L<File::Spec::Win32>, L<File::Spec::VMS>, L<File::Spec::Functions>, |
296 | L<ExtUtils::MakeMaker> |
270d1e39 |
297 | |
5b287435 |
298 | =head1 AUTHOR |
299 | |
300 | Currently maintained by Ken Williams C<< <KWILLIAMS@cpan.org> >>. |
301 | |
302 | The vast majority of the code was written by |
303 | Kenneth Albanowski C<< <kjahds@kjahds.com> >>, |
304 | Andy Dougherty C<< <doughera@lafayette.edu> >>, |
305 | Andreas KE<ouml>nig C<< <A.Koenig@franz.ww.TU-Berlin.DE> >>, |
306 | Tim Bunce C<< <Tim.Bunce@ig.co.uk> >>. |
307 | VMS support by Charles Bailey C<< <bailey@newman.upenn.edu> >>. |
308 | OS/2 support by Ilya Zakharevich C<< <ilya@math.ohio-state.edu> >>. |
309 | Mac support by Paul Schinder C<< <schinder@pobox.com> >>, and |
310 | Thomas Wegner C<< <wegner_thomas@yahoo.com> >>. |
311 | abs2rel() and rel2abs() written by Shigio Yamaguchi C<< <shigio@tamacom.com> >>, |
312 | modified by Barrie Slaymaker C<< <barries@slaysys.com> >>. |
313 | splitpath(), splitdir(), catpath() and catdir() by Barrie Slaymaker. |
e021ab8e |
314 | |
99f36a73 |
315 | =head1 COPYRIGHT |
316 | |
317 | Copyright (c) 2004 by the Perl 5 Porters. All rights reserved. |
318 | |
319 | This program is free software; you can redistribute it and/or modify |
320 | it under the same terms as Perl itself. |
321 | |
e021ab8e |
322 | =cut |