.\" Automatically generated by Pod::Man 4.11 (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
.\" ========================================================================
.\"
.IX Title "Parse::ErrorString::Perl::ErrorItem 3pm"
.TH Parse::ErrorString::Perl::ErrorItem 3pm "2020-05-18" "perl v5.30.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"
Parse::ErrorString::Perl::ErrorItem \- a Perl error item object
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Each object contains the following accessors (only \f(CW\*(C`message\*(C'\fR, \f(CW\*(C`file\*(C'\fR,
and \f(CW\*(C`line\*(C'\fR are guaranteed to be present for every error):
.IP "type" 4
.IX Item "type"
Normally returns a single letter identifying the type of the error. The
possbile options are \f(CW\*(C`W\*(C'\fR, \f(CW\*(C`D\*(C'\fR, \f(CW\*(C`S\*(C'\fR, \f(CW\*(C`F\*(C'\fR, \f(CW\*(C`P\*(C'\fR, \f(CW\*(C`X\*(C'\fR, and \f(CW\*(C`A\*(C'\fR.
Sometimes an error can be of either of two types, in which case a string
such as "\f(CW\*(C`S|F\*(C'\fR" is returned in scalar context and a list of the two
letters is returned in list context. If \f(CW\*(C`type\*(C'\fR is empty, you can assume
that the error was not emitted by perl itself, but by the user or by a
third-party module.
.IP "type_description" 4
.IX Item "type_description"
A description of the error type. The possible options are:
.Sp
.Vb 7
\&    W => warning
\&    D => deprecation
\&    S => severe warning
\&    F => fatal error
\&    P => internal error
\&    X => very fatal error
\&    A => alien error message
.Ve
.Sp
If the error can be of either or two types, the two types are
concactenated with "\f(CW\*(C` or \*(C'\fR". Note that this description is always
returned in English, regardless of the \f(CW\*(C`lang\*(C'\fR option.
.IP "message" 4
.IX Item "message"
The error message.
.IP "file" 4
.IX Item "file"
The path to the file in which the error occurred, possibly truncated. If
the error occurred in a script, the parser will attempt to return only
the filename; if the error occurred in a module, the parser will attempt
to return the path to the module relative to the directory in \f(CW@INC\fR in
which it resides.
.IP "file_abspath" 4
.IX Item "file_abspath"
Absolute path to the file in which the error occurred.
.IP "file_msgpath" 4
.IX Item "file_msgpath"
The file path as displayed in which the error message.
.IP "line" 4
.IX Item "line"
Line in which the error occurred.
.IP "near" 4
.IX Item "near"
Text near which the error occurred (note that this often contains
newline characters).
.IP "at" 4
.IX Item "at"
Additional information about where the error occurred (e.g. "\f(CW\*(C`at EOF\*(C'\fR").
.IP "diagnostics" 4
.IX Item "diagnostics"
Detailed explanation of the error (from perldiag). If the \f(CW\*(C`lang\*(C'\fR
option is specified when constructing the parser, an attempt will be
made to return the diagnostics message in the appropriate language. If
an explanation is not found in the localized perldiag, the default
perldiag will also be searched. Returned as raw pod, so you may need to
use a pod parser to render into the format you need.
.IP "stack" 4
.IX Item "stack"
Callstack for the error. Returns a list of Parse::ErrorString::Perl::StackItem objects.
.PP
# Copyright 2008\-2013 The Padre development team as listed in Padre.pm.
# \s-1LICENSE\s0
# This program is free software; you can redistribute it and/or
# modify it under the same terms as Perl 5 itself.