More consistent names for all the parameter name/declaration methods
[p5sagit/p5-mst-13.2.git] / lib / ExtUtils / Command.pm
index bdf32d4..3be5a8e 100644 (file)
@@ -1,16 +1,20 @@
 package ExtUtils::Command;
+
+use 5.00503;
 use strict;
-# use AutoLoader;
 use Carp;
 use File::Copy;
 use File::Compare;
 use File::Basename;
 use File::Path qw(rmtree);
 require Exporter;
-use vars qw(@ISA @EXPORT $VERSION);
-@ISA     = qw(Exporter);
-@EXPORT  = qw(cp rm_f rm_rf mv cat eqtime mkpath touch test_f);
-$VERSION = '1.00';
+use vars qw(@ISA @EXPORT @EXPORT_OK $VERSION);
+@ISA       = qw(Exporter);
+@EXPORT    = qw(cp rm_f rm_rf mv cat eqtime mkpath touch test_f chmod 
+                dos2unix);
+$VERSION = '1.07';
+
+my $Is_VMS = $^O eq 'VMS';
 
 =head1 NAME
 
@@ -18,31 +22,44 @@ ExtUtils::Command - utilities to replace common UNIX commands in Makefiles etc.
 
 =head1 SYNOPSIS
 
-  perl -MExtUtils::command -e cat files... > destination
-  perl -MExtUtils::command -e mv source... destination
-  perl -MExtUtils::command -e cp source... destination
-  perl -MExtUtils::command -e touch files...
-  perl -MExtUtils::command -e rm_f file...
-  perl -MExtUtils::command -e rm_rf directories...
-  perl -MExtUtils::command -e mkpath directories...
-  perl -MExtUtils::command -e eqtime source destination
-  perl -MExtUtils::command -e chmod mode files...
-  perl -MExtUtils::command -e test_f file
+  perl -MExtUtils::Command       -e cat files... > destination
+  perl -MExtUtils::Command       -e mv source... destination
+  perl -MExtUtils::Command       -e cp source... destination
+  perl -MExtUtils::Command       -e touch files...
+  perl -MExtUtils::Command       -e rm_f files...
+  perl -MExtUtils::Command       -e rm_rf directories...
+  perl -MExtUtils::Command       -e mkpath directories...
+  perl -MExtUtils::Command       -e eqtime source destination
+  perl -MExtUtils::Command       -e test_f file
+  perl -MExtUtils::Command       -e chmod mode files...
+  ...
 
 =head1 DESCRIPTION
 
-The module is used in Win32 port to replace common UNIX commands.
-Most commands are wrapers on generic modules File::Path and File::Basename.
+The module is used to replace common UNIX commands.  In all cases the
+functions work from @ARGV rather than taking arguments.  This makes
+them easier to deal with in Makefiles.
+
+  perl -MExtUtils::Command -e some_command some files to work on
+
+I<NOT>
+
+  perl -MExtUtils::Command -e 'some_command qw(some files to work on)'
+
+Filenames with * and ? will be glob expanded.
 
 =over 4
 
 =cut
 
+# VMS uses % instead of ? to mean "one character"
+my $wild_regex = $Is_VMS ? '*%' : '*?';
 sub expand_wildcards
 {
- @ARGV = map(/[\*\?]/ ? glob($_) : $_,@ARGV);
+ @ARGV = map(/[$wild_regex]/o ? glob($_) : $_,@ARGV);
 }
 
+
 =item cat 
 
 Concatenates all files mentioned on command line to STDOUT.
@@ -64,12 +81,11 @@ Sets modified time of dst to that of src
 sub eqtime
 {
  my ($src,$dst) = @ARGV;
- open(F,">$dst");
- close(F);
+ local @ARGV = ($dst);  touch();  # in case $dst doesn't exist
  utime((stat($src))[8,9],$dst);
 }
 
-=item rm_f files....
+=item rm_rf files....
 
 Removes directories - recursively (even if readonly)
 
@@ -77,7 +93,8 @@ Removes directories - recursively (even if readonly)
 
 sub rm_rf
 {
- rmtree([grep -e $_,expand_wildcards()],0,0);
+ expand_wildcards();
+ rmtree([grep -e $_,@ARGV],0,0);
 }
 
 =item rm_f files....
@@ -86,83 +103,122 @@ Removes files (even if readonly)
 
 =cut 
 
