Commit | Line | Data |
---|---|---|
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 |
13 | struct 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; | |
acfe0abc | 25 | void (*xcv_xsub) (pTHX_ 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; |
4d1ff10f | 32 | #ifdef USE_5005THREADS |
12ca11f6 | 33 | perl_mutex *xcv_mutexp; |
52e1cb5e | 34 | struct perl_thread *xcv_owner; /* current owner thread */ |
4d1ff10f | 35 | #endif /* USE_5005THREADS */ |
77a005ab | 36 | cv_flags_t xcv_flags; |
79072805 | 37 | }; |
748a9306 | 38 | |
954c1994 GS |
39 | /* |
40 | =for apidoc AmU||Nullcv | |
41 | Null CV pointer. | |
42 | ||
43 | =for apidoc Am|HV*|CvSTASH|CV* cv | |
44 | Returns the stash of the CV. | |
45 | ||
46 | =cut | |
47 | */ | |
48 | ||
79072805 | 49 | #define Nullcv Null(CV*) |
a5f75d66 | 50 | |
79072805 LW |
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 | |
a0d0e21e LW |
54 | #define CvXSUB(sv) ((XPVCV*)SvANY(sv))->xcv_xsub |
55 | #define CvXSUBANY(sv) ((XPVCV*)SvANY(sv))->xcv_xsubany | |
8990e307 | 56 | #define CvGV(sv) ((XPVCV*)SvANY(sv))->xcv_gv |
57843af0 | 57 | #define CvFILE(sv) ((XPVCV*)SvANY(sv))->xcv_file |
a636914a RH |
58 | #ifdef USE_ITHREADS |
59 | # define CvFILE_set_from_cop(sv, cop) (CvFILE(sv) = savepv(CopFILE(cop))) | |
60 | #else | |
61 | # define CvFILE_set_from_cop(sv, cop) (CvFILE(sv) = CopFILE(cop)) | |
62 | #endif | |
57843af0 | 63 | #define CvFILEGV(sv) (gv_fetchfile(CvFILE(sv)) |
79072805 LW |
64 | #define CvDEPTH(sv) ((XPVCV*)SvANY(sv))->xcv_depth |
65 | #define CvPADLIST(sv) ((XPVCV*)SvANY(sv))->xcv_padlist | |
748a9306 | 66 | #define CvOUTSIDE(sv) ((XPVCV*)SvANY(sv))->xcv_outside |
4d1ff10f | 67 | #ifdef USE_5005THREADS |
11343788 | 68 | #define CvMUTEXP(sv) ((XPVCV*)SvANY(sv))->xcv_mutexp |
11343788 | 69 | #define CvOWNER(sv) ((XPVCV*)SvANY(sv))->xcv_owner |
4d1ff10f | 70 | #endif /* USE_5005THREADS */ |
a5f75d66 AD |
71 | #define CvFLAGS(sv) ((XPVCV*)SvANY(sv))->xcv_flags |
72 | ||
77a005ab MB |
73 | #define CVf_CLONE 0x0001 /* anon CV uses external lexicals */ |
74 | #define CVf_CLONED 0x0002 /* a clone of one of those */ | |
75 | #define CVf_ANON 0x0004 /* CvGV() can't be trusted */ | |
76 | #define CVf_OLDSTYLE 0x0008 | |
77 | #define CVf_UNIQUE 0x0010 /* can't be cloned */ | |
78 | #define CVf_NODEBUG 0x0020 /* no DB::sub indirection for this CV | |
8ebc5c01 | 79 | (esp. useful for special XSUBs) */ |
77a005ab MB |
80 | #define CVf_METHOD 0x0040 /* CV is explicitly marked as a method */ |
81 | #define CVf_LOCKED 0x0080 /* CV locks itself or first arg on entry */ | |
cd06dffe | 82 | #define CVf_LVALUE 0x0100 /* CV return value can be used as lvalue */ |
beab0874 | 83 | #define CVf_CONST 0x0200 /* inlinable sub */ |
a5f75d66 AD |
84 | |
85 | #define CvCLONE(cv) (CvFLAGS(cv) & CVf_CLONE) | |
86 | #define CvCLONE_on(cv) (CvFLAGS(cv) |= CVf_CLONE) | |
87 | #define CvCLONE_off(cv) (CvFLAGS(cv) &= ~CVf_CLONE) | |
88 | ||
89 | #define CvCLONED(cv) (CvFLAGS(cv) & CVf_CLONED) | |
90 | #define CvCLONED_on(cv) (CvFLAGS(cv) |= CVf_CLONED) | |
91 | #define CvCLONED_off(cv) (CvFLAGS(cv) &= ~CVf_CLONED) | |
92 | ||
93 | #define CvANON(cv) (CvFLAGS(cv) & CVf_ANON) | |
94 | #define CvANON_on(cv) (CvFLAGS(cv) |= CVf_ANON) | |
95 | #define CvANON_off(cv) (CvFLAGS(cv) &= ~CVf_ANON) | |
79072805 | 96 | |
67caa1fe | 97 | #ifdef PERL_XSUB_OLDSTYLE |
a5f75d66 AD |
98 | #define CvOLDSTYLE(cv) (CvFLAGS(cv) & CVf_OLDSTYLE) |
99 | #define CvOLDSTYLE_on(cv) (CvFLAGS(cv) |= CVf_OLDSTYLE) | |
100 | #define CvOLDSTYLE_off(cv) (CvFLAGS(cv) &= ~CVf_OLDSTYLE) | |
67caa1fe | 101 | #endif |
07055b4c CS |
102 | |
103 | #define CvUNIQUE(cv) (CvFLAGS(cv) & CVf_UNIQUE) | |
104 | #define CvUNIQUE_on(cv) (CvFLAGS(cv) |= CVf_UNIQUE) | |
105 | #define CvUNIQUE_off(cv) (CvFLAGS(cv) &= ~CVf_UNIQUE) | |
8ebc5c01 | 106 | |
107 | #define CvNODEBUG(cv) (CvFLAGS(cv) & CVf_NODEBUG) | |
108 | #define CvNODEBUG_on(cv) (CvFLAGS(cv) |= CVf_NODEBUG) | |
109 | #define CvNODEBUG_off(cv) (CvFLAGS(cv) &= ~CVf_NODEBUG) | |
77a005ab MB |
110 | |
111 | #define CvMETHOD(cv) (CvFLAGS(cv) & CVf_METHOD) | |
112 | #define CvMETHOD_on(cv) (CvFLAGS(cv) |= CVf_METHOD) | |
113 | #define CvMETHOD_off(cv) (CvFLAGS(cv) &= ~CVf_METHOD) | |
114 | ||
115 | #define CvLOCKED(cv) (CvFLAGS(cv) & CVf_LOCKED) | |
116 | #define CvLOCKED_on(cv) (CvFLAGS(cv) |= CVf_LOCKED) | |
117 | #define CvLOCKED_off(cv) (CvFLAGS(cv) &= ~CVf_LOCKED) | |
1aff0e91 | 118 | |
cd06dffe GS |
119 | #define CvLVALUE(cv) (CvFLAGS(cv) & CVf_LVALUE) |
120 | #define CvLVALUE_on(cv) (CvFLAGS(cv) |= CVf_LVALUE) | |
121 | #define CvLVALUE_off(cv) (CvFLAGS(cv) &= ~CVf_LVALUE) | |
122 | ||
1aff0e91 GS |
123 | #define CvEVAL(cv) (CvUNIQUE(cv) && !SvFAKE(cv)) |
124 | #define CvEVAL_on(cv) (CvUNIQUE_on(cv),SvFAKE_off(cv)) | |
125 | #define CvEVAL_off(cv) CvUNIQUE_off(cv) | |
126 | ||
127 | /* BEGIN|INIT|END */ | |
128 | #define CvSPECIAL(cv) (CvUNIQUE(cv) && SvFAKE(cv)) | |
129 | #define CvSPECIAL_on(cv) (CvUNIQUE_on(cv),SvFAKE_on(cv)) | |
130 | #define CvSPECIAL_off(cv) (CvUNIQUE_off(cv),SvFAKE_off(cv)) | |
beab0874 JT |
131 | |
132 | #define CvCONST(cv) (CvFLAGS(cv) & CVf_CONST) | |
133 | #define CvCONST_on(cv) (CvFLAGS(cv) |= CVf_CONST) | |
134 | #define CvCONST_off(cv) (CvFLAGS(cv) &= ~CVf_CONST) |