Commit | Line | Data |
a0d0e21e |
1 | /* cv.h |
79072805 |
2 | * |
eb1102fc |
3 | * Copyright (c) 1991-2002, Larry Wall |
79072805 |
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 |
8 | */ |
9 | |
57843af0 |
10 | /* This structure much match XPVCV in B/C.pm and the beginning of XPVFM |
11 | * in sv.h */ |
44a8e56a |
12 | |
79072805 |
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 |
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 */ |
dd2155a4 |
30 | PADLIST * xcv_padlist; |
748a9306 |
31 | CV * xcv_outside; |
77a005ab |
32 | cv_flags_t xcv_flags; |
a3985cdc |
33 | U32 xcv_outside_seq; /* the COP sequence (at the point of our |
34 | * compilation) in the lexically enclosing |
35 | * sub */ |
79072805 |
36 | }; |
748a9306 |
37 | |
954c1994 |
38 | /* |
ccfc67b7 |
39 | =head1 Handy Values |
40 | |
954c1994 |
41 | =for apidoc AmU||Nullcv |
42 | Null CV pointer. |
43 | |
ccfc67b7 |
44 | =head1 CV Manipulation Functions |
45 | |
954c1994 |
46 | =for apidoc Am|HV*|CvSTASH|CV* cv |
47 | Returns the stash of the CV. |
48 | |
49 | =cut |
50 | */ |
51 | |
79072805 |
52 | #define Nullcv Null(CV*) |
a5f75d66 |
53 | |
79072805 |
54 | #define CvSTASH(sv) ((XPVCV*)SvANY(sv))->xcv_stash |
55 | #define CvSTART(sv) ((XPVCV*)SvANY(sv))->xcv_start |
56 | #define CvROOT(sv) ((XPVCV*)SvANY(sv))->xcv_root |
a0d0e21e |
57 | #define CvXSUB(sv) ((XPVCV*)SvANY(sv))->xcv_xsub |
58 | #define CvXSUBANY(sv) ((XPVCV*)SvANY(sv))->xcv_xsubany |
8990e307 |
59 | #define CvGV(sv) ((XPVCV*)SvANY(sv))->xcv_gv |
57843af0 |
60 | #define CvFILE(sv) ((XPVCV*)SvANY(sv))->xcv_file |
a636914a |
61 | #ifdef USE_ITHREADS |
62 | # define CvFILE_set_from_cop(sv, cop) (CvFILE(sv) = savepv(CopFILE(cop))) |
63 | #else |
64 | # define CvFILE_set_from_cop(sv, cop) (CvFILE(sv) = CopFILE(cop)) |
65 | #endif |
9ec2a764 |
66 | #define CvFILEGV(sv) (gv_fetchfile(CvFILE(sv))) |
79072805 |
67 | #define CvDEPTH(sv) ((XPVCV*)SvANY(sv))->xcv_depth |
68 | #define CvPADLIST(sv) ((XPVCV*)SvANY(sv))->xcv_padlist |
748a9306 |
69 | #define CvOUTSIDE(sv) ((XPVCV*)SvANY(sv))->xcv_outside |
a5f75d66 |
70 | #define CvFLAGS(sv) ((XPVCV*)SvANY(sv))->xcv_flags |
a3985cdc |
71 | #define CvOUTSIDE_SEQ(sv) ((XPVCV*)SvANY(sv))->xcv_outside_seq |
a5f75d66 |
72 | |
77a005ab |
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 |
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 */ |
d3cea301 |
84 | /* This symbol for optimised communication between toke.c and op.c: */ |
85 | #define CVf_BUILTIN_ATTRS (CVf_METHOD|CVf_LOCKED|CVf_LVALUE) |
a5f75d66 |
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 |
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 |
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 |
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 |
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 |
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 |
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 | |
bec31f9a |
129 | /* BEGIN|CHECK|INIT|END */ |
1aff0e91 |
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 |
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) |
a4f1a029 |
137 | |