.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" 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" ''
.    ds C`
.    ds C'
'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 >0, 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.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Lintian::CheckScript 3"
.TH Lintian::CheckScript 3 "2019-05-26" "Lintian v2.15.0~bpo9+1" "Debian Package Checker"
.\" 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"
Lintian::CheckScript \- Check script meta data
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use Lintian::CheckScript;
\& 
\& my $cs = Lintian::CheckScript\->new ("$ENV{\*(AqLINTIAN_ROOT\*(Aq}/checks/",
\&                                     \*(Aqfiles\*(Aq);
\& my $name = $cs\->name;
\& foreach my $tag ($cs\->tags) {
\&    # $ti is an instance of Lintian::Tag::Info
\&    my $ti = $cs\->get_tag ($tag);
\&    print "$tag is a part of the check $name\en";
\&    # Do something with $ti / $tag
\& }
\& foreach my $needs ($cs\->needs_info) {
\&    print "$name needs $needs\en";
\& }
\& if ($cs\->is_check_type (\*(Aqbinary\*(Aq) && $cs\->is_check_type (\*(Aqsource\*(Aq)) {
\&    # Check applies to binary pkgs AND source pkgs
\& }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Instances of this class represents the data in the check \*(L".desc\*(R"
files.  It allows access to the tags (as Lintian::Tag::Info) and the
common meta data of the check (such as Needs-Info).
.SH "CLASS METHODS"
.IX Header "CLASS METHODS"
.ie n .IP "Lintian::CheckScript\->new($basedir, $checkname)" 4
.el .IP "Lintian::CheckScript\->new($basedir, \f(CW$checkname\fR)" 4
.IX Item "Lintian::CheckScript->new($basedir, $checkname)"
Parses the \f(CW$file\fR as a check desc file.
.ie n .IP "$cs\->name" 4
.el .IP "\f(CW$cs\fR\->name" 4
.IX Item "$cs->name"
Returns the \*(L"name\*(R" of the check script.  This is the value in the
Check-Script field in the file.
.ie n .IP "$cs\->type" 4
.el .IP "\f(CW$cs\fR\->type" 4
.IX Item "$cs->type"
Returns the value stored in the \*(L"Type\*(R" field of the file.  For the
purpose of testing if the check applies to a given package type, the
\&\*(L"is_check_type\*(R" method can be used instead.
.Sp
Note in rare cases this may return undef.  This is the case for the
lintian.desc, where this field is simply not present.
.ie n .IP "$cs\->abbrev" 4
.el .IP "\f(CW$cs\fR\->abbrev" 4
.IX Item "$cs->abbrev"
Returns the value of the Abbrev field from the desc file.
.ie n .IP "$cs\->script_path" 4
.el .IP "\f(CW$cs\fR\->script_path" 4
.IX Item "$cs->script_path"
Returns the (expected) path to the script implementing this check.
.IP "needs_info" 4
.IX Item "needs_info"
Returns a list of all items listed in the Needs-Info field.  Neither
the list nor its contents should be modified.
.ie n .IP "$cs\->is_check_type ($type)" 4
.el .IP "\f(CW$cs\fR\->is_check_type ($type)" 4
.IX Item "$cs->is_check_type ($type)"
Returns a truth value if this check can be applied to a \f(CW$type\fR package.
.Sp
Note if \f(CW$cs\fR\->type return undef, this will return a truth value for all
inputs.
.ie n .IP "$cs\->get_tag ($tagname)" 4
.el .IP "\f(CW$cs\fR\->get_tag ($tagname)" 4
.IX Item "$cs->get_tag ($tagname)"
Return the tag or undef (if the tag is not in
this check).
.ie n .IP "$cs\->tags" 4
.el .IP "\f(CW$cs\fR\->tags" 4
.IX Item "$cs->tags"
Returns the list of tag names in the check.  The list nor its contents
should be modified.
.ie n .IP "$cs\->load_check" 4
.el .IP "\f(CW$cs\fR\->load_check" 4
.IX Item "$cs->load_check"
Attempts to load the check.  On failure, the load error will be
propagated to the caller.  On success it returns normally.
.ie n .IP "$cs\->run_check ($proc, $group)" 4
.el .IP "\f(CW$cs\fR\->run_check ($proc, \f(CW$group\fR)" 4
.IX Item "$cs->run_check ($proc, $group)"
Run the check on \f(CW$proc\fR, which is in the
group \f(CW$group\fR.  \f(CW$proc\fR should be
a lab entry and must have the proper
collections run on it prior to calling this method (See
Lintian::Unpacker).
.Sp
The method may error out if loading the check failed or if the check
itself calls die/croak/fail/etc.
.Sp
Returns normally on success; the return value has no semantic meaning
and is currently \f(CW\*(C`undef\*(C'\fR.
.Sp
\&\s-1NB:\s0 load_check can be used to determine if the check itself is
loadable.
.SH "AUTHOR"
.IX Header "AUTHOR"
Originally written by Niels Thykier <niels@thykier.net> for Lintian.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIlintian\fR\|(1), \fILintian::Profile\fR\|(3), \fILintian::Tag::Info\fR\|(3)