[p5sagit/p5-mst-13.2.git] / lib / File / Spec / VMS.pm

package File::Spec::VMS;

use strict;
use vars qw(@ISA $VERSION);
require File::Spec::Unix;

$VERSION = '1.4';

@ISA = qw(File::Spec::Unix);

use File::Basename;
use VMS::Filespec;

=head1 NAME

File::Spec::VMS - methods for VMS file specs

=head1 SYNOPSIS

 require File::Spec::VMS; # Done internally by File::Spec if needed

=head1 DESCRIPTION

See File::Spec::Unix for a documentation of the methods provided
there. This package overrides the implementation of these methods, not
the semantics.

=over 4

=item canonpath (override)

Removes redundant portions of file specifications according to VMS syntax.

=cut

sub canonpath {
    my($self,$path) = @_;

    if ($path =~ m|/|) { # Fake Unix
      my $pathify = $path =~ m|/\Z(?!\n)|;
      $path = $self->SUPER::canonpath($path);
      if ($pathify) { return vmspath($path); }
      else          { return vmsify($path);  }
    }
    else {
	$path =~ tr/<>/[]/;			# < and >       ==> [ and ]
	$path =~ s/\]\[\./\.\]\[/g;		# ][.		==> .][
	$path =~ s/\[000000\.\]\[/\[/g;		# [000000.][	==> [
	$path =~ s/\[000000\./\[/g;		# [000000.	==> [
	$path =~ s/\.\]\[000000\]/\]/g;		# .][000000]	==> ]
	$path =~ s/\.\]\[/\./g;			# foo.][bar     ==> foo.bar
	1 while ($path =~ s/([\[\.])(-+)\.(-+)([\.\]])/$1$2$3$4/);
						# That loop does the following
						# with any amount of dashes:
						# .-.-.		==> .--.
						# [-.-.		==> [--.
						# .-.-]		==> .--]
						# [-.-]		==> [--]
	1 while ($path =~ s/([\[\.])[^\]\.]+\.-(-+)([\]\.])/$1$2$3/);
						# That loop does the following
						# with any amount (minimum 2)
						# of dashes:
						# .foo.--.	==> .-.
						# .foo.--]	==> .-]
						# [foo.--.	==> [-.
						# [foo.--]	==> [-]
						#
						# And then, the remaining cases
	$path =~ s/\[\.-/[-/;			# [.-		==> [-
	$path =~ s/\.[^\]\.]+\.-\./\./g;	# .foo.-.	==> .
	$path =~ s/\[[^\]\.]+\.-\./\[/g;	# [foo.-.	==> [
	$path =~ s/\.[^\]\.]+\.-\]/\]/g;	# .foo.-]	==> ]
	$path =~ s/\[[^\]\.]+\.-\]/\[000000\]/g;# [foo.-]       ==> [000000]
	$path =~ s/\[\]//;			# []		==>
	return $path;
    }
}

=item catdir (override)

Concatenates a list of file specifications, and returns the result as a
VMS-syntax directory specification.  No check is made for "impossible"
cases (e.g. elements other than the first being absolute filespecs).

=cut

sub catdir {
    my ($self,@dirs) = @_;
    my $dir = pop @dirs;
    @dirs = grep($_,@dirs);
    my $rslt;
    if (@dirs) {
	my $path = (@dirs == 1 ? $dirs[0] : $self->catdir(@dirs));
	my ($spath,$sdir) = ($path,$dir);
	$spath =~ s/\.dir\Z(?!\n)//; $sdir =~ s/\.dir\Z(?!\n)//; 
	$sdir = $self->eliminate_macros($sdir) unless $sdir =~ /^[\w\-]+\Z(?!\n)/s;
	$rslt = $self->fixpath($self->eliminate_macros($spath)."/$sdir",1);

	# Special case for VMS absolute directory specs: these will have had device
	# prepended during trip through Unix syntax in eliminate_macros(), since
	# Unix syntax has no way to express "absolute from the top of this device's
	# directory tree".
	if ($spath =~ /^[\[<][^.\-]/s) { $rslt =~ s/^[^\[<]+//s; }
    }
    else {
	if    (not defined $dir or not length $dir) { $rslt = ''; }
	elsif ($dir =~ /^\$\([^\)]+\)\Z(?!\n)/s)          { $rslt = $dir; }
	else                                        { $rslt = vmspath($dir); }
    }
    return $self->canonpath($rslt);
}

=item catfile (override)

Concatenates a list of file specifications, and returns the result as a
VMS-syntax file specification.

=cut

sub catfile {
    my ($self,@files) = @_;
    my $file = $self->canonpath(pop @files);
    @files = grep($_,@files);
    my $rslt;
    if (@files) {
	my $path = (@files == 1 ? $files[0] : $self->catdir(@files));
	my $spath = $path;
	$spath =~ s/\.dir\Z(?!\n)//;
	if ($spath =~ /^[^\)\]\/:>]+\)\Z(?!\n)/s && basename($file) eq $file) {
	    $rslt = "$spath$file";
	}
	else {
	    $rslt = $self->eliminate_macros($spath);
	    $rslt = vmsify($rslt.($rslt ? '/' : '').unixify($file));
	}
    }
    else { $rslt = (defined($file) && length($file)) ? vmsify($file) : ''; }
    return $self->canonpath($rslt);
}


