File Coverage

blib/lib/IPC/ShellCmd/Generic.pm

Criterion	Covered	Total	%
statement	9	23	39.1
branch	0	4	0.0
condition			n/a
subroutine	3	5	60.0
pod	1	2	50.0
total	13	34	38.2

package IPC::ShellCmd::Generic;

use strict;
use Carp qw(croak);
use base qw(IPC::ShellCmd::ShBase);

=head1 NAME

  IPC::ShellCmd::Generic - Chain a generic wrapper-type command

=head1 SYNOPSIS

    $cmd_obj->chain_prog(
        IPC::ShellCmd::Generic->new(
	        Prog => 'time',
			Args => ["-p"],
        )
    );


=head1 DESCRIPTION

=head2 IPC::ShellCmd::Generic->B(Prog => I<$prog>, [I<$opt> => I<$val>, ...])

The only external method for this is the constructor. This sets up the
various arguments that are going to be used to generate the command-line.

Other methods on this are used by L, but it should only ever be
used inside of the B method on a L object.

=over 4

=item B I

The program to run, eg. tsocks, socksify, time

=item B

A set of arguments to the program before passing the command and args

=back

=cut

sub new {
    my $package = shift;
    my %args = @_;

    croak "Must specify a Prog argument"
        unless defined $args{Prog};

    my $self = bless { args => \%args }, $package;

    return $self;
}

sub chain {
    my $self = shift;
    my $cmd = shift;
    my $args = shift;

    my $cmd_string = $self->generate_sh_cmd($cmd, $args);

    my @generic = ($self->{args}->{Prog});

    push (@generic, @{$self->{args}->{Args}})
	    if(defined $self->{args}->{Args});

    push (@generic, "sh", "-c", $cmd_string);

    return @generic;
}

=head1 BUGS

I don't know of any, but that doesn't mean they're not there.

=head1 AUTHORS

See L for authors.

=head1 LICENSE

See L for the license.

=cut

1;