1 package File::Spec::VMS;
4 use vars qw(@ISA $VERSION);
5 require File::Spec::Unix;
9 @ISA = qw(File::Spec::Unix);
16 File::Spec::VMS - methods for VMS file specs
20 require File::Spec::VMS; # Done internally by File::Spec if needed
24 See File::Spec::Unix for a documentation of the methods provided
25 there. This package overrides the implementation of these methods, not
30 =item canonpath (override)
32 Removes redundant portions of file specifications according to VMS syntax.
39 if ($path =~ m|/|) { # Fake Unix
40 my $pathify = $path =~ m|/\Z(?!\n)|;
41 $path = $self->SUPER::canonpath($path);
42 if ($pathify) { return vmspath($path); }
43 else { return vmsify($path); }
46 $path =~ tr/<>/[]/; # < and > ==> [ and ]
47 $path =~ s/\]\[\./\.\]\[/g; # ][. ==> .][
48 $path =~ s/\[000000\.\]\[/\[/g; # [000000.][ ==> [
49 $path =~ s/\[000000\./\[/g; # [000000. ==> [
50 $path =~ s/\.\]\[000000\]/\]/g; # .][000000] ==> ]
51 $path =~ s/\.\]\[/\./g; # foo.][bar ==> foo.bar
52 1 while ($path =~ s/([\[\.])(-+)\.(-+)([\.\]])/$1$2$3$4/);
53 # That loop does the following
54 # with any amount of dashes:
59 1 while ($path =~ s/([\[\.])[^\]\.]+\.-(-+)([\]\.])/$1$2$3/);
60 # That loop does the following
61 # with any amount (minimum 2)
68 # And then, the remaining cases
69 $path =~ s/\[\.-/[-/; # [.- ==> [-
70 $path =~ s/\.[^\]\.]+\.-\./\./g; # .foo.-. ==> .
71 $path =~ s/\[[^\]\.]+\.-\./\[/g; # [foo.-. ==> [
72 $path =~ s/\.[^\]\.]+\.-\]/\]/g; # .foo.-] ==> ]
73 $path =~ s/\[[^\]\.]+\.-\]/\[000000\]/g;# [foo.-] ==> [000000]
74 $path =~ s/\[\]// unless $path eq '[]'; # [] ==>
79 =item catdir (override)
81 Concatenates a list of file specifications, and returns the result as a
82 VMS-syntax directory specification. No check is made for "impossible"
83 cases (e.g. elements other than the first being absolute filespecs).
88 my ($self,@dirs) = @_;
90 @dirs = grep($_,@dirs);
93 my $path = (@dirs == 1 ? $dirs[0] : $self->catdir(@dirs));
94 my ($spath,$sdir) = ($path,$dir);
95 $spath =~ s/\.dir\Z(?!\n)//; $sdir =~ s/\.dir\Z(?!\n)//;
96 $sdir = $self->eliminate_macros($sdir) unless $sdir =~ /^[\w\-]+\Z(?!\n)/s;
97 $rslt = $self->fixpath($self->eliminate_macros($spath)."/$sdir",1);
99 # Special case for VMS absolute directory specs: these will have had device
100 # prepended during trip through Unix syntax in eliminate_macros(), since
101 # Unix syntax has no way to express "absolute from the top of this device's
103 if ($spath =~ /^[\[<][^.\-]/s) { $rslt =~ s/^[^\[<]+//s; }
106 if (not defined $dir or not length $dir) { $rslt = ''; }
107 elsif ($dir =~ /^\$\([^\)]+\)\Z(?!\n)/s) { $rslt = $dir; }
108 else { $rslt = vmspath($dir); }
110 return $self->canonpath($rslt);
113 =item catfile (override)
115 Concatenates a list of file specifications, and returns the result as a
116 VMS-syntax file specification.
121 my ($self,@files) = @_;
122 my $file = $self->canonpath(pop @files);
123 @files = grep($_,@files);
126 my $path = (@files == 1 ? $files[0] : $self->catdir(@files));
128 $spath =~ s/\.dir\Z(?!\n)//;
129 if ($spath =~ /^[^\)\]\/:>]+\)\Z(?!\n)/s && basename($file) eq $file) {
130 $rslt = "$spath$file";
133 $rslt = $self->eliminate_macros($spath);
134 $rslt = vmsify($rslt.($rslt ? '/' : '').unixify($file));
137 else { $rslt = (defined($file) && length($file)) ? vmsify($file) : ''; }
138 return $self->canonpath($rslt);
142 =item curdir (override)
144 Returns a string representation of the current directory: '[]'
152 =item devnull (override)
154 Returns a string representation of the null device: '_NLA0:'
162 =item rootdir (override)
164 Returns a string representation of the root directory: 'SYS$DISK:[000000]'
169 return 'SYS$DISK:[000000]';
172 =item tmpdir (override)
174 Returns a string representation of the first writable directory
175 from the following list or '' if none are writable:
180 Since perl 5.8.0, if running under taint mode, and if $ENV{TMPDIR}
181 is tainted, it is not used.
187 return $tmpdir if defined $tmpdir;
188 $tmpdir = $_[0]->_tmpdir( 'sys$scratch:', $ENV{TMPDIR} );
191 =item updir (override)
193 Returns a string representation of the parent directory: '[-]'
201 =item case_tolerant (override)
203 VMS file specification syntax is case-tolerant.
211 =item path (override)
213 Translate logical name DCL$PATH as a searchlist, rather than trying
214 to C<split> string value of C<$ENV{'PATH'}>.
220 while ($dir = $ENV{'DCL$PATH;' . $i++}) { push(@dirs,$dir); }
224 =item file_name_is_absolute (override)
226 Checks for VMS directory spec as well as Unix separators.
230 sub file_name_is_absolute {
231 my ($self,$file) = @_;
232 # If it's a logical name, expand it.
233 $file = $ENV{$file} while $file =~ /^[\w\$\-]+\Z(?!\n)/s && $ENV{$file};
234 return scalar($file =~ m!^/!s ||
235 $file =~ m![<\[][^.\-\]>]! ||
239 =item splitpath (override)
241 Splits using VMS syntax.
246 my($self,$path) = @_;
247 my($dev,$dir,$file) = ('','','');
249 vmsify($path) =~ /(.+:)?([\[<].*[\]>])?(.*)/s;
250 return ($1 || '',$2 || '',$3);
253 =item splitdir (override)
255 Split dirspec using VMS syntax.
260 my($self,$dirspec) = @_;
261 $dirspec =~ tr/<>/[]/; # < and > ==> [ and ]
262 $dirspec =~ s/\]\[\./\.\]\[/g; # ][. ==> .][
263 $dirspec =~ s/\[000000\.\]\[/\[/g; # [000000.][ ==> [
264 $dirspec =~ s/\[000000\./\[/g; # [000000. ==> [
265 $dirspec =~ s/\.\]\[000000\]/\]/g; # .][000000] ==> ]
266 $dirspec =~ s/\.\]\[/\./g; # foo.][bar ==> foo.bar
267 while ($dirspec =~ s/(^|[\[\<\.])\-(\-+)($|[\]\>\.])/$1-.$2$3/g) {}
268 # That loop does the following
269 # with any amount of dashes:
274 $dirspec = "[$dirspec]" unless $dirspec =~ /[\[<]/; # make legal
275 my(@dirs) = split('\.', vmspath($dirspec));
276 $dirs[0] =~ s/^[\[<]//s; $dirs[-1] =~ s/[\]>]\Z(?!\n)//s;
281 =item catpath (override)
283 Construct a complete filespec using VMS syntax
288 my($self,$dev,$dir,$file) = @_;
290 # We look for a volume in $dev, then in $dir, but not both
291 my ($dir_volume, $dir_dir, $dir_file) = $self->splitpath($dir);
292 $dev = $dir_volume unless length $dev;
293 $dir = length $dir_file ? $self->catfile($dir_dir, $dir_file) : $dir_dir;
295 if ($dev =~ m|^/+([^/]+)|) { $dev = "$1:"; }
296 else { $dev .= ':' unless $dev eq '' or $dev =~ /:\Z(?!\n)/; }
297 if (length($dev) or length($dir)) {
298 $dir = "[$dir]" unless $dir =~ /[\[<\/]/;
299 $dir = vmspath($dir);
304 =item abs2rel (override)
306 Use VMS syntax when converting filespecs.
312 return vmspath(File::Spec::Unix::abs2rel( $self, @_ ))
315 my($path,$base) = @_;
316 $base = $self->_cwd() unless defined $base and length $base;
318 for ($path, $base) { $_ = $self->canonpath($_) }
320 # Are we even starting $path on the same (node::)device as $base? Note that
321 # logical paths or nodename differences may be on the "same device"
322 # but the comparison that ignores device differences so as to concatenate
323 # [---] up directory specs is not even a good idea in cases where there is
324 # a logical path difference between $path and $base nodename and/or device.
325 # Hence we fall back to returning the absolute $path spec
326 # if there is a case blind device (or node) difference of any sort
327 # and we do not even try to call $parse() or consult %ENV for $trnlnm()
328 # (this module needs to run on non VMS platforms after all).
330 my ($path_volume, $path_directories, $path_file) = $self->splitpath($path);
331 my ($base_volume, $base_directories, $base_file) = $self->splitpath($base);
332 return $path unless lc($path_volume) eq lc($base_volume);
334 for ($path, $base) { $_ = $self->rel2abs($_) }
336 # Now, remove all leading components that are the same
337 my @pathchunks = $self->splitdir( $path_directories );
338 my $pathchunks = @pathchunks;
339 unshift(@pathchunks,'000000') unless $pathchunks[0] eq '000000';
340 my @basechunks = $self->splitdir( $base_directories );
341 my $basechunks = @basechunks;
342 unshift(@basechunks,'000000') unless $basechunks[0] eq '000000';
344 while ( @pathchunks &&
346 lc( $pathchunks[0] ) eq lc( $basechunks[0] )
352 # @basechunks now contains the directories to climb out of,
353 # @pathchunks now has the directories to descend in to.
354 if ((@basechunks > 0) || ($basechunks != $pathchunks)) {
355 $path_directories = join '.', ('-' x @basechunks, @pathchunks) ;
358 $path_directories = join '.', @pathchunks;
360 $path_directories = '['.$path_directories.']';
361 return $self->canonpath( $self->catpath( '', $path_directories, $path_file ) ) ;
365 =item rel2abs (override)
367 Use VMS syntax when converting filespecs.
373 my ($path,$base ) = @_;
374 return undef unless defined $path;
375 if ($path =~ m/\//) {
376 $path = ( -d $path || $path =~ m/\/\z/ # educated guessing about
377 ? vmspath($path) # whether it's a directory
380 $base = vmspath($base) if defined $base && $base =~ m/\//;
381 # Clean up and split up $path
382 if ( ! $self->file_name_is_absolute( $path ) ) {
383 # Figure out the effective $base and clean it up.
384 if ( !defined( $base ) || $base eq '' ) {
387 elsif ( ! $self->file_name_is_absolute( $base ) ) {
388 $base = $self->rel2abs( $base ) ;
391 $base = $self->canonpath( $base ) ;
395 my ( $path_directories, $path_file ) =
396 ($self->splitpath( $path ))[1,2] ;
398 my ( $base_volume, $base_directories ) =
399 $self->splitpath( $base ) ;
401 $path_directories = '' if $path_directories eq '[]' ||
402 $path_directories eq '<>';
405 if ( $base_directories =~ m{[^.\]>]\Z(?!\n)} &&
406 $path_directories =~ m{^[^.\[<]}s
408 $base_directories = "$base_directories$sep$path_directories";
409 $base_directories =~ s{\.?[\]>][\[<]\.?}{.};
411 $path = $self->catpath( $base_volume, $base_directories, $path_file );
414 return $self->canonpath( $path ) ;
418 # eliminate_macros() and fixpath() are MakeMaker-specific methods
419 # which are used inside catfile() and catdir(). MakeMaker has its own
420 # copies as of 6.06_03 which are the canonical ones. We leave these
421 # here, in peace, so that File::Spec continues to work with MakeMakers
424 # Please consider these two methods deprecated. Do not patch them,
425 # patch the ones in ExtUtils::MM_VMS instead.
426 sub eliminate_macros {
427 my($self,$path) = @_;
428 return '' unless $path;
429 $self = {} unless ref $self;
432 return join ' ', map { $self->eliminate_macros($_) } split /\s+/, $path;
435 my($npath) = unixify($path);
437 my($head,$macro,$tail);
439 # perform m##g in scalar context so it acts as an iterator
440 while ($npath =~ m#(.*?)\$\((\S+?)\)(.*)#gs) {
442 ($head,$macro,$tail) = ($1,$2,$3);
443 if (ref $self->{$macro}) {
444 if (ref $self->{$macro} eq 'ARRAY') {
445 $macro = join ' ', @{$self->{$macro}};
448 print "Note: can't expand macro \$($macro) containing ",ref($self->{$macro}),
449 "\n\t(using MMK-specific deferred substitutuon; MMS will break)\n";
450 $macro = "\cB$macro\cB";
454 else { ($macro = unixify($self->{$macro})) =~ s#/\Z(?!\n)##; }
455 $npath = "$head$macro$tail";
458 if ($complex) { $npath =~ s#\cB(.*?)\cB#\${$1}#gs; }
462 # Deprecated. See the note above for eliminate_macros().
464 my($self,$path,$force_path) = @_;
465 return '' unless $path;
466 $self = bless {} unless ref $self;
467 my($fixedpath,$prefix,$name);
471 map { $self->fixpath($_,$force_path) }
475 if ($path =~ m#^\$\([^\)]+\)\Z(?!\n)#s || $path =~ m#[/:>\]]#) {
476 if ($force_path or $path =~ /(?:DIR\)|\])\Z(?!\n)/) {
477 $fixedpath = vmspath($self->eliminate_macros($path));
480 $fixedpath = vmsify($self->eliminate_macros($path));
483 elsif ((($prefix,$name) = ($path =~ m#^\$\(([^\)]+)\)(.+)#s)) && $self->{$prefix}) {
484 my($vmspre) = $self->eliminate_macros("\$($prefix)");
485 # is it a dir or just a name?
486 $vmspre = ($vmspre =~ m|/| or $prefix =~ /DIR\Z(?!\n)/) ? vmspath($vmspre) : '';
487 $fixedpath = ($vmspre ? $vmspre : $self->{$prefix}) . $name;
488 $fixedpath = vmspath($fixedpath) if $force_path;
492 $fixedpath = vmspath($fixedpath) if $force_path;
494 # No hints, so we try to guess
495 if (!defined($force_path) and $fixedpath !~ /[:>(.\]]/) {
496 $fixedpath = vmspath($fixedpath) if -d $fixedpath;
499 # Trim off root dirname if it's had other dirs inserted in front of it.
500 $fixedpath =~ s/\.000000([\]>])/$1/;
501 # Special case for VMS absolute directory specs: these will have had device
502 # prepended during trip through Unix syntax in eliminate_macros(), since
503 # Unix syntax has no way to express "absolute from the top of this device's
505 if ($path =~ /^[\[>][^.\-]/) { $fixedpath =~ s/^[^\[<]+//; }
514 Copyright (c) 2004 by the Perl 5 Porters. All rights reserved.
516 This program is free software; you can redistribute it and/or modify
517 it under the same terms as Perl itself.
521 See L<File::Spec> and L<File::Spec::Unix>. This package overrides the
522 implementation of these methods, not the semantics.
524 An explanation of VMS file specs can be found at
525 L<"http://h71000.www7.hp.com/doc/731FINAL/4506/4506pro_014.html#apps_locating_naming_files">.