=item curdir (override)

Returns a string representation of the current directory: '[]'

=cut

sub curdir {
    return '[]';
}

=item devnull (override)

Returns a string representation of the null device: '_NLA0:'

=cut

sub devnull {
    return "_NLA0:";
}

=item rootdir (override)

Returns a string representation of the root directory: 'SYS$DISK:[000000]'

=cut

sub rootdir {
    return 'SYS$DISK:[000000]';
}

=item tmpdir (override)

Returns a string representation of the first writable directory
from the following list or '' if none are writable:

    sys$scratch:
    $ENV{TMPDIR}

Since perl 5.8.0, if running under taint mode, and if $ENV{TMPDIR}
is tainted, it is not used.

=cut

my $tmpdir;
sub tmpdir {
    return $tmpdir if defined $tmpdir;
    $tmpdir = $_[0]->_tmpdir( 'sys$scratch:', $ENV{TMPDIR} );
}

=item updir (override)

Returns a string representation of the parent directory: '[-]'

=cut

sub updir {
    return '[-]';
}

=item case_tolerant (override)

VMS file specification syntax is case-tolerant.

=cut

sub case_tolerant {
    return 1;
}

=item path (override)

Translate logical name DCL$PATH as a searchlist, rather than trying
to C<split> string value of C<$ENV{'PATH'}>.

=cut

sub path {
    my (@dirs,$dir,$i);
    while ($dir = $ENV{'DCL$PATH;' . $i++}) { push(@dirs,$dir); }
    return @dirs;
}

=item file_name_is_absolute (override)

Checks for VMS directory spec as well as Unix separators.

=cut

