1 package File::Spec::Mac;
4 use vars qw(@ISA $VERSION);
5 require File::Spec::Unix;
8 $VERSION = eval $VERSION;
10 @ISA = qw(File::Spec::Unix);
14 $macfiles = eval { require Mac::Files };
17 sub case_tolerant { 1 }
22 File::Spec::Mac - File::Spec for Mac OS (Classic)
26 require File::Spec::Mac; # Done internally by File::Spec if needed
30 Methods for manipulating file specifications.
38 On Mac OS, there's nothing to be done. Returns what it's given.
43 my ($self,$path) = @_;
49 Concatenate two or more directory names to form a path separated by colons
50 (":") ending with a directory. Resulting paths are B<relative> by default,
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
56 B<IMPORTANT NOTE:> Beginning with version 1.3 of this module, the resulting
57 path is relative by default and I<not> absolute. This decision was made due
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
60 OS. Note that this may break some existing scripts.
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 ":").
72 catdir("a","b") = ":a:b:"
73 catdir() = "" (special case)
75 calls like the following
78 catdir(":a","b") = ":a:b:"
79 catdir(":a:","b") = ":a:b:"
80 catdir(":a:",":b:") = ":a:b:"
85 Here are the rules that are used in C<catdir()>; note that we try to be as
86 compatible as possible to Unix:
92 The resulting path is relative by default, i.e. the resulting path will have a
97 A trailing colon is added automatically to the resulting path, to denote a
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"),
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.
114 catdir(":::a","::b","c") = ":::a::b:c:"
115 catdir(":::a::","::b","c") = ":::a:::b:c:"
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.
127 catdir("a",":",":","b") = ":a:b:"
128 catdir("a",":","::",":b") = ":a::b:"
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>.
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.
140 catdir("","a","b") is the same as
142 catdir(rootdir(),"a","b").
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.
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:
157 Unix->catdir("","") = "/"
158 Unix->catdir("",".") = "/"
159 Unix->catdir("","..") = "/" # can't go beyond root
160 Unix->catdir("",".","..","..","a") = "/a"
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:")
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.
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
186 $dir = File::Spec->catdir("tmp","sources");
187 $abs_path = File::Spec->catpath("MacintoshHD:", $dir,"");
191 "MacintoshHD:tmp:sources:" .
202 # take care of the first argument
204 if ($args[0] eq '') { # absolute path, rootdir
207 $first_arg = $self->rootdir;
209 } elsif ($args[0] =~ /^[^:]+:/) { # absolute path, volume name
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)/);
215 } else { # relative path
217 if ( $args[0] =~ /^::+\Z(?!\n)/ ) {
218 # updir colon path ('::', ':::' etc.), don't shift
220 } elsif ($args[0] eq ':') {
221 $first_arg = shift @args;
223 # add a trailing ':' if need be
224 $first_arg = shift @args;
225 $first_arg = "$first_arg:" unless ($first_arg =~ /:\Z(?!\n)/);
229 # For all other arguments,
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
236 my $result = $first_arg;
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
244 $updir_count += (length($arg) - 1);
246 $arg = (':' x $updir_count);
248 $arg =~ s/^://s; # remove a leading ':' if any
249 $arg = "$arg:" unless ($arg =~ /:\Z(?!\n)/); # ensure trailing ':'
255 if ( ($relative) && ($result !~ /^:/) ) {
256 # add a leading colon if need be
257 $result = ":$result";
261 # remove updirs immediately following the volume name
262 $result =~ s/([^:]+:)(:*)(.*)\Z(?!\n)/$1$3/;
270 Concatenate one or more directory names and a filename to form a
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).
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
276 decision was made due to portability reasons. Since
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.
279 Note that this may break some existing scripts.
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
284 absolute paths is true:
287 catfile("file") = "file"
291 catfile("","") = rootdir() # (e.g. "HD:")
292 catfile("","file") = rootdir() . file # (e.g. "HD:file")
293 catfile("HD:","file") = "HD:file"
295 This means that C<catdir()> is called only when there are two or more
296 arguments, as one might expect.
298 Note that the leading ":" is removed from the filename, so that
300 catfile("a","b","file") = ":a:b:file" and
302 catfile("a","b",":file") = ":a:b:file"
304 give the same answer.
306 To concatenate I<volume names>, I<directory paths> and I<filenames>,
307 you are encouraged to use C<catpath()> (see below).
315 return $file unless @_;
316 my $dir = $self->catdir(@_);
323 Returns a string representing the current directory. On Mac OS, this is ":".
333 Returns a string representing the null device. On Mac OS, this is "Dev:Null".
343 Returns a string representing the root directory. Under MacPerl,
344 returns the name of the startup volume, since that's the closest in
345 concept, although other volumes aren't rooted there. The name has a
346 trailing ":", because that's the correct specification for a volume
349 If Mac::Files could not be loaded, the empty string is returned.
355 # There's no real root directory on Mac OS. The name of the startup
356 # volume is returned, since that's the closest in concept.
358 return '' unless $macfiles;
359 my $system = Mac::Files::FindFolder(&Mac::Files::kOnSystemDisk,
360 &Mac::Files::kSystemFolderType);
361 $system =~ s/:.*\Z(?!\n)/:/s;
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.
376 return $tmpdir if defined $tmpdir;
377 $tmpdir = $_[0]->_tmpdir( $ENV{TMPDIR} );
382 Returns a string representing the parent directory. On Mac OS, this is "::".
390 =item file_name_is_absolute
392 Takes as argument a path and returns true, if it is an absolute path.
393 If the path has a leading ":", it's a relative path. Otherwise, it's an
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,
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.
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)
411 sub file_name_is_absolute {
412 my ($self,$file) = @_;
414 return (! ($file =~ m/^:/s) );
415 } elsif ( $file eq '' ) {
418 return 0; # i.e. a file like "a"
424 Returns the null list for the MacPerl application, since the concept is
425 usually meaningless under Mac OS. But if you're using the MacPerl tool under
426 MPW, it gives back $ENV{Commands} suitably split, as is done in
427 :lib:ExtUtils:MM_Mac.pm.
433 # The concept is meaningless under the MacPerl application.
434 # Under MPW, it has a meaning.
436 return unless exists $ENV{Commands};
437 return split(/,/, $ENV{Commands});
442 ($volume,$directories,$file) = File::Spec->splitpath( $path );
443 ($volume,$directories,$file) = File::Spec->splitpath( $path, $no_file );
445 Splits a path into volume, directory, and filename portions.
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.
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 ":".
453 Empty portions are returned as empty string ''.
455 The results can be passed to C<catpath()> to get back a path equivalent to
456 (usually identical to) the original path.
462 my ($self,$path, $nofile) = @_;
463 my ($volume,$directory,$file);
466 ( $volume, $directory ) = $path =~ m|^((?:[^:]+:)?)(.*)|s;
479 $volume = '' unless defined($volume);
480 $directory = ":$directory" if ( $volume && $directory ); # take care of "HD::dir"
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 ':');
488 $file = '' unless defined($file);
490 return ($volume,$directory,$file);
496 The opposite of C<catdir()>.
498 @dirs = File::Spec->splitdir( $directories );
500 $directories should be only the directory portion of the path on systems
501 that have the concept of a volume or that have path syntax that differentiates
502 files from directories. Consider using C<splitpath()> otherwise.
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.
509 Hence, on Mac OS, both
511 File::Spec->splitdir( ":a:b::c:" ); and
512 File::Spec->splitdir( ":a:b::c" );
516 ( "a", "b", "::", "c")
520 File::Spec->splitdir( ":a:b::c::" );
524 ( "a", "b", "::", "c", "::")
530 my ($self, $path) = @_;
532 my ($head, $sep, $tail, $volume, $directories);
534 return @result if ( (!defined($path)) || ($path eq '') );
535 return (':') if ($path eq ':');
537 ( $volume, $sep, $directories ) = $path =~ m|^((?:[^:]+:)?)(:*)(.*)|s;
539 # deprecated, but handle it correctly
541 push (@result, $volume);
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
551 push (@result, '::');
556 ( $head, $sep, $tail ) = $directories =~ m|^((?:[^:]+)?)(:*)(.*)|s;
557 push (@result, $head);
558 $directories = $tail;
567 $path = File::Spec->catpath($volume,$directory,$file);
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 ':'.
581 my ($self,$volume,$directory,$file) = @_;
583 if ( (! $volume) && (! $directory) ) {
584 $file =~ s/^:// if $file;
588 # We look for a volume in $volume, then in $directory, but not both
590 my ($dir_volume, $dir_dirs) = $self->splitpath($directory, 1);
592 $volume = $dir_volume unless length $volume;
593 my $path = $volume; # may be ''
594 $path .= ':' unless (substr($path, -1) eq ':'); # ensure trailing ':'
597 $directory = $dir_dirs if $volume;
598 $directory =~ s/^://; # remove leading ':' if any
600 $path .= ':' unless (substr($path, -1) eq ':'); # ensure trailing ':'
604 $file =~ s/^://; # remove leading ':' if any
613 Takes a destination path and an optional base path and returns a relative path
614 from the base path to the destination path:
616 $rel_path = File::Spec->abs2rel( $path ) ;
617 $rel_path = File::Spec->abs2rel( $path, $base ) ;
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 ':').
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.
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.
631 If $base doesn't have a trailing colon, the last element of $base is
632 assumed to be a filename. This filename is ignored. Otherwise all path
633 components are assumed to be directories.
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.
638 Based on code written by Shigio Yamaguchi.
643 # maybe this should be done in canonpath() ?
644 sub _resolve_updirs {
648 # resolve any updirs, e.g. "HD:tmp::file" -> "HD:file"
650 $proceed = ($path =~ s/^(.*):[^:]+::(.*?)\z/$1:$2/);
658 my($self,$path,$base) = @_;
661 if ( ! $self->file_name_is_absolute( $path ) ) {
662 $path = $self->rel2abs( $path ) ;
665 # Figure out the effective $base and clean it up.
666 if ( !defined( $base ) || $base eq '' ) {
667 $base = $self->_cwd();
669 elsif ( ! $self->file_name_is_absolute( $base ) ) {
670 $base = $self->rel2abs( $base ) ;
671 $base = _resolve_updirs( $base ); # resolve updirs in $base
674 $base = _resolve_updirs( $base );
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 );
681 return $path unless lc( $path_vol ) eq lc( $base_vol );
683 # Now, remove all leading components that are the same
684 my @pathchunks = $self->splitdir( $path_dirs );
685 my @basechunks = $self->splitdir( $base_dirs );
687 while ( @pathchunks &&
689 lc( $pathchunks[0] ) eq lc( $basechunks[0] ) ) {
694 # @pathchunks now has the directories to descend in to.
695 # ensure relative path, even if @pathchunks is empty
696 $path_dirs = $self->catdir( ':', @pathchunks );
698 # @basechunks now contains the number of directories to climb out of.
699 $base_dirs = (':' x @basechunks) . ':' ;
701 return $self->catpath( '', $self->catdir( $base_dirs, $path_dirs ), $path_file ) ;
706 Converts a relative path to an absolute path:
708 $abs_path = File::Spec->rel2abs( $path ) ;
709 $abs_path = File::Spec->rel2abs( $path, $base ) ;
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 ':').
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.
719 If $base doesn't have a trailing colon, the last element of $base is
720 assumed to be a filename. This filename is ignored. Otherwise all path
721 components are assumed to be directories.
723 If $path is already absolute, it is returned and $base is ignored.
725 Based on code written by Shigio Yamaguchi.
730 my ($self,$path,$base) = @_;
732 if ( ! $self->file_name_is_absolute($path) ) {
733 # Figure out the effective $base and clean it up.
734 if ( !defined( $base ) || $base eq '' ) {
735 $base = $self->_cwd();
737 elsif ( ! $self->file_name_is_absolute($base) ) {
738 $base = $self->rel2abs($base) ;
743 # igonore $path's volume
744 my ( $path_dirs, $path_file ) = ($self->splitpath($path))[1,2] ;
746 # ignore $base's file part
747 my ( $base_vol, $base_dirs ) = $self->splitpath($base) ;
750 $path_dirs = ':' if ($path_dirs eq '');
751 $base_dirs =~ s/:$//; # remove trailing ':', if any
752 $base_dirs = $base_dirs . $path_dirs;
754 $path = $self->catpath( $base_vol, $base_dirs, $path_file );
764 See the authors list in I<File::Spec>. Mac OS support by Paul Schinder
765 <schinder@pobox.com> and Thomas Wegner <wegner_thomas@yahoo.com>.
769 Copyright (c) 2004 by the Perl 5 Porters. All rights reserved.
771 This program is free software; you can redistribute it and/or modify
772 it under the same terms as Perl itself.
776 See L<File::Spec> and L<File::Spec::Unix>. This package overrides the
777 implementation of these methods, not the semantics.