1 package File::Spec::VMS;
4 use vars qw(@ISA $VERSION);
5 require File::Spec::Unix;
9 @ISA = qw(File::Spec::Unix);
17 File::Spec::VMS - methods for VMS file specs
21 require File::Spec::VMS; # Done internally by File::Spec if needed
25 See File::Spec::Unix for a documentation of the methods provided
26 there. This package overrides the implementation of these methods, not
31 =item eliminate_macros
33 Expands MM[KS]/Make macros in a text string, using the contents of
34 identically named elements of C<%$self>, and returns the result
35 as a file specification in Unix syntax.
39 sub eliminate_macros {
41 return '' unless $path;
42 $self = {} unless ref $self;
45 return join ' ', map { $self->eliminate_macros($_) } split /\s+/, $path;
48 my($npath) = unixify($path);
50 my($head,$macro,$tail);
52 # perform m##g in scalar context so it acts as an iterator
53 while ($npath =~ m#(.*?)\$\((\S+?)\)(.*)#gs) {
55 ($head,$macro,$tail) = ($1,$2,$3);
56 if (ref $self->{$macro}) {
57 if (ref $self->{$macro} eq 'ARRAY') {
58 $macro = join ' ', @{$self->{$macro}};
61 print "Note: can't expand macro \$($macro) containing ",ref($self->{$macro}),
62 "\n\t(using MMK-specific deferred substitutuon; MMS will break)\n";
63 $macro = "\cB$macro\cB";
67 else { ($macro = unixify($self->{$macro})) =~ s#/\Z(?!\n)##; }
68 $npath = "$head$macro$tail";
71 if ($complex) { $npath =~ s#\cB(.*?)\cB#\${$1}#gs; }
77 Catchall routine to clean up problem MM[SK]/Make macros. Expands macros
78 in any directory specification, in order to avoid juxtaposing two
79 VMS-syntax directories when MM[SK] is run. Also expands expressions which
80 are all macro, so that we can tell how long the expansion is, and avoid
81 overrunning DCL's command buffer when MM[KS] is running.
83 If optional second argument has a TRUE value, then the return string is
84 a VMS-syntax directory specification, if it is FALSE, the return string
85 is a VMS-syntax file specification, and if it is not specified, fixpath()
86 checks to see whether it matches the name of a directory in the current
87 default directory, and returns a directory or file specification accordingly.
92 my($self,$path,$force_path) = @_;
93 return '' unless $path;
94 $self = bless {} unless ref $self;
95 my($fixedpath,$prefix,$name);
99 map { $self->fixpath($_,$force_path) }
103 if ($path =~ m#^\$\([^\)]+\)\Z(?!\n)#s || $path =~ m#[/:>\]]#) {
104 if ($force_path or $path =~ /(?:DIR\)|\])\Z(?!\n)/) {
105 $fixedpath = vmspath($self->eliminate_macros($path));
108 $fixedpath = vmsify($self->eliminate_macros($path));
111 elsif ((($prefix,$name) = ($path =~ m#^\$\(([^\)]+)\)(.+)#s)) && $self->{$prefix}) {
112 my($vmspre) = $self->eliminate_macros("\$($prefix)");
113 # is it a dir or just a name?
114 $vmspre = ($vmspre =~ m|/| or $prefix =~ /DIR\Z(?!\n)/) ? vmspath($vmspre) : '';
115 $fixedpath = ($vmspre ? $vmspre : $self->{$prefix}) . $name;
116 $fixedpath = vmspath($fixedpath) if $force_path;
120 $fixedpath = vmspath($fixedpath) if $force_path;
122 # No hints, so we try to guess
123 if (!defined($force_path) and $fixedpath !~ /[:>(.\]]/) {
124 $fixedpath = vmspath($fixedpath) if -d $fixedpath;
127 # Trim off root dirname if it's had other dirs inserted in front of it.
128 $fixedpath =~ s/\.000000([\]>])/$1/;
129 # Special case for VMS absolute directory specs: these will have had device
130 # prepended during trip through Unix syntax in eliminate_macros(), since
131 # Unix syntax has no way to express "absolute from the top of this device's
133 if ($path =~ /^[\[>][^.\-]/) { $fixedpath =~ s/^[^\[<]+//; }
139 =head2 Methods always loaded
143 =item canonpath (override)
145 Removes redundant portions of file specifications according to VMS syntax.
150 my($self,$path) = @_;
152 if ($path =~ m|/|) { # Fake Unix
153 my $pathify = $path =~ m|/\Z(?!\n)|;
154 $path = $self->SUPER::canonpath($path);
155 if ($pathify) { return vmspath($path); }
156 else { return vmsify($path); }
159 $path =~ s/([\[<])000000\./$1/g; # [000000.foo ==> [foo
160 $path =~ s/([^-]+)\.(\]\[|><)?000000([\]\>])/$1$3/g; # foo.000000] ==> foo]
161 $path =~ s-\]\[--g; $path =~ s/><//g; # foo.][bar ==> foo.bar
162 1 while $path =~ s{([\[<-])\.-}{$1-}; # [.-.- ==> [--
163 $path =~ s/\.[^\[<\.]+\.-([\]\>])/$1/; # bar.foo.-] ==> bar]
164 $path =~ s/([\[<])(-+)/$1 . "\cx" x length($2)/e; # encode leading '-'s
165 $path =~ s/([\[<\.])([^\[<\.\cx]+)\.-\.?/$1/g; # bar.-.foo ==> foo
166 $path =~ s/([\[<])(\cx+)/$1 . '-' x length($2)/e; # then decode
173 Concatenates a list of file specifications, and returns the result as a
174 VMS-syntax directory specification. No check is made for "impossible"
175 cases (e.g. elements other than the first being absolute filespecs).
180 my ($self,@dirs) = @_;
182 @dirs = grep($_,@dirs);
185 my $path = (@dirs == 1 ? $dirs[0] : $self->catdir(@dirs));
186 my ($spath,$sdir) = ($path,$dir);
187 $spath =~ s/\.dir\Z(?!\n)//; $sdir =~ s/\.dir\Z(?!\n)//;
188 $sdir = $self->eliminate_macros($sdir) unless $sdir =~ /^[\w\-]+\Z(?!\n)/s;
189 $rslt = $self->fixpath($self->eliminate_macros($spath)."/$sdir",1);
191 # Special case for VMS absolute directory specs: these will have had device
192 # prepended during trip through Unix syntax in eliminate_macros(), since
193 # Unix syntax has no way to express "absolute from the top of this device's
195 if ($spath =~ /^[\[<][^.\-]/s) { $rslt =~ s/^[^\[<]+//s; }
198 if (not defined $dir or not length $dir) { $rslt = ''; }
199 elsif ($dir =~ /^\$\([^\)]+\)\Z(?!\n)/s) { $rslt = $dir; }
200 else { $rslt = vmspath($dir); }
202 return $self->canonpath($rslt);
207 Concatenates a list of file specifications, and returns the result as a
208 VMS-syntax file specification.
213 my ($self,@files) = @_;
214 my $file = pop @files;
215 @files = grep($_,@files);
218 my $path = (@files == 1 ? $files[0] : $self->catdir(@files));
220 $spath =~ s/\.dir\Z(?!\n)//;
221 if ($spath =~ /^[^\)\]\/:>]+\)\Z(?!\n)/s && basename($file) eq $file) {
222 $rslt = "$spath$file";
225 $rslt = $self->eliminate_macros($spath);
226 $rslt = vmsify($rslt.($rslt ? '/' : '').unixify($file));
229 else { $rslt = (defined($file) && length($file)) ? vmsify($file) : ''; }
230 return $self->canonpath($rslt);
234 =item curdir (override)
236 Returns a string representation of the current directory: '[]'
244 =item devnull (override)
246 Returns a string representation of the null device: '_NLA0:'
254 =item rootdir (override)
256 Returns a string representation of the root directory: 'SYS$DISK:[000000]'
261 return 'SYS$DISK:[000000]';
264 =item tmpdir (override)
266 Returns a string representation of the first writable directory
267 from the following list or '' if none are writable:
272 Since perl 5.8.0, if running under taint mode, and if $ENV{TMPDIR}
273 is tainted, it is not used.
279 return $tmpdir if defined $tmpdir;
280 my @dirlist = ('sys$scratch:', $ENV{TMPDIR});
283 if (${"\cTAINT"}) { # Check for taint mode on perl >= 5.8.0
284 require Scalar::Util;
285 pop @dirlist if Scalar::Util::tainted($ENV{TMPDIR});
289 next unless defined && -d && -w _;
293 $tmpdir = '' unless defined $tmpdir;
297 =item updir (override)
299 Returns a string representation of the parent directory: '[-]'
307 =item case_tolerant (override)
309 VMS file specification syntax is case-tolerant.
317 =item path (override)
319 Translate logical name DCL$PATH as a searchlist, rather than trying
320 to C<split> string value of C<$ENV{'PATH'}>.
326 while ($dir = $ENV{'DCL$PATH;' . $i++}) { push(@dirs,$dir); }
330 =item file_name_is_absolute (override)
332 Checks for VMS directory spec as well as Unix separators.
336 sub file_name_is_absolute {
337 my ($self,$file) = @_;
338 # If it's a logical name, expand it.
339 $file = $ENV{$file} while $file =~ /^[\w\$\-]+\Z(?!\n)/s && $ENV{$file};
340 return scalar($file =~ m!^/!s ||
341 $file =~ m![<\[][^.\-\]>]! ||
345 =item splitpath (override)
347 Splits using VMS syntax.
352 my($self,$path) = @_;
353 my($dev,$dir,$file) = ('','','');
355 vmsify($path) =~ /(.+:)?([\[<].*[\]>])?(.*)/s;
356 return ($1 || '',$2 || '',$3);
359 =item splitdir (override)
361 Split dirspec using VMS syntax.
366 my($self,$dirspec) = @_;
367 $dirspec =~ s/\]\[//g; $dirspec =~ s/\-\-/-.-/g;
368 $dirspec = "[$dirspec]" unless $dirspec =~ /[\[<]/; # make legal
369 my(@dirs) = split('\.', vmspath($dirspec));
370 $dirs[0] =~ s/^[\[<]//s; $dirs[-1] =~ s/[\]>]\Z(?!\n)//s;
375 =item catpath (override)
377 Construct a complete filespec using VMS syntax
382 my($self,$dev,$dir,$file) = @_;
383 if ($dev =~ m|^/+([^/]+)|) { $dev = "$1:"; }
384 else { $dev .= ':' unless $dev eq '' or $dev =~ /:\Z(?!\n)/; }
385 if (length($dev) or length($dir)) {
386 $dir = "[$dir]" unless $dir =~ /[\[<\/]/;
387 $dir = vmspath($dir);
392 =item abs2rel (override)
394 Use VMS syntax when converting filespecs.
401 return vmspath(File::Spec::Unix::abs2rel( $self, @_ ))
402 if ( join( '', @_ ) =~ m{/} ) ;
404 my($path,$base) = @_;
406 # Note: we use '/' to glue things together here, then let canonpath()
407 # clean them up at the end.
410 if ( ! $self->file_name_is_absolute( $path ) ) {
411 $path = $self->rel2abs( $path ) ;
414 $path = $self->canonpath( $path ) ;
417 # Figure out the effective $base and clean it up.
418 if ( !defined( $base ) || $base eq '' ) {
420 $base = $self->canonpath( $base ) ;
422 elsif ( ! $self->file_name_is_absolute( $base ) ) {
423 $base = $self->rel2abs( $base ) ;
426 $base = $self->canonpath( $base ) ;
430 my ( $path_directories, $path_file ) =
431 ($self->splitpath( $path, 1 ))[1,2] ;
433 $path_directories = $1
434 if $path_directories =~ /^\[(.*)\]\Z(?!\n)/s ;
436 my $base_directories = ($self->splitpath( $base, 1 ))[1] ;
438 $base_directories = $1
439 if $base_directories =~ /^\[(.*)\]\Z(?!\n)/s ;
441 # Now, remove all leading components that are the same
442 my @pathchunks = $self->splitdir( $path_directories );
443 unshift(@pathchunks,'000000') unless $pathchunks[0] eq '000000';
444 my @basechunks = $self->splitdir( $base_directories );
445 unshift(@basechunks,'000000') unless $basechunks[0] eq '000000';
447 while ( @pathchunks &&
449 lc( $pathchunks[0] ) eq lc( $basechunks[0] )
455 # @basechunks now contains the directories to climb out of,
456 # @pathchunks now has the directories to descend in to.
457 $path_directories = '-.' x @basechunks . join( '.', @pathchunks ) ;
458 $path_directories =~ s{\.\Z(?!\n)}{} ;
459 return $self->canonpath( $self->catpath( '', $path_directories, $path_file ) ) ;
463 =item rel2abs (override)
465 Use VMS syntax when converting filespecs.
471 return vmspath(File::Spec::Unix::rel2abs( $self, @_ ))
472 if ( join( '', @_ ) =~ m{/} ) ;
474 my ($path,$base ) = @_;
475 # Clean up and split up $path
476 if ( ! $self->file_name_is_absolute( $path ) ) {
477 # Figure out the effective $base and clean it up.
478 if ( !defined( $base ) || $base eq '' ) {
481 elsif ( ! $self->file_name_is_absolute( $base ) ) {
482 $base = $self->rel2abs( $base ) ;
485 $base = $self->canonpath( $base ) ;
489 my ( $path_directories, $path_file ) =
490 ($self->splitpath( $path ))[1,2] ;
492 my ( $base_volume, $base_directories ) =
493 $self->splitpath( $base ) ;
495 $path_directories = '' if $path_directories eq '[]' ||
496 $path_directories eq '<>';
499 if ( $base_directories =~ m{[^.\]>]\Z(?!\n)} &&
500 $path_directories =~ m{^[^.\[<]}s
502 $base_directories = "$base_directories$sep$path_directories";
503 $base_directories =~ s{\.?[\]>][\[<]\.?}{.};
505 $path = $self->catpath( $base_volume, $base_directories, $path_file );
508 return $self->canonpath( $path ) ;