Commit | Line | Data |
270d1e39 |
1 | package File::Spec::Mac; |
2 | |
270d1e39 |
3 | use strict; |
b4296952 |
4 | use vars qw(@ISA $VERSION); |
cbc7acb0 |
5 | require File::Spec::Unix; |
b4296952 |
6 | |
21887892 |
7 | $VERSION = '3.29'; |
486bcc50 |
8 | $VERSION = eval $VERSION; |
b4296952 |
9 | |
270d1e39 |
10 | @ISA = qw(File::Spec::Unix); |
270d1e39 |
11 | |
bcdb689b |
12 | my $macfiles; |
13 | if ($^O eq 'MacOS') { |
14 | $macfiles = eval { require Mac::Files }; |
15 | } |
be708cc0 |
16 | |
e021ab8e |
17 | sub case_tolerant { 1 } |
18 | |
19 | |
270d1e39 |
20 | =head1 NAME |
21 | |
2586ba89 |
22 | File::Spec::Mac - File::Spec for Mac OS (Classic) |
270d1e39 |
23 | |
24 | =head1 SYNOPSIS |
25 | |
cbc7acb0 |
26 | require File::Spec::Mac; # Done internally by File::Spec if needed |
270d1e39 |
27 | |
28 | =head1 DESCRIPTION |
29 | |
30 | Methods for manipulating file specifications. |
31 | |
32 | =head1 METHODS |
33 | |
34 | =over 2 |
35 | |
36 | =item canonpath |
37 | |
2586ba89 |
38 | On Mac OS, there's nothing to be done. Returns what it's given. |
270d1e39 |
39 | |
40 | =cut |
41 | |
42 | sub canonpath { |
cbc7acb0 |
43 | my ($self,$path) = @_; |
44 | return $path; |
270d1e39 |
45 | } |
46 | |
59605c55 |
47 | =item catdir() |
270d1e39 |
48 | |
be708cc0 |
49 | Concatenate two or more directory names to form a path separated by colons |
2586ba89 |
50 | (":") ending with a directory. Resulting paths are B<relative> by default, |
45657e91 |
51 | but can be forced to be absolute (but avoid this, see below). Automatically |
52 | puts a trailing ":" on the end of the complete path, because that's what's |
53 | done in MacPerl's environment and helps to distinguish a file path from a |
2586ba89 |
54 | directory path. |
55 | |
45657e91 |
56 | B<IMPORTANT NOTE:> Beginning with version 1.3 of this module, the resulting |
3c4b39be |
57 | path is relative by default and I<not> absolute. This decision was made due |
45657e91 |
58 | to portability reasons. Since C<File::Spec-E<gt>catdir()> returns relative paths |
59 | on all other operating systems, it will now also follow this convention on Mac |
2586ba89 |
60 | OS. Note that this may break some existing scripts. |
be708cc0 |
61 | |
62 | The intended purpose of this routine is to concatenate I<directory names>. |
63 | But because of the nature of Macintosh paths, some additional possibilities |
64 | are allowed to make using this routine give reasonable results for some |
65 | common situations. In other words, you are also allowed to concatenate |
66 | I<paths> instead of directory names (strictly speaking, a string like ":a" |
67 | is a path, but not a name, since it contains a punctuation character ":"). |
68 | |
be708cc0 |
69 | So, beside calls like |
70 | |
2586ba89 |
71 | catdir("a") = ":a:" |
72 | catdir("a","b") = ":a:b:" |
73 | catdir() = "" (special case) |
be708cc0 |
74 | |
75 | calls like the following |
270d1e39 |
76 | |
2586ba89 |
77 | catdir(":a:") = ":a:" |
78 | catdir(":a","b") = ":a:b:" |
79 | catdir(":a:","b") = ":a:b:" |
80 | catdir(":a:",":b:") = ":a:b:" |
81 | catdir(":") = ":" |
270d1e39 |
82 | |
be708cc0 |
83 | are allowed. |
270d1e39 |
84 | |
5813de03 |
85 | Here are the rules that are used in C<catdir()>; note that we try to be as |
86 | compatible as possible to Unix: |
2586ba89 |
87 | |
88 | =over 2 |
89 | |
2586ba89 |
90 | =item 1. |
2586ba89 |
91 | |
5813de03 |
92 | The resulting path is relative by default, i.e. the resulting path will have a |
93 | leading colon. |
2586ba89 |
94 | |
95 | =item 2. |
2586ba89 |
96 | |
5813de03 |
97 | A trailing colon is added automatically to the resulting path, to denote a |
98 | directory. |
2586ba89 |
99 | |
100 | =item 3. |
2586ba89 |
101 | |
5813de03 |
102 | Generally, each argument has one leading ":" and one trailing ":" |
103 | removed (if any). They are then joined together by a ":". Special |
104 | treatment applies for arguments denoting updir paths like "::lib:", |
105 | see (4), or arguments consisting solely of colons ("colon paths"), |
106 | see (5). |
270d1e39 |
107 | |
2586ba89 |
108 | =item 4. |
5813de03 |
109 | |
110 | When an updir path like ":::lib::" is passed as argument, the number |
111 | of directories to climb up is handled correctly, not removing leading |
112 | or trailing colons when necessary. E.g. |
270d1e39 |
113 | |
2586ba89 |
114 | catdir(":::a","::b","c") = ":::a::b:c:" |
115 | catdir(":::a::","::b","c") = ":::a:::b:c:" |
270d1e39 |
116 | |
2586ba89 |
117 | =item 5. |
5813de03 |
118 | |
119 | Adding a colon ":" or empty string "" to a path at I<any> position |
120 | doesn't alter the path, i.e. these arguments are ignored. (When a "" |
121 | is passed as the first argument, it has a special meaning, see |
122 | (6)). This way, a colon ":" is handled like a "." (curdir) on Unix, |
123 | while an empty string "" is generally ignored (see |
124 | C<Unix-E<gt>canonpath()> ). Likewise, a "::" is handled like a ".." |
125 | (updir), and a ":::" is handled like a "../.." etc. E.g. |
270d1e39 |
126 | |
2586ba89 |
127 | catdir("a",":",":","b") = ":a:b:" |
128 | catdir("a",":","::",":b") = ":a::b:" |
129 | |
2586ba89 |
130 | =item 6. |
5813de03 |
131 | |
132 | If the first argument is an empty string "" or is a volume name, i.e. matches |
133 | the pattern /^[^:]+:/, the resulting path is B<absolute>. |
2586ba89 |
134 | |
135 | =item 7. |
5813de03 |
136 | |
137 | Passing an empty string "" as the first argument to C<catdir()> is |
138 | like passingC<File::Spec-E<gt>rootdir()> as the first argument, i.e. |
2586ba89 |
139 | |
140 | catdir("","a","b") is the same as |
141 | |
45657e91 |
142 | catdir(rootdir(),"a","b"). |
2586ba89 |
143 | |
5813de03 |
144 | This is true on Unix, where C<catdir("","a","b")> yields "/a/b" and |
145 | C<rootdir()> is "/". Note that C<rootdir()> on Mac OS is the startup |
146 | volume, which is the closest in concept to Unix' "/". This should help |
147 | to run existing scripts originally written for Unix. |
2586ba89 |
148 | |
149 | =item 8. |
5813de03 |
150 | |
151 | For absolute paths, some cleanup is done, to ensure that the volume |
152 | name isn't immediately followed by updirs. This is invalid, because |
153 | this would go beyond "root". Generally, these cases are handled like |
154 | their Unix counterparts: |
2586ba89 |
155 | |
156 | Unix: |
157 | Unix->catdir("","") = "/" |
158 | Unix->catdir("",".") = "/" |
159 | Unix->catdir("","..") = "/" # can't go beyond root |
160 | Unix->catdir("",".","..","..","a") = "/a" |
161 | Mac: |
162 | Mac->catdir("","") = rootdir() # (e.g. "HD:") |
163 | Mac->catdir("",":") = rootdir() |
164 | Mac->catdir("","::") = rootdir() # can't go beyond root |
165 | Mac->catdir("",":","::","::","a") = rootdir() . "a:" # (e.g. "HD:a:") |
166 | |
5813de03 |
167 | However, this approach is limited to the first arguments following |
168 | "root" (again, see C<Unix-E<gt>canonpath()> ). If there are more |
169 | arguments that move up the directory tree, an invalid path going |
170 | beyond root can be created. |
2586ba89 |
171 | |
172 | =back |
173 | |
5813de03 |
174 | As you've seen, you can force C<catdir()> to create an absolute path |
175 | by passing either an empty string or a path that begins with a volume |
176 | name as the first argument. However, you are strongly encouraged not |
177 | to do so, since this is done only for backward compatibility. Newer |
178 | versions of File::Spec come with a method called C<catpath()> (see |
179 | below), that is designed to offer a portable solution for the creation |
180 | of absolute paths. It takes volume, directory and file portions and |
181 | returns an entire path. While C<catdir()> is still suitable for the |
182 | concatenation of I<directory names>, you are encouraged to use |
183 | C<catpath()> to concatenate I<volume names> and I<directory |
184 | paths>. E.g. |
2586ba89 |
185 | |
186 | $dir = File::Spec->catdir("tmp","sources"); |
187 | $abs_path = File::Spec->catpath("MacintoshHD:", $dir,""); |
270d1e39 |
188 | |
be708cc0 |
189 | yields |
270d1e39 |
190 | |
2586ba89 |
191 | "MacintoshHD:tmp:sources:" . |
270d1e39 |
192 | |
270d1e39 |
193 | =cut |
194 | |
270d1e39 |
195 | sub catdir { |
45657e91 |
196 | my $self = shift; |
197 | return '' unless @_; |
198 | my @args = @_; |
199 | my $first_arg; |
200 | my $relative; |
201 | |
2586ba89 |
202 | # take care of the first argument |
45657e91 |
203 | |
2586ba89 |
204 | if ($args[0] eq '') { # absolute path, rootdir |
205 | shift @args; |
206 | $relative = 0; |
207 | $first_arg = $self->rootdir; |
45657e91 |
208 | |
2586ba89 |
209 | } elsif ($args[0] =~ /^[^:]+:/) { # absolute path, volume name |
210 | $relative = 0; |
211 | $first_arg = shift @args; |
212 | # add a trailing ':' if need be (may be it's a path like HD:dir) |
213 | $first_arg = "$first_arg:" unless ($first_arg =~ /:\Z(?!\n)/); |
45657e91 |
214 | |
2586ba89 |
215 | } else { # relative path |
216 | $relative = 1; |
45657e91 |
217 | if ( $args[0] =~ /^::+\Z(?!\n)/ ) { |
2586ba89 |
218 | # updir colon path ('::', ':::' etc.), don't shift |
219 | $first_arg = ':'; |
220 | } elsif ($args[0] eq ':') { |
221 | $first_arg = shift @args; |
222 | } else { |
223 | # add a trailing ':' if need be |
224 | $first_arg = shift @args; |
225 | $first_arg = "$first_arg:" unless ($first_arg =~ /:\Z(?!\n)/); |
45657e91 |
226 | } |
227 | } |
228 | |
229 | # For all other arguments, |
2586ba89 |
230 | # (a) ignore arguments that equal ':' or '', |
231 | # (b) handle updir paths specially: |
232 | # '::' -> concatenate '::' |
233 | # '::' . '::' -> concatenate ':::' etc. |
234 | # (c) add a trailing ':' if need be |
45657e91 |
235 | |
2586ba89 |
236 | my $result = $first_arg; |
237 | while (@args) { |
238 | my $arg = shift @args; |
239 | unless (($arg eq '') || ($arg eq ':')) { |
240 | if ($arg =~ /^::+\Z(?!\n)/ ) { # updir colon path like ':::' |
241 | my $updir_count = length($arg) - 1; |
242 | while ((@args) && ($args[0] =~ /^::+\Z(?!\n)/) ) { # while updir colon path |
45657e91 |
243 | $arg = shift @args; |
2586ba89 |
244 | $updir_count += (length($arg) - 1); |
245 | } |
45657e91 |
246 | $arg = (':' x $updir_count); |
2586ba89 |
247 | } else { |
248 | $arg =~ s/^://s; # remove a leading ':' if any |
249 | $arg = "$arg:" unless ($arg =~ /:\Z(?!\n)/); # ensure trailing ':' |
250 | } |
251 | $result .= $arg; |
252 | }#unless |
45657e91 |
253 | } |
254 | |
255 | if ( ($relative) && ($result !~ /^:/) ) { |
2586ba89 |
256 | # add a leading colon if need be |
257 | $result = ":$result"; |
258 | } |
45657e91 |
259 | |
260 | unless ($relative) { |
2586ba89 |
261 | # remove updirs immediately following the volume name |
262 | $result =~ s/([^:]+:)(:*)(.*)\Z(?!\n)/$1$3/; |
263 | } |
45657e91 |
264 | |
265 | return $result; |
270d1e39 |
266 | } |
267 | |
268 | =item catfile |
269 | |
270 | Concatenate one or more directory names and a filename to form a |
45657e91 |
271 | complete path ending with a filename. Resulting paths are B<relative> |
272 | by default, but can be forced to be absolute (but avoid this). |
273 | |
274 | B<IMPORTANT NOTE:> Beginning with version 1.3 of this module, the |
275 | resulting path is relative by default and I<not> absolute. This |
3c4b39be |
276 | decision was made due to portability reasons. Since |
45657e91 |
277 | C<File::Spec-E<gt>catfile()> returns relative paths on all other |
278 | operating systems, it will now also follow this convention on Mac OS. |
2586ba89 |
279 | Note that this may break some existing scripts. |
280 | |
45657e91 |
281 | The last argument is always considered to be the file portion. Since |
282 | C<catfile()> uses C<catdir()> (see above) for the concatenation of the |
283 | directory portions (if any), the following with regard to relative and |
2586ba89 |
284 | absolute paths is true: |
285 | |
286 | catfile("") = "" |
45657e91 |
287 | catfile("file") = "file" |
2586ba89 |
288 | |
289 | but |
290 | |
291 | catfile("","") = rootdir() # (e.g. "HD:") |
292 | catfile("","file") = rootdir() . file # (e.g. "HD:file") |
293 | catfile("HD:","file") = "HD:file" |
270d1e39 |
294 | |
45657e91 |
295 | This means that C<catdir()> is called only when there are two or more |
2586ba89 |
296 | arguments, as one might expect. |
270d1e39 |
297 | |
2586ba89 |
298 | Note that the leading ":" is removed from the filename, so that |
270d1e39 |
299 | |
2586ba89 |
300 | catfile("a","b","file") = ":a:b:file" and |
270d1e39 |
301 | |
2586ba89 |
302 | catfile("a","b",":file") = ":a:b:file" |
303 | |
45657e91 |
304 | give the same answer. |
2586ba89 |
305 | |
45657e91 |
306 | To concatenate I<volume names>, I<directory paths> and I<filenames>, |
2586ba89 |
307 | you are encouraged to use C<catpath()> (see below). |
270d1e39 |
308 | |
309 | =cut |
310 | |
311 | sub catfile { |
cbc7acb0 |
312 | my $self = shift; |
be708cc0 |
313 | return '' unless @_; |
270d1e39 |
314 | my $file = pop @_; |
315 | return $file unless @_; |
316 | my $dir = $self->catdir(@_); |
1b1e14d3 |
317 | $file =~ s/^://s; |
270d1e39 |
318 | return $dir.$file; |
319 | } |
320 | |
321 | =item curdir |
322 | |
be708cc0 |
323 | Returns a string representing the current directory. On Mac OS, this is ":". |
270d1e39 |
324 | |
325 | =cut |
326 | |
327 | sub curdir { |
cbc7acb0 |
328 | return ":"; |
329 | } |
330 | |
331 | =item devnull |
332 | |
be708cc0 |
333 | Returns a string representing the null device. On Mac OS, this is "Dev:Null". |
cbc7acb0 |
334 | |
335 | =cut |
336 | |
337 | sub devnull { |
338 | return "Dev:Null"; |
270d1e39 |
339 | } |
340 | |
341 | =item rootdir |
342 | |
343 | Returns a string representing the root directory. Under MacPerl, |
344 | returns the name of the startup volume, since that's the closest in |
be708cc0 |
345 | concept, although other volumes aren't rooted there. The name has a |
346 | trailing ":", because that's the correct specification for a volume |
347 | name on Mac OS. |
270d1e39 |
348 | |
bcdb689b |
349 | If Mac::Files could not be loaded, the empty string is returned. |
350 | |
270d1e39 |
351 | =cut |
352 | |
353 | sub rootdir { |
354 | # |
2586ba89 |
355 | # There's no real root directory on Mac OS. The name of the startup |
cbc7acb0 |
356 | # volume is returned, since that's the closest in concept. |
270d1e39 |
357 | # |
bcdb689b |
358 | return '' unless $macfiles; |
359 | my $system = Mac::Files::FindFolder(&Mac::Files::kOnSystemDisk, |
360 | &Mac::Files::kSystemFolderType); |
9c045eb2 |
361 | $system =~ s/:.*\Z(?!\n)/:/s; |
cbc7acb0 |
362 | return $system; |
363 | } |
364 | |
365 | =item tmpdir |
366 | |
07824bd1 |
367 | Returns the contents of $ENV{TMPDIR}, if that directory exits or the |
368 | current working directory otherwise. Under MacPerl, $ENV{TMPDIR} will |
369 | contain a path like "MacintoshHD:Temporary Items:", which is a hidden |
370 | directory on your startup volume. |
cbc7acb0 |
371 | |
372 | =cut |
373 | |
374 | my $tmpdir; |
375 | sub tmpdir { |
376 | return $tmpdir if defined $tmpdir; |
60598624 |
377 | $tmpdir = $_[0]->_tmpdir( $ENV{TMPDIR} ); |
270d1e39 |
378 | } |
379 | |
380 | =item updir |
381 | |
be708cc0 |
382 | Returns a string representing the parent directory. On Mac OS, this is "::". |
270d1e39 |
383 | |
384 | =cut |
385 | |
386 | sub updir { |
387 | return "::"; |
388 | } |
389 | |
390 | =item file_name_is_absolute |
391 | |
be708cc0 |
392 | Takes as argument a path and returns true, if it is an absolute path. |
2586ba89 |
393 | If the path has a leading ":", it's a relative path. Otherwise, it's an |
be708cc0 |
394 | absolute path, unless the path doesn't contain any colons, i.e. it's a name |
395 | like "a". In this particular case, the path is considered to be relative |
396 | (i.e. it is considered to be a filename). Use ":" in the appropriate place |
397 | in the path if you want to distinguish unambiguously. As a special case, |
45657e91 |
398 | the filename '' is always considered to be absolute. Note that with version |
399 | 1.2 of File::Spec::Mac, this does no longer consult the local filesystem. |
be708cc0 |
400 | |
401 | E.g. |
402 | |
403 | File::Spec->file_name_is_absolute("a"); # false (relative) |
404 | File::Spec->file_name_is_absolute(":a:b:"); # false (relative) |
405 | File::Spec->file_name_is_absolute("MacintoshHD:"); # true (absolute) |
406 | File::Spec->file_name_is_absolute(""); # true (absolute) |
270d1e39 |
407 | |
3c32ced9 |
408 | |
270d1e39 |
409 | =cut |
410 | |
411 | sub file_name_is_absolute { |
cbc7acb0 |
412 | my ($self,$file) = @_; |
413 | if ($file =~ /:/) { |
be708cc0 |
414 | return (! ($file =~ m/^:/s) ); |
3c32ced9 |
415 | } elsif ( $file eq '' ) { |
416 | return 1 ; |
cbc7acb0 |
417 | } else { |
be708cc0 |
418 | return 0; # i.e. a file like "a" |
270d1e39 |
419 | } |
420 | } |
421 | |
422 | =item path |
423 | |
be708cc0 |
424 | Returns the null list for the MacPerl application, since the concept is |
2586ba89 |
425 | usually meaningless under Mac OS. But if you're using the MacPerl tool under |
be708cc0 |
426 | MPW, it gives back $ENV{Commands} suitably split, as is done in |
270d1e39 |
427 | :lib:ExtUtils:MM_Mac.pm. |
428 | |
429 | =cut |
430 | |
431 | sub path { |
432 | # |
433 | # The concept is meaningless under the MacPerl application. |
434 | # Under MPW, it has a meaning. |
435 | # |
cbc7acb0 |
436 | return unless exists $ENV{Commands}; |
437 | return split(/,/, $ENV{Commands}); |
270d1e39 |
438 | } |
439 | |
0994714a |
440 | =item splitpath |
441 | |
be708cc0 |
442 | ($volume,$directories,$file) = File::Spec->splitpath( $path ); |
443 | ($volume,$directories,$file) = File::Spec->splitpath( $path, $no_file ); |
444 | |
40d020d9 |
445 | Splits a path into volume, directory, and filename portions. |
be708cc0 |
446 | |
447 | On Mac OS, assumes that the last part of the path is a filename unless |
448 | $no_file is true or a trailing separator ":" is present. |
449 | |
450 | The volume portion is always returned with a trailing ":". The directory portion |
451 | is always returned with a leading (to denote a relative path) and a trailing ":" |
452 | (to denote a directory). The file portion is always returned I<without> a leading ":". |
2586ba89 |
453 | Empty portions are returned as empty string ''. |
be708cc0 |
454 | |
2586ba89 |
455 | The results can be passed to C<catpath()> to get back a path equivalent to |
be708cc0 |
456 | (usually identical to) the original path. |
457 | |
458 | |
0994714a |
459 | =cut |
460 | |
461 | sub splitpath { |
462 | my ($self,$path, $nofile) = @_; |
be708cc0 |
463 | my ($volume,$directory,$file); |
0994714a |
464 | |
465 | if ( $nofile ) { |
be708cc0 |
466 | ( $volume, $directory ) = $path =~ m|^((?:[^:]+:)?)(.*)|s; |
0994714a |
467 | } |
468 | else { |
be708cc0 |
469 | $path =~ |
470 | m|^( (?: [^:]+: )? ) |
471 | ( (?: .*: )? ) |
472 | ( .* ) |
473 | |xs; |
0994714a |
474 | $volume = $1; |
475 | $directory = $2; |
476 | $file = $3; |
477 | } |
478 | |
be708cc0 |
479 | $volume = '' unless defined($volume); |
480 | $directory = ":$directory" if ( $volume && $directory ); # take care of "HD::dir" |
481 | if ($directory) { |
482 | # Make sure non-empty directories begin and end in ':' |
483 | $directory .= ':' unless (substr($directory,-1) eq ':'); |
484 | $directory = ":$directory" unless (substr($directory,0,1) eq ':'); |
485 | } else { |
486 | $directory = ''; |
487 | } |
488 | $file = '' unless defined($file); |
489 | |
0994714a |
490 | return ($volume,$directory,$file); |
491 | } |
492 | |
493 | |
494 | =item splitdir |
495 | |
2586ba89 |
496 | The opposite of C<catdir()>. |
be708cc0 |
497 | |
498 | @dirs = File::Spec->splitdir( $directories ); |
499 | |
2586ba89 |
500 | $directories should be only the directory portion of the path on systems |
be708cc0 |
501 | that have the concept of a volume or that have path syntax that differentiates |
2586ba89 |
502 | files from directories. Consider using C<splitpath()> otherwise. |
be708cc0 |
503 | |
504 | Unlike just splitting the directories on the separator, empty directory names |
505 | (C<"">) can be returned. Since C<catdir()> on Mac OS always appends a trailing |
506 | colon to distinguish a directory path from a file path, a single trailing colon |
507 | will be ignored, i.e. there's no empty directory name after it. |
508 | |
509 | Hence, on Mac OS, both |
510 | |
511 | File::Spec->splitdir( ":a:b::c:" ); and |
512 | File::Spec->splitdir( ":a:b::c" ); |
513 | |
514 | yield: |
515 | |
2586ba89 |
516 | ( "a", "b", "::", "c") |
be708cc0 |
517 | |
518 | while |
519 | |
520 | File::Spec->splitdir( ":a:b::c::" ); |
521 | |
522 | yields: |
523 | |
2586ba89 |
524 | ( "a", "b", "::", "c", "::") |
be708cc0 |
525 | |
526 | |
0994714a |
527 | =cut |
528 | |
529 | sub splitdir { |
45657e91 |
530 | my ($self, $path) = @_; |
2586ba89 |
531 | my @result = (); |
532 | my ($head, $sep, $tail, $volume, $directories); |
45657e91 |
533 | |
bf7c0a3d |
534 | return @result if ( (!defined($path)) || ($path eq '') ); |
2586ba89 |
535 | return (':') if ($path eq ':'); |
536 | |
537 | ( $volume, $sep, $directories ) = $path =~ m|^((?:[^:]+:)?)(:*)(.*)|s; |
538 | |
539 | # deprecated, but handle it correctly |
540 | if ($volume) { |
541 | push (@result, $volume); |
542 | $sep .= ':'; |
543 | } |
45657e91 |
544 | |
2586ba89 |
545 | while ($sep || $directories) { |
546 | if (length($sep) > 1) { |
547 | my $updir_count = length($sep) - 1; |
548 | for (my $i=0; $i<$updir_count; $i++) { |
549 | # push '::' updir_count times; |
550 | # simulate Unix '..' updirs |
45657e91 |
551 | push (@result, '::'); |
2586ba89 |
552 | } |
553 | } |
554 | $sep = ''; |
555 | if ($directories) { |
556 | ( $head, $sep, $tail ) = $directories =~ m|^((?:[^:]+)?)(:*)(.*)|s; |
557 | push (@result, $head); |
558 | $directories = $tail; |
559 | } |
45657e91 |
560 | } |
2586ba89 |
561 | return @result; |
0994714a |
562 | } |
563 | |
564 | |
45657e91 |
565 | =item catpath |
0994714a |
566 | |
be708cc0 |
567 | $path = File::Spec->catpath($volume,$directory,$file); |
568 | |
569 | Takes volume, directory and file portions and returns an entire path. On Mac OS, |
570 | $volume, $directory and $file are concatenated. A ':' is inserted if need be. You |
571 | may pass an empty string for each portion. If all portions are empty, the empty |
572 | string is returned. If $volume is empty, the result will be a relative path, |
573 | beginning with a ':'. If $volume and $directory are empty, a leading ":" (if any) |
574 | is removed form $file and the remainder is returned. If $file is empty, the |
575 | resulting path will have a trailing ':'. |
576 | |
577 | |
0994714a |
578 | =cut |
579 | |
580 | sub catpath { |
be708cc0 |
581 | my ($self,$volume,$directory,$file) = @_; |
0994714a |
582 | |
be708cc0 |
583 | if ( (! $volume) && (! $directory) ) { |
584 | $file =~ s/^:// if $file; |
585 | return $file ; |
586 | } |
0994714a |
587 | |
638113eb |
588 | # We look for a volume in $volume, then in $directory, but not both |
589 | |
590 | my ($dir_volume, $dir_dirs) = $self->splitpath($directory, 1); |
591 | |
592 | $volume = $dir_volume unless length $volume; |
be708cc0 |
593 | my $path = $volume; # may be '' |
594 | $path .= ':' unless (substr($path, -1) eq ':'); # ensure trailing ':' |
595 | |
596 | if ($directory) { |
638113eb |
597 | $directory = $dir_dirs if $volume; |
be708cc0 |
598 | $directory =~ s/^://; # remove leading ':' if any |
599 | $path .= $directory; |
600 | $path .= ':' unless (substr($path, -1) eq ':'); # ensure trailing ':' |
0994714a |
601 | } |
602 | |
be708cc0 |
603 | if ($file) { |
604 | $file =~ s/^://; # remove leading ':' if any |
605 | $path .= $file; |
606 | } |
607 | |
608 | return $path; |
0994714a |
609 | } |
610 | |
611 | =item abs2rel |
612 | |
be708cc0 |
613 | Takes a destination path and an optional base path and returns a relative path |
614 | from the base path to the destination path: |
615 | |
616 | $rel_path = File::Spec->abs2rel( $path ) ; |
617 | $rel_path = File::Spec->abs2rel( $path, $base ) ; |
618 | |
619 | Note that both paths are assumed to have a notation that distinguishes a |
620 | directory path (with trailing ':') from a file path (without trailing ':'). |
621 | |
622 | If $base is not present or '', then the current working directory is used. |
623 | If $base is relative, then it is converted to absolute form using C<rel2abs()>. |
624 | This means that it is taken to be relative to the current working directory. |
625 | |
638113eb |
626 | If $path and $base appear to be on two different volumes, we will not |
627 | attempt to resolve the two paths, and we will instead simply return |
628 | $path. Note that previous versions of this module ignored the volume |
629 | of $base, which resulted in garbage results part of the time. |
be708cc0 |
630 | |
631 | If $base doesn't have a trailing colon, the last element of $base is |
638113eb |
632 | assumed to be a filename. This filename is ignored. Otherwise all path |
be708cc0 |
633 | components are assumed to be directories. |
634 | |
635 | If $path is relative, it is converted to absolute form using C<rel2abs()>. |
636 | This means that it is taken to be relative to the current working directory. |
637 | |
638 | Based on code written by Shigio Yamaguchi. |
3c32ced9 |
639 | |
3c32ced9 |
640 | |
0994714a |
641 | =cut |
642 | |
be708cc0 |
643 | # maybe this should be done in canonpath() ? |
644 | sub _resolve_updirs { |
645 | my $path = shift @_; |
646 | my $proceed; |
647 | |
648 | # resolve any updirs, e.g. "HD:tmp::file" -> "HD:file" |
649 | do { |
650 | $proceed = ($path =~ s/^(.*):[^:]+::(.*?)\z/$1:$2/); |
651 | } while ($proceed); |
652 | |
653 | return $path; |
654 | } |
655 | |
656 | |
0994714a |
657 | sub abs2rel { |
658 | my($self,$path,$base) = @_; |
659 | |
660 | # Clean up $path |
661 | if ( ! $self->file_name_is_absolute( $path ) ) { |
662 | $path = $self->rel2abs( $path ) ; |
663 | } |
664 | |
665 | # Figure out the effective $base and clean it up. |
666 | if ( !defined( $base ) || $base eq '' ) { |
0fab864c |
667 | $base = $self->_cwd(); |
0994714a |
668 | } |
669 | elsif ( ! $self->file_name_is_absolute( $base ) ) { |
670 | $base = $self->rel2abs( $base ) ; |
be708cc0 |
671 | $base = _resolve_updirs( $base ); # resolve updirs in $base |
0994714a |
672 | } |
be708cc0 |
673 | else { |
674 | $base = _resolve_updirs( $base ); |
675 | } |
676 | |
638113eb |
677 | # Split up paths - ignore $base's file |
678 | my ( $path_vol, $path_dirs, $path_file ) = $self->splitpath( $path ); |
679 | my ( $base_vol, $base_dirs ) = $self->splitpath( $base ); |
be708cc0 |
680 | |
638113eb |
681 | return $path unless lc( $path_vol ) eq lc( $base_vol ); |
0994714a |
682 | |
683 | # Now, remove all leading components that are the same |
7c90792d |
684 | my @pathchunks = $self->splitdir( $path_dirs ); |
685 | my @basechunks = $self->splitdir( $base_dirs ); |
45657e91 |
686 | |
be708cc0 |
687 | while ( @pathchunks && |
688 | @basechunks && |
689 | lc( $pathchunks[0] ) eq lc( $basechunks[0] ) ) { |
0994714a |
690 | shift @pathchunks ; |
691 | shift @basechunks ; |
692 | } |
45657e91 |
693 | |
be708cc0 |
694 | # @pathchunks now has the directories to descend in to. |
45657e91 |
695 | # ensure relative path, even if @pathchunks is empty |
696 | $path_dirs = $self->catdir( ':', @pathchunks ); |
0994714a |
697 | |
698 | # @basechunks now contains the number of directories to climb out of. |
be708cc0 |
699 | $base_dirs = (':' x @basechunks) . ':' ; |
0994714a |
700 | |
2586ba89 |
701 | return $self->catpath( '', $self->catdir( $base_dirs, $path_dirs ), $path_file ) ; |
0994714a |
702 | } |
703 | |
704 | =item rel2abs |
705 | |
be708cc0 |
706 | Converts a relative path to an absolute path: |
707 | |
708 | $abs_path = File::Spec->rel2abs( $path ) ; |
709 | $abs_path = File::Spec->rel2abs( $path, $base ) ; |
0994714a |
710 | |
be708cc0 |
711 | Note that both paths are assumed to have a notation that distinguishes a |
712 | directory path (with trailing ':') from a file path (without trailing ':'). |
713 | |
714 | If $base is not present or '', then $base is set to the current working |
715 | directory. If $base is relative, then it is converted to absolute form |
716 | using C<rel2abs()>. This means that it is taken to be relative to the |
717 | current working directory. |
718 | |
719 | If $base doesn't have a trailing colon, the last element of $base is |
638113eb |
720 | assumed to be a filename. This filename is ignored. Otherwise all path |
be708cc0 |
721 | components are assumed to be directories. |
722 | |
723 | If $path is already absolute, it is returned and $base is ignored. |
724 | |
725 | Based on code written by Shigio Yamaguchi. |
0994714a |
726 | |
727 | =cut |
728 | |
786b702f |
729 | sub rel2abs { |
be708cc0 |
730 | my ($self,$path,$base) = @_; |
0994714a |
731 | |
be708cc0 |
732 | if ( ! $self->file_name_is_absolute($path) ) { |
733 | # Figure out the effective $base and clean it up. |
0994714a |
734 | if ( !defined( $base ) || $base eq '' ) { |
0fab864c |
735 | $base = $self->_cwd(); |
0994714a |
736 | } |
be708cc0 |
737 | elsif ( ! $self->file_name_is_absolute($base) ) { |
738 | $base = $self->rel2abs($base) ; |
0994714a |
739 | } |
740 | |
be708cc0 |
741 | # Split up paths |
742 | |
743 | # igonore $path's volume |
744 | my ( $path_dirs, $path_file ) = ($self->splitpath($path))[1,2] ; |
745 | |
746 | # ignore $base's file part |
638113eb |
747 | my ( $base_vol, $base_dirs ) = $self->splitpath($base) ; |
be708cc0 |
748 | |
749 | # Glom them together |
750 | $path_dirs = ':' if ($path_dirs eq ''); |
751 | $base_dirs =~ s/:$//; # remove trailing ':', if any |
752 | $base_dirs = $base_dirs . $path_dirs; |
0994714a |
753 | |
be708cc0 |
754 | $path = $self->catpath( $base_vol, $base_dirs, $path_file ); |
755 | } |
756 | return $path; |
0994714a |
757 | } |
758 | |
759 | |
270d1e39 |
760 | =back |
761 | |
be708cc0 |
762 | =head1 AUTHORS |
763 | |
2586ba89 |
764 | See the authors list in I<File::Spec>. Mac OS support by Paul Schinder |
be708cc0 |
765 | <schinder@pobox.com> and Thomas Wegner <wegner_thomas@yahoo.com>. |
766 | |
99f36a73 |
767 | =head1 COPYRIGHT |
768 | |
769 | Copyright (c) 2004 by the Perl 5 Porters. All rights reserved. |
770 | |
771 | This program is free software; you can redistribute it and/or modify |
772 | it under the same terms as Perl itself. |
773 | |
270d1e39 |
774 | =head1 SEE ALSO |
775 | |
72f15715 |
776 | See L<File::Spec> and L<File::Spec::Unix>. This package overrides the |
777 | implementation of these methods, not the semantics. |
270d1e39 |
778 | |
779 | =cut |
780 | |
781 | 1; |