This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Upgrade to ExtUtils::Command 1.15
[perl5.git] / lib / ExtUtils / Command.pm
index 829de16..63fbfd6 100644 (file)
@@ -8,12 +8,15 @@ 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.04';
+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 test_d chmod
+                dos2unix);
+$VERSION = '1.15';
+
+my $Is_VMS   = $^O eq 'VMS';
+my $Is_Win32 = $^O eq 'MSWin32';
 
-my $Is_VMS = $^O eq 'VMS';
 
 =head1 NAME
 
@@ -25,27 +28,34 @@ ExtUtils::Command - utilities to replace common UNIX commands in Makefiles etc.
   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_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 chmod mode files...
   perl -MExtUtils::Command -e test_f file
+  perl -MExtUtils::Command -e test_d directory
+  perl -MExtUtils::Command -e chmod mode files...
+  ...
 
 =head1 DESCRIPTION
 
 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.
+them easier to deal with in Makefiles.  Call them like this:
 
   perl -MExtUtils::Command -e some_command some files to work on
 
-I<NOT>
+and I<NOT> like this:
 
   perl -MExtUtils::Command -e 'some_command qw(some files to work on)'
 
+For that use L<Shell::Command>.
+
 Filenames with * and ? will be glob expanded.
 
+
+=head2 FUNCTIONS
+
 =over 4
 
 =cut
@@ -57,7 +67,10 @@ sub expand_wildcards
  @ARGV = map(/[$wild_regex]/o ? glob($_) : $_,@ARGV);
 }
 
-=item cat 
+
+=item cat
+
+    cat file ...
 
 Concatenates all files mentioned on command line to STDOUT.
 
@@ -69,23 +82,26 @@ sub cat ()
  print while (<>);
 }
 
-=item eqtime src dst
+=item eqtime
 
-Sets modified time of dst to that of src
+    eqtime source destination
+
+Sets modified time of destination to that of source.
 
 =cut 
 
 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_rf files....
+=item rm_rf
+
+    rm_rf files or directories ...
 
-Removes directories - recursively (even if readonly)
+Removes files and directories - recursively (even if readonly)
 
 =cut 
 
@@ -95,98 +111,151 @@ sub rm_rf
  rmtree([grep -e $_,@ARGV],0,0);
 }
 
-=item rm_f files....
+=item rm_f
+
+    rm_f file ...
 
 Removes files (even if readonly)
 
 =cut 
 
-sub rm_f
-{
- expand_wildcards();
- foreach (@ARGV)
-  {
-   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 ...
+
+=item touch
+
+    touch file ...
 
 Makes files exist, with current timestamp 
 
 =cut 
 
-sub touch
-{
- my $t    = time;
- expand_wildcards();
- while (@ARGV)
-  {
-   my $file = shift(@ARGV);
-   open(FILE,">>$file") || die "Cannot write $file:$!";
-   close(FILE);
-   utime($t,$t,$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
+=item mv
 
-Moves source to destination.
-Multiple sources are allowed if destination is an existing directory.
+    mv source_file destination_file
+    mv source_file source_file destination_dir
+
+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
+=item cp
+
+    cp source_file destination_file
+    cp source_file source_file destination_dir
 
-Copies source to destination.
-Multiple sources are allowed if destination is an existing directory.
+Copies sources to the destination.  Multiple sources are allowed if
+destination is an existing directory.
+
+Returns true if all copies succeeded, false otherwise.
 
 =cut
 
-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);
-  }
+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);
+
+        # Win32 does not update the mod time of a copied file, just the
+        # created time which make does not look at.
+        utime(time, time, $dst) if $Is_Win32;
+    }
+    return $nok;
 }
 
-=item chmod mode files...
+=item chmod
 
-Sets UNIX like permissions 'mode' on all the files.
+    chmod mode files ...
+
+Sets UNIX like permissions 'mode' on all the files.  e.g. 0666
 
 =cut 
 
-sub chmod
-{
- my $mode = shift(@ARGV);
- expand_wildcards();
- chmod($mode,@ARGV) || 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...
+=item mkpath
+
+    mkpath directory ...
 
-Creates directory, including any parent directories.
+Creates directories, including any parent directories.
 
 =cut 
 
@@ -196,34 +265,82 @@ sub mkpath
  File::Path::mkpath([@ARGV],0,0777);
 }
 
-=item test_f file
+=item test_f
+
+    test_f file
 
-Tests if a file exists
+Tests if a file exists.  I<Exits> with 0 if it does, 1 if it does not (ie.
+shell's idea of true and false).
 
 =cut 
 
 sub test_f
 {
- exit !-f shift(@ARGV);
+ exit(-f $ARGV[0] ? 0 : 1);
 }
 
+=item test_d
 
-1;
-__END__ 
+    test_d directory
 
-=back
+Tests if a directory exists.  I<Exits> with 0 if it does, 1 if it does
+not (ie. shell's idea of true and false).
+
+=cut
+
+sub test_d
+{
+ exit(-d $ARGV[0] ? 0 : 1);
+}
 
-=head1 BUGS
+=item dos2unix
 
-Should probably be Auto/Self loaded.
+    dos2unix files or dirs ...
 
-=head1 SEE ALSO 
+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
+
+=head1 SEE ALSO
+
+Shell::Command which is these same functions but take arguments normally.
 
-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>
+
+Maintained by Michael G Schwern C<schwern@pobox.com> within the
+ExtUtils-MakeMaker package and, as a separate CPAN package, by
+Randy Kobes C<r.kobes@uwinnipeg.ca>.
 
 =cut