[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 eliminate_macros

Expands MM[KS]/Make macros in a text string, using the contents of
identically named elements of C<%$self>, and returns the result
as a file specification in Unix syntax.

=cut

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;
}

=item fixpath

Catchall routine to clean up problem MM[SK]/Make macros.  Expands macros
in any directory specification, in order to avoid juxtaposing two
VMS-syntax directories when MM[SK] is run.  Also expands expressions which
are all macro, so that we can tell how long the expansion is, and avoid
overrunning DCL's command buffer when MM[KS] is running.

If optional second argument has a TRUE value, then the return string is
a VMS-syntax directory specification, if it is FALSE, the return string
is a VMS-syntax file specification, and if it is not specified, fixpath()
checks to see whether it matches the name of a directory in the current
default directory, and returns a directory or file specification accordingly.

=cut

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

=head2 Methods always loaded

=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/\[[^\]\.]+\.-\]/\[\]/g;	# [foo.-]	==> []
	$path =~ s/\[\]//;			# []		==>
	return $path;
    }
}

=item catdir

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

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;
    my $self = shift;
    $tmpdir = $self->_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 ;
    }

    # @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;
    $path = vmsify($path) if $path =~ m/\//;
    $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 ) ;
}


=back

=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
377875b9	30	=item eliminate_macros
	31
	32	Expands MM[KS]/Make macros in a text string, using the contents of
	33	identically named elements of C<%$self>, and returns the result
	34	as a file specification in Unix syntax.
	35
