This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
(Retracted by #11223.)
[perl5.git] / cv.h
CommitLineData
a0d0e21e 1/* cv.h
79072805 2 *
bc89e66f 3 * Copyright (c) 1991-2001, Larry Wall
79072805
LW
4 *
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.
7 *
79072805
LW
8 */
9
57843af0
GS
10/* This structure much match XPVCV in B/C.pm and the beginning of XPVFM
11 * in sv.h */
44a8e56a 12
79072805
LW
13struct xpvcv {
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 */
a0d0e21e 17 IV xof_off; /* integer value */
65202027 18 NV xnv_nv; /* numeric value, if any */
79072805
LW
19 MAGIC* xmg_magic; /* magic for scalar array */
20 HV* xmg_stash; /* class package */
21
22 HV * xcv_stash;
23 OP * xcv_start;
24 OP * xcv_root;
0cb96387 25 void (*xcv_xsub) (pTHXo_ CV*);
a0d0e21e 26 ANY xcv_xsubany;
8990e307 27 GV * xcv_gv;
57843af0 28 char * xcv_file;
b195d487 29 long xcv_depth; /* >= 2 indicates recursive call */
79072805 30 AV * xcv_padlist;
748a9306 31 CV * xcv_outside;
11343788 32#ifdef USE_THREADS
12ca11f6 33 perl_mutex *xcv_mutexp;
52e1cb5e 34 struct perl_thread *xcv_owner; /* current owner thread */
11343788 35#endif /* USE_THREADS */
77a005ab 36 cv_flags_t xcv_flags;
246699ca 37 HV * xcv_defstash;
79072805 38};
748a9306 39
954c1994
GS
40/*
41=for apidoc AmU||Nullcv
42Null CV pointer.
43
44=for apidoc Am|HV*|CvSTASH|CV* cv
45Returns the stash of the CV.
46
47=cut
48*/
49
79072805 50#define Nullcv Null(CV*)
a5f75d66 51
79072805
LW
52#define CvSTASH(sv) ((XPVCV*)SvANY(sv))->xcv_stash
53#define CvSTART(sv) ((XPVCV*)SvANY(sv))->xcv_start
54#define CvROOT(sv) ((XPVCV*)SvANY(sv))->xcv_root
a0d0e21e
LW
55#define CvXSUB(sv) ((XPVCV*)SvANY(sv))->xcv_xsub
56#define CvXSUBANY(sv) ((XPVCV*)SvANY(sv))->xcv_xsubany
8990e307 57#define CvGV(sv) ((XPVCV*)SvANY(sv))->xcv_gv
57843af0 58#define CvFILE(sv) ((XPVCV*)SvANY(sv))->xcv_file
a636914a
RH
59#ifdef USE_ITHREADS
60# define CvFILE_set_from_cop(sv, cop) (CvFILE(sv) = savepv(CopFILE(cop)))
61#else
62# define CvFILE_set_from_cop(sv, cop) (CvFILE(sv) = CopFILE(cop))
63#endif
57843af0 64#define CvFILEGV(sv) (gv_fetchfile(CvFILE(sv))
79072805
LW
65#define CvDEPTH(sv) ((XPVCV*)SvANY(sv))->xcv_depth
66#define CvPADLIST(sv) ((XPVCV*)SvANY(sv))->xcv_padlist
748a9306 67#define CvOUTSIDE(sv) ((XPVCV*)SvANY(sv))->xcv_outside
11343788
MB
68#ifdef USE_THREADS
69#define CvMUTEXP(sv) ((XPVCV*)SvANY(sv))->xcv_mutexp
11343788
MB
70#define CvOWNER(sv) ((XPVCV*)SvANY(sv))->xcv_owner
71#endif /* USE_THREADS */
a5f75d66 72#define CvFLAGS(sv) ((XPVCV*)SvANY(sv))->xcv_flags
246699ca 73#define CvDEFSTASH(sv) ((XPVCV*)SvANY(sv))->xcv_defstash
a5f75d66 74
77a005ab
MB
75#define CVf_CLONE 0x0001 /* anon CV uses external lexicals */
76#define CVf_CLONED 0x0002 /* a clone of one of those */
77#define CVf_ANON 0x0004 /* CvGV() can't be trusted */
78#define CVf_OLDSTYLE 0x0008
79#define CVf_UNIQUE 0x0010 /* can't be cloned */
80#define CVf_NODEBUG 0x0020 /* no DB::sub indirection for this CV
8ebc5c01 81 (esp. useful for special XSUBs) */
77a005ab
MB
82#define CVf_METHOD 0x0040 /* CV is explicitly marked as a method */
83#define CVf_LOCKED 0x0080 /* CV locks itself or first arg on entry */
cd06dffe 84#define CVf_LVALUE 0x0100 /* CV return value can be used as lvalue */
beab0874 85#define CVf_CONST 0x0200 /* inlinable sub */
a5f75d66
AD
86
87#define CvCLONE(cv) (CvFLAGS(cv) & CVf_CLONE)
88#define CvCLONE_on(cv) (CvFLAGS(cv) |= CVf_CLONE)
89#define CvCLONE_off(cv) (CvFLAGS(cv) &= ~CVf_CLONE)
90
91#define CvCLONED(cv) (CvFLAGS(cv) & CVf_CLONED)
92#define CvCLONED_on(cv) (CvFLAGS(cv) |= CVf_CLONED)
93#define CvCLONED_off(cv) (CvFLAGS(cv) &= ~CVf_CLONED)
94
95#define CvANON(cv) (CvFLAGS(cv) & CVf_ANON)
96#define CvANON_on(cv) (CvFLAGS(cv) |= CVf_ANON)
97#define CvANON_off(cv) (CvFLAGS(cv) &= ~CVf_ANON)
79072805 98
67caa1fe 99#ifdef PERL_XSUB_OLDSTYLE
a5f75d66
AD
100#define CvOLDSTYLE(cv) (CvFLAGS(cv) & CVf_OLDSTYLE)
101#define CvOLDSTYLE_on(cv) (CvFLAGS(cv) |= CVf_OLDSTYLE)
102#define CvOLDSTYLE_off(cv) (CvFLAGS(cv) &= ~CVf_OLDSTYLE)
67caa1fe 103#endif
07055b4c
CS
104
105#define CvUNIQUE(cv) (CvFLAGS(cv) & CVf_UNIQUE)
106#define CvUNIQUE_on(cv) (CvFLAGS(cv) |= CVf_UNIQUE)
107#define CvUNIQUE_off(cv) (CvFLAGS(cv) &= ~CVf_UNIQUE)
8ebc5c01
PP
108
109#define CvNODEBUG(cv) (CvFLAGS(cv) & CVf_NODEBUG)
110#define CvNODEBUG_on(cv) (CvFLAGS(cv) |= CVf_NODEBUG)
111#define CvNODEBUG_off(cv) (CvFLAGS(cv) &= ~CVf_NODEBUG)
77a005ab
MB
112
113#define CvMETHOD(cv) (CvFLAGS(cv) & CVf_METHOD)
114#define CvMETHOD_on(cv) (CvFLAGS(cv) |= CVf_METHOD)
115#define CvMETHOD_off(cv) (CvFLAGS(cv) &= ~CVf_METHOD)
116
117#define CvLOCKED(cv) (CvFLAGS(cv) & CVf_LOCKED)
118#define CvLOCKED_on(cv) (CvFLAGS(cv) |= CVf_LOCKED)
119#define CvLOCKED_off(cv) (CvFLAGS(cv) &= ~CVf_LOCKED)
1aff0e91 120
cd06dffe
GS
121#define CvLVALUE(cv) (CvFLAGS(cv) & CVf_LVALUE)
122#define CvLVALUE_on(cv) (CvFLAGS(cv) |= CVf_LVALUE)
123#define CvLVALUE_off(cv) (CvFLAGS(cv) &= ~CVf_LVALUE)
124
1aff0e91
GS
125#define CvEVAL(cv) (CvUNIQUE(cv) && !SvFAKE(cv))
126#define CvEVAL_on(cv) (CvUNIQUE_on(cv),SvFAKE_off(cv))
127#define CvEVAL_off(cv) CvUNIQUE_off(cv)
128
129/* BEGIN|INIT|END */
130#define CvSPECIAL(cv) (CvUNIQUE(cv) && SvFAKE(cv))
131#define CvSPECIAL_on(cv) (CvUNIQUE_on(cv),SvFAKE_on(cv))
132#define CvSPECIAL_off(cv) (CvUNIQUE_off(cv),SvFAKE_off(cv))
beab0874
JT
133
134#define CvCONST(cv) (CvFLAGS(cv) & CVf_CONST)
135#define CvCONST_on(cv) (CvFLAGS(cv) |= CVf_CONST)
136#define CvCONST_off(cv) (CvFLAGS(cv) &= ~CVf_CONST)