5.005_03-MAINT_TRIAL_5 utils/h2xs fixing -A & more
[p5sagit/p5-mst-13.2.git] / lib / IPC / Open3.pm
index 5d85458..d079041 100644 (file)
@@ -2,15 +2,15 @@ package IPC::Open3;
 
 use strict;
 no strict 'refs'; # because users pass me bareword filehandles
-use vars qw($VERSION @ISA @EXPORT $Fh $Me);
+use vars qw($VERSION @ISA @EXPORT $Me);
 
 require 5.001;
 require Exporter;
 
 use Carp;
-use Symbol 'qualify';
+use Symbol qw(gensym qualify);
 
-$VERSION       = 1.01;
+$VERSION       = 1.0103;
 @ISA           = qw(Exporter);
 @EXPORT                = qw(open3);
 
@@ -20,7 +20,7 @@ IPC::Open3, open3 - open a process for reading, writing, and error handling
 
 =head1 SYNOPSIS
 
-    $pid = open3(\*WTRFH, \*RDRFH, \*ERRFH
+    $pid = open3(\*WTRFH, \*RDRFH, \*ERRFH,
                    'some cmd and args', 'optarg', ...);
 
 =head1 DESCRIPTION
@@ -28,12 +28,12 @@ IPC::Open3, open3 - open a process for reading, writing, and error handling
 Extremely similar to open2(), open3() spawns the given $cmd and
 connects RDRFH for reading, WTRFH for writing, and ERRFH for errors.  If
 ERRFH is '', or the same as RDRFH, then STDOUT and STDERR of the child are
-on the same file handle.
+on the same file handle.  The WTRFH will have autoflush turned on.
 
 If WTRFH begins with "E<lt>&", then WTRFH will be closed in the parent, and
 the child will read from it directly.  If RDRFH or ERRFH begins with
-"E<gt>&", then the child will send output directly to that file handle.  In both
-cases, there will be a dup(2) instead of a pipe(2) made.
+"E<gt>&", then the child will send output directly to that file handle.
+In both cases, there will be a dup(2) instead of a pipe(2) made.
 
 If you try to read from the child's stdout writer and their stderr
 writer, you'll have problems with blocking, which means you'll
@@ -57,7 +57,7 @@ time.  Programs like B<sort> that read their entire input stream first,
 however, are quite apt to cause deadlock.
 
 The big problem with this approach is that if you don't have control
-over source code being run in the the child process, you can't control
+over source code being run in the child process, you can't control
 what it does with pipe buffering.  Thus you can't just open a pipe to
 C<cat -v> and continually read and write a line from it.
 
@@ -66,6 +66,7 @@ C<cat -v> and continually read and write a line from it.
 # &open3: Marc Horowitz <marc@mit.edu>
 # derived mostly from &open2 by tom christiansen, <tchrist@convex.com>
 # fixed for 5.001 by Ulrich Kunitz <kunitz@mai-koeln.com>
+# ported to Win32 by Ron Schmidt, Merrill Lynch almost ended my career
 #
 # $Id: open3.pl,v 1.1 1993/11/23 06:26:15 marc Exp $
 #
@@ -93,7 +94,6 @@ C<cat -v> and continually read and write a line from it.
 #   rdr or wtr are null
 #   a system call fails
 
-$Fh = 'FHOPEN000';     # package static in case called more than once
 $Me = 'open3 (bug)';   # you should never see this, it's always localized
 
 # Fatal.pm needs to be fixed WRT prototypes.
@@ -119,6 +119,8 @@ sub xclose {
     close $_[0] or croak "$Me: close($_[0]) failed: $!";
 }
 
+my $do_spawn = $^O eq 'os2' || $^O eq 'MSWin32';
+
 sub _open3 {
     local $Me = shift;
     my($package, $dad_wtr, $dad_rdr, $dad_err, @cmd) = @_;
@@ -137,51 +139,95 @@ sub _open3 {
     $dad_rdr = qualify $dad_rdr, $package;
     $dad_err = qualify $dad_err, $package;
 
-    my $kid_rdr = ++$Fh;
-    my $kid_wtr = ++$Fh;
-    my $kid_err = ++$Fh;
+    my $kid_rdr = gensym;
+    my $kid_wtr = gensym;
+    my $kid_err = gensym;
 
     xpipe $kid_rdr, $dad_wtr if !$dup_wtr;
     xpipe $dad_rdr, $kid_wtr if !$dup_rdr;
     xpipe $dad_err, $kid_err if !$dup_err && $dad_err ne $dad_rdr;
 
-    $kidpid = xfork;
-    if ($kidpid == 0) {
+    $kidpid = $do_spawn ? -1 : xfork;
+    if ($kidpid == 0) {                # Kid
        # If she wants to dup the kid's stderr onto her stdout I need to
        # save a copy of her stdout before I put something else there.
        if ($dad_rdr ne $dad_err && $dup_err
                && fileno($dad_err) == fileno(STDOUT)) {
-           my $tmp = ++$Fh;
+           my $tmp = gensym;
            xopen($tmp, ">&$dad_err");
            $dad_err = $tmp;
        }
 
        if ($dup_wtr) {
-           open(STDIN,  "<&$dad_wtr") if (fileno(STDIN) != fileno($dad_wtr));
+           xopen \*STDIN,  "<&$dad_wtr" if fileno(STDIN) != fileno($dad_wtr);
        } else {
-           close($dad_wtr);
-           open(STDIN,  "<&$kid_rdr");
+           xclose $dad_wtr;
+           xopen \*STDIN,  "<&=" . fileno $kid_rdr;
        }
        if ($dup_rdr) {
-           open(STDOUT, ">&$dad_rdr") if (fileno(STDOUT) != fileno($dad_rdr));
+           xopen \*STDOUT, ">&$dad_rdr" if fileno(STDOUT) != fileno($dad_rdr);
        } else {
-           close($dad_rdr);
-           open(STDOUT, ">&$kid_wtr");
+           xclose $dad_rdr;
+           xopen \*STDOUT, ">&=" . fileno $kid_wtr;
        }
        if ($dad_rdr ne $dad_err) {
            if ($dup_err) {
-               open(STDERR, ">&$dad_err")
-                   if (fileno(STDERR) != fileno($dad_err));
+               # I have to use a fileno here because in this one case
+               # I'm doing a dup but the filehandle might be a reference
+               # (from the special case above).
+               xopen \*STDERR, ">&" . fileno $dad_err
+                   if fileno(STDERR) != fileno($dad_err);
            } else {
-               close($dad_err);
-               open(STDERR, ">&$kid_err");
+               xclose $dad_err;
+               xopen \*STDERR, ">&=" . fileno $kid_err;
            }
        } else {
-           open(STDERR, ">&STDOUT") if (fileno(STDERR) != fileno(STDOUT));
+           xopen \*STDERR, ">&STDOUT" if fileno(STDERR) != fileno(STDOUT);
        }
        local($")=(" ");
        exec @cmd
-           or croak "open3: exec of @cmd failed";
+           or croak "$Me: exec of @cmd failed";
+    } elsif ($do_spawn) {
+       # All the bookkeeping of coincidence between handles is
+       # handled in spawn_with_handles.
+
+       my @close;
+       if ($dup_wtr) {
+         $kid_rdr = \*{$dad_wtr};
+         push @close, $kid_rdr;
+       } else {
+         push @close, \*{$dad_wtr}, $kid_rdr;
+       }
+       if ($dup_rdr) {
+         $kid_wtr = \*{$dad_rdr};
+         push @close, $kid_wtr;
+       } else {
+         push @close, \*{$dad_rdr}, $kid_wtr;
+       }
+       if ($dad_rdr ne $dad_err) {
+           if ($dup_err) {
+             $kid_err = \*{$dad_err};
+             push @close, $kid_err;
+           } else {
+             push @close, \*{$dad_err}, $kid_err;
+           }
+       } else {
+         $kid_err = $kid_wtr;
+       }
+       require IO::Pipe;
+       $kidpid = eval {
+           spawn_with_handles( [ { mode => 'r',
+                                   open_as => $kid_rdr,
+                                   handle => \*STDIN },
+                                 { mode => 'w',
+                                   open_as => $kid_wtr,
+                                   handle => \*STDOUT },
+                                 { mode => 'w',
+                                   open_as => $kid_err,
+                                   handle => \*STDERR },
+                               ], \@close, @cmd);
+       };
+       die "$Me: $@" if $@;
     }
 
     xclose $kid_rdr if !$dup_wtr;
@@ -196,7 +242,50 @@ sub _open3 {
 }
 
 sub open3 {
+    if (@_ < 4) {
+       local $" = ', ';
+       croak "open3(@_): not enough arguments";
+    }
     return _open3 'open3', scalar caller, @_
 }
-1; # so require is happy
 
+sub spawn_with_handles {
+    my $fds = shift;           # Fields: handle, mode, open_as
+    my $close_in_child = shift;
+    my ($fd, $pid, @saved_fh, $saved, %saved, @errs);
+    require Fcntl;
+
+    foreach $fd (@$fds) {
+       $fd->{tmp_copy} = IO::Handle->new_from_fd($fd->{handle}, $fd->{mode});
+       $saved{fileno $fd->{handle}} = $fd->{tmp_copy};
+    }
+    foreach $fd (@$fds) {
+       bless $fd->{handle}, 'IO::Handle'
+           unless eval { $fd->{handle}->isa('IO::Handle') } ;
+       # If some of handles to redirect-to coincide with handles to
+       # redirect, we need to use saved variants:
+       $fd->{handle}->fdopen($saved{fileno $fd->{open_as}} || $fd->{open_as},
+                             $fd->{mode});
+    }
+    unless ($^O eq 'MSWin32') {
+       # Stderr may be redirected below, so we save the err text:
+       foreach $fd (@$close_in_child) {
+           fcntl($fd, Fcntl::F_SETFD(), 1) or push @errs, "fcntl $fd: $!"
+               unless $saved{fileno $fd}; # Do not close what we redirect!
+       }
+    }
+
+    unless (@errs) {
+       $pid = eval { system 1, @_ }; # 1 == P_NOWAIT
+       push @errs, "IO::Pipe: Can't spawn-NOWAIT: $!" if !$pid || $pid < 0;
+    }
+
+    foreach $fd (@$fds) {
+       $fd->{handle}->fdopen($fd->{tmp_copy}, $fd->{mode});
+       $fd->{tmp_copy}->close or croak "Can't close: $!";
+    }
+    croak join "\n", @errs if @errs;
+    return $pid;
+}
+
+1; # so require is happy