| Current Path : /proc/2/cwd/usr/share/man/man3/ |
| Current File : //proc/2/cwd/usr/share/man/man3/TAP::Parser::Source.3pm |
.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.13)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.el \{\
. de IX
..
.\}
.\" ========================================================================
.\"
.IX Title "TAP::Parser::Source 3"
.TH TAP::Parser::Source 3 "2018-03-19" "perl v5.10.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
TAP::Parser::Source \- a TAP source & meta data about it
.SH "VERSION"
.IX Header "VERSION"
Version 3.42
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 8
\& use TAP::Parser::Source;
\& my $source = TAP::Parser::Source\->new;
\& $source\->raw( \e\*(Aqreference to raw TAP source\*(Aq )
\& \->config( \e%config )
\& \->merge( $boolean )
\& \->switches( \e@switches )
\& \->test_args( \e@args )
\& \->assemble_meta;
\&
\& do { ... } if $source\->meta\->{is_file};
\& # see assemble_meta for a full list of data available
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
A \s-1TAP\s0 \fIsource\fR is something that produces a stream of \s-1TAP\s0 for the parser to
consume, such as an executable file, a text file, an archive, an \s-1IO\s0 handle, a
database, etc. \f(CW\*(C`TAP::Parser::Source\*(C'\fRs encapsulate these \fIraw\fR sources, and
provide some useful meta data about them. They are used by
TAP::Parser::SourceHandlers, which do whatever is required to produce &
capture a stream of \s-1TAP\s0 from the \fIraw\fR source, and package it up in a
TAP::Parser::Iterator for the parser to consume.
.PP
Unless you're writing a new TAP::Parser::SourceHandler, a plugin or
subclassing TAP::Parser, you probably won't need to use this module directly.
.SH "METHODS"
.IX Header "METHODS"
.SS "Class Methods"
.IX Subsection "Class Methods"
\fI\f(CI\*(C`new\*(C'\fI\fR
.IX Subsection "new"
.PP
.Vb 1
\& my $source = TAP::Parser::Source\->new;
.Ve
.PP
Returns a new \f(CW\*(C`TAP::Parser::Source\*(C'\fR object.
.SS "Instance Methods"
.IX Subsection "Instance Methods"
\fI\f(CI\*(C`raw\*(C'\fI\fR
.IX Subsection "raw"
.PP
.Vb 2
\& my $raw = $source\->raw;
\& $source\->raw( $some_value );
.Ve
.PP
Chaining getter/setter for the raw \s-1TAP\s0 source. This is a reference, as it may
contain large amounts of data (eg: raw \s-1TAP\s0).
.PP
\fI\f(CI\*(C`meta\*(C'\fI\fR
.IX Subsection "meta"
.PP
.Vb 2
\& my $meta = $source\->meta;
\& $source\->meta({ %some_value });
.Ve
.PP
Chaining getter/setter for meta data about the source. This defaults to an
empty hashref. See \*(L"assemble_meta\*(R" for more info.
.PP
\fI\f(CI\*(C`has_meta\*(C'\fI\fR
.IX Subsection "has_meta"
.PP
True if the source has meta data.
.PP
\fI\f(CI\*(C`config\*(C'\fI\fR
.IX Subsection "config"
.PP
.Vb 2
\& my $config = $source\->config;
\& $source\->config({ %some_value });
.Ve
.PP
Chaining getter/setter for the source's configuration, if any has been provided
by the user. How it's used is up to you. This defaults to an empty hashref.
See \*(L"config_for\*(R" for more info.
.PP
\fI\f(CI\*(C`merge\*(C'\fI\fR
.IX Subsection "merge"
.PP
.Vb 2
\& my $merge = $source\->merge;
\& $source\->config( $bool );
.Ve
.PP
Chaining getter/setter for the flag that dictates whether \s-1STDOUT\s0 and \s-1STDERR\s0
should be merged (where appropriate). Defaults to undef.
.PP
\fI\f(CI\*(C`switches\*(C'\fI\fR
.IX Subsection "switches"
.PP
.Vb 2
\& my $switches = $source\->switches;
\& $source\->config([ @switches ]);
.Ve
.PP
Chaining getter/setter for the list of command-line switches that should be
passed to the source (where appropriate). Defaults to undef.
.PP
\fI\f(CI\*(C`test_args\*(C'\fI\fR
.IX Subsection "test_args"
.PP
.Vb 2
\& my $test_args = $source\->test_args;
\& $source\->config([ @test_args ]);
.Ve
.PP
Chaining getter/setter for the list of command-line arguments that should be
passed to the source (where appropriate). Defaults to undef.
.PP
\fI\f(CI\*(C`assemble_meta\*(C'\fI\fR
.IX Subsection "assemble_meta"
.PP
.Vb 1
\& my $meta = $source\->assemble_meta;
.Ve
.PP
Gathers meta data about the \*(L"raw\*(R" source, stashes it in \*(L"meta\*(R" and returns
it as a hashref. This is done so that the TAP::Parser::SourceHandlers don't
have to repeat common checks. Currently this includes:
.PP
.Vb 3
\& is_scalar => $bool,
\& is_hash => $bool,
\& is_array => $bool,
\&
\& # for scalars:
\& length => $n
\& has_newlines => $bool
\&
\& # only done if the scalar looks like a filename
\& is_file => $bool,
\& is_dir => $bool,
\& is_symlink => $bool,
\& file => {
\& # only done if the scalar looks like a filename
\& basename => $string, # including ext
\& dir => $string,
\& ext => $string,
\& lc_ext => $string,
\& # system checks
\& exists => $bool,
\& stat => [ ... ], # perldoc \-f stat
\& empty => $bool,
\& size => $n,
\& text => $bool,
\& binary => $bool,
\& read => $bool,
\& write => $bool,
\& execute => $bool,
\& setuid => $bool,
\& setgid => $bool,
\& sticky => $bool,
\& is_file => $bool,
\& is_dir => $bool,
\& is_symlink => $bool,
\& # only done if the file\*(Aqs a symlink
\& lstat => [ ... ], # perldoc \-f lstat
\& # only done if the file\*(Aqs a readable text file
\& shebang => $first_line,
\& }
\&
\& # for arrays:
\& size => $n,
.Ve
.PP
\fI\f(CI\*(C`shebang\*(C'\fI\fR
.IX Subsection "shebang"
.PP
Get the shebang line for a script file.
.PP
.Vb 1
\& my $shebang = TAP::Parser::Source\->shebang( $some_script );
.Ve
.PP
May be called as a class method
.PP
\fI\f(CI\*(C`config_for\*(C'\fI\fR
.IX Subsection "config_for"
.PP
.Vb 1
\& my $config = $source\->config_for( $class );
.Ve
.PP
Returns \*(L"config\*(R" for the \f(CW$class\fR given. Class names may be fully qualified
or abbreviated, eg:
.PP
.Vb 3
\& # these are equivalent
\& $source\->config_for( \*(AqPerl\*(Aq );
\& $source\->config_for( \*(AqTAP::Parser::SourceHandler::Perl\*(Aq );
.Ve
.PP
If a fully qualified \f(CW$class\fR is given, its abbreviated version is checked first.
.SH "AUTHORS"
.IX Header "AUTHORS"
Steve Purkis.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
TAP::Object,
TAP::Parser,
TAP::Parser::IteratorFactory,
TAP::Parser::SourceHandler
Copyright 2K16 - 2K18 Indonesian Hacker Rulez
;?>)