Add tests for last and next in when()
[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 the beginning of XPVFM in sv.h  */
12
13 struct xpvcv {
14     _XPV_HEAD;
15     _XPVMG_HEAD;
16     _XPVCV_COMMON;
17 };
18
19 typedef struct {
20     _XPV_ALLOCATED_HEAD;
21     _XPVMG_HEAD;
22     _XPVCV_COMMON;
23 } xpvcv_allocated;
24
25 /*
26 =head1 Handy Values
27
28 =for apidoc AmU||Nullcv
29 Null CV pointer.
30
31 (deprecated - use C<(CV *)NULL> instead)
32
33 =head1 CV Manipulation Functions
34
35 =for apidoc Am|HV*|CvSTASH|CV* cv
36 Returns the stash of the CV.
37
38 =cut
39 */
40
41 #ifndef PERL_CORE
42 #  define Nullcv Null(CV*)
43 #endif
44
45 #define CvSTASH(sv)     ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_stash
46 #define CvSTART(sv)     ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_start_u.xcv_start
47 #define CvROOT(sv)      ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_root_u.xcv_root
48 #define CvXSUB(sv)      ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_root_u.xcv_xsub
49 #define CvXSUBANY(sv)   ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_start_u.xcv_xsubany
50 #define CvGV(sv)        ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_gv
51 #define CvFILE(sv)      ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_file
52 #ifdef USE_ITHREADS
53 #  define CvFILE_set_from_cop(sv, cop)  (CvFILE(sv) = savepv(CopFILE(cop)))
54 #else
55 #  define CvFILE_set_from_cop(sv, cop)  (CvFILE(sv) = CopFILE(cop))
56 #endif
57 #define CvFILEGV(sv)    (gv_fetchfile(CvFILE(sv)))
58 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
59 #  define CvDEPTH(sv) (*({const CV *const _cvdepth = (const CV *)sv; \
60                           assert(SvTYPE(_cvdepth) == SVt_PVCV);  \
61                           &((XPVCV*)SvANY(_cvdepth))->xiv_u.xivu_i32; \
62                         }))
63 #else
64 #  define CvDEPTH(sv)   ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xiv_u.xivu_i32
65 #endif
66 #define CvPADLIST(sv)   ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_padlist
67 #define CvOUTSIDE(sv)   ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_outside
68 #define CvFLAGS(sv)     ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_flags
69 #define CvOUTSIDE_SEQ(sv) ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_outside_seq
70
71 #define CVf_METHOD      0x0001  /* CV is explicitly marked as a method */
72 #define CVf_LVALUE      0x0004  /* CV return value can be used as lvalue */
73
74 #define CVf_WEAKOUTSIDE 0x0010  /* CvOUTSIDE isn't ref counted */
75 #define CVf_CLONE       0x0020  /* anon CV uses external lexicals */
76 #define CVf_CLONED      0x0040  /* a clone of one of those */
77 #define CVf_ANON        0x0080  /* CvGV() can't be trusted */
78 #define CVf_UNIQUE      0x0100  /* sub is only called once (eg PL_main_cv,
79                                  * require, eval). */
80 #define CVf_NODEBUG     0x0200  /* no DB::sub indirection for this CV
81                                    (esp. useful for special XSUBs) */
82 #define CVf_CONST       0x0400  /* inlinable sub */
83 #define CVf_ISXSUB      0x0800  /* CV is an XSUB, not pure perl.  */
84
85 /* This symbol for optimised communication between toke.c and op.c: */
86 #define CVf_BUILTIN_ATTRS       (CVf_METHOD|CVf_LVALUE)
87
88 #define CvCLONE(cv)             (CvFLAGS(cv) & CVf_CLONE)
89 #define CvCLONE_on(cv)          (CvFLAGS(cv) |= CVf_CLONE)
90 #define CvCLONE_off(cv)         (CvFLAGS(cv) &= ~CVf_CLONE)
91
92 #define CvCLONED(cv)            (CvFLAGS(cv) & CVf_CLONED)
93 #define CvCLONED_on(cv)         (CvFLAGS(cv) |= CVf_CLONED)
94 #define CvCLONED_off(cv)        (CvFLAGS(cv) &= ~CVf_CLONED)
95
96 #define CvANON(cv)              (CvFLAGS(cv) & CVf_ANON)
97 #define CvANON_on(cv)           (CvFLAGS(cv) |= CVf_ANON)
98 #define CvANON_off(cv)          (CvFLAGS(cv) &= ~CVf_ANON)
99
100 #define CvUNIQUE(cv)            (CvFLAGS(cv) & CVf_UNIQUE)
101 #define CvUNIQUE_on(cv)         (CvFLAGS(cv) |= CVf_UNIQUE)
102 #define CvUNIQUE_off(cv)        (CvFLAGS(cv) &= ~CVf_UNIQUE)
103
104 #define CvNODEBUG(cv)           (CvFLAGS(cv) & CVf_NODEBUG)
105 #define CvNODEBUG_on(cv)        (CvFLAGS(cv) |= CVf_NODEBUG)
106 #define CvNODEBUG_off(cv)       (CvFLAGS(cv) &= ~CVf_NODEBUG)
107
108 #define CvMETHOD(cv)            (CvFLAGS(cv) & CVf_METHOD)
109 #define CvMETHOD_on(cv)         (CvFLAGS(cv) |= CVf_METHOD)
110 #define CvMETHOD_off(cv)        (CvFLAGS(cv) &= ~CVf_METHOD)
111
112 #define CvLVALUE(cv)            (CvFLAGS(cv) & CVf_LVALUE)
113 #define CvLVALUE_on(cv)         (CvFLAGS(cv) |= CVf_LVALUE)
114 #define CvLVALUE_off(cv)        (CvFLAGS(cv) &= ~CVf_LVALUE)
115
116 #define CvEVAL(cv)              (CvUNIQUE(cv) && !SvFAKE(cv))
117 #define CvEVAL_on(cv)           (CvUNIQUE_on(cv),SvFAKE_off(cv))
118 #define CvEVAL_off(cv)          CvUNIQUE_off(cv)
119
120 /* BEGIN|CHECK|INIT|UNITCHECK|END */
121 #define CvSPECIAL(cv)           (CvUNIQUE(cv) && SvFAKE(cv))
122 #define CvSPECIAL_on(cv)        (CvUNIQUE_on(cv),SvFAKE_on(cv))
123 #define CvSPECIAL_off(cv)       (CvUNIQUE_off(cv),SvFAKE_off(cv))
124
125 #define CvCONST(cv)             (CvFLAGS(cv) & CVf_CONST)
126 #define CvCONST_on(cv)          (CvFLAGS(cv) |= CVf_CONST)
127 #define CvCONST_off(cv)         (CvFLAGS(cv) &= ~CVf_CONST)
128
129 #define CvWEAKOUTSIDE(cv)       (CvFLAGS(cv) & CVf_WEAKOUTSIDE)
130 #define CvWEAKOUTSIDE_on(cv)    (CvFLAGS(cv) |= CVf_WEAKOUTSIDE)
131 #define CvWEAKOUTSIDE_off(cv)   (CvFLAGS(cv) &= ~CVf_WEAKOUTSIDE)
132
133 #define CvISXSUB(cv)            (CvFLAGS(cv) & CVf_ISXSUB)
134 #define CvISXSUB_on(cv)         (CvFLAGS(cv) |= CVf_ISXSUB)
135 #define CvISXSUB_off(cv)        (CvFLAGS(cv) &= ~CVf_ISXSUB)
136
137 /* Flags for newXS_flags  */
138 #define XS_DYNAMIC_FILENAME     0x01    /* The filename isn't static  */
139
140 /*
141 =head1 CV reference counts and CvOUTSIDE
142
143 =for apidoc m|bool|CvWEAKOUTSIDE|CV *cv
144
145 Each CV has a pointer, C<CvOUTSIDE()>, to its lexically enclosing
146 CV (if any). Because pointers to anonymous sub prototypes are
147 stored in C<&> pad slots, it is a possible to get a circular reference,
148 with the parent pointing to the child and vice-versa. To avoid the
149 ensuing memory leak, we do not increment the reference count of the CV
150 pointed to by C<CvOUTSIDE> in the I<one specific instance> that the parent
151 has a C<&> pad slot pointing back to us. In this case, we set the
152 C<CvWEAKOUTSIDE> flag in the child. This allows us to determine under what
153 circumstances we should decrement the refcount of the parent when freeing
154 the child.
155
156 There is a further complication with non-closure anonymous subs (i.e. those
157 that do not refer to any lexicals outside that sub). In this case, the
158 anonymous prototype is shared rather than being cloned. This has the
159 consequence that the parent may be freed while there are still active
160 children, eg
161
162     BEGIN { $a = sub { eval '$x' } }
163
164 In this case, the BEGIN is freed immediately after execution since there
165 are no active references to it: the anon sub prototype has
166 C<CvWEAKOUTSIDE> set since it's not a closure, and $a points to the same
167 CV, so it doesn't contribute to BEGIN's refcount either.  When $a is
168 executed, the C<eval '$x'> causes the chain of C<CvOUTSIDE>s to be followed,
169 and the freed BEGIN is accessed.
170
171 To avoid this, whenever a CV and its associated pad is freed, any
172 C<&> entries in the pad are explicitly removed from the pad, and if the
173 refcount of the pointed-to anon sub is still positive, then that
174 child's C<CvOUTSIDE> is set to point to its grandparent. This will only
175 occur in the single specific case of a non-closure anon prototype
176 having one or more active references (such as C<$a> above).
177
178 One other thing to consider is that a CV may be merely undefined
179 rather than freed, eg C<undef &foo>. In this case, its refcount may
180 not have reached zero, but we still delete its pad and its C<CvROOT> etc.
181 Since various children may still have their C<CvOUTSIDE> pointing at this
182 undefined CV, we keep its own C<CvOUTSIDE> for the time being, so that
183 the chain of lexical scopes is unbroken. For example, the following
184 should print 123:
185
186     my $x = 123;
187     sub tmp { sub { eval '$x' } }
188     my $a = tmp();
189     undef &tmp;
190     print  $a->();
191
192 =cut
193 */
194
195 /*
196  * Local variables:
197  * c-indentation-style: bsd
198  * c-basic-offset: 4
199  * indent-tabs-mode: t
200  * End:
201  *
202  * ex: set ts=8 sts=4 sw=4 noet:
203  */