Git.pm: Implement options for the command interface

This gives the user a way to easily pass options to the command routines.
Currently only the STDERR option is implemented and can be used to adjust
what shall be done with error output of the called command (most usefully,
it can be used to silence it).

Signed-off-by: Petr Baudis <pasky@suse.cz>
Signed-off-by: Junio C Hamano <junkio@cox.net>

diff --git a/perl/Git.pm b/perl/Git.pm
index 11ec62d4068f6ca19c24166273f3ad025fe2506e..e2b66c461923934deef2bf096279c255dcf0c68e 100644 (file)
--- a/perl/Git.pm
+++ b/perl/Git.pm
@@ -36,7 +36,8 @@ =head1 SYNOPSIS
   my $lastrev = <$fh>; chomp $lastrev;
   $repo->command_close_pipe($fh, $c);
 
   my $lastrev = <$fh>; chomp $lastrev;
   $repo->command_close_pipe($fh, $c);
 

-  my $lastrev = $repo->command_oneline('rev-list', '--all');
+  my $lastrev = $repo->command_oneline( [ 'rev-list', '--all' ],
+                                        STDERR => 0 );

 
 =cut
 
 
 =cut
 


@@ -178,9 +179,21 @@ =head1 METHODS
 
 =item command ( COMMAND [, ARGUMENTS... ] )
 
 
 =item command ( COMMAND [, ARGUMENTS... ] )
 

+=item command ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } )
+

 Execute the given Git C<COMMAND> (specify it without the 'git-'
 prefix), optionally with the specified extra C<ARGUMENTS>.
 
 Execute the given Git C<COMMAND> (specify it without the 'git-'
 prefix), optionally with the specified extra C<ARGUMENTS>.
 

+The second more elaborate form can be used if you want to further adjust
+the command execution. Currently, only one option is supported:
+
+B<STDERR> - How to deal with the command's error output. By default (C<undef>)
+it is delivered to the caller's C<STDERR>. A false value (0 or '') will cause
+it to be thrown away. If you want to process it, you can get it in a filehandle
+you specify, but you must be extremely careful; if the error output is not
+very short and you want to read it in the same process as where you called
+C<command()>, you are set up for a nice deadlock!
+

 The method can be called without any instance or on a specified Git repository
 (in that case the command will be run in the repository context).
 
 The method can be called without any instance or on a specified Git repository
 (in that case the command will be run in the repository context).
 


@@ -231,6 +244,8 @@ sub command {
 
 =item command_oneline ( COMMAND [, ARGUMENTS... ] )
 
 
 =item command_oneline ( COMMAND [, ARGUMENTS... ] )
 

+=item command_oneline ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } )
+

 Execute the given C<COMMAND> in the same way as command()
 does but always return a scalar string containing the first line
 of the command's standard output.
 Execute the given C<COMMAND> in the same way as command()
 does but always return a scalar string containing the first line
 of the command's standard output.


@@ -256,6 +271,8 @@ sub command_oneline {
 
 =item command_output_pipe ( COMMAND [, ARGUMENTS... ] )
 
 
 =item command_output_pipe ( COMMAND [, ARGUMENTS... ] )
 

+=item command_output_pipe ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } )
+

 Execute the given C<COMMAND> in the same way as command()
 does but return a pipe filehandle from which the command output can be
 read.
 Execute the given C<COMMAND> in the same way as command()
 does but return a pipe filehandle from which the command output can be
 read.


@@ -272,6 +289,8 @@ sub command_output_pipe {
 
 =item command_input_pipe ( COMMAND [, ARGUMENTS... ] )
 
 
 =item command_input_pipe ( COMMAND [, ARGUMENTS... ] )
 

+=item command_input_pipe ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } )
+

 Execute the given C<COMMAND> in the same way as command_output_pipe()
 does but return an input pipe filehandle instead; the command output
 is not captured.
 Execute the given C<COMMAND> in the same way as command_output_pipe()
 does but return an input pipe filehandle instead; the command output
 is not captured.


@@ -534,13 +553,27 @@ sub _check_valid_cmd {
 # Common backend for the pipe creators.
 sub _command_common_pipe {
        my $direction = shift;
 # Common backend for the pipe creators.
 sub _command_common_pipe {
        my $direction = shift;

-       my ($self, $cmd, @args) = _maybe_self(@_);
+       my ($self, @p) = _maybe_self(@_);
+       my (%opts, $cmd, @args);
+       if (ref $p[0]) {
+               ($cmd, @args) = @{shift @p};
+               %opts = ref $p[0] ? %{$p[0]} : @p;
+       } else {
+               ($cmd, @args) = @p;
+       }

        _check_valid_cmd($cmd);
 
        my $pid = open(my $fh, $direction);
        if (not defined $pid) {
                throw Error::Simple("open failed: $!");
        } elsif ($pid == 0) {
        _check_valid_cmd($cmd);
 
        my $pid = open(my $fh, $direction);
        if (not defined $pid) {
                throw Error::Simple("open failed: $!");
        } elsif ($pid == 0) {

+               if (defined $opts{STDERR}) {
+                       close STDERR;
+               }
+               if ($opts{STDERR}) {
+                       open (STDERR, '>&', $opts{STDERR})
+                               or die "dup failed: $!";
+               }

                _cmd_exec($self, $cmd, @args);
        }
        return wantarray ? ($fh, join(' ', $cmd, @args)) : $fh;
                _cmd_exec($self, $cmd, @args);
        }
        return wantarray ? ($fh, join(' ', $cmd, @args)) : $fh;