.\" 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 "Test::Carp 3"
.TH Test::Carp 3 "2016-08-24" "perl v5.16.3" "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"
Test::Carp \- test your code for calls to Carp functions
.SH "VERSION"
.IX Header "VERSION"
This document describes Test::Carp version 0.2
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    use Test::More tests => 42;
\&    use Test::Carp;
\&    
\&    ok($x eq $y, "X does equal Y");
\&    does_carp(\e&function);
\&    does_croak(\e&function, 1, 2, 3);
\&    does_carp_that_matches(\e&function, qr/whoopsy/);
\&    does_croak_that_matches(\e&function, 1, 2, 3, qr/a likely story/);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Call given code (with given arguments) and tests whether the given Carp function (or their imported versions) are called (with a given value) or not.
.SH "INTERFACE"
.IX Header "INTERFACE"
All functions are put in the caller's name space during \fIimport()\fR. If you'd rather use their full name space and not clutter up the current package with functions just:
.PP
.Vb 1
\&  require Test::Carp;
.Ve
.PP
or
.PP
.Vb 1
\&  use Test::Carp ();
.Ve
.PP
instead of
.PP
.Vb 1
\&  use Test::Carp;
.Ve
.SS "being \fIok()\fP w/ \fIok()\fP"
.IX Subsection "being ok() w/ ok()"
Internally, Test::Carp uses \fITest::More::ok()\fR (\fIrequire()\fRing in Test::More if needed) when it needs to use an \fIok()\fR function.
.PP
If you want to specify a different one for it to use simply supply a coderef in the use statement.
.PP
.Vb 1
\&   use Test::Carp \e&Test::Foo::ok;
.Ve
.PP
The function should take the same args as \fITest::More::ok()\fR and probably behave the same as well.
.SS "\fIcarp()\fP/\fIcluck()\fP functions"
.IX Subsection "carp()/cluck() functions"
.IP "\fIdoes_carp()\fR" 4
.IX Item "does_carp()"
Test whether the given code ref, when executed, calls \fIcarp()\fR.
.Sp
Test fails if \fIcarp()\fR is not called. There are 2 forms:
.Sp
Without arguments to codreref:
.Sp
.Vb 1
\&   does_carp(sub {...});
.Ve
.Sp
With arge to coderef:
.Sp
.Vb 1
\&   does_carp(sub {...},"first arg to coderef", "second arg to coderef", ...);
.Ve
.IP "\fIdoes_carp_that_matches()\fR" 4
.IX Item "does_carp_that_matches()"
Test whether the given code ref, when executed, calls \fIcarp()\fR with a specific message.
.Sp
The test fails if \fIcarp()\fR is not called with the given message.
.Sp
The last argument should be a string or Regexp ref (i.e. qr//) to match the message against.
.Sp
There are 2 forms:
.Sp
Without arguments passed to codreref:
.Sp
.Vb 1
\&   does_carp(sub {...}, $match_me)
.Ve
.Sp
With arguments passed to coderef:
.Sp
.Vb 1
\&   does_carp(sub {...},"first arg to coderef", "second arg to coderef", ..., $match_me);
.Ve
.IP "does_cluck" 4
.IX Item "does_cluck"
Like \fIdoes_carp()\fR but for \fIcluck()\fR
.IP "does_cluck_that_matches" 4
.IX Item "does_cluck_that_matches"
Like \fIdoes_carp_that_matches()\fR but for \fIcluck()\fR
.SS "\fIcroak()\fP/\fIconfess()\fP functions"
.IX Subsection "croak()/confess() functions"
These functions stop running at the point it calls the [croak|cluck]() just like in normal code.
.IP "\fIdoes_croak()\fR" 4
.IX Item "does_croak()"
Like \fIdoes_carp()\fR but for \fIcroak()\fR
.IP "\fIdoes_croak_that_matches()\fR" 4
.IX Item "does_croak_that_matches()"
Like \fIdoes_carp_that_matches()\fR but for \fIcroak()\fR
.IP "\fIdoes_confess()\fR" 4
.IX Item "does_confess()"
Like \fIdoes_carp()\fR but for \fIconfess()\fR
.IP "\fIdoes_confess_that_matches()\fR" 4
.IX Item "does_confess_that_matches()"
Like \fIdoes_carp_that_matches()\fR but for \fIconfess()\fR
.SH "DIAGNOSTICS"
.IX Header "DIAGNOSTICS"
Throws no warnings or errors of it's own.
.SH "CONFIGURATION AND ENVIRONMENT"
.IX Header "CONFIGURATION AND ENVIRONMENT"
Test::Carp requires no configuration files or environment variables.
.SH "DEPENDENCIES"
.IX Header "DEPENDENCIES"
Test::More for \fIok()\fR unless you define a different \fIok()\fR for it to use.
.PP
It uses Carp in order to ensure carp and corak are defined before it does what it does.
.SH "INCOMPATIBILITIES"
.IX Header "INCOMPATIBILITIES"
None reported.
.SH "BUGS AND LIMITATIONS"
.IX Header "BUGS AND LIMITATIONS"
No bugs have been reported.
.PP
Please report any bugs or feature requests to
\&\f(CW\*(C`bug\-test\-carp@rt.cpan.org\*(C'\fR, or through the web interface at
<http://rt.cpan.org>.
.SH "TODO"
.IX Header "TODO"
Corresponding does_not_* functions. (v0.2)
.PP
TODOs in 02.functions.t (v0.2)
.PP
Maybe count and overall call info type functions, depending on demand ?
.PP
Determine [what needs done/if it should be done/etc] to make the test syntax not require a codref ?
.PP
Add mostly-internal Carp functions like (short|long)mess[_heavy](), etc ?
.SH "AUTHOR"
.IX Header "AUTHOR"
Daniel Muey  \f(CW\*(C`<http://drmuey.com/cpan_contact.pl>\*(C'\fR
.SH "LICENCE AND COPYRIGHT"
.IX Header "LICENCE AND COPYRIGHT"
Copyright (c) 2010, Daniel Muey \f(CW\*(C`<http://drmuey.com/cpan_contact.pl>\*(C'\fR. All rights reserved.
.PP
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself. See perlartistic.
.SH "DISCLAIMER OF WARRANTY"
.IX Header "DISCLAIMER OF WARRANTY"
\&\s-1BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE SOFTWARE \*(L"AS IS\*(R" WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
NECESSARY SERVICING, REPAIR, OR CORRECTION.\s0
.PP
\&\s-1IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE
LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
THE SOFTWARE \s0(\s-1INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE\s0), \s-1EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.\s0