.\" 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::Output 3"
.TH Lintian::Output 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::Output \- Lintian messaging handling
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    # non\-OO
\&    use Lintian::Output qw(:messages);
\&
\&    $Lintian::Output::GLOBAL\->verbosity_level(1);
\&
\&    msg("Something interesting");
\&    v_msg("Something less interesting");
\&    debug_msg(3, "Something very specific");
\&
\&    # OO
\&    use Lintian::Output;
\&
\&    my $out = Lintian::Output\->new;
\&
\&    $out\->verbosity_level(\-1);
\&    $out\->msg("Something interesting");
\&    $out\->v_msg("Something less interesting");
\&    $out\->debug_msg(3, "Something very specific");
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Lintian::Output is used for all interaction between lintian and the user.
It is designed to be easily extensible via subclassing.
.PP
To simplify usage in the most common cases, many Lintian::Output methods
can be used as class methods and will therefore automatically use the object
\&\f(CW$Lintian::Output::GLOBAL\fR unless their first argument \f(CW\*(C`isa(\*(AqLintian::Output\*(Aq)\*(C'\fR.
.SH "ACCESSORS"
.IX Header "ACCESSORS"
The following fields define the behaviours of Lintian::Output.
.IP "verbosity_level" 4
.IX Item "verbosity_level"
Determine how verbose the output should be.  \*(L"0\*(R" is the default value
(tags and msg only), \*(L"\-1\*(R" is quiet (tags only) and \*(L"1\*(R" is verbose
(tags, msg and v_msg).
.IP "debug" 4
.IX Item "debug"
If set to a positive integer, will enable all debug messages issued with
a level lower or equal to its value.
.IP "color" 4
.IX Item "color"
Can take the values \*(L"never\*(R", \*(L"always\*(R", \*(L"auto\*(R" or \*(L"html\*(R".
.Sp
Whether to colorize tags based on their severity.  The default is \*(L"never\*(R",
which never uses color.  \*(L"always\*(R" will always use color, \*(L"auto\*(R" will use
color only if the output is going to a terminal.
.Sp
\&\*(L"html\*(R" will output \s-1HTML\s0 <span> tags with a color style attribute (instead
of \s-1ANSI\s0 color escape sequences).
.IP "stdout" 4
.IX Item "stdout"
I/O handle to use for output of messages and tags.  Defaults to \f(CW\*(C`\e*STDOUT\*(C'\fR.
.IP "stderr" 4
.IX Item "stderr"
I/O handle to use for warnings.  Defaults to \f(CW\*(C`\e*STDERR\*(C'\fR.
.IP "showdescription" 4
.IX Item "showdescription"
Whether to show the description of a tag when printing it.
.IP "issuedtags" 4
.IX Item "issuedtags"
Hash containing the names of tags which have been issued.
.IP "tag_display_limit" 4
.IX Item "tag_display_limit"
Get/Set the number of times a tag is emitted per processable.
.SH "CLASS/INSTANCE METHODS"
.IX Header "CLASS/INSTANCE METHODS"
These methods can be used both with and without an object.  If no object
is given, they will fall back to the \f(CW$Lintian::Output::GLOBAL\fR object.
.ie n .IP """msg(@args)""" 4
.el .IP "\f(CWmsg(@args)\fR" 4
.IX Item "msg(@args)"
Will output the strings given in \f(CW@args\fR, one per line, each line prefixed
with 'N: '.  Will do nothing if verbosity_level is less than 0.
.ie n .IP """v_msg(@args)""" 4
.el .IP "\f(CWv_msg(@args)\fR" 4
.IX Item "v_msg(@args)"
Will output the strings given in \f(CW@args\fR, one per line, each line prefixed
with 'N: '.  Will do nothing unless verbosity_level is greater than 0.
.ie n .IP """debug_msg($level, @args)""" 4
.el .IP "\f(CWdebug_msg($level, @args)\fR" 4
.IX Item "debug_msg($level, @args)"
\&\f(CW$level\fR should be a positive integer.
.Sp
Will output the strings given in \f(CW@args\fR, one per line, each line prefixed
with 'N: '.  Will do nothing unless debug is set to a positive integer
>= \f(CW$level\fR.
.ie n .IP """warning(@args)""" 4
.el .IP "\f(CWwarning(@args)\fR" 4
.IX Item "warning(@args)"
Will output the strings given in \f(CW@args\fR on stderr, one per line, each line
prefixed with 'warning: '.
.ie n .IP """perf_log(@args)""" 4
.el .IP "\f(CWperf_log(@args)\fR" 4
.IX Item "perf_log(@args)"
Like \*(L"v_msg\*(R", except output is possibly sent to a dedicated log
file.
.Sp
Will output the strings given in \f(CW@args\fR, one per line.  The lines will
not be prefixed.  Will do nothing unless perf_debug is set to a
positive integer.
.ie n .IP """delimiter()""" 4
.el .IP "\f(CWdelimiter()\fR" 4
.IX Item "delimiter()"
Gives back a string that is usable for separating messages in the output.
Note: This does not print anything, it just gives back the string, use
with one of the methods above, e.g.
.Sp
.Vb 1
\& v_msg(\*(Aqfoo\*(Aq, delimiter(), \*(Aqbar\*(Aq);
.Ve
.ie n .IP """issued_tag($tag_name)""" 4
.el .IP "\f(CWissued_tag($tag_name)\fR" 4
.IX Item "issued_tag($tag_name)"
Indicate that the named tag has been issued.  Returns a boolean value
indicating whether the tag had previously been issued by the object.
.ie n .IP """string($lead, @args)""" 4
.el .IP "\f(CWstring($lead, @args)\fR" 4
.IX Item "string($lead, @args)"
\&\s-1TODO:\s0 Is this part of the public interface?
.SH "INSTANCE METHODS FOR CONTEXT-AWARE OUTPUT"
.IX Header "INSTANCE METHODS FOR CONTEXT-AWARE OUTPUT"
The following methods are designed to be called at specific points
during program execution and require very specific arguments.  They
can only be called as instance methods.
.ie n .IP """print_tag($pkg_info, $tag_info, $extra, $override)""" 4
.el .IP "\f(CWprint_tag($pkg_info, $tag_info, $extra, $override)\fR" 4
.IX Item "print_tag($pkg_info, $tag_info, $extra, $override)"
Print a tag.  The first two arguments are hash reference with the
information about the package and the tag, \f(CW$extra\fR is the extra
information for the tag (if any) as an array reference, and \f(CW$override\fR
is either undef if the tag is not overridden or the
override for this tag.  Called from
\&\fILintian::Tags::tag()\fR.
.ie n .IP """print_start_pkg($pkg_info)""" 4
.el .IP "\f(CWprint_start_pkg($pkg_info)\fR" 4
.IX Item "print_start_pkg($pkg_info)"
Called before lintian starts to handle each package.  The version in
Lintian::Output uses \fIv_msg()\fR for output.  Called from \fITags::select_pkg()\fR.
.ie n .IP """print_start_pkg($pkg_info)""" 4
.el .IP "\f(CWprint_start_pkg($pkg_info)\fR" 4
.IX Item "print_start_pkg($pkg_info)"
Called after lintian is finished with a package.  The version in
Lintian::Output does nothing.  Called from \fILintian::Tags::file_start()\fR and
\&\fILintian::Tags::file_end()\fR.
.ie n .IP """print_first()""" 4
.el .IP "\f(CWprint_first()\fR" 4
.IX Item "print_first()"
Called before lintian starts to handle any package.
.ie n .IP """print_last()""" 4
.el .IP "\f(CWprint_last()\fR" 4
.IX Item "print_last()"
Called after lintian is finished with a package.
.SH "INSTANCE METHODS FOR SUBCLASSING"
.IX Header "INSTANCE METHODS FOR SUBCLASSING"
The following methods are only intended for subclassing and are
only available as instance methods.  The methods mentioned in
\&\*(L"\s-1CLASS/INSTANCE METHODS\*(R"\s0
usually only check whether they should do anything at all (according
to the values of verbosity_level and debug) and then call one of
the following methods to do the actual printing. Almost all of them
finally call \fI_print()\fR to do that.  This convoluted scheme is necessary
to be able to use the methods above as class methods and still make
the behaviour overridable in subclasses.
.ie n .IP """_message(@args)""" 4
.el .IP "\f(CW_message(@args)\fR" 4
.IX Item "_message(@args)"
Called by \fImsg()\fR, \fIv_msg()\fR, and \fIdebug_msg()\fR to print the
message.
.ie n .IP """_warning(@args)""" 4
.el .IP "\f(CW_warning(@args)\fR" 4
.IX Item "_warning(@args)"
Called by \fIwarning()\fR to print the warning.
.ie n .IP """_print($stream, $lead, @args)""" 4
.el .IP "\f(CW_print($stream, $lead, @args)\fR" 4
.IX Item "_print($stream, $lead, @args)"
Called by \fI_message()\fR, \fI_warning()\fR, and \fIprint_tag()\fR to do
the actual printing.
.Sp
If you override these three methods, you can change
the calling convention for this method to pretty much
whatever you want.
.Sp
The version in Lintian::Output prints the strings in
\&\f(CW@args\fR, one per line, each line preceded by \f(CW$lead\fR to
the I/O handle given in \f(CW$stream\fR.
.ie n .IP """_delimiter()""" 4
.el .IP "\f(CW_delimiter()\fR" 4
.IX Item "_delimiter()"
Called by \fIdelimiter()\fR.
.ie n .IP """_do_color()""" 4
.el .IP "\f(CW_do_color()\fR" 4
.IX Item "_do_color()"
Called by \fIprint_tag()\fR to determine whether to produce colored
output.
.ie n .IP """_quote_print($string)""" 4
.el .IP "\f(CW_quote_print($string)\fR" 4
.IX Item "_quote_print($string)"
Called to quote a string.  By default it will replace all
non-printables with \*(L"?\*(R".  Sub-classes can override it if
they allow non-ascii printables etc.
.SH "CLASS METHODS"
.IX Header "CLASS METHODS"
.ie n .IP """_global_or_object(@args)""" 4
.el .IP "\f(CW_global_or_object(@args)\fR" 4
.IX Item "_global_or_object(@args)"
If \f(CW$args\fR[0] is an object which satisfies \f(CW\*(C`isa(\*(AqLintian::Output\*(Aq)\*(C'\fR
returns \f(CW@args\fR, otherwise returns \f(CW\*(C`($Lintian::Output::GLOBAL, @_)\*(C'\fR.
.SH "EXPORTS"
.IX Header "EXPORTS"
Lintian::Output exports nothing by default, but the following export
tags are available:
.IP ":messages" 4
.IX Item ":messages"
Exports all the methods in \*(L"\s-1CLASS/INSTANCE METHODS\*(R"\s0
.IP ":util" 4
.IX Item ":util"
Exports all the methods in \*(L"\s-1CLASS METHODS\*(R"\s0
.SH "AUTHOR"
.IX Header "AUTHOR"
Originally written by Frank Lichtenheld <djpig@debian.org> for Lintian.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIlintian\fR\|(1)