.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" 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" ''
'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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" 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 "Scalar 3pm"
.TH Scalar 3pm "2009-02-12" "perl v5.14.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"
Test::Data::Scalar \-\- test functions for scalar variables
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&        use Test::Data qw(Scalar);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This modules provides a collection of test utilities for
scalar variables.  Load the module through Test::Data.
.SS "Functions"
.IX Subsection "Functions"
.IP "blessed_ok( \s-1SCALAR\s0 )" 4
.IX Item "blessed_ok( SCALAR )"
Ok if the \s-1SCALAR\s0 is a blessed reference.
.IP "defined_ok( \s-1SCALAR\s0 )" 4
.IX Item "defined_ok( SCALAR )"
Ok if the \s-1SCALAR\s0 is defined.
.IP "undef_ok( \s-1SCALAR\s0 )" 4
.IX Item "undef_ok( SCALAR )"
Ok if the \s-1SCALAR\s0 is undefined.
.IP "dualvar_ok( \s-1SCALAR\s0 )" 4
.IX Item "dualvar_ok( SCALAR )"
Ok if the scalar is a dualvar.
.Sp
How do I test this?
.Sp
sub dualvar_ok ($;$)
	{
	my \f(CW$ok\fR   = Scalar::Util::dualvar( \f(CW$_\fR[0] );
	my \f(CW$name\fR = \f(CW$_\fR[1] || 'Scalar is a dualvar';
.Sp
.Vb 1
\&        $Test\->ok( $ok, $name );
\&
\&        $Test\->diag("Expected a dualvar, didn\*(Aqt get it\en")
\&                unless $ok;
\&        }
.Ve
.IP "greater_than( \s-1SCALAR\s0, \s-1BOUND\s0 )" 4
.IX Item "greater_than( SCALAR, BOUND )"
Ok if the \s-1SCALAR\s0 is numerically greater than \s-1BOUND\s0.
.IP "length_ok( \s-1SCALAR\s0, \s-1LENGTH\s0 )" 4
.IX Item "length_ok( SCALAR, LENGTH )"
Ok if the length of \s-1SCALAR\s0 is \s-1LENGTH\s0.
.IP "less_than( \s-1SCALAR\s0, \s-1BOUND\s0 )" 4
.IX Item "less_than( SCALAR, BOUND )"
Ok if the \s-1SCALAR\s0 is numerically less than \s-1BOUND\s0.
.IP "maxlength_ok( \s-1SCALAR\s0, \s-1LENGTH\s0 )" 4
.IX Item "maxlength_ok( SCALAR, LENGTH )"
Ok is the length of \s-1SCALAR\s0 is less than or equal to \s-1LENGTH\s0.
.IP "minlength_ok( \s-1SCALAR\s0, \s-1LENGTH\s0 )" 4
.IX Item "minlength_ok( SCALAR, LENGTH )"
Ok is the length of \s-1SCALAR\s0 is greater than or equal to \s-1LENGTH\s0.
.IP "number_ok( \s-1SCALAR\s0 )" 4
.IX Item "number_ok( SCALAR )"
Ok if the \s-1SCALAR\s0 is a number ( or a string that represents a
number ).
.Sp
At the moment, a number is just a string of digits.  This needs
work.
.IP "number_between_ok( \s-1SCALAR\s0, \s-1LOWER\s0, \s-1UPPER\s0 )" 4
.IX Item "number_between_ok( SCALAR, LOWER, UPPER )"
Ok if the number in \s-1SCALAR\s0 sorts between the number
in \s-1LOWER\s0 and the number in \s-1UPPER\s0, numerically.
.Sp
If you put something that isn't a number into \s-1UPPER\s0 or
\&\s-1LOWER\s0, Perl will try to make it into a number and you
may get unexpected results.
.IP "string_between_ok( \s-1SCALAR\s0, \s-1LOWER\s0, \s-1UPPER\s0 )" 4
.IX Item "string_between_ok( SCALAR, LOWER, UPPER )"
Ok if the string in \s-1SCALAR\s0 sorts between the string
in \s-1LOWER\s0 and the string in \s-1UPPER\s0, ASCII-betically.
.IP "readonly_ok( \s-1SCALAR\s0 )" 4
.IX Item "readonly_ok( SCALAR )"
Ok is the \s-1SCALAR\s0 is read-only.
.IP "ref_ok( \s-1SCALAR\s0 )" 4
.IX Item "ref_ok( SCALAR )"
Ok if the \s-1SCALAR\s0 is a reference.
.IP "ref_type_ok( \s-1REF1\s0, \s-1REF2\s0 )" 4
.IX Item "ref_type_ok( REF1, REF2 )"
Ok if \s-1REF1\s0 is the same reference type as \s-1REF2\s0.
.IP "strong_ok( \s-1SCALAR\s0 )" 4
.IX Item "strong_ok( SCALAR )"
Ok is the \s-1SCALAR\s0 is not a weak reference.
.IP "tainted_ok( \s-1SCALAR\s0 )" 4
.IX Item "tainted_ok( SCALAR )"
Ok is the \s-1SCALAR\s0 is tainted.
.Sp
(Tainted values may seem like a not-Ok thing, but remember, when
you use taint checking, you want Perl to taint data, so you
should have a test to make sure it happens.)
.IP "untainted_ok( \s-1SCALAR\s0 )" 4
.IX Item "untainted_ok( SCALAR )"
Ok if the \s-1SCALAR\s0 is not tainted.
.IP "weak_ok( \s-1SCALAR\s0 )" 4
.IX Item "weak_ok( SCALAR )"
Ok if the \s-1SCALAR\s0 is a weak reference.
.SH "TO DO"
.IX Header "TO DO"
* add is_a_filehandle test
.PP
* add is_vstring test
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Scalar::Util,
Test::Data,
Test::Data::Array,
Test::Data::Function,
Test::Data::Hash,
Test::Builder
.SH "SOURCE AVAILABILITY"
.IX Header "SOURCE AVAILABILITY"
This source is in Github:
.PP
.Vb 1
\&        http://github.com/briandfoy/test\-data/tree/master
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
brian d foy, \f(CW\*(C`<bdfoy@cpan.org>\*(C'\fR
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (c) 2002\-2009 brian d foy.  All rights reserved.
.PP
This program is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.