3 * Copyright (c) 1991-2002, Larry Wall
5 * You may distribute under the terms of either the GNU General Public
6 * License or the Artistic License, as specified in the README file.
10 /* This structure much match XPVCV in B/C.pm and the beginning of XPVFM
14 char * xpv_pv; /* pointer to malloced string */
15 STRLEN xpv_cur; /* length of xp_pv as a C string */
16 STRLEN xpv_len; /* allocated size */
17 IV xof_off; /* integer value */
18 NV xnv_nv; /* numeric value, if any */
19 MAGIC* xmg_magic; /* magic for scalar array */
20 HV* xmg_stash; /* class package */
25 void (*xcv_xsub) (pTHX_ CV*);
29 long xcv_depth; /* >= 2 indicates recursive call */
30 PADLIST * xcv_padlist;
38 =for apidoc AmU||Nullcv
41 =head1 CV Manipulation Functions
43 =for apidoc Am|HV*|CvSTASH|CV* cv
44 Returns the stash of the CV.
49 #define Nullcv Null(CV*)
51 #define CvSTASH(sv) ((XPVCV*)SvANY(sv))->xcv_stash
52 #define CvSTART(sv) ((XPVCV*)SvANY(sv))->xcv_start
53 #define CvROOT(sv) ((XPVCV*)SvANY(sv))->xcv_root
54 #define CvXSUB(sv) ((XPVCV*)SvANY(sv))->xcv_xsub
55 #define CvXSUBANY(sv) ((XPVCV*)SvANY(sv))->xcv_xsubany
56 #define CvGV(sv) ((XPVCV*)SvANY(sv))->xcv_gv
57 #define CvFILE(sv) ((XPVCV*)SvANY(sv))->xcv_file
59 # define CvFILE_set_from_cop(sv, cop) (CvFILE(sv) = savepv(CopFILE(cop)))
61 # define CvFILE_set_from_cop(sv, cop) (CvFILE(sv) = CopFILE(cop))
63 #define CvFILEGV(sv) (gv_fetchfile(CvFILE(sv)))
64 #define CvDEPTH(sv) ((XPVCV*)SvANY(sv))->xcv_depth
65 #define CvPADLIST(sv) ((XPVCV*)SvANY(sv))->xcv_padlist
66 #define CvOUTSIDE(sv) ((XPVCV*)SvANY(sv))->xcv_outside
67 #define CvFLAGS(sv) ((XPVCV*)SvANY(sv))->xcv_flags
69 #define CVf_CLONE 0x0001 /* anon CV uses external lexicals */
70 #define CVf_CLONED 0x0002 /* a clone of one of those */
71 #define CVf_ANON 0x0004 /* CvGV() can't be trusted */
72 #define CVf_OLDSTYLE 0x0008
73 #define CVf_UNIQUE 0x0010 /* can't be cloned */
74 #define CVf_NODEBUG 0x0020 /* no DB::sub indirection for this CV
75 (esp. useful for special XSUBs) */
76 #define CVf_METHOD 0x0040 /* CV is explicitly marked as a method */
77 #define CVf_LOCKED 0x0080 /* CV locks itself or first arg on entry */
78 #define CVf_LVALUE 0x0100 /* CV return value can be used as lvalue */
79 #define CVf_CONST 0x0200 /* inlinable sub */
80 /* This symbol for optimised communication between toke.c and op.c: */
81 #define CVf_BUILTIN_ATTRS (CVf_METHOD|CVf_LOCKED|CVf_LVALUE)
83 #define CvCLONE(cv) (CvFLAGS(cv) & CVf_CLONE)
84 #define CvCLONE_on(cv) (CvFLAGS(cv) |= CVf_CLONE)
85 #define CvCLONE_off(cv) (CvFLAGS(cv) &= ~CVf_CLONE)
87 #define CvCLONED(cv) (CvFLAGS(cv) & CVf_CLONED)
88 #define CvCLONED_on(cv) (CvFLAGS(cv) |= CVf_CLONED)
89 #define CvCLONED_off(cv) (CvFLAGS(cv) &= ~CVf_CLONED)
91 #define CvANON(cv) (CvFLAGS(cv) & CVf_ANON)
92 #define CvANON_on(cv) (CvFLAGS(cv) |= CVf_ANON)
93 #define CvANON_off(cv) (CvFLAGS(cv) &= ~CVf_ANON)
95 #ifdef PERL_XSUB_OLDSTYLE
96 #define CvOLDSTYLE(cv) (CvFLAGS(cv) & CVf_OLDSTYLE)
97 #define CvOLDSTYLE_on(cv) (CvFLAGS(cv) |= CVf_OLDSTYLE)
98 #define CvOLDSTYLE_off(cv) (CvFLAGS(cv) &= ~CVf_OLDSTYLE)
101 #define CvUNIQUE(cv) (CvFLAGS(cv) & CVf_UNIQUE)
102 #define CvUNIQUE_on(cv) (CvFLAGS(cv) |= CVf_UNIQUE)
103 #define CvUNIQUE_off(cv) (CvFLAGS(cv) &= ~CVf_UNIQUE)
105 #define CvNODEBUG(cv) (CvFLAGS(cv) & CVf_NODEBUG)
106 #define CvNODEBUG_on(cv) (CvFLAGS(cv) |= CVf_NODEBUG)
107 #define CvNODEBUG_off(cv) (CvFLAGS(cv) &= ~CVf_NODEBUG)
109 #define CvMETHOD(cv) (CvFLAGS(cv) & CVf_METHOD)
110 #define CvMETHOD_on(cv) (CvFLAGS(cv) |= CVf_METHOD)
111 #define CvMETHOD_off(cv) (CvFLAGS(cv) &= ~CVf_METHOD)
113 #define CvLOCKED(cv) (CvFLAGS(cv) & CVf_LOCKED)
114 #define CvLOCKED_on(cv) (CvFLAGS(cv) |= CVf_LOCKED)
115 #define CvLOCKED_off(cv) (CvFLAGS(cv) &= ~CVf_LOCKED)
117 #define CvLVALUE(cv) (CvFLAGS(cv) & CVf_LVALUE)
118 #define CvLVALUE_on(cv) (CvFLAGS(cv) |= CVf_LVALUE)
119 #define CvLVALUE_off(cv) (CvFLAGS(cv) &= ~CVf_LVALUE)
121 #define CvEVAL(cv) (CvUNIQUE(cv) && !SvFAKE(cv))
122 #define CvEVAL_on(cv) (CvUNIQUE_on(cv),SvFAKE_off(cv))
123 #define CvEVAL_off(cv) CvUNIQUE_off(cv)
125 /* BEGIN|CHECK|INIT|END */
126 #define CvSPECIAL(cv) (CvUNIQUE(cv) && SvFAKE(cv))
127 #define CvSPECIAL_on(cv) (CvUNIQUE_on(cv),SvFAKE_on(cv))
128 #define CvSPECIAL_off(cv) (CvUNIQUE_off(cv),SvFAKE_off(cv))
130 #define CvCONST(cv) (CvFLAGS(cv) & CVf_CONST)
131 #define CvCONST_on(cv) (CvFLAGS(cv) |= CVf_CONST)
132 #define CvCONST_off(cv) (CvFLAGS(cv) &= ~CVf_CONST)