summaryrefslogtreecommitdiff
path: root/sv.h
diff options
context:
space:
mode:
authorKarl Williamson <khw@cpan.org>2020-07-22 17:02:37 -0600
committerKarl Williamson <khw@cpan.org>2020-11-21 12:45:08 -0700
commit1d31276decae722536833b5395bb9fd32bb121d5 (patch)
tree4c7410d682a461b4c6040fdadffc028bdc65bf14 /sv.h
parente6cf6753c0a863255ba19b08b556a08c5e571b51 (diff)
downloadperl-1d31276decae722536833b5395bb9fd32bb121d5.tar.gz
Document isGV_with_GP
Diffstat (limited to 'sv.h')
-rw-r--r--sv.h7
1 files changed, 7 insertions, 0 deletions
diff --git a/sv.h b/sv.h
index fc35f346e6..abe93ec05f 100644
--- a/sv.h
+++ b/sv.h
@@ -2236,6 +2236,13 @@ See also C<L</PL_sv_yes>> and C<L</PL_sv_no>>.
#define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
/* If I give every macro argument a different name, then there won't be bugs
where nested macros get confused. Been there, done that. */
+/*
+=for apidoc Am|bool|isGV_with_GP|SV * sv
+Returns a boolean as to whether or not C<sv> is a GV with a pointer to a GP
+(glob pointer).
+
+=cut
+*/
#define isGV_with_GP(pwadak) \
(((SvFLAGS(pwadak) & (SVp_POK|SVpgv_GP)) == SVpgv_GP) \
&& (SvTYPE(pwadak) == SVt_PVGV || SvTYPE(pwadak) == SVt_PVLV))