.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" 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 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.
.\"
.\" 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 "Log::Report::Util 3pm"
.TH Log::Report::Util 3pm "2014-03-10" "perl v5.18.2" "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"
Log::Report::Util \- helpful routines to Log::Report
.SH "INHERITANCE"
.IX Header "INHERITANCE"
.Vb 2
\& Log::Report::Util
\&   is a Exporter
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module collects a few functions and definitions which are shared
between different components in the Log::Report infrastructure.
They should not be needed for end-user applications, although this
man-page may contain some useful background information.
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.SS "Reasons"
.IX Subsection "Reasons"
.IP "\fBexpand_reasons\fR($reasons)" 4
.IX Item "expand_reasons($reasons)"
Returns a sub-set of all existing message reason labels, based on the
content \f(CW$reasons\fR string. The following rules apply:
 \s-1REASONS\s0 = \s-1BLOCK\s0 [ ',' \s-1BLOCKS\s0]
 \s-1BLOCK  \s0 = '\-' \s-1TO\s0 | \s-1FROM \s0'\-' \s-1TO\s0 | \s-1ONE\s0 | \s-1SOURCE
 FROM,TO,ONE\s0 = '\s-1TRACE\s0' | '\s-1ASSERT\s0' | ,,, | '\s-1PANIC\s0'
 \s-1SOURCE \s0 = '\s-1USER\s0' | '\s-1PROGRAM\s0' | '\s-1SYSTEM\s0' | '\s-1ALL\s0'
.Sp
The \s-1SOURCE\s0 specification group all reasons which are usually related to
the problem: report about problems caused by the user, reported by
the program, or with system interaction.
.Sp
example: of expended \s-1REASONS\s0
.Sp
.Vb 5
\& WARNING\-FAULT # == WARNING,MISTAKE,ERROR,FAULT
\& \-INFO         # == TRACE\-INFO
\& ALERT\-        # == ALERT,FAILURE,PANIC
\& USER          # == MISTAKE,ERROR
\& ALL           # == TRACE\-PANIC
.Ve
.IP "\fBis_fatal\fR($reason)" 4
.IX Item "is_fatal($reason)"
Returns true if the \f(CW$reason\fR is severe enough to cause an exception
(or program termination).
.IP "\fBis_reason\fR($name)" 4
.IX Item "is_reason($name)"
Returns true if the \s-1STRING\s0 is one of the predefined \s-1REASONS.\s0
.IP "\fBuse_errno\fR($reason)" 4
.IX Item "use_errno($reason)"
.SS "Modes"
.IX Subsection "Modes"
Run-modes are explained in Log::Report::Dispatcher.
.IP "\fBmode_accepts\fR($mode)" 4
.IX Item "mode_accepts($mode)"
Returns something acceptable by \fIexpand_reasons()\fR
.IP "\fBmode_number\fR($name|$mode)" 4
.IX Item "mode_number($name|$mode)"
Returns the \f(CW$mode\fR as number.
.ie n .IP "\fBmust_show_location\fR($mode, $reason)" 4
.el .IP "\fBmust_show_location\fR($mode, \f(CW$reason\fR)" 4
.IX Item "must_show_location($mode, $reason)"
.PD 0
.ie n .IP "\fBmust_show_stack\fR($mode, $reason)" 4
.el .IP "\fBmust_show_stack\fR($mode, \f(CW$reason\fR)" 4
.IX Item "must_show_stack($mode, $reason)"
.PD
.SS "Other"
.IX Subsection "Other"
.IP "\fBescape_chars\fR(\s-1STRING\s0)" 4
.IX Item "escape_chars(STRING)"
Replace all escape characters into their readable counterpart.  For
instance, a new-line is replaced by backslash-n.
.IP "\fBparse_locale\fR(\s-1STRING\s0)" 4
.IX Item "parse_locale(STRING)"
Decompose a locale string.
.Sp
For simplicity of the caller's code, the capatization of the returned
fields is standardized to the preferred, although the match is case\-
insensitive as required by the \s-1RFC.\s0 The territory in returned in capitals
(\s-1ISO3166\s0), the language is lower-case (\s-1ISO639\s0), the script as upper-case
first, the character-set as lower-case, and the modifier and variant unchanged.
.Sp
In \s-1LIST\s0 context, four elements are returned: language, territory,
character-set (codeset), and modifier.  Those four are important for the
usual unix translationg infrastructure.  Only the \*(L"country\*(R" is obligatory,
the others can be \f(CW\*(C`undef\*(C'\fR.  It may also return \f(CW\*(C`C\*(C'\fR and \f(CW\*(C`POSIX\*(C'\fR.
.Sp
In \s-1SCALAR\s0 context, a \s-1HASH\s0 is returned which can contain more information:
language, script, territory, variant, codeset, and modifiers.  The
variant (\s-1RFC3066\s0 is probably never used)
.ie n .IP "\fBpkg2domain\fR( $package, [$domain, $filename, $line] )" 4
.el .IP "\fBpkg2domain\fR( \f(CW$package\fR, [$domain, \f(CW$filename\fR, \f(CW$line\fR] )" 4
.IX Item "pkg2domain( $package, [$domain, $filename, $line] )"
With \f(CW$domain\fR, \f(CW$filename\fR and \f(CW$line\fR, this registers a location where the
textdomain is specified.  Each \f(CW$package\fR can only belong to one \f(CW$domain\fR.
.Sp
Without these parameters, the registered domain for the \f(CW$package\fR is
returned.
.IP "\fBunescape_chars\fR(\s-1STRING\s0)" 4
.IX Item "unescape_chars(STRING)"
Replace all backslash-something escapes by their escape character.
For instance, backslash-t is replaced by a tab character.
.SH "SYNOPSYS"
.IX Header "SYNOPSYS"
.Vb 2
\& my ($language, $territory, $charset, $modifier)
\&    = parse_locale \*(Aqnl_BE.utf\-8@home\*(Aq;
\&
\& my @take = expand_reasons \*(AqINFO\-ERROR,PANIC\*(Aq;
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
This module is part of Log-Report-Optional distribution version 1.01,
built on March 10, 2014. Website: \fIhttp://perl.overmeer.net/log\-report/\fR
.SH "LICENSE"
.IX Header "LICENSE"
Copyrights 2013\-2014 by [Mark Overmeer]. For other contributors see ChangeLog.
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
See \fIhttp://www.perl.com/perl/misc/Artistic.html\fR