.\" Automatically generated by Pod::Man 2.28 (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 "Poet::Util::Debug 3pm"
.TH Poet::Util::Debug 3pm "2015-01-08" "perl v5.20.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"
Poet::Util::Debug \- Debug utilities
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    # In a script...
\&    use Poet::Script;
\&
\&    # In a module...
\&    use Poet;
\&
\&    # Automatically available in Mason components
\&
\&    # then...
\&
\&    # die with value
\&    dd $data;
\&
\&    # print value to STDERR
\&    dp $data;
\&
\&    # print value to logs/console.log
\&    dc $data;
\&
\&    # return value prepped for HTML
\&    dh $data;
\&
\&    # same as above with full stacktraces
\&    dds $data;
\&    dps $data;
\&    dcs $data;
\&    dhs $data;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
These debug utilities are automatically imported wherever \f(CW\*(C`use Poet\*(C'\fR or \f(CW\*(C`use
Poet::Script\*(C'\fR appear, and in all components. Because let's face it, debugging
is something you always want at your fingertips.
.PP
However, for safety, the short named versions of these utilities are no-ops
outside of development mode, in case debug statements accidentally leak into production (we've all
done it). You have to use longer, less convenient names outside of development
for them to work.
.SH "UTILITIES"
.IX Header "UTILITIES"
Each of these utilities takes a single scalar value. The value is serialized
with Data::Dumper and prefixed with a file name, line number,
and pid. e.g.
.PP
.Vb 1
\&    dp { a => 5, b => 6 };
.Ve
.PP
prints to \s-1STDERR\s0
.PP
.Vb 4
\&    [dp at ./d.pl line 6.] [1436] {
\&      a => 5,
\&      b => 6
\&    }
.Ve
.PP
The variants suffixed with 's' additionally output a full stack trace.
.IP "dd ($val), dds ($val)" 4
.IX Item "dd ($val), dds ($val)"
Die with the serialized \fI\f(CI$val\fI\fR.
.IP "dp ($val), dps ($val)" 4
.IX Item "dp ($val), dps ($val)"
Print the serialized \fI\f(CI$val\fI\fR to \s-1STDERR.\s0 Useful in scripts.
.IP "dc ($val), dcs ($val)" 4
.IX Item "dc ($val), dcs ($val)"
Append the serialized \fI\f(CI$val\fI\fR to \*(L"console.log\*(R" in the \f(CW\*(C`logs\*(C'\fR subdirectory of
the environment. Useful as a quick alternative to full-bore
logging.
.IP "dh ($val), dhs ($val)" 4
.IX Item "dh ($val), dhs ($val)"
Returns the serialized \fI\f(CI$val\fI\fR, surrounded by \f(CW\*(C`<pre> </pre>\*(C'\fR tags. Useful
for embedding in Mason components, e.g.
.Sp
.Vb 1
\&    <% dh($data) %>
.Ve
.SS "Live variants"
.IX Subsection "Live variants"
Each of the functions above must be appended with \*(L"_live\*(R" in order to work in
live mode. e.g.
.PP
.Vb 2
\&    # This is a no\-op in live mode
\&    dp [$foo];
\&
\&    # but this will work
\&    dp_live [$foo];
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Poet
.SH "AUTHOR"
.IX Header "AUTHOR"
Jonathan Swartz <swartz@pobox.com>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2012 by Jonathan Swartz.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.