-sub rm_f
-{
- foreach (expand_wildcards())
-  {
-   next unless -f $_;        
-   next if unlink($_);
-   chmod(0777,$_);           
-   next if unlink($_);
-   carp "Cannot delete $_:$!";
-  }
+sub rm_f {
+    expand_wildcards();
+
+    foreach my $file (@ARGV) {
+        next unless -f $file;
+
+        next if _unlink($file);
+
+        chmod(0777, $file);
+
+        next if _unlink($file);
+            
+        carp "Cannot delete $file: $!";
+    }
 }
 
+sub _unlink {
+    my $files_unlinked = 0;
+    foreach my $file (@_) {
+        my $delete_count = 0;
+        $delete_count++ while unlink $file;
+        $files_unlinked++ if $delete_count;
+    }
+    return $files_unlinked;
+}
+
+
 =item touch files ...
 
 Makes files exist, with current timestamp 
 
 =cut 
 
-sub touch
-{
- expand_wildcards();
- while (@ARGV)
-  {
-   my $file = shift(@ARGV);               
-   open(FILE,">>$file") || die "Cannot write $file:$!";
-   close(FILE);
-  }
+sub touch {
+    my $t    = time;
+    expand_wildcards();
+    foreach my $file (@ARGV) {
+        open(FILE,">>$file") || die "Cannot write $file:$!";
+        close(FILE);
+        utime($t,$t,$file);
+    }
 }
 
 =item mv source... destination
 
-Moves source to destination.
-Multiple sources are allowed if destination is an existing directory.
+Moves source to destination.  Multiple sources are allowed if
+destination is an existing directory.
+
+Returns true if all moves succeeded, false otherwise.
 
 =cut 
 
-sub mv
-{
- my $dst = pop(@ARGV);
- expand_wildcards();
- croak("Too many arguments") if (@ARGV > 1 && ! -d $dst);
- while (@ARGV)
-  {
-   my $src = shift(@ARGV);               
-   move($src,$dst);
-  }
+sub mv {
+    expand_wildcards();
+    my @src = @ARGV;
+    my $dst = pop @src;
+
+    croak("Too many arguments") if (@src > 1 && ! -d $dst);
+
+    my $nok = 0;
+    foreach my $src (@src) {
+        $nok ||= !move($src,$dst);
+    }
+    return !$nok;
 }
 
 =item cp source... destination
 
-Copies source to destination.
-Multiple sources are allowed if destination is an existing directory.
+Copies source to destination.  Multiple sources are allowed if
+destination is an existing directory.
 
-=cut 
+Returns true if all copies succeeded, false otherwise.
 
-sub cp
-{
- my $dst = pop(@ARGV);
- expand_wildcards();
- croak("Too many arguments") if (@ARGV > 1 && ! -d $dst);
- while (@ARGV)
-  {
-   my $src = shift(@ARGV);               
-   copy($src,$dst);
-  }
+=cut
+
+sub cp {
+    expand_wildcards();
+    my @src = @ARGV;
+    my $dst = pop @src;
+
+    croak("Too many arguments") if (@src > 1 && ! -d $dst);
+
+    my $nok = 0;
+    foreach my $src (@src) {
+        $nok ||= !copy($src,$dst);
+    }
+    return $nok;
 }
 
 =item chmod mode files...
 
-Sets UNIX like permissions 'mode' on all the files.
+Sets UNIX like permissions 'mode' on all the files.  e.g. 0666
 
 =cut 
 
-sub chmod
-{
- my $mode = shift(@ARGV);
- chmod($mode,expand_wildcards()) || die "Cannot chmod ".join(' ',$mode,@ARGV).":$!";
+sub chmod {
+    local @ARGV = @ARGV;
+    my $mode = shift(@ARGV);
+    expand_wildcards();
+
+    if( $Is_VMS ) {
+        foreach my $idx (0..$#ARGV) {
+            my $path = $ARGV[$idx];
+            next unless -d $path;
+
+            # chmod 0777, [.foo.bar] doesn't work on VMS, you have to do
+            # chmod 0777, [.foo]bar.dir
+            my @dirs = File::Spec->splitdir( $path );
+            $dirs[-1] .= '.dir';
+            $path = File::Spec->catfile(@dirs);
+
+            $ARGV[$idx] = $path;
+        }
+    }
+
+    chmod(oct $mode,@ARGV) || die "Cannot chmod ".join(' ',$mode,@ARGV).":$!";
 }
 
 =item mkpath directory...
@@ -173,7 +229,8 @@ Creates directory, including any parent directories.
 
 sub mkpath
 {
- File::Path::mkpath([expand_wildcards()],1,0777);
+ expand_wildcards();
+ File::Path::mkpath([@ARGV],0,0777);
 }
 
 =item test_f file
@@ -184,11 +241,40 @@ Tests if a file exists
 
 sub test_f
 {
- exit !-f shift(@ARGV);
+ exit !-f $ARGV[0];
 }
 
-1;
-__END__ 
+=item dos2unix
+
+Converts DOS and OS/2 linefeeds to Unix style recursively.
+
+=cut
+
+sub dos2unix {
+    require File::Find;
+    File::Find::find(sub {
+        return if -d;
+        return unless -w _;
+        return unless -r _;
+        return if -B _;
+
+        local $\;
+
+       my $orig = $_;
+       my $temp = '.dos2unix_tmp';
+       open ORIG, $_ or do { warn "dos2unix can't open $_: $!"; return };
+       open TEMP, ">$temp" or 
+           do { warn "dos2unix can't create .dos2unix_tmp: $!"; return };
+        while (my $line = <ORIG>) { 
+            $line =~ s/\015\012/\012/g;
+            print TEMP $line;
+        }
+       close ORIG;
+       close TEMP;
+       rename $temp, $orig;
+
+    }, @ARGV);
+}
 
 =back
 
@@ -202,7 +288,9 @@ ExtUtils::MakeMaker, ExtUtils::MM_Unix, ExtUtils::MM_Win32
 
 =head1 AUTHOR
 
-Nick Ing-Simmons <F<nick@ni-s.u-net.com>>.
+Nick Ing-Simmons C<ni-s@cpan.org>
+
+Currently maintained by Michael G Schwern C<schwern@pobox.com>.
 
 =cut