Upgrade to Text-Tabs+Wrap-2012.0818
[perl.git] / cv.h
1 /*    cv.h
2  *
3  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1999, 2000, 2001,
4  *    2002, 2003, 2004, 2005, 2006, 2007, 2008 by Larry Wall and others
5  *
6  *    You may distribute under the terms of either the GNU General Public
7  *    License or the Artistic License, as specified in the README file.
8  *
9  */
10
11 /* This structure must match the beginning of XPVFM in sv.h  */
12
13 struct xpvcv {
14     _XPV_HEAD;
15     _XPVCV_COMMON;
16     I32 xcv_depth;      /* >= 2 indicates recursive call */
17 };
18
19 /*
20 =head1 Handy Values
21
22 =for apidoc AmU||Nullcv
23 Null CV pointer.
24
25 (deprecated - use C<(CV *)NULL> instead)
26
27 =head1 CV Manipulation Functions
28
29 This section documents functions to manipulate CVs which are code-values,
30 or subroutines. For more information, see L<perlguts>.
31
32 =for apidoc Am|HV*|CvSTASH|CV* cv
33 Returns the stash of the CV. A stash is the symbol table hash, containing
34 the package-scoped variables in the package where the subroutine was defined.
35 For more information, see L<perlguts>.
36
37 This also has a special use with XS AUTOLOAD subs.
38 See L<perlguts/Autoloading with XSUBs>.
39
40 =cut
41 */
42
43 #ifndef PERL_CORE
44 #  define Nullcv Null(CV*)
45 #endif
46
47 #define CvSTASH(sv)     (0+((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_stash)
48 #define CvSTASH_set(cv,st) Perl_cvstash_set(aTHX_ cv, st)
49 #define CvSTART(sv)     ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_start_u.xcv_start
50 #define CvROOT(sv)      ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_root_u.xcv_root
51 #define CvXSUB(sv)      ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_root_u.xcv_xsub
52 #define CvXSUBANY(sv)   ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_start_u.xcv_xsubany
53 #define CvGV(sv)        (0+((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_gv)
54 #define CvGV_set(cv,gv) Perl_cvgv_set(aTHX_ cv, gv)
55 #define CvFILE(sv)      ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_file
56 #ifdef USE_ITHREADS
57 #  define CvFILE_set_from_cop(sv, cop)  \
58     (CvFILE(sv) = savepv(CopFILE(cop)), CvDYNFILE_on(sv))
59 #else
60 #  define CvFILE_set_from_cop(sv, cop)  \
61     (CvFILE(sv) = CopFILE(cop), CvDYNFILE_off(sv))
62 #endif
63 #define CvFILEGV(sv)    (gv_fetchfile(CvFILE(sv)))
64 PERL_STATIC_INLINE I32 *
65 S_CvDEPTHp(const CV * const sv)
66 {
67     return SvTYPE(sv) == SVt_PVCV
68         ? &((XPVCV*)SvANY(sv))->xcv_depth
69         : &((XPVCV*)SvANY(sv))->xpv_fmdepth;
70 }
71 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
72 #  define CvDEPTH(sv) (*({const CV *const _cvdepth = (const CV *)sv; \
73                           assert(SvTYPE(_cvdepth) == SVt_PVCV         \
74                               || SvTYPE(_cvdepth) == SVt_PVFM);        \
75                           S_CvDEPTHp(_cvdepth);                         \
76                         }))
77 #else
78 #  define CvDEPTH(sv)   (*S_CvDEPTHp((const CV *)sv))
79 #endif
80 #define CvPADLIST(sv)   ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_padlist
81 #define CvOUTSIDE(sv)   ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_outside
82 #define CvFLAGS(sv)     ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_flags
83 #define CvOUTSIDE_SEQ(sv) ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_outside_seq
84
85 /* These two are sometimes called on non-CVs */
86 #define CvPROTO(sv)                               \
87         (                                          \
88          SvPOK(sv)                                  \
89           ? SvTYPE(sv) == SVt_PVCV && CvAUTOLOAD(sv) \
90              ? SvEND(sv)+1 : SvPVX_const(sv)          \
91           : NULL                                       \
92         )
93 #define CvPROTOLEN(sv)                            \
94         (                                          \
95          SvPOK(sv)                                  \
96           ? SvTYPE(sv) == SVt_PVCV && CvAUTOLOAD(sv) \
97              ? SvLEN(sv)-SvCUR(sv)-2                  \
98              : SvCUR(sv)                               \
99           : 0                                           \
100         )
101
102 #define CVf_METHOD      0x0001  /* CV is explicitly marked as a method */
103 #define CVf_LVALUE      0x0002  /* CV return value can be used as lvalue */
104 #define CVf_CONST       0x0004  /* inlinable sub */
105 #define CVf_ISXSUB      0x0008  /* CV is an XSUB, not pure perl.  */
106
107 #define CVf_WEAKOUTSIDE 0x0010  /* CvOUTSIDE isn't ref counted */
108 #define CVf_CLONE       0x0020  /* anon CV uses external lexicals */
109 #define CVf_CLONED      0x0040  /* a clone of one of those */
110 #define CVf_ANON        0x0080  /* CV is not pointed to by a GV */
111 #define CVf_UNIQUE      0x0100  /* sub is only called once (eg PL_main_cv,
112                                  * require, eval). */
113 #define CVf_NODEBUG     0x0200  /* no DB::sub indirection for this CV
114                                    (esp. useful for special XSUBs) */
115 #define CVf_CVGV_RC     0x0400  /* CvGV is reference counted */
116 #ifdef PERL_CORE
117 # define CVf_SLABBED    0x0800  /* Holds refcount on op slab  */
118 #endif
119 #define CVf_DYNFILE     0x1000  /* The filename isn't static  */
120 #define CVf_AUTOLOAD    0x2000  /* SvPVX contains AUTOLOADed sub name  */
121 #define CVf_HASEVAL     0x4000  /* contains string eval  */
122
123 /* This symbol for optimised communication between toke.c and op.c: */
124 #define CVf_BUILTIN_ATTRS       (CVf_METHOD|CVf_LVALUE)
125
126 #define CvCLONE(cv)             (CvFLAGS(cv) & CVf_CLONE)
127 #define CvCLONE_on(cv)          (CvFLAGS(cv) |= CVf_CLONE)
128 #define CvCLONE_off(cv)         (CvFLAGS(cv) &= ~CVf_CLONE)
129
130 #define CvCLONED(cv)            (CvFLAGS(cv) & CVf_CLONED)
131 #define CvCLONED_on(cv)         (CvFLAGS(cv) |= CVf_CLONED)
132 #define CvCLONED_off(cv)        (CvFLAGS(cv) &= ~CVf_CLONED)
133
134 #define CvANON(cv)              (CvFLAGS(cv) & CVf_ANON)
135 #define CvANON_on(cv)           (CvFLAGS(cv) |= CVf_ANON)
136 #define CvANON_off(cv)          (CvFLAGS(cv) &= ~CVf_ANON)
137
138 /* CvEVAL or CvSPECIAL */
139 #define CvUNIQUE(cv)            (CvFLAGS(cv) & CVf_UNIQUE)
140 #define CvUNIQUE_on(cv)         (CvFLAGS(cv) |= CVf_UNIQUE)
141 #define CvUNIQUE_off(cv)        (CvFLAGS(cv) &= ~CVf_UNIQUE)
142
143 #define CvNODEBUG(cv)           (CvFLAGS(cv) & CVf_NODEBUG)
144 #define CvNODEBUG_on(cv)        (CvFLAGS(cv) |= CVf_NODEBUG)
145 #define CvNODEBUG_off(cv)       (CvFLAGS(cv) &= ~CVf_NODEBUG)
146
147 #define CvMETHOD(cv)            (CvFLAGS(cv) & CVf_METHOD)
148 #define CvMETHOD_on(cv)         (CvFLAGS(cv) |= CVf_METHOD)
149 #define CvMETHOD_off(cv)        (CvFLAGS(cv) &= ~CVf_METHOD)
150
151 #define CvLVALUE(cv)            (CvFLAGS(cv) & CVf_LVALUE)
152 #define CvLVALUE_on(cv)         (CvFLAGS(cv) |= CVf_LVALUE)
153 #define CvLVALUE_off(cv)        (CvFLAGS(cv) &= ~CVf_LVALUE)
154
155 /* eval or PL_main_cv */
156 #define CvEVAL(cv)              (CvUNIQUE(cv) && !SvFAKE(cv))
157 #define CvEVAL_on(cv)           (CvUNIQUE_on(cv),SvFAKE_off(cv))
158 #define CvEVAL_off(cv)          CvUNIQUE_off(cv)
159
160 /* BEGIN|CHECK|INIT|UNITCHECK|END */
161 #define CvSPECIAL(cv)           (CvUNIQUE(cv) && SvFAKE(cv))
162 #define CvSPECIAL_on(cv)        (CvUNIQUE_on(cv),SvFAKE_on(cv))
163 #define CvSPECIAL_off(cv)       (CvUNIQUE_off(cv),SvFAKE_off(cv))
164
165 #define CvCONST(cv)             (CvFLAGS(cv) & CVf_CONST)
166 #define CvCONST_on(cv)          (CvFLAGS(cv) |= CVf_CONST)
167 #define CvCONST_off(cv)         (CvFLAGS(cv) &= ~CVf_CONST)
168
169 #define CvWEAKOUTSIDE(cv)       (CvFLAGS(cv) & CVf_WEAKOUTSIDE)
170 #define CvWEAKOUTSIDE_on(cv)    (CvFLAGS(cv) |= CVf_WEAKOUTSIDE)
171 #define CvWEAKOUTSIDE_off(cv)   (CvFLAGS(cv) &= ~CVf_WEAKOUTSIDE)
172
173 #define CvISXSUB(cv)            (CvFLAGS(cv) & CVf_ISXSUB)
174 #define CvISXSUB_on(cv)         (CvFLAGS(cv) |= CVf_ISXSUB)
175 #define CvISXSUB_off(cv)        (CvFLAGS(cv) &= ~CVf_ISXSUB)
176
177 #define CvCVGV_RC(cv)           (CvFLAGS(cv) & CVf_CVGV_RC)
178 #define CvCVGV_RC_on(cv)        (CvFLAGS(cv) |= CVf_CVGV_RC)
179 #define CvCVGV_RC_off(cv)       (CvFLAGS(cv) &= ~CVf_CVGV_RC)
180
181 #ifdef PERL_CORE
182 # define CvSLABBED(cv)          (CvFLAGS(cv) & CVf_SLABBED)
183 # define CvSLABBED_on(cv)       (CvFLAGS(cv) |= CVf_SLABBED)
184 # define CvSLABBED_off(cv)      (CvFLAGS(cv) &= ~CVf_SLABBED)
185 #endif
186
187 #define CvDYNFILE(cv)           (CvFLAGS(cv) & CVf_DYNFILE)
188 #define CvDYNFILE_on(cv)        (CvFLAGS(cv) |= CVf_DYNFILE)
189 #define CvDYNFILE_off(cv)       (CvFLAGS(cv) &= ~CVf_DYNFILE)
190
191 #define CvAUTOLOAD(cv)          (CvFLAGS(cv) & CVf_AUTOLOAD)
192 #define CvAUTOLOAD_on(cv)       (CvFLAGS(cv) |= CVf_AUTOLOAD)
193 #define CvAUTOLOAD_off(cv)      (CvFLAGS(cv) &= ~CVf_AUTOLOAD)
194
195 #define CvHASEVAL(cv)           (CvFLAGS(cv) & CVf_HASEVAL)
196 #define CvHASEVAL_on(cv)        (CvFLAGS(cv) |= CVf_HASEVAL)
197 #define CvHASEVAL_off(cv)       (CvFLAGS(cv) &= ~CVf_HASEVAL)
198
199 /* Flags for newXS_flags  */
200 #define XS_DYNAMIC_FILENAME     0x01    /* The filename isn't static  */
201
202 /*
203 =head1 CV reference counts and CvOUTSIDE
204
205 =for apidoc m|bool|CvWEAKOUTSIDE|CV *cv
206
207 Each CV has a pointer, C<CvOUTSIDE()>, to its lexically enclosing
208 CV (if any). Because pointers to anonymous sub prototypes are
209 stored in C<&> pad slots, it is a possible to get a circular reference,
210 with the parent pointing to the child and vice-versa. To avoid the
211 ensuing memory leak, we do not increment the reference count of the CV
212 pointed to by C<CvOUTSIDE> in the I<one specific instance> that the parent
213 has a C<&> pad slot pointing back to us. In this case, we set the
214 C<CvWEAKOUTSIDE> flag in the child. This allows us to determine under what
215 circumstances we should decrement the refcount of the parent when freeing
216 the child.
217
218 There is a further complication with non-closure anonymous subs (i.e. those
219 that do not refer to any lexicals outside that sub). In this case, the
220 anonymous prototype is shared rather than being cloned. This has the
221 consequence that the parent may be freed while there are still active
222 children, eg
223
224     BEGIN { $a = sub { eval '$x' } }
225
226 In this case, the BEGIN is freed immediately after execution since there
227 are no active references to it: the anon sub prototype has
228 C<CvWEAKOUTSIDE> set since it's not a closure, and $a points to the same
229 CV, so it doesn't contribute to BEGIN's refcount either.  When $a is
230 executed, the C<eval '$x'> causes the chain of C<CvOUTSIDE>s to be followed,
231 and the freed BEGIN is accessed.
232
233 To avoid this, whenever a CV and its associated pad is freed, any
234 C<&> entries in the pad are explicitly removed from the pad, and if the
235 refcount of the pointed-to anon sub is still positive, then that
236 child's C<CvOUTSIDE> is set to point to its grandparent. This will only
237 occur in the single specific case of a non-closure anon prototype
238 having one or more active references (such as C<$a> above).
239
240 One other thing to consider is that a CV may be merely undefined
241 rather than freed, eg C<undef &foo>. In this case, its refcount may
242 not have reached zero, but we still delete its pad and its C<CvROOT> etc.
243 Since various children may still have their C<CvOUTSIDE> pointing at this
244 undefined CV, we keep its own C<CvOUTSIDE> for the time being, so that
245 the chain of lexical scopes is unbroken. For example, the following
246 should print 123:
247
248     my $x = 123;
249     sub tmp { sub { eval '$x' } }
250     my $a = tmp();
251     undef &tmp;
252     print  $a->();
253
254 =cut
255 */
256
257 typedef OP *(*Perl_call_checker)(pTHX_ OP *, GV *, SV *);
258
259 /*
260  * Local variables:
261  * c-indentation-style: bsd
262  * c-basic-offset: 4
263  * indent-tabs-mode: nil
264  * End:
265  *
266  * ex: set ts=8 sts=4 sw=4 et:
267  */