.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" 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
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" 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::Collect 3"
.TH Lintian::Collect 3 "2019-11-07" "Lintian v2.33.0~bpo10+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::Collect \- Lintian interface to package data collection
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 4
\&    my ($name, $type, $dir) = (\*(Aqfoobar\*(Aq, \*(Aqudeb\*(Aq, \*(Aq/some/abs/path\*(Aq);
\&    my $collect = Lintian::Collect\->new ($name, $type, $dir);
\&    $name = $collect\->name;
\&    $type = $collect\->type;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Lintian::Collect provides the shared interface to package data used by
source, binary and udeb packages and .changes files.  It creates an
object of the appropriate type and provides common functions used by the
collection interface to all types of package.
.PP
Usually instances should not be created directly (exceptions include
collections), but instead be requested via the
info method in Lintian::Lab::Entry.
.PP
This module is in its infancy.  Most of Lintian still reads all data from
files in the laboratory whenever that data is needed and generates that
data via collect scripts.  The goal is to eventually access all data via
this module and its subclasses so that the module can cache data where
appropriate and possibly retire collect scripts in favor of caching that
data in memory.
.SH "CLASS METHODS"
.IX Header "CLASS METHODS"
.IP "new (\s-1PACKAGE, TYPE,\s0 BASEDIR[, \s-1FIELDS\s0]))" 4
.IX Item "new (PACKAGE, TYPE, BASEDIR[, FIELDS]))"
Creates a new object appropriate to the package type.  \s-1TYPE\s0 can be
retrieved later with the \*(L"type\*(R" method.  Croaks if given an unknown
\&\s-1TYPE.\s0
.Sp
\&\s-1PACKAGE\s0 is the name of the package and is stored in the collect object.
It can be retrieved with the \*(L"name\*(R" method.
.Sp
\&\s-1BASEDIR\s0 is the base directory for the data and should be absolute.
.Sp
If \s-1FIELDS\s0 is given it is assumed to be the fields from the underlying
control file.  This is only used to avoid an unnecessary read
operation (possibly incl. an ar | gzip pipeline) when the fields are
already known.
.SH "INSTANCE METHODS"
.IX Header "INSTANCE METHODS"
In addition to the instance methods documented here, see the documentation
of Lintian::Collect::Source, Lintian::Collect::Binary and
Lintian::Collect::Changes for instance methods specific to source and
binary / udeb packages and .changes files.
.IP "name" 4
.IX Item "name"
Returns the name of the package.
.Sp
Needs-Info requirements for using \fIname\fR: none
.IP "type" 4
.IX Item "type"
Returns the type of the package.
.Sp
Needs-Info requirements for using \fItype\fR: none
.IP "base_dir" 4
.IX Item "base_dir"
Returns the base_dir where all the package information is stored.
.Sp
Needs-Info requirements for using \fIbase_dir\fR: none
.IP "lab_data_path ([\s-1ENTRY\s0])" 4
.IX Item "lab_data_path ([ENTRY])"
Return the path to the \s-1ENTRY\s0 in the lab.  This is a convenience method
around base_dir.  If \s-1ENTRY\s0 is not given, this method behaves like
base_dir.
.Sp
Needs-Info requirements for using \fIlab_data_path\fR: \*(L"base_dir\*(R"
.IP "unfolded_field (\s-1FIELD\s0)" 4
.IX Item "unfolded_field (FIELD)"
This method returns the unfolded value of the control field \s-1FIELD\s0 in
the control file for the package.  For a source package, this is the
*.dsc file; for a binary package, this is the control file in the
control section of the package.
.Sp
If \s-1FIELD\s0 is passed but not present, then this method returns undef.
.Sp
Needs-Info requirements for using \fIunfolded_field\fR: none
.IP "field ([FIELD[, \s-1DEFAULT\s0]])" 4
.IX Item "field ([FIELD[, DEFAULT]])"
If \s-1FIELD\s0 is given, this method returns the value of the control field
\&\s-1FIELD\s0 in the control file for the package.  For a source package, this
is the *.dsc file; for a binary package, this is the control file in
the control section of the package.
.Sp
If \s-1FIELD\s0 is passed but not present, then this method will return
\&\s-1DEFAULT\s0 (if given) or undef.
.Sp
Otherwise this will return a hash of fields, where the key is the field
name (in all lowercase).
.Sp
Needs-Info requirements for using \fIfield\fR: none
.IP "is_non_free" 4
.IX Item "is_non_free"
Returns a truth value if the package appears to be non-free (based on
the section field; \*(L"non\-free/*\*(R" and \*(L"restricted/*\*(R")
.Sp
Needs-Info requirements for using \fIis_non_free\fR: \*(L"field ([FIELD[, \s-1DEFAULT\s0]])\*(R"
.SH "AUTHOR"
.IX Header "AUTHOR"
Originally written by Russ Allbery <rra@debian.org> for Lintian.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBlintian\fR\|(1), Lintian::Collect::Binary, Lintian::Collect::Changes,
Lintian::Collect::Source