summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJarkko Hietaniemi <jhi@iki.fi>2000-09-05 21:16:01 +0000
committerJarkko Hietaniemi <jhi@iki.fi>2000-09-05 21:16:01 +0000
commite331fc526c631ec7738ea465ef21f191ba7f166b (patch)
tree2ece93d668fb0b5368e430866a03ec18ff3e0f53
parent1c846c1f6d96d2ca4dfccdcfc0ff050c1474993e (diff)
downloadperl-e331fc526c631ec7738ea465ef21f191ba7f166b.tar.gz
Document the SvIOK_.*UV().
p4raw-id: //depot/perl@7017
-rw-r--r--pod/perlapi.pod41
-rw-r--r--sv.h9
2 files changed, 43 insertions, 7 deletions
diff --git a/pod/perlapi.pod b/pod/perlapi.pod
index ccb159d7c5..76afa0e682 100644
--- a/pod/perlapi.pod
+++ b/pod/perlapi.pod
@@ -1906,6 +1906,15 @@ the B<private> setting. Use C<SvIOK>.
=for hackers
Found in file sv.h
+=item SvIOK_notUV
+
+Returns a boolean indicating whether the SV contains an signed integer.
+
+ void SvIOK_notUV(SV* sv)
+
+=for hackers
+Found in file sv.h
+
=item SvIOK_off
Unsets the IV status of an SV.
@@ -1933,6 +1942,24 @@ Tells an SV that it is an integer and disables all other OK bits.
=for hackers
Found in file sv.h
+=item SvIOK_only_UV
+
+Tells and SV that it is an unsigned integer and disables all other OK bits.
+
+ void SvIOK_only_UV(SV* sv)
+
+=for hackers
+Found in file sv.h
+
+=item SvIOK_UV
+
+Returns a boolean indicating whether the SV contains an unsigned integer.
+
+ void SvIOK_UV(SV* sv)
+
+=for hackers
+Found in file sv.h
+
=item SvIV
Coerces the given SV to an integer and returns it.
@@ -2318,19 +2345,19 @@ false, defined or undefined. Does not handle 'get' magic.
=for hackers
Found in file sv.h
-=item svtype
+=item SvTYPE
-An enum of flags for Perl types. These are found in the file B<sv.h>
-in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
+Returns the type of the SV. See C<svtype>.
+
+ svtype SvTYPE(SV* sv)
=for hackers
Found in file sv.h
-=item SvTYPE
-
-Returns the type of the SV. See C<svtype>.
+=item svtype
- svtype SvTYPE(SV* sv)
+An enum of flags for Perl types. These are found in the file B<sv.h>
+in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
=for hackers
Found in file sv.h
diff --git a/sv.h b/sv.h
index 5500d2b46b..b91cc5fed1 100644
--- a/sv.h
+++ b/sv.h
@@ -442,6 +442,15 @@ Unsets the IV status of an SV.
=for apidoc Am|void|SvIOK_only|SV* sv
Tells an SV that it is an integer and disables all other OK bits.
+=for apidoc Am|void|SvIOK_only_UV|SV* sv
+Tells and SV that it is an unsigned integer and disables all other OK bits.
+
+=for apidoc Am|void|SvIOK_UV|SV* sv
+Returns a boolean indicating whether the SV contains an unsigned integer.
+
+=for apidoc Am|void|SvIOK_notUV|SV* sv
+Returns a boolean indicating whether the SV contains an signed integer.
+
=for apidoc Am|bool|SvNOK|SV* sv
Returns a boolean indicating whether the SV contains a double.