1f47e8e2	36	=cut
	37
	38	sub eliminate_macros {
	39	my($self,$path) = @_;
	40	return '' unless $path;
	41	$self = {} unless ref $self;
bdb84599	42
	43	if ($path =~ /\s/) {
	44	return join ' ', map { $self->eliminate_macros($_) } split /\s+/, $path;
	45	}
	46
1f47e8e2	47	my($npath) = unixify($path);
	48	my($complex) = 0;
	49	my($head,$macro,$tail);
	50
	51	# perform m##g in scalar context so it acts as an iterator
14a089c5	52	while ($npath =~ m#(.?)\$\((\S+?)\)(.)#gs) {
1f47e8e2	53	if ($self->{$2}) {
	54	($head,$macro,$tail) = ($1,$2,$3);
	55	if (ref $self->{$macro}) {
	56	if (ref $self->{$macro} eq 'ARRAY') {
	57	$macro = join ' ', @{$self->{$macro}};
	58	}
	59	else {
	60	print "Note: can't expand macro \$($macro) containing ",ref($self->{$macro}),
	61	"\n\t(using MMK-specific deferred substitutuon; MMS will break)\n";
	62	$macro = "\cB$macro\cB";
	63	$complex = 1;
	64	}
	65	}
ee8c7f54	66	else { ($macro = unixify($self->{$macro})) =~ s#/\Z(?!\n)##; }
1f47e8e2	67	$npath = "$head$macro$tail";
	68	}
	69	}
14a089c5	70	if ($complex) { $npath =~ s#\cB(.*?)\cB#\${$1}#gs; }
1f47e8e2	71	$npath;
	72	}
	73
377875b9	74	=item fixpath
	75
	76	Catchall routine to clean up problem MM[SK]/Make macros. Expands macros
	77	in any directory specification, in order to avoid juxtaposing two
	78	VMS-syntax directories when MM[SK] is run. Also expands expressions which
	79	are all macro, so that we can tell how long the expansion is, and avoid
	80	overrunning DCL's command buffer when MM[KS] is running.
	81
	82	If optional second argument has a TRUE value, then the return string is
	83	a VMS-syntax directory specification, if it is FALSE, the return string
	84	is a VMS-syntax file specification, and if it is not specified, fixpath()
	85	checks to see whether it matches the name of a directory in the current
	86	default directory, and returns a directory or file specification accordingly.
	87
	88	=cut
	89
1f47e8e2	90	sub fixpath {
	91	my($self,$path,$force_path) = @_;
	92	return '' unless $path;
	93	$self = bless {} unless ref $self;
	94	my($fixedpath,$prefix,$name);
	95
bdb84599	96	if ($path =~ /\s/) {
	97	return join ' ',
	98	map { $self->fixpath($_,$force_path) }
	99	split /\s+/, $path;
	100	}
	101
ee8c7f54	102	if ($path =~ m#^\$\([^\)]+\)\Z(?!\n)#s \|\| $path =~ m#[/:>\]]#) {
ee8c7f54	103	if ($force_path or $path =~ /(?:DIR\)\|\])\Z(?!\n)/) {
1f47e8e2	104	$fixedpath = vmspath($self->eliminate_macros($path));
	105	}
	106	else {
	107	$fixedpath = vmsify($self->eliminate_macros($path));
	108	}
	109	}
1b1e14d3	110	elsif ((($prefix,$name) = ($path =~ m#^\$\(([^\)]+)\)(.+)#s)) && $self->{$prefix}) {
1f47e8e2	111	my($vmspre) = $self->eliminate_macros("\$($prefix)");
1f47e8e2	112	# is it a dir or just a name?
ee8c7f54	113	$vmspre = ($vmspre =~ m\|/\| or $prefix =~ /DIR\Z(?!\n)/) ? vmspath($vmspre) : '';
1f47e8e2	114	$fixedpath = ($vmspre ? $vmspre : $self->{$prefix}) . $name;
	115	$fixedpath = vmspath($fixedpath) if $force_path;
	116	}
	117	else {
	118	$fixedpath = $path;
	119	$fixedpath = vmspath($fixedpath) if $force_path;
	120	}
	121	# No hints, so we try to guess
	122	if (!defined($force_path) and $fixedpath !~ /[:>(.\]]/) {
	123	$fixedpath = vmspath($fixedpath) if -d $fixedpath;
	124	}
46726cbe	125
1f47e8e2	126	# Trim off root dirname if it's had other dirs inserted in front of it.
1f47e8e2	127	$fixedpath =~ s/\.000000([\]>])/$1/;
46726cbe	128	# Special case for VMS absolute directory specs: these will have had device
	129	# prepended during trip through Unix syntax in eliminate_macros(), since
	130	# Unix syntax has no way to express "absolute from the top of this device's
	131	# directory tree".
	132	if ($path =~ /^[\[>][^.\-]/) { $fixedpath =~ s/^[^\[<]+//; }
1f47e8e2	133	$fixedpath;
	134	}
	135
a45bd81d	136	=back
1f47e8e2	137
270d1e39	138	=head2 Methods always loaded
270d1e39	139
bbc7dcd2	140	=over 4
270d1e39	141
46726cbe	142	=item canonpath (override)
46726cbe	143
fd7385b9	144	Removes redundant portions of file specifications according to VMS syntax.
46726cbe	145
	146	=cut
	147
	148	sub canonpath {
fd7385b9	149	my($self,$path) = @_;
46726cbe	150
46726cbe	151	if ($path =~ m\|/\|) { # Fake Unix
ee8c7f54	152	my $pathify = $path =~ m\|/\Z(?!\n)\|;
fd7385b9	153	$path = $self->SUPER::canonpath($path);
46726cbe	154	if ($pathify) { return vmspath($path); }
	155	else { return vmsify($path); }
	156	}
	157	else {
bdc74e5c	158	$path =~ tr/<>/[]/; # < and > ==> [ and ]
	159	$path =~ s/\]\[\./\.\]\[/g; # ][. ==> .][
	160	$path =~ s/\[000000\.\]\[/\[/g; # [000000.][ ==> [
	161	$path =~ s/\[000000\./\[/g; # [000000. ==> [
	162	$path =~ s/\.\]\[000000\]/\]/g; # .][000000] ==> ]
	163	$path =~ s/\.\]\[/\./g; # foo.][bar ==> foo.bar
	164	1 while ($path =~ s/([\[\.])(-+)\.(-+)([\.\]])/$1$2$3$4/);
	165	# That loop does the following
	166	# with any amount of dashes:
	167	# .-.-. ==> .--.
	168	# [-.-. ==> [--.
	169	# .-.-] ==> .--]
	170	# [-.-] ==> [--]
	171	1 while ($path =~ s/([\[\.])[^\]\.]+\.-(-+)([\]\.])/$1$2$3/);
	172	# That loop does the following
	173	# with any amount (minimum 2)
	174	# of dashes:
	175	# .foo.--. ==> .-.
	176	# .foo.--] ==> .-]
	177	# [foo.--. ==> [-.
	178	# [foo.--] ==> [-]
	179	#
	180	# And then, the remaining cases
	181	$path =~ s/\[\.-/[-/; # [.- ==> [-
	182	$path =~ s/\.[^\]\.]+\.-\./\./g; # .foo.-. ==> .
	183	$path =~ s/\[[^\]\.]+\.-\./\[/g; # [foo.-. ==> [
	184	$path =~ s/\.[^\]\.]+\.-\]/\]/g; # .foo.-] ==> ]
	185	$path =~ s/\[[^\]\.]+\.-\]/\[\]/g; # [foo.-] ==> []
	186	$path =~ s/\[\]//; # [] ==>
	187	return $path;
46726cbe	188	}
	189	}
	190
270d1e39	191	=item catdir
	192
	193	Concatenates a list of file specifications, and returns the result as a
46726cbe	194	VMS-syntax directory specification. No check is made for "impossible"
46726cbe	195	cases (e.g. elements other than the first being absolute filespecs).
270d1e39	196
	197	=cut
	198
	199	sub catdir {
cbc7acb0	200	my ($self,@dirs) = @_;
cbc7acb0	201	my $dir = pop @dirs;
270d1e39	202	@dirs = grep($_,@dirs);
cbc7acb0	203	my $rslt;
270d1e39	204	if (@dirs) {
cbc7acb0	205	my $path = (@dirs == 1 ? $dirs[0] : $self->catdir(@dirs));
cbc7acb0	206	my ($spath,$sdir) = ($path,$dir);
ee8c7f54	207	$spath =~ s/\.dir\Z(?!\n)//; $sdir =~ s/\.dir\Z(?!\n)//;
ee8c7f54	208	$sdir = $self->eliminate_macros($sdir) unless $sdir =~ /^[\w\-]+\Z(?!\n)/s;
cbc7acb0	209	$rslt = $self->fixpath($self->eliminate_macros($spath)."/$sdir",1);
46726cbe	210
fd7385b9	211	# Special case for VMS absolute directory specs: these will have had device
	212	# prepended during trip through Unix syntax in eliminate_macros(), since
	213	# Unix syntax has no way to express "absolute from the top of this device's
	214	# directory tree".
	215	if ($spath =~ /^[\[<][^.\-]/s) { $rslt =~ s/^[^\[<]+//s; }
270d1e39	216	}
cbc7acb0	217	else {
fd7385b9	218	if (not defined $dir or not length $dir) { $rslt = ''; }
ee8c7f54	219	elsif ($dir =~ /^\$\([^\)]+\)\Z(?!\n)/s) { $rslt = $dir; }
fd7385b9	220	else { $rslt = vmspath($dir); }
270d1e39	221	}
099f76bb	222	return $self->canonpath($rslt);
270d1e39	223	}
	224
	225	=item catfile
	226
	227	Concatenates a list of file specifications, and returns the result as a
46726cbe	228	VMS-syntax file specification.
270d1e39	229
	230	=cut
	231
	232	sub catfile {
cbc7acb0	233	my ($self,@files) = @_;
9ba1b7d2	234	my $file = $self->canonpath(pop @files);
270d1e39	235	@files = grep($_,@files);
cbc7acb0	236	my $rslt;
270d1e39	237	if (@files) {
cbc7acb0	238	my $path = (@files == 1 ? $files[0] : $self->catdir(@files));
cbc7acb0	239	my $spath = $path;
ee8c7f54	240	$spath =~ s/\.dir\Z(?!\n)//;
ee8c7f54	241	if ($spath =~ /^[^\)\]\/:>]+\)\Z(?!\n)/s && basename($file) eq $file) {
cbc7acb0	242	$rslt = "$spath$file";
	243	}
	244	else {
	245	$rslt = $self->eliminate_macros($spath);
	246	$rslt = vmsify($rslt.($rslt ? '/' : '').unixify($file));
	247	}
270d1e39	248	}
fd7385b9	249	else { $rslt = (defined($file) && length($file)) ? vmsify($file) : ''; }
099f76bb	250	return $self->canonpath($rslt);
270d1e39	251	}
270d1e39	252
46726cbe	253
270d1e39	254	=item curdir (override)
270d1e39	255
cbc7acb0	256	Returns a string representation of the current directory: '[]'
270d1e39	257
	258	=cut
	259
	260	sub curdir {
	261	return '[]';
	262	}
	263
99804bbb	264	=item devnull (override)
99804bbb	265
cbc7acb0	266	Returns a string representation of the null device: '_NLA0:'
99804bbb	267
	268	=cut
	269
	270	sub devnull {
cbc7acb0	271	return "_NLA0:";
99804bbb	272	}
99804bbb	273
270d1e39	274	=item rootdir (override)
270d1e39	275
cbc7acb0	276	Returns a string representation of the root directory: 'SYS$DISK:[000000]'
270d1e39	277
	278	=cut
	279
	280	sub rootdir {
cbc7acb0	281	return 'SYS$DISK:[000000]';
	282	}
	283
	284	=item tmpdir (override)
	285
	286	Returns a string representation of the first writable directory
	287	from the following list or '' if none are writable:
	288
188ff3c1	289	sys$scratch:
cbc7acb0	290	$ENV{TMPDIR}
cbc7acb0	291
a384e9e1	292	Since perl 5.8.0, if running under taint mode, and if $ENV{TMPDIR}
	293	is tainted, it is not used.
	294
cbc7acb0	295	=cut
	296
	297	my $tmpdir;
	298	sub tmpdir {
	299	return $tmpdir if defined $tmpdir;
07824bd1	300	my $self = shift;
07824bd1	301	$tmpdir = $self->_tmpdir( 'sys$scratch:', $ENV{TMPDIR} );
270d1e39	302	}
	303
	304	=item updir (override)
	305
cbc7acb0	306	Returns a string representation of the parent directory: '[-]'
270d1e39	307
	308	=cut
	309
	310	sub updir {
	311	return '[-]';
	312	}
	313
46726cbe	314	=item case_tolerant (override)
	315
	316	VMS file specification syntax is case-tolerant.
	317
	318	=cut
	319
	320	sub case_tolerant {
	321	return 1;
	322	}
	323
270d1e39	324	=item path (override)
	325
	326	Translate logical name DCL$PATH as a searchlist, rather than trying
	327	to C<split> string value of C<$ENV{'PATH'}>.
	328
	329	=cut
	330
	331	sub path {
cbc7acb0	332	my (@dirs,$dir,$i);
270d1e39	333	while ($dir = $ENV{'DCL$PATH;' . $i++}) { push(@dirs,$dir); }
cbc7acb0	334	return @dirs;
270d1e39	335	}
	336
	337	=item file_name_is_absolute (override)
	338
	339	Checks for VMS directory spec as well as Unix separators.
	340
	341	=cut
	342
	343	sub file_name_is_absolute {
cbc7acb0	344	my ($self,$file) = @_;
270d1e39	345	# If it's a logical name, expand it.
ee8c7f54	346	$file = $ENV{$file} while $file =~ /^[\w\$\-]+\Z(?!\n)/s && $ENV{$file};
1b1e14d3	347	return scalar($file =~ m!^/!s \|\|
cbc7acb0	348	$file =~ m![<\[][^.\-\]>]! \|\|
cbc7acb0	349	$file =~ /:[^<\[]/);
270d1e39	350	}
270d1e39	351
46726cbe	352	=item splitpath (override)
	353
	354	Splits using VMS syntax.
	355
	356	=cut
	357
	358	sub splitpath {
	359	my($self,$path) = @_;
	360	my($dev,$dir,$file) = ('','','');
	361
1b1e14d3	362	vmsify($path) =~ /(.+:)?([\[<].[\]>])?(.)/s;
46726cbe	363	return ($1 \|\| '',$2 \|\| '',$3);
	364	}
	365
	366	=item splitdir (override)
	367
	368	Split dirspec using VMS syntax.
	369
	370	=cut
	371
	372	sub splitdir {
	373	my($self,$dirspec) = @_;
bdc74e5c	374	$dirspec =~ tr/<>/[]/; # < and > ==> [ and ]
	375	$dirspec =~ s/\]\[\./\.\]\[/g; # ][. ==> .][
	376	$dirspec =~ s/\[000000\.\]\[/\[/g; # [000000.][ ==> [
	377	$dirspec =~ s/\[000000\./\[/g; # [000000. ==> [
	378	$dirspec =~ s/\.\]\[000000\]/\]/g; # .][000000] ==> ]
	379	$dirspec =~ s/\.\]\[/\./g; # foo.][bar ==> foo.bar
	380	while ($dirspec =~ s/(^\|[\[\<\.])\-(\-+)($\|[\]\>\.])/$1-.$2$3/g) {}
	381	# That loop does the following
	382	# with any amount of dashes:
	383	# .--. ==> .-.-.
	384	# [--. ==> [-.-.
	385	# .--] ==> .-.-]
	386	# [--] ==> [-.-]
fd7385b9	387	$dirspec = "[$dirspec]" unless $dirspec =~ /[\[<]/; # make legal
46726cbe	388	my(@dirs) = split('\.', vmspath($dirspec));
ee8c7f54	389	$dirs[0] =~ s/^[\[<]//s; $dirs[-1] =~ s/[\]>]\Z(?!\n)//s;
46726cbe	390	@dirs;
	391	}
	392
	393
	394	=item catpath (override)
	395
	396	Construct a complete filespec using VMS syntax
	397
	398	=cut
	399
	400	sub catpath {
	401	my($self,$dev,$dir,$file) = @_;
638113eb	402
	403	# We look for a volume in $dev, then in $dir, but not both
	404	my ($dir_volume, $dir_dir, $dir_file) = $self->splitpath($dir);
	405	$dev = $dir_volume unless length $dev;
	406	$dir = length $dir_file ? $self->catfile($dir_dir, $dir_file) : $dir_dir;
	407
fd7385b9	408	if ($dev =~ m\|^/+([^/]+)\|) { $dev = "$1:"; }
ee8c7f54	409	else { $dev .= ':' unless $dev eq '' or $dev =~ /:\Z(?!\n)/; }
fd7385b9	410	if (length($dev) or length($dir)) {
	411	$dir = "[$dir]" unless $dir =~ /[\[<\/]/;
	412	$dir = vmspath($dir);
0994714a	413	}
fd7385b9	414	"$dev$dir$file";
0994714a	415	}
0994714a	416
fd7385b9	417	=item abs2rel (override)
0994714a	418
fd7385b9	419	Use VMS syntax when converting filespecs.
0994714a	420
	421	=cut
	422
0994714a	423	sub abs2rel {
0994714a	424	my $self = shift;
fd7385b9	425	return vmspath(File::Spec::Unix::abs2rel( $self, @_ ))
638113eb	426	if grep m{/}, @_;
0994714a	427
0994714a	428	my($path,$base) = @_;
638113eb	429	$base = $self->_cwd() unless defined $base and length $base;
0994714a	430
638113eb	431	for ($path, $base) { $_ = $self->canonpath($_) }
0994714a	432
d84c672d	433	# Are we even starting $path on the same (node::)device as $base? Note that
	434	# logical paths or nodename differences may be on the "same device"
	435	# but the comparison that ignores device differences so as to concatenate
	436	# [---] up directory specs is not even a good idea in cases where there is
	437	# a logical path difference between $path and $base nodename and/or device.
	438	# Hence we fall back to returning the absolute $path spec
	439	# if there is a case blind device (or node) difference of any sort
	440	# and we do not even try to call $parse() or consult %ENV for $trnlnm()
	441	# (this module needs to run on non VMS platforms after all).
638113eb	442
	443	my ($path_volume, $path_directories, $path_file) = $self->splitpath($path);
	444	my ($base_volume, $base_directories, $base_file) = $self->splitpath($base);
	445	return $path unless lc($path_volume) eq lc($base_volume);
d84c672d	446
638113eb	447	for ($path, $base) { $_ = $self->rel2abs($_) }
0994714a	448
	449	# Now, remove all leading components that are the same
	450	my @pathchunks = $self->splitdir( $path_directories );
737c380e	451	unshift(@pathchunks,'000000') unless $pathchunks[0] eq '000000';
0994714a	452	my @basechunks = $self->splitdir( $base_directories );
737c380e	453	unshift(@basechunks,'000000') unless $basechunks[0] eq '000000';
0994714a	454
	455	while ( @pathchunks &&
	456	@basechunks &&
	457	lc( $pathchunks[0] ) eq lc( $basechunks[0] )
	458	) {
	459	shift @pathchunks ;
	460	shift @basechunks ;
	461	}
	462
	463	# @basechunks now contains the directories to climb out of,
	464	# @pathchunks now has the directories to descend in to.
638113eb	465	$path_directories = join '.', ('-' x @basechunks, @pathchunks) ;
fd7385b9	466	return $self->canonpath( $self->catpath( '', $path_directories, $path_file ) ) ;
0994714a	467	}
	468
	469
fd7385b9	470	=item rel2abs (override)
	471
	472	Use VMS syntax when converting filespecs.
	473
	474	=cut
	475
786b702f	476	sub rel2abs {
0994714a	477	my $self = shift ;
0994714a	478	my ($path,$base ) = @_;
bdc74e5c	479	return undef unless defined $path;
21f4e7e5	480	$path = vmsify($path) if $path =~ m/\//;
bdc74e5c	481	$base = vmspath($base) if defined $base && $base =~ m/\//;
0994714a	482	# Clean up and split up $path
	483	if ( ! $self->file_name_is_absolute( $path ) ) {
	484	# Figure out the effective $base and clean it up.
	485	if ( !defined( $base ) \|\| $base eq '' ) {
0fab864c	486	$base = $self->_cwd;
0994714a	487	}
	488	elsif ( ! $self->file_name_is_absolute( $base ) ) {
	489	$base = $self->rel2abs( $base ) ;
	490	}
	491	else {
	492	$base = $self->canonpath( $base ) ;
	493	}
	494
	495	# Split up paths
ee8c7f54	496	my ( $path_directories, $path_file ) =
ee8c7f54	497	($self->splitpath( $path ))[1,2] ;
0994714a	498
ee8c7f54	499	my ( $base_volume, $base_directories ) =
0994714a	500	$self->splitpath( $base ) ;
0994714a	501
fd7385b9	502	$path_directories = '' if $path_directories eq '[]' \|\|
fd7385b9	503	$path_directories eq '<>';
0994714a	504	my $sep = '' ;
0994714a	505	$sep = '.'
ee8c7f54	506	if ( $base_directories =~ m{[^.\]>]\Z(?!\n)} &&
fd7385b9	507	$path_directories =~ m{^[^.\[<]}s
0994714a	508	) ;
fd7385b9	509	$base_directories = "$base_directories$sep$path_directories";
fd7385b9	510	$base_directories =~ s{\.?[\]>][\[<]\.?}{.};
0994714a	511
	512	$path = $self->catpath( $base_volume, $base_directories, $path_file );
	513	}
	514
	515	return $self->canonpath( $path ) ;
	516	}
	517
	518
cbc7acb0	519	=back
270d1e39	520
cbc7acb0	521	=head1 SEE ALSO
cbc7acb0	522
72f15715	523	See L<File::Spec> and L<File::Spec::Unix>. This package overrides the
72f15715	524	implementation of these methods, not the semantics.
cbc7acb0	525
638113eb	526	An explanation of VMS file specs can be found at
	527	L<"http://h71000.www7.hp.com/doc/731FINAL/4506/4506pro_014.html#apps_locating_naming_files">.
	528
cbc7acb0	529	=cut
	530
	531	1;