<!-- GENERATED by docs/sphinx/bin/20-reference (p5) from reference/bundled/TAP/Parser/SourceHandler/Perl.md. Do not edit. -->

```{index} single: TAP::Parser::SourceHandler::Perl
```

# TAP::Parser::SourceHandler::Perl

Stream TAP from a Perl executable

## VERSION

Version 3.52

## SYNOPSIS

```perl
use TAP::Parser::Source;
use TAP::Parser::SourceHandler::Perl;

my $source = TAP::Parser::Source->new->raw( \'script.pl' );
$source->assemble_meta;

my $class = 'TAP::Parser::SourceHandler::Perl';
my $vote  = $class->can_handle( $source );
my $iter  = $class->make_iterator( $source );
```

## DESCRIPTION

This is a _Perl_ [TAP::Parser::SourceHandler](../SourceHandler.md) - it has 2 jobs:

1\. Figure out if the [TAP::Parser::Source](../Source.md) it's given is actually a Perl
script ("can\_handle").

2\. Creates an iterator for Perl sources ("make\_iterator").

Unless you're writing a plugin or subclassing [TAP::Parser](../../Parser.md), you probably
won't need to use this module directly.

## METHODS

### Class Methods

#### `can_handle`

```perl
my $vote = $class->can_handle( $source );
```

Only votes if $source looks like a file.  Casts the following votes:

```text
0.9  if it has a shebang ala "#!...perl"
0.3  if it has any shebang
0.8  if it's a .t file
0.9  if it's a .pl file
0.75 if it's in a 't' directory
0.25 by default (backwards compat)
```

#### `make_iterator`

```perl
my $iterator = $class->make_iterator( $source );
```

Constructs & returns a new [TAP::Parser::Iterator::Process](../Iterator/Process.md) for the source.
Assumes `$source->raw` contains a reference to the perl script.  `croak`s
if the file could not be found.

The command to run is built as follows:

```perl
$perl @switches $perl_script @test_args
```

The perl command to use is determined by "get\_perl".  The command generated
is guaranteed to preserve:

```text
PERL5LIB
PERL5OPT
Taint Mode, if set in the script's shebang
```

_Note:_ the command generated will _not_ respect any shebang line defined in
your Perl script.  This is only a problem if you have compiled a custom version
of Perl or if you want to use a specific version of Perl for one test and a
different version for another, for example:

```perl
#!/path/to/a/custom_perl --some --args
#!/usr/local/perl-5.6/bin/perl -w
```

Currently you need to write a plugin to get around this.

#### `get_taint`

Decode any taint switches from a Perl shebang line.

```perl
## $taint will be 't'
my $taint = TAP::Parser::SourceHandler::Perl->get_taint( '#!/usr/bin/perl -t' );

## $untaint will be undefined
my $untaint = TAP::Parser::SourceHandler::Perl->get_taint( '#!/usr/bin/perl' );
```

#### `get_perl`

Gets the version of Perl currently running the test suite.

## SUBCLASSING

Please see ["SUBCLASSING" in TAP::Parser](../../Parser.md) for a subclassing overview.

### Example

```perl
package MyPerlSourceHandler;

use strict;

use TAP::Parser::SourceHandler::Perl;

use base 'TAP::Parser::SourceHandler::Perl';

## use the version of perl from the shebang line in the test file
sub get_perl {
    my $self = shift;
    if (my $shebang = $self->shebang( $self->{file} )) {
        $shebang =~ /^#!(.*\bperl.*?)(?:(?:\s)|(?:$))/;
        return $1 if $1;
    }
    return $self->SUPER::get_perl(@_);
}
```

## SEE ALSO

[TAP::Object](../../Object.md),
[TAP::Parser](../../Parser.md),
[TAP::Parser::IteratorFactory](../IteratorFactory.md),
[TAP::Parser::SourceHandler](../SourceHandler.md),
[TAP::Parser::SourceHandler::Executable](Executable.md),
[TAP::Parser::SourceHandler::File](File.md),
[TAP::Parser::SourceHandler::Handle](Handle.md),
[TAP::Parser::SourceHandler::RawTAP](RawTAP.md)