sub file_name_is_absolute {
    my ($self,$file) = @_;
    # If it's a logical name, expand it.
    $file = $ENV{$file} while $file =~ /^[\w\$\-]+\Z(?!\n)/s && $ENV{$file};
    return scalar($file =~ m!^/!s             ||
		  $file =~ m![<\[][^.\-\]>]!  ||
		  $file =~ /:[^<\[]/);
}

=item splitpath (override)

Splits using VMS syntax.

=cut

sub splitpath {
    my($self,$path) = @_;
    my($dev,$dir,$file) = ('','','');

    vmsify($path) =~ /(.+:)?([\[<].*[\]>])?(.*)/s;
    return ($1 || '',$2 || '',$3);
}

=item splitdir (override)

Split dirspec using VMS syntax.

=cut

sub splitdir {
    my($self,$dirspec) = @_;
    $dirspec =~ tr/<>/[]/;			# < and >	==> [ and ]
    $dirspec =~ s/\]\[\./\.\]\[/g;		# ][.		==> .][
    $dirspec =~ s/\[000000\.\]\[/\[/g;		# [000000.][	==> [
    $dirspec =~ s/\[000000\./\[/g;		# [000000.	==> [
    $dirspec =~ s/\.\]\[000000\]/\]/g;		# .][000000]	==> ]
    $dirspec =~ s/\.\]\[/\./g;			# foo.][bar	==> foo.bar
    while ($dirspec =~ s/(^|[\[\<\.])\-(\-+)($|[\]\>\.])/$1-.$2$3/g) {}
						# That loop does the following
						# with any amount of dashes:
						# .--.		==> .-.-.
						# [--.		==> [-.-.
						# .--]		==> .-.-]
						# [--]		==> [-.-]
    $dirspec = "[$dirspec]" unless $dirspec =~ /[\[<]/; # make legal
    my(@dirs) = split('\.', vmspath($dirspec));
    $dirs[0] =~ s/^[\[<]//s;  $dirs[-1] =~ s/[\]>]\Z(?!\n)//s;
    @dirs;
}


=item catpath (override)

Construct a complete filespec using VMS syntax

=cut

sub catpath {
    my($self,$dev,$dir,$file) = @_;
    
    # We look for a volume in $dev, then in $dir, but not both
    my ($dir_volume, $dir_dir, $dir_file) = $self->splitpath($dir);
    $dev = $dir_volume unless length $dev;
    $dir = length $dir_file ? $self->catfile($dir_dir, $dir_file) : $dir_dir;
    
    if ($dev =~ m|^/+([^/]+)|) { $dev = "$1:"; }
    else { $dev .= ':' unless $dev eq '' or $dev =~ /:\Z(?!\n)/; }
    if (length($dev) or length($dir)) {
      $dir = "[$dir]" unless $dir =~ /[\[<\/]/;
      $dir = vmspath($dir);
    }
    "$dev$dir$file";
}

=item abs2rel (override)

Use VMS syntax when converting filespecs.

=cut

sub abs2rel {
    my $self = shift;
    return vmspath(File::Spec::Unix::abs2rel( $self, @_ ))
        if grep m{/}, @_;

    my($path,$base) = @_;
    $base = $self->_cwd() unless defined $base and length $base;

    for ($path, $base) { $_ = $self->canonpath($_) }

    # Are we even starting $path on the same (node::)device as $base?  Note that
    # logical paths or nodename differences may be on the "same device" 
    # but the comparison that ignores device differences so as to concatenate 
    # [---] up directory specs is not even a good idea in cases where there is 
    # a logical path difference between $path and $base nodename and/or device.
    # Hence we fall back to returning the absolute $path spec
    # if there is a case blind device (or node) difference of any sort
    # and we do not even try to call $parse() or consult %ENV for $trnlnm()
    # (this module needs to run on non VMS platforms after all).
    
    my ($path_volume, $path_directories, $path_file) = $self->splitpath($path);
    my ($base_volume, $base_directories, $base_file) = $self->splitpath($base);
    return $path unless lc($path_volume) eq lc($base_volume);

    for ($path, $base) { $_ = $self->rel2abs($_) }

    # Now, remove all leading components that are the same
    my @pathchunks = $self->splitdir( $path_directories );
    unshift(@pathchunks,'000000') unless $pathchunks[0] eq '000000';
    my @basechunks = $self->splitdir( $base_directories );
    unshift(@basechunks,'000000') unless $basechunks[0] eq '000000';

    while ( @pathchunks && 
            @basechunks && 
            lc( $pathchunks[0] ) eq lc( $basechunks[0] ) 
          ) {
        shift @pathchunks ;
        shift @basechunks ;
    }

    return $self->curdir unless @pathchunks || @basechunks;

    # @basechunks now contains the directories to climb out of,
    # @pathchunks now has the directories to descend in to.
    $path_directories = join '.', ('-' x @basechunks, @pathchunks) ;
    return $self->canonpath( $self->catpath( '', $path_directories, $path_file ) ) ;
}


=item rel2abs (override)

Use VMS syntax when converting filespecs.

=cut

sub rel2abs {
    my $self = shift ;
    my ($path,$base ) = @_;
    return undef unless defined $path;
    if ($path =~ m/\//) {
	$path = ( -d $path || $path =~ m/\/\z/  # educated guessing about
		   ? vmspath($path)             # whether it's a directory
		   : vmsify($path) );
    }
    $base = vmspath($base) if defined $base && $base =~ m/\//;
    # Clean up and split up $path
    if ( ! $self->file_name_is_absolute( $path ) ) {
        # Figure out the effective $base and clean it up.
        if ( !defined( $base ) || $base eq '' ) {
            $base = $self->_cwd;
        }
        elsif ( ! $self->file_name_is_absolute( $base ) ) {
            $base = $self->rel2abs( $base ) ;
        }
        else {
            $base = $self->canonpath( $base ) ;
        }

        # Split up paths
        my ( $path_directories, $path_file ) =
            ($self->splitpath( $path ))[1,2] ;

        my ( $base_volume, $base_directories ) =
            $self->splitpath( $base ) ;

        $path_directories = '' if $path_directories eq '[]' ||
                                  $path_directories eq '<>';
        my $sep = '' ;
        $sep = '.'
            if ( $base_directories =~ m{[^.\]>]\Z(?!\n)} &&
                 $path_directories =~ m{^[^.\[<]}s
            ) ;
        $base_directories = "$base_directories$sep$path_directories";
        $base_directories =~ s{\.?[\]>][\[<]\.?}{.};

        $path = $self->catpath( $base_volume, $base_directories, $path_file );
   }

    return $self->canonpath( $path ) ;
}


# eliminate_macros() and fixpath() are MakeMaker-specific methods
# which are used inside catfile() and catdir().  MakeMaker has its own
# copies as of 6.06_03 which are the canonical ones.  We leave these
# here, in peace, so that File::Spec continues to work with MakeMakers
# prior to 6.06_03.
# 
# Please consider these two methods deprecated.  Do not patch them,
# patch the ones in ExtUtils::MM_VMS instead.
sub eliminate_macros {
    my($self,$path) = @_;
    return '' unless $path;
    $self = {} unless ref $self;

    if ($path =~ /\s/) {
      return join ' ', map { $self->eliminate_macros($_) } split /\s+/, $path;
    }

    my($npath) = unixify($path);
    my($complex) = 0;
    my($head,$macro,$tail);

    # perform m##g in scalar context so it acts as an iterator
    while ($npath =~ m#(.*?)\$\((\S+?)\)(.*)#gs) { 
        if ($self->{$2}) {
            ($head,$macro,$tail) = ($1,$2,$3);
            if (ref $self->{$macro}) {
                if (ref $self->{$macro} eq 'ARRAY') {
                    $macro = join ' ', @{$self->{$macro}};
                }
                else {
                    print "Note: can't expand macro \$($macro) containing ",ref($self->{$macro}),
                          "\n\t(using MMK-specific deferred substitutuon; MMS will break)\n";
                    $macro = "\cB$macro\cB";
                    $complex = 1;
                }
            }
            else { ($macro = unixify($self->{$macro})) =~ s#/\Z(?!\n)##; }
            $npath = "$head$macro$tail";
        }
    }
    if ($complex) { $npath =~ s#\cB(.*?)\cB#\${$1}#gs; }
    $npath;
}

# Deprecated.  See the note above for eliminate_macros().
sub fixpath {
    my($self,$path,$force_path) = @_;
    return '' unless $path;
    $self = bless {} unless ref $self;
    my($fixedpath,$prefix,$name);

    if ($path =~ /\s/) {
      return join ' ',
             map { $self->fixpath($_,$force_path) }
	     split /\s+/, $path;
    }

    if ($path =~ m#^\$\([^\)]+\)\Z(?!\n)#s || $path =~ m#[/:>\]]#) { 
        if ($force_path or $path =~ /(?:DIR\)|\])\Z(?!\n)/) {
            $fixedpath = vmspath($self->eliminate_macros($path));
        }
        else {
            $fixedpath = vmsify($self->eliminate_macros($path));
        }
    }
    elsif ((($prefix,$name) = ($path =~ m#^\$\(([^\)]+)\)(.+)#s)) && $self->{$prefix}) {
        my($vmspre) = $self->eliminate_macros("\$($prefix)");
        # is it a dir or just a name?
        $vmspre = ($vmspre =~ m|/| or $prefix =~ /DIR\Z(?!\n)/) ? vmspath($vmspre) : '';
        $fixedpath = ($vmspre ? $vmspre : $self->{$prefix}) . $name;
        $fixedpath = vmspath($fixedpath) if $force_path;
    }
    else {
        $fixedpath = $path;
        $fixedpath = vmspath($fixedpath) if $force_path;
    }
    # No hints, so we try to guess
    if (!defined($force_path) and $fixedpath !~ /[:>(.\]]/) {
        $fixedpath = vmspath($fixedpath) if -d $fixedpath;
    }

    # Trim off root dirname if it's had other dirs inserted in front of it.
    $fixedpath =~ s/\.000000([\]>])/$1/;
    # Special case for VMS absolute directory specs: these will have had device
    # prepended during trip through Unix syntax in eliminate_macros(), since
    # Unix syntax has no way to express "absolute from the top of this device's
    # directory tree".
    if ($path =~ /^[\[>][^.\-]/) { $fixedpath =~ s/^[^\[<]+//; }
    $fixedpath;
}


=back

=head1 COPYRIGHT

Copyright (c) 2004 by the Perl 5 Porters.  All rights reserved.

This program is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.

=head1 SEE ALSO

See L<File::Spec> and L<File::Spec::Unix>.  This package overrides the
implementation of these methods, not the semantics.

An explanation of VMS file specs can be found at
L<"http://h71000.www7.hp.com/doc/731FINAL/4506/4506pro_014.html#apps_locating_naming_files">.

=cut

1;
Commit	Line	Data
270d1e39	1	package File::Spec::VMS;
270d1e39	2
cbc7acb0	3	use strict;
ee8c7f54	4	use vars qw(@ISA $VERSION);
cbc7acb0	5	require File::Spec::Unix;
ee8c7f54	6
07824bd1	7	$VERSION = '1.4';
ee8c7f54	8
270d1e39	9	@ISA = qw(File::Spec::Unix);
270d1e39	10
cbc7acb0	11	use File::Basename;
cbc7acb0	12	use VMS::Filespec;
270d1e39	13
	14	=head1 NAME
	15
	16	File::Spec::VMS - methods for VMS file specs
	17
	18	=head1 SYNOPSIS
	19
cbc7acb0	20	require File::Spec::VMS; # Done internally by File::Spec if needed
270d1e39	21
	22	=head1 DESCRIPTION
	23
	24	See File::Spec::Unix for a documentation of the methods provided
	25	there. This package overrides the implementation of these methods, not
	26	the semantics.
	27
bbc7dcd2	28	=over 4
a45bd81d	29
46726cbe	30	=item canonpath (override)
46726cbe	31
fd7385b9	32	Removes redundant portions of file specifications according to VMS syntax.
46726cbe	33
	34	=cut
	35
	36	sub canonpath {
fd7385b9	37	my($self,$path) = @_;
46726cbe	38
46726cbe	39	if ($path =~ m\|/\|) { # Fake Unix
ee8c7f54	40	my $pathify = $path =~ m\|/\Z(?!\n)\|;
fd7385b9	41	$path = $self->SUPER::canonpath($path);
46726cbe	42	if ($pathify) { return vmspath($path); }
	43	else { return vmsify($path); }
	44	}
	45	else {
bdc74e5c	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:
	55	# .-.-. ==> .--.
	56	# [-.-. ==> [--.
	57	# .-.-] ==> .--]
	58	# [-.-] ==> [--]
	59	1 while ($path =~ s/([\[\.])[^\]\.]+\.-(-+)([\]\.])/$1$2$3/);
	60	# That loop does the following
	61	# with any amount (minimum 2)
	62	# of dashes:
	63	# .foo.--. ==> .-.
	64	# .foo.--] ==> .-]
	65	# [foo.--. ==> [-.
	66	# [foo.--] ==> [-]
	67	#
	68	# And then, the remaining cases
	69	$path =~ s/\[\.-/[-/; # [.- ==> [-
	70	$path =~ s/\.[^\]\.]+\.-\./\./g; # .foo.-. ==> .
	71	$path =~ s/\[[^\]\.]+\.-\./\[/g; # [foo.-. ==> [
	72	$path =~ s/\.[^\]\.]+\.-\]/\]/g; # .foo.-] ==> ]
99f36a73	73	$path =~ s/\[[^\]\.]+\.-\]/\[000000\]/g;# [foo.-] ==> [000000]
bdc74e5c	74	$path =~ s/\[\]//; # [] ==>
bdc74e5c	75	return $path;
46726cbe	76	}
	77	}
	78
9596c75c	79	=item catdir (override)
270d1e39	80
270d1e39	81	Concatenates a list of file specifications, and returns the result as a
46726cbe	82	VMS-syntax directory specification. No check is made for "impossible"
46726cbe	83	cases (e.g. elements other than the first being absolute filespecs).
270d1e39	84
	85	=cut
	86
	87	sub catdir {
cbc7acb0	88	my ($self,@dirs) = @_;
cbc7acb0	89	my $dir = pop @dirs;
270d1e39	90	@dirs = grep($_,@dirs);
cbc7acb0	91	my $rslt;
270d1e39	92	if (@dirs) {
cbc7acb0	93	my $path = (@dirs == 1 ? $dirs[0] : $self->catdir(@dirs));
cbc7acb0	94	my ($spath,$sdir) = ($path,$dir);
ee8c7f54	95	$spath =~ s/\.dir\Z(?!\n)//; $sdir =~ s/\.dir\Z(?!\n)//;
ee8c7f54	96	$sdir = $self->eliminate_macros($sdir) unless $sdir =~ /^[\w\-]+\Z(?!\n)/s;
cbc7acb0	97	$rslt = $self->fixpath($self->eliminate_macros($spath)."/$sdir",1);
46726cbe	98
fd7385b9	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
	102	# directory tree".
	103	if ($spath =~ /^[\[<][^.\-]/s) { $rslt =~ s/^[^\[<]+//s; }
270d1e39	104	}
cbc7acb0	105	else {
fd7385b9	106	if (not defined $dir or not length $dir) { $rslt = ''; }
ee8c7f54	107	elsif ($dir =~ /^\$\([^\)]+\)\Z(?!\n)/s) { $rslt = $dir; }
fd7385b9	108	else { $rslt = vmspath($dir); }
270d1e39	109	}
099f76bb	110	return $self->canonpath($rslt);
270d1e39	111	}
270d1e39	112
9596c75c	113	=item catfile (override)
270d1e39	114
270d1e39	115	Concatenates a list of file specifications, and returns the result as a
46726cbe	116	VMS-syntax file specification.
270d1e39	117
	118	=cut
	119
	120	sub catfile {
cbc7acb0	121	my ($self,@files) = @_;
9ba1b7d2	122	my $file = $self->canonpath(pop @files);
270d1e39	123	@files = grep($_,@files);
cbc7acb0	124	my $rslt;
270d1e39	125	if (@files) {
cbc7acb0	126	my $path = (@files == 1 ? $files[0] : $self->catdir(@files));
cbc7acb0	127	my $spath = $path;
ee8c7f54	128	$spath =~ s/\.dir\Z(?!\n)//;
ee8c7f54	129	if ($spath =~ /^[^\)\]\/:>]+\)\Z(?!\n)/s && basename($file) eq $file) {
cbc7acb0	130	$rslt = "$spath$file";
	131	}
	132	else {
	133	$rslt = $self->eliminate_macros($spath);
	134	$rslt = vmsify($rslt.($rslt ? '/' : '').unixify($file));
	135	}
270d1e39	136	}
fd7385b9	137	else { $rslt = (defined($file) && length($file)) ? vmsify($file) : ''; }
099f76bb	138	return $self->canonpath($rslt);
270d1e39	139	}
270d1e39	140
46726cbe	141
270d1e39	142	=item curdir (override)
270d1e39	143
cbc7acb0	144	Returns a string representation of the current directory: '[]'
270d1e39	145
	146	=cut
	147
	148	sub curdir {
	149	return '[]';
	150	}
	151
99804bbb	152	=item devnull (override)
99804bbb	153
cbc7acb0	154	Returns a string representation of the null device: '_NLA0:'
99804bbb	155
	156	=cut
	157
	158	sub devnull {
cbc7acb0	159	return "_NLA0:";
99804bbb	160	}
99804bbb	161
270d1e39	162	=item rootdir (override)
270d1e39	163
cbc7acb0	164	Returns a string representation of the root directory: 'SYS$DISK:[000000]'
270d1e39	165
	166	=cut
	167
	168	sub rootdir {
cbc7acb0	169	return 'SYS$DISK:[000000]';
	170	}
	171
	172	=item tmpdir (override)
	173
	174	Returns a string representation of the first writable directory
	175	from the following list or '' if none are writable:
	176
188ff3c1	177	sys$scratch:
cbc7acb0	178	$ENV{TMPDIR}
cbc7acb0	179
a384e9e1	180	Since perl 5.8.0, if running under taint mode, and if $ENV{TMPDIR}
	181	is tainted, it is not used.
	182
cbc7acb0	183	=cut
	184
	185	my $tmpdir;
	186	sub tmpdir {
	187	return $tmpdir if defined $tmpdir;
60598624	188	$tmpdir = $_[0]->_tmpdir( 'sys$scratch:', $ENV{TMPDIR} );
270d1e39	189	}
	190
	191	=item updir (override)
	192
cbc7acb0	193	Returns a string representation of the parent directory: '[-]'
270d1e39	194
	195	=cut
	196
	197	sub updir {
	198	return '[-]';
	199	}
	200
46726cbe	201	=item case_tolerant (override)
	202
	203	VMS file specification syntax is case-tolerant.
	204
	205	=cut
	206
	207	sub case_tolerant {
	208	return 1;
	209	}
	210
270d1e39	211	=item path (override)
	212
	213	Translate logical name DCL$PATH as a searchlist, rather than trying
	214	to C<split> string value of C<$ENV{'PATH'}>.
	215
	216	=cut
	217
	218	sub path {
cbc7acb0	219	my (@dirs,$dir,$i);
270d1e39	220	while ($dir = $ENV{'DCL$PATH;' . $i++}) { push(@dirs,$dir); }
cbc7acb0	221	return @dirs;
270d1e39	222	}
	223
	224	=item file_name_is_absolute (override)
	225
	226	Checks for VMS directory spec as well as Unix separators.
	227
	228	=cut
	229
	230	sub file_name_is_absolute {
cbc7acb0	231	my ($self,$file) = @_;
270d1e39	232	# If it's a logical name, expand it.
ee8c7f54	233	$file = $ENV{$file} while $file =~ /^[\w\$\-]+\Z(?!\n)/s && $ENV{$file};
1b1e14d3	234	return scalar($file =~ m!^/!s \|\|
cbc7acb0	235	$file =~ m![<\[][^.\-\]>]! \|\|
cbc7acb0	236	$file =~ /:[^<\[]/);
270d1e39	237	}
270d1e39	238
46726cbe	239	=item splitpath (override)
	240
	241	Splits using VMS syntax.
	242
	243	=cut
	244
	245	sub splitpath {
	246	my($self,$path) = @_;
	247	my($dev,$dir,$file) = ('','','');
	248
1b1e14d3	249	vmsify($path) =~ /(.+:)?([\[<].[\]>])?(.)/s;
46726cbe	250	return ($1 \|\| '',$2 \|\| '',$3);
	251	}
	252
	253	=item splitdir (override)
	254
	255	Split dirspec using VMS syntax.
	256
	257	=cut
	258
	259	sub splitdir {
	260	my($self,$dirspec) = @_;
bdc74e5c	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:
	270	# .--. ==> .-.-.
	271	# [--. ==> [-.-.
	272	# .--] ==> .-.-]
	273	# [--] ==> [-.-]
fd7385b9	274	$dirspec = "[$dirspec]" unless $dirspec =~ /[\[<]/; # make legal
46726cbe	275	my(@dirs) = split('\.', vmspath($dirspec));
ee8c7f54	276	$dirs[0] =~ s/^[\[<]//s; $dirs[-1] =~ s/[\]>]\Z(?!\n)//s;
46726cbe	277	@dirs;
	278	}
	279
	280
	281	=item catpath (override)
	282
	283	Construct a complete filespec using VMS syntax
	284
	285	=cut
	286
	287	sub catpath {
	288	my($self,$dev,$dir,$file) = @_;
638113eb	289
	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;
	294
fd7385b9	295	if ($dev =~ m\|^/+([^/]+)\|) { $dev = "$1:"; }
ee8c7f54	296	else { $dev .= ':' unless $dev eq '' or $dev =~ /:\Z(?!\n)/; }
fd7385b9	297	if (length($dev) or length($dir)) {
	298	$dir = "[$dir]" unless $dir =~ /[\[<\/]/;
	299	$dir = vmspath($dir);
0994714a	300	}
fd7385b9	301	"$dev$dir$file";
0994714a	302	}
0994714a	303
fd7385b9	304	=item abs2rel (override)
0994714a	305
fd7385b9	306	Use VMS syntax when converting filespecs.
0994714a	307
	308	=cut
	309
0994714a	310	sub abs2rel {
0994714a	311	my $self = shift;
fd7385b9	312	return vmspath(File::Spec::Unix::abs2rel( $self, @_ ))
638113eb	313	if grep m{/}, @_;
0994714a	314
0994714a	315	my($path,$base) = @_;
638113eb	316	$base = $self->_cwd() unless defined $base and length $base;
0994714a	317
638113eb	318	for ($path, $base) { $_ = $self->canonpath($_) }
0994714a	319
d84c672d	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).
638113eb	329
	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);
d84c672d	333
638113eb	334	for ($path, $base) { $_ = $self->rel2abs($_) }
0994714a	335
	336	# Now, remove all leading components that are the same
	337	my @pathchunks = $self->splitdir( $path_directories );
737c380e	338	unshift(@pathchunks,'000000') unless $pathchunks[0] eq '000000';
0994714a	339	my @basechunks = $self->splitdir( $base_directories );
737c380e	340	unshift(@basechunks,'000000') unless $basechunks[0] eq '000000';
0994714a	341
	342	while ( @pathchunks &&
	343	@basechunks &&
	344	lc( $pathchunks[0] ) eq lc( $basechunks[0] )
	345	) {
	346	shift @pathchunks ;
	347	shift @basechunks ;
	348	}
	349
9d5071ba	350	return $self->curdir unless @pathchunks \|\| @basechunks;
9d5071ba	351
0994714a	352	# @basechunks now contains the directories to climb out of,
0994714a	353	# @pathchunks now has the directories to descend in to.
638113eb	354	$path_directories = join '.', ('-' x @basechunks, @pathchunks) ;
fd7385b9	355	return $self->canonpath( $self->catpath( '', $path_directories, $path_file ) ) ;
0994714a	356	}
	357
	358
fd7385b9	359	=item rel2abs (override)
	360
	361	Use VMS syntax when converting filespecs.
	362
	363	=cut
	364
786b702f	365	sub rel2abs {
0994714a	366	my $self = shift ;
0994714a	367	my ($path,$base ) = @_;
bdc74e5c	368	return undef unless defined $path;
99f36a73	369	if ($path =~ m/\//) {
	370	$path = ( -d $path \|\| $path =~ m/\/\z/ # educated guessing about
	371	? vmspath($path) # whether it's a directory
	372	: vmsify($path) );
	373	}
bdc74e5c	374	$base = vmspath($base) if defined $base && $base =~ m/\//;
0994714a	375	# Clean up and split up $path
	376	if ( ! $self->file_name_is_absolute( $path ) ) {
	377	# Figure out the effective $base and clean it up.
	378	if ( !defined( $base ) \|\| $base eq '' ) {
0fab864c	379	$base = $self->_cwd;
0994714a	380	}
	381	elsif ( ! $self->file_name_is_absolute( $base ) ) {
	382	$base = $self->rel2abs( $base ) ;
	383	}
	384	else {
	385	$base = $self->canonpath( $base ) ;
	386	}
	387
	388	# Split up paths
ee8c7f54	389	my ( $path_directories, $path_file ) =
ee8c7f54	390	($self->splitpath( $path ))[1,2] ;
0994714a	391
ee8c7f54	392	my ( $base_volume, $base_directories ) =
0994714a	393	$self->splitpath( $base ) ;
0994714a	394
fd7385b9	395	$path_directories = '' if $path_directories eq '[]' \|\|
fd7385b9	396	$path_directories eq '<>';
0994714a	397	my $sep = '' ;
0994714a	398	$sep = '.'
ee8c7f54	399	if ( $base_directories =~ m{[^.\]>]\Z(?!\n)} &&
fd7385b9	400	$path_directories =~ m{^[^.\[<]}s
0994714a	401	) ;
fd7385b9	402	$base_directories = "$base_directories$sep$path_directories";
fd7385b9	403	$base_directories =~ s{\.?[\]>][\[<]\.?}{.};
0994714a	404
	405	$path = $self->catpath( $base_volume, $base_directories, $path_file );
	406	}
	407
	408	return $self->canonpath( $path ) ;
	409	}
	410
	411
9596c75c	412	# eliminate_macros() and fixpath() are MakeMaker-specific methods
	413	# which are used inside catfile() and catdir(). MakeMaker has its own
	414	# copies as of 6.06_03 which are the canonical ones. We leave these
	415	# here, in peace, so that File::Spec continues to work with MakeMakers
	416	# prior to 6.06_03.
	417	#
	418	# Please consider these two methods deprecated. Do not patch them,
	419	# patch the ones in ExtUtils::MM_VMS instead.
	420	sub eliminate_macros {
	421	my($self,$path) = @_;
	422	return '' unless $path;
	423	$self = {} unless ref $self;
	424
	425	if ($path =~ /\s/) {
	426	return join ' ', map { $self->eliminate_macros($_) } split /\s+/, $path;
	427	}
	428
	429	my($npath) = unixify($path);
	430	my($complex) = 0;
	431	my($head,$macro,$tail);
	432
	433	# perform m##g in scalar context so it acts as an iterator
	434	while ($npath =~ m#(.?)\$\((\S+?)\)(.)#gs) {
	435	if ($self->{$2}) {
	436	($head,$macro,$tail) = ($1,$2,$3);
	437	if (ref $self->{$macro}) {
	438	if (ref $self->{$macro} eq 'ARRAY') {
	439	$macro = join ' ', @{$self->{$macro}};
	440	}
	441	else {
	442	print "Note: can't expand macro \$($macro) containing ",ref($self->{$macro}),
	443	"\n\t(using MMK-specific deferred substitutuon; MMS will break)\n";
	444	$macro = "\cB$macro\cB";
	445	$complex = 1;
	446	}
	447	}
	448	else { ($macro = unixify($self->{$macro})) =~ s#/\Z(?!\n)##; }
	449	$npath = "$head$macro$tail";
	450	}
	451	}
	452	if ($complex) { $npath =~ s#\cB(.*?)\cB#\${$1}#gs; }
	453	$npath;
	454	}
	455
	456	# Deprecated. See the note above for eliminate_macros().
	457	sub fixpath {
	458	my($self,$path,$force_path) = @_;
	459	return '' unless $path;
	460	$self = bless {} unless ref $self;
	461	my($fixedpath,$prefix,$name);
	462
	463	if ($path =~ /\s/) {
	464	return join ' ',
	465	map { $self->fixpath($_,$force_path) }
	466	split /\s+/, $path;
	467	}
	468
	469	if ($path =~ m#^\$\([^\)]+\)\Z(?!\n)#s \|\| $path =~ m#[/:>\]]#) {
	470	if ($force_path or $path =~ /(?:DIR\)\|\])\Z(?!\n)/) {
	471	$fixedpath = vmspath($self->eliminate_macros($path));
	472	}
	473	else {
	474	$fixedpath = vmsify($self->eliminate_macros($path));
	475	}
476	}
477	elsif ((($prefix,$name) = ($path =~ m#^\$\(([^\)]+)\)(.+)#s)) && $self->{$prefix}) {
478	my($vmspre) = $self->eliminate_macros("\$($prefix)");
479	# is it a dir or just a name?
480	$vmspre = ($vmspre =~ m\|/\| or $prefix =~ /DIR\Z(?!\n)/) ? vmspath($vmspre) : '';
481	$fixedpath = ($vmspre ? $vmspre : $self->{$prefix}) . $name;
482	$fixedpath = vmspath($fixedpath) if $force_path;
483	}
484	else {
485	$fixedpath = $path;
486	$fixedpath = vmspath($fixedpath) if $force_path;
487	}
488	# No hints, so we try to guess
489	if (!defined($force_path) and $fixedpath !~ /[:>(.\]]/) {
490	$fixedpath = vmspath($fixedpath) if -d $fixedpath;
491	}
492
493	# Trim off root dirname if it's had other dirs inserted in front of it.
494	$fixedpath =~ s/\.000000([\]>])/$1/;
495	# Special case for VMS absolute directory specs: these will have had device
496	# prepended during trip through Unix syntax in eliminate_macros(), since
497	# Unix syntax has no way to express "absolute from the top of this device's
498	# directory tree".
499	if ($path =~ /^[\[>][^.\-]/) { $fixedpath =~ s/^[^\[<]+//; }
500	$fixedpath;
501	}
502
503
cbc7acb0	504	=back
270d1e39	505
99f36a73	506	=head1 COPYRIGHT
	507
	508	Copyright (c) 2004 by the Perl 5 Porters. All rights reserved.
	509
	510	This program is free software; you can redistribute it and/or modify
	511	it under the same terms as Perl itself.
	512
cbc7acb0	513	=head1 SEE ALSO
cbc7acb0	514
72f15715	515	See L<File::Spec> and L<File::Spec::Unix>. This package overrides the
72f15715	516	implementation of these methods, not the semantics.
cbc7acb0	517
638113eb	518	An explanation of VMS file specs can be found at
	519	L<"http://h71000.www7.hp.com/doc/731FINAL/4506/4506pro_014.html#apps_locating_naming_files">.
	520
cbc7acb0	521	=cut
	522
	